ACPI / PM: Take SMART_SUSPEND driver flag into account
[muen/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 new_id_store(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_WO(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 remove_id_store(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_WO(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          * or any other runtime PM helper function decrementing the usage
302          * count, in its probe routine and pm_runtime_get_noresume() in
303          * its remove routine.
304          */
305         pm_runtime_get_sync(dev);
306         pci_dev->driver = pci_drv;
307         rc = pci_drv->probe(pci_dev, ddi->id);
308         if (!rc)
309                 return rc;
310         if (rc < 0) {
311                 pci_dev->driver = NULL;
312                 pm_runtime_put_sync(dev);
313                 return rc;
314         }
315         /*
316          * Probe function should return < 0 for failure, 0 for success
317          * Treat values > 0 as success, but warn.
318          */
319         dev_warn(dev, "Driver probe function unexpectedly returned %d\n", rc);
320         return 0;
321 }
322
323 static bool pci_physfn_is_probed(struct pci_dev *dev)
324 {
325 #ifdef CONFIG_PCI_IOV
326         return dev->is_virtfn && dev->physfn->is_probed;
327 #else
328         return false;
329 #endif
330 }
331
332 static int pci_call_probe(struct pci_driver *drv, struct pci_dev *dev,
333                           const struct pci_device_id *id)
334 {
335         int error, node, cpu;
336         struct drv_dev_and_id ddi = { drv, dev, id };
337
338         /*
339          * Execute driver initialization on node where the device is
340          * attached.  This way the driver likely allocates its local memory
341          * on the right node.
342          */
343         node = dev_to_node(&dev->dev);
344         dev->is_probed = 1;
345
346         cpu_hotplug_disable();
347
348         /*
349          * Prevent nesting work_on_cpu() for the case where a Virtual Function
350          * device is probed from work_on_cpu() of the Physical device.
351          */
352         if (node < 0 || node >= MAX_NUMNODES || !node_online(node) ||
353             pci_physfn_is_probed(dev))
354                 cpu = nr_cpu_ids;
355         else
356                 cpu = cpumask_any_and(cpumask_of_node(node), cpu_online_mask);
357
358         if (cpu < nr_cpu_ids)
359                 error = work_on_cpu(cpu, local_pci_probe, &ddi);
360         else
361                 error = local_pci_probe(&ddi);
362
363         dev->is_probed = 0;
364         cpu_hotplug_enable();
365         return error;
366 }
367
368 /**
369  * __pci_device_probe - check if a driver wants to claim a specific PCI device
370  * @drv: driver to call to check if it wants the PCI device
371  * @pci_dev: PCI device being probed
372  *
373  * returns 0 on success, else error.
374  * side-effect: pci_dev->driver is set to drv when drv claims pci_dev.
375  */
376 static int __pci_device_probe(struct pci_driver *drv, struct pci_dev *pci_dev)
377 {
378         const struct pci_device_id *id;
379         int error = 0;
380
381         if (!pci_dev->driver && drv->probe) {
382                 error = -ENODEV;
383
384                 id = pci_match_device(drv, pci_dev);
385                 if (id)
386                         error = pci_call_probe(drv, pci_dev, id);
387         }
388         return error;
389 }
390
391 int __weak pcibios_alloc_irq(struct pci_dev *dev)
392 {
393         return 0;
394 }
395
396 void __weak pcibios_free_irq(struct pci_dev *dev)
397 {
398 }
399
400 #ifdef CONFIG_PCI_IOV
401 static inline bool pci_device_can_probe(struct pci_dev *pdev)
402 {
403         return (!pdev->is_virtfn || pdev->physfn->sriov->drivers_autoprobe);
404 }
405 #else
406 static inline bool pci_device_can_probe(struct pci_dev *pdev)
407 {
408         return true;
409 }
410 #endif
411
412 static int pci_device_probe(struct device *dev)
413 {
414         int error;
415         struct pci_dev *pci_dev = to_pci_dev(dev);
416         struct pci_driver *drv = to_pci_driver(dev->driver);
417
418         pci_assign_irq(pci_dev);
419
420         error = pcibios_alloc_irq(pci_dev);
421         if (error < 0)
422                 return error;
423
424         pci_dev_get(pci_dev);
425         if (pci_device_can_probe(pci_dev)) {
426                 error = __pci_device_probe(drv, pci_dev);
427                 if (error) {
428                         pcibios_free_irq(pci_dev);
429                         pci_dev_put(pci_dev);
430                 }
431         }
432
433         return error;
434 }
435
436 static int pci_device_remove(struct device *dev)
437 {
438         struct pci_dev *pci_dev = to_pci_dev(dev);
439         struct pci_driver *drv = pci_dev->driver;
440
441         if (drv) {
442                 if (drv->remove) {
443                         pm_runtime_get_sync(dev);
444                         drv->remove(pci_dev);
445                         pm_runtime_put_noidle(dev);
446                 }
447                 pcibios_free_irq(pci_dev);
448                 pci_dev->driver = NULL;
449         }
450
451         /* Undo the runtime PM settings in local_pci_probe() */
452         pm_runtime_put_sync(dev);
453
454         /*
455          * If the device is still on, set the power state as "unknown",
456          * since it might change by the next time we load the driver.
457          */
458         if (pci_dev->current_state == PCI_D0)
459                 pci_dev->current_state = PCI_UNKNOWN;
460
461         /*
462          * We would love to complain here if pci_dev->is_enabled is set, that
463          * the driver should have called pci_disable_device(), but the
464          * unfortunate fact is there are too many odd BIOS and bridge setups
465          * that don't like drivers doing that all of the time.
466          * Oh well, we can dream of sane hardware when we sleep, no matter how
467          * horrible the crap we have to deal with is when we are awake...
468          */
469
470         pci_dev_put(pci_dev);
471         return 0;
472 }
473
474 static void pci_device_shutdown(struct device *dev)
475 {
476         struct pci_dev *pci_dev = to_pci_dev(dev);
477         struct pci_driver *drv = pci_dev->driver;
478
479         pm_runtime_resume(dev);
480
481         if (drv && drv->shutdown)
482                 drv->shutdown(pci_dev);
483
484         /*
485          * If this is a kexec reboot, turn off Bus Master bit on the
486          * device to tell it to not continue to do DMA. Don't touch
487          * devices in D3cold or unknown states.
488          * If it is not a kexec reboot, firmware will hit the PCI
489          * devices with big hammer and stop their DMA any way.
490          */
491         if (kexec_in_progress && (pci_dev->current_state <= PCI_D3hot))
492                 pci_clear_master(pci_dev);
493 }
494
495 #ifdef CONFIG_PM
496
497 /* Auxiliary functions used for system resume and run-time resume. */
498
499 /**
500  * pci_restore_standard_config - restore standard config registers of PCI device
501  * @pci_dev: PCI device to handle
502  */
503 static int pci_restore_standard_config(struct pci_dev *pci_dev)
504 {
505         pci_update_current_state(pci_dev, PCI_UNKNOWN);
506
507         if (pci_dev->current_state != PCI_D0) {
508                 int error = pci_set_power_state(pci_dev, PCI_D0);
509                 if (error)
510                         return error;
511         }
512
513         pci_restore_state(pci_dev);
514         pci_pme_restore(pci_dev);
515         return 0;
516 }
517
518 #endif
519
520 #ifdef CONFIG_PM_SLEEP
521
522 static void pci_pm_default_resume_early(struct pci_dev *pci_dev)
523 {
524         pci_power_up(pci_dev);
525         pci_restore_state(pci_dev);
526         pci_pme_restore(pci_dev);
527         pci_fixup_device(pci_fixup_resume_early, pci_dev);
528 }
529
530 /*
531  * Default "suspend" method for devices that have no driver provided suspend,
532  * or not even a driver at all (second part).
533  */
534 static void pci_pm_set_unknown_state(struct pci_dev *pci_dev)
535 {
536         /*
537          * mark its power state as "unknown", since we don't know if
538          * e.g. the BIOS will change its device state when we suspend.
539          */
540         if (pci_dev->current_state == PCI_D0)
541                 pci_dev->current_state = PCI_UNKNOWN;
542 }
543
544 /*
545  * Default "resume" method for devices that have no driver provided resume,
546  * or not even a driver at all (second part).
547  */
548 static int pci_pm_reenable_device(struct pci_dev *pci_dev)
549 {
550         int retval;
551
552         /* if the device was enabled before suspend, reenable */
553         retval = pci_reenable_device(pci_dev);
554         /*
555          * if the device was busmaster before the suspend, make it busmaster
556          * again
557          */
558         if (pci_dev->is_busmaster)
559                 pci_set_master(pci_dev);
560
561         return retval;
562 }
563
564 static int pci_legacy_suspend(struct device *dev, pm_message_t state)
565 {
566         struct pci_dev *pci_dev = to_pci_dev(dev);
567         struct pci_driver *drv = pci_dev->driver;
568
569         if (drv && drv->suspend) {
570                 pci_power_t prev = pci_dev->current_state;
571                 int error;
572
573                 error = drv->suspend(pci_dev, state);
574                 suspend_report_result(drv->suspend, error);
575                 if (error)
576                         return error;
577
578                 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
579                     && pci_dev->current_state != PCI_UNKNOWN) {
580                         WARN_ONCE(pci_dev->current_state != prev,
581                                 "PCI PM: Device state not saved by %pF\n",
582                                 drv->suspend);
583                 }
584         }
585
586         pci_fixup_device(pci_fixup_suspend, pci_dev);
587
588         return 0;
589 }
590
591 static int pci_legacy_suspend_late(struct device *dev, pm_message_t state)
592 {
593         struct pci_dev *pci_dev = to_pci_dev(dev);
594         struct pci_driver *drv = pci_dev->driver;
595
596         if (drv && drv->suspend_late) {
597                 pci_power_t prev = pci_dev->current_state;
598                 int error;
599
600                 error = drv->suspend_late(pci_dev, state);
601                 suspend_report_result(drv->suspend_late, error);
602                 if (error)
603                         return error;
604
605                 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
606                     && pci_dev->current_state != PCI_UNKNOWN) {
607                         WARN_ONCE(pci_dev->current_state != prev,
608                                 "PCI PM: Device state not saved by %pF\n",
609                                 drv->suspend_late);
610                         goto Fixup;
611                 }
612         }
613
614         if (!pci_dev->state_saved)
615                 pci_save_state(pci_dev);
616
617         pci_pm_set_unknown_state(pci_dev);
618
619 Fixup:
620         pci_fixup_device(pci_fixup_suspend_late, pci_dev);
621
622         return 0;
623 }
624
625 static int pci_legacy_resume_early(struct device *dev)
626 {
627         struct pci_dev *pci_dev = to_pci_dev(dev);
628         struct pci_driver *drv = pci_dev->driver;
629
630         return drv && drv->resume_early ?
631                         drv->resume_early(pci_dev) : 0;
632 }
633
634 static int pci_legacy_resume(struct device *dev)
635 {
636         struct pci_dev *pci_dev = to_pci_dev(dev);
637         struct pci_driver *drv = pci_dev->driver;
638
639         pci_fixup_device(pci_fixup_resume, pci_dev);
640
641         return drv && drv->resume ?
642                         drv->resume(pci_dev) : pci_pm_reenable_device(pci_dev);
643 }
644
645 /* Auxiliary functions used by the new power management framework */
646
647 static void pci_pm_default_resume(struct pci_dev *pci_dev)
648 {
649         pci_fixup_device(pci_fixup_resume, pci_dev);
650         pci_enable_wake(pci_dev, PCI_D0, false);
651 }
652
653 static void pci_pm_default_suspend(struct pci_dev *pci_dev)
654 {
655         /* Disable non-bridge devices without PM support */
656         if (!pci_has_subordinate(pci_dev))
657                 pci_disable_enabled_device(pci_dev);
658 }
659
660 static bool pci_has_legacy_pm_support(struct pci_dev *pci_dev)
661 {
662         struct pci_driver *drv = pci_dev->driver;
663         bool ret = drv && (drv->suspend || drv->suspend_late || drv->resume
664                 || drv->resume_early);
665
666         /*
667          * Legacy PM support is used by default, so warn if the new framework is
668          * supported as well.  Drivers are supposed to support either the
669          * former, or the latter, but not both at the same time.
670          */
671         WARN(ret && drv->driver.pm, "driver %s device %04x:%04x\n",
672                 drv->name, pci_dev->vendor, pci_dev->device);
673
674         return ret;
675 }
676
677 /* New power management framework */
678
679 static int pci_pm_prepare(struct device *dev)
680 {
681         struct device_driver *drv = dev->driver;
682
683         /*
684          * Devices having power.ignore_children set may still be necessary for
685          * suspending their children in the next phase of device suspend.
686          */
687         if (dev->power.ignore_children)
688                 pm_runtime_resume(dev);
689
690         if (drv && drv->pm && drv->pm->prepare) {
691                 int error = drv->pm->prepare(dev);
692                 if (error < 0)
693                         return error;
694
695                 if (!error && dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_PREPARE))
696                         return 0;
697         }
698         return pci_dev_keep_suspended(to_pci_dev(dev));
699 }
700
701 static void pci_pm_complete(struct device *dev)
702 {
703         struct pci_dev *pci_dev = to_pci_dev(dev);
704
705         pci_dev_complete_resume(pci_dev);
706         pm_generic_complete(dev);
707
708         /* Resume device if platform firmware has put it in reset-power-on */
709         if (dev->power.direct_complete && pm_resume_via_firmware()) {
710                 pci_power_t pre_sleep_state = pci_dev->current_state;
711
712                 pci_update_current_state(pci_dev, pci_dev->current_state);
713                 if (pci_dev->current_state < pre_sleep_state)
714                         pm_request_resume(dev);
715         }
716 }
717
718 #else /* !CONFIG_PM_SLEEP */
719
720 #define pci_pm_prepare  NULL
721 #define pci_pm_complete NULL
722
723 #endif /* !CONFIG_PM_SLEEP */
724
725 #ifdef CONFIG_SUSPEND
726
727 static int pci_pm_suspend(struct device *dev)
728 {
729         struct pci_dev *pci_dev = to_pci_dev(dev);
730         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
731
732         if (pci_has_legacy_pm_support(pci_dev))
733                 return pci_legacy_suspend(dev, PMSG_SUSPEND);
734
735         if (!pm) {
736                 pci_pm_default_suspend(pci_dev);
737                 return 0;
738         }
739
740         /*
741          * PCI devices suspended at run time may need to be resumed at this
742          * point, because in general it may be necessary to reconfigure them for
743          * system suspend.  Namely, if the device is expected to wake up the
744          * system from the sleep state, it may have to be reconfigured for this
745          * purpose, or if the device is not expected to wake up the system from
746          * the sleep state, it should be prevented from signaling wakeup events
747          * going forward.
748          *
749          * Also if the driver of the device does not indicate that its system
750          * suspend callbacks can cope with runtime-suspended devices, it is
751          * better to resume the device from runtime suspend here.
752          */
753         if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
754             !pci_dev_keep_suspended(pci_dev))
755                 pm_runtime_resume(dev);
756
757         pci_dev->state_saved = false;
758         if (pm->suspend) {
759                 pci_power_t prev = pci_dev->current_state;
760                 int error;
761
762                 error = pm->suspend(dev);
763                 suspend_report_result(pm->suspend, error);
764                 if (error)
765                         return error;
766
767                 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
768                     && pci_dev->current_state != PCI_UNKNOWN) {
769                         WARN_ONCE(pci_dev->current_state != prev,
770                                 "PCI PM: State of device not saved by %pF\n",
771                                 pm->suspend);
772                 }
773         }
774
775         return 0;
776 }
777
778 static int pci_pm_suspend_late(struct device *dev)
779 {
780         if (dev_pm_smart_suspend_and_suspended(dev))
781                 return 0;
782
783         pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));
784
785         return pm_generic_suspend_late(dev);
786 }
787
788 static int pci_pm_suspend_noirq(struct device *dev)
789 {
790         struct pci_dev *pci_dev = to_pci_dev(dev);
791         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
792
793         if (dev_pm_smart_suspend_and_suspended(dev))
794                 return 0;
795
796         if (pci_has_legacy_pm_support(pci_dev))
797                 return pci_legacy_suspend_late(dev, PMSG_SUSPEND);
798
799         if (!pm) {
800                 pci_save_state(pci_dev);
801                 goto Fixup;
802         }
803
804         if (pm->suspend_noirq) {
805                 pci_power_t prev = pci_dev->current_state;
806                 int error;
807
808                 error = pm->suspend_noirq(dev);
809                 suspend_report_result(pm->suspend_noirq, error);
810                 if (error)
811                         return error;
812
813                 if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
814                     && pci_dev->current_state != PCI_UNKNOWN) {
815                         WARN_ONCE(pci_dev->current_state != prev,
816                                 "PCI PM: State of device not saved by %pF\n",
817                                 pm->suspend_noirq);
818                         goto Fixup;
819                 }
820         }
821
822         if (!pci_dev->state_saved) {
823                 pci_save_state(pci_dev);
824                 if (pci_power_manageable(pci_dev))
825                         pci_prepare_to_sleep(pci_dev);
826         }
827
828         pci_pm_set_unknown_state(pci_dev);
829
830         /*
831          * Some BIOSes from ASUS have a bug: If a USB EHCI host controller's
832          * PCI COMMAND register isn't 0, the BIOS assumes that the controller
833          * hasn't been quiesced and tries to turn it off.  If the controller
834          * is already in D3, this can hang or cause memory corruption.
835          *
836          * Since the value of the COMMAND register doesn't matter once the
837          * device has been suspended, we can safely set it to 0 here.
838          */
839         if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
840                 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
841
842 Fixup:
843         pci_fixup_device(pci_fixup_suspend_late, pci_dev);
844
845         return 0;
846 }
847
848 static int pci_pm_resume_noirq(struct device *dev)
849 {
850         struct pci_dev *pci_dev = to_pci_dev(dev);
851         struct device_driver *drv = dev->driver;
852         int error = 0;
853
854         /*
855          * Devices with DPM_FLAG_SMART_SUSPEND may be left in runtime suspend
856          * during system suspend, so update their runtime PM status to "active"
857          * as they are going to be put into D0 shortly.
858          */
859         if (dev_pm_smart_suspend_and_suspended(dev))
860                 pm_runtime_set_active(dev);
861
862         pci_pm_default_resume_early(pci_dev);
863
864         if (pci_has_legacy_pm_support(pci_dev))
865                 return pci_legacy_resume_early(dev);
866
867         if (drv && drv->pm && drv->pm->resume_noirq)
868                 error = drv->pm->resume_noirq(dev);
869
870         return error;
871 }
872
873 static int pci_pm_resume(struct device *dev)
874 {
875         struct pci_dev *pci_dev = to_pci_dev(dev);
876         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
877         int error = 0;
878
879         /*
880          * This is necessary for the suspend error path in which resume is
881          * called without restoring the standard config registers of the device.
882          */
883         if (pci_dev->state_saved)
884                 pci_restore_standard_config(pci_dev);
885
886         if (pci_has_legacy_pm_support(pci_dev))
887                 return pci_legacy_resume(dev);
888
889         pci_pm_default_resume(pci_dev);
890
891         if (pm) {
892                 if (pm->resume)
893                         error = pm->resume(dev);
894         } else {
895                 pci_pm_reenable_device(pci_dev);
896         }
897
898         return error;
899 }
900
901 #else /* !CONFIG_SUSPEND */
902
903 #define pci_pm_suspend          NULL
904 #define pci_pm_suspend_late     NULL
905 #define pci_pm_suspend_noirq    NULL
906 #define pci_pm_resume           NULL
907 #define pci_pm_resume_noirq     NULL
908
909 #endif /* !CONFIG_SUSPEND */
910
911 #ifdef CONFIG_HIBERNATE_CALLBACKS
912
913
914 /*
915  * pcibios_pm_ops - provide arch-specific hooks when a PCI device is doing
916  * a hibernate transition
917  */
918 struct dev_pm_ops __weak pcibios_pm_ops;
919
920 static int pci_pm_freeze(struct device *dev)
921 {
922         struct pci_dev *pci_dev = to_pci_dev(dev);
923         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
924
925         if (pci_has_legacy_pm_support(pci_dev))
926                 return pci_legacy_suspend(dev, PMSG_FREEZE);
927
928         if (!pm) {
929                 pci_pm_default_suspend(pci_dev);
930                 return 0;
931         }
932
933         /*
934          * This used to be done in pci_pm_prepare() for all devices and some
935          * drivers may depend on it, so do it here.  Ideally, runtime-suspended
936          * devices should not be touched during freeze/thaw transitions,
937          * however.
938          */
939         if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND))
940                 pm_runtime_resume(dev);
941
942         pci_dev->state_saved = false;
943         if (pm->freeze) {
944                 int error;
945
946                 error = pm->freeze(dev);
947                 suspend_report_result(pm->freeze, error);
948                 if (error)
949                         return error;
950         }
951
952         return 0;
953 }
954
955 static int pci_pm_freeze_late(struct device *dev)
956 {
957         if (dev_pm_smart_suspend_and_suspended(dev))
958                 return 0;
959
960         return pm_generic_freeze_late(dev);;
961 }
962
963 static int pci_pm_freeze_noirq(struct device *dev)
964 {
965         struct pci_dev *pci_dev = to_pci_dev(dev);
966         struct device_driver *drv = dev->driver;
967
968         if (dev_pm_smart_suspend_and_suspended(dev))
969                 return 0;
970
971         if (pci_has_legacy_pm_support(pci_dev))
972                 return pci_legacy_suspend_late(dev, PMSG_FREEZE);
973
974         if (drv && drv->pm && drv->pm->freeze_noirq) {
975                 int error;
976
977                 error = drv->pm->freeze_noirq(dev);
978                 suspend_report_result(drv->pm->freeze_noirq, error);
979                 if (error)
980                         return error;
981         }
982
983         if (!pci_dev->state_saved)
984                 pci_save_state(pci_dev);
985
986         pci_pm_set_unknown_state(pci_dev);
987
988         if (pcibios_pm_ops.freeze_noirq)
989                 return pcibios_pm_ops.freeze_noirq(dev);
990
991         return 0;
992 }
993
994 static int pci_pm_thaw_noirq(struct device *dev)
995 {
996         struct pci_dev *pci_dev = to_pci_dev(dev);
997         struct device_driver *drv = dev->driver;
998         int error = 0;
999
1000         /*
1001          * If the device is in runtime suspend, the code below may not work
1002          * correctly with it, so skip that code and make the PM core skip all of
1003          * the subsequent "thaw" callbacks for the device.
1004          */
1005         if (dev_pm_smart_suspend_and_suspended(dev)) {
1006                 dev->power.direct_complete = true;
1007                 return 0;
1008         }
1009
1010         if (pcibios_pm_ops.thaw_noirq) {
1011                 error = pcibios_pm_ops.thaw_noirq(dev);
1012                 if (error)
1013                         return error;
1014         }
1015
1016         if (pci_has_legacy_pm_support(pci_dev))
1017                 return pci_legacy_resume_early(dev);
1018
1019         pci_update_current_state(pci_dev, PCI_D0);
1020         pci_restore_state(pci_dev);
1021
1022         if (drv && drv->pm && drv->pm->thaw_noirq)
1023                 error = drv->pm->thaw_noirq(dev);
1024
1025         return error;
1026 }
1027
1028 static int pci_pm_thaw(struct device *dev)
1029 {
1030         struct pci_dev *pci_dev = to_pci_dev(dev);
1031         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1032         int error = 0;
1033
1034         if (pci_has_legacy_pm_support(pci_dev))
1035                 return pci_legacy_resume(dev);
1036
1037         if (pm) {
1038                 if (pm->thaw)
1039                         error = pm->thaw(dev);
1040         } else {
1041                 pci_pm_reenable_device(pci_dev);
1042         }
1043
1044         pci_dev->state_saved = false;
1045
1046         return error;
1047 }
1048
1049 static int pci_pm_poweroff(struct device *dev)
1050 {
1051         struct pci_dev *pci_dev = to_pci_dev(dev);
1052         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1053
1054         if (pci_has_legacy_pm_support(pci_dev))
1055                 return pci_legacy_suspend(dev, PMSG_HIBERNATE);
1056
1057         if (!pm) {
1058                 pci_pm_default_suspend(pci_dev);
1059                 return 0;
1060         }
1061
1062         /* The reason to do that is the same as in pci_pm_suspend(). */
1063         if (!dev_pm_test_driver_flags(dev, DPM_FLAG_SMART_SUSPEND) ||
1064             !pci_dev_keep_suspended(pci_dev))
1065                 pm_runtime_resume(dev);
1066
1067         pci_dev->state_saved = false;
1068         if (pm->poweroff) {
1069                 int error;
1070
1071                 error = pm->poweroff(dev);
1072                 suspend_report_result(pm->poweroff, error);
1073                 if (error)
1074                         return error;
1075         }
1076
1077         return 0;
1078 }
1079
1080 static int pci_pm_poweroff_late(struct device *dev)
1081 {
1082         if (dev_pm_smart_suspend_and_suspended(dev))
1083                 return 0;
1084
1085         pci_fixup_device(pci_fixup_suspend, to_pci_dev(dev));
1086
1087         return pm_generic_poweroff_late(dev);
1088 }
1089
1090 static int pci_pm_poweroff_noirq(struct device *dev)
1091 {
1092         struct pci_dev *pci_dev = to_pci_dev(dev);
1093         struct device_driver *drv = dev->driver;
1094
1095         if (dev_pm_smart_suspend_and_suspended(dev))
1096                 return 0;
1097
1098         if (pci_has_legacy_pm_support(to_pci_dev(dev)))
1099                 return pci_legacy_suspend_late(dev, PMSG_HIBERNATE);
1100
1101         if (!drv || !drv->pm) {
1102                 pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1103                 return 0;
1104         }
1105
1106         if (drv->pm->poweroff_noirq) {
1107                 int error;
1108
1109                 error = drv->pm->poweroff_noirq(dev);
1110                 suspend_report_result(drv->pm->poweroff_noirq, error);
1111                 if (error)
1112                         return error;
1113         }
1114
1115         if (!pci_dev->state_saved && !pci_has_subordinate(pci_dev))
1116                 pci_prepare_to_sleep(pci_dev);
1117
1118         /*
1119          * The reason for doing this here is the same as for the analogous code
1120          * in pci_pm_suspend_noirq().
1121          */
1122         if (pci_dev->class == PCI_CLASS_SERIAL_USB_EHCI)
1123                 pci_write_config_word(pci_dev, PCI_COMMAND, 0);
1124
1125         pci_fixup_device(pci_fixup_suspend_late, pci_dev);
1126
1127         if (pcibios_pm_ops.poweroff_noirq)
1128                 return pcibios_pm_ops.poweroff_noirq(dev);
1129
1130         return 0;
1131 }
1132
1133 static int pci_pm_restore_noirq(struct device *dev)
1134 {
1135         struct pci_dev *pci_dev = to_pci_dev(dev);
1136         struct device_driver *drv = dev->driver;
1137         int error = 0;
1138
1139         /* This is analogous to the pci_pm_resume_noirq() case. */
1140         if (dev_pm_smart_suspend_and_suspended(dev))
1141                 pm_runtime_set_active(dev);
1142
1143         if (pcibios_pm_ops.restore_noirq) {
1144                 error = pcibios_pm_ops.restore_noirq(dev);
1145                 if (error)
1146                         return error;
1147         }
1148
1149         pci_pm_default_resume_early(pci_dev);
1150
1151         if (pci_has_legacy_pm_support(pci_dev))
1152                 return pci_legacy_resume_early(dev);
1153
1154         if (drv && drv->pm && drv->pm->restore_noirq)
1155                 error = drv->pm->restore_noirq(dev);
1156
1157         return error;
1158 }
1159
1160 static int pci_pm_restore(struct device *dev)
1161 {
1162         struct pci_dev *pci_dev = to_pci_dev(dev);
1163         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1164         int error = 0;
1165
1166         /*
1167          * This is necessary for the hibernation error path in which restore is
1168          * called without restoring the standard config registers of the device.
1169          */
1170         if (pci_dev->state_saved)
1171                 pci_restore_standard_config(pci_dev);
1172
1173         if (pci_has_legacy_pm_support(pci_dev))
1174                 return pci_legacy_resume(dev);
1175
1176         pci_pm_default_resume(pci_dev);
1177
1178         if (pm) {
1179                 if (pm->restore)
1180                         error = pm->restore(dev);
1181         } else {
1182                 pci_pm_reenable_device(pci_dev);
1183         }
1184
1185         return error;
1186 }
1187
1188 #else /* !CONFIG_HIBERNATE_CALLBACKS */
1189
1190 #define pci_pm_freeze           NULL
1191 #define pci_pm_freeze_late      NULL
1192 #define pci_pm_freeze_noirq     NULL
1193 #define pci_pm_thaw             NULL
1194 #define pci_pm_thaw_noirq       NULL
1195 #define pci_pm_poweroff         NULL
1196 #define pci_pm_poweroff_late    NULL
1197 #define pci_pm_poweroff_noirq   NULL
1198 #define pci_pm_restore          NULL
1199 #define pci_pm_restore_noirq    NULL
1200
1201 #endif /* !CONFIG_HIBERNATE_CALLBACKS */
1202
1203 #ifdef CONFIG_PM
1204
1205 static int pci_pm_runtime_suspend(struct device *dev)
1206 {
1207         struct pci_dev *pci_dev = to_pci_dev(dev);
1208         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1209         pci_power_t prev = pci_dev->current_state;
1210         int error;
1211
1212         /*
1213          * If pci_dev->driver is not set (unbound), the device should
1214          * always remain in D0 regardless of the runtime PM status
1215          */
1216         if (!pci_dev->driver)
1217                 return 0;
1218
1219         if (!pm || !pm->runtime_suspend)
1220                 return -ENOSYS;
1221
1222         pci_dev->state_saved = false;
1223         error = pm->runtime_suspend(dev);
1224         if (error) {
1225                 /*
1226                  * -EBUSY and -EAGAIN is used to request the runtime PM core
1227                  * to schedule a new suspend, so log the event only with debug
1228                  * log level.
1229                  */
1230                 if (error == -EBUSY || error == -EAGAIN)
1231                         dev_dbg(dev, "can't suspend now (%pf returned %d)\n",
1232                                 pm->runtime_suspend, error);
1233                 else
1234                         dev_err(dev, "can't suspend (%pf returned %d)\n",
1235                                 pm->runtime_suspend, error);
1236
1237                 return error;
1238         }
1239
1240         pci_fixup_device(pci_fixup_suspend, pci_dev);
1241
1242         if (!pci_dev->state_saved && pci_dev->current_state != PCI_D0
1243             && pci_dev->current_state != PCI_UNKNOWN) {
1244                 WARN_ONCE(pci_dev->current_state != prev,
1245                         "PCI PM: State of device not saved by %pF\n",
1246                         pm->runtime_suspend);
1247                 return 0;
1248         }
1249
1250         if (!pci_dev->state_saved) {
1251                 pci_save_state(pci_dev);
1252                 pci_finish_runtime_suspend(pci_dev);
1253         }
1254
1255         return 0;
1256 }
1257
1258 static int pci_pm_runtime_resume(struct device *dev)
1259 {
1260         int rc;
1261         struct pci_dev *pci_dev = to_pci_dev(dev);
1262         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1263
1264         /*
1265          * If pci_dev->driver is not set (unbound), the device should
1266          * always remain in D0 regardless of the runtime PM status
1267          */
1268         if (!pci_dev->driver)
1269                 return 0;
1270
1271         if (!pm || !pm->runtime_resume)
1272                 return -ENOSYS;
1273
1274         pci_restore_standard_config(pci_dev);
1275         pci_fixup_device(pci_fixup_resume_early, pci_dev);
1276         pci_enable_wake(pci_dev, PCI_D0, false);
1277         pci_fixup_device(pci_fixup_resume, pci_dev);
1278
1279         rc = pm->runtime_resume(dev);
1280
1281         pci_dev->runtime_d3cold = false;
1282
1283         return rc;
1284 }
1285
1286 static int pci_pm_runtime_idle(struct device *dev)
1287 {
1288         struct pci_dev *pci_dev = to_pci_dev(dev);
1289         const struct dev_pm_ops *pm = dev->driver ? dev->driver->pm : NULL;
1290         int ret = 0;
1291
1292         /*
1293          * If pci_dev->driver is not set (unbound), the device should
1294          * always remain in D0 regardless of the runtime PM status
1295          */
1296         if (!pci_dev->driver)
1297                 return 0;
1298
1299         if (!pm)
1300                 return -ENOSYS;
1301
1302         if (pm->runtime_idle)
1303                 ret = pm->runtime_idle(dev);
1304
1305         return ret;
1306 }
1307
1308 static const struct dev_pm_ops pci_dev_pm_ops = {
1309         .prepare = pci_pm_prepare,
1310         .complete = pci_pm_complete,
1311         .suspend = pci_pm_suspend,
1312         .suspend_late = pci_pm_suspend_late,
1313         .resume = pci_pm_resume,
1314         .freeze = pci_pm_freeze,
1315         .freeze_late = pci_pm_freeze_late,
1316         .thaw = pci_pm_thaw,
1317         .poweroff = pci_pm_poweroff,
1318         .poweroff_late = pci_pm_poweroff_late,
1319         .restore = pci_pm_restore,
1320         .suspend_noirq = pci_pm_suspend_noirq,
1321         .resume_noirq = pci_pm_resume_noirq,
1322         .freeze_noirq = pci_pm_freeze_noirq,
1323         .thaw_noirq = pci_pm_thaw_noirq,
1324         .poweroff_noirq = pci_pm_poweroff_noirq,
1325         .restore_noirq = pci_pm_restore_noirq,
1326         .runtime_suspend = pci_pm_runtime_suspend,
1327         .runtime_resume = pci_pm_runtime_resume,
1328         .runtime_idle = pci_pm_runtime_idle,
1329 };
1330
1331 #define PCI_PM_OPS_PTR  (&pci_dev_pm_ops)
1332
1333 #else /* !CONFIG_PM */
1334
1335 #define pci_pm_runtime_suspend  NULL
1336 #define pci_pm_runtime_resume   NULL
1337 #define pci_pm_runtime_idle     NULL
1338
1339 #define PCI_PM_OPS_PTR  NULL
1340
1341 #endif /* !CONFIG_PM */
1342
1343 /**
1344  * __pci_register_driver - register a new pci driver
1345  * @drv: the driver structure to register
1346  * @owner: owner module of drv
1347  * @mod_name: module name string
1348  *
1349  * Adds the driver structure to the list of registered drivers.
1350  * Returns a negative value on error, otherwise 0.
1351  * If no error occurred, the driver remains registered even if
1352  * no device was claimed during registration.
1353  */
1354 int __pci_register_driver(struct pci_driver *drv, struct module *owner,
1355                           const char *mod_name)
1356 {
1357         /* initialize common driver fields */
1358         drv->driver.name = drv->name;
1359         drv->driver.bus = &pci_bus_type;
1360         drv->driver.owner = owner;
1361         drv->driver.mod_name = mod_name;
1362         drv->driver.groups = drv->groups;
1363
1364         spin_lock_init(&drv->dynids.lock);
1365         INIT_LIST_HEAD(&drv->dynids.list);
1366
1367         /* register with core */
1368         return driver_register(&drv->driver);
1369 }
1370 EXPORT_SYMBOL(__pci_register_driver);
1371
1372 /**
1373  * pci_unregister_driver - unregister a pci driver
1374  * @drv: the driver structure to unregister
1375  *
1376  * Deletes the driver structure from the list of registered PCI drivers,
1377  * gives it a chance to clean up by calling its remove() function for
1378  * each device it was responsible for, and marks those devices as
1379  * driverless.
1380  */
1381
1382 void pci_unregister_driver(struct pci_driver *drv)
1383 {
1384         driver_unregister(&drv->driver);
1385         pci_free_dynids(drv);
1386 }
1387 EXPORT_SYMBOL(pci_unregister_driver);
1388
1389 static struct pci_driver pci_compat_driver = {
1390         .name = "compat"
1391 };
1392
1393 /**
1394  * pci_dev_driver - get the pci_driver of a device
1395  * @dev: the device to query
1396  *
1397  * Returns the appropriate pci_driver structure or %NULL if there is no
1398  * registered driver for the device.
1399  */
1400 struct pci_driver *pci_dev_driver(const struct pci_dev *dev)
1401 {
1402         if (dev->driver)
1403                 return dev->driver;
1404         else {
1405                 int i;
1406                 for (i = 0; i <= PCI_ROM_RESOURCE; i++)
1407                         if (dev->resource[i].flags & IORESOURCE_BUSY)
1408                                 return &pci_compat_driver;
1409         }
1410         return NULL;
1411 }
1412 EXPORT_SYMBOL(pci_dev_driver);
1413
1414 /**
1415  * pci_bus_match - Tell if a PCI device structure has a matching PCI device id structure
1416  * @dev: the PCI device structure to match against
1417  * @drv: the device driver to search for matching PCI device id structures
1418  *
1419  * Used by a driver to check whether a PCI device present in the
1420  * system is in its list of supported devices. Returns the matching
1421  * pci_device_id structure or %NULL if there is no match.
1422  */
1423 static int pci_bus_match(struct device *dev, struct device_driver *drv)
1424 {
1425         struct pci_dev *pci_dev = to_pci_dev(dev);
1426         struct pci_driver *pci_drv;
1427         const struct pci_device_id *found_id;
1428
1429         if (!pci_dev->match_driver)
1430                 return 0;
1431
1432         pci_drv = to_pci_driver(drv);
1433         found_id = pci_match_device(pci_drv, pci_dev);
1434         if (found_id)
1435                 return 1;
1436
1437         return 0;
1438 }
1439
1440 /**
1441  * pci_dev_get - increments the reference count of the pci device structure
1442  * @dev: the device being referenced
1443  *
1444  * Each live reference to a device should be refcounted.
1445  *
1446  * Drivers for PCI devices should normally record such references in
1447  * their probe() methods, when they bind to a device, and release
1448  * them by calling pci_dev_put(), in their disconnect() methods.
1449  *
1450  * A pointer to the device with the incremented reference counter is returned.
1451  */
1452 struct pci_dev *pci_dev_get(struct pci_dev *dev)
1453 {
1454         if (dev)
1455                 get_device(&dev->dev);
1456         return dev;
1457 }
1458 EXPORT_SYMBOL(pci_dev_get);
1459
1460 /**
1461  * pci_dev_put - release a use of the pci device structure
1462  * @dev: device that's been disconnected
1463  *
1464  * Must be called when a user of a device is finished with it.  When the last
1465  * user of the device calls this function, the memory of the device is freed.
1466  */
1467 void pci_dev_put(struct pci_dev *dev)
1468 {
1469         if (dev)
1470                 put_device(&dev->dev);
1471 }
1472 EXPORT_SYMBOL(pci_dev_put);
1473
1474 static int pci_uevent(struct device *dev, struct kobj_uevent_env *env)
1475 {
1476         struct pci_dev *pdev;
1477
1478         if (!dev)
1479                 return -ENODEV;
1480
1481         pdev = to_pci_dev(dev);
1482
1483         if (add_uevent_var(env, "PCI_CLASS=%04X", pdev->class))
1484                 return -ENOMEM;
1485
1486         if (add_uevent_var(env, "PCI_ID=%04X:%04X", pdev->vendor, pdev->device))
1487                 return -ENOMEM;
1488
1489         if (add_uevent_var(env, "PCI_SUBSYS_ID=%04X:%04X", pdev->subsystem_vendor,
1490                            pdev->subsystem_device))
1491                 return -ENOMEM;
1492
1493         if (add_uevent_var(env, "PCI_SLOT_NAME=%s", pci_name(pdev)))
1494                 return -ENOMEM;
1495
1496         if (add_uevent_var(env, "MODALIAS=pci:v%08Xd%08Xsv%08Xsd%08Xbc%02Xsc%02Xi%02X",
1497                            pdev->vendor, pdev->device,
1498                            pdev->subsystem_vendor, pdev->subsystem_device,
1499                            (u8)(pdev->class >> 16), (u8)(pdev->class >> 8),
1500                            (u8)(pdev->class)))
1501                 return -ENOMEM;
1502
1503         return 0;
1504 }
1505
1506 static int pci_bus_num_vf(struct device *dev)
1507 {
1508         return pci_num_vf(to_pci_dev(dev));
1509 }
1510
1511 struct bus_type pci_bus_type = {
1512         .name           = "pci",
1513         .match          = pci_bus_match,
1514         .uevent         = pci_uevent,
1515         .probe          = pci_device_probe,
1516         .remove         = pci_device_remove,
1517         .shutdown       = pci_device_shutdown,
1518         .dev_groups     = pci_dev_groups,
1519         .bus_groups     = pci_bus_groups,
1520         .drv_groups     = pci_drv_groups,
1521         .pm             = PCI_PM_OPS_PTR,
1522         .num_vf         = pci_bus_num_vf,
1523 };
1524 EXPORT_SYMBOL(pci_bus_type);
1525
1526 static int __init pci_driver_init(void)
1527 {
1528         return bus_register(&pci_bus_type);
1529 }
1530 postcore_initcall(pci_driver_init);