1 // SPDX-License-Identifier: GPL-2.0
3 * PCI Bus Services, see include/linux/pci.h for further explanation.
5 * Copyright 1993 -- 1997 Drew Eckhardt, Frederic Potter,
8 * Copyright 1997 -- 2000 Martin Mares <mj@ucw.cz>
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>
18 #include <linux/pci.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>
33 #include <linux/aer.h>
34 #include <linux/bitfield.h>
37 DEFINE_MUTEX(pci_slot_mutex);
39 const char *pci_power_names[] = {
40 "error", "D0", "D1", "D2", "D3hot", "D3cold", "unknown",
42 EXPORT_SYMBOL_GPL(pci_power_names);
45 int isa_dma_bridge_buggy;
46 EXPORT_SYMBOL(isa_dma_bridge_buggy);
50 EXPORT_SYMBOL(pci_pci_problems);
52 unsigned int pci_pm_d3hot_delay;
54 static void pci_pme_list_scan(struct work_struct *work);
56 static LIST_HEAD(pci_pme_list);
57 static DEFINE_MUTEX(pci_pme_list_mutex);
58 static DECLARE_DELAYED_WORK(pci_pme_work, pci_pme_list_scan);
60 struct pci_pme_device {
61 struct list_head list;
65 #define PME_TIMEOUT 1000 /* How long between PME checks */
68 * Following exit from Conventional Reset, devices must be ready within 1 sec
69 * (PCIe r6.0 sec 6.6.1). A D3cold to D0 transition implies a Conventional
70 * Reset (PCIe r6.0 sec 5.8).
72 #define PCI_RESET_WAIT 1000 /* msec */
75 * Devices may extend the 1 sec period through Request Retry Status
76 * completions (PCIe r6.0 sec 2.3.1). The spec does not provide an upper
77 * limit, but 60 sec ought to be enough for any device to become
80 #define PCIE_RESET_READY_POLL_MS 60000 /* msec */
82 static void pci_dev_d3_sleep(struct pci_dev *dev)
84 unsigned int delay_ms = max(dev->d3hot_delay, pci_pm_d3hot_delay);
88 /* Use a 20% upper bound, 1ms minimum */
89 upper = max(DIV_ROUND_CLOSEST(delay_ms, 5), 1U);
90 usleep_range(delay_ms * USEC_PER_MSEC,
91 (delay_ms + upper) * USEC_PER_MSEC);
95 bool pci_reset_supported(struct pci_dev *dev)
97 return dev->reset_methods[0] != 0;
100 #ifdef CONFIG_PCI_DOMAINS
101 int pci_domains_supported = 1;
104 #define DEFAULT_CARDBUS_IO_SIZE (256)
105 #define DEFAULT_CARDBUS_MEM_SIZE (64*1024*1024)
106 /* pci=cbmemsize=nnM,cbiosize=nn can override this */
107 unsigned long pci_cardbus_io_size = DEFAULT_CARDBUS_IO_SIZE;
108 unsigned long pci_cardbus_mem_size = DEFAULT_CARDBUS_MEM_SIZE;
110 #define DEFAULT_HOTPLUG_IO_SIZE (256)
111 #define DEFAULT_HOTPLUG_MMIO_SIZE (2*1024*1024)
112 #define DEFAULT_HOTPLUG_MMIO_PREF_SIZE (2*1024*1024)
113 /* hpiosize=nn can override this */
114 unsigned long pci_hotplug_io_size = DEFAULT_HOTPLUG_IO_SIZE;
116 * pci=hpmmiosize=nnM overrides non-prefetchable MMIO size,
117 * pci=hpmmioprefsize=nnM overrides prefetchable MMIO size;
118 * pci=hpmemsize=nnM overrides both
120 unsigned long pci_hotplug_mmio_size = DEFAULT_HOTPLUG_MMIO_SIZE;
121 unsigned long pci_hotplug_mmio_pref_size = DEFAULT_HOTPLUG_MMIO_PREF_SIZE;
123 #define DEFAULT_HOTPLUG_BUS_SIZE 1
124 unsigned long pci_hotplug_bus_size = DEFAULT_HOTPLUG_BUS_SIZE;
127 /* PCIe MPS/MRRS strategy; can be overridden by kernel command-line param */
128 #ifdef CONFIG_PCIE_BUS_TUNE_OFF
129 enum pcie_bus_config_types pcie_bus_config = PCIE_BUS_TUNE_OFF;
130 #elif defined CONFIG_PCIE_BUS_SAFE
131 enum pcie_bus_config_types pcie_bus_config = PCIE_BUS_SAFE;
132 #elif defined CONFIG_PCIE_BUS_PERFORMANCE
133 enum pcie_bus_config_types pcie_bus_config = PCIE_BUS_PERFORMANCE;
134 #elif defined CONFIG_PCIE_BUS_PEER2PEER
135 enum pcie_bus_config_types pcie_bus_config = PCIE_BUS_PEER2PEER;
137 enum pcie_bus_config_types pcie_bus_config = PCIE_BUS_DEFAULT;
141 * The default CLS is used if arch didn't set CLS explicitly and not
142 * all pci devices agree on the same value. Arch can override either
143 * the dfl or actual value as it sees fit. Don't forget this is
144 * measured in 32-bit words, not bytes.
146 u8 pci_dfl_cache_line_size = L1_CACHE_BYTES >> 2;
147 u8 pci_cache_line_size;
150 * If we set up a device for bus mastering, we need to check the latency
151 * timer as certain BIOSes forget to set it properly.
153 unsigned int pcibios_max_latency = 255;
155 /* If set, the PCIe ARI capability will not be used. */
156 static bool pcie_ari_disabled;
158 /* If set, the PCIe ATS capability will not be used. */
159 static bool pcie_ats_disabled;
161 /* If set, the PCI config space of each device is printed during boot. */
164 bool pci_ats_disabled(void)
166 return pcie_ats_disabled;
168 EXPORT_SYMBOL_GPL(pci_ats_disabled);
170 /* Disable bridge_d3 for all PCIe ports */
171 static bool pci_bridge_d3_disable;
172 /* Force bridge_d3 for all PCIe ports */
173 static bool pci_bridge_d3_force;
175 static int __init pcie_port_pm_setup(char *str)
177 if (!strcmp(str, "off"))
178 pci_bridge_d3_disable = true;
179 else if (!strcmp(str, "force"))
180 pci_bridge_d3_force = true;
183 __setup("pcie_port_pm=", pcie_port_pm_setup);
186 * pci_bus_max_busnr - returns maximum PCI bus number of given bus' children
187 * @bus: pointer to PCI bus structure to search
189 * Given a PCI bus, returns the highest PCI bus number present in the set
190 * including the given PCI bus and its list of child PCI buses.
192 unsigned char pci_bus_max_busnr(struct pci_bus *bus)
195 unsigned char max, n;
197 max = bus->busn_res.end;
198 list_for_each_entry(tmp, &bus->children, node) {
199 n = pci_bus_max_busnr(tmp);
205 EXPORT_SYMBOL_GPL(pci_bus_max_busnr);
208 * pci_status_get_and_clear_errors - return and clear error bits in PCI_STATUS
209 * @pdev: the PCI device
211 * Returns error bits set in PCI_STATUS and clears them.
213 int pci_status_get_and_clear_errors(struct pci_dev *pdev)
218 ret = pci_read_config_word(pdev, PCI_STATUS, &status);
219 if (ret != PCIBIOS_SUCCESSFUL)
222 status &= PCI_STATUS_ERROR_BITS;
224 pci_write_config_word(pdev, PCI_STATUS, status);
228 EXPORT_SYMBOL_GPL(pci_status_get_and_clear_errors);
230 #ifdef CONFIG_HAS_IOMEM
231 static void __iomem *__pci_ioremap_resource(struct pci_dev *pdev, int bar,
234 struct resource *res = &pdev->resource[bar];
235 resource_size_t start = res->start;
236 resource_size_t size = resource_size(res);
239 * Make sure the BAR is actually a memory resource, not an IO resource
241 if (res->flags & IORESOURCE_UNSET || !(res->flags & IORESOURCE_MEM)) {
242 pci_err(pdev, "can't ioremap BAR %d: %pR\n", bar, res);
247 return ioremap_wc(start, size);
249 return ioremap(start, size);
252 void __iomem *pci_ioremap_bar(struct pci_dev *pdev, int bar)
254 return __pci_ioremap_resource(pdev, bar, false);
256 EXPORT_SYMBOL_GPL(pci_ioremap_bar);
258 void __iomem *pci_ioremap_wc_bar(struct pci_dev *pdev, int bar)
260 return __pci_ioremap_resource(pdev, bar, true);
262 EXPORT_SYMBOL_GPL(pci_ioremap_wc_bar);
266 * pci_dev_str_match_path - test if a path string matches a device
267 * @dev: the PCI device to test
268 * @path: string to match the device against
269 * @endptr: pointer to the string after the match
271 * Test if a string (typically from a kernel parameter) formatted as a
272 * path of device/function addresses matches a PCI device. The string must
275 * [<domain>:]<bus>:<device>.<func>[/<device>.<func>]*
277 * A path for a device can be obtained using 'lspci -t'. Using a path
278 * is more robust against bus renumbering than using only a single bus,
279 * device and function address.
281 * Returns 1 if the string matches the device, 0 if it does not and
282 * a negative error code if it fails to parse the string.
284 static int pci_dev_str_match_path(struct pci_dev *dev, const char *path,
288 unsigned int seg, bus, slot, func;
292 *endptr = strchrnul(path, ';');
294 wpath = kmemdup_nul(path, *endptr - path, GFP_ATOMIC);
299 p = strrchr(wpath, '/');
302 ret = sscanf(p, "/%x.%x%c", &slot, &func, &end);
308 if (dev->devfn != PCI_DEVFN(slot, func)) {
314 * Note: we don't need to get a reference to the upstream
315 * bridge because we hold a reference to the top level
316 * device which should hold a reference to the bridge,
319 dev = pci_upstream_bridge(dev);
328 ret = sscanf(wpath, "%x:%x:%x.%x%c", &seg, &bus, &slot,
332 ret = sscanf(wpath, "%x:%x.%x%c", &bus, &slot, &func, &end);
339 ret = (seg == pci_domain_nr(dev->bus) &&
340 bus == dev->bus->number &&
341 dev->devfn == PCI_DEVFN(slot, func));
349 * pci_dev_str_match - test if a string matches a device
350 * @dev: the PCI device to test
351 * @p: string to match the device against
352 * @endptr: pointer to the string after the match
354 * Test if a string (typically from a kernel parameter) matches a specified
355 * PCI device. The string may be of one of the following formats:
357 * [<domain>:]<bus>:<device>.<func>[/<device>.<func>]*
358 * pci:<vendor>:<device>[:<subvendor>:<subdevice>]
360 * The first format specifies a PCI bus/device/function address which
361 * may change if new hardware is inserted, if motherboard firmware changes,
362 * or due to changes caused in kernel parameters. If the domain is
363 * left unspecified, it is taken to be 0. In order to be robust against
364 * bus renumbering issues, a path of PCI device/function numbers may be used
365 * to address the specific device. The path for a device can be determined
366 * through the use of 'lspci -t'.
368 * The second format matches devices using IDs in the configuration
369 * space which may match multiple devices in the system. A value of 0
370 * for any field will match all devices. (Note: this differs from
371 * in-kernel code that uses PCI_ANY_ID which is ~0; this is for
372 * legacy reasons and convenience so users don't have to specify
373 * FFFFFFFFs on the command line.)
375 * Returns 1 if the string matches the device, 0 if it does not and
376 * a negative error code if the string cannot be parsed.
378 static int pci_dev_str_match(struct pci_dev *dev, const char *p,
383 unsigned short vendor, device, subsystem_vendor, subsystem_device;
385 if (strncmp(p, "pci:", 4) == 0) {
386 /* PCI vendor/device (subvendor/subdevice) IDs are specified */
388 ret = sscanf(p, "%hx:%hx:%hx:%hx%n", &vendor, &device,
389 &subsystem_vendor, &subsystem_device, &count);
391 ret = sscanf(p, "%hx:%hx%n", &vendor, &device, &count);
395 subsystem_vendor = 0;
396 subsystem_device = 0;
401 if ((!vendor || vendor == dev->vendor) &&
402 (!device || device == dev->device) &&
403 (!subsystem_vendor ||
404 subsystem_vendor == dev->subsystem_vendor) &&
405 (!subsystem_device ||
406 subsystem_device == dev->subsystem_device))
410 * PCI Bus, Device, Function IDs are specified
411 * (optionally, may include a path of devfns following it)
413 ret = pci_dev_str_match_path(dev, p, &p);
428 static u8 __pci_find_next_cap_ttl(struct pci_bus *bus, unsigned int devfn,
429 u8 pos, int cap, int *ttl)
434 pci_bus_read_config_byte(bus, devfn, pos, &pos);
440 pci_bus_read_config_word(bus, devfn, pos, &ent);
452 static u8 __pci_find_next_cap(struct pci_bus *bus, unsigned int devfn,
455 int ttl = PCI_FIND_CAP_TTL;
457 return __pci_find_next_cap_ttl(bus, devfn, pos, cap, &ttl);
460 u8 pci_find_next_capability(struct pci_dev *dev, u8 pos, int cap)
462 return __pci_find_next_cap(dev->bus, dev->devfn,
463 pos + PCI_CAP_LIST_NEXT, cap);
465 EXPORT_SYMBOL_GPL(pci_find_next_capability);
467 static u8 __pci_bus_find_cap_start(struct pci_bus *bus,
468 unsigned int devfn, u8 hdr_type)
472 pci_bus_read_config_word(bus, devfn, PCI_STATUS, &status);
473 if (!(status & PCI_STATUS_CAP_LIST))
477 case PCI_HEADER_TYPE_NORMAL:
478 case PCI_HEADER_TYPE_BRIDGE:
479 return PCI_CAPABILITY_LIST;
480 case PCI_HEADER_TYPE_CARDBUS:
481 return PCI_CB_CAPABILITY_LIST;
488 * pci_find_capability - query for devices' capabilities
489 * @dev: PCI device to query
490 * @cap: capability code
492 * Tell if a device supports a given PCI capability.
493 * Returns the address of the requested capability structure within the
494 * device's PCI configuration space or 0 in case the device does not
495 * support it. Possible values for @cap include:
497 * %PCI_CAP_ID_PM Power Management
498 * %PCI_CAP_ID_AGP Accelerated Graphics Port
499 * %PCI_CAP_ID_VPD Vital Product Data
500 * %PCI_CAP_ID_SLOTID Slot Identification
501 * %PCI_CAP_ID_MSI Message Signalled Interrupts
502 * %PCI_CAP_ID_CHSWP CompactPCI HotSwap
503 * %PCI_CAP_ID_PCIX PCI-X
504 * %PCI_CAP_ID_EXP PCI Express
506 u8 pci_find_capability(struct pci_dev *dev, int cap)
510 pos = __pci_bus_find_cap_start(dev->bus, dev->devfn, dev->hdr_type);
512 pos = __pci_find_next_cap(dev->bus, dev->devfn, pos, cap);
516 EXPORT_SYMBOL(pci_find_capability);
519 * pci_bus_find_capability - query for devices' capabilities
520 * @bus: the PCI bus to query
521 * @devfn: PCI device to query
522 * @cap: capability code
524 * Like pci_find_capability() but works for PCI devices that do not have a
525 * pci_dev structure set up yet.
527 * Returns the address of the requested capability structure within the
528 * device's PCI configuration space or 0 in case the device does not
531 u8 pci_bus_find_capability(struct pci_bus *bus, unsigned int devfn, int cap)
535 pci_bus_read_config_byte(bus, devfn, PCI_HEADER_TYPE, &hdr_type);
537 pos = __pci_bus_find_cap_start(bus, devfn, hdr_type & PCI_HEADER_TYPE_MASK);
539 pos = __pci_find_next_cap(bus, devfn, pos, cap);
543 EXPORT_SYMBOL(pci_bus_find_capability);
546 * pci_find_next_ext_capability - Find an extended capability
547 * @dev: PCI device to query
548 * @start: address at which to start looking (0 to start at beginning of list)
549 * @cap: capability code
551 * Returns the address of the next matching extended capability structure
552 * within the device's PCI configuration space or 0 if the device does
553 * not support it. Some capabilities can occur several times, e.g., the
554 * vendor-specific capability, and this provides a way to find them all.
556 u16 pci_find_next_ext_capability(struct pci_dev *dev, u16 start, int cap)
560 u16 pos = PCI_CFG_SPACE_SIZE;
562 /* minimum 8 bytes per capability */
563 ttl = (PCI_CFG_SPACE_EXP_SIZE - PCI_CFG_SPACE_SIZE) / 8;
565 if (dev->cfg_size <= PCI_CFG_SPACE_SIZE)
571 if (pci_read_config_dword(dev, pos, &header) != PCIBIOS_SUCCESSFUL)
575 * If we have no capabilities, this is indicated by cap ID,
576 * cap version and next pointer all being 0.
582 if (PCI_EXT_CAP_ID(header) == cap && pos != start)
585 pos = PCI_EXT_CAP_NEXT(header);
586 if (pos < PCI_CFG_SPACE_SIZE)
589 if (pci_read_config_dword(dev, pos, &header) != PCIBIOS_SUCCESSFUL)
595 EXPORT_SYMBOL_GPL(pci_find_next_ext_capability);
598 * pci_find_ext_capability - Find an extended capability
599 * @dev: PCI device to query
600 * @cap: capability code
602 * Returns the address of the requested extended capability structure
603 * within the device's PCI configuration space or 0 if the device does
604 * not support it. Possible values for @cap include:
606 * %PCI_EXT_CAP_ID_ERR Advanced Error Reporting
607 * %PCI_EXT_CAP_ID_VC Virtual Channel
608 * %PCI_EXT_CAP_ID_DSN Device Serial Number
609 * %PCI_EXT_CAP_ID_PWR Power Budgeting
611 u16 pci_find_ext_capability(struct pci_dev *dev, int cap)
613 return pci_find_next_ext_capability(dev, 0, cap);
615 EXPORT_SYMBOL_GPL(pci_find_ext_capability);
618 * pci_get_dsn - Read and return the 8-byte Device Serial Number
619 * @dev: PCI device to query
621 * Looks up the PCI_EXT_CAP_ID_DSN and reads the 8 bytes of the Device Serial
624 * Returns the DSN, or zero if the capability does not exist.
626 u64 pci_get_dsn(struct pci_dev *dev)
632 pos = pci_find_ext_capability(dev, PCI_EXT_CAP_ID_DSN);
637 * The Device Serial Number is two dwords offset 4 bytes from the
638 * capability position. The specification says that the first dword is
639 * the lower half, and the second dword is the upper half.
642 pci_read_config_dword(dev, pos, &dword);
644 pci_read_config_dword(dev, pos + 4, &dword);
645 dsn |= ((u64)dword) << 32;
649 EXPORT_SYMBOL_GPL(pci_get_dsn);
651 static u8 __pci_find_next_ht_cap(struct pci_dev *dev, u8 pos, int ht_cap)
653 int rc, ttl = PCI_FIND_CAP_TTL;
656 if (ht_cap == HT_CAPTYPE_SLAVE || ht_cap == HT_CAPTYPE_HOST)
657 mask = HT_3BIT_CAP_MASK;
659 mask = HT_5BIT_CAP_MASK;
661 pos = __pci_find_next_cap_ttl(dev->bus, dev->devfn, pos,
662 PCI_CAP_ID_HT, &ttl);
664 rc = pci_read_config_byte(dev, pos + 3, &cap);
665 if (rc != PCIBIOS_SUCCESSFUL)
668 if ((cap & mask) == ht_cap)
671 pos = __pci_find_next_cap_ttl(dev->bus, dev->devfn,
672 pos + PCI_CAP_LIST_NEXT,
673 PCI_CAP_ID_HT, &ttl);
680 * pci_find_next_ht_capability - query a device's HyperTransport capabilities
681 * @dev: PCI device to query
682 * @pos: Position from which to continue searching
683 * @ht_cap: HyperTransport capability code
685 * To be used in conjunction with pci_find_ht_capability() to search for
686 * all capabilities matching @ht_cap. @pos should always be a value returned
687 * from pci_find_ht_capability().
689 * NB. To be 100% safe against broken PCI devices, the caller should take
690 * steps to avoid an infinite loop.
692 u8 pci_find_next_ht_capability(struct pci_dev *dev, u8 pos, int ht_cap)
694 return __pci_find_next_ht_cap(dev, pos + PCI_CAP_LIST_NEXT, ht_cap);
696 EXPORT_SYMBOL_GPL(pci_find_next_ht_capability);
699 * pci_find_ht_capability - query a device's HyperTransport capabilities
700 * @dev: PCI device to query
701 * @ht_cap: HyperTransport capability code
703 * Tell if a device supports a given HyperTransport capability.
704 * Returns an address within the device's PCI configuration space
705 * or 0 in case the device does not support the request capability.
706 * The address points to the PCI capability, of type PCI_CAP_ID_HT,
707 * which has a HyperTransport capability matching @ht_cap.
709 u8 pci_find_ht_capability(struct pci_dev *dev, int ht_cap)
713 pos = __pci_bus_find_cap_start(dev->bus, dev->devfn, dev->hdr_type);
715 pos = __pci_find_next_ht_cap(dev, pos, ht_cap);
719 EXPORT_SYMBOL_GPL(pci_find_ht_capability);
722 * pci_find_vsec_capability - Find a vendor-specific extended capability
723 * @dev: PCI device to query
724 * @vendor: Vendor ID for which capability is defined
725 * @cap: Vendor-specific capability ID
727 * If @dev has Vendor ID @vendor, search for a VSEC capability with
728 * VSEC ID @cap. If found, return the capability offset in
729 * config space; otherwise return 0.
731 u16 pci_find_vsec_capability(struct pci_dev *dev, u16 vendor, int cap)
737 if (vendor != dev->vendor)
740 while ((vsec = pci_find_next_ext_capability(dev, vsec,
741 PCI_EXT_CAP_ID_VNDR))) {
742 ret = pci_read_config_dword(dev, vsec + PCI_VNDR_HEADER, &header);
743 if (ret != PCIBIOS_SUCCESSFUL)
746 if (PCI_VNDR_HEADER_ID(header) == cap)
752 EXPORT_SYMBOL_GPL(pci_find_vsec_capability);
755 * pci_find_dvsec_capability - Find DVSEC for vendor
756 * @dev: PCI device to query
757 * @vendor: Vendor ID to match for the DVSEC
758 * @dvsec: Designated Vendor-specific capability ID
760 * If DVSEC has Vendor ID @vendor and DVSEC ID @dvsec return the capability
761 * offset in config space; otherwise return 0.
763 u16 pci_find_dvsec_capability(struct pci_dev *dev, u16 vendor, u16 dvsec)
767 pos = pci_find_ext_capability(dev, PCI_EXT_CAP_ID_DVSEC);
774 pci_read_config_word(dev, pos + PCI_DVSEC_HEADER1, &v);
775 pci_read_config_word(dev, pos + PCI_DVSEC_HEADER2, &id);
776 if (vendor == v && dvsec == id)
779 pos = pci_find_next_ext_capability(dev, pos, PCI_EXT_CAP_ID_DVSEC);
784 EXPORT_SYMBOL_GPL(pci_find_dvsec_capability);
787 * pci_find_parent_resource - return resource region of parent bus of given
789 * @dev: PCI device structure contains resources to be searched
790 * @res: child resource record for which parent is sought
792 * For given resource region of given device, return the resource region of
793 * parent bus the given region is contained in.
795 struct resource *pci_find_parent_resource(const struct pci_dev *dev,
796 struct resource *res)
798 const struct pci_bus *bus = dev->bus;
801 pci_bus_for_each_resource(bus, r) {
804 if (resource_contains(r, res)) {
807 * If the window is prefetchable but the BAR is
808 * not, the allocator made a mistake.
810 if (r->flags & IORESOURCE_PREFETCH &&
811 !(res->flags & IORESOURCE_PREFETCH))
815 * If we're below a transparent bridge, there may
816 * be both a positively-decoded aperture and a
817 * subtractively-decoded region that contain the BAR.
818 * We want the positively-decoded one, so this depends
819 * on pci_bus_for_each_resource() giving us those
827 EXPORT_SYMBOL(pci_find_parent_resource);
830 * pci_find_resource - Return matching PCI device resource
831 * @dev: PCI device to query
832 * @res: Resource to look for
834 * Goes over standard PCI resources (BARs) and checks if the given resource
835 * is partially or fully contained in any of them. In that case the
836 * matching resource is returned, %NULL otherwise.
838 struct resource *pci_find_resource(struct pci_dev *dev, struct resource *res)
842 for (i = 0; i < PCI_STD_NUM_BARS; i++) {
843 struct resource *r = &dev->resource[i];
845 if (r->start && resource_contains(r, res))
851 EXPORT_SYMBOL(pci_find_resource);
854 * pci_wait_for_pending - wait for @mask bit(s) to clear in status word @pos
855 * @dev: the PCI device to operate on
856 * @pos: config space offset of status word
857 * @mask: mask of bit(s) to care about in status word
859 * Return 1 when mask bit(s) in status word clear, 0 otherwise.
861 int pci_wait_for_pending(struct pci_dev *dev, int pos, u16 mask)
865 /* Wait for Transaction Pending bit clean */
866 for (i = 0; i < 4; i++) {
869 msleep((1 << (i - 1)) * 100);
871 pci_read_config_word(dev, pos, &status);
872 if (!(status & mask))
879 static int pci_acs_enable;
882 * pci_request_acs - ask for ACS to be enabled if supported
884 void pci_request_acs(void)
889 static const char *disable_acs_redir_param;
892 * pci_disable_acs_redir - disable ACS redirect capabilities
893 * @dev: the PCI device
895 * For only devices specified in the disable_acs_redir parameter.
897 static void pci_disable_acs_redir(struct pci_dev *dev)
904 if (!disable_acs_redir_param)
907 p = disable_acs_redir_param;
909 ret = pci_dev_str_match(dev, p, &p);
911 pr_info_once("PCI: Can't parse disable_acs_redir parameter: %s\n",
912 disable_acs_redir_param);
915 } else if (ret == 1) {
920 if (*p != ';' && *p != ',') {
921 /* End of param or invalid format */
930 if (!pci_dev_specific_disable_acs_redir(dev))
935 pci_warn(dev, "cannot disable ACS redirect for this hardware as it does not have ACS capabilities\n");
939 pci_read_config_word(dev, pos + PCI_ACS_CTRL, &ctrl);
941 /* P2P Request & Completion Redirect */
942 ctrl &= ~(PCI_ACS_RR | PCI_ACS_CR | PCI_ACS_EC);
944 pci_write_config_word(dev, pos + PCI_ACS_CTRL, ctrl);
946 pci_info(dev, "disabled ACS redirect\n");
950 * pci_std_enable_acs - enable ACS on devices using standard ACS capabilities
951 * @dev: the PCI device
953 static void pci_std_enable_acs(struct pci_dev *dev)
963 pci_read_config_word(dev, pos + PCI_ACS_CAP, &cap);
964 pci_read_config_word(dev, pos + PCI_ACS_CTRL, &ctrl);
966 /* Source Validation */
967 ctrl |= (cap & PCI_ACS_SV);
969 /* P2P Request Redirect */
970 ctrl |= (cap & PCI_ACS_RR);
972 /* P2P Completion Redirect */
973 ctrl |= (cap & PCI_ACS_CR);
975 /* Upstream Forwarding */
976 ctrl |= (cap & PCI_ACS_UF);
978 /* Enable Translation Blocking for external devices and noats */
979 if (pci_ats_disabled() || dev->external_facing || dev->untrusted)
980 ctrl |= (cap & PCI_ACS_TB);
982 pci_write_config_word(dev, pos + PCI_ACS_CTRL, ctrl);
986 * pci_enable_acs - enable ACS if hardware support it
987 * @dev: the PCI device
989 static void pci_enable_acs(struct pci_dev *dev)
992 goto disable_acs_redir;
994 if (!pci_dev_specific_enable_acs(dev))
995 goto disable_acs_redir;
997 pci_std_enable_acs(dev);
1001 * Note: pci_disable_acs_redir() must be called even if ACS was not
1002 * enabled by the kernel because it may have been enabled by
1003 * platform firmware. So if we are told to disable it, we should
1004 * always disable it after setting the kernel's default
1007 pci_disable_acs_redir(dev);
1011 * pci_restore_bars - restore a device's BAR values (e.g. after wake-up)
1012 * @dev: PCI device to have its BARs restored
1014 * Restore the BAR values for a given device, so as to make it
1015 * accessible by its driver.
1017 static void pci_restore_bars(struct pci_dev *dev)
1021 for (i = 0; i < PCI_BRIDGE_RESOURCES; i++)
1022 pci_update_resource(dev, i);
1025 static inline bool platform_pci_power_manageable(struct pci_dev *dev)
1027 if (pci_use_mid_pm())
1030 return acpi_pci_power_manageable(dev);
1033 static inline int platform_pci_set_power_state(struct pci_dev *dev,
1036 if (pci_use_mid_pm())
1037 return mid_pci_set_power_state(dev, t);
1039 return acpi_pci_set_power_state(dev, t);
1042 static inline pci_power_t platform_pci_get_power_state(struct pci_dev *dev)
1044 if (pci_use_mid_pm())
1045 return mid_pci_get_power_state(dev);
1047 return acpi_pci_get_power_state(dev);
1050 static inline void platform_pci_refresh_power_state(struct pci_dev *dev)
1052 if (!pci_use_mid_pm())
1053 acpi_pci_refresh_power_state(dev);
1056 static inline pci_power_t platform_pci_choose_state(struct pci_dev *dev)
1058 if (pci_use_mid_pm())
1059 return PCI_POWER_ERROR;
1061 return acpi_pci_choose_state(dev);
1064 static inline int platform_pci_set_wakeup(struct pci_dev *dev, bool enable)
1066 if (pci_use_mid_pm())
1067 return PCI_POWER_ERROR;
1069 return acpi_pci_wakeup(dev, enable);
1072 static inline bool platform_pci_need_resume(struct pci_dev *dev)
1074 if (pci_use_mid_pm())
1077 return acpi_pci_need_resume(dev);
1080 static inline bool platform_pci_bridge_d3(struct pci_dev *dev)
1082 if (pci_use_mid_pm())
1085 return acpi_pci_bridge_d3(dev);
1089 * pci_update_current_state - Read power state of given device and cache it
1090 * @dev: PCI device to handle.
1091 * @state: State to cache in case the device doesn't have the PM capability
1093 * The power state is read from the PMCSR register, which however is
1094 * inaccessible in D3cold. The platform firmware is therefore queried first
1095 * to detect accessibility of the register. In case the platform firmware
1096 * reports an incorrect state or the device isn't power manageable by the
1097 * platform at all, we try to detect D3cold by testing accessibility of the
1098 * vendor ID in config space.
1100 void pci_update_current_state(struct pci_dev *dev, pci_power_t state)
1102 if (platform_pci_get_power_state(dev) == PCI_D3cold) {
1103 dev->current_state = PCI_D3cold;
1104 } else if (dev->pm_cap) {
1107 pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
1108 if (PCI_POSSIBLE_ERROR(pmcsr)) {
1109 dev->current_state = PCI_D3cold;
1112 dev->current_state = pmcsr & PCI_PM_CTRL_STATE_MASK;
1114 dev->current_state = state;
1119 * pci_refresh_power_state - Refresh the given device's power state data
1120 * @dev: Target PCI device.
1122 * Ask the platform to refresh the devices power state information and invoke
1123 * pci_update_current_state() to update its current PCI power state.
1125 void pci_refresh_power_state(struct pci_dev *dev)
1127 platform_pci_refresh_power_state(dev);
1128 pci_update_current_state(dev, dev->current_state);
1132 * pci_platform_power_transition - Use platform to change device power state
1133 * @dev: PCI device to handle.
1134 * @state: State to put the device into.
1136 int pci_platform_power_transition(struct pci_dev *dev, pci_power_t state)
1140 error = platform_pci_set_power_state(dev, state);
1142 pci_update_current_state(dev, state);
1143 else if (!dev->pm_cap) /* Fall back to PCI_D0 */
1144 dev->current_state = PCI_D0;
1148 EXPORT_SYMBOL_GPL(pci_platform_power_transition);
1150 static int pci_resume_one(struct pci_dev *pci_dev, void *ign)
1152 pm_request_resume(&pci_dev->dev);
1157 * pci_resume_bus - Walk given bus and runtime resume devices on it
1158 * @bus: Top bus of the subtree to walk.
1160 void pci_resume_bus(struct pci_bus *bus)
1163 pci_walk_bus(bus, pci_resume_one, NULL);
1166 static int pci_dev_wait(struct pci_dev *dev, char *reset_type, int timeout)
1169 bool retrain = false;
1170 struct pci_dev *bridge;
1172 if (pci_is_pcie(dev)) {
1173 bridge = pci_upstream_bridge(dev);
1179 * After reset, the device should not silently discard config
1180 * requests, but it may still indicate that it needs more time by
1181 * responding to them with CRS completions. The Root Port will
1182 * generally synthesize ~0 (PCI_ERROR_RESPONSE) data to complete
1183 * the read (except when CRS SV is enabled and the read was for the
1184 * Vendor ID; in that case it synthesizes 0x0001 data).
1186 * Wait for the device to return a non-CRS completion. Read the
1187 * Command register instead of Vendor ID so we don't have to
1188 * contend with the CRS SV value.
1193 pci_read_config_dword(dev, PCI_COMMAND, &id);
1194 if (!PCI_POSSIBLE_ERROR(id))
1197 if (delay > timeout) {
1198 pci_warn(dev, "not ready %dms after %s; giving up\n",
1199 delay - 1, reset_type);
1203 if (delay > PCI_RESET_WAIT) {
1206 if (pcie_failed_link_retrain(bridge)) {
1211 pci_info(dev, "not ready %dms after %s; waiting\n",
1212 delay - 1, reset_type);
1219 if (delay > PCI_RESET_WAIT)
1220 pci_info(dev, "ready %dms after %s\n", delay - 1,
1223 pci_dbg(dev, "ready %dms after %s\n", delay - 1,
1230 * pci_power_up - Put the given device into D0
1231 * @dev: PCI device to power up
1233 * On success, return 0 or 1, depending on whether or not it is necessary to
1234 * restore the device's BARs subsequently (1 is returned in that case).
1236 * On failure, return a negative error code. Always return failure if @dev
1237 * lacks a Power Management Capability, even if the platform was able to
1238 * put the device in D0 via non-PCI means.
1240 int pci_power_up(struct pci_dev *dev)
1246 platform_pci_set_power_state(dev, PCI_D0);
1249 state = platform_pci_get_power_state(dev);
1250 if (state == PCI_UNKNOWN)
1251 dev->current_state = PCI_D0;
1253 dev->current_state = state;
1258 pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
1259 if (PCI_POSSIBLE_ERROR(pmcsr)) {
1260 pci_err(dev, "Unable to change power state from %s to D0, device inaccessible\n",
1261 pci_power_name(dev->current_state));
1262 dev->current_state = PCI_D3cold;
1266 state = pmcsr & PCI_PM_CTRL_STATE_MASK;
1268 need_restore = (state == PCI_D3hot || dev->current_state >= PCI_D3hot) &&
1269 !(pmcsr & PCI_PM_CTRL_NO_SOFT_RESET);
1271 if (state == PCI_D0)
1275 * Force the entire word to 0. This doesn't affect PME_Status, disables
1276 * PME_En, and sets PowerState to 0.
1278 pci_write_config_word(dev, dev->pm_cap + PCI_PM_CTRL, 0);
1280 /* Mandatory transition delays; see PCI PM 1.2. */
1281 if (state == PCI_D3hot)
1282 pci_dev_d3_sleep(dev);
1283 else if (state == PCI_D2)
1284 udelay(PCI_PM_D2_DELAY);
1287 dev->current_state = PCI_D0;
1295 * pci_set_full_power_state - Put a PCI device into D0 and update its state
1296 * @dev: PCI device to power up
1298 * Call pci_power_up() to put @dev into D0, read from its PCI_PM_CTRL register
1299 * to confirm the state change, restore its BARs if they might be lost and
1300 * reconfigure ASPM in accordance with the new power state.
1302 * If pci_restore_state() is going to be called right after a power state change
1303 * to D0, it is more efficient to use pci_power_up() directly instead of this
1306 static int pci_set_full_power_state(struct pci_dev *dev)
1311 ret = pci_power_up(dev);
1313 if (dev->current_state == PCI_D0)
1319 pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
1320 dev->current_state = pmcsr & PCI_PM_CTRL_STATE_MASK;
1321 if (dev->current_state != PCI_D0) {
1322 pci_info_ratelimited(dev, "Refused to change power state from %s to D0\n",
1323 pci_power_name(dev->current_state));
1324 } else if (ret > 0) {
1326 * According to section 5.4.1 of the "PCI BUS POWER MANAGEMENT
1327 * INTERFACE SPECIFICATION, REV. 1.2", a device transitioning
1328 * from D3hot to D0 _may_ perform an internal reset, thereby
1329 * going to "D0 Uninitialized" rather than "D0 Initialized".
1330 * For example, at least some versions of the 3c905B and the
1331 * 3c556B exhibit this behaviour.
1333 * At least some laptop BIOSen (e.g. the Thinkpad T21) leave
1334 * devices in a D3hot state at boot. Consequently, we need to
1335 * restore at least the BARs so that the device will be
1336 * accessible to its driver.
1338 pci_restore_bars(dev);
1342 pcie_aspm_pm_state_change(dev->bus->self);
1348 * __pci_dev_set_current_state - Set current state of a PCI device
1349 * @dev: Device to handle
1350 * @data: pointer to state to be set
1352 static int __pci_dev_set_current_state(struct pci_dev *dev, void *data)
1354 pci_power_t state = *(pci_power_t *)data;
1356 dev->current_state = state;
1361 * pci_bus_set_current_state - Walk given bus and set current state of devices
1362 * @bus: Top bus of the subtree to walk.
1363 * @state: state to be set
1365 void pci_bus_set_current_state(struct pci_bus *bus, pci_power_t state)
1368 pci_walk_bus(bus, __pci_dev_set_current_state, &state);
1372 * pci_set_low_power_state - Put a PCI device into a low-power state.
1373 * @dev: PCI device to handle.
1374 * @state: PCI power state (D1, D2, D3hot) to put the device into.
1376 * Use the device's PCI_PM_CTRL register to put it into a low-power state.
1379 * -EINVAL if the requested state is invalid.
1380 * -EIO if device does not support PCI PM or its PM capabilities register has a
1381 * wrong version, or device doesn't support the requested state.
1382 * 0 if device already is in the requested state.
1383 * 0 if device's power state has been successfully changed.
1385 static int pci_set_low_power_state(struct pci_dev *dev, pci_power_t state)
1393 * Validate transition: We can enter D0 from any state, but if
1394 * we're already in a low-power state, we can only go deeper. E.g.,
1395 * we can go from D1 to D3, but we can't go directly from D3 to D1;
1396 * we'd have to go from D3 to D0, then to D1.
1398 if (dev->current_state <= PCI_D3cold && dev->current_state > state) {
1399 pci_dbg(dev, "Invalid power transition (from %s to %s)\n",
1400 pci_power_name(dev->current_state),
1401 pci_power_name(state));
1405 /* Check if this device supports the desired state */
1406 if ((state == PCI_D1 && !dev->d1_support)
1407 || (state == PCI_D2 && !dev->d2_support))
1410 pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
1411 if (PCI_POSSIBLE_ERROR(pmcsr)) {
1412 pci_err(dev, "Unable to change power state from %s to %s, device inaccessible\n",
1413 pci_power_name(dev->current_state),
1414 pci_power_name(state));
1415 dev->current_state = PCI_D3cold;
1419 pmcsr &= ~PCI_PM_CTRL_STATE_MASK;
1422 /* Enter specified state */
1423 pci_write_config_word(dev, dev->pm_cap + PCI_PM_CTRL, pmcsr);
1425 /* Mandatory power management transition delays; see PCI PM 1.2. */
1426 if (state == PCI_D3hot)
1427 pci_dev_d3_sleep(dev);
1428 else if (state == PCI_D2)
1429 udelay(PCI_PM_D2_DELAY);
1431 pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
1432 dev->current_state = pmcsr & PCI_PM_CTRL_STATE_MASK;
1433 if (dev->current_state != state)
1434 pci_info_ratelimited(dev, "Refused to change power state from %s to %s\n",
1435 pci_power_name(dev->current_state),
1436 pci_power_name(state));
1439 pcie_aspm_pm_state_change(dev->bus->self);
1445 * pci_set_power_state - Set the power state of a PCI device
1446 * @dev: PCI device to handle.
1447 * @state: PCI power state (D0, D1, D2, D3hot) to put the device into.
1449 * Transition a device to a new power state, using the platform firmware and/or
1450 * the device's PCI PM registers.
1453 * -EINVAL if the requested state is invalid.
1454 * -EIO if device does not support PCI PM or its PM capabilities register has a
1455 * wrong version, or device doesn't support the requested state.
1456 * 0 if the transition is to D1 or D2 but D1 and D2 are not supported.
1457 * 0 if device already is in the requested state.
1458 * 0 if the transition is to D3 but D3 is not supported.
1459 * 0 if device's power state has been successfully changed.
1461 int pci_set_power_state(struct pci_dev *dev, pci_power_t state)
1465 /* Bound the state we're entering */
1466 if (state > PCI_D3cold)
1468 else if (state < PCI_D0)
1470 else if ((state == PCI_D1 || state == PCI_D2) && pci_no_d1d2(dev))
1473 * If the device or the parent bridge do not support PCI
1474 * PM, ignore the request if we're doing anything other
1475 * than putting it into D0 (which would only happen on
1480 /* Check if we're already there */
1481 if (dev->current_state == state)
1484 if (state == PCI_D0)
1485 return pci_set_full_power_state(dev);
1488 * This device is quirked not to be put into D3, so don't put it in
1491 if (state >= PCI_D3hot && (dev->dev_flags & PCI_DEV_FLAGS_NO_D3))
1494 if (state == PCI_D3cold) {
1496 * To put the device in D3cold, put it into D3hot in the native
1497 * way, then put it into D3cold using platform ops.
1499 error = pci_set_low_power_state(dev, PCI_D3hot);
1501 if (pci_platform_power_transition(dev, PCI_D3cold))
1504 /* Powering off a bridge may power off the whole hierarchy */
1505 if (dev->current_state == PCI_D3cold)
1506 pci_bus_set_current_state(dev->subordinate, PCI_D3cold);
1508 error = pci_set_low_power_state(dev, state);
1510 if (pci_platform_power_transition(dev, state))
1516 EXPORT_SYMBOL(pci_set_power_state);
1518 #define PCI_EXP_SAVE_REGS 7
1520 static struct pci_cap_saved_state *_pci_find_saved_cap(struct pci_dev *pci_dev,
1521 u16 cap, bool extended)
1523 struct pci_cap_saved_state *tmp;
1525 hlist_for_each_entry(tmp, &pci_dev->saved_cap_space, next) {
1526 if (tmp->cap.cap_extended == extended && tmp->cap.cap_nr == cap)
1532 struct pci_cap_saved_state *pci_find_saved_cap(struct pci_dev *dev, char cap)
1534 return _pci_find_saved_cap(dev, cap, false);
1537 struct pci_cap_saved_state *pci_find_saved_ext_cap(struct pci_dev *dev, u16 cap)
1539 return _pci_find_saved_cap(dev, cap, true);
1542 static int pci_save_pcie_state(struct pci_dev *dev)
1545 struct pci_cap_saved_state *save_state;
1548 if (!pci_is_pcie(dev))
1551 save_state = pci_find_saved_cap(dev, PCI_CAP_ID_EXP);
1553 pci_err(dev, "buffer not found in %s\n", __func__);
1557 cap = (u16 *)&save_state->cap.data[0];
1558 pcie_capability_read_word(dev, PCI_EXP_DEVCTL, &cap[i++]);
1559 pcie_capability_read_word(dev, PCI_EXP_LNKCTL, &cap[i++]);
1560 pcie_capability_read_word(dev, PCI_EXP_SLTCTL, &cap[i++]);
1561 pcie_capability_read_word(dev, PCI_EXP_RTCTL, &cap[i++]);
1562 pcie_capability_read_word(dev, PCI_EXP_DEVCTL2, &cap[i++]);
1563 pcie_capability_read_word(dev, PCI_EXP_LNKCTL2, &cap[i++]);
1564 pcie_capability_read_word(dev, PCI_EXP_SLTCTL2, &cap[i++]);
1569 void pci_bridge_reconfigure_ltr(struct pci_dev *dev)
1571 #ifdef CONFIG_PCIEASPM
1572 struct pci_dev *bridge;
1575 bridge = pci_upstream_bridge(dev);
1576 if (bridge && bridge->ltr_path) {
1577 pcie_capability_read_dword(bridge, PCI_EXP_DEVCTL2, &ctl);
1578 if (!(ctl & PCI_EXP_DEVCTL2_LTR_EN)) {
1579 pci_dbg(bridge, "re-enabling LTR\n");
1580 pcie_capability_set_word(bridge, PCI_EXP_DEVCTL2,
1581 PCI_EXP_DEVCTL2_LTR_EN);
1587 static void pci_restore_pcie_state(struct pci_dev *dev)
1590 struct pci_cap_saved_state *save_state;
1593 save_state = pci_find_saved_cap(dev, PCI_CAP_ID_EXP);
1598 * Downstream ports reset the LTR enable bit when link goes down.
1599 * Check and re-configure the bit here before restoring device.
1600 * PCIe r5.0, sec 7.5.3.16.
1602 pci_bridge_reconfigure_ltr(dev);
1604 cap = (u16 *)&save_state->cap.data[0];
1605 pcie_capability_write_word(dev, PCI_EXP_DEVCTL, cap[i++]);
1606 pcie_capability_write_word(dev, PCI_EXP_LNKCTL, cap[i++]);
1607 pcie_capability_write_word(dev, PCI_EXP_SLTCTL, cap[i++]);
1608 pcie_capability_write_word(dev, PCI_EXP_RTCTL, cap[i++]);
1609 pcie_capability_write_word(dev, PCI_EXP_DEVCTL2, cap[i++]);
1610 pcie_capability_write_word(dev, PCI_EXP_LNKCTL2, cap[i++]);
1611 pcie_capability_write_word(dev, PCI_EXP_SLTCTL2, cap[i++]);
1614 static int pci_save_pcix_state(struct pci_dev *dev)
1617 struct pci_cap_saved_state *save_state;
1619 pos = pci_find_capability(dev, PCI_CAP_ID_PCIX);
1623 save_state = pci_find_saved_cap(dev, PCI_CAP_ID_PCIX);
1625 pci_err(dev, "buffer not found in %s\n", __func__);
1629 pci_read_config_word(dev, pos + PCI_X_CMD,
1630 (u16 *)save_state->cap.data);
1635 static void pci_restore_pcix_state(struct pci_dev *dev)
1638 struct pci_cap_saved_state *save_state;
1641 save_state = pci_find_saved_cap(dev, PCI_CAP_ID_PCIX);
1642 pos = pci_find_capability(dev, PCI_CAP_ID_PCIX);
1643 if (!save_state || !pos)
1645 cap = (u16 *)&save_state->cap.data[0];
1647 pci_write_config_word(dev, pos + PCI_X_CMD, cap[i++]);
1650 static void pci_save_ltr_state(struct pci_dev *dev)
1653 struct pci_cap_saved_state *save_state;
1656 if (!pci_is_pcie(dev))
1659 ltr = pci_find_ext_capability(dev, PCI_EXT_CAP_ID_LTR);
1663 save_state = pci_find_saved_ext_cap(dev, PCI_EXT_CAP_ID_LTR);
1665 pci_err(dev, "no suspend buffer for LTR; ASPM issues possible after resume\n");
1669 /* Some broken devices only support dword access to LTR */
1670 cap = &save_state->cap.data[0];
1671 pci_read_config_dword(dev, ltr + PCI_LTR_MAX_SNOOP_LAT, cap);
1674 static void pci_restore_ltr_state(struct pci_dev *dev)
1676 struct pci_cap_saved_state *save_state;
1680 save_state = pci_find_saved_ext_cap(dev, PCI_EXT_CAP_ID_LTR);
1681 ltr = pci_find_ext_capability(dev, PCI_EXT_CAP_ID_LTR);
1682 if (!save_state || !ltr)
1685 /* Some broken devices only support dword access to LTR */
1686 cap = &save_state->cap.data[0];
1687 pci_write_config_dword(dev, ltr + PCI_LTR_MAX_SNOOP_LAT, *cap);
1691 * pci_save_state - save the PCI configuration space of a device before
1693 * @dev: PCI device that we're dealing with
1695 int pci_save_state(struct pci_dev *dev)
1698 /* XXX: 100% dword access ok here? */
1699 for (i = 0; i < 16; i++) {
1700 pci_read_config_dword(dev, i * 4, &dev->saved_config_space[i]);
1701 pci_dbg(dev, "save config %#04x: %#010x\n",
1702 i * 4, dev->saved_config_space[i]);
1704 dev->state_saved = true;
1706 i = pci_save_pcie_state(dev);
1710 i = pci_save_pcix_state(dev);
1714 pci_save_ltr_state(dev);
1715 pci_save_dpc_state(dev);
1716 pci_save_aer_state(dev);
1717 pci_save_ptm_state(dev);
1718 return pci_save_vc_state(dev);
1720 EXPORT_SYMBOL(pci_save_state);
1722 static void pci_restore_config_dword(struct pci_dev *pdev, int offset,
1723 u32 saved_val, int retry, bool force)
1727 pci_read_config_dword(pdev, offset, &val);
1728 if (!force && val == saved_val)
1732 pci_dbg(pdev, "restore config %#04x: %#010x -> %#010x\n",
1733 offset, val, saved_val);
1734 pci_write_config_dword(pdev, offset, saved_val);
1738 pci_read_config_dword(pdev, offset, &val);
1739 if (val == saved_val)
1746 static void pci_restore_config_space_range(struct pci_dev *pdev,
1747 int start, int end, int retry,
1752 for (index = end; index >= start; index--)
1753 pci_restore_config_dword(pdev, 4 * index,
1754 pdev->saved_config_space[index],
1758 static void pci_restore_config_space(struct pci_dev *pdev)
1760 if (pdev->hdr_type == PCI_HEADER_TYPE_NORMAL) {
1761 pci_restore_config_space_range(pdev, 10, 15, 0, false);
1762 /* Restore BARs before the command register. */
1763 pci_restore_config_space_range(pdev, 4, 9, 10, false);
1764 pci_restore_config_space_range(pdev, 0, 3, 0, false);
1765 } else if (pdev->hdr_type == PCI_HEADER_TYPE_BRIDGE) {
1766 pci_restore_config_space_range(pdev, 12, 15, 0, false);
1769 * Force rewriting of prefetch registers to avoid S3 resume
1770 * issues on Intel PCI bridges that occur when these
1771 * registers are not explicitly written.
1773 pci_restore_config_space_range(pdev, 9, 11, 0, true);
1774 pci_restore_config_space_range(pdev, 0, 8, 0, false);
1776 pci_restore_config_space_range(pdev, 0, 15, 0, false);
1780 static void pci_restore_rebar_state(struct pci_dev *pdev)
1782 unsigned int pos, nbars, i;
1785 pos = pci_find_ext_capability(pdev, PCI_EXT_CAP_ID_REBAR);
1789 pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
1790 nbars = FIELD_GET(PCI_REBAR_CTRL_NBAR_MASK, ctrl);
1792 for (i = 0; i < nbars; i++, pos += 8) {
1793 struct resource *res;
1796 pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
1797 bar_idx = ctrl & PCI_REBAR_CTRL_BAR_IDX;
1798 res = pdev->resource + bar_idx;
1799 size = pci_rebar_bytes_to_size(resource_size(res));
1800 ctrl &= ~PCI_REBAR_CTRL_BAR_SIZE;
1801 ctrl |= FIELD_PREP(PCI_REBAR_CTRL_BAR_SIZE, size);
1802 pci_write_config_dword(pdev, pos + PCI_REBAR_CTRL, ctrl);
1807 * pci_restore_state - Restore the saved state of a PCI device
1808 * @dev: PCI device that we're dealing with
1810 void pci_restore_state(struct pci_dev *dev)
1812 if (!dev->state_saved)
1816 * Restore max latencies (in the LTR capability) before enabling
1817 * LTR itself (in the PCIe capability).
1819 pci_restore_ltr_state(dev);
1821 pci_restore_pcie_state(dev);
1822 pci_restore_pasid_state(dev);
1823 pci_restore_pri_state(dev);
1824 pci_restore_ats_state(dev);
1825 pci_restore_vc_state(dev);
1826 pci_restore_rebar_state(dev);
1827 pci_restore_dpc_state(dev);
1828 pci_restore_ptm_state(dev);
1830 pci_aer_clear_status(dev);
1831 pci_restore_aer_state(dev);
1833 pci_restore_config_space(dev);
1835 pci_restore_pcix_state(dev);
1836 pci_restore_msi_state(dev);
1838 /* Restore ACS and IOV configuration state */
1839 pci_enable_acs(dev);
1840 pci_restore_iov_state(dev);
1842 dev->state_saved = false;
1844 EXPORT_SYMBOL(pci_restore_state);
1846 struct pci_saved_state {
1847 u32 config_space[16];
1848 struct pci_cap_saved_data cap[];
1852 * pci_store_saved_state - Allocate and return an opaque struct containing
1853 * the device saved state.
1854 * @dev: PCI device that we're dealing with
1856 * Return NULL if no state or error.
1858 struct pci_saved_state *pci_store_saved_state(struct pci_dev *dev)
1860 struct pci_saved_state *state;
1861 struct pci_cap_saved_state *tmp;
1862 struct pci_cap_saved_data *cap;
1865 if (!dev->state_saved)
1868 size = sizeof(*state) + sizeof(struct pci_cap_saved_data);
1870 hlist_for_each_entry(tmp, &dev->saved_cap_space, next)
1871 size += sizeof(struct pci_cap_saved_data) + tmp->cap.size;
1873 state = kzalloc(size, GFP_KERNEL);
1877 memcpy(state->config_space, dev->saved_config_space,
1878 sizeof(state->config_space));
1881 hlist_for_each_entry(tmp, &dev->saved_cap_space, next) {
1882 size_t len = sizeof(struct pci_cap_saved_data) + tmp->cap.size;
1883 memcpy(cap, &tmp->cap, len);
1884 cap = (struct pci_cap_saved_data *)((u8 *)cap + len);
1886 /* Empty cap_save terminates list */
1890 EXPORT_SYMBOL_GPL(pci_store_saved_state);
1893 * pci_load_saved_state - Reload the provided save state into struct pci_dev.
1894 * @dev: PCI device that we're dealing with
1895 * @state: Saved state returned from pci_store_saved_state()
1897 int pci_load_saved_state(struct pci_dev *dev,
1898 struct pci_saved_state *state)
1900 struct pci_cap_saved_data *cap;
1902 dev->state_saved = false;
1907 memcpy(dev->saved_config_space, state->config_space,
1908 sizeof(state->config_space));
1912 struct pci_cap_saved_state *tmp;
1914 tmp = _pci_find_saved_cap(dev, cap->cap_nr, cap->cap_extended);
1915 if (!tmp || tmp->cap.size != cap->size)
1918 memcpy(tmp->cap.data, cap->data, tmp->cap.size);
1919 cap = (struct pci_cap_saved_data *)((u8 *)cap +
1920 sizeof(struct pci_cap_saved_data) + cap->size);
1923 dev->state_saved = true;
1926 EXPORT_SYMBOL_GPL(pci_load_saved_state);
1929 * pci_load_and_free_saved_state - Reload the save state pointed to by state,
1930 * and free the memory allocated for it.
1931 * @dev: PCI device that we're dealing with
1932 * @state: Pointer to saved state returned from pci_store_saved_state()
1934 int pci_load_and_free_saved_state(struct pci_dev *dev,
1935 struct pci_saved_state **state)
1937 int ret = pci_load_saved_state(dev, *state);
1942 EXPORT_SYMBOL_GPL(pci_load_and_free_saved_state);
1944 int __weak pcibios_enable_device(struct pci_dev *dev, int bars)
1946 return pci_enable_resources(dev, bars);
1949 static int do_pci_enable_device(struct pci_dev *dev, int bars)
1952 struct pci_dev *bridge;
1956 err = pci_set_power_state(dev, PCI_D0);
1957 if (err < 0 && err != -EIO)
1960 bridge = pci_upstream_bridge(dev);
1962 pcie_aspm_powersave_config_link(bridge);
1964 err = pcibios_enable_device(dev, bars);
1967 pci_fixup_device(pci_fixup_enable, dev);
1969 if (dev->msi_enabled || dev->msix_enabled)
1972 pci_read_config_byte(dev, PCI_INTERRUPT_PIN, &pin);
1974 pci_read_config_word(dev, PCI_COMMAND, &cmd);
1975 if (cmd & PCI_COMMAND_INTX_DISABLE)
1976 pci_write_config_word(dev, PCI_COMMAND,
1977 cmd & ~PCI_COMMAND_INTX_DISABLE);
1984 * pci_reenable_device - Resume abandoned device
1985 * @dev: PCI device to be resumed
1987 * NOTE: This function is a backend of pci_default_resume() and is not supposed
1988 * to be called by normal code, write proper resume handler and use it instead.
1990 int pci_reenable_device(struct pci_dev *dev)
1992 if (pci_is_enabled(dev))
1993 return do_pci_enable_device(dev, (1 << PCI_NUM_RESOURCES) - 1);
1996 EXPORT_SYMBOL(pci_reenable_device);
1998 static void pci_enable_bridge(struct pci_dev *dev)
2000 struct pci_dev *bridge;
2003 bridge = pci_upstream_bridge(dev);
2005 pci_enable_bridge(bridge);
2007 if (pci_is_enabled(dev)) {
2008 if (!dev->is_busmaster)
2009 pci_set_master(dev);
2013 retval = pci_enable_device(dev);
2015 pci_err(dev, "Error enabling bridge (%d), continuing\n",
2017 pci_set_master(dev);
2020 static int pci_enable_device_flags(struct pci_dev *dev, unsigned long flags)
2022 struct pci_dev *bridge;
2027 * Power state could be unknown at this point, either due to a fresh
2028 * boot or a device removal call. So get the current power state
2029 * so that things like MSI message writing will behave as expected
2030 * (e.g. if the device really is in D0 at enable time).
2032 pci_update_current_state(dev, dev->current_state);
2034 if (atomic_inc_return(&dev->enable_cnt) > 1)
2035 return 0; /* already enabled */
2037 bridge = pci_upstream_bridge(dev);
2039 pci_enable_bridge(bridge);
2041 /* only skip sriov related */
2042 for (i = 0; i <= PCI_ROM_RESOURCE; i++)
2043 if (dev->resource[i].flags & flags)
2045 for (i = PCI_BRIDGE_RESOURCES; i < DEVICE_COUNT_RESOURCE; i++)
2046 if (dev->resource[i].flags & flags)
2049 err = do_pci_enable_device(dev, bars);
2051 atomic_dec(&dev->enable_cnt);
2056 * pci_enable_device_io - Initialize a device for use with IO space
2057 * @dev: PCI device to be initialized
2059 * Initialize device before it's used by a driver. Ask low-level code
2060 * to enable I/O resources. Wake up the device if it was suspended.
2061 * Beware, this function can fail.
2063 int pci_enable_device_io(struct pci_dev *dev)
2065 return pci_enable_device_flags(dev, IORESOURCE_IO);
2067 EXPORT_SYMBOL(pci_enable_device_io);
2070 * pci_enable_device_mem - Initialize a device for use with Memory space
2071 * @dev: PCI device to be initialized
2073 * Initialize device before it's used by a driver. Ask low-level code
2074 * to enable Memory resources. Wake up the device if it was suspended.
2075 * Beware, this function can fail.
2077 int pci_enable_device_mem(struct pci_dev *dev)
2079 return pci_enable_device_flags(dev, IORESOURCE_MEM);
2081 EXPORT_SYMBOL(pci_enable_device_mem);
2084 * pci_enable_device - Initialize device before it's used by a driver.
2085 * @dev: PCI device to be initialized
2087 * Initialize device before it's used by a driver. Ask low-level code
2088 * to enable I/O and memory. Wake up the device if it was suspended.
2089 * Beware, this function can fail.
2091 * Note we don't actually enable the device many times if we call
2092 * this function repeatedly (we just increment the count).
2094 int pci_enable_device(struct pci_dev *dev)
2096 return pci_enable_device_flags(dev, IORESOURCE_MEM | IORESOURCE_IO);
2098 EXPORT_SYMBOL(pci_enable_device);
2101 * Managed PCI resources. This manages device on/off, INTx/MSI/MSI-X
2102 * on/off and BAR regions. pci_dev itself records MSI/MSI-X status, so
2103 * there's no need to track it separately. pci_devres is initialized
2104 * when a device is enabled using managed PCI device enable interface.
2107 unsigned int enabled:1;
2108 unsigned int pinned:1;
2109 unsigned int orig_intx:1;
2110 unsigned int restore_intx:1;
2115 static void pcim_release(struct device *gendev, void *res)
2117 struct pci_dev *dev = to_pci_dev(gendev);
2118 struct pci_devres *this = res;
2121 for (i = 0; i < DEVICE_COUNT_RESOURCE; i++)
2122 if (this->region_mask & (1 << i))
2123 pci_release_region(dev, i);
2128 if (this->restore_intx)
2129 pci_intx(dev, this->orig_intx);
2131 if (this->enabled && !this->pinned)
2132 pci_disable_device(dev);
2135 static struct pci_devres *get_pci_dr(struct pci_dev *pdev)
2137 struct pci_devres *dr, *new_dr;
2139 dr = devres_find(&pdev->dev, pcim_release, NULL, NULL);
2143 new_dr = devres_alloc(pcim_release, sizeof(*new_dr), GFP_KERNEL);
2146 return devres_get(&pdev->dev, new_dr, NULL, NULL);
2149 static struct pci_devres *find_pci_dr(struct pci_dev *pdev)
2151 if (pci_is_managed(pdev))
2152 return devres_find(&pdev->dev, pcim_release, NULL, NULL);
2157 * pcim_enable_device - Managed pci_enable_device()
2158 * @pdev: PCI device to be initialized
2160 * Managed pci_enable_device().
2162 int pcim_enable_device(struct pci_dev *pdev)
2164 struct pci_devres *dr;
2167 dr = get_pci_dr(pdev);
2173 rc = pci_enable_device(pdev);
2175 pdev->is_managed = 1;
2180 EXPORT_SYMBOL(pcim_enable_device);
2183 * pcim_pin_device - Pin managed PCI device
2184 * @pdev: PCI device to pin
2186 * Pin managed PCI device @pdev. Pinned device won't be disabled on
2187 * driver detach. @pdev must have been enabled with
2188 * pcim_enable_device().
2190 void pcim_pin_device(struct pci_dev *pdev)
2192 struct pci_devres *dr;
2194 dr = find_pci_dr(pdev);
2195 WARN_ON(!dr || !dr->enabled);
2199 EXPORT_SYMBOL(pcim_pin_device);
2202 * pcibios_device_add - provide arch specific hooks when adding device dev
2203 * @dev: the PCI device being added
2205 * Permits the platform to provide architecture specific functionality when
2206 * devices are added. This is the default implementation. Architecture
2207 * implementations can override this.
2209 int __weak pcibios_device_add(struct pci_dev *dev)
2215 * pcibios_release_device - provide arch specific hooks when releasing
2217 * @dev: the PCI device being released
2219 * Permits the platform to provide architecture specific functionality when
2220 * devices are released. This is the default implementation. Architecture
2221 * implementations can override this.
2223 void __weak pcibios_release_device(struct pci_dev *dev) {}
2226 * pcibios_disable_device - disable arch specific PCI resources for device dev
2227 * @dev: the PCI device to disable
2229 * Disables architecture specific PCI resources for the device. This
2230 * is the default implementation. Architecture implementations can
2233 void __weak pcibios_disable_device(struct pci_dev *dev) {}
2236 * pcibios_penalize_isa_irq - penalize an ISA IRQ
2237 * @irq: ISA IRQ to penalize
2238 * @active: IRQ active or not
2240 * Permits the platform to provide architecture-specific functionality when
2241 * penalizing ISA IRQs. This is the default implementation. Architecture
2242 * implementations can override this.
2244 void __weak pcibios_penalize_isa_irq(int irq, int active) {}
2246 static void do_pci_disable_device(struct pci_dev *dev)
2250 pci_read_config_word(dev, PCI_COMMAND, &pci_command);
2251 if (pci_command & PCI_COMMAND_MASTER) {
2252 pci_command &= ~PCI_COMMAND_MASTER;
2253 pci_write_config_word(dev, PCI_COMMAND, pci_command);
2256 pcibios_disable_device(dev);
2260 * pci_disable_enabled_device - Disable device without updating enable_cnt
2261 * @dev: PCI device to disable
2263 * NOTE: This function is a backend of PCI power management routines and is
2264 * not supposed to be called drivers.
2266 void pci_disable_enabled_device(struct pci_dev *dev)
2268 if (pci_is_enabled(dev))
2269 do_pci_disable_device(dev);
2273 * pci_disable_device - Disable PCI device after use
2274 * @dev: PCI device to be disabled
2276 * Signal to the system that the PCI device is not in use by the system
2277 * anymore. This only involves disabling PCI bus-mastering, if active.
2279 * Note we don't actually disable the device until all callers of
2280 * pci_enable_device() have called pci_disable_device().
2282 void pci_disable_device(struct pci_dev *dev)
2284 struct pci_devres *dr;
2286 dr = find_pci_dr(dev);
2290 dev_WARN_ONCE(&dev->dev, atomic_read(&dev->enable_cnt) <= 0,
2291 "disabling already-disabled device");
2293 if (atomic_dec_return(&dev->enable_cnt) != 0)
2296 do_pci_disable_device(dev);
2298 dev->is_busmaster = 0;
2300 EXPORT_SYMBOL(pci_disable_device);
2303 * pcibios_set_pcie_reset_state - set reset state for device dev
2304 * @dev: the PCIe device reset
2305 * @state: Reset state to enter into
2307 * Set the PCIe reset state for the device. This is the default
2308 * implementation. Architecture implementations can override this.
2310 int __weak pcibios_set_pcie_reset_state(struct pci_dev *dev,
2311 enum pcie_reset_state state)
2317 * pci_set_pcie_reset_state - set reset state for device dev
2318 * @dev: the PCIe device reset
2319 * @state: Reset state to enter into
2321 * Sets the PCI reset state for the device.
2323 int pci_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state)
2325 return pcibios_set_pcie_reset_state(dev, state);
2327 EXPORT_SYMBOL_GPL(pci_set_pcie_reset_state);
2329 #ifdef CONFIG_PCIEAER
2330 void pcie_clear_device_status(struct pci_dev *dev)
2334 pcie_capability_read_word(dev, PCI_EXP_DEVSTA, &sta);
2335 pcie_capability_write_word(dev, PCI_EXP_DEVSTA, sta);
2340 * pcie_clear_root_pme_status - Clear root port PME interrupt status.
2341 * @dev: PCIe root port or event collector.
2343 void pcie_clear_root_pme_status(struct pci_dev *dev)
2345 pcie_capability_set_dword(dev, PCI_EXP_RTSTA, PCI_EXP_RTSTA_PME);
2349 * pci_check_pme_status - Check if given device has generated PME.
2350 * @dev: Device to check.
2352 * Check the PME status of the device and if set, clear it and clear PME enable
2353 * (if set). Return 'true' if PME status and PME enable were both set or
2354 * 'false' otherwise.
2356 bool pci_check_pme_status(struct pci_dev *dev)
2365 pmcsr_pos = dev->pm_cap + PCI_PM_CTRL;
2366 pci_read_config_word(dev, pmcsr_pos, &pmcsr);
2367 if (!(pmcsr & PCI_PM_CTRL_PME_STATUS))
2370 /* Clear PME status. */
2371 pmcsr |= PCI_PM_CTRL_PME_STATUS;
2372 if (pmcsr & PCI_PM_CTRL_PME_ENABLE) {
2373 /* Disable PME to avoid interrupt flood. */
2374 pmcsr &= ~PCI_PM_CTRL_PME_ENABLE;
2378 pci_write_config_word(dev, pmcsr_pos, pmcsr);
2384 * pci_pme_wakeup - Wake up a PCI device if its PME Status bit is set.
2385 * @dev: Device to handle.
2386 * @pme_poll_reset: Whether or not to reset the device's pme_poll flag.
2388 * Check if @dev has generated PME and queue a resume request for it in that
2391 static int pci_pme_wakeup(struct pci_dev *dev, void *pme_poll_reset)
2393 if (pme_poll_reset && dev->pme_poll)
2394 dev->pme_poll = false;
2396 if (pci_check_pme_status(dev)) {
2397 pci_wakeup_event(dev);
2398 pm_request_resume(&dev->dev);
2404 * pci_pme_wakeup_bus - Walk given bus and wake up devices on it, if necessary.
2405 * @bus: Top bus of the subtree to walk.
2407 void pci_pme_wakeup_bus(struct pci_bus *bus)
2410 pci_walk_bus(bus, pci_pme_wakeup, (void *)true);
2415 * pci_pme_capable - check the capability of PCI device to generate PME#
2416 * @dev: PCI device to handle.
2417 * @state: PCI state from which device will issue PME#.
2419 bool pci_pme_capable(struct pci_dev *dev, pci_power_t state)
2424 return !!(dev->pme_support & (1 << state));
2426 EXPORT_SYMBOL(pci_pme_capable);
2428 static void pci_pme_list_scan(struct work_struct *work)
2430 struct pci_pme_device *pme_dev, *n;
2432 mutex_lock(&pci_pme_list_mutex);
2433 list_for_each_entry_safe(pme_dev, n, &pci_pme_list, list) {
2434 struct pci_dev *pdev = pme_dev->dev;
2436 if (pdev->pme_poll) {
2437 struct pci_dev *bridge = pdev->bus->self;
2438 struct device *dev = &pdev->dev;
2442 * If bridge is in low power state, the
2443 * configuration space of subordinate devices
2444 * may be not accessible
2446 if (bridge && bridge->current_state != PCI_D0)
2450 * If the device is in a low power state it
2451 * should not be polled either.
2453 pm_status = pm_runtime_get_if_active(dev, true);
2457 if (pdev->current_state != PCI_D3cold)
2458 pci_pme_wakeup(pdev, NULL);
2461 pm_runtime_put(dev);
2463 list_del(&pme_dev->list);
2467 if (!list_empty(&pci_pme_list))
2468 queue_delayed_work(system_freezable_wq, &pci_pme_work,
2469 msecs_to_jiffies(PME_TIMEOUT));
2470 mutex_unlock(&pci_pme_list_mutex);
2473 static void __pci_pme_active(struct pci_dev *dev, bool enable)
2477 if (!dev->pme_support)
2480 pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
2481 /* Clear PME_Status by writing 1 to it and enable PME# */
2482 pmcsr |= PCI_PM_CTRL_PME_STATUS | PCI_PM_CTRL_PME_ENABLE;
2484 pmcsr &= ~PCI_PM_CTRL_PME_ENABLE;
2486 pci_write_config_word(dev, dev->pm_cap + PCI_PM_CTRL, pmcsr);
2490 * pci_pme_restore - Restore PME configuration after config space restore.
2491 * @dev: PCI device to update.
2493 void pci_pme_restore(struct pci_dev *dev)
2497 if (!dev->pme_support)
2500 pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &pmcsr);
2501 if (dev->wakeup_prepared) {
2502 pmcsr |= PCI_PM_CTRL_PME_ENABLE;
2503 pmcsr &= ~PCI_PM_CTRL_PME_STATUS;
2505 pmcsr &= ~PCI_PM_CTRL_PME_ENABLE;
2506 pmcsr |= PCI_PM_CTRL_PME_STATUS;
2508 pci_write_config_word(dev, dev->pm_cap + PCI_PM_CTRL, pmcsr);
2512 * pci_pme_active - enable or disable PCI device's PME# function
2513 * @dev: PCI device to handle.
2514 * @enable: 'true' to enable PME# generation; 'false' to disable it.
2516 * The caller must verify that the device is capable of generating PME# before
2517 * calling this function with @enable equal to 'true'.
2519 void pci_pme_active(struct pci_dev *dev, bool enable)
2521 __pci_pme_active(dev, enable);
2524 * PCI (as opposed to PCIe) PME requires that the device have
2525 * its PME# line hooked up correctly. Not all hardware vendors
2526 * do this, so the PME never gets delivered and the device
2527 * remains asleep. The easiest way around this is to
2528 * periodically walk the list of suspended devices and check
2529 * whether any have their PME flag set. The assumption is that
2530 * we'll wake up often enough anyway that this won't be a huge
2531 * hit, and the power savings from the devices will still be a
2534 * Although PCIe uses in-band PME message instead of PME# line
2535 * to report PME, PME does not work for some PCIe devices in
2536 * reality. For example, there are devices that set their PME
2537 * status bits, but don't really bother to send a PME message;
2538 * there are PCI Express Root Ports that don't bother to
2539 * trigger interrupts when they receive PME messages from the
2540 * devices below. So PME poll is used for PCIe devices too.
2543 if (dev->pme_poll) {
2544 struct pci_pme_device *pme_dev;
2546 pme_dev = kmalloc(sizeof(struct pci_pme_device),
2549 pci_warn(dev, "can't enable PME#\n");
2553 mutex_lock(&pci_pme_list_mutex);
2554 list_add(&pme_dev->list, &pci_pme_list);
2555 if (list_is_singular(&pci_pme_list))
2556 queue_delayed_work(system_freezable_wq,
2558 msecs_to_jiffies(PME_TIMEOUT));
2559 mutex_unlock(&pci_pme_list_mutex);
2561 mutex_lock(&pci_pme_list_mutex);
2562 list_for_each_entry(pme_dev, &pci_pme_list, list) {
2563 if (pme_dev->dev == dev) {
2564 list_del(&pme_dev->list);
2569 mutex_unlock(&pci_pme_list_mutex);
2573 pci_dbg(dev, "PME# %s\n", enable ? "enabled" : "disabled");
2575 EXPORT_SYMBOL(pci_pme_active);
2578 * __pci_enable_wake - enable PCI device as wakeup event source
2579 * @dev: PCI device affected
2580 * @state: PCI state from which device will issue wakeup events
2581 * @enable: True to enable event generation; false to disable
2583 * This enables the device as a wakeup event source, or disables it.
2584 * When such events involves platform-specific hooks, those hooks are
2585 * called automatically by this routine.
2587 * Devices with legacy power management (no standard PCI PM capabilities)
2588 * always require such platform hooks.
2591 * 0 is returned on success
2592 * -EINVAL is returned if device is not supposed to wake up the system
2593 * Error code depending on the platform is returned if both the platform and
2594 * the native mechanism fail to enable the generation of wake-up events
2596 static int __pci_enable_wake(struct pci_dev *dev, pci_power_t state, bool enable)
2601 * Bridges that are not power-manageable directly only signal
2602 * wakeup on behalf of subordinate devices which is set up
2603 * elsewhere, so skip them. However, bridges that are
2604 * power-manageable may signal wakeup for themselves (for example,
2605 * on a hotplug event) and they need to be covered here.
2607 if (!pci_power_manageable(dev))
2610 /* Don't do the same thing twice in a row for one device. */
2611 if (!!enable == !!dev->wakeup_prepared)
2615 * According to "PCI System Architecture" 4th ed. by Tom Shanley & Don
2616 * Anderson we should be doing PME# wake enable followed by ACPI wake
2617 * enable. To disable wake-up we call the platform first, for symmetry.
2624 * Enable PME signaling if the device can signal PME from
2625 * D3cold regardless of whether or not it can signal PME from
2626 * the current target state, because that will allow it to
2627 * signal PME when the hierarchy above it goes into D3cold and
2628 * the device itself ends up in D3cold as a result of that.
2630 if (pci_pme_capable(dev, state) || pci_pme_capable(dev, PCI_D3cold))
2631 pci_pme_active(dev, true);
2634 error = platform_pci_set_wakeup(dev, true);
2638 dev->wakeup_prepared = true;
2640 platform_pci_set_wakeup(dev, false);
2641 pci_pme_active(dev, false);
2642 dev->wakeup_prepared = false;
2649 * pci_enable_wake - change wakeup settings for a PCI device
2650 * @pci_dev: Target device
2651 * @state: PCI state from which device will issue wakeup events
2652 * @enable: Whether or not to enable event generation
2654 * If @enable is set, check device_may_wakeup() for the device before calling
2655 * __pci_enable_wake() for it.
2657 int pci_enable_wake(struct pci_dev *pci_dev, pci_power_t state, bool enable)
2659 if (enable && !device_may_wakeup(&pci_dev->dev))
2662 return __pci_enable_wake(pci_dev, state, enable);
2664 EXPORT_SYMBOL(pci_enable_wake);
2667 * pci_wake_from_d3 - enable/disable device to wake up from D3_hot or D3_cold
2668 * @dev: PCI device to prepare
2669 * @enable: True to enable wake-up event generation; false to disable
2671 * Many drivers want the device to wake up the system from D3_hot or D3_cold
2672 * and this function allows them to set that up cleanly - pci_enable_wake()
2673 * should not be called twice in a row to enable wake-up due to PCI PM vs ACPI
2674 * ordering constraints.
2676 * This function only returns error code if the device is not allowed to wake
2677 * up the system from sleep or it is not capable of generating PME# from both
2678 * D3_hot and D3_cold and the platform is unable to enable wake-up power for it.
2680 int pci_wake_from_d3(struct pci_dev *dev, bool enable)
2682 return pci_pme_capable(dev, PCI_D3cold) ?
2683 pci_enable_wake(dev, PCI_D3cold, enable) :
2684 pci_enable_wake(dev, PCI_D3hot, enable);
2686 EXPORT_SYMBOL(pci_wake_from_d3);
2689 * pci_target_state - find an appropriate low power state for a given PCI dev
2691 * @wakeup: Whether or not wakeup functionality will be enabled for the device.
2693 * Use underlying platform code to find a supported low power state for @dev.
2694 * If the platform can't manage @dev, return the deepest state from which it
2695 * can generate wake events, based on any available PME info.
2697 static pci_power_t pci_target_state(struct pci_dev *dev, bool wakeup)
2699 if (platform_pci_power_manageable(dev)) {
2701 * Call the platform to find the target state for the device.
2703 pci_power_t state = platform_pci_choose_state(dev);
2706 case PCI_POWER_ERROR:
2712 if (pci_no_d1d2(dev))
2720 * If the device is in D3cold even though it's not power-manageable by
2721 * the platform, it may have been powered down by non-standard means.
2722 * Best to let it slumber.
2724 if (dev->current_state == PCI_D3cold)
2726 else if (!dev->pm_cap)
2729 if (wakeup && dev->pme_support) {
2730 pci_power_t state = PCI_D3hot;
2733 * Find the deepest state from which the device can generate
2736 while (state && !(dev->pme_support & (1 << state)))
2741 else if (dev->pme_support & 1)
2749 * pci_prepare_to_sleep - prepare PCI device for system-wide transition
2750 * into a sleep state
2751 * @dev: Device to handle.
2753 * Choose the power state appropriate for the device depending on whether
2754 * it can wake up the system and/or is power manageable by the platform
2755 * (PCI_D3hot is the default) and put the device into that state.
2757 int pci_prepare_to_sleep(struct pci_dev *dev)
2759 bool wakeup = device_may_wakeup(&dev->dev);
2760 pci_power_t target_state = pci_target_state(dev, wakeup);
2763 if (target_state == PCI_POWER_ERROR)
2766 pci_enable_wake(dev, target_state, wakeup);
2768 error = pci_set_power_state(dev, target_state);
2771 pci_enable_wake(dev, target_state, false);
2775 EXPORT_SYMBOL(pci_prepare_to_sleep);
2778 * pci_back_from_sleep - turn PCI device on during system-wide transition
2779 * into working state
2780 * @dev: Device to handle.
2782 * Disable device's system wake-up capability and put it into D0.
2784 int pci_back_from_sleep(struct pci_dev *dev)
2786 int ret = pci_set_power_state(dev, PCI_D0);
2791 pci_enable_wake(dev, PCI_D0, false);
2794 EXPORT_SYMBOL(pci_back_from_sleep);
2797 * pci_finish_runtime_suspend - Carry out PCI-specific part of runtime suspend.
2798 * @dev: PCI device being suspended.
2800 * Prepare @dev to generate wake-up events at run time and put it into a low
2803 int pci_finish_runtime_suspend(struct pci_dev *dev)
2805 pci_power_t target_state;
2808 target_state = pci_target_state(dev, device_can_wakeup(&dev->dev));
2809 if (target_state == PCI_POWER_ERROR)
2812 __pci_enable_wake(dev, target_state, pci_dev_run_wake(dev));
2814 error = pci_set_power_state(dev, target_state);
2817 pci_enable_wake(dev, target_state, false);
2823 * pci_dev_run_wake - Check if device can generate run-time wake-up events.
2824 * @dev: Device to check.
2826 * Return true if the device itself is capable of generating wake-up events
2827 * (through the platform or using the native PCIe PME) or if the device supports
2828 * PME and one of its upstream bridges can generate wake-up events.
2830 bool pci_dev_run_wake(struct pci_dev *dev)
2832 struct pci_bus *bus = dev->bus;
2834 if (!dev->pme_support)
2837 /* PME-capable in principle, but not from the target power state */
2838 if (!pci_pme_capable(dev, pci_target_state(dev, true)))
2841 if (device_can_wakeup(&dev->dev))
2844 while (bus->parent) {
2845 struct pci_dev *bridge = bus->self;
2847 if (device_can_wakeup(&bridge->dev))
2853 /* We have reached the root bus. */
2855 return device_can_wakeup(bus->bridge);
2859 EXPORT_SYMBOL_GPL(pci_dev_run_wake);
2862 * pci_dev_need_resume - Check if it is necessary to resume the device.
2863 * @pci_dev: Device to check.
2865 * Return 'true' if the device is not runtime-suspended or it has to be
2866 * reconfigured due to wakeup settings difference between system and runtime
2867 * suspend, or the current power state of it is not suitable for the upcoming
2868 * (system-wide) transition.
2870 bool pci_dev_need_resume(struct pci_dev *pci_dev)
2872 struct device *dev = &pci_dev->dev;
2873 pci_power_t target_state;
2875 if (!pm_runtime_suspended(dev) || platform_pci_need_resume(pci_dev))
2878 target_state = pci_target_state(pci_dev, device_may_wakeup(dev));
2881 * If the earlier platform check has not triggered, D3cold is just power
2882 * removal on top of D3hot, so no need to resume the device in that
2885 return target_state != pci_dev->current_state &&
2886 target_state != PCI_D3cold &&
2887 pci_dev->current_state != PCI_D3hot;
2891 * pci_dev_adjust_pme - Adjust PME setting for a suspended device.
2892 * @pci_dev: Device to check.
2894 * If the device is suspended and it is not configured for system wakeup,
2895 * disable PME for it to prevent it from waking up the system unnecessarily.
2897 * Note that if the device's power state is D3cold and the platform check in
2898 * pci_dev_need_resume() has not triggered, the device's configuration need not
2901 void pci_dev_adjust_pme(struct pci_dev *pci_dev)
2903 struct device *dev = &pci_dev->dev;
2905 spin_lock_irq(&dev->power.lock);
2907 if (pm_runtime_suspended(dev) && !device_may_wakeup(dev) &&
2908 pci_dev->current_state < PCI_D3cold)
2909 __pci_pme_active(pci_dev, false);
2911 spin_unlock_irq(&dev->power.lock);
2915 * pci_dev_complete_resume - Finalize resume from system sleep for a device.
2916 * @pci_dev: Device to handle.
2918 * If the device is runtime suspended and wakeup-capable, enable PME for it as
2919 * it might have been disabled during the prepare phase of system suspend if
2920 * the device was not configured for system wakeup.
2922 void pci_dev_complete_resume(struct pci_dev *pci_dev)
2924 struct device *dev = &pci_dev->dev;
2926 if (!pci_dev_run_wake(pci_dev))
2929 spin_lock_irq(&dev->power.lock);
2931 if (pm_runtime_suspended(dev) && pci_dev->current_state < PCI_D3cold)
2932 __pci_pme_active(pci_dev, true);
2934 spin_unlock_irq(&dev->power.lock);
2938 * pci_choose_state - Choose the power state of a PCI device.
2939 * @dev: Target PCI device.
2940 * @state: Target state for the whole system.
2942 * Returns PCI power state suitable for @dev and @state.
2944 pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state)
2946 if (state.event == PM_EVENT_ON)
2949 return pci_target_state(dev, false);
2951 EXPORT_SYMBOL(pci_choose_state);
2953 void pci_config_pm_runtime_get(struct pci_dev *pdev)
2955 struct device *dev = &pdev->dev;
2956 struct device *parent = dev->parent;
2959 pm_runtime_get_sync(parent);
2960 pm_runtime_get_noresume(dev);
2962 * pdev->current_state is set to PCI_D3cold during suspending,
2963 * so wait until suspending completes
2965 pm_runtime_barrier(dev);
2967 * Only need to resume devices in D3cold, because config
2968 * registers are still accessible for devices suspended but
2971 if (pdev->current_state == PCI_D3cold)
2972 pm_runtime_resume(dev);
2975 void pci_config_pm_runtime_put(struct pci_dev *pdev)
2977 struct device *dev = &pdev->dev;
2978 struct device *parent = dev->parent;
2980 pm_runtime_put(dev);
2982 pm_runtime_put_sync(parent);
2985 static const struct dmi_system_id bridge_d3_blacklist[] = {
2989 * Gigabyte X299 root port is not marked as hotplug capable
2990 * which allows Linux to power manage it. However, this
2991 * confuses the BIOS SMI handler so don't power manage root
2992 * ports on that system.
2994 .ident = "X299 DESIGNARE EX-CF",
2996 DMI_MATCH(DMI_BOARD_VENDOR, "Gigabyte Technology Co., Ltd."),
2997 DMI_MATCH(DMI_BOARD_NAME, "X299 DESIGNARE EX-CF"),
3002 * Downstream device is not accessible after putting a root port
3003 * into D3cold and back into D0 on Elo Continental Z2 board
3005 .ident = "Elo Continental Z2",
3007 DMI_MATCH(DMI_BOARD_VENDOR, "Elo Touch Solutions"),
3008 DMI_MATCH(DMI_BOARD_NAME, "Geminilake"),
3009 DMI_MATCH(DMI_BOARD_VERSION, "Continental Z2"),
3017 * pci_bridge_d3_possible - Is it possible to put the bridge into D3
3018 * @bridge: Bridge to check
3020 * This function checks if it is possible to move the bridge to D3.
3021 * Currently we only allow D3 for recent enough PCIe ports and Thunderbolt.
3023 bool pci_bridge_d3_possible(struct pci_dev *bridge)
3025 if (!pci_is_pcie(bridge))
3028 switch (pci_pcie_type(bridge)) {
3029 case PCI_EXP_TYPE_ROOT_PORT:
3030 case PCI_EXP_TYPE_UPSTREAM:
3031 case PCI_EXP_TYPE_DOWNSTREAM:
3032 if (pci_bridge_d3_disable)
3036 * Hotplug ports handled by firmware in System Management Mode
3037 * may not be put into D3 by the OS (Thunderbolt on non-Macs).
3039 if (bridge->is_hotplug_bridge && !pciehp_is_native(bridge))
3042 if (pci_bridge_d3_force)
3045 /* Even the oldest 2010 Thunderbolt controller supports D3. */
3046 if (bridge->is_thunderbolt)
3049 /* Platform might know better if the bridge supports D3 */
3050 if (platform_pci_bridge_d3(bridge))
3054 * Hotplug ports handled natively by the OS were not validated
3055 * by vendors for runtime D3 at least until 2018 because there
3056 * was no OS support.
3058 if (bridge->is_hotplug_bridge)
3061 if (dmi_check_system(bridge_d3_blacklist))
3065 * It should be safe to put PCIe ports from 2015 or newer
3068 if (dmi_get_bios_year() >= 2015)
3076 static int pci_dev_check_d3cold(struct pci_dev *dev, void *data)
3078 bool *d3cold_ok = data;
3080 if (/* The device needs to be allowed to go D3cold ... */
3081 dev->no_d3cold || !dev->d3cold_allowed ||
3083 /* ... and if it is wakeup capable to do so from D3cold. */
3084 (device_may_wakeup(&dev->dev) &&
3085 !pci_pme_capable(dev, PCI_D3cold)) ||
3087 /* If it is a bridge it must be allowed to go to D3. */
3088 !pci_power_manageable(dev))
3096 * pci_bridge_d3_update - Update bridge D3 capabilities
3097 * @dev: PCI device which is changed
3099 * Update upstream bridge PM capabilities accordingly depending on if the
3100 * device PM configuration was changed or the device is being removed. The
3101 * change is also propagated upstream.
3103 void pci_bridge_d3_update(struct pci_dev *dev)
3105 bool remove = !device_is_registered(&dev->dev);
3106 struct pci_dev *bridge;
3107 bool d3cold_ok = true;
3109 bridge = pci_upstream_bridge(dev);
3110 if (!bridge || !pci_bridge_d3_possible(bridge))
3114 * If D3 is currently allowed for the bridge, removing one of its
3115 * children won't change that.
3117 if (remove && bridge->bridge_d3)
3121 * If D3 is currently allowed for the bridge and a child is added or
3122 * changed, disallowance of D3 can only be caused by that child, so
3123 * we only need to check that single device, not any of its siblings.
3125 * If D3 is currently not allowed for the bridge, checking the device
3126 * first may allow us to skip checking its siblings.
3129 pci_dev_check_d3cold(dev, &d3cold_ok);
3132 * If D3 is currently not allowed for the bridge, this may be caused
3133 * either by the device being changed/removed or any of its siblings,
3134 * so we need to go through all children to find out if one of them
3135 * continues to block D3.
3137 if (d3cold_ok && !bridge->bridge_d3)
3138 pci_walk_bus(bridge->subordinate, pci_dev_check_d3cold,
3141 if (bridge->bridge_d3 != d3cold_ok) {
3142 bridge->bridge_d3 = d3cold_ok;
3143 /* Propagate change to upstream bridges */
3144 pci_bridge_d3_update(bridge);
3149 * pci_d3cold_enable - Enable D3cold for device
3150 * @dev: PCI device to handle
3152 * This function can be used in drivers to enable D3cold from the device
3153 * they handle. It also updates upstream PCI bridge PM capabilities
3156 void pci_d3cold_enable(struct pci_dev *dev)
3158 if (dev->no_d3cold) {
3159 dev->no_d3cold = false;
3160 pci_bridge_d3_update(dev);
3163 EXPORT_SYMBOL_GPL(pci_d3cold_enable);
3166 * pci_d3cold_disable - Disable D3cold for device
3167 * @dev: PCI device to handle
3169 * This function can be used in drivers to disable D3cold from the device
3170 * they handle. It also updates upstream PCI bridge PM capabilities
3173 void pci_d3cold_disable(struct pci_dev *dev)
3175 if (!dev->no_d3cold) {
3176 dev->no_d3cold = true;
3177 pci_bridge_d3_update(dev);
3180 EXPORT_SYMBOL_GPL(pci_d3cold_disable);
3183 * pci_pm_init - Initialize PM functions of given PCI device
3184 * @dev: PCI device to handle.
3186 void pci_pm_init(struct pci_dev *dev)
3192 pm_runtime_forbid(&dev->dev);
3193 pm_runtime_set_active(&dev->dev);
3194 pm_runtime_enable(&dev->dev);
3195 device_enable_async_suspend(&dev->dev);
3196 dev->wakeup_prepared = false;
3199 dev->pme_support = 0;
3201 /* find PCI PM capability in list */
3202 pm = pci_find_capability(dev, PCI_CAP_ID_PM);
3205 /* Check device's ability to generate PME# */
3206 pci_read_config_word(dev, pm + PCI_PM_PMC, &pmc);
3208 if ((pmc & PCI_PM_CAP_VER_MASK) > 3) {
3209 pci_err(dev, "unsupported PM cap regs version (%u)\n",
3210 pmc & PCI_PM_CAP_VER_MASK);
3215 dev->d3hot_delay = PCI_PM_D3HOT_WAIT;
3216 dev->d3cold_delay = PCI_PM_D3COLD_WAIT;
3217 dev->bridge_d3 = pci_bridge_d3_possible(dev);
3218 dev->d3cold_allowed = true;
3220 dev->d1_support = false;
3221 dev->d2_support = false;
3222 if (!pci_no_d1d2(dev)) {
3223 if (pmc & PCI_PM_CAP_D1)
3224 dev->d1_support = true;
3225 if (pmc & PCI_PM_CAP_D2)
3226 dev->d2_support = true;
3228 if (dev->d1_support || dev->d2_support)
3229 pci_info(dev, "supports%s%s\n",
3230 dev->d1_support ? " D1" : "",
3231 dev->d2_support ? " D2" : "");
3234 pmc &= PCI_PM_CAP_PME_MASK;
3236 pci_info(dev, "PME# supported from%s%s%s%s%s\n",
3237 (pmc & PCI_PM_CAP_PME_D0) ? " D0" : "",
3238 (pmc & PCI_PM_CAP_PME_D1) ? " D1" : "",
3239 (pmc & PCI_PM_CAP_PME_D2) ? " D2" : "",
3240 (pmc & PCI_PM_CAP_PME_D3hot) ? " D3hot" : "",
3241 (pmc & PCI_PM_CAP_PME_D3cold) ? " D3cold" : "");
3242 dev->pme_support = FIELD_GET(PCI_PM_CAP_PME_MASK, pmc);
3243 dev->pme_poll = true;
3245 * Make device's PM flags reflect the wake-up capability, but
3246 * let the user space enable it to wake up the system as needed.
3248 device_set_wakeup_capable(&dev->dev, true);
3249 /* Disable the PME# generation functionality */
3250 pci_pme_active(dev, false);
3253 pci_read_config_word(dev, PCI_STATUS, &status);
3254 if (status & PCI_STATUS_IMM_READY)
3258 static unsigned long pci_ea_flags(struct pci_dev *dev, u8 prop)
3260 unsigned long flags = IORESOURCE_PCI_FIXED | IORESOURCE_PCI_EA_BEI;
3264 case PCI_EA_P_VF_MEM:
3265 flags |= IORESOURCE_MEM;
3267 case PCI_EA_P_MEM_PREFETCH:
3268 case PCI_EA_P_VF_MEM_PREFETCH:
3269 flags |= IORESOURCE_MEM | IORESOURCE_PREFETCH;
3272 flags |= IORESOURCE_IO;
3281 static struct resource *pci_ea_get_resource(struct pci_dev *dev, u8 bei,
3284 if (bei <= PCI_EA_BEI_BAR5 && prop <= PCI_EA_P_IO)
3285 return &dev->resource[bei];
3286 #ifdef CONFIG_PCI_IOV
3287 else if (bei >= PCI_EA_BEI_VF_BAR0 && bei <= PCI_EA_BEI_VF_BAR5 &&
3288 (prop == PCI_EA_P_VF_MEM || prop == PCI_EA_P_VF_MEM_PREFETCH))
3289 return &dev->resource[PCI_IOV_RESOURCES +
3290 bei - PCI_EA_BEI_VF_BAR0];
3292 else if (bei == PCI_EA_BEI_ROM)
3293 return &dev->resource[PCI_ROM_RESOURCE];
3298 /* Read an Enhanced Allocation (EA) entry */
3299 static int pci_ea_read(struct pci_dev *dev, int offset)
3301 struct resource *res;
3302 int ent_size, ent_offset = offset;
3303 resource_size_t start, end;
3304 unsigned long flags;
3305 u32 dw0, bei, base, max_offset;
3307 bool support_64 = (sizeof(resource_size_t) >= 8);
3309 pci_read_config_dword(dev, ent_offset, &dw0);
3312 /* Entry size field indicates DWORDs after 1st */
3313 ent_size = (FIELD_GET(PCI_EA_ES, dw0) + 1) << 2;
3315 if (!(dw0 & PCI_EA_ENABLE)) /* Entry not enabled */
3318 bei = FIELD_GET(PCI_EA_BEI, dw0);
3319 prop = FIELD_GET(PCI_EA_PP, dw0);
3322 * If the Property is in the reserved range, try the Secondary
3325 if (prop > PCI_EA_P_BRIDGE_IO && prop < PCI_EA_P_MEM_RESERVED)
3326 prop = FIELD_GET(PCI_EA_SP, dw0);
3327 if (prop > PCI_EA_P_BRIDGE_IO)
3330 res = pci_ea_get_resource(dev, bei, prop);
3332 pci_err(dev, "Unsupported EA entry BEI: %u\n", bei);
3336 flags = pci_ea_flags(dev, prop);
3338 pci_err(dev, "Unsupported EA properties: %#x\n", prop);
3343 pci_read_config_dword(dev, ent_offset, &base);
3344 start = (base & PCI_EA_FIELD_MASK);
3347 /* Read MaxOffset */
3348 pci_read_config_dword(dev, ent_offset, &max_offset);
3351 /* Read Base MSBs (if 64-bit entry) */
3352 if (base & PCI_EA_IS_64) {
3355 pci_read_config_dword(dev, ent_offset, &base_upper);
3358 flags |= IORESOURCE_MEM_64;
3360 /* entry starts above 32-bit boundary, can't use */
3361 if (!support_64 && base_upper)
3365 start |= ((u64)base_upper << 32);
3368 end = start + (max_offset | 0x03);
3370 /* Read MaxOffset MSBs (if 64-bit entry) */
3371 if (max_offset & PCI_EA_IS_64) {
3372 u32 max_offset_upper;
3374 pci_read_config_dword(dev, ent_offset, &max_offset_upper);
3377 flags |= IORESOURCE_MEM_64;
3379 /* entry too big, can't use */
3380 if (!support_64 && max_offset_upper)
3384 end += ((u64)max_offset_upper << 32);
3388 pci_err(dev, "EA Entry crosses address boundary\n");
3392 if (ent_size != ent_offset - offset) {
3393 pci_err(dev, "EA Entry Size (%d) does not match length read (%d)\n",
3394 ent_size, ent_offset - offset);
3398 res->name = pci_name(dev);
3403 if (bei <= PCI_EA_BEI_BAR5)
3404 pci_info(dev, "BAR %d: %pR (from Enhanced Allocation, properties %#02x)\n",
3406 else if (bei == PCI_EA_BEI_ROM)
3407 pci_info(dev, "ROM: %pR (from Enhanced Allocation, properties %#02x)\n",
3409 else if (bei >= PCI_EA_BEI_VF_BAR0 && bei <= PCI_EA_BEI_VF_BAR5)
3410 pci_info(dev, "VF BAR %d: %pR (from Enhanced Allocation, properties %#02x)\n",
3411 bei - PCI_EA_BEI_VF_BAR0, res, prop);
3413 pci_info(dev, "BEI %d res: %pR (from Enhanced Allocation, properties %#02x)\n",
3417 return offset + ent_size;
3420 /* Enhanced Allocation Initialization */
3421 void pci_ea_init(struct pci_dev *dev)
3428 /* find PCI EA capability in list */
3429 ea = pci_find_capability(dev, PCI_CAP_ID_EA);
3433 /* determine the number of entries */
3434 pci_bus_read_config_byte(dev->bus, dev->devfn, ea + PCI_EA_NUM_ENT,
3436 num_ent &= PCI_EA_NUM_ENT_MASK;
3438 offset = ea + PCI_EA_FIRST_ENT;
3440 /* Skip DWORD 2 for type 1 functions */
3441 if (dev->hdr_type == PCI_HEADER_TYPE_BRIDGE)
3444 /* parse each EA entry */
3445 for (i = 0; i < num_ent; ++i)
3446 offset = pci_ea_read(dev, offset);
3449 static void pci_add_saved_cap(struct pci_dev *pci_dev,
3450 struct pci_cap_saved_state *new_cap)
3452 hlist_add_head(&new_cap->next, &pci_dev->saved_cap_space);
3456 * _pci_add_cap_save_buffer - allocate buffer for saving given
3457 * capability registers
3458 * @dev: the PCI device
3459 * @cap: the capability to allocate the buffer for
3460 * @extended: Standard or Extended capability ID
3461 * @size: requested size of the buffer
3463 static int _pci_add_cap_save_buffer(struct pci_dev *dev, u16 cap,
3464 bool extended, unsigned int size)
3467 struct pci_cap_saved_state *save_state;
3470 pos = pci_find_ext_capability(dev, cap);
3472 pos = pci_find_capability(dev, cap);
3477 save_state = kzalloc(sizeof(*save_state) + size, GFP_KERNEL);
3481 save_state->cap.cap_nr = cap;
3482 save_state->cap.cap_extended = extended;
3483 save_state->cap.size = size;
3484 pci_add_saved_cap(dev, save_state);
3489 int pci_add_cap_save_buffer(struct pci_dev *dev, char cap, unsigned int size)
3491 return _pci_add_cap_save_buffer(dev, cap, false, size);
3494 int pci_add_ext_cap_save_buffer(struct pci_dev *dev, u16 cap, unsigned int size)
3496 return _pci_add_cap_save_buffer(dev, cap, true, size);
3500 * pci_allocate_cap_save_buffers - allocate buffers for saving capabilities
3501 * @dev: the PCI device
3503 void pci_allocate_cap_save_buffers(struct pci_dev *dev)
3507 error = pci_add_cap_save_buffer(dev, PCI_CAP_ID_EXP,
3508 PCI_EXP_SAVE_REGS * sizeof(u16));
3510 pci_err(dev, "unable to preallocate PCI Express save buffer\n");
3512 error = pci_add_cap_save_buffer(dev, PCI_CAP_ID_PCIX, sizeof(u16));
3514 pci_err(dev, "unable to preallocate PCI-X save buffer\n");
3516 error = pci_add_ext_cap_save_buffer(dev, PCI_EXT_CAP_ID_LTR,
3519 pci_err(dev, "unable to allocate suspend buffer for LTR\n");
3521 pci_allocate_vc_save_buffers(dev);
3524 void pci_free_cap_save_buffers(struct pci_dev *dev)
3526 struct pci_cap_saved_state *tmp;
3527 struct hlist_node *n;
3529 hlist_for_each_entry_safe(tmp, n, &dev->saved_cap_space, next)
3534 * pci_configure_ari - enable or disable ARI forwarding
3535 * @dev: the PCI device
3537 * If @dev and its upstream bridge both support ARI, enable ARI in the
3538 * bridge. Otherwise, disable ARI in the bridge.
3540 void pci_configure_ari(struct pci_dev *dev)
3543 struct pci_dev *bridge;
3545 if (pcie_ari_disabled || !pci_is_pcie(dev) || dev->devfn)
3548 bridge = dev->bus->self;
3552 pcie_capability_read_dword(bridge, PCI_EXP_DEVCAP2, &cap);
3553 if (!(cap & PCI_EXP_DEVCAP2_ARI))
3556 if (pci_find_ext_capability(dev, PCI_EXT_CAP_ID_ARI)) {
3557 pcie_capability_set_word(bridge, PCI_EXP_DEVCTL2,
3558 PCI_EXP_DEVCTL2_ARI);
3559 bridge->ari_enabled = 1;
3561 pcie_capability_clear_word(bridge, PCI_EXP_DEVCTL2,
3562 PCI_EXP_DEVCTL2_ARI);
3563 bridge->ari_enabled = 0;
3567 static bool pci_acs_flags_enabled(struct pci_dev *pdev, u16 acs_flags)
3572 pos = pdev->acs_cap;
3577 * Except for egress control, capabilities are either required
3578 * or only required if controllable. Features missing from the
3579 * capability field can therefore be assumed as hard-wired enabled.
3581 pci_read_config_word(pdev, pos + PCI_ACS_CAP, &cap);
3582 acs_flags &= (cap | PCI_ACS_EC);
3584 pci_read_config_word(pdev, pos + PCI_ACS_CTRL, &ctrl);
3585 return (ctrl & acs_flags) == acs_flags;
3589 * pci_acs_enabled - test ACS against required flags for a given device
3590 * @pdev: device to test
3591 * @acs_flags: required PCI ACS flags
3593 * Return true if the device supports the provided flags. Automatically
3594 * filters out flags that are not implemented on multifunction devices.
3596 * Note that this interface checks the effective ACS capabilities of the
3597 * device rather than the actual capabilities. For instance, most single
3598 * function endpoints are not required to support ACS because they have no
3599 * opportunity for peer-to-peer access. We therefore return 'true'
3600 * regardless of whether the device exposes an ACS capability. This makes
3601 * it much easier for callers of this function to ignore the actual type
3602 * or topology of the device when testing ACS support.
3604 bool pci_acs_enabled(struct pci_dev *pdev, u16 acs_flags)
3608 ret = pci_dev_specific_acs_enabled(pdev, acs_flags);
3613 * Conventional PCI and PCI-X devices never support ACS, either
3614 * effectively or actually. The shared bus topology implies that
3615 * any device on the bus can receive or snoop DMA.
3617 if (!pci_is_pcie(pdev))
3620 switch (pci_pcie_type(pdev)) {
3622 * PCI/X-to-PCIe bridges are not specifically mentioned by the spec,
3623 * but since their primary interface is PCI/X, we conservatively
3624 * handle them as we would a non-PCIe device.
3626 case PCI_EXP_TYPE_PCIE_BRIDGE:
3628 * PCIe 3.0, 6.12.1 excludes ACS on these devices. "ACS is never
3629 * applicable... must never implement an ACS Extended Capability...".
3630 * This seems arbitrary, but we take a conservative interpretation
3631 * of this statement.
3633 case PCI_EXP_TYPE_PCI_BRIDGE:
3634 case PCI_EXP_TYPE_RC_EC:
3637 * PCIe 3.0, 6.12.1.1 specifies that downstream and root ports should
3638 * implement ACS in order to indicate their peer-to-peer capabilities,
3639 * regardless of whether they are single- or multi-function devices.
3641 case PCI_EXP_TYPE_DOWNSTREAM:
3642 case PCI_EXP_TYPE_ROOT_PORT:
3643 return pci_acs_flags_enabled(pdev, acs_flags);
3645 * PCIe 3.0, 6.12.1.2 specifies ACS capabilities that should be
3646 * implemented by the remaining PCIe types to indicate peer-to-peer
3647 * capabilities, but only when they are part of a multifunction
3648 * device. The footnote for section 6.12 indicates the specific
3649 * PCIe types included here.
3651 case PCI_EXP_TYPE_ENDPOINT:
3652 case PCI_EXP_TYPE_UPSTREAM:
3653 case PCI_EXP_TYPE_LEG_END:
3654 case PCI_EXP_TYPE_RC_END:
3655 if (!pdev->multifunction)
3658 return pci_acs_flags_enabled(pdev, acs_flags);
3662 * PCIe 3.0, 6.12.1.3 specifies no ACS capabilities are applicable
3663 * to single function devices with the exception of downstream ports.
3669 * pci_acs_path_enabled - test ACS flags from start to end in a hierarchy
3670 * @start: starting downstream device
3671 * @end: ending upstream device or NULL to search to the root bus
3672 * @acs_flags: required flags
3674 * Walk up a device tree from start to end testing PCI ACS support. If
3675 * any step along the way does not support the required flags, return false.
3677 bool pci_acs_path_enabled(struct pci_dev *start,
3678 struct pci_dev *end, u16 acs_flags)
3680 struct pci_dev *pdev, *parent = start;
3685 if (!pci_acs_enabled(pdev, acs_flags))
3688 if (pci_is_root_bus(pdev->bus))
3689 return (end == NULL);
3691 parent = pdev->bus->self;
3692 } while (pdev != end);
3698 * pci_acs_init - Initialize ACS if hardware supports it
3699 * @dev: the PCI device
3701 void pci_acs_init(struct pci_dev *dev)
3703 dev->acs_cap = pci_find_ext_capability(dev, PCI_EXT_CAP_ID_ACS);
3706 * Attempt to enable ACS regardless of capability because some Root
3707 * Ports (e.g. those quirked with *_intel_pch_acs_*) do not have
3708 * the standard ACS capability but still support ACS via those
3711 pci_enable_acs(dev);
3715 * pci_rebar_find_pos - find position of resize ctrl reg for BAR
3719 * Helper to find the position of the ctrl register for a BAR.
3720 * Returns -ENOTSUPP if resizable BARs are not supported at all.
3721 * Returns -ENOENT if no ctrl register for the BAR could be found.
3723 static int pci_rebar_find_pos(struct pci_dev *pdev, int bar)
3725 unsigned int pos, nbars, i;
3728 pos = pci_find_ext_capability(pdev, PCI_EXT_CAP_ID_REBAR);
3732 pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
3733 nbars = FIELD_GET(PCI_REBAR_CTRL_NBAR_MASK, ctrl);
3735 for (i = 0; i < nbars; i++, pos += 8) {
3738 pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
3739 bar_idx = FIELD_GET(PCI_REBAR_CTRL_BAR_IDX, ctrl);
3748 * pci_rebar_get_possible_sizes - get possible sizes for BAR
3750 * @bar: BAR to query
3752 * Get the possible sizes of a resizable BAR as bitmask defined in the spec
3753 * (bit 0=1MB, bit 19=512GB). Returns 0 if BAR isn't resizable.
3755 u32 pci_rebar_get_possible_sizes(struct pci_dev *pdev, int bar)
3760 pos = pci_rebar_find_pos(pdev, bar);
3764 pci_read_config_dword(pdev, pos + PCI_REBAR_CAP, &cap);
3765 cap = FIELD_GET(PCI_REBAR_CAP_SIZES, cap);
3767 /* Sapphire RX 5600 XT Pulse has an invalid cap dword for BAR 0 */
3768 if (pdev->vendor == PCI_VENDOR_ID_ATI && pdev->device == 0x731f &&
3769 bar == 0 && cap == 0x700)
3774 EXPORT_SYMBOL(pci_rebar_get_possible_sizes);
3777 * pci_rebar_get_current_size - get the current size of a BAR
3779 * @bar: BAR to set size to
3781 * Read the size of a BAR from the resizable BAR config.
3782 * Returns size if found or negative error code.
3784 int pci_rebar_get_current_size(struct pci_dev *pdev, int bar)
3789 pos = pci_rebar_find_pos(pdev, bar);
3793 pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
3794 return FIELD_GET(PCI_REBAR_CTRL_BAR_SIZE, ctrl);
3798 * pci_rebar_set_size - set a new size for a BAR
3800 * @bar: BAR to set size to
3801 * @size: new size as defined in the spec (0=1MB, 19=512GB)
3803 * Set the new size of a BAR as defined in the spec.
3804 * Returns zero if resizing was successful, error code otherwise.
3806 int pci_rebar_set_size(struct pci_dev *pdev, int bar, int size)
3811 pos = pci_rebar_find_pos(pdev, bar);
3815 pci_read_config_dword(pdev, pos + PCI_REBAR_CTRL, &ctrl);
3816 ctrl &= ~PCI_REBAR_CTRL_BAR_SIZE;
3817 ctrl |= FIELD_PREP(PCI_REBAR_CTRL_BAR_SIZE, size);
3818 pci_write_config_dword(pdev, pos + PCI_REBAR_CTRL, ctrl);
3823 * pci_enable_atomic_ops_to_root - enable AtomicOp requests to root port
3824 * @dev: the PCI device
3825 * @cap_mask: mask of desired AtomicOp sizes, including one or more of:
3826 * PCI_EXP_DEVCAP2_ATOMIC_COMP32
3827 * PCI_EXP_DEVCAP2_ATOMIC_COMP64
3828 * PCI_EXP_DEVCAP2_ATOMIC_COMP128
3830 * Return 0 if all upstream bridges support AtomicOp routing, egress
3831 * blocking is disabled on all upstream ports, and the root port supports
3832 * the requested completion capabilities (32-bit, 64-bit and/or 128-bit
3833 * AtomicOp completion), or negative otherwise.
3835 int pci_enable_atomic_ops_to_root(struct pci_dev *dev, u32 cap_mask)
3837 struct pci_bus *bus = dev->bus;
3838 struct pci_dev *bridge;
3842 * Per PCIe r5.0, sec 9.3.5.10, the AtomicOp Requester Enable bit
3843 * in Device Control 2 is reserved in VFs and the PF value applies
3844 * to all associated VFs.
3849 if (!pci_is_pcie(dev))
3853 * Per PCIe r4.0, sec 6.15, endpoints and root ports may be
3854 * AtomicOp requesters. For now, we only support endpoints as
3855 * requesters and root ports as completers. No endpoints as
3856 * completers, and no peer-to-peer.
3859 switch (pci_pcie_type(dev)) {
3860 case PCI_EXP_TYPE_ENDPOINT:
3861 case PCI_EXP_TYPE_LEG_END:
3862 case PCI_EXP_TYPE_RC_END:
3868 while (bus->parent) {
3871 pcie_capability_read_dword(bridge, PCI_EXP_DEVCAP2, &cap);
3873 switch (pci_pcie_type(bridge)) {
3874 /* Ensure switch ports support AtomicOp routing */
3875 case PCI_EXP_TYPE_UPSTREAM:
3876 case PCI_EXP_TYPE_DOWNSTREAM:
3877 if (!(cap & PCI_EXP_DEVCAP2_ATOMIC_ROUTE))
3881 /* Ensure root port supports all the sizes we care about */
3882 case PCI_EXP_TYPE_ROOT_PORT:
3883 if ((cap & cap_mask) != cap_mask)
3888 /* Ensure upstream ports don't block AtomicOps on egress */
3889 if (pci_pcie_type(bridge) == PCI_EXP_TYPE_UPSTREAM) {
3890 pcie_capability_read_dword(bridge, PCI_EXP_DEVCTL2,
3892 if (ctl2 & PCI_EXP_DEVCTL2_ATOMIC_EGRESS_BLOCK)
3899 pcie_capability_set_word(dev, PCI_EXP_DEVCTL2,
3900 PCI_EXP_DEVCTL2_ATOMIC_REQ);
3903 EXPORT_SYMBOL(pci_enable_atomic_ops_to_root);
3906 * pci_swizzle_interrupt_pin - swizzle INTx for device behind bridge
3907 * @dev: the PCI device
3908 * @pin: the INTx pin (1=INTA, 2=INTB, 3=INTC, 4=INTD)
3910 * Perform INTx swizzling for a device behind one level of bridge. This is
3911 * required by section 9.1 of the PCI-to-PCI bridge specification for devices
3912 * behind bridges on add-in cards. For devices with ARI enabled, the slot
3913 * number is always 0 (see the Implementation Note in section 2.2.8.1 of
3914 * the PCI Express Base Specification, Revision 2.1)
3916 u8 pci_swizzle_interrupt_pin(const struct pci_dev *dev, u8 pin)
3920 if (pci_ari_enabled(dev->bus))
3923 slot = PCI_SLOT(dev->devfn);
3925 return (((pin - 1) + slot) % 4) + 1;
3928 int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge)
3936 while (!pci_is_root_bus(dev->bus)) {
3937 pin = pci_swizzle_interrupt_pin(dev, pin);
3938 dev = dev->bus->self;
3945 * pci_common_swizzle - swizzle INTx all the way to root bridge
3946 * @dev: the PCI device
3947 * @pinp: pointer to the INTx pin value (1=INTA, 2=INTB, 3=INTD, 4=INTD)
3949 * Perform INTx swizzling for a device. This traverses through all PCI-to-PCI
3950 * bridges all the way up to a PCI root bus.
3952 u8 pci_common_swizzle(struct pci_dev *dev, u8 *pinp)
3956 while (!pci_is_root_bus(dev->bus)) {
3957 pin = pci_swizzle_interrupt_pin(dev, pin);
3958 dev = dev->bus->self;
3961 return PCI_SLOT(dev->devfn);
3963 EXPORT_SYMBOL_GPL(pci_common_swizzle);
3966 * pci_release_region - Release a PCI bar
3967 * @pdev: PCI device whose resources were previously reserved by
3968 * pci_request_region()
3969 * @bar: BAR to release
3971 * Releases the PCI I/O and memory resources previously reserved by a
3972 * successful call to pci_request_region(). Call this function only
3973 * after all use of the PCI regions has ceased.
3975 void pci_release_region(struct pci_dev *pdev, int bar)
3977 struct pci_devres *dr;
3979 if (pci_resource_len(pdev, bar) == 0)
3981 if (pci_resource_flags(pdev, bar) & IORESOURCE_IO)
3982 release_region(pci_resource_start(pdev, bar),
3983 pci_resource_len(pdev, bar));
3984 else if (pci_resource_flags(pdev, bar) & IORESOURCE_MEM)
3985 release_mem_region(pci_resource_start(pdev, bar),
3986 pci_resource_len(pdev, bar));
3988 dr = find_pci_dr(pdev);
3990 dr->region_mask &= ~(1 << bar);
3992 EXPORT_SYMBOL(pci_release_region);
3995 * __pci_request_region - Reserved PCI I/O and memory resource
3996 * @pdev: PCI device whose resources are to be reserved
3997 * @bar: BAR to be reserved
3998 * @res_name: Name to be associated with resource.
3999 * @exclusive: whether the region access is exclusive or not
4001 * Mark the PCI region associated with PCI device @pdev BAR @bar as
4002 * being reserved by owner @res_name. Do not access any
4003 * address inside the PCI regions unless this call returns
4006 * If @exclusive is set, then the region is marked so that userspace
4007 * is explicitly not allowed to map the resource via /dev/mem or
4008 * sysfs MMIO access.
4010 * Returns 0 on success, or %EBUSY on error. A warning
4011 * message is also printed on failure.
4013 static int __pci_request_region(struct pci_dev *pdev, int bar,
4014 const char *res_name, int exclusive)
4016 struct pci_devres *dr;
4018 if (pci_resource_len(pdev, bar) == 0)
4021 if (pci_resource_flags(pdev, bar) & IORESOURCE_IO) {
4022 if (!request_region(pci_resource_start(pdev, bar),
4023 pci_resource_len(pdev, bar), res_name))
4025 } else if (pci_resource_flags(pdev, bar) & IORESOURCE_MEM) {
4026 if (!__request_mem_region(pci_resource_start(pdev, bar),
4027 pci_resource_len(pdev, bar), res_name,
4032 dr = find_pci_dr(pdev);
4034 dr->region_mask |= 1 << bar;
4039 pci_warn(pdev, "BAR %d: can't reserve %pR\n", bar,
4040 &pdev->resource[bar]);
4045 * pci_request_region - Reserve PCI I/O and memory resource
4046 * @pdev: PCI device whose resources are to be reserved
4047 * @bar: BAR to be reserved
4048 * @res_name: Name to be associated with resource
4050 * Mark the PCI region associated with PCI device @pdev BAR @bar as
4051 * being reserved by owner @res_name. Do not access any
4052 * address inside the PCI regions unless this call returns
4055 * Returns 0 on success, or %EBUSY on error. A warning
4056 * message is also printed on failure.
4058 int pci_request_region(struct pci_dev *pdev, int bar, const char *res_name)
4060 return __pci_request_region(pdev, bar, res_name, 0);
4062 EXPORT_SYMBOL(pci_request_region);
4065 * pci_release_selected_regions - Release selected PCI I/O and memory resources
4066 * @pdev: PCI device whose resources were previously reserved
4067 * @bars: Bitmask of BARs to be released
4069 * Release selected PCI I/O and memory resources previously reserved.
4070 * Call this function only after all use of the PCI regions has ceased.
4072 void pci_release_selected_regions(struct pci_dev *pdev, int bars)
4076 for (i = 0; i < PCI_STD_NUM_BARS; i++)
4077 if (bars & (1 << i))
4078 pci_release_region(pdev, i);
4080 EXPORT_SYMBOL(pci_release_selected_regions);
4082 static int __pci_request_selected_regions(struct pci_dev *pdev, int bars,
4083 const char *res_name, int excl)
4087 for (i = 0; i < PCI_STD_NUM_BARS; i++)
4088 if (bars & (1 << i))
4089 if (__pci_request_region(pdev, i, res_name, excl))
4095 if (bars & (1 << i))
4096 pci_release_region(pdev, i);
4103 * pci_request_selected_regions - Reserve selected PCI I/O and memory resources
4104 * @pdev: PCI device whose resources are to be reserved
4105 * @bars: Bitmask of BARs to be requested
4106 * @res_name: Name to be associated with resource
4108 int pci_request_selected_regions(struct pci_dev *pdev, int bars,
4109 const char *res_name)
4111 return __pci_request_selected_regions(pdev, bars, res_name, 0);
4113 EXPORT_SYMBOL(pci_request_selected_regions);
4115 int pci_request_selected_regions_exclusive(struct pci_dev *pdev, int bars,
4116 const char *res_name)
4118 return __pci_request_selected_regions(pdev, bars, res_name,
4119 IORESOURCE_EXCLUSIVE);
4121 EXPORT_SYMBOL(pci_request_selected_regions_exclusive);
4124 * pci_release_regions - Release reserved PCI I/O and memory resources
4125 * @pdev: PCI device whose resources were previously reserved by
4126 * pci_request_regions()
4128 * Releases all PCI I/O and memory resources previously reserved by a
4129 * successful call to pci_request_regions(). Call this function only
4130 * after all use of the PCI regions has ceased.
4133 void pci_release_regions(struct pci_dev *pdev)
4135 pci_release_selected_regions(pdev, (1 << PCI_STD_NUM_BARS) - 1);
4137 EXPORT_SYMBOL(pci_release_regions);
4140 * pci_request_regions - Reserve PCI I/O and memory resources
4141 * @pdev: PCI device whose resources are to be reserved
4142 * @res_name: Name to be associated with resource.
4144 * Mark all PCI regions associated with PCI device @pdev as
4145 * being reserved by owner @res_name. Do not access any
4146 * address inside the PCI regions unless this call returns
4149 * Returns 0 on success, or %EBUSY on error. A warning
4150 * message is also printed on failure.
4152 int pci_request_regions(struct pci_dev *pdev, const char *res_name)
4154 return pci_request_selected_regions(pdev,
4155 ((1 << PCI_STD_NUM_BARS) - 1), res_name);
4157 EXPORT_SYMBOL(pci_request_regions);
4160 * pci_request_regions_exclusive - Reserve PCI I/O and memory resources
4161 * @pdev: PCI device whose resources are to be reserved
4162 * @res_name: Name to be associated with resource.
4164 * Mark all PCI regions associated with PCI device @pdev as being reserved
4165 * by owner @res_name. Do not access any address inside the PCI regions
4166 * unless this call returns successfully.
4168 * pci_request_regions_exclusive() will mark the region so that /dev/mem
4169 * and the sysfs MMIO access will not be allowed.
4171 * Returns 0 on success, or %EBUSY on error. A warning message is also
4172 * printed on failure.
4174 int pci_request_regions_exclusive(struct pci_dev *pdev, const char *res_name)
4176 return pci_request_selected_regions_exclusive(pdev,
4177 ((1 << PCI_STD_NUM_BARS) - 1), res_name);
4179 EXPORT_SYMBOL(pci_request_regions_exclusive);
4182 * Record the PCI IO range (expressed as CPU physical address + size).
4183 * Return a negative value if an error has occurred, zero otherwise
4185 int pci_register_io_range(struct fwnode_handle *fwnode, phys_addr_t addr,
4186 resource_size_t size)
4190 struct logic_pio_hwaddr *range;
4192 if (!size || addr + size < addr)
4195 range = kzalloc(sizeof(*range), GFP_ATOMIC);
4199 range->fwnode = fwnode;
4201 range->hw_start = addr;
4202 range->flags = LOGIC_PIO_CPU_MMIO;
4204 ret = logic_pio_register_range(range);
4208 /* Ignore duplicates due to deferred probing */
4216 phys_addr_t pci_pio_to_address(unsigned long pio)
4219 if (pio < MMIO_UPPER_LIMIT)
4220 return logic_pio_to_hwaddr(pio);
4223 return (phys_addr_t) OF_BAD_ADDR;
4225 EXPORT_SYMBOL_GPL(pci_pio_to_address);
4227 unsigned long __weak pci_address_to_pio(phys_addr_t address)
4230 return logic_pio_trans_cpuaddr(address);
4232 if (address > IO_SPACE_LIMIT)
4233 return (unsigned long)-1;
4235 return (unsigned long) address;
4240 * pci_remap_iospace - Remap the memory mapped I/O space
4241 * @res: Resource describing the I/O space
4242 * @phys_addr: physical address of range to be mapped
4244 * Remap the memory mapped I/O space described by the @res and the CPU
4245 * physical address @phys_addr into virtual address space. Only
4246 * architectures that have memory mapped IO functions defined (and the
4247 * PCI_IOBASE value defined) should call this function.
4249 #ifndef pci_remap_iospace
4250 int pci_remap_iospace(const struct resource *res, phys_addr_t phys_addr)
4252 #if defined(PCI_IOBASE) && defined(CONFIG_MMU)
4253 unsigned long vaddr = (unsigned long)PCI_IOBASE + res->start;
4255 if (!(res->flags & IORESOURCE_IO))
4258 if (res->end > IO_SPACE_LIMIT)
4261 return ioremap_page_range(vaddr, vaddr + resource_size(res), phys_addr,
4262 pgprot_device(PAGE_KERNEL));
4265 * This architecture does not have memory mapped I/O space,
4266 * so this function should never be called
4268 WARN_ONCE(1, "This architecture does not support memory mapped I/O\n");
4272 EXPORT_SYMBOL(pci_remap_iospace);
4276 * pci_unmap_iospace - Unmap the memory mapped I/O space
4277 * @res: resource to be unmapped
4279 * Unmap the CPU virtual address @res from virtual address space. Only
4280 * architectures that have memory mapped IO functions defined (and the
4281 * PCI_IOBASE value defined) should call this function.
4283 void pci_unmap_iospace(struct resource *res)
4285 #if defined(PCI_IOBASE) && defined(CONFIG_MMU)
4286 unsigned long vaddr = (unsigned long)PCI_IOBASE + res->start;
4288 vunmap_range(vaddr, vaddr + resource_size(res));
4291 EXPORT_SYMBOL(pci_unmap_iospace);
4293 static void devm_pci_unmap_iospace(struct device *dev, void *ptr)
4295 struct resource **res = ptr;
4297 pci_unmap_iospace(*res);
4301 * devm_pci_remap_iospace - Managed pci_remap_iospace()
4302 * @dev: Generic device to remap IO address for
4303 * @res: Resource describing the I/O space
4304 * @phys_addr: physical address of range to be mapped
4306 * Managed pci_remap_iospace(). Map is automatically unmapped on driver
4309 int devm_pci_remap_iospace(struct device *dev, const struct resource *res,
4310 phys_addr_t phys_addr)
4312 const struct resource **ptr;
4315 ptr = devres_alloc(devm_pci_unmap_iospace, sizeof(*ptr), GFP_KERNEL);
4319 error = pci_remap_iospace(res, phys_addr);
4324 devres_add(dev, ptr);
4329 EXPORT_SYMBOL(devm_pci_remap_iospace);
4332 * devm_pci_remap_cfgspace - Managed pci_remap_cfgspace()
4333 * @dev: Generic device to remap IO address for
4334 * @offset: Resource address to map
4335 * @size: Size of map
4337 * Managed pci_remap_cfgspace(). Map is automatically unmapped on driver
4340 void __iomem *devm_pci_remap_cfgspace(struct device *dev,
4341 resource_size_t offset,
4342 resource_size_t size)
4344 void __iomem **ptr, *addr;
4346 ptr = devres_alloc(devm_ioremap_release, sizeof(*ptr), GFP_KERNEL);
4350 addr = pci_remap_cfgspace(offset, size);
4353 devres_add(dev, ptr);
4359 EXPORT_SYMBOL(devm_pci_remap_cfgspace);
4362 * devm_pci_remap_cfg_resource - check, request region and ioremap cfg resource
4363 * @dev: generic device to handle the resource for
4364 * @res: configuration space resource to be handled
4366 * Checks that a resource is a valid memory region, requests the memory
4367 * region and ioremaps with pci_remap_cfgspace() API that ensures the
4368 * proper PCI configuration space memory attributes are guaranteed.
4370 * All operations are managed and will be undone on driver detach.
4372 * Returns a pointer to the remapped memory or an ERR_PTR() encoded error code
4373 * on failure. Usage example::
4375 * res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
4376 * base = devm_pci_remap_cfg_resource(&pdev->dev, res);
4378 * return PTR_ERR(base);
4380 void __iomem *devm_pci_remap_cfg_resource(struct device *dev,
4381 struct resource *res)
4383 resource_size_t size;
4385 void __iomem *dest_ptr;
4389 if (!res || resource_type(res) != IORESOURCE_MEM) {
4390 dev_err(dev, "invalid resource\n");
4391 return IOMEM_ERR_PTR(-EINVAL);
4394 size = resource_size(res);
4397 name = devm_kasprintf(dev, GFP_KERNEL, "%s %s", dev_name(dev),
4400 name = devm_kstrdup(dev, dev_name(dev), GFP_KERNEL);
4402 return IOMEM_ERR_PTR(-ENOMEM);
4404 if (!devm_request_mem_region(dev, res->start, size, name)) {
4405 dev_err(dev, "can't request region for resource %pR\n", res);
4406 return IOMEM_ERR_PTR(-EBUSY);
4409 dest_ptr = devm_pci_remap_cfgspace(dev, res->start, size);
4411 dev_err(dev, "ioremap failed for resource %pR\n", res);
4412 devm_release_mem_region(dev, res->start, size);
4413 dest_ptr = IOMEM_ERR_PTR(-ENOMEM);
4418 EXPORT_SYMBOL(devm_pci_remap_cfg_resource);
4420 static void __pci_set_master(struct pci_dev *dev, bool enable)
4424 pci_read_config_word(dev, PCI_COMMAND, &old_cmd);
4426 cmd = old_cmd | PCI_COMMAND_MASTER;
4428 cmd = old_cmd & ~PCI_COMMAND_MASTER;
4429 if (cmd != old_cmd) {
4430 pci_dbg(dev, "%s bus mastering\n",
4431 enable ? "enabling" : "disabling");
4432 pci_write_config_word(dev, PCI_COMMAND, cmd);
4434 dev->is_busmaster = enable;
4438 * pcibios_setup - process "pci=" kernel boot arguments
4439 * @str: string used to pass in "pci=" kernel boot arguments
4441 * Process kernel boot arguments. This is the default implementation.
4442 * Architecture specific implementations can override this as necessary.
4444 char * __weak __init pcibios_setup(char *str)
4450 * pcibios_set_master - enable PCI bus-mastering for device dev
4451 * @dev: the PCI device to enable
4453 * Enables PCI bus-mastering for the device. This is the default
4454 * implementation. Architecture specific implementations can override
4455 * this if necessary.
4457 void __weak pcibios_set_master(struct pci_dev *dev)
4461 /* The latency timer doesn't apply to PCIe (either Type 0 or Type 1) */
4462 if (pci_is_pcie(dev))
4465 pci_read_config_byte(dev, PCI_LATENCY_TIMER, &lat);
4467 lat = (64 <= pcibios_max_latency) ? 64 : pcibios_max_latency;
4468 else if (lat > pcibios_max_latency)
4469 lat = pcibios_max_latency;
4473 pci_write_config_byte(dev, PCI_LATENCY_TIMER, lat);
4477 * pci_set_master - enables bus-mastering for device dev
4478 * @dev: the PCI device to enable
4480 * Enables bus-mastering on the device and calls pcibios_set_master()
4481 * to do the needed arch specific settings.
4483 void pci_set_master(struct pci_dev *dev)
4485 __pci_set_master(dev, true);
4486 pcibios_set_master(dev);
4488 EXPORT_SYMBOL(pci_set_master);
4491 * pci_clear_master - disables bus-mastering for device dev
4492 * @dev: the PCI device to disable
4494 void pci_clear_master(struct pci_dev *dev)
4496 __pci_set_master(dev, false);
4498 EXPORT_SYMBOL(pci_clear_master);
4501 * pci_set_cacheline_size - ensure the CACHE_LINE_SIZE register is programmed
4502 * @dev: the PCI device for which MWI is to be enabled
4504 * Helper function for pci_set_mwi.
4505 * Originally copied from drivers/net/acenic.c.
4506 * Copyright 1998-2001 by Jes Sorensen, <jes@trained-monkey.org>.
4508 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
4510 int pci_set_cacheline_size(struct pci_dev *dev)
4514 if (!pci_cache_line_size)
4517 /* Validate current setting: the PCI_CACHE_LINE_SIZE must be
4518 equal to or multiple of the right value. */
4519 pci_read_config_byte(dev, PCI_CACHE_LINE_SIZE, &cacheline_size);
4520 if (cacheline_size >= pci_cache_line_size &&
4521 (cacheline_size % pci_cache_line_size) == 0)
4524 /* Write the correct value. */
4525 pci_write_config_byte(dev, PCI_CACHE_LINE_SIZE, pci_cache_line_size);
4527 pci_read_config_byte(dev, PCI_CACHE_LINE_SIZE, &cacheline_size);
4528 if (cacheline_size == pci_cache_line_size)
4531 pci_dbg(dev, "cache line size of %d is not supported\n",
4532 pci_cache_line_size << 2);
4536 EXPORT_SYMBOL_GPL(pci_set_cacheline_size);
4539 * pci_set_mwi - enables memory-write-invalidate PCI transaction
4540 * @dev: the PCI device for which MWI is enabled
4542 * Enables the Memory-Write-Invalidate transaction in %PCI_COMMAND.
4544 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
4546 int pci_set_mwi(struct pci_dev *dev)
4548 #ifdef PCI_DISABLE_MWI
4554 rc = pci_set_cacheline_size(dev);
4558 pci_read_config_word(dev, PCI_COMMAND, &cmd);
4559 if (!(cmd & PCI_COMMAND_INVALIDATE)) {
4560 pci_dbg(dev, "enabling Mem-Wr-Inval\n");
4561 cmd |= PCI_COMMAND_INVALIDATE;
4562 pci_write_config_word(dev, PCI_COMMAND, cmd);
4567 EXPORT_SYMBOL(pci_set_mwi);
4570 * pcim_set_mwi - a device-managed pci_set_mwi()
4571 * @dev: the PCI device for which MWI is enabled
4573 * Managed pci_set_mwi().
4575 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
4577 int pcim_set_mwi(struct pci_dev *dev)
4579 struct pci_devres *dr;
4581 dr = find_pci_dr(dev);
4586 return pci_set_mwi(dev);
4588 EXPORT_SYMBOL(pcim_set_mwi);
4591 * pci_try_set_mwi - enables memory-write-invalidate PCI transaction
4592 * @dev: the PCI device for which MWI is enabled
4594 * Enables the Memory-Write-Invalidate transaction in %PCI_COMMAND.
4595 * Callers are not required to check the return value.
4597 * RETURNS: An appropriate -ERRNO error value on error, or zero for success.
4599 int pci_try_set_mwi(struct pci_dev *dev)
4601 #ifdef PCI_DISABLE_MWI
4604 return pci_set_mwi(dev);
4607 EXPORT_SYMBOL(pci_try_set_mwi);
4610 * pci_clear_mwi - disables Memory-Write-Invalidate for device dev
4611 * @dev: the PCI device to disable
4613 * Disables PCI Memory-Write-Invalidate transaction on the device
4615 void pci_clear_mwi(struct pci_dev *dev)
4617 #ifndef PCI_DISABLE_MWI
4620 pci_read_config_word(dev, PCI_COMMAND, &cmd);
4621 if (cmd & PCI_COMMAND_INVALIDATE) {
4622 cmd &= ~PCI_COMMAND_INVALIDATE;
4623 pci_write_config_word(dev, PCI_COMMAND, cmd);
4627 EXPORT_SYMBOL(pci_clear_mwi);
4630 * pci_disable_parity - disable parity checking for device
4631 * @dev: the PCI device to operate on
4633 * Disable parity checking for device @dev
4635 void pci_disable_parity(struct pci_dev *dev)
4639 pci_read_config_word(dev, PCI_COMMAND, &cmd);
4640 if (cmd & PCI_COMMAND_PARITY) {
4641 cmd &= ~PCI_COMMAND_PARITY;
4642 pci_write_config_word(dev, PCI_COMMAND, cmd);
4647 * pci_intx - enables/disables PCI INTx for device dev
4648 * @pdev: the PCI device to operate on
4649 * @enable: boolean: whether to enable or disable PCI INTx
4651 * Enables/disables PCI INTx for device @pdev
4653 void pci_intx(struct pci_dev *pdev, int enable)
4655 u16 pci_command, new;
4657 pci_read_config_word(pdev, PCI_COMMAND, &pci_command);
4660 new = pci_command & ~PCI_COMMAND_INTX_DISABLE;
4662 new = pci_command | PCI_COMMAND_INTX_DISABLE;
4664 if (new != pci_command) {
4665 struct pci_devres *dr;
4667 pci_write_config_word(pdev, PCI_COMMAND, new);
4669 dr = find_pci_dr(pdev);
4670 if (dr && !dr->restore_intx) {
4671 dr->restore_intx = 1;
4672 dr->orig_intx = !enable;
4676 EXPORT_SYMBOL_GPL(pci_intx);
4678 static bool pci_check_and_set_intx_mask(struct pci_dev *dev, bool mask)
4680 struct pci_bus *bus = dev->bus;
4681 bool mask_updated = true;
4682 u32 cmd_status_dword;
4683 u16 origcmd, newcmd;
4684 unsigned long flags;
4688 * We do a single dword read to retrieve both command and status.
4689 * Document assumptions that make this possible.
4691 BUILD_BUG_ON(PCI_COMMAND % 4);
4692 BUILD_BUG_ON(PCI_COMMAND + 2 != PCI_STATUS);
4694 raw_spin_lock_irqsave(&pci_lock, flags);
4696 bus->ops->read(bus, dev->devfn, PCI_COMMAND, 4, &cmd_status_dword);
4698 irq_pending = (cmd_status_dword >> 16) & PCI_STATUS_INTERRUPT;
4701 * Check interrupt status register to see whether our device
4702 * triggered the interrupt (when masking) or the next IRQ is
4703 * already pending (when unmasking).
4705 if (mask != irq_pending) {
4706 mask_updated = false;
4710 origcmd = cmd_status_dword;
4711 newcmd = origcmd & ~PCI_COMMAND_INTX_DISABLE;
4713 newcmd |= PCI_COMMAND_INTX_DISABLE;
4714 if (newcmd != origcmd)
4715 bus->ops->write(bus, dev->devfn, PCI_COMMAND, 2, newcmd);
4718 raw_spin_unlock_irqrestore(&pci_lock, flags);
4720 return mask_updated;
4724 * pci_check_and_mask_intx - mask INTx on pending interrupt
4725 * @dev: the PCI device to operate on
4727 * Check if the device dev has its INTx line asserted, mask it and return
4728 * true in that case. False is returned if no interrupt was pending.
4730 bool pci_check_and_mask_intx(struct pci_dev *dev)
4732 return pci_check_and_set_intx_mask(dev, true);
4734 EXPORT_SYMBOL_GPL(pci_check_and_mask_intx);
4737 * pci_check_and_unmask_intx - unmask INTx if no interrupt is pending
4738 * @dev: the PCI device to operate on
4740 * Check if the device dev has its INTx line asserted, unmask it if not and
4741 * return true. False is returned and the mask remains active if there was
4742 * still an interrupt pending.
4744 bool pci_check_and_unmask_intx(struct pci_dev *dev)
4746 return pci_check_and_set_intx_mask(dev, false);
4748 EXPORT_SYMBOL_GPL(pci_check_and_unmask_intx);
4751 * pci_wait_for_pending_transaction - wait for pending transaction
4752 * @dev: the PCI device to operate on
4754 * Return 0 if transaction is pending 1 otherwise.
4756 int pci_wait_for_pending_transaction(struct pci_dev *dev)
4758 if (!pci_is_pcie(dev))
4761 return pci_wait_for_pending(dev, pci_pcie_cap(dev) + PCI_EXP_DEVSTA,
4762 PCI_EXP_DEVSTA_TRPND);
4764 EXPORT_SYMBOL(pci_wait_for_pending_transaction);
4767 * pcie_flr - initiate a PCIe function level reset
4768 * @dev: device to reset
4770 * Initiate a function level reset unconditionally on @dev without
4771 * checking any flags and DEVCAP
4773 int pcie_flr(struct pci_dev *dev)
4775 if (!pci_wait_for_pending_transaction(dev))
4776 pci_err(dev, "timed out waiting for pending transaction; performing function level reset anyway\n");
4778 pcie_capability_set_word(dev, PCI_EXP_DEVCTL, PCI_EXP_DEVCTL_BCR_FLR);
4784 * Per PCIe r4.0, sec 6.6.2, a device must complete an FLR within
4785 * 100ms, but may silently discard requests while the FLR is in
4786 * progress. Wait 100ms before trying to access the device.
4790 return pci_dev_wait(dev, "FLR", PCIE_RESET_READY_POLL_MS);
4792 EXPORT_SYMBOL_GPL(pcie_flr);
4795 * pcie_reset_flr - initiate a PCIe function level reset
4796 * @dev: device to reset
4797 * @probe: if true, return 0 if device can be reset this way
4799 * Initiate a function level reset on @dev.
4801 int pcie_reset_flr(struct pci_dev *dev, bool probe)
4803 if (dev->dev_flags & PCI_DEV_FLAGS_NO_FLR_RESET)
4806 if (!(dev->devcap & PCI_EXP_DEVCAP_FLR))
4812 return pcie_flr(dev);
4814 EXPORT_SYMBOL_GPL(pcie_reset_flr);
4816 static int pci_af_flr(struct pci_dev *dev, bool probe)
4821 pos = pci_find_capability(dev, PCI_CAP_ID_AF);
4825 if (dev->dev_flags & PCI_DEV_FLAGS_NO_FLR_RESET)
4828 pci_read_config_byte(dev, pos + PCI_AF_CAP, &cap);
4829 if (!(cap & PCI_AF_CAP_TP) || !(cap & PCI_AF_CAP_FLR))
4836 * Wait for Transaction Pending bit to clear. A word-aligned test
4837 * is used, so we use the control offset rather than status and shift
4838 * the test bit to match.
4840 if (!pci_wait_for_pending(dev, pos + PCI_AF_CTRL,
4841 PCI_AF_STATUS_TP << 8))
4842 pci_err(dev, "timed out waiting for pending transaction; performing AF function level reset anyway\n");
4844 pci_write_config_byte(dev, pos + PCI_AF_CTRL, PCI_AF_CTRL_FLR);
4850 * Per Advanced Capabilities for Conventional PCI ECN, 13 April 2006,
4851 * updated 27 July 2006; a device must complete an FLR within
4852 * 100ms, but may silently discard requests while the FLR is in
4853 * progress. Wait 100ms before trying to access the device.
4857 return pci_dev_wait(dev, "AF_FLR", PCIE_RESET_READY_POLL_MS);
4861 * pci_pm_reset - Put device into PCI_D3 and back into PCI_D0.
4862 * @dev: Device to reset.
4863 * @probe: if true, return 0 if the device can be reset this way.
4865 * If @dev supports native PCI PM and its PCI_PM_CTRL_NO_SOFT_RESET flag is
4866 * unset, it will be reinitialized internally when going from PCI_D3hot to
4867 * PCI_D0. If that's the case and the device is not in a low-power state
4868 * already, force it into PCI_D3hot and back to PCI_D0, causing it to be reset.
4870 * NOTE: This causes the caller to sleep for twice the device power transition
4871 * cooldown period, which for the D0->D3hot and D3hot->D0 transitions is 10 ms
4872 * by default (i.e. unless the @dev's d3hot_delay field has a different value).
4873 * Moreover, only devices in D0 can be reset by this function.
4875 static int pci_pm_reset(struct pci_dev *dev, bool probe)
4879 if (!dev->pm_cap || dev->dev_flags & PCI_DEV_FLAGS_NO_PM_RESET)
4882 pci_read_config_word(dev, dev->pm_cap + PCI_PM_CTRL, &csr);
4883 if (csr & PCI_PM_CTRL_NO_SOFT_RESET)
4889 if (dev->current_state != PCI_D0)
4892 csr &= ~PCI_PM_CTRL_STATE_MASK;
4894 pci_write_config_word(dev, dev->pm_cap + PCI_PM_CTRL, csr);
4895 pci_dev_d3_sleep(dev);
4897 csr &= ~PCI_PM_CTRL_STATE_MASK;
4899 pci_write_config_word(dev, dev->pm_cap + PCI_PM_CTRL, csr);
4900 pci_dev_d3_sleep(dev);
4902 return pci_dev_wait(dev, "PM D3hot->D0", PCIE_RESET_READY_POLL_MS);
4906 * pcie_wait_for_link_status - Wait for link status change
4907 * @pdev: Device whose link to wait for.
4908 * @use_lt: Use the LT bit if TRUE, or the DLLLA bit if FALSE.
4909 * @active: Waiting for active or inactive?
4911 * Return 0 if successful, or -ETIMEDOUT if status has not changed within
4912 * PCIE_LINK_RETRAIN_TIMEOUT_MS milliseconds.
4914 static int pcie_wait_for_link_status(struct pci_dev *pdev,
4915 bool use_lt, bool active)
4917 u16 lnksta_mask, lnksta_match;
4918 unsigned long end_jiffies;
4921 lnksta_mask = use_lt ? PCI_EXP_LNKSTA_LT : PCI_EXP_LNKSTA_DLLLA;
4922 lnksta_match = active ? lnksta_mask : 0;
4924 end_jiffies = jiffies + msecs_to_jiffies(PCIE_LINK_RETRAIN_TIMEOUT_MS);
4926 pcie_capability_read_word(pdev, PCI_EXP_LNKSTA, &lnksta);
4927 if ((lnksta & lnksta_mask) == lnksta_match)
4930 } while (time_before(jiffies, end_jiffies));
4936 * pcie_retrain_link - Request a link retrain and wait for it to complete
4937 * @pdev: Device whose link to retrain.
4938 * @use_lt: Use the LT bit if TRUE, or the DLLLA bit if FALSE, for status.
4940 * Retrain completion status is retrieved from the Link Status Register
4941 * according to @use_lt. It is not verified whether the use of the DLLLA
4944 * Return 0 if successful, or -ETIMEDOUT if training has not completed
4945 * within PCIE_LINK_RETRAIN_TIMEOUT_MS milliseconds.
4947 int pcie_retrain_link(struct pci_dev *pdev, bool use_lt)
4952 * Ensure the updated LNKCTL parameters are used during link
4953 * training by checking that there is no ongoing link training to
4954 * avoid LTSSM race as recommended in Implementation Note at the
4955 * end of PCIe r6.0.1 sec 7.5.3.7.
4957 rc = pcie_wait_for_link_status(pdev, use_lt, !use_lt);
4961 pcie_capability_set_word(pdev, PCI_EXP_LNKCTL, PCI_EXP_LNKCTL_RL);
4962 if (pdev->clear_retrain_link) {
4964 * Due to an erratum in some devices the Retrain Link bit
4965 * needs to be cleared again manually to allow the link
4966 * training to succeed.
4968 pcie_capability_clear_word(pdev, PCI_EXP_LNKCTL, PCI_EXP_LNKCTL_RL);
4971 return pcie_wait_for_link_status(pdev, use_lt, !use_lt);
4975 * pcie_wait_for_link_delay - Wait until link is active or inactive
4976 * @pdev: Bridge device
4977 * @active: waiting for active or inactive?
4978 * @delay: Delay to wait after link has become active (in ms)
4980 * Use this to wait till link becomes active or inactive.
4982 static bool pcie_wait_for_link_delay(struct pci_dev *pdev, bool active,
4988 * Some controllers might not implement link active reporting. In this
4989 * case, we wait for 1000 ms + any delay requested by the caller.
4991 if (!pdev->link_active_reporting) {
4992 msleep(PCIE_LINK_RETRAIN_TIMEOUT_MS + delay);
4997 * PCIe r4.0 sec 6.6.1, a component must enter LTSSM Detect within 20ms,
4998 * after which we should expect an link active if the reset was
4999 * successful. If so, software must wait a minimum 100ms before sending
5000 * configuration requests to devices downstream this port.
5002 * If the link fails to activate, either the device was physically
5003 * removed or the link is permanently failed.
5007 rc = pcie_wait_for_link_status(pdev, false, active);
5010 rc = pcie_failed_link_retrain(pdev);
5025 * pcie_wait_for_link - Wait until link is active or inactive
5026 * @pdev: Bridge device
5027 * @active: waiting for active or inactive?
5029 * Use this to wait till link becomes active or inactive.
5031 bool pcie_wait_for_link(struct pci_dev *pdev, bool active)
5033 return pcie_wait_for_link_delay(pdev, active, 100);
5037 * Find maximum D3cold delay required by all the devices on the bus. The
5038 * spec says 100 ms, but firmware can lower it and we allow drivers to
5039 * increase it as well.
5041 * Called with @pci_bus_sem locked for reading.
5043 static int pci_bus_max_d3cold_delay(const struct pci_bus *bus)
5045 const struct pci_dev *pdev;
5046 int min_delay = 100;
5049 list_for_each_entry(pdev, &bus->devices, bus_list) {
5050 if (pdev->d3cold_delay < min_delay)
5051 min_delay = pdev->d3cold_delay;
5052 if (pdev->d3cold_delay > max_delay)
5053 max_delay = pdev->d3cold_delay;
5056 return max(min_delay, max_delay);
5060 * pci_bridge_wait_for_secondary_bus - Wait for secondary bus to be accessible
5062 * @reset_type: reset type in human-readable form
5064 * Handle necessary delays before access to the devices on the secondary
5065 * side of the bridge are permitted after D3cold to D0 transition
5066 * or Conventional Reset.
5068 * For PCIe this means the delays in PCIe 5.0 section 6.6.1. For
5069 * conventional PCI it means Tpvrh + Trhfa specified in PCI 3.0 section
5072 * Return 0 on success or -ENOTTY if the first device on the secondary bus
5073 * failed to become accessible.
5075 int pci_bridge_wait_for_secondary_bus(struct pci_dev *dev, char *reset_type)
5077 struct pci_dev *child;
5080 if (pci_dev_is_disconnected(dev))
5083 if (!pci_is_bridge(dev))
5086 down_read(&pci_bus_sem);
5089 * We only deal with devices that are present currently on the bus.
5090 * For any hot-added devices the access delay is handled in pciehp
5091 * board_added(). In case of ACPI hotplug the firmware is expected
5092 * to configure the devices before OS is notified.
5094 if (!dev->subordinate || list_empty(&dev->subordinate->devices)) {
5095 up_read(&pci_bus_sem);
5099 /* Take d3cold_delay requirements into account */
5100 delay = pci_bus_max_d3cold_delay(dev->subordinate);
5102 up_read(&pci_bus_sem);
5106 child = list_first_entry(&dev->subordinate->devices, struct pci_dev,
5108 up_read(&pci_bus_sem);
5111 * Conventional PCI and PCI-X we need to wait Tpvrh + Trhfa before
5112 * accessing the device after reset (that is 1000 ms + 100 ms).
5114 if (!pci_is_pcie(dev)) {
5115 pci_dbg(dev, "waiting %d ms for secondary bus\n", 1000 + delay);
5116 msleep(1000 + delay);
5121 * For PCIe downstream and root ports that do not support speeds
5122 * greater than 5 GT/s need to wait minimum 100 ms. For higher
5123 * speeds (gen3) we need to wait first for the data link layer to
5126 * However, 100 ms is the minimum and the PCIe spec says the
5127 * software must allow at least 1s before it can determine that the
5128 * device that did not respond is a broken device. Also device can
5129 * take longer than that to respond if it indicates so through Request
5130 * Retry Status completions.
5132 * Therefore we wait for 100 ms and check for the device presence
5133 * until the timeout expires.
5135 if (!pcie_downstream_port(dev))
5138 if (pcie_get_speed_cap(dev) <= PCIE_SPEED_5_0GT) {
5141 pci_dbg(dev, "waiting %d ms for downstream link\n", delay);
5144 if (!pci_dev_wait(child, reset_type, PCI_RESET_WAIT - delay))
5148 * If the port supports active link reporting we now check
5149 * whether the link is active and if not bail out early with
5150 * the assumption that the device is not present anymore.
5152 if (!dev->link_active_reporting)
5155 pcie_capability_read_word(dev, PCI_EXP_LNKSTA, &status);
5156 if (!(status & PCI_EXP_LNKSTA_DLLLA))
5159 return pci_dev_wait(child, reset_type,
5160 PCIE_RESET_READY_POLL_MS - PCI_RESET_WAIT);
5163 pci_dbg(dev, "waiting %d ms for downstream link, after activation\n",
5165 if (!pcie_wait_for_link_delay(dev, true, delay)) {
5166 /* Did not train, no need to wait any further */
5167 pci_info(dev, "Data Link Layer Link Active not set in 1000 msec\n");
5171 return pci_dev_wait(child, reset_type,
5172 PCIE_RESET_READY_POLL_MS - delay);
5175 void pci_reset_secondary_bus(struct pci_dev *dev)
5179 pci_read_config_word(dev, PCI_BRIDGE_CONTROL, &ctrl);
5180 ctrl |= PCI_BRIDGE_CTL_BUS_RESET;
5181 pci_write_config_word(dev, PCI_BRIDGE_CONTROL, ctrl);
5184 * PCI spec v3.0 7.6.4.2 requires minimum Trst of 1ms. Double
5185 * this to 2ms to ensure that we meet the minimum requirement.
5189 ctrl &= ~PCI_BRIDGE_CTL_BUS_RESET;
5190 pci_write_config_word(dev, PCI_BRIDGE_CONTROL, ctrl);
5193 void __weak pcibios_reset_secondary_bus(struct pci_dev *dev)
5195 pci_reset_secondary_bus(dev);
5199 * pci_bridge_secondary_bus_reset - Reset the secondary bus on a PCI bridge.
5200 * @dev: Bridge device
5202 * Use the bridge control register to assert reset on the secondary bus.
5203 * Devices on the secondary bus are left in power-on state.
5205 int pci_bridge_secondary_bus_reset(struct pci_dev *dev)
5207 pcibios_reset_secondary_bus(dev);
5209 return pci_bridge_wait_for_secondary_bus(dev, "bus reset");
5211 EXPORT_SYMBOL_GPL(pci_bridge_secondary_bus_reset);
5213 static int pci_parent_bus_reset(struct pci_dev *dev, bool probe)
5215 struct pci_dev *pdev;
5217 if (pci_is_root_bus(dev->bus) || dev->subordinate ||
5218 !dev->bus->self || dev->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET)
5221 list_for_each_entry(pdev, &dev->bus->devices, bus_list)
5228 return pci_bridge_secondary_bus_reset(dev->bus->self);
5231 static int pci_reset_hotplug_slot(struct hotplug_slot *hotplug, bool probe)
5235 if (!hotplug || !try_module_get(hotplug->owner))
5238 if (hotplug->ops->reset_slot)
5239 rc = hotplug->ops->reset_slot(hotplug, probe);
5241 module_put(hotplug->owner);
5246 static int pci_dev_reset_slot_function(struct pci_dev *dev, bool probe)
5248 if (dev->multifunction || dev->subordinate || !dev->slot ||
5249 dev->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET)
5252 return pci_reset_hotplug_slot(dev->slot->hotplug, probe);
5255 static int pci_reset_bus_function(struct pci_dev *dev, bool probe)
5259 rc = pci_dev_reset_slot_function(dev, probe);
5262 return pci_parent_bus_reset(dev, probe);
5265 void pci_dev_lock(struct pci_dev *dev)
5267 /* block PM suspend, driver probe, etc. */
5268 device_lock(&dev->dev);
5269 pci_cfg_access_lock(dev);
5271 EXPORT_SYMBOL_GPL(pci_dev_lock);
5273 /* Return 1 on successful lock, 0 on contention */
5274 int pci_dev_trylock(struct pci_dev *dev)
5276 if (device_trylock(&dev->dev)) {
5277 if (pci_cfg_access_trylock(dev))
5279 device_unlock(&dev->dev);
5284 EXPORT_SYMBOL_GPL(pci_dev_trylock);
5286 void pci_dev_unlock(struct pci_dev *dev)
5288 pci_cfg_access_unlock(dev);
5289 device_unlock(&dev->dev);
5291 EXPORT_SYMBOL_GPL(pci_dev_unlock);
5293 static void pci_dev_save_and_disable(struct pci_dev *dev)
5295 const struct pci_error_handlers *err_handler =
5296 dev->driver ? dev->driver->err_handler : NULL;
5299 * dev->driver->err_handler->reset_prepare() is protected against
5300 * races with ->remove() by the device lock, which must be held by
5303 if (err_handler && err_handler->reset_prepare)
5304 err_handler->reset_prepare(dev);
5307 * Wake-up device prior to save. PM registers default to D0 after
5308 * reset and a simple register restore doesn't reliably return
5309 * to a non-D0 state anyway.
5311 pci_set_power_state(dev, PCI_D0);
5313 pci_save_state(dev);
5315 * Disable the device by clearing the Command register, except for
5316 * INTx-disable which is set. This not only disables MMIO and I/O port
5317 * BARs, but also prevents the device from being Bus Master, preventing
5318 * DMA from the device including MSI/MSI-X interrupts. For PCI 2.3
5319 * compliant devices, INTx-disable prevents legacy interrupts.
5321 pci_write_config_word(dev, PCI_COMMAND, PCI_COMMAND_INTX_DISABLE);
5324 static void pci_dev_restore(struct pci_dev *dev)
5326 const struct pci_error_handlers *err_handler =
5327 dev->driver ? dev->driver->err_handler : NULL;
5329 pci_restore_state(dev);
5332 * dev->driver->err_handler->reset_done() is protected against
5333 * races with ->remove() by the device lock, which must be held by
5336 if (err_handler && err_handler->reset_done)
5337 err_handler->reset_done(dev);
5340 /* dev->reset_methods[] is a 0-terminated list of indices into this array */
5341 static const struct pci_reset_fn_method pci_reset_fn_methods[] = {
5343 { pci_dev_specific_reset, .name = "device_specific" },
5344 { pci_dev_acpi_reset, .name = "acpi" },
5345 { pcie_reset_flr, .name = "flr" },
5346 { pci_af_flr, .name = "af_flr" },
5347 { pci_pm_reset, .name = "pm" },
5348 { pci_reset_bus_function, .name = "bus" },
5351 static ssize_t reset_method_show(struct device *dev,
5352 struct device_attribute *attr, char *buf)
5354 struct pci_dev *pdev = to_pci_dev(dev);
5358 for (i = 0; i < PCI_NUM_RESET_METHODS; i++) {
5359 m = pdev->reset_methods[i];
5363 len += sysfs_emit_at(buf, len, "%s%s", len ? " " : "",
5364 pci_reset_fn_methods[m].name);
5368 len += sysfs_emit_at(buf, len, "\n");
5373 static int reset_method_lookup(const char *name)
5377 for (m = 1; m < PCI_NUM_RESET_METHODS; m++) {
5378 if (sysfs_streq(name, pci_reset_fn_methods[m].name))
5382 return 0; /* not found */
5385 static ssize_t reset_method_store(struct device *dev,
5386 struct device_attribute *attr,
5387 const char *buf, size_t count)
5389 struct pci_dev *pdev = to_pci_dev(dev);
5390 char *options, *name;
5392 u8 reset_methods[PCI_NUM_RESET_METHODS] = { 0 };
5394 if (sysfs_streq(buf, "")) {
5395 pdev->reset_methods[0] = 0;
5396 pci_warn(pdev, "All device reset methods disabled by user");
5400 if (sysfs_streq(buf, "default")) {
5401 pci_init_reset_methods(pdev);
5405 options = kstrndup(buf, count, GFP_KERNEL);
5410 while ((name = strsep(&options, " ")) != NULL) {
5411 if (sysfs_streq(name, ""))
5416 m = reset_method_lookup(name);
5418 pci_err(pdev, "Invalid reset method '%s'", name);
5422 if (pci_reset_fn_methods[m].reset_fn(pdev, PCI_RESET_PROBE)) {
5423 pci_err(pdev, "Unsupported reset method '%s'", name);
5427 if (n == PCI_NUM_RESET_METHODS - 1) {
5428 pci_err(pdev, "Too many reset methods\n");
5432 reset_methods[n++] = m;
5435 reset_methods[n] = 0;
5437 /* Warn if dev-specific supported but not highest priority */
5438 if (pci_reset_fn_methods[1].reset_fn(pdev, PCI_RESET_PROBE) == 0 &&
5439 reset_methods[0] != 1)
5440 pci_warn(pdev, "Device-specific reset disabled/de-prioritized by user");
5441 memcpy(pdev->reset_methods, reset_methods, sizeof(pdev->reset_methods));
5446 /* Leave previous methods unchanged */
5450 static DEVICE_ATTR_RW(reset_method);
5452 static struct attribute *pci_dev_reset_method_attrs[] = {
5453 &dev_attr_reset_method.attr,
5457 static umode_t pci_dev_reset_method_attr_is_visible(struct kobject *kobj,
5458 struct attribute *a, int n)
5460 struct pci_dev *pdev = to_pci_dev(kobj_to_dev(kobj));
5462 if (!pci_reset_supported(pdev))
5468 const struct attribute_group pci_dev_reset_method_attr_group = {
5469 .attrs = pci_dev_reset_method_attrs,
5470 .is_visible = pci_dev_reset_method_attr_is_visible,
5474 * __pci_reset_function_locked - reset a PCI device function while holding
5475 * the @dev mutex lock.
5476 * @dev: PCI device to reset
5478 * Some devices allow an individual function to be reset without affecting
5479 * other functions in the same device. The PCI device must be responsive
5480 * to PCI config space in order to use this function.
5482 * The device function is presumed to be unused and the caller is holding
5483 * the device mutex lock when this function is called.
5485 * Resetting the device will make the contents of PCI configuration space
5486 * random, so any caller of this must be prepared to reinitialise the
5487 * device including MSI, bus mastering, BARs, decoding IO and memory spaces,
5490 * Returns 0 if the device function was successfully reset or negative if the
5491 * device doesn't support resetting a single function.
5493 int __pci_reset_function_locked(struct pci_dev *dev)
5500 * A reset method returns -ENOTTY if it doesn't support this device and
5501 * we should try the next method.
5503 * If it returns 0 (success), we're finished. If it returns any other
5504 * error, we're also finished: this indicates that further reset
5505 * mechanisms might be broken on the device.
5507 for (i = 0; i < PCI_NUM_RESET_METHODS; i++) {
5508 m = dev->reset_methods[i];
5512 rc = pci_reset_fn_methods[m].reset_fn(dev, PCI_RESET_DO_RESET);
5521 EXPORT_SYMBOL_GPL(__pci_reset_function_locked);
5524 * pci_init_reset_methods - check whether device can be safely reset
5525 * and store supported reset mechanisms.
5526 * @dev: PCI device to check for reset mechanisms
5528 * Some devices allow an individual function to be reset without affecting
5529 * other functions in the same device. The PCI device must be in D0-D3hot
5532 * Stores reset mechanisms supported by device in reset_methods byte array
5533 * which is a member of struct pci_dev.
5535 void pci_init_reset_methods(struct pci_dev *dev)
5539 BUILD_BUG_ON(ARRAY_SIZE(pci_reset_fn_methods) != PCI_NUM_RESET_METHODS);
5544 for (m = 1; m < PCI_NUM_RESET_METHODS; m++) {
5545 rc = pci_reset_fn_methods[m].reset_fn(dev, PCI_RESET_PROBE);
5547 dev->reset_methods[i++] = m;
5548 else if (rc != -ENOTTY)
5552 dev->reset_methods[i] = 0;
5556 * pci_reset_function - quiesce and reset a PCI device function
5557 * @dev: PCI device to reset
5559 * Some devices allow an individual function to be reset without affecting
5560 * other functions in the same device. The PCI device must be responsive
5561 * to PCI config space in order to use this function.
5563 * This function does not just reset the PCI portion of a device, but
5564 * clears all the state associated with the device. This function differs
5565 * from __pci_reset_function_locked() in that it saves and restores device state
5566 * over the reset and takes the PCI device lock.
5568 * Returns 0 if the device function was successfully reset or negative if the
5569 * device doesn't support resetting a single function.
5571 int pci_reset_function(struct pci_dev *dev)
5575 if (!pci_reset_supported(dev))
5579 pci_dev_save_and_disable(dev);
5581 rc = __pci_reset_function_locked(dev);
5583 pci_dev_restore(dev);
5584 pci_dev_unlock(dev);
5588 EXPORT_SYMBOL_GPL(pci_reset_function);
5591 * pci_reset_function_locked - quiesce and reset a PCI device function
5592 * @dev: PCI device to reset
5594 * Some devices allow an individual function to be reset without affecting
5595 * other functions in the same device. The PCI device must be responsive
5596 * to PCI config space in order to use this function.
5598 * This function does not just reset the PCI portion of a device, but
5599 * clears all the state associated with the device. This function differs
5600 * from __pci_reset_function_locked() in that it saves and restores device state
5601 * over the reset. It also differs from pci_reset_function() in that it
5602 * requires the PCI device lock to be held.
5604 * Returns 0 if the device function was successfully reset or negative if the
5605 * device doesn't support resetting a single function.
5607 int pci_reset_function_locked(struct pci_dev *dev)
5611 if (!pci_reset_supported(dev))
5614 pci_dev_save_and_disable(dev);
5616 rc = __pci_reset_function_locked(dev);
5618 pci_dev_restore(dev);
5622 EXPORT_SYMBOL_GPL(pci_reset_function_locked);
5625 * pci_try_reset_function - quiesce and reset a PCI device function
5626 * @dev: PCI device to reset
5628 * Same as above, except return -EAGAIN if unable to lock device.
5630 int pci_try_reset_function(struct pci_dev *dev)
5634 if (!pci_reset_supported(dev))
5637 if (!pci_dev_trylock(dev))
5640 pci_dev_save_and_disable(dev);
5641 rc = __pci_reset_function_locked(dev);
5642 pci_dev_restore(dev);
5643 pci_dev_unlock(dev);
5647 EXPORT_SYMBOL_GPL(pci_try_reset_function);
5649 /* Do any devices on or below this bus prevent a bus reset? */
5650 static bool pci_bus_resettable(struct pci_bus *bus)
5652 struct pci_dev *dev;
5655 if (bus->self && (bus->self->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET))
5658 list_for_each_entry(dev, &bus->devices, bus_list) {
5659 if (dev->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET ||
5660 (dev->subordinate && !pci_bus_resettable(dev->subordinate)))
5667 /* Lock devices from the top of the tree down */
5668 static void pci_bus_lock(struct pci_bus *bus)
5670 struct pci_dev *dev;
5672 list_for_each_entry(dev, &bus->devices, bus_list) {
5674 if (dev->subordinate)
5675 pci_bus_lock(dev->subordinate);
5679 /* Unlock devices from the bottom of the tree up */
5680 static void pci_bus_unlock(struct pci_bus *bus)
5682 struct pci_dev *dev;
5684 list_for_each_entry(dev, &bus->devices, bus_list) {
5685 if (dev->subordinate)
5686 pci_bus_unlock(dev->subordinate);
5687 pci_dev_unlock(dev);
5691 /* Return 1 on successful lock, 0 on contention */
5692 static int pci_bus_trylock(struct pci_bus *bus)
5694 struct pci_dev *dev;
5696 list_for_each_entry(dev, &bus->devices, bus_list) {
5697 if (!pci_dev_trylock(dev))
5699 if (dev->subordinate) {
5700 if (!pci_bus_trylock(dev->subordinate)) {
5701 pci_dev_unlock(dev);
5709 list_for_each_entry_continue_reverse(dev, &bus->devices, bus_list) {
5710 if (dev->subordinate)
5711 pci_bus_unlock(dev->subordinate);
5712 pci_dev_unlock(dev);
5717 /* Do any devices on or below this slot prevent a bus reset? */
5718 static bool pci_slot_resettable(struct pci_slot *slot)
5720 struct pci_dev *dev;
5722 if (slot->bus->self &&
5723 (slot->bus->self->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET))
5726 list_for_each_entry(dev, &slot->bus->devices, bus_list) {
5727 if (!dev->slot || dev->slot != slot)
5729 if (dev->dev_flags & PCI_DEV_FLAGS_NO_BUS_RESET ||
5730 (dev->subordinate && !pci_bus_resettable(dev->subordinate)))
5737 /* Lock devices from the top of the tree down */
5738 static void pci_slot_lock(struct pci_slot *slot)
5740 struct pci_dev *dev;
5742 list_for_each_entry(dev, &slot->bus->devices, bus_list) {
5743 if (!dev->slot || dev->slot != slot)
5746 if (dev->subordinate)
5747 pci_bus_lock(dev->subordinate);
5751 /* Unlock devices from the bottom of the tree up */
5752 static void pci_slot_unlock(struct pci_slot *slot)
5754 struct pci_dev *dev;
5756 list_for_each_entry(dev, &slot->bus->devices, bus_list) {
5757 if (!dev->slot || dev->slot != slot)
5759 if (dev->subordinate)
5760 pci_bus_unlock(dev->subordinate);
5761 pci_dev_unlock(dev);
5765 /* Return 1 on successful lock, 0 on contention */
5766 static int pci_slot_trylock(struct pci_slot *slot)
5768 struct pci_dev *dev;
5770 list_for_each_entry(dev, &slot->bus->devices, bus_list) {
5771 if (!dev->slot || dev->slot != slot)
5773 if (!pci_dev_trylock(dev))
5775 if (dev->subordinate) {
5776 if (!pci_bus_trylock(dev->subordinate)) {
5777 pci_dev_unlock(dev);
5785 list_for_each_entry_continue_reverse(dev,
5786 &slot->bus->devices, bus_list) {
5787 if (!dev->slot || dev->slot != slot)
5789 if (dev->subordinate)
5790 pci_bus_unlock(dev->subordinate);
5791 pci_dev_unlock(dev);
5797 * Save and disable devices from the top of the tree down while holding
5798 * the @dev mutex lock for the entire tree.
5800 static void pci_bus_save_and_disable_locked(struct pci_bus *bus)
5802 struct pci_dev *dev;
5804 list_for_each_entry(dev, &bus->devices, bus_list) {
5805 pci_dev_save_and_disable(dev);
5806 if (dev->subordinate)
5807 pci_bus_save_and_disable_locked(dev->subordinate);
5812 * Restore devices from top of the tree down while holding @dev mutex lock
5813 * for the entire tree. Parent bridges need to be restored before we can
5814 * get to subordinate devices.
5816 static void pci_bus_restore_locked(struct pci_bus *bus)
5818 struct pci_dev *dev;
5820 list_for_each_entry(dev, &bus->devices, bus_list) {
5821 pci_dev_restore(dev);
5822 if (dev->subordinate)
5823 pci_bus_restore_locked(dev->subordinate);
5828 * Save and disable devices from the top of the tree down while holding
5829 * the @dev mutex lock for the entire tree.
5831 static void pci_slot_save_and_disable_locked(struct pci_slot *slot)
5833 struct pci_dev *dev;
5835 list_for_each_entry(dev, &slot->bus->devices, bus_list) {
5836 if (!dev->slot || dev->slot != slot)
5838 pci_dev_save_and_disable(dev);
5839 if (dev->subordinate)
5840 pci_bus_save_and_disable_locked(dev->subordinate);
5845 * Restore devices from top of the tree down while holding @dev mutex lock
5846 * for the entire tree. Parent bridges need to be restored before we can
5847 * get to subordinate devices.
5849 static void pci_slot_restore_locked(struct pci_slot *slot)
5851 struct pci_dev *dev;
5853 list_for_each_entry(dev, &slot->bus->devices, bus_list) {
5854 if (!dev->slot || dev->slot != slot)
5856 pci_dev_restore(dev);
5857 if (dev->subordinate)
5858 pci_bus_restore_locked(dev->subordinate);
5862 static int pci_slot_reset(struct pci_slot *slot, bool probe)
5866 if (!slot || !pci_slot_resettable(slot))
5870 pci_slot_lock(slot);
5874 rc = pci_reset_hotplug_slot(slot->hotplug, probe);
5877 pci_slot_unlock(slot);
5883 * pci_probe_reset_slot - probe whether a PCI slot can be reset
5884 * @slot: PCI slot to probe
5886 * Return 0 if slot can be reset, negative if a slot reset is not supported.
5888 int pci_probe_reset_slot(struct pci_slot *slot)
5890 return pci_slot_reset(slot, PCI_RESET_PROBE);
5892 EXPORT_SYMBOL_GPL(pci_probe_reset_slot);
5895 * __pci_reset_slot - Try to reset a PCI slot
5896 * @slot: PCI slot to reset
5898 * A PCI bus may host multiple slots, each slot may support a reset mechanism
5899 * independent of other slots. For instance, some slots may support slot power
5900 * control. In the case of a 1:1 bus to slot architecture, this function may
5901 * wrap the bus reset to avoid spurious slot related events such as hotplug.
5902 * Generally a slot reset should be attempted before a bus reset. All of the
5903 * function of the slot and any subordinate buses behind the slot are reset
5904 * through this function. PCI config space of all devices in the slot and
5905 * behind the slot is saved before and restored after reset.
5907 * Same as above except return -EAGAIN if the slot cannot be locked
5909 static int __pci_reset_slot(struct pci_slot *slot)
5913 rc = pci_slot_reset(slot, PCI_RESET_PROBE);
5917 if (pci_slot_trylock(slot)) {
5918 pci_slot_save_and_disable_locked(slot);
5920 rc = pci_reset_hotplug_slot(slot->hotplug, PCI_RESET_DO_RESET);
5921 pci_slot_restore_locked(slot);
5922 pci_slot_unlock(slot);
5929 static int pci_bus_reset(struct pci_bus *bus, bool probe)
5933 if (!bus->self || !pci_bus_resettable(bus))
5943 ret = pci_bridge_secondary_bus_reset(bus->self);
5945 pci_bus_unlock(bus);
5951 * pci_bus_error_reset - reset the bridge's subordinate bus
5952 * @bridge: The parent device that connects to the bus to reset
5954 * This function will first try to reset the slots on this bus if the method is
5955 * available. If slot reset fails or is not available, this will fall back to a
5956 * secondary bus reset.
5958 int pci_bus_error_reset(struct pci_dev *bridge)
5960 struct pci_bus *bus = bridge->subordinate;
5961 struct pci_slot *slot;
5966 mutex_lock(&pci_slot_mutex);
5967 if (list_empty(&bus->slots))
5970 list_for_each_entry(slot, &bus->slots, list)
5971 if (pci_probe_reset_slot(slot))
5974 list_for_each_entry(slot, &bus->slots, list)
5975 if (pci_slot_reset(slot, PCI_RESET_DO_RESET))
5978 mutex_unlock(&pci_slot_mutex);
5981 mutex_unlock(&pci_slot_mutex);
5982 return pci_bus_reset(bridge->subordinate, PCI_RESET_DO_RESET);
5986 * pci_probe_reset_bus - probe whether a PCI bus can be reset
5987 * @bus: PCI bus to probe
5989 * Return 0 if bus can be reset, negative if a bus reset is not supported.
5991 int pci_probe_reset_bus(struct pci_bus *bus)
5993 return pci_bus_reset(bus, PCI_RESET_PROBE);
5995 EXPORT_SYMBOL_GPL(pci_probe_reset_bus);
5998 * __pci_reset_bus - Try to reset a PCI bus
5999 * @bus: top level PCI bus to reset
6001 * Same as above except return -EAGAIN if the bus cannot be locked
6003 static int __pci_reset_bus(struct pci_bus *bus)
6007 rc = pci_bus_reset(bus, PCI_RESET_PROBE);
6011 if (pci_bus_trylock(bus)) {
6012 pci_bus_save_and_disable_locked(bus);
6014 rc = pci_bridge_secondary_bus_reset(bus->self);
6015 pci_bus_restore_locked(bus);
6016 pci_bus_unlock(bus);
6024 * pci_reset_bus - Try to reset a PCI bus
6025 * @pdev: top level PCI device to reset via slot/bus
6027 * Same as above except return -EAGAIN if the bus cannot be locked
6029 int pci_reset_bus(struct pci_dev *pdev)
6031 return (!pci_probe_reset_slot(pdev->slot)) ?
6032 __pci_reset_slot(pdev->slot) : __pci_reset_bus(pdev->bus);
6034 EXPORT_SYMBOL_GPL(pci_reset_bus);
6037 * pcix_get_max_mmrbc - get PCI-X maximum designed memory read byte count
6038 * @dev: PCI device to query
6040 * Returns mmrbc: maximum designed memory read count in bytes or
6041 * appropriate error value.
6043 int pcix_get_max_mmrbc(struct pci_dev *dev)
6048 cap = pci_find_capability(dev, PCI_CAP_ID_PCIX);
6052 if (pci_read_config_dword(dev, cap + PCI_X_STATUS, &stat))
6055 return 512 << FIELD_GET(PCI_X_STATUS_MAX_READ, stat);
6057 EXPORT_SYMBOL(pcix_get_max_mmrbc);
6060 * pcix_get_mmrbc - get PCI-X maximum memory read byte count
6061 * @dev: PCI device to query
6063 * Returns mmrbc: maximum memory read count in bytes or appropriate error
6066 int pcix_get_mmrbc(struct pci_dev *dev)
6071 cap = pci_find_capability(dev, PCI_CAP_ID_PCIX);
6075 if (pci_read_config_word(dev, cap + PCI_X_CMD, &cmd))
6078 return 512 << FIELD_GET(PCI_X_CMD_MAX_READ, cmd);
6080 EXPORT_SYMBOL(pcix_get_mmrbc);
6083 * pcix_set_mmrbc - set PCI-X maximum memory read byte count
6084 * @dev: PCI device to query
6085 * @mmrbc: maximum memory read count in bytes
6086 * valid values are 512, 1024, 2048, 4096
6088 * If possible sets maximum memory read byte count, some bridges have errata
6089 * that prevent this.
6091 int pcix_set_mmrbc(struct pci_dev *dev, int mmrbc)
6097 if (mmrbc < 512 || mmrbc > 4096 || !is_power_of_2(mmrbc))
6100 v = ffs(mmrbc) - 10;
6102 cap = pci_find_capability(dev, PCI_CAP_ID_PCIX);
6106 if (pci_read_config_dword(dev, cap + PCI_X_STATUS, &stat))
6109 if (v > FIELD_GET(PCI_X_STATUS_MAX_READ, stat))
6112 if (pci_read_config_word(dev, cap + PCI_X_CMD, &cmd))
6115 o = FIELD_GET(PCI_X_CMD_MAX_READ, cmd);
6117 if (v > o && (dev->bus->bus_flags & PCI_BUS_FLAGS_NO_MMRBC))
6120 cmd &= ~PCI_X_CMD_MAX_READ;
6121 cmd |= FIELD_PREP(PCI_X_CMD_MAX_READ, v);
6122 if (pci_write_config_word(dev, cap + PCI_X_CMD, cmd))
6127 EXPORT_SYMBOL(pcix_set_mmrbc);
6130 * pcie_get_readrq - get PCI Express read request size
6131 * @dev: PCI device to query
6133 * Returns maximum memory read request in bytes or appropriate error value.
6135 int pcie_get_readrq(struct pci_dev *dev)
6139 pcie_capability_read_word(dev, PCI_EXP_DEVCTL, &ctl);
6141 return 128 << FIELD_GET(PCI_EXP_DEVCTL_READRQ, ctl);
6143 EXPORT_SYMBOL(pcie_get_readrq);
6146 * pcie_set_readrq - set PCI Express maximum memory read request
6147 * @dev: PCI device to query
6148 * @rq: maximum memory read count in bytes
6149 * valid values are 128, 256, 512, 1024, 2048, 4096
6151 * If possible sets maximum memory read request in bytes
6153 int pcie_set_readrq(struct pci_dev *dev, int rq)
6157 struct pci_host_bridge *bridge = pci_find_host_bridge(dev->bus);
6159 if (rq < 128 || rq > 4096 || !is_power_of_2(rq))
6163 * If using the "performance" PCIe config, we clamp the read rq
6164 * size to the max packet size to keep the host bridge from
6165 * generating requests larger than we can cope with.
6167 if (pcie_bus_config == PCIE_BUS_PERFORMANCE) {
6168 int mps = pcie_get_mps(dev);
6174 v = FIELD_PREP(PCI_EXP_DEVCTL_READRQ, ffs(rq) - 8);
6176 if (bridge->no_inc_mrrs) {
6177 int max_mrrs = pcie_get_readrq(dev);
6179 if (rq > max_mrrs) {
6180 pci_info(dev, "can't set Max_Read_Request_Size to %d; max is %d\n", rq, max_mrrs);
6185 ret = pcie_capability_clear_and_set_word(dev, PCI_EXP_DEVCTL,
6186 PCI_EXP_DEVCTL_READRQ, v);
6188 return pcibios_err_to_errno(ret);
6190 EXPORT_SYMBOL(pcie_set_readrq);
6193 * pcie_get_mps - get PCI Express maximum payload size
6194 * @dev: PCI device to query
6196 * Returns maximum payload size in bytes
6198 int pcie_get_mps(struct pci_dev *dev)
6202 pcie_capability_read_word(dev, PCI_EXP_DEVCTL, &ctl);
6204 return 128 << FIELD_GET(PCI_EXP_DEVCTL_PAYLOAD, ctl);
6206 EXPORT_SYMBOL(pcie_get_mps);
6209 * pcie_set_mps - set PCI Express maximum payload size
6210 * @dev: PCI device to query
6211 * @mps: maximum payload size in bytes
6212 * valid values are 128, 256, 512, 1024, 2048, 4096
6214 * If possible sets maximum payload size
6216 int pcie_set_mps(struct pci_dev *dev, int mps)
6221 if (mps < 128 || mps > 4096 || !is_power_of_2(mps))
6225 if (v > dev->pcie_mpss)
6227 v = FIELD_PREP(PCI_EXP_DEVCTL_PAYLOAD, v);
6229 ret = pcie_capability_clear_and_set_word(dev, PCI_EXP_DEVCTL,
6230 PCI_EXP_DEVCTL_PAYLOAD, v);
6232 return pcibios_err_to_errno(ret);
6234 EXPORT_SYMBOL(pcie_set_mps);
6237 * pcie_bandwidth_available - determine minimum link settings of a PCIe
6238 * device and its bandwidth limitation
6239 * @dev: PCI device to query
6240 * @limiting_dev: storage for device causing the bandwidth limitation
6241 * @speed: storage for speed of limiting device
6242 * @width: storage for width of limiting device
6244 * Walk up the PCI device chain and find the point where the minimum
6245 * bandwidth is available. Return the bandwidth available there and (if
6246 * limiting_dev, speed, and width pointers are supplied) information about
6247 * that point. The bandwidth returned is in Mb/s, i.e., megabits/second of
6250 u32 pcie_bandwidth_available(struct pci_dev *dev, struct pci_dev **limiting_dev,
6251 enum pci_bus_speed *speed,
6252 enum pcie_link_width *width)
6255 enum pci_bus_speed next_speed;
6256 enum pcie_link_width next_width;
6260 *speed = PCI_SPEED_UNKNOWN;
6262 *width = PCIE_LNK_WIDTH_UNKNOWN;
6267 pcie_capability_read_word(dev, PCI_EXP_LNKSTA, &lnksta);
6269 next_speed = pcie_link_speed[FIELD_GET(PCI_EXP_LNKSTA_CLS,
6271 next_width = FIELD_GET(PCI_EXP_LNKSTA_NLW, lnksta);
6273 next_bw = next_width * PCIE_SPEED2MBS_ENC(next_speed);
6275 /* Check if current device limits the total bandwidth */
6276 if (!bw || next_bw <= bw) {
6280 *limiting_dev = dev;
6282 *speed = next_speed;
6284 *width = next_width;
6287 dev = pci_upstream_bridge(dev);
6292 EXPORT_SYMBOL(pcie_bandwidth_available);
6295 * pcie_get_speed_cap - query for the PCI device's link speed capability
6296 * @dev: PCI device to query
6298 * Query the PCI device speed capability. Return the maximum link speed
6299 * supported by the device.
6301 enum pci_bus_speed pcie_get_speed_cap(struct pci_dev *dev)
6303 u32 lnkcap2, lnkcap;
6306 * Link Capabilities 2 was added in PCIe r3.0, sec 7.8.18. The
6307 * implementation note there recommends using the Supported Link
6308 * Speeds Vector in Link Capabilities 2 when supported.
6310 * Without Link Capabilities 2, i.e., prior to PCIe r3.0, software
6311 * should use the Supported Link Speeds field in Link Capabilities,
6312 * where only 2.5 GT/s and 5.0 GT/s speeds were defined.
6314 pcie_capability_read_dword(dev, PCI_EXP_LNKCAP2, &lnkcap2);
6316 /* PCIe r3.0-compliant */
6318 return PCIE_LNKCAP2_SLS2SPEED(lnkcap2);
6320 pcie_capability_read_dword(dev, PCI_EXP_LNKCAP, &lnkcap);
6321 if ((lnkcap & PCI_EXP_LNKCAP_SLS) == PCI_EXP_LNKCAP_SLS_5_0GB)
6322 return PCIE_SPEED_5_0GT;
6323 else if ((lnkcap & PCI_EXP_LNKCAP_SLS) == PCI_EXP_LNKCAP_SLS_2_5GB)
6324 return PCIE_SPEED_2_5GT;
6326 return PCI_SPEED_UNKNOWN;
6328 EXPORT_SYMBOL(pcie_get_speed_cap);
6331 * pcie_get_width_cap - query for the PCI device's link width capability
6332 * @dev: PCI device to query
6334 * Query the PCI device width capability. Return the maximum link width
6335 * supported by the device.
6337 enum pcie_link_width pcie_get_width_cap(struct pci_dev *dev)
6341 pcie_capability_read_dword(dev, PCI_EXP_LNKCAP, &lnkcap);
6343 return FIELD_GET(PCI_EXP_LNKCAP_MLW, lnkcap);
6345 return PCIE_LNK_WIDTH_UNKNOWN;
6347 EXPORT_SYMBOL(pcie_get_width_cap);
6350 * pcie_bandwidth_capable - calculate a PCI device's link bandwidth capability
6352 * @speed: storage for link speed
6353 * @width: storage for link width
6355 * Calculate a PCI device's link bandwidth by querying for its link speed
6356 * and width, multiplying them, and applying encoding overhead. The result
6357 * is in Mb/s, i.e., megabits/second of raw bandwidth.
6359 u32 pcie_bandwidth_capable(struct pci_dev *dev, enum pci_bus_speed *speed,
6360 enum pcie_link_width *width)
6362 *speed = pcie_get_speed_cap(dev);
6363 *width = pcie_get_width_cap(dev);
6365 if (*speed == PCI_SPEED_UNKNOWN || *width == PCIE_LNK_WIDTH_UNKNOWN)
6368 return *width * PCIE_SPEED2MBS_ENC(*speed);
6372 * __pcie_print_link_status - Report the PCI device's link speed and width
6373 * @dev: PCI device to query
6374 * @verbose: Print info even when enough bandwidth is available
6376 * If the available bandwidth at the device is less than the device is
6377 * capable of, report the device's maximum possible bandwidth and the
6378 * upstream link that limits its performance. If @verbose, always print
6379 * the available bandwidth, even if the device isn't constrained.
6381 void __pcie_print_link_status(struct pci_dev *dev, bool verbose)
6383 enum pcie_link_width width, width_cap;
6384 enum pci_bus_speed speed, speed_cap;
6385 struct pci_dev *limiting_dev = NULL;
6386 u32 bw_avail, bw_cap;
6388 bw_cap = pcie_bandwidth_capable(dev, &speed_cap, &width_cap);
6389 bw_avail = pcie_bandwidth_available(dev, &limiting_dev, &speed, &width);
6391 if (bw_avail >= bw_cap && verbose)
6392 pci_info(dev, "%u.%03u Gb/s available PCIe bandwidth (%s x%d link)\n",
6393 bw_cap / 1000, bw_cap % 1000,
6394 pci_speed_string(speed_cap), width_cap);
6395 else if (bw_avail < bw_cap)
6396 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",
6397 bw_avail / 1000, bw_avail % 1000,
6398 pci_speed_string(speed), width,
6399 limiting_dev ? pci_name(limiting_dev) : "<unknown>",
6400 bw_cap / 1000, bw_cap % 1000,
6401 pci_speed_string(speed_cap), width_cap);
6405 * pcie_print_link_status - Report the PCI device's link speed and width
6406 * @dev: PCI device to query
6408 * Report the available bandwidth at the device.
6410 void pcie_print_link_status(struct pci_dev *dev)
6412 __pcie_print_link_status(dev, true);
6414 EXPORT_SYMBOL(pcie_print_link_status);
6417 * pci_select_bars - Make BAR mask from the type of resource
6418 * @dev: the PCI device for which BAR mask is made
6419 * @flags: resource type mask to be selected
6421 * This helper routine makes bar mask from the type of resource.
6423 int pci_select_bars(struct pci_dev *dev, unsigned long flags)
6426 for (i = 0; i < PCI_NUM_RESOURCES; i++)
6427 if (pci_resource_flags(dev, i) & flags)
6431 EXPORT_SYMBOL(pci_select_bars);
6433 /* Some architectures require additional programming to enable VGA */
6434 static arch_set_vga_state_t arch_set_vga_state;
6436 void __init pci_register_set_vga_state(arch_set_vga_state_t func)
6438 arch_set_vga_state = func; /* NULL disables */
6441 static int pci_set_vga_state_arch(struct pci_dev *dev, bool decode,
6442 unsigned int command_bits, u32 flags)
6444 if (arch_set_vga_state)
6445 return arch_set_vga_state(dev, decode, command_bits,
6451 * pci_set_vga_state - set VGA decode state on device and parents if requested
6452 * @dev: the PCI device
6453 * @decode: true = enable decoding, false = disable decoding
6454 * @command_bits: PCI_COMMAND_IO and/or PCI_COMMAND_MEMORY
6455 * @flags: traverse ancestors and change bridges
6456 * CHANGE_BRIDGE_ONLY / CHANGE_BRIDGE
6458 int pci_set_vga_state(struct pci_dev *dev, bool decode,
6459 unsigned int command_bits, u32 flags)
6461 struct pci_bus *bus;
6462 struct pci_dev *bridge;
6466 WARN_ON((flags & PCI_VGA_STATE_CHANGE_DECODES) && (command_bits & ~(PCI_COMMAND_IO|PCI_COMMAND_MEMORY)));
6468 /* ARCH specific VGA enables */
6469 rc = pci_set_vga_state_arch(dev, decode, command_bits, flags);
6473 if (flags & PCI_VGA_STATE_CHANGE_DECODES) {
6474 pci_read_config_word(dev, PCI_COMMAND, &cmd);
6476 cmd |= command_bits;
6478 cmd &= ~command_bits;
6479 pci_write_config_word(dev, PCI_COMMAND, cmd);
6482 if (!(flags & PCI_VGA_STATE_CHANGE_BRIDGE))
6489 pci_read_config_word(bridge, PCI_BRIDGE_CONTROL,
6492 cmd |= PCI_BRIDGE_CTL_VGA;
6494 cmd &= ~PCI_BRIDGE_CTL_VGA;
6495 pci_write_config_word(bridge, PCI_BRIDGE_CONTROL,
6504 bool pci_pr3_present(struct pci_dev *pdev)
6506 struct acpi_device *adev;
6511 adev = ACPI_COMPANION(&pdev->dev);
6515 return adev->power.flags.power_resources &&
6516 acpi_has_method(adev->handle, "_PR3");
6518 EXPORT_SYMBOL_GPL(pci_pr3_present);
6522 * pci_add_dma_alias - Add a DMA devfn alias for a device
6523 * @dev: the PCI device for which alias is added
6524 * @devfn_from: alias slot and function
6525 * @nr_devfns: number of subsequent devfns to alias
6527 * This helper encodes an 8-bit devfn as a bit number in dma_alias_mask
6528 * which is used to program permissible bus-devfn source addresses for DMA
6529 * requests in an IOMMU. These aliases factor into IOMMU group creation
6530 * and are useful for devices generating DMA requests beyond or different
6531 * from their logical bus-devfn. Examples include device quirks where the
6532 * device simply uses the wrong devfn, as well as non-transparent bridges
6533 * where the alias may be a proxy for devices in another domain.
6535 * IOMMU group creation is performed during device discovery or addition,
6536 * prior to any potential DMA mapping and therefore prior to driver probing
6537 * (especially for userspace assigned devices where IOMMU group definition
6538 * cannot be left as a userspace activity). DMA aliases should therefore
6539 * be configured via quirks, such as the PCI fixup header quirk.
6541 void pci_add_dma_alias(struct pci_dev *dev, u8 devfn_from,
6542 unsigned int nr_devfns)
6546 nr_devfns = min(nr_devfns, (unsigned int)MAX_NR_DEVFNS - devfn_from);
6547 devfn_to = devfn_from + nr_devfns - 1;
6549 if (!dev->dma_alias_mask)
6550 dev->dma_alias_mask = bitmap_zalloc(MAX_NR_DEVFNS, GFP_KERNEL);
6551 if (!dev->dma_alias_mask) {
6552 pci_warn(dev, "Unable to allocate DMA alias mask\n");
6556 bitmap_set(dev->dma_alias_mask, devfn_from, nr_devfns);
6559 pci_info(dev, "Enabling fixed DMA alias to %02x.%d\n",
6560 PCI_SLOT(devfn_from), PCI_FUNC(devfn_from));
6561 else if (nr_devfns > 1)
6562 pci_info(dev, "Enabling fixed DMA alias for devfn range from %02x.%d to %02x.%d\n",
6563 PCI_SLOT(devfn_from), PCI_FUNC(devfn_from),
6564 PCI_SLOT(devfn_to), PCI_FUNC(devfn_to));
6567 bool pci_devs_are_dma_aliases(struct pci_dev *dev1, struct pci_dev *dev2)
6569 return (dev1->dma_alias_mask &&
6570 test_bit(dev2->devfn, dev1->dma_alias_mask)) ||
6571 (dev2->dma_alias_mask &&
6572 test_bit(dev1->devfn, dev2->dma_alias_mask)) ||
6573 pci_real_dma_dev(dev1) == dev2 ||
6574 pci_real_dma_dev(dev2) == dev1;
6577 bool pci_device_is_present(struct pci_dev *pdev)
6581 /* Check PF if pdev is a VF, since VF Vendor/Device IDs are 0xffff */
6582 pdev = pci_physfn(pdev);
6583 if (pci_dev_is_disconnected(pdev))
6585 return pci_bus_read_dev_vendor_id(pdev->bus, pdev->devfn, &v, 0);
6587 EXPORT_SYMBOL_GPL(pci_device_is_present);
6589 void pci_ignore_hotplug(struct pci_dev *dev)
6591 struct pci_dev *bridge = dev->bus->self;
6593 dev->ignore_hotplug = 1;
6594 /* Propagate the "ignore hotplug" setting to the parent bridge. */
6596 bridge->ignore_hotplug = 1;
6598 EXPORT_SYMBOL_GPL(pci_ignore_hotplug);
6601 * pci_real_dma_dev - Get PCI DMA device for PCI device
6602 * @dev: the PCI device that may have a PCI DMA alias
6604 * Permits the platform to provide architecture-specific functionality to
6605 * devices needing to alias DMA to another PCI device on another PCI bus. If
6606 * the PCI device is on the same bus, it is recommended to use
6607 * pci_add_dma_alias(). This is the default implementation. Architecture
6608 * implementations can override this.
6610 struct pci_dev __weak *pci_real_dma_dev(struct pci_dev *dev)
6615 resource_size_t __weak pcibios_default_alignment(void)
6621 * Arches that don't want to expose struct resource to userland as-is in
6622 * sysfs and /proc can implement their own pci_resource_to_user().
6624 void __weak pci_resource_to_user(const struct pci_dev *dev, int bar,
6625 const struct resource *rsrc,
6626 resource_size_t *start, resource_size_t *end)
6628 *start = rsrc->start;
6632 static char *resource_alignment_param;
6633 static DEFINE_SPINLOCK(resource_alignment_lock);
6636 * pci_specified_resource_alignment - get resource alignment specified by user.
6637 * @dev: the PCI device to get
6638 * @resize: whether or not to change resources' size when reassigning alignment
6640 * RETURNS: Resource alignment if it is specified.
6641 * Zero if it is not specified.
6643 static resource_size_t pci_specified_resource_alignment(struct pci_dev *dev,
6646 int align_order, count;
6647 resource_size_t align = pcibios_default_alignment();
6651 spin_lock(&resource_alignment_lock);
6652 p = resource_alignment_param;
6655 if (pci_has_flag(PCI_PROBE_ONLY)) {
6657 pr_info_once("PCI: Ignoring requested alignments (PCI_PROBE_ONLY)\n");
6663 if (sscanf(p, "%d%n", &align_order, &count) == 1 &&
6666 if (align_order > 63) {
6667 pr_err("PCI: Invalid requested alignment (order %d)\n",
6669 align_order = PAGE_SHIFT;
6672 align_order = PAGE_SHIFT;
6675 ret = pci_dev_str_match(dev, p, &p);
6678 align = 1ULL << align_order;
6680 } else if (ret < 0) {
6681 pr_err("PCI: Can't parse resource_alignment parameter: %s\n",
6686 if (*p != ';' && *p != ',') {
6687 /* End of param or invalid format */
6693 spin_unlock(&resource_alignment_lock);
6697 static void pci_request_resource_alignment(struct pci_dev *dev, int bar,
6698 resource_size_t align, bool resize)
6700 struct resource *r = &dev->resource[bar];
6701 resource_size_t size;
6703 if (!(r->flags & IORESOURCE_MEM))
6706 if (r->flags & IORESOURCE_PCI_FIXED) {
6707 pci_info(dev, "BAR%d %pR: ignoring requested alignment %#llx\n",
6708 bar, r, (unsigned long long)align);
6712 size = resource_size(r);
6717 * Increase the alignment of the resource. There are two ways we
6720 * 1) Increase the size of the resource. BARs are aligned on their
6721 * size, so when we reallocate space for this resource, we'll
6722 * allocate it with the larger alignment. This also prevents
6723 * assignment of any other BARs inside the alignment region, so
6724 * if we're requesting page alignment, this means no other BARs
6725 * will share the page.
6727 * The disadvantage is that this makes the resource larger than
6728 * the hardware BAR, which may break drivers that compute things
6729 * based on the resource size, e.g., to find registers at a
6730 * fixed offset before the end of the BAR.
6732 * 2) Retain the resource size, but use IORESOURCE_STARTALIGN and
6733 * set r->start to the desired alignment. By itself this
6734 * doesn't prevent other BARs being put inside the alignment
6735 * region, but if we realign *every* resource of every device in
6736 * the system, none of them will share an alignment region.
6738 * When the user has requested alignment for only some devices via
6739 * the "pci=resource_alignment" argument, "resize" is true and we
6740 * use the first method. Otherwise we assume we're aligning all
6741 * devices and we use the second.
6744 pci_info(dev, "BAR%d %pR: requesting alignment to %#llx\n",
6745 bar, r, (unsigned long long)align);
6751 r->flags &= ~IORESOURCE_SIZEALIGN;
6752 r->flags |= IORESOURCE_STARTALIGN;
6754 r->end = r->start + size - 1;
6756 r->flags |= IORESOURCE_UNSET;
6760 * This function disables memory decoding and releases memory resources
6761 * of the device specified by kernel's boot parameter 'pci=resource_alignment='.
6762 * It also rounds up size to specified alignment.
6763 * Later on, the kernel will assign page-aligned memory resource back
6766 void pci_reassigndev_resource_alignment(struct pci_dev *dev)
6770 resource_size_t align;
6772 bool resize = false;
6775 * VF BARs are read-only zero according to SR-IOV spec r1.1, sec
6776 * 3.4.1.11. Their resources are allocated from the space
6777 * described by the VF BARx register in the PF's SR-IOV capability.
6778 * We can't influence their alignment here.
6783 /* check if specified PCI is target device to reassign */
6784 align = pci_specified_resource_alignment(dev, &resize);
6788 if (dev->hdr_type == PCI_HEADER_TYPE_NORMAL &&
6789 (dev->class >> 8) == PCI_CLASS_BRIDGE_HOST) {
6790 pci_warn(dev, "Can't reassign resources to host bridge\n");
6794 pci_read_config_word(dev, PCI_COMMAND, &command);
6795 command &= ~PCI_COMMAND_MEMORY;
6796 pci_write_config_word(dev, PCI_COMMAND, command);
6798 for (i = 0; i <= PCI_ROM_RESOURCE; i++)
6799 pci_request_resource_alignment(dev, i, align, resize);
6802 * Need to disable bridge's resource window,
6803 * to enable the kernel to reassign new resource
6806 if (dev->hdr_type == PCI_HEADER_TYPE_BRIDGE) {
6807 for (i = PCI_BRIDGE_RESOURCES; i < PCI_NUM_RESOURCES; i++) {
6808 r = &dev->resource[i];
6809 if (!(r->flags & IORESOURCE_MEM))
6811 r->flags |= IORESOURCE_UNSET;
6812 r->end = resource_size(r) - 1;
6815 pci_disable_bridge_window(dev);
6819 static ssize_t resource_alignment_show(const struct bus_type *bus, char *buf)
6823 spin_lock(&resource_alignment_lock);
6824 if (resource_alignment_param)
6825 count = sysfs_emit(buf, "%s\n", resource_alignment_param);
6826 spin_unlock(&resource_alignment_lock);
6831 static ssize_t resource_alignment_store(const struct bus_type *bus,
6832 const char *buf, size_t count)
6834 char *param, *old, *end;
6836 if (count >= (PAGE_SIZE - 1))
6839 param = kstrndup(buf, count, GFP_KERNEL);
6843 end = strchr(param, '\n');
6847 spin_lock(&resource_alignment_lock);
6848 old = resource_alignment_param;
6849 if (strlen(param)) {
6850 resource_alignment_param = param;
6853 resource_alignment_param = NULL;
6855 spin_unlock(&resource_alignment_lock);
6862 static BUS_ATTR_RW(resource_alignment);
6864 static int __init pci_resource_alignment_sysfs_init(void)
6866 return bus_create_file(&pci_bus_type,
6867 &bus_attr_resource_alignment);
6869 late_initcall(pci_resource_alignment_sysfs_init);
6871 static void pci_no_domains(void)
6873 #ifdef CONFIG_PCI_DOMAINS
6874 pci_domains_supported = 0;
6878 #ifdef CONFIG_PCI_DOMAINS_GENERIC
6879 static DEFINE_IDA(pci_domain_nr_static_ida);
6880 static DEFINE_IDA(pci_domain_nr_dynamic_ida);
6882 static void of_pci_reserve_static_domain_nr(void)
6884 struct device_node *np;
6887 for_each_node_by_type(np, "pci") {
6888 domain_nr = of_get_pci_domain_nr(np);
6892 * Permanently allocate domain_nr in dynamic_ida
6893 * to prevent it from dynamic allocation.
6895 ida_alloc_range(&pci_domain_nr_dynamic_ida,
6896 domain_nr, domain_nr, GFP_KERNEL);
6900 static int of_pci_bus_find_domain_nr(struct device *parent)
6902 static bool static_domains_reserved = false;
6905 /* On the first call scan device tree for static allocations. */
6906 if (!static_domains_reserved) {
6907 of_pci_reserve_static_domain_nr();
6908 static_domains_reserved = true;
6913 * If domain is in DT, allocate it in static IDA. This
6914 * prevents duplicate static allocations in case of errors
6917 domain_nr = of_get_pci_domain_nr(parent->of_node);
6919 return ida_alloc_range(&pci_domain_nr_static_ida,
6920 domain_nr, domain_nr,
6925 * If domain was not specified in DT, choose a free ID from dynamic
6926 * allocations. All domain numbers from DT are permanently in
6927 * dynamic allocations to prevent assigning them to other DT nodes
6928 * without static domain.
6930 return ida_alloc(&pci_domain_nr_dynamic_ida, GFP_KERNEL);
6933 static void of_pci_bus_release_domain_nr(struct pci_bus *bus, struct device *parent)
6935 if (bus->domain_nr < 0)
6938 /* Release domain from IDA where it was allocated. */
6939 if (of_get_pci_domain_nr(parent->of_node) == bus->domain_nr)
6940 ida_free(&pci_domain_nr_static_ida, bus->domain_nr);
6942 ida_free(&pci_domain_nr_dynamic_ida, bus->domain_nr);
6945 int pci_bus_find_domain_nr(struct pci_bus *bus, struct device *parent)
6947 return acpi_disabled ? of_pci_bus_find_domain_nr(parent) :
6948 acpi_pci_bus_find_domain_nr(bus);
6951 void pci_bus_release_domain_nr(struct pci_bus *bus, struct device *parent)
6955 of_pci_bus_release_domain_nr(bus, parent);
6960 * pci_ext_cfg_avail - can we access extended PCI config space?
6962 * Returns 1 if we can access PCI extended config space (offsets
6963 * greater than 0xff). This is the default implementation. Architecture
6964 * implementations can override this.
6966 int __weak pci_ext_cfg_avail(void)
6971 void __weak pci_fixup_cardbus(struct pci_bus *bus)
6974 EXPORT_SYMBOL(pci_fixup_cardbus);
6976 static int __init pci_setup(char *str)
6979 char *k = strchr(str, ',');
6982 if (*str && (str = pcibios_setup(str)) && *str) {
6983 if (!strcmp(str, "nomsi")) {
6985 } else if (!strncmp(str, "noats", 5)) {
6986 pr_info("PCIe: ATS is disabled\n");
6987 pcie_ats_disabled = true;
6988 } else if (!strcmp(str, "noaer")) {
6990 } else if (!strcmp(str, "earlydump")) {
6991 pci_early_dump = true;
6992 } else if (!strncmp(str, "realloc=", 8)) {
6993 pci_realloc_get_opt(str + 8);
6994 } else if (!strncmp(str, "realloc", 7)) {
6995 pci_realloc_get_opt("on");
6996 } else if (!strcmp(str, "nodomains")) {
6998 } else if (!strncmp(str, "noari", 5)) {
6999 pcie_ari_disabled = true;
7000 } else if (!strncmp(str, "cbiosize=", 9)) {
7001 pci_cardbus_io_size = memparse(str + 9, &str);
7002 } else if (!strncmp(str, "cbmemsize=", 10)) {
7003 pci_cardbus_mem_size = memparse(str + 10, &str);
7004 } else if (!strncmp(str, "resource_alignment=", 19)) {
7005 resource_alignment_param = str + 19;
7006 } else if (!strncmp(str, "ecrc=", 5)) {
7007 pcie_ecrc_get_policy(str + 5);
7008 } else if (!strncmp(str, "hpiosize=", 9)) {
7009 pci_hotplug_io_size = memparse(str + 9, &str);
7010 } else if (!strncmp(str, "hpmmiosize=", 11)) {
7011 pci_hotplug_mmio_size = memparse(str + 11, &str);
7012 } else if (!strncmp(str, "hpmmioprefsize=", 15)) {
7013 pci_hotplug_mmio_pref_size = memparse(str + 15, &str);
7014 } else if (!strncmp(str, "hpmemsize=", 10)) {
7015 pci_hotplug_mmio_size = memparse(str + 10, &str);
7016 pci_hotplug_mmio_pref_size = pci_hotplug_mmio_size;
7017 } else if (!strncmp(str, "hpbussize=", 10)) {
7018 pci_hotplug_bus_size =
7019 simple_strtoul(str + 10, &str, 0);
7020 if (pci_hotplug_bus_size > 0xff)
7021 pci_hotplug_bus_size = DEFAULT_HOTPLUG_BUS_SIZE;
7022 } else if (!strncmp(str, "pcie_bus_tune_off", 17)) {
7023 pcie_bus_config = PCIE_BUS_TUNE_OFF;
7024 } else if (!strncmp(str, "pcie_bus_safe", 13)) {
7025 pcie_bus_config = PCIE_BUS_SAFE;
7026 } else if (!strncmp(str, "pcie_bus_perf", 13)) {
7027 pcie_bus_config = PCIE_BUS_PERFORMANCE;
7028 } else if (!strncmp(str, "pcie_bus_peer2peer", 18)) {
7029 pcie_bus_config = PCIE_BUS_PEER2PEER;
7030 } else if (!strncmp(str, "pcie_scan_all", 13)) {
7031 pci_add_flags(PCI_SCAN_ALL_PCIE_DEVS);
7032 } else if (!strncmp(str, "disable_acs_redir=", 18)) {
7033 disable_acs_redir_param = str + 18;
7035 pr_err("PCI: Unknown option `%s'\n", str);
7042 early_param("pci", pci_setup);
7045 * 'resource_alignment_param' and 'disable_acs_redir_param' are initialized
7046 * in pci_setup(), above, to point to data in the __initdata section which
7047 * will be freed after the init sequence is complete. We can't allocate memory
7048 * in pci_setup() because some architectures do not have any memory allocation
7049 * service available during an early_param() call. So we allocate memory and
7050 * copy the variable here before the init section is freed.
7053 static int __init pci_realloc_setup_params(void)
7055 resource_alignment_param = kstrdup(resource_alignment_param,
7057 disable_acs_redir_param = kstrdup(disable_acs_redir_param, GFP_KERNEL);
7061 pure_initcall(pci_realloc_setup_params);