Skip to contentSkip to conversation

ACPI / watchdog: Fix two reported issues

PATCH Applied Mika Westerberg 4 participants 9 messages Feb 12, 2020 – Feb 13, 2020

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

v2 cover ACPI / watchdog: Fix two reported issues

Hi,

This is an updated version of the patch series posted here:

https://lore.kernel.org/linux-watchdog/[email protected]/

This should fix the two issues reported by Jean Delvare. I also addressed all the review comments and fixed the bugs in the previous version.

This time I actually tested these on Intel Joule board and the watchdog still works as expected.

I'm now including ACPICA maintainers as well to get some feedback regarding the first patch of the series.

Mika Westerberg (3):
ACPICA: Introduce ACPI_ACCESS_BYTE_WIDTH() macro ACPI / watchdog: Fix gas->access_width usage ACPI / watchdog: Set default timeout in probe

 drivers/acpi/acpi_watchdog.c |  3 +--
 drivers/watchdog/wdat_wdt.c  | 25 ++++++++++++++++++++++++-
 include/acpi/actypes.h       |  3 ++-
 3 files changed, 27 insertions(+), 4 deletions(-)
Signature · 1 line
2.25.0
#1 lore raw

PATCH v2 1/3 ACPICA: Introduce ACPI_ACCESS_BYTE_WIDTH() macro

Sometimes it is useful to find the access_width field value in bytes and not in bits so add a helper that can be used for this purpose.

---
 include/acpi/actypes.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
include/acpi/actypes.h +2 -1
index a2583c2bc054..4defed58ea33 100644
@@ -532,11 +532,12 @@ typedef u64 acpi_integer;
 	 strnlen (a, ACPI_NAMESEG_SIZE) == ACPI_NAMESEG_SIZE)
 
 /*
- * Algorithm to obtain access bit width.
+ * Algorithm to obtain access bit or byte width.
  * Can be used with access_width of struct acpi_generic_address and access_size of
  * struct acpi_resource_generic_register.
  */
 #define ACPI_ACCESS_BIT_WIDTH(size)     (1 << ((size) + 2))
+#define ACPI_ACCESS_BYTE_WIDTH(size)    (1 << ((size) - 1))
 
 /*******************************************************************************
  *
Signature · 1 line
2.25.0
#3 lore raw

PATCH v2 2/3 ACPI / watchdog: Fix gas->access_width usage

In reply to Mika Westerberg

ACPI Generic Address Structure (GAS) access_width field is not in bytes as the driver seems to expect in few places so fix this by using the newly introduced macro ACPI_ACCESS_BYTE_WIDTH().

Fixes b1abf6fc4982 ("ACPI / watchdog: Fix off-by-one error at resource assignment")
Fixes 058dfc767008 ("ACPI / watchdog: Add support for WDAT hardware watchdog")
---
 drivers/acpi/acpi_watchdog.c | 3 +--
 drivers/watchdog/wdat_wdt.c  | 2 +-
 2 files changed, 2 insertions(+), 3 deletions(-)
drivers/acpi/acpi_watchdog.c +1 -2
index b5516b04ffc0..d827a4a3e946 100644
@@ -126,12 +126,11 @@ void __init acpi_watchdog_init(void)
 		gas = &entries[i].register_region;
 
 		res.start = gas->address;
+		res.end = res.start + ACPI_ACCESS_BYTE_WIDTH(gas->access_width) - 1;
 		if (gas->space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY) {
 			res.flags = IORESOURCE_MEM;
-			res.end = res.start + ALIGN(gas->access_width, 4) - 1;
 		} else if (gas->space_id == ACPI_ADR_SPACE_SYSTEM_IO) {
 			res.flags = IORESOURCE_IO;
-			res.end = res.start + gas->access_width - 1;
 		} else {
 			pr_warn("Unsupported address space: %u\n",
 				gas->space_id);
drivers/watchdog/wdat_wdt.c +1 -1
index b069349b52f5..e1b1fcfc02af 100644
@@ -389,7 +389,7 @@ static int wdat_wdt_probe(struct platform_device *pdev)
 
 		memset(&r, 0, sizeof(r));
 		r.start = gas->address;
-		r.end = r.start + gas->access_width - 1;
+		r.end = r.start + ACPI_ACCESS_BYTE_WIDTH(gas->access_width) - 1;
 		if (gas->space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY) {
 			r.flags = IORESOURCE_MEM;
 		} else if (gas->space_id == ACPI_ADR_SPACE_SYSTEM_IO) {
Signature · 1 line
2.25.0
#6 lore raw

PATCH v2 3/3 ACPI / watchdog: Set default timeout in probe

In reply to Mika Westerberg

If the BIOS default timeout for the watchdog is too small userspace may not have enough time to configure new timeout after opening the device before the system is already reset. For this reason program default timeout of 30 seconds in the driver probe and allow userspace to change this from command line or through module parameter (wdat_wdt.timeout).

---
 drivers/watchdog/wdat_wdt.c | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
drivers/watchdog/wdat_wdt.c +23 -0
index e1b1fcfc02af..3065dd670a18 100644
@@ -54,6 +54,13 @@ module_param(nowayout, bool, 0);
 MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default="
 		 __MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
 
+#define WDAT_DEFAULT_TIMEOUT	30
+
+static int timeout = WDAT_DEFAULT_TIMEOUT;
+module_param(timeout, int, 0);
+MODULE_PARM_DESC(timeout, "Watchdog timeout in seconds (default="
+		 __MODULE_STRING(WDAT_DEFAULT_TIMEOUT) ")");
+
 static int wdat_wdt_read(struct wdat_wdt *wdat,
 	 const struct wdat_instruction *instr, u32 *value)
 {
@@ -438,6 +445,22 @@ static int wdat_wdt_probe(struct platform_device *pdev)
 
 	platform_set_drvdata(pdev, wdat);
 
+	/*
+	 * Set initial timeout so that userspace has time to configure the
+	 * watchdog properly after it has opened the device. In some cases
+	 * the BIOS default is too short and causes immediate reboot.
+	 */
+	if (timeout * 1000 < wdat->wdd.min_hw_heartbeat_ms ||
+	    timeout * 1000 > wdat->wdd.max_hw_heartbeat_ms) {
+		dev_warn(dev, "Invalid timeout %d given, using %d\n",
+			 timeout, WDAT_DEFAULT_TIMEOUT);
+		timeout = WDAT_DEFAULT_TIMEOUT;
+	}
+
+	ret = wdat_wdt_set_timeout(&wdat->wdd, timeout);
+	if (ret)
+		return ret;
+
 	watchdog_set_nowayout(&wdat->wdd, nowayout);
 	return devm_watchdog_register_device(dev, &wdat->wdd);
 }
