linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-arm-kernel@lists.infradead.org,
	linux-kernel@vger.kernel.org, stable@vger.kernel.org
Subject: [PATCH 02/10] mfd: mfd-core: Complete kerneldoc header for devm_mfd_add_devices()
Date: Thu, 25 Jun 2020 07:46:11 +0100	[thread overview]
Message-ID: <20200625064619.2775707-3-lee.jones@linaro.org> (raw)
In-Reply-To: <20200625064619.2775707-1-lee.jones@linaro.org>

Each function parameter should be documented in kerneldoc format.

Squashes the following W=1 warnings:

 drivers/mfd/mfd-core.c:326: warning: Function parameter or member 'dev' not described in 'devm_mfd_add_devices'
 drivers/mfd/mfd-core.c:326: warning: Function parameter or member 'id' not described in 'devm_mfd_add_devices'
 drivers/mfd/mfd-core.c:326: warning: Function parameter or member 'cells' not described in 'devm_mfd_add_devices'
 drivers/mfd/mfd-core.c:326: warning: Function parameter or member 'n_devs' not described in 'devm_mfd_add_devices'
 drivers/mfd/mfd-core.c:326: warning: Function parameter or member 'mem_base' not described in 'devm_mfd_add_devices'
 drivers/mfd/mfd-core.c:326: warning: Function parameter or member 'irq_base' not described in 'devm_mfd_add_devices'
 drivers/mfd/mfd-core.c:326: warning: Function parameter or member 'domain' not described in 'devm_mfd_add_devices'

Cc: <stable@vger.kernel.org>
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/mfd/mfd-core.c | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/drivers/mfd/mfd-core.c b/drivers/mfd/mfd-core.c
index f5a73af60dd40..720e5c8b1588c 100644
--- a/drivers/mfd/mfd-core.c
+++ b/drivers/mfd/mfd-core.c
@@ -318,6 +318,16 @@ static void devm_mfd_dev_release(struct device *dev, void *res)
  * Returns 0 on success or an appropriate negative error number on failure.
  * All child-devices of the MFD will automatically be removed when it gets
  * unbinded.
+ *
+ * @dev:	Pointer to parent device.
+ * @id:		Can be PLATFORM_DEVID_AUTO to let the Platform API take care
+ *		of device numbering, or will be added to a device's cell_id.
+ * @cells:	Array of (struct mfd_cell)s describing child devices.
+ * @n_devs:	Number of child devices to register.
+ * @mem_base:	Parent register range resource for child devices.
+ * @irq_base:	Base of the range of virtual interrupt numbers allocated for
+ *		this MFD device. Unused if @domain is specified.
+ * @domain:	Interrupt domain to create mappings for hardware interrupts.
  */
 int devm_mfd_add_devices(struct device *dev, int id,
 			 const struct mfd_cell *cells, int n_devs,
-- 
2.25.1


  parent reply	other threads:[~2020-06-25  6:47 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-06-25  6:46 [PATCH 00/10] Fix a bunch more W=1 warnings in MFD Lee Jones
2020-06-25  6:46 ` [PATCH 01/10] mfd: wm8350-core: Supply description wm8350_reg_{un}lock args Lee Jones
2020-06-25  6:56   ` Greg KH
2020-06-25  7:13     ` Lee Jones
2020-06-25  9:45       ` Greg KH
2020-06-25 13:34         ` Lee Jones
2020-06-25 13:24       ` Jonathan Corbet
2020-06-25 13:38         ` Lee Jones
2020-06-25  6:46 ` Lee Jones [this message]
2020-07-01 19:33   ` [PATCH 02/10] mfd: mfd-core: Complete kerneldoc header for devm_mfd_add_devices() Sasha Levin
2020-07-02  6:36     ` Lee Jones
2020-07-10 14:02   ` Sasha Levin
2020-06-25  6:46 ` [PATCH 03/10] mfd: db8500-prcmu: Add description for 'reset_reason' in kerneldoc Lee Jones
2020-07-07 12:39   ` Linus Walleij
2020-06-25  6:46 ` [PATCH 04/10] mfd: db8500-prcmu: Remove incorrect function header from .probe() function Lee Jones
2020-07-07 12:39   ` Linus Walleij
2020-06-25  6:46 ` [PATCH 05/10] mfd: omap-usb-host: Remove invalid use of kerneldoc syntax Lee Jones
2020-06-25  6:46 ` [PATCH 06/10] mfd: omap-usb-host: Provide description for 'pdev' argument to .probe() Lee Jones
2020-06-25  6:46 ` [PATCH 07/10] mfd: omap-usb-tll: " Lee Jones
2020-06-25  6:46 ` [PATCH 08/10] mfd: atmel-smc: Silence comparison of unsigned expression < 0 is always false warning (W=1) Lee Jones
2020-06-26 20:56   ` Alexandre Belloni
2020-06-30 12:10     ` Lee Jones
2020-06-25  6:46 ` [PATCH 09/10] mfd: atmel-smc: Add missing colon(s) for 'conf' arguments Lee Jones
2020-06-25  6:55   ` Greg KH
2020-06-26 20:56   ` Alexandre Belloni
2020-07-01 19:33   ` Sasha Levin
2020-07-02  6:36     ` Lee Jones
2020-07-10 14:02   ` Sasha Levin
2020-06-25  6:46 ` [PATCH 10/10] mfd: altera-sysmgr: Supply descriptions for 'np' and 'property' function args Lee Jones
2020-07-01 19:33   ` Sasha Levin
2020-07-02  6:35     ` Lee Jones
2020-07-10 14:02   ` Sasha Levin

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=20200625064619.2775707-3-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=stable@vger.kernel.org \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).