linux.git/Documentation/core-api/irq, branch v6.16

irqdomain: Fix kernel-doc and add it to Documentation

2025-05-16T19:06:13+00:00

irqdomain.c's kernel-doc exists, but is not plugged into Documentation/
yet.

Before plugging it in, fix it first: irq_domain_get_irq_data() and
irq_domain_set_info() were documented twice. Identically, by both
definitions for CONFIG_IRQ_DOMAIN_HIERARCHY and !CONFIG_IRQ_DOMAIN_HIERARCHY.

Therefore, switch the second kernel-doc into an ordinary comment -- change
"/**" to simple "/*". This avoids sphinx's: WARNING: Duplicate C
declaration

Next, in commit b7b377332b96 ("irqdomain: Fix the kernel-doc and plug it
into Documentation"), irqdomain.h's (header) kernel-doc was added into
core-api/genericirq.rst. But given the amount of irqdomain functions and
structures, move all these to core-api/irq/irq-domain.rst now.

Finally, add these newly fixed irqdomain.c's (source) docs there as
well.

Signed-off-by: Jiri Slaby (SUSE) 
Signed-off-by: Thomas Gleixner 
Link: https://lore.kernel.org/all/20250319092951.37667-58-jirislaby@kernel.org

Documentation: irqdomain: Update it

2025-05-16T19:06:13+00:00

The irqdomain documentaion became obsolete over time. Update and extend
it a bit with respect to the current code and HW.

Most notably the doubled documentation of irq_domain (from .rst and .h)
was unified and let only in .rst. A reference link was added to .h.

Furthermore:
 * Add some 'struct' keywords, so that the respective structs are
   hyperlinked
 * :c:member: use where appropriate to mark a member of a struct
 * Rephrase some wording to improve readability/understanding

Signed-off-by: Jiri Slaby (SUSE) 
Signed-off-by: Thomas Gleixner 
Link: https://lore.kernel.org/all/20250319092951.37667-57-jirislaby@kernel.org

Documentation: irq-domain.rst: Simple improvements

2025-05-16T19:06:13+00:00

The improvements include:

  * Capitals in headlines.
  * Add commas: for easier reading, it is always desired to add commas
    at some places in text. Like before adverbs or after fronted
    sentences.
  * 3rd person -> add 's' to verbs.
  * End some sentences with period and start a new one. Avoid thus heavy
    sentences.

[ tglx: Fix up subject prefix ]

Signed-off-by: Jiri Slaby (SUSE) 
Signed-off-by: Thomas Gleixner 
Link: https://lore.kernel.org/all/20250319092951.37667-56-jirislaby@kernel.org

Documentation: irq/concepts: Minor improvements

2025-05-16T19:06:13+00:00

Just note in the docs:

 1) A PCI device as an example for shared interrupts
 2) A sparse tree can be used for interrupts too
 3) i8259s which have 8 pins

[ tglx: Fix up subject prefix ]

Signed-off-by: Jiri Slaby (SUSE) 
Signed-off-by: Thomas Gleixner 
Link: https://lore.kernel.org/all/20250319092951.37667-55-jirislaby@kernel.org

Documentation: irq/concepts: Add commas and reflow

2025-05-16T19:06:13+00:00

For easier reading, it is always desired to add commas at some places in
text. Like before adverbs or after fronted sentences.

[ tglx: Fix up subject prefix ]

Signed-off-by: Jiri Slaby (SUSE) 
Signed-off-by: Thomas Gleixner 
Link: https://lore.kernel.org/all/20250319092951.37667-54-jirislaby@kernel.org

irqdomain: Drop irq_linear_revmap()

2025-05-16T19:06:12+00:00

irq_linear_revmap() is deprecated and unused now. So remove it.

Signed-off-by: Jiri Slaby (SUSE) 
Signed-off-by: Thomas Gleixner 
Link: https://lore.kernel.org/all/20250319092951.37667-50-jirislaby@kernel.org

irqdomain: Drop irq_domain_add_*() functions

2025-05-16T19:06:11+00:00

Most irq_domain_add_*() functions are unused now, so drop them. The
remaining ones are moved to the deprecated section and will be removed
during the merge window after the patches in various trees have been
merged.

Note: The Chinese docs are touched but unfinished. I cannot parse those.

[ tglx: Remove the leftover in irq-domain.rst and handle merge logistics ]

Signed-off-by: Jiri Slaby (SUSE) 
Signed-off-by: Thomas Gleixner 
Link: https://lore.kernel.org/all/20250319092951.37667-41-jirislaby@kernel.org

powerpc: Switch irq_domain_add_nomap() to use fwnode

2025-05-16T19:06:11+00:00

All irq_domain_add_*() functions are going away. PowerPC is the only
user of irq_domain_add_nomap() and there is no irq_domain_create_nomap()
complement.

Therefore, to align with the rest of the kernel, rename
irq_domain_add_nomap() to irq_domain_create_nomap() and accept a
fwnode_handle instead of a device_node.

[ tglx: Fix up subject prefix ]

Signed-off-by: Jiri Slaby (SUSE) 
Signed-off-by: Thomas Gleixner 
Link: https://lore.kernel.org/all/20250319092951.37667-40-jirislaby@kernel.org

Documentation: irqdomain: Fix typo of "at least once"

2022-08-18T17:11:52+00:00

Signed-off-by: Eric Lin 
Link: https://lore.kernel.org/r/20220811091516.2107908-1-dslin1010@gmail.com
Signed-off-by: Jonathan Corbet

irq: remove handle_domain_{irq,nmi}()

2021-10-26T09:13:31+00:00

Now that entry code handles IRQ entry (including setting the IRQ regs)
before calling irqchip code, irqchip code can safely call
generic_handle_domain_irq(), and there's no functional reason for it to
call handle_domain_irq().

Let's cement this split of responsibility and remove handle_domain_irq()
entirely, updating irqchip drivers to call generic_handle_domain_irq().

For consistency, handle_domain_nmi() is similarly removed and replaced
with a generic_handle_domain_nmi() function which also does not perform
any entry logic.

Previously handle_domain_{irq,nmi}() had a WARN_ON() which would fire
when they were called in an inappropriate context. So that we can
identify similar issues going forward, similar WARN_ON_ONCE() logic is
added to the generic_handle_*() functions, and comments are updated for
clarity and consistency.

Signed-off-by: Mark Rutland 
Reviewed-by: Marc Zyngier 
Cc: Thomas Gleixner