linux-kernel - [PATCH] mtd: spinand: macronix: Fixed warning: Function paramteter or member not described

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20240711083611.364431-1-linchengming884@gmail.com>
Date: Thu, 11 Jul 2024 16:36:11 +0800
From: Cheng Ming Lin <linchengming884@...il.com>
To: miquel.raynal@...tlin.com,
	vigneshr@...com,
	linux-mtd@...ts.infradead.org,
	linux-kernel@...r.kernel.org
Cc: richard@....at,
	alvinzhou@...c.com.tw,
	leoyu@...c.com.tw,
	Cheng Ming Lin <chengminglin@...c.com.tw>,
	kernel test robot <lkp@...el.com>
Subject: [PATCH] mtd: spinand: macronix: Fixed warning: Function paramteter or member not described

From: Cheng Ming Lin <chengminglin@...c.com.tw>

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

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

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)
 {

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