[PATCH 0/8] regulator: kerneldoc section fixes

[PATCH 0/8] regulator: kerneldoc section fixes

[Chen-Yu Tsai]

Hi,

Here are a bunch of kerneldoc fixes for the regulator core. This sort of
came as a request from Andy to not move code that already had warnings
without fixing said warnings. So here I'm fixing them first.

The bulk of the fixes are in the regulator core and OF code, but I also
fixed up a few bits in common code that were missing "Return" sections.
These are purely kerneldoc fixes and don't touch any actual code. I left
the devres code and helpers alone for now.

Please merge if possible. I will rebase my I2C OF component prober
series [1] on top of them.

Thanks
ChenYu

[1] https://lore.kernel.org/all/20240822092006.3134096-1-wenst@chromium.org/


Chen-Yu Tsai (8):
  regulator: core: Fix short description for
    _regulator_check_status_enabled()
  regulator: core: Fix regulator_is_supported_voltage() kerneldoc return
    value
  regulator: core: Fix incorrectly formatted kerneldoc "Return" sections
  regulator: core: Add missing kerneldoc Return sections
  regulator: of: Fix incorrectly formatted kerneldoc "Return" sections
  regulator: fixed: Fix incorrectly formatted kerneldoc "Return" section
  regulator: fixed-helper: Add missing "Return" kerneldoc section
  regulator: irq_helpers: Add missing "Return" kerneldoc section

 drivers/regulator/core.c         | 175 ++++++++++++++++++++++---------
 drivers/regulator/fixed-helper.c |   2 +
 drivers/regulator/fixed.c        |   6 +-
 drivers/regulator/irq_helpers.c  |   4 +
 drivers/regulator/of_regulator.c |  14 +--
 5 files changed, 141 insertions(+), 60 deletions(-)

-- 
2.46.0.295.g3b9ea8a38a-goog

[PATCH 1/8] regulator: core: Fix short description for _regulator_check_status_enabled()

[Chen-Yu Tsai]

kernel-doc complains that _regulator_check_status_enabled() is missing a
short description.

Since the current description is already quite short, just trim it a bit
more and use it as the short description.

Fixes: f7d7ad42a9dc ("regulator: Allow regulators to verify enabled during enable()")
Signed-off-by: Chen-Yu Tsai <wenst@chromium.org>
---
 drivers/regulator/core.c | 6 ++----
 1 file changed, 2 insertions(+), 4 deletions(-)

diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c
index 9029de5395ee..763048d6f1ed 100644
--- a/drivers/regulator/core.c
+++ b/drivers/regulator/core.c
@@ -2707,10 +2707,8 @@ static void _regulator_delay_helper(unsigned int delay)
 }
 
 /**
- * _regulator_check_status_enabled
- *
- * A helper function to check if the regulator status can be interpreted
- * as 'regulator is enabled'.
+ * _regulator_check_status_enabled - check if regulator status can be
+ *				     interpreted as "regulator is enabled"
  * @rdev: the regulator device to check
  *
  * Return:
-- 
2.46.0.295.g3b9ea8a38a-goog

[PATCH 2/8] regulator: core: Fix regulator_is_supported_voltage() kerneldoc return value

[Chen-Yu Tsai]

The kerneldoc for regulator_is_supported_voltage() states that the
return value is a boolean. That is not correct, as it could return an
error number if the check failed.

Fix the description by expanding it to cover the true, false and error
conditions. The description is also converted to a proper "Return"
section.

Fixes: c5f3939b8fe0 ("regulator: core: Support fixed voltages in regulator_is_supported_voltage()")
Signed-off-by: Chen-Yu Tsai <wenst@chromium.org>
---
 drivers/regulator/core.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c
index 763048d6f1ed..3a1b6fd9780d 100644
--- a/drivers/regulator/core.c
+++ b/drivers/regulator/core.c
@@ -3456,7 +3456,8 @@ EXPORT_SYMBOL_GPL(regulator_get_linear_step);
  * @min_uV: Minimum required voltage in uV.
  * @max_uV: Maximum required voltage in uV.
  *
- * Returns a boolean.
+ * Return: 1 if voltage range is support, 0 if not, or error number if
+ *	   voltage can't be changed and voltage readback failed.
  */
 int regulator_is_supported_voltage(struct regulator *regulator,
 				   int min_uV, int max_uV)
-- 
2.46.0.295.g3b9ea8a38a-goog

Re: [PATCH 2/8] regulator: core: Fix regulator_is_supported_voltage() kerneldoc return value

[Andy Shevchenko]

On Tue, Aug 27, 2024 at 05:55:42PM +0800, Chen-Yu Tsai wrote:
> The kerneldoc for regulator_is_supported_voltage() states that the
> return value is a boolean. That is not correct, as it could return an
> error number if the check failed.

I don't know what error number means. Is it positive? Negative?

s/error number/negative error code/g
(Here and everywhere else)


> Fix the description by expanding it to cover the true, false and error

true and false are not what is returned, right?

> conditions. The description is also converted to a proper "Return"
> section.

...

> - * Returns a boolean.
> + * Return: 1 if voltage range is support, 0 if not, or error number if

supported

> + *	   voltage can't be changed and voltage readback failed.

-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH 2/8] regulator: core: Fix regulator_is_supported_voltage() kerneldoc return value

[Chen-Yu Tsai]

On Tue, Aug 27, 2024 at 10:35 PM Andy Shevchenko
<andriy.shevchenko@linux.intel.com> wrote:
>
> On Tue, Aug 27, 2024 at 05:55:42PM +0800, Chen-Yu Tsai wrote:
> > The kerneldoc for regulator_is_supported_voltage() states that the
> > return value is a boolean. That is not correct, as it could return an
> > error number if the check failed.
>
> I don't know what error number means. Is it positive? Negative?
>
> s/error number/negative error code/g
> (Here and everywhere else)

Ack. I intended to unify them throughout the series. Looks like I missed
a couple spots.

> > Fix the description by expanding it to cover the true, false and error
>
> true and false are not what is returned, right?

What I meant to describe was true or false with regards to the function
name. I'll try to make it clear.

> > conditions. The description is also converted to a proper "Return"
> > section.
>
> ...
>
> > - * Returns a boolean.
> > + * Return: 1 if voltage range is support, 0 if not, or error number if
>
> supported

Ack.


Thanks
ChenYu

> > + *      voltage can't be changed and voltage readback failed.
>
> --
> With Best Regards,
> Andy Shevchenko
>
>

[PATCH 3/8] regulator: core: Fix incorrectly formatted kerneldoc "Return" sections

[Chen-Yu Tsai]

kernel-doc complains about missing "Return" section for many documented
functions in the regulator core. Many of them actually have descriptions
about the return values, just not in the format kernel-doc wants.

Convert these to use the proper "Return:" section header. The existing
descriptions have been reworded and moved around to fit the grammar and
formatting.

In a few cases where the functions don't call even more functions
and the error numbers are known, those are documented in detail.

