PCI PM: make the PM core more careful with drivers using the new PM framework
[cascardo/linux.git] / drivers / pci / pci-driver.c
index 23bdf64..93eac14 100644 (file)
@@ -314,21 +314,12 @@ static void pci_device_shutdown(struct device *dev)
 
 #ifdef CONFIG_PM_SLEEP
 
-static bool pci_has_legacy_pm_support(struct pci_dev *pci_dev)
-{
-       struct pci_driver *drv = pci_dev->driver;
-
-       return drv && (drv->suspend || drv->suspend_late || drv->resume
-               || drv->resume_early);
-}
-
 /*
  * Default "suspend" method for devices that have no driver provided suspend,
- * or not even a driver at all.
+ * or not even a driver at all (second part).
  */
-static void pci_default_pm_suspend(struct pci_dev *pci_dev)
+static void pci_pm_set_unknown_state(struct pci_dev *pci_dev)
 {
-       pci_save_state(pci_dev);
        /*
         * mark its power state as "unknown", since we don't know if
         * e.g. the BIOS will change its device state when we suspend.
@@ -337,21 +328,11 @@ static void pci_default_pm_suspend(struct pci_dev *pci_dev)
                pci_dev->current_state = PCI_UNKNOWN;
 }
 
-/*
- * Default "resume" method for devices that have no driver provided resume,
- * or not even a driver at all (first part).
- */
-static void pci_default_pm_resume_early(struct pci_dev *pci_dev)
-{
-       /* restore the PCI config space */
-       pci_restore_state(pci_dev);
-}
-
 /*
  * Default "resume" method for devices that have no driver provided resume,
  * or not even a driver at all (second part).
  */
-static int pci_default_pm_resume_late(struct pci_dev *pci_dev)
+static int pci_pm_reenable_device(struct pci_dev *pci_dev)
 {
        int retval;
 
@@ -374,11 +355,36 @@ static int pci_legacy_suspend(struct device *dev, pm_message_t state)
        int i = 0;
 
        if (drv && drv->suspend) {
+               pci_power_t prev = pci_dev->current_state;
+
+               pci_dev->state_saved = false;
+
                i = drv->suspend(pci_dev, state);
                suspend_report_result(drv->suspend, i);
-       } else {
-               pci_default_pm_suspend(pci_dev);
+               if (i)
+                       return i;
+
+               if (pci_dev->state_saved)
+                       goto Fixup;
+
+               if (pci_dev->current_state != PCI_D0
+                   && pci_dev->current_state != PCI_UNKNOWN) {
+                       WARN_ONCE(pci_dev->current_state != prev,
+                               "PCI PM: Device state not saved by %pF\n",
+                               drv->suspend);
+                       goto Fixup;
+               }
        }
+
+       pci_save_state(pci_dev);
+       /*
+        * This is for compatibility with existing code with legacy PM support.
+        */
+       pci_pm_set_unknown_state(pci_dev);
+
+ Fixup:
+       pci_fixup_device(pci_fixup_suspend, pci_dev);
+
        return i;
 }
 
@@ -395,32 +401,69 @@ static int pci_legacy_suspend_late(struct device *dev, pm_message_t state)
        return i;
 }
 
-static int pci_legacy_resume(struct device *dev)
+static int pci_legacy_resume_early(struct device *dev)
 {
-       int error;
        struct pci_dev * pci_dev = to_pci_dev(dev);
        struct pci_driver * drv = pci_dev->driver;
 
-       if (drv && drv->resume) {
-               error = drv->resume(pci_dev);
-       } else {
-               pci_default_pm_resume_early(pci_dev);
-               error = pci_default_pm_resume_late(pci_dev);
-       }
-       return error;
+       return drv && drv->resume_early ?
+                       drv->resume_early(pci_dev) : 0;
 }
 
