Commit 2dc3d1e0 authored Nov 09, 2020 by Lee Jones Committed by Miquel Raynal Nov 20, 2020

mtd: onenand: Fix some kernel-doc misdemeanours

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>
Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
Link: https://lore.kernel.org/linux-mtd/20201109182206.3037326-23-lee.jones@linaro.org

parent b489681b

drivers/mtd/nand/onenand/onenand_base.c

+15 −21

Original line number	Diff line number	Diff line
		@@ -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,
		@@ -1959,10 +1959,7 @@ 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
		* @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
		*/
		@@ -2760,9 +2757,7 @@ 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
		* @ops: oob operation description structure
		*
		* OneNAND write out-of-band only for OTP
		*/
		@@ -3381,8 +3376,8 @@ static int onenand_check_maf(int manuf)

		/**
		* flexonenand_get_boundary - Reads the SLC boundary
		* @onenand_info: - onenand info structure
		**/
		* @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)

Admin message