doc: add interrupt implementation details #304
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nashif
approved these changes
May 26, 2017
nashif
requested changes
May 27, 2017
doc/kernel/other/interrupts.rst
Outdated
| The priority level of any interrupt is not encoded in these tables, instead | ||
| :c:macro:`IRQ_CONNECT` also has a runtime component which programs the | ||
| desired priority level of the interrupt to the interrupt controller. Some | ||
| arches do not support the notion of interrupt priority, in which case the |
doc/kernel/other/interrupts.rst
Outdated
|
|
||
| Vector Table | ||
| ------------ | ||
| Whether to generate this depends on whether CONFIG_GEN_IRQ_VECTOR_TABLE is |
There was a problem hiding this comment.
Whether to generate the vector table ...
doc/kernel/other/interrupts.rst
Outdated
| x86 Details | ||
| ----------- | ||
|
|
||
| x86 has a special type of vector table called the Interrupt Descriptor Table |
There was a problem hiding this comment.
The X86 architecture has a special ....
dbkinder
reviewed
May 28, 2017
doc/kernel/other/interrupts.rst
Outdated
|
|
||
| Interrupt tables are set up at build time using some special build tools. | ||
| The details laid out here apply to all architectures except x86, which will | ||
| be covered in its own section. |
There was a problem hiding this comment.
how about:
which are covered in the `x86 Details`_ section below.
dbkinder
reviewed
May 28, 2017
doc/kernel/other/interrupts.rst
Outdated
| struct _isr_list isrs[]; <- of size num_isrs | ||
| }; | ||
|
|
||
| This is then used by the gen_isr_tables.py script to |
There was a problem hiding this comment.
Say what "this" is. Are you referring to zephyr_prebuild.elf?
dbkinder
reviewed
May 28, 2017
doc/kernel/other/interrupts.rst
Outdated
| }; | ||
|
|
||
| This is then used by the gen_isr_tables.py script to | ||
| generate a vector table and/or a software ISR table. This is produced as a C |
There was a problem hiding this comment.
generate a C file defining a vector table and software ISR table that are then compiled and linked into the final application.
dbkinder
reviewed
May 29, 2017
doc/kernel/other/interrupts.rst
Outdated
|
|
||
| Vector Table | ||
| ------------ | ||
| Whether to generate this depends on whether CONFIG_GEN_IRQ_VECTOR_TABLE is |
There was a problem hiding this comment.
How about:
A vector table is generated when CONFIG_GEN_IRQ_VECTOR_TABLE is enabled.
dbkinder
reviewed
May 29, 2017
doc/kernel/other/interrupts.rst
Outdated
| Vector Table | ||
| ------------ | ||
| Whether to generate this depends on whether CONFIG_GEN_IRQ_VECTOR_TABLE is | ||
| enabled. This is simply an array of function pointers, where each element |
There was a problem hiding this comment.
A vector table is simply an array of function pointers, where each element n corresponds to the IRQ handler for IRQ line n, and the function pointers are:
dbkinder
reviewed
May 29, 2017
doc/kernel/other/interrupts.rst
Outdated
| #. For interrupt lines that are not configured at all, the address of the | ||
| spurious IRQ handler, which causes a system fatal error if encountered. | ||
|
|
||
| Some architectures (like Nios II internal interrupt controller) have a common |
dbkinder
reviewed
May 29, 2017
doc/kernel/other/interrupts.rst
Outdated
|
|
||
| Some architectures (like Nios II internal interrupt controller) have a common | ||
| entry point for all interrupts and do not support a vector table, in which case | ||
| this option should be disabled. |
There was a problem hiding this comment.
the CONFIG_GEN_IRQ_VECTOR_TABLE option should be disabled.
dbkinder
suggested changes
May 29, 2017
nashif
previously approved these changes
Jun 6, 2017
dbkinder
reviewed
Jun 6, 2017
doc/kernel/other/interrupts.rst
Outdated
| ====================== | ||
|
|
||
| Interrupt tables are set up at build time using some special build tools. The | ||
| details laid out here apply to all architectures except x86, which which are |
dbkinder
reviewed
Jun 6, 2017
doc/kernel/other/interrupts.rst
Outdated
| kernel interrupt bookkeeping and looks up the ISR and parameter from the | ||
| software ISR table. | ||
| #. For interrupt lines that are not configured at all, the address of the | ||
| spurious IRQ handler, which causes a system fatal error if encountered. |
There was a problem hiding this comment.
after "which causes a system fatal error if encoungered" add ", will be placed here."
dbkinder
suggested changes
Jun 6, 2017
Issue: ZEP-634 Signed-off-by: Andrew Boie <[email protected]>
|
updated |
nagineni
pushed a commit
to nagineni/zephyr
that referenced
this pull request
Nov 20, 2017
…rproject-rtos#304) Signed-off-by: James Prestwood <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue: ZEP-634
Signed-off-by: Andrew Boie [email protected]