[PATCH v2 08/10] regulator: irq_helpers: Fix regulator_irq_map_event_simple() kerneldoc
Chen-Yu Tsai
wenst at chromium.org
Thu Aug 29 01:51:28 PDT 2024
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. The function
actually always returns 0, but fills in fields in its @rid parameter as
needed. Expand the description of the parameter to cover this.
While at it fix a typo found in the description of the same function.
Reported-by: Matti Vaittinen <mazziesaccount at gmail.com>
Closes: https://lore.kernel.org/all/e341240e-1c1f-49a2-91cd-440888fdbda0@gmail.com/
Signed-off-by: Chen-Yu Tsai <wenst at chromium.org>
---
Changes since v1:
- Update commit subject to reflect changes
- Was 'regulator: irq_helpers: Add missing "Return" kerneldoc section'
- Add period ('.') to the end of the "Return" section sentence
- Fix typo in function description spotted by Marti
- Describe output fields in @rid clearly
---
drivers/regulator/irq_helpers.c | 15 ++++++++++-----
1 file changed, 10 insertions(+), 5 deletions(-)
diff --git a/drivers/regulator/irq_helpers.c b/drivers/regulator/irq_helpers.c
index 5ab1a0befe12..2de7b907c81d 100644
--- a/drivers/regulator/irq_helpers.c
+++ b/drivers/regulator/irq_helpers.c
@@ -404,16 +404,21 @@ EXPORT_SYMBOL_GPL(regulator_irq_helper_cancel);
/**
* regulator_irq_map_event_simple - regulator IRQ notification for trivial IRQs
*
- * @irq: Number of IRQ that occurred
- * @rid: Information about the event IRQ indicates
- * @dev_mask: mask indicating the regulator originating the IRQ
+ * @irq: Number of IRQ that occurred.
+ * @rid: Information about the event IRQ indicates.
+ * The function fills in the ®ulator_err_state->notifs
+ * and ®ulator_err_state->errors fields of
+ * ®ulator_irq_data->states as output.
+ * @dev_mask: mask indicating the regulator originating the IRQ.
*
* Regulators whose IRQ has single, well defined purpose (always indicate
* exactly one event, and are relevant to exactly one regulator device) can
- * use this function as their map_event callbac for their regulator IRQ
- * notification helperk. Exactly one rdev and exactly one error (in
+ * use this function as their map_event callback for their regulator IRQ
+ * notification helper. 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.
*/
int regulator_irq_map_event_simple(int irq, struct regulator_irq_data *rid,
unsigned long *dev_mask)
--
2.46.0.295.g3b9ea8a38a-goog
More information about the linux-arm-kernel
mailing list