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