GNU Linux-libre 5.4.241-gnu1
[releases.git] / drivers / pci / pci.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * PCI Bus Services, see include/linux/pci.h for further explanation.
4  *
5  * Copyright 1993 -- 1997 Drew Eckhardt, Frederic Potter,
6  * David Mosberger-Tang
7  *
8  * Copyright 1997 -- 2000 Martin Mares <mj@ucw.cz>
9  */
10
11 #include <linux/acpi.h>
12 #include <linux/kernel.h>
13 #include <linux/delay.h>
14 #include <linux/dmi.h>
15 #include <linux/init.h>
16 #include <linux/of.h>
17 #include <linux/of_pci.h>
18 #include <linux/pci.h>
19 #include <linux/pm.h>
20 #include <linux/slab.h>
21 #include <linux/module.h>
22 #include <linux/spinlock.h>
23 #include <linux/string.h>
24 #include <linux/log2.h>
25 #include <linux/logic_pio.h>
26 #include <linux/pm_wakeup.h>
27 #include <linux/interrupt.h>
28 #include <linux/device.h>
29 #include <linux/pm_runtime.h>
30 #include <linux/pci_hotplug.h>
31 #include <linux/vmalloc.h>
32 #include <linux/pci-ats.h>
33 #include <asm/setup.h>
34 #include <asm/dma.h>
35 #include <linux/aer.h>
36 #include "pci.h"
37
38 DEFINE_MUTEX(pci_slot_mutex);
39
40 const char *pci_power_names[] = {
41         "error", "D0", "D1", "D2", "D3hot", "D3cold", "unknown",
42 };
43 EXPORT_SYMBOL_GPL(pci_power_names);
44
45 int isa_dma_bridge_buggy;
46 EXPORT_SYMBOL(isa_dma_bridge_buggy);
47
48 int pci_pci_problems;
49 EXPORT_SYMBOL(pci_pci_problems);
50
51 unsigned int pci_pm_d3_delay;
52
53 static void pci_pme_list_scan(struct work_struct *work);
54
55 static LIST_HEAD(pci_pme_list);
56 static DEFINE_MUTEX(pci_pme_list_mutex);
57 static DECLARE_DELAYED_WORK(pci_pme_work, pci_pme_list_scan);
58
59 struct pci_pme_device {
60         struct list_head list;
61         struct pci_dev *dev;
62 };
63
64 #define PME_TIMEOUT 1000 /* How long between PME checks */
65
66 static void pci_dev_d3_sleep(struct pci_dev *dev)
67 {
68         unsigned int delay = dev->d3_delay;
69
70         if (delay < pci_pm_d3_delay)
71                 delay = pci_pm_d3_delay;
72
73         if (delay)
74                 msleep(delay);
75 }
76
77 #ifdef CONFIG_PCI_DOMAINS
78 int pci_domains_supported = 1;
79 #endif
80
81 #define DEFAULT_CARDBUS_IO_SIZE         (256)
82 #define DEFAULT_CARDBUS_MEM_SIZE        (64*1024*1024)
83 /* pci=cbmemsize=nnM,cbiosize=nn can override this */
84 unsigned long pci_cardbus_io_size = DEFAULT_CARDBUS_IO_SIZE;
85 unsigned long pci_cardbus_mem_size = DEFAULT_CARDBUS_MEM_SIZE;
86
87 #define DEFAULT_HOTPLUG_IO_SIZE         (256)
88 #define DEFAULT_HOTPLUG_MEM_SIZE        (2*1024*1024)
89 /* pci=hpmemsize=nnM,hpiosize=nn can override this */
90 unsigned long pci_hotplug_io_size  = DEFAULT_HOTPLUG_IO_SIZE;
91 unsigned long pci_hotplug_mem_size = DEFAULT_HOTPLUG_MEM_SIZE;
92
93 #define DEFAULT_HOTPLUG_BUS_SIZE        1
94 unsigned long pci_hotplug_bus_size = DEFAULT_HOTPLUG_BUS_SIZE;
95
96 enum pcie_bus_config_types pcie_bus_config = PCIE_BUS_DEFAULT;
97
98 /*
99  * The default CLS is used if arch didn't set CLS explicitly and not
100  * all pci devices agree on the same value.  Arch can override either
101  * the dfl or actual value as it sees fit.  Don't forget this is
102  * measured in 32-bit words, not bytes.
103  */
104 u8 pci_dfl_cache_line_size = L1_CACHE_BYTES >> 2;
105 u8 pci_cache_line_size;
106
107 /*
108  * If we set up a device for bus mastering, we need to check the latency
109  * timer as certain BIOSes forget to set it properly.
110  */
111 unsigned int pcibios_max_latency = 255;
112
113 /* If set, the PCIe ARI capability will not be used. */
114 static bool pcie_ari_disabled;
115
116 /* If set, the PCIe ATS capability will not be used. */
117 static bool pcie_ats_disabled;
118
119 /* If set, the PCI config space of each device is printed during boot. */
120 bool pci_early_dump;
121
122 bool pci_ats_disabled(void)
123 {
124         return pcie_ats_disabled;
125 }
126
127 /* Disable bridge_d3 for all PCIe ports */
128 static bool pci_bridge_d3_disable;
129 /* Force bridge_d3 for all PCIe ports */
130 static bool pci_bridge_d3_force;
131
132 static int __init pcie_port_pm_setup(char *str)
133 {
134         if (!strcmp(str, "off"))
135                 pci_bridge_d3_disable = true;
136         else if (!strcmp(str, "force"))
137                 pci_bridge_d3_force = true;
138         return 1;
139 }
140 __setup("pcie_port_pm=", pcie_port_pm_setup);
141
142 /* Time to wait after a reset for device to become responsive */
143 #define PCIE_RESET_READY_POLL_MS 60000
144
145 /**
146  * pci_bus_max_busnr - returns maximum PCI bus number of given bus' children
147  * @bus: pointer to PCI bus structure to search
148  *
149  * Given a PCI bus, returns the highest PCI bus number present in the set
150  * including the given PCI bus and its list of child PCI buses.
151  */
152 unsigned char pci_bus_max_busnr(struct pci_bus *bus)
153 {
154         struct pci_bus *tmp;
155         unsigned char max, n;
156
157         max = bus->busn_res.end;
158         list_for_each_entry(tmp, &bus->children, node) {
159                 n = pci_bus_max_busnr(tmp);
160                 if (n > max)
161                         max = n;
162         }
163         return max;
164 }
165 EXPORT_SYMBOL_GPL(pci_bus_max_busnr);
166
167 #ifdef CONFIG_HAS_IOMEM
168 void __iomem *pci_ioremap_bar(struct pci_dev *pdev, int bar)
169 {
170         struct resource *res = &pdev->resource[bar];
171
172         /*
173          * Make sure the BAR is actually a memory resource, not an IO resource
174          */
175         if (res->flags & IORESOURCE_UNSET || !(res->flags & IORESOURCE_MEM)) {
176                 pci_warn(pdev, "can't ioremap BAR %d: %pR\n", bar, res);
177                 return NULL;
178         }
179         return ioremap_nocache(res->start, resource_size(res));
180 }
181 EXPORT_SYMBOL_GPL(pci_ioremap_bar);
182
183 void __iomem *pci_ioremap_wc_bar(struct pci_dev *pdev, int bar)
184 {
185         /*
186          * Make sure the BAR is actually a memory resource, not an IO resource
187          */
188         if (!(pci_resource_flags(pdev, bar) & IORESOURCE_MEM)) {
189                 WARN_ON(1);
190                 return NULL;
191         }
192         return ioremap_wc(pci_resource_start(pdev, bar),
193                           pci_resource_len(pdev, bar));
194 }
195 EXPORT_SYMBOL_GPL(pci_ioremap_wc_bar);
196 #endif
197
198 /**
199  * pci_dev_str_match_path - test if a path string matches a device
200  * @dev: the PCI device to test
201  * @path: string to match the device against
202  * @endptr: pointer to the string after the match
203  *
204  * Test if a string (typically from a kernel parameter) formatted as a
205  * path of device/function addresses matches a PCI device. The string must
206  * be of the form:
207  *
208  *   [<domain>:]<bus>:<device>.<func>[/<device>.<func>]*
209  *
210  * A path for a device can be obtained using 'lspci -t'.  Using a path
211  * is more robust against bus renumbering than using only a single bus,
212  * device and function address.
213  *
214  * Returns 1 if the string matches the device, 0 if it does not and
215  * a negative error code if it fails to parse the string.
216  */
217 static int pci_dev_str_match_path(struct pci_dev *dev, const char *path,
218                                   const char **endptr)
219 {
220         int ret;
221         int seg, bus, slot, func;
222         char *wpath, *p;
223         char end;
224
225         *endptr = strchrnul(path, ';');
226
227         wpath = kmemdup_nul(path, *endptr - path, GFP_ATOMIC);
228         if (!wpath)
229                 return -ENOMEM;
230
231         while (1) {
232                 p = strrchr(wpath, '/');
233                 if (!p)
234                         break;
235                 ret = sscanf(p, "/%x.%x%c", &slot, &func, &end);
236                 if (ret != 2) {
237                         ret = -EINVAL;
238                         goto free_and_exit;
239                 }
240
241                 if (dev->devfn != PCI_DEVFN(slot, func)) {
242                         ret = 0;
243                         goto free_and_exit;
244                 }
245
246                 /*
247                  * Note: we don't need to get a reference to the upstream
248                  * bridge because we hold a reference to the top level
249                  * device which should hold a reference to the bridge,
250                  * and so on.
251                  */
252                 dev = pci_upstream_bridge(dev);
253                 if (!dev) {
254                         ret = 0;
255                         goto free_and_exit;
256                 }
257
258                 *p = 0;
259         }
260
261         ret = sscanf(wpath, "%x:%x:%x.%x%c", &seg, &bus, &slot,
262                      &func, &end);
263         if (ret != 4) {
264                 seg = 0;
265                 ret = sscanf(wpath, "%x:%x.%x%c", &bus, &slot, &func, &end);
266                 if (ret != 3) {
267                         ret = -EINVAL;
268                         goto free_and_exit;
269                 }
270         }
271
272         ret = (seg == pci_domain_nr(dev->bus) &&
273                bus == dev->bus->number &&
274                dev->devfn == PCI_DEVFN(slot, func));
275
276 free_and_exit:
277         kfree(wpath);
278         return ret;
279 }
280
281 /**
282  * pci_dev_str_match - test if a string matches a device
283  * @dev: the PCI device to test
284  * @p: string to match the device against
285  * @endptr: pointer to the string after the match
286  *
287  * Test if a string (typically from a kernel parameter) matches a specified
288  * PCI device. The string may be of one of the following formats:
289  *
290  *   [<domain>:]<bus>:<device>.<func>[/<device>.<func>]*
291  *   pci:<vendor>:<device>[:<subvendor>:<subdevice>]
292  *
293  * The first format specifies a PCI bus/device/function address which
294  * may change if new hardware is inserted, if motherboard firmware changes,
295  * or due to changes caused in kernel parameters. If the domain is
296  * left unspecified, it is taken to be 0.  In order to be robust against
297  * bus renumbering issues, a path of PCI device/function numbers may be used
298  * to address the specific device.  The path for a device can be determined
299  * through the use of 'lspci -t'.
300  *
301  * The second format matches devices using IDs in the configuration
302  * space which may match multiple devices in the system. A value of 0
303  * for any field will match all devices. (Note: this differs from
304  * in-kernel code that uses PCI_ANY_ID which is ~0; this is for
305  * legacy reasons and convenience so users don't have to specify
306  * FFFFFFFFs on the command line.)
307  *
308  * Returns 1 if the string matches the device, 0 if it does not and
309  * a negative error code if the string cannot be parsed.
310  */
311 static int pci_dev_str_match(struct pci_dev *dev, const char *p,
312                              const char **endptr)
313 {
314         int ret;
315         int count;
316         unsigned short vendor, device, subsystem_vendor, subsystem_device;
317
318         if (strncmp(p, "pci:", 4) == 0) {
319                 /* PCI vendor/device (subvendor/subdevice) IDs are specified */
320                 p += 4;
321                 ret = sscanf(p, "%hx:%hx:%hx:%hx%n", &vendor, &device,
322                              &subsystem_vendor, &subsystem_device, &count);
323                 if (ret != 4) {
324                         ret = sscanf(p, "%hx:%hx%n", &vendor, &device, &count);
325                         if (ret != 2)
326                                 return -EINVAL;
327
328                         subsystem_vendor = 0;
329                         subsystem_device = 0;
330                 }
331
332                 p += count;
333
334                 if ((!vendor || vendor == dev->vendor) &&
335                     (!device || device == dev->device) &&
336                     (!subsystem_vendor ||
337                             subsystem_vendor == dev->subsystem_vendor) &&
338                     (!subsystem_device ||
339                             subsystem_device == dev->subsystem_device))
340                         goto found;
341         } else {
342                 /*
343                  * PCI Bus, Device, Function IDs are specified
344                  * (optionally, may include a path of devfns following it)
345                  */
346                 ret = pci_dev_str_match_path(dev, p, &p);
347                 if (ret < 0)
348                         return ret;
349                 else if (ret)
350                         goto found;
351         }
352
353         *endptr = p;
354         return 0;
355
356 found:
357         *endptr = p;
358         return 1;
359 }
360
361 static int __pci_find_next_cap_ttl(struct pci_bus *bus, unsigned int devfn,
362                                    u8 pos, int cap, int *ttl)
363 {
364         u8 id;
365         u16 ent;
366
367         pci_bus_read_config_byte(bus, devfn, pos, &pos);
368
369         while ((*ttl)--) {
370                 if (pos < 0x40)
371                         break;
372                 pos &= ~3;
373                 pci_bus_read_config_word(bus, devfn, pos, &ent);
374
375                 id = ent & 0xff;
376                 if (id == 0xff)
377                         break;
378                 if (id == cap)
379                         return pos;
380                 pos = (ent >> 8);
381         }
382         return 0;
383 }
384
385 static int __pci_find_next_cap(struct pci_bus *bus, unsigned int devfn,
386                                u8 pos, int cap)
387 {
388         int ttl = PCI_FIND_CAP_TTL;
389
390         return __pci_find_next_cap_ttl(bus, devfn, pos, cap, &ttl);
391 }
392
393 int pci_find_next_capability(struct pci_dev *dev, u8 pos, int cap)
394 {
395         return __pci_find_next_cap(dev->bus, dev->devfn,
396                                    pos + PCI_CAP_LIST_NEXT, cap);
397 }
398 EXPORT_SYMBOL_GPL(pci_find_next_capability);
399
400 static int __pci_bus_find_cap_start(struct pci_bus *bus,
401                                     unsigned int devfn, u8 hdr_type)
402 {
403         u16 status;
404
405         pci_bus_read_config_word(bus, devfn, PCI_STATUS, &status);
406         if (!(status & PCI_STATUS_CAP_LIST))
407                 return 0;
408
409         switch (hdr_type) {
410         case PCI_HEADER_TYPE_NORMAL:
411         case PCI_HEADER_TYPE_BRIDGE:
412                 return PCI_CAPABILITY_LIST;
413         case PCI_HEADER_TYPE_CARDBUS:
414                 return PCI_CB_CAPABILITY_LIST;
415         }
416
417         return 0;
418 }
419
420 /**
421  * pci_find_capability - query for devices' capabilities
422  * @dev: PCI device to query
423  * @cap: capability code
424  *
425  * Tell if a device supports a given PCI capability.
426  * Returns the address of the requested capability structure within the
427  * device's PCI configuration space or 0 in case the device does not
428  * support it.  Possible values for @cap include:
429  *
430  *  %PCI_CAP_ID_PM           Power Management
431  *  %PCI_CAP_ID_AGP          Accelerated Graphics Port
432  *  %PCI_CAP_ID_VPD          Vital Product Data
433  *  %PCI_CAP_ID_SLOTID       Slot Identification
434  *  %PCI_CAP_ID_MSI          Message Signalled Interrupts
435  *  %PCI_CAP_ID_CHSWP        CompactPCI HotSwap
436  *  %PCI_CAP_ID_PCIX         PCI-X
437  *  %PCI_CAP_ID_EXP          PCI Express
438  */
439 int pci_find_capability(struct pci_dev *dev, int cap)
440 {
441         int pos;
442
443         pos = __pci_bus_find_cap_start(dev->bus, dev->devfn, dev->hdr_type);
444         if (pos)
445                 pos = __pci_find_next_cap(dev->bus, dev->devfn, pos, cap);
446
447         return pos;
448 }
449 EXPORT_SYMBOL(pci_find_capability);
450
451 /**
452  * pci_bus_find_capability - query for devices' capabilities
453  * @bus: the PCI bus to query
454  * @devfn: PCI device to query
455  * @cap: capability code
456  *
457  * Like pci_find_capability() but works for PCI devices that do not have a
458  * pci_dev structure set up yet.
459  *
460  * Returns the address of the requested capability structure within the
461  * device's PCI configuration space or 0 in case the device does not
462  * support it.
463  */
464 int pci_bus_find_capability(struct pci_bus *bus, unsigned int devfn, int cap)
465 {
466         int pos;
467         u8 hdr_type;
468
469         pci_bus_read_config_byte(bus, devfn, PCI_HEADER_TYPE, &hdr_type);
470
471         pos = __pci_bus_find_cap_start(bus, devfn, hdr_type & 0x7f);
472         if (pos)
473                 pos = __pci_find_next_cap(bus, devfn, pos, cap);
474
475         return pos;
476 }
477 EXPORT_SYMBOL(pci_bus_find_capability);
478
479 /**
480  * pci_find_next_ext_capability - Find an extended capability
481  * @dev: PCI device to query
482  * @start: address at which to start looking (0 to start at beginning of list)
483  * @cap: capability code
484  *
485  * Returns the address of the next matching extended capability structure
486  * within the device's PCI configuration space or 0 if the device does
487  * not support it.  Some capabilities can occur several times, e.g., the
488  * vendor-specific capability, and this provides a way to find them all.
489  */
490 int pci_find_next_ext_capability(struct pci_dev *dev, int start, int cap)
491 {
492         u32 header;
493         int ttl;
494         int pos = PCI_CFG_SPACE_SIZE;
495
496         /* minimum 8 bytes per capability */
497         ttl = (PCI_CFG_SPACE_EXP_SIZE - PCI_CFG_SPACE_SIZE) / 8;
498
499         if (dev->cfg_size <= PCI_CFG_SPACE_SIZE)
500                 return 0;
501
502         if (start)
503                 pos = start;
504
505         if (pci_read_config_dword(dev, pos, &header) != PCIBIOS_SUCCESSFUL)
506                 return 0;
507
508         /*
509          * If we have no capabilities, this is indicated by cap ID,
510          * cap version and next pointer all being 0.
511          */
512         if (header == 0)
513                 return 0;
514
515         while (ttl-- > 0) {
516                 if (PCI_EXT_CAP_ID(header) == cap && pos != start)
517                         return pos;
518
519                 pos = PCI_EXT_CAP_NEXT(header);
520                 if (pos < PCI_CFG_SPACE_SIZE)
521                         break;
522
523                 if (pci_read_config_dword(dev, pos, &header) != PCIBIOS_SUCCESSFUL)
524                         break;
525         }
526
527         return 0;
528 }
529 EXPORT_SYMBOL_GPL(pci_find_next_ext_capability);
530
531 /**
532  * pci_find_ext_capability - Find an extended capability
533  * @dev: PCI device to query
534  * @cap: capability code
535  *
536  * Returns the address of the requested extended capability structure
537  * within the device's PCI configuration space or 0 if the device does
538  * not support it.  Possible values for @cap include:
539  *
540  *  %PCI_EXT_CAP_ID_ERR         Advanced Error Reporting
541  *  %PCI_EXT_CAP_ID_VC          Virtual Channel
542  *  %PCI_EXT_CAP_ID_DSN         Device Serial Number
543  *  %PCI_EXT_CAP_ID_PWR         Power Budgeting
544  */
545 int pci_find_ext_capability(struct pci_dev *dev, int cap)
546 {
547         return pci_find_next_ext_capability(dev, 0, cap);
548 }
549 EXPORT_SYMBOL_GPL(pci_find_ext_capability);
550
551 static int __pci_find_next_ht_cap(struct pci_dev *dev, int pos, int ht_cap)
552 {
553         int rc, ttl = PCI_FIND_CAP_TTL;
554         u8 cap, mask;
555
556         if (ht_cap == HT_CAPTYPE_SLAVE || ht_cap == HT_CAPTYPE_HOST)
557                 mask = HT_3BIT_CAP_MASK;
558         else
559                 mask = HT_5BIT_CAP_MASK;
560
561         pos = __pci_find_next_cap_ttl(dev->bus, dev->devfn, pos,
562                                       PCI_CAP_ID_HT, &ttl);
563         while (pos) {
564                 rc = pci_read_config_byte(dev, pos + 3, &cap);
565                 if (rc != PCIBIOS_SUCCESSFUL)
566                         return 0;
567
568                 if ((cap & mask) == ht_cap)
569                         return pos;
570
571                 pos = __pci_find_next_cap_ttl(dev->bus, dev->devfn,
572                                               pos + PCI_CAP_LIST_NEXT,
573                                               PCI_CAP_ID_HT, &ttl);
574         }
575
576         return 0;
577 }
578 /**
579  * pci_find_next_ht_capability - query a device's Hypertransport capabilities
580  * @dev: PCI device to query
581  * @pos: Position from which to continue searching
582  * @ht_cap: Hypertransport capability code
583  *
584  * To be used in conjunction with pci_find_ht_capability() to search for
585  * all capabilities matching @ht_cap. @pos should always be a value returned
586  * from pci_find_ht_capability().
587  *
588  * NB. To be 100% safe against broken PCI devices, the caller should take
589  * steps to avoid an infinite loop.
590  */
591 int pci_find_next_ht_capability(struct pci_dev *dev, int pos, int ht_cap)
592 {
593         return __pci_find_next_ht_cap(dev, pos + PCI_CAP_LIST_NEXT, ht_cap);
594 }
595 EXPORT_SYMBOL_GPL(pci_find_next_ht_capability);
596
597 /**
598  * pci_find_ht_capability - query a device's Hypertransport capabilities
599  * @dev: PCI device to query
600  * @ht_cap: Hypertransport capability code
601  *
602  * Tell if a device supports a given Hypertransport capability.
603  * Returns an address within the device's PCI configuration space
604  * or 0 in case the device does not support the request capability.
605  * The address points to the PCI capability, of type PCI_CAP_ID_HT,
606  * which has a Hypertransport capability matching @ht_cap.
607  */
608 int pci_find_ht_capability(struct pci_dev *dev, int ht_cap)
609 {
610         int pos;
611
612         pos = __pci_bus_find_cap_start(dev->bus, dev->devfn, dev->hdr_type);
613         if (pos)
614                 pos = __pci_find_next_ht_cap(dev, pos, ht_cap);
615
616         return pos;
617 }
618 EXPORT_SYMBOL_GPL(pci_find_ht_capability);
619
620 /**
621  * pci_find_parent_resource - return resource region of parent bus of given
622  *                            region
623  * @dev: PCI device structure contains resources to be searched
624  * @res: child resource record for which parent is sought
625  *
626  * For given resource region of given device, return the resource region of
627  * parent bus the given region is contained in.
628  */
629 struct resource *pci_find_parent_resource(const struct pci_dev *dev,
630                                           struct resource *res)
631 {
632         const struct pci_bus *bus = dev->bus;
633         struct resource *r;
634         int i;
635
636         pci_bus_for_each_resource(bus, r, i) {
637                 if (!r)
638                         continue;
639                 if (resource_contains(r, res)) {
640
641                         /*
642                          * If the window is prefetchable but the BAR is
643                          * not, the allocator made a mistake.
644                          */
645                         if (r->flags & IORESOURCE_PREFETCH &&
646                             !(res->flags & IORESOURCE_PREFETCH))
647                                 return NULL;
648
649                         /*
650                          * If we're below a transparent bridge, there may
651                          * be both a positively-decoded aperture and a
652                          * subtractively-decoded region that contain the BAR.
653                          * We want the positively-decoded one, so this depends
654                          * on pci_bus_for_each_resource() giving us those
655                          * first.
656                          */
657                         return r;
658                 }
659         }
660         return NULL;
661 }
662 EXPORT_SYMBOL(pci_find_parent_resource);
663
664 /**
665  * pci_find_resource - Return matching PCI device resource
666  * @dev: PCI device to query
667  * @res: Resource to look for
668  *
669  * Goes over standard PCI resources (BARs) and checks if the given resource
670  * is partially or fully contained in any of them. In that case the
671  * matching resource is returned, %NULL otherwise.
672  */
673 struct resource *pci_find_resource(struct pci_dev *dev, struct resource *res)
674 {
675         int i;
676
677         for (i = 0; i < PCI_ROM_RESOURCE; i++) {
678                 struct resource *r = &dev->resource[i];
679
680                 if (r->start && resource_contains(r, res))
681                         return r;
682         }
683
684         return NULL;
685 }
686 EXPORT_SYMBOL(pci_find_resource);
687
688 /**
689  * pci_find_pcie_root_port - return PCIe Root Port
690  * @dev: PCI device to query
691  *
692  * Traverse up the parent chain and return the PCIe Root Port PCI Device
693  * for a given PCI Device.
694  */
695 struct pci_dev *pci_find_pcie_root_port(struct pci_dev *dev)
696 {
697         struct pci_dev *bridge, *highest_pcie_bridge = dev;
698
699         bridge = pci_upstream_bridge(dev);
700         while (bridge && pci_is_pcie(bridge)) {
701                 highest_pcie_bridge = bridge;
702                 bridge = pci_upstream_bridge(bridge);
703         }
704
705         if (pci_pcie_type(highest_pcie_bridge) != PCI_EXP_TYPE_ROOT_PORT)
706                 return NULL;
707
708         return highest_pcie_bridge;
709 }
710 EXPORT_SYMBOL(pci_find_pcie_root_port);
711
712 /**
713  * pci_wait_for_pending - wait for @mask bit(s) to clear in status word @pos
714  * @dev: the PCI device to operate on
715  * @pos: config space offset of status word
716  * @mask: mask of bit(s) to care about in status word
717  *
718  * Return 1 when mask bit(s) in status word clear, 0 otherwise.
719  */
720 int pci_wait_for_pending(struct pci_dev *dev, int pos, u16 mask)
721 {
722         int i;
723
724         /* Wait for Transaction Pending bit clean */
725         for (i = 0; i < 4; i++) {
726                 u16 status;
727                 if (i)
728                         msleep((1 << (i - 1)) * 100);
729
730                 pci_read_config_word(dev, pos, &status);
731                 if (!(status & mask))
732                         return 1;
733         }
734
735         return 0;
736 }
737
738 /**
739  * pci_restore_bars - restore a device's BAR values (e.g. after wake-up)
740  * @dev: PCI device to have its BARs restored
741  *
742  * Restore the BAR values for a given device, so as to make it
743  * accessible by its driver.
744  */
745 static void pci_restore_bars(struct pci_dev *dev)
746 {
747         int i;
748
749         for (i = 0; i < PCI_BRIDGE_RESOURCES; i++)
750                 pci_update_resource(dev, i);
751 }
752
753 static const struct pci_platform_pm_ops *pci_platform_pm;
754
755 int pci_set_platform_pm(const struct pci_platform_pm_ops *ops)
756 {
757         if (!ops->is_manageable || !ops->set_state  || !ops->get_state ||
758             !ops->choose_state  || !ops->set_wakeup || !ops->need_resume)
759                 return -EINVAL;
760         pci_platform_pm = ops;
761         return 0;
762 }
763
764 static inline bool platform_pci_power_manageable(struct pci_dev *dev)
765 {
766         return pci_platform_pm ? pci_platform_pm->is_manageable(dev) : false;
767 }
768
769 static inline int platform_pci_set_power_state(struct pci_dev *dev,
770                                                pci_power_t t)
771 {
772         return pci_platform_pm ? pci_platform_pm->set_state(dev, t) : -ENOSYS;
773 }
774
775 static inline pci_power_t platform_pci_get_power_state(struct pci_dev *dev)
776 {
777         return pci_platform_pm ? pci_platform_pm->get_state(dev) : PCI_UNKNOWN;
778 }
779
780 static inline void platform_pci_refresh_power_state(struct pci_dev *dev)
781 {
782         if (pci_platform_pm && pci_platform_pm->refresh_state)
783                 pci_platform_pm->refresh_state(dev);
784 }
785
786 static inline pci_power_t platform_pci_choose_state(struct pci_dev *dev)
787 {
788         return pci_platform_pm ?
789                         pci_platform_pm->choose_state(dev) : PCI_POWER_ERROR;
790 }
791
792 static inline int platform_pci_set_wakeup(struct pci_dev *dev, bool enable)
793 {
794         return pci_platform_pm ?
795                         pci_platform_pm->set_wakeup(dev, enable) : -ENODEV;
796 }
797
798 static inline bool platform_pci_need_resume(struct pci_dev *dev)
799 {
800         return pci_platform_pm ? pci_platform_pm->need_resume(dev) : false;
801 }
802
803 static inline bool platform_pci_bridge_d3(struct pci_dev *dev)
804 {
805         if (pci_platform_pm && pci_platform_pm->bridge_d3)
806                 return pci_platform_pm->bridge_d3(dev);
807         return false;
808 }
809
810 /**
811  * pci_raw_set_power_state - Use PCI PM registers to set the power state of
812  *                           given PCI device
813  * @dev: PCI device to handle.
814  * @state: PCI power state (D0, D1, D2, D3hot) to put the device into.
815  *
816  * RETURN VALUE:
817  * -EINVAL if the requested state is invalid.
818  * -EIO if device does not support PCI PM or its PM capabilities register has a
819  * wrong version, or device doesn't support the requested state.
820  * 0 if device already is in the requested state.
821  * 0 if device's power state has been successfully changed.
822  */
823 static int pci_raw_set_power_state(struct pci_dev *dev, pci_power_t state)
824 {
825         u16 pmcsr;
826         bool need_restore = false;
827
828         /* Check if we're already there */
829         if (dev->current_state == state)
830                 return 0;
831
832         if (!dev->pm_cap)
833                 return -EIO;
834
835         if (state < PCI_D0 || state > PCI_D3hot)
836                 return -EINVAL;
837
838         /*
839          * Validate current state:
840          * Can enter D0 from any state, but if we can only go deeper
841          * to sleep if we're already in a low power state
842          */
843         if (state != PCI_D0 && dev->current_state <= PCI_D3cold
844             && dev->current_state > state) {
845                 pci_err(dev, "invalid power transition (from state %d to %d)\n",
846                         dev->current_state, state);
847                 return -EINVAL;
848         }
849
850         /* Check if this device supports the desired state */
851         if ((state == PCI_D1 && !dev->d1_support)
852            || (state == PCI_D2 && !dev->d2_support))
853                 return -EIO;
854
855         pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
856
857         /*
858          * If we're (effectively) in D3, force entire word to 0.
859          * This doesn't affect PME_Status, disables PME_En, and
860          * sets PowerState to 0.
861          */
862         switch (dev->current_state) {
863         case PCI_D0:
864         case PCI_D1:
865         case PCI_D2:
866                 pmcsr &= ~PCI_PM_CTRL_STATE_MASK;
867                 pmcsr |= state;
868                 break;
869         case PCI_D3hot:
870         case PCI_D3cold:
871         case PCI_UNKNOWN: /* Boot-up */
872                 if ((pmcsr & PCI_PM_CTRL_STATE_MASK) == PCI_D3hot
873                  && !(pmcsr & PCI_PM_CTRL_NO_SOFT_RESET))
874                         need_restore = true;
875                 /* Fall-through - force to D0 */
876         default:
877                 pmcsr = 0;
878                 break;
879         }
880
881         /* Enter specified state */
882         pci_write_config_word(dev, dev->pm_cap + PCI_PM_CTRL, pmcsr);
883
884         /*
885          * Mandatory power management transition delays; see PCI PM 1.1
886          * 5.6.1 table 18
887          */
888         if (state == PCI_D3hot || dev->current_state == PCI_D3hot)
889                 pci_dev_d3_sleep(dev);
890         else if (state == PCI_D2 || dev->current_state == PCI_D2)
891                 udelay(PCI_PM_D2_DELAY);
892
893         pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
894         dev->current_state = (pmcsr & PCI_PM_CTRL_STATE_MASK);
895         if (dev->current_state != state)
896                 pci_info_ratelimited(dev, "Refused to change power state, currently in D%d\n",
897                          dev->current_state);
898
899         /*
900          * According to section 5.4.1 of the "PCI BUS POWER MANAGEMENT
901          * INTERFACE SPECIFICATION, REV. 1.2", a device transitioning
902          * from D3hot to D0 _may_ perform an internal reset, thereby
903          * going to "D0 Uninitialized" rather than "D0 Initialized".
904          * For example, at least some versions of the 3c905B and the
905          * 3c556B exhibit this behaviour.
906          *
907          * At least some laptop BIOSen (e.g. the Thinkpad T21) leave
908          * devices in a D3hot state at boot.  Consequently, we need to
909          * restore at least the BARs so that the device will be
910          * accessible to its driver.
911          */
912         if (need_restore)
913                 pci_restore_bars(dev);
914
915         if (dev->bus->self)
916                 pcie_aspm_pm_state_change(dev->bus->self);
917
918         return 0;
919 }
920
921 /**
922  * pci_update_current_state - Read power state of given device and cache it
923  * @dev: PCI device to handle.
924  * @state: State to cache in case the device doesn't have the PM capability
925  *
926  * The power state is read from the PMCSR register, which however is
927  * inaccessible in D3cold.  The platform firmware is therefore queried first
928  * to detect accessibility of the register.  In case the platform firmware
929  * reports an incorrect state or the device isn't power manageable by the
930  * platform at all, we try to detect D3cold by testing accessibility of the
931  * vendor ID in config space.
932  */
933 void pci_update_current_state(struct pci_dev *dev, pci_power_t state)
934 {
935         if (platform_pci_get_power_state(dev) == PCI_D3cold ||
936             !pci_device_is_present(dev)) {
937                 dev->current_state = PCI_D3cold;
938         } else if (dev->pm_cap) {
939                 u16 pmcsr;
940
941                 pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
942                 dev->current_state = (pmcsr & PCI_PM_CTRL_STATE_MASK);
943         } else {
944                 dev->current_state = state;
945         }
946 }
947
948 /**
949  * pci_refresh_power_state - Refresh the given device's power state data
950  * @dev: Target PCI device.
951  *
952  * Ask the platform to refresh the devices power state information and invoke
953  * pci_update_current_state() to update its current PCI power state.
954  */
955 void pci_refresh_power_state(struct pci_dev *dev)
956 {
957         if (platform_pci_power_manageable(dev))
958                 platform_pci_refresh_power_state(dev);
959
960         pci_update_current_state(dev, dev->current_state);
961 }
962
963 /**
964  * pci_platform_power_transition - Use platform to change device power state
965  * @dev: PCI device to handle.
966  * @state: State to put the device into.
967  */
968 static int pci_platform_power_transition(struct pci_dev *dev, pci_power_t state)
969 {
970         int error;
971
972         if (platform_pci_power_manageable(dev)) {
973                 error = platform_pci_set_power_state(dev, state);
974                 if (!error)
975                         pci_update_current_state(dev, state);
976         } else
977                 error = -ENODEV;
978
979         if (error && !dev->pm_cap) /* Fall back to PCI_D0 */
980                 dev->current_state = PCI_D0;
981
982         return error;
983 }
984
985 /**
986  * pci_wakeup - Wake up a PCI device
987  * @pci_dev: Device to handle.
988  * @ign: ignored parameter
989  */
990 static int pci_wakeup(struct pci_dev *pci_dev, void *ign)
991 {
992         pci_wakeup_event(pci_dev);
993         pm_request_resume(&pci_dev->dev);
994         return 0;
995 }
996
997 /**
998  * pci_wakeup_bus - Walk given bus and wake up devices on it
999  * @bus: Top bus of the subtree to walk.
1000  */
1001 void pci_wakeup_bus(struct pci_bus *bus)
1002 {
1003         if (bus)
1004                 pci_walk_bus(bus, pci_wakeup, NULL);
1005 }
1006
1007 /**
1008  * __pci_start_power_transition - Start power transition of a PCI device
1009  * @dev: PCI device to handle.
1010  * @state: State to put the device into.
1011  */
1012 static void __pci_start_power_transition(struct pci_dev *dev, pci_power_t state)
1013 {
1014         if (state == PCI_D0) {
1015                 pci_platform_power_transition(dev, PCI_D0);
1016                 /*
1017                  * Mandatory power management transition delays, see
1018                  * PCI Express Base Specification Revision 2.0 Section
1019                  * 6.6.1: Conventional Reset.  Do not delay for
1020                  * devices powered on/off by corresponding bridge,
1021                  * because have already delayed for the bridge.
1022                  */
1023                 if (dev->runtime_d3cold) {
1024                         /*
1025                          * When powering on a bridge from D3cold, the
1026                          * whole hierarchy may be powered on into
1027                          * D0uninitialized state, resume them to give
1028                          * them a chance to suspend again
1029                          */
1030                         pci_wakeup_bus(dev->subordinate);
1031                 }
1032         }
1033 }
1034
1035 /**
1036  * __pci_dev_set_current_state - Set current state of a PCI device
1037  * @dev: Device to handle
1038  * @data: pointer to state to be set
1039  */
1040 static int __pci_dev_set_current_state(struct pci_dev *dev, void *data)
1041 {
1042         pci_power_t state = *(pci_power_t *)data;
1043
1044         dev->current_state = state;
1045         return 0;
1046 }
1047
1048 /**
1049  * pci_bus_set_current_state - Walk given bus and set current state of devices
1050  * @bus: Top bus of the subtree to walk.
1051  * @state: state to be set
1052  */
1053 void pci_bus_set_current_state(struct pci_bus *bus, pci_power_t state)
1054 {
1055         if (bus)
1056                 pci_walk_bus(bus, __pci_dev_set_current_state, &state);
1057 }
1058
1059 /**
1060  * __pci_complete_power_transition - Complete power transition of a PCI device
1061  * @dev: PCI device to handle.
1062  * @state: State to put the device into.
1063  *
1064  * This function should not be called directly by device drivers.
1065  */
1066 int __pci_complete_power_transition(struct pci_dev *dev, pci_power_t state)
1067 {
1068         int ret;
1069
1070         if (state <= PCI_D0)
1071                 return -EINVAL;
1072         ret = pci_platform_power_transition(dev, state);
1073         /* Power off the bridge may power off the whole hierarchy */
1074         if (!ret && state == PCI_D3cold)
1075                 pci_bus_set_current_state(dev->subordinate, PCI_D3cold);
1076         return ret;
1077 }
1078 EXPORT_SYMBOL_GPL(__pci_complete_power_transition);
1079
1080 /**
1081  * pci_set_power_state - Set the power state of a PCI device
1082  * @dev: PCI device to handle.
1083  * @state: PCI power state (D0, D1, D2, D3hot) to put the device into.
1084  *
1085  * Transition a device to a new power state, using the platform firmware and/or
1086  * the device's PCI PM registers.
1087  *
1088  * RETURN VALUE:
1089  * -EINVAL if the requested state is invalid.
1090  * -EIO if device does not support PCI PM or its PM capabilities register has a
1091  * wrong version, or device doesn't support the requested state.
1092  * 0 if the transition is to D1 or D2 but D1 and D2 are not supported.
1093  * 0 if device already is in the requested state.
1094  * 0 if the transition is to D3 but D3 is not supported.
1095  * 0 if device's power state has been successfully changed.
1096  */
1097 int pci_set_power_state(struct pci_dev *dev, pci_power_t state)
1098 {
1099         int error;
1100
1101         /* Bound the state we're entering */
1102         if (state > PCI_D3cold)
1103                 state = PCI_D3cold;
1104         else if (state < PCI_D0)
1105                 state = PCI_D0;
1106         else if ((state == PCI_D1 || state == PCI_D2) && pci_no_d1d2(dev))
1107
1108                 /*
1109                  * If the device or the parent bridge do not support PCI
1110                  * PM, ignore the request if we're doing anything other
1111                  * than putting it into D0 (which would only happen on
1112                  * boot).
1113                  */
1114                 return 0;
1115
1116         /* Check if we're already there */
1117         if (dev->current_state == state)
1118                 return 0;
1119
1120         __pci_start_power_transition(dev, state);
1121
1122         /*
1123          * This device is quirked not to be put into D3, so don't put it in
1124          * D3
1125          */
1126         if (state >= PCI_D3hot && (dev->dev_flags & PCI_DEV_FLAGS_NO_D3))
1127                 return 0;
1128
1129         /*
1130          * To put device in D3cold, we put device into D3hot in native
1131          * way, then put device into D3cold with platform ops
1132          */
1133         error = pci_raw_set_power_state(dev, state > PCI_D3hot ?
1134                                         PCI_D3hot : state);
1135
1136         if (!__pci_complete_power_transition(dev, state))
1137                 error = 0;
1138
1139         return error;
1140 }
1141 EXPORT_SYMBOL(pci_set_power_state);
1142
1143 /**
1144  * pci_power_up - Put the given device into D0 forcibly
1145  * @dev: PCI device to power up
1146  */
1147 void pci_power_up(struct pci_dev *dev)
1148 {
1149         __pci_start_power_transition(dev, PCI_D0);
1150         pci_raw_set_power_state(dev, PCI_D0);
1151         pci_update_current_state(dev, PCI_D0);
1152 }
1153
1154 /**
1155  * pci_choose_state - Choose the power state of a PCI device
1156  * @dev: PCI device to be suspended
1157  * @state: target sleep state for the whole system. This is the value
1158  *         that is passed to suspend() function.
1159  *
1160  * Returns PCI power state suitable for given device and given system
1161  * message.
1162  */
1163 pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state)
1164 {
1165         pci_power_t ret;
1166
1167         if (!dev->pm_cap)
1168                 return PCI_D0;
1169
1170         ret = platform_pci_choose_state(dev);
1171         if (ret != PCI_POWER_ERROR)
1172                 return ret;
1173
1174         switch (state.event) {
1175         case PM_EVENT_ON:
1176                 return PCI_D0;
1177         case PM_EVENT_FREEZE:
1178         case PM_EVENT_PRETHAW:
1179                 /* REVISIT both freeze and pre-thaw "should" use D0 */
1180         case PM_EVENT_SUSPEND:
1181         case PM_EVENT_HIBERNATE:
1182                 return PCI_D3hot;
1183         default:
1184                 pci_info(dev, "unrecognized suspend event %d\n",
1185                          state.event);
1186                 BUG();
1187         }
1188         return PCI_D0;
1189 }
1190 EXPORT_SYMBOL(pci_choose_state);
1191
1192 #define PCI_EXP_SAVE_REGS       7
1193
1194 static struct pci_cap_saved_state *_pci_find_saved_cap(struct pci_dev *pci_dev,
1195                                                        u16 cap, bool extended)
1196 {
1197         struct pci_cap_saved_state *tmp;
1198
1199         hlist_for_each_entry(tmp, &pci_dev->saved_cap_space, next) {
1200                 if (tmp->cap.cap_extended == extended && tmp->cap.cap_nr == cap)
1201                         return tmp;
1202         }
1203         return NULL;
1204 }
1205
1206 struct pci_cap_saved_state *pci_find_saved_cap(struct pci_dev *dev, char cap)
1207 {
1208         return _pci_find_saved_cap(dev, cap, false);
1209 }
1210
1211 struct pci_cap_saved_state *pci_find_saved_ext_cap(struct pci_dev *dev, u16 cap)
1212 {
1213         return _pci_find_saved_cap(dev, cap, true);
1214 }
1215
1216 static int pci_save_pcie_state(struct pci_dev *dev)
1217 {
1218         int i = 0;
1219         struct pci_cap_saved_state *save_state;
1220         u16 *cap;
1221
1222         if (!pci_is_pcie(dev))
1223                 return 0;
1224
1225         save_state = pci_find_saved_cap(dev, PCI_CAP_ID_EXP);
1226         if (!save_state) {
1227                 pci_err(dev, "buffer not found in %s\n", __func__);
1228                 return -ENOMEM;
1229         }
1230
1231         cap = (u16 *)&save_state->cap.data[0];
1232         pcie_capability_read_word(dev, PCI_EXP_DEVCTL, &cap[i++]);
1233         pcie_capability_read_word(dev, PCI_EXP_LNKCTL, &cap[i++]);
1234         pcie_capability_read_word(dev, PCI_EXP_SLTCTL, &cap[i++]);
1235         pcie_capability_read_word(dev, PCI_EXP_RTCTL,  &cap[i++]);
1236         pcie_capability_read_word(dev, PCI_EXP_DEVCTL2, &cap[i++]);
1237         pcie_capability_read_word(dev, PCI_EXP_LNKCTL2, &cap[i++]);
1238         pcie_capability_read_word(dev, PCI_EXP_SLTCTL2, &cap[i++]);
1239
1240         return 0;
1241 }
1242
1243 static void pci_restore_pcie_state(struct pci_dev *dev)
1244 {
1245         int i = 0;
1246         struct pci_cap_saved_state *save_state;
1247         u16 *cap;
1248
1249         save_state = pci_find_saved_cap(dev, PCI_CAP_ID_EXP);
1250         if (!save_state)
1251                 return;
1252
1253         cap = (u16 *)&save_state->cap.data[0];
1254         pcie_capability_write_word(dev, PCI_EXP_DEVCTL, cap[i++]);
1255         pcie_capability_write_word(dev, PCI_EXP_LNKCTL, cap[i++]);
1256         pcie_capability_write_word(dev, PCI_EXP_SLTCTL, cap[i++]);
1257         pcie_capability_write_word(dev, PCI_EXP_RTCTL, cap[i++]);
1258         pcie_capability_write_word(dev, PCI_EXP_DEVCTL2, cap[i++]);
1259         pcie_capability_write_word(dev, PCI_EXP_LNKCTL2, cap[i++]);
1260         pcie_capability_write_word(dev, PCI_EXP_SLTCTL2, cap[i++]);
1261 }
1262
1263 static int pci_save_pcix_state(struct pci_dev *dev)
1264 {
1265         int pos;
1266         struct pci_cap_saved_state *save_state;
1267
1268         pos = pci_find_capability(dev, PCI_CAP_ID_PCIX);
1269         if (!pos)
1270                 return 0;
1271
1272         save_state = pci_find_saved_cap(dev, PCI_CAP_ID_PCIX);
1273         if (!save_state) {
1274                 pci_err(dev, "buffer not found in %s\n", __func__);
1275                 return -ENOMEM;
1276         }
1277
1278         pci_read_config_word(dev, pos + PCI_X_CMD,
1279                              (u16 *)save_state->cap.data);
1280
1281         return 0;
1282 }
1283
1284 static void pci_restore_pcix_state(struct pci_dev *dev)
1285 {
1286         int i = 0, pos;
1287         struct pci_cap_saved_state *save_state;
1288         u16 *cap;
1289
1290         save_state = pci_find_saved_cap(dev, PCI_CAP_ID_PCIX);
1291         pos = pci_find_capability(dev, PCI_CAP_ID_PCIX);
1292         if (!save_state || !pos)
1293                 return;
1294         cap = (u16 *)&save_state->cap.data[0];
1295
1296         pci_write_config_word(dev, pos + PCI_X_CMD, cap[i++]);
1297 }
1298
1299 static void pci_save_ltr_state(struct pci_dev *dev)
1300 {
1301         int ltr;
1302         struct pci_cap_saved_state *save_state;
1303         u16 *cap;
1304
1305         if (!pci_is_pcie(dev))
1306                 return;
1307
1308         ltr = pci_find_ext_capability(dev, PCI_EXT_CAP_ID_LTR);
1309         if (!ltr)
1310                 return;
1311
1312         save_state = pci_find_saved_ext_cap(dev, PCI_EXT_CAP_ID_LTR);
1313         if (!save_state) {
1314                 pci_err(dev, "no suspend buffer for LTR; ASPM issues possible after resume\n");
1315                 return;
1316         }
1317
1318         cap = (u16 *)&save_state->cap.data[0];
1319         pci_read_config_word(dev, ltr + PCI_LTR_MAX_SNOOP_LAT, cap++);
1320         pci_read_config_word(dev, ltr + PCI_LTR_MAX_NOSNOOP_LAT, cap++);
1321 }
1322
1323 static void pci_restore_ltr_state(struct pci_dev *dev)
1324 {
1325         struct pci_cap_saved_state *save_state;
1326         int ltr;
1327         u16 *cap;
1328
1329         save_state = pci_find_saved_ext_cap(dev, PCI_EXT_CAP_ID_LTR);
1330         ltr = pci_find_ext_capability(dev, PCI_EXT_CAP_ID_LTR);
1331         if (!save_state || !ltr)
1332                 return;
1333
1334         cap = (u16 *)&save_state->cap.data[0];
1335         pci_write_config_word(dev, ltr + PCI_LTR_MAX_SNOOP_LAT, *cap++);
1336         pci_write_config_word(dev, ltr + PCI_LTR_MAX_NOSNOOP_LAT, *cap++);
1337 }
1338
1339 /**
1340  * pci_save_state - save the PCI configuration space of a device before
1341  *                  suspending
1342  * @dev: PCI device that we're dealing with
1343  */
1344 int pci_save_state(struct pci_dev *dev)
1345 {
1346         int i;
1347         /* XXX: 100% dword access ok here? */
1348         for (i = 0; i < 16; i++)
1349                 pci_read_config_dword(dev, i * 4, &dev->saved_config_space[i]);
1350         dev->state_saved = true;
1351
1352         i = pci_save_pcie_state(dev);
1353         if (i != 0)
1354                 return i;
1355
1356         i = pci_save_pcix_state(dev);
1357         if (i != 0)
1358                 return i;
1359
1360         pci_save_ltr_state(dev);
1361         pci_save_dpc_state(dev);
1362         return pci_save_vc_state(dev);
1363 }
1364 EXPORT_SYMBOL(pci_save_state);
1365
1366 static void pci_restore_config_dword(struct pci_dev *pdev, int offset,
1367                                      u32 saved_val, int retry, bool force)
1368 {
1369         u32 val;
1370
1371         pci_read_config_dword(pdev, offset, &val);
1372         if (!force && val == saved_val)
1373                 return;
1374
1375         for (;;) {
1376                 pci_dbg(pdev, "restoring config space at offset %#x (was %#x, writing %#x)\n",
1377                         offset, val, saved_val);
1378                 pci_write_config_dword(pdev, offset, saved_val);
1379                 if (retry-- <= 0)
1380                         return;
1381
1382                 pci_read_config_dword(pdev, offset, &val);
1383                 if (val == saved_val)
1384                         return;
1385
1386                 mdelay(1);
1387         }
1388 }
1389
1390 static void pci_restore_config_space_range(struct pci_dev *pdev,
1391                                            int start, int end, int retry,
1392                                            bool force)
1393 {
1394         int index;
1395
1396         for (index = end; index >= start; index--)
1397                 pci_restore_config_dword(pdev, 4 * index,
1398                                          pdev->saved_config_space[index],
1399                                          retry, force);
1400 }
1401
1402 static void pci_restore_config_space(struct pci_dev *pdev)
1403 {
1404         if (pdev->hdr_type == PCI_HEADER_TYPE_NORMAL) {
1405                 pci_restore_config_space_range(pdev, 10, 15, 0, false);
1406                 /* Restore BARs before the command register. */
1407                 pci_restore_config_space_range(pdev, 4, 9, 10, false);
1408                 pci_restore_config_space_range(pdev, 0, 3, 0, false);
1409         } else if (pdev->hdr_type == PCI_HEADER_TYPE_BRIDGE) {
1410                 pci_restore_config_space_range(pdev, 12, 15, 0, false);
1411
1412                 /*
1413                  * Force rewriting of prefetch registers to avoid S3 resume
1414                  * issues on Intel PCI bridges that occur when these
1415                  * registers are not explicitly written.
1416                  */
1417                 pci_restore_config_space_range(pdev, 9, 11, 0, true);
1418                 pci_restore_config_space_range(pdev, 0, 8, 0, false);
1419         } else {
1420                 pci_restore_config_space_range(pdev, 0, 15, 0, false);
1421         }
1422 }
1423
1424 static void pci_restore_rebar_state(struct pci_dev *pdev)
1425 {
1426         unsigned int pos, nbars, i;
1427         u32 ctrl;
1428
1429         pos = pci_find_ext_capability(pdev, PCI_EXT_CAP_ID_REBAR);
1430         if (!pos)
1431                 return;
1432
1433         pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
1434         nbars = (ctrl & PCI_REBAR_CTRL_NBAR_MASK) >>
1435                     PCI_REBAR_CTRL_NBAR_SHIFT;
1436
1437         for (i = 0; i < nbars; i++, pos += 8) {
1438                 struct resource *res;
1439                 int bar_idx, size;
1440
1441                 pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
1442                 bar_idx = ctrl & PCI_REBAR_CTRL_BAR_IDX;
1443                 res = pdev->resource + bar_idx;
1444                 size = ilog2(resource_size(res)) - 20;
1445                 ctrl &= ~PCI_REBAR_CTRL_BAR_SIZE;
1446                 ctrl |= size << PCI_REBAR_CTRL_BAR_SHIFT;
1447                 pci_write_config_dword(pdev, pos + PCI_REBAR_CTRL, ctrl);
1448         }
1449 }
1450
1451 /**
1452  * pci_restore_state - Restore the saved state of a PCI device
1453  * @dev: PCI device that we're dealing with
1454  */
1455 void pci_restore_state(struct pci_dev *dev)
1456 {
1457         if (!dev->state_saved)
1458                 return;
1459
1460         /*
1461          * Restore max latencies (in the LTR capability) before enabling
1462          * LTR itself (in the PCIe capability).
1463          */
1464         pci_restore_ltr_state(dev);
1465
1466         pci_restore_pcie_state(dev);
1467         pci_restore_pasid_state(dev);
1468         pci_restore_pri_state(dev);
1469         pci_restore_ats_state(dev);
1470         pci_restore_vc_state(dev);
1471         pci_restore_rebar_state(dev);
1472         pci_restore_dpc_state(dev);
1473
1474         pci_cleanup_aer_error_status_regs(dev);
1475
1476         pci_restore_config_space(dev);
1477
1478         pci_restore_pcix_state(dev);
1479         pci_restore_msi_state(dev);
1480
1481         /* Restore ACS and IOV configuration state */
1482         pci_enable_acs(dev);
1483         pci_restore_iov_state(dev);
1484
1485         dev->state_saved = false;
1486 }
1487 EXPORT_SYMBOL(pci_restore_state);
1488
1489 struct pci_saved_state {
1490         u32 config_space[16];
1491         struct pci_cap_saved_data cap[0];
1492 };
1493
1494 /**
1495  * pci_store_saved_state - Allocate and return an opaque struct containing
1496  *                         the device saved state.
1497  * @dev: PCI device that we're dealing with
1498  *
1499  * Return NULL if no state or error.
1500  */
1501 struct pci_saved_state *pci_store_saved_state(struct pci_dev *dev)
1502 {
1503         struct pci_saved_state *state;
1504         struct pci_cap_saved_state *tmp;
1505         struct pci_cap_saved_data *cap;
1506         size_t size;
1507
1508         if (!dev->state_saved)
1509                 return NULL;
1510
1511         size = sizeof(*state) + sizeof(struct pci_cap_saved_data);
1512
1513         hlist_for_each_entry(tmp, &dev->saved_cap_space, next)
1514                 size += sizeof(struct pci_cap_saved_data) + tmp->cap.size;
1515
1516         state = kzalloc(size, GFP_KERNEL);
1517         if (!state)
1518                 return NULL;
1519
1520         memcpy(state->config_space, dev->saved_config_space,
1521                sizeof(state->config_space));
1522
1523         cap = state->cap;
1524         hlist_for_each_entry(tmp, &dev->saved_cap_space, next) {
1525                 size_t len = sizeof(struct pci_cap_saved_data) + tmp->cap.size;
1526                 memcpy(cap, &tmp->cap, len);
1527                 cap = (struct pci_cap_saved_data *)((u8 *)cap + len);
1528         }
1529         /* Empty cap_save terminates list */
1530
1531         return state;
1532 }
1533 EXPORT_SYMBOL_GPL(pci_store_saved_state);
1534
1535 /**
1536  * pci_load_saved_state - Reload the provided save state into struct pci_dev.
1537  * @dev: PCI device that we're dealing with
1538  * @state: Saved state returned from pci_store_saved_state()
1539  */
1540 int pci_load_saved_state(struct pci_dev *dev,
1541                          struct pci_saved_state *state)
1542 {
1543         struct pci_cap_saved_data *cap;
1544
1545         dev->state_saved = false;
1546
1547         if (!state)
1548                 return 0;
1549
1550         memcpy(dev->saved_config_space, state->config_space,
1551                sizeof(state->config_space));
1552
1553         cap = state->cap;
1554         while (cap->size) {
1555                 struct pci_cap_saved_state *tmp;
1556
1557                 tmp = _pci_find_saved_cap(dev, cap->cap_nr, cap->cap_extended);
1558                 if (!tmp || tmp->cap.size != cap->size)
1559                         return -EINVAL;
1560
1561                 memcpy(tmp->cap.data, cap->data, tmp->cap.size);
1562                 cap = (struct pci_cap_saved_data *)((u8 *)cap +
1563                        sizeof(struct pci_cap_saved_data) + cap->size);
1564         }
1565
1566         dev->state_saved = true;
1567         return 0;
1568 }
1569 EXPORT_SYMBOL_GPL(pci_load_saved_state);
1570
1571 /**
1572  * pci_load_and_free_saved_state - Reload the save state pointed to by state,
1573  *                                 and free the memory allocated for it.
1574  * @dev: PCI device that we're dealing with
1575  * @state: Pointer to saved state returned from pci_store_saved_state()
1576  */
1577 int pci_load_and_free_saved_state(struct pci_dev *dev,
1578                                   struct pci_saved_state **state)
1579 {
1580         int ret = pci_load_saved_state(dev, *state);
1581         kfree(*state);
1582         *state = NULL;
1583         return ret;
1584 }
1585 EXPORT_SYMBOL_GPL(pci_load_and_free_saved_state);
1586
1587 int __weak pcibios_enable_device(struct pci_dev *dev, int bars)
1588 {
1589         return pci_enable_resources(dev, bars);
1590 }
1591
1592 static int do_pci_enable_device(struct pci_dev *dev, int bars)
1593 {
1594         int err;
1595         struct pci_dev *bridge;
1596         u16 cmd;
1597         u8 pin;
1598
1599         err = pci_set_power_state(dev, PCI_D0);
1600         if (err < 0 && err != -EIO)
1601                 return err;
1602
1603         bridge = pci_upstream_bridge(dev);
1604         if (bridge)
1605                 pcie_aspm_powersave_config_link(bridge);
1606
1607         err = pcibios_enable_device(dev, bars);
1608         if (err < 0)
1609                 return err;
1610         pci_fixup_device(pci_fixup_enable, dev);
1611
1612         if (dev->msi_enabled || dev->msix_enabled)
1613                 return 0;
1614
1615         pci_read_config_byte(dev, PCI_INTERRUPT_PIN, &pin);
1616         if (pin) {
1617                 pci_read_config_word(dev, PCI_COMMAND, &cmd);
1618                 if (cmd & PCI_COMMAND_INTX_DISABLE)
1619                         pci_write_config_word(dev, PCI_COMMAND,
1620                                               cmd & ~PCI_COMMAND_INTX_DISABLE);
1621         }
1622
1623         return 0;
1624 }
1625
1626 /**
1627  * pci_reenable_device - Resume abandoned device
1628  * @dev: PCI device to be resumed
1629  *
1630  * NOTE: This function is a backend of pci_default_resume() and is not supposed
1631  * to be called by normal code, write proper resume handler and use it instead.
1632  */
1633 int pci_reenable_device(struct pci_dev *dev)
1634 {
1635         if (pci_is_enabled(dev))
1636                 return do_pci_enable_device(dev, (1 << PCI_NUM_RESOURCES) - 1);
1637         return 0;
1638 }
1639 EXPORT_SYMBOL(pci_reenable_device);
1640
1641 static void pci_enable_bridge(struct pci_dev *dev)
1642 {
1643         struct pci_dev *bridge;
1644         int retval;
1645
1646         bridge = pci_upstream_bridge(dev);
1647         if (bridge)
1648                 pci_enable_bridge(bridge);
1649
1650         if (pci_is_enabled(dev)) {
1651                 if (!dev->is_busmaster)
1652                         pci_set_master(dev);
1653                 return;
1654         }
1655
1656         retval = pci_enable_device(dev);
1657         if (retval)
1658                 pci_err(dev, "Error enabling bridge (%d), continuing\n",
1659                         retval);
1660         pci_set_master(dev);
1661 }
1662
1663 static int pci_enable_device_flags(struct pci_dev *dev, unsigned long flags)
1664 {
1665         struct pci_dev *bridge;
1666         int err;
1667         int i, bars = 0;
1668
1669         /*
1670          * Power state could be unknown at this point, either due to a fresh
1671          * boot or a device removal call.  So get the current power state
1672          * so that things like MSI message writing will behave as expected
1673          * (e.g. if the device really is in D0 at enable time).
1674          */
1675         pci_update_current_state(dev, dev->current_state);
1676
1677         if (atomic_inc_return(&dev->enable_cnt) > 1)
1678                 return 0;               /* already enabled */
1679
1680         bridge = pci_upstream_bridge(dev);
1681         if (bridge)
1682                 pci_enable_bridge(bridge);
1683
1684         /* only skip sriov related */
1685         for (i = 0; i <= PCI_ROM_RESOURCE; i++)
1686                 if (dev->resource[i].flags & flags)
1687                         bars |= (1 << i);
1688         for (i = PCI_BRIDGE_RESOURCES; i < DEVICE_COUNT_RESOURCE; i++)
1689                 if (dev->resource[i].flags & flags)
1690                         bars |= (1 << i);
1691
1692         err = do_pci_enable_device(dev, bars);
1693         if (err < 0)
1694                 atomic_dec(&dev->enable_cnt);
1695         return err;
1696 }
1697
1698 /**
1699  * pci_enable_device_io - Initialize a device for use with IO space
1700  * @dev: PCI device to be initialized
1701  *
1702  * Initialize device before it's used by a driver. Ask low-level code
1703  * to enable I/O resources. Wake up the device if it was suspended.
1704  * Beware, this function can fail.
1705  */
1706 int pci_enable_device_io(struct pci_dev *dev)
1707 {
1708         return pci_enable_device_flags(dev, IORESOURCE_IO);
1709 }
1710 EXPORT_SYMBOL(pci_enable_device_io);
1711
1712 /**
1713  * pci_enable_device_mem - Initialize a device for use with Memory space
1714  * @dev: PCI device to be initialized
1715  *
1716  * Initialize device before it's used by a driver. Ask low-level code
1717  * to enable Memory resources. Wake up the device if it was suspended.
1718  * Beware, this function can fail.
1719  */
1720 int pci_enable_device_mem(struct pci_dev *dev)
1721 {
1722         return pci_enable_device_flags(dev, IORESOURCE_MEM);
1723 }
1724 EXPORT_SYMBOL(pci_enable_device_mem);
1725
1726 /**
1727  * pci_enable_device - Initialize device before it's used by a driver.
1728  * @dev: PCI device to be initialized
1729  *
1730  * Initialize device before it's used by a driver. Ask low-level code
1731  * to enable I/O and memory. Wake up the device if it was suspended.
1732  * Beware, this function can fail.
1733  *
1734  * Note we don't actually enable the device many times if we call
1735  * this function repeatedly (we just increment the count).
1736  */
1737 int pci_enable_device(struct pci_dev *dev)
1738 {
1739         return pci_enable_device_flags(dev, IORESOURCE_MEM | IORESOURCE_IO);
1740 }
1741 EXPORT_SYMBOL(pci_enable_device);
1742
1743 /*
1744  * Managed PCI resources.  This manages device on/off, INTx/MSI/MSI-X
1745  * on/off and BAR regions.  pci_dev itself records MSI/MSI-X status, so
1746  * there's no need to track it separately.  pci_devres is initialized
1747  * when a device is enabled using managed PCI device enable interface.
1748  */
1749 struct pci_devres {
1750         unsigned int enabled:1;
1751         unsigned int pinned:1;
1752         unsigned int orig_intx:1;
1753         unsigned int restore_intx:1;
1754         unsigned int mwi:1;
1755         u32 region_mask;
1756 };
1757
1758 static void pcim_release(struct device *gendev, void *res)
1759 {
1760         struct pci_dev *dev = to_pci_dev(gendev);
1761         struct pci_devres *this = res;
1762         int i;
1763
1764         if (dev->msi_enabled)
1765                 pci_disable_msi(dev);
1766         if (dev->msix_enabled)
1767                 pci_disable_msix(dev);
1768
1769         for (i = 0; i < DEVICE_COUNT_RESOURCE; i++)
1770                 if (this->region_mask & (1 << i))
1771                         pci_release_region(dev, i);
1772
1773         if (this->mwi)
1774                 pci_clear_mwi(dev);
1775
1776         if (this->restore_intx)
1777                 pci_intx(dev, this->orig_intx);
1778
1779         if (this->enabled && !this->pinned)
1780                 pci_disable_device(dev);
1781 }
1782
1783 static struct pci_devres *get_pci_dr(struct pci_dev *pdev)
1784 {
1785         struct pci_devres *dr, *new_dr;
1786
1787         dr = devres_find(&pdev->dev, pcim_release, NULL, NULL);
1788         if (dr)
1789                 return dr;
1790
1791         new_dr = devres_alloc(pcim_release, sizeof(*new_dr), GFP_KERNEL);
1792         if (!new_dr)
1793                 return NULL;
1794         return devres_get(&pdev->dev, new_dr, NULL, NULL);
1795 }
1796
1797 static struct pci_devres *find_pci_dr(struct pci_dev *pdev)
1798 {
1799         if (pci_is_managed(pdev))
1800                 return devres_find(&pdev->dev, pcim_release, NULL, NULL);
1801         return NULL;
1802 }
1803
1804 /**
1805  * pcim_enable_device - Managed pci_enable_device()
1806  * @pdev: PCI device to be initialized
1807  *
1808  * Managed pci_enable_device().
1809  */
1810 int pcim_enable_device(struct pci_dev *pdev)
1811 {
1812         struct pci_devres *dr;
1813         int rc;
1814
1815         dr = get_pci_dr(pdev);
1816         if (unlikely(!dr))
1817                 return -ENOMEM;
1818         if (dr->enabled)
1819                 return 0;
1820
1821         rc = pci_enable_device(pdev);
1822         if (!rc) {
1823                 pdev->is_managed = 1;
1824                 dr->enabled = 1;
1825         }
1826         return rc;
1827 }
1828 EXPORT_SYMBOL(pcim_enable_device);
1829
1830 /**
1831  * pcim_pin_device - Pin managed PCI device
1832  * @pdev: PCI device to pin
1833  *
1834  * Pin managed PCI device @pdev.  Pinned device won't be disabled on
1835  * driver detach.  @pdev must have been enabled with
1836  * pcim_enable_device().
1837  */
1838 void pcim_pin_device(struct pci_dev *pdev)
1839 {
1840         struct pci_devres *dr;
1841
1842         dr = find_pci_dr(pdev);
1843         WARN_ON(!dr || !dr->enabled);
1844         if (dr)
1845                 dr->pinned = 1;
1846 }
1847 EXPORT_SYMBOL(pcim_pin_device);
1848
1849 /*
1850  * pcibios_add_device - provide arch specific hooks when adding device dev
1851  * @dev: the PCI device being added
1852  *
1853  * Permits the platform to provide architecture specific functionality when
1854  * devices are added. This is the default implementation. Architecture
1855  * implementations can override this.
1856  */
1857 int __weak pcibios_add_device(struct pci_dev *dev)
1858 {
1859         return 0;
1860 }
1861
1862 /**
1863  * pcibios_release_device - provide arch specific hooks when releasing
1864  *                          device dev
1865  * @dev: the PCI device being released
1866  *
1867  * Permits the platform to provide architecture specific functionality when
1868  * devices are released. This is the default implementation. Architecture
1869  * implementations can override this.
1870  */
1871 void __weak pcibios_release_device(struct pci_dev *dev) {}
1872
1873 /**
1874  * pcibios_disable_device - disable arch specific PCI resources for device dev
1875  * @dev: the PCI device to disable
1876  *
1877  * Disables architecture specific PCI resources for the device. This
1878  * is the default implementation. Architecture implementations can
1879  * override this.
1880  */
1881 void __weak pcibios_disable_device(struct pci_dev *dev) {}
1882
1883 /**
1884  * pcibios_penalize_isa_irq - penalize an ISA IRQ
1885  * @irq: ISA IRQ to penalize
1886  * @active: IRQ active or not
1887  *
1888  * Permits the platform to provide architecture-specific functionality when
1889  * penalizing ISA IRQs. This is the default implementation. Architecture
1890  * implementations can override this.
1891  */
1892 void __weak pcibios_penalize_isa_irq(int irq, int active) {}
1893
1894 static void do_pci_disable_device(struct pci_dev *dev)
1895 {
1896         u16 pci_command;
1897
1898         pci_read_config_word(dev, PCI_COMMAND, &pci_command);
1899         if (pci_command & PCI_COMMAND_MASTER) {
1900                 pci_command &= ~PCI_COMMAND_MASTER;
1901                 pci_write_config_word(dev, PCI_COMMAND, pci_command);
1902         }
1903
1904         pcibios_disable_device(dev);
1905 }
1906
1907 /**
1908  * pci_disable_enabled_device - Disable device without updating enable_cnt
1909  * @dev: PCI device to disable
1910  *
1911  * NOTE: This function is a backend of PCI power management routines and is
1912  * not supposed to be called drivers.
1913  */
1914 void pci_disable_enabled_device(struct pci_dev *dev)
1915 {
1916         if (pci_is_enabled(dev))
1917                 do_pci_disable_device(dev);
1918 }
1919
1920 /**
1921  * pci_disable_device - Disable PCI device after use
1922  * @dev: PCI device to be disabled
1923  *
1924  * Signal to the system that the PCI device is not in use by the system
1925  * anymore.  This only involves disabling PCI bus-mastering, if active.
1926  *
1927  * Note we don't actually disable the device until all callers of
1928  * pci_enable_device() have called pci_disable_device().
1929  */
1930 void pci_disable_device(struct pci_dev *dev)
1931 {
1932         struct pci_devres *dr;
1933
1934         dr = find_pci_dr(dev);
1935         if (dr)
1936                 dr->enabled = 0;
1937
1938         dev_WARN_ONCE(&dev->dev, atomic_read(&dev->enable_cnt) <= 0,
1939                       "disabling already-disabled device");
1940
1941         if (atomic_dec_return(&dev->enable_cnt) != 0)
1942                 return;
1943
1944         do_pci_disable_device(dev);
1945
1946         dev->is_busmaster = 0;
1947 }
1948 EXPORT_SYMBOL(pci_disable_device);
1949
1950 /**
1951  * pcibios_set_pcie_reset_state - set reset state for device dev
1952  * @dev: the PCIe device reset
1953  * @state: Reset state to enter into
1954  *
1955  * Set the PCIe reset state for the device. This is the default
1956  * implementation. Architecture implementations can override this.
1957  */
1958 int __weak pcibios_set_pcie_reset_state(struct pci_dev *dev,
1959                                         enum pcie_reset_state state)
1960 {
1961         return -EINVAL;
1962 }
1963
1964 /**
1965  * pci_set_pcie_reset_state - set reset state for device dev
1966  * @dev: the PCIe device reset
1967  * @state: Reset state to enter into
1968  *
1969  * Sets the PCI reset state for the device.
1970  */
1971 int pci_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state)
1972 {
1973         return pcibios_set_pcie_reset_state(dev, state);
1974 }
1975 EXPORT_SYMBOL_GPL(pci_set_pcie_reset_state);
1976
1977 /**
1978  * pcie_clear_root_pme_status - Clear root port PME interrupt status.
1979  * @dev: PCIe root port or event collector.
1980  */
1981 void pcie_clear_root_pme_status(struct pci_dev *dev)
1982 {
1983         pcie_capability_set_dword(dev, PCI_EXP_RTSTA, PCI_EXP_RTSTA_PME);
1984 }
1985
1986 /**
1987  * pci_check_pme_status - Check if given device has generated PME.
1988  * @dev: Device to check.
1989  *
1990  * Check the PME status of the device and if set, clear it and clear PME enable
1991  * (if set).  Return 'true' if PME status and PME enable were both set or
1992  * 'false' otherwise.
1993  */
1994 bool pci_check_pme_status(struct pci_dev *dev)
1995 {
1996         int pmcsr_pos;
1997         u16 pmcsr;
1998         bool ret = false;
1999
2000         if (!dev->pm_cap)
2001                 return false;
2002
2003         pmcsr_pos = dev->pm_cap + PCI_PM_CTRL;
2004         pci_read_config_word(dev, pmcsr_pos, &pmcsr);
2005         if (!(pmcsr & PCI_PM_CTRL_PME_STATUS))
2006                 return false;
2007
2008         /* Clear PME status. */
2009         pmcsr |= PCI_PM_CTRL_PME_STATUS;
2010         if (pmcsr & PCI_PM_CTRL_PME_ENABLE) {
2011                 /* Disable PME to avoid interrupt flood. */
2012                 pmcsr &= ~PCI_PM_CTRL_PME_ENABLE;
2013                 ret = true;
2014         }
2015
2016         pci_write_config_word(dev, pmcsr_pos, pmcsr);
2017
2018         return ret;
2019 }
2020
2021 /**
2022  * pci_pme_wakeup - Wake up a PCI device if its PME Status bit is set.
2023  * @dev: Device to handle.
2024  * @pme_poll_reset: Whether or not to reset the device's pme_poll flag.
2025  *
2026  * Check if @dev has generated PME and queue a resume request for it in that
2027  * case.
2028  */
2029 static int pci_pme_wakeup(struct pci_dev *dev, void *pme_poll_reset)
2030 {
2031         if (pme_poll_reset && dev->pme_poll)
2032                 dev->pme_poll = false;
2033
2034         if (pci_check_pme_status(dev)) {
2035                 pci_wakeup_event(dev);
2036                 pm_request_resume(&dev->dev);
2037         }
2038         return 0;
2039 }
2040
2041 /**
2042  * pci_pme_wakeup_bus - Walk given bus and wake up devices on it, if necessary.
2043  * @bus: Top bus of the subtree to walk.
2044  */
2045 void pci_pme_wakeup_bus(struct pci_bus *bus)
2046 {
2047         if (bus)
2048                 pci_walk_bus(bus, pci_pme_wakeup, (void *)true);
2049 }
2050
2051
2052 /**
2053  * pci_pme_capable - check the capability of PCI device to generate PME#
2054  * @dev: PCI device to handle.
2055  * @state: PCI state from which device will issue PME#.
2056  */
2057 bool pci_pme_capable(struct pci_dev *dev, pci_power_t state)
2058 {
2059         if (!dev->pm_cap)
2060                 return false;
2061
2062         return !!(dev->pme_support & (1 << state));
2063 }
2064 EXPORT_SYMBOL(pci_pme_capable);
2065
2066 static void pci_pme_list_scan(struct work_struct *work)
2067 {
2068         struct pci_pme_device *pme_dev, *n;
2069
2070         mutex_lock(&pci_pme_list_mutex);
2071         list_for_each_entry_safe(pme_dev, n, &pci_pme_list, list) {
2072                 if (pme_dev->dev->pme_poll) {
2073                         struct pci_dev *bridge;
2074
2075                         bridge = pme_dev->dev->bus->self;
2076                         /*
2077                          * If bridge is in low power state, the
2078                          * configuration space of subordinate devices
2079                          * may be not accessible
2080                          */
2081                         if (bridge && bridge->current_state != PCI_D0)
2082                                 continue;
2083                         /*
2084                          * If the device is in D3cold it should not be
2085                          * polled either.
2086                          */
2087                         if (pme_dev->dev->current_state == PCI_D3cold)
2088                                 continue;
2089
2090                         pci_pme_wakeup(pme_dev->dev, NULL);
2091                 } else {
2092                         list_del(&pme_dev->list);
2093                         kfree(pme_dev);
2094                 }
2095         }
2096         if (!list_empty(&pci_pme_list))
2097                 queue_delayed_work(system_freezable_wq, &pci_pme_work,
2098                                    msecs_to_jiffies(PME_TIMEOUT));
2099         mutex_unlock(&pci_pme_list_mutex);
2100 }
2101
2102 static void __pci_pme_active(struct pci_dev *dev, bool enable)
2103 {
2104         u16 pmcsr;
2105
2106         if (!dev->pme_support)
2107                 return;
2108
2109         pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
2110         /* Clear PME_Status by writing 1 to it and enable PME# */
2111         pmcsr |= PCI_PM_CTRL_PME_STATUS | PCI_PM_CTRL_PME_ENABLE;
2112         if (!enable)
2113                 pmcsr &= ~PCI_PM_CTRL_PME_ENABLE;
2114
2115         pci_write_config_word(dev, dev->pm_cap + PCI_PM_CTRL, pmcsr);
2116 }
2117
2118 /**
2119  * pci_pme_restore - Restore PME configuration after config space restore.
2120  * @dev: PCI device to update.
2121  */
2122 void pci_pme_restore(struct pci_dev *dev)
2123 {
2124         u16 pmcsr;
2125
2126         if (!dev->pme_support)
2127                 return;
2128
2129         pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
2130         if (dev->wakeup_prepared) {
2131                 pmcsr |= PCI_PM_CTRL_PME_ENABLE;
2132                 pmcsr &= ~PCI_PM_CTRL_PME_STATUS;
2133         } else {
2134                 pmcsr &= ~PCI_PM_CTRL_PME_ENABLE;
2135                 pmcsr |= PCI_PM_CTRL_PME_STATUS;
2136         }
2137         pci_write_config_word(dev, dev->pm_cap + PCI_PM_CTRL, pmcsr);
2138 }
2139
2140 /**
2141  * pci_pme_active - enable or disable PCI device's PME# function
2142  * @dev: PCI device to handle.
2143  * @enable: 'true' to enable PME# generation; 'false' to disable it.
2144  *
2145  * The caller must verify that the device is capable of generating PME# before
2146  * calling this function with @enable equal to 'true'.
2147  */
2148 void pci_pme_active(struct pci_dev *dev, bool enable)
2149 {
2150         __pci_pme_active(dev, enable);
2151
2152         /*
2153          * PCI (as opposed to PCIe) PME requires that the device have
2154          * its PME# line hooked up correctly. Not all hardware vendors
2155          * do this, so the PME never gets delivered and the device
2156          * remains asleep. The easiest way around this is to
2157          * periodically walk the list of suspended devices and check
2158          * whether any have their PME flag set. The assumption is that
2159          * we'll wake up often enough anyway that this won't be a huge
2160          * hit, and the power savings from the devices will still be a
2161          * win.
2162          *
2163          * Although PCIe uses in-band PME message instead of PME# line
2164          * to report PME, PME does not work for some PCIe devices in
2165          * reality.  For example, there are devices that set their PME
2166          * status bits, but don't really bother to send a PME message;
2167          * there are PCI Express Root Ports that don't bother to
2168          * trigger interrupts when they receive PME messages from the
2169          * devices below.  So PME poll is used for PCIe devices too.
2170          */
2171
2172         if (dev->pme_poll) {
2173                 struct pci_pme_device *pme_dev;
2174                 if (enable) {
2175                         pme_dev = kmalloc(sizeof(struct pci_pme_device),
2176                                           GFP_KERNEL);
2177                         if (!pme_dev) {
2178                                 pci_warn(dev, "can't enable PME#\n");
2179                                 return;
2180                         }
2181                         pme_dev->dev = dev;
2182                         mutex_lock(&pci_pme_list_mutex);
2183                         list_add(&pme_dev->list, &pci_pme_list);
2184                         if (list_is_singular(&pci_pme_list))
2185                                 queue_delayed_work(system_freezable_wq,
2186                                                    &pci_pme_work,
2187                                                    msecs_to_jiffies(PME_TIMEOUT));
2188                         mutex_unlock(&pci_pme_list_mutex);
2189                 } else {
2190                         mutex_lock(&pci_pme_list_mutex);
2191                         list_for_each_entry(pme_dev, &pci_pme_list, list) {
2192                                 if (pme_dev->dev == dev) {
2193                                         list_del(&pme_dev->list);
2194                                         kfree(pme_dev);
2195                                         break;
2196                                 }
2197                         }
2198                         mutex_unlock(&pci_pme_list_mutex);
2199                 }
2200         }
2201
2202         pci_dbg(dev, "PME# %s\n", enable ? "enabled" : "disabled");
2203 }
2204 EXPORT_SYMBOL(pci_pme_active);
2205
2206 /**
2207  * __pci_enable_wake - enable PCI device as wakeup event source
2208  * @dev: PCI device affected
2209  * @state: PCI state from which device will issue wakeup events
2210  * @enable: True to enable event generation; false to disable
2211  *
2212  * This enables the device as a wakeup event source, or disables it.
2213  * When such events involves platform-specific hooks, those hooks are
2214  * called automatically by this routine.
2215  *
2216  * Devices with legacy power management (no standard PCI PM capabilities)
2217  * always require such platform hooks.
2218  *
2219  * RETURN VALUE:
2220  * 0 is returned on success
2221  * -EINVAL is returned if device is not supposed to wake up the system
2222  * Error code depending on the platform is returned if both the platform and
2223  * the native mechanism fail to enable the generation of wake-up events
2224  */
2225 static int __pci_enable_wake(struct pci_dev *dev, pci_power_t state, bool enable)
2226 {
2227         int ret = 0;
2228
2229         /*
2230          * Bridges that are not power-manageable directly only signal
2231          * wakeup on behalf of subordinate devices which is set up
2232          * elsewhere, so skip them. However, bridges that are
2233          * power-manageable may signal wakeup for themselves (for example,
2234          * on a hotplug event) and they need to be covered here.
2235          */
2236         if (!pci_power_manageable(dev))
2237                 return 0;
2238
2239         /* Don't do the same thing twice in a row for one device. */
2240         if (!!enable == !!dev->wakeup_prepared)
2241                 return 0;
2242
2243         /*
2244          * According to "PCI System Architecture" 4th ed. by Tom Shanley & Don
2245          * Anderson we should be doing PME# wake enable followed by ACPI wake
2246          * enable.  To disable wake-up we call the platform first, for symmetry.
2247          */
2248
2249         if (enable) {
2250                 int error;
2251
2252                 /*
2253                  * Enable PME signaling if the device can signal PME from
2254                  * D3cold regardless of whether or not it can signal PME from
2255                  * the current target state, because that will allow it to
2256                  * signal PME when the hierarchy above it goes into D3cold and
2257                  * the device itself ends up in D3cold as a result of that.
2258                  */
2259                 if (pci_pme_capable(dev, state) || pci_pme_capable(dev, PCI_D3cold))
2260                         pci_pme_active(dev, true);
2261                 else
2262                         ret = 1;
2263                 error = platform_pci_set_wakeup(dev, true);
2264                 if (ret)
2265                         ret = error;
2266                 if (!ret)
2267                         dev->wakeup_prepared = true;
2268         } else {
2269                 platform_pci_set_wakeup(dev, false);
2270                 pci_pme_active(dev, false);
2271                 dev->wakeup_prepared = false;
2272         }
2273
2274         return ret;
2275 }
2276
2277 /**
2278  * pci_enable_wake - change wakeup settings for a PCI device
2279  * @pci_dev: Target device
2280  * @state: PCI state from which device will issue wakeup events
2281  * @enable: Whether or not to enable event generation
2282  *
2283  * If @enable is set, check device_may_wakeup() for the device before calling
2284  * __pci_enable_wake() for it.
2285  */
2286 int pci_enable_wake(struct pci_dev *pci_dev, pci_power_t state, bool enable)
2287 {
2288         if (enable && !device_may_wakeup(&pci_dev->dev))
2289                 return -EINVAL;
2290
2291         return __pci_enable_wake(pci_dev, state, enable);
2292 }
2293 EXPORT_SYMBOL(pci_enable_wake);
2294
2295 /**
2296  * pci_wake_from_d3 - enable/disable device to wake up from D3_hot or D3_cold
2297  * @dev: PCI device to prepare
2298  * @enable: True to enable wake-up event generation; false to disable
2299  *
2300  * Many drivers want the device to wake up the system from D3_hot or D3_cold
2301  * and this function allows them to set that up cleanly - pci_enable_wake()
2302  * should not be called twice in a row to enable wake-up due to PCI PM vs ACPI
2303  * ordering constraints.
2304  *
2305  * This function only returns error code if the device is not allowed to wake
2306  * up the system from sleep or it is not capable of generating PME# from both
2307  * D3_hot and D3_cold and the platform is unable to enable wake-up power for it.
2308  */
2309 int pci_wake_from_d3(struct pci_dev *dev, bool enable)
2310 {
2311         return pci_pme_capable(dev, PCI_D3cold) ?
2312                         pci_enable_wake(dev, PCI_D3cold, enable) :
2313                         pci_enable_wake(dev, PCI_D3hot, enable);
2314 }
2315 EXPORT_SYMBOL(pci_wake_from_d3);
2316
2317 /**
2318  * pci_target_state - find an appropriate low power state for a given PCI dev
2319  * @dev: PCI device
2320  * @wakeup: Whether or not wakeup functionality will be enabled for the device.
2321  *
2322  * Use underlying platform code to find a supported low power state for @dev.
2323  * If the platform can't manage @dev, return the deepest state from which it
2324  * can generate wake events, based on any available PME info.
2325  */
2326 static pci_power_t pci_target_state(struct pci_dev *dev, bool wakeup)
2327 {
2328         pci_power_t target_state = PCI_D3hot;
2329
2330         if (platform_pci_power_manageable(dev)) {
2331                 /*
2332                  * Call the platform to find the target state for the device.
2333                  */
2334                 pci_power_t state = platform_pci_choose_state(dev);
2335
2336                 switch (state) {
2337                 case PCI_POWER_ERROR:
2338                 case PCI_UNKNOWN:
2339                         break;
2340                 case PCI_D1:
2341                 case PCI_D2:
2342                         if (pci_no_d1d2(dev))
2343                                 break;
2344                         /* else, fall through */
2345                 default:
2346                         target_state = state;
2347                 }
2348
2349                 return target_state;
2350         }
2351
2352         if (!dev->pm_cap)
2353                 target_state = PCI_D0;
2354
2355         /*
2356          * If the device is in D3cold even though it's not power-manageable by
2357          * the platform, it may have been powered down by non-standard means.
2358          * Best to let it slumber.
2359          */
2360         if (dev->current_state == PCI_D3cold)
2361                 target_state = PCI_D3cold;
2362
2363         if (wakeup && dev->pme_support) {
2364                 pci_power_t state = target_state;
2365
2366                 /*
2367                  * Find the deepest state from which the device can generate
2368                  * PME#.
2369                  */
2370                 while (state && !(dev->pme_support & (1 << state)))
2371                         state--;
2372
2373                 if (state)
2374                         return state;
2375                 else if (dev->pme_support & 1)
2376                         return PCI_D0;
2377         }
2378
2379         return target_state;
2380 }
2381
2382 /**
2383  * pci_prepare_to_sleep - prepare PCI device for system-wide transition
2384  *                        into a sleep state
2385  * @dev: Device to handle.
2386  *
2387  * Choose the power state appropriate for the device depending on whether
2388  * it can wake up the system and/or is power manageable by the platform
2389  * (PCI_D3hot is the default) and put the device into that state.
2390  */
2391 int pci_prepare_to_sleep(struct pci_dev *dev)
2392 {
2393         bool wakeup = device_may_wakeup(&dev->dev);
2394         pci_power_t target_state = pci_target_state(dev, wakeup);
2395         int error;
2396
2397         if (target_state == PCI_POWER_ERROR)
2398                 return -EIO;
2399
2400         pci_enable_wake(dev, target_state, wakeup);
2401
2402         error = pci_set_power_state(dev, target_state);
2403
2404         if (error)
2405                 pci_enable_wake(dev, target_state, false);
2406
2407         return error;
2408 }
2409 EXPORT_SYMBOL(pci_prepare_to_sleep);
2410
2411 /**
2412  * pci_back_from_sleep - turn PCI device on during system-wide transition
2413  *                       into working state
2414  * @dev: Device to handle.
2415  *
2416  * Disable device's system wake-up capability and put it into D0.
2417  */
2418 int pci_back_from_sleep(struct pci_dev *dev)
2419 {
2420         pci_enable_wake(dev, PCI_D0, false);
2421         return pci_set_power_state(dev, PCI_D0);
2422 }
2423 EXPORT_SYMBOL(pci_back_from_sleep);
2424
2425 /**
2426  * pci_finish_runtime_suspend - Carry out PCI-specific part of runtime suspend.
2427  * @dev: PCI device being suspended.
2428  *
2429  * Prepare @dev to generate wake-up events at run time and put it into a low
2430  * power state.
2431  */
2432 int pci_finish_runtime_suspend(struct pci_dev *dev)
2433 {
2434         pci_power_t target_state;
2435         int error;
2436
2437         target_state = pci_target_state(dev, device_can_wakeup(&dev->dev));
2438         if (target_state == PCI_POWER_ERROR)
2439                 return -EIO;
2440
2441         dev->runtime_d3cold = target_state == PCI_D3cold;
2442
2443         __pci_enable_wake(dev, target_state, pci_dev_run_wake(dev));
2444
2445         error = pci_set_power_state(dev, target_state);
2446
2447         if (error) {
2448                 pci_enable_wake(dev, target_state, false);
2449                 dev->runtime_d3cold = false;
2450         }
2451
2452         return error;
2453 }
2454
2455 /**
2456  * pci_dev_run_wake - Check if device can generate run-time wake-up events.
2457  * @dev: Device to check.
2458  *
2459  * Return true if the device itself is capable of generating wake-up events
2460  * (through the platform or using the native PCIe PME) or if the device supports
2461  * PME and one of its upstream bridges can generate wake-up events.
2462  */
2463 bool pci_dev_run_wake(struct pci_dev *dev)
2464 {
2465         struct pci_bus *bus = dev->bus;
2466
2467         if (!dev->pme_support)
2468                 return false;
2469
2470         /* PME-capable in principle, but not from the target power state */
2471         if (!pci_pme_capable(dev, pci_target_state(dev, true)))
2472                 return false;
2473
2474         if (device_can_wakeup(&dev->dev))
2475                 return true;
2476
2477         while (bus->parent) {
2478                 struct pci_dev *bridge = bus->self;
2479
2480                 if (device_can_wakeup(&bridge->dev))
2481                         return true;
2482
2483                 bus = bus->parent;
2484         }
2485
2486         /* We have reached the root bus. */
2487         if (bus->bridge)
2488                 return device_can_wakeup(bus->bridge);
2489
2490         return false;
2491 }
2492 EXPORT_SYMBOL_GPL(pci_dev_run_wake);
2493
2494 /**
2495  * pci_dev_need_resume - Check if it is necessary to resume the device.
2496  * @pci_dev: Device to check.
2497  *
2498  * Return 'true' if the device is not runtime-suspended or it has to be
2499  * reconfigured due to wakeup settings difference between system and runtime
2500  * suspend, or the current power state of it is not suitable for the upcoming
2501  * (system-wide) transition.
2502  */
2503 bool pci_dev_need_resume(struct pci_dev *pci_dev)
2504 {
2505         struct device *dev = &pci_dev->dev;
2506         pci_power_t target_state;
2507
2508         if (!pm_runtime_suspended(dev) || platform_pci_need_resume(pci_dev))
2509                 return true;
2510
2511         target_state = pci_target_state(pci_dev, device_may_wakeup(dev));
2512
2513         /*
2514          * If the earlier platform check has not triggered, D3cold is just power
2515          * removal on top of D3hot, so no need to resume the device in that
2516          * case.
2517          */
2518         return target_state != pci_dev->current_state &&
2519                 target_state != PCI_D3cold &&
2520                 pci_dev->current_state != PCI_D3hot;
2521 }
2522
2523 /**
2524  * pci_dev_adjust_pme - Adjust PME setting for a suspended device.
2525  * @pci_dev: Device to check.
2526  *
2527  * If the device is suspended and it is not configured for system wakeup,
2528  * disable PME for it to prevent it from waking up the system unnecessarily.
2529  *
2530  * Note that if the device's power state is D3cold and the platform check in
2531  * pci_dev_need_resume() has not triggered, the device's configuration need not
2532  * be changed.
2533  */
2534 void pci_dev_adjust_pme(struct pci_dev *pci_dev)
2535 {
2536         struct device *dev = &pci_dev->dev;
2537
2538         spin_lock_irq(&dev->power.lock);
2539
2540         if (pm_runtime_suspended(dev) && !device_may_wakeup(dev) &&
2541             pci_dev->current_state < PCI_D3cold)
2542                 __pci_pme_active(pci_dev, false);
2543
2544         spin_unlock_irq(&dev->power.lock);
2545 }
2546
2547 /**
2548  * pci_dev_complete_resume - Finalize resume from system sleep for a device.
2549  * @pci_dev: Device to handle.
2550  *
2551  * If the device is runtime suspended and wakeup-capable, enable PME for it as
2552  * it might have been disabled during the prepare phase of system suspend if
2553  * the device was not configured for system wakeup.
2554  */
2555 void pci_dev_complete_resume(struct pci_dev *pci_dev)
2556 {
2557         struct device *dev = &pci_dev->dev;
2558
2559         if (!pci_dev_run_wake(pci_dev))
2560                 return;
2561
2562         spin_lock_irq(&dev->power.lock);
2563
2564         if (pm_runtime_suspended(dev) && pci_dev->current_state < PCI_D3cold)
2565                 __pci_pme_active(pci_dev, true);
2566
2567         spin_unlock_irq(&dev->power.lock);
2568 }
2569
2570 void pci_config_pm_runtime_get(struct pci_dev *pdev)
2571 {
2572         struct device *dev = &pdev->dev;
2573         struct device *parent = dev->parent;
2574
2575         if (parent)
2576                 pm_runtime_get_sync(parent);
2577         pm_runtime_get_noresume(dev);
2578         /*
2579          * pdev->current_state is set to PCI_D3cold during suspending,
2580          * so wait until suspending completes
2581          */
2582         pm_runtime_barrier(dev);
2583         /*
2584          * Only need to resume devices in D3cold, because config
2585          * registers are still accessible for devices suspended but
2586          * not in D3cold.
2587          */
2588         if (pdev->current_state == PCI_D3cold)
2589                 pm_runtime_resume(dev);
2590 }
2591
2592 void pci_config_pm_runtime_put(struct pci_dev *pdev)
2593 {
2594         struct device *dev = &pdev->dev;
2595         struct device *parent = dev->parent;
2596
2597         pm_runtime_put(dev);
2598         if (parent)
2599                 pm_runtime_put_sync(parent);
2600 }
2601
2602 static const struct dmi_system_id bridge_d3_blacklist[] = {
2603 #ifdef CONFIG_X86
2604         {
2605                 /*
2606                  * Gigabyte X299 root port is not marked as hotplug capable
2607                  * which allows Linux to power manage it.  However, this
2608                  * confuses the BIOS SMI handler so don't power manage root
2609                  * ports on that system.
2610                  */
2611                 .ident = "X299 DESIGNARE EX-CF",
2612                 .matches = {
2613                         DMI_MATCH(DMI_BOARD_VENDOR, "Gigabyte Technology Co., Ltd."),
2614                         DMI_MATCH(DMI_BOARD_NAME, "X299 DESIGNARE EX-CF"),
2615                 },
2616         },
2617         {
2618                 /*
2619                  * Downstream device is not accessible after putting a root port
2620                  * into D3cold and back into D0 on Elo i2.
2621                  */
2622                 .ident = "Elo i2",
2623                 .matches = {
2624                         DMI_MATCH(DMI_SYS_VENDOR, "Elo Touch Solutions"),
2625                         DMI_MATCH(DMI_PRODUCT_NAME, "Elo i2"),
2626                         DMI_MATCH(DMI_PRODUCT_VERSION, "RevB"),
2627                 },
2628         },
2629 #endif
2630         { }
2631 };
2632
2633 /**
2634  * pci_bridge_d3_possible - Is it possible to put the bridge into D3
2635  * @bridge: Bridge to check
2636  *
2637  * This function checks if it is possible to move the bridge to D3.
2638  * Currently we only allow D3 for recent enough PCIe ports and Thunderbolt.
2639  */
2640 bool pci_bridge_d3_possible(struct pci_dev *bridge)
2641 {
2642         if (!pci_is_pcie(bridge))
2643                 return false;
2644
2645         switch (pci_pcie_type(bridge)) {
2646         case PCI_EXP_TYPE_ROOT_PORT:
2647         case PCI_EXP_TYPE_UPSTREAM:
2648         case PCI_EXP_TYPE_DOWNSTREAM:
2649                 if (pci_bridge_d3_disable)
2650                         return false;
2651
2652                 /*
2653                  * Hotplug ports handled by firmware in System Management Mode
2654                  * may not be put into D3 by the OS (Thunderbolt on non-Macs).
2655                  */
2656                 if (bridge->is_hotplug_bridge && !pciehp_is_native(bridge))
2657                         return false;
2658
2659                 if (pci_bridge_d3_force)
2660                         return true;
2661
2662                 /* Even the oldest 2010 Thunderbolt controller supports D3. */
2663                 if (bridge->is_thunderbolt)
2664                         return true;
2665
2666                 /* Platform might know better if the bridge supports D3 */
2667                 if (platform_pci_bridge_d3(bridge))
2668                         return true;
2669
2670                 /*
2671                  * Hotplug ports handled natively by the OS were not validated
2672                  * by vendors for runtime D3 at least until 2018 because there
2673                  * was no OS support.
2674                  */
2675                 if (bridge->is_hotplug_bridge)
2676                         return false;
2677
2678                 if (dmi_check_system(bridge_d3_blacklist))
2679                         return false;
2680
2681                 /*
2682                  * It should be safe to put PCIe ports from 2015 or newer
2683                  * to D3.
2684                  */
2685                 if (dmi_get_bios_year() >= 2015)
2686                         return true;
2687                 break;
2688         }
2689
2690         return false;
2691 }
2692
2693 static int pci_dev_check_d3cold(struct pci_dev *dev, void *data)
2694 {
2695         bool *d3cold_ok = data;
2696
2697         if (/* The device needs to be allowed to go D3cold ... */
2698             dev->no_d3cold || !dev->d3cold_allowed ||
2699
2700             /* ... and if it is wakeup capable to do so from D3cold. */
2701             (device_may_wakeup(&dev->dev) &&
2702              !pci_pme_capable(dev, PCI_D3cold)) ||
2703
2704             /* If it is a bridge it must be allowed to go to D3. */
2705             !pci_power_manageable(dev))
2706
2707                 *d3cold_ok = false;
2708
2709         return !*d3cold_ok;
2710 }
2711
2712 /*
2713  * pci_bridge_d3_update - Update bridge D3 capabilities
2714  * @dev: PCI device which is changed
2715  *
2716  * Update upstream bridge PM capabilities accordingly depending on if the
2717  * device PM configuration was changed or the device is being removed.  The
2718  * change is also propagated upstream.
2719  */
2720 void pci_bridge_d3_update(struct pci_dev *dev)
2721 {
2722         bool remove = !device_is_registered(&dev->dev);
2723         struct pci_dev *bridge;
2724         bool d3cold_ok = true;
2725
2726         bridge = pci_upstream_bridge(dev);
2727         if (!bridge || !pci_bridge_d3_possible(bridge))
2728                 return;
2729
2730         /*
2731          * If D3 is currently allowed for the bridge, removing one of its
2732          * children won't change that.
2733          */
2734         if (remove && bridge->bridge_d3)
2735                 return;
2736
2737         /*
2738          * If D3 is currently allowed for the bridge and a child is added or
2739          * changed, disallowance of D3 can only be caused by that child, so
2740          * we only need to check that single device, not any of its siblings.
2741          *
2742          * If D3 is currently not allowed for the bridge, checking the device
2743          * first may allow us to skip checking its siblings.
2744          */
2745         if (!remove)
2746                 pci_dev_check_d3cold(dev, &d3cold_ok);
2747
2748         /*
2749          * If D3 is currently not allowed for the bridge, this may be caused
2750          * either by the device being changed/removed or any of its siblings,
2751          * so we need to go through all children to find out if one of them
2752          * continues to block D3.
2753          */
2754         if (d3cold_ok && !bridge->bridge_d3)
2755                 pci_walk_bus(bridge->subordinate, pci_dev_check_d3cold,
2756                              &d3cold_ok);
2757
2758         if (bridge->bridge_d3 != d3cold_ok) {
2759                 bridge->bridge_d3 = d3cold_ok;
2760                 /* Propagate change to upstream bridges */
2761                 pci_bridge_d3_update(bridge);
2762         }
2763 }
2764
2765 /**
2766  * pci_d3cold_enable - Enable D3cold for device
2767  * @dev: PCI device to handle
2768  *
2769  * This function can be used in drivers to enable D3cold from the device
2770  * they handle.  It also updates upstream PCI bridge PM capabilities
2771  * accordingly.
2772  */
2773 void pci_d3cold_enable(struct pci_dev *dev)
2774 {
2775         if (dev->no_d3cold) {
2776                 dev->no_d3cold = false;
2777                 pci_bridge_d3_update(dev);
2778         }
2779 }
2780 EXPORT_SYMBOL_GPL(pci_d3cold_enable);
2781
2782 /**
2783  * pci_d3cold_disable - Disable D3cold for device
2784  * @dev: PCI device to handle
2785  *
2786  * This function can be used in drivers to disable D3cold from the device
2787  * they handle.  It also updates upstream PCI bridge PM capabilities
2788  * accordingly.
2789  */
2790 void pci_d3cold_disable(struct pci_dev *dev)
2791 {
2792         if (!dev->no_d3cold) {
2793                 dev->no_d3cold = true;
2794                 pci_bridge_d3_update(dev);
2795         }
2796 }
2797 EXPORT_SYMBOL_GPL(pci_d3cold_disable);
2798
2799 /**
2800  * pci_pm_init - Initialize PM functions of given PCI device
2801  * @dev: PCI device to handle.
2802  */
2803 void pci_pm_init(struct pci_dev *dev)
2804 {
2805         int pm;
2806         u16 status;
2807         u16 pmc;
2808
2809         pm_runtime_forbid(&dev->dev);
2810         pm_runtime_set_active(&dev->dev);
2811         pm_runtime_enable(&dev->dev);
2812         device_enable_async_suspend(&dev->dev);
2813         dev->wakeup_prepared = false;
2814
2815         dev->pm_cap = 0;
2816         dev->pme_support = 0;
2817
2818         /* find PCI PM capability in list */
2819         pm = pci_find_capability(dev, PCI_CAP_ID_PM);
2820         if (!pm)
2821                 return;
2822         /* Check device's ability to generate PME# */
2823         pci_read_config_word(dev, pm + PCI_PM_PMC, &pmc);
2824
2825         if ((pmc & PCI_PM_CAP_VER_MASK) > 3) {
2826                 pci_err(dev, "unsupported PM cap regs version (%u)\n",
2827                         pmc & PCI_PM_CAP_VER_MASK);
2828                 return;
2829         }
2830
2831         dev->pm_cap = pm;
2832         dev->d3_delay = PCI_PM_D3_WAIT;
2833         dev->d3cold_delay = PCI_PM_D3COLD_WAIT;
2834         dev->bridge_d3 = pci_bridge_d3_possible(dev);
2835         dev->d3cold_allowed = true;
2836
2837         dev->d1_support = false;
2838         dev->d2_support = false;
2839         if (!pci_no_d1d2(dev)) {
2840                 if (pmc & PCI_PM_CAP_D1)
2841                         dev->d1_support = true;
2842                 if (pmc & PCI_PM_CAP_D2)
2843                         dev->d2_support = true;
2844
2845                 if (dev->d1_support || dev->d2_support)
2846                         pci_info(dev, "supports%s%s\n",
2847                                    dev->d1_support ? " D1" : "",
2848                                    dev->d2_support ? " D2" : "");
2849         }
2850
2851         pmc &= PCI_PM_CAP_PME_MASK;
2852         if (pmc) {
2853                 pci_info(dev, "PME# supported from%s%s%s%s%s\n",
2854                          (pmc & PCI_PM_CAP_PME_D0) ? " D0" : "",
2855                          (pmc & PCI_PM_CAP_PME_D1) ? " D1" : "",
2856                          (pmc & PCI_PM_CAP_PME_D2) ? " D2" : "",
2857                          (pmc & PCI_PM_CAP_PME_D3) ? " D3hot" : "",
2858                          (pmc & PCI_PM_CAP_PME_D3cold) ? " D3cold" : "");
2859                 dev->pme_support = pmc >> PCI_PM_CAP_PME_SHIFT;
2860                 dev->pme_poll = true;
2861                 /*
2862                  * Make device's PM flags reflect the wake-up capability, but
2863                  * let the user space enable it to wake up the system as needed.
2864                  */
2865                 device_set_wakeup_capable(&dev->dev, true);
2866                 /* Disable the PME# generation functionality */
2867                 pci_pme_active(dev, false);
2868         }
2869
2870         pci_read_config_word(dev, PCI_STATUS, &status);
2871         if (status & PCI_STATUS_IMM_READY)
2872                 dev->imm_ready = 1;
2873 }
2874
2875 static unsigned long pci_ea_flags(struct pci_dev *dev, u8 prop)
2876 {
2877         unsigned long flags = IORESOURCE_PCI_FIXED | IORESOURCE_PCI_EA_BEI;
2878
2879         switch (prop) {
2880         case PCI_EA_P_MEM:
2881         case PCI_EA_P_VF_MEM:
2882                 flags |= IORESOURCE_MEM;
2883                 break;
2884         case PCI_EA_P_MEM_PREFETCH:
2885         case PCI_EA_P_VF_MEM_PREFETCH:
2886                 flags |= IORESOURCE_MEM | IORESOURCE_PREFETCH;
2887                 break;
2888         case PCI_EA_P_IO:
2889                 flags |= IORESOURCE_IO;
2890                 break;
2891         default:
2892                 return 0;
2893         }
2894
2895         return flags;
2896 }
2897
2898 static struct resource *pci_ea_get_resource(struct pci_dev *dev, u8 bei,
2899                                             u8 prop)
2900 {
2901         if (bei <= PCI_EA_BEI_BAR5 && prop <= PCI_EA_P_IO)
2902                 return &dev->resource[bei];
2903 #ifdef CONFIG_PCI_IOV
2904         else if (bei >= PCI_EA_BEI_VF_BAR0 && bei <= PCI_EA_BEI_VF_BAR5 &&
2905                  (prop == PCI_EA_P_VF_MEM || prop == PCI_EA_P_VF_MEM_PREFETCH))
2906                 return &dev->resource[PCI_IOV_RESOURCES +
2907                                       bei - PCI_EA_BEI_VF_BAR0];
2908 #endif
2909         else if (bei == PCI_EA_BEI_ROM)
2910                 return &dev->resource[PCI_ROM_RESOURCE];
2911         else
2912                 return NULL;
2913 }
2914
2915 /* Read an Enhanced Allocation (EA) entry */
2916 static int pci_ea_read(struct pci_dev *dev, int offset)
2917 {
2918         struct resource *res;
2919         int ent_size, ent_offset = offset;
2920         resource_size_t start, end;
2921         unsigned long flags;
2922         u32 dw0, bei, base, max_offset;
2923         u8 prop;
2924         bool support_64 = (sizeof(resource_size_t) >= 8);
2925
2926         pci_read_config_dword(dev, ent_offset, &dw0);
2927         ent_offset += 4;
2928
2929         /* Entry size field indicates DWORDs after 1st */
2930         ent_size = ((dw0 & PCI_EA_ES) + 1) << 2;
2931
2932         if (!(dw0 & PCI_EA_ENABLE)) /* Entry not enabled */
2933                 goto out;
2934
2935         bei = (dw0 & PCI_EA_BEI) >> 4;
2936         prop = (dw0 & PCI_EA_PP) >> 8;
2937
2938         /*
2939          * If the Property is in the reserved range, try the Secondary
2940          * Property instead.
2941          */
2942         if (prop > PCI_EA_P_BRIDGE_IO && prop < PCI_EA_P_MEM_RESERVED)
2943                 prop = (dw0 & PCI_EA_SP) >> 16;
2944         if (prop > PCI_EA_P_BRIDGE_IO)
2945                 goto out;
2946
2947         res = pci_ea_get_resource(dev, bei, prop);
2948         if (!res) {
2949                 pci_err(dev, "Unsupported EA entry BEI: %u\n", bei);
2950                 goto out;
2951         }
2952
2953         flags = pci_ea_flags(dev, prop);
2954         if (!flags) {
2955                 pci_err(dev, "Unsupported EA properties: %#x\n", prop);
2956                 goto out;
2957         }
2958
2959         /* Read Base */
2960         pci_read_config_dword(dev, ent_offset, &base);
2961         start = (base & PCI_EA_FIELD_MASK);
2962         ent_offset += 4;
2963
2964         /* Read MaxOffset */
2965         pci_read_config_dword(dev, ent_offset, &max_offset);
2966         ent_offset += 4;
2967
2968         /* Read Base MSBs (if 64-bit entry) */
2969         if (base & PCI_EA_IS_64) {
2970                 u32 base_upper;
2971
2972                 pci_read_config_dword(dev, ent_offset, &base_upper);
2973                 ent_offset += 4;
2974
2975                 flags |= IORESOURCE_MEM_64;
2976
2977                 /* entry starts above 32-bit boundary, can't use */
2978                 if (!support_64 && base_upper)
2979                         goto out;
2980
2981                 if (support_64)
2982                         start |= ((u64)base_upper << 32);
2983         }
2984
2985         end = start + (max_offset | 0x03);
2986
2987         /* Read MaxOffset MSBs (if 64-bit entry) */
2988         if (max_offset & PCI_EA_IS_64) {
2989                 u32 max_offset_upper;
2990
2991                 pci_read_config_dword(dev, ent_offset, &max_offset_upper);
2992                 ent_offset += 4;
2993
2994                 flags |= IORESOURCE_MEM_64;
2995
2996                 /* entry too big, can't use */
2997                 if (!support_64 && max_offset_upper)
2998                         goto out;
2999
3000                 if (support_64)
3001                         end += ((u64)max_offset_upper << 32);
3002         }
3003
3004         if (end < start) {
3005                 pci_err(dev, "EA Entry crosses address boundary\n");
3006                 goto out;
3007         }
3008
3009         if (ent_size != ent_offset - offset) {
3010                 pci_err(dev, "EA Entry Size (%d) does not match length read (%d)\n",
3011                         ent_size, ent_offset - offset);
3012                 goto out;
3013         }
3014
3015         res->name = pci_name(dev);
3016         res->start = start;
3017         res->end = end;
3018         res->flags = flags;
3019
3020         if (bei <= PCI_EA_BEI_BAR5)
3021                 pci_info(dev, "BAR %d: %pR (from Enhanced Allocation, properties %#02x)\n",
3022                            bei, res, prop);
3023         else if (bei == PCI_EA_BEI_ROM)
3024                 pci_info(dev, "ROM: %pR (from Enhanced Allocation, properties %#02x)\n",
3025                            res, prop);
3026         else if (bei >= PCI_EA_BEI_VF_BAR0 && bei <= PCI_EA_BEI_VF_BAR5)
3027                 pci_info(dev, "VF BAR %d: %pR (from Enhanced Allocation, properties %#02x)\n",
3028                            bei - PCI_EA_BEI_VF_BAR0, res, prop);
3029         else
3030                 pci_info(dev, "BEI %d res: %pR (from Enhanced Allocation, properties %#02x)\n",
3031                            bei, res, prop);
3032
3033 out:
3034         return offset + ent_size;
3035 }
3036
3037 /* Enhanced Allocation Initialization */
3038 void pci_ea_init(struct pci_dev *dev)
3039 {
3040         int ea;
3041         u8 num_ent;
3042         int offset;
3043         int i;
3044
3045         /* find PCI EA capability in list */
3046         ea = pci_find_capability(dev, PCI_CAP_ID_EA);
3047         if (!ea)
3048                 return;
3049
3050         /* determine the number of entries */
3051         pci_bus_read_config_byte(dev->bus, dev->devfn, ea + PCI_EA_NUM_ENT,
3052                                         &num_ent);
3053         num_ent &= PCI_EA_NUM_ENT_MASK;
3054
3055         offset = ea + PCI_EA_FIRST_ENT;
3056
3057         /* Skip DWORD 2 for type 1 functions */
3058         if (dev->hdr_type == PCI_HEADER_TYPE_BRIDGE)
3059                 offset += 4;
3060
3061         /* parse each EA entry */
3062         for (i = 0; i < num_ent; ++i)
3063                 offset = pci_ea_read(dev, offset);
3064 }
3065
3066 static void pci_add_saved_cap(struct pci_dev *pci_dev,
3067         struct pci_cap_saved_state *new_cap)
3068 {
3069         hlist_add_head(&new_cap->next, &pci_dev->saved_cap_space);
3070 }
3071
3072 /**
3073  * _pci_add_cap_save_buffer - allocate buffer for saving given
3074  *                            capability registers
3075  * @dev: the PCI device
3076  * @cap: the capability to allocate the buffer for
3077  * @extended: Standard or Extended capability ID
3078  * @size: requested size of the buffer
3079  */
3080 static int _pci_add_cap_save_buffer(struct pci_dev *dev, u16 cap,
3081                                     bool extended, unsigned int size)
3082 {
3083         int pos;
3084         struct pci_cap_saved_state *save_state;
3085
3086         if (extended)
3087                 pos = pci_find_ext_capability(dev, cap);
3088         else
3089                 pos = pci_find_capability(dev, cap);
3090
3091         if (!pos)
3092                 return 0;
3093
3094         save_state = kzalloc(sizeof(*save_state) + size, GFP_KERNEL);
3095         if (!save_state)
3096                 return -ENOMEM;
3097
3098         save_state->cap.cap_nr = cap;
3099         save_state->cap.cap_extended = extended;
3100         save_state->cap.size = size;
3101         pci_add_saved_cap(dev, save_state);
3102
3103         return 0;
3104 }
3105
3106 int pci_add_cap_save_buffer(struct pci_dev *dev, char cap, unsigned int size)
3107 {
3108         return _pci_add_cap_save_buffer(dev, cap, false, size);
3109 }
3110
3111 int pci_add_ext_cap_save_buffer(struct pci_dev *dev, u16 cap, unsigned int size)
3112 {
3113         return _pci_add_cap_save_buffer(dev, cap, true, size);
3114 }
3115
3116 /**
3117  * pci_allocate_cap_save_buffers - allocate buffers for saving capabilities
3118  * @dev: the PCI device
3119  */
3120 void pci_allocate_cap_save_buffers(struct pci_dev *dev)
3121 {
3122         int error;
3123
3124         error = pci_add_cap_save_buffer(dev, PCI_CAP_ID_EXP,
3125                                         PCI_EXP_SAVE_REGS * sizeof(u16));
3126         if (error)
3127                 pci_err(dev, "unable to preallocate PCI Express save buffer\n");
3128
3129         error = pci_add_cap_save_buffer(dev, PCI_CAP_ID_PCIX, sizeof(u16));
3130         if (error)
3131                 pci_err(dev, "unable to preallocate PCI-X save buffer\n");
3132
3133         error = pci_add_ext_cap_save_buffer(dev, PCI_EXT_CAP_ID_LTR,
3134                                             2 * sizeof(u16));
3135         if (error)
3136                 pci_err(dev, "unable to allocate suspend buffer for LTR\n");
3137
3138         pci_allocate_vc_save_buffers(dev);
3139 }
3140
3141 void pci_free_cap_save_buffers(struct pci_dev *dev)
3142 {
3143         struct pci_cap_saved_state *tmp;
3144         struct hlist_node *n;
3145
3146         hlist_for_each_entry_safe(tmp, n, &dev->saved_cap_space, next)
3147                 kfree(tmp);
3148 }
3149
3150 /**
3151  * pci_configure_ari - enable or disable ARI forwarding
3152  * @dev: the PCI device
3153  *
3154  * If @dev and its upstream bridge both support ARI, enable ARI in the
3155  * bridge.  Otherwise, disable ARI in the bridge.
3156  */
3157 void pci_configure_ari(struct pci_dev *dev)
3158 {
3159         u32 cap;
3160         struct pci_dev *bridge;
3161
3162         if (pcie_ari_disabled || !pci_is_pcie(dev) || dev->devfn)
3163                 return;
3164
3165         bridge = dev->bus->self;
3166         if (!bridge)
3167                 return;
3168
3169         pcie_capability_read_dword(bridge, PCI_EXP_DEVCAP2, &cap);
3170         if (!(cap & PCI_EXP_DEVCAP2_ARI))
3171                 return;
3172
3173         if (pci_find_ext_capability(dev, PCI_EXT_CAP_ID_ARI)) {
3174                 pcie_capability_set_word(bridge, PCI_EXP_DEVCTL2,
3175                                          PCI_EXP_DEVCTL2_ARI);
3176                 bridge->ari_enabled = 1;
3177         } else {
3178                 pcie_capability_clear_word(bridge, PCI_EXP_DEVCTL2,
3179                                            PCI_EXP_DEVCTL2_ARI);
3180                 bridge->ari_enabled = 0;
3181         }
3182 }
3183
3184 static int pci_acs_enable;
3185
3186 /**
3187  * pci_request_acs - ask for ACS to be enabled if supported
3188  */
3189 void pci_request_acs(void)
3190 {
3191         pci_acs_enable = 1;
3192 }
3193
3194 static const char *disable_acs_redir_param;
3195
3196 /**
3197  * pci_disable_acs_redir - disable ACS redirect capabilities
3198  * @dev: the PCI device
3199  *
3200  * For only devices specified in the disable_acs_redir parameter.
3201  */
3202 static void pci_disable_acs_redir(struct pci_dev *dev)
3203 {
3204         int ret = 0;
3205         const char *p;
3206         int pos;
3207         u16 ctrl;
3208
3209         if (!disable_acs_redir_param)
3210                 return;
3211
3212         p = disable_acs_redir_param;
3213         while (*p) {
3214                 ret = pci_dev_str_match(dev, p, &p);
3215                 if (ret < 0) {
3216                         pr_info_once("PCI: Can't parse disable_acs_redir parameter: %s\n",
3217                                      disable_acs_redir_param);
3218
3219                         break;
3220                 } else if (ret == 1) {
3221                         /* Found a match */
3222                         break;
3223                 }
3224
3225                 if (*p != ';' && *p != ',') {
3226                         /* End of param or invalid format */
3227                         break;
3228                 }
3229                 p++;
3230         }
3231
3232         if (ret != 1)
3233                 return;
3234
3235         if (!pci_dev_specific_disable_acs_redir(dev))
3236                 return;
3237
3238         pos = pci_find_ext_capability(dev, PCI_EXT_CAP_ID_ACS);
3239         if (!pos) {
3240                 pci_warn(dev, "cannot disable ACS redirect for this hardware as it does not have ACS capabilities\n");
3241                 return;
3242         }
3243
3244         pci_read_config_word(dev, pos + PCI_ACS_CTRL, &ctrl);
3245
3246         /* P2P Request & Completion Redirect */
3247         ctrl &= ~(PCI_ACS_RR | PCI_ACS_CR | PCI_ACS_EC);
3248
3249         pci_write_config_word(dev, pos + PCI_ACS_CTRL, ctrl);
3250
3251         pci_info(dev, "disabled ACS redirect\n");
3252 }
3253
3254 /**
3255  * pci_std_enable_acs - enable ACS on devices using standard ACS capabilities
3256  * @dev: the PCI device
3257  */
3258 static void pci_std_enable_acs(struct pci_dev *dev)
3259 {
3260         int pos;
3261         u16 cap;
3262         u16 ctrl;
3263
3264         pos = pci_find_ext_capability(dev, PCI_EXT_CAP_ID_ACS);
3265         if (!pos)
3266                 return;
3267
3268         pci_read_config_word(dev, pos + PCI_ACS_CAP, &cap);
3269         pci_read_config_word(dev, pos + PCI_ACS_CTRL, &ctrl);
3270
3271         /* Source Validation */
3272         ctrl |= (cap & PCI_ACS_SV);
3273
3274         /* P2P Request Redirect */
3275         ctrl |= (cap & PCI_ACS_RR);
3276
3277         /* P2P Completion Redirect */
3278         ctrl |= (cap & PCI_ACS_CR);
3279
3280         /* Upstream Forwarding */
3281         ctrl |= (cap & PCI_ACS_UF);
3282
3283         pci_write_config_word(dev, pos + PCI_ACS_CTRL, ctrl);
3284 }
3285
3286 /**
3287  * pci_enable_acs - enable ACS if hardware support it
3288  * @dev: the PCI device
3289  */
3290 void pci_enable_acs(struct pci_dev *dev)
3291 {
3292         if (!pci_acs_enable)
3293                 goto disable_acs_redir;
3294
3295         if (!pci_dev_specific_enable_acs(dev))
3296                 goto disable_acs_redir;
3297
3298         pci_std_enable_acs(dev);
3299
3300 disable_acs_redir:
3301         /*
3302          * Note: pci_disable_acs_redir() must be called even if ACS was not
3303          * enabled by the kernel because it may have been enabled by
3304          * platform firmware.  So if we are told to disable it, we should
3305          * always disable it after setting the kernel's default
3306          * preferences.
3307          */
3308         pci_disable_acs_redir(dev);
3309 }
3310
3311 static bool pci_acs_flags_enabled(struct pci_dev *pdev, u16 acs_flags)
3312 {
3313         int pos;
3314         u16 cap, ctrl;
3315
3316         pos = pci_find_ext_capability(pdev, PCI_EXT_CAP_ID_ACS);
3317         if (!pos)
3318                 return false;
3319
3320         /*
3321          * Except for egress control, capabilities are either required
3322          * or only required if controllable.  Features missing from the
3323          * capability field can therefore be assumed as hard-wired enabled.
3324          */
3325         pci_read_config_word(pdev, pos + PCI_ACS_CAP, &cap);
3326         acs_flags &= (cap | PCI_ACS_EC);
3327
3328         pci_read_config_word(pdev, pos + PCI_ACS_CTRL, &ctrl);
3329         return (ctrl & acs_flags) == acs_flags;
3330 }
3331
3332 /**
3333  * pci_acs_enabled - test ACS against required flags for a given device
3334  * @pdev: device to test
3335  * @acs_flags: required PCI ACS flags
3336  *
3337  * Return true if the device supports the provided flags.  Automatically
3338  * filters out flags that are not implemented on multifunction devices.
3339  *
3340  * Note that this interface checks the effective ACS capabilities of the
3341  * device rather than the actual capabilities.  For instance, most single
3342  * function endpoints are not required to support ACS because they have no
3343  * opportunity for peer-to-peer access.  We therefore return 'true'
3344  * regardless of whether the device exposes an ACS capability.  This makes
3345  * it much easier for callers of this function to ignore the actual type
3346  * or topology of the device when testing ACS support.
3347  */
3348 bool pci_acs_enabled(struct pci_dev *pdev, u16 acs_flags)
3349 {
3350         int ret;
3351
3352         ret = pci_dev_specific_acs_enabled(pdev, acs_flags);
3353         if (ret >= 0)
3354                 return ret > 0;
3355
3356         /*
3357          * Conventional PCI and PCI-X devices never support ACS, either
3358          * effectively or actually.  The shared bus topology implies that
3359          * any device on the bus can receive or snoop DMA.
3360          */
3361         if (!pci_is_pcie(pdev))
3362                 return false;
3363
3364         switch (pci_pcie_type(pdev)) {
3365         /*
3366          * PCI/X-to-PCIe bridges are not specifically mentioned by the spec,
3367          * but since their primary interface is PCI/X, we conservatively
3368          * handle them as we would a non-PCIe device.
3369          */
3370         case PCI_EXP_TYPE_PCIE_BRIDGE:
3371         /*
3372          * PCIe 3.0, 6.12.1 excludes ACS on these devices.  "ACS is never
3373          * applicable... must never implement an ACS Extended Capability...".
3374          * This seems arbitrary, but we take a conservative interpretation
3375          * of this statement.
3376          */
3377         case PCI_EXP_TYPE_PCI_BRIDGE:
3378         case PCI_EXP_TYPE_RC_EC:
3379                 return false;
3380         /*
3381          * PCIe 3.0, 6.12.1.1 specifies that downstream and root ports should
3382          * implement ACS in order to indicate their peer-to-peer capabilities,
3383          * regardless of whether they are single- or multi-function devices.
3384          */
3385         case PCI_EXP_TYPE_DOWNSTREAM:
3386         case PCI_EXP_TYPE_ROOT_PORT:
3387                 return pci_acs_flags_enabled(pdev, acs_flags);
3388         /*
3389          * PCIe 3.0, 6.12.1.2 specifies ACS capabilities that should be
3390          * implemented by the remaining PCIe types to indicate peer-to-peer
3391          * capabilities, but only when they are part of a multifunction
3392          * device.  The footnote for section 6.12 indicates the specific
3393          * PCIe types included here.
3394          */
3395         case PCI_EXP_TYPE_ENDPOINT:
3396         case PCI_EXP_TYPE_UPSTREAM:
3397         case PCI_EXP_TYPE_LEG_END:
3398         case PCI_EXP_TYPE_RC_END:
3399                 if (!pdev->multifunction)
3400                         break;
3401
3402                 return pci_acs_flags_enabled(pdev, acs_flags);
3403         }
3404
3405         /*
3406          * PCIe 3.0, 6.12.1.3 specifies no ACS capabilities are applicable
3407          * to single function devices with the exception of downstream ports.
3408          */
3409         return true;
3410 }
3411
3412 /**
3413  * pci_acs_path_enable - test ACS flags from start to end in a hierarchy
3414  * @start: starting downstream device
3415  * @end: ending upstream device or NULL to search to the root bus
3416  * @acs_flags: required flags
3417  *
3418  * Walk up a device tree from start to end testing PCI ACS support.  If
3419  * any step along the way does not support the required flags, return false.
3420  */
3421 bool pci_acs_path_enabled(struct pci_dev *start,
3422                           struct pci_dev *end, u16 acs_flags)
3423 {
3424         struct pci_dev *pdev, *parent = start;
3425
3426         do {
3427                 pdev = parent;
3428
3429                 if (!pci_acs_enabled(pdev, acs_flags))
3430                         return false;
3431
3432                 if (pci_is_root_bus(pdev->bus))
3433                         return (end == NULL);
3434
3435                 parent = pdev->bus->self;
3436         } while (pdev != end);
3437
3438         return true;
3439 }
3440
3441 /**
3442  * pci_rebar_find_pos - find position of resize ctrl reg for BAR
3443  * @pdev: PCI device
3444  * @bar: BAR to find
3445  *
3446  * Helper to find the position of the ctrl register for a BAR.
3447  * Returns -ENOTSUPP if resizable BARs are not supported at all.
3448  * Returns -ENOENT if no ctrl register for the BAR could be found.
3449  */
3450 static int pci_rebar_find_pos(struct pci_dev *pdev, int bar)
3451 {
3452         unsigned int pos, nbars, i;
3453         u32 ctrl;
3454
3455         pos = pci_find_ext_capability(pdev, PCI_EXT_CAP_ID_REBAR);
3456         if (!pos)
3457                 return -ENOTSUPP;
3458
3459         pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
3460         nbars = (ctrl & PCI_REBAR_CTRL_NBAR_MASK) >>
3461                     PCI_REBAR_CTRL_NBAR_SHIFT;
3462
3463         for (i = 0; i < nbars; i++, pos += 8) {
3464                 int bar_idx;
3465
3466                 pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
3467                 bar_idx = ctrl & PCI_REBAR_CTRL_BAR_IDX;
3468                 if (bar_idx == bar)
3469                         return pos;
3470         }
3471
3472         return -ENOENT;
3473 }
3474
3475 /**
3476  * pci_rebar_get_possible_sizes - get possible sizes for BAR
3477  * @pdev: PCI device
3478  * @bar: BAR to query
3479  *
3480  * Get the possible sizes of a resizable BAR as bitmask defined in the spec
3481  * (bit 0=1MB, bit 19=512GB). Returns 0 if BAR isn't resizable.
3482  */
3483 u32 pci_rebar_get_possible_sizes(struct pci_dev *pdev, int bar)
3484 {
3485         int pos;
3486         u32 cap;
3487
3488         pos = pci_rebar_find_pos(pdev, bar);
3489         if (pos < 0)
3490                 return 0;
3491
3492         pci_read_config_dword(pdev, pos + PCI_REBAR_CAP, &cap);
3493         cap &= PCI_REBAR_CAP_SIZES;
3494
3495         /* Sapphire RX 5600 XT Pulse has an invalid cap dword for BAR 0 */
3496         if (pdev->vendor == PCI_VENDOR_ID_ATI && pdev->device == 0x731f &&
3497             bar == 0 && cap == 0x7000)
3498                 cap = 0x3f000;
3499
3500         return cap >> 4;
3501 }
3502
3503 /**
3504  * pci_rebar_get_current_size - get the current size of a BAR
3505  * @pdev: PCI device
3506  * @bar: BAR to set size to
3507  *
3508  * Read the size of a BAR from the resizable BAR config.
3509  * Returns size if found or negative error code.
3510  */
3511 int pci_rebar_get_current_size(struct pci_dev *pdev, int bar)
3512 {
3513         int pos;
3514         u32 ctrl;
3515
3516         pos = pci_rebar_find_pos(pdev, bar);
3517         if (pos < 0)
3518                 return pos;
3519
3520         pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
3521         return (ctrl & PCI_REBAR_CTRL_BAR_SIZE) >> PCI_REBAR_CTRL_BAR_SHIFT;
3522 }
3523
3524 /**
3525  * pci_rebar_set_size - set a new size for a BAR
3526  * @pdev: PCI device
3527  * @bar: BAR to set size to
3528  * @size: new size as defined in the spec (0=1MB, 19=512GB)
3529  *
3530  * Set the new size of a BAR as defined in the spec.
3531  * Returns zero if resizing was successful, error code otherwise.
3532  */
3533 int pci_rebar_set_size(struct pci_dev *pdev, int bar, int size)
3534 {
3535         int pos;
3536         u32 ctrl;
3537
3538         pos = pci_rebar_find_pos(pdev, bar);
3539         if (pos < 0)
3540                 return pos;
3541
3542         pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
3543         ctrl &= ~PCI_REBAR_CTRL_BAR_SIZE;
3544         ctrl |= size << PCI_REBAR_CTRL_BAR_SHIFT;
3545         pci_write_config_dword(pdev, pos + PCI_REBAR_CTRL, ctrl);
3546         return 0;
3547 }
3548
3549 /**
3550  * pci_enable_atomic_ops_to_root - enable AtomicOp requests to root port
3551  * @dev: the PCI device
3552  * @cap_mask: mask of desired AtomicOp sizes, including one or more of:
3553  *      PCI_EXP_DEVCAP2_ATOMIC_COMP32
3554  *      PCI_EXP_DEVCAP2_ATOMIC_COMP64
3555  *      PCI_EXP_DEVCAP2_ATOMIC_COMP128
3556  *
3557  * Return 0 if all upstream bridges support AtomicOp routing, egress
3558  * blocking is disabled on all upstream ports, and the root port supports
3559  * the requested completion capabilities (32-bit, 64-bit and/or 128-bit
3560  * AtomicOp completion), or negative otherwise.
3561  */
3562 int pci_enable_atomic_ops_to_root(struct pci_dev *dev, u32 cap_mask)
3563 {
3564         struct pci_bus *bus = dev->bus;
3565         struct pci_dev *bridge;
3566         u32 cap, ctl2;
3567
3568         if (!pci_is_pcie(dev))
3569                 return -EINVAL;
3570
3571         /*
3572          * Per PCIe r4.0, sec 6.15, endpoints and root ports may be
3573          * AtomicOp requesters.  For now, we only support endpoints as
3574          * requesters and root ports as completers.  No endpoints as
3575          * completers, and no peer-to-peer.
3576          */
3577
3578         switch (pci_pcie_type(dev)) {
3579         case PCI_EXP_TYPE_ENDPOINT:
3580         case PCI_EXP_TYPE_LEG_END:
3581         case PCI_EXP_TYPE_RC_END:
3582                 break;
3583         default:
3584                 return -EINVAL;
3585         }
3586
3587         while (bus->parent) {
3588                 bridge = bus->self;
3589
3590                 pcie_capability_read_dword(bridge, PCI_EXP_DEVCAP2, &cap);
3591
3592                 switch (pci_pcie_type(bridge)) {
3593                 /* Ensure switch ports support AtomicOp routing */
3594                 case PCI_EXP_TYPE_UPSTREAM:
3595                 case PCI_EXP_TYPE_DOWNSTREAM:
3596                         if (!(cap & PCI_EXP_DEVCAP2_ATOMIC_ROUTE))
3597                                 return -EINVAL;
3598                         break;
3599
3600                 /* Ensure root port supports all the sizes we care about */
3601                 case PCI_EXP_TYPE_ROOT_PORT:
3602                         if ((cap & cap_mask) != cap_mask)
3603                                 return -EINVAL;
3604                         break;
3605                 }
3606
3607                 /* Ensure upstream ports don't block AtomicOps on egress */
3608                 if (pci_pcie_type(bridge) == PCI_EXP_TYPE_UPSTREAM) {
3609                         pcie_capability_read_dword(bridge, PCI_EXP_DEVCTL2,
3610                                                    &ctl2);
3611                         if (ctl2 & PCI_EXP_DEVCTL2_ATOMIC_EGRESS_BLOCK)
3612                                 return -EINVAL;
3613                 }
3614
3615                 bus = bus->parent;
3616         }
3617
3618         pcie_capability_set_word(dev, PCI_EXP_DEVCTL2,
3619                                  PCI_EXP_DEVCTL2_ATOMIC_REQ);
3620         return 0;
3621 }
3622 EXPORT_SYMBOL(pci_enable_atomic_ops_to_root);
3623
3624 /**
3625  * pci_swizzle_interrupt_pin - swizzle INTx for device behind bridge
3626  * @dev: the PCI device
3627  * @pin: the INTx pin (1=INTA, 2=INTB, 3=INTC, 4=INTD)
3628  *
3629  * Perform INTx swizzling for a device behind one level of bridge.  This is
3630  * required by section 9.1 of the PCI-to-PCI bridge specification for devices
3631  * behind bridges on add-in cards.  For devices with ARI enabled, the slot
3632  * number is always 0 (see the Implementation Note in section 2.2.8.1 of
3633  * the PCI Express Base Specification, Revision 2.1)
3634  */
3635 u8 pci_swizzle_interrupt_pin(const struct pci_dev *dev, u8 pin)
3636 {
3637         int slot;
3638
3639         if (pci_ari_enabled(dev->bus))
3640                 slot = 0;
3641         else
3642                 slot = PCI_SLOT(dev->devfn);
3643
3644         return (((pin - 1) + slot) % 4) + 1;
3645 }
3646
3647 int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge)
3648 {
3649         u8 pin;
3650
3651         pin = dev->pin;
3652         if (!pin)
3653                 return -1;
3654
3655         while (!pci_is_root_bus(dev->bus)) {
3656                 pin = pci_swizzle_interrupt_pin(dev, pin);
3657                 dev = dev->bus->self;
3658         }
3659         *bridge = dev;
3660         return pin;
3661 }
3662
3663 /**
3664  * pci_common_swizzle - swizzle INTx all the way to root bridge
3665  * @dev: the PCI device
3666  * @pinp: pointer to the INTx pin value (1=INTA, 2=INTB, 3=INTD, 4=INTD)
3667  *
3668  * Perform INTx swizzling for a device.  This traverses through all PCI-to-PCI
3669  * bridges all the way up to a PCI root bus.
3670  */
3671 u8 pci_common_swizzle(struct pci_dev *dev, u8 *pinp)
3672 {
3673         u8 pin = *pinp;
3674
3675         while (!pci_is_root_bus(dev->bus)) {
3676                 pin = pci_swizzle_interrupt_pin(dev, pin);
3677                 dev = dev->bus->self;
3678         }
3679         *pinp = pin;
3680         return PCI_SLOT(dev->devfn);
3681 }
3682 EXPORT_SYMBOL_GPL(pci_common_swizzle);
3683
3684 /**
3685  * pci_release_region - Release a PCI bar
3686  * @pdev: PCI device whose resources were previously reserved by
3687  *        pci_request_region()
3688  * @bar: BAR to release
3689  *
3690  * Releases the PCI I/O and memory resources previously reserved by a
3691  * successful call to pci_request_region().  Call this function only
3692  * after all use of the PCI regions has ceased.
3693  */
3694 void pci_release_region(struct pci_dev *pdev, int bar)
3695 {
3696         struct pci_devres *dr;
3697
3698         if (pci_resource_len(pdev, bar) == 0)
3699                 return;
3700         if (pci_resource_flags(pdev, bar) & IORESOURCE_IO)
3701                 release_region(pci_resource_start(pdev, bar),
3702                                 pci_resource_len(pdev, bar));
3703         else if (pci_resource_flags(pdev, bar) & IORESOURCE_MEM)
3704                 release_mem_region(pci_resource_start(pdev, bar),
3705                                 pci_resource_len(pdev, bar));
3706
3707         dr = find_pci_dr(pdev);
3708         if (dr)
3709                 dr->region_mask &= ~(1 << bar);
3710 }
3711 EXPORT_SYMBOL(pci_release_region);
3712
3713 /**
3714  * __pci_request_region - Reserved PCI I/O and memory resource
3715  * @pdev: PCI device whose resources are to be reserved
3716  * @bar: BAR to be reserved
3717  * @res_name: Name to be associated with resource.
3718  * @exclusive: whether the region access is exclusive or not
3719  *
3720  * Mark the PCI region associated with PCI device @pdev BAR @bar as
3721  * being reserved by owner @res_name.  Do not access any
3722  * address inside the PCI regions unless this call returns
3723  * successfully.
3724  *
3725  * If @exclusive is set, then the region is marked so that userspace
3726  * is explicitly not allowed to map the resource via /dev/mem or
3727  * sysfs MMIO access.
3728  *
3729  * Returns 0 on success, or %EBUSY on error.  A warning
3730  * message is also printed on failure.
3731  */
3732 static int __pci_request_region(struct pci_dev *pdev, int bar,
3733                                 const char *res_name, int exclusive)
3734 {
3735         struct pci_devres *dr;
3736
3737         if (pci_resource_len(pdev, bar) == 0)
3738                 return 0;
3739
3740         if (pci_resource_flags(pdev, bar) & IORESOURCE_IO) {
3741                 if (!request_region(pci_resource_start(pdev, bar),
3742                             pci_resource_len(pdev, bar), res_name))
3743                         goto err_out;
3744         } else if (pci_resource_flags(pdev, bar) & IORESOURCE_MEM) {
3745                 if (!__request_mem_region(pci_resource_start(pdev, bar),
3746                                         pci_resource_len(pdev, bar), res_name,
3747                                         exclusive))
3748                         goto err_out;
3749         }
3750
3751         dr = find_pci_dr(pdev);
3752         if (dr)
3753                 dr->region_mask |= 1 << bar;
3754
3755         return 0;
3756
3757 err_out:
3758         pci_warn(pdev, "BAR %d: can't reserve %pR\n", bar,
3759                  &pdev->resource[bar]);
3760         return -EBUSY;
3761 }
3762
3763 /**
3764  * pci_request_region - Reserve PCI I/O and memory resource
3765  * @pdev: PCI device whose resources are to be reserved
3766  * @bar: BAR to be reserved
3767  * @res_name: Name to be associated with resource
3768  *
3769  * Mark the PCI region associated with PCI device @pdev BAR @bar as
3770  * being reserved by owner @res_name.  Do not access any
3771  * address inside the PCI regions unless this call returns
3772  * successfully.
3773  *
3774  * Returns 0 on success, or %EBUSY on error.  A warning
3775  * message is also printed on failure.
3776  */
3777 int pci_request_region(struct pci_dev *pdev, int bar, const char *res_name)
3778 {
3779         return __pci_request_region(pdev, bar, res_name, 0);
3780 }
3781 EXPORT_SYMBOL(pci_request_region);
3782
3783 /**
3784  * pci_release_selected_regions - Release selected PCI I/O and memory resources
3785  * @pdev: PCI device whose resources were previously reserved
3786  * @bars: Bitmask of BARs to be released
3787  *
3788  * Release selected PCI I/O and memory resources previously reserved.
3789  * Call this function only after all use of the PCI regions has ceased.
3790  */
3791 void pci_release_selected_regions(struct pci_dev *pdev, int bars)
3792 {
3793         int i;
3794
3795         for (i = 0; i < 6; i++)
3796                 if (bars & (1 << i))
3797                         pci_release_region(pdev, i);
3798 }
3799 EXPORT_SYMBOL(pci_release_selected_regions);
3800
3801 static int __pci_request_selected_regions(struct pci_dev *pdev, int bars,
3802                                           const char *res_name, int excl)
3803 {
3804         int i;
3805
3806         for (i = 0; i < 6; i++)
3807                 if (bars & (1 << i))
3808                         if (__pci_request_region(pdev, i, res_name, excl))
3809                                 goto err_out;
3810         return 0;
3811
3812 err_out:
3813         while (--i >= 0)
3814                 if (bars & (1 << i))
3815                         pci_release_region(pdev, i);
3816
3817         return -EBUSY;
3818 }
3819
3820
3821 /**
3822  * pci_request_selected_regions - Reserve selected PCI I/O and memory resources
3823  * @pdev: PCI device whose resources are to be reserved
3824  * @bars: Bitmask of BARs to be requested
3825  * @res_name: Name to be associated with resource
3826  */
3827 int pci_request_selected_regions(struct pci_dev *pdev, int bars,
3828                                  const char *res_name)
3829 {
3830         return __pci_request_selected_regions(pdev, bars, res_name, 0);
3831 }
3832 EXPORT_SYMBOL(pci_request_selected_regions);
3833
3834 int pci_request_selected_regions_exclusive(struct pci_dev *pdev, int bars,
3835                                            const char *res_name)
3836 {
3837         return __pci_request_selected_regions(pdev, bars, res_name,
3838                         IORESOURCE_EXCLUSIVE);
3839 }
3840 EXPORT_SYMBOL(pci_request_selected_regions_exclusive);
3841
3842 /**
3843  * pci_release_regions - Release reserved PCI I/O and memory resources
3844  * @pdev: PCI device whose resources were previously reserved by
3845  *        pci_request_regions()
3846  *
3847  * Releases all PCI I/O and memory resources previously reserved by a
3848  * successful call to pci_request_regions().  Call this function only
3849  * after all use of the PCI regions has ceased.
3850  */
3851
3852 void pci_release_regions(struct pci_dev *pdev)
3853 {
3854         pci_release_selected_regions(pdev, (1 << 6) - 1);
3855 }
3856 EXPORT_SYMBOL(pci_release_regions);
3857
3858 /**
3859  * pci_request_regions - Reserve PCI I/O and memory resources
3860  * @pdev: PCI device whose resources are to be reserved
3861  * @res_name: Name to be associated with resource.
3862  *
3863  * Mark all PCI regions associated with PCI device @pdev as
3864  * being reserved by owner @res_name.  Do not access any
3865  * address inside the PCI regions unless this call returns
3866  * successfully.
3867  *
3868  * Returns 0 on success, or %EBUSY on error.  A warning
3869  * message is also printed on failure.
3870  */
3871 int pci_request_regions(struct pci_dev *pdev, const char *res_name)
3872 {
3873         return pci_request_selected_regions(pdev, ((1 << 6) - 1), res_name);
3874 }
3875 EXPORT_SYMBOL(pci_request_regions);
3876
3877 /**
3878  * pci_request_regions_exclusive - Reserve PCI I/O and memory resources
3879  * @pdev: PCI device whose resources are to be reserved
3880  * @res_name: Name to be associated with resource.
3881  *
3882  * Mark all PCI regions associated with PCI device @pdev as being reserved
3883  * by owner @res_name.  Do not access any address inside the PCI regions
3884  * unless this call returns successfully.
3885  *
3886  * pci_request_regions_exclusive() will mark the region so that /dev/mem
3887  * and the sysfs MMIO access will not be allowed.
3888  *
3889  * Returns 0 on success, or %EBUSY on error.  A warning message is also
3890  * printed on failure.
3891  */
3892 int pci_request_regions_exclusive(struct pci_dev *pdev, const char *res_name)
3893 {
3894         return pci_request_selected_regions_exclusive(pdev,
3895                                         ((1 << 6) - 1), res_name);
3896 }
3897 EXPORT_SYMBOL(pci_request_regions_exclusive);
3898
3899 /*
3900  * Record the PCI IO range (expressed as CPU physical address + size).
3901  * Return a negative value if an error has occurred, zero otherwise
3902  */
3903 int pci_register_io_range(struct fwnode_handle *fwnode, phys_addr_t addr,
3904                         resource_size_t size)
3905 {
3906         int ret = 0;
3907 #ifdef PCI_IOBASE
3908         struct logic_pio_hwaddr *range;
3909
3910         if (!size || addr + size < addr)
3911                 return -EINVAL;
3912
3913         range = kzalloc(sizeof(*range), GFP_ATOMIC);
3914         if (!range)
3915                 return -ENOMEM;
3916
3917         range->fwnode = fwnode;
3918         range->size = size;
3919         range->hw_start = addr;
3920         range->flags = LOGIC_PIO_CPU_MMIO;
3921
3922         ret = logic_pio_register_range(range);
3923         if (ret)
3924                 kfree(range);
3925
3926         /* Ignore duplicates due to deferred probing */
3927         if (ret == -EEXIST)
3928                 ret = 0;
3929 #endif
3930
3931         return ret;
3932 }
3933
3934 phys_addr_t pci_pio_to_address(unsigned long pio)
3935 {
3936         phys_addr_t address = (phys_addr_t)OF_BAD_ADDR;
3937
3938 #ifdef PCI_IOBASE
3939         if (pio >= MMIO_UPPER_LIMIT)
3940                 return address;
3941
3942         address = logic_pio_to_hwaddr(pio);
3943 #endif
3944
3945         return address;
3946 }
3947
3948 unsigned long __weak pci_address_to_pio(phys_addr_t address)
3949 {
3950 #ifdef PCI_IOBASE
3951         return logic_pio_trans_cpuaddr(address);
3952 #else
3953         if (address > IO_SPACE_LIMIT)
3954                 return (unsigned long)-1;
3955
3956         return (unsigned long) address;
3957 #endif
3958 }
3959
3960 /**
3961  * pci_remap_iospace - Remap the memory mapped I/O space
3962  * @res: Resource describing the I/O space
3963  * @phys_addr: physical address of range to be mapped
3964  *
3965  * Remap the memory mapped I/O space described by the @res and the CPU
3966  * physical address @phys_addr into virtual address space.  Only
3967  * architectures that have memory mapped IO functions defined (and the
3968  * PCI_IOBASE value defined) should call this function.
3969  */
3970 int pci_remap_iospace(const struct resource *res, phys_addr_t phys_addr)
3971 {
3972 #if defined(PCI_IOBASE) && defined(CONFIG_MMU)
3973         unsigned long vaddr = (unsigned long)PCI_IOBASE + res->start;
3974
3975         if (!(res->flags & IORESOURCE_IO))
3976                 return -EINVAL;
3977
3978         if (res->end > IO_SPACE_LIMIT)
3979                 return -EINVAL;
3980
3981         return ioremap_page_range(vaddr, vaddr + resource_size(res), phys_addr,
3982                                   pgprot_device(PAGE_KERNEL));
3983 #else
3984         /*
3985          * This architecture does not have memory mapped I/O space,
3986          * so this function should never be called
3987          */
3988         WARN_ONCE(1, "This architecture does not support memory mapped I/O\n");
3989         return -ENODEV;
3990 #endif
3991 }
3992 EXPORT_SYMBOL(pci_remap_iospace);
3993
3994 /**
3995  * pci_unmap_iospace - Unmap the memory mapped I/O space
3996  * @res: resource to be unmapped
3997  *
3998  * Unmap the CPU virtual address @res from virtual address space.  Only
3999  * architectures that have memory mapped IO functions defined (and the
4000  * PCI_IOBASE value defined) should call this function.
4001  */
4002 void pci_unmap_iospace(struct resource *res)
4003 {
4004 #if defined(PCI_IOBASE) && defined(CONFIG_MMU)
4005         unsigned long vaddr = (unsigned long)PCI_IOBASE + res->start;
4006
4007         unmap_kernel_range(vaddr, resource_size(res));
4008 #endif
4009 }
4010 EXPORT_SYMBOL(pci_unmap_iospace);
4011
4012 static void devm_pci_unmap_iospace(struct device *dev, void *ptr)
4013 {
4014         struct resource **res = ptr;
4015
4016         pci_unmap_iospace(*res);
4017 }
4018
4019 /**
4020  * devm_pci_remap_iospace - Managed pci_remap_iospace()
4021  * @dev: Generic device to remap IO address for
4022  * @res: Resource describing the I/O space
4023  * @phys_addr: physical address of range to be mapped
4024  *
4025  * Managed pci_remap_iospace().  Map is automatically unmapped on driver
4026  * detach.
4027  */
4028 int devm_pci_remap_iospace(struct device *dev, const struct resource *res,
4029                            phys_addr_t phys_addr)
4030 {
4031         const struct resource **ptr;
4032         int error;
4033
4034         ptr = devres_alloc(devm_pci_unmap_iospace, sizeof(*ptr), GFP_KERNEL);
4035         if (!ptr)
4036                 return -ENOMEM;
4037
4038         error = pci_remap_iospace(res, phys_addr);
4039         if (error) {
4040                 devres_free(ptr);
4041         } else  {
4042                 *ptr = res;
4043                 devres_add(dev, ptr);
4044         }
4045
4046         return error;
4047 }
4048 EXPORT_SYMBOL(devm_pci_remap_iospace);
4049
4050 /**
4051  * devm_pci_remap_cfgspace - Managed pci_remap_cfgspace()
4052  * @dev: Generic device to remap IO address for
4053  * @offset: Resource address to map
4054  * @size: Size of map
4055  *
4056  * Managed pci_remap_cfgspace().  Map is automatically unmapped on driver
4057  * detach.
4058  */
4059 void __iomem *devm_pci_remap_cfgspace(struct device *dev,
4060                                       resource_size_t offset,
4061                                       resource_size_t size)
4062 {
4063         void __iomem **ptr, *addr;
4064
4065         ptr = devres_alloc(devm_ioremap_release, sizeof(*ptr), GFP_KERNEL);
4066         if (!ptr)
4067                 return NULL;
4068
4069         addr = pci_remap_cfgspace(offset, size);
4070         if (addr) {
4071                 *ptr = addr;
4072                 devres_add(dev, ptr);
4073         } else
4074                 devres_free(ptr);
4075
4076         return addr;
4077 }
4078 EXPORT_SYMBOL(devm_pci_remap_cfgspace);
4079
4080 /**
4081  * devm_pci_remap_cfg_resource - check, request region and ioremap cfg resource
4082  * @dev: generic device to handle the resource for
4083  * @res: configuration space resource to be handled
4084  *
4085  * Checks that a resource is a valid memory region, requests the memory
4086  * region and ioremaps with pci_remap_cfgspace() API that ensures the
4087  * proper PCI configuration space memory attributes are guaranteed.
4088  *
4089  * All operations are managed and will be undone on driver detach.
4090  *
4091  * Returns a pointer to the remapped memory or an ERR_PTR() encoded error code
4092  * on failure. Usage example::
4093  *
4094  *      res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
4095  *      base = devm_pci_remap_cfg_resource(&pdev->dev, res);
4096  *      if (IS_ERR(base))
4097  *              return PTR_ERR(base);
4098  */
4099 void __iomem *devm_pci_remap_cfg_resource(struct device *dev,
4100                                           struct resource *res)
4101 {
4102         resource_size_t size;
4103         const char *name;
4104         void __iomem *dest_ptr;
4105
4106         BUG_ON(!dev);
4107
4108         if (!res || resource_type(res) != IORESOURCE_MEM) {
4109                 dev_err(dev, "invalid resource\n");
4110                 return IOMEM_ERR_PTR(-EINVAL);
4111         }
4112
4113         size = resource_size(res);
4114         name = res->name ?: dev_name(dev);
4115
4116         if (!devm_request_mem_region(dev, res->start, size, name)) {
4117                 dev_err(dev, "can't request region for resource %pR\n", res);
4118                 return IOMEM_ERR_PTR(-EBUSY);
4119         }
4120
4121         dest_ptr = devm_pci_remap_cfgspace(dev, res->start, size);
4122         if (!dest_ptr) {
4123                 dev_err(dev, "ioremap failed for resource %pR\n", res);
4124                 devm_release_mem_region(dev, res->start, size);
4125                 dest_ptr = IOMEM_ERR_PTR(-ENOMEM);
4126         }
4127
4128         return dest_ptr;
4129 }
4130 EXPORT_SYMBOL(devm_pci_remap_cfg_resource);
4131
4132 static void __pci_set_master(struct pci_dev *dev, bool enable)
4133 {
4134         u16 old_cmd, cmd;
4135
4136         pci_read_config_word(dev, PCI_COMMAND, &old_cmd);
4137         if (enable)
4138                 cmd = old_cmd | PCI_COMMAND_MASTER;
4139         else
4140                 cmd = old_cmd & ~PCI_COMMAND_MASTER;
4141         if (cmd != old_cmd) {
4142                 pci_dbg(dev, "%s bus mastering\n",
4143                         enable ? "enabling" : "disabling");
4144                 pci_write_config_word(dev, PCI_COMMAND, cmd);
4145         }
4146         dev->is_busmaster = enable;
4147 }
4148
4149 /**
4150  * pcibios_setup - process "pci=" kernel boot arguments
4151  * @str: string used to pass in "pci=" kernel boot arguments
4152  *
4153  * Process kernel boot arguments.  This is the default implementation.
4154  * Architecture specific implementations can override this as necessary.
4155  */
4156 char * __weak __init pcibios_setup(char *str)
4157 {
4158         return str;
4159 }
4160
4161 /**
4162  * pcibios_set_master - enable PCI bus-mastering for device dev
4163  * @dev: the PCI device to enable
4164  *
4165  * Enables PCI bus-mastering for the device.  This is the default
4166  * implementation.  Architecture specific implementations can override
4167  * this if necessary.
4168  */
4169 void __weak pcibios_set_master(struct pci_dev *dev)
4170 {
4171         u8 lat;
4172
4173         /* The latency timer doesn't apply to PCIe (either Type 0 or Type 1) */
4174         if (pci_is_pcie(dev))
4175                 return;
4176
4177         pci_read_config_byte(dev, PCI_LATENCY_TIMER, &lat);
4178         if (lat < 16)
4179                 lat = (64 <= pcibios_max_latency) ? 64 : pcibios_max_latency;
4180         else if (lat > pcibios_max_latency)
4181                 lat = pcibios_max_latency;
4182         else
4183                 return;
4184
4185         pci_write_config_byte(dev, PCI_LATENCY_TIMER, lat);
4186 }
4187
4188 /**
4189  * pci_set_master - enables bus-mastering for device dev
4190  * @dev: the PCI device to enable
4191  *
4192  * Enables bus-mastering on the device and calls pcibios_set_master()
4193  * to do the needed arch specific settings.
4194  */
4195 void pci_set_master(struct pci_dev *dev)
4196 {
4197         __pci_set_master(dev, true);
4198         pcibios_set_master(dev);
4199 }
4200 EXPORT_SYMBOL(pci_set_master);
4201
4202 /**
4203  * pci_clear_master - disables bus-mastering for device dev
4204  * @dev: the PCI device to disable
4205  */
4206 void pci_clear_master(struct pci_dev *dev)
4207 {
4208         __pci_set_master(dev, false);
4209 }
4210 EXPORT_SYMBOL(pci_clear_master);
4211
4212 /**
4213  * pci_set_cacheline_size - ensure the CACHE_LINE_SIZE register is programmed
4214  * @dev: the PCI device for which MWI is to be enabled
4215  *
4216  * Helper function for pci_set_mwi.
4217  * Originally copied from drivers/net/acenic.c.
4218  * Copyright 1998-2001 by Jes Sorensen, <jes@trained-monkey.org>.
4219  *
4220  * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
4221  */
4222 int pci_set_cacheline_size(struct pci_dev *dev)
4223 {
4224         u8 cacheline_size;
4225
4226         if (!pci_cache_line_size)
4227                 return -EINVAL;
4228
4229         /* Validate current setting: the PCI_CACHE_LINE_SIZE must be
4230            equal to or multiple of the right value. */
4231         pci_read_config_byte(dev, PCI_CACHE_LINE_SIZE, &cacheline_size);
4232         if (cacheline_size >= pci_cache_line_size &&
4233             (cacheline_size % pci_cache_line_size) == 0)
4234                 return 0;
4235
4236         /* Write the correct value. */
4237         pci_write_config_byte(dev, PCI_CACHE_LINE_SIZE, pci_cache_line_size);
4238         /* Read it back. */
4239         pci_read_config_byte(dev, PCI_CACHE_LINE_SIZE, &cacheline_size);
4240         if (cacheline_size == pci_cache_line_size)
4241                 return 0;
4242
4243         pci_info(dev, "cache line size of %d is not supported\n",
4244                    pci_cache_line_size << 2);
4245
4246         return -EINVAL;
4247 }
4248 EXPORT_SYMBOL_GPL(pci_set_cacheline_size);
4249
4250 /**
4251  * pci_set_mwi - enables memory-write-invalidate PCI transaction
4252  * @dev: the PCI device for which MWI is enabled
4253  *
4254  * Enables the Memory-Write-Invalidate transaction in %PCI_COMMAND.
4255  *
4256  * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
4257  */
4258 int pci_set_mwi(struct pci_dev *dev)
4259 {
4260 #ifdef PCI_DISABLE_MWI
4261         return 0;
4262 #else
4263         int rc;
4264         u16 cmd;
4265
4266         rc = pci_set_cacheline_size(dev);
4267         if (rc)
4268                 return rc;
4269
4270         pci_read_config_word(dev, PCI_COMMAND, &cmd);
4271         if (!(cmd & PCI_COMMAND_INVALIDATE)) {
4272                 pci_dbg(dev, "enabling Mem-Wr-Inval\n");
4273                 cmd |= PCI_COMMAND_INVALIDATE;
4274                 pci_write_config_word(dev, PCI_COMMAND, cmd);
4275         }
4276         return 0;
4277 #endif
4278 }
4279 EXPORT_SYMBOL(pci_set_mwi);
4280
4281 /**
4282  * pcim_set_mwi - a device-managed pci_set_mwi()
4283  * @dev: the PCI device for which MWI is enabled
4284  *
4285  * Managed pci_set_mwi().
4286  *
4287  * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
4288  */
4289 int pcim_set_mwi(struct pci_dev *dev)
4290 {
4291         struct pci_devres *dr;
4292
4293         dr = find_pci_dr(dev);
4294         if (!dr)
4295                 return -ENOMEM;
4296
4297         dr->mwi = 1;
4298         return pci_set_mwi(dev);
4299 }
4300 EXPORT_SYMBOL(pcim_set_mwi);
4301
4302 /**
4303  * pci_try_set_mwi - enables memory-write-invalidate PCI transaction
4304  * @dev: the PCI device for which MWI is enabled
4305  *
4306  * Enables the Memory-Write-Invalidate transaction in %PCI_COMMAND.
4307  * Callers are not required to check the return value.
4308  *
4309  * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
4310  */
4311 int pci_try_set_mwi(struct pci_dev *dev)
4312 {
4313 #ifdef PCI_DISABLE_MWI
4314         return 0;
4315 #else
4316         return pci_set_mwi(dev);
4317 #endif
4318 }
4319 EXPORT_SYMBOL(pci_try_set_mwi);
4320
4321 /**
4322  * pci_clear_mwi - disables Memory-Write-Invalidate for device dev
4323  * @dev: the PCI device to disable
4324  *
4325  * Disables PCI Memory-Write-Invalidate transaction on the device
4326  */
4327 void pci_clear_mwi(struct pci_dev *dev)
4328 {
4329 #ifndef PCI_DISABLE_MWI
4330         u16 cmd;
4331
4332         pci_read_config_word(dev, PCI_COMMAND, &cmd);
4333         if (cmd & PCI_COMMAND_INVALIDATE) {
4334                 cmd &= ~PCI_COMMAND_INVALIDATE;
4335                 pci_write_config_word(dev, PCI_COMMAND, cmd);
4336         }
4337 #endif
4338 }
4339 EXPORT_SYMBOL(pci_clear_mwi);
4340
4341 /**
4342  * pci_intx - enables/disables PCI INTx for device dev
4343  * @pdev: the PCI device to operate on
4344  * @enable: boolean: whether to enable or disable PCI INTx
4345  *
4346  * Enables/disables PCI INTx for device @pdev
4347  */
4348 void pci_intx(struct pci_dev *pdev, int enable)
4349 {
4350         u16 pci_command, new;
4351
4352         pci_read_config_word(pdev, PCI_COMMAND, &pci_command);
4353
4354         if (enable)
4355                 new = pci_command & ~PCI_COMMAND_INTX_DISABLE;
4356         else
4357                 new = pci_command | PCI_COMMAND_INTX_DISABLE;
4358
4359         if (new != pci_command) {
4360                 struct pci_devres *dr;
4361
4362                 pci_write_config_word(pdev, PCI_COMMAND, new);
4363
4364                 dr = find_pci_dr(pdev);
4365                 if (dr && !dr->restore_intx) {
4366                         dr->restore_intx = 1;
4367                         dr->orig_intx = !enable;
4368                 }
4369         }
4370 }
4371 EXPORT_SYMBOL_GPL(pci_intx);
4372
4373 static bool pci_check_and_set_intx_mask(struct pci_dev *dev, bool mask)
4374 {
4375         struct pci_bus *bus = dev->bus;
4376         bool mask_updated = true;
4377         u32 cmd_status_dword;
4378         u16 origcmd, newcmd;
4379         unsigned long flags;
4380         bool irq_pending;
4381
4382         /*
4383          * We do a single dword read to retrieve both command and status.
4384          * Document assumptions that make this possible.
4385          */
4386         BUILD_BUG_ON(PCI_COMMAND % 4);
4387         BUILD_BUG_ON(PCI_COMMAND + 2 != PCI_STATUS);
4388
4389         raw_spin_lock_irqsave(&pci_lock, flags);
4390
4391         bus->ops->read(bus, dev->devfn, PCI_COMMAND, 4, &cmd_status_dword);
4392
4393         irq_pending = (cmd_status_dword >> 16) & PCI_STATUS_INTERRUPT;
4394
4395         /*
4396          * Check interrupt status register to see whether our device
4397          * triggered the interrupt (when masking) or the next IRQ is
4398          * already pending (when unmasking).
4399          */
4400         if (mask != irq_pending) {
4401                 mask_updated = false;
4402                 goto done;
4403         }
4404
4405         origcmd = cmd_status_dword;
4406         newcmd = origcmd & ~PCI_COMMAND_INTX_DISABLE;
4407         if (mask)
4408                 newcmd |= PCI_COMMAND_INTX_DISABLE;
4409         if (newcmd != origcmd)
4410                 bus->ops->write(bus, dev->devfn, PCI_COMMAND, 2, newcmd);
4411
4412 done:
4413         raw_spin_unlock_irqrestore(&pci_lock, flags);
4414
4415         return mask_updated;
4416 }
4417
4418 /**
4419  * pci_check_and_mask_intx - mask INTx on pending interrupt
4420  * @dev: the PCI device to operate on
4421  *
4422  * Check if the device dev has its INTx line asserted, mask it and return
4423  * true in that case. False is returned if no interrupt was pending.
4424  */
4425 bool pci_check_and_mask_intx(struct pci_dev *dev)
4426 {
4427         return pci_check_and_set_intx_mask(dev, true);
4428 }
4429 EXPORT_SYMBOL_GPL(pci_check_and_mask_intx);
4430
4431 /**
4432  * pci_check_and_unmask_intx - unmask INTx if no interrupt is pending
4433  * @dev: the PCI device to operate on
4434  *
4435  * Check if the device dev has its INTx line asserted, unmask it if not and
4436  * return true. False is returned and the mask remains active if there was
4437  * still an interrupt pending.
4438  */
4439 bool pci_check_and_unmask_intx(struct pci_dev *dev)
4440 {
4441         return pci_check_and_set_intx_mask(dev, false);
4442 }
4443 EXPORT_SYMBOL_GPL(pci_check_and_unmask_intx);
4444
4445 /**
4446  * pci_wait_for_pending_transaction - wait for pending transaction
4447  * @dev: the PCI device to operate on
4448  *
4449  * Return 0 if transaction is pending 1 otherwise.
4450  */
4451 int pci_wait_for_pending_transaction(struct pci_dev *dev)
4452 {
4453         if (!pci_is_pcie(dev))
4454                 return 1;
4455
4456         return pci_wait_for_pending(dev, pci_pcie_cap(dev) + PCI_EXP_DEVSTA,
4457                                     PCI_EXP_DEVSTA_TRPND);
4458 }
4459 EXPORT_SYMBOL(pci_wait_for_pending_transaction);
4460
4461 static int pci_dev_wait(struct pci_dev *dev, char *reset_type, int timeout)
4462 {
4463         int delay = 1;
4464         u32 id;
4465
4466         /*
4467          * After reset, the device should not silently discard config
4468          * requests, but it may still indicate that it needs more time by
4469          * responding to them with CRS completions.  The Root Port will
4470          * generally synthesize ~0 data to complete the read (except when
4471          * CRS SV is enabled and the read was for the Vendor ID; in that
4472          * case it synthesizes 0x0001 data).
4473          *
4474          * Wait for the device to return a non-CRS completion.  Read the
4475          * Command register instead of Vendor ID so we don't have to
4476          * contend with the CRS SV value.
4477          */
4478         pci_read_config_dword(dev, PCI_COMMAND, &id);
4479         while (id == ~0) {
4480                 if (delay > timeout) {
4481                         pci_warn(dev, "not ready %dms after %s; giving up\n",
4482                                  delay - 1, reset_type);
4483                         return -ENOTTY;
4484                 }
4485
4486                 if (delay > PCI_RESET_WAIT)
4487                         pci_info(dev, "not ready %dms after %s; waiting\n",
4488                                  delay - 1, reset_type);
4489
4490                 msleep(delay);
4491                 delay *= 2;
4492                 pci_read_config_dword(dev, PCI_COMMAND, &id);
4493         }
4494
4495         if (delay > PCI_RESET_WAIT)
4496                 pci_info(dev, "ready %dms after %s\n", delay - 1,
4497                          reset_type);
4498
4499         return 0;
4500 }
4501
4502 /**
4503  * pcie_has_flr - check if a device supports function level resets
4504  * @dev: device to check
4505  *
4506  * Returns true if the device advertises support for PCIe function level
4507  * resets.
4508  */
4509 bool pcie_has_flr(struct pci_dev *dev)
4510 {
4511         u32 cap;
4512
4513         if (dev->dev_flags & PCI_DEV_FLAGS_NO_FLR_RESET)
4514                 return false;
4515
4516         pcie_capability_read_dword(dev, PCI_EXP_DEVCAP, &cap);
4517         return cap & PCI_EXP_DEVCAP_FLR;
4518 }
4519 EXPORT_SYMBOL_GPL(pcie_has_flr);
4520
4521 /**
4522  * pcie_flr - initiate a PCIe function level reset
4523  * @dev: device to reset
4524  *
4525  * Initiate a function level reset on @dev.  The caller should ensure the
4526  * device supports FLR before calling this function, e.g. by using the
4527  * pcie_has_flr() helper.
4528  */
4529 int pcie_flr(struct pci_dev *dev)
4530 {
4531         if (!pci_wait_for_pending_transaction(dev))
4532                 pci_err(dev, "timed out waiting for pending transaction; performing function level reset anyway\n");
4533
4534         pcie_capability_set_word(dev, PCI_EXP_DEVCTL, PCI_EXP_DEVCTL_BCR_FLR);
4535
4536         if (dev->imm_ready)
4537                 return 0;
4538
4539         /*
4540          * Per PCIe r4.0, sec 6.6.2, a device must complete an FLR within
4541          * 100ms, but may silently discard requests while the FLR is in
4542          * progress.  Wait 100ms before trying to access the device.
4543          */
4544         msleep(100);
4545
4546         return pci_dev_wait(dev, "FLR", PCIE_RESET_READY_POLL_MS);
4547 }
4548 EXPORT_SYMBOL_GPL(pcie_flr);
4549
4550 static int pci_af_flr(struct pci_dev *dev, int probe)
4551 {
4552         int pos;
4553         u8 cap;
4554
4555         pos = pci_find_capability(dev, PCI_CAP_ID_AF);
4556         if (!pos)
4557                 return -ENOTTY;
4558
4559         if (dev->dev_flags & PCI_DEV_FLAGS_NO_FLR_RESET)
4560                 return -ENOTTY;
4561
4562         pci_read_config_byte(dev, pos + PCI_AF_CAP, &cap);
4563         if (!(cap & PCI_AF_CAP_TP) || !(cap & PCI_AF_CAP_FLR))
4564                 return -ENOTTY;
4565
4566         if (probe)
4567                 return 0;
4568
4569         /*
4570          * Wait for Transaction Pending bit to clear.  A word-aligned test
4571          * is used, so we use the control offset rather than status and shift
4572          * the test bit to match.
4573          */
4574         if (!pci_wait_for_pending(dev, pos + PCI_AF_CTRL,
4575                                  PCI_AF_STATUS_TP << 8))
4576                 pci_err(dev, "timed out waiting for pending transaction; performing AF function level reset anyway\n");
4577
4578         pci_write_config_byte(dev, pos + PCI_AF_CTRL, PCI_AF_CTRL_FLR);
4579
4580         if (dev->imm_ready)
4581                 return 0;
4582
4583         /*
4584          * Per Advanced Capabilities for Conventional PCI ECN, 13 April 2006,
4585          * updated 27 July 2006; a device must complete an FLR within
4586          * 100ms, but may silently discard requests while the FLR is in
4587          * progress.  Wait 100ms before trying to access the device.
4588          */
4589         msleep(100);
4590
4591         return pci_dev_wait(dev, "AF_FLR", PCIE_RESET_READY_POLL_MS);
4592 }
4593
4594 /**
4595  * pci_pm_reset - Put device into PCI_D3 and back into PCI_D0.
4596  * @dev: Device to reset.
4597  * @probe: If set, only check if the device can be reset this way.
4598  *
4599  * If @dev supports native PCI PM and its PCI_PM_CTRL_NO_SOFT_RESET flag is
4600  * unset, it will be reinitialized internally when going from PCI_D3hot to
4601  * PCI_D0.  If that's the case and the device is not in a low-power state
4602  * already, force it into PCI_D3hot and back to PCI_D0, causing it to be reset.
4603  *
4604  * NOTE: This causes the caller to sleep for twice the device power transition
4605  * cooldown period, which for the D0->D3hot and D3hot->D0 transitions is 10 ms
4606  * by default (i.e. unless the @dev's d3_delay field has a different value).
4607  * Moreover, only devices in D0 can be reset by this function.
4608  */
4609 static int pci_pm_reset(struct pci_dev *dev, int probe)
4610 {
4611         u16 csr;
4612
4613         if (!dev->pm_cap || dev->dev_flags & PCI_DEV_FLAGS_NO_PM_RESET)
4614                 return -ENOTTY;
4615
4616         pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &csr);
4617         if (csr & PCI_PM_CTRL_NO_SOFT_RESET)
4618                 return -ENOTTY;
4619
4620         if (probe)
4621                 return 0;
4622
4623         if (dev->current_state != PCI_D0)
4624                 return -EINVAL;
4625
4626         csr &= ~PCI_PM_CTRL_STATE_MASK;
4627         csr |= PCI_D3hot;
4628         pci_write_config_word(dev, dev->pm_cap + PCI_PM_CTRL, csr);
4629         pci_dev_d3_sleep(dev);
4630
4631         csr &= ~PCI_PM_CTRL_STATE_MASK;
4632         csr |= PCI_D0;
4633         pci_write_config_word(dev, dev->pm_cap + PCI_PM_CTRL, csr);
4634         pci_dev_d3_sleep(dev);
4635
4636         return pci_dev_wait(dev, "PM D3->D0", PCIE_RESET_READY_POLL_MS);
4637 }
4638
4639 /**
4640  * pcie_wait_for_link_delay - Wait until link is active or inactive
4641  * @pdev: Bridge device
4642  * @active: waiting for active or inactive?
4643  * @delay: Delay to wait after link has become active (in ms)
4644  *
4645  * Use this to wait till link becomes active or inactive.
4646  */
4647 static bool pcie_wait_for_link_delay(struct pci_dev *pdev, bool active,
4648                                      int delay)
4649 {
4650         int timeout = 1000;
4651         bool ret;
4652         u16 lnk_status;
4653
4654         /*
4655          * Some controllers might not implement link active reporting. In this
4656          * case, we wait for 1000 ms + any delay requested by the caller.
4657          */
4658         if (!pdev->link_active_reporting) {
4659                 msleep(timeout + delay);
4660                 return true;
4661         }
4662
4663         /*
4664          * PCIe r4.0 sec 6.6.1, a component must enter LTSSM Detect within 20ms,
4665          * after which we should expect an link active if the reset was
4666          * successful. If so, software must wait a minimum 100ms before sending
4667          * configuration requests to devices downstream this port.
4668          *
4669          * If the link fails to activate, either the device was physically
4670          * removed or the link is permanently failed.
4671          */
4672         if (active)
4673                 msleep(20);
4674         for (;;) {
4675                 pcie_capability_read_word(pdev, PCI_EXP_LNKSTA, &lnk_status);
4676                 ret = !!(lnk_status & PCI_EXP_LNKSTA_DLLLA);
4677                 if (ret == active)
4678                         break;
4679                 if (timeout <= 0)
4680                         break;
4681                 msleep(10);
4682                 timeout -= 10;
4683         }
4684         if (active && ret)
4685                 msleep(delay);
4686         else if (ret != active)
4687                 pci_info(pdev, "Data Link Layer Link Active not %s in 1000 msec\n",
4688                         active ? "set" : "cleared");
4689         return ret == active;
4690 }
4691
4692 /**
4693  * pcie_wait_for_link - Wait until link is active or inactive
4694  * @pdev: Bridge device
4695  * @active: waiting for active or inactive?
4696  *
4697  * Use this to wait till link becomes active or inactive.
4698  */
4699 bool pcie_wait_for_link(struct pci_dev *pdev, bool active)
4700 {
4701         return pcie_wait_for_link_delay(pdev, active, 100);
4702 }
4703
4704 /*
4705  * Find maximum D3cold delay required by all the devices on the bus.  The
4706  * spec says 100 ms, but firmware can lower it and we allow drivers to
4707  * increase it as well.
4708  *
4709  * Called with @pci_bus_sem locked for reading.
4710  */
4711 static int pci_bus_max_d3cold_delay(const struct pci_bus *bus)
4712 {
4713         const struct pci_dev *pdev;
4714         int min_delay = 100;
4715         int max_delay = 0;
4716
4717         list_for_each_entry(pdev, &bus->devices, bus_list) {
4718                 if (pdev->d3cold_delay < min_delay)
4719                         min_delay = pdev->d3cold_delay;
4720                 if (pdev->d3cold_delay > max_delay)
4721                         max_delay = pdev->d3cold_delay;
4722         }
4723
4724         return max(min_delay, max_delay);
4725 }
4726
4727 /**
4728  * pci_bridge_wait_for_secondary_bus - Wait for secondary bus to be accessible
4729  * @dev: PCI bridge
4730  * @reset_type: reset type in human-readable form
4731  * @timeout: maximum time to wait for devices on secondary bus (milliseconds)
4732  *
4733  * Handle necessary delays before access to the devices on the secondary
4734  * side of the bridge are permitted after D3cold to D0 transition
4735  * or Conventional Reset.
4736  *
4737  * For PCIe this means the delays in PCIe 5.0 section 6.6.1. For
4738  * conventional PCI it means Tpvrh + Trhfa specified in PCI 3.0 section
4739  * 4.3.2.
4740  *
4741  * Return 0 on success or -ENOTTY if the first device on the secondary bus
4742  * failed to become accessible.
4743  */
4744 int pci_bridge_wait_for_secondary_bus(struct pci_dev *dev, char *reset_type,
4745                                       int timeout)
4746 {
4747         struct pci_dev *child;
4748         int delay;
4749
4750         if (pci_dev_is_disconnected(dev))
4751                 return 0;
4752
4753         if (!pci_is_bridge(dev))
4754                 return 0;
4755
4756         down_read(&pci_bus_sem);
4757
4758         /*
4759          * We only deal with devices that are present currently on the bus.
4760          * For any hot-added devices the access delay is handled in pciehp
4761          * board_added(). In case of ACPI hotplug the firmware is expected
4762          * to configure the devices before OS is notified.
4763          */
4764         if (!dev->subordinate || list_empty(&dev->subordinate->devices)) {
4765                 up_read(&pci_bus_sem);
4766                 return 0;
4767         }
4768
4769         /* Take d3cold_delay requirements into account */
4770         delay = pci_bus_max_d3cold_delay(dev->subordinate);
4771         if (!delay) {
4772                 up_read(&pci_bus_sem);
4773                 return 0;
4774         }
4775
4776         child = list_first_entry(&dev->subordinate->devices, struct pci_dev,
4777                                  bus_list);
4778         up_read(&pci_bus_sem);
4779
4780         /*
4781          * Conventional PCI and PCI-X we need to wait Tpvrh + Trhfa before
4782          * accessing the device after reset (that is 1000 ms + 100 ms).
4783          */
4784         if (!pci_is_pcie(dev)) {
4785                 pci_dbg(dev, "waiting %d ms for secondary bus\n", 1000 + delay);
4786                 msleep(1000 + delay);
4787                 return 0;
4788         }
4789
4790         /*
4791          * For PCIe downstream and root ports that do not support speeds
4792          * greater than 5 GT/s need to wait minimum 100 ms. For higher
4793          * speeds (gen3) we need to wait first for the data link layer to
4794          * become active.
4795          *
4796          * However, 100 ms is the minimum and the PCIe spec says the
4797          * software must allow at least 1s before it can determine that the
4798          * device that did not respond is a broken device. There is
4799          * evidence that 100 ms is not always enough, for example certain
4800          * Titan Ridge xHCI controller does not always respond to
4801          * configuration requests if we only wait for 100 ms (see
4802          * https://bugzilla.kernel.org/show_bug.cgi?id=203885).
4803          *
4804          * Therefore we wait for 100 ms and check for the device presence
4805          * until the timeout expires.
4806          */
4807         if (!pcie_downstream_port(dev))
4808                 return 0;
4809
4810         if (pcie_get_speed_cap(dev) <= PCIE_SPEED_5_0GT) {
4811                 pci_dbg(dev, "waiting %d ms for downstream link\n", delay);
4812                 msleep(delay);
4813         } else {
4814                 pci_dbg(dev, "waiting %d ms for downstream link, after activation\n",
4815                         delay);
4816                 if (!pcie_wait_for_link_delay(dev, true, delay)) {
4817                         /* Did not train, no need to wait any further */
4818                         return -ENOTTY;
4819                 }
4820         }
4821
4822         return pci_dev_wait(child, reset_type, timeout - delay);
4823 }
4824
4825 void pci_reset_secondary_bus(struct pci_dev *dev)
4826 {
4827         u16 ctrl;
4828
4829         pci_read_config_word(dev, PCI_BRIDGE_CONTROL, &ctrl);
4830         ctrl |= PCI_BRIDGE_CTL_BUS_RESET;
4831         pci_write_config_word(dev, PCI_BRIDGE_CONTROL, ctrl);
4832
4833         /*
4834          * PCI spec v3.0 7.6.4.2 requires minimum Trst of 1ms.  Double
4835          * this to 2ms to ensure that we meet the minimum requirement.
4836          */
4837         msleep(2);
4838
4839         ctrl &= ~PCI_BRIDGE_CTL_BUS_RESET;
4840         pci_write_config_word(dev, PCI_BRIDGE_CONTROL, ctrl);
4841 }
4842
4843 void __weak pcibios_reset_secondary_bus(struct pci_dev *dev)
4844 {
4845         pci_reset_secondary_bus(dev);
4846 }
4847
4848 /**
4849  * pci_bridge_secondary_bus_reset - Reset the secondary bus on a PCI bridge.
4850  * @dev: Bridge device
4851  *
4852  * Use the bridge control register to assert reset on the secondary bus.
4853  * Devices on the secondary bus are left in power-on state.
4854  */
4855 int pci_bridge_secondary_bus_reset(struct pci_dev *dev)
4856 {
4857         pcibios_reset_secondary_bus(dev);
4858
4859         return pci_bridge_wait_for_secondary_bus(dev, "bus reset",
4860                                                  PCIE_RESET_READY_POLL_MS);
4861 }
4862 EXPORT_SYMBOL_GPL(pci_bridge_secondary_bus_reset);
4863
4864 static int pci_parent_bus_reset(struct pci_dev *dev, int probe)
4865 {
4866         struct pci_dev *pdev;
4867
4868         if (pci_is_root_bus(dev->bus) || dev->subordinate ||
4869             !dev->bus->self || dev->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET)
4870                 return -ENOTTY;
4871
4872         list_for_each_entry(pdev, &dev->bus->devices, bus_list)
4873                 if (pdev != dev)
4874                         return -ENOTTY;
4875
4876         if (probe)
4877                 return 0;
4878
4879         return pci_bridge_secondary_bus_reset(dev->bus->self);
4880 }
4881
4882 static int pci_reset_hotplug_slot(struct hotplug_slot *hotplug, int probe)
4883 {
4884         int rc = -ENOTTY;
4885
4886         if (!hotplug || !try_module_get(hotplug->owner))
4887                 return rc;
4888
4889         if (hotplug->ops->reset_slot)
4890                 rc = hotplug->ops->reset_slot(hotplug, probe);
4891
4892         module_put(hotplug->owner);
4893
4894         return rc;
4895 }
4896
4897 static int pci_dev_reset_slot_function(struct pci_dev *dev, int probe)
4898 {
4899         struct pci_dev *pdev;
4900
4901         if (dev->subordinate || !dev->slot ||
4902             dev->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET)
4903                 return -ENOTTY;
4904
4905         list_for_each_entry(pdev, &dev->bus->devices, bus_list)
4906                 if (pdev != dev && pdev->slot == dev->slot)
4907                         return -ENOTTY;
4908
4909         return pci_reset_hotplug_slot(dev->slot->hotplug, probe);
4910 }
4911
4912 static void pci_dev_lock(struct pci_dev *dev)
4913 {
4914         /* block PM suspend, driver probe, etc. */
4915         device_lock(&dev->dev);
4916         pci_cfg_access_lock(dev);
4917 }
4918
4919 /* Return 1 on successful lock, 0 on contention */
4920 static int pci_dev_trylock(struct pci_dev *dev)
4921 {
4922         if (device_trylock(&dev->dev)) {
4923                 if (pci_cfg_access_trylock(dev))
4924                         return 1;
4925                 device_unlock(&dev->dev);
4926         }
4927
4928         return 0;
4929 }
4930
4931 static void pci_dev_unlock(struct pci_dev *dev)
4932 {
4933         pci_cfg_access_unlock(dev);
4934         device_unlock(&dev->dev);
4935 }
4936
4937 static void pci_dev_save_and_disable(struct pci_dev *dev)
4938 {
4939         const struct pci_error_handlers *err_handler =
4940                         dev->driver ? dev->driver->err_handler : NULL;
4941
4942         /*
4943          * dev->driver->err_handler->reset_prepare() is protected against
4944          * races with ->remove() by the device lock, which must be held by
4945          * the caller.
4946          */
4947         if (err_handler && err_handler->reset_prepare)
4948                 err_handler->reset_prepare(dev);
4949
4950         /*
4951          * Wake-up device prior to save.  PM registers default to D0 after
4952          * reset and a simple register restore doesn't reliably return
4953          * to a non-D0 state anyway.
4954          */
4955         pci_set_power_state(dev, PCI_D0);
4956
4957         pci_save_state(dev);
4958         /*
4959          * Disable the device by clearing the Command register, except for
4960          * INTx-disable which is set.  This not only disables MMIO and I/O port
4961          * BARs, but also prevents the device from being Bus Master, preventing
4962          * DMA from the device including MSI/MSI-X interrupts.  For PCI 2.3
4963          * compliant devices, INTx-disable prevents legacy interrupts.
4964          */
4965         pci_write_config_word(dev, PCI_COMMAND, PCI_COMMAND_INTX_DISABLE);
4966 }
4967
4968 static void pci_dev_restore(struct pci_dev *dev)
4969 {
4970         const struct pci_error_handlers *err_handler =
4971                         dev->driver ? dev->driver->err_handler : NULL;
4972
4973         pci_restore_state(dev);
4974
4975         /*
4976          * dev->driver->err_handler->reset_done() is protected against
4977          * races with ->remove() by the device lock, which must be held by
4978          * the caller.
4979          */
4980         if (err_handler && err_handler->reset_done)
4981                 err_handler->reset_done(dev);
4982 }
4983
4984 /**
4985  * __pci_reset_function_locked - reset a PCI device function while holding
4986  * the @dev mutex lock.
4987  * @dev: PCI device to reset
4988  *
4989  * Some devices allow an individual function to be reset without affecting
4990  * other functions in the same device.  The PCI device must be responsive
4991  * to PCI config space in order to use this function.
4992  *
4993  * The device function is presumed to be unused and the caller is holding
4994  * the device mutex lock when this function is called.
4995  *
4996  * Resetting the device will make the contents of PCI configuration space
4997  * random, so any caller of this must be prepared to reinitialise the
4998  * device including MSI, bus mastering, BARs, decoding IO and memory spaces,
4999  * etc.
5000  *
5001  * Returns 0 if the device function was successfully reset or negative if the
5002  * device doesn't support resetting a single function.
5003  */
5004 int __pci_reset_function_locked(struct pci_dev *dev)
5005 {
5006         int rc;
5007
5008         might_sleep();
5009
5010         /*
5011          * A reset method returns -ENOTTY if it doesn't support this device
5012          * and we should try the next method.
5013          *
5014          * If it returns 0 (success), we're finished.  If it returns any
5015          * other error, we're also finished: this indicates that further
5016          * reset mechanisms might be broken on the device.
5017          */
5018         rc = pci_dev_specific_reset(dev, 0);
5019         if (rc != -ENOTTY)
5020                 return rc;
5021         if (pcie_has_flr(dev)) {
5022                 rc = pcie_flr(dev);
5023                 if (rc != -ENOTTY)
5024                         return rc;
5025         }
5026         rc = pci_af_flr(dev, 0);
5027         if (rc != -ENOTTY)
5028                 return rc;
5029         rc = pci_pm_reset(dev, 0);
5030         if (rc != -ENOTTY)
5031                 return rc;
5032         rc = pci_dev_reset_slot_function(dev, 0);
5033         if (rc != -ENOTTY)
5034                 return rc;
5035         return pci_parent_bus_reset(dev, 0);
5036 }
5037 EXPORT_SYMBOL_GPL(__pci_reset_function_locked);
5038
5039 /**
5040  * pci_probe_reset_function - check whether the device can be safely reset
5041  * @dev: PCI device to reset
5042  *
5043  * Some devices allow an individual function to be reset without affecting
5044  * other functions in the same device.  The PCI device must be responsive
5045  * to PCI config space in order to use this function.
5046  *
5047  * Returns 0 if the device function can be reset or negative if the
5048  * device doesn't support resetting a single function.
5049  */
5050 int pci_probe_reset_function(struct pci_dev *dev)
5051 {
5052         int rc;
5053
5054         might_sleep();
5055
5056         rc = pci_dev_specific_reset(dev, 1);
5057         if (rc != -ENOTTY)
5058                 return rc;
5059         if (pcie_has_flr(dev))
5060                 return 0;
5061         rc = pci_af_flr(dev, 1);
5062         if (rc != -ENOTTY)
5063                 return rc;
5064         rc = pci_pm_reset(dev, 1);
5065         if (rc != -ENOTTY)
5066                 return rc;
5067         rc = pci_dev_reset_slot_function(dev, 1);
5068         if (rc != -ENOTTY)
5069                 return rc;
5070
5071         return pci_parent_bus_reset(dev, 1);
5072 }
5073
5074 /**
5075  * pci_reset_function - quiesce and reset a PCI device function
5076  * @dev: PCI device to reset
5077  *
5078  * Some devices allow an individual function to be reset without affecting
5079  * other functions in the same device.  The PCI device must be responsive
5080  * to PCI config space in order to use this function.
5081  *
5082  * This function does not just reset the PCI portion of a device, but
5083  * clears all the state associated with the device.  This function differs
5084  * from __pci_reset_function_locked() in that it saves and restores device state
5085  * over the reset and takes the PCI device lock.
5086  *
5087  * Returns 0 if the device function was successfully reset or negative if the
5088  * device doesn't support resetting a single function.
5089  */
5090 int pci_reset_function(struct pci_dev *dev)
5091 {
5092         int rc;
5093
5094         if (!dev->reset_fn)
5095                 return -ENOTTY;
5096
5097         pci_dev_lock(dev);
5098         pci_dev_save_and_disable(dev);
5099
5100         rc = __pci_reset_function_locked(dev);
5101
5102         pci_dev_restore(dev);
5103         pci_dev_unlock(dev);
5104
5105         return rc;
5106 }
5107 EXPORT_SYMBOL_GPL(pci_reset_function);
5108
5109 /**
5110  * pci_reset_function_locked - quiesce and reset a PCI device function
5111  * @dev: PCI device to reset
5112  *
5113  * Some devices allow an individual function to be reset without affecting
5114  * other functions in the same device.  The PCI device must be responsive
5115  * to PCI config space in order to use this function.
5116  *
5117  * This function does not just reset the PCI portion of a device, but
5118  * clears all the state associated with the device.  This function differs
5119  * from __pci_reset_function_locked() in that it saves and restores device state
5120  * over the reset.  It also differs from pci_reset_function() in that it
5121  * requires the PCI device lock to be held.
5122  *
5123  * Returns 0 if the device function was successfully reset or negative if the
5124  * device doesn't support resetting a single function.
5125  */
5126 int pci_reset_function_locked(struct pci_dev *dev)
5127 {
5128         int rc;
5129
5130         if (!dev->reset_fn)
5131                 return -ENOTTY;
5132
5133         pci_dev_save_and_disable(dev);
5134
5135         rc = __pci_reset_function_locked(dev);
5136
5137         pci_dev_restore(dev);
5138
5139         return rc;
5140 }
5141 EXPORT_SYMBOL_GPL(pci_reset_function_locked);
5142
5143 /**
5144  * pci_try_reset_function - quiesce and reset a PCI device function
5145  * @dev: PCI device to reset
5146  *
5147  * Same as above, except return -EAGAIN if unable to lock device.
5148  */
5149 int pci_try_reset_function(struct pci_dev *dev)
5150 {
5151         int rc;
5152
5153         if (!dev->reset_fn)
5154                 return -ENOTTY;
5155
5156         if (!pci_dev_trylock(dev))
5157                 return -EAGAIN;
5158
5159         pci_dev_save_and_disable(dev);
5160         rc = __pci_reset_function_locked(dev);
5161         pci_dev_restore(dev);
5162         pci_dev_unlock(dev);
5163
5164         return rc;
5165 }
5166 EXPORT_SYMBOL_GPL(pci_try_reset_function);
5167
5168 /* Do any devices on or below this bus prevent a bus reset? */
5169 static bool pci_bus_resetable(struct pci_bus *bus)
5170 {
5171         struct pci_dev *dev;
5172
5173
5174         if (bus->self && (bus->self->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET))
5175                 return false;
5176
5177         list_for_each_entry(dev, &bus->devices, bus_list) {
5178                 if (dev->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET ||
5179                     (dev->subordinate && !pci_bus_resetable(dev->subordinate)))
5180                         return false;
5181         }
5182
5183         return true;
5184 }
5185
5186 /* Lock devices from the top of the tree down */
5187 static void pci_bus_lock(struct pci_bus *bus)
5188 {
5189         struct pci_dev *dev;
5190
5191         list_for_each_entry(dev, &bus->devices, bus_list) {
5192                 pci_dev_lock(dev);
5193                 if (dev->subordinate)
5194                         pci_bus_lock(dev->subordinate);
5195         }
5196 }
5197
5198 /* Unlock devices from the bottom of the tree up */
5199 static void pci_bus_unlock(struct pci_bus *bus)
5200 {
5201         struct pci_dev *dev;
5202
5203         list_for_each_entry(dev, &bus->devices, bus_list) {
5204                 if (dev->subordinate)
5205                         pci_bus_unlock(dev->subordinate);
5206                 pci_dev_unlock(dev);
5207         }
5208 }
5209
5210 /* Return 1 on successful lock, 0 on contention */
5211 static int pci_bus_trylock(struct pci_bus *bus)
5212 {
5213         struct pci_dev *dev;
5214
5215         list_for_each_entry(dev, &bus->devices, bus_list) {
5216                 if (!pci_dev_trylock(dev))
5217                         goto unlock;
5218                 if (dev->subordinate) {
5219                         if (!pci_bus_trylock(dev->subordinate)) {
5220                                 pci_dev_unlock(dev);
5221                                 goto unlock;
5222                         }
5223                 }
5224         }
5225         return 1;
5226
5227 unlock:
5228         list_for_each_entry_continue_reverse(dev, &bus->devices, bus_list) {
5229                 if (dev->subordinate)
5230                         pci_bus_unlock(dev->subordinate);
5231                 pci_dev_unlock(dev);
5232         }
5233         return 0;
5234 }
5235
5236 /* Do any devices on or below this slot prevent a bus reset? */
5237 static bool pci_slot_resetable(struct pci_slot *slot)
5238 {
5239         struct pci_dev *dev;
5240
5241         if (slot->bus->self &&
5242             (slot->bus->self->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET))
5243                 return false;
5244
5245         list_for_each_entry(dev, &slot->bus->devices, bus_list) {
5246                 if (!dev->slot || dev->slot != slot)
5247                         continue;
5248                 if (dev->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET ||
5249                     (dev->subordinate && !pci_bus_resetable(dev->subordinate)))
5250                         return false;
5251         }
5252
5253         return true;
5254 }
5255
5256 /* Lock devices from the top of the tree down */
5257 static void pci_slot_lock(struct pci_slot *slot)
5258 {
5259         struct pci_dev *dev;
5260
5261         list_for_each_entry(dev, &slot->bus->devices, bus_list) {
5262                 if (!dev->slot || dev->slot != slot)
5263                         continue;
5264                 pci_dev_lock(dev);
5265                 if (dev->subordinate)
5266                         pci_bus_lock(dev->subordinate);
5267         }
5268 }
5269
5270 /* Unlock devices from the bottom of the tree up */
5271 static void pci_slot_unlock(struct pci_slot *slot)
5272 {
5273         struct pci_dev *dev;
5274
5275         list_for_each_entry(dev, &slot->bus->devices, bus_list) {
5276                 if (!dev->slot || dev->slot != slot)
5277                         continue;
5278                 if (dev->subordinate)
5279                         pci_bus_unlock(dev->subordinate);
5280                 pci_dev_unlock(dev);
5281         }
5282 }
5283
5284 /* Return 1 on successful lock, 0 on contention */
5285 static int pci_slot_trylock(struct pci_slot *slot)
5286 {
5287         struct pci_dev *dev;
5288
5289         list_for_each_entry(dev, &slot->bus->devices, bus_list) {
5290                 if (!dev->slot || dev->slot != slot)
5291                         continue;
5292                 if (!pci_dev_trylock(dev))
5293                         goto unlock;
5294                 if (dev->subordinate) {
5295                         if (!pci_bus_trylock(dev->subordinate)) {
5296                                 pci_dev_unlock(dev);
5297                                 goto unlock;
5298                         }
5299                 }
5300         }
5301         return 1;
5302
5303 unlock:
5304         list_for_each_entry_continue_reverse(dev,
5305                                              &slot->bus->devices, bus_list) {
5306                 if (!dev->slot || dev->slot != slot)
5307                         continue;
5308                 if (dev->subordinate)
5309                         pci_bus_unlock(dev->subordinate);
5310                 pci_dev_unlock(dev);
5311         }
5312         return 0;
5313 }
5314
5315 /*
5316  * Save and disable devices from the top of the tree down while holding
5317  * the @dev mutex lock for the entire tree.
5318  */
5319 static void pci_bus_save_and_disable_locked(struct pci_bus *bus)
5320 {
5321         struct pci_dev *dev;
5322
5323         list_for_each_entry(dev, &bus->devices, bus_list) {
5324                 pci_dev_save_and_disable(dev);
5325                 if (dev->subordinate)
5326                         pci_bus_save_and_disable_locked(dev->subordinate);
5327         }
5328 }
5329
5330 /*
5331  * Restore devices from top of the tree down while holding @dev mutex lock
5332  * for the entire tree.  Parent bridges need to be restored before we can
5333  * get to subordinate devices.
5334  */
5335 static void pci_bus_restore_locked(struct pci_bus *bus)
5336 {
5337         struct pci_dev *dev;
5338
5339         list_for_each_entry(dev, &bus->devices, bus_list) {
5340                 pci_dev_restore(dev);
5341                 if (dev->subordinate)
5342                         pci_bus_restore_locked(dev->subordinate);
5343         }
5344 }
5345
5346 /*
5347  * Save and disable devices from the top of the tree down while holding
5348  * the @dev mutex lock for the entire tree.
5349  */
5350 static void pci_slot_save_and_disable_locked(struct pci_slot *slot)
5351 {
5352         struct pci_dev *dev;
5353
5354         list_for_each_entry(dev, &slot->bus->devices, bus_list) {
5355                 if (!dev->slot || dev->slot != slot)
5356                         continue;
5357                 pci_dev_save_and_disable(dev);
5358                 if (dev->subordinate)
5359                         pci_bus_save_and_disable_locked(dev->subordinate);
5360         }
5361 }
5362
5363 /*
5364  * Restore devices from top of the tree down while holding @dev mutex lock
5365  * for the entire tree.  Parent bridges need to be restored before we can
5366  * get to subordinate devices.
5367  */
5368 static void pci_slot_restore_locked(struct pci_slot *slot)
5369 {
5370         struct pci_dev *dev;
5371
5372         list_for_each_entry(dev, &slot->bus->devices, bus_list) {
5373                 if (!dev->slot || dev->slot != slot)
5374                         continue;
5375                 pci_dev_restore(dev);
5376                 if (dev->subordinate)
5377                         pci_bus_restore_locked(dev->subordinate);
5378         }
5379 }
5380
5381 static int pci_slot_reset(struct pci_slot *slot, int probe)
5382 {
5383         int rc;
5384
5385         if (!slot || !pci_slot_resetable(slot))
5386                 return -ENOTTY;
5387
5388         if (!probe)
5389                 pci_slot_lock(slot);
5390
5391         might_sleep();
5392
5393         rc = pci_reset_hotplug_slot(slot->hotplug, probe);
5394
5395         if (!probe)
5396                 pci_slot_unlock(slot);
5397
5398         return rc;
5399 }
5400
5401 /**
5402  * pci_probe_reset_slot - probe whether a PCI slot can be reset
5403  * @slot: PCI slot to probe
5404  *
5405  * Return 0 if slot can be reset, negative if a slot reset is not supported.
5406  */
5407 int pci_probe_reset_slot(struct pci_slot *slot)
5408 {
5409         return pci_slot_reset(slot, 1);
5410 }
5411 EXPORT_SYMBOL_GPL(pci_probe_reset_slot);
5412
5413 /**
5414  * __pci_reset_slot - Try to reset a PCI slot
5415  * @slot: PCI slot to reset
5416  *
5417  * A PCI bus may host multiple slots, each slot may support a reset mechanism
5418  * independent of other slots.  For instance, some slots may support slot power
5419  * control.  In the case of a 1:1 bus to slot architecture, this function may
5420  * wrap the bus reset to avoid spurious slot related events such as hotplug.
5421  * Generally a slot reset should be attempted before a bus reset.  All of the
5422  * function of the slot and any subordinate buses behind the slot are reset
5423  * through this function.  PCI config space of all devices in the slot and
5424  * behind the slot is saved before and restored after reset.
5425  *
5426  * Same as above except return -EAGAIN if the slot cannot be locked
5427  */
5428 static int __pci_reset_slot(struct pci_slot *slot)
5429 {
5430         int rc;
5431
5432         rc = pci_slot_reset(slot, 1);
5433         if (rc)
5434                 return rc;
5435
5436         if (pci_slot_trylock(slot)) {
5437                 pci_slot_save_and_disable_locked(slot);
5438                 might_sleep();
5439                 rc = pci_reset_hotplug_slot(slot->hotplug, 0);
5440                 pci_slot_restore_locked(slot);
5441                 pci_slot_unlock(slot);
5442         } else
5443                 rc = -EAGAIN;
5444
5445         return rc;
5446 }
5447
5448 static int pci_bus_reset(struct pci_bus *bus, int probe)
5449 {
5450         int ret;
5451
5452         if (!bus->self || !pci_bus_resetable(bus))
5453                 return -ENOTTY;
5454
5455         if (probe)
5456                 return 0;
5457
5458         pci_bus_lock(bus);
5459
5460         might_sleep();
5461
5462         ret = pci_bridge_secondary_bus_reset(bus->self);
5463
5464         pci_bus_unlock(bus);
5465
5466         return ret;
5467 }
5468
5469 /**
5470  * pci_bus_error_reset - reset the bridge's subordinate bus
5471  * @bridge: The parent device that connects to the bus to reset
5472  *
5473  * This function will first try to reset the slots on this bus if the method is
5474  * available. If slot reset fails or is not available, this will fall back to a
5475  * secondary bus reset.
5476  */
5477 int pci_bus_error_reset(struct pci_dev *bridge)
5478 {
5479         struct pci_bus *bus = bridge->subordinate;
5480         struct pci_slot *slot;
5481
5482         if (!bus)
5483                 return -ENOTTY;
5484
5485         mutex_lock(&pci_slot_mutex);
5486         if (list_empty(&bus->slots))
5487                 goto bus_reset;
5488
5489         list_for_each_entry(slot, &bus->slots, list)
5490                 if (pci_probe_reset_slot(slot))
5491                         goto bus_reset;
5492
5493         list_for_each_entry(slot, &bus->slots, list)
5494                 if (pci_slot_reset(slot, 0))
5495                         goto bus_reset;
5496
5497         mutex_unlock(&pci_slot_mutex);
5498         return 0;
5499 bus_reset:
5500         mutex_unlock(&pci_slot_mutex);
5501         return pci_bus_reset(bridge->subordinate, 0);
5502 }
5503
5504 /**
5505  * pci_probe_reset_bus - probe whether a PCI bus can be reset
5506  * @bus: PCI bus to probe
5507  *
5508  * Return 0 if bus can be reset, negative if a bus reset is not supported.
5509  */
5510 int pci_probe_reset_bus(struct pci_bus *bus)
5511 {
5512         return pci_bus_reset(bus, 1);
5513 }
5514 EXPORT_SYMBOL_GPL(pci_probe_reset_bus);
5515
5516 /**
5517  * __pci_reset_bus - Try to reset a PCI bus
5518  * @bus: top level PCI bus to reset
5519  *
5520  * Same as above except return -EAGAIN if the bus cannot be locked
5521  */
5522 static int __pci_reset_bus(struct pci_bus *bus)
5523 {
5524         int rc;
5525
5526         rc = pci_bus_reset(bus, 1);
5527         if (rc)
5528                 return rc;
5529
5530         if (pci_bus_trylock(bus)) {
5531                 pci_bus_save_and_disable_locked(bus);
5532                 might_sleep();
5533                 rc = pci_bridge_secondary_bus_reset(bus->self);
5534                 pci_bus_restore_locked(bus);
5535                 pci_bus_unlock(bus);
5536         } else
5537                 rc = -EAGAIN;
5538
5539         return rc;
5540 }
5541
5542 /**
5543  * pci_reset_bus - Try to reset a PCI bus
5544  * @pdev: top level PCI device to reset via slot/bus
5545  *
5546  * Same as above except return -EAGAIN if the bus cannot be locked
5547  */
5548 int pci_reset_bus(struct pci_dev *pdev)
5549 {
5550         return (!pci_probe_reset_slot(pdev->slot)) ?
5551             __pci_reset_slot(pdev->slot) : __pci_reset_bus(pdev->bus);
5552 }
5553 EXPORT_SYMBOL_GPL(pci_reset_bus);
5554
5555 /**
5556  * pcix_get_max_mmrbc - get PCI-X maximum designed memory read byte count
5557  * @dev: PCI device to query
5558  *
5559  * Returns mmrbc: maximum designed memory read count in bytes or
5560  * appropriate error value.
5561  */
5562 int pcix_get_max_mmrbc(struct pci_dev *dev)
5563 {
5564         int cap;
5565         u32 stat;
5566
5567         cap = pci_find_capability(dev, PCI_CAP_ID_PCIX);
5568         if (!cap)
5569                 return -EINVAL;
5570
5571         if (pci_read_config_dword(dev, cap + PCI_X_STATUS, &stat))
5572                 return -EINVAL;
5573
5574         return 512 << ((stat & PCI_X_STATUS_MAX_READ) >> 21);
5575 }
5576 EXPORT_SYMBOL(pcix_get_max_mmrbc);
5577
5578 /**
5579  * pcix_get_mmrbc - get PCI-X maximum memory read byte count
5580  * @dev: PCI device to query
5581  *
5582  * Returns mmrbc: maximum memory read count in bytes or appropriate error
5583  * value.
5584  */
5585 int pcix_get_mmrbc(struct pci_dev *dev)
5586 {
5587         int cap;
5588         u16 cmd;
5589
5590         cap = pci_find_capability(dev, PCI_CAP_ID_PCIX);
5591         if (!cap)
5592                 return -EINVAL;
5593
5594         if (pci_read_config_word(dev, cap + PCI_X_CMD, &cmd))
5595                 return -EINVAL;
5596
5597         return 512 << ((cmd & PCI_X_CMD_MAX_READ) >> 2);
5598 }
5599 EXPORT_SYMBOL(pcix_get_mmrbc);
5600
5601 /**
5602  * pcix_set_mmrbc - set PCI-X maximum memory read byte count
5603  * @dev: PCI device to query
5604  * @mmrbc: maximum memory read count in bytes
5605  *    valid values are 512, 1024, 2048, 4096
5606  *
5607  * If possible sets maximum memory read byte count, some bridges have errata
5608  * that prevent this.
5609  */
5610 int pcix_set_mmrbc(struct pci_dev *dev, int mmrbc)
5611 {
5612         int cap;
5613         u32 stat, v, o;
5614         u16 cmd;
5615
5616         if (mmrbc < 512 || mmrbc > 4096 || !is_power_of_2(mmrbc))
5617                 return -EINVAL;
5618
5619         v = ffs(mmrbc) - 10;
5620
5621         cap = pci_find_capability(dev, PCI_CAP_ID_PCIX);
5622         if (!cap)
5623                 return -EINVAL;
5624
5625         if (pci_read_config_dword(dev, cap + PCI_X_STATUS, &stat))
5626                 return -EINVAL;
5627
5628         if (v > (stat & PCI_X_STATUS_MAX_READ) >> 21)
5629                 return -E2BIG;
5630
5631         if (pci_read_config_word(dev, cap + PCI_X_CMD, &cmd))
5632                 return -EINVAL;
5633
5634         o = (cmd & PCI_X_CMD_MAX_READ) >> 2;
5635         if (o != v) {
5636                 if (v > o && (dev->bus->bus_flags & PCI_BUS_FLAGS_NO_MMRBC))
5637                         return -EIO;
5638
5639                 cmd &= ~PCI_X_CMD_MAX_READ;
5640                 cmd |= v << 2;
5641                 if (pci_write_config_word(dev, cap + PCI_X_CMD, cmd))
5642                         return -EIO;
5643         }
5644         return 0;
5645 }
5646 EXPORT_SYMBOL(pcix_set_mmrbc);
5647
5648 /**
5649  * pcie_get_readrq - get PCI Express read request size
5650  * @dev: PCI device to query
5651  *
5652  * Returns maximum memory read request in bytes or appropriate error value.
5653  */
5654 int pcie_get_readrq(struct pci_dev *dev)
5655 {
5656         u16 ctl;
5657
5658         pcie_capability_read_word(dev, PCI_EXP_DEVCTL, &ctl);
5659
5660         return 128 << ((ctl & PCI_EXP_DEVCTL_READRQ) >> 12);
5661 }
5662 EXPORT_SYMBOL(pcie_get_readrq);
5663
5664 /**
5665  * pcie_set_readrq - set PCI Express maximum memory read request
5666  * @dev: PCI device to query
5667  * @rq: maximum memory read count in bytes
5668  *    valid values are 128, 256, 512, 1024, 2048, 4096
5669  *
5670  * If possible sets maximum memory read request in bytes
5671  */
5672 int pcie_set_readrq(struct pci_dev *dev, int rq)
5673 {
5674         u16 v;
5675
5676         if (rq < 128 || rq > 4096 || !is_power_of_2(rq))
5677                 return -EINVAL;
5678
5679         /*
5680          * If using the "performance" PCIe config, we clamp the read rq
5681          * size to the max packet size to keep the host bridge from
5682          * generating requests larger than we can cope with.
5683          */
5684         if (pcie_bus_config == PCIE_BUS_PERFORMANCE) {
5685                 int mps = pcie_get_mps(dev);
5686
5687                 if (mps < rq)
5688                         rq = mps;
5689         }
5690
5691         v = (ffs(rq) - 8) << 12;
5692
5693         return pcie_capability_clear_and_set_word(dev, PCI_EXP_DEVCTL,
5694                                                   PCI_EXP_DEVCTL_READRQ, v);
5695 }
5696 EXPORT_SYMBOL(pcie_set_readrq);
5697
5698 /**
5699  * pcie_get_mps - get PCI Express maximum payload size
5700  * @dev: PCI device to query
5701  *
5702  * Returns maximum payload size in bytes
5703  */
5704 int pcie_get_mps(struct pci_dev *dev)
5705 {
5706         u16 ctl;
5707
5708         pcie_capability_read_word(dev, PCI_EXP_DEVCTL, &ctl);
5709
5710         return 128 << ((ctl & PCI_EXP_DEVCTL_PAYLOAD) >> 5);
5711 }
5712 EXPORT_SYMBOL(pcie_get_mps);
5713
5714 /**
5715  * pcie_set_mps - set PCI Express maximum payload size
5716  * @dev: PCI device to query
5717  * @mps: maximum payload size in bytes
5718  *    valid values are 128, 256, 512, 1024, 2048, 4096
5719  *
5720  * If possible sets maximum payload size
5721  */
5722 int pcie_set_mps(struct pci_dev *dev, int mps)
5723 {
5724         u16 v;
5725
5726         if (mps < 128 || mps > 4096 || !is_power_of_2(mps))
5727                 return -EINVAL;
5728
5729         v = ffs(mps) - 8;
5730         if (v > dev->pcie_mpss)
5731                 return -EINVAL;
5732         v <<= 5;
5733
5734         return pcie_capability_clear_and_set_word(dev, PCI_EXP_DEVCTL,
5735                                                   PCI_EXP_DEVCTL_PAYLOAD, v);
5736 }
5737 EXPORT_SYMBOL(pcie_set_mps);
5738
5739 /**
5740  * pcie_bandwidth_available - determine minimum link settings of a PCIe
5741  *                            device and its bandwidth limitation
5742  * @dev: PCI device to query
5743  * @limiting_dev: storage for device causing the bandwidth limitation
5744  * @speed: storage for speed of limiting device
5745  * @width: storage for width of limiting device
5746  *
5747  * Walk up the PCI device chain and find the point where the minimum
5748  * bandwidth is available.  Return the bandwidth available there and (if
5749  * limiting_dev, speed, and width pointers are supplied) information about
5750  * that point.  The bandwidth returned is in Mb/s, i.e., megabits/second of
5751  * raw bandwidth.
5752  */
5753 u32 pcie_bandwidth_available(struct pci_dev *dev, struct pci_dev **limiting_dev,
5754                              enum pci_bus_speed *speed,
5755                              enum pcie_link_width *width)
5756 {
5757         u16 lnksta;
5758         enum pci_bus_speed next_speed;
5759         enum pcie_link_width next_width;
5760         u32 bw, next_bw;
5761
5762         if (speed)
5763                 *speed = PCI_SPEED_UNKNOWN;
5764         if (width)
5765                 *width = PCIE_LNK_WIDTH_UNKNOWN;
5766
5767         bw = 0;
5768
5769         while (dev) {
5770                 pcie_capability_read_word(dev, PCI_EXP_LNKSTA, &lnksta);
5771
5772                 next_speed = pcie_link_speed[lnksta & PCI_EXP_LNKSTA_CLS];
5773                 next_width = (lnksta & PCI_EXP_LNKSTA_NLW) >>
5774                         PCI_EXP_LNKSTA_NLW_SHIFT;
5775
5776                 next_bw = next_width * PCIE_SPEED2MBS_ENC(next_speed);
5777
5778                 /* Check if current device limits the total bandwidth */
5779                 if (!bw || next_bw <= bw) {
5780                         bw = next_bw;
5781
5782                         if (limiting_dev)
5783                                 *limiting_dev = dev;
5784                         if (speed)
5785                                 *speed = next_speed;
5786                         if (width)
5787                                 *width = next_width;
5788                 }
5789
5790                 dev = pci_upstream_bridge(dev);
5791         }
5792
5793         return bw;
5794 }
5795 EXPORT_SYMBOL(pcie_bandwidth_available);
5796
5797 /**
5798  * pcie_get_speed_cap - query for the PCI device's link speed capability
5799  * @dev: PCI device to query
5800  *
5801  * Query the PCI device speed capability.  Return the maximum link speed
5802  * supported by the device.
5803  */
5804 enum pci_bus_speed pcie_get_speed_cap(struct pci_dev *dev)
5805 {
5806         u32 lnkcap2, lnkcap;
5807
5808         /*
5809          * Link Capabilities 2 was added in PCIe r3.0, sec 7.8.18.  The
5810          * implementation note there recommends using the Supported Link
5811          * Speeds Vector in Link Capabilities 2 when supported.
5812          *
5813          * Without Link Capabilities 2, i.e., prior to PCIe r3.0, software
5814          * should use the Supported Link Speeds field in Link Capabilities,
5815          * where only 2.5 GT/s and 5.0 GT/s speeds were defined.
5816          */
5817         pcie_capability_read_dword(dev, PCI_EXP_LNKCAP2, &lnkcap2);
5818         if (lnkcap2) { /* PCIe r3.0-compliant */
5819                 if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_32_0GB)
5820                         return PCIE_SPEED_32_0GT;
5821                 else if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_16_0GB)
5822                         return PCIE_SPEED_16_0GT;
5823                 else if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_8_0GB)
5824                         return PCIE_SPEED_8_0GT;
5825                 else if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_5_0GB)
5826                         return PCIE_SPEED_5_0GT;
5827                 else if (lnkcap2 & PCI_EXP_LNKCAP2_SLS_2_5GB)
5828                         return PCIE_SPEED_2_5GT;
5829                 return PCI_SPEED_UNKNOWN;
5830         }
5831
5832         pcie_capability_read_dword(dev, PCI_EXP_LNKCAP, &lnkcap);
5833         if ((lnkcap & PCI_EXP_LNKCAP_SLS) == PCI_EXP_LNKCAP_SLS_5_0GB)
5834                 return PCIE_SPEED_5_0GT;
5835         else if ((lnkcap & PCI_EXP_LNKCAP_SLS) == PCI_EXP_LNKCAP_SLS_2_5GB)
5836                 return PCIE_SPEED_2_5GT;
5837
5838         return PCI_SPEED_UNKNOWN;
5839 }
5840 EXPORT_SYMBOL(pcie_get_speed_cap);
5841
5842 /**
5843  * pcie_get_width_cap - query for the PCI device's link width capability
5844  * @dev: PCI device to query
5845  *
5846  * Query the PCI device width capability.  Return the maximum link width
5847  * supported by the device.
5848  */
5849 enum pcie_link_width pcie_get_width_cap(struct pci_dev *dev)
5850 {
5851         u32 lnkcap;
5852
5853         pcie_capability_read_dword(dev, PCI_EXP_LNKCAP, &lnkcap);
5854         if (lnkcap)
5855                 return (lnkcap & PCI_EXP_LNKCAP_MLW) >> 4;
5856
5857         return PCIE_LNK_WIDTH_UNKNOWN;
5858 }
5859 EXPORT_SYMBOL(pcie_get_width_cap);
5860
5861 /**
5862  * pcie_bandwidth_capable - calculate a PCI device's link bandwidth capability
5863  * @dev: PCI device
5864  * @speed: storage for link speed
5865  * @width: storage for link width
5866  *
5867  * Calculate a PCI device's link bandwidth by querying for its link speed
5868  * and width, multiplying them, and applying encoding overhead.  The result
5869  * is in Mb/s, i.e., megabits/second of raw bandwidth.
5870  */
5871 u32 pcie_bandwidth_capable(struct pci_dev *dev, enum pci_bus_speed *speed,
5872                            enum pcie_link_width *width)
5873 {
5874         *speed = pcie_get_speed_cap(dev);
5875         *width = pcie_get_width_cap(dev);
5876
5877         if (*speed == PCI_SPEED_UNKNOWN || *width == PCIE_LNK_WIDTH_UNKNOWN)
5878                 return 0;
5879
5880         return *width * PCIE_SPEED2MBS_ENC(*speed);
5881 }
5882
5883 /**
5884  * __pcie_print_link_status - Report the PCI device's link speed and width
5885  * @dev: PCI device to query
5886  * @verbose: Print info even when enough bandwidth is available
5887  *
5888  * If the available bandwidth at the device is less than the device is
5889  * capable of, report the device's maximum possible bandwidth and the
5890  * upstream link that limits its performance.  If @verbose, always print
5891  * the available bandwidth, even if the device isn't constrained.
5892  */
5893 void __pcie_print_link_status(struct pci_dev *dev, bool verbose)
5894 {
5895         enum pcie_link_width width, width_cap;
5896         enum pci_bus_speed speed, speed_cap;
5897         struct pci_dev *limiting_dev = NULL;
5898         u32 bw_avail, bw_cap;
5899
5900         bw_cap = pcie_bandwidth_capable(dev, &speed_cap, &width_cap);
5901         bw_avail = pcie_bandwidth_available(dev, &limiting_dev, &speed, &width);
5902
5903         if (bw_avail >= bw_cap && verbose)
5904                 pci_info(dev, "%u.%03u Gb/s available PCIe bandwidth (%s x%d link)\n",
5905                          bw_cap / 1000, bw_cap % 1000,
5906                          PCIE_SPEED2STR(speed_cap), width_cap);
5907         else if (bw_avail < bw_cap)
5908                 pci_info(dev, "%u.%03u Gb/s available PCIe bandwidth, limited by %s x%d link at %s (capable of %u.%03u Gb/s with %s x%d link)\n",
5909                          bw_avail / 1000, bw_avail % 1000,
5910                          PCIE_SPEED2STR(speed), width,
5911                          limiting_dev ? pci_name(limiting_dev) : "<unknown>",
5912                          bw_cap / 1000, bw_cap % 1000,
5913                          PCIE_SPEED2STR(speed_cap), width_cap);
5914 }
5915
5916 /**
5917  * pcie_print_link_status - Report the PCI device's link speed and width
5918  * @dev: PCI device to query
5919  *
5920  * Report the available bandwidth at the device.
5921  */
5922 void pcie_print_link_status(struct pci_dev *dev)
5923 {
5924         __pcie_print_link_status(dev, true);
5925 }
5926 EXPORT_SYMBOL(pcie_print_link_status);
5927
5928 /**
5929  * pci_select_bars - Make BAR mask from the type of resource
5930  * @dev: the PCI device for which BAR mask is made
5931  * @flags: resource type mask to be selected
5932  *
5933  * This helper routine makes bar mask from the type of resource.
5934  */
5935 int pci_select_bars(struct pci_dev *dev, unsigned long flags)
5936 {
5937         int i, bars = 0;
5938         for (i = 0; i < PCI_NUM_RESOURCES; i++)
5939                 if (pci_resource_flags(dev, i) & flags)
5940                         bars |= (1 << i);
5941         return bars;
5942 }
5943 EXPORT_SYMBOL(pci_select_bars);
5944
5945 /* Some architectures require additional programming to enable VGA */
5946 static arch_set_vga_state_t arch_set_vga_state;
5947
5948 void __init pci_register_set_vga_state(arch_set_vga_state_t func)
5949 {
5950         arch_set_vga_state = func;      /* NULL disables */
5951 }
5952
5953 static int pci_set_vga_state_arch(struct pci_dev *dev, bool decode,
5954                                   unsigned int command_bits, u32 flags)
5955 {
5956         if (arch_set_vga_state)
5957                 return arch_set_vga_state(dev, decode, command_bits,
5958                                                 flags);
5959         return 0;
5960 }
5961
5962 /**
5963  * pci_set_vga_state - set VGA decode state on device and parents if requested
5964  * @dev: the PCI device
5965  * @decode: true = enable decoding, false = disable decoding
5966  * @command_bits: PCI_COMMAND_IO and/or PCI_COMMAND_MEMORY
5967  * @flags: traverse ancestors and change bridges
5968  * CHANGE_BRIDGE_ONLY / CHANGE_BRIDGE
5969  */
5970 int pci_set_vga_state(struct pci_dev *dev, bool decode,
5971                       unsigned int command_bits, u32 flags)
5972 {
5973         struct pci_bus *bus;
5974         struct pci_dev *bridge;
5975         u16 cmd;
5976         int rc;
5977
5978         WARN_ON((flags & PCI_VGA_STATE_CHANGE_DECODES) && (command_bits & ~(PCI_COMMAND_IO|PCI_COMMAND_MEMORY)));
5979
5980         /* ARCH specific VGA enables */
5981         rc = pci_set_vga_state_arch(dev, decode, command_bits, flags);
5982         if (rc)
5983                 return rc;
5984
5985         if (flags & PCI_VGA_STATE_CHANGE_DECODES) {
5986                 pci_read_config_word(dev, PCI_COMMAND, &cmd);
5987                 if (decode == true)
5988                         cmd |= command_bits;
5989                 else
5990                         cmd &= ~command_bits;
5991                 pci_write_config_word(dev, PCI_COMMAND, cmd);
5992         }
5993
5994         if (!(flags & PCI_VGA_STATE_CHANGE_BRIDGE))
5995                 return 0;
5996
5997         bus = dev->bus;
5998         while (bus) {
5999                 bridge = bus->self;
6000                 if (bridge) {
6001                         pci_read_config_word(bridge, PCI_BRIDGE_CONTROL,
6002                                              &cmd);
6003                         if (decode == true)
6004                                 cmd |= PCI_BRIDGE_CTL_VGA;
6005                         else
6006                                 cmd &= ~PCI_BRIDGE_CTL_VGA;
6007                         pci_write_config_word(bridge, PCI_BRIDGE_CONTROL,
6008                                               cmd);
6009                 }
6010                 bus = bus->parent;
6011         }
6012         return 0;
6013 }
6014
6015 #ifdef CONFIG_ACPI
6016 bool pci_pr3_present(struct pci_dev *pdev)
6017 {
6018         struct acpi_device *adev;
6019
6020         if (acpi_disabled)
6021                 return false;
6022
6023         adev = ACPI_COMPANION(&pdev->dev);
6024         if (!adev)
6025                 return false;
6026
6027         return adev->power.flags.power_resources &&
6028                 acpi_has_method(adev->handle, "_PR3");
6029 }
6030 EXPORT_SYMBOL_GPL(pci_pr3_present);
6031 #endif
6032
6033 /**
6034  * pci_add_dma_alias - Add a DMA devfn alias for a device
6035  * @dev: the PCI device for which alias is added
6036  * @devfn_from: alias slot and function
6037  * @nr_devfns: number of subsequent devfns to alias
6038  *
6039  * This helper encodes an 8-bit devfn as a bit number in dma_alias_mask
6040  * which is used to program permissible bus-devfn source addresses for DMA
6041  * requests in an IOMMU.  These aliases factor into IOMMU group creation
6042  * and are useful for devices generating DMA requests beyond or different
6043  * from their logical bus-devfn.  Examples include device quirks where the
6044  * device simply uses the wrong devfn, as well as non-transparent bridges
6045  * where the alias may be a proxy for devices in another domain.
6046  *
6047  * IOMMU group creation is performed during device discovery or addition,
6048  * prior to any potential DMA mapping and therefore prior to driver probing
6049  * (especially for userspace assigned devices where IOMMU group definition
6050  * cannot be left as a userspace activity).  DMA aliases should therefore
6051  * be configured via quirks, such as the PCI fixup header quirk.
6052  */
6053 void pci_add_dma_alias(struct pci_dev *dev, u8 devfn_from, unsigned nr_devfns)
6054 {
6055         int devfn_to;
6056
6057         nr_devfns = min(nr_devfns, (unsigned) MAX_NR_DEVFNS - devfn_from);
6058         devfn_to = devfn_from + nr_devfns - 1;
6059
6060         if (!dev->dma_alias_mask)
6061                 dev->dma_alias_mask = bitmap_zalloc(MAX_NR_DEVFNS, GFP_KERNEL);
6062         if (!dev->dma_alias_mask) {
6063                 pci_warn(dev, "Unable to allocate DMA alias mask\n");
6064                 return;
6065         }
6066
6067         bitmap_set(dev->dma_alias_mask, devfn_from, nr_devfns);
6068
6069         if (nr_devfns == 1)
6070                 pci_info(dev, "Enabling fixed DMA alias to %02x.%d\n",
6071                                 PCI_SLOT(devfn_from), PCI_FUNC(devfn_from));
6072         else if (nr_devfns > 1)
6073                 pci_info(dev, "Enabling fixed DMA alias for devfn range from %02x.%d to %02x.%d\n",
6074                                 PCI_SLOT(devfn_from), PCI_FUNC(devfn_from),
6075                                 PCI_SLOT(devfn_to), PCI_FUNC(devfn_to));
6076 }
6077
6078 bool pci_devs_are_dma_aliases(struct pci_dev *dev1, struct pci_dev *dev2)
6079 {
6080         return (dev1->dma_alias_mask &&
6081                 test_bit(dev2->devfn, dev1->dma_alias_mask)) ||
6082                (dev2->dma_alias_mask &&
6083                 test_bit(dev1->devfn, dev2->dma_alias_mask));
6084 }
6085
6086 bool pci_device_is_present(struct pci_dev *pdev)
6087 {
6088         u32 v;
6089
6090         /* Check PF if pdev is a VF, since VF Vendor/Device IDs are 0xffff */
6091         pdev = pci_physfn(pdev);
6092         if (pci_dev_is_disconnected(pdev))
6093                 return false;
6094         return pci_bus_read_dev_vendor_id(pdev->bus, pdev->devfn, &v, 0);
6095 }
6096 EXPORT_SYMBOL_GPL(pci_device_is_present);
6097
6098 void pci_ignore_hotplug(struct pci_dev *dev)
6099 {
6100         struct pci_dev *bridge = dev->bus->self;
6101
6102         dev->ignore_hotplug = 1;
6103         /* Propagate the "ignore hotplug" setting to the parent bridge. */
6104         if (bridge)
6105                 bridge->ignore_hotplug = 1;
6106 }
6107 EXPORT_SYMBOL_GPL(pci_ignore_hotplug);
6108
6109 resource_size_t __weak pcibios_default_alignment(void)
6110 {
6111         return 0;
6112 }
6113
6114 /*
6115  * Arches that don't want to expose struct resource to userland as-is in
6116  * sysfs and /proc can implement their own pci_resource_to_user().
6117  */
6118 void __weak pci_resource_to_user(const struct pci_dev *dev, int bar,
6119                                  const struct resource *rsrc,
6120                                  resource_size_t *start, resource_size_t *end)
6121 {
6122         *start = rsrc->start;
6123         *end = rsrc->end;
6124 }
6125
6126 static char *resource_alignment_param;
6127 static DEFINE_SPINLOCK(resource_alignment_lock);
6128
6129 /**
6130  * pci_specified_resource_alignment - get resource alignment specified by user.
6131  * @dev: the PCI device to get
6132  * @resize: whether or not to change resources' size when reassigning alignment
6133  *
6134  * RETURNS: Resource alignment if it is specified.
6135  *          Zero if it is not specified.
6136  */
6137 static resource_size_t pci_specified_resource_alignment(struct pci_dev *dev,
6138                                                         bool *resize)
6139 {
6140         int align_order, count;
6141         resource_size_t align = pcibios_default_alignment();
6142         const char *p;
6143         int ret;
6144
6145         spin_lock(&resource_alignment_lock);
6146         p = resource_alignment_param;
6147         if (!p || !*p)
6148                 goto out;
6149         if (pci_has_flag(PCI_PROBE_ONLY)) {
6150                 align = 0;
6151                 pr_info_once("PCI: Ignoring requested alignments (PCI_PROBE_ONLY)\n");
6152                 goto out;
6153         }
6154
6155         while (*p) {
6156                 count = 0;
6157                 if (sscanf(p, "%d%n", &align_order, &count) == 1 &&
6158                     p[count] == '@') {
6159                         p += count + 1;
6160                         if (align_order > 63) {
6161                                 pr_err("PCI: Invalid requested alignment (order %d)\n",
6162                                        align_order);
6163                                 align_order = PAGE_SHIFT;
6164                         }
6165                 } else {
6166                         align_order = PAGE_SHIFT;
6167                 }
6168
6169                 ret = pci_dev_str_match(dev, p, &p);
6170                 if (ret == 1) {
6171                         *resize = true;
6172                         align = 1ULL << align_order;
6173                         break;
6174                 } else if (ret < 0) {
6175                         pr_err("PCI: Can't parse resource_alignment parameter: %s\n",
6176                                p);
6177                         break;
6178                 }
6179
6180                 if (*p != ';' && *p != ',') {
6181                         /* End of param or invalid format */
6182                         break;
6183                 }
6184                 p++;
6185         }
6186 out:
6187         spin_unlock(&resource_alignment_lock);
6188         return align;
6189 }
6190
6191 static void pci_request_resource_alignment(struct pci_dev *dev, int bar,
6192                                            resource_size_t align, bool resize)
6193 {
6194         struct resource *r = &dev->resource[bar];
6195         resource_size_t size;
6196
6197         if (!(r->flags & IORESOURCE_MEM))
6198                 return;
6199
6200         if (r->flags & IORESOURCE_PCI_FIXED) {
6201                 pci_info(dev, "BAR%d %pR: ignoring requested alignment %#llx\n",
6202                          bar, r, (unsigned long long)align);
6203                 return;
6204         }
6205
6206         size = resource_size(r);
6207         if (size >= align)
6208                 return;
6209
6210         /*
6211          * Increase the alignment of the resource.  There are two ways we
6212          * can do this:
6213          *
6214          * 1) Increase the size of the resource.  BARs are aligned on their
6215          *    size, so when we reallocate space for this resource, we'll
6216          *    allocate it with the larger alignment.  This also prevents
6217          *    assignment of any other BARs inside the alignment region, so
6218          *    if we're requesting page alignment, this means no other BARs
6219          *    will share the page.
6220          *
6221          *    The disadvantage is that this makes the resource larger than
6222          *    the hardware BAR, which may break drivers that compute things
6223          *    based on the resource size, e.g., to find registers at a
6224          *    fixed offset before the end of the BAR.
6225          *
6226          * 2) Retain the resource size, but use IORESOURCE_STARTALIGN and
6227          *    set r->start to the desired alignment.  By itself this
6228          *    doesn't prevent other BARs being put inside the alignment
6229          *    region, but if we realign *every* resource of every device in
6230          *    the system, none of them will share an alignment region.
6231          *
6232          * When the user has requested alignment for only some devices via
6233          * the "pci=resource_alignment" argument, "resize" is true and we
6234          * use the first method.  Otherwise we assume we're aligning all
6235          * devices and we use the second.
6236          */
6237
6238         pci_info(dev, "BAR%d %pR: requesting alignment to %#llx\n",
6239                  bar, r, (unsigned long long)align);
6240
6241         if (resize) {
6242                 r->start = 0;
6243                 r->end = align - 1;
6244         } else {
6245                 r->flags &= ~IORESOURCE_SIZEALIGN;
6246                 r->flags |= IORESOURCE_STARTALIGN;
6247                 r->start = align;
6248                 r->end = r->start + size - 1;
6249         }
6250         r->flags |= IORESOURCE_UNSET;
6251 }
6252
6253 /*
6254  * This function disables memory decoding and releases memory resources
6255  * of the device specified by kernel's boot parameter 'pci=resource_alignment='.
6256  * It also rounds up size to specified alignment.
6257  * Later on, the kernel will assign page-aligned memory resource back
6258  * to the device.
6259  */
6260 void pci_reassigndev_resource_alignment(struct pci_dev *dev)
6261 {
6262         int i;
6263         struct resource *r;
6264         resource_size_t align;
6265         u16 command;
6266         bool resize = false;
6267
6268         /*
6269          * VF BARs are read-only zero according to SR-IOV spec r1.1, sec
6270          * 3.4.1.11.  Their resources are allocated from the space
6271          * described by the VF BARx register in the PF's SR-IOV capability.
6272          * We can't influence their alignment here.
6273          */
6274         if (dev->is_virtfn)
6275                 return;
6276
6277         /* check if specified PCI is target device to reassign */
6278         align = pci_specified_resource_alignment(dev, &resize);
6279         if (!align)
6280                 return;
6281
6282         if (dev->hdr_type == PCI_HEADER_TYPE_NORMAL &&
6283             (dev->class >> 8) == PCI_CLASS_BRIDGE_HOST) {
6284                 pci_warn(dev, "Can't reassign resources to host bridge\n");
6285                 return;
6286         }
6287
6288         pci_read_config_word(dev, PCI_COMMAND, &command);
6289         command &= ~PCI_COMMAND_MEMORY;
6290         pci_write_config_word(dev, PCI_COMMAND, command);
6291
6292         for (i = 0; i <= PCI_ROM_RESOURCE; i++)
6293                 pci_request_resource_alignment(dev, i, align, resize);
6294
6295         /*
6296          * Need to disable bridge's resource window,
6297          * to enable the kernel to reassign new resource
6298          * window later on.
6299          */
6300         if (dev->hdr_type == PCI_HEADER_TYPE_BRIDGE) {
6301                 for (i = PCI_BRIDGE_RESOURCES; i < PCI_NUM_RESOURCES; i++) {
6302                         r = &dev->resource[i];
6303                         if (!(r->flags & IORESOURCE_MEM))
6304                                 continue;
6305                         r->flags |= IORESOURCE_UNSET;
6306                         r->end = resource_size(r) - 1;
6307                         r->start = 0;
6308                 }
6309                 pci_disable_bridge_window(dev);
6310         }
6311 }
6312
6313 static ssize_t resource_alignment_show(struct bus_type *bus, char *buf)
6314 {
6315         size_t count = 0;
6316
6317         spin_lock(&resource_alignment_lock);
6318         if (resource_alignment_param)
6319                 count = snprintf(buf, PAGE_SIZE, "%s", resource_alignment_param);
6320         spin_unlock(&resource_alignment_lock);
6321
6322         /*
6323          * When set by the command line, resource_alignment_param will not
6324          * have a trailing line feed, which is ugly. So conditionally add
6325          * it here.
6326          */
6327         if (count >= 2 && buf[count - 2] != '\n' && count < PAGE_SIZE - 1) {
6328                 buf[count - 1] = '\n';
6329                 buf[count++] = 0;
6330         }
6331
6332         return count;
6333 }
6334
6335 static ssize_t resource_alignment_store(struct bus_type *bus,
6336                                         const char *buf, size_t count)
6337 {
6338         char *param = kstrndup(buf, count, GFP_KERNEL);
6339
6340         if (!param)
6341                 return -ENOMEM;
6342
6343         spin_lock(&resource_alignment_lock);
6344         kfree(resource_alignment_param);
6345         resource_alignment_param = param;
6346         spin_unlock(&resource_alignment_lock);
6347         return count;
6348 }
6349
6350 static BUS_ATTR_RW(resource_alignment);
6351
6352 static int __init pci_resource_alignment_sysfs_init(void)
6353 {
6354         return bus_create_file(&pci_bus_type,
6355                                         &bus_attr_resource_alignment);
6356 }
6357 late_initcall(pci_resource_alignment_sysfs_init);
6358
6359 static void pci_no_domains(void)
6360 {
6361 #ifdef CONFIG_PCI_DOMAINS
6362         pci_domains_supported = 0;
6363 #endif
6364 }
6365
6366 #ifdef CONFIG_PCI_DOMAINS_GENERIC
6367 static atomic_t __domain_nr = ATOMIC_INIT(-1);
6368
6369 static int pci_get_new_domain_nr(void)
6370 {
6371         return atomic_inc_return(&__domain_nr);
6372 }
6373
6374 static int of_pci_bus_find_domain_nr(struct device *parent)
6375 {
6376         static int use_dt_domains = -1;
6377         int domain = -1;
6378
6379         if (parent)
6380                 domain = of_get_pci_domain_nr(parent->of_node);
6381
6382         /*
6383          * Check DT domain and use_dt_domains values.
6384          *
6385          * If DT domain property is valid (domain >= 0) and
6386          * use_dt_domains != 0, the DT assignment is valid since this means
6387          * we have not previously allocated a domain number by using
6388          * pci_get_new_domain_nr(); we should also update use_dt_domains to
6389          * 1, to indicate that we have just assigned a domain number from
6390          * DT.
6391          *
6392          * If DT domain property value is not valid (ie domain < 0), and we
6393          * have not previously assigned a domain number from DT
6394          * (use_dt_domains != 1) we should assign a domain number by
6395          * using the:
6396          *
6397          * pci_get_new_domain_nr()
6398          *
6399          * API and update the use_dt_domains value to keep track of method we
6400          * are using to assign domain numbers (use_dt_domains = 0).
6401          *
6402          * All other combinations imply we have a platform that is trying
6403          * to mix domain numbers obtained from DT and pci_get_new_domain_nr(),
6404          * which is a recipe for domain mishandling and it is prevented by
6405          * invalidating the domain value (domain = -1) and printing a
6406          * corresponding error.
6407          */
6408         if (domain >= 0 && use_dt_domains) {
6409                 use_dt_domains = 1;
6410         } else if (domain < 0 && use_dt_domains != 1) {
6411                 use_dt_domains = 0;
6412                 domain = pci_get_new_domain_nr();
6413         } else {
6414                 if (parent)
6415                         pr_err("Node %pOF has ", parent->of_node);
6416                 pr_err("Inconsistent \"linux,pci-domain\" property in DT\n");
6417                 domain = -1;
6418         }
6419
6420         return domain;
6421 }
6422
6423 int pci_bus_find_domain_nr(struct pci_bus *bus, struct device *parent)
6424 {
6425         return acpi_disabled ? of_pci_bus_find_domain_nr(parent) :
6426                                acpi_pci_bus_find_domain_nr(bus);
6427 }
6428 #endif
6429
6430 /**
6431  * pci_ext_cfg_avail - can we access extended PCI config space?
6432  *
6433  * Returns 1 if we can access PCI extended config space (offsets
6434  * greater than 0xff). This is the default implementation. Architecture
6435  * implementations can override this.
6436  */
6437 int __weak pci_ext_cfg_avail(void)
6438 {
6439         return 1;
6440 }
6441
6442 void __weak pci_fixup_cardbus(struct pci_bus *bus)
6443 {
6444 }
6445 EXPORT_SYMBOL(pci_fixup_cardbus);
6446
6447 static int __init pci_setup(char *str)
6448 {
6449         while (str) {
6450                 char *k = strchr(str, ',');
6451                 if (k)
6452                         *k++ = 0;
6453                 if (*str && (str = pcibios_setup(str)) && *str) {
6454                         if (!strcmp(str, "nomsi")) {
6455                                 pci_no_msi();
6456                         } else if (!strncmp(str, "noats", 5)) {
6457                                 pr_info("PCIe: ATS is disabled\n");
6458                                 pcie_ats_disabled = true;
6459                         } else if (!strcmp(str, "noaer")) {
6460                                 pci_no_aer();
6461                         } else if (!strcmp(str, "earlydump")) {
6462                                 pci_early_dump = true;
6463                         } else if (!strncmp(str, "realloc=", 8)) {
6464                                 pci_realloc_get_opt(str + 8);
6465                         } else if (!strncmp(str, "realloc", 7)) {
6466                                 pci_realloc_get_opt("on");
6467                         } else if (!strcmp(str, "nodomains")) {
6468                                 pci_no_domains();
6469                         } else if (!strncmp(str, "noari", 5)) {
6470                                 pcie_ari_disabled = true;
6471                         } else if (!strncmp(str, "cbiosize=", 9)) {
6472                                 pci_cardbus_io_size = memparse(str + 9, &str);
6473                         } else if (!strncmp(str, "cbmemsize=", 10)) {
6474                                 pci_cardbus_mem_size = memparse(str + 10, &str);
6475                         } else if (!strncmp(str, "resource_alignment=", 19)) {
6476                                 resource_alignment_param = str + 19;
6477                         } else if (!strncmp(str, "ecrc=", 5)) {
6478                                 pcie_ecrc_get_policy(str + 5);
6479                         } else if (!strncmp(str, "hpiosize=", 9)) {
6480                                 pci_hotplug_io_size = memparse(str + 9, &str);
6481                         } else if (!strncmp(str, "hpmemsize=", 10)) {
6482                                 pci_hotplug_mem_size = memparse(str + 10, &str);
6483                         } else if (!strncmp(str, "hpbussize=", 10)) {
6484                                 pci_hotplug_bus_size =
6485                                         simple_strtoul(str + 10, &str, 0);
6486                                 if (pci_hotplug_bus_size > 0xff)
6487                                         pci_hotplug_bus_size = DEFAULT_HOTPLUG_BUS_SIZE;
6488                         } else if (!strncmp(str, "pcie_bus_tune_off", 17)) {
6489                                 pcie_bus_config = PCIE_BUS_TUNE_OFF;
6490                         } else if (!strncmp(str, "pcie_bus_safe", 13)) {
6491                                 pcie_bus_config = PCIE_BUS_SAFE;
6492                         } else if (!strncmp(str, "pcie_bus_perf", 13)) {
6493                                 pcie_bus_config = PCIE_BUS_PERFORMANCE;
6494                         } else if (!strncmp(str, "pcie_bus_peer2peer", 18)) {
6495                                 pcie_bus_config = PCIE_BUS_PEER2PEER;
6496                         } else if (!strncmp(str, "pcie_scan_all", 13)) {
6497                                 pci_add_flags(PCI_SCAN_ALL_PCIE_DEVS);
6498                         } else if (!strncmp(str, "disable_acs_redir=", 18)) {
6499                                 disable_acs_redir_param = str + 18;
6500                         } else {
6501                                 pr_err("PCI: Unknown option `%s'\n", str);
6502                         }
6503                 }
6504                 str = k;
6505         }
6506         return 0;
6507 }
6508 early_param("pci", pci_setup);
6509
6510 /*
6511  * 'resource_alignment_param' and 'disable_acs_redir_param' are initialized
6512  * in pci_setup(), above, to point to data in the __initdata section which
6513  * will be freed after the init sequence is complete. We can't allocate memory
6514  * in pci_setup() because some architectures do not have any memory allocation
6515  * service available during an early_param() call. So we allocate memory and
6516  * copy the variable here before the init section is freed.
6517  *
6518  */
6519 static int __init pci_realloc_setup_params(void)
6520 {
6521         resource_alignment_param = kstrdup(resource_alignment_param,
6522                                            GFP_KERNEL);
6523         disable_acs_redir_param = kstrdup(disable_acs_redir_param, GFP_KERNEL);
6524
6525         return 0;
6526 }
6527 pure_initcall(pci_realloc_setup_params);