diff mbox series

ACPI: irq: Fix some kernel-doc issues

Message ID 20221108014623.71622-1-wangxiongfeng2@huawei.com
State Accepted
Commit ebb92d58b90753e658059f5d8590d9048395491a
Headers show
Series ACPI: irq: Fix some kernel-doc issues | expand

Commit Message

Xiongfeng Wang Nov. 8, 2022, 1:46 a.m. UTC
The following commit change the second parameter of acpi_set_irq_model()
but forgot to update the function description. Let's fix it.

  commit 7327b16f5f56 ("APCI: irq: Add support for multiple GSI domains")

Also add description of parameter 'gsi' for
acpi_get_irq_source_fwhandle() to avoid the following build W=1 warning.

  drivers/acpi/irq.c:108: warning: Function parameter or member 'gsi' not described in 'acpi_get_irq_source_fwhandle'

Fixes: 7327b16f5f56 ("APCI: irq: Add support for multiple GSI domains")
Signed-off-by: Xiongfeng Wang <wangxiongfeng2@huawei.com>
---
 drivers/acpi/irq.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

Comments

Rafael J. Wysocki Nov. 10, 2022, 7:23 p.m. UTC | #1
On Tue, Nov 8, 2022 at 2:27 AM Xiongfeng Wang <wangxiongfeng2@huawei.com> wrote:
>
> The following commit change the second parameter of acpi_set_irq_model()
> but forgot to update the function description. Let's fix it.
>
>   commit 7327b16f5f56 ("APCI: irq: Add support for multiple GSI domains")
>
> Also add description of parameter 'gsi' for
> acpi_get_irq_source_fwhandle() to avoid the following build W=1 warning.
>
>   drivers/acpi/irq.c:108: warning: Function parameter or member 'gsi' not described in 'acpi_get_irq_source_fwhandle'
>
> Fixes: 7327b16f5f56 ("APCI: irq: Add support for multiple GSI domains")
> Signed-off-by: Xiongfeng Wang <wangxiongfeng2@huawei.com>

Applied as 6.2 material, thanks!

> ---
>  drivers/acpi/irq.c | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/drivers/acpi/irq.c b/drivers/acpi/irq.c
> index 1cc4647f78b8..c2c786eb95ab 100644
> --- a/drivers/acpi/irq.c
> +++ b/drivers/acpi/irq.c
> @@ -94,6 +94,7 @@ EXPORT_SYMBOL_GPL(acpi_unregister_gsi);
>  /**
>   * acpi_get_irq_source_fwhandle() - Retrieve fwhandle from IRQ resource source.
>   * @source: acpi_resource_source to use for the lookup.
> + * @gsi: GSI IRQ number
>   *
>   * Description:
>   * Retrieve the fwhandle of the device referenced by the given IRQ resource
> @@ -297,8 +298,8 @@ EXPORT_SYMBOL_GPL(acpi_irq_get);
>  /**
>   * acpi_set_irq_model - Setup the GSI irqdomain information
>   * @model: the value assigned to acpi_irq_model
> - * @fwnode: the irq_domain identifier for mapping and looking up
> - *          GSI interrupts
> + * @fn: a dispatcher function that will return the domain fwnode
> + *     for a given GSI
>   */
>  void __init acpi_set_irq_model(enum acpi_irq_model_id model,
>                                struct fwnode_handle *(*fn)(u32))
> --
> 2.20.1
>
diff mbox series

Patch

diff --git a/drivers/acpi/irq.c b/drivers/acpi/irq.c
index 1cc4647f78b8..c2c786eb95ab 100644
--- a/drivers/acpi/irq.c
+++ b/drivers/acpi/irq.c
@@ -94,6 +94,7 @@  EXPORT_SYMBOL_GPL(acpi_unregister_gsi);
 /**
  * acpi_get_irq_source_fwhandle() - Retrieve fwhandle from IRQ resource source.
  * @source: acpi_resource_source to use for the lookup.
+ * @gsi: GSI IRQ number
  *
  * Description:
  * Retrieve the fwhandle of the device referenced by the given IRQ resource
@@ -297,8 +298,8 @@  EXPORT_SYMBOL_GPL(acpi_irq_get);
 /**
  * acpi_set_irq_model - Setup the GSI irqdomain information
  * @model: the value assigned to acpi_irq_model
- * @fwnode: the irq_domain identifier for mapping and looking up
- *          GSI interrupts
+ * @fn: a dispatcher function that will return the domain fwnode
+ *	for a given GSI
  */
 void __init acpi_set_irq_model(enum acpi_irq_model_id model,
 			       struct fwnode_handle *(*fn)(u32))