platform/x86: wmi: Use devres to disable the WMI device
authorArmin Wolf <W_Armin@gmx.de>
Sun, 16 Feb 2025 19:32:48 +0000 (20:32 +0100)
committerIlpo Järvinen <ilpo.jarvinen@linux.intel.com>
Mon, 24 Feb 2025 11:19:19 +0000 (13:19 +0200)
Use devm_add_action_or_reset() to disable the WMI device instead of
manually calling wmi_method_enable() to prepare for future changes
inside the WMI data block handlign code.

The reason for this is that we have to make sure that all
devres-managed resources are released first because some might still
want to access the underlying WMI device.

Because devres-managed resources are not released during shutdown
we still have to manually disable the WMI device in this case.

Signed-off-by: Armin Wolf <W_Armin@gmx.de>
Link: https://lore.kernel.org/r/20250216193251.866125-6-W_Armin@gmx.de
Reviewed-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
drivers/platform/x86/wmi.c

index 646370bd6b03887f158f714aa9f8fb14a650ddeb..7cb36a71e9ea563f4c80f186e33efc5896cf21ee 100644 (file)
@@ -821,11 +821,19 @@ static int wmi_dev_match(struct device *dev, const struct device_driver *driver)
        return 0;
 }
 
+static void wmi_dev_disable(void *data)
+{
+       struct wmi_block *wblock = data;
+
+       if (ACPI_FAILURE(wmi_method_enable(wblock, false)))
+               dev_warn(&wblock->dev.dev, "Failed to disable device\n");
+}
+
 static int wmi_dev_probe(struct device *dev)
 {
        struct wmi_block *wblock = dev_to_wblock(dev);
        struct wmi_driver *wdriver = to_wmi_driver(dev->driver);
-       int ret = 0;
+       int ret;
 
        /* Some older WMI drivers will break if instantiated multiple times,
         * so they are blocked from probing WMI devices with a duplicated GUID.
@@ -847,15 +855,19 @@ static int wmi_dev_probe(struct device *dev)
        if (ACPI_FAILURE(wmi_method_enable(wblock, true)))
                dev_warn(dev, "failed to enable device -- probing anyway\n");
 
+       /*
+        * We have to make sure that all devres-managed resources are released first because
+        * some might still want to access the underlying WMI device.
+        */
+       ret = devm_add_action_or_reset(dev, wmi_dev_disable, wblock);
+       if (ret < 0)
+               return ret;
+
        if (wdriver->probe) {
                ret = wdriver->probe(to_wmi_device(dev),
                                find_guid_context(wblock, wdriver));
-               if (ret) {
-                       if (ACPI_FAILURE(wmi_method_enable(wblock, false)))
-                               dev_warn(dev, "Failed to disable device\n");
-
+               if (ret)
                        return ret;
-               }
        }
 
        down_write(&wblock->notify_lock);
@@ -876,9 +888,6 @@ static void wmi_dev_remove(struct device *dev)
 
        if (wdriver->remove)
                wdriver->remove(to_wmi_device(dev));
-
-       if (ACPI_FAILURE(wmi_method_enable(wblock, false)))
-               dev_warn(dev, "failed to disable device\n");
 }
 
 static void wmi_dev_shutdown(struct device *dev)
@@ -902,6 +911,10 @@ static void wmi_dev_shutdown(struct device *dev)
                if (wdriver->shutdown)
                        wdriver->shutdown(to_wmi_device(dev));
 
+               /*
+                * We still need to disable the WMI device here since devres-managed resources
+                * like wmi_dev_disable() will not be release during shutdown.
+                */
                if (ACPI_FAILURE(wmi_method_enable(wblock, false)))
                        dev_warn(dev, "Failed to disable device\n");
        }