PCI PM: Rearrange code in pci-driver.c
[firefly-linux-kernel-4.4.55.git] / drivers / pci / pci-driver.c
index c3f76be832d44e0fafb295bd9cfe34b7eab49599..2e76945a1cd880f05023e162ba485b0e2e7b35c1 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;
 
@@ -377,7 +358,12 @@ static int pci_legacy_suspend(struct device *dev, pm_message_t state)
                i = drv->suspend(pci_dev, state);
                suspend_report_result(drv->suspend, i);
        } else {
-               pci_default_pm_suspend(pci_dev);
+               pci_save_state(pci_dev);
+               /*
+                * This is for compatibility with existing code with legacy PM
+                * support.
+                */
+               pci_pm_set_unknown_state(pci_dev);
        }
        return i;
 }
@@ -404,8 +390,9 @@ static int pci_legacy_resume(struct device *dev)
        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);
+               /* restore the PCI config space */
+               pci_restore_state(pci_dev);
+               error = pci_pm_reenable_device(pci_dev);
        }
        return error;
 }
@@ -421,6 +408,97 @@ static int pci_legacy_resume_early(struct device *dev)
        return error;
 }
 
+/* Auxiliary functions used by the new power management framework */
+
+static int pci_restore_standard_config(struct pci_dev *pci_dev)
+{
+       struct pci_dev *parent = pci_dev->bus->self;
+       int error = 0;
+
+       /* Check if the device's bus is operational */
+       if (!parent || parent->current_state == PCI_D0) {
+               pci_restore_state(pci_dev);
+               pci_update_current_state(pci_dev, PCI_D0);
+       } else {
+               dev_warn(&pci_dev->dev, "unable to restore config, "
+                       "bridge %s in low power state D%d\n", pci_name(parent),
+                       parent->current_state);
+               pci_dev->current_state = PCI_UNKNOWN;
+               error = -EAGAIN;
+       }
+
+       return error;
+}
+
+static bool pci_is_bridge(struct pci_dev *pci_dev)
+{
+       return !!(pci_dev->subordinate);
+}
+
+static void pci_pm_default_resume_noirq(struct pci_dev *pci_dev)
+{
+       if (pci_restore_standard_config(pci_dev))
+               pci_fixup_device(pci_fixup_resume_early, pci_dev);
+}
+
+static int pci_pm_default_resume(struct pci_dev *pci_dev)
+{
+       /*
+        * pci_restore_standard_config() should have been called once already,
+        * but it would have failed if the device's parent bridge had not been
+        * in power state D0 at that time.  Check it and try again if necessary.
+        */
+       if (pci_dev->current_state == PCI_UNKNOWN) {
+               int error = pci_restore_standard_config(pci_dev);
+               if (error)
+                       return error;
+       }
+
+       pci_fixup_device(pci_fixup_resume, pci_dev);
+
+       if (!pci_is_bridge(pci_dev))
+               pci_enable_wake(pci_dev, PCI_D0, false);
+
+       return pci_pm_reenable_device(pci_dev);
+}
+
+static void pci_pm_default_suspend_generic(struct pci_dev *pci_dev)
+{
+       /* If device is enabled at this point, disable it */
+       pci_disable_enabled_device(pci_dev);
+       /*
+        * Save state with interrupts enabled, because in principle the bus the
+        * device is on may be put into a low power state after this code runs.
+        */
+       pci_save_state(pci_dev);
+}
+
+static void pci_pm_default_suspend(struct pci_dev *pci_dev)
+{
+       pci_pm_default_suspend_generic(pci_dev);
+
+       if (!pci_is_bridge(pci_dev))
+               pci_prepare_to_sleep(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;
@@ -448,14 +526,21 @@ static int pci_pm_suspend(struct device *dev)
        struct device_driver *drv = dev->driver;
        int error = 0;
 
+       if (pci_has_legacy_pm_support(pci_dev)) {
+               error = pci_legacy_suspend(dev, PMSG_SUSPEND);
+               goto Exit;
+       }
+
        if (drv && drv->pm) {
                if (drv->pm->suspend) {
                        error = drv->pm->suspend(dev);
                        suspend_report_result(drv->pm->suspend, error);
                }
-       } else if (pci_has_legacy_pm_support(pci_dev)) {
-               error = pci_legacy_suspend(dev, PMSG_SUSPEND);
+       } else {
+               pci_pm_default_suspend(pci_dev);
        }
+
+ Exit:
        pci_fixup_device(pci_fixup_suspend, pci_dev);
 
        return error;
@@ -467,15 +552,16 @@ static int pci_pm_suspend_noirq(struct device *dev)
        struct device_driver *drv = dev->driver;
        int error = 0;
 
+       if (pci_has_legacy_pm_support(pci_dev))
+               return pci_legacy_suspend_late(dev, PMSG_SUSPEND);
+
        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);
+               pci_pm_set_unknown_state(pci_dev);
        }
 
        return error;
@@ -487,15 +573,18 @@ static int pci_pm_resume(struct device *dev)
        struct device_driver *drv = dev->driver;
        int error = 0;
 
-       pci_fixup_device(pci_fixup_resume, pci_dev);
+       if (pci_has_legacy_pm_support(pci_dev)) {
+               pci_fixup_device(pci_fixup_resume, pci_dev);
+               return pci_legacy_resume(dev);
+       }
 
        if (drv && drv->pm) {
+               pci_fixup_device(pci_fixup_resume, pci_dev);
+
                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);
