[PATCH] regulator: helper: Document ramp_delay parameter of regulator_set_ramp_delay_regmap()

From: cy_huang
Date: Thu Jun 15 2023 - 22:08:39 EST


From: ChiYuan Huang <cy_huang@xxxxxxxxxxx>

With W=1:

drivers/regulator/helpers.c:947: warning: Function parameter or member 'ramp_delay' not described in 'regulator_set_ramp_delay_regmap'

Fix it by documenting the parameter.

Fixes: fb8fee9efdcf ("regulator: Add regmap helper for ramp-delay setting")
Signed-off-by: ChiYuan Huang <cy_huang@xxxxxxxxxxx>
---
drivers/regulator/helpers.c | 1 +
1 file changed, 1 insertion(+)

diff --git a/drivers/regulator/helpers.c b/drivers/regulator/helpers.c
index ad2237a95572..d2183c11d51d 100644
--- a/drivers/regulator/helpers.c
+++ b/drivers/regulator/helpers.c
@@ -938,6 +938,7 @@ static int find_closest_bigger(unsigned int target, const unsigned int *table,
* regulator_set_ramp_delay_regmap - set_ramp_delay() helper
*
* @rdev: regulator to operate on
+ * @ramp_delay: ramp-rate value given in units V/S (uV/uS)
*
* Regulators that use regmap for their register I/O can set the ramp_reg
* and ramp_mask fields in their descriptor and then use this as their
--
2.40.1