-static int pci_legacy_resume_early(struct device *dev)
+static int pci_legacy_resume(struct device *dev)
 {
-       int error = 0;
        struct pci_dev * pci_dev = to_pci_dev(dev);
        struct pci_driver * drv = pci_dev->driver;
 
-       if (drv && drv->resume_early)
-               error = drv->resume_early(pci_dev);
-       return error;
+       pci_fixup_device(pci_fixup_resume, pci_dev);
+
+       return drv && drv->resume ?
+                       drv->resume(pci_dev) : pci_pm_reenable_device(pci_dev);
+}
+
+/* Auxiliary functions used by the new power management framework */
+
+static void pci_pm_default_resume_noirq(struct pci_dev *pci_dev)
+{
+       pci_restore_standard_config(pci_dev);
+       pci_dev->state_saved = false;
+       pci_fixup_device(pci_fixup_resume_early, pci_dev);
+}
+
+static void pci_pm_default_resume(struct pci_dev *pci_dev)
+{
+       pci_fixup_device(pci_fixup_resume, pci_dev);
+
+       if (!pci_is_bridge(pci_dev))
+               pci_enable_wake(pci_dev, PCI_D0, false);
+}
+
+static void pci_pm_default_suspend(struct pci_dev *pci_dev)
+{
+       /* Disable non-bridge devices without PM support */
+       if (!pci_is_bridge(pci_dev))
+               pci_disable_enabled_device(pci_dev);
+       pci_save_state(pci_dev);
+}
+
+static bool pci_has_legacy_pm_support(struct pci_dev *pci_dev)
+{
+       struct pci_driver *drv = pci_dev->driver;
+       bool ret = drv && (drv->suspend || drv->suspend_late || drv->resume
+               || drv->resume_early);
+
+       /*
+        * Legacy PM support is used by default, so warn if the new framework is
+        * supported as well.  Drivers are supposed to support either the
+        * former, or the latter, but not both at the same time.
+        */
+       WARN_ON(ret && drv->driver.pm);
+
+       return ret;
 }
 
