From: Randy Dunlap <rdunlap@infradead.org>
To: linux-kernel@vger.kernel.org
Cc: Randy Dunlap <rdunlap@infradead.org>,
Kevin Hilman <khilman@kernel.org>,
Tony Lindgren <tony@atomide.com>,
linux-omap@vger.kernel.org, Russell King <linux@armlinux.org.uk>,
linux-arm-kernel@lists.infradead.org, patches@armlinux.org.uk
Subject: [PATCH 08/13] ARM: OMAP2+: pmic-cpcap: fix kernel-doc warnings
Date: Tue, 16 Jan 2024 17:09:56 -0800 [thread overview]
Message-ID: <20240117011004.22669-9-rdunlap@infradead.org> (raw)
In-Reply-To: <20240117011004.22669-1-rdunlap@infradead.org>
Use the correct function names in kernel-doc comments.
Use "Return[s]:" kernel-doc notation for function return values.
These changes prevent the following warnings:
pmic-cpcap.c:28: warning: expecting prototype for omap_cpcap_vsel_to_vdc(). Prototype was for omap_cpcap_vsel_to_uv() instead
pmic-cpcap.c:92: warning: expecting prototype for omap_max8952_vsel_to_vdc(). Prototype was for omap_max8952_vsel_to_uv() instead
pmic-cpcap.c:139: warning: expecting prototype for omap_fan5355_vsel_to_vdc(). Prototype was for omap_fan535503_vsel_to_uv() instead
pmic-cpcap.c:154: warning: expecting prototype for omap_fan535508_vsel_to_vdc(). Prototype was for omap_fan535508_vsel_to_uv() instead
pmic-cpcap.c:28: warning: No description found for return value of 'omap_cpcap_vsel_to_uv'
pmic-cpcap.c:42: warning: No description found for return value of 'omap_cpcap_uv_to_vsel'
pmic-cpcap.c:92: warning: No description found for return value of 'omap_max8952_vsel_to_uv'
pmic-cpcap.c:106: warning: No description found for return value of 'omap_max8952_uv_to_vsel'
pmic-cpcap.c:139: warning: No description found for return value of 'omap_fan535503_vsel_to_uv'
pmic-cpcap.c:154: warning: No description found for return value of 'omap_fan535508_vsel_to_uv'
pmic-cpcap.c:172: warning: No description found for return value of 'omap_fan535503_uv_to_vsel'
pmic-cpcap.c:191: warning: No description found for return value of 'omap_fan535508_uv_to_vsel'
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Kevin Hilman <khilman@kernel.org>
Cc: Tony Lindgren <tony@atomide.com>
Cc: linux-omap@vger.kernel.org
Cc: Russell King <linux@armlinux.org.uk>
Cc: linux-arm-kernel@lists.infradead.org
Cc: patches@armlinux.org.uk
---
KernelVersion: 0dd3ee31125508cd67f7e717
arch/arm/mach-omap2/pmic-cpcap.c | 24 ++++++++++++------------
1 file changed, 12 insertions(+), 12 deletions(-)
diff -- a/arch/arm/mach-omap2/pmic-cpcap.c b/arch/arm/mach-omap2/pmic-cpcap.c
--- a/arch/arm/mach-omap2/pmic-cpcap.c
+++ b/arch/arm/mach-omap2/pmic-cpcap.c
@@ -18,10 +18,10 @@
#include "vc.h"
/**
- * omap_cpcap_vsel_to_vdc - convert CPCAP VSEL value to microvolts DC
+ * omap_cpcap_vsel_to_uv - convert CPCAP VSEL value to microvolts DC
* @vsel: CPCAP VSEL value to convert
*
- * Returns the microvolts DC that the CPCAP PMIC should generate when
+ * Returns: the microvolts DC that the CPCAP PMIC should generate when
* programmed with @vsel.
*/
static unsigned long omap_cpcap_vsel_to_uv(unsigned char vsel)
@@ -35,7 +35,7 @@ static unsigned long omap_cpcap_vsel_to_
* omap_cpcap_uv_to_vsel - convert microvolts DC to CPCAP VSEL value
* @uv: microvolts DC to convert
*
- * Returns the VSEL value necessary for the CPCAP PMIC to
+ * Returns: the VSEL value necessary for the CPCAP PMIC to
* generate an output voltage equal to or greater than @uv microvolts DC.
*/
static unsigned char omap_cpcap_uv_to_vsel(unsigned long uv)
@@ -82,10 +82,10 @@ static struct omap_voltdm_pmic omap_cpca
};
/**
- * omap_max8952_vsel_to_vdc - convert MAX8952 VSEL value to microvolts DC
+ * omap_max8952_vsel_to_uv - convert MAX8952 VSEL value to microvolts DC
* @vsel: MAX8952 VSEL value to convert
*
- * Returns the microvolts DC that the MAX8952 Regulator should generate when
+ * Returns: the microvolts DC that the MAX8952 Regulator should generate when
* programmed with @vsel.
*/
static unsigned long omap_max8952_vsel_to_uv(unsigned char vsel)
@@ -99,7 +99,7 @@ static unsigned long omap_max8952_vsel_t
* omap_max8952_uv_to_vsel - convert microvolts DC to MAX8952 VSEL value
* @uv: microvolts DC to convert
*
- * Returns the VSEL value necessary for the MAX8952 Regulator to
+ * Returns: the VSEL value necessary for the MAX8952 Regulator to
* generate an output voltage equal to or greater than @uv microvolts DC.
*/
static unsigned char omap_max8952_uv_to_vsel(unsigned long uv)
@@ -129,10 +129,10 @@ static struct omap_voltdm_pmic omap443x_
};
/**
- * omap_fan5355_vsel_to_vdc - convert FAN535503 VSEL value to microvolts DC
+ * omap_fan535503_vsel_to_uv - convert FAN535503 VSEL value to microvolts DC
* @vsel: FAN535503 VSEL value to convert
*
- * Returns the microvolts DC that the FAN535503 Regulator should generate when
+ * Returns: the microvolts DC that the FAN535503 Regulator should generate when
* programmed with @vsel.
*/
static unsigned long omap_fan535503_vsel_to_uv(unsigned char vsel)
@@ -144,10 +144,10 @@ static unsigned long omap_fan535503_vsel
}
/**
- * omap_fan535508_vsel_to_vdc - convert FAN535508 VSEL value to microvolts DC
+ * omap_fan535508_vsel_to_uv - convert FAN535508 VSEL value to microvolts DC
* @vsel: FAN535508 VSEL value to convert
*
- * Returns the microvolts DC that the FAN535508 Regulator should generate when
+ * Returns: the microvolts DC that the FAN535508 Regulator should generate when
* programmed with @vsel.
*/
static unsigned long omap_fan535508_vsel_to_uv(unsigned char vsel)
@@ -165,7 +165,7 @@ static unsigned long omap_fan535508_vsel
* omap_fan535503_uv_to_vsel - convert microvolts DC to FAN535503 VSEL value
* @uv: microvolts DC to convert
*
- * Returns the VSEL value necessary for the MAX8952 Regulator to
+ * Returns: the VSEL value necessary for the MAX8952 Regulator to
* generate an output voltage equal to or greater than @uv microvolts DC.
*/
static unsigned char omap_fan535503_uv_to_vsel(unsigned long uv)
@@ -184,7 +184,7 @@ static unsigned char omap_fan535503_uv_t
* omap_fan535508_uv_to_vsel - convert microvolts DC to FAN535508 VSEL value
* @uv: microvolts DC to convert
*
- * Returns the VSEL value necessary for the MAX8952 Regulator to
+ * Returns: the VSEL value necessary for the MAX8952 Regulator to
* generate an output voltage equal to or greater than @uv microvolts DC.
*/
static unsigned char omap_fan535508_uv_to_vsel(unsigned long uv)
next prev parent reply other threads:[~2024-01-17 1:10 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-17 1:09 [PATCH 00/13] ARM: OMAP2+: fix a bunch of " Randy Dunlap
2024-01-17 1:09 ` [PATCH 01/13] ARM: OMAP2+: am33xx-restart: fix function name in kernel-doc Randy Dunlap
2024-01-17 1:09 ` [PATCH 02/13] ARM: OMAP2+: clockdomain: fix kernel-doc warnings Randy Dunlap
2024-01-17 1:09 ` [PATCH 03/13] ARM: OMAP2+: clock: fix a function name in kernel-doc Randy Dunlap
2024-01-17 1:09 ` [PATCH 04/13] ARM: OMAP2+: cm33xx: use matching " Randy Dunlap
2024-01-17 1:09 ` [PATCH 05/13] ARM: OMAP2+: CMINST: " Randy Dunlap
2024-01-17 1:09 ` [PATCH 06/13] ARM: OMAP2+: hwmod: remove misuse of kernel-doc Randy Dunlap
2024-01-17 1:09 ` [PATCH 07/13] ARM: OMAP2+: hwmod: fix kernel-doc warnings Randy Dunlap
2024-01-17 1:09 ` Randy Dunlap [this message]
2024-01-17 1:09 ` [PATCH 09/13] ARM: OMAP2+: prm44xx: fix a kernel-doc warning Randy Dunlap
2024-01-17 1:09 ` [PATCH 10/13] ARM: OMAP2+: PRM: fix kernel-doc warnings Randy Dunlap
2024-01-17 1:09 ` [PATCH 11/13] ARM: OMAP2+: fix a kernel-doc warning Randy Dunlap
2024-01-17 1:10 ` [PATCH 12/13] ARM: OMAP2+: fix kernel-doc warnings Randy Dunlap
2024-01-17 1:10 ` [PATCH 13/13] " Randy Dunlap
2024-01-17 13:13 ` [PATCH 00/13] ARM: OMAP2+: fix a bunch of " Tony Lindgren
2024-01-17 16:52 ` Randy Dunlap
2024-01-18 8:57 ` Tony Lindgren
2024-01-26 8:39 ` Tony Lindgren
2024-02-01 9:32 ` Russell King (Oracle)
2024-02-01 16:27 ` Randy Dunlap
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240117011004.22669-9-rdunlap@infradead.org \
--to=rdunlap@infradead.org \
--cc=khilman@kernel.org \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-omap@vger.kernel.org \
--cc=linux@armlinux.org.uk \
--cc=patches@armlinux.org.uk \
--cc=tony@atomide.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®