Signature · 1 line
2.25.0
Reviewed-by on v2 2/3
#4 lore raw

Re: [PATCH v2 2/3] ACPI / watchdog: Fix gas->access_width usage

In reply to Mika Westerberg
Quoted 5 lines · Mika Westerberg

ACPI Generic Address Structure (GAS) access_width field is not in bytes as the driver seems to expect in few places so fix this by using the newly introduced macro ACPI_ACCESS_BYTE_WIDTH().

Fixes b1abf6fc4982 ("ACPI / watchdog: Fix off-by-one error at resource assignment")

It does not actually fix that commit, as the bug already existed prior to it. It has to be applied on top of that commit though because they touch the same lines, granted.

Quoted 31 lines
Fixes 058dfc767008 ("ACPI / watchdog: Add support for WDAT hardware watchdog")
---
 drivers/acpi/acpi_watchdog.c | 3 +--
 drivers/watchdog/wdat_wdt.c  | 2 +-
 2 files changed, 2 insertions(+), 3 deletions(-)
drivers/acpi/acpi_watchdog.c +1 -2
index b5516b04ffc0..d827a4a3e946 100644
@@ -126,12 +126,11 @@ void __init acpi_watchdog_init(void)
 		gas = &entries[i].register_region;
 
 		res.start = gas->address;
