Skip to contentSkip to conversation

wifi: ath11k: Add a warning for wcn6855 spurious wakeup events

PATCH In review Mario Limonciello 2 participants 7 messages Feb 20, 2023 – Apr 5, 2023

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

PATCH 1/1 wifi: ath11k: Add a warning for wcn6855 spurious wakeup events

When WCN6855 firmware versions less than 0x110B196E are used with an AMD APU and the user puts the system into s2idle spurious wakeup events can occur. These are difficult to attribute to the WLAN F/W so add a warning to the kernel driver to give users a hint where to look.

This was tested on WCN6855 and a Lenovo Z13 with the following firmware versions:
WLAN.HSP.1.1-03125-QCAHSPSWPL_V1_V2_SILICONZ_LITE-3.6510.9 WLAN.HSP.1.1-03125-QCAHSPSWPL_V1_V2_SILICONZ_LITE-3.6510.23

---
 drivers/net/wireless/ath/ath11k/pci.c | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)
drivers/net/wireless/ath/ath11k/pci.c +26 -0
index 99cf3357c66e..87536327e214 100644
@@ -8,6 +8,7 @@
 #include <linux/msi.h>
 #include <linux/pci.h>
 #include <linux/of.h>
+#include <linux/suspend.h>
 
 #include "pci.h"
 #include "core.h"
@@ -27,6 +28,8 @@
 #define QCN9074_DEVICE_ID		0x1104
 #define WCN6855_DEVICE_ID		0x1103
 
+#define WCN6855_S2IDLE_VER		0x110b196e
+
 static const struct pci_device_id ath11k_pci_id_table[] = {
 	{ PCI_VDEVICE(QCOM, QCA6390_DEVICE_ID) },
 	{ PCI_VDEVICE(QCOM, WCN6855_DEVICE_ID) },
@@ -965,6 +968,27 @@ static void ath11k_pci_shutdown(struct pci_dev *pdev)
 	ath11k_pci_power_down(ab);
 }
 
+static void ath11k_check_s2idle_bug(struct ath11k_base *ab)
+{
+	struct pci_dev *rdev;
+
+	if (pm_suspend_target_state != PM_SUSPEND_TO_IDLE)
+		return;
+
+	if (ab->id.device != WCN6855_DEVICE_ID)
+		return;
+
+	if (ab->qmi.target.fw_version >= WCN6855_S2IDLE_VER)
+		return;
+
+	rdev = pci_get_domain_bus_and_slot(0, 0, PCI_DEVFN(0, 0));
+	if (rdev->vendor == PCI_VENDOR_ID_AMD)
+		ath11k_warn(ab, "fw_version 0x%x may cause spurious wakeups. Upgrade to 0x%x or later.",
+			    ab->qmi.target.fw_version, WCN6855_S2IDLE_VER);
+
+	pci_dev_put(rdev);
+}
+
 static __maybe_unused int ath11k_pci_pm_suspend(struct device *dev)
 {
 	struct ath11k_base *ab = dev_get_drvdata(dev);
@@ -975,6 +999,8 @@ static __maybe_unused int ath11k_pci_pm_suspend(struct device *dev)
 		return 0;
 	}
 
+	ath11k_check_s2idle_bug(ab);
+
 	ret = ath11k_core_suspend(ab);
 	if (ret)
 		ath11k_warn(ab, "failed to suspend core: %d\n", ret);
Signature · 1 line
2.34.1
#1 lore raw
Quoted 16 lines · Mario Limonciello

When WCN6855 firmware versions less than 0x110B196E are used with an AMD APU and the user puts the system into s2idle spurious wakeup events can occur. These are difficult to attribute to the WLAN F/W so add a warning to the kernel driver to give users a hint where to look.

This was tested on WCN6855 and a Lenovo Z13 with the following firmware versions:
WLAN.HSP.1.1-03125-QCAHSPSWPL_V1_V2_SILICONZ_LITE-3.6510.9 WLAN.HSP.1.1-03125-QCAHSPSWPL_V1_V2_SILICONZ_LITE-3.6510.23

[...]

