Back to home page

OSCL-LXR
 
 

     

0001 // SPDX-License-Identifier: GPL-2.0
0002 /*
0003  * (C) Copyright 2002-2004, 2007 Greg Kroah-Hartman <greg@kroah.com>
0004  * (C) Copyright 2007 Novell Inc.
0005  */
0006 
0007 #include <linux/pci.h>
0008 #include <linux/module.h>
0009 #include <linux/init.h>
0010 #include <linux/device.h>
0011 #include <linux/mempolicy.h>
0012 #include <linux/string.h>
0013 #include <linux/slab.h>
0014 #include <linux/sched.h>
0015 #include <linux/sched/isolation.h>
0016 #include <linux/cpu.h>
0017 #include <linux/pm_runtime.h>
0018 #include <linux/suspend.h>
0019 #include <linux/kexec.h>
0020 #include <linux/of_device.h>
0021 #include <linux/acpi.h>
0022 #include <linux/dma-map-ops.h>
0023 #include <linux/iommu.h>
0024 #include "pci.h"
0025 #include "pcie/portdrv.h"
0026 
0027 struct pci_dynid {
0028     struct list_head node;
0029     struct pci_device_id id;
0030 };
0031 
0032 /**
0033  * pci_add_dynid - add a new PCI device ID to this driver and re-probe devices
0034  * @drv: target pci driver
0035  * @vendor: PCI vendor ID
0036  * @device: PCI device ID
0037  * @subvendor: PCI subvendor ID
0038  * @subdevice: PCI subdevice ID
0039  * @class: PCI class
0040  * @class_mask: PCI class mask
0041  * @driver_data: private driver data
0042  *
0043  * Adds a new dynamic pci device ID to this driver and causes the
0044  * driver to probe for all devices again.  @drv must have been
0045  * registered prior to calling this function.
0046  *
0047  * CONTEXT:
0048  * Does GFP_KERNEL allocation.
0049  *
0050  * RETURNS:
0051  * 0 on success, -errno on failure.
0052  */
0053 int pci_add_dynid(struct pci_driver *drv,
0054           unsigned int vendor, unsigned int device,
0055           unsigned int subvendor, unsigned int subdevice,
0056           unsigned int class, unsigned int class_mask,
0057           unsigned long driver_data)
0058 {
0059     struct pci_dynid *dynid;
0060 
0061     dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
0062     if (!dynid)
0063         return -ENOMEM;
0064 
0065     dynid->id.vendor = vendor;
0066     dynid->id.device = device;
0067     dynid->id.subvendor = subvendor;
0068     dynid->id.subdevice = subdevice;
0069     dynid->id.class = class;
0070     dynid->id.class_mask = class_mask;
0071     dynid->id.driver_data = driver_data;
0072 
0073     spin_lock(&drv->dynids.lock);
0074     list_add_tail(&dynid->node, &drv->dynids.list);
0075     spin_unlock(&drv->dynids.lock);
0076 
0077     return driver_attach(&drv->driver);
0078 }
0079 EXPORT_SYMBOL_GPL(pci_add_dynid);
0080 
0081 static void pci_free_dynids(struct pci_driver *drv)
0082 {
0083     struct pci_dynid *dynid, *n;
0084 
0085     spin_lock(&drv->dynids.lock);
0086     list_for_each_entry_safe(dynid, n, &drv->dynids.list, node) {
0087         list_del(&dynid->node);
0088         kfree(dynid);
0089     }
0090     spin_unlock(&drv->dynids.lock);
0091 }
0092 
0093 /**
0094  * pci_match_id - See if a PCI device matches a given pci_id table
0095  * @ids: array of PCI device ID structures to search in
0096  * @dev: the PCI device structure to match against.
0097  *
0098  * Used by a driver to check whether a PCI device is in its list of
0099  * supported devices.  Returns the matching pci_device_id structure or
0100  * %NULL if there is no match.
0101  *
0102  * Deprecated; don't use this as it will not catch any dynamic IDs
0103  * that a driver might want to check for.
0104  */
0105 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
0106                      struct pci_dev *dev)
0107 {
0108     if (ids) {
0109         while (ids->vendor || ids->subvendor || ids->class_mask) {
0110             if (pci_match_one_device(ids, dev))
0111                 return ids;
0112             ids++;
0113         }
0114     }
0115     return NULL;
0116 }
0117 EXPORT_SYMBOL(pci_match_id);
0118 
0119 static const struct pci_device_id pci_device_id_any = {
0120     .vendor = PCI_ANY_ID,
0121     .device = PCI_ANY_ID,
0122     .subvendor = PCI_ANY_ID,
0123     .subdevice = PCI_ANY_ID,
0124 };
0125 
0126 /**
0127  * pci_match_device - See if a device matches a driver's list of IDs
0128  * @drv: the PCI driver to match against
0129  * @dev: the PCI device structure to match against
0130  *
0131  * Used by a driver to check whether a PCI device is in its list of
0132  * supported devices or in the dynids list, which may have been augmented
0133  * via the sysfs "new_id" file.  Returns the matching pci_device_id
0134  * structure or %NULL if there is no match.
0135  */
0136 static const struct pci_device_id *pci_match_device(struct pci_driver *drv,
0137                             struct pci_dev *dev)
0138 {
0139     struct pci_dynid *dynid;
0140     const struct pci_device_id *found_id = NULL, *ids;
0141 
0142     /* When driver_override is set, only bind to the matching driver */
0143     if (dev->driver_override && strcmp(dev->driver_override, drv->name))
0144         return NULL;
0145 
0146     /* Look at the dynamic ids first, before the static ones */
0147     spin_lock(&drv->dynids.lock);
0148     list_for_each_entry(dynid, &drv->dynids.list, node) {
0149         if (pci_match_one_device(&dynid->id, dev)) {
0150             found_id = &dynid->id;
0151             break;
0152         }
0153     }
0154     spin_unlock(&drv->dynids.lock);
0155 
0156     if (found_id)
0157         return found_id;
0158 
0159     for (ids = drv->id_table; (found_id = pci_match_id(ids, dev));
0160          ids = found_id + 1) {
0161         /*
0162          * The match table is split based on driver_override.
0163          * In case override_only was set, enforce driver_override
0164          * matching.
0165          */
0166         if (found_id->override_only) {
0167             if (dev->driver_override)
0168                 return found_id;
0169         } else {
0170             return found_id;
0171         }
0172     }
0173 
0174     /* driver_override will always match, send a dummy id */
0175     if (dev->driver_override)
0176         return &pci_device_id_any;
0177     return NULL;
0178 }
0179 
0180 /**
0181  * new_id_store - sysfs frontend to pci_add_dynid()
0182  * @driver: target device driver
0183  * @buf: buffer for scanning device ID data
0184  * @count: input size
0185  *
0186  * Allow PCI IDs to be added to an existing driver via sysfs.
0187  */
0188 static ssize_t new_id_store(struct device_driver *driver, const char *buf,
0189                 size_t count)
0190 {
0191     struct pci_driver *pdrv = to_pci_driver(driver);
0192     const struct pci_device_id *ids = pdrv->id_table;
0193     u32 vendor, device, subvendor = PCI_ANY_ID,
0194         subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
0195     unsigned long driver_data = 0;
0196     int fields = 0;
0197     int retval = 0;
0198 
0199     fields = sscanf(buf, "%x %x %x %x %x %x %lx",
0200             &vendor, &device, &subvendor, &subdevice,
0201             &class, &class_mask, &driver_data);
0202     if (fields < 2)
0203         return -EINVAL;
0204 
0205     if (fields != 7) {
0206         struct pci_dev *pdev = kzalloc(sizeof(*pdev), GFP_KERNEL);
0207         if (!pdev)
0208             return -ENOMEM;
0209 
0210         pdev->vendor = vendor;
0211         pdev->device = device;
0212         pdev->subsystem_vendor = subvendor;
0213         pdev->subsystem_device = subdevice;
0214         pdev->class = class;
0215 
0216         if (pci_match_device(pdrv, pdev))
0217             retval = -EEXIST;
0218 
0219         kfree(pdev);
0220 
0221         if (retval)
0222             return retval;
0223     }
0224 
0225     /* Only accept driver_data values that match an existing id_table
0226        entry */
0227     if (ids) {
0228         retval = -EINVAL;
0229         while (ids->vendor || ids->subvendor || ids->class_mask) {
0230             if (driver_data == ids->driver_data) {
0231                 retval = 0;
0232                 break;
0233             }
0234             ids++;
0235         }
0236         if (retval) /* No match */
0237             return retval;
0238     }
0239 
0240     retval = pci_add_dynid(pdrv, vendor, device, subvendor, subdevice,
0241                    class, class_mask, driver_data);
0242     if (retval)
0243         return retval;
0244     return count;
0245 }
0246 static DRIVER_ATTR_WO(new_id);
0247 
0248 /**
0249  * remove_id_store - remove a PCI device ID from this driver
0250  * @driver: target device driver
0251  * @buf: buffer for scanning device ID data
0252  * @count: input size
0253  *
0254  * Removes a dynamic pci device ID to this driver.
0255  */
0256 static ssize_t remove_id_store(struct device_driver *driver, const char *buf,
0257                    size_t count)
0258 {
0259     struct pci_dynid *dynid, *n;
0260     struct pci_driver *pdrv = to_pci_driver(driver);
0261     u32 vendor, device, subvendor = PCI_ANY_ID,
0262         subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
0263     int fields = 0;
0264     size_t retval = -ENODEV;
0265 
0266     fields = sscanf(buf, "%x %x %x %x %x %x",
0267             &vendor, &device, &subvendor, &subdevice,
0268             &class, &class_mask);
0269     if (fields < 2)
0270         return -EINVAL;
0271 
0272     spin_lock(&pdrv->dynids.lock);
0273     list_for_each_entry_safe(dynid, n, &pdrv->dynids.list, node) {
0274         struct pci_device_id *id = &dynid->id;
0275         if ((id->vendor == vendor) &&
0276             (id->device == device) &&
0277             (subvendor == PCI_ANY_ID || id->subvendor == subvendor) &&
0278             (subdevice == PCI_ANY_ID || id->subdevice == subdevice) &&
0279             !((id->class ^ class) & class_mask)) {
0280             list_del(&dynid->node);
0281             kfree(dynid);
0282             retval = count;
0283             break;
0284         }
0285     }
0286     spin_unlock(&pdrv->dynids.lock);
0287 
0288     return retval;
0289 }
0290 static DRIVER_ATTR_WO(remove_id);
0291 
0292 static struct attribute *pci_drv_attrs[] = {
0293     &driver_attr_new_id.attr,
0294     &driver_attr_remove_id.attr,
0295     NULL,
0296 };
0297 ATTRIBUTE_GROUPS(pci_drv);
0298 
0299 struct drv_dev_and_id {
0300     struct pci_driver *drv;
0301     struct pci_dev *dev;
0302     const struct pci_device_id *id;
0303 };
0304 
0305 static long local_pci_probe(void *_ddi)
0306 {
0307     struct drv_dev_and_id *ddi = _ddi;
0308     struct pci_dev *pci_dev = ddi->dev;
0309     struct pci_driver *pci_drv = ddi->drv;
0310     struct device *dev = &pci_dev->dev;
0311     int rc;
0312 
0313     /*
0314      * Unbound PCI devices are always put in D0, regardless of
0315      * runtime PM status.  During probe, the device is set to
0316      * active and the usage count is incremented.  If the driver
0317      * supports runtime PM, it should call pm_runtime_put_noidle(),
0318      * or any other runtime PM helper function decrementing the usage
0319      * count, in its probe routine and pm_runtime_get_noresume() in
0320      * its remove routine.
0321      */
0322     pm_runtime_get_sync(dev);
0323     pci_dev->driver = pci_drv;
0324     rc = pci_drv->probe(pci_dev, ddi->id);
0325     if (!rc)
0326         return rc;
0327     if (rc < 0) {
0328         pci_dev->driver = NULL;
0329         pm_runtime_put_sync(dev);
0330         return rc;
0331     }
0332     /*
0333      * Probe function should return < 0 for failure, 0 for success
0334      * Treat values > 0 as success, but warn.
0335      */
0336     pci_warn(pci_dev, "Driver probe function unexpectedly returned %d\n",
0337          rc);
0338     return 0;
0339 }
0340 
0341 static bool pci_physfn_is_probed(struct pci_dev *dev)
0342 {
0343 #ifdef CONFIG_PCI_IOV
0344     return dev->is_virtfn && dev->physfn->is_probed;
0345 #else
0346     return false;
0347 #endif
0348 }
0349 
0350 static int pci_call_probe(struct pci_driver *drv, struct pci_dev *dev,
0351               const struct pci_device_id *id)
0352 {
0353     int error, node, cpu;
0354     struct drv_dev_and_id ddi = { drv, dev, id };
0355 
0356     /*
0357      * Execute driver initialization on node where the device is
0358      * attached.  This way the driver likely allocates its local memory
0359      * on the right node.
0360      */
0361     node = dev_to_node(&dev->dev);
0362     dev->is_probed = 1;
0363 
0364     cpu_hotplug_disable();
0365 
0366     /*
0367      * Prevent nesting work_on_cpu() for the case where a Virtual Function
0368      * device is probed from work_on_cpu() of the Physical device.
0369      */
0370     if (node < 0 || node >= MAX_NUMNODES || !node_online(node) ||
0371         pci_physfn_is_probed(dev)) {
0372         cpu = nr_cpu_ids;
0373     } else {
0374         cpumask_var_t wq_domain_mask;
0375 
0376         if (!zalloc_cpumask_var(&wq_domain_mask, GFP_KERNEL)) {
0377             error = -ENOMEM;
0378             goto out;
0379         }
0380         cpumask_and(wq_domain_mask,
0381                 housekeeping_cpumask(HK_TYPE_WQ),
0382                 housekeeping_cpumask(HK_TYPE_DOMAIN));
0383 
0384         cpu = cpumask_any_and(cpumask_of_node(node),
0385                       wq_domain_mask);
0386         free_cpumask_var(wq_domain_mask);
0387     }
0388 
0389     if (cpu < nr_cpu_ids)
0390         error = work_on_cpu(cpu, local_pci_probe, &ddi);
0391     else
0392         error = local_pci_probe(&ddi);
0393 out:
0394     dev->is_probed = 0;
0395     cpu_hotplug_enable();
0396     return error;
0397 }
0398 
0399 /**
0400  * __pci_device_probe - check if a driver wants to claim a specific PCI device
0401  * @drv: driver to call to check if it wants the PCI device
0402  * @pci_dev: PCI device being probed
0403  *
0404  * returns 0 on success, else error.
0405  * side-effect: pci_dev->driver is set to drv when drv claims pci_dev.
0406  */
0407 static int __pci_device_probe(struct pci_driver *drv, struct pci_dev *pci_dev)
0408 {
0409     const struct pci_device_id *id;
0410     int error = 0;
0411 
0412     if (drv->probe) {
0413         error = -ENODEV;
0414 
0415         id = pci_match_device(drv, pci_dev);
0416         if (id)
0417             error = pci_call_probe(drv, pci_dev, id);
0418     }
0419     return error;
0420 }
0421 
0422 int __weak pcibios_alloc_irq(struct pci_dev *dev)
0423 {
0424     return 0;
0425 }
0426 
0427 void __weak pcibios_free_irq(struct pci_dev *dev)
0428 {
0429 }
0430 
0431 #ifdef CONFIG_PCI_IOV
0432 static inline bool pci_device_can_probe(struct pci_dev *pdev)
0433 {
0434     return (!pdev->is_virtfn || pdev->physfn->sriov->drivers_autoprobe ||
0435         pdev->driver_override);
0436 }
0437 #else
0438 static inline bool pci_device_can_probe(struct pci_dev *pdev)
0439 {
0440     return true;
0441 }
0442 #endif
0443 
0444 static int pci_device_probe(struct device *dev)
0445 {
0446     int error;
0447     struct pci_dev *pci_dev = to_pci_dev(dev);
0448     struct pci_driver *drv = to_pci_driver(dev->driver);
0449 
0450     if (!pci_device_can_probe(pci_dev))
0451         return -ENODEV;
0452 
0453     pci_assign_irq(pci_dev);
0454 
0455     error = pcibios_alloc_irq(pci_dev);
0456     if (error < 0)
0457         return error;
0458 
0459     pci_dev_get(pci_dev);
0460     error = __pci_device_probe(drv, pci_dev);
0461     if (error) {
0462         pcibios_free_irq(pci_dev);
0463         pci_dev_put(pci_dev);
0464     }
0465 
0466     return error;
0467 }
0468 
0469 static void pci_device_remove(struct device *dev)
0470 {
0471     struct pci_dev *pci_dev = to_pci_dev(dev);
0472     struct pci_driver *drv = pci_dev->driver;
0473 
0474     if (drv->remove) {
0475         pm_runtime_get_sync(dev);
0476         drv->remove(pci_dev);
0477         pm_runtime_put_noidle(dev);
0478     }
0479     pcibios_free_irq(pci_dev);
0480     pci_dev->driver = NULL;
0481     pci_iov_remove(pci_dev);
0482 
0483     /* Undo the runtime PM settings in local_pci_probe() */
0484     pm_runtime_put_sync(dev);
0485 
0486     /*
0487      * If the device is still on, set the power state as "unknown",
0488      * since it might change by the next time we load the driver.
0489      */
0490     if (pci_dev->current_state == PCI_D0)
0491         pci_dev->current_state = PCI_UNKNOWN;
0492 
0493     /*
0494      * We would love to complain here if pci_dev->is_enabled is set, that
0495      * the driver should have called pci_disable_device(), but the
0496      * unfortunate fact is there are too many odd BIOS and bridge setups
0497      * that don't like drivers doing that all of the time.
0498      * Oh well, we can dream of sane hardware when we sleep, no matter how
0499      * horrible the crap we have to deal with is when we are awake...
0500      */
0501 
0502     pci_dev_put(pci_dev);
0503 }
0504 
0505 static void pci_device_shutdown(struct device *dev)
0506 {
0507     struct pci_dev *pci_dev = to_pci_dev(dev);
0508     struct pci_driver *drv = pci_dev->driver;
0509 
0510     pm_runtime_resume(dev);
0511 
0512     if (drv && drv->shutdown)
0513         drv->shutdown(pci_dev);
0514 
0515     /*
0516      * If this is a kexec reboot, turn off Bus Master bit on the
0517      * device to tell it to not continue to do DMA. Don't touch
0518      * devices in D3cold or unknown states.
0519      * If it is not a kexec reboot, firmware will hit the PCI
0520      * devices with big hammer and stop their DMA any way.
0521      */
0522     if (kexec_in_progress && (pci_dev->current_state <= PCI_D3hot))
0523         pci_clear_master(pci_dev);
0524 }
0525 
0526 #ifdef CONFIG_PM_SLEEP
0527 
0528 /* Auxiliary functions used for system resume */
0529 
0530 /**
0531  * pci_restore_standard_config - restore standard config registers of PCI device
0532  * @pci_dev: PCI device to handle
0533  */
0534 static int pci_restore_standard_config(struct pci_dev *pci_dev)
0535 {
0536     pci_update_current_state(pci_dev, PCI_UNKNOWN);
0537 
0538     if (pci_dev->current_state != PCI_D0) {
0539         int error = pci_set_power_state(pci_dev, PCI_D0);
0540         if (error)
0541             return error;
0542     }
0543 
0544     pci_restore_state(pci_dev);
0545     pci_pme_restore(pci_dev);
0546     return 0;
0547 }
0548 #endif /* CONFIG_PM_SLEEP */
0549 
0550 #ifdef CONFIG_PM
0551 
0552 /* Auxiliary functions used for system resume and run-time resume */
0553 
0554 static void pci_pm_default_resume(struct pci_dev *pci_dev)
0555 {
0556     pci_fixup_device(pci_fixup_resume, pci_dev);
0557     pci_enable_wake(pci_dev, PCI_D0, false);
0558 }
0559 
0560 static void pci_pm_power_up_and_verify_state(struct pci_dev *pci_dev)
0561 {
0562     pci_power_up(pci_dev);
0563     pci_update_current_state(pci_dev, PCI_D0);
0564 }
0565 
0566 static void pci_pm_default_resume_early(struct pci_dev *pci_dev)
0567 {
0568     pci_pm_power_up_and_verify_state(pci_dev);
0569     pci_restore_state(pci_dev);
0570     pci_pme_restore(pci_dev);
0571 }
0572 
0573 static void pci_pm_bridge_power_up_actions(struct pci_dev *pci_dev)
0574 {
0575     pci_bridge_wait_for_secondary_bus(pci_dev);
0576     /*
0577      * When powering on a bridge from D3cold, the whole hierarchy may be
0578      * powered on into D0uninitialized state, resume them to give them a
0579      * chance to suspend again
0580      */
0581     pci_resume_bus(pci_dev->subordinate);
0582 }
0583 
0584 #endif /* CONFIG_PM */
0585 
0586 #ifdef CONFIG_PM_SLEEP
0587 
0588 /*
0589  * Default "suspend" method for devices that have no driver provided suspend,
0590  * or not even a driver at all (second part).
0591  */
0592 static void pci_pm_set_unknown_state(struct pci_dev *pci_dev)
0593 {
0594     /*
0595      * mark its power state as "unknown", since we don't know if
0596      * e.g. the BIOS will change its device state when we suspend.
0597      */
0598     if (pci_dev->current_state == PCI_D0)
0599         pci_dev->current_state = PCI_UNKNOWN;
0600 }
0601 
0602 /*
0603  * Default "resume" method for devices that have no driver provided resume,
0604  * or not even a driver at all (second part).
0605  */
0606 static int pci_pm_reenable_device(struct pci_dev *pci_dev)
0607 {
0608     int retval;
0609 
0610     /* if the device was enabled before suspend, re-enable */
0611     retval = pci_reenable_device(pci_dev);
0612     /*
0613      * if the device was busmaster before the suspend, make it busmaster
0614      * again
0615      */
0616     if (pci_dev->is_busmaster)
0617         pci_set_master(pci_dev);
0618 
0619     return retval;
0620 }
0621 
0622 static int pci_legacy_suspend(struct device *dev, pm_message_t state)
0623 {
0624     struct pci_dev *pci_dev = to_pci_dev(dev);
0625     struct pci_driver *drv = pci_dev->driver;
0626 
0627     if (drv && drv->suspend) {
0628         pci_power_t prev = pci_dev->current_state;
0629         int error;
0630 
0631         error = drv->suspend(pci_dev, state);
0632         suspend_report_result(dev, drv->suspend, error);
0633         if (error)
0634             return error;
0635 
0636         if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
0637             && pci_dev->current_state != PCI_UNKNOWN) {
0638             pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
0639                       "PCI PM: Device state not saved by %pS\n",
0640                       drv->suspend);
0641         }
0642     }
0643 
0644     pci_fixup_device(pci_fixup_suspend, pci_dev);
0645 
0646     return 0;
0647 }
0648 
0649 static int pci_legacy_suspend_late(struct device *dev, pm_message_t state)
0650 {
0651     struct pci_dev *pci_dev = to_pci_dev(dev);
0652 
0653     if (!pci_dev->state_saved)
0654         pci_save_state(pci_dev);
0655 
0656     pci_pm_set_unknown_state(pci_dev);
0657 
0658     pci_fixup_device(pci_fixup_suspend_late, pci_dev);
0659 
0660     return 0;
0661 }
0662 
0663 static int pci_legacy_resume(struct device *dev)
0664 {
0665     struct pci_dev *pci_dev = to_pci_dev(dev);
0666     struct pci_driver *drv = pci_dev->driver;
0667 
0668     pci_fixup_device(pci_fixup_resume, pci_dev);
0669 
0670     return drv && drv->resume ?
0671             drv->resume(pci_dev) : pci_pm_reenable_device(pci_dev);
0672 }
0673 
0674 /* Auxiliary functions used by the new power management framework */
0675 
0676 static void pci_pm_default_suspend(struct pci_dev *pci_dev)
0677 {
0678     /* Disable non-bridge devices without PM support */
0679     if (!pci_has_subordinate(pci_dev))
0680         pci_disable_enabled_device(pci_dev);
0681 }
0682 
0683 static bool pci_has_legacy_pm_support(struct pci_dev *pci_dev)
0684 {
0685     struct pci_driver *drv = pci_dev->driver;
0686     bool ret = drv && (drv->suspend || drv->resume);
0687 
0688     /*
0689      * Legacy PM support is used by default, so warn if the new framework is
0690      * supported as well.  Drivers are supposed to support either the
0691      * former, or the latter, but not both at the same time.
0692      */
0693     pci_WARN(pci_dev, ret && drv->driver.pm, "device %04x:%04x\n",
0694          pci_dev->vendor, pci_dev->device);
0695 
0696     return ret;
0697 }
0698 
0699 /* New power management framework */
0700 
0701 static int pci_pm_prepare(struct device *dev)
0702 {
0703     struct pci_dev *pci_dev = to_pci_dev(dev);
0704     const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
0705 
0706     if (pm && pm->prepare) {
0707         int error = pm->prepare(dev);
0708         if (error < 0)
0709             return error;
0710 
0711         if (!error && dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_PREPARE))
0712             return 0;
0713     }
0714     if (pci_dev_need_resume(pci_dev))
0715         return 0;
0716 
0717     /*
0718      * The PME setting needs to be adjusted here in case the direct-complete
0719      * optimization is used with respect to this device.
0720      */
0721     pci_dev_adjust_pme(pci_dev);
0722     return 1;
0723 }
0724 
0725 static void pci_pm_complete(struct device *dev)
0726 {
0727     struct pci_dev *pci_dev = to_pci_dev(dev);
0728 
0729     pci_dev_complete_resume(pci_dev);
0730     pm_generic_complete(dev);
0731 
0732     /* Resume device if platform firmware has put it in reset-power-on */
0733     if (pm_runtime_suspended(dev) && pm_resume_via_firmware()) {
0734         pci_power_t pre_sleep_state = pci_dev->current_state;
0735 
0736         pci_refresh_power_state(pci_dev);
0737         /*
0738          * On platforms with ACPI this check may also trigger for
0739          * devices sharing power resources if one of those power
0740          * resources has been activated as a result of a change of the
0741          * power state of another device sharing it.  However, in that
0742          * case it is also better to resume the device, in general.
0743          */
0744         if (pci_dev->current_state < pre_sleep_state)
0745             pm_request_resume(dev);
0746     }
0747 }
0748 
0749 #else /* !CONFIG_PM_SLEEP */
0750 
0751 #define pci_pm_prepare  NULL
0752 #define pci_pm_complete NULL
0753 
0754 #endif /* !CONFIG_PM_SLEEP */
0755 
0756 #ifdef CONFIG_SUSPEND
0757 static void pcie_pme_root_status_cleanup(struct pci_dev *pci_dev)
0758 {
0759     /*
0760      * Some BIOSes forget to clear Root PME Status bits after system
0761      * wakeup, which breaks ACPI-based runtime wakeup on PCI Express.
0762      * Clear those bits now just in case (shouldn't hurt).
0763      */
0764     if (pci_is_pcie(pci_dev) &&
0765         (pci_pcie_type(pci_dev) == PCI_EXP_TYPE_ROOT_PORT ||
0766          pci_pcie_type(pci_dev) == PCI_EXP_TYPE_RC_EC))
0767         pcie_clear_root_pme_status(pci_dev);
0768 }
0769 
0770 static int pci_pm_suspend(struct device *dev)
0771 {
0772     struct pci_dev *pci_dev = to_pci_dev(dev);
0773     const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
0774 
0775     pci_dev->skip_bus_pm = false;
0776 
0777     if (pci_has_legacy_pm_support(pci_dev))
0778         return pci_legacy_suspend(dev, PMSG_SUSPEND);
0779 
0780     if (!pm) {
0781         pci_pm_default_suspend(pci_dev);
0782         return 0;
0783     }
0784 
0785     /*
0786      * PCI devices suspended at run time may need to be resumed at this
0787      * point, because in general it may be necessary to reconfigure them for
0788      * system suspend.  Namely, if the device is expected to wake up the
0789      * system from the sleep state, it may have to be reconfigured for this
0790      * purpose, or if the device is not expected to wake up the system from
0791      * the sleep state, it should be prevented from signaling wakeup events
0792      * going forward.
0793      *
0794      * Also if the driver of the device does not indicate that its system
0795      * suspend callbacks can cope with runtime-suspended devices, it is
0796      * better to resume the device from runtime suspend here.
0797      */
0798     if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
0799         pci_dev_need_resume(pci_dev)) {
0800         pm_runtime_resume(dev);
0801         pci_dev->state_saved = false;
0802     } else {
0803         pci_dev_adjust_pme(pci_dev);
0804     }
0805 
0806     if (pm->suspend) {
0807         pci_power_t prev = pci_dev->current_state;
0808         int error;
0809 
0810         error = pm->suspend(dev);
0811         suspend_report_result(dev, pm->suspend, error);
0812         if (error)
0813             return error;
0814 
0815         if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
0816             && pci_dev->current_state != PCI_UNKNOWN) {
0817             pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
0818                       "PCI PM: State of device not saved by %pS\n",
0819                       pm->suspend);
0820         }
0821     }
0822 
0823     return 0;
0824 }
0825 
0826 static int pci_pm_suspend_late(struct device *dev)
0827 {
0828     if (dev_pm_skip_suspend(dev))
0829         return 0;
0830 
0831     pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));
0832 
0833     return pm_generic_suspend_late(dev);
0834 }
0835 
0836 static int pci_pm_suspend_noirq(struct device *dev)
0837 {
0838     struct pci_dev *pci_dev = to_pci_dev(dev);
0839     const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
0840 
0841     if (dev_pm_skip_suspend(dev))
0842         return 0;
0843 
0844     if (pci_has_legacy_pm_support(pci_dev))
0845         return pci_legacy_suspend_late(dev, PMSG_SUSPEND);
0846 
0847     if (!pm) {
0848         pci_save_state(pci_dev);
0849         goto Fixup;
0850     }
0851 
0852     if (pm->suspend_noirq) {
0853         pci_power_t prev = pci_dev->current_state;
0854         int error;
0855 
0856         error = pm->suspend_noirq(dev);
0857         suspend_report_result(dev, pm->suspend_noirq, error);
0858         if (error)
0859             return error;
0860 
0861         if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
0862             && pci_dev->current_state != PCI_UNKNOWN) {
0863             pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
0864                       "PCI PM: State of device not saved by %pS\n",
0865                       pm->suspend_noirq);
0866             goto Fixup;
0867         }
0868     }
0869 
0870     if (pci_dev->skip_bus_pm) {
0871         /*
0872          * Either the device is a bridge with a child in D0 below it, or
0873          * the function is running for the second time in a row without
0874          * going through full resume, which is possible only during
0875          * suspend-to-idle in a spurious wakeup case.  The device should
0876          * be in D0 at this point, but if it is a bridge, it may be
0877          * necessary to save its state.
0878          */
0879         if (!pci_dev->state_saved)
0880             pci_save_state(pci_dev);
0881     } else if (!pci_dev->state_saved) {
0882         pci_save_state(pci_dev);
0883         if (pci_power_manageable(pci_dev))
0884             pci_prepare_to_sleep(pci_dev);
0885     }
0886 
0887     pci_dbg(pci_dev, "PCI PM: Suspend power state: %s\n",
0888         pci_power_name(pci_dev->current_state));
0889 
0890     if (pci_dev->current_state == PCI_D0) {
0891         pci_dev->skip_bus_pm = true;
0892         /*
0893          * Per PCI PM r1.2, table 6-1, a bridge must be in D0 if any
0894          * downstream device is in D0, so avoid changing the power state
0895          * of the parent bridge by setting the skip_bus_pm flag for it.
0896          */
0897         if (pci_dev->bus->self)
0898             pci_dev->bus->self->skip_bus_pm = true;
0899     }
0900 
0901     if (pci_dev->skip_bus_pm && pm_suspend_no_platform()) {
0902         pci_dbg(pci_dev, "PCI PM: Skipped\n");
0903         goto Fixup;
0904     }
0905 
0906     pci_pm_set_unknown_state(pci_dev);
0907 
0908     /*
0909      * Some BIOSes from ASUS have a bug: If a USB EHCI host controller's
0910      * PCI COMMAND register isn't 0, the BIOS assumes that the controller
0911      * hasn't been quiesced and tries to turn it off.  If the controller
0912      * is already in D3, this can hang or cause memory corruption.
0913      *
0914      * Since the value of the COMMAND register doesn't matter once the
0915      * device has been suspended, we can safely set it to 0 here.
0916      */
0917     if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
0918         pci_write_config_word(pci_dev, PCI_COMMAND, 0);
0919 
0920 Fixup:
0921     pci_fixup_device(pci_fixup_suspend_late, pci_dev);
0922 
0923     /*
0924      * If the target system sleep state is suspend-to-idle, it is sufficient
0925      * to check whether or not the device's wakeup settings are good for
0926      * runtime PM.  Otherwise, the pm_resume_via_firmware() check will cause
0927      * pci_pm_complete() to take care of fixing up the device's state
0928      * anyway, if need be.
0929      */
0930     if (device_can_wakeup(dev) && !device_may_wakeup(dev))
0931         dev->power.may_skip_resume = false;
0932 
0933     return 0;
0934 }
0935 
0936 static int pci_pm_resume_noirq(struct device *dev)
0937 {
0938     struct pci_dev *pci_dev = to_pci_dev(dev);
0939     const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
0940     pci_power_t prev_state = pci_dev->current_state;
0941     bool skip_bus_pm = pci_dev->skip_bus_pm;
0942 
0943     if (dev_pm_skip_resume(dev))
0944         return 0;
0945 
0946     /*
0947      * In the suspend-to-idle case, devices left in D0 during suspend will
0948      * stay in D0, so it is not necessary to restore or update their
0949      * configuration here and attempting to put them into D0 again is
0950      * pointless, so avoid doing that.
0951      */
0952     if (!(skip_bus_pm && pm_suspend_no_platform()))
0953         pci_pm_default_resume_early(pci_dev);
0954 
0955     pci_fixup_device(pci_fixup_resume_early, pci_dev);
0956     pcie_pme_root_status_cleanup(pci_dev);
0957 
0958     if (!skip_bus_pm && prev_state == PCI_D3cold)
0959         pci_pm_bridge_power_up_actions(pci_dev);
0960 
0961     if (pci_has_legacy_pm_support(pci_dev))
0962         return 0;
0963 
0964     if (pm && pm->resume_noirq)
0965         return pm->resume_noirq(dev);
0966 
0967     return 0;
0968 }
0969 
0970 static int pci_pm_resume_early(struct device *dev)
0971 {
0972     if (dev_pm_skip_resume(dev))
0973         return 0;
0974 
0975     return pm_generic_resume_early(dev);
0976 }
0977 
0978 static int pci_pm_resume(struct device *dev)
0979 {
0980     struct pci_dev *pci_dev = to_pci_dev(dev);
0981     const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
0982 
0983     /*
0984      * This is necessary for the suspend error path in which resume is
0985      * called without restoring the standard config registers of the device.
0986      */
0987     if (pci_dev->state_saved)
0988         pci_restore_standard_config(pci_dev);
0989 
0990     if (pci_has_legacy_pm_support(pci_dev))
0991         return pci_legacy_resume(dev);
0992 
0993     pci_pm_default_resume(pci_dev);
0994 
0995     if (pm) {
0996         if (pm->resume)
0997             return pm->resume(dev);
0998     } else {
0999         pci_pm_reenable_device(pci_dev);
1000     }
1001 
1002     return 0;
1003 }
1004 
1005 #else /* !CONFIG_SUSPEND */
1006 
1007 #define pci_pm_suspend      NULL
1008 #define pci_pm_suspend_late NULL
1009 #define pci_pm_suspend_noirq    NULL
1010 #define pci_pm_resume       NULL
1011 #define pci_pm_resume_early NULL
1012 #define pci_pm_resume_noirq NULL
1013 
1014 #endif /* !CONFIG_SUSPEND */
1015 
1016 #ifdef CONFIG_HIBERNATE_CALLBACKS
1017 
1018 static int pci_pm_freeze(struct device *dev)
1019 {
1020     struct pci_dev *pci_dev = to_pci_dev(dev);
1021     const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1022 
1023     if (pci_has_legacy_pm_support(pci_dev))
1024         return pci_legacy_suspend(dev, PMSG_FREEZE);
1025 
1026     if (!pm) {
1027         pci_pm_default_suspend(pci_dev);
1028         return 0;
1029     }
1030 
1031     /*
1032      * Resume all runtime-suspended devices before creating a snapshot
1033      * image of system memory, because the restore kernel generally cannot
1034      * be expected to always handle them consistently and they need to be
1035      * put into the runtime-active metastate during system resume anyway,
1036      * so it is better to ensure that the state saved in the image will be
1037      * always consistent with that.
1038      */
1039     pm_runtime_resume(dev);
1040     pci_dev->state_saved = false;
1041 
1042     if (pm->freeze) {
1043         int error;
1044 
1045         error = pm->freeze(dev);
1046         suspend_report_result(dev, pm->freeze, error);
1047         if (error)
1048             return error;
1049     }
1050 
1051     return 0;
1052 }
1053 
1054 static int pci_pm_freeze_noirq(struct device *dev)
1055 {
1056     struct pci_dev *pci_dev = to_pci_dev(dev);
1057     const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1058 
1059     if (pci_has_legacy_pm_support(pci_dev))
1060         return pci_legacy_suspend_late(dev, PMSG_FREEZE);
1061 
1062     if (pm && pm->freeze_noirq) {
1063         int error;
1064 
1065         error = pm->freeze_noirq(dev);
1066         suspend_report_result(dev, pm->freeze_noirq, error);
1067         if (error)
1068             return error;
1069     }
1070 
1071     if (!pci_dev->state_saved)
1072         pci_save_state(pci_dev);
1073 
1074     pci_pm_set_unknown_state(pci_dev);
1075 
1076     return 0;
1077 }
1078 
1079 static int pci_pm_thaw_noirq(struct device *dev)
1080 {
1081     struct pci_dev *pci_dev = to_pci_dev(dev);
1082     const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1083 
1084     /*
1085      * The pm->thaw_noirq() callback assumes the device has been
1086      * returned to D0 and its config state has been restored.
1087      *
1088      * In addition, pci_restore_state() restores MSI-X state in MMIO
1089      * space, which requires the device to be in D0, so return it to D0
1090      * in case the driver's "freeze" callbacks put it into a low-power
1091      * state.
1092      */
1093     pci_pm_power_up_and_verify_state(pci_dev);
1094     pci_restore_state(pci_dev);
1095 
1096     if (pci_has_legacy_pm_support(pci_dev))
1097         return 0;
1098 
1099     if (pm && pm->thaw_noirq)
1100         return pm->thaw_noirq(dev);
1101 
1102     return 0;
1103 }
1104 
1105 static int pci_pm_thaw(struct device *dev)
1106 {
1107     struct pci_dev *pci_dev = to_pci_dev(dev);
1108     const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1109     int error = 0;
1110 
1111     if (pci_has_legacy_pm_support(pci_dev))
1112         return pci_legacy_resume(dev);
1113 
1114     if (pm) {
1115         if (pm->thaw)
1116             error = pm->thaw(dev);
1117     } else {
1118         pci_pm_reenable_device(pci_dev);
1119     }
1120 
1121     pci_dev->state_saved = false;
1122 
1123     return error;
1124 }
1125 
1126 static int pci_pm_poweroff(struct device *dev)
1127 {
1128     struct pci_dev *pci_dev = to_pci_dev(dev);
1129     const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1130 
1131     if (pci_has_legacy_pm_support(pci_dev))
1132         return pci_legacy_suspend(dev, PMSG_HIBERNATE);
1133 
1134     if (!pm) {
1135         pci_pm_default_suspend(pci_dev);
1136         return 0;
1137     }
1138 
1139     /* The reason to do that is the same as in pci_pm_suspend(). */
1140     if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
1141         pci_dev_need_resume(pci_dev)) {
1142         pm_runtime_resume(dev);
1143         pci_dev->state_saved = false;
1144     } else {
1145         pci_dev_adjust_pme(pci_dev);
1146     }
1147 
1148     if (pm->poweroff) {
1149         int error;
1150 
1151         error = pm->poweroff(dev);
1152         suspend_report_result(dev, pm->poweroff, error);
1153         if (error)
1154             return error;
1155     }
1156 
1157     return 0;
1158 }
1159 
1160 static int pci_pm_poweroff_late(struct device *dev)
1161 {
1162     if (dev_pm_skip_suspend(dev))
1163         return 0;
1164 
1165     pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));
1166 
1167     return pm_generic_poweroff_late(dev);
1168 }
1169 
1170 static int pci_pm_poweroff_noirq(struct device *dev)
1171 {
1172     struct pci_dev *pci_dev = to_pci_dev(dev);
1173     const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1174 
1175     if (dev_pm_skip_suspend(dev))
1176         return 0;
1177 
1178     if (pci_has_legacy_pm_support(pci_dev))
1179         return pci_legacy_suspend_late(dev, PMSG_HIBERNATE);
1180 
1181     if (!pm) {
1182         pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1183         return 0;
1184     }
1185 
1186     if (pm->poweroff_noirq) {
1187         int error;
1188 
1189         error = pm->poweroff_noirq(dev);
1190         suspend_report_result(dev, pm->poweroff_noirq, error);
1191         if (error)
1192             return error;
1193     }
1194 
1195     if (!pci_dev->state_saved && !pci_has_subordinate(pci_dev))
1196         pci_prepare_to_sleep(pci_dev);
1197 
1198     /*
1199      * The reason for doing this here is the same as for the analogous code
1200      * in pci_pm_suspend_noirq().
1201      */
1202     if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
1203         pci_write_config_word(pci_dev, PCI_COMMAND, 0);
1204 
1205     pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1206 
1207     return 0;
1208 }
1209 
1210 static int pci_pm_restore_noirq(struct device *dev)
1211 {
1212     struct pci_dev *pci_dev = to_pci_dev(dev);
1213     const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1214 
1215     pci_pm_default_resume_early(pci_dev);
1216     pci_fixup_device(pci_fixup_resume_early, pci_dev);
1217 
1218     if (pci_has_legacy_pm_support(pci_dev))
1219         return 0;
1220 
1221     if (pm && pm->restore_noirq)
1222         return pm->restore_noirq(dev);
1223 
1224     return 0;
1225 }
1226 
1227 static int pci_pm_restore(struct device *dev)
1228 {
1229     struct pci_dev *pci_dev = to_pci_dev(dev);
1230     const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1231 
1232     /*
1233      * This is necessary for the hibernation error path in which restore is
1234      * called without restoring the standard config registers of the device.
1235      */
1236     if (pci_dev->state_saved)
1237         pci_restore_standard_config(pci_dev);
1238 
1239     if (pci_has_legacy_pm_support(pci_dev))
1240         return pci_legacy_resume(dev);
1241 
1242     pci_pm_default_resume(pci_dev);
1243 
1244     if (pm) {
1245         if (pm->restore)
1246             return pm->restore(dev);
1247     } else {
1248         pci_pm_reenable_device(pci_dev);
1249     }
1250 
1251     return 0;
1252 }
1253 
1254 #else /* !CONFIG_HIBERNATE_CALLBACKS */
1255 
1256 #define pci_pm_freeze       NULL
1257 #define pci_pm_freeze_noirq NULL
1258 #define pci_pm_thaw     NULL
1259 #define pci_pm_thaw_noirq   NULL
1260 #define pci_pm_poweroff     NULL
1261 #define pci_pm_poweroff_late    NULL
1262 #define pci_pm_poweroff_noirq   NULL
1263 #define pci_pm_restore      NULL
1264 #define pci_pm_restore_noirq    NULL
1265 
1266 #endif /* !CONFIG_HIBERNATE_CALLBACKS */
1267 
1268 #ifdef CONFIG_PM
1269 
1270 static int pci_pm_runtime_suspend(struct device *dev)
1271 {
1272     struct pci_dev *pci_dev = to_pci_dev(dev);
1273     const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1274     pci_power_t prev = pci_dev->current_state;
1275     int error;
1276 
1277     /*
1278      * If pci_dev->driver is not set (unbound), we leave the device in D0,
1279      * but it may go to D3cold when the bridge above it runtime suspends.
1280      * Save its config space in case that happens.
1281      */
1282     if (!pci_dev->driver) {
1283         pci_save_state(pci_dev);
1284         return 0;
1285     }
1286 
1287     pci_dev->state_saved = false;
1288     if (pm && pm->runtime_suspend) {
1289         error = pm->runtime_suspend(dev);
1290         /*
1291          * -EBUSY and -EAGAIN is used to request the runtime PM core
1292          * to schedule a new suspend, so log the event only with debug
1293          * log level.
1294          */
1295         if (error == -EBUSY || error == -EAGAIN) {
1296             pci_dbg(pci_dev, "can't suspend now (%ps returned %d)\n",
1297                 pm->runtime_suspend, error);
1298             return error;
1299         } else if (error) {
1300             pci_err(pci_dev, "can't suspend (%ps returned %d)\n",
1301                 pm->runtime_suspend, error);
1302             return error;
1303         }
1304     }
1305 
1306     pci_fixup_device(pci_fixup_suspend, pci_dev);
1307 
1308     if (pm && pm->runtime_suspend
1309         && !pci_dev->state_saved && pci_dev->current_state != PCI_D0
1310         && pci_dev->current_state != PCI_UNKNOWN) {
1311         pci_WARN_ONCE(pci_dev, pci_dev->current_state != prev,
1312                   "PCI PM: State of device not saved by %pS\n",
1313                   pm->runtime_suspend);
1314         return 0;
1315     }
1316 
1317     if (!pci_dev->state_saved) {
1318         pci_save_state(pci_dev);
1319         pci_finish_runtime_suspend(pci_dev);
1320     }
1321 
1322     return 0;
1323 }
1324 
1325 static int pci_pm_runtime_resume(struct device *dev)
1326 {
1327     struct pci_dev *pci_dev = to_pci_dev(dev);
1328     const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1329     pci_power_t prev_state = pci_dev->current_state;
1330     int error = 0;
1331 
1332     /*
1333      * Restoring config space is necessary even if the device is not bound
1334      * to a driver because although we left it in D0, it may have gone to
1335      * D3cold when the bridge above it runtime suspended.
1336      */
1337     pci_pm_default_resume_early(pci_dev);
1338 
1339     if (!pci_dev->driver)
1340         return 0;
1341 
1342     pci_fixup_device(pci_fixup_resume_early, pci_dev);
1343     pci_pm_default_resume(pci_dev);
1344 
1345     if (prev_state == PCI_D3cold)
1346         pci_pm_bridge_power_up_actions(pci_dev);
1347 
1348     if (pm && pm->runtime_resume)
1349         error = pm->runtime_resume(dev);
1350 
1351     return error;
1352 }
1353 
1354 static int pci_pm_runtime_idle(struct device *dev)
1355 {
1356     struct pci_dev *pci_dev = to_pci_dev(dev);
1357     const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1358 
1359     /*
1360      * If pci_dev->driver is not set (unbound), the device should
1361      * always remain in D0 regardless of the runtime PM status
1362      */
1363     if (!pci_dev->driver)
1364         return 0;
1365 
1366     if (!pm)
1367         return -ENOSYS;
1368 
1369     if (pm->runtime_idle)
1370         return pm->runtime_idle(dev);
1371 
1372     return 0;
1373 }
1374 
1375 static const struct dev_pm_ops pci_dev_pm_ops = {
1376     .prepare = pci_pm_prepare,
1377     .complete = pci_pm_complete,
1378     .suspend = pci_pm_suspend,
1379     .suspend_late = pci_pm_suspend_late,
1380     .resume = pci_pm_resume,
1381     .resume_early = pci_pm_resume_early,
1382     .freeze = pci_pm_freeze,
1383     .thaw = pci_pm_thaw,
1384     .poweroff = pci_pm_poweroff,
1385     .poweroff_late = pci_pm_poweroff_late,
1386     .restore = pci_pm_restore,
1387     .suspend_noirq = pci_pm_suspend_noirq,
1388     .resume_noirq = pci_pm_resume_noirq,
1389     .freeze_noirq = pci_pm_freeze_noirq,
1390     .thaw_noirq = pci_pm_thaw_noirq,
1391     .poweroff_noirq = pci_pm_poweroff_noirq,
1392     .restore_noirq = pci_pm_restore_noirq,
1393     .runtime_suspend = pci_pm_runtime_suspend,
1394     .runtime_resume = pci_pm_runtime_resume,
1395     .runtime_idle = pci_pm_runtime_idle,
1396 };
1397 
1398 #define PCI_PM_OPS_PTR  (&pci_dev_pm_ops)
1399 
1400 #else /* !CONFIG_PM */
1401 
1402 #define pci_pm_runtime_suspend  NULL
1403 #define pci_pm_runtime_resume   NULL
1404 #define pci_pm_runtime_idle NULL
1405 
1406 #define PCI_PM_OPS_PTR  NULL
1407 
1408 #endif /* !CONFIG_PM */
1409 
1410 /**
1411  * __pci_register_driver - register a new pci driver
1412  * @drv: the driver structure to register
1413  * @owner: owner module of drv
1414  * @mod_name: module name string
1415  *
1416  * Adds the driver structure to the list of registered drivers.
1417  * Returns a negative value on error, otherwise 0.
1418  * If no error occurred, the driver remains registered even if
1419  * no device was claimed during registration.
1420  */
1421 int __pci_register_driver(struct pci_driver *drv, struct module *owner,
1422               const char *mod_name)
1423 {
1424     /* initialize common driver fields */
1425     drv->driver.name = drv->name;
1426     drv->driver.bus = &pci_bus_type;
1427     drv->driver.owner = owner;
1428     drv->driver.mod_name = mod_name;
1429     drv->driver.groups = drv->groups;
1430     drv->driver.dev_groups = drv->dev_groups;
1431 
1432     spin_lock_init(&drv->dynids.lock);
1433     INIT_LIST_HEAD(&drv->dynids.list);
1434 
1435     /* register with core */
1436     return driver_register(&drv->driver);
1437 }
1438 EXPORT_SYMBOL(__pci_register_driver);
1439 
1440 /**
1441  * pci_unregister_driver - unregister a pci driver
1442  * @drv: the driver structure to unregister
1443  *
1444  * Deletes the driver structure from the list of registered PCI drivers,
1445  * gives it a chance to clean up by calling its remove() function for
1446  * each device it was responsible for, and marks those devices as
1447  * driverless.
1448  */
1449 
1450 void pci_unregister_driver(struct pci_driver *drv)
1451 {
1452     driver_unregister(&drv->driver);
1453     pci_free_dynids(drv);
1454 }
1455 EXPORT_SYMBOL(pci_unregister_driver);
1456 
1457 static struct pci_driver pci_compat_driver = {
1458     .name = "compat"
1459 };
1460 
1461 /**
1462  * pci_dev_driver - get the pci_driver of a device
1463  * @dev: the device to query
1464  *
1465  * Returns the appropriate pci_driver structure or %NULL if there is no
1466  * registered driver for the device.
1467  */
1468 struct pci_driver *pci_dev_driver(const struct pci_dev *dev)
1469 {
1470     if (dev->driver)
1471         return dev->driver;
1472     else {
1473         int i;
1474         for (i = 0; i <= PCI_ROM_RESOURCE; i++)
1475             if (dev->resource[i].flags & IORESOURCE_BUSY)
1476                 return &pci_compat_driver;
1477     }
1478     return NULL;
1479 }
1480 EXPORT_SYMBOL(pci_dev_driver);
1481 
1482 /**
1483  * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
1484  * @dev: the PCI device structure to match against
1485  * @drv: the device driver to search for matching PCI device id structures
1486  *
1487  * Used by a driver to check whether a PCI device present in the
1488  * system is in its list of supported devices. Returns the matching
1489  * pci_device_id structure or %NULL if there is no match.
1490  */
1491 static int pci_bus_match(struct device *dev, struct device_driver *drv)
1492 {
1493     struct pci_dev *pci_dev = to_pci_dev(dev);
1494     struct pci_driver *pci_drv;
1495     const struct pci_device_id *found_id;
1496 
1497     if (!pci_dev->match_driver)
1498         return 0;
1499 
1500     pci_drv = to_pci_driver(drv);
1501     found_id = pci_match_device(pci_drv, pci_dev);
1502     if (found_id)
1503         return 1;
1504 
1505     return 0;
1506 }
1507 
1508 /**
1509  * pci_dev_get - increments the reference count of the pci device structure
1510  * @dev: the device being referenced
1511  *
1512  * Each live reference to a device should be refcounted.
1513  *
1514  * Drivers for PCI devices should normally record such references in
1515  * their probe() methods, when they bind to a device, and release
1516  * them by calling pci_dev_put(), in their disconnect() methods.
1517  *
1518  * A pointer to the device with the incremented reference counter is returned.
1519  */
1520 struct pci_dev *pci_dev_get(struct pci_dev *dev)
1521 {
1522     if (dev)
1523         get_device(&dev->dev);
1524     return dev;
1525 }
1526 EXPORT_SYMBOL(pci_dev_get);
1527 
1528 /**
1529  * pci_dev_put - release a use of the pci device structure
1530  * @dev: device that's been disconnected
1531  *
1532  * Must be called when a user of a device is finished with it.  When the last
1533  * user of the device calls this function, the memory of the device is freed.
1534  */
1535 void pci_dev_put(struct pci_dev *dev)
1536 {
1537     if (dev)
1538         put_device(&dev->dev);
1539 }
1540 EXPORT_SYMBOL(pci_dev_put);
1541 
1542 static int pci_uevent(struct device *dev, struct kobj_uevent_env *env)
1543 {
1544     struct pci_dev *pdev;
1545 
1546     if (!dev)
1547         return -ENODEV;
1548 
1549     pdev = to_pci_dev(dev);
1550 
1551     if (add_uevent_var(env, "PCI_CLASS=%04X", pdev->class))
1552         return -ENOMEM;
1553 
1554     if (add_uevent_var(env, "PCI_ID=%04X:%04X", pdev->vendor, pdev->device))
1555         return -ENOMEM;
1556 
1557     if (add_uevent_var(env, "PCI_SUBSYS_ID=%04X:%04X", pdev->subsystem_vendor,
1558                pdev->subsystem_device))
1559         return -ENOMEM;
1560 
1561     if (add_uevent_var(env, "PCI_SLOT_NAME=%s", pci_name(pdev)))
1562         return -ENOMEM;
1563 
1564     if (add_uevent_var(env, "MODALIAS=pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X",
1565                pdev->vendor, pdev->device,
1566                pdev->subsystem_vendor, pdev->subsystem_device,
1567                (u8)(pdev->class >> 16), (u8)(pdev->class >> 8),
1568                (u8)(pdev->class)))
1569         return -ENOMEM;
1570 
1571     return 0;
1572 }
1573 
1574 #if defined(CONFIG_PCIEAER) || defined(CONFIG_EEH)
1575 /**
1576  * pci_uevent_ers - emit a uevent during recovery path of PCI device
1577  * @pdev: PCI device undergoing error recovery
1578  * @err_type: type of error event
1579  */
1580 void pci_uevent_ers(struct pci_dev *pdev, enum pci_ers_result err_type)
1581 {
1582     int idx = 0;
1583     char *envp[3];
1584 
1585     switch (err_type) {
1586     case PCI_ERS_RESULT_NONE:
1587     case PCI_ERS_RESULT_CAN_RECOVER:
1588         envp[idx++] = "ERROR_EVENT=BEGIN_RECOVERY";
1589         envp[idx++] = "DEVICE_ONLINE=0";
1590         break;
1591     case PCI_ERS_RESULT_RECOVERED:
1592         envp[idx++] = "ERROR_EVENT=SUCCESSFUL_RECOVERY";
1593         envp[idx++] = "DEVICE_ONLINE=1";
1594         break;
1595     case PCI_ERS_RESULT_DISCONNECT:
1596         envp[idx++] = "ERROR_EVENT=FAILED_RECOVERY";
1597         envp[idx++] = "DEVICE_ONLINE=0";
1598         break;
1599     default:
1600         break;
1601     }
1602 
1603     if (idx > 0) {
1604         envp[idx++] = NULL;
1605         kobject_uevent_env(&pdev->dev.kobj, KOBJ_CHANGE, envp);
1606     }
1607 }
1608 #endif
1609 
1610 static int pci_bus_num_vf(struct device *dev)
1611 {
1612     return pci_num_vf(to_pci_dev(dev));
1613 }
1614 
1615 /**
1616  * pci_dma_configure - Setup DMA configuration
1617  * @dev: ptr to dev structure
1618  *
1619  * Function to update PCI devices's DMA configuration using the same
1620  * info from the OF node or ACPI node of host bridge's parent (if any).
1621  */
1622 static int pci_dma_configure(struct device *dev)
1623 {
1624     struct pci_driver *driver = to_pci_driver(dev->driver);
1625     struct device *bridge;
1626     int ret = 0;
1627 
1628     bridge = pci_get_host_bridge_device(to_pci_dev(dev));
1629 
1630     if (IS_ENABLED(CONFIG_OF) && bridge->parent &&
1631         bridge->parent->of_node) {
1632         ret = of_dma_configure(dev, bridge->parent->of_node, true);
1633     } else if (has_acpi_companion(bridge)) {
1634         struct acpi_device *adev = to_acpi_device_node(bridge->fwnode);
1635 
1636         ret = acpi_dma_configure(dev, acpi_get_dma_attr(adev));
1637     }
1638 
1639     pci_put_host_bridge_device(bridge);
1640 
1641     if (!ret && !driver->driver_managed_dma) {
1642         ret = iommu_device_use_default_domain(dev);
1643         if (ret)
1644             arch_teardown_dma_ops(dev);
1645     }
1646 
1647     return ret;
1648 }
1649 
1650 static void pci_dma_cleanup(struct device *dev)
1651 {
1652     struct pci_driver *driver = to_pci_driver(dev->driver);
1653 
1654     if (!driver->driver_managed_dma)
1655         iommu_device_unuse_default_domain(dev);
1656 }
1657 
1658 struct bus_type pci_bus_type = {
1659     .name       = "pci",
1660     .match      = pci_bus_match,
1661     .uevent     = pci_uevent,
1662     .probe      = pci_device_probe,
1663     .remove     = pci_device_remove,
1664     .shutdown   = pci_device_shutdown,
1665     .dev_groups = pci_dev_groups,
1666     .bus_groups = pci_bus_groups,
1667     .drv_groups = pci_drv_groups,
1668     .pm     = PCI_PM_OPS_PTR,
1669     .num_vf     = pci_bus_num_vf,
1670     .dma_configure  = pci_dma_configure,
1671     .dma_cleanup    = pci_dma_cleanup,
1672 };
1673 EXPORT_SYMBOL(pci_bus_type);
1674 
1675 #ifdef CONFIG_PCIEPORTBUS
1676 static int pcie_port_bus_match(struct device *dev, struct device_driver *drv)
1677 {
1678     struct pcie_device *pciedev;
1679     struct pcie_port_service_driver *driver;
1680 
1681     if (drv->bus != &pcie_port_bus_type || dev->bus != &pcie_port_bus_type)
1682         return 0;
1683 
1684     pciedev = to_pcie_device(dev);
1685     driver = to_service_driver(drv);
1686 
1687     if (driver->service != pciedev->service)
1688         return 0;
1689 
1690     if (driver->port_type != PCIE_ANY_PORT &&
1691         driver->port_type != pci_pcie_type(pciedev->port))
1692         return 0;
1693 
1694     return 1;
1695 }
1696 
1697 struct bus_type pcie_port_bus_type = {
1698     .name       = "pci_express",
1699     .match      = pcie_port_bus_match,
1700 };
1701 EXPORT_SYMBOL_GPL(pcie_port_bus_type);
1702 #endif
1703 
1704 static int __init pci_driver_init(void)
1705 {
1706     int ret;
1707 
1708     ret = bus_register(&pci_bus_type);
1709     if (ret)
1710         return ret;
1711 
1712 #ifdef CONFIG_PCIEPORTBUS
1713     ret = bus_register(&pcie_port_bus_type);
1714     if (ret)
1715         return ret;
1716 #endif
1717     dma_debug_add_bus(&pci_bus_type);
1718     return 0;
1719 }
1720 postcore_initcall(pci_driver_init);
[ Source navigation ] [ Diff markup ] [ Identifier search ] [ general search ]

This page was automatically generated by the 2.1.0 LXR engine.

The LXR team
Valid CSS 2.1! Valid HTML 4.01!