1 /* SPDX-License-Identifier: GPL-2.0 */
5 * PCI defines and function prototypes
6 * Copyright 1994, Drew Eckhardt
7 * Copyright 1997--1999 Martin Mares <mj@ucw.cz>
9 * For more information, please consult the following manuals (look at
10 * http://www.pcisig.com/ for how to get them):
12 * PCI BIOS Specification
13 * PCI Local Bus Specification
14 * PCI to PCI Bridge Specification
15 * PCI System Design Guide
21 #include <linux/mod_devicetable.h>
23 #include <linux/types.h>
24 #include <linux/init.h>
25 #include <linux/ioport.h>
26 #include <linux/list.h>
27 #include <linux/compiler.h>
28 #include <linux/errno.h>
29 #include <linux/kobject.h>
30 #include <linux/atomic.h>
31 #include <linux/device.h>
32 #include <linux/interrupt.h>
34 #include <linux/resource_ext.h>
35 #include <uapi/linux/pci.h>
37 #include <linux/pci_ids.h>
40 * The PCI interface treats multi-function devices as independent
41 * devices. The slot/function address of each device is encoded
42 * in a single byte as follows:
47 * PCI_DEVFN(), PCI_SLOT(), and PCI_FUNC() are defined in uapi/linux/pci.h.
48 * In the interest of not exposing interfaces to user-space unnecessarily,
49 * the following kernel-only defines are being added here.
51 #define PCI_DEVID(bus, devfn) ((((u16)(bus)) << 8) | (devfn))
52 /* return bus from PCI devid = ((u16)bus_number) << 8) | devfn */
53 #define PCI_BUS_NUM(x) (((x) >> 8) & 0xff)
55 /* pci_slot represents a physical slot */
57 struct pci_bus *bus; /* The bus this slot is on */
58 struct list_head list; /* node in list of slots on this bus */
59 struct hotplug_slot *hotplug; /* Hotplug info (migrate over time) */
60 unsigned char number; /* PCI_SLOT(pci_dev->devfn) */
64 static inline const char *pci_slot_name(const struct pci_slot *slot)
66 return kobject_name(&slot->kobj);
69 /* File state for mmap()s on /proc/bus/pci/X/Y */
76 * For PCI devices, the region numbers are assigned this way:
79 /* #0-5: standard PCI resources */
81 PCI_STD_RESOURCE_END = 5,
83 /* #6: expansion ROM resource */
86 /* device specific resources */
89 PCI_IOV_RESOURCE_END = PCI_IOV_RESOURCES + PCI_SRIOV_NUM_BARS - 1,
92 /* resources assigned to buses behind the bridge */
93 #define PCI_BRIDGE_RESOURCE_NUM 4
96 PCI_BRIDGE_RESOURCE_END = PCI_BRIDGE_RESOURCES +
97 PCI_BRIDGE_RESOURCE_NUM - 1,
99 /* total resources associated with a PCI device */
102 /* preserve this for compatibility */
103 DEVICE_COUNT_RESOURCE = PCI_NUM_RESOURCES,
107 * enum pci_interrupt_pin - PCI INTx interrupt values
108 * @PCI_INTERRUPT_UNKNOWN: Unknown or unassigned interrupt
109 * @PCI_INTERRUPT_INTA: PCI INTA pin
110 * @PCI_INTERRUPT_INTB: PCI INTB pin
111 * @PCI_INTERRUPT_INTC: PCI INTC pin
112 * @PCI_INTERRUPT_INTD: PCI INTD pin
114 * Corresponds to values for legacy PCI INTx interrupts, as can be found in the
115 * PCI_INTERRUPT_PIN register.
117 enum pci_interrupt_pin {
118 PCI_INTERRUPT_UNKNOWN,
125 /* The number of legacy PCI INTx interrupts */
126 #define PCI_NUM_INTX 4
129 * pci_power_t values must match the bits in the Capabilities PME_Support
130 * and Control/Status PowerState fields in the Power Management capability.
132 typedef int __bitwise pci_power_t;
134 #define PCI_D0 ((pci_power_t __force) 0)
135 #define PCI_D1 ((pci_power_t __force) 1)
136 #define PCI_D2 ((pci_power_t __force) 2)
137 #define PCI_D3hot ((pci_power_t __force) 3)
138 #define PCI_D3cold ((pci_power_t __force) 4)
139 #define PCI_UNKNOWN ((pci_power_t __force) 5)
140 #define PCI_POWER_ERROR ((pci_power_t __force) -1)
142 /* Remember to update this when the list above changes! */
143 extern const char *pci_power_names[];
145 static inline const char *pci_power_name(pci_power_t state)
147 return pci_power_names[1 + (__force int) state];
150 #define PCI_PM_D2_DELAY 200
151 #define PCI_PM_D3_WAIT 10
152 #define PCI_PM_D3COLD_WAIT 100
153 #define PCI_PM_BUS_WAIT 50
155 /** The pci_channel state describes connectivity between the CPU and
156 * the pci device. If some PCI bus between here and the pci device
157 * has crashed or locked up, this info is reflected here.
159 typedef unsigned int __bitwise pci_channel_state_t;
161 enum pci_channel_state {
162 /* I/O channel is in normal state */
163 pci_channel_io_normal = (__force pci_channel_state_t) 1,
165 /* I/O to channel is blocked */
166 pci_channel_io_frozen = (__force pci_channel_state_t) 2,
168 /* PCI card is dead */
169 pci_channel_io_perm_failure = (__force pci_channel_state_t) 3,
172 typedef unsigned int __bitwise pcie_reset_state_t;
174 enum pcie_reset_state {
175 /* Reset is NOT asserted (Use to deassert reset) */
176 pcie_deassert_reset = (__force pcie_reset_state_t) 1,
178 /* Use #PERST to reset PCIe device */
179 pcie_warm_reset = (__force pcie_reset_state_t) 2,
181 /* Use PCIe Hot Reset to reset device */
182 pcie_hot_reset = (__force pcie_reset_state_t) 3
185 typedef unsigned short __bitwise pci_dev_flags_t;
187 /* INTX_DISABLE in PCI_COMMAND register disables MSI
190 PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG = (__force pci_dev_flags_t) (1 << 0),
191 /* Device configuration is irrevocably lost if disabled into D3 */
192 PCI_DEV_FLAGS_NO_D3 = (__force pci_dev_flags_t) (1 << 1),
193 /* Provide indication device is assigned by a Virtual Machine Manager */
194 PCI_DEV_FLAGS_ASSIGNED = (__force pci_dev_flags_t) (1 << 2),
195 /* Flag for quirk use to store if quirk-specific ACS is enabled */
196 PCI_DEV_FLAGS_ACS_ENABLED_QUIRK = (__force pci_dev_flags_t) (1 << 3),
197 /* Use a PCIe-to-PCI bridge alias even if !pci_is_pcie */
198 PCI_DEV_FLAG_PCIE_BRIDGE_ALIAS = (__force pci_dev_flags_t) (1 << 5),
199 /* Do not use bus resets for device */
200 PCI_DEV_FLAGS_NO_BUS_RESET = (__force pci_dev_flags_t) (1 << 6),
201 /* Do not use PM reset even if device advertises NoSoftRst- */
202 PCI_DEV_FLAGS_NO_PM_RESET = (__force pci_dev_flags_t) (1 << 7),
203 /* Get VPD from function 0 VPD */
204 PCI_DEV_FLAGS_VPD_REF_F0 = (__force pci_dev_flags_t) (1 << 8),
205 /* a non-root bridge where translation occurs, stop alias search here */
206 PCI_DEV_FLAGS_BRIDGE_XLATE_ROOT = (__force pci_dev_flags_t) (1 << 9),
207 /* Do not use FLR even if device advertises PCI_AF_CAP */
208 PCI_DEV_FLAGS_NO_FLR_RESET = (__force pci_dev_flags_t) (1 << 10),
209 /* Don't use Relaxed Ordering for TLPs directed at this device */
210 PCI_DEV_FLAGS_NO_RELAXED_ORDERING = (__force pci_dev_flags_t) (1 << 11),
213 enum pci_irq_reroute_variant {
214 INTEL_IRQ_REROUTE_VARIANT = 1,
215 MAX_IRQ_REROUTE_VARIANTS = 3
218 typedef unsigned short __bitwise pci_bus_flags_t;
220 PCI_BUS_FLAGS_NO_MSI = (__force pci_bus_flags_t) 1,
221 PCI_BUS_FLAGS_NO_MMRBC = (__force pci_bus_flags_t) 2,
222 PCI_BUS_FLAGS_NO_AERSID = (__force pci_bus_flags_t) 4,
225 /* These values come from the PCI Express Spec */
226 enum pcie_link_width {
227 PCIE_LNK_WIDTH_RESRV = 0x00,
235 PCIE_LNK_WIDTH_UNKNOWN = 0xFF,
238 /* Based on the PCI Hotplug Spec, but some values are made up by us */
240 PCI_SPEED_33MHz = 0x00,
241 PCI_SPEED_66MHz = 0x01,
242 PCI_SPEED_66MHz_PCIX = 0x02,
243 PCI_SPEED_100MHz_PCIX = 0x03,
244 PCI_SPEED_133MHz_PCIX = 0x04,
245 PCI_SPEED_66MHz_PCIX_ECC = 0x05,
246 PCI_SPEED_100MHz_PCIX_ECC = 0x06,
247 PCI_SPEED_133MHz_PCIX_ECC = 0x07,
248 PCI_SPEED_66MHz_PCIX_266 = 0x09,
249 PCI_SPEED_100MHz_PCIX_266 = 0x0a,
250 PCI_SPEED_133MHz_PCIX_266 = 0x0b,
256 PCI_SPEED_66MHz_PCIX_533 = 0x11,
257 PCI_SPEED_100MHz_PCIX_533 = 0x12,
258 PCI_SPEED_133MHz_PCIX_533 = 0x13,
259 PCIE_SPEED_2_5GT = 0x14,
260 PCIE_SPEED_5_0GT = 0x15,
261 PCIE_SPEED_8_0GT = 0x16,
262 PCI_SPEED_UNKNOWN = 0xff,
265 struct pci_cap_saved_data {
272 struct pci_cap_saved_state {
273 struct hlist_node next;
274 struct pci_cap_saved_data cap;
278 struct pcie_link_state;
284 * The pci_dev structure is used to describe PCI devices.
287 struct list_head bus_list; /* node in per-bus list */
288 struct pci_bus *bus; /* bus this device is on */
289 struct pci_bus *subordinate; /* bus this device bridges to */
291 void *sysdata; /* hook for sys-specific extension */
292 struct proc_dir_entry *procent; /* device entry in /proc/bus/pci */
293 struct pci_slot *slot; /* Physical slot this device is in */
295 unsigned int devfn; /* encoded device & function index */
296 unsigned short vendor;
297 unsigned short device;
298 unsigned short subsystem_vendor;
299 unsigned short subsystem_device;
300 unsigned int class; /* 3 bytes: (base,sub,prog-if) */
301 u8 revision; /* PCI revision, low byte of class word */
302 u8 hdr_type; /* PCI header type (`multi' flag masked out) */
303 #ifdef CONFIG_PCIEAER
304 u16 aer_cap; /* AER capability offset */
306 u8 pcie_cap; /* PCIe capability offset */
307 u8 msi_cap; /* MSI capability offset */
308 u8 msix_cap; /* MSI-X capability offset */
309 u8 pcie_mpss:3; /* PCIe Max Payload Size Supported */
310 u8 rom_base_reg; /* which config register controls the ROM */
311 u8 pin; /* which interrupt pin this device uses */
312 u16 pcie_flags_reg; /* cached PCIe Capabilities Register */
313 unsigned long *dma_alias_mask;/* mask of enabled devfn aliases */
315 struct pci_driver *driver; /* which driver has allocated this device */
316 u64 dma_mask; /* Mask of the bits of bus address this
317 device implements. Normally this is
318 0xffffffff. You only need to change
319 this if your device has broken DMA
320 or supports 64-bit transfers. */
322 struct device_dma_parameters dma_parms;
324 pci_power_t current_state; /* Current operating state. In ACPI-speak,
325 this is D0-D3, D0 being fully functional,
327 u8 pm_cap; /* PM capability offset */
328 unsigned int pme_support:5; /* Bitmask of states from which PME#
330 unsigned int pme_poll:1; /* Poll device's PME status bit */
331 unsigned int d1_support:1; /* Low power state D1 is supported */
332 unsigned int d2_support:1; /* Low power state D2 is supported */
333 unsigned int no_d1d2:1; /* D1 and D2 are forbidden */
334 unsigned int no_d3cold:1; /* D3cold is forbidden */
335 unsigned int bridge_d3:1; /* Allow D3 for bridge */
336 unsigned int d3cold_allowed:1; /* D3cold is allowed by user */
337 unsigned int mmio_always_on:1; /* disallow turning off io/mem
338 decoding during bar sizing */
339 unsigned int wakeup_prepared:1;
340 unsigned int runtime_d3cold:1; /* whether go through runtime
341 D3cold, not set for devices
342 powered on/off by the
343 corresponding bridge */
344 unsigned int ignore_hotplug:1; /* Ignore hotplug events */
345 unsigned int hotplug_user_indicators:1; /* SlotCtl indicators
346 controlled exclusively by
348 unsigned int d3_delay; /* D3->D0 transition time in ms */
349 unsigned int d3cold_delay; /* D3cold->D0 transition time in ms */
351 #ifdef CONFIG_PCIEASPM
352 struct pcie_link_state *link_state; /* ASPM link state */
355 pci_channel_state_t error_state; /* current connectivity state */
356 struct device dev; /* Generic device interface */
358 int cfg_size; /* Size of configuration space */
361 * Instead of touching interrupt line and base address registers
362 * directly, use the values stored here. They might be different!
365 struct resource resource[DEVICE_COUNT_RESOURCE]; /* I/O and memory regions + expansion ROMs */
367 bool match_driver; /* Skip attaching driver */
368 /* These fields are used by common fixups */
369 unsigned int transparent:1; /* Subtractive decode PCI bridge */
370 unsigned int multifunction:1;/* Part of multi-function device */
371 /* keep track of device state */
372 unsigned int is_added:1;
373 unsigned int is_busmaster:1; /* device is busmaster */
374 unsigned int no_msi:1; /* device may not use msi */
375 unsigned int no_64bit_msi:1; /* device may only use 32-bit MSIs */
376 unsigned int block_cfg_access:1; /* config space access is blocked */
377 unsigned int broken_parity_status:1; /* Device generates false positive parity */
378 unsigned int irq_reroute_variant:2; /* device needs IRQ rerouting variant */
379 unsigned int msi_enabled:1;
380 unsigned int msix_enabled:1;
381 unsigned int ari_enabled:1; /* ARI forwarding */
382 unsigned int ats_enabled:1; /* Address Translation Service */
383 unsigned int pasid_enabled:1; /* Process Address Space ID */
384 unsigned int pri_enabled:1; /* Page Request Interface */
385 unsigned int is_managed:1;
386 unsigned int needs_freset:1; /* Dev requires fundamental reset */
387 unsigned int state_saved:1;
388 unsigned int is_physfn:1;
389 unsigned int is_virtfn:1;
390 unsigned int reset_fn:1;
391 unsigned int is_hotplug_bridge:1;
392 unsigned int is_thunderbolt:1; /* Thunderbolt controller */
393 unsigned int __aer_firmware_first_valid:1;
394 unsigned int __aer_firmware_first:1;
395 unsigned int broken_intx_masking:1; /* INTx masking can't be used */
396 unsigned int io_window_1k:1; /* Intel P2P bridge 1K I/O windows */
397 unsigned int irq_managed:1;
398 unsigned int has_secondary_link:1;
399 unsigned int non_compliant_bars:1; /* broken BARs; ignore them */
400 unsigned int is_probed:1; /* device probing in progress */
401 pci_dev_flags_t dev_flags;
402 atomic_t enable_cnt; /* pci_enable_device has been called */
404 u32 saved_config_space[16]; /* config space saved at suspend time */
405 struct hlist_head saved_cap_space;
406 struct bin_attribute *rom_attr; /* attribute descriptor for sysfs ROM entry */
407 int rom_attr_enabled; /* has display of the rom attribute been enabled? */
408 struct bin_attribute *res_attr[DEVICE_COUNT_RESOURCE]; /* sysfs file for resources */
409 struct bin_attribute *res_attr_wc[DEVICE_COUNT_RESOURCE]; /* sysfs file for WC mapping of resources */
411 #ifdef CONFIG_PCIE_PTM
412 unsigned int ptm_root:1;
413 unsigned int ptm_enabled:1;
416 #ifdef CONFIG_PCI_MSI
417 const struct attribute_group **msi_irq_groups;
420 #ifdef CONFIG_PCI_ATS
422 struct pci_sriov *sriov; /* SR-IOV capability related */
423 struct pci_dev *physfn; /* the PF this VF is associated with */
425 u16 ats_cap; /* ATS Capability offset */
426 u8 ats_stu; /* ATS Smallest Translation Unit */
427 atomic_t ats_ref_cnt; /* number of VFs with ATS enabled */
429 #ifdef CONFIG_PCI_PRI
430 u32 pri_reqs_alloc; /* Number of PRI requests allocated */
432 #ifdef CONFIG_PCI_PASID
435 phys_addr_t rom; /* Physical address of ROM if it's not from the BAR */
436 size_t romlen; /* Length of ROM if it's not from the BAR */
437 char *driver_override; /* Driver name to force a match */
439 unsigned long priv_flags; /* Private flags for the pci driver */
442 static inline struct pci_dev *pci_physfn(struct pci_dev *dev)
444 #ifdef CONFIG_PCI_IOV
451 struct pci_dev *pci_alloc_dev(struct pci_bus *bus);
453 #define to_pci_dev(n) container_of(n, struct pci_dev, dev)
454 #define for_each_pci_dev(d) while ((d = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, d)) != NULL)
456 static inline int pci_channel_offline(struct pci_dev *pdev)
458 return (pdev->error_state != pci_channel_io_normal);
461 struct pci_host_bridge {
463 struct pci_bus *bus; /* root bus */
467 struct list_head windows; /* resource_entry */
468 u8 (*swizzle_irq)(struct pci_dev *, u8 *); /* platform IRQ swizzler */
469 int (*map_irq)(const struct pci_dev *, u8, u8);
470 void (*release_fn)(struct pci_host_bridge *);
472 struct msi_controller *msi;
473 unsigned int ignore_reset_delay:1; /* for entire hierarchy */
474 unsigned int no_ext_tags:1; /* no Extended Tags */
475 /* Resource alignment requirements */
476 resource_size_t (*align_resource)(struct pci_dev *dev,
477 const struct resource *res,
478 resource_size_t start,
479 resource_size_t size,
480 resource_size_t align);
481 unsigned long private[0] ____cacheline_aligned;
484 #define to_pci_host_bridge(n) container_of(n, struct pci_host_bridge, dev)
486 static inline void *pci_host_bridge_priv(struct pci_host_bridge *bridge)
488 return (void *)bridge->private;
491 static inline struct pci_host_bridge *pci_host_bridge_from_priv(void *priv)
493 return container_of(priv, struct pci_host_bridge, private);
496 struct pci_host_bridge *pci_alloc_host_bridge(size_t priv);
497 struct pci_host_bridge *devm_pci_alloc_host_bridge(struct device *dev,
499 void pci_free_host_bridge(struct pci_host_bridge *bridge);
500 struct pci_host_bridge *pci_find_host_bridge(struct pci_bus *bus);
502 void pci_set_host_bridge_release(struct pci_host_bridge *bridge,
503 void (*release_fn)(struct pci_host_bridge *),
506 int pcibios_root_bridge_prepare(struct pci_host_bridge *bridge);
509 * The first PCI_BRIDGE_RESOURCE_NUM PCI bus resources (those that correspond
510 * to P2P or CardBus bridge windows) go in a table. Additional ones (for
511 * buses below host bridges or subtractive decode bridges) go in the list.
512 * Use pci_bus_for_each_resource() to iterate through all the resources.
516 * PCI_SUBTRACTIVE_DECODE means the bridge forwards the window implicitly
517 * and there's no way to program the bridge with the details of the window.
518 * This does not apply to ACPI _CRS windows, even with the _DEC subtractive-
519 * decode bit set, because they are explicit and can be programmed with _SRS.
521 #define PCI_SUBTRACTIVE_DECODE 0x1
523 struct pci_bus_resource {
524 struct list_head list;
525 struct resource *res;
529 #define PCI_REGION_FLAG_MASK 0x0fU /* These bits of resource flags tell us the PCI region flags */
532 struct list_head node; /* node in list of buses */
533 struct pci_bus *parent; /* parent bus this bridge is on */
534 struct list_head children; /* list of child buses */
535 struct list_head devices; /* list of devices on this bus */
536 struct pci_dev *self; /* bridge device as seen by parent */
537 struct list_head slots; /* list of slots on this bus;
538 protected by pci_slot_mutex */
539 struct resource *resource[PCI_BRIDGE_RESOURCE_NUM];
540 struct list_head resources; /* address space routed to this bus */
541 struct resource busn_res; /* bus numbers routed to this bus */
543 struct pci_ops *ops; /* configuration access functions */
544 struct msi_controller *msi; /* MSI controller */
545 void *sysdata; /* hook for sys-specific extension */
546 struct proc_dir_entry *procdir; /* directory entry in /proc/bus/pci */
548 unsigned char number; /* bus number */
549 unsigned char primary; /* number of primary bridge */
550 unsigned char max_bus_speed; /* enum pci_bus_speed */
551 unsigned char cur_bus_speed; /* enum pci_bus_speed */
552 #ifdef CONFIG_PCI_DOMAINS_GENERIC
558 unsigned short bridge_ctl; /* manage NO_ISA/FBB/et al behaviors */
559 pci_bus_flags_t bus_flags; /* inherited by child buses */
560 struct device *bridge;
562 struct bin_attribute *legacy_io; /* legacy I/O for this bus */
563 struct bin_attribute *legacy_mem; /* legacy mem */
564 unsigned int is_added:1;
567 #define to_pci_bus(n) container_of(n, struct pci_bus, dev)
570 * Returns true if the PCI bus is root (behind host-PCI bridge),
573 * Some code assumes that "bus->self == NULL" means that bus is a root bus.
574 * This is incorrect because "virtual" buses added for SR-IOV (via
575 * virtfn_add_bus()) have "bus->self == NULL" but are not root buses.
577 static inline bool pci_is_root_bus(struct pci_bus *pbus)
579 return !(pbus->parent);
583 * pci_is_bridge - check if the PCI device is a bridge
586 * Return true if the PCI device is bridge whether it has subordinate
589 static inline bool pci_is_bridge(struct pci_dev *dev)
591 return dev->hdr_type == PCI_HEADER_TYPE_BRIDGE ||
592 dev->hdr_type == PCI_HEADER_TYPE_CARDBUS;
595 #define for_each_pci_bridge(dev, bus) \
596 list_for_each_entry(dev, &bus->devices, bus_list) \
597 if (!pci_is_bridge(dev)) {} else
599 static inline struct pci_dev *pci_upstream_bridge(struct pci_dev *dev)
601 dev = pci_physfn(dev);
602 if (pci_is_root_bus(dev->bus))
605 return dev->bus->self;
608 struct device *pci_get_host_bridge_device(struct pci_dev *dev);
609 void pci_put_host_bridge_device(struct device *dev);
611 #ifdef CONFIG_PCI_MSI
612 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev)
614 return pci_dev->msi_enabled || pci_dev->msix_enabled;
617 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev) { return false; }
621 * Error values that may be returned by PCI functions.
623 #define PCIBIOS_SUCCESSFUL 0x00
624 #define PCIBIOS_FUNC_NOT_SUPPORTED 0x81
625 #define PCIBIOS_BAD_VENDOR_ID 0x83
626 #define PCIBIOS_DEVICE_NOT_FOUND 0x86
627 #define PCIBIOS_BAD_REGISTER_NUMBER 0x87
628 #define PCIBIOS_SET_FAILED 0x88
629 #define PCIBIOS_BUFFER_TOO_SMALL 0x89
632 * Translate above to generic errno for passing back through non-PCI code.
634 static inline int pcibios_err_to_errno(int err)
636 if (err <= PCIBIOS_SUCCESSFUL)
637 return err; /* Assume already errno */
640 case PCIBIOS_FUNC_NOT_SUPPORTED:
642 case PCIBIOS_BAD_VENDOR_ID:
644 case PCIBIOS_DEVICE_NOT_FOUND:
646 case PCIBIOS_BAD_REGISTER_NUMBER:
648 case PCIBIOS_SET_FAILED:
650 case PCIBIOS_BUFFER_TOO_SMALL:
657 /* Low-level architecture-dependent routines */
660 int (*add_bus)(struct pci_bus *bus);
661 void (*remove_bus)(struct pci_bus *bus);
662 void __iomem *(*map_bus)(struct pci_bus *bus, unsigned int devfn, int where);
663 int (*read)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 *val);
664 int (*write)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 val);
668 * ACPI needs to be able to access PCI config space before we've done a
669 * PCI bus scan and created pci_bus structures.
671 int raw_pci_read(unsigned int domain, unsigned int bus, unsigned int devfn,
672 int reg, int len, u32 *val);
673 int raw_pci_write(unsigned int domain, unsigned int bus, unsigned int devfn,
674 int reg, int len, u32 val);
676 #ifdef CONFIG_PCI_BUS_ADDR_T_64BIT
677 typedef u64 pci_bus_addr_t;
679 typedef u32 pci_bus_addr_t;
682 struct pci_bus_region {
683 pci_bus_addr_t start;
688 spinlock_t lock; /* protects list, index */
689 struct list_head list; /* for IDs added at runtime */
694 * PCI Error Recovery System (PCI-ERS). If a PCI device driver provides
695 * a set of callbacks in struct pci_error_handlers, that device driver
696 * will be notified of PCI bus errors, and will be driven to recovery
697 * when an error occurs.
700 typedef unsigned int __bitwise pci_ers_result_t;
702 enum pci_ers_result {
703 /* no result/none/not supported in device driver */
704 PCI_ERS_RESULT_NONE = (__force pci_ers_result_t) 1,
706 /* Device driver can recover without slot reset */
707 PCI_ERS_RESULT_CAN_RECOVER = (__force pci_ers_result_t) 2,
709 /* Device driver wants slot to be reset. */
710 PCI_ERS_RESULT_NEED_RESET = (__force pci_ers_result_t) 3,
712 /* Device has completely failed, is unrecoverable */
713 PCI_ERS_RESULT_DISCONNECT = (__force pci_ers_result_t) 4,
715 /* Device driver is fully recovered and operational */
716 PCI_ERS_RESULT_RECOVERED = (__force pci_ers_result_t) 5,
718 /* No AER capabilities registered for the driver */
719 PCI_ERS_RESULT_NO_AER_DRIVER = (__force pci_ers_result_t) 6,
722 /* PCI bus error event callbacks */
723 struct pci_error_handlers {
724 /* PCI bus error detected on this device */
725 pci_ers_result_t (*error_detected)(struct pci_dev *dev,
726 enum pci_channel_state error);
728 /* MMIO has been re-enabled, but not DMA */
729 pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev);
731 /* PCI slot has been reset */
732 pci_ers_result_t (*slot_reset)(struct pci_dev *dev);
734 /* PCI function reset prepare or completed */
735 void (*reset_prepare)(struct pci_dev *dev);
736 void (*reset_done)(struct pci_dev *dev);
738 /* Device driver may resume normal operations */
739 void (*resume)(struct pci_dev *dev);
745 struct list_head node;
747 const struct pci_device_id *id_table; /* must be non-NULL for probe to be called */
748 int (*probe) (struct pci_dev *dev, const struct pci_device_id *id); /* New device inserted */
749 void (*remove) (struct pci_dev *dev); /* Device removed (NULL if not a hot-plug capable driver) */
750 int (*suspend) (struct pci_dev *dev, pm_message_t state); /* Device suspended */
751 int (*suspend_late) (struct pci_dev *dev, pm_message_t state);
752 int (*resume_early) (struct pci_dev *dev);
753 int (*resume) (struct pci_dev *dev); /* Device woken up */
754 void (*shutdown) (struct pci_dev *dev);
755 int (*sriov_configure) (struct pci_dev *dev, int num_vfs); /* PF pdev */
756 const struct pci_error_handlers *err_handler;
757 const struct attribute_group **groups;
758 struct device_driver driver;
759 struct pci_dynids dynids;
762 #define to_pci_driver(drv) container_of(drv, struct pci_driver, driver)
765 * PCI_DEVICE - macro used to describe a specific pci device
766 * @vend: the 16 bit PCI Vendor ID
767 * @dev: the 16 bit PCI Device ID
769 * This macro is used to create a struct pci_device_id that matches a
770 * specific device. The subvendor and subdevice fields will be set to
773 #define PCI_DEVICE(vend,dev) \
774 .vendor = (vend), .device = (dev), \
775 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
778 * PCI_DEVICE_SUB - macro used to describe a specific pci device with subsystem
779 * @vend: the 16 bit PCI Vendor ID
780 * @dev: the 16 bit PCI Device ID
781 * @subvend: the 16 bit PCI Subvendor ID
782 * @subdev: the 16 bit PCI Subdevice ID
784 * This macro is used to create a struct pci_device_id that matches a
785 * specific device with subsystem information.
787 #define PCI_DEVICE_SUB(vend, dev, subvend, subdev) \
788 .vendor = (vend), .device = (dev), \
789 .subvendor = (subvend), .subdevice = (subdev)
792 * PCI_DEVICE_CLASS - macro used to describe a specific pci device class
793 * @dev_class: the class, subclass, prog-if triple for this device
794 * @dev_class_mask: the class mask for this device
796 * This macro is used to create a struct pci_device_id that matches a
797 * specific PCI class. The vendor, device, subvendor, and subdevice
798 * fields will be set to PCI_ANY_ID.
800 #define PCI_DEVICE_CLASS(dev_class,dev_class_mask) \
801 .class = (dev_class), .class_mask = (dev_class_mask), \
802 .vendor = PCI_ANY_ID, .device = PCI_ANY_ID, \
803 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
806 * PCI_VDEVICE - macro used to describe a specific pci device in short form
807 * @vend: the vendor name
808 * @dev: the 16 bit PCI Device ID
810 * This macro is used to create a struct pci_device_id that matches a
811 * specific PCI device. The subvendor, and subdevice fields will be set
812 * to PCI_ANY_ID. The macro allows the next field to follow as the device
816 #define PCI_VDEVICE(vend, dev) \
817 .vendor = PCI_VENDOR_ID_##vend, .device = (dev), \
818 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, 0, 0
821 PCI_REASSIGN_ALL_RSRC = 0x00000001, /* ignore firmware setup */
822 PCI_REASSIGN_ALL_BUS = 0x00000002, /* reassign all bus numbers */
823 PCI_PROBE_ONLY = 0x00000004, /* use existing setup */
824 PCI_CAN_SKIP_ISA_ALIGN = 0x00000008, /* don't do ISA alignment */
825 PCI_ENABLE_PROC_DOMAINS = 0x00000010, /* enable domains in /proc */
826 PCI_COMPAT_DOMAIN_0 = 0x00000020, /* ... except domain 0 */
827 PCI_SCAN_ALL_PCIE_DEVS = 0x00000040, /* scan all, not just dev 0 */
830 /* these external functions are only available when PCI support is enabled */
833 extern unsigned int pci_flags;
835 static inline void pci_set_flags(int flags) { pci_flags = flags; }
836 static inline void pci_add_flags(int flags) { pci_flags |= flags; }
837 static inline void pci_clear_flags(int flags) { pci_flags &= ~flags; }
838 static inline int pci_has_flag(int flag) { return pci_flags & flag; }
840 void pcie_bus_configure_settings(struct pci_bus *bus);
842 enum pcie_bus_config_types {
843 PCIE_BUS_TUNE_OFF, /* don't touch MPS at all */
844 PCIE_BUS_DEFAULT, /* ensure MPS matches upstream bridge */
845 PCIE_BUS_SAFE, /* use largest MPS boot-time devices support */
846 PCIE_BUS_PERFORMANCE, /* use MPS and MRRS for best performance */
847 PCIE_BUS_PEER2PEER, /* set MPS = 128 for all devices */
850 extern enum pcie_bus_config_types pcie_bus_config;
852 extern struct bus_type pci_bus_type;
854 /* Do NOT directly access these two variables, unless you are arch-specific PCI
855 * code, or PCI core code. */
856 extern struct list_head pci_root_buses; /* list of all known PCI buses */
857 /* Some device drivers need know if PCI is initiated */
858 int no_pci_devices(void);
860 void pcibios_resource_survey_bus(struct pci_bus *bus);
861 void pcibios_bus_add_device(struct pci_dev *pdev);
862 void pcibios_add_bus(struct pci_bus *bus);
863 void pcibios_remove_bus(struct pci_bus *bus);
864 void pcibios_fixup_bus(struct pci_bus *);
865 int __must_check pcibios_enable_device(struct pci_dev *, int mask);
866 /* Architecture-specific versions may override this (weak) */
867 char *pcibios_setup(char *str);
869 /* Used only when drivers/pci/setup.c is used */
870 resource_size_t pcibios_align_resource(void *, const struct resource *,
874 /* Weak but can be overriden by arch */
875 void pci_fixup_cardbus(struct pci_bus *);
877 /* Generic PCI functions used internally */
879 void pcibios_resource_to_bus(struct pci_bus *bus, struct pci_bus_region *region,
880 struct resource *res);
881 void pcibios_bus_to_resource(struct pci_bus *bus, struct resource *res,
882 struct pci_bus_region *region);
883 void pcibios_scan_specific_bus(int busn);
884 struct pci_bus *pci_find_bus(int domain, int busnr);
885 void pci_bus_add_devices(const struct pci_bus *bus);
886 struct pci_bus *pci_scan_bus(int bus, struct pci_ops *ops, void *sysdata);
887 struct pci_bus *pci_create_root_bus(struct device *parent, int bus,
888 struct pci_ops *ops, void *sysdata,
889 struct list_head *resources);
890 int pci_bus_insert_busn_res(struct pci_bus *b, int bus, int busmax);
891 int pci_bus_update_busn_res_end(struct pci_bus *b, int busmax);
892 void pci_bus_release_busn_res(struct pci_bus *b);
893 struct pci_bus *pci_scan_root_bus(struct device *parent, int bus,
894 struct pci_ops *ops, void *sysdata,
895 struct list_head *resources);
896 int pci_scan_root_bus_bridge(struct pci_host_bridge *bridge);
897 struct pci_bus *pci_add_new_bus(struct pci_bus *parent, struct pci_dev *dev,
899 void pcie_update_link_speed(struct pci_bus *bus, u16 link_status);
900 struct pci_slot *pci_create_slot(struct pci_bus *parent, int slot_nr,
902 struct hotplug_slot *hotplug);
903 void pci_destroy_slot(struct pci_slot *slot);
905 void pci_dev_assign_slot(struct pci_dev *dev);
907 static inline void pci_dev_assign_slot(struct pci_dev *dev) { }
909 int pci_scan_slot(struct pci_bus *bus, int devfn);
910 struct pci_dev *pci_scan_single_device(struct pci_bus *bus, int devfn);
911 void pci_device_add(struct pci_dev *dev, struct pci_bus *bus);
912 unsigned int pci_scan_child_bus(struct pci_bus *bus);
913 void pci_bus_add_device(struct pci_dev *dev);
914 void pci_read_bridge_bases(struct pci_bus *child);
915 struct resource *pci_find_parent_resource(const struct pci_dev *dev,
916 struct resource *res);
917 struct pci_dev *pci_find_pcie_root_port(struct pci_dev *dev);
918 u8 pci_swizzle_interrupt_pin(const struct pci_dev *dev, u8 pin);
919 int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge);
920 u8 pci_common_swizzle(struct pci_dev *dev, u8 *pinp);
921 struct pci_dev *pci_dev_get(struct pci_dev *dev);
922 void pci_dev_put(struct pci_dev *dev);
923 void pci_remove_bus(struct pci_bus *b);
924 void pci_stop_and_remove_bus_device(struct pci_dev *dev);
925 void pci_stop_and_remove_bus_device_locked(struct pci_dev *dev);
926 void pci_stop_root_bus(struct pci_bus *bus);
927 void pci_remove_root_bus(struct pci_bus *bus);
928 void pci_setup_cardbus(struct pci_bus *bus);
929 void pcibios_setup_bridge(struct pci_bus *bus, unsigned long type);
930 void pci_sort_breadthfirst(void);
931 #define dev_is_pci(d) ((d)->bus == &pci_bus_type)
932 #define dev_is_pf(d) ((dev_is_pci(d) ? to_pci_dev(d)->is_physfn : false))
934 /* Generic PCI functions exported to card drivers */
936 enum pci_lost_interrupt_reason {
937 PCI_LOST_IRQ_NO_INFORMATION = 0,
938 PCI_LOST_IRQ_DISABLE_MSI,
939 PCI_LOST_IRQ_DISABLE_MSIX,
940 PCI_LOST_IRQ_DISABLE_ACPI,
942 enum pci_lost_interrupt_reason pci_lost_interrupt(struct pci_dev *dev);
943 int pci_find_capability(struct pci_dev *dev, int cap);
944 int pci_find_next_capability(struct pci_dev *dev, u8 pos, int cap);
945 int pci_find_ext_capability(struct pci_dev *dev, int cap);
946 int pci_find_next_ext_capability(struct pci_dev *dev, int pos, int cap);
947 int pci_find_ht_capability(struct pci_dev *dev, int ht_cap);
948 int pci_find_next_ht_capability(struct pci_dev *dev, int pos, int ht_cap);
949 struct pci_bus *pci_find_next_bus(const struct pci_bus *from);
951 struct pci_dev *pci_get_device(unsigned int vendor, unsigned int device,
952 struct pci_dev *from);
953 struct pci_dev *pci_get_subsys(unsigned int vendor, unsigned int device,
954 unsigned int ss_vendor, unsigned int ss_device,
955 struct pci_dev *from);
956 struct pci_dev *pci_get_slot(struct pci_bus *bus, unsigned int devfn);
957 struct pci_dev *pci_get_domain_bus_and_slot(int domain, unsigned int bus,
959 static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
962 return pci_get_domain_bus_and_slot(0, bus, devfn);
964 struct pci_dev *pci_get_class(unsigned int class, struct pci_dev *from);
965 int pci_dev_present(const struct pci_device_id *ids);
967 int pci_bus_read_config_byte(struct pci_bus *bus, unsigned int devfn,
969 int pci_bus_read_config_word(struct pci_bus *bus, unsigned int devfn,
970 int where, u16 *val);
971 int pci_bus_read_config_dword(struct pci_bus *bus, unsigned int devfn,
972 int where, u32 *val);
973 int pci_bus_write_config_byte(struct pci_bus *bus, unsigned int devfn,
975 int pci_bus_write_config_word(struct pci_bus *bus, unsigned int devfn,
977 int pci_bus_write_config_dword(struct pci_bus *bus, unsigned int devfn,
980 int pci_generic_config_read(struct pci_bus *bus, unsigned int devfn,
981 int where, int size, u32 *val);
982 int pci_generic_config_write(struct pci_bus *bus, unsigned int devfn,
983 int where, int size, u32 val);
984 int pci_generic_config_read32(struct pci_bus *bus, unsigned int devfn,
985 int where, int size, u32 *val);
986 int pci_generic_config_write32(struct pci_bus *bus, unsigned int devfn,
987 int where, int size, u32 val);
989 struct pci_ops *pci_bus_set_ops(struct pci_bus *bus, struct pci_ops *ops);
991 int pci_read_config_byte(const struct pci_dev *dev, int where, u8 *val);
992 int pci_read_config_word(const struct pci_dev *dev, int where, u16 *val);
993 int pci_read_config_dword(const struct pci_dev *dev, int where, u32 *val);
994 int pci_write_config_byte(const struct pci_dev *dev, int where, u8 val);
995 int pci_write_config_word(const struct pci_dev *dev, int where, u16 val);
996 int pci_write_config_dword(const struct pci_dev *dev, int where, u32 val);
998 int pcie_capability_read_word(struct pci_dev *dev, int pos, u16 *val);
999 int pcie_capability_read_dword(struct pci_dev *dev, int pos, u32 *val);
1000 int pcie_capability_write_word(struct pci_dev *dev, int pos, u16 val);
1001 int pcie_capability_write_dword(struct pci_dev *dev, int pos, u32 val);
1002 int pcie_capability_clear_and_set_word(struct pci_dev *dev, int pos,
1003 u16 clear, u16 set);
1004 int pcie_capability_clear_and_set_dword(struct pci_dev *dev, int pos,
1005 u32 clear, u32 set);
1007 static inline int pcie_capability_set_word(struct pci_dev *dev, int pos,
1010 return pcie_capability_clear_and_set_word(dev, pos, 0, set);
1013 static inline int pcie_capability_set_dword(struct pci_dev *dev, int pos,
1016 return pcie_capability_clear_and_set_dword(dev, pos, 0, set);
1019 static inline int pcie_capability_clear_word(struct pci_dev *dev, int pos,
1022 return pcie_capability_clear_and_set_word(dev, pos, clear, 0);
1025 static inline int pcie_capability_clear_dword(struct pci_dev *dev, int pos,
1028 return pcie_capability_clear_and_set_dword(dev, pos, clear, 0);
1031 /* user-space driven config access */
1032 int pci_user_read_config_byte(struct pci_dev *dev, int where, u8 *val);
1033 int pci_user_read_config_word(struct pci_dev *dev, int where, u16 *val);
1034 int pci_user_read_config_dword(struct pci_dev *dev, int where, u32 *val);
1035 int pci_user_write_config_byte(struct pci_dev *dev, int where, u8 val);
1036 int pci_user_write_config_word(struct pci_dev *dev, int where, u16 val);
1037 int pci_user_write_config_dword(struct pci_dev *dev, int where, u32 val);
1039 int __must_check pci_enable_device(struct pci_dev *dev);
1040 int __must_check pci_enable_device_io(struct pci_dev *dev);
1041 int __must_check pci_enable_device_mem(struct pci_dev *dev);
1042 int __must_check pci_reenable_device(struct pci_dev *);
1043 int __must_check pcim_enable_device(struct pci_dev *pdev);
1044 void pcim_pin_device(struct pci_dev *pdev);
1046 static inline bool pci_intx_mask_supported(struct pci_dev *pdev)
1049 * INTx masking is supported if PCI_COMMAND_INTX_DISABLE is
1050 * writable and no quirk has marked the feature broken.
1052 return !pdev->broken_intx_masking;
1055 static inline int pci_is_enabled(struct pci_dev *pdev)
1057 return (atomic_read(&pdev->enable_cnt) > 0);
1060 static inline int pci_is_managed(struct pci_dev *pdev)
1062 return pdev->is_managed;
1065 void pci_disable_device(struct pci_dev *dev);
1067 extern unsigned int pcibios_max_latency;
1068 void pci_set_master(struct pci_dev *dev);
1069 void pci_clear_master(struct pci_dev *dev);
1071 int pci_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state);
1072 int pci_set_cacheline_size(struct pci_dev *dev);
1073 #define HAVE_PCI_SET_MWI
1074 int __must_check pci_set_mwi(struct pci_dev *dev);
1075 int __must_check pcim_set_mwi(struct pci_dev *dev);
1076 int pci_try_set_mwi(struct pci_dev *dev);
1077 void pci_clear_mwi(struct pci_dev *dev);
1078 void pci_intx(struct pci_dev *dev, int enable);
1079 bool pci_check_and_mask_intx(struct pci_dev *dev);
1080 bool pci_check_and_unmask_intx(struct pci_dev *dev);
1081 int pci_wait_for_pending(struct pci_dev *dev, int pos, u16 mask);
1082 int pci_wait_for_pending_transaction(struct pci_dev *dev);
1083 int pcix_get_max_mmrbc(struct pci_dev *dev);
1084 int pcix_get_mmrbc(struct pci_dev *dev);
1085 int pcix_set_mmrbc(struct pci_dev *dev, int mmrbc);
1086 int pcie_get_readrq(struct pci_dev *dev);
1087 int pcie_set_readrq(struct pci_dev *dev, int rq);
1088 int pcie_get_mps(struct pci_dev *dev);
1089 int pcie_set_mps(struct pci_dev *dev, int mps);
1090 int pcie_get_minimum_link(struct pci_dev *dev, enum pci_bus_speed *speed,
1091 enum pcie_link_width *width);
1092 void pcie_flr(struct pci_dev *dev);
1093 int __pci_reset_function_locked(struct pci_dev *dev);
1094 int pci_reset_function(struct pci_dev *dev);
1095 int pci_reset_function_locked(struct pci_dev *dev);
1096 int pci_try_reset_function(struct pci_dev *dev);
1097 int pci_probe_reset_slot(struct pci_slot *slot);
1098 int pci_reset_slot(struct pci_slot *slot);
1099 int pci_try_reset_slot(struct pci_slot *slot);
1100 int pci_probe_reset_bus(struct pci_bus *bus);
1101 int pci_reset_bus(struct pci_bus *bus);
1102 int pci_try_reset_bus(struct pci_bus *bus);
1103 void pci_reset_secondary_bus(struct pci_dev *dev);
1104 void pcibios_reset_secondary_bus(struct pci_dev *dev);
1105 void pci_reset_bridge_secondary_bus(struct pci_dev *dev);
1106 void pci_update_resource(struct pci_dev *dev, int resno);
1107 int __must_check pci_assign_resource(struct pci_dev *dev, int i);
1108 int __must_check pci_reassign_resource(struct pci_dev *dev, int i, resource_size_t add_size, resource_size_t align);
1109 void pci_release_resource(struct pci_dev *dev, int resno);
1110 int __must_check pci_resize_resource(struct pci_dev *dev, int i, int size);
1111 int pci_select_bars(struct pci_dev *dev, unsigned long flags);
1112 bool pci_device_is_present(struct pci_dev *pdev);
1113 void pci_ignore_hotplug(struct pci_dev *dev);
1115 int __printf(6, 7) pci_request_irq(struct pci_dev *dev, unsigned int nr,
1116 irq_handler_t handler, irq_handler_t thread_fn, void *dev_id,
1117 const char *fmt, ...);
1118 void pci_free_irq(struct pci_dev *dev, unsigned int nr, void *dev_id);
1120 /* ROM control related routines */
1121 int pci_enable_rom(struct pci_dev *pdev);
1122 void pci_disable_rom(struct pci_dev *pdev);
1123 void __iomem __must_check *pci_map_rom(struct pci_dev *pdev, size_t *size);
1124 void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom);
1125 size_t pci_get_rom_size(struct pci_dev *pdev, void __iomem *rom, size_t size);
1126 void __iomem __must_check *pci_platform_rom(struct pci_dev *pdev, size_t *size);
1128 /* Power management related routines */
1129 int pci_save_state(struct pci_dev *dev);
1130 void pci_restore_state(struct pci_dev *dev);
1131 struct pci_saved_state *pci_store_saved_state(struct pci_dev *dev);
1132 int pci_load_saved_state(struct pci_dev *dev,
1133 struct pci_saved_state *state);
1134 int pci_load_and_free_saved_state(struct pci_dev *dev,
1135 struct pci_saved_state **state);
1136 struct pci_cap_saved_state *pci_find_saved_cap(struct pci_dev *dev, char cap);
1137 struct pci_cap_saved_state *pci_find_saved_ext_cap(struct pci_dev *dev,
1139 int pci_add_cap_save_buffer(struct pci_dev *dev, char cap, unsigned int size);
1140 int pci_add_ext_cap_save_buffer(struct pci_dev *dev,
1141 u16 cap, unsigned int size);
1142 int __pci_complete_power_transition(struct pci_dev *dev, pci_power_t state);
1143 int pci_set_power_state(struct pci_dev *dev, pci_power_t state);
1144 pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state);
1145 bool pci_pme_capable(struct pci_dev *dev, pci_power_t state);
1146 void pci_pme_active(struct pci_dev *dev, bool enable);
1147 int pci_enable_wake(struct pci_dev *dev, pci_power_t state, bool enable);
1148 int pci_wake_from_d3(struct pci_dev *dev, bool enable);
1149 int pci_prepare_to_sleep(struct pci_dev *dev);
1150 int pci_back_from_sleep(struct pci_dev *dev);
1151 bool pci_dev_run_wake(struct pci_dev *dev);
1152 bool pci_check_pme_status(struct pci_dev *dev);
1153 void pci_pme_wakeup_bus(struct pci_bus *bus);
1154 void pci_d3cold_enable(struct pci_dev *dev);
1155 void pci_d3cold_disable(struct pci_dev *dev);
1156 bool pcie_relaxed_ordering_enabled(struct pci_dev *dev);
1158 /* PCI Virtual Channel */
1159 int pci_save_vc_state(struct pci_dev *dev);
1160 void pci_restore_vc_state(struct pci_dev *dev);
1161 void pci_allocate_vc_save_buffers(struct pci_dev *dev);
1163 /* For use by arch with custom probe code */
1164 void set_pcie_port_type(struct pci_dev *pdev);
1165 void set_pcie_hotplug_bridge(struct pci_dev *pdev);
1167 /* Functions for PCI Hotplug drivers to use */
1168 int pci_bus_find_capability(struct pci_bus *bus, unsigned int devfn, int cap);
1169 unsigned int pci_rescan_bus_bridge_resize(struct pci_dev *bridge);
1170 unsigned int pci_rescan_bus(struct pci_bus *bus);
1171 void pci_lock_rescan_remove(void);
1172 void pci_unlock_rescan_remove(void);
1174 /* Vital product data routines */
1175 ssize_t pci_read_vpd(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
1176 ssize_t pci_write_vpd(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
1177 int pci_set_vpd_size(struct pci_dev *dev, size_t len);
1179 /* Helper functions for low-level code (drivers/pci/setup-[bus,res].c) */
1180 resource_size_t pcibios_retrieve_fw_addr(struct pci_dev *dev, int idx);
1181 void pci_bus_assign_resources(const struct pci_bus *bus);
1182 void pci_bus_claim_resources(struct pci_bus *bus);
1183 void pci_bus_size_bridges(struct pci_bus *bus);
1184 int pci_claim_resource(struct pci_dev *, int);
1185 int pci_claim_bridge_resource(struct pci_dev *bridge, int i);
1186 void pci_assign_unassigned_resources(void);
1187 void pci_assign_unassigned_bridge_resources(struct pci_dev *bridge);
1188 void pci_assign_unassigned_bus_resources(struct pci_bus *bus);
1189 void pci_assign_unassigned_root_bus_resources(struct pci_bus *bus);
1190 int pci_reassign_bridge_resources(struct pci_dev *bridge, unsigned long type);
1191 void pdev_enable_device(struct pci_dev *);
1192 int pci_enable_resources(struct pci_dev *, int mask);
1193 void pci_assign_irq(struct pci_dev *dev);
1194 struct resource *pci_find_resource(struct pci_dev *dev, struct resource *res);
1195 #define HAVE_PCI_REQ_REGIONS 2
1196 int __must_check pci_request_regions(struct pci_dev *, const char *);
1197 int __must_check pci_request_regions_exclusive(struct pci_dev *, const char *);
1198 void pci_release_regions(struct pci_dev *);
1199 int __must_check pci_request_region(struct pci_dev *, int, const char *);
1200 int __must_check pci_request_region_exclusive(struct pci_dev *, int, const char *);
1201 void pci_release_region(struct pci_dev *, int);
1202 int pci_request_selected_regions(struct pci_dev *, int, const char *);
1203 int pci_request_selected_regions_exclusive(struct pci_dev *, int, const char *);
1204 void pci_release_selected_regions(struct pci_dev *, int);
1206 /* drivers/pci/bus.c */
1207 struct pci_bus *pci_bus_get(struct pci_bus *bus);
1208 void pci_bus_put(struct pci_bus *bus);
1209 void pci_add_resource(struct list_head *resources, struct resource *res);
1210 void pci_add_resource_offset(struct list_head *resources, struct resource *res,
1211 resource_size_t offset);
1212 void pci_free_resource_list(struct list_head *resources);
1213 void pci_bus_add_resource(struct pci_bus *bus, struct resource *res,
1214 unsigned int flags);
1215 struct resource *pci_bus_resource_n(const struct pci_bus *bus, int n);
1216 void pci_bus_remove_resources(struct pci_bus *bus);
1217 int devm_request_pci_bus_resources(struct device *dev,
1218 struct list_head *resources);
1220 #define pci_bus_for_each_resource(bus, res, i) \
1222 (res = pci_bus_resource_n(bus, i)) || i < PCI_BRIDGE_RESOURCE_NUM; \
1225 int __must_check pci_bus_alloc_resource(struct pci_bus *bus,
1226 struct resource *res, resource_size_t size,
1227 resource_size_t align, resource_size_t min,
1228 unsigned long type_mask,
1229 resource_size_t (*alignf)(void *,
1230 const struct resource *,
1236 int pci_register_io_range(phys_addr_t addr, resource_size_t size);
1237 unsigned long pci_address_to_pio(phys_addr_t addr);
1238 phys_addr_t pci_pio_to_address(unsigned long pio);
1239 int pci_remap_iospace(const struct resource *res, phys_addr_t phys_addr);
1240 void pci_unmap_iospace(struct resource *res);
1241 void __iomem *devm_pci_remap_cfgspace(struct device *dev,
1242 resource_size_t offset,
1243 resource_size_t size);
1244 void __iomem *devm_pci_remap_cfg_resource(struct device *dev,
1245 struct resource *res);
1247 static inline pci_bus_addr_t pci_bus_address(struct pci_dev *pdev, int bar)
1249 struct pci_bus_region region;
1251 pcibios_resource_to_bus(pdev->bus, ®ion, &pdev->resource[bar]);
1252 return region.start;
1255 /* Proper probing supporting hot-pluggable devices */
1256 int __must_check __pci_register_driver(struct pci_driver *, struct module *,
1257 const char *mod_name);
1260 * pci_register_driver must be a macro so that KBUILD_MODNAME can be expanded
1262 #define pci_register_driver(driver) \
1263 __pci_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
1265 void pci_unregister_driver(struct pci_driver *dev);
1268 * module_pci_driver() - Helper macro for registering a PCI driver
1269 * @__pci_driver: pci_driver struct
1271 * Helper macro for PCI drivers which do not do anything special in module
1272 * init/exit. This eliminates a lot of boilerplate. Each module may only
1273 * use this macro once, and calling it replaces module_init() and module_exit()
1275 #define module_pci_driver(__pci_driver) \
1276 module_driver(__pci_driver, pci_register_driver, \
1277 pci_unregister_driver)
1280 * builtin_pci_driver() - Helper macro for registering a PCI driver
1281 * @__pci_driver: pci_driver struct
1283 * Helper macro for PCI drivers which do not do anything special in their
1284 * init code. This eliminates a lot of boilerplate. Each driver may only
1285 * use this macro once, and calling it replaces device_initcall(...)
1287 #define builtin_pci_driver(__pci_driver) \
1288 builtin_driver(__pci_driver, pci_register_driver)
1290 struct pci_driver *pci_dev_driver(const struct pci_dev *dev);
1291 int pci_add_dynid(struct pci_driver *drv,
1292 unsigned int vendor, unsigned int device,
1293 unsigned int subvendor, unsigned int subdevice,
1294 unsigned int class, unsigned int class_mask,
1295 unsigned long driver_data);
1296 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
1297 struct pci_dev *dev);
1298 int pci_scan_bridge(struct pci_bus *bus, struct pci_dev *dev, int max,
1301 void pci_walk_bus(struct pci_bus *top, int (*cb)(struct pci_dev *, void *),
1303 int pci_cfg_space_size(struct pci_dev *dev);
1304 unsigned char pci_bus_max_busnr(struct pci_bus *bus);
1305 void pci_setup_bridge(struct pci_bus *bus);
1306 resource_size_t pcibios_window_alignment(struct pci_bus *bus,
1307 unsigned long type);
1308 resource_size_t pcibios_iov_resource_alignment(struct pci_dev *dev, int resno);
1310 #define PCI_VGA_STATE_CHANGE_BRIDGE (1 << 0)
1311 #define PCI_VGA_STATE_CHANGE_DECODES (1 << 1)
1313 int pci_set_vga_state(struct pci_dev *pdev, bool decode,
1314 unsigned int command_bits, u32 flags);
1316 #define PCI_IRQ_LEGACY (1 << 0) /* allow legacy interrupts */
1317 #define PCI_IRQ_MSI (1 << 1) /* allow MSI interrupts */
1318 #define PCI_IRQ_MSIX (1 << 2) /* allow MSI-X interrupts */
1319 #define PCI_IRQ_AFFINITY (1 << 3) /* auto-assign affinity */
1320 #define PCI_IRQ_ALL_TYPES \
1321 (PCI_IRQ_LEGACY | PCI_IRQ_MSI | PCI_IRQ_MSIX)
1323 /* kmem_cache style wrapper around pci_alloc_consistent() */
1325 #include <linux/pci-dma.h>
1326 #include <linux/dmapool.h>
1328 #define pci_pool dma_pool
1329 #define pci_pool_create(name, pdev, size, align, allocation) \
1330 dma_pool_create(name, &pdev->dev, size, align, allocation)
1331 #define pci_pool_destroy(pool) dma_pool_destroy(pool)
1332 #define pci_pool_alloc(pool, flags, handle) dma_pool_alloc(pool, flags, handle)
1333 #define pci_pool_zalloc(pool, flags, handle) \
1334 dma_pool_zalloc(pool, flags, handle)
1335 #define pci_pool_free(pool, vaddr, addr) dma_pool_free(pool, vaddr, addr)
1338 u32 vector; /* kernel uses to write allocated vector */
1339 u16 entry; /* driver uses to specify entry, OS writes */
1342 #ifdef CONFIG_PCI_MSI
1343 int pci_msi_vec_count(struct pci_dev *dev);
1344 void pci_disable_msi(struct pci_dev *dev);
1345 int pci_msix_vec_count(struct pci_dev *dev);
1346 void pci_disable_msix(struct pci_dev *dev);
1347 void pci_restore_msi_state(struct pci_dev *dev);
1348 int pci_msi_enabled(void);
1349 int pci_enable_msi(struct pci_dev *dev);
1350 int pci_enable_msix_range(struct pci_dev *dev, struct msix_entry *entries,
1351 int minvec, int maxvec);
1352 static inline int pci_enable_msix_exact(struct pci_dev *dev,
1353 struct msix_entry *entries, int nvec)
1355 int rc = pci_enable_msix_range(dev, entries, nvec, nvec);
1360 int pci_alloc_irq_vectors_affinity(struct pci_dev *dev, unsigned int min_vecs,
1361 unsigned int max_vecs, unsigned int flags,
1362 const struct irq_affinity *affd);
1364 void pci_free_irq_vectors(struct pci_dev *dev);
1365 int pci_irq_vector(struct pci_dev *dev, unsigned int nr);
1366 const struct cpumask *pci_irq_get_affinity(struct pci_dev *pdev, int vec);
1367 int pci_irq_get_node(struct pci_dev *pdev, int vec);
1370 static inline int pci_msi_vec_count(struct pci_dev *dev) { return -ENOSYS; }
1371 static inline void pci_disable_msi(struct pci_dev *dev) { }
1372 static inline int pci_msix_vec_count(struct pci_dev *dev) { return -ENOSYS; }
1373 static inline void pci_disable_msix(struct pci_dev *dev) { }
1374 static inline void pci_restore_msi_state(struct pci_dev *dev) { }
1375 static inline int pci_msi_enabled(void) { return 0; }
1376 static inline int pci_enable_msi(struct pci_dev *dev)
1378 static inline int pci_enable_msix_range(struct pci_dev *dev,
1379 struct msix_entry *entries, int minvec, int maxvec)
1381 static inline int pci_enable_msix_exact(struct pci_dev *dev,
1382 struct msix_entry *entries, int nvec)
1386 pci_alloc_irq_vectors_affinity(struct pci_dev *dev, unsigned int min_vecs,
1387 unsigned int max_vecs, unsigned int flags,
1388 const struct irq_affinity *aff_desc)
1390 if ((flags & PCI_IRQ_LEGACY) && min_vecs == 1 && dev->irq)
1395 static inline void pci_free_irq_vectors(struct pci_dev *dev)
1399 static inline int pci_irq_vector(struct pci_dev *dev, unsigned int nr)
1401 if (WARN_ON_ONCE(nr > 0))
1405 static inline const struct cpumask *pci_irq_get_affinity(struct pci_dev *pdev,
1408 return cpu_possible_mask;
1411 static inline int pci_irq_get_node(struct pci_dev *pdev, int vec)
1413 return first_online_node;
1418 pci_alloc_irq_vectors(struct pci_dev *dev, unsigned int min_vecs,
1419 unsigned int max_vecs, unsigned int flags)
1421 return pci_alloc_irq_vectors_affinity(dev, min_vecs, max_vecs, flags,
1426 * pci_irqd_intx_xlate() - Translate PCI INTx value to an IRQ domain hwirq
1427 * @d: the INTx IRQ domain
1428 * @node: the DT node for the device whose interrupt we're translating
1429 * @intspec: the interrupt specifier data from the DT
1430 * @intsize: the number of entries in @intspec
1431 * @out_hwirq: pointer at which to write the hwirq number
1432 * @out_type: pointer at which to write the interrupt type
1434 * Translate a PCI INTx interrupt number from device tree in the range 1-4, as
1435 * stored in the standard PCI_INTERRUPT_PIN register, to a value in the range
1436 * 0-3 suitable for use in a 4 entry IRQ domain. That is, subtract one from the
1437 * INTx value to obtain the hwirq number.
1439 * Returns 0 on success, or -EINVAL if the interrupt specifier is out of range.
1441 static inline int pci_irqd_intx_xlate(struct irq_domain *d,
1442 struct device_node *node,
1444 unsigned int intsize,
1445 unsigned long *out_hwirq,
1446 unsigned int *out_type)
1448 const u32 intx = intspec[0];
1450 if (intx < PCI_INTERRUPT_INTA || intx > PCI_INTERRUPT_INTD)
1453 *out_hwirq = intx - PCI_INTERRUPT_INTA;
1457 #ifdef CONFIG_PCIEPORTBUS
1458 extern bool pcie_ports_disabled;
1459 extern bool pcie_ports_auto;
1461 #define pcie_ports_disabled true
1462 #define pcie_ports_auto false
1465 #ifdef CONFIG_PCIEASPM
1466 bool pcie_aspm_support_enabled(void);
1468 static inline bool pcie_aspm_support_enabled(void) { return false; }
1471 #ifdef CONFIG_PCIEAER
1472 void pci_no_aer(void);
1473 bool pci_aer_available(void);
1474 int pci_aer_init(struct pci_dev *dev);
1476 static inline void pci_no_aer(void) { }
1477 static inline bool pci_aer_available(void) { return false; }
1478 static inline int pci_aer_init(struct pci_dev *d) { return -ENODEV; }
1481 #ifdef CONFIG_PCIE_ECRC
1482 void pcie_set_ecrc_checking(struct pci_dev *dev);
1483 void pcie_ecrc_get_policy(char *str);
1485 static inline void pcie_set_ecrc_checking(struct pci_dev *dev) { }
1486 static inline void pcie_ecrc_get_policy(char *str) { }
1489 #ifdef CONFIG_PCI_ATS
1490 /* Address Translation Service */
1491 void pci_ats_init(struct pci_dev *dev);
1492 int pci_enable_ats(struct pci_dev *dev, int ps);
1493 void pci_disable_ats(struct pci_dev *dev);
1494 int pci_ats_queue_depth(struct pci_dev *dev);
1496 static inline void pci_ats_init(struct pci_dev *d) { }
1497 static inline int pci_enable_ats(struct pci_dev *d, int ps) { return -ENODEV; }
1498 static inline void pci_disable_ats(struct pci_dev *d) { }
1499 static inline int pci_ats_queue_depth(struct pci_dev *d) { return -ENODEV; }
1502 #ifdef CONFIG_PCIE_PTM
1503 int pci_enable_ptm(struct pci_dev *dev, u8 *granularity);
1505 static inline int pci_enable_ptm(struct pci_dev *dev, u8 *granularity)
1509 void pci_cfg_access_lock(struct pci_dev *dev);
1510 bool pci_cfg_access_trylock(struct pci_dev *dev);
1511 void pci_cfg_access_unlock(struct pci_dev *dev);
1514 * PCI domain support. Sometimes called PCI segment (eg by ACPI),
1515 * a PCI domain is defined to be a set of PCI buses which share
1516 * configuration space.
1518 #ifdef CONFIG_PCI_DOMAINS
1519 extern int pci_domains_supported;
1520 int pci_get_new_domain_nr(void);
1522 enum { pci_domains_supported = 0 };
1523 static inline int pci_domain_nr(struct pci_bus *bus) { return 0; }
1524 static inline int pci_proc_domain(struct pci_bus *bus) { return 0; }
1525 static inline int pci_get_new_domain_nr(void) { return -ENOSYS; }
1526 #endif /* CONFIG_PCI_DOMAINS */
1529 * Generic implementation for PCI domain support. If your
1530 * architecture does not need custom management of PCI
1531 * domains then this implementation will be used
1533 #ifdef CONFIG_PCI_DOMAINS_GENERIC
1534 static inline int pci_domain_nr(struct pci_bus *bus)
1536 return bus->domain_nr;
1539 int acpi_pci_bus_find_domain_nr(struct pci_bus *bus);
1541 static inline int acpi_pci_bus_find_domain_nr(struct pci_bus *bus)
1544 int pci_bus_find_domain_nr(struct pci_bus *bus, struct device *parent);
1547 /* some architectures require additional setup to direct VGA traffic */
1548 typedef int (*arch_set_vga_state_t)(struct pci_dev *pdev, bool decode,
1549 unsigned int command_bits, u32 flags);
1550 void pci_register_set_vga_state(arch_set_vga_state_t func);
1553 pci_request_io_regions(struct pci_dev *pdev, const char *name)
1555 return pci_request_selected_regions(pdev,
1556 pci_select_bars(pdev, IORESOURCE_IO), name);
1560 pci_release_io_regions(struct pci_dev *pdev)
1562 return pci_release_selected_regions(pdev,
1563 pci_select_bars(pdev, IORESOURCE_IO));
1567 pci_request_mem_regions(struct pci_dev *pdev, const char *name)
1569 return pci_request_selected_regions(pdev,
1570 pci_select_bars(pdev, IORESOURCE_MEM), name);
1574 pci_release_mem_regions(struct pci_dev *pdev)
1576 return pci_release_selected_regions(pdev,
1577 pci_select_bars(pdev, IORESOURCE_MEM));
1580 #else /* CONFIG_PCI is not enabled */
1582 static inline void pci_set_flags(int flags) { }
1583 static inline void pci_add_flags(int flags) { }
1584 static inline void pci_clear_flags(int flags) { }
1585 static inline int pci_has_flag(int flag) { return 0; }
1588 * If the system does not have PCI, clearly these return errors. Define
1589 * these as simple inline functions to avoid hair in drivers.
1592 #define _PCI_NOP(o, s, t) \
1593 static inline int pci_##o##_config_##s(struct pci_dev *dev, \
1595 { return PCIBIOS_FUNC_NOT_SUPPORTED; }
1597 #define _PCI_NOP_ALL(o, x) _PCI_NOP(o, byte, u8 x) \
1598 _PCI_NOP(o, word, u16 x) \
1599 _PCI_NOP(o, dword, u32 x)
1600 _PCI_NOP_ALL(read, *)
1601 _PCI_NOP_ALL(write,)
1603 static inline struct pci_dev *pci_get_device(unsigned int vendor,
1604 unsigned int device,
1605 struct pci_dev *from)
1608 static inline struct pci_dev *pci_get_subsys(unsigned int vendor,
1609 unsigned int device,
1610 unsigned int ss_vendor,
1611 unsigned int ss_device,
1612 struct pci_dev *from)
1615 static inline struct pci_dev *pci_get_class(unsigned int class,
1616 struct pci_dev *from)
1619 #define pci_dev_present(ids) (0)
1620 #define no_pci_devices() (1)
1621 #define pci_dev_put(dev) do { } while (0)
1623 static inline void pci_set_master(struct pci_dev *dev) { }
1624 static inline int pci_enable_device(struct pci_dev *dev) { return -EIO; }
1625 static inline void pci_disable_device(struct pci_dev *dev) { }
1626 static inline int pci_assign_resource(struct pci_dev *dev, int i)
1628 static inline int __pci_register_driver(struct pci_driver *drv,
1629 struct module *owner)
1631 static inline int pci_register_driver(struct pci_driver *drv)
1633 static inline void pci_unregister_driver(struct pci_driver *drv) { }
1634 static inline int pci_find_capability(struct pci_dev *dev, int cap)
1636 static inline int pci_find_next_capability(struct pci_dev *dev, u8 post,
1639 static inline int pci_find_ext_capability(struct pci_dev *dev, int cap)
1642 /* Power management related routines */
1643 static inline int pci_save_state(struct pci_dev *dev) { return 0; }
1644 static inline void pci_restore_state(struct pci_dev *dev) { }
1645 static inline int pci_set_power_state(struct pci_dev *dev, pci_power_t state)
1647 static inline int pci_wake_from_d3(struct pci_dev *dev, bool enable)
1649 static inline pci_power_t pci_choose_state(struct pci_dev *dev,
1652 static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
1656 static inline struct resource *pci_find_resource(struct pci_dev *dev,
1657 struct resource *res)
1659 static inline int pci_request_regions(struct pci_dev *dev, const char *res_name)
1661 static inline void pci_release_regions(struct pci_dev *dev) { }
1663 static inline unsigned long pci_address_to_pio(phys_addr_t addr) { return -1; }
1665 static inline void pci_block_cfg_access(struct pci_dev *dev) { }
1666 static inline int pci_block_cfg_access_in_atomic(struct pci_dev *dev)
1668 static inline void pci_unblock_cfg_access(struct pci_dev *dev) { }
1670 static inline struct pci_bus *pci_find_next_bus(const struct pci_bus *from)
1672 static inline struct pci_dev *pci_get_slot(struct pci_bus *bus,
1675 static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
1678 static inline struct pci_dev *pci_get_domain_bus_and_slot(int domain,
1679 unsigned int bus, unsigned int devfn)
1682 static inline int pci_domain_nr(struct pci_bus *bus) { return 0; }
1683 static inline struct pci_dev *pci_dev_get(struct pci_dev *dev) { return NULL; }
1684 static inline int pci_get_new_domain_nr(void) { return -ENOSYS; }
1686 #define dev_is_pci(d) (false)
1687 #define dev_is_pf(d) (false)
1688 static inline bool pci_acs_enabled(struct pci_dev *pdev, u16 acs_flags)
1690 #endif /* CONFIG_PCI */
1692 /* Include architecture-dependent settings and functions */
1694 #include <asm/pci.h>
1696 /* These two functions provide almost identical functionality. Depennding
1697 * on the architecture, one will be implemented as a wrapper around the
1698 * other (in drivers/pci/mmap.c).
1700 * pci_mmap_resource_range() maps a specific BAR, and vm->vm_pgoff
1701 * is expected to be an offset within that region.
1703 * pci_mmap_page_range() is the legacy architecture-specific interface,
1704 * which accepts a "user visible" resource address converted by
1705 * pci_resource_to_user(), as used in the legacy mmap() interface in
1708 int pci_mmap_resource_range(struct pci_dev *dev, int bar,
1709 struct vm_area_struct *vma,
1710 enum pci_mmap_state mmap_state, int write_combine);
1711 int pci_mmap_page_range(struct pci_dev *pdev, int bar,
1712 struct vm_area_struct *vma,
1713 enum pci_mmap_state mmap_state, int write_combine);
1715 #ifndef arch_can_pci_mmap_wc
1716 #define arch_can_pci_mmap_wc() 0
1719 #ifndef arch_can_pci_mmap_io
1720 #define arch_can_pci_mmap_io() 0
1721 #define pci_iobar_pfn(pdev, bar, vma) (-EINVAL)
1723 int pci_iobar_pfn(struct pci_dev *pdev, int bar, struct vm_area_struct *vma);
1726 #ifndef pci_root_bus_fwnode
1727 #define pci_root_bus_fwnode(bus) NULL
1730 /* these helpers provide future and backwards compatibility
1731 * for accessing popular PCI BAR info */
1732 #define pci_resource_start(dev, bar) ((dev)->resource[(bar)].start)
1733 #define pci_resource_end(dev, bar) ((dev)->resource[(bar)].end)
1734 #define pci_resource_flags(dev, bar) ((dev)->resource[(bar)].flags)
1735 #define pci_resource_len(dev,bar) \
1736 ((pci_resource_start((dev), (bar)) == 0 && \
1737 pci_resource_end((dev), (bar)) == \
1738 pci_resource_start((dev), (bar))) ? 0 : \
1740 (pci_resource_end((dev), (bar)) - \
1741 pci_resource_start((dev), (bar)) + 1))
1743 /* Similar to the helpers above, these manipulate per-pci_dev
1744 * driver-specific data. They are really just a wrapper around
1745 * the generic device structure functions of these calls.
1747 static inline void *pci_get_drvdata(struct pci_dev *pdev)
1749 return dev_get_drvdata(&pdev->dev);
1752 static inline void pci_set_drvdata(struct pci_dev *pdev, void *data)
1754 dev_set_drvdata(&pdev->dev, data);
1757 /* If you want to know what to call your pci_dev, ask this function.
1758 * Again, it's a wrapper around the generic device.
1760 static inline const char *pci_name(const struct pci_dev *pdev)
1762 return dev_name(&pdev->dev);
1766 /* Some archs don't want to expose struct resource to userland as-is
1767 * in sysfs and /proc
1769 #ifdef HAVE_ARCH_PCI_RESOURCE_TO_USER
1770 void pci_resource_to_user(const struct pci_dev *dev, int bar,
1771 const struct resource *rsrc,
1772 resource_size_t *start, resource_size_t *end);
1774 static inline void pci_resource_to_user(const struct pci_dev *dev, int bar,
1775 const struct resource *rsrc, resource_size_t *start,
1776 resource_size_t *end)
1778 *start = rsrc->start;
1781 #endif /* HAVE_ARCH_PCI_RESOURCE_TO_USER */
1785 * The world is not perfect and supplies us with broken PCI devices.
1786 * For at least a part of these bugs we need a work-around, so both
1787 * generic (drivers/pci/quirks.c) and per-architecture code can define
1788 * fixup hooks to be called for particular buggy devices.
1792 u16 vendor; /* You can use PCI_ANY_ID here of course */
1793 u16 device; /* You can use PCI_ANY_ID here of course */
1794 u32 class; /* You can use PCI_ANY_ID here too */
1795 unsigned int class_shift; /* should be 0, 8, 16 */
1796 void (*hook)(struct pci_dev *dev);
1799 enum pci_fixup_pass {
1800 pci_fixup_early, /* Before probing BARs */
1801 pci_fixup_header, /* After reading configuration header */
1802 pci_fixup_final, /* Final phase of device fixups */
1803 pci_fixup_enable, /* pci_enable_device() time */
1804 pci_fixup_resume, /* pci_device_resume() */
1805 pci_fixup_suspend, /* pci_device_suspend() */
1806 pci_fixup_resume_early, /* pci_device_resume_early() */
1807 pci_fixup_suspend_late, /* pci_device_suspend_late() */
1810 /* Anonymous variables would be nice... */
1811 #define DECLARE_PCI_FIXUP_SECTION(section, name, vendor, device, class, \
1812 class_shift, hook) \
1813 static const struct pci_fixup __PASTE(__pci_fixup_##name,__LINE__) __used \
1814 __attribute__((__section__(#section), aligned((sizeof(void *))))) \
1815 = { vendor, device, class, class_shift, hook };
1817 #define DECLARE_PCI_FIXUP_CLASS_EARLY(vendor, device, class, \
1818 class_shift, hook) \
1819 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early, \
1820 hook, vendor, device, class, class_shift, hook)
1821 #define DECLARE_PCI_FIXUP_CLASS_HEADER(vendor, device, class, \
1822 class_shift, hook) \
1823 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header, \
1824 hook, vendor, device, class, class_shift, hook)
1825 #define DECLARE_PCI_FIXUP_CLASS_FINAL(vendor, device, class, \
1826 class_shift, hook) \
1827 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final, \
1828 hook, vendor, device, class, class_shift, hook)
1829 #define DECLARE_PCI_FIXUP_CLASS_ENABLE(vendor, device, class, \
1830 class_shift, hook) \
1831 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable, \
1832 hook, vendor, device, class, class_shift, hook)
1833 #define DECLARE_PCI_FIXUP_CLASS_RESUME(vendor, device, class, \
1834 class_shift, hook) \
1835 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume, \
1836 resume##hook, vendor, device, class, \
1838 #define DECLARE_PCI_FIXUP_CLASS_RESUME_EARLY(vendor, device, class, \
1839 class_shift, hook) \
1840 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early, \
1841 resume_early##hook, vendor, device, \
1842 class, class_shift, hook)
1843 #define DECLARE_PCI_FIXUP_CLASS_SUSPEND(vendor, device, class, \
1844 class_shift, hook) \
1845 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend, \
1846 suspend##hook, vendor, device, class, \
1848 #define DECLARE_PCI_FIXUP_CLASS_SUSPEND_LATE(vendor, device, class, \
1849 class_shift, hook) \
1850 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend_late, \
1851 suspend_late##hook, vendor, device, \
1852 class, class_shift, hook)
1854 #define DECLARE_PCI_FIXUP_EARLY(vendor, device, hook) \
1855 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early, \
1856 hook, vendor, device, PCI_ANY_ID, 0, hook)
1857 #define DECLARE_PCI_FIXUP_HEADER(vendor, device, hook) \
1858 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header, \
1859 hook, vendor, device, PCI_ANY_ID, 0, hook)
1860 #define DECLARE_PCI_FIXUP_FINAL(vendor, device, hook) \
1861 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final, \
1862 hook, vendor, device, PCI_ANY_ID, 0, hook)
1863 #define DECLARE_PCI_FIXUP_ENABLE(vendor, device, hook) \
1864 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable, \
1865 hook, vendor, device, PCI_ANY_ID, 0, hook)
1866 #define DECLARE_PCI_FIXUP_RESUME(vendor, device, hook) \
1867 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume, \
1868 resume##hook, vendor, device, \
1869 PCI_ANY_ID, 0, hook)
1870 #define DECLARE_PCI_FIXUP_RESUME_EARLY(vendor, device, hook) \
1871 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early, \
1872 resume_early##hook, vendor, device, \
1873 PCI_ANY_ID, 0, hook)
1874 #define DECLARE_PCI_FIXUP_SUSPEND(vendor, device, hook) \
1875 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend, \
1876 suspend##hook, vendor, device, \
1877 PCI_ANY_ID, 0, hook)
1878 #define DECLARE_PCI_FIXUP_SUSPEND_LATE(vendor, device, hook) \
1879 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend_late, \
1880 suspend_late##hook, vendor, device, \
1881 PCI_ANY_ID, 0, hook)
1883 #ifdef CONFIG_PCI_QUIRKS
1884 void pci_fixup_device(enum pci_fixup_pass pass, struct pci_dev *dev);
1885 int pci_dev_specific_acs_enabled(struct pci_dev *dev, u16 acs_flags);
1886 int pci_dev_specific_enable_acs(struct pci_dev *dev);
1888 static inline void pci_fixup_device(enum pci_fixup_pass pass,
1889 struct pci_dev *dev) { }
1890 static inline int pci_dev_specific_acs_enabled(struct pci_dev *dev,
1895 static inline int pci_dev_specific_enable_acs(struct pci_dev *dev)
1901 void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen);
1902 void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr);
1903 void __iomem * const *pcim_iomap_table(struct pci_dev *pdev);
1904 int pcim_iomap_regions(struct pci_dev *pdev, int mask, const char *name);
1905 int pcim_iomap_regions_request_all(struct pci_dev *pdev, int mask,
1907 void pcim_iounmap_regions(struct pci_dev *pdev, int mask);
1909 extern int pci_pci_problems;
1910 #define PCIPCI_FAIL 1 /* No PCI PCI DMA */
1911 #define PCIPCI_TRITON 2
1912 #define PCIPCI_NATOMA 4
1913 #define PCIPCI_VIAETBF 8
1914 #define PCIPCI_VSFX 16
1915 #define PCIPCI_ALIMAGIK 32 /* Need low latency setting */
1916 #define PCIAGP_FAIL 64 /* No PCI to AGP DMA */
1918 extern unsigned long pci_cardbus_io_size;
1919 extern unsigned long pci_cardbus_mem_size;
1920 extern u8 pci_dfl_cache_line_size;
1921 extern u8 pci_cache_line_size;
1923 extern unsigned long pci_hotplug_io_size;
1924 extern unsigned long pci_hotplug_mem_size;
1925 extern unsigned long pci_hotplug_bus_size;
1927 /* Architecture-specific versions may override these (weak) */
1928 void pcibios_disable_device(struct pci_dev *dev);
1929 void pcibios_set_master(struct pci_dev *dev);
1930 int pcibios_set_pcie_reset_state(struct pci_dev *dev,
1931 enum pcie_reset_state state);
1932 int pcibios_add_device(struct pci_dev *dev);
1933 void pcibios_release_device(struct pci_dev *dev);
1934 void pcibios_penalize_isa_irq(int irq, int active);
1935 int pcibios_alloc_irq(struct pci_dev *dev);
1936 void pcibios_free_irq(struct pci_dev *dev);
1938 #ifdef CONFIG_HIBERNATE_CALLBACKS
1939 extern struct dev_pm_ops pcibios_pm_ops;
1942 #if defined(CONFIG_PCI_MMCONFIG) || defined(CONFIG_ACPI_MCFG)
1943 void __init pci_mmcfg_early_init(void);
1944 void __init pci_mmcfg_late_init(void);
1946 static inline void pci_mmcfg_early_init(void) { }
1947 static inline void pci_mmcfg_late_init(void) { }
1950 int pci_ext_cfg_avail(void);
1952 void __iomem *pci_ioremap_bar(struct pci_dev *pdev, int bar);
1953 void __iomem *pci_ioremap_wc_bar(struct pci_dev *pdev, int bar);
1955 #ifdef CONFIG_PCI_IOV
1956 int pci_iov_virtfn_bus(struct pci_dev *dev, int id);
1957 int pci_iov_virtfn_devfn(struct pci_dev *dev, int id);
1959 int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn);
1960 void pci_disable_sriov(struct pci_dev *dev);
1961 int pci_iov_add_virtfn(struct pci_dev *dev, int id);
1962 void pci_iov_remove_virtfn(struct pci_dev *dev, int id);
1963 int pci_num_vf(struct pci_dev *dev);
1964 int pci_vfs_assigned(struct pci_dev *dev);
1965 int pci_sriov_set_totalvfs(struct pci_dev *dev, u16 numvfs);
1966 int pci_sriov_get_totalvfs(struct pci_dev *dev);
1967 resource_size_t pci_iov_resource_size(struct pci_dev *dev, int resno);
1968 void pci_vf_drivers_autoprobe(struct pci_dev *dev, bool probe);
1970 static inline int pci_iov_virtfn_bus(struct pci_dev *dev, int id)
1974 static inline int pci_iov_virtfn_devfn(struct pci_dev *dev, int id)
1978 static inline int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn)
1980 static inline int pci_iov_add_virtfn(struct pci_dev *dev, int id)
1984 static inline void pci_iov_remove_virtfn(struct pci_dev *dev,
1986 static inline void pci_disable_sriov(struct pci_dev *dev) { }
1987 static inline int pci_num_vf(struct pci_dev *dev) { return 0; }
1988 static inline int pci_vfs_assigned(struct pci_dev *dev)
1990 static inline int pci_sriov_set_totalvfs(struct pci_dev *dev, u16 numvfs)
1992 static inline int pci_sriov_get_totalvfs(struct pci_dev *dev)
1994 static inline resource_size_t pci_iov_resource_size(struct pci_dev *dev, int resno)
1996 static inline void pci_vf_drivers_autoprobe(struct pci_dev *dev, bool probe) { }
1999 #if defined(CONFIG_HOTPLUG_PCI) || defined(CONFIG_HOTPLUG_PCI_MODULE)
2000 void pci_hp_create_module_link(struct pci_slot *pci_slot);
2001 void pci_hp_remove_module_link(struct pci_slot *pci_slot);
2005 * pci_pcie_cap - get the saved PCIe capability offset
2008 * PCIe capability offset is calculated at PCI device initialization
2009 * time and saved in the data structure. This function returns saved
2010 * PCIe capability offset. Using this instead of pci_find_capability()
2011 * reduces unnecessary search in the PCI configuration space. If you
2012 * need to calculate PCIe capability offset from raw device for some
2013 * reasons, please use pci_find_capability() instead.
2015 static inline int pci_pcie_cap(struct pci_dev *dev)
2017 return dev->pcie_cap;
2021 * pci_is_pcie - check if the PCI device is PCI Express capable
2024 * Returns: true if the PCI device is PCI Express capable, false otherwise.
2026 static inline bool pci_is_pcie(struct pci_dev *dev)
2028 return pci_pcie_cap(dev);
2032 * pcie_caps_reg - get the PCIe Capabilities Register
2035 static inline u16 pcie_caps_reg(const struct pci_dev *dev)
2037 return dev->pcie_flags_reg;
2041 * pci_pcie_type - get the PCIe device/port type
2044 static inline int pci_pcie_type(const struct pci_dev *dev)
2046 return (pcie_caps_reg(dev) & PCI_EXP_FLAGS_TYPE) >> 4;
2049 static inline struct pci_dev *pcie_find_root_port(struct pci_dev *dev)
2052 if (!pci_is_pcie(dev))
2054 if (pci_pcie_type(dev) == PCI_EXP_TYPE_ROOT_PORT)
2056 if (!dev->bus->self)
2058 dev = dev->bus->self;
2063 void pci_request_acs(void);
2064 bool pci_acs_enabled(struct pci_dev *pdev, u16 acs_flags);
2065 bool pci_acs_path_enabled(struct pci_dev *start,
2066 struct pci_dev *end, u16 acs_flags);
2068 #define PCI_VPD_LRDT 0x80 /* Large Resource Data Type */
2069 #define PCI_VPD_LRDT_ID(x) ((x) | PCI_VPD_LRDT)
2071 /* Large Resource Data Type Tag Item Names */
2072 #define PCI_VPD_LTIN_ID_STRING 0x02 /* Identifier String */
2073 #define PCI_VPD_LTIN_RO_DATA 0x10 /* Read-Only Data */
2074 #define PCI_VPD_LTIN_RW_DATA 0x11 /* Read-Write Data */
2076 #define PCI_VPD_LRDT_ID_STRING PCI_VPD_LRDT_ID(PCI_VPD_LTIN_ID_STRING)
2077 #define PCI_VPD_LRDT_RO_DATA PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RO_DATA)
2078 #define PCI_VPD_LRDT_RW_DATA PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RW_DATA)
2080 /* Small Resource Data Type Tag Item Names */
2081 #define PCI_VPD_STIN_END 0x0f /* End */
2083 #define PCI_VPD_SRDT_END (PCI_VPD_STIN_END << 3)
2085 #define PCI_VPD_SRDT_TIN_MASK 0x78
2086 #define PCI_VPD_SRDT_LEN_MASK 0x07
2087 #define PCI_VPD_LRDT_TIN_MASK 0x7f
2089 #define PCI_VPD_LRDT_TAG_SIZE 3
2090 #define PCI_VPD_SRDT_TAG_SIZE 1
2092 #define PCI_VPD_INFO_FLD_HDR_SIZE 3
2094 #define PCI_VPD_RO_KEYWORD_PARTNO "PN"
2095 #define PCI_VPD_RO_KEYWORD_MFR_ID "MN"
2096 #define PCI_VPD_RO_KEYWORD_VENDOR0 "V0"
2097 #define PCI_VPD_RO_KEYWORD_CHKSUM "RV"
2100 * pci_vpd_lrdt_size - Extracts the Large Resource Data Type length
2101 * @lrdt: Pointer to the beginning of the Large Resource Data Type tag
2103 * Returns the extracted Large Resource Data Type length.
2105 static inline u16 pci_vpd_lrdt_size(const u8 *lrdt)
2107 return (u16)lrdt[1] + ((u16)lrdt[2] << 8);
2111 * pci_vpd_lrdt_tag - Extracts the Large Resource Data Type Tag Item
2112 * @lrdt: Pointer to the beginning of the Large Resource Data Type tag
2114 * Returns the extracted Large Resource Data Type Tag item.
2116 static inline u16 pci_vpd_lrdt_tag(const u8 *lrdt)
2118 return (u16)(lrdt[0] & PCI_VPD_LRDT_TIN_MASK);
2122 * pci_vpd_srdt_size - Extracts the Small Resource Data Type length
2123 * @srdt: Pointer to the beginning of the Small Resource Data Type tag
2125 * Returns the extracted Small Resource Data Type length.
2127 static inline u8 pci_vpd_srdt_size(const u8 *srdt)
2129 return (*srdt) & PCI_VPD_SRDT_LEN_MASK;
2133 * pci_vpd_srdt_tag - Extracts the Small Resource Data Type Tag Item
2134 * @srdt: Pointer to the beginning of the Small Resource Data Type tag
2136 * Returns the extracted Small Resource Data Type Tag Item.
2138 static inline u8 pci_vpd_srdt_tag(const u8 *srdt)
2140 return ((*srdt) & PCI_VPD_SRDT_TIN_MASK) >> 3;
2144 * pci_vpd_info_field_size - Extracts the information field length
2145 * @lrdt: Pointer to the beginning of an information field header
2147 * Returns the extracted information field length.
2149 static inline u8 pci_vpd_info_field_size(const u8 *info_field)
2151 return info_field[2];
2155 * pci_vpd_find_tag - Locates the Resource Data Type tag provided
2156 * @buf: Pointer to buffered vpd data
2157 * @off: The offset into the buffer at which to begin the search
2158 * @len: The length of the vpd buffer
2159 * @rdt: The Resource Data Type to search for
2161 * Returns the index where the Resource Data Type was found or
2162 * -ENOENT otherwise.
2164 int pci_vpd_find_tag(const u8 *buf, unsigned int off, unsigned int len, u8 rdt);
2167 * pci_vpd_find_info_keyword - Locates an information field keyword in the VPD
2168 * @buf: Pointer to buffered vpd data
2169 * @off: The offset into the buffer at which to begin the search
2170 * @len: The length of the buffer area, relative to off, in which to search
2171 * @kw: The keyword to search for
2173 * Returns the index where the information field keyword was found or
2174 * -ENOENT otherwise.
2176 int pci_vpd_find_info_keyword(const u8 *buf, unsigned int off,
2177 unsigned int len, const char *kw);
2179 /* PCI <-> OF binding helpers */
2183 void pci_set_of_node(struct pci_dev *dev);
2184 void pci_release_of_node(struct pci_dev *dev);
2185 void pci_set_bus_of_node(struct pci_bus *bus);
2186 void pci_release_bus_of_node(struct pci_bus *bus);
2187 struct irq_domain *pci_host_bridge_of_msi_domain(struct pci_bus *bus);
2189 /* Arch may override this (weak) */
2190 struct device_node *pcibios_get_phb_of_node(struct pci_bus *bus);
2192 static inline struct device_node *
2193 pci_device_to_OF_node(const struct pci_dev *pdev)
2195 return pdev ? pdev->dev.of_node : NULL;
2198 static inline struct device_node *pci_bus_to_OF_node(struct pci_bus *bus)
2200 return bus ? bus->dev.of_node : NULL;
2203 #else /* CONFIG_OF */
2204 static inline void pci_set_of_node(struct pci_dev *dev) { }
2205 static inline void pci_release_of_node(struct pci_dev *dev) { }
2206 static inline void pci_set_bus_of_node(struct pci_bus *bus) { }
2207 static inline void pci_release_bus_of_node(struct pci_bus *bus) { }
2208 static inline struct device_node *
2209 pci_device_to_OF_node(const struct pci_dev *pdev) { return NULL; }
2210 static inline struct irq_domain *
2211 pci_host_bridge_of_msi_domain(struct pci_bus *bus) { return NULL; }
2212 #endif /* CONFIG_OF */
2215 struct irq_domain *pci_host_bridge_acpi_msi_domain(struct pci_bus *bus);
2218 pci_msi_register_fwnode_provider(struct fwnode_handle *(*fn)(struct device *));
2220 static inline struct irq_domain *
2221 pci_host_bridge_acpi_msi_domain(struct pci_bus *bus) { return NULL; }
2225 static inline struct eeh_dev *pci_dev_to_eeh_dev(struct pci_dev *pdev)
2227 return pdev->dev.archdata.edev;
2231 void pci_add_dma_alias(struct pci_dev *dev, u8 devfn);
2232 bool pci_devs_are_dma_aliases(struct pci_dev *dev1, struct pci_dev *dev2);
2233 int pci_for_each_dma_alias(struct pci_dev *pdev,
2234 int (*fn)(struct pci_dev *pdev,
2235 u16 alias, void *data), void *data);
2237 /* helper functions for operation of device flag */
2238 static inline void pci_set_dev_assigned(struct pci_dev *pdev)
2240 pdev->dev_flags |= PCI_DEV_FLAGS_ASSIGNED;
2242 static inline void pci_clear_dev_assigned(struct pci_dev *pdev)
2244 pdev->dev_flags &= ~PCI_DEV_FLAGS_ASSIGNED;
2246 static inline bool pci_is_dev_assigned(struct pci_dev *pdev)
2248 return (pdev->dev_flags & PCI_DEV_FLAGS_ASSIGNED) == PCI_DEV_FLAGS_ASSIGNED;
2252 * pci_ari_enabled - query ARI forwarding status
2255 * Returns true if ARI forwarding is enabled.
2257 static inline bool pci_ari_enabled(struct pci_bus *bus)
2259 return bus->self && bus->self->ari_enabled;
2263 * pci_is_thunderbolt_attached - whether device is on a Thunderbolt daisy chain
2264 * @pdev: PCI device to check
2266 * Walk upwards from @pdev and check for each encountered bridge if it's part
2267 * of a Thunderbolt controller. Reaching the host bridge means @pdev is not
2268 * Thunderbolt-attached. (But rather soldered to the mainboard usually.)
2270 static inline bool pci_is_thunderbolt_attached(struct pci_dev *pdev)
2272 struct pci_dev *parent = pdev;
2274 if (pdev->is_thunderbolt)
2277 while ((parent = pci_upstream_bridge(parent)))
2278 if (parent->is_thunderbolt)
2285 * pci_uevent_ers - emit a uevent during recovery path of pci device
2286 * @pdev: pci device to check
2287 * @err_type: type of error event
2290 static inline void pci_uevent_ers(struct pci_dev *pdev,
2291 enum pci_ers_result err_type)
2297 case PCI_ERS_RESULT_NONE:
2298 case PCI_ERS_RESULT_CAN_RECOVER:
2299 envp[idx++] = "ERROR_EVENT=BEGIN_RECOVERY";
2300 envp[idx++] = "DEVICE_ONLINE=0";
2302 case PCI_ERS_RESULT_RECOVERED:
2303 envp[idx++] = "ERROR_EVENT=SUCCESSFUL_RECOVERY";
2304 envp[idx++] = "DEVICE_ONLINE=1";
2306 case PCI_ERS_RESULT_DISCONNECT:
2307 envp[idx++] = "ERROR_EVENT=FAILED_RECOVERY";
2308 envp[idx++] = "DEVICE_ONLINE=0";
2316 kobject_uevent_env(&pdev->dev.kobj, KOBJ_CHANGE, envp);
2320 /* provide the legacy pci_dma_* API */
2321 #include <linux/pci-dma-compat.h>
2323 #endif /* LINUX_PCI_H */