Commit 2425a57b authored by Lee Jones's avatar Lee Jones Committed by Miquel Raynal
Browse files

mtd: rawnand: omap2: Fix a bunch of kernel-doc misdemeanours 



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

 drivers/mtd/nand/raw/omap2.c:191: warning: Function parameter or member 'info' not described in 'omap_prefetch_enable'
 drivers/mtd/nand/raw/omap2.c:221: warning: Function parameter or member 'cs' not described in 'omap_prefetch_reset'
 drivers/mtd/nand/raw/omap2.c:221: warning: Function parameter or member 'info' not described in 'omap_prefetch_reset'
 drivers/mtd/nand/raw/omap2.c:946: warning: Function parameter or member 'chip' not described in 'omap_enable_hwecc'
 drivers/mtd/nand/raw/omap2.c:946: warning: Excess function parameter 'mtd' description in 'omap_enable_hwecc'
 drivers/mtd/nand/raw/omap2.c:1017: warning: Function parameter or member 'chip' not described in 'omap_dev_ready'
 drivers/mtd/nand/raw/omap2.c:1017: warning: Excess function parameter 'mtd' description in 'omap_dev_ready'
 drivers/mtd/nand/raw/omap2.c:1036: warning: Function parameter or member 'chip' not described in 'omap_enable_hwecc_bch'
 drivers/mtd/nand/raw/omap2.c:1036: warning: Excess function parameter 'mtd' description in 'omap_enable_hwecc_bch'
 drivers/mtd/nand/raw/omap2.c:1142: warning: Function parameter or member 'ecc_calc' not described in '_omap_calculate_ecc_bch'
 drivers/mtd/nand/raw/omap2.c:1142: warning: Excess function parameter 'ecc_code' description in '_omap_calculate_ecc_bch'
 drivers/mtd/nand/raw/omap2.c:1270: warning: Function parameter or member 'ecc_calc' not described in 'omap_calculate_ecc_bch_sw'
 drivers/mtd/nand/raw/omap2.c:1270: warning: Excess function parameter 'ecc_code' description in 'omap_calculate_ecc_bch_sw'
 drivers/mtd/nand/raw/omap2.c:1284: warning: Function parameter or member 'ecc_calc' not described in 'omap_calculate_ecc_bch_multi'
 drivers/mtd/nand/raw/omap2.c:1284: warning: Excess function parameter 'ecc_code' description in 'omap_calculate_ecc_bch_multi'
 drivers/mtd/nand/raw/omap2.c:1681: warning: Function parameter or member 'info' not described in 'is_elm_present'
 drivers/mtd/nand/raw/omap2.c:1681: warning: Function parameter or member 'elm_node' not described in 'is_elm_present'
 drivers/mtd/nand/raw/omap2.c:1681: warning: Excess function parameter 'omap_nand_info' description in 'is_elm_present'

Cc: Miquel Raynal <miquel.raynal@bootlin.com>
Cc: Richard Weinberger <richard@nod.at>
Cc: Vignesh Raghavendra <vigneshr@ti.com>
Cc: Jian Zhang <jzhang@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-20-lee.jones@linaro.org
parent a318b95a

drivers/mtd/nand/raw/omap2.c

+10 −8
Original line number Diff line number Diff line
@@ -185,6 +185,7 @@ static inline struct omap_nand_info *mtd_to_omap(struct mtd_info *mtd) 
 * @dma_mode: dma mode enable (1) or disable (0)

 * @u32_count: number of bytes to be transferred

 * @is_write: prefetch read(0) or write post(1) mode

 * @info: NAND device structure containing platform data

 */

static int omap_prefetch_enable(int cs, int fifo_th, int dma_mode,

	unsigned int u32_count, int is_write, struct omap_nand_info *info)
@@ -214,7 +215,7 @@ static int omap_prefetch_enable(int cs, int fifo_th, int dma_mode, 
	return 0;

}



/**

/*

 * omap_prefetch_reset - disables and stops the prefetch engine

 */

static int omap_prefetch_reset(int cs, struct omap_nand_info *info)
@@ -939,7 +940,7 @@ static int omap_calculate_ecc(struct nand_chip *chip, const u_char *dat, 


/**

 * omap_enable_hwecc - This function enables the hardware ecc functionality

 * @mtd: MTD device structure

 * @chip: NAND chip object

 * @mode: Read/Write mode

 */

static void omap_enable_hwecc(struct nand_chip *chip, int mode)
@@ -1009,7 +1010,7 @@ static int omap_wait(struct nand_chip *this) 


/**

 * omap_dev_ready - checks the NAND Ready GPIO line

 * @mtd: MTD device structure

 * @chip: NAND chip object

 *

 * Returns true if ready and false if busy.

 */
@@ -1022,7 +1023,7 @@ static int omap_dev_ready(struct nand_chip *chip) 


/**

 * omap_enable_hwecc_bch - Program GPMC to perform BCH ECC calculation

 * @mtd: MTD device structure

 * @chip: NAND chip object

 * @mode: Read/Write mode

 *

 * When using BCH with SW correction (i.e. no ELM), sector size is set
@@ -1131,7 +1132,7 @@ static u8 bch8_polynomial[] = {0xef, 0x51, 0x2e, 0x09, 0xed, 0x93, 0x9a, 0xc2, 
 * _omap_calculate_ecc_bch - Generate ECC bytes for one sector

 * @mtd:	MTD device structure

 * @dat:	The pointer to data on which ecc is computed

 * @ecc_code:	The ecc_code buffer

 * @ecc_calc:	The ecc_code buffer

 * @i:		The sector number (for a multi sector page)

 *

 * Support calculating of BCH4/8/16 ECC vectors for one sector
@@ -1259,7 +1260,7 @@ static int _omap_calculate_ecc_bch(struct mtd_info *mtd, 
 * omap_calculate_ecc_bch_sw - ECC generator for sector for SW based correction

 * @chip:	NAND chip object

 * @dat:	The pointer to data on which ecc is computed

 * @ecc_code:	The ecc_code buffer

 * @ecc_calc:	Buffer storing the calculated ECC bytes

 *

 * Support calculating of BCH4/8/16 ECC vectors for one sector. This is used

 * when SW based correction is required as ECC is required for one sector
@@ -1275,7 +1276,7 @@ static int omap_calculate_ecc_bch_sw(struct nand_chip *chip, 
 * omap_calculate_ecc_bch_multi - Generate ECC for multiple sectors

 * @mtd:	MTD device structure

 * @dat:	The pointer to data on which ecc is computed

 * @ecc_code:	The ecc_code buffer

 * @ecc_calc:	Buffer storing the calculated ECC bytes

 *

 * Support calculating of BCH4/8/16 ecc vectors for the entire page in one go.

 */
@@ -1674,7 +1675,8 @@ static int omap_read_page_bch(struct nand_chip *chip, uint8_t *buf, 


/**

 * is_elm_present - checks for presence of ELM module by scanning DT nodes

 * @omap_nand_info: NAND device structure containing platform data

 * @info: NAND device structure containing platform data

 * @elm_node: ELM's DT node

 */

static bool is_elm_present(struct omap_nand_info *info,

			   struct device_node *elm_node)

CRA Git | Maintained and supported by SUSTech CRA and CCSE