2021-05-22 13:21:47

by Jonas Dreßler

[permalink] [raw]
Subject: [RFC PATCH 0/3] mwifiex: Add quirks for MS Surface devices


This series is based on the patches from Tsuchiya Yuto which have been
submitted previously already, where it was suggested to cc linux-pci and
Bjorn to ask if there's a better way of doing those quirks.

Original series sent in by Tsuchiya: https://lore.kernel.org/linux-wireless/[email protected]/

Here's the summary written by Tsuchiya:

This series adds firmware reset quirks for Microsoft Surface devices
(PCIe-88W8897). Surface devices somehow requires quirks to reset the
firmware. Otherwise, current mwifiex driver can reset only software level.
This is not enough to recover from a bad state.

To do so, in the first patch, I added a DMI-based quirk implementation
for Surface devices that use mwifiex chip.

The required quirk is different by generation. Surface gen3 devices
(Surface 3 and Surface Pro 3) require a quirk that calls _DSM method
(the third patch).
Note that Surface Pro 3 is not yet supported because of the difference
between Surface 3. On Surface 3, the wifi card will be immediately
removed/reprobed after the _DSM call. On the other hand, Surface Pro 3
doesn't. Need to remove/reprobe wifi card ourselves. This behavior makes
the support difficult.

Surface gen4+ devices (Surface Pro 4 and later) require a quirk that
puts wifi into D3cold before FLR.

While here, created new files for quirks (mwifiex/pcie_quirks.c and
mwifiex/pcie_quirks.h) because the changes are a little bit too big to
add into pcie.c.

Jonas Dreßler (1):
mwifiex: pcie: add DMI-based quirk implementation for Surface devices

Tsuchiya Yuto (2):
mwifiex: pcie: add reset_d3cold quirk for Surface gen4+ devices
mwifiex: pcie: add reset_wsid quirk for Surface 3

drivers/net/wireless/marvell/mwifiex/Makefile | 1 +
drivers/net/wireless/marvell/mwifiex/pcie.c | 21 ++
drivers/net/wireless/marvell/mwifiex/pcie.h | 1 +
.../wireless/marvell/mwifiex/pcie_quirks.c | 246 ++++++++++++++++++
.../wireless/marvell/mwifiex/pcie_quirks.h | 17 ++
5 files changed, 286 insertions(+)
create mode 100644 drivers/net/wireless/marvell/mwifiex/pcie_quirks.c
create mode 100644 drivers/net/wireless/marvell/mwifiex/pcie_quirks.h

--
2.31.1


2021-05-22 13:22:32

by Jonas Dreßler

[permalink] [raw]
Subject: [RFC PATCH 2/3] mwifiex: pcie: add reset_d3cold quirk for Surface gen4+ devices

From: Tsuchiya Yuto <[email protected]>

To reset mwifiex on Surface gen4+ (Pro 4 or later gen) devices, it
seems that putting the wifi device into D3cold is required according
to errata.inf file on Windows installation (Windows/INF/errata.inf).

This patch adds a function that performs power-cycle (put into D3cold
then D0) and call the function at the end of reset_prepare().

Note: Need to also reset the parent device (bridge) of wifi on SB1;
it might be because the bridge of wifi always reports it's in D3hot.
When I tried to reset only the wifi device (not touching parent), it gave
the following error and the reset failed:

acpi device:4b: Cannot transition to power state D0 for parent in D3hot
mwifiex_pcie 0000:03:00.0: can't change power state from D3cold to D0 (config space inaccessible)

Signed-off-by: Tsuchiya Yuto <[email protected]>
Signed-off-by: Jonas Dreßler <[email protected]>
---
drivers/net/wireless/marvell/mwifiex/pcie.c | 7 +
.../wireless/marvell/mwifiex/pcie_quirks.c | 123 ++++++++++++++++++
.../wireless/marvell/mwifiex/pcie_quirks.h | 3 +
3 files changed, 133 insertions(+)

