2023-06-16 02:28:02

by ChiYuan Huang

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

From: ChiYuan Huang <[email protected]>

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 <[email protected]>
---
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



2023-06-16 13:48:41

by Mark Brown

[permalink] [raw]
Subject: Re: [PATCH] regulator: helper: Document ramp_delay parameter of regulator_set_ramp_delay_regmap()

On Fri, 16 Jun 2023 10:08:18 +0800, [email protected] wrote:
> 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.
>
>
> [...]

Applied to

https://git.kernel.org/pub/scm/linux/kernel/git/broonie/regulator.git for-next

Thanks!

[1/1] regulator: helper: Document ramp_delay parameter of regulator_set_ramp_delay_regmap()
commit: d3b555e563a0ac80383b66f4ffd8bee2f6272779

All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying
to this mail.

Thanks,
Mark