regulator: helper: Document ramp_delay parameter of regulator_set_ramp_delay_regmap()

ChiYuan Huang · broonie · commit d3b555e563a0 · 2023-06-16T12:56:16.000+01:00
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: fb8fee9 ("regulator: Add regmap helper for ramp-delay setting") Signed-off-by: ChiYuan Huang <cy_huang@richtek.com> Link: https://lore.kernel.org/r/1686881298-28333-1-git-send-email-cy_huang@richtek.com Signed-off-by: Mark Brown <broonie@kernel.org>
diff --git a/drivers/regulator/helpers.c b/drivers/regulator/helpers.c
@@ -952,6 +952,7 @@ EXPORT_SYMBOL_GPL(regulator_find_closest_bigger);
  * 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

Original file line number	Diff line number	Diff line change
`@@ -952,6 +952,7 @@ EXPORT_SYMBOL_GPL(regulator_find_closest_bigger);`
`952`	`952`	`* regulator_set_ramp_delay_regmap - set_ramp_delay() helper`
`953`	`953`	`*`
`954`	`954`	`* @rdev: regulator to operate on`
	`955`	`+ * @ramp_delay: ramp-rate value given in units V/S (uV/uS)`
`955`	`956`	`*`
`956`	`957`	`* Regulators that use regmap for their register I/O can set the ramp_reg`
`957`	`958`	`* and ramp_mask fields in their descriptor and then use this as their`