mwifiex: pcie: add reset_d3cold quirk for Surface gen4+ devices

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 <kitakar@gmail.com>
Signed-off-by: Jonas Dreßler <verdre@v0yd.nl>
Signed-off-by: Kalle Valo <kvalo@codeaurora.org>
Link: https://lore.kernel.org/r/20210820142050.35741-3-verdre@v0yd.nl

diff --git a/drivers/net/wireless/marvell/mwifiex/pcie.c b/drivers/net/wireless/marvell/mwifiex/pcie.c
index a530832..c6ccce4 100644 (file)
--- 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);
+
+       /* On MS Surface gen4+ devices FLR isn't effective to recover from
+        * hangups, so we power-cycle the card instead.
+        */
+       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 c1665ac..0234cf3 100644 (file)
--- a/drivers/net/wireless/marvell/mwifiex/pcie_quirks.c
+++ b/drivers/net/wireless/marvell/mwifiex/pcie_quirks.c
@@ -21,6 +21,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,
+       },
        {}
 };
 
@@ -35,4 +101,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 18eacc8..8ec4176 100644 (file)
--- a/drivers/net/wireless/marvell/mwifiex/pcie_quirks.h
+++ b/drivers/net/wireless/marvell/mwifiex/pcie_quirks.h
@@ -17,4 +17,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);