Commit b4dc049e authored by Herve Codina's avatar Herve Codina Committed by Thomas Gleixner
Browse files

irqdomain: Add missing parameter descriptions in kernel-doc comments 



During compilation, several warning of the following form were raised:
  Function parameter or struct member 'x' not described in 'yyy'

Add the missing function parameter descriptions.

Signed-off-by: default avatarHerve Codina <herve.codina@bootlin.com>
Signed-off-by: default avatarThomas Gleixner <tglx@linutronix.de>
Link: https://lore.kernel.org/r/20240527161450.326615-10-herve.codina@bootlin.com
parent cb06c982

kernel/irq/irqdomain.c

+27 −0
Original line number Diff line number Diff line
@@ -111,6 +111,7 @@ EXPORT_SYMBOL_GPL(__irq_domain_alloc_fwnode); 


/**

 * irq_domain_free_fwnode - Free a non-OF-backed fwnode_handle

 * @fwnode: fwnode_handle to free

 *

 * Free a fwnode_handle allocated with irq_domain_alloc_fwnode.

 */
@@ -982,6 +983,12 @@ EXPORT_SYMBOL_GPL(__irq_resolve_mapping); 


/**

 * irq_domain_xlate_onecell() - Generic xlate for direct one cell bindings

 * @d:		Interrupt domain involved in the translation

 * @ctrlr:	The device tree node for the device whose interrupt is translated

 * @intspec:	The interrupt specifier data from the device tree

 * @intsize:	The number of entries in @intspec

 * @out_hwirq:	Pointer to storage for the hardware interrupt number

 * @out_type:	Pointer to storage for the interrupt type

 *

 * Device Tree IRQ specifier translation function which works with one cell

 * bindings where the cell value maps directly to the hwirq number.
@@ -1000,6 +1007,12 @@ EXPORT_SYMBOL_GPL(irq_domain_xlate_onecell); 


/**

 * irq_domain_xlate_twocell() - Generic xlate for direct two cell bindings

 * @d:		Interrupt domain involved in the translation

 * @ctrlr:	The device tree node for the device whose interrupt is translated

 * @intspec:	The interrupt specifier data from the device tree

 * @intsize:	The number of entries in @intspec

 * @out_hwirq:	Pointer to storage for the hardware interrupt number

 * @out_type:	Pointer to storage for the interrupt type

 *

 * Device Tree IRQ specifier translation function which works with two cell

 * bindings where the cell values map directly to the hwirq number
@@ -1018,6 +1031,12 @@ EXPORT_SYMBOL_GPL(irq_domain_xlate_twocell); 


/**

 * irq_domain_xlate_onetwocell() - Generic xlate for one or two cell bindings

 * @d:		Interrupt domain involved in the translation

 * @ctrlr:	The device tree node for the device whose interrupt is translated

 * @intspec:	The interrupt specifier data from the device tree

 * @intsize:	The number of entries in @intspec

 * @out_hwirq:	Pointer to storage for the hardware interrupt number

 * @out_type:	Pointer to storage for the interrupt type

 *

 * Device Tree IRQ specifier translation function which works with either one

 * or two cell bindings where the cell values map directly to the hwirq number
@@ -1051,6 +1070,10 @@ EXPORT_SYMBOL_GPL(irq_domain_simple_ops); 
/**

 * irq_domain_translate_onecell() - Generic translate for direct one cell

 * bindings

 * @d:		Interrupt domain involved in the translation

 * @fwspec:	The firmware interrupt specifier to translate

 * @out_hwirq:	Pointer to storage for the hardware interrupt number

 * @out_type:	Pointer to storage for the interrupt type

 */

int irq_domain_translate_onecell(struct irq_domain *d,

				 struct irq_fwspec *fwspec,
@@ -1068,6 +1091,10 @@ EXPORT_SYMBOL_GPL(irq_domain_translate_onecell); 
/**

 * irq_domain_translate_twocell() - Generic translate for direct two cell

 * bindings

 * @d:		Interrupt domain involved in the translation

 * @fwspec:	The firmware interrupt specifier to translate

 * @out_hwirq:	Pointer to storage for the hardware interrupt number

 * @out_type:	Pointer to storage for the interrupt type

 *

 * Device Tree IRQ specifier translation function which works with two cell

 * bindings where the cell values map directly to the hwirq number