diff --git a/drivers/net/wireless/marvell/mwifiex/pcie.c b/drivers/net/wireless/marvell/mwifiex/pcie.c
index 02fdce926de5..d9acfea395ad 100644
--- a/drivers/net/wireless/marvell/mwifiex/pcie.c
+++ b/drivers/net/wireless/marvell/mwifiex/pcie.c
@@ -528,6 +528,13 @@ static void mwifiex_pcie_reset_prepare(struct pci_dev *pdev)
mwifiex_shutdown_sw(adapter);
clear_bit(MWIFIEX_IFACE_WORK_DEVICE_DUMP, &card->work_flags);
clear_bit(MWIFIEX_IFACE_WORK_CARD_RESET, &card->work_flags);
+
+ /* For Surface gen4+ devices, we need to put wifi into D3cold right
+ * before performing FLR
+ */
+ if (card->quirks & QUIRK_FW_RST_D3COLD)
+ mwifiex_pcie_reset_d3cold_quirk(pdev);
+
mwifiex_dbg(adapter, INFO, "%s, successful\n", __func__);

card->pci_reset_ongoing = true;
diff --git a/drivers/net/wireless/marvell/mwifiex/pcie_quirks.c b/drivers/net/wireless/marvell/mwifiex/pcie_quirks.c
index 4064f99b36ba..b5f214fc1212 100644
--- a/drivers/net/wireless/marvell/mwifiex/pcie_quirks.c
+++ b/drivers/net/wireless/marvell/mwifiex/pcie_quirks.c
@@ -15,6 +15,72 @@

/* quirk table based on DMI matching */
static const struct dmi_system_id mwifiex_quirk_table[] = {
+ {
+ .ident = "Surface Pro 4",
+ .matches = {
+ DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
+ DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Pro 4"),
+ },
+ .driver_data = (void *)QUIRK_FW_RST_D3COLD,
+ },
+ {
+ .ident = "Surface Pro 5",
+ .matches = {
+ /* match for SKU here due to generic product name "Surface Pro" */
+ DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
+ DMI_EXACT_MATCH(DMI_PRODUCT_SKU, "Surface_Pro_1796"),
+ },
+ .driver_data = (void *)QUIRK_FW_RST_D3COLD,
+ },
+ {
+ .ident = "Surface Pro 5 (LTE)",
+ .matches = {
+ /* match for SKU here due to generic product name "Surface Pro" */
+ DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
+ DMI_EXACT_MATCH(DMI_PRODUCT_SKU, "Surface_Pro_1807"),
+ },
+ .driver_data = (void *)QUIRK_FW_RST_D3COLD,
+ },
+ {
+ .ident = "Surface Pro 6",
+ .matches = {
+ DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
+ DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Pro 6"),
+ },
+ .driver_data = (void *)QUIRK_FW_RST_D3COLD,
+ },
+ {
+ .ident = "Surface Book 1",
+ .matches = {
+ DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
+ DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Book"),
+ },
+ .driver_data = (void *)QUIRK_FW_RST_D3COLD,
+ },
+ {
+ .ident = "Surface Book 2",
+ .matches = {
+ DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
+ DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Book 2"),
+ },
+ .driver_data = (void *)QUIRK_FW_RST_D3COLD,
+ },
+ {
+ .ident = "Surface Laptop 1",
+ .matches = {
+ DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
+ DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Laptop"),
+ },
+ .driver_data = (void *)QUIRK_FW_RST_D3COLD,
+ },
+ {
+ .ident = "Surface Laptop 2",
+ .matches = {
+ DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
+ DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Laptop 2"),
+ },
+ .driver_data = (void *)QUIRK_FW_RST_D3COLD,
+ },
{}
};

@@ -29,4 +95,61 @@ void mwifiex_initialize_quirks(struct pcie_service_card *card)

