Blob Blame History Raw
From d3b555e563a0ac80383b66f4ffd8bee2f6272779 Mon Sep 17 00:00:00 2001
From: ChiYuan Huang <cy_huang@richtek.com>
Date: Fri, 16 Jun 2023 10:08:18 +0800
Subject: [PATCH] regulator: helper: Document ramp_delay parameter of regulator_set_ramp_delay_regmap()
Git-commit: d3b555e563a0ac80383b66f4ffd8bee2f6272779
Patch-mainline: v6.5-rc1
References: git-fixes

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@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>
Acked-by: Takashi Iwai <tiwai@suse.de>

---
 drivers/regulator/helpers.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/regulator/helpers.c b/drivers/regulator/helpers.c
index 586f42e378ee..e6c999ba3fa2 100644
--- 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
-- 
2.35.3