]> git.kernelconcepts.de Git - karo-tx-linux.git/blob - drivers/pci/pci-driver.c
2865ba37e2954c90ba9f796b8284c86d74f08c6a
[karo-tx-linux.git] / drivers / pci / pci-driver.c
1 /*
2  * drivers/pci/pci-driver.c
3  *
4  * (C) Copyright 2002-2004, 2007 Greg Kroah-Hartman <greg@kroah.com>
5  * (C) Copyright 2007 Novell Inc.
6  *
7  * Released under the GPL v2 only.
8  *
9  */
10
11 #include <linux/pci.h>
12 #include <linux/module.h>
13 #include <linux/init.h>
14 #include <linux/device.h>
15 #include <linux/mempolicy.h>
16 #include <linux/string.h>
17 #include <linux/slab.h>
18 #include <linux/sched.h>
19 #include <linux/cpu.h>
20 #include <linux/pm_runtime.h>
21 #include <linux/suspend.h>
22 #include <linux/kexec.h>
23 #include "pci.h"
24
25 struct pci_dynid {
26         struct list_head node;
27         struct pci_device_id id;
28 };
29
30 /**
31  * pci_add_dynid - add a new PCI device ID to this driver and re-probe devices
32  * @drv: target pci driver
33  * @vendor: PCI vendor ID
34  * @device: PCI device ID
35  * @subvendor: PCI subvendor ID
36  * @subdevice: PCI subdevice ID
37  * @class: PCI class
38  * @class_mask: PCI class mask
39  * @driver_data: private driver data
40  *
41  * Adds a new dynamic pci device ID to this driver and causes the
42  * driver to probe for all devices again.  @drv must have been
43  * registered prior to calling this function.
44  *
45  * CONTEXT:
46  * Does GFP_KERNEL allocation.
47  *
48  * RETURNS:
49  * 0 on success, -errno on failure.
50  */
51 int pci_add_dynid(struct pci_driver *drv,
52                   unsigned int vendor, unsigned int device,
53                   unsigned int subvendor, unsigned int subdevice,
54                   unsigned int class, unsigned int class_mask,
55                   unsigned long driver_data)
56 {
57         struct pci_dynid *dynid;
58
59         dynid = kzalloc(sizeof(*dynid), GFP_KERNEL);
60         if (!dynid)
61                 return -ENOMEM;
62
63         dynid->id.vendor = vendor;
64         dynid->id.device = device;
65         dynid->id.subvendor = subvendor;
66         dynid->id.subdevice = subdevice;
67         dynid->id.class = class;
68         dynid->id.class_mask = class_mask;
69         dynid->id.driver_data = driver_data;
70
71         spin_lock(&drv->dynids.lock);
72         list_add_tail(&dynid->node, &drv->dynids.list);
73         spin_unlock(&drv->dynids.lock);
74
75         return driver_attach(&drv->driver);
76 }
77 EXPORT_SYMBOL_GPL(pci_add_dynid);
78
79 static void pci_free_dynids(struct pci_driver *drv)
80 {
81         struct pci_dynid *dynid, *n;
82
83         spin_lock(&drv->dynids.lock);
84         list_for_each_entry_safe(dynid, n, &drv->dynids.list, node) {
85                 list_del(&dynid->node);
86                 kfree(dynid);
87         }
88         spin_unlock(&drv->dynids.lock);
89 }
90
91 /**
92  * store_new_id - sysfs frontend to pci_add_dynid()
93  * @driver: target device driver
94  * @buf: buffer for scanning device ID data
95  * @count: input size
96  *
97  * Allow PCI IDs to be added to an existing driver via sysfs.
98  */
99 static ssize_t store_new_id(struct device_driver *driver, const char *buf,
100                             size_t count)
101 {
102         struct pci_driver *pdrv = to_pci_driver(driver);
103         const struct pci_device_id *ids = pdrv->id_table;
104         __u32 vendor, device, subvendor = PCI_ANY_ID,
105                 subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
106         unsigned long driver_data = 0;
107         int fields = 0;
108         int retval = 0;
109
110         fields = sscanf(buf, "%x %x %x %x %x %x %lx",
111                         &vendor, &device, &subvendor, &subdevice,
112                         &class, &class_mask, &driver_data);
113         if (fields < 2)
114                 return -EINVAL;
115
116         if (fields != 7) {
117                 struct pci_dev *pdev = kzalloc(sizeof(*pdev), GFP_KERNEL);
118                 if (!pdev)
119                         return -ENOMEM;
120
121                 pdev->vendor = vendor;
122                 pdev->device = device;
123                 pdev->subsystem_vendor = subvendor;
124                 pdev->subsystem_device = subdevice;
125                 pdev->class = class;
126
127                 if (pci_match_id(pdrv->id_table, pdev))
128                         retval = -EEXIST;
129
130                 kfree(pdev);
131
132                 if (retval)
133                         return retval;
134         }
135
136         /* Only accept driver_data values that match an existing id_table
137            entry */
138         if (ids) {
139                 retval = -EINVAL;
140                 while (ids->vendor || ids->subvendor || ids->class_mask) {
141                         if (driver_data == ids->driver_data) {
142                                 retval = 0;
143                                 break;
144                         }
145                         ids++;
146                 }
147                 if (retval)     /* No match */
148                         return retval;
149         }
150
151         retval = pci_add_dynid(pdrv, vendor, device, subvendor, subdevice,
152                                class, class_mask, driver_data);
153         if (retval)
154                 return retval;
155         return count;
156 }
157 static DRIVER_ATTR(new_id, S_IWUSR, NULL, store_new_id);
158
159 /**
160  * store_remove_id - remove a PCI device ID from this driver
161  * @driver: target device driver
162  * @buf: buffer for scanning device ID data
163  * @count: input size
164  *
165  * Removes a dynamic pci device ID to this driver.
166  */
167 static ssize_t store_remove_id(struct device_driver *driver, const char *buf,
168                                size_t count)
169 {
170         struct pci_dynid *dynid, *n;
171         struct pci_driver *pdrv = to_pci_driver(driver);
172         __u32 vendor, device, subvendor = PCI_ANY_ID,
173                 subdevice = PCI_ANY_ID, class = 0, class_mask = 0;
174         int fields = 0;
175         size_t retval = -ENODEV;
176
177         fields = sscanf(buf, "%x %x %x %x %x %x",
178                         &vendor, &device, &subvendor, &subdevice,
179                         &class, &class_mask);
180         if (fields < 2)
181                 return -EINVAL;
182
183         spin_lock(&pdrv->dynids.lock);
184         list_for_each_entry_safe(dynid, n, &pdrv->dynids.list, node) {
185                 struct pci_device_id *id = &dynid->id;
186                 if ((id->vendor == vendor) &&
187                     (id->device == device) &&
188                     (subvendor == PCI_ANY_ID || id->subvendor == subvendor) &&
189                     (subdevice == PCI_ANY_ID || id->subdevice == subdevice) &&
190                     !((id->class ^ class) & class_mask)) {
191                         list_del(&dynid->node);
192                         kfree(dynid);
193                         retval = count;
194                         break;
195                 }
196         }
197         spin_unlock(&pdrv->dynids.lock);
198
199         return retval;
200 }
201 static DRIVER_ATTR(remove_id, S_IWUSR, NULL, store_remove_id);
202
203 static struct attribute *pci_drv_attrs[] = {
204         &driver_attr_new_id.attr,
205         &driver_attr_remove_id.attr,
206         NULL,
207 };
208 ATTRIBUTE_GROUPS(pci_drv);
209
210 /**
211  * pci_match_id - See if a pci device matches a given pci_id table
212  * @ids: array of PCI device id structures to search in
213  * @dev: the PCI device structure to match against.
214  *
215  * Used by a driver to check whether a PCI device present in the
216  * system is in its list of supported devices.  Returns the matching
217  * pci_device_id structure or %NULL if there is no match.
218  *
219  * Deprecated, don't use this as it will not catch any dynamic ids
220  * that a driver might want to check for.
221  */
222 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
223                                          struct pci_dev *dev)
224 {
225         if (ids) {
226                 while (ids->vendor || ids->subvendor || ids->class_mask) {
227                         if (pci_match_one_device(ids, dev))
228                                 return ids;
229                         ids++;
230                 }
231         }
232         return NULL;
233 }
234 EXPORT_SYMBOL(pci_match_id);
235
236 static const struct pci_device_id pci_device_id_any = {
237         .vendor = PCI_ANY_ID,
238         .device = PCI_ANY_ID,
239         .subvendor = PCI_ANY_ID,
240         .subdevice = PCI_ANY_ID,
241 };
242
243 /**
244  * pci_match_device - Tell if a PCI device structure has a matching PCI device id structure
245  * @drv: the PCI driver to match against
246  * @dev: the PCI device structure to match against
247  *
248  * Used by a driver to check whether a PCI device present in the
249  * system is in its list of supported devices.  Returns the matching
250  * pci_device_id structure or %NULL if there is no match.
251  */
252 static const struct pci_device_id *pci_match_device(struct pci_driver *drv,
253                                                     struct pci_dev *dev)
254 {
255         struct pci_dynid *dynid;
256         const struct pci_device_id *found_id = NULL;
257
258         /* When driver_override is set, only bind to the matching driver */
259         if (dev->driver_override && strcmp(dev->driver_override, drv->name))
260                 return NULL;
261
262         /* Look at the dynamic ids first, before the static ones */
263         spin_lock(&drv->dynids.lock);
264         list_for_each_entry(dynid, &drv->dynids.list, node) {
265                 if (pci_match_one_device(&dynid->id, dev)) {
266                         found_id = &dynid->id;
267                         break;
268                 }
269         }
270         spin_unlock(&drv->dynids.lock);
271
272         if (!found_id)
273                 found_id = pci_match_id(drv->id_table, dev);
274
275         /* driver_override will always match, send a dummy id */
276         if (!found_id && dev->driver_override)
277                 found_id = &pci_device_id_any;
278
279         return found_id;
280 }
281
282 struct drv_dev_and_id {
283         struct pci_driver *drv;
284         struct pci_dev *dev;
285         const struct pci_device_id *id;
286 };
287
288 static long local_pci_probe(void *_ddi)
289 {
290         struct drv_dev_and_id *ddi = _ddi;
291         struct pci_dev *pci_dev = ddi->dev;
292         struct pci_driver *pci_drv = ddi->drv;
293         struct device *dev = &pci_dev->dev;
294         int rc;
295
296         /*
297          * Unbound PCI devices are always put in D0, regardless of
298          * runtime PM status.  During probe, the device is set to
299          * active and the usage count is incremented.  If the driver
300          * supports runtime PM, it should call pm_runtime_put_noidle()
301          * in its probe routine and pm_runtime_get_noresume() in its
302          * remove routine.
303          */
304         pm_runtime_get_sync(dev);
305         pci_dev->driver = pci_drv;
306         rc = pci_drv->probe(pci_dev, ddi->id);
307         if (!rc)
308                 return rc;
309         if (rc < 0) {
310                 pci_dev->driver = NULL;
311                 pm_runtime_put_sync(dev);
312                 return rc;
313         }
314         /*
315          * Probe function should return < 0 for failure, 0 for success
316          * Treat values > 0 as success, but warn.
317          */
318         dev_warn(dev, "Driver probe function unexpectedly returned %d\n", rc);
319         return 0;
320 }
321
322 static int pci_call_probe(struct pci_driver *drv, struct pci_dev *dev,
323                           const struct pci_device_id *id)
324 {
325         int error, node;
326         struct drv_dev_and_id ddi = { drv, dev, id };
327
328         /*
329          * Execute driver initialization on node where the device is
330          * attached.  This way the driver likely allocates its local memory
331          * on the right node.
332          */
333         node = dev_to_node(&dev->dev);
334
335         /*
336          * On NUMA systems, we are likely to call a PF probe function using
337          * work_on_cpu().  If that probe calls pci_enable_sriov() (which
338          * adds the VF devices via pci_bus_add_device()), we may re-enter
339          * this function to call the VF probe function.  Calling
340          * work_on_cpu() again will cause a lockdep warning.  Since VFs are
341          * always on the same node as the PF, we can work around this by
342          * avoiding work_on_cpu() when we're already on the correct node.
343          *
344          * Preemption is enabled, so it's theoretically unsafe to use
345          * numa_node_id(), but even if we run the probe function on the
346          * wrong node, it should be functionally correct.
347          */
348         if (node >= 0 && node != numa_node_id()) {
349                 int cpu;
350
351                 get_online_cpus();
352                 cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
353                 if (cpu < nr_cpu_ids)
354                         error = work_on_cpu(cpu, local_pci_probe, &ddi);
355                 else
356                         error = local_pci_probe(&ddi);
357                 put_online_cpus();
358         } else
359                 error = local_pci_probe(&ddi);
360
361         return error;
362 }
363
364 /**
365  * __pci_device_probe - check if a driver wants to claim a specific PCI device
366  * @drv: driver to call to check if it wants the PCI device
367  * @pci_dev: PCI device being probed
368  *
369  * returns 0 on success, else error.
370  * side-effect: pci_dev->driver is set to drv when drv claims pci_dev.
371  */
372 static int __pci_device_probe(struct pci_driver *drv, struct pci_dev *pci_dev)
373 {
374         const struct pci_device_id *id;
375         int error = 0;
376
377         if (!pci_dev->driver && drv->probe) {
378                 error = -ENODEV;
379
380                 id = pci_match_device(drv, pci_dev);
381                 if (id)
382                         error = pci_call_probe(drv, pci_dev, id);
383                 if (error >= 0)
384                         error = 0;
385         }
386         return error;
387 }
388
389 int __weak pcibios_alloc_irq(struct pci_dev *dev)
390 {
391         return 0;
392 }
393
394 void __weak pcibios_free_irq(struct pci_dev *dev)
395 {
396 }
397
398 static int pci_device_probe(struct device *dev)
399 {
400         int error;
401         struct pci_dev *pci_dev = to_pci_dev(dev);
402         struct pci_driver *drv = to_pci_driver(dev->driver);
403
404         error = pcibios_alloc_irq(pci_dev);
405         if (error < 0)
406                 return error;
407
408         pci_dev_get(pci_dev);
409         error = __pci_device_probe(drv, pci_dev);
410         if (error) {
411                 pcibios_free_irq(pci_dev);
412                 pci_dev_put(pci_dev);
413         }
414
415         return error;
416 }
417
418 static int pci_device_remove(struct device *dev)
419 {
420         struct pci_dev *pci_dev = to_pci_dev(dev);
421         struct pci_driver *drv = pci_dev->driver;
422
423         if (drv) {
424                 if (drv->remove) {
425                         pm_runtime_get_sync(dev);
426                         drv->remove(pci_dev);
427                         pm_runtime_put_noidle(dev);
428                 }
429                 pcibios_free_irq(pci_dev);
430                 pci_dev->driver = NULL;
431         }
432
433         /* Undo the runtime PM settings in local_pci_probe() */
434         pm_runtime_put_sync(dev);
435
436         /*
437          * If the device is still on, set the power state as "unknown",
438          * since it might change by the next time we load the driver.
439          */
440         if (pci_dev->current_state == PCI_D0)
441                 pci_dev->current_state = PCI_UNKNOWN;
442
443         /*
444          * We would love to complain here if pci_dev->is_enabled is set, that
445          * the driver should have called pci_disable_device(), but the
446          * unfortunate fact is there are too many odd BIOS and bridge setups
447          * that don't like drivers doing that all of the time.
448          * Oh well, we can dream of sane hardware when we sleep, no matter how
449          * horrible the crap we have to deal with is when we are awake...
450          */
451
452         pci_dev_put(pci_dev);
453         return 0;
454 }
455
456 static void pci_device_shutdown(struct device *dev)
457 {
458         struct pci_dev *pci_dev = to_pci_dev(dev);
459         struct pci_driver *drv = pci_dev->driver;
460
461         pm_runtime_resume(dev);
462
463         if (drv && drv->shutdown)
464                 drv->shutdown(pci_dev);
465         pci_msi_shutdown(pci_dev);
466         pci_msix_shutdown(pci_dev);
467
468 #ifdef CONFIG_KEXEC_CORE
469         /*
470          * If this is a kexec reboot, turn off Bus Master bit on the
471          * device to tell it to not continue to do DMA. Don't touch
472          * devices in D3cold or unknown states.
473          * If it is not a kexec reboot, firmware will hit the PCI
474          * devices with big hammer and stop their DMA any way.
475          */
476         if (kexec_in_progress && (pci_dev->current_state <= PCI_D3hot))
477                 pci_clear_master(pci_dev);
478 #endif
479 }
480
481 #ifdef CONFIG_PM
482
483 /* Auxiliary functions used for system resume and run-time resume. */
484
485 /**
486  * pci_restore_standard_config - restore standard config registers of PCI device
487  * @pci_dev: PCI device to handle
488  */
489 static int pci_restore_standard_config(struct pci_dev *pci_dev)
490 {
491         pci_update_current_state(pci_dev, PCI_UNKNOWN);
492
493         if (pci_dev->current_state != PCI_D0) {
494                 int error = pci_set_power_state(pci_dev, PCI_D0);
495                 if (error)
496                         return error;
497         }
498
499         pci_restore_state(pci_dev);
500         return 0;
501 }
502
503 #endif
504
505 #ifdef CONFIG_PM_SLEEP
506
507 static void pci_pm_default_resume_early(struct pci_dev *pci_dev)
508 {
509         pci_power_up(pci_dev);
510         pci_restore_state(pci_dev);
511         pci_fixup_device(pci_fixup_resume_early, pci_dev);
512 }
513
514 /*
515  * Default "suspend" method for devices that have no driver provided suspend,
516  * or not even a driver at all (second part).
517  */
518 static void pci_pm_set_unknown_state(struct pci_dev *pci_dev)
519 {
520         /*
521          * mark its power state as "unknown", since we don't know if
522          * e.g. the BIOS will change its device state when we suspend.
523          */
524         if (pci_dev->current_state == PCI_D0)
525                 pci_dev->current_state = PCI_UNKNOWN;
526 }
527
528 /*
529  * Default "resume" method for devices that have no driver provided resume,
530  * or not even a driver at all (second part).
531  */
532 static int pci_pm_reenable_device(struct pci_dev *pci_dev)
533 {
534         int retval;
535
536         /* if the device was enabled before suspend, reenable */
537         retval = pci_reenable_device(pci_dev);
538         /*
539          * if the device was busmaster before the suspend, make it busmaster
540          * again
541          */
542         if (pci_dev->is_busmaster)
543                 pci_set_master(pci_dev);
544
545         return retval;
546 }
547
548 static int pci_legacy_suspend(struct device *dev, pm_message_t state)
549 {
550         struct pci_dev *pci_dev = to_pci_dev(dev);
551         struct pci_driver *drv = pci_dev->driver;
552
553         if (drv && drv->suspend) {
554                 pci_power_t prev = pci_dev->current_state;
555                 int error;
556
557                 error = drv->suspend(pci_dev, state);
558                 suspend_report_result(drv->suspend, error);
559                 if (error)
560                         return error;
561
562                 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
563                     && pci_dev->current_state != PCI_UNKNOWN) {
564                         WARN_ONCE(pci_dev->current_state != prev,
565                                 "PCI PM: Device state not saved by %pF\n",
566                                 drv->suspend);
567                 }
568         }
569
570         pci_fixup_device(pci_fixup_suspend, pci_dev);
571
572         return 0;
573 }
574
575 static int pci_legacy_suspend_late(struct device *dev, pm_message_t state)
576 {
577         struct pci_dev *pci_dev = to_pci_dev(dev);
578         struct pci_driver *drv = pci_dev->driver;
579
580         if (drv && drv->suspend_late) {
581                 pci_power_t prev = pci_dev->current_state;
582                 int error;
583
584                 error = drv->suspend_late(pci_dev, state);
585                 suspend_report_result(drv->suspend_late, error);
586                 if (error)
587                         return error;
588
589                 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
590                     && pci_dev->current_state != PCI_UNKNOWN) {
591                         WARN_ONCE(pci_dev->current_state != prev,
592                                 "PCI PM: Device state not saved by %pF\n",
593                                 drv->suspend_late);
594                         goto Fixup;
595                 }
596         }
597
598         if (!pci_dev->state_saved)
599                 pci_save_state(pci_dev);
600
601         pci_pm_set_unknown_state(pci_dev);
602
603 Fixup:
604         pci_fixup_device(pci_fixup_suspend_late, pci_dev);
605
606         return 0;
607 }
608
609 static int pci_legacy_resume_early(struct device *dev)
610 {
611         struct pci_dev *pci_dev = to_pci_dev(dev);
612         struct pci_driver *drv = pci_dev->driver;
613
614         return drv && drv->resume_early ?
615                         drv->resume_early(pci_dev) : 0;
616 }
617
618 static int pci_legacy_resume(struct device *dev)
619 {
620         struct pci_dev *pci_dev = to_pci_dev(dev);
621         struct pci_driver *drv = pci_dev->driver;
622
623         pci_fixup_device(pci_fixup_resume, pci_dev);
624
625         return drv && drv->resume ?
626                         drv->resume(pci_dev) : pci_pm_reenable_device(pci_dev);
627 }
628
629 /* Auxiliary functions used by the new power management framework */
630
631 static void pci_pm_default_resume(struct pci_dev *pci_dev)
632 {
633         pci_fixup_device(pci_fixup_resume, pci_dev);
634
635         if (!pci_has_subordinate(pci_dev))
636                 pci_enable_wake(pci_dev, PCI_D0, false);
637 }
638
639 static void pci_pm_default_suspend(struct pci_dev *pci_dev)
640 {
641         /* Disable non-bridge devices without PM support */
642         if (!pci_has_subordinate(pci_dev))
643                 pci_disable_enabled_device(pci_dev);
644 }
645
646 static bool pci_has_legacy_pm_support(struct pci_dev *pci_dev)
647 {
648         struct pci_driver *drv = pci_dev->driver;
649         bool ret = drv && (drv->suspend || drv->suspend_late || drv->resume
650                 || drv->resume_early);
651
652         /*
653          * Legacy PM support is used by default, so warn if the new framework is
654          * supported as well.  Drivers are supposed to support either the
655          * former, or the latter, but not both at the same time.
656          */
657         WARN(ret && drv->driver.pm, "driver %s device %04x:%04x\n",
658                 drv->name, pci_dev->vendor, pci_dev->device);
659
660         return ret;
661 }
662
663 /* New power management framework */
664
665 static int pci_pm_prepare(struct device *dev)
666 {
667         struct device_driver *drv = dev->driver;
668
669         /*
670          * Devices having power.ignore_children set may still be necessary for
671          * suspending their children in the next phase of device suspend.
672          */
673         if (dev->power.ignore_children)
674                 pm_runtime_resume(dev);
675
676         if (drv && drv->pm && drv->pm->prepare) {
677                 int error = drv->pm->prepare(dev);
678                 if (error)
679                         return error;
680         }
681         return pci_dev_keep_suspended(to_pci_dev(dev));
682 }
683
684
685 #else /* !CONFIG_PM_SLEEP */
686
687 #define pci_pm_prepare  NULL
688
689 #endif /* !CONFIG_PM_SLEEP */
690
691 #ifdef CONFIG_SUSPEND
692
693 static int pci_pm_suspend(struct device *dev)
694 {
695         struct pci_dev *pci_dev = to_pci_dev(dev);
696         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
697
698         if (pci_has_legacy_pm_support(pci_dev))
699                 return pci_legacy_suspend(dev, PMSG_SUSPEND);
700
701         if (!pm) {
702                 pci_pm_default_suspend(pci_dev);
703                 goto Fixup;
704         }
705
706         /*
707          * PCI devices suspended at run time need to be resumed at this point,
708          * because in general it is necessary to reconfigure them for system
709          * suspend.  Namely, if the device is supposed to wake up the system
710          * from the sleep state, we may need to reconfigure it for this purpose.
711          * In turn, if the device is not supposed to wake up the system from the
712          * sleep state, we'll have to prevent it from signaling wake-up.
713          */
714         pm_runtime_resume(dev);
715
716         pci_dev->state_saved = false;
717         if (pm->suspend) {
718                 pci_power_t prev = pci_dev->current_state;
719                 int error;
720
721                 error = pm->suspend(dev);
722                 suspend_report_result(pm->suspend, error);
723                 if (error)
724                         return error;
725
726                 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
727                     && pci_dev->current_state != PCI_UNKNOWN) {
728                         WARN_ONCE(pci_dev->current_state != prev,
729                                 "PCI PM: State of device not saved by %pF\n",
730                                 pm->suspend);
731                 }
732         }
733
734  Fixup:
735         pci_fixup_device(pci_fixup_suspend, pci_dev);
736
737         return 0;
738 }
739
740 static int pci_pm_suspend_noirq(struct device *dev)
741 {
742         struct pci_dev *pci_dev = to_pci_dev(dev);
743         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
744
745         if (pci_has_legacy_pm_support(pci_dev))
746                 return pci_legacy_suspend_late(dev, PMSG_SUSPEND);
747
748         if (!pm) {
749                 pci_save_state(pci_dev);
750                 goto Fixup;
751         }
752
753         if (pm->suspend_noirq) {
754                 pci_power_t prev = pci_dev->current_state;
755                 int error;
756
757                 error = pm->suspend_noirq(dev);
758                 suspend_report_result(pm->suspend_noirq, error);
759                 if (error)
760                         return error;
761
762                 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
763                     && pci_dev->current_state != PCI_UNKNOWN) {
764                         WARN_ONCE(pci_dev->current_state != prev,
765                                 "PCI PM: State of device not saved by %pF\n",
766                                 pm->suspend_noirq);
767                         goto Fixup;
768                 }
769         }
770
771         if (!pci_dev->state_saved) {
772                 pci_save_state(pci_dev);
773                 if (!pci_has_subordinate(pci_dev))
774                         pci_prepare_to_sleep(pci_dev);
775         }
776
777         pci_pm_set_unknown_state(pci_dev);
778
779         /*
780          * Some BIOSes from ASUS have a bug: If a USB EHCI host controller's
781          * PCI COMMAND register isn't 0, the BIOS assumes that the controller
782          * hasn't been quiesced and tries to turn it off.  If the controller
783          * is already in D3, this can hang or cause memory corruption.
784          *
785          * Since the value of the COMMAND register doesn't matter once the
786          * device has been suspended, we can safely set it to 0 here.
787          */
788         if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
789                 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
790
791 Fixup:
792         pci_fixup_device(pci_fixup_suspend_late, pci_dev);
793
794         return 0;
795 }
796
797 static int pci_pm_resume_noirq(struct device *dev)
798 {
799         struct pci_dev *pci_dev = to_pci_dev(dev);
800         struct device_driver *drv = dev->driver;
801         int error = 0;
802
803         pci_pm_default_resume_early(pci_dev);
804
805         if (pci_has_legacy_pm_support(pci_dev))
806                 return pci_legacy_resume_early(dev);
807
808         if (drv && drv->pm && drv->pm->resume_noirq)
809                 error = drv->pm->resume_noirq(dev);
810
811         return error;
812 }
813
814 static int pci_pm_resume(struct device *dev)
815 {
816         struct pci_dev *pci_dev = to_pci_dev(dev);
817         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
818         int error = 0;
819
820         /*
821          * This is necessary for the suspend error path in which resume is
822          * called without restoring the standard config registers of the device.
823          */
824         if (pci_dev->state_saved)
825                 pci_restore_standard_config(pci_dev);
826
827         if (pci_has_legacy_pm_support(pci_dev))
828                 return pci_legacy_resume(dev);
829
830         pci_pm_default_resume(pci_dev);
831
832         if (pm) {
833                 if (pm->resume)
834                         error = pm->resume(dev);
835         } else {
836                 pci_pm_reenable_device(pci_dev);
837         }
838
839         return error;
840 }
841
842 #else /* !CONFIG_SUSPEND */
843
844 #define pci_pm_suspend          NULL
845 #define pci_pm_suspend_noirq    NULL
846 #define pci_pm_resume           NULL
847 #define pci_pm_resume_noirq     NULL
848
849 #endif /* !CONFIG_SUSPEND */
850
851 #ifdef CONFIG_HIBERNATE_CALLBACKS
852
853
854 /*
855  * pcibios_pm_ops - provide arch-specific hooks when a PCI device is doing
856  * a hibernate transition
857  */
858 struct dev_pm_ops __weak pcibios_pm_ops;
859
860 static int pci_pm_freeze(struct device *dev)
861 {
862         struct pci_dev *pci_dev = to_pci_dev(dev);
863         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
864
865         if (pci_has_legacy_pm_support(pci_dev))
866                 return pci_legacy_suspend(dev, PMSG_FREEZE);
867
868         if (!pm) {
869                 pci_pm_default_suspend(pci_dev);
870                 return 0;
871         }
872
873         /*
874          * This used to be done in pci_pm_prepare() for all devices and some
875          * drivers may depend on it, so do it here.  Ideally, runtime-suspended
876          * devices should not be touched during freeze/thaw transitions,
877          * however.
878          */
879         pm_runtime_resume(dev);
880
881         pci_dev->state_saved = false;
882         if (pm->freeze) {
883                 int error;
884
885                 error = pm->freeze(dev);
886                 suspend_report_result(pm->freeze, error);
887                 if (error)
888                         return error;
889         }
890
891         if (pcibios_pm_ops.freeze)
892                 return pcibios_pm_ops.freeze(dev);
893
894         return 0;
895 }
896
897 static int pci_pm_freeze_noirq(struct device *dev)
898 {
899         struct pci_dev *pci_dev = to_pci_dev(dev);
900         struct device_driver *drv = dev->driver;
901
902         if (pci_has_legacy_pm_support(pci_dev))
903                 return pci_legacy_suspend_late(dev, PMSG_FREEZE);
904
905         if (drv && drv->pm && drv->pm->freeze_noirq) {
906                 int error;
907
908                 error = drv->pm->freeze_noirq(dev);
909                 suspend_report_result(drv->pm->freeze_noirq, error);
910                 if (error)
911                         return error;
912         }
913
914         if (!pci_dev->state_saved)
915                 pci_save_state(pci_dev);
916
917         pci_pm_set_unknown_state(pci_dev);
918
919         if (pcibios_pm_ops.freeze_noirq)
920                 return pcibios_pm_ops.freeze_noirq(dev);
921
922         return 0;
923 }
924
925 static int pci_pm_thaw_noirq(struct device *dev)
926 {
927         struct pci_dev *pci_dev = to_pci_dev(dev);
928         struct device_driver *drv = dev->driver;
929         int error = 0;
930
931         if (pcibios_pm_ops.thaw_noirq) {
932                 error = pcibios_pm_ops.thaw_noirq(dev);
933                 if (error)
934                         return error;
935         }
936
937         if (pci_has_legacy_pm_support(pci_dev))
938                 return pci_legacy_resume_early(dev);
939
940         pci_update_current_state(pci_dev, PCI_D0);
941
942         if (drv && drv->pm && drv->pm->thaw_noirq)
943                 error = drv->pm->thaw_noirq(dev);
944
945         return error;
946 }
947
948 static int pci_pm_thaw(struct device *dev)
949 {
950         struct pci_dev *pci_dev = to_pci_dev(dev);
951         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
952         int error = 0;
953
954         if (pcibios_pm_ops.thaw) {
955                 error = pcibios_pm_ops.thaw(dev);
956                 if (error)
957                         return error;
958         }
959
960         if (pci_has_legacy_pm_support(pci_dev))
961                 return pci_legacy_resume(dev);
962
963         if (pm) {
964                 if (pm->thaw)
965                         error = pm->thaw(dev);
966         } else {
967                 pci_pm_reenable_device(pci_dev);
968         }
969
970         pci_dev->state_saved = false;
971
972         return error;
973 }
974
975 static int pci_pm_poweroff(struct device *dev)
976 {
977         struct pci_dev *pci_dev = to_pci_dev(dev);
978         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
979
980         if (pci_has_legacy_pm_support(pci_dev))
981                 return pci_legacy_suspend(dev, PMSG_HIBERNATE);
982
983         if (!pm) {
984                 pci_pm_default_suspend(pci_dev);
985                 goto Fixup;
986         }
987
988         /* The reason to do that is the same as in pci_pm_suspend(). */
989         pm_runtime_resume(dev);
990
991         pci_dev->state_saved = false;
992         if (pm->poweroff) {
993                 int error;
994
995                 error = pm->poweroff(dev);
996                 suspend_report_result(pm->poweroff, error);
997                 if (error)
998                         return error;
999         }
1000
1001  Fixup:
1002         pci_fixup_device(pci_fixup_suspend, pci_dev);
1003
1004         if (pcibios_pm_ops.poweroff)
1005                 return pcibios_pm_ops.poweroff(dev);
1006
1007         return 0;
1008 }
1009
1010 static int pci_pm_poweroff_noirq(struct device *dev)
1011 {
1012         struct pci_dev *pci_dev = to_pci_dev(dev);
1013         struct device_driver *drv = dev->driver;
1014
1015         if (pci_has_legacy_pm_support(to_pci_dev(dev)))
1016                 return pci_legacy_suspend_late(dev, PMSG_HIBERNATE);
1017
1018         if (!drv || !drv->pm) {
1019                 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1020                 return 0;
1021         }
1022
1023         if (drv->pm->poweroff_noirq) {
1024                 int error;
1025
1026                 error = drv->pm->poweroff_noirq(dev);
1027                 suspend_report_result(drv->pm->poweroff_noirq, error);
1028                 if (error)
1029                         return error;
1030         }
1031
1032         if (!pci_dev->state_saved && !pci_has_subordinate(pci_dev))
1033                 pci_prepare_to_sleep(pci_dev);
1034
1035         /*
1036          * The reason for doing this here is the same as for the analogous code
1037          * in pci_pm_suspend_noirq().
1038          */
1039         if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
1040                 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
1041
1042         pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1043
1044         if (pcibios_pm_ops.poweroff_noirq)
1045                 return pcibios_pm_ops.poweroff_noirq(dev);
1046
1047         return 0;
1048 }
1049
1050 static int pci_pm_restore_noirq(struct device *dev)
1051 {
1052         struct pci_dev *pci_dev = to_pci_dev(dev);
1053         struct device_driver *drv = dev->driver;
1054         int error = 0;
1055
1056         if (pcibios_pm_ops.restore_noirq) {
1057                 error = pcibios_pm_ops.restore_noirq(dev);
1058                 if (error)
1059                         return error;
1060         }
1061
1062         pci_pm_default_resume_early(pci_dev);
1063
1064         if (pci_has_legacy_pm_support(pci_dev))
1065                 return pci_legacy_resume_early(dev);
1066
1067         if (drv && drv->pm && drv->pm->restore_noirq)
1068                 error = drv->pm->restore_noirq(dev);
1069
1070         return error;
1071 }
1072
1073 static int pci_pm_restore(struct device *dev)
1074 {
1075         struct pci_dev *pci_dev = to_pci_dev(dev);
1076         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1077         int error = 0;
1078
1079         if (pcibios_pm_ops.restore) {
1080                 error = pcibios_pm_ops.restore(dev);
1081                 if (error)
1082                         return error;
1083         }
1084
1085         /*
1086          * This is necessary for the hibernation error path in which restore is
1087          * called without restoring the standard config registers of the device.
1088          */
1089         if (pci_dev->state_saved)
1090                 pci_restore_standard_config(pci_dev);
1091
1092         if (pci_has_legacy_pm_support(pci_dev))
1093                 return pci_legacy_resume(dev);
1094
1095         pci_pm_default_resume(pci_dev);
1096
1097         if (pm) {
1098                 if (pm->restore)
1099                         error = pm->restore(dev);
1100         } else {
1101                 pci_pm_reenable_device(pci_dev);
1102         }
1103
1104         return error;
1105 }
1106
1107 #else /* !CONFIG_HIBERNATE_CALLBACKS */
1108
1109 #define pci_pm_freeze           NULL
1110 #define pci_pm_freeze_noirq     NULL
1111 #define pci_pm_thaw             NULL
1112 #define pci_pm_thaw_noirq       NULL
1113 #define pci_pm_poweroff         NULL
1114 #define pci_pm_poweroff_noirq   NULL
1115 #define pci_pm_restore          NULL
1116 #define pci_pm_restore_noirq    NULL
1117
1118 #endif /* !CONFIG_HIBERNATE_CALLBACKS */
1119
1120 #ifdef CONFIG_PM
1121
1122 static int pci_pm_runtime_suspend(struct device *dev)
1123 {
1124         struct pci_dev *pci_dev = to_pci_dev(dev);
1125         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1126         pci_power_t prev = pci_dev->current_state;
1127         int error;
1128
1129         /*
1130          * If pci_dev->driver is not set (unbound), the device should
1131          * always remain in D0 regardless of the runtime PM status
1132          */
1133         if (!pci_dev->driver)
1134                 return 0;
1135
1136         if (!pm || !pm->runtime_suspend)
1137                 return -ENOSYS;
1138
1139         pci_dev->state_saved = false;
1140         pci_dev->no_d3cold = false;
1141         error = pm->runtime_suspend(dev);
1142         suspend_report_result(pm->runtime_suspend, error);
1143         if (error)
1144                 return error;
1145         if (!pci_dev->d3cold_allowed)
1146                 pci_dev->no_d3cold = true;
1147
1148         pci_fixup_device(pci_fixup_suspend, pci_dev);
1149
1150         if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
1151             && pci_dev->current_state != PCI_UNKNOWN) {
1152                 WARN_ONCE(pci_dev->current_state != prev,
1153                         "PCI PM: State of device not saved by %pF\n",
1154                         pm->runtime_suspend);
1155                 return 0;
1156         }
1157
1158         if (!pci_dev->state_saved) {
1159                 pci_save_state(pci_dev);
1160                 pci_finish_runtime_suspend(pci_dev);
1161         }
1162
1163         return 0;
1164 }
1165
1166 static int pci_pm_runtime_resume(struct device *dev)
1167 {
1168         int rc;
1169         struct pci_dev *pci_dev = to_pci_dev(dev);
1170         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1171
1172         /*
1173          * If pci_dev->driver is not set (unbound), the device should
1174          * always remain in D0 regardless of the runtime PM status
1175          */
1176         if (!pci_dev->driver)
1177                 return 0;
1178
1179         if (!pm || !pm->runtime_resume)
1180                 return -ENOSYS;
1181
1182         pci_restore_standard_config(pci_dev);
1183         pci_fixup_device(pci_fixup_resume_early, pci_dev);
1184         __pci_enable_wake(pci_dev, PCI_D0, true, false);
1185         pci_fixup_device(pci_fixup_resume, pci_dev);
1186
1187         rc = pm->runtime_resume(dev);
1188
1189         pci_dev->runtime_d3cold = false;
1190
1191         return rc;
1192 }
1193
1194 static int pci_pm_runtime_idle(struct device *dev)
1195 {
1196         struct pci_dev *pci_dev = to_pci_dev(dev);
1197         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1198         int ret = 0;
1199
1200         /*
1201          * If pci_dev->driver is not set (unbound), the device should
1202          * always remain in D0 regardless of the runtime PM status
1203          */
1204         if (!pci_dev->driver)
1205                 return 0;
1206
1207         if (!pm)
1208                 return -ENOSYS;
1209
1210         if (pm->runtime_idle)
1211                 ret = pm->runtime_idle(dev);
1212
1213         return ret;
1214 }
1215
1216 static const struct dev_pm_ops pci_dev_pm_ops = {
1217         .prepare = pci_pm_prepare,
1218         .suspend = pci_pm_suspend,
1219         .resume = pci_pm_resume,
1220         .freeze = pci_pm_freeze,
1221         .thaw = pci_pm_thaw,
1222         .poweroff = pci_pm_poweroff,
1223         .restore = pci_pm_restore,
1224         .suspend_noirq = pci_pm_suspend_noirq,
1225         .resume_noirq = pci_pm_resume_noirq,
1226         .freeze_noirq = pci_pm_freeze_noirq,
1227         .thaw_noirq = pci_pm_thaw_noirq,
1228         .poweroff_noirq = pci_pm_poweroff_noirq,
1229         .restore_noirq = pci_pm_restore_noirq,
1230         .runtime_suspend = pci_pm_runtime_suspend,
1231         .runtime_resume = pci_pm_runtime_resume,
1232         .runtime_idle = pci_pm_runtime_idle,
1233 };
1234
1235 #define PCI_PM_OPS_PTR  (&pci_dev_pm_ops)
1236
1237 #else /* !CONFIG_PM */
1238
1239 #define pci_pm_runtime_suspend  NULL
1240 #define pci_pm_runtime_resume   NULL
1241 #define pci_pm_runtime_idle     NULL
1242
1243 #define PCI_PM_OPS_PTR  NULL
1244
1245 #endif /* !CONFIG_PM */
1246
1247 /**
1248  * __pci_register_driver - register a new pci driver
1249  * @drv: the driver structure to register
1250  * @owner: owner module of drv
1251  * @mod_name: module name string
1252  *
1253  * Adds the driver structure to the list of registered drivers.
1254  * Returns a negative value on error, otherwise 0.
1255  * If no error occurred, the driver remains registered even if
1256  * no device was claimed during registration.
1257  */
1258 int __pci_register_driver(struct pci_driver *drv, struct module *owner,
1259                           const char *mod_name)
1260 {
1261         /* initialize common driver fields */
1262         drv->driver.name = drv->name;
1263         drv->driver.bus = &pci_bus_type;
1264         drv->driver.owner = owner;
1265         drv->driver.mod_name = mod_name;
1266
1267         spin_lock_init(&drv->dynids.lock);
1268         INIT_LIST_HEAD(&drv->dynids.list);
1269
1270         /* register with core */
1271         return driver_register(&drv->driver);
1272 }
1273 EXPORT_SYMBOL(__pci_register_driver);
1274
1275 /**
1276  * pci_unregister_driver - unregister a pci driver
1277  * @drv: the driver structure to unregister
1278  *
1279  * Deletes the driver structure from the list of registered PCI drivers,
1280  * gives it a chance to clean up by calling its remove() function for
1281  * each device it was responsible for, and marks those devices as
1282  * driverless.
1283  */
1284
1285 void pci_unregister_driver(struct pci_driver *drv)
1286 {
1287         driver_unregister(&drv->driver);
1288         pci_free_dynids(drv);
1289 }
1290 EXPORT_SYMBOL(pci_unregister_driver);
1291
1292 static struct pci_driver pci_compat_driver = {
1293         .name = "compat"
1294 };
1295
1296 /**
1297  * pci_dev_driver - get the pci_driver of a device
1298  * @dev: the device to query
1299  *
1300  * Returns the appropriate pci_driver structure or %NULL if there is no
1301  * registered driver for the device.
1302  */
1303 struct pci_driver *pci_dev_driver(const struct pci_dev *dev)
1304 {
1305         if (dev->driver)
1306                 return dev->driver;
1307         else {
1308                 int i;
1309                 for (i = 0; i <= PCI_ROM_RESOURCE; i++)
1310                         if (dev->resource[i].flags & IORESOURCE_BUSY)
1311                                 return &pci_compat_driver;
1312         }
1313         return NULL;
1314 }
1315 EXPORT_SYMBOL(pci_dev_driver);
1316
1317 /**
1318  * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
1319  * @dev: the PCI device structure to match against
1320  * @drv: the device driver to search for matching PCI device id structures
1321  *
1322  * Used by a driver to check whether a PCI device present in the
1323  * system is in its list of supported devices. Returns the matching
1324  * pci_device_id structure or %NULL if there is no match.
1325  */
1326 static int pci_bus_match(struct device *dev, struct device_driver *drv)
1327 {
1328         struct pci_dev *pci_dev = to_pci_dev(dev);
1329         struct pci_driver *pci_drv;
1330         const struct pci_device_id *found_id;
1331
1332         if (!pci_dev->match_driver)
1333                 return 0;
1334
1335         pci_drv = to_pci_driver(drv);
1336         found_id = pci_match_device(pci_drv, pci_dev);
1337         if (found_id)
1338                 return 1;
1339
1340         return 0;
1341 }
1342
1343 /**
1344  * pci_dev_get - increments the reference count of the pci device structure
1345  * @dev: the device being referenced
1346  *
1347  * Each live reference to a device should be refcounted.
1348  *
1349  * Drivers for PCI devices should normally record such references in
1350  * their probe() methods, when they bind to a device, and release
1351  * them by calling pci_dev_put(), in their disconnect() methods.
1352  *
1353  * A pointer to the device with the incremented reference counter is returned.
1354  */
1355 struct pci_dev *pci_dev_get(struct pci_dev *dev)
1356 {
1357         if (dev)
1358                 get_device(&dev->dev);
1359         return dev;
1360 }
1361 EXPORT_SYMBOL(pci_dev_get);
1362
1363 /**
1364  * pci_dev_put - release a use of the pci device structure
1365  * @dev: device that's been disconnected
1366  *
1367  * Must be called when a user of a device is finished with it.  When the last
1368  * user of the device calls this function, the memory of the device is freed.
1369  */
1370 void pci_dev_put(struct pci_dev *dev)
1371 {
1372         if (dev)
1373                 put_device(&dev->dev);
1374 }
1375 EXPORT_SYMBOL(pci_dev_put);
1376
1377 static int pci_uevent(struct device *dev, struct kobj_uevent_env *env)
1378 {
1379         struct pci_dev *pdev;
1380
1381         if (!dev)
1382                 return -ENODEV;
1383
1384         pdev = to_pci_dev(dev);
1385
1386         if (add_uevent_var(env, "PCI_CLASS=%04X", pdev->class))
1387                 return -ENOMEM;
1388
1389         if (add_uevent_var(env, "PCI_ID=%04X:%04X", pdev->vendor, pdev->device))
1390                 return -ENOMEM;
1391
1392         if (add_uevent_var(env, "PCI_SUBSYS_ID=%04X:%04X", pdev->subsystem_vendor,
1393                            pdev->subsystem_device))
1394                 return -ENOMEM;
1395
1396         if (add_uevent_var(env, "PCI_SLOT_NAME=%s", pci_name(pdev)))
1397                 return -ENOMEM;
1398
1399         if (add_uevent_var(env, "MODALIAS=pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X",
1400                            pdev->vendor, pdev->device,
1401                            pdev->subsystem_vendor, pdev->subsystem_device,
1402                            (u8)(pdev->class >> 16), (u8)(pdev->class >> 8),
1403                            (u8)(pdev->class)))
1404                 return -ENOMEM;
1405
1406         return 0;
1407 }
1408
1409 struct bus_type pci_bus_type = {
1410         .name           = "pci",
1411         .match          = pci_bus_match,
1412         .uevent         = pci_uevent,
1413         .probe          = pci_device_probe,
1414         .remove         = pci_device_remove,
1415         .shutdown       = pci_device_shutdown,
1416         .dev_groups     = pci_dev_groups,
1417         .bus_groups     = pci_bus_groups,
1418         .drv_groups     = pci_drv_groups,
1419         .pm             = PCI_PM_OPS_PTR,
1420 };
1421 EXPORT_SYMBOL(pci_bus_type);
1422
1423 static int __init pci_driver_init(void)
1424 {
1425         return bus_register(&pci_bus_type);
1426 }
1427 postcore_initcall(pci_driver_init);