Skip to content

Commit d07d808

Browse files
ycsincarlescufi
authored andcommitted
doc: touch-up multi-level interrupt documentation
Some very minor touch-ups for multi-level interrupt wordings and documentations to better reflects its current state. Signed-off-by: Yong Cong Sin <[email protected]>
1 parent e78aacd commit d07d808

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

doc/kernel/services/interrupts.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ nesting support is enabled.
5959

6060
.. _multi_level_interrupts:
6161

62-
Multi-level Interrupt handling
62+
Multi-level Interrupt Handling
6363
==============================
6464

6565
A hardware platform can support more interrupt lines than natively-provided
@@ -68,7 +68,7 @@ hardware interrupts are combined into one line that is then routed to
6868
the parent controller.
6969

7070
If nested interrupt controllers are supported, :kconfig:option:`CONFIG_MULTI_LEVEL_INTERRUPTS`
71-
should be set to 1, and :kconfig:option:`CONFIG_2ND_LEVEL_INTERRUPTS` and
71+
should be enabled, and :kconfig:option:`CONFIG_2ND_LEVEL_INTERRUPTS` and
7272
:kconfig:option:`CONFIG_3RD_LEVEL_INTERRUPTS` configured as well, based on the
7373
hardware architecture.
7474

@@ -608,19 +608,19 @@ connected.
608608
Going Beyond the Default Supported Number of Interrupts
609609
-------------------------------------------------------
610610

611-
When generating interrupts in the multilevel configuration, 8-bits per level is the default
611+
When generating interrupts in the multi-level configuration, 8-bits per level is the default
612612
mask used when determining which level a given interrupt code belongs to. This can become
613613
a problem when dealing with CPUs that support more than 255 interrupts per single
614614
aggregator. In this case it may be desirable to override these defaults and use a custom
615615
number of bits per level. Regardless of how many bits used for each level, the sum of
616616
the total bits used between all levels must sum to be less than or equal to 32-bits,
617617
fitting into a single 32-bit integer. To modify the bit total per level, override the
618618
default 8 in `Kconfig.multilevel` by setting :kconfig:option:`CONFIG_1ST_LEVEL_INTERRUPT_BITS`
619-
for the first level, :kconfig:option:`CONFIG_2ND_LEVEL_INTERRUPT_BITS` for the second tier and
620-
:kconfig:option:`CONFIG_3RD_LEVEL_INTERRUPT_BITS` for the third tier. These masks control the
619+
for the first level, :kconfig:option:`CONFIG_2ND_LEVEL_INTERRUPT_BITS` for the second level and
620+
:kconfig:option:`CONFIG_3RD_LEVEL_INTERRUPT_BITS` for the third level. These masks control the
621621
length of the bit masks and shift to apply when generating interrupt values, when checking the
622622
interrupts level and converting interrupts to a different level. The logic controlling
623-
this can be found in `irq.h`
623+
this can be found in :file:`irq_multilevel.h`
624624

625625
Suggested Uses
626626
**************

0 commit comments

Comments
 (0)