Commit 8fed6e0a authored by Lee Jones's avatar Lee Jones Committed by Miquel Raynal
Browse files

mtd: onenand: onenand_bbt: Fix expected kernel-doc formatting 



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

 drivers/mtd/nand/onenand/onenand_bbt.c:33: warning: Function parameter or member 'buf' not described in 'check_short_pattern'
 drivers/mtd/nand/onenand/onenand_bbt.c:33: warning: Function parameter or member 'len' not described in 'check_short_pattern'
 drivers/mtd/nand/onenand/onenand_bbt.c:33: warning: Function parameter or member 'paglen' not described in 'check_short_pattern'
 drivers/mtd/nand/onenand/onenand_bbt.c:33: warning: Function parameter or member 'td' not described in 'check_short_pattern'
 drivers/mtd/nand/onenand/onenand_bbt.c:57: warning: Function parameter or member 'mtd' not described in 'create_bbt'
 drivers/mtd/nand/onenand/onenand_bbt.c:57: warning: Function parameter or member 'buf' not described in 'create_bbt'
 drivers/mtd/nand/onenand/onenand_bbt.c:57: warning: Function parameter or member 'bd' not described in 'create_bbt'
 drivers/mtd/nand/onenand/onenand_bbt.c:57: warning: Function parameter or member 'chip' not described in 'create_bbt'
 drivers/mtd/nand/onenand/onenand_bbt.c:132: warning: Function parameter or member 'mtd' not described in 'onenand_memory_bbt'
 drivers/mtd/nand/onenand/onenand_bbt.c:132: warning: Function parameter or member 'bd' not described in 'onenand_memory_bbt'
 drivers/mtd/nand/onenand/onenand_bbt.c:145: warning: Function parameter or member 'mtd' not described in 'onenand_isbad_bbt'
 drivers/mtd/nand/onenand/onenand_bbt.c:145: warning: Function parameter or member 'offs' not described in 'onenand_isbad_bbt'
 drivers/mtd/nand/onenand/onenand_bbt.c:145: warning: Function parameter or member 'allowbbt' not described in 'onenand_isbad_bbt'
 drivers/mtd/nand/onenand/onenand_bbt.c:182: warning: Function parameter or member 'mtd' not described in 'onenand_scan_bbt'
 drivers/mtd/nand/onenand/onenand_bbt.c:182: warning: Function parameter or member 'bd' not described in 'onenand_scan_bbt'
 drivers/mtd/nand/onenand/onenand_bbt.c:230: warning: Function parameter or member 'mtd' not described in 'onenand_default_bbt'

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: default avatarLee Jones <lee.jones@linaro.org>
Signed-off-by: default avatarMiquel Raynal <miquel.raynal@bootlin.com>
Link: https://lore.kernel.org/linux-mtd/20201109182206.3037326-7-lee.jones@linaro.org
parent 6361f536

drivers/mtd/nand/onenand/onenand_bbt.c

+16 −16
Original line number Diff line number Diff line
@@ -18,10 +18,10 @@ 


/**

 * check_short_pattern - [GENERIC] check if a pattern is in the buffer

 * @param buf		the buffer to search

 * @param len		the length of buffer to search

 * @param paglen	the pagelength

 * @param td		search pattern descriptor

 * @buf:		the buffer to search

 * @len:		the length of buffer to search

 * @paglen:	the pagelength

 * @td:		search pattern descriptor

 *

 * Check for a pattern at the given place. Used to search bad block

 * tables and good / bad block identifiers. Same as check_pattern, but
@@ -44,10 +44,10 @@ static int check_short_pattern(uint8_t *buf, int len, int paglen, struct nand_bb 


/**

 * create_bbt - [GENERIC] Create a bad block table by scanning the device

 * @param mtd		MTD device structure

 * @param buf		temporary buffer

 * @param bd		descriptor for the good/bad block search pattern

 * @param chip		create the table for a specific chip, -1 read all chips.

 * @mtd:		MTD device structure

 * @buf:		temporary buffer

 * @bd:		descriptor for the good/bad block search pattern

 * @chip:		create the table for a specific chip, -1 read all chips.

 *              Applies only if NAND_BBT_PERCHIP option is set

 *

 * Create a bad block table by scanning the device
@@ -122,8 +122,8 @@ static int create_bbt(struct mtd_info *mtd, uint8_t *buf, struct nand_bbt_descr 


/**

 * onenand_memory_bbt - [GENERIC] create a memory based bad block table

 * @param mtd		MTD device structure

 * @param bd		descriptor for the good/bad block search pattern

 * @mtd:		MTD device structure

 * @bd:		descriptor for the good/bad block search pattern

 *

 * The function creates a memory based bbt by scanning the device

 * for manufacturer / software marked good / bad blocks
@@ -137,9 +137,9 @@ static inline int onenand_memory_bbt (struct mtd_info *mtd, struct nand_bbt_desc 


/**

 * onenand_isbad_bbt - [OneNAND Interface] Check if a block is bad

 * @param mtd		MTD device structure

 * @param offs		offset in the device

 * @param allowbbt	allow access to bad block table region

 * @mtd:		MTD device structure

 * @offs:		offset in the device

 * @allowbbt:	allow access to bad block table region

 */

static int onenand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt)

{
@@ -166,8 +166,8 @@ static int onenand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt) 


/**

 * onenand_scan_bbt - [OneNAND Interface] scan, find, read and maybe create bad block table(s)

 * @param mtd		MTD device structure

 * @param bd		descriptor for the good/bad block search pattern

 * @mtd:		MTD device structure

 * @bd:		descriptor for the good/bad block search pattern

 *

 * The function checks, if a bad block table(s) is/are already

 * available. If not it scans the device for manufacturer
@@ -221,7 +221,7 @@ static struct nand_bbt_descr largepage_memorybased = { 


/**

 * onenand_default_bbt - [OneNAND Interface] Select a default bad block table for the device

 * @param mtd		MTD device structure

 * @mtd:		MTD device structure

 *

 * This function selects the default bad block table

 * support for the device and calls the onenand_scan_bbt function