[PATCH] power: reset: gpio-poweroff: Clarify the warning message

[PATCH] power: reset: gpio-poweroff: Clarify the warning message

[Fabio Estevam]

When gpio-poweroff fails, a WARN_ON() is triggered without
an explanation to the user about the failure.

Add some comments explaining that the attempt to poweroff the system
via gpio-poweroff failed and convert it to a WARN() message with a
bit of context to provide some hint to the user.

Signed-off-by: Fabio Estevam <festevam@gmail.com>
---
 drivers/power/reset/gpio-poweroff.c | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/drivers/power/reset/gpio-poweroff.c b/drivers/power/reset/gpio-poweroff.c
index 52cfeee2cb28..3eaae352ffb9 100644
--- a/drivers/power/reset/gpio-poweroff.c
+++ b/drivers/power/reset/gpio-poweroff.c
@@ -44,7 +44,13 @@ static int gpio_poweroff_do_poweroff(struct sys_off_data *data)
 	/* give it some time */
 	mdelay(gpio_poweroff->timeout_ms);
 
-	WARN_ON(1);
+	/*
+	 * If code reaches this point, it means that gpio-poweroff has failed
+	 * to actually power off the system.
+	 * Warn the user that the attempt to poweroff via gpio-poweroff
+	 * has gone wrong.
+	 */
+	WARN(1, "Failed to poweroff via gpio-poweroff mechanism\n");
 
 	return NOTIFY_DONE;
 }
-- 
2.34.1

Re: [PATCH] power: reset: gpio-poweroff: Clarify the warning message

[Sebastian Reichel]

On Thu, 12 Dec 2024 10:04:56 -0300, Fabio Estevam wrote:
> When gpio-poweroff fails, a WARN_ON() is triggered without
> an explanation to the user about the failure.
> 
> Add some comments explaining that the attempt to poweroff the system
> via gpio-poweroff failed and convert it to a WARN() message with a
> bit of context to provide some hint to the user.
> 
> [...]

Applied, thanks!

[1/1] power: reset: gpio-poweroff: Clarify the warning message
      commit: 8a1c099f36b256c8203319313f65666ce0043fe5

Best regards,
-- 
Sebastian Reichel <sebastian.reichel@collabora.com>