+		res.end = res.start + ACPI_ACCESS_BYTE_WIDTH(gas->access_width) - 1;
 		if (gas->space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY) {
 			res.flags = IORESOURCE_MEM;
-			res.end = res.start + ALIGN(gas->access_width, 4) - 1;
 		} else if (gas->space_id == ACPI_ADR_SPACE_SYSTEM_IO) {
 			res.flags = IORESOURCE_IO;
-			res.end = res.start + gas->access_width - 1;
 		} else {
 			pr_warn("Unsupported address space: %u\n",
 				gas->space_id);
drivers/watchdog/wdat_wdt.c +0 -0
index b069349b52f5..e1b1fcfc02af 100644

drivers/watchdog/wdat_wdt.c static int wdat_wdt_probe(struct platform_device *pdev) · line 395

Quoted 8 lines
drivers/watchdog/wdat_wdt.c +1 -1
@@ -389,7 +389,7 @@ static int wdat_wdt_probe(struct platform_device *pdev)
 
 		memset(&r, 0, sizeof(r));
 		r.start = gas->address;
-		r.end = r.start + gas->access_width - 1;
+		r.end = r.start + ACPI_ACCESS_BYTE_WIDTH(gas->access_width) - 1;
 		if (gas->space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY) {
 			r.flags = IORESOURCE_MEM;
 		} else if (gas->space_id == ACPI_ADR_SPACE_SYSTEM_IO) {
Signature · 2 lines
Jean Delvare
SUSE L3 Support
Reviewed-by on v2 3/3
#7 lore raw

Re: [PATCH v2 3/3] ACPI / watchdog: Set default timeout in probe

In reply to Mika Westerberg
Quoted 43 lines · Mika Westerberg

If the BIOS default timeout for the watchdog is too small userspace may not have enough time to configure new timeout after opening the device before the system is already reset. For this reason program default timeout of 30 seconds in the driver probe and allow userspace to change this from command line or through module parameter (wdat_wdt.timeout).

---
 drivers/watchdog/wdat_wdt.c | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
drivers/watchdog/wdat_wdt.c +16 -0
index e1b1fcfc02af..3065dd670a18 100644
@@ -54,6 +54,13 @@ module_param(nowayout, bool, 0);
 MODULE_PARM_DESC(nowayout, "Watchdog cannot be stopped once started (default="
 		 __MODULE_STRING(WATCHDOG_NOWAYOUT) ")");
 
+#define WDAT_DEFAULT_TIMEOUT	30
+
+static int timeout = WDAT_DEFAULT_TIMEOUT;
+module_param(timeout, int, 0);
+MODULE_PARM_DESC(timeout, "Watchdog timeout in seconds (default="
+		 __MODULE_STRING(WDAT_DEFAULT_TIMEOUT) ")");
+
 static int wdat_wdt_read(struct wdat_wdt *wdat,
 	 const struct wdat_instruction *instr, u32 *value)
 {
@@ -438,6 +445,22 @@ static int wdat_wdt_probe(struct platform_device *pdev)
 
 	platform_set_drvdata(pdev, wdat);
 
+	/*
+	 * Set initial timeout so that userspace has time to configure the
+	 * watchdog properly after it has opened the device. In some cases
+	 * the BIOS default is too short and causes immediate reboot.
+	 */
+	if (timeout * 1000 < wdat->wdd.min_hw_heartbeat_ms ||
+	    timeout * 1000 > wdat->wdd.max_hw_heartbeat_ms) {
+		dev_warn(dev, "Invalid timeout %d given, using %d\n",
+			 timeout, WDAT_DEFAULT_TIMEOUT);

drivers/watchdog/wdat_wdt.c static int wdat_wdt_probe(struct platform_device *pdev) · line 466

Quoted 10 lines
drivers/watchdog/wdat_wdt.c +7 -0
+		timeout = WDAT_DEFAULT_TIMEOUT;
+	}
+
+	ret = wdat_wdt_set_timeout(&wdat->wdd, timeout);
+	if (ret)
+		return ret;
+
 	watchdog_set_nowayout(&wdat->wdd, nowayout);
 	return devm_watchdog_register_device(dev, &wdat->wdd);
 }

Thanks Mika!

Signature · 2 lines
Jean Delvare
SUSE L3 Support
#5 lore raw

Re: [PATCH v2 2/3] ACPI / watchdog: Fix gas->access_width usage

In reply to Jean Delvare
Quoted 10 lines · Jean Delvare
Quoted 5 lines · Mika Westerberg

ACPI Generic Address Structure (GAS) access_width field is not in bytes as the driver seems to expect in few places so fix this by using the newly introduced macro ACPI_ACCESS_BYTE_WIDTH().

Fixes b1abf6fc4982 ("ACPI / watchdog: Fix off-by-one error at resource assignment")

It does not actually fix that commit, as the bug already existed prior to it. It has to be applied on top of that commit though because they touch the same lines, granted.

Yeah, I figured I should put the dependency commit here as well. I guess Depends-on can be used as well:

Depends-on: b1abf6fc4982 ("ACPI / watchdog: Fix off-by-one error at resource assignment")

Quoted 32 lines
Quoted 32 lines
Fixes 058dfc767008 ("ACPI / watchdog: Add support for WDAT hardware watchdog")
---
 drivers/acpi/acpi_watchdog.c | 3 +--
 drivers/watchdog/wdat_wdt.c  | 2 +-
 2 files changed, 2 insertions(+), 3 deletions(-)
drivers/acpi/acpi_watchdog.c +1 -2
index b5516b04ffc0..d827a4a3e946 100644
@@ -126,12 +126,11 @@ void __init acpi_watchdog_init(void)
 		gas = &entries[i].register_region;
 
 		res.start = gas->address;
+		res.end = res.start + ACPI_ACCESS_BYTE_WIDTH(gas->access_width) - 1;
 		if (gas->space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY) {
 			res.flags = IORESOURCE_MEM;
-			res.end = res.start + ALIGN(gas->access_width, 4) - 1;
 		} else if (gas->space_id == ACPI_ADR_SPACE_SYSTEM_IO) {
 			res.flags = IORESOURCE_IO;
-			res.end = res.start + gas->access_width - 1;
 		} else {
 			pr_warn("Unsupported address space: %u\n",
 				gas->space_id);
drivers/watchdog/wdat_wdt.c +0 -0
index b069349b52f5..e1b1fcfc02af 100644
@@ -389,7 +389,7 @@ static int wdat_wdt_probe(struct platform_device *pdev)
 
Quoted 9 lines

drivers/watchdog/wdat_wdt.c static int wdat_wdt_probe(struct platform_device *pdev) · line 395

Quoted 7 lines
drivers/watchdog/wdat_wdt.c +1 -1
 		memset(&r, 0, sizeof(r));
 		r.start = gas->address;
-		r.end = r.start + gas->access_width - 1;
+		r.end = r.start + ACPI_ACCESS_BYTE_WIDTH(gas->access_width) - 1;
 		if (gas->space_id == ACPI_ADR_SPACE_SYSTEM_MEMORY) {
 			r.flags = IORESOURCE_MEM;
 		} else if (gas->space_id == ACPI_ADR_SPACE_SYSTEM_IO) {

Thanks!

Reviewed-by Jean Delvare on v2 1/3
#2 lore raw

RE: [PATCH v2 1/3] ACPICA: Introduce ACPI_ACCESS_BYTE_WIDTH() macro

In reply to Mika Westerberg

-----Original Message-----
From: Mika Westerberg <[email protected]>
Sent: Wednesday, February 12, 2020 7:00 AM
To: Jean Delvare <[email protected]>; Rafael J. Wysocki <[email protected]>
Cc: Len Brown <[email protected]>; [email protected]; Wim Van Sebroeck <[email protected]>; Guenter Roeck <[email protected]>; [email protected]; Moore, Robert <[email protected]>; Kaneda, Erik <[email protected]>; Tom Abraham <[email protected]>; Mika Westerberg <[email protected]>
Subject: [PATCH v2 1/3] ACPICA: Introduce ACPI_ACCESS_BYTE_WIDTH() macro

Sometimes it is useful to find the access_width field value in bytes and not in bits so add a helper that can be used for this purpose.

---
 include/acpi/actypes.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
include/acpi/actypes.h +2 -1
@@ -532,11 +532,12 @@ typedef u64 acpi_integer;
 	 strnlen (a, ACPI_NAMESEG_SIZE) == ACPI_NAMESEG_SIZE)
 
 /*
- * Algorithm to obtain access bit width.
+ * Algorithm to obtain access bit or byte width.
  * Can be used with access_width of struct acpi_generic_address and access_size of
  * struct acpi_resource_generic_register.
  */
 #define ACPI_ACCESS_BIT_WIDTH(size)     (1 << ((size) + 2))
+#define ACPI_ACCESS_BYTE_WIDTH(size)    (1 << ((size) - 1))
 

OK, we've taken this one into ACPICA.
Thanks,
Bob

/*******************************************************************************
*
--
2.25.0

maintainer Applied
#8 lore raw
In reply to Mika Westerberg
Quoted 13 lines · Mika Westerberg

Hi,

This is an updated version of the patch series posted here:

https://lore.kernel.org/linux-watchdog/[email protected]/

This should fix the two issues reported by Jean Delvare. I also addressed all the review comments and fixed the bugs in the previous version.

This time I actually tested these on Intel Joule board and the watchdog still works as expected.

Quoted 7 lines

I'm now including ACPICA maintainers as well to get some feedback regarding the first patch of the series.

Mika Westerberg (3):
ACPICA: Introduce ACPI_ACCESS_BYTE_WIDTH() macro ACPI / watchdog: Fix gas->access_width usage ACPI / watchdog: Set default timeout in probe

Applied as fixes for 5.6, thanks!