]> git.ipfire.org Git - thirdparty/linux.git/commitdiff
regulator: pf9453: Improve documentation for pf9453_regulator_set_ramp_delay_regmap
authorYang Li <yang.lee@linux.alibaba.com>
Mon, 7 Apr 2025 06:45:32 +0000 (14:45 +0800)
committerMark Brown <broonie@kernel.org>
Mon, 7 Apr 2025 11:57:44 +0000 (12:57 +0100)
The function pf9453_regulator_set_ramp_delay_regmap lacked detailed
parameter descriptions and return value explanations in its documentation.
This patch improves the documentation by adding specific details about
the parameters, their usage, and the return values, enhancing clarity for
developers.

Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Closes: https://bugzilla.openanolis.cn/show_bug.cgi?id=20168
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
Link: https://patch.msgid.link/20250407064532.22680-1-yang.lee@linux.alibaba.com
Signed-off-by: Mark Brown <broonie@kernel.org>
drivers/regulator/pf9453-regulator.c

index ed6bf0f6c4fe23a146ffd9258532bbdefa35ad3f..b58c9c0a5022d672d32b1bd1bf6f17baef27e837 100644 (file)
@@ -412,6 +412,7 @@ static int find_closest_bigger(unsigned int target, const unsigned int *table,
  * pf9453_regulator_set_ramp_delay_regmap
  *
  * @rdev: regulator to operate on
+ * @ramp_delay: desired ramp delay value in microseconds
  *
  * 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