diff mbox series

mtd: spinand: macronix: Fixed warning: Function paramteter or member not described

Message ID 20240711083611.364431-1-linchengming884@gmail.com
State New
Headers show
Series mtd: spinand: macronix: Fixed warning: Function paramteter or member not described | expand

Commit Message

Cheng Ming Lin July 11, 2024, 8:36 a.m. UTC 
From: Cheng Ming Lin <chengminglin@mxic.com.tw>

Fixed the warnings: Function paramteter or member 'xxx' not described

Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202407110520.pbPnrOlM-lkp@intel.com/
Signed-off-by: Cheng Ming Lin <chengminglin@mxic.com.tw>
---
 drivers/mtd/nand/spi/macronix.c | 23 +++++++++++++++++++----
 1 file changed, 19 insertions(+), 4 deletions(-)


base-commit: 6000ef48e571f49a636b0c51494c1326ff9b7736
prerequisite-patch-id: 5cea93c94f6237a2f8f51397ba76187952ef45b2

Comments

Miquel Raynal July 17, 2024, 8:08 a.m. UTC | #1 
Hi Cheng,

linchengming884@gmail.com wrote on Thu, 11 Jul 2024 16:36:11 +0800:

> From: Cheng Ming Lin <chengminglin@mxic.com.tw>
> 
> Fixed the warnings: Function paramteter or member 'xxx' not described
> 
> Reported-by: kernel test robot <lkp@intel.com>

I know this robot tells you to create a patch and credit it, but that's
not how it is supposed to work. Only do that if your patch has already
been accepted. Here in this case you need to send a v2.

> Closes: https://lore.kernel.org/oe-kbuild-all/202407110520.pbPnrOlM-lkp@intel.com/
> Signed-off-by: Cheng Ming Lin <chengminglin@mxic.com.tw>

Thanks,
Miquèl
diff mbox series

Patch

diff --git a/drivers/mtd/nand/spi/macronix.c b/drivers/mtd/nand/spi/macronix.c
index c61f1ba31f0c..ea956933e8a1 100644
--- a/drivers/mtd/nand/spi/macronix.c
+++ b/drivers/mtd/nand/spi/macronix.c
@@ -101,12 +101,16 @@  static int mx35lf1ge4ab_ecc_get_status(struct spinand_device *spinand,
 }
 
 /**
+ * write_Plane_Select_bit_in_cadd - Write Plane Select bit to the column address
+ * @spinand: SPI NAND device
+ * @req: NAND I/O request object
+ * @column: the column address
+ *
  * Macronix serial NAND flash with a two-plane structure
- * should insert Plane Select bit to the column address
+ * should insert Plane Select bit into the column address
  * during the write_to_cache operation.
- * Additionally, MX35{U,F}2G14AC also need to insert Plane
- * Select bit to the column address during the read_from_cache
- * operation.
+ *
+ * Return: the column address after insertion of Plane Select bit
  */
 static unsigned int write_Plane_Select_bit_in_cadd(struct spinand_device *spinand,
 			const struct nand_page_io_req *req, unsigned int column)
@@ -116,6 +120,17 @@  static unsigned int write_Plane_Select_bit_in_cadd(struct spinand_device *spinan
 	return column | (req->pos.plane << fls(nanddev_page_size(nand)));
 }
 
+/**
+ * read_Plane_Select_bit_in_cadd - Write Plane Select bit to the column address
+ * @spinand: SPI NAND device
+ * @req: NAND I/O request object
+ * @column: the column address
+ *
+ * MX35{U,F}2G14AC also need to insert Plane Select bit
+ * into the column address during the read_from_cache operation.
+ *
+ * Return: the column address after insertion of Plane Select bit
+ */
 static u16 read_Plane_Select_bit_in_cadd(struct spinand_device *spinand,
 			const struct nand_page_io_req *req, u16 column)
 {