+/* New power management framework */
+
 static int pci_pm_prepare(struct device *dev)
 {
        struct device_driver *drv = dev->driver;
@@ -445,20 +488,49 @@ static void pci_pm_complete(struct device *dev)
 static int pci_pm_suspend(struct device *dev)
 {
        struct pci_dev *pci_dev = to_pci_dev(dev);
-       struct device_driver *drv = dev->driver;
-       int error = 0;
+       struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
+
+       if (pci_has_legacy_pm_support(pci_dev))
+               return pci_legacy_suspend(dev, PMSG_SUSPEND);
+
+       if (!pm) {
+               pci_pm_default_suspend(pci_dev);
+               goto Fixup;
+       }
+
+       pci_dev->state_saved = false;
+
+       if (pm->suspend) {
+               pci_power_t prev = pci_dev->current_state;
+               int error;
+
+               error = pm->suspend(dev);
+               suspend_report_result(pm->suspend, error);
+               if (error)
+                       return error;
+
+               if (pci_dev->state_saved)
+                       goto Fixup;
 
-       if (drv && drv->pm) {
-               if (drv->pm->suspend) {
-                       error = drv->pm->suspend(dev);
-                       suspend_report_result(drv->pm->suspend, error);
+               if (pci_dev->current_state != PCI_D0
+                   && pci_dev->current_state != PCI_UNKNOWN) {
+                       WARN_ONCE(pci_dev->current_state != prev,
+                               "PCI PM: State of device not saved by %pF\n",
+                               pm->suspend);
+                       goto Fixup;
                }
-       } else if (pci_has_legacy_pm_support(pci_dev)) {
-               error = pci_legacy_suspend(dev, PMSG_SUSPEND);
        }
+
+       if (!pci_dev->state_saved) {
+               pci_save_state(pci_dev);
+               if (!pci_is_bridge(pci_dev))
+                       pci_prepare_to_sleep(pci_dev);
+       }
+
+ Fixup:
        pci_fixup_device(pci_fixup_suspend, pci_dev);
 
-       return error;
+       return 0;
 }
 
 static int pci_pm_suspend_noirq(struct device *dev)
@@ -467,58 +539,63 @@ static int pci_pm_suspend_noirq(struct device *dev)
        struct device_driver *drv = dev->driver;
        int error = 0;
 
-       if (drv && drv->pm) {
-               if (drv->pm->suspend_noirq) {
-                       error = drv->pm->suspend_noirq(dev);
-                       suspend_report_result(drv->pm->suspend_noirq, error);
-               }
-       } else if (pci_has_legacy_pm_support(pci_dev)) {
-               error = pci_legacy_suspend_late(dev, PMSG_SUSPEND);
-       } else {
-               pci_default_pm_suspend(pci_dev);
+       if (pci_has_legacy_pm_support(pci_dev))
+               return pci_legacy_suspend_late(dev, PMSG_SUSPEND);
+
+       if (drv && drv->pm && drv->pm->suspend_noirq) {
+               error = drv->pm->suspend_noirq(dev);
+               suspend_report_result(drv->pm->suspend_noirq, error);
        }
 
+       if (!error)
+               pci_pm_set_unknown_state(pci_dev);
+
        return error;
 }
 
-static int pci_pm_resume(struct device *dev)
+static int pci_pm_resume_noirq(struct device *dev)
 {
        struct pci_dev *pci_dev = to_pci_dev(dev);
        struct device_driver *drv = dev->driver;
        int error = 0;
 
-       pci_fixup_device(pci_fixup_resume, pci_dev);
+       pci_pm_default_resume_noirq(pci_dev);
 
-       if (drv && drv->pm) {
-               if (drv->pm->resume)
-                       error = drv->pm->resume(dev);
-       } else if (pci_has_legacy_pm_support(pci_dev)) {
-               error = pci_legacy_resume(dev);
-       } else {
-               error = pci_default_pm_resume_late(pci_dev);
-       }
+       if (pci_has_legacy_pm_support(pci_dev))
+               return pci_legacy_resume_early(dev);
+
+       if (drv && drv->pm && drv->pm->resume_noirq)
+               error = drv->pm->resume_noirq(dev);
 
        return error;
 }
 
-static int pci_pm_resume_noirq(struct device *dev)
+static int pci_pm_resume(struct device *dev)
 {
        struct pci_dev *pci_dev = to_pci_dev(dev);
-       struct device_driver *drv = dev->driver;
+       struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
        int error = 0;
 
-       pci_fixup_device(pci_fixup_resume_early, to_pci_dev(dev));
+       /*
+        * This is necessary for the suspend error path in which resume is
+        * called without restoring the standard config registers of the device.
+        */
+       if (pci_dev->state_saved)
+               pci_restore_standard_config(pci_dev);
+
+       if (pci_has_legacy_pm_support(pci_dev))
+               return pci_legacy_resume(dev);
 
-       if (drv && drv->pm) {
-               if (drv->pm->resume_noirq)
-                       error = drv->pm->resume_noirq(dev);
-       } else if (pci_has_legacy_pm_support(pci_dev)) {
-               error = pci_legacy_resume_early(dev);
+       pci_pm_default_resume(pci_dev);
+
+       if (pm) {
+               if (pm->resume)
+                       error = pm->resume(dev);
        } else {
-               pci_default_pm_resume_early(pci_dev);
+               pci_pm_reenable_device(pci_dev);
        }
 
-       return error;
+       return 0;
 }
 
 #else /* !CONFIG_SUSPEND */
@@ -535,20 +612,31 @@ static int pci_pm_resume_noirq(struct device *dev)
 static int pci_pm_freeze(struct device *dev)
 {
        struct pci_dev *pci_dev = to_pci_dev(dev);
-       struct device_driver *drv = dev->driver;
-       int error = 0;
+       struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
 
-       if (drv && drv->pm) {
-               if (drv->pm->freeze) {
-                       error = drv->pm->freeze(dev);
-                       suspend_report_result(drv->pm->freeze, error);
-               }
-       } else if (pci_has_legacy_pm_support(pci_dev)) {
-               error = pci_legacy_suspend(dev, PMSG_FREEZE);
-               pci_fixup_device(pci_fixup_suspend, pci_dev);
+       if (pci_has_legacy_pm_support(pci_dev))
+               return pci_legacy_suspend(dev, PMSG_FREEZE);
+
+       if (!pm) {
+               pci_pm_default_suspend(pci_dev);
+               return 0;
        }
 
-       return error;
+       pci_dev->state_saved = false;
+
+       if (pm->freeze) {
+               int error;
+
+               error = pm->freeze(dev);
+               suspend_report_result(pm->freeze, error);
+               if (error)
+                       return error;
+       }
+
+       if (!pci_dev->state_saved)
+               pci_save_state(pci_dev);
+
+       return 0;
 }
 
 static int pci_pm_freeze_noirq(struct device *dev)
@@ -557,49 +645,51 @@ static int pci_pm_freeze_noirq(struct device *dev)
        struct device_driver *drv = dev->driver;
        int error = 0;
 
-       if (drv && drv->pm) {
-               if (drv->pm->freeze_noirq) {
-                       error = drv->pm->freeze_noirq(dev);
-                       suspend_report_result(drv->pm->freeze_noirq, error);
-               }
-       } else if (pci_has_legacy_pm_support(pci_dev)) {
-               error = pci_legacy_suspend_late(dev, PMSG_FREEZE);
-       } else {
-               pci_default_pm_suspend(pci_dev);
+       if (pci_has_legacy_pm_support(pci_dev))
+               return pci_legacy_suspend_late(dev, PMSG_FREEZE);
+
+       if (drv && drv->pm && drv->pm->freeze_noirq) {
+               error = drv->pm->freeze_noirq(dev);
+               suspend_report_result(drv->pm->freeze_noirq, error);
        }
 
+       if (!error)
+               pci_pm_set_unknown_state(pci_dev);
+
        return error;
 }
 
-static int pci_pm_thaw(struct device *dev)
+static int pci_pm_thaw_noirq(struct device *dev)
 {
        struct pci_dev *pci_dev = to_pci_dev(dev);
        struct device_driver *drv = dev->driver;
        int error = 0;
 
-       if (drv && drv->pm) {
-               if (drv->pm->thaw)
-                       error =  drv->pm->thaw(dev);
-       } else if (pci_has_legacy_pm_support(pci_dev)) {
-               pci_fixup_device(pci_fixup_resume, pci_dev);
-               error = pci_legacy_resume(dev);
-       }
+       if (pci_has_legacy_pm_support(pci_dev))
+               return pci_legacy_resume_early(dev);
+
+       pci_update_current_state(pci_dev, PCI_D0);
+
+       if (drv && drv->pm && drv->pm->thaw_noirq)
+               error = drv->pm->thaw_noirq(dev);
 
        return error;
 }
 
-static int pci_pm_thaw_noirq(struct device *dev)
+static int pci_pm_thaw(struct device *dev)
 {
        struct pci_dev *pci_dev = to_pci_dev(dev);
-       struct device_driver *drv = dev->driver;
+       struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
        int error = 0;
 
-       if (drv && drv->pm) {
-               if (drv->pm->thaw_noirq)
-                       error = drv->pm->thaw_noirq(dev);
-       } else if (pci_has_legacy_pm_support(pci_dev)) {
-               pci_fixup_device(pci_fixup_resume_early, to_pci_dev(dev));
-               error = pci_legacy_resume_early(dev);
+       if (pci_has_legacy_pm_support(pci_dev))
+               return pci_legacy_resume(dev);
+
+       if (pm) {
+               if (pm->thaw)
+                       error = pm->thaw(dev);
+       } else {
+               pci_pm_reenable_device(pci_dev);
        }
 
        return error;
@@ -608,18 +698,28 @@ static int pci_pm_thaw_noirq(struct device *dev)
 static int pci_pm_poweroff(struct device *dev)
 {
        struct pci_dev *pci_dev = to_pci_dev(dev);
-       struct device_driver *drv = dev->driver;
+       struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
        int error = 0;
 
-       if (drv && drv->pm) {
-               if (drv->pm->poweroff) {
-                       error = drv->pm->poweroff(dev);
-                       suspend_report_result(drv->pm->poweroff, error);
-               }
-       } else if (pci_has_legacy_pm_support(pci_dev)) {
-               error = pci_legacy_suspend(dev, PMSG_HIBERNATE);
+       if (pci_has_legacy_pm_support(pci_dev))
+               return pci_legacy_suspend(dev, PMSG_HIBERNATE);
+
+       if (!pm) {
+               pci_pm_default_suspend(pci_dev);
+               goto Fixup;
+       }
+
+       pci_dev->state_saved = false;
+
+       if (pm->poweroff) {
+               error = pm->poweroff(dev);
+               suspend_report_result(pm->poweroff, error);
        }
 
+       if (!pci_dev->state_saved && !pci_is_bridge(pci_dev))
+               pci_prepare_to_sleep(pci_dev);
+
+ Fixup:
        pci_fixup_device(pci_fixup_suspend, pci_dev);
 
        return error;
@@ -630,53 +730,57 @@ static int pci_pm_poweroff_noirq(struct device *dev)
        struct device_driver *drv = dev->driver;
        int error = 0;
 
-       if (drv && drv->pm) {
-               if (drv->pm->poweroff_noirq) {
-                       error = drv->pm->poweroff_noirq(dev);
-                       suspend_report_result(drv->pm->poweroff_noirq, error);
-               }
-       } else if (pci_has_legacy_pm_support(to_pci_dev(dev))) {
-               error = pci_legacy_suspend_late(dev, PMSG_HIBERNATE);
+       if (pci_has_legacy_pm_support(to_pci_dev(dev)))
+               return pci_legacy_suspend_late(dev, PMSG_HIBERNATE);
+
+       if (drv && drv->pm && drv->pm->poweroff_noirq) {
+               error = drv->pm->poweroff_noirq(dev);
+               suspend_report_result(drv->pm->poweroff_noirq, error);
        }
 
        return error;
 }
 
-static int pci_pm_restore(struct device *dev)
+static int pci_pm_restore_noirq(struct device *dev)
 {
        struct pci_dev *pci_dev = to_pci_dev(dev);
        struct device_driver *drv = dev->driver;
        int error = 0;
 
-       pci_fixup_device(pci_fixup_resume, pci_dev);
+       pci_pm_default_resume_noirq(pci_dev);
 
-       if (drv && drv->pm) {
-               if (drv->pm->restore)
-                       error = drv->pm->restore(dev);
-       } else if (pci_has_legacy_pm_support(pci_dev)) {
-               error = pci_legacy_resume(dev);
-       } else {
-               error = pci_default_pm_resume_late(pci_dev);
-       }
+       if (pci_has_legacy_pm_support(pci_dev))
+               return pci_legacy_resume_early(dev);
+
+       if (drv && drv->pm && drv->pm->restore_noirq)
+               error = drv->pm->restore_noirq(dev);
 
        return error;
 }
 
-static int pci_pm_restore_noirq(struct device *dev)
+static int pci_pm_restore(struct device *dev)
 {
        struct pci_dev *pci_dev = to_pci_dev(dev);
-       struct device_driver *drv = dev->driver;
+       struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
        int error = 0;
 
-       pci_fixup_device(pci_fixup_resume_early, pci_dev);
+       /*
+        * This is necessary for the hibernation error path in which restore is
+        * called without restoring the standard config registers of the device.
+        */
+       if (pci_dev->state_saved)
+               pci_restore_standard_config(pci_dev);
+
+       if (pci_has_legacy_pm_support(pci_dev))
+               return pci_legacy_resume(dev);
+
+       pci_pm_default_resume(pci_dev);
 
-       if (drv && drv->pm) {
-               if (drv->pm->restore_noirq)
-                       error = drv->pm->restore_noirq(dev);
-       } else if (pci_has_legacy_pm_support(pci_dev)) {
-               error = pci_legacy_resume_early(dev);
+       if (pm) {
+               if (pm->restore)
+                       error = pm->restore(dev);
        } else {
-               pci_default_pm_resume_early(pci_dev);
+               pci_pm_reenable_device(pci_dev);
        }
 
        return error;