Quoted 7 lines
drivers/net/wireless/ath/ath11k/pci.c +7 -0
+static void ath11k_check_s2idle_bug(struct ath11k_base *ab)
+{
+	struct pci_dev *rdev;
+
+	if (pm_suspend_target_state != PM_SUSPEND_TO_IDLE)
+		return;
+

drivers/net/wireless/ath/ath11k/pci.c static void ath11k_pci_shutdown(struct pci_dev *pdev) · line 987

Quoted 10 lines
drivers/net/wireless/ath/ath11k/pci.c +10 -0
+	if (ab->id.device != WCN6855_DEVICE_ID)
+		return;
+
+	if (ab->qmi.target.fw_version >= WCN6855_S2IDLE_VER)
+		return;
+
+	rdev = pci_get_domain_bus_and_slot(0, 0, PCI_DEVFN(0, 0));
+	if (rdev->vendor == PCI_VENDOR_ID_AMD)
+		ath11k_warn(ab, "fw_version 0x%x may cause spurious wakeups. Upgrade to 0x%x or later.",
+			    ab->qmi.target.fw_version, WCN6855_S2IDLE_VER);

I understand the reasons for this warning but I don't really trust the check 'ab->qmi.target.fw_version >= WCN6855_S2IDLE_VER'. I don't know how the firmware team populates the fw_version so I'm worried that if we ever switch to a different firmware branch (or similar) this warning might all of sudden start triggering for the users.

Signature · 8 lines
https://patchwork.kernel.org/project/linux-wireless/list/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches

-- 
ath11k mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/ath11k
#2 lore raw
Quoted 36 lines · Kalle Valo
Quoted 16 lines · Mario Limonciello

When WCN6855 firmware versions less than 0x110B196E are used with an AMD APU and the user puts the system into s2idle spurious wakeup events can occur. These are difficult to attribute to the WLAN F/W so add a warning to the kernel driver to give users a hint where to look.

This was tested on WCN6855 and a Lenovo Z13 with the following firmware versions:
WLAN.HSP.1.1-03125-QCAHSPSWPL_V1_V2_SILICONZ_LITE-3.6510.9 WLAN.HSP.1.1-03125-QCAHSPSWPL_V1_V2_SILICONZ_LITE-3.6510.23

[...]

Quoted 15 lines
drivers/net/wireless/ath/ath11k/pci.c +15 -0
+static void ath11k_check_s2idle_bug(struct ath11k_base *ab)
+{
+	struct pci_dev *rdev;
+
+	if (pm_suspend_target_state != PM_SUSPEND_TO_IDLE)
+		return;
+
+	if (ab->id.device != WCN6855_DEVICE_ID)
+		return;
+
+	if (ab->qmi.target.fw_version >= WCN6855_S2IDLE_VER)
+		return;
+
+	rdev = pci_get_domain_bus_and_slot(0, 0, PCI_DEVFN(0, 0));
+	if (rdev->vendor == PCI_VENDOR_ID_AMD)
Quoted 9 lines

drivers/net/wireless/ath/ath11k/pci.c static void ath11k_pci_shutdown(struct pci_dev *pdev) · line 987

Quoted 2 lines
drivers/net/wireless/ath/ath11k/pci.c +2 -0
+		ath11k_warn(ab, "fw_version 0x%x may cause spurious wakeups. Upgrade to 0x%x or later.",
+			    ab->qmi.target.fw_version, WCN6855_S2IDLE_VER);

I understand the reasons for this warning but I don't really trust the check 'ab->qmi.target.fw_version >= WCN6855_S2IDLE_VER'. I don't know how the firmware team populates the fw_version so I'm worried that if we ever switch to a different firmware branch (or similar) this warning might all of sudden start triggering for the users.

In that case, maybe would it be better to just have a list of the public firmware with issue and ensure it doesn't match one of those?

Signature · 3 lines
ath11k mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/ath11k
#3 lore raw
Quoted 50 lines · Mario Limonciello
Quoted 38 lines · Kalle Valo
Quoted 17 lines · Mario Limonciello

When WCN6855 firmware versions less than 0x110B196E are used with an AMD APU and the user puts the system into s2idle spurious wakeup events can occur. These are difficult to attribute to the WLAN F/W so add a warning to the kernel driver to give users a hint where to look.

This was tested on WCN6855 and a Lenovo Z13 with the following firmware versions:
WLAN.HSP.1.1-03125-QCAHSPSWPL_V1_V2_SILICONZ_LITE-3.6510.9 WLAN.HSP.1.1-03125-QCAHSPSWPL_V1_V2_SILICONZ_LITE-3.6510.23

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

[...]

Quoted 16 lines
drivers/net/wireless/ath/ath11k/pci.c +16 -0
+static void ath11k_check_s2idle_bug(struct ath11k_base *ab)
+{
+	struct pci_dev *rdev;
+
+	if (pm_suspend_target_state != PM_SUSPEND_TO_IDLE)
+		return;
+
+	if (ab->id.device != WCN6855_DEVICE_ID)
+		return;
+
+	if (ab->qmi.target.fw_version >= WCN6855_S2IDLE_VER)
+		return;
+
+	rdev = pci_get_domain_bus_and_slot(0, 0, PCI_DEVFN(0, 0));
+	if (rdev->vendor == PCI_VENDOR_ID_AMD)
+ ath11k_warn(ab, "fw_version 0x%x may cause spurious wakeups.
Quoted 9 lines

drivers/net/wireless/ath/ath11k/pci.c static void ath11k_pci_shutdown(struct pci_dev *pdev) · line 987

Quoted 2 lines

Upgrade to 0x%x or later.",

drivers/net/wireless/ath/ath11k/pci.c +1 -0
+			    ab->qmi.target.fw_version, WCN6855_S2IDLE_VER);

I understand the reasons for this warning but I don't really trust the check 'ab->qmi.target.fw_version >= WCN6855_S2IDLE_VER'. I don't know how the firmware team populates the fw_version so I'm worried that if we ever switch to a different firmware branch (or similar) this warning might all of sudden start triggering for the users.

Quoted 2 lines

In that case, maybe would it be better to just have a list of the public firmware with issue and ensure it doesn't match one of those?

You mean ath11k checking for known broken versions and reporting that? We have so many different firmwares to support in ath11k, I'm not really keen on adding tests for a specific version.

We have a list of known important bugs in the wiki:

https://wireless.wiki.kernel.org/en/users/drivers/ath11k#known_bugslimitations

What about adding the issue there, would that get more exposure to the bug and hopefully the users would upgrade the firmware?

Signature · 8 lines
https://patchwork.kernel.org/project/linux-wireless/list/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches

-- 
ath11k mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/ath11k
#4 lore raw
Quoted 52 lines · Kalle Valo
Quoted 50 lines · Mario Limonciello
Quoted 47 lines · Kalle Valo
Quoted 17 lines · Mario Limonciello

When WCN6855 firmware versions less than 0x110B196E are used with an AMD APU and the user puts the system into s2idle spurious wakeup events can occur. These are difficult to attribute to the WLAN F/W so add a warning to the kernel driver to give users a hint where to look.

This was tested on WCN6855 and a Lenovo Z13 with the following firmware versions:
WLAN.HSP.1.1-03125-QCAHSPSWPL_V1_V2_SILICONZ_LITE-3.6510.9 WLAN.HSP.1.1-03125-QCAHSPSWPL_V1_V2_SILICONZ_LITE-3.6510.23

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

[...]

Quoted 17 lines
drivers/net/wireless/ath/ath11k/pci.c +16 -0
+static void ath11k_check_s2idle_bug(struct ath11k_base *ab)
+{
+	struct pci_dev *rdev;
+
+	if (pm_suspend_target_state != PM_SUSPEND_TO_IDLE)
+		return;
+
+	if (ab->id.device != WCN6855_DEVICE_ID)
+		return;
+
+	if (ab->qmi.target.fw_version >= WCN6855_S2IDLE_VER)
+		return;
+
+	rdev = pci_get_domain_bus_and_slot(0, 0, PCI_DEVFN(0, 0));
+	if (rdev->vendor == PCI_VENDOR_ID_AMD)
+ ath11k_warn(ab, "fw_version 0x%x may cause spurious wakeups.

Upgrade to 0x%x or later.",

drivers/net/wireless/ath/ath11k/pci.c static void ath11k_pci_shutdown(struct pci_dev *pdev) · line 987

Quoted 1 line
drivers/net/wireless/ath/ath11k/pci.c +1 -0
+			    ab->qmi.target.fw_version, WCN6855_S2IDLE_VER);

I understand the reasons for this warning but I don't really trust the check 'ab->qmi.target.fw_version >= WCN6855_S2IDLE_VER'. I don't know how the firmware team populates the fw_version so I'm worried that if we ever switch to a different firmware branch (or similar) this warning might all of sudden start triggering for the users.

Quoted 6 lines
Quoted 2 lines

In that case, maybe would it be better to just have a list of the public firmware with issue and ensure it doesn't match one of those?

You mean ath11k checking for known broken versions and reporting that? We have so many different firmwares to support in ath11k, I'm not really keen on adding tests for a specific version.

I checked and only found a total of 7 firmware versions published for WCN6855 at your ath11k-firmware repo. I'm not sure how many went to linux-firmware. But it seems like a relatively small list to have.

Quoted 8 lines

We have a list of known important bugs in the wiki:

https://wireless.wiki.kernel.org/en/users/drivers/ath11k#known_bugslimitations

What about adding the issue there, would that get more exposure to the bug and hopefully the users would upgrade the firmware?

The problem is when this happens users have no way to know it's even caused by wireless. So why would they go looking at the wireless wiki?

The GPIO used for WLAN is different from design to design so we can't put it in the GPIO driver. There are plenty of designs that have valid reasons to wakeup from other GPIOs as well so it can't just be the GPIO driver IRQ.

Signature · 3 lines
ath11k mailing list
[email protected]
http://lists.infradead.org/mailman/listinfo/ath11k
#5 lore raw
Quoted 37 lines · Mario Limonciello
Quoted 35 lines · Kalle Valo
Quoted 32 lines · Mario Limonciello
Quoted 18 lines · Kalle Valo
Quoted 16 lines · Mario Limonciello
drivers/net/wireless/ath/ath11k/pci.c +16 -0
+static void ath11k_check_s2idle_bug(struct ath11k_base *ab)
+{
+	struct pci_dev *rdev;
+
+	if (pm_suspend_target_state != PM_SUSPEND_TO_IDLE)
+		return;
+
+	if (ab->id.device != WCN6855_DEVICE_ID)
+		return;
+
+	if (ab->qmi.target.fw_version >= WCN6855_S2IDLE_VER)
+		return;
+
+	rdev = pci_get_domain_bus_and_slot(0, 0, PCI_DEVFN(0, 0));
+	if (rdev->vendor == PCI_VENDOR_ID_AMD)
+ ath11k_warn(ab, "fw_version 0x%x may cause spurious wakeups.
Quoted 9 lines

drivers/net/wireless/ath/ath11k/pci.c static void ath11k_pci_shutdown(struct pci_dev *pdev) · line 987

Quoted 2 lines

Upgrade to 0x%x or later.",

drivers/net/wireless/ath/ath11k/pci.c +1 -0
+			    ab->qmi.target.fw_version, WCN6855_S2IDLE_VER);

I understand the reasons for this warning but I don't really trust the check 'ab->qmi.target.fw_version >= WCN6855_S2IDLE_VER'. I don't know how the firmware team populates the fw_version so I'm worried that if we ever switch to a different firmware branch (or similar) this warning might all of sudden start triggering for the users.

In that case, maybe would it be better to just have a list of the public firmware with issue and ensure it doesn't match one of those?

Quoted 7 lines
Quoted 3 lines

You mean ath11k checking for known broken versions and reporting that? We have so many different firmwares to support in ath11k, I'm not really keen on adding tests for a specific version.

I checked and only found a total of 7 firmware versions published for WCN6855 at your ath11k-firmware repo. I'm not sure how many went to linux-firmware. But it seems like a relatively small list to have.

ath11k supports also other hardware families than just WCN6855, so there are a lot of different firmware versions and branches.

Quoted 8 lines
Quoted 7 lines

We have a list of known important bugs in the wiki:

https://wireless.wiki.kernel.org/en/users/drivers/ath11k#known_bugslimitations

What about adding the issue there, would that get more exposure to the bug and hopefully the users would upgrade the firmware?

Quoted 8 lines

The problem is when this happens users have no way to know it's even caused by wireless. So why would they go looking at the wireless wiki?

The GPIO used for WLAN is different from design to design so we can't put it in the GPIO driver. There are plenty of designs that have valid reasons to wakeup from other GPIOs as well so it can't just be the GPIO driver IRQ.

I understand your problem but my problem is that I have three Qualcomm drivers to support and that's a major challenge itself. So I try to keep the drivers as simple as possible and avoid any hacks.

Signature · 3 lines
https://patchwork.kernel.org/project/linux-wireless/list/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches
#6 lore raw

[Public]

Quoted 45 lines
Quoted 8 lines · Kalle Valo
Quoted 7 lines
Quoted 4 lines · Mario Limonciello
Quoted 2 lines · Kalle Valo

Mario Limonciello <[email protected]> writes:

Quoted 14 lines
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
Quoted 6 lines
drivers/net/wireless/ath/ath11k/pci.c +6 -0
+static void ath11k_check_s2idle_bug(struct ath11k_base *ab)
+{
+	struct pci_dev *rdev;
+
+	if (pm_suspend_target_state != PM_SUSPEND_TO_IDLE)
+		return;
Quoted 8 lines
Quoted 8 lines
Quoted 8 lines

drivers/net/wireless/ath/ath11k/pci.c static void ath11k_pci_shutdown(struct pci_dev *pdev)

Quoted 8 lines
drivers/net/wireless/ath/ath11k/pci.c +8 -0
+
+	if (ab->id.device != WCN6855_DEVICE_ID)
+		return;
+
+	if (ab->qmi.target.fw_version >= WCN6855_S2IDLE_VER)
+		return;
+
+	rdev = pci_get_domain_bus_and_slot(0, 0, PCI_DEVFN(0,

0));

Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines

Review

Quoted 4 lines
(quoted diff) +2 -0
+	if (rdev->vendor == PCI_VENDOR_ID_AMD)
+ ath11k_warn(ab, "fw_version 0x%x may cause spurious wakeups.

Upgrade to 0x%x or later.",

(quoted diff) +1 -0
+			    ab->qmi.target.fw_version,

WCN6855_S2IDLE_VER);

Quoted 3 lines
Quoted 3 lines
Quoted 3 lines
Quoted 3 lines

I understand the reasons for this warning but I don't really trust the check 'ab->qmi.target.fw_version >= WCN6855_S2IDLE_VER'. I don't

know

Quoted 1 line
Quoted 1 line
Quoted 1 line
Quoted 1 line

how the firmware team populates the fw_version so I'm worried that if

we

Quoted 11 lines
Quoted 10 lines
Quoted 6 lines
Quoted 3 lines

ever switch to a different firmware branch (or similar) this warning might all of sudden start triggering for the users.

In that case, maybe would it be better to just have a list of the public firmware with issue and ensure it doesn't match one of those?

You mean ath11k checking for known broken versions and reporting that? We have so many different firmwares to support in ath11k, I'm not really keen on adding tests for a specific version.

Quoted 6 lines
Quoted 3 lines

I checked and only found a total of 7 firmware versions published for WCN6855 at your ath11k-firmware repo. I'm not sure how many went to linux-firmware. But it seems like a relatively small list to have.

ath11k supports also other hardware families than just WCN6855, so there are a lot of different firmware versions and branches.

Right, but this change was explicitly checking the device ID matched WCN6855.

So it could be a single check for that device and any of the 5 bad firmware binaries.

Quoted 15 lines
Quoted 4 lines
Quoted 4 lines

We have a list of known important bugs in the wiki:

https://wireless.wiki.kernel.org/en/users/drivers/ath11k#known_bugslimita
tions

Quoted 9 lines
Quoted 4 lines

What about adding the issue there, would that get more exposure to the bug and hopefully the users would upgrade the firmware?

The problem is when this happens users have no way to know it's even caused by wireless. So why would they go looking at the wireless wiki?

Quoted 8 lines
Quoted 4 lines

The GPIO used for WLAN is different from design to design so we can't put it in the GPIO driver. There are plenty of designs that have valid reasons to wakeup from other GPIOs as well so it can't just be the GPIO driver IRQ.

I understand your problem but my problem is that I have three Qualcomm drivers to support and that's a major challenge itself. So I try to keep the drivers as simple as possible and avoid any hacks.

OK.