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