From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: linux-kernel@vger.kernel.org,
Kyungmin Park <kyungmin.park@samsung.com>,
Miquel Raynal <miquel.raynal@bootlin.com>,
Richard Weinberger <richard@nod.at>,
Vignesh Raghavendra <vigneshr@ti.com>,
linux-mtd@lists.infradead.org
Subject: [PATCH v3 22/23] mtd: onenand: Fix some kernel-doc misdemeanours
Date: Mon, 9 Nov 2020 18:22:05 +0000 [thread overview]
Message-ID: <20201109182206.3037326-23-lee.jones@linaro.org> (raw)
In-Reply-To: <20201109182206.3037326-1-lee.jones@linaro.org>
Fixes the following W=1 kernel build warning(s):
drivers/mtd/nand/onenand/onenand_base.c:140: warning: Function parameter or member 'mtd' not described in 'onenand_ooblayout_32_64_ecc'
drivers/mtd/nand/onenand/onenand_base.c:140: warning: Function parameter or member 'section' not described in 'onenand_ooblayout_32_64_ecc'
drivers/mtd/nand/onenand/onenand_base.c:140: warning: Function parameter or member 'oobregion' not described in 'onenand_ooblayout_32_64_ecc'
drivers/mtd/nand/onenand/onenand_base.c:1436: warning: bad line:
drivers/mtd/nand/onenand/onenand_base.c:1971: warning: Function parameter or member 'ops' not described in 'onenand_write_oob_nolock'
drivers/mtd/nand/onenand/onenand_base.c:1971: warning: Excess function parameter 'len' description in 'onenand_write_oob_nolock'
drivers/mtd/nand/onenand/onenand_base.c:1971: warning: Excess function parameter 'retlen' description in 'onenand_write_oob_nolock'
drivers/mtd/nand/onenand/onenand_base.c:1971: warning: Excess function parameter 'buf' description in 'onenand_write_oob_nolock'
drivers/mtd/nand/onenand/onenand_base.c:1971: warning: Excess function parameter 'mode' description in 'onenand_write_oob_nolock'
drivers/mtd/nand/onenand/onenand_base.c:2156: warning: Function parameter or member 'block_size' not described in 'onenand_multiblock_erase'
drivers/mtd/nand/onenand/onenand_base.c:2156: warning: Excess function parameter 'region' description in 'onenand_multiblock_erase'
drivers/mtd/nand/onenand/onenand_base.c:2771: warning: Function parameter or member 'ops' not described in 'onenand_otp_write_oob_nolock'
drivers/mtd/nand/onenand/onenand_base.c:2771: warning: Excess function parameter 'len' description in 'onenand_otp_write_oob_nolock'
drivers/mtd/nand/onenand/onenand_base.c:2771: warning: Excess function parameter 'retlen' description in 'onenand_otp_write_oob_nolock'
drivers/mtd/nand/onenand/onenand_base.c:2771: warning: Excess function parameter 'buf' description in 'onenand_otp_write_oob_nolock'
drivers/mtd/nand/onenand/onenand_base.c:3387: warning: Function parameter or member 'mtd' not described in 'flexonenand_get_boundary'
drivers/mtd/nand/onenand/onenand_base.c:3387: warning: Excess function parameter 'onenand_info' description in 'flexonenand_get_boundary'
drivers/mtd/nand/onenand/onenand_base.c:3509: warning: Function parameter or member 'mtd' not described in 'flexonenand_check_blocks_erased'
drivers/mtd/nand/onenand/onenand_base.c:3509: warning: Excess function parameter 'mtd_info' description in 'flexonenand_check_blocks_erased'
drivers/mtd/nand/onenand/onenand_base.c:3557: warning: Function parameter or member 'die' not described in 'flexonenand_set_boundary'
drivers/mtd/nand/onenand/onenand_base.c:3557: warning: Function parameter or member 'boundary' not described in 'flexonenand_set_boundary'
drivers/mtd/nand/onenand/onenand_base.c:3557: warning: Function parameter or member 'lock' not described in 'flexonenand_set_boundary'
Cc: Kyungmin Park <kyungmin.park@samsung.com>
Cc: Miquel Raynal <miquel.raynal@bootlin.com>
Cc: Richard Weinberger <richard@nod.at>
Cc: Vignesh Raghavendra <vigneshr@ti.com>
Cc: linux-mtd@lists.infradead.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/mtd/nand/onenand/onenand_base.c | 36 +++++++++++--------------
1 file changed, 15 insertions(+), 21 deletions(-)
diff --git a/drivers/mtd/nand/onenand/onenand_base.c b/drivers/mtd/nand/onenand/onenand_base.c
index 9fca3988ee236..a9fdea26ea464 100644
--- a/drivers/mtd/nand/onenand/onenand_base.c
+++ b/drivers/mtd/nand/onenand/onenand_base.c
@@ -132,7 +132,7 @@ static const struct mtd_ooblayout_ops onenand_oob_128_ooblayout_ops = {
.free = onenand_ooblayout_128_free,
};
-/**
+/*
* onenand_oob_32_64 - oob info for large (2KB) page
*/
static int onenand_ooblayout_32_64_ecc(struct mtd_info *mtd, int section,
@@ -271,7 +271,7 @@ static int onenand_page_address(int page, int sector)
* @dataram1: DataRAM index
* @sectors: the sector address
* @count: the number of sectors
- * @return the start buffer value
+ * Return: the start buffer value
*
* Setup Start Buffer Register (F200h)
*/
@@ -1433,7 +1433,7 @@ static int onenand_read_oob_nolock(struct mtd_info *mtd, loff_t from,
* @mtd: MTD device structure
* @from: offset to read from
* @ops: oob operation description structure
-
+ *
* Read main and/or out-of-band
*/
static int onenand_read_oob(struct mtd_info *mtd, loff_t from,
@@ -1958,11 +1958,8 @@ static int onenand_write_ops_nolock(struct mtd_info *mtd, loff_t to,
/**
* onenand_write_oob_nolock - [INTERN] OneNAND write out-of-band
* @mtd: MTD device structure
- * @to: offset to write to
- * @len: number of bytes to write
- * @retlen: pointer to variable to store the number of written bytes
- * @buf: the data to write
- * @mode: operation mode
+ * @to: offset to write to
+ * @ops: oob operation description structure
*
* OneNAND write out-of-band
*/
@@ -2146,7 +2143,7 @@ static int onenand_multiblock_erase_verify(struct mtd_info *mtd,
* onenand_multiblock_erase - [INTERN] erase block(s) using multiblock erase
* @mtd: MTD device structure
* @instr: erase instruction
- * @region: erase region
+ * @block_size: block size
*
* Erase one or more blocks up to 64 block at a time
*/
@@ -2759,10 +2756,8 @@ static int onenand_otp_command(struct mtd_info *mtd, int cmd, loff_t addr,
/**
* onenand_otp_write_oob_nolock - [INTERN] OneNAND write out-of-band, specific to OTP
* @mtd: MTD device structure
- * @to: offset to write to
- * @len: number of bytes to write
- * @retlen: pointer to variable to store the number of written bytes
- * @buf: the data to write
+ * @to: offset to write to
+ * @ops: oob operation description structure
*
* OneNAND write out-of-band only for OTP
*/
@@ -3380,9 +3375,9 @@ static int onenand_check_maf(int manuf)
}
/**
-* flexonenand_get_boundary - Reads the SLC boundary
-* @onenand_info: - onenand info structure
-**/
+ * flexonenand_get_boundary - Reads the SLC boundary
+ * @mtd: MTD data structure
+ */
static int flexonenand_get_boundary(struct mtd_info *mtd)
{
struct onenand_chip *this = mtd->priv;
@@ -3493,9 +3488,9 @@ static void flexonenand_get_size(struct mtd_info *mtd)
/**
* flexonenand_check_blocks_erased - Check if blocks are erased
- * @mtd_info: - mtd info structure
- * @start: - first erase block to check
- * @end: - last erase block to check
+ * @mtd: mtd info structure
+ * @start: first erase block to check
+ * @end: last erase block to check
*
* Converting an unerased block from MLC to SLC
* causes byte values to change. Since both data and its ECC
@@ -3548,9 +3543,8 @@ static int flexonenand_check_blocks_erased(struct mtd_info *mtd, int start, int
return 0;
}
-/**
+/*
* flexonenand_set_boundary - Writes the SLC boundary
- * @mtd: - mtd info structure
*/
static int flexonenand_set_boundary(struct mtd_info *mtd, int die,
int boundary, int lock)
--
2.25.1
next prev parent reply other threads:[~2020-11-09 18:23 UTC|newest]
Thread overview: 49+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-09 18:21 [PATCH v3 00/23] Rid W=1 warnings in MTD Lee Jones
2020-11-09 18:21 ` [PATCH v3 01/23] mtd: mtdpart: Fix misdocumented function parameter 'mtd' Lee Jones
2020-11-19 21:11 ` Miquel Raynal
2020-11-09 18:21 ` [PATCH v3 02/23] mtd: devices: phram: File headers are not good candidates for kernel-doc Lee Jones
2020-11-19 21:11 ` Miquel Raynal
2020-11-09 18:21 ` [PATCH v3 03/23] mtd: onenand: onenand_base: Fix expected kernel-doc formatting Lee Jones
2020-11-19 21:11 ` Miquel Raynal
2020-11-09 18:21 ` [PATCH v3 04/23] mtd: devices: docg3: Fix kernel-doc 'bad line' and 'excessive doc' issues Lee Jones
2020-11-19 21:11 ` Miquel Raynal
2020-11-09 18:21 ` [PATCH v3 05/23] mtd: Fix misspelled function parameter 'section' Lee Jones
2020-11-19 21:10 ` Miquel Raynal
2020-11-09 18:21 ` [PATCH v3 06/23] mtd: onenand: onenand_bbt: Fix expected kernel-doc formatting Lee Jones
2020-11-19 21:10 ` Miquel Raynal
2020-11-09 18:21 ` [PATCH v3 07/23] mtd: spi-nor: hisi-sfc: Demote non-conformant kernel-doc Lee Jones
2020-11-19 21:10 ` Miquel Raynal
2020-11-09 18:21 ` [PATCH v3 08/23] mtd: ubi: build: Document 'ubi_num' in struct mtd_dev_param Lee Jones
2020-11-19 21:09 ` Miquel Raynal
2020-11-09 18:21 ` [PATCH v3 09/23] mtd: spinand: toshiba: Demote non-conformant kernel-doc header Lee Jones
2020-11-19 21:09 ` Miquel Raynal
2020-11-09 18:21 ` [PATCH v3 10/23] mtd: ubi: kapi: Correct documentation for 'ubi_leb_read_sg's 'sgl' parameter Lee Jones
2020-11-19 21:09 ` Miquel Raynal
2020-11-09 18:21 ` [PATCH v3 11/23] mtd: ubi: eba: Fix a couple of misdocumentation issues Lee Jones
2020-11-19 21:09 ` Miquel Raynal
2020-11-09 18:21 ` [PATCH v3 12/23] mtd: ubi: wl: Fix a couple of kernel-doc issues Lee Jones
2020-11-19 21:09 ` Miquel Raynal
2020-11-09 18:21 ` [PATCH v3 13/23] mtd: rawnand: brcmnand: Demote non-conformant kernel-doc headers Lee Jones
2020-11-19 21:08 ` Miquel Raynal
2020-11-09 18:21 ` [PATCH v3 14/23] mtd: ubi: gluebi: Fix misnamed function parameter documentation Lee Jones
2020-11-19 21:08 ` Miquel Raynal
2020-11-09 18:21 ` [PATCH v3 15/23] mtd: rawnand: diskonchip: Marking unused variables as __always_unused Lee Jones
2020-11-19 21:08 ` Miquel Raynal
2020-11-09 18:21 ` [PATCH v3 16/23] mtd: rawnand: cafe_nand: Remove superfluous param doc and add another Lee Jones
2020-11-19 21:08 ` Miquel Raynal
2020-11-09 18:22 ` [PATCH v3 17/23] mtd: rawnand: s3c2410: Add documentation for 2 missing struct members Lee Jones
2020-11-19 21:08 ` Miquel Raynal
2020-11-09 18:22 ` [PATCH v3 18/23] mtd: rawnand: omap_elm: Finish half populated function header, demote empty ones Lee Jones
2020-11-19 21:07 ` Miquel Raynal
2020-11-09 18:22 ` [PATCH v3 19/23] mtd: rawnand: omap2: Fix a bunch of kernel-doc misdemeanours Lee Jones
2020-11-19 21:07 ` Miquel Raynal
2020-11-09 18:22 ` [PATCH v3 20/23] mtd: rawnand: sunxi: Document 'sunxi_nfc's 'caps' member Lee Jones
2020-11-19 21:07 ` Miquel Raynal
2020-11-09 18:22 ` [PATCH v3 21/23] mtd: rawnand: arasan: Document 'anfc_op's 'buf' member Lee Jones
2020-11-19 21:07 ` Miquel Raynal
2020-11-09 18:22 ` Lee Jones [this message]
2020-11-19 21:07 ` [PATCH v3 22/23] mtd: onenand: Fix some kernel-doc misdemeanours Miquel Raynal
2020-11-09 18:22 ` [PATCH v3 23/23] mtd: devices: powernv_flash: Add function names to headers and fix 'dev' Lee Jones
2020-11-19 21:07 ` Miquel Raynal
2020-11-20 7:50 ` Lee Jones
2020-11-20 11:42 ` Miquel Raynal
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=20201109182206.3037326-23-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=kyungmin.park@samsung.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mtd@lists.infradead.org \
--cc=miquel.raynal@bootlin.com \
--cc=richard@nod.at \
--cc=vigneshr@ti.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 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).