| Message ID | 20240527161450.326615-10-herve.codina@bootlin.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Add support for the LAN966x PCI device using a DT overlay | expand |
On Mon, May 27 2024 at 18:14, Herve Codina wrote: > 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. Sigh. Why is such a cleanup burried in the middle of patch series which tries to add a network driver?
Mon, May 27, 2024 at 06:14:36PM +0200, Herve Codina kirjoitti: > 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. ... > /** > * 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 (kernel-doc perhaps will complain on something missing here) > */ > int irq_domain_translate_onecell(struct irq_domain *d, You can go further and run scripts/kernel-doc -v -none -Wall ... against this file and fix more issues, like I believe in the above excerpt.
Hi Andy, On Wed, 5 Jun 2024 23:02:30 +0300 Andy Shevchenko <andy.shevchenko@gmail.com> wrote: > Mon, May 27, 2024 at 06:14:36PM +0200, Herve Codina kirjoitti: > > 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. > > ... > > > /** > > * 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 > > (kernel-doc perhaps will complain on something missing here) > > > */ > > int irq_domain_translate_onecell(struct irq_domain *d, > > You can go further and run > > scripts/kernel-doc -v -none -Wall ... > > against this file and fix more issues, like I believe in the above excerpt. > Yes indeed, I missed the return values. Will be updated in the next iteration. Best regards, Hervé
On Thu, Jun 6, 2024 at 10:14 AM Herve Codina <herve.codina@bootlin.com> wrote: > On Wed, 5 Jun 2024 23:02:30 +0300 > Andy Shevchenko <andy.shevchenko@gmail.com> wrote: ... > Yes indeed, I missed the return values. > Will be updated in the next iteration. Note, Thomas already applied this version, so it should be just a follow up.
On Thu, 6 Jun 2024 11:46:25 +0300 Andy Shevchenko <andy.shevchenko@gmail.com> wrote: > On Thu, Jun 6, 2024 at 10:14 AM Herve Codina <herve.codina@bootlin.com> wrote: > > On Wed, 5 Jun 2024 23:02:30 +0300 > > Andy Shevchenko <andy.shevchenko@gmail.com> wrote: > > ... > > > Yes indeed, I missed the return values. > > Will be updated in the next iteration. > > Note, Thomas already applied this version, so it should be just a follow up. Indeed, I saw that. Thanks, Hervé
diff --git a/kernel/irq/irqdomain.c b/kernel/irq/irqdomain.c index aadc8891cc16..86f8b91b0d3a 100644 --- a/kernel/irq/irqdomain.c +++ b/kernel/irq/irqdomain.c @@ -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
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: Herve Codina <herve.codina@bootlin.com> --- kernel/irq/irqdomain.c | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+)