linux-kernel - [PATCH] gpio: omap: add kernel-doc comment for omap_gpio

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: <tencent_BB49A52B7796EBAFEC293B0B5203602BD608@qq.com>
Date: Mon,  1 Dec 2025 17:54:21 +0800
From: cjz <guagua210311@...com>
To: linux-gpio@...r.kernel.org,
	linux-omap@...r.kernel.org,
	linux-kernel@...r.kernel.org
Cc: Grygorii.Strashko@...com,
	ssantosh@...nel.org,
	khilman@...nel.org,
	linus.walleij@...aro.org,
	brgl@...nel.org,
	guagua210311@...com
Subject: [PATCH] gpio: omap: add kernel-doc comment for omap_gpio_get()

From: changjunzheng <guagua210311@...com>

omap_gpio_get() is a core function for reading OMAP GPIO pin level, but it lacks complete kernel-doc comment (no function description, parameter explanation, or return value说明). This causes gcc W=1 warning and reduces code readability.

Add standard kernel-doc comment to fix the warning and improve maintainability.

Signed-off-by: changjunzheng <guagua210311@...com>
---
 drivers/gpio/gpio-omap.c | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/drivers/gpio/gpio-omap.c b/drivers/gpio/gpio-omap.c
index a268c76bdca6..ad69892e9d98 100644
--- a/drivers/gpio/gpio-omap.c
+++ b/drivers/gpio/gpio-omap.c
@@ -861,6 +861,17 @@ static int omap_gpio_input(struct gpio_chip *chip, unsigned offset)
 	return 0;
 }
 
+/**
+ * omap_gpio_get - Get the logic level of an OMAP GPIO pin
+ * @chip: Pointer to the GPIO chip instance
+ * @offset: Offset of the GPIO pin within the chip's pin range
+ *
+ * Read the current logic level of the specified OMAP GPIO pin. If the pin is
+ * configured as input, read the actual pin level; if configured as output, read
+ * the last set output level.
+ *
+ * Return: 0 if the pin is at low level, 1 if at high level
+ */
 static int omap_gpio_get(struct gpio_chip *chip, unsigned offset)
 {
 	struct gpio_bank *bank = gpiochip_get_data(chip);
-- 
2.43.0