Signed-off-by: Chen-Yu Tsai <wenst@chromium.org>
---
 drivers/regulator/core.c | 101 ++++++++++++++++++++++-----------------
 1 file changed, 56 insertions(+), 45 deletions(-)

diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c
index 3a1b6fd9780d..b1950cbc046a 100644
--- a/drivers/regulator/core.c
+++ b/drivers/regulator/core.c
@@ -427,8 +427,9 @@ static void regulator_lock_dependent(struct regulator_dev *rdev,
  *
  * Traverse all child nodes.
  * Extract the child regulator device node corresponding to the supply name.
- * returns the device node corresponding to the regulator if found, else
- * returns NULL.
+ *
+ * Return: pointer the &struct device_node corresponding to the regulator if found,
+ *	   or %NULL if not found.
  */
 static struct device_node *of_get_child_regulator(struct device_node *parent,
 						  const char *prop_name)
@@ -460,8 +461,9 @@ static struct device_node *of_get_child_regulator(struct device_node *parent,
  * @supply: regulator supply name
  *
  * Extract the regulator device node corresponding to the supply name.
- * returns the device node corresponding to the regulator if found, else
- * returns NULL.
+ *
+ * Return: pointer the &struct device_node corresponding to the regulator if found,
+ *	   or %NULL if not found.
  */
 static struct device_node *of_get_regulator(struct device *dev, const char *supply)
 {
@@ -2308,13 +2310,13 @@ struct regulator *_regulator_get(struct device *dev, const char *id,
  * @dev: device for regulator "consumer"
  * @id: Supply name or regulator ID.
  *
- * Returns a struct regulator corresponding to the regulator producer,
- * or IS_ERR() condition containing errno.
- *
  * Use of supply names configured via set_consumer_device_supply() is
  * strongly encouraged.  It is recommended that the supply name used
  * should match the name used for the supply and/or the relevant
  * device pins in the datasheet.
+ *
+ * Return: pointer to a &struct regulator corresponding to the regulator
+ *	   producer, or ERR_PTR() encoded negative error number.
  */
 struct regulator *regulator_get(struct device *dev, const char *id)
 {
@@ -2327,11 +2329,9 @@ EXPORT_SYMBOL_GPL(regulator_get);
  * @dev: device for regulator "consumer"
  * @id: Supply name or regulator ID.
  *
- * Returns a struct regulator corresponding to the regulator producer,
- * or IS_ERR() condition containing errno.  Other consumers will be
- * unable to obtain this regulator while this reference is held and the
- * use count for the regulator will be initialised to reflect the current
- * state of the regulator.
+ * Other consumers will be unable to obtain this regulator while this
+ * reference is held and the use count for the regulator will be
+ * initialised to reflect the current state of the regulator.
  *
  * This is intended for use by consumers which cannot tolerate shared
  * use of the regulator such as those which need to force the
@@ -2342,6 +2342,9 @@ EXPORT_SYMBOL_GPL(regulator_get);
  * strongly encouraged.  It is recommended that the supply name used
  * should match the name used for the supply and/or the relevant
  * device pins in the datasheet.
+ *
+ * Return: pointer to a &struct regulator corresponding to the regulator
+ *	   producer, or ERR_PTR() encoded negative error number.
  */
 struct regulator *regulator_get_exclusive(struct device *dev, const char *id)
 {
@@ -2354,9 +2357,6 @@ EXPORT_SYMBOL_GPL(regulator_get_exclusive);
  * @dev: device for regulator "consumer"
  * @id: Supply name or regulator ID.
  *
- * Returns a struct regulator corresponding to the regulator producer,
- * or IS_ERR() condition containing errno.
- *
  * This is intended for use by consumers for devices which can have
  * some supplies unconnected in normal use, such as some MMC devices.
  * It can allow the regulator core to provide stub supplies for other
@@ -2368,6 +2368,9 @@ EXPORT_SYMBOL_GPL(regulator_get_exclusive);
  * strongly encouraged.  It is recommended that the supply name used
  * should match the name used for the supply and/or the relevant
  * device pins in the datasheet.
+ *
+ * Return: pointer to a &struct regulator corresponding to the regulator
+ *	   producer, or ERR_PTR() encoded negative error number.
  */
 struct regulator *regulator_get_optional(struct device *dev, const char *id)
 {
@@ -2507,12 +2510,12 @@ EXPORT_SYMBOL_GPL(regulator_unregister_supply_alias);
  * lookup the supply
  * @num_id: Number of aliases to register
  *
- * @return 0 on success, an errno on failure.
- *
  * This helper function allows drivers to register several supply
  * aliases in one operation.  If any of the aliases cannot be
  * registered any aliases that were registered will be removed
  * before returning to the caller.
+ *
+ * Return: 0 on success or negative error number on failure.
  */
 int regulator_bulk_register_supply_alias(struct device *dev,
 					 const char *const *id,
@@ -2837,7 +2840,7 @@ static int _regulator_do_enable(struct regulator_dev *rdev)
  * responsible for keeping track of the refcount for a given regulator consumer
  * and applying / unapplying these things.
  *
- * Returns 0 upon no error; -error upon error.
+ * Return: 0 on success or negative error number on failure.
  */
 static int _regulator_handle_consumer_enable(struct regulator *regulator)
 {
@@ -2863,7 +2866,7 @@ static int _regulator_handle_consumer_enable(struct regulator *regulator)
  *
  * The opposite of _regulator_handle_consumer_enable().
  *
- * Returns 0 upon no error; -error upon error.
+ * Return: 0 on success or negative error number on failure.
  */
 static int _regulator_handle_consumer_disable(struct regulator *regulator)
 {
@@ -3271,13 +3274,13 @@ static int _regulator_list_voltage(struct regulator_dev *rdev,
  * regulator_is_enabled - is the regulator output enabled
  * @regulator: regulator source
  *
- * Returns positive if the regulator driver backing the source/client
- * has requested that the device be enabled, zero if it hasn't, else a
- * negative errno code.
- *
  * Note that the device backing this regulator handle can have multiple
  * users, so it might be enabled even if regulator_enable() was never
  * called for this particular source.
+ *
+ * Return: positive if the regulator driver backing the source/client
+ * has requested that the device be enabled, zero if it hasn't, else a
+ * negative error number.
  */
 int regulator_is_enabled(struct regulator *regulator)
 {
@@ -3298,9 +3301,10 @@ EXPORT_SYMBOL_GPL(regulator_is_enabled);
  * regulator_count_voltages - count regulator_list_voltage() selectors
  * @regulator: regulator source
  *
- * Returns number of selectors, or negative errno.  Selectors are
- * numbered starting at zero, and typically correspond to bitfields
- * in hardware registers.
+ * Return: number of selectors for @regulator, or negative error number.
+ *
+ * Selectors are numbered starting at zero, and typically correspond to
+ * bitfields in hardware registers.
  */
 int regulator_count_voltages(struct regulator *regulator)
 {
@@ -3322,9 +3326,9 @@ EXPORT_SYMBOL_GPL(regulator_count_voltages);
  * @selector: identify voltage to list
  * Context: can sleep
  *
- * Returns a voltage that can be passed to @regulator_set_voltage(),
- * zero if this selector code can't be used on this system, or a
- * negative errno.
+ * Return: voltage for @selector that can be passed to regulator_set_voltage(),
+ *	   0 if @selector can't be used on this system, or a negative error
+ *	   number on failure.
  */
 int regulator_list_voltage(struct regulator *regulator, unsigned selector)
 {
@@ -3336,8 +3340,8 @@ EXPORT_SYMBOL_GPL(regulator_list_voltage);
  * regulator_get_regmap - get the regulator's register map
  * @regulator: regulator source
  *
- * Returns the register map for the given regulator, or an ERR_PTR value
- * if the regulator doesn't use regmap.
+ * Return: pointer to &struct regmap for @regulator, or ERR_PTR()
+ *	   encoded -%EOPNOTSUPP if @regulator doesn't use regmap.
  */
 struct regmap *regulator_get_regmap(struct regulator *regulator)
 {
@@ -3387,7 +3391,9 @@ EXPORT_SYMBOL_GPL(regulator_get_hardware_vsel_register);
  * directly written to the regulator registers. The address of the voltage
  * register can be determined by calling @regulator_get_hardware_vsel_register.
  *
- * On error a negative errno is returned.
+ * Return: 0 on success, -%EINVAL if the selector is outside the supported
+ *	   range, or -%EOPNOTSUPP if the regulator does not support voltage
+ *	   selectors.
  */
 int regulator_list_hardware_vsel(struct regulator *regulator,
 				 unsigned selector)
@@ -3414,7 +3420,7 @@ EXPORT_SYMBOL_GPL(regulator_list_hardware_vsel);
  * Request that the regulator be enabled/disabled with the regulator output at
  * the predefined voltage or current value.
  *
- * On success 0 is returned, otherwise a negative errno is returned.
+ * Return: 0 on success or negative error number on failure.
  */
 int regulator_hardware_enable(struct regulator *regulator, bool enable)
 {
@@ -3438,8 +3444,8 @@ EXPORT_SYMBOL_GPL(regulator_hardware_enable);
  * regulator_get_linear_step - return the voltage step size between VSEL values
  * @regulator: regulator source
  *
- * Returns the voltage step size between VSEL values for linear
- * regulators, or return 0 if the regulator isn't a linear regulator.
+ * Return: the voltage step size between VSEL values for linear regulators,
+ *	   or 0 if the regulator isn't a linear regulator.
  */
 unsigned int regulator_get_linear_step(struct regulator *regulator)
 {
@@ -4526,7 +4532,7 @@ EXPORT_SYMBOL_GPL(regulator_get_voltage_rdev);
  * regulator_get_voltage - get regulator output voltage
  * @regulator: regulator source
  *
- * This returns the current regulator voltage in uV.
+ * Return: current regulator voltage in uV, or negative error number on failure.
  *
  * NOTE: If the regulator is disabled it will return the voltage value. This
  * function should not be used to determine regulator state.
@@ -4610,7 +4616,8 @@ static int _regulator_get_current_limit(struct regulator_dev *rdev)
  * regulator_get_current_limit - get regulator output current
  * @regulator: regulator source
  *
- * This returns the current supplied by the specified current sink in uA.
+ * Return: current supplied by the specified current sink in uA,
+ *	   or negative error number on failure.
  *
  * NOTE: If the regulator is disabled it will return the current value. This
  * function should not be used to determine regulator state.
@@ -4778,7 +4785,7 @@ EXPORT_SYMBOL_GPL(regulator_get_error_flags);
  * If a regulator is an always-on regulator then an individual consumer's
  * load will still be removed if that consumer is fully disabled.
  *
- * On error a negative errno is returned.
+ * Return: 0 on success or negative error number on failure.
  */
 int regulator_set_load(struct regulator *regulator, int uA_load)
 {
@@ -4963,12 +4970,12 @@ int _regulator_bulk_get(struct device *dev, int num_consumers,
  * @num_consumers: Number of consumers to register
  * @consumers:     Configuration of consumers; clients are stored here.
  *
- * @return 0 on success, an errno on failure.
- *
  * This helper function allows drivers to get several regulator
  * consumers in one operation.  If any of the regulators cannot be
  * acquired then any regulators that were allocated will be freed
  * before returning to the caller.
+ *
+ * Return: 0 on success or negative error number on failure.
  */
 int regulator_bulk_get(struct device *dev, int num_consumers,
 		       struct regulator_bulk_data *consumers)
@@ -4989,12 +4996,13 @@ static void regulator_bulk_enable_async(void *data, async_cookie_t cookie)
  *
  * @num_consumers: Number of consumers
  * @consumers:     Consumer data; clients are stored here.
- * @return         0 on success, an errno on failure
  *
  * This convenience API allows consumers to enable multiple regulator
  * clients in a single API call.  If any consumers cannot be enabled
  * then any others that were enabled will be disabled again prior to
  * return.
+ *
+ * Return: 0 on success or negative error number on failure.
  */
 int regulator_bulk_enable(int num_consumers,
 			  struct regulator_bulk_data *consumers)
@@ -5038,12 +5046,13 @@ EXPORT_SYMBOL_GPL(regulator_bulk_enable);
  *
  * @num_consumers: Number of consumers
  * @consumers:     Consumer data; clients are stored here.
- * @return         0 on success, an errno on failure
  *
  * This convenience API allows consumers to disable multiple regulator
  * clients in a single API call.  If any consumers cannot be disabled
  * then any others that were disabled will be enabled again prior to
  * return.
+ *
+ * Return: 0 on success or negative error number on failure.
  */
 int regulator_bulk_disable(int num_consumers,
 			   struct regulator_bulk_data *consumers)
@@ -5077,7 +5086,6 @@ EXPORT_SYMBOL_GPL(regulator_bulk_disable);
  *
  * @num_consumers: Number of consumers
  * @consumers:     Consumer data; clients are stored here.
- * @return         0 on success, an errno on failure
  *
  * This convenience API allows consumers to forcibly disable multiple regulator
  * clients in a single API call.
@@ -5085,6 +5093,8 @@ EXPORT_SYMBOL_GPL(regulator_bulk_disable);
  * likely occur if the regulators are not disabled (e.g. over temp).
  * Although regulator_force_disable function call for some consumers can
  * return error numbers, the function is called for all consumers.
+ *
+ * Return: 0 on success or negative error number on failure.
  */
 int regulator_bulk_force_disable(int num_consumers,
 			   struct regulator_bulk_data *consumers)
@@ -5581,8 +5591,9 @@ static struct regulator_coupler generic_regulator_coupler = {
  * @cfg: runtime configuration for regulator
  *
  * Called by regulator drivers to register a regulator.
- * Returns a valid pointer to struct regulator_dev on success
- * or an ERR_PTR() on error.
+ *
+ * Return: pointer to valid &struct regulator_dev on success
+ *	   or ERR_PTR() encoded negative error number on failure.
  */
 struct regulator_dev *
 regulator_register(struct device *dev,
-- 
2.46.0.295.g3b9ea8a38a-goog

Re: [PATCH 3/8] regulator: core: Fix incorrectly formatted kerneldoc "Return" sections

[Andy Shevchenko]

On Tue, Aug 27, 2024 at 05:55:43PM +0800, Chen-Yu Tsai wrote:
> kernel-doc complains about missing "Return" section for many documented
> functions in the regulator core. Many of them actually have descriptions
> about the return values, just not in the format kernel-doc wants.
> 
> Convert these to use the proper "Return:" section header. The existing
> descriptions have been reworded and moved around to fit the grammar and
> formatting.
> 
> In a few cases where the functions don't call even more functions
> and the error numbers are known, those are documented in detail.

...

> + * Return: pointer the &struct device_node corresponding to the regulator if found,

"pointer to the"
Same elsewhere.

> + *	   or %NULL if not found.

...

> + * Return: pointer to a &struct regulator corresponding to the regulator
> + *	   producer, or ERR_PTR() encoded negative error number.

(I'm not sure of definite vs. indefinite article, though. Perhaps you need to
consult with native speaker.)

...

> + *	   producer, or ERR_PTR() encoded negative error number.

Okay, maybe "negative error number" to be used everywhere (see previous email),
the main point is a) to make it clear that it's negative, and b) be consistent
with a term across the subsystem.

-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH 3/8] regulator: core: Fix incorrectly formatted kerneldoc "Return" sections

[Chen-Yu Tsai]

On Tue, Aug 27, 2024 at 10:42 PM Andy Shevchenko
<andriy.shevchenko@linux.intel.com> wrote:
>
> On Tue, Aug 27, 2024 at 05:55:43PM +0800, Chen-Yu Tsai wrote:
> > kernel-doc complains about missing "Return" section for many documented
> > functions in the regulator core. Many of them actually have descriptions
> > about the return values, just not in the format kernel-doc wants.
> >
> > Convert these to use the proper "Return:" section header. The existing
> > descriptions have been reworded and moved around to fit the grammar and
> > formatting.
> >
> > In a few cases where the functions don't call even more functions
> > and the error numbers are known, those are documented in detail.
>
> ...
>
> > + * Return: pointer the &struct device_node corresponding to the regulator if found,
>
> "pointer to the"
> Same elsewhere.

Ack.

> > + *      or %NULL if not found.
>
> ...
>
> > + * Return: pointer to a &struct regulator corresponding to the regulator
> > + *      producer, or ERR_PTR() encoded negative error number.
>
> (I'm not sure of definite vs. indefinite article, though. Perhaps you need to
> consult with native speaker.)

I think "a" makes more sense, because in the case of _regulator_get(),
the |struct regulator| consumer instances are allocated separately on
the fly for each call.

> ...
>
> > + *      producer, or ERR_PTR() encoded negative error number.
>
> Okay, maybe "negative error number" to be used everywhere (see previous email),
> the main point is a) to make it clear that it's negative, and b) be consistent
> with a term across the subsystem.

Ack.


Thanks
ChenYu

Re: [PATCH 3/8] regulator: core: Fix incorrectly formatted kerneldoc "Return" sections

[Mark Brown]

[-- Attachment #1: Type: text/plain, Size: 692 bytes --]

On Wed, Aug 28, 2024 at 04:01:52PM +0800, Chen-Yu Tsai wrote:
> On Tue, Aug 27, 2024 at 10:42 PM Andy Shevchenko
> > On Tue, Aug 27, 2024 at 05:55:43PM +0800, Chen-Yu Tsai wrote:

> > > + * Return: pointer to a &struct regulator corresponding to the regulator
> > > + *      producer, or ERR_PTR() encoded negative error number.

> > (I'm not sure of definite vs. indefinite article, though. Perhaps you need to
> > consult with native speaker.)

> I think "a" makes more sense, because in the case of _regulator_get(),
> the |struct regulator| consumer instances are allocated separately on
> the fly for each call.

Your text is perfectly fine and completely intelligible.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

[PATCH 4/8] regulator: core: Add missing kerneldoc Return sections

[Chen-Yu Tsai]

kernel-doc complains about missing "Return" section for many documented
functions in the regulator core. Some with free-form return value
descriptions have been fixed in the previous patch. The remaining are
completely missing any mention of return values.

Add "Return" sections to these kerneldoc blocks with basic descriptions.
In a few cases where the functions don't call even more functions and
the error numbers are known, those are documented in detail.

Signed-off-by: Chen-Yu Tsai <wenst@chromium.org>
---
 drivers/regulator/core.c | 65 ++++++++++++++++++++++++++++++++++++++--
 1 file changed, 63 insertions(+), 2 deletions(-)

diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c
index b1950cbc046a..1f2303a2ba7b 100644
--- a/drivers/regulator/core.c
+++ b/drivers/regulator/core.c
@@ -139,6 +139,8 @@ static bool regulator_ops_is_valid(struct regulator_dev *rdev, int ops)
  * once. If a task, which is calling this function is other
  * than the one, which initially locked the mutex, it will
  * wait on mutex.
+ *
+ * Return: 0 on success or negative error number on failure.
  */
 static inline int regulator_lock_nested(struct regulator_dev *rdev,
 					struct ww_acquire_ctx *ww_ctx)
@@ -1464,6 +1466,8 @@ static int handle_notify_limits(struct regulator_dev *rdev,
  * Constraints *must* be set by platform code in order for some
  * regulator operations to proceed i.e. set_voltage, set_current_limit,
  * set_mode.
+ *
+ * Return: 0 on success or negative error number on failure.
  */
 static int set_machine_constraints(struct regulator_dev *rdev)
 {
@@ -1702,6 +1706,8 @@ static int set_machine_constraints(struct regulator_dev *rdev)
  * Called by platform initialisation code to set the supply regulator for this
  * regulator. This ensures that a regulators supply will also be enabled by the
  * core if it's child is enabled.
+ *
+ * Return: 0 on success or negative error number on failure.
  */
 static int set_supply(struct regulator_dev *rdev,
 		      struct regulator_dev *supply_rdev)
@@ -1734,6 +1740,8 @@ static int set_supply(struct regulator_dev *rdev,
  * sources to symbolic names for supplies for use by devices.  Devices
  * should use these symbolic names to request regulators, avoiding the
  * need to provide board-specific regulator names as platform data.
+ *
+ * Return: 0 on success or negative error number on failure.
  */
 static int set_consumer_device_supply(struct regulator_dev *rdev,
 				      const char *consumer_dev_name,
@@ -2000,11 +2008,13 @@ static struct regulator_dev *regulator_lookup_by_name(const char *name)
  * @dev: device for regulator "consumer".
  * @supply: Supply name or regulator ID.
  *
+ * Return: pointer to &struct regulator_dev or ERR_PTR() encoded negative error number.
+ *
  * If successful, returns a struct regulator_dev that corresponds to the name
  * @supply and with the embedded struct device refcount incremented by one.
  * The refcount must be dropped by calling put_device().
- * On failure one of the following ERR-PTR-encoded values is returned:
- * -ENODEV if lookup fails permanently, -EPROBE_DEFER if lookup could succeed
+ * On failure one of the following ERR_PTR() encoded values is returned:
+ * -%ENODEV if lookup fails permanently, -%EPROBE_DEFER if lookup could succeed
  * in the future.
  */
 static struct regulator_dev *regulator_dev_lookup(struct device *dev,
@@ -2451,6 +2461,8 @@ EXPORT_SYMBOL_GPL(regulator_put);
  *
  * All lookups for id on dev will instead be conducted for alias_id on
  * alias_dev.
+ *
+ * Return: 0 on success or negative error number on failure.
  */
 int regulator_register_supply_alias(struct device *dev, const char *id,
 				    struct device *alias_dev,
@@ -2640,6 +2652,8 @@ static void regulator_ena_gpio_free(struct regulator_dev *rdev)
  *
  * GPIO is enabled in case of initial use. (enable_count is 0)
  * GPIO is disabled when it is not shared any more. (enable_count <= 1)
+ *
+ * Return: 0 on success or negative error number on failure.
  */
 static int regulator_ena_gpio_ctrl(struct regulator_dev *rdev, bool enable)
 {
@@ -2962,6 +2976,8 @@ static int _regulator_enable(struct regulator *regulator)
  *
  * NOTE: the output value can be set by other drivers, boot loader or may be
  * hardwired in the regulator.
+ *
+ * Return: 0 on success or negative error number on failure.
  */
 int regulator_enable(struct regulator *regulator)
 {
@@ -3072,6 +3088,8 @@ static int _regulator_disable(struct regulator *regulator)
  * NOTE: this will only disable the regulator output if no other consumer
  * devices have it enabled, the regulator device supports disabling and
  * machine constraints permit this operation.
+ *
+ * Return: 0 on success or negative error number on failure.
  */
 int regulator_disable(struct regulator *regulator)
 {
@@ -3121,6 +3139,8 @@ static int _regulator_force_disable(struct regulator_dev *rdev)
  * NOTE: this *will* disable the regulator output even if other consumer
  * devices have it enabled. This should be used for situations when device
  * damage will likely occur if the regulator is not disabled (e.g. over temp).
+ *
+ * Return: 0 on success or negative error number on failure.
  */
 int regulator_force_disable(struct regulator *regulator)
 {
@@ -3203,6 +3223,8 @@ static void regulator_disable_work(struct work_struct *work)
  * NOTE: this will only disable the regulator output if no other consumer
  * devices have it enabled, the regulator device supports disabling and
  * machine constraints permit this operation.
+ *
+ * Return: 0 on success or negative error number on failure.
  */
 int regulator_disable_deferred(struct regulator *regulator, int ms)
 {
@@ -3362,6 +3384,9 @@ EXPORT_SYMBOL_GPL(regulator_get_regmap);
  * hardware or firmware that can make I2C requests behind the kernel's back,
  * for example.
  *
+ * Return: 0 on success, or -%EOPNOTSUPP if the regulator does not support
+ *         voltage selectors.
+ *
  * On success, the output parameters @vsel_reg and @vsel_mask are filled in
  * and 0 is returned, otherwise a negative errno is returned.
  */
@@ -4215,6 +4240,8 @@ static int regulator_balance_voltage(struct regulator_dev *rdev,
  * request voltage that meets the system constraints will be used.
  * Regulator system constraints must be set for this regulator before
  * calling this function otherwise this call will fail.
+ *
+ * Return: 0 on success or negative error number on failure.
  */
 int regulator_set_voltage(struct regulator *regulator, int min_uV, int max_uV)
 {
@@ -4325,6 +4352,8 @@ EXPORT_SYMBOL_GPL(regulator_set_suspend_voltage);
  * Provided with the starting and ending voltage, this function attempts to
  * calculate the time in microseconds required to rise or fall to this new
  * voltage.
+ *
+ * Return: ramp time in microseconds, or negative error number if calculation failed.
  */
 int regulator_set_voltage_time(struct regulator *regulator,
 			       int old_uV, int new_uV)
@@ -4382,6 +4411,8 @@ EXPORT_SYMBOL_GPL(regulator_set_voltage_time);
  *
  * Drivers providing ramp_delay in regulation_constraints can use this as their
  * set_voltage_time_sel() operation.
+ *
+ * Return: ramp time in microseconds, or negative error number if calculation failed.
  */
 int regulator_set_voltage_time_sel(struct regulator_dev *rdev,
 				   unsigned int old_selector,
@@ -4434,6 +4465,8 @@ int regulator_sync_voltage_rdev(struct regulator_dev *rdev)
  * Re-apply the last configured voltage.  This is intended to be used
  * where some external control source the consumer is cooperating with
  * has caused the configured voltage to change.
+ *
+ * Return: 0 on success or negative error number on failure.
  */
 int regulator_sync_voltage(struct regulator *regulator)
 {
@@ -4565,6 +4598,8 @@ EXPORT_SYMBOL_GPL(regulator_get_voltage);
  *
  * NOTE: Regulator system constraints must be set for this regulator before
  * calling this function otherwise this call will fail.
+ *
+ * Return: 0 on success or negative error number on failure.
  */
 int regulator_set_current_limit(struct regulator *regulator,
 			       int min_uA, int max_uA)
@@ -4638,6 +4673,8 @@ EXPORT_SYMBOL_GPL(regulator_get_current_limit);
  *
  * NOTE: Regulator system constraints must be set for this regulator before
  * calling this function otherwise this call will fail.
+ *
+ * Return: 0 on success or negative error number on failure.
  */
 int regulator_set_mode(struct regulator *regulator, unsigned int mode)
 {
@@ -4699,6 +4736,9 @@ static unsigned int _regulator_get_mode(struct regulator_dev *rdev)
  * @regulator: regulator source
  *
  * Get the current regulator operating mode.
+ *
+ * Return: Current operating mode as %REGULATOR_MODE_* values,
+ *	   or negative error number on failure.
  */
 unsigned int regulator_get_mode(struct regulator *regulator)
 {
@@ -4745,6 +4785,8 @@ static int _regulator_get_error_flags(struct regulator_dev *rdev,
  * @flags: pointer to store error flags
  *
  * Get the current regulator error information.
+ *
+ * Return: 0 on success or negative error number on failure.
  */
 int regulator_get_error_flags(struct regulator *regulator,
 				unsigned int *flags)
@@ -4817,6 +4859,9 @@ EXPORT_SYMBOL_GPL(regulator_set_load);
  * for the regulator also enable bypass mode and the machine
  * constraints allow this.  Bypass mode means that the regulator is
  * simply passing the input directly to the output with no regulation.
+ *
+ * Return: 0 on success or if changing bypass is not possible;
+ *	   negative error number on failure.
  */
 int regulator_allow_bypass(struct regulator *regulator, bool enable)
 {
@@ -4874,6 +4919,8 @@ EXPORT_SYMBOL_GPL(regulator_allow_bypass);
  * @nb: notifier block
  *
  * Register notifier block to receive regulator events.
+ *
+ * Return: 0 on success or negative error number on failure.
  */
 int regulator_register_notifier(struct regulator *regulator,
 			      struct notifier_block *nb)
@@ -4889,6 +4936,8 @@ EXPORT_SYMBOL_GPL(regulator_register_notifier);
  * @nb: notifier block
  *
  * Unregister regulator event notifier block.
+ *
+ * Return: 0 on success or negative error number on failure.
  */
 int regulator_unregister_notifier(struct regulator *regulator,
 				struct notifier_block *nb)
@@ -5179,6 +5228,8 @@ static void regulator_handle_critical(struct regulator_dev *rdev,
  *
  * Called by regulator drivers to notify clients a regulator event has
  * occurred.
+ *
+ * Return: %NOTIFY_DONE.
  */
 int regulator_notifier_call_chain(struct regulator_dev *rdev,
 				  unsigned long event, void *data)
@@ -5197,6 +5248,8 @@ EXPORT_SYMBOL_GPL(regulator_notifier_call_chain);
  * @mode: Mode to convert
  *
  * Convert a regulator mode into a status.
+ *
+ * Return: %REGULATOR_STATUS_* value corresponding to given mode.
  */
 int regulator_mode_to_status(unsigned int mode)
 {
@@ -5887,6 +5940,8 @@ EXPORT_SYMBOL_GPL(regulator_unregister);
  * @dev: ``&struct device`` pointer that is passed to _regulator_suspend()
  *
  * Configure each regulator with it's suspend operating parameters for state.
+ *
+ * Return: 0 on success or negative error number on failure.
  */
 static int regulator_suspend(struct device *dev)
 {
@@ -5976,6 +6031,8 @@ EXPORT_SYMBOL_GPL(regulator_has_full_constraints);
  *
  * Get rdev regulator driver private data. This call can be used in the
  * regulator driver context.
+ *
+ * Return: pointer to regulator driver private data.
  */
 void *rdev_get_drvdata(struct regulator_dev *rdev)
 {
@@ -5989,6 +6046,8 @@ EXPORT_SYMBOL_GPL(rdev_get_drvdata);
  *
  * Get regulator driver private data. This call can be used in the consumer
  * driver context when non API regulator specific functions need to be called.
+ *
+ * Return: pointer to regulator driver private data.
  */
 void *regulator_get_drvdata(struct regulator *regulator)
 {
@@ -6010,6 +6069,8 @@ EXPORT_SYMBOL_GPL(regulator_set_drvdata);
 /**
  * rdev_get_id - get regulator ID
  * @rdev: regulator
+ *
+ * Return: regulator ID for @rdev.
  */
 int rdev_get_id(struct regulator_dev *rdev)
 {
-- 
2.46.0.295.g3b9ea8a38a-goog

[PATCH 5/8] regulator: of: Fix incorrectly formatted kerneldoc "Return" sections

[Chen-Yu Tsai]

kernel-doc complains about missing "Return" section for many documented
functions in the regulator OF-specific code. These all have descriptions
about the return values, just not in the format kernel-doc wants.

Convert these to use the proper "Return:" section header. The existing
descriptions have been reworded and moved around to fit the grammar and
formatting.

Signed-off-by: Chen-Yu Tsai <wenst@chromium.org>
---
 drivers/regulator/of_regulator.c | 14 ++++++++------
 1 file changed, 8 insertions(+), 6 deletions(-)

diff --git a/drivers/regulator/of_regulator.c b/drivers/regulator/of_regulator.c
index d557f7b1ec7c..9dab8ee74fde 100644
--- a/drivers/regulator/of_regulator.c
+++ b/drivers/regulator/of_regulator.c
@@ -338,8 +338,10 @@ static int of_get_regulation_constraints(struct device *dev,
  * @desc: regulator description
  *
  * Populates regulator_init_data structure by extracting data from device
- * tree node, returns a pointer to the populated structure or NULL if memory
- * alloc fails.
+ * tree node.
+ *
+ * Return: pointer to populated &struct regulator_init_data or NULL if
+ *	   memory alloc fails.
  */
 struct regulator_init_data *of_get_regulator_init_data(struct device *dev,
 					  struct device_node *node,
@@ -391,7 +393,7 @@ static void devm_of_regulator_put_matches(struct device *dev, void *res)
  * in place and an additional of_node reference is taken for each matched
  * regulator.
  *
- * Returns the number of matches found or a negative error code on failure.
+ * Return: the number of matches found or a negative error code on failure.
  */
 int of_regulator_match(struct device *dev, struct device_node *node,
 		       struct of_regulator_match *matches,
@@ -619,7 +621,7 @@ static bool of_coupling_find_node(struct device_node *src,
  * - all coupled regulators have the same number of regulator_dev phandles
  * - all regulators are linked to each other
  *
- * Returns true if all conditions are met.
+ * Return: true if all conditions are met; false otherwise.
  */
 bool of_check_coupling_data(struct regulator_dev *rdev)
 {
@@ -690,8 +692,8 @@ bool of_check_coupling_data(struct regulator_dev *rdev)
  *	  "regulator-coupled-with" property
  * @index: Index in phandles array
  *
- * Returns the regulator_dev pointer parsed from DTS. If it has not been yet
- * registered, returns NULL
+ * Return: pointer to &struct regulator_dev parsed from DTS, or %NULL if
+ *	   it has not yet been registered.
  */
 struct regulator_dev *of_parse_coupled_regulator(struct regulator_dev *rdev,
 						 int index)
-- 
2.46.0.295.g3b9ea8a38a-goog

[PATCH 6/8] regulator: fixed: Fix incorrectly formatted kerneldoc "Return" section

[Chen-Yu Tsai]

kernel-doc complains about missing "Return" section for kerneldoc of
of_get_fixed_voltage_config(). The kerneldoc has a description
about the return values, just not in the format kernel-doc wants.

Convert it to use the proper "Return:" section header. The existing
description have been reworded and moved around to fit the grammar and
formatting.

Signed-off-by: Chen-Yu Tsai <wenst@chromium.org>
---
 drivers/regulator/fixed.c | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/drivers/regulator/fixed.c b/drivers/regulator/fixed.c
index cb93e5cdcfa9..1629aa525ef2 100644
--- a/drivers/regulator/fixed.c
+++ b/drivers/regulator/fixed.c
@@ -158,8 +158,10 @@ static int reg_fixed_get_irqs(struct device *dev,
  * @desc: regulator description
  *
  * Populates fixed_voltage_config structure by extracting data from device
- * tree node, returns a pointer to the populated structure of NULL if memory
- * alloc fails.
+ * tree node.
+ *
+ * Return: pointer to populated &struct fixed_voltage_config or %NULL if
+ *	   memory alloc fails.
  */
 static struct fixed_voltage_config *
 of_get_fixed_voltage_config(struct device *dev,
-- 
2.46.0.295.g3b9ea8a38a-goog

Re: [PATCH 6/8] regulator: fixed: Fix incorrectly formatted kerneldoc "Return" section

[Andy Shevchenko]

On Tue, Aug 27, 2024 at 05:55:46PM +0800, Chen-Yu Tsai wrote:
> kernel-doc complains about missing "Return" section for kerneldoc of
> of_get_fixed_voltage_config(). The kerneldoc has a description
> about the return values, just not in the format kernel-doc wants.
> 
> Convert it to use the proper "Return:" section header. The existing
> description have been reworded and moved around to fit the grammar and
> formatting.

...

> + * Return: pointer to populated &struct fixed_voltage_config or %NULL if

Seems to me this should be "pointer to the"

> + *	   memory alloc fails.

-- 
With Best Regards,
Andy Shevchenko

[PATCH 7/8] regulator: fixed-helper: Add missing "Return" kerneldoc section

[Chen-Yu Tsai]

kernel-doc complains about missing "Return" section for the function
regulator_register_always_on().

Add a "Return" section for it based on its behavior.

Signed-off-by: Chen-Yu Tsai <wenst@chromium.org>
---
 drivers/regulator/fixed-helper.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/drivers/regulator/fixed-helper.c b/drivers/regulator/fixed-helper.c
index 2d5a42b2b3d8..72807af63126 100644
--- a/drivers/regulator/fixed-helper.c
+++ b/drivers/regulator/fixed-helper.c
@@ -26,6 +26,8 @@ static void regulator_fixed_release(struct device *dev)
  * @supplies: consumers for this regulator
  * @num_supplies: number of consumers
  * @uv: voltage in microvolts
+ *
+ * Return: pointer to registered platform device, or %NULL if memory alloc fails.
  */
 struct platform_device *regulator_register_always_on(int id, const char *name,
 	struct regulator_consumer_supply *supplies, int num_supplies, int uv)
-- 
2.46.0.295.g3b9ea8a38a-goog

Re: [PATCH 7/8] regulator: fixed-helper: Add missing "Return" kerneldoc section

[Andy Shevchenko]

On Tue, Aug 27, 2024 at 05:55:47PM +0800, Chen-Yu Tsai wrote:
> kernel-doc complains about missing "Return" section for the function
> regulator_register_always_on().
> 
> Add a "Return" section for it based on its behavior.

...

> + * Return: pointer to registered platform device, or %NULL if memory alloc fails.

s/alloc/allocation/


-- 
With Best Regards,
Andy Shevchenko

[PATCH 8/8] regulator: irq_helpers: Add missing "Return" kerneldoc section

[Chen-Yu Tsai]

kernel-doc complains about missing "Return" section for the function
regulator_irq_map_event_simple().

Add a "Return" section for it based on its behavior.

Signed-off-by: Chen-Yu Tsai <wenst@chromium.org>
---
 drivers/regulator/irq_helpers.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/drivers/regulator/irq_helpers.c b/drivers/regulator/irq_helpers.c
index 5ab1a0befe12..5803ef016b7d 100644
--- a/drivers/regulator/irq_helpers.c
+++ b/drivers/regulator/irq_helpers.c
@@ -414,6 +414,10 @@ EXPORT_SYMBOL_GPL(regulator_irq_helper_cancel);
  * notification helperk. Exactly one rdev and exactly one error (in
  * "common_errs"-field) can be given at IRQ helper registration for
  * regulator_irq_map_event_simple() to be viable.
+ *
+ * Return: 0
+ *
+ * Actual regulator error and notification are passed back through @rid.
  */
 int regulator_irq_map_event_simple(int irq, struct regulator_irq_data *rid,
 			    unsigned long *dev_mask)
-- 
2.46.0.295.g3b9ea8a38a-goog

Re: [PATCH 8/8] regulator: irq_helpers: Add missing "Return" kerneldoc section

[Andy Shevchenko]

On Tue, Aug 27, 2024 at 05:55:48PM +0800, Chen-Yu Tsai wrote:
> kernel-doc complains about missing "Return" section for the function
> regulator_irq_map_event_simple().
> 
> Add a "Return" section for it based on its behavior.

...

> + * Return: 0

"0."

> + *

I don't think we need this blank line.

> + * Actual regulator error and notification are passed back through @rid.

-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH 8/8] regulator: irq_helpers: Add missing "Return" kerneldoc section

[Chen-Yu Tsai]

On Tue, Aug 27, 2024 at 10:44 PM Andy Shevchenko
<andriy.shevchenko@linux.intel.com> wrote:
>
> On Tue, Aug 27, 2024 at 05:55:48PM +0800, Chen-Yu Tsai wrote:
> > kernel-doc complains about missing "Return" section for the function
> > regulator_irq_map_event_simple().
> >
> > Add a "Return" section for it based on its behavior.
>
> ...
>
> > + * Return: 0
>
> "0."

Ack.

> > + *
>
> I don't think we need this blank line.

This actually changes the output. Without the blank line, they are treated
as the same paragraph. With the blank line, the next line is treated as
a separate paragraph, and put in the "Description" section.

Strictly speaking, the only return value is the 0 integer. The other
"return" values are output parameters that have been modified by the
function. I believe those should not be in the "Return" section.


ChenYu


> > + * Actual regulator error and notification are passed back through @rid.
>
> --
> With Best Regards,
> Andy Shevchenko
>
>

Re: [PATCH 8/8] regulator: irq_helpers: Add missing "Return" kerneldoc section

[Andy Shevchenko]

On Wed, Aug 28, 2024 at 03:50:55PM +0800, Chen-Yu Tsai wrote:
> On Tue, Aug 27, 2024 at 10:44 PM Andy Shevchenko
> <andriy.shevchenko@linux.intel.com> wrote:
> > On Tue, Aug 27, 2024 at 05:55:48PM +0800, Chen-Yu Tsai wrote:

...

> > > + * Return: 0
> >
> > "0."
> 
> Ack.
> 
> > > + *
> >
> > I don't think we need this blank line.
> 
> This actually changes the output. Without the blank line, they are treated
> as the same paragraph. With the blank line, the next line is treated as
> a separate paragraph, and put in the "Description" section.

I see, then please make sure that description either annotated with
"Description:" or comes _before_ "Return:". that's why it confused me and I
though it's related to the "Return:" section.

> Strictly speaking, the only return value is the 0 integer. The other
> "return" values are output parameters that have been modified by the
> function. I believe those should not be in the "Return" section.
> 
> > > + * Actual regulator error and notification are passed back through @rid.

-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH 8/8] regulator: irq_helpers: Add missing "Return" kerneldoc section

[Matti Vaittinen]

On 8/27/24 12:55, Chen-Yu Tsai wrote:
> kernel-doc complains about missing "Return" section for the function
> regulator_irq_map_event_simple().
> 
> Add a "Return" section for it based on its behavior.
> 
> Signed-off-by: Chen-Yu Tsai <wenst@chromium.org>

Thank You for improving this! I appreciate it :)

> ---
>   drivers/regulator/irq_helpers.c | 4 ++++
>   1 file changed, 4 insertions(+)
> 
> diff --git a/drivers/regulator/irq_helpers.c b/drivers/regulator/irq_helpers.c
> index 5ab1a0befe12..5803ef016b7d 100644
> --- a/drivers/regulator/irq_helpers.c
> +++ b/drivers/regulator/irq_helpers.c
> @@ -414,6 +414,10 @@ EXPORT_SYMBOL_GPL(regulator_irq_helper_cancel);
>    * notification helperk. Exactly one rdev and exactly one error (in

I just noticed (an existing) typo "helperk". I wonder if it was Ok to 
fix it while anyways changing the doc. It's not strictly speaking 
related to the return values though :)

>    * "common_errs"-field) can be given at IRQ helper registration for
>    * regulator_irq_map_event_simple() to be viable.
> + *
> + * Return: 0
> + *
Anyways, I agree with Andy about not needing the blank line here - but 
other than that:

Reviewed-by: Matti Vaittinen <mazziesaccount@gmail.com>

> + * Actual regulator error and notification are passed back through @rid.
>    */
>   int regulator_irq_map_event_simple(int irq, struct regulator_irq_data *rid,
>   			    unsigned long *dev_mask)

-- 
Matti Vaittinen
Linux kernel developer at ROHM Semiconductors
Oulu Finland

~~ When things go utterly wrong vim users can always type :help! ~~

Re: [PATCH 8/8] regulator: irq_helpers: Add missing "Return" kerneldoc section

[Chen-Yu Tsai]

On Wed, Aug 28, 2024 at 1:55 PM Matti Vaittinen
<mazziesaccount@gmail.com> wrote:
>
> On 8/27/24 12:55, Chen-Yu Tsai wrote:
> > kernel-doc complains about missing "Return" section for the function
> > regulator_irq_map_event_simple().
> >
> > Add a "Return" section for it based on its behavior.
> >
> > Signed-off-by: Chen-Yu Tsai <wenst@chromium.org>
>
> Thank You for improving this! I appreciate it :)
>
> > ---
> >   drivers/regulator/irq_helpers.c | 4 ++++
> >   1 file changed, 4 insertions(+)
> >
> > diff --git a/drivers/regulator/irq_helpers.c b/drivers/regulator/irq_helpers.c
> > index 5ab1a0befe12..5803ef016b7d 100644
> > --- a/drivers/regulator/irq_helpers.c
> > +++ b/drivers/regulator/irq_helpers.c
> > @@ -414,6 +414,10 @@ EXPORT_SYMBOL_GPL(regulator_irq_helper_cancel);
> >    * notification helperk. Exactly one rdev and exactly one error (in
>
> I just noticed (an existing) typo "helperk". I wonder if it was Ok to
> fix it while anyways changing the doc. It's not strictly speaking
> related to the return values though :)

Why not? Only the kerneldoc this function is touched. It looks like the
'k' belongs to the "callbac" on the previous line.

> >    * "common_errs"-field) can be given at IRQ helper registration for
> >    * regulator_irq_map_event_simple() to be viable.
> > + *
> > + * Return: 0
> > + *
> Anyways, I agree with Andy about not needing the blank line here - but

I disagree because of the formatting result. See my other reply.

> other than that:
>
> Reviewed-by: Matti Vaittinen <mazziesaccount@gmail.com>
>
> > + * Actual regulator error and notification are passed back through @rid.
> >    */
> >   int regulator_irq_map_event_simple(int irq, struct regulator_irq_data *rid,
> >                           unsigned long *dev_mask)
>
> --
> Matti Vaittinen
> Linux kernel developer at ROHM Semiconductors
> Oulu Finland
>
> ~~ When things go utterly wrong vim users can always type :help! ~~
>

Re: [PATCH 8/8] regulator: irq_helpers: Add missing "Return" kerneldoc section

[Matti Vaittinen]

ke 28. elok. 2024 klo 10.53 Chen-Yu Tsai (wenst@chromium.org) kirjoitti:
>
> On Wed, Aug 28, 2024 at 1:55 PM Matti Vaittinen
> <mazziesaccount@gmail.com> wrote:
> >
> > On 8/27/24 12:55, Chen-Yu Tsai wrote:
> > > kernel-doc complains about missing "Return" section for the function
> > > regulator_irq_map_event_simple().
> > >
> > > Add a "Return" section for it based on its behavior.
> > >
> > > Signed-off-by: Chen-Yu Tsai <wenst@chromium.org>
> >
> > Thank You for improving this! I appreciate it :)
> >
> > > ---
> > >   drivers/regulator/irq_helpers.c | 4 ++++
> > >   1 file changed, 4 insertions(+)
> > >
> > > diff --git a/drivers/regulator/irq_helpers.c b/drivers/regulator/irq_helpers.c
> > > index 5ab1a0befe12..5803ef016b7d 100644
> > > --- a/drivers/regulator/irq_helpers.c
> > > +++ b/drivers/regulator/irq_helpers.c
> > > @@ -414,6 +414,10 @@ EXPORT_SYMBOL_GPL(regulator_irq_helper_cancel);
> > >    * notification helperk. Exactly one rdev and exactly one error (in
> >
> > I just noticed (an existing) typo "helperk". I wonder if it was Ok to
> > fix it while anyways changing the doc. It's not strictly speaking
> > related to the return values though :)
>
> Why not? Only the kerneldoc this function is touched. It looks like the
> 'k' belongs to the "callbac" on the previous line.

Right. It'd be nice if you fixed the typo as well if you for some
reason re-spin this.

> > >    * "common_errs"-field) can be given at IRQ helper registration for
> > >    * regulator_irq_map_event_simple() to be viable.
> > > + *
> > > + * Return: 0
> > > + *
> > Anyways, I agree with Andy about not needing the blank line here - but
>
> I disagree because of the formatting result. See my other reply.

Fair enough. The "errors" or "notifications" indeed don't tell if this
specific function has failed.
So, if you feel the @rid is not documented well enough, maybe add a note in the
respective parameter documentation instead of leaving it alone at the
bottom of the doc?

Well, I don't have a strong opinion on this so you can keep the RB tag
also with the blank line.

Yours,
  -- Matti

Re: [PATCH 0/8] regulator: kerneldoc section fixes

[Andy Shevchenko]

On Tue, Aug 27, 2024 at 05:55:40PM +0800, Chen-Yu Tsai wrote:
> Hi,
> 
> Here are a bunch of kerneldoc fixes for the regulator core. This sort of
> came as a request from Andy to not move code that already had warnings

You can add Reported-by: or Suggested-by to the cover letter.

> without fixing said warnings. So here I'm fixing them first.
> 
> The bulk of the fixes are in the regulator core and OF code, but I also
> fixed up a few bits in common code that were missing "Return" sections.
> These are purely kerneldoc fixes and don't touch any actual code. I left
> the devres code and helpers alone for now.

Thanks for doing this!

I briefly looked at them, the main two remarks are:
1) definite vs. indefinite article;
2) same and consistent term for negative error codes (or numbers if you
prefer).

Otherwise LGTM!

-- 
With Best Regards,
Andy Shevchenko