if (!card->quirks)
dev_info(&pdev->dev, "no quirks enabled\n");
+ if (card->quirks & QUIRK_FW_RST_D3COLD)
+ dev_info(&pdev->dev, "quirk reset_d3cold enabled\n");
+}
+
+static void mwifiex_pcie_set_power_d3cold(struct pci_dev *pdev)
+{
+ dev_info(&pdev->dev, "putting into D3cold...\n");
+
+ pci_save_state(pdev);
+ if (pci_is_enabled(pdev))
+ pci_disable_device(pdev);
+ pci_set_power_state(pdev, PCI_D3cold);
+}
+
+static int mwifiex_pcie_set_power_d0(struct pci_dev *pdev)
+{
+ int ret;
+
+ dev_info(&pdev->dev, "putting into D0...\n");
+
+ pci_set_power_state(pdev, PCI_D0);
+ ret = pci_enable_device(pdev);
+ if (ret) {
+ dev_err(&pdev->dev, "pci_enable_device failed\n");
+ return ret;
+ }
+ pci_restore_state(pdev);
+
+ return 0;
+}
+
+int mwifiex_pcie_reset_d3cold_quirk(struct pci_dev *pdev)
+{
+ struct pci_dev *parent_pdev = pci_upstream_bridge(pdev);
+ int ret;
+
+ /* Power-cycle (put into D3cold then D0) */
+ dev_info(&pdev->dev, "Using reset_d3cold quirk to perform FW reset\n");
+
+ /* We need to perform power-cycle also for bridge of wifi because
+ * on some devices (e.g. Surface Book 1), the OS for some reasons
+ * can't know the real power state of the bridge.
+ * When tried to power-cycle only wifi, the reset failed with the
+ * following dmesg log:
+ * "Cannot transition to power state D0 for parent in D3hot".
+ */
+ mwifiex_pcie_set_power_d3cold(pdev);
+ mwifiex_pcie_set_power_d3cold(parent_pdev);
+
+ ret = mwifiex_pcie_set_power_d0(parent_pdev);
+ if (ret)
+ return ret;
+ ret = mwifiex_pcie_set_power_d0(pdev);
+ if (ret)
+ return ret;
+
+ return 0;
}
diff --git a/drivers/net/wireless/marvell/mwifiex/pcie_quirks.h b/drivers/net/wireless/marvell/mwifiex/pcie_quirks.h
index 7a1fe3b3a61a..549093067813 100644
--- a/drivers/net/wireless/marvell/mwifiex/pcie_quirks.h
+++ b/drivers/net/wireless/marvell/mwifiex/pcie_quirks.h
@@ -5,4 +5,7 @@

#include "pcie.h"

+#define QUIRK_FW_RST_D3COLD BIT(0)
+
void mwifiex_initialize_quirks(struct pcie_service_card *card);
+int mwifiex_pcie_reset_d3cold_quirk(struct pci_dev *pdev);
--
2.31.1

2021-05-24 20:28:50

by Amey Narkhede

[permalink] [raw]
Subject: Re: [RFC PATCH 2/3] mwifiex: pcie: add reset_d3cold quirk for Surface gen4+ devices

On 21/05/23 12:28PM, Jonas Dre?ler wrote:
> On 5/22/21 8:44 PM, Amey Narkhede wrote:
> > On 21/05/22 03:18PM, Jonas Dre?ler wrote:
> > > From: Tsuchiya Yuto <[email protected]>
> > >
> > > To reset mwifiex on Surface gen4+ (Pro 4 or later gen) devices, it
> > > seems that putting the wifi device into D3cold is required according
> > > to errata.inf file on Windows installation (Windows/INF/errata.inf).
> > >
> > > This patch adds a function that performs power-cycle (put into D3cold
> > > then D0) and call the function at the end of reset_prepare().
> > >
> > > Note: Need to also reset the parent device (bridge) of wifi on SB1;
> > > it might be because the bridge of wifi always reports it's in D3hot.
> > > When I tried to reset only the wifi device (not touching parent), it gave
> > > the following error and the reset failed:
> > >
> > > acpi device:4b: Cannot transition to power state D0 for parent in D3hot
> > > mwifiex_pcie 0000:03:00.0: can't change power state from D3cold to D0 (config space inaccessible)
> > >
> > May I know how did you reset only the wifi device when you encountered
> > this error?
>
> Not exactly sure what you mean by that, the trick was to put the parent
> bridge into D3cold and then into D0 before transitioning the card into
> D0.
>
If the parent bridge has multiple devices attached to it, this can
have some side effects on other devices after the reset but as you
mentioned below that parent bridge is only connected to wifi card it
should be fine in that case.