+               error = pci_pm_default_resume(pci_dev);
        }
 
        return error;
@@ -507,15 +596,18 @@ static int pci_pm_resume_noirq(struct device *dev)
        struct device_driver *drv = dev->driver;
        int error = 0;
 
-       pci_fixup_device(pci_fixup_resume_early, to_pci_dev(dev));
+       if (pci_has_legacy_pm_support(pci_dev)) {
+               pci_fixup_device(pci_fixup_resume_early, pci_dev);
+               return pci_legacy_resume_early(dev);
+       }
 
        if (drv && drv->pm) {
+               pci_fixup_device(pci_fixup_resume_early, pci_dev);
+
                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);
        } else {
-               pci_default_pm_resume_early(pci_dev);
+               pci_pm_default_resume_noirq(pci_dev);
        }
 
        return error;
@@ -538,14 +630,19 @@ static int pci_pm_freeze(struct device *dev)
        struct device_driver *drv = dev->driver;
        int error = 0;
 
+       if (pci_has_legacy_pm_support(pci_dev)) {
+               error = pci_legacy_suspend(dev, PMSG_FREEZE);
+               pci_fixup_device(pci_fixup_suspend, pci_dev);
+               return error;
+       }
+
        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);
+       } else {
+               pci_pm_default_suspend_generic(pci_dev);
        }
 
        return error;
@@ -557,15 +654,16 @@ static int pci_pm_freeze_noirq(struct device *dev)
        struct device_driver *drv = dev->driver;
        int error = 0;
 
+       if (pci_has_legacy_pm_support(pci_dev))
+               return pci_legacy_suspend_late(dev, PMSG_FREEZE);
+
        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);
+               pci_pm_set_unknown_state(pci_dev);
        }
 
        return error;
@@ -577,12 +675,16 @@ static int pci_pm_thaw(struct device *dev)
        struct device_driver *drv = dev->driver;
        int error = 0;
 
+       if (pci_has_legacy_pm_support(pci_dev)) {
+               pci_fixup_device(pci_fixup_resume, pci_dev);
+               return pci_legacy_resume(dev);
+       }
+
        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);
+       } else {
+               pci_pm_reenable_device(pci_dev);
        }
 
        return error;
@@ -594,12 +696,16 @@ static int pci_pm_thaw_noirq(struct device *dev)
        struct device_driver *drv = dev->driver;
        int error = 0;
 
+       if (pci_has_legacy_pm_support(pci_dev)) {
+               pci_fixup_device(pci_fixup_resume_early, to_pci_dev(dev));
+               return pci_legacy_resume_early(dev);
+       }
+
        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);
+       } else {
+               pci_update_current_state(pci_dev, PCI_D0);
        }
 
        return error;
@@ -611,17 +717,23 @@ static int pci_pm_poweroff(struct device *dev)
        struct device_driver *drv = dev->driver;
        int error = 0;
 
-       pci_fixup_device(pci_fixup_suspend, pci_dev);
+       if (pci_has_legacy_pm_support(pci_dev)) {
+               error = pci_legacy_suspend(dev, PMSG_HIBERNATE);
+               goto Exit;
+       }
 
        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);
+       } else {
+               pci_pm_default_suspend(pci_dev);
        }
 
+ Exit:
+       pci_fixup_device(pci_fixup_suspend, pci_dev);
+
        return error;
 }
 
@@ -630,13 +742,14 @@ static int pci_pm_poweroff_noirq(struct device *dev)
        struct device_driver *drv = dev->driver;
        int error = 0;
 
+       if (pci_has_legacy_pm_support(to_pci_dev(dev)))
+               return pci_legacy_suspend_late(dev, PMSG_HIBERNATE);
+
        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);
        }
 
        return error;
@@ -648,15 +761,19 @@ static int pci_pm_restore(struct device *dev)
        struct device_driver *drv = dev->driver;
        int error = 0;
 
+       if (pci_has_legacy_pm_support(pci_dev)) {
+               pci_fixup_device(pci_fixup_resume, pci_dev);
+               return pci_legacy_resume(dev);
+       }
+
        if (drv && drv->pm) {
+               pci_fixup_device(pci_fixup_resume, pci_dev);
+
                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);
+               error = pci_pm_default_resume(pci_dev);
        }
-       pci_fixup_device(pci_fixup_resume, pci_dev);
 
        return error;
 }
@@ -667,17 +784,19 @@ static int pci_pm_restore_noirq(struct device *dev)
        struct device_driver *drv = dev->driver;
        int error = 0;
 
-       pci_fixup_device(pci_fixup_resume, pci_dev);
+       if (pci_has_legacy_pm_support(pci_dev)) {
+               pci_fixup_device(pci_fixup_resume_early, pci_dev);
+               return pci_legacy_resume_early(dev);
+       }
 
        if (drv && drv->pm) {
+               pci_fixup_device(pci_fixup_resume_early, pci_dev);
+
                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);
        } else {
-               pci_default_pm_resume_early(pci_dev);
+               pci_pm_default_resume_noirq(pci_dev);
        }
-       pci_fixup_device(pci_fixup_resume_early, pci_dev);
 
        return error;
 }