[PATCH] ARM: OMAP2+: prm33xx.c: Fix kerneldoc warnings
Tony Lindgren
tony at atomide.com
Thu Mar 7 23:35:00 PST 2024
Commit 6521f6a195c7 ("ARM: AM33xx: PRM: Implement REBOOT_COLD")
added a new kerneldoc warning as the function name changed:
warning: expecting prototype for am33xx_prm_global_warm_sw_reset().
Prototype was for am33xx_prm_global_sw_reset() instead
Turns out prm33xx.c produces a few other kerneldoc warnings so let's
fix them all.
Fixes: 6521f6a195c7 ("ARM: AM33xx: PRM: Implement REBOOT_COLD")
Cc: Alexander Sverdlin <alexander.sverdlin at siemens.com>
Cc: Matthias Michel <matthias.michel at siemens.com>
Cc: Randy Dunlap <rdunlap at infradead.org>
Signed-off-by: Tony Lindgren <tony at atomide.com>
---
arch/arm/mach-omap2/prm33xx.c | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/arch/arm/mach-omap2/prm33xx.c b/arch/arm/mach-omap2/prm33xx.c
--- a/arch/arm/mach-omap2/prm33xx.c
+++ b/arch/arm/mach-omap2/prm33xx.c
@@ -48,8 +48,7 @@ static u32 am33xx_prm_rmw_reg_bits(u32 mask, u32 bits, s16 inst, s16 idx)
* @part: PRM partition, ignored for AM33xx
* @inst: CM instance register offset (*_INST macro)
* @rstctrl_offs: RM_RSTCTRL register address offset for this module
- *
- * Returns 1 if the (sub)module hardreset line is currently asserted,
+ * @return: 1 if the (sub)module hardreset line is currently asserted,
* 0 if the (sub)module hardreset line is not currently asserted, or
* -EINVAL upon parameter error.
*/
@@ -70,14 +69,14 @@ static int am33xx_prm_is_hardreset_asserted(u8 shift, u8 part, s16 inst,
* @shift: register bit shift corresponding to the reset line to assert
* @part: CM partition, ignored for AM33xx
* @inst: CM instance register offset (*_INST macro)
- * @rstctrl_reg: RM_RSTCTRL register address for this module
+ * @rstctrl_offs: RM_RSTCTRL register address offset for this module
+ * @return: Returns 0 upon success or -EINVAL upon an argument error
*
* Some IPs like dsp, ipu or iva contain processors that require an HW
* reset line to be asserted / deasserted in order to fully enable the
* IP. These modules may have multiple hard-reset lines that reset
* different 'submodules' inside the IP block. This function will
- * place the submodule into reset. Returns 0 upon success or -EINVAL
- * upon an argument error.
+ * place the submodule into reset.
*/
static int am33xx_prm_assert_hardreset(u8 shift, u8 part, s16 inst,
u16 rstctrl_offs)
@@ -96,17 +95,18 @@ static int am33xx_prm_assert_hardreset(u8 shift, u8 part, s16 inst,
* @st_shift: reset status register bit shift corresponding to the reset line
* @part: PRM partition, not used for AM33xx
* @inst: CM instance register offset (*_INST macro)
- * @rstctrl_reg: RM_RSTCTRL register address for this module
- * @rstst_reg: RM_RSTST register address for this module
+ * @rstctrl_offs: RM_RSTCTRL register address offset for this module
+ * @rstst_offs: RM_RSTST register address offset for this module
+ * @return: Returns 0 upon success or -EINVAL upon an argument error,
+ * -EEXIST if the submodule was already out of reset, or -EBUSY if the
+ * submodule did not exit reset promptly
*
* Some IPs like dsp, ipu or iva contain processors that require an HW
* reset line to be asserted / deasserted in order to fully enable the
* IP. These modules may have multiple hard-reset lines that reset
* different 'submodules' inside the IP block. This function will
* take the submodule out of reset and wait until the PRCM indicates
- * that the reset has completed before returning. Returns 0 upon success or
- * -EINVAL upon an argument error, -EEXIST if the submodule was already out
- * of reset, or -EBUSY if the submodule did not exit reset promptly.
+ * that the reset has completed before returning.
*/
static int am33xx_prm_deassert_hardreset(u8 shift, u8 st_shift, u8 part,
s16 inst, u16 rstctrl_offs,
@@ -315,7 +315,7 @@ static int am33xx_check_vcvp(void)
}
/**
- * am33xx_prm_global_warm_sw_reset - reboot the device via warm reset
+ * am33xx_prm_global_sw_reset - reboot the device via warm reset
*
* Immediately reboots the device through warm reset.
*/
--
2.43.1
More information about the linux-arm-kernel
mailing list