2023-11-23 14:48:23

by Luca Ceresoli

Subject: [PATCH] of: dynamic: Fix of_reconfig_get_state_change() return value documentation

The documented numeric return values do not match the actual returned
values. Fix them by using the enum names instead of raw numbers.

Fixes: b53a2340d0d3 ("of/reconfig: Add of_reconfig_get_state_change() of notifier helper.")
Signed-off-by: Luca Ceresoli <[email protected]>
---
drivers/of/dynamic.c | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/drivers/of/dynamic.c b/drivers/of/dynamic.c
index 0a3483e247a8..a5afe14eef28 100644
--- a/drivers/of/dynamic.c
+++ b/drivers/of/dynamic.c
@@ -98,8 +98,9 @@ int of_reconfig_notify(unsigned long action, struct of_reconfig_data *p)
*
* Returns the new state of a device based on the notifier used.
*
- * Return: 0 on device going from enabled to disabled, 1 on device
- * going from disabled to enabled and -1 on no change.
+ * Return: OF_RECONFIG_CHANGE_REMOVE on device going from enabled to
+ * disabled, OF_RECONFIG_CHANGE_ADD on device going from disabled to
+ * enabled and OF_RECONFIG_NO_CHANGE on no change.
*/
int of_reconfig_get_state_change(unsigned long action, struct of_reconfig_data *pr)
{

---
base-commit: f364a65e37ec9e57809642b00b39e7a530d9cbde
change-id: 20231123-fix-of_reconfig_get_state_change-docs-d08d45d1d493

Best regards,
--
Luca Ceresoli <[email protected]>

2023-11-27 20:47:59

by Rob Herring (Arm)

Subject: Re: [PATCH] of: dynamic: Fix of_reconfig_get_state_change() return value documentation

On Thu, 23 Nov 2023 15:47:18 +0100, Luca Ceresoli wrote:
> The documented numeric return values do not match the actual returned
> values. Fix them by using the enum names instead of raw numbers.
>
> Fixes: b53a2340d0d3 ("of/reconfig: Add of_reconfig_get_state_change() of notifier helper.")
> Signed-off-by: Luca Ceresoli <[email protected]>
> ---
> drivers/of/dynamic.c | 5 +++--
> 1 file changed, 3 insertions(+), 2 deletions(-)
>

Applied, thanks!