> That "Cannot transition to power state" warning is just the kernel
> enforcing ACPI specs afaik, and that prevents us from putting the device
> into ACPI state D0. This in turn means the device still has no power and
> we can't set the PCI power state to D0, which is the second error.
>
> >
> > > Signed-off-by: Tsuchiya Yuto <[email protected]>
> > > Signed-off-by: Jonas Dre?ler <[email protected]>
> > > ---
> > > drivers/net/wireless/marvell/mwifiex/pcie.c | 7 +
> > > .../wireless/marvell/mwifiex/pcie_quirks.c | 123 ++++++++++++++++++
> > > .../wireless/marvell/mwifiex/pcie_quirks.h | 3 +
> > > 3 files changed, 133 insertions(+)
> > >
> > > diff --git a/drivers/net/wireless/marvell/mwifiex/pcie.c b/drivers/net/wireless/marvell/mwifiex/pcie.c
> > > index 02fdce926de5..d9acfea395ad 100644
> > > --- a/drivers/net/wireless/marvell/mwifiex/pcie.c
> > > +++ b/drivers/net/wireless/marvell/mwifiex/pcie.c
> > > @@ -528,6 +528,13 @@ static void mwifiex_pcie_reset_prepare(struct pci_dev *pdev)
> > > mwifiex_shutdown_sw(adapter);
> > > clear_bit(MWIFIEX_IFACE_WORK_DEVICE_DUMP, &card->work_flags);
> > > clear_bit(MWIFIEX_IFACE_WORK_CARD_RESET, &card->work_flags);
> > > +
> > > + /* For Surface gen4+ devices, we need to put wifi into D3cold right
> > > + * before performing FLR
> > > + */
> > > + if (card->quirks & QUIRK_FW_RST_D3COLD)
> > > + mwifiex_pcie_reset_d3cold_quirk(pdev);
> > > +
> > > mwifiex_dbg(adapter, INFO, "%s, successful\n", __func__);
> > >
> > > card->pci_reset_ongoing = true;
> > > diff --git a/drivers/net/wireless/marvell/mwifiex/pcie_quirks.c b/drivers/net/wireless/marvell/mwifiex/pcie_quirks.c
> > > index 4064f99b36ba..b5f214fc1212 100644
> > > --- a/drivers/net/wireless/marvell/mwifiex/pcie_quirks.c
> > > +++ b/drivers/net/wireless/marvell/mwifiex/pcie_quirks.c
> > > @@ -15,6 +15,72 @@
> > >
> > > /* quirk table based on DMI matching */
> > > static const struct dmi_system_id mwifiex_quirk_table[] = {
> > > + {
> > > + .ident = "Surface Pro 4",
> > > + .matches = {
> > > + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
> > > + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Pro 4"),
> > > + },
> > > + .driver_data = (void *)QUIRK_FW_RST_D3COLD,
> > > + },
> > > + {
> > > + .ident = "Surface Pro 5",
> > > + .matches = {
> > > + /* match for SKU here due to generic product name "Surface Pro" */
> > > + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
> > > + DMI_EXACT_MATCH(DMI_PRODUCT_SKU, "Surface_Pro_1796"),
> > > + },
> > > + .driver_data = (void *)QUIRK_FW_RST_D3COLD,
> > > + },
> > > + {
> > > + .ident = "Surface Pro 5 (LTE)",
> > > + .matches = {
> > > + /* match for SKU here due to generic product name "Surface Pro" */
> > > + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
> > > + DMI_EXACT_MATCH(DMI_PRODUCT_SKU, "Surface_Pro_1807"),
> > > + },
> > > + .driver_data = (void *)QUIRK_FW_RST_D3COLD,
> > > + },
> > > + {
> > > + .ident = "Surface Pro 6",
> > > + .matches = {
> > > + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
> > > + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Pro 6"),
> > > + },
> > > + .driver_data = (void *)QUIRK_FW_RST_D3COLD,
> > > + },
> > > + {
> > > + .ident = "Surface Book 1",
> > > + .matches = {
> > > + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
> > > + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Book"),
> > > + },
> > > + .driver_data = (void *)QUIRK_FW_RST_D3COLD,
> > > + },
> > > + {
> > > + .ident = "Surface Book 2",
> > > + .matches = {
> > > + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
> > > + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Book 2"),
> > > + },
> > > + .driver_data = (void *)QUIRK_FW_RST_D3COLD,
> > > + },
> > > + {
> > > + .ident = "Surface Laptop 1",
> > > + .matches = {
> > > + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
> > > + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Laptop"),
> > > + },
> > > + .driver_data = (void *)QUIRK_FW_RST_D3COLD,
> > > + },
> > > + {
> > > + .ident = "Surface Laptop 2",
> > > + .matches = {
> > > + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
> > > + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Laptop 2"),
> > > + },
> > > + .driver_data = (void *)QUIRK_FW_RST_D3COLD,
> > > + },
> > > {}
> > > };
> > >
> > > @@ -29,4 +95,61 @@ void mwifiex_initialize_quirks(struct pcie_service_card *card)
> > >
> > > if (!card->quirks)
> > > dev_info(&pdev->dev, "no quirks enabled\n");
> > > + if (card->quirks & QUIRK_FW_RST_D3COLD)
> > > + dev_info(&pdev->dev, "quirk reset_d3cold enabled\n");
> > > +}
> > > +
> > > +static void mwifiex_pcie_set_power_d3cold(struct pci_dev *pdev)
> > > +{
> > > + dev_info(&pdev->dev, "putting into D3cold...\n");
> > > +
> > > + pci_save_state(pdev);
> > > + if (pci_is_enabled(pdev))
> > > + pci_disable_device(pdev);
> > > + pci_set_power_state(pdev, PCI_D3cold);
> > > +}
> > pci_set_power_state with PCI_D3cold state calls
> > pci_bus_set_current_state(dev->subordinate, PCI_D3cold).
> > Maybe this was the reason for the earlier problem you had?
> > Not 100% sure about this though CCing: Alex
>
> Hmm, so we'd only have to put the bridge into D3cold and that takes care
> of the device going to D3cold automatically?
>
Yeah I think it should do it. Have you tried this?
> >
> > > +
> > > +static int mwifiex_pcie_set_power_d0(struct pci_dev *pdev)
> > > +{
> > > + int ret;
> > > +
> > > + dev_info(&pdev->dev, "putting into D0...\n");
> > > +
> > > + pci_set_power_state(pdev, PCI_D0);
> > > + ret = pci_enable_device(pdev);
> > > + if (ret) {
> > > + dev_err(&pdev->dev, "pci_enable_device failed\n");
> > > + return ret;
> > > + }
> > > + pci_restore_state(pdev);
> > On the side note just save and restore is enough in this case?
> > What would be the device <-> driver state after the reset as you
> > are calling this on parent_pdev below so that affects other
> > devices on bus?
>
> Not sure we can do anything more than save and restore, can we? I don't
> think it will affect other devices on the bus, the parent bridge is only
> connected to the wifi card, nothing else.
>
I was thinking of doing remove-reset-rescan but I think save-restore
should be ok if there is a single device connected to the parent bridge.

Thanks,
Amey
[...]
> > > diff --git a/drivers/net/wireless/marvell/mwifiex/pcie_quirks.h b/drivers/net/wireless/marvell/mwifiex/pcie_quirks.h
> > > index 7a1fe3b3a61a..549093067813 100644
> > > --- a/drivers/net/wireless/marvell/mwifiex/pcie_quirks.h
> > > +++ b/drivers/net/wireless/marvell/mwifiex/pcie_quirks.h
> > > @@ -5,4 +5,7 @@
> > >
> > > #include "pcie.h"
> > >
> > > +#define QUIRK_FW_RST_D3COLD BIT(0)
> > > +
> > > void mwifiex_initialize_quirks(struct pcie_service_card *card);
> > > +int mwifiex_pcie_reset_d3cold_quirk(struct pci_dev *pdev);
> > > --
> > > 2.31.1
> > >
>
> Thanks for the review,
> Jonas

2021-06-04 21:09:09

by Bjorn Helgaas

[permalink] [raw]
Subject: Re: [RFC PATCH 2/3] mwifiex: pcie: add reset_d3cold quirk for Surface gen4+ devices

On Sat, May 22, 2021 at 03:18:26PM +0200, Jonas Dre?ler wrote:
> From: Tsuchiya Yuto <[email protected]>
>
> To reset mwifiex on Surface gen4+ (Pro 4 or later gen) devices, it
> seems that putting the wifi device into D3cold is required according
> to errata.inf file on Windows installation (Windows/INF/errata.inf).
>
> This patch adds a function that performs power-cycle (put into D3cold
> then D0) and call the function at the end of reset_prepare().
>
> Note: Need to also reset the parent device (bridge) of wifi on SB1;
> it might be because the bridge of wifi always reports it's in D3hot.
> When I tried to reset only the wifi device (not touching parent), it gave
> the following error and the reset failed:
>
> acpi device:4b: Cannot transition to power state D0 for parent in D3hot
> mwifiex_pcie 0000:03:00.0: can't change power state from D3cold to D0 (config space inaccessible)
>
> Signed-off-by: Tsuchiya Yuto <[email protected]>
> Signed-off-by: Jonas Dre?ler <[email protected]>
> ---
> drivers/net/wireless/marvell/mwifiex/pcie.c | 7 +
> .../wireless/marvell/mwifiex/pcie_quirks.c | 123 ++++++++++++++++++
> .../wireless/marvell/mwifiex/pcie_quirks.h | 3 +
> 3 files changed, 133 insertions(+)
>
> diff --git a/drivers/net/wireless/marvell/mwifiex/pcie.c b/drivers/net/wireless/marvell/mwifiex/pcie.c
> index 02fdce926de5..d9acfea395ad 100644
> --- a/drivers/net/wireless/marvell/mwifiex/pcie.c
> +++ b/drivers/net/wireless/marvell/mwifiex/pcie.c
> @@ -528,6 +528,13 @@ static void mwifiex_pcie_reset_prepare(struct pci_dev *pdev)
> mwifiex_shutdown_sw(adapter);
> clear_bit(MWIFIEX_IFACE_WORK_DEVICE_DUMP, &card->work_flags);
> clear_bit(MWIFIEX_IFACE_WORK_CARD_RESET, &card->work_flags);
> +
> + /* For Surface gen4+ devices, we need to put wifi into D3cold right
> + * before performing FLR

This comment seems incorrect or at least incomplete. When the device
is in D3cold, it isn't powered at all, so you can't do anything with
it, including FLR. But maybe you meant that you need to put it in
D3cold and back to D0 before doing an FLR. That would work. But in
that case, there's no point in an FLR because the power cycle has
already reset more than the FLR will.

Bjorn

2021-07-09 14:12:06

by Jonas Dreßler

[permalink] [raw]
Subject: Re: [RFC PATCH 2/3] mwifiex: pcie: add reset_d3cold quirk for Surface gen4+ devices

On 5/24/21 10:27 PM, Amey Narkhede wrote:
> On 21/05/23 12:28PM, Jonas Dreßler wrote:
>> On 5/22/21 8:44 PM, Amey Narkhede wrote:
>>> On 21/05/22 03:18PM, Jonas Dreßler wrote:
>>>> From: Tsuchiya Yuto <[email protected]>
>>>>
>>>> To reset mwifiex on Surface gen4+ (Pro 4 or later gen) devices, it
>>>> seems that putting the wifi device into D3cold is required according
>>>> to errata.inf file on Windows installation (Windows/INF/errata.inf).
>>>>
>>>> This patch adds a function that performs power-cycle (put into D3cold
>>>> then D0) and call the function at the end of reset_prepare().
>>>>
>>>> Note: Need to also reset the parent device (bridge) of wifi on SB1;
>>>> it might be because the bridge of wifi always reports it's in D3hot.
>>>> When I tried to reset only the wifi device (not touching parent),
it gave
>>>> the following error and the reset failed:
>>>>
>>>> acpi device:4b: Cannot transition to power state D0 for
parent in D3hot
>>>> mwifiex_pcie 0000:03:00.0: can't change power state from
D3cold to D0 (config space inaccessible)
>>>>
>>> May I know how did you reset only the wifi device when you encountered
>>> this error?
>>
>> Not exactly sure what you mean by that, the trick was to put the parent
>> bridge into D3cold and then into D0 before transitioning the card into
>> D0.
>>
> If the parent bridge has multiple devices attached to it, this can
> have some side effects on other devices after the reset but as you
> mentioned below that parent bridge is only connected to wifi card it
> should be fine in that case.
>
>> That "Cannot transition to power state" warning is just the kernel
>> enforcing ACPI specs afaik, and that prevents us from putting the device
>> into ACPI state D0. This in turn means the device still has no power and
>> we can't set the PCI power state to D0, which is the second error.
>>
>>>
>>>> Signed-off-by: Tsuchiya Yuto <[email protected]>
>>>> Signed-off-by: Jonas Dreßler <[email protected]>
>>>> ---
>>>> drivers/net/wireless/marvell/mwifiex/pcie.c | 7 +
>>>> .../wireless/marvell/mwifiex/pcie_quirks.c | 123
++++++++++++++++++
>>>> .../wireless/marvell/mwifiex/pcie_quirks.h | 3 +
>>>> 3 files changed, 133 insertions(+)
>>>>
>>>> diff --git a/drivers/net/wireless/marvell/mwifiex/pcie.c
b/drivers/net/wireless/marvell/mwifiex/pcie.c
>>>> index 02fdce926de5..d9acfea395ad 100644
>>>> --- a/drivers/net/wireless/marvell/mwifiex/pcie.c
>>>> +++ b/drivers/net/wireless/marvell/mwifiex/pcie.c
>>>> @@ -528,6 +528,13 @@ static void mwifiex_pcie_reset_prepare(struct
pci_dev *pdev)
>>>> mwifiex_shutdown_sw(adapter);
>>>> clear_bit(MWIFIEX_IFACE_WORK_DEVICE_DUMP, &card->work_flags);
>>>> clear_bit(MWIFIEX_IFACE_WORK_CARD_RESET, &card->work_flags);
>>>> +
>>>> + /* For Surface gen4+ devices, we need to put wifi into D3cold right
>>>> + * before performing FLR
>>>> + */
>>>> + if (card->quirks & QUIRK_FW_RST_D3COLD)
>>>> + mwifiex_pcie_reset_d3cold_quirk(pdev);
>>>> +
>>>> mwifiex_dbg(adapter, INFO, "%s, successful\n", __func__);
>>>>
>>>> card->pci_reset_ongoing = true;
>>>> diff --git a/drivers/net/wireless/marvell/mwifiex/pcie_quirks.c
b/drivers/net/wireless/marvell/mwifiex/pcie_quirks.c
>>>> index 4064f99b36ba..b5f214fc1212 100644
>>>> --- a/drivers/net/wireless/marvell/mwifiex/pcie_quirks.c
>>>> +++ b/drivers/net/wireless/marvell/mwifiex/pcie_quirks.c
>>>> @@ -15,6 +15,72 @@
>>>>
>>>> /* quirk table based on DMI matching */
>>>> static const struct dmi_system_id mwifiex_quirk_table[] = {
>>>> + {
>>>> + .ident = "Surface Pro 4",
>>>> + .matches = {
>>>> + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
>>>> + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Pro 4"),
>>>> + },
>>>> + .driver_data = (void *)QUIRK_FW_RST_D3COLD,
>>>> + },
>>>> + {
>>>> + .ident = "Surface Pro 5",
>>>> + .matches = {
>>>> + /* match for SKU here due to generic product name "Surface Pro" */
>>>> + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
>>>> + DMI_EXACT_MATCH(DMI_PRODUCT_SKU, "Surface_Pro_1796"),
>>>> + },
>>>> + .driver_data = (void *)QUIRK_FW_RST_D3COLD,
>>>> + },
>>>> + {
>>>> + .ident = "Surface Pro 5 (LTE)",
>>>> + .matches = {
>>>> + /* match for SKU here due to generic product name "Surface Pro" */
>>>> + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
>>>> + DMI_EXACT_MATCH(DMI_PRODUCT_SKU, "Surface_Pro_1807"),
>>>> + },
>>>> + .driver_data = (void *)QUIRK_FW_RST_D3COLD,
>>>> + },
>>>> + {
>>>> + .ident = "Surface Pro 6",
>>>> + .matches = {
>>>> + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
>>>> + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Pro 6"),
>>>> + },
>>>> + .driver_data = (void *)QUIRK_FW_RST_D3COLD,
>>>> + },
>>>> + {
>>>> + .ident = "Surface Book 1",
>>>> + .matches = {
>>>> + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
>>>> + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Book"),
>>>> + },
>>>> + .driver_data = (void *)QUIRK_FW_RST_D3COLD,
>>>> + },
>>>> + {
>>>> + .ident = "Surface Book 2",
>>>> + .matches = {
>>>> + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
>>>> + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Book 2"),
>>>> + },
>>>> + .driver_data = (void *)QUIRK_FW_RST_D3COLD,
>>>> + },
>>>> + {
>>>> + .ident = "Surface Laptop 1",
>>>> + .matches = {
>>>> + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
>>>> + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Laptop"),
>>>> + },
>>>> + .driver_data = (void *)QUIRK_FW_RST_D3COLD,
>>>> + },
>>>> + {
>>>> + .ident = "Surface Laptop 2",
>>>> + .matches = {
>>>> + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Microsoft Corporation"),
>>>> + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "Surface Laptop 2"),
>>>> + },
>>>> + .driver_data = (void *)QUIRK_FW_RST_D3COLD,
>>>> + },
>>>> {}
>>>> };
>>>>
>>>> @@ -29,4 +95,61 @@ void mwifiex_initialize_quirks(struct
pcie_service_card *card)
>>>>
>>>> if (!card->quirks)
>>>> dev_info(&pdev->dev, "no quirks enabled\n");
>>>> + if (card->quirks & QUIRK_FW_RST_D3COLD)
>>>> + dev_info(&pdev->dev, "quirk reset_d3cold enabled\n");
>>>> +}
>>>> +
>>>> +static void mwifiex_pcie_set_power_d3cold(struct pci_dev *pdev)
>>>> +{
>>>> + dev_info(&pdev->dev, "putting into D3cold...\n");
>>>> +
>>>> + pci_save_state(pdev);
>>>> + if (pci_is_enabled(pdev))
>>>> + pci_disable_device(pdev);
>>>> + pci_set_power_state(pdev, PCI_D3cold);
>>>> +}
>>> pci_set_power_state with PCI_D3cold state calls
>>> pci_bus_set_current_state(dev->subordinate, PCI_D3cold).
>>> Maybe this was the reason for the earlier problem you had?
>>> Not 100% sure about this though CCing: Alex
>>
>> Hmm, so we'd only have to put the bridge into D3cold and that takes care
>> of the device going to D3cold automatically?
>>
> Yeah I think it should do it. Have you tried this?

Finally found some time to try that now and looks like it doesn't work.
First reset works fine, but on the second one the device can't switch
from D3cold to D0:

mwifiex_pcie 0000:01:00.0: can't change power state from D3cold to D0
(config space inaccessible)

Thanks,
Jonas

>>>
>>>> +
>>>> +static int mwifiex_pcie_set_power_d0(struct pci_dev *pdev)
>>>> +{
>>>> + int ret;
>>>> +
>>>> + dev_info(&pdev->dev, "putting into D0...\n");
>>>> +
>>>> + pci_set_power_state(pdev, PCI_D0);
>>>> + ret = pci_enable_device(pdev);
>>>> + if (ret) {
>>>> + dev_err(&pdev->dev, "pci_enable_device failed\n");
>>>> + return ret;
>>>> + }
>>>> + pci_restore_state(pdev);
>>> On the side note just save and restore is enough in this case?
>>> What would be the device <-> driver state after the reset as you
>>> are calling this on parent_pdev below so that affects other
>>> devices on bus?
>>
>> Not sure we can do anything more than save and restore, can we? I don't
>> think it will affect other devices on the bus, the parent bridge is only
>> connected to the wifi card, nothing else.
>>
> I was thinking of doing remove-reset-rescan but I think save-restore
> should be ok if there is a single device connected to the parent bridge.
>
> Thanks,
> Amey
> [...]
>>>> diff --git a/drivers/net/wireless/marvell/mwifiex/pcie_quirks.h
b/drivers/net/wireless/marvell/mwifiex/pcie_quirks.h
>>>> index 7a1fe3b3a61a..549093067813 100644
>>>> --- a/drivers/net/wireless/marvell/mwifiex/pcie_quirks.h
>>>> +++ b/drivers/net/wireless/marvell/mwifiex/pcie_quirks.h
>>>> @@ -5,4 +5,7 @@
>>>>
>>>> #include "pcie.h"
>>>>
>>>> +#define QUIRK_FW_RST_D3COLD BIT(0)
>>>> +
>>>> void mwifiex_initialize_quirks(struct pcie_service_card *card);
>>>> +int mwifiex_pcie_reset_d3cold_quirk(struct pci_dev *pdev);
>>>> --
>>>> 2.31.1
>>>>
>>
>> Thanks for the review,
>> Jonas