All of lore.kernel.org
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org, Stuart Yoder <stuyoder@gmail.com>,
	Laurentiu Tudor <laurentiu.tudor@nxp.com>,
	German Rivera <German.Rivera@freescale.com>
Subject: [PATCH 05/10] bus: fsl-mc: dprc-driver: Fix some missing/incorrect function parameter descriptions
Date: Wed, 26 May 2021 09:10:33 +0100	[thread overview]
Message-ID: <20210526081038.544942-6-lee.jones@linaro.org> (raw)
In-Reply-To: <20210526081038.544942-1-lee.jones@linaro.org>

Fixes the following W=1 kernel build warning(s):

 drivers/bus/fsl-mc/dprc-driver.c:360: warning: Function parameter or member 'alloc_interrupts' not described in 'dprc_scan_container'
 drivers/bus/fsl-mc/dprc-driver.c:383: warning: Function parameter or member 'irq_num' not described in 'dprc_irq0_handler'
 drivers/bus/fsl-mc/dprc-driver.c:383: warning: Excess function parameter 'irq' description in 'dprc_irq0_handler'
 drivers/bus/fsl-mc/dprc-driver.c:394: warning: Function parameter or member 'irq_num' not described in 'dprc_irq0_handler_thread'
 drivers/bus/fsl-mc/dprc-driver.c:394: warning: Excess function parameter 'irq' description in 'dprc_irq0_handler_thread'

Cc: Stuart Yoder <stuyoder@gmail.com>
Cc: Laurentiu Tudor <laurentiu.tudor@nxp.com>
Cc: German Rivera <German.Rivera@freescale.com>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/bus/fsl-mc/dprc-driver.c | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/drivers/bus/fsl-mc/dprc-driver.c b/drivers/bus/fsl-mc/dprc-driver.c
index e3e2ae41c22b3..315e830b6ecda 100644
--- a/drivers/bus/fsl-mc/dprc-driver.c
+++ b/drivers/bus/fsl-mc/dprc-driver.c
@@ -350,7 +350,8 @@ int dprc_scan_objects(struct fsl_mc_device *mc_bus_dev,
  * dprc_scan_container - Scans a physical DPRC and synchronizes Linux bus state
  *
  * @mc_bus_dev: pointer to the fsl-mc device that represents a DPRC object
- *
+ * @alloc_interrupts: if true the function allocates the interrupt pool,
+ *                    otherwise the interrupt allocation is delayed
  * Scans the physical DPRC and synchronizes the state of the Linux
  * bus driver with the actual state of the MC by adding and removing
  * devices as appropriate.
@@ -373,10 +374,11 @@ int dprc_scan_container(struct fsl_mc_device *mc_bus_dev,
 	return error;
 }
 EXPORT_SYMBOL_GPL(dprc_scan_container);
+
 /**
  * dprc_irq0_handler - Regular ISR for DPRC interrupt 0
  *
- * @irq: IRQ number of the interrupt being handled
+ * @irq_num: IRQ number of the interrupt being handled
  * @arg: Pointer to device structure
  */
 static irqreturn_t dprc_irq0_handler(int irq_num, void *arg)
@@ -387,7 +389,7 @@ static irqreturn_t dprc_irq0_handler(int irq_num, void *arg)
 /**
  * dprc_irq0_handler_thread - Handler thread function for DPRC interrupt 0
  *
- * @irq: IRQ number of the interrupt being handled
+ * @irq_num: IRQ number of the interrupt being handled
  * @arg: Pointer to device structure
  */
 static irqreturn_t dprc_irq0_handler_thread(int irq_num, void *arg)
-- 
2.31.1


  parent reply	other threads:[~2021-05-26  8:11 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-05-26  8:10 [PATCH 00/10] Rid W=1 warnings from Bus Lee Jones
2021-05-26  8:10 ` [PATCH 01/10] bus: fsl-mc: mc-io: Supply function names for 'fsl_create_mc_io()' and 'fsl_destroy_mc_io()' Lee Jones
2021-05-26  8:10 ` [PATCH 02/10] bus: fsl-mc: mc-sys: Supply missing function names in kernel-doc headers Lee Jones
2021-05-26  8:10 ` [PATCH 03/10] bus: fsl-mc: fsl-mc-bus: Demote a bunch of non-conformant kernel-doc headers and help others Lee Jones
2021-05-26  8:10 ` [PATCH 04/10] bus: fsl-mc: dprc: Fix a couple of misspelling and formatting issues Lee Jones
2021-05-26  8:10 ` Lee Jones [this message]
2021-05-26  8:10 ` [PATCH 06/10] bus: fsl-mc: fsl-mc-allocator: Fix misspelling of 'new_mc_adev' and demote non-kernel-doc headers Lee Jones
2021-05-26  8:10 ` [PATCH 07/10] bus: qcom-ebi2: Fix incorrect documentation for '{slow,fast}_cfg' Lee Jones
2021-05-26 22:33   ` Linus Walleij
2021-05-27  2:22   ` Bjorn Andersson
2021-05-26  8:10 ` [PATCH 08/10] bus: fsl-mc-msi: Fix a little doc-rot pertaining to 'np' to 'fwnode' conversion Lee Jones
2021-05-26  8:10 ` [PATCH 09/10] bus: ti-sysc: Correct misdocumentation of 'sysc_ioremap()' Lee Jones
2021-06-11  7:21   ` Tony Lindgren
2021-05-26  8:10 ` [PATCH 10/10] bus: fsl-mc: mc-io: Correct misdocumentation of 'dpmcp_dev' param Lee Jones
2021-05-26 12:19 ` [PATCH 00/10] Rid W=1 warnings from Bus Laurentiu Tudor
2021-06-17  9:49   ` Lee Jones
2021-06-17 10:11     ` Laurentiu Tudor
2021-06-17 10:57       ` Greg KH

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20210526081038.544942-6-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=German.Rivera@freescale.com \
    --cc=laurentiu.tudor@nxp.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=stuyoder@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.