[PATCH] mmc: core: Fix wrong comments in the regulator helpers

[PATCH] mmc: core: Fix wrong comments in the regulator helpers

[Shawn Lin]

From: Shawn Lin <shawn.lin@rock-chips.com>

mmc_ocrbitnum_to_vdd() stores the voltage range in microvolts, as the
min_uV and max_uV argument names say, but its kernel-doc documents the
unit as mV. Fix the unit.

mmc_regulator_disable_vqmmc() returns void, but its kernel-doc claims
that it returns 0 or an errno. Drop that sentence.

No functional change.

Signed-off-by: Shawn Lin <shawn.lin@rock-chips.com>
---
 drivers/mmc/core/regulator.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/drivers/mmc/core/regulator.c b/drivers/mmc/core/regulator.c
index a85179f1a4de..bbc773c647fa 100644
--- a/drivers/mmc/core/regulator.c
+++ b/drivers/mmc/core/regulator.c
@@ -19,8 +19,8 @@
 /**
  * mmc_ocrbitnum_to_vdd - Convert a OCR bit number to its voltage
  * @vdd_bit:	OCR bit number
- * @min_uV:	minimum voltage value (mV)
- * @max_uV:	maximum voltage value (mV)
+ * @min_uV:	minimum voltage value (uV)
+ * @max_uV:	maximum voltage value (uV)
  *
  * This function returns the voltage range according to the provided OCR
  * bit number. If conversion is not possible a negative errno value returned.
@@ -418,7 +418,7 @@ EXPORT_SYMBOL_GPL(mmc_regulator_enable_vqmmc);
  * mmc_regulator_disable_vqmmc - disable VQMMC regulator for a host
  * @mmc: the host to regulate
  *
- * Returns 0 or errno. Disables the regulator for vqmmc.
+ * Disables the regulator for vqmmc.
  * Keeps track of the enable status for ensuring that calls to
  * regulator_enable/disable are balanced.
  */
-- 
2.25.1

Re: [PATCH] mmc: core: Fix wrong comments in the regulator helpers

[Ulf Hansson]

On Mon, Oct 26, 2026 at 8:00 AM Shawn Lin <shawn.lin@linux.dev> wrote:
>
> From: Shawn Lin <shawn.lin@rock-chips.com>
>
> mmc_ocrbitnum_to_vdd() stores the voltage range in microvolts, as the
> min_uV and max_uV argument names say, but its kernel-doc documents the
> unit as mV. Fix the unit.
>
> mmc_regulator_disable_vqmmc() returns void, but its kernel-doc claims
> that it returns 0 or an errno. Drop that sentence.
>
> No functional change.
>
> Signed-off-by: Shawn Lin <shawn.lin@rock-chips.com>

Applied for next, thanks!

Kind regards
Uffe


> ---
>  drivers/mmc/core/regulator.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/drivers/mmc/core/regulator.c b/drivers/mmc/core/regulator.c
> index a85179f1a4de..bbc773c647fa 100644
> --- a/drivers/mmc/core/regulator.c
> +++ b/drivers/mmc/core/regulator.c
> @@ -19,8 +19,8 @@
>  /**
>   * mmc_ocrbitnum_to_vdd - Convert a OCR bit number to its voltage
>   * @vdd_bit:   OCR bit number
> - * @min_uV:    minimum voltage value (mV)
> - * @max_uV:    maximum voltage value (mV)
> + * @min_uV:    minimum voltage value (uV)
> + * @max_uV:    maximum voltage value (uV)
>   *
>   * This function returns the voltage range according to the provided OCR
>   * bit number. If conversion is not possible a negative errno value returned.
> @@ -418,7 +418,7 @@ EXPORT_SYMBOL_GPL(mmc_regulator_enable_vqmmc);
>   * mmc_regulator_disable_vqmmc - disable VQMMC regulator for a host
>   * @mmc: the host to regulate
>   *
> - * Returns 0 or errno. Disables the regulator for vqmmc.
> + * Disables the regulator for vqmmc.
>   * Keeps track of the enable status for ensuring that calls to
>   * regulator_enable/disable are balanced.
>   */
> --
> 2.25.1
>