4 * PCI defines and function prototypes
5 * Copyright 1994, Drew Eckhardt
8 * For more information, please consult the following manuals (look at
9 * http://www.pcisig.com/ for how to get them):
11 * PCI BIOS Specification
12 * PCI Local Bus Specification
13 * PCI to PCI Bridge Specification
14 * PCI System Design Guide
20 #include <linux/mod_devicetable.h>
22 #include <linux/types.h>
23 #include <linux/init.h>
24 #include <linux/ioport.h>
25 #include <linux/list.h>
26 #include <linux/compiler.h>
27 #include <linux/errno.h>
28 #include <linux/kobject.h>
29 #include <linux/atomic.h>
30 #include <linux/device.h>
31 #include <linux/interrupt.h>
33 #include <linux/resource_ext.h>
34 #include <uapi/linux/pci.h>
36 #include <linux/pci_ids.h>
39 * The PCI interface treats multi-function devices as independent
40 * devices. The slot/function address of each device is encoded
41 * in a single byte as follows:
46 * PCI_DEVFN(), PCI_SLOT(), and PCI_FUNC() are defined in uapi/linux/pci.h.
47 * In the interest of not exposing interfaces to user-space unnecessarily,
48 * the following kernel-only defines are being added here.
50 #define PCI_DEVID(bus, devfn) ((((u16)(bus)) << 8) | (devfn))
51 /* return bus from PCI devid = ((u16)bus_number) << 8) | devfn */
52 #define PCI_BUS_NUM(x) (((x) >> 8) & 0xff)
54 /* pci_slot represents a physical slot */
56 struct pci_bus *bus; /* The bus this slot is on */
57 struct list_head list; /* node in list of slots on this bus */
58 struct hotplug_slot *hotplug; /* Hotplug info (migrate over time) */
59 unsigned char number; /* PCI_SLOT(pci_dev->devfn) */
63 static inline const char *pci_slot_name(const struct pci_slot *slot)
65 return kobject_name(&slot->kobj);
68 /* File state for mmap()s on /proc/bus/pci/X/Y */
75 * For PCI devices, the region numbers are assigned this way:
78 /* #0-5: standard PCI resources */
80 PCI_STD_RESOURCE_END = 5,
82 /* #6: expansion ROM resource */
85 /* device specific resources */
88 PCI_IOV_RESOURCE_END = PCI_IOV_RESOURCES + PCI_SRIOV_NUM_BARS - 1,
91 /* resources assigned to buses behind the bridge */
92 #define PCI_BRIDGE_RESOURCE_NUM 4
95 PCI_BRIDGE_RESOURCE_END = PCI_BRIDGE_RESOURCES +
96 PCI_BRIDGE_RESOURCE_NUM - 1,
98 /* total resources associated with a PCI device */
101 /* preserve this for compatibility */
102 DEVICE_COUNT_RESOURCE = PCI_NUM_RESOURCES,
106 * pci_power_t values must match the bits in the Capabilities PME_Support
107 * and Control/Status PowerState fields in the Power Management capability.
109 typedef int __bitwise pci_power_t;
111 #define PCI_D0 ((pci_power_t __force) 0)
112 #define PCI_D1 ((pci_power_t __force) 1)
113 #define PCI_D2 ((pci_power_t __force) 2)
114 #define PCI_D3hot ((pci_power_t __force) 3)
115 #define PCI_D3cold ((pci_power_t __force) 4)
116 #define PCI_UNKNOWN ((pci_power_t __force) 5)
117 #define PCI_POWER_ERROR ((pci_power_t __force) -1)
119 /* Remember to update this when the list above changes! */
120 extern const char *pci_power_names[];
122 static inline const char *pci_power_name(pci_power_t state)
124 return pci_power_names[1 + (__force int) state];
127 #define PCI_PM_D2_DELAY 200
128 #define PCI_PM_D3_WAIT 10
129 #define PCI_PM_D3COLD_WAIT 100
130 #define PCI_PM_BUS_WAIT 50
132 /** The pci_channel state describes connectivity between the CPU and
133 * the pci device. If some PCI bus between here and the pci device
134 * has crashed or locked up, this info is reflected here.
136 typedef unsigned int __bitwise pci_channel_state_t;
138 enum pci_channel_state {
139 /* I/O channel is in normal state */
140 pci_channel_io_normal = (__force pci_channel_state_t) 1,
142 /* I/O to channel is blocked */
143 pci_channel_io_frozen = (__force pci_channel_state_t) 2,
145 /* PCI card is dead */
146 pci_channel_io_perm_failure = (__force pci_channel_state_t) 3,
149 typedef unsigned int __bitwise pcie_reset_state_t;
151 enum pcie_reset_state {
152 /* Reset is NOT asserted (Use to deassert reset) */
153 pcie_deassert_reset = (__force pcie_reset_state_t) 1,
155 /* Use #PERST to reset PCIe device */
156 pcie_warm_reset = (__force pcie_reset_state_t) 2,
158 /* Use PCIe Hot Reset to reset device */
159 pcie_hot_reset = (__force pcie_reset_state_t) 3
162 typedef unsigned short __bitwise pci_dev_flags_t;
164 /* INTX_DISABLE in PCI_COMMAND register disables MSI
167 PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG = (__force pci_dev_flags_t) (1 << 0),
168 /* Device configuration is irrevocably lost if disabled into D3 */
169 PCI_DEV_FLAGS_NO_D3 = (__force pci_dev_flags_t) (1 << 1),
170 /* Provide indication device is assigned by a Virtual Machine Manager */
171 PCI_DEV_FLAGS_ASSIGNED = (__force pci_dev_flags_t) (1 << 2),
172 /* Flag for quirk use to store if quirk-specific ACS is enabled */
173 PCI_DEV_FLAGS_ACS_ENABLED_QUIRK = (__force pci_dev_flags_t) (1 << 3),
174 /* Use a PCIe-to-PCI bridge alias even if !pci_is_pcie */
175 PCI_DEV_FLAG_PCIE_BRIDGE_ALIAS = (__force pci_dev_flags_t) (1 << 5),
176 /* Do not use bus resets for device */
177 PCI_DEV_FLAGS_NO_BUS_RESET = (__force pci_dev_flags_t) (1 << 6),
178 /* Do not use PM reset even if device advertises NoSoftRst- */
179 PCI_DEV_FLAGS_NO_PM_RESET = (__force pci_dev_flags_t) (1 << 7),
180 /* Get VPD from function 0 VPD */
181 PCI_DEV_FLAGS_VPD_REF_F0 = (__force pci_dev_flags_t) (1 << 8),
182 /* a non-root bridge where translation occurs, stop alias search here */
183 PCI_DEV_FLAGS_BRIDGE_XLATE_ROOT = (__force pci_dev_flags_t) (1 << 9),
184 /* Do not use FLR even if device advertises PCI_AF_CAP */
185 PCI_DEV_FLAGS_NO_FLR_RESET = (__force pci_dev_flags_t) (1 << 10),
188 enum pci_irq_reroute_variant {
189 INTEL_IRQ_REROUTE_VARIANT = 1,
190 MAX_IRQ_REROUTE_VARIANTS = 3
193 typedef unsigned short __bitwise pci_bus_flags_t;
195 PCI_BUS_FLAGS_NO_MSI = (__force pci_bus_flags_t) 1,
196 PCI_BUS_FLAGS_NO_MMRBC = (__force pci_bus_flags_t) 2,
197 PCI_BUS_FLAGS_NO_AERSID = (__force pci_bus_flags_t) 4,
200 /* These values come from the PCI Express Spec */
201 enum pcie_link_width {
202 PCIE_LNK_WIDTH_RESRV = 0x00,
210 PCIE_LNK_WIDTH_UNKNOWN = 0xFF,
213 /* Based on the PCI Hotplug Spec, but some values are made up by us */
215 PCI_SPEED_33MHz = 0x00,
216 PCI_SPEED_66MHz = 0x01,
217 PCI_SPEED_66MHz_PCIX = 0x02,
218 PCI_SPEED_100MHz_PCIX = 0x03,
219 PCI_SPEED_133MHz_PCIX = 0x04,
220 PCI_SPEED_66MHz_PCIX_ECC = 0x05,
221 PCI_SPEED_100MHz_PCIX_ECC = 0x06,
222 PCI_SPEED_133MHz_PCIX_ECC = 0x07,
223 PCI_SPEED_66MHz_PCIX_266 = 0x09,
224 PCI_SPEED_100MHz_PCIX_266 = 0x0a,
225 PCI_SPEED_133MHz_PCIX_266 = 0x0b,
231 PCI_SPEED_66MHz_PCIX_533 = 0x11,
232 PCI_SPEED_100MHz_PCIX_533 = 0x12,
233 PCI_SPEED_133MHz_PCIX_533 = 0x13,
234 PCIE_SPEED_2_5GT = 0x14,
235 PCIE_SPEED_5_0GT = 0x15,
236 PCIE_SPEED_8_0GT = 0x16,
237 PCI_SPEED_UNKNOWN = 0xff,
240 struct pci_cap_saved_data {
247 struct pci_cap_saved_state {
248 struct hlist_node next;
249 struct pci_cap_saved_data cap;
253 struct pcie_link_state;
259 * The pci_dev structure is used to describe PCI devices.
262 struct list_head bus_list; /* node in per-bus list */
263 struct pci_bus *bus; /* bus this device is on */
264 struct pci_bus *subordinate; /* bus this device bridges to */
266 void *sysdata; /* hook for sys-specific extension */
267 struct proc_dir_entry *procent; /* device entry in /proc/bus/pci */
268 struct pci_slot *slot; /* Physical slot this device is in */
270 unsigned int devfn; /* encoded device & function index */
271 unsigned short vendor;
272 unsigned short device;
273 unsigned short subsystem_vendor;
274 unsigned short subsystem_device;
275 unsigned int class; /* 3 bytes: (base,sub,prog-if) */
276 u8 revision; /* PCI revision, low byte of class word */
277 u8 hdr_type; /* PCI header type (`multi' flag masked out) */
278 #ifdef CONFIG_PCIEAER
279 u16 aer_cap; /* AER capability offset */
281 u8 pcie_cap; /* PCIe capability offset */
282 u8 msi_cap; /* MSI capability offset */
283 u8 msix_cap; /* MSI-X capability offset */
284 u8 pcie_mpss:3; /* PCIe Max Payload Size Supported */
285 u8 rom_base_reg; /* which config register controls the ROM */
286 u8 pin; /* which interrupt pin this device uses */
287 u16 pcie_flags_reg; /* cached PCIe Capabilities Register */
288 unsigned long *dma_alias_mask;/* mask of enabled devfn aliases */
290 struct pci_driver *driver; /* which driver has allocated this device */
291 u64 dma_mask; /* Mask of the bits of bus address this
292 device implements. Normally this is
293 0xffffffff. You only need to change
294 this if your device has broken DMA
295 or supports 64-bit transfers. */
297 struct device_dma_parameters dma_parms;
299 pci_power_t current_state; /* Current operating state. In ACPI-speak,
300 this is D0-D3, D0 being fully functional,
302 u8 pm_cap; /* PM capability offset */
303 unsigned int pme_support:5; /* Bitmask of states from which PME#
305 unsigned int pme_interrupt:1;
306 unsigned int pme_poll:1; /* Poll device's PME status bit */
307 unsigned int d1_support:1; /* Low power state D1 is supported */
308 unsigned int d2_support:1; /* Low power state D2 is supported */
309 unsigned int no_d1d2:1; /* D1 and D2 are forbidden */
310 unsigned int no_d3cold:1; /* D3cold is forbidden */
311 unsigned int bridge_d3:1; /* Allow D3 for bridge */
312 unsigned int d3cold_allowed:1; /* D3cold is allowed by user */
313 unsigned int mmio_always_on:1; /* disallow turning off io/mem
314 decoding during bar sizing */
315 unsigned int wakeup_prepared:1;
316 unsigned int runtime_d3cold:1; /* whether go through runtime
317 D3cold, not set for devices
318 powered on/off by the
319 corresponding bridge */
320 unsigned int ignore_hotplug:1; /* Ignore hotplug events */
321 unsigned int hotplug_user_indicators:1; /* SlotCtl indicators
322 controlled exclusively by
324 unsigned int d3_delay; /* D3->D0 transition time in ms */
325 unsigned int d3cold_delay; /* D3cold->D0 transition time in ms */
327 #ifdef CONFIG_PCIEASPM
328 struct pcie_link_state *link_state; /* ASPM link state */
331 pci_channel_state_t error_state; /* current connectivity state */
332 struct device dev; /* Generic device interface */
334 int cfg_size; /* Size of configuration space */
337 * Instead of touching interrupt line and base address registers
338 * directly, use the values stored here. They might be different!
341 struct resource resource[DEVICE_COUNT_RESOURCE]; /* I/O and memory regions + expansion ROMs */
343 bool match_driver; /* Skip attaching driver */
344 /* These fields are used by common fixups */
345 unsigned int transparent:1; /* Subtractive decode PCI bridge */
346 unsigned int multifunction:1;/* Part of multi-function device */
347 /* keep track of device state */
348 unsigned int is_added:1;
349 unsigned int is_busmaster:1; /* device is busmaster */
350 unsigned int no_msi:1; /* device may not use msi */
351 unsigned int no_64bit_msi:1; /* device may only use 32-bit MSIs */
352 unsigned int block_cfg_access:1; /* config space access is blocked */
353 unsigned int broken_parity_status:1; /* Device generates false positive parity */
354 unsigned int irq_reroute_variant:2; /* device needs IRQ rerouting variant */
355 unsigned int msi_enabled:1;
356 unsigned int msix_enabled:1;
357 unsigned int ari_enabled:1; /* ARI forwarding */
358 unsigned int ats_enabled:1; /* Address Translation Service */
359 unsigned int is_managed:1;
360 unsigned int needs_freset:1; /* Dev requires fundamental reset */
361 unsigned int state_saved:1;
362 unsigned int is_physfn:1;
363 unsigned int is_virtfn:1;
364 unsigned int reset_fn:1;
365 unsigned int is_hotplug_bridge:1;
366 unsigned int __aer_firmware_first_valid:1;
367 unsigned int __aer_firmware_first:1;
368 unsigned int broken_intx_masking:1;
369 unsigned int io_window_1k:1; /* Intel P2P bridge 1K I/O windows */
370 unsigned int irq_managed:1;
371 unsigned int has_secondary_link:1;
372 unsigned int non_compliant_bars:1; /* broken BARs; ignore them */
373 pci_dev_flags_t dev_flags;
374 atomic_t enable_cnt; /* pci_enable_device has been called */
376 u32 saved_config_space[16]; /* config space saved at suspend time */
377 struct hlist_head saved_cap_space;
378 struct bin_attribute *rom_attr; /* attribute descriptor for sysfs ROM entry */
379 int rom_attr_enabled; /* has display of the rom attribute been enabled? */
380 struct bin_attribute *res_attr[DEVICE_COUNT_RESOURCE]; /* sysfs file for resources */
381 struct bin_attribute *res_attr_wc[DEVICE_COUNT_RESOURCE]; /* sysfs file for WC mapping of resources */
383 #ifdef CONFIG_PCIE_PTM
384 unsigned int ptm_root:1;
385 unsigned int ptm_enabled:1;
388 #ifdef CONFIG_PCI_MSI
389 const struct attribute_group **msi_irq_groups;
392 #ifdef CONFIG_PCI_ATS
394 struct pci_sriov *sriov; /* SR-IOV capability related */
395 struct pci_dev *physfn; /* the PF this VF is associated with */
397 u16 ats_cap; /* ATS Capability offset */
398 u8 ats_stu; /* ATS Smallest Translation Unit */
399 atomic_t ats_ref_cnt; /* number of VFs with ATS enabled */
401 phys_addr_t rom; /* Physical address of ROM if it's not from the BAR */
402 size_t romlen; /* Length of ROM if it's not from the BAR */
403 char *driver_override; /* Driver name to force a match */
405 unsigned long priv_flags; /* Private flags for the pci driver */
408 static inline struct pci_dev *pci_physfn(struct pci_dev *dev)
410 #ifdef CONFIG_PCI_IOV
417 struct pci_dev *pci_alloc_dev(struct pci_bus *bus);
419 #define to_pci_dev(n) container_of(n, struct pci_dev, dev)
420 #define for_each_pci_dev(d) while ((d = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, d)) != NULL)
422 static inline int pci_channel_offline(struct pci_dev *pdev)
424 return (pdev->error_state != pci_channel_io_normal);
427 struct pci_host_bridge {
429 struct pci_bus *bus; /* root bus */
433 struct list_head windows; /* resource_entry */
434 void (*release_fn)(struct pci_host_bridge *);
436 struct msi_controller *msi;
437 unsigned int ignore_reset_delay:1; /* for entire hierarchy */
438 /* Resource alignment requirements */
439 resource_size_t (*align_resource)(struct pci_dev *dev,
440 const struct resource *res,
441 resource_size_t start,
442 resource_size_t size,
443 resource_size_t align);
444 unsigned long private[0] ____cacheline_aligned;
447 #define to_pci_host_bridge(n) container_of(n, struct pci_host_bridge, dev)
449 static inline void *pci_host_bridge_priv(struct pci_host_bridge *bridge)
451 return (void *)bridge->private;
454 static inline struct pci_host_bridge *pci_host_bridge_from_priv(void *priv)
456 return container_of(priv, struct pci_host_bridge, private);
459 struct pci_host_bridge *pci_alloc_host_bridge(size_t priv);
460 int pci_register_host_bridge(struct pci_host_bridge *bridge);
461 struct pci_host_bridge *pci_find_host_bridge(struct pci_bus *bus);
463 void pci_set_host_bridge_release(struct pci_host_bridge *bridge,
464 void (*release_fn)(struct pci_host_bridge *),
467 int pcibios_root_bridge_prepare(struct pci_host_bridge *bridge);
470 * The first PCI_BRIDGE_RESOURCE_NUM PCI bus resources (those that correspond
471 * to P2P or CardBus bridge windows) go in a table. Additional ones (for
472 * buses below host bridges or subtractive decode bridges) go in the list.
473 * Use pci_bus_for_each_resource() to iterate through all the resources.
477 * PCI_SUBTRACTIVE_DECODE means the bridge forwards the window implicitly
478 * and there's no way to program the bridge with the details of the window.
479 * This does not apply to ACPI _CRS windows, even with the _DEC subtractive-
480 * decode bit set, because they are explicit and can be programmed with _SRS.
482 #define PCI_SUBTRACTIVE_DECODE 0x1
484 struct pci_bus_resource {
485 struct list_head list;
486 struct resource *res;
490 #define PCI_REGION_FLAG_MASK 0x0fU /* These bits of resource flags tell us the PCI region flags */
493 struct list_head node; /* node in list of buses */
494 struct pci_bus *parent; /* parent bus this bridge is on */
495 struct list_head children; /* list of child buses */
496 struct list_head devices; /* list of devices on this bus */
497 struct pci_dev *self; /* bridge device as seen by parent */
498 struct list_head slots; /* list of slots on this bus;
499 protected by pci_slot_mutex */
500 struct resource *resource[PCI_BRIDGE_RESOURCE_NUM];
501 struct list_head resources; /* address space routed to this bus */
502 struct resource busn_res; /* bus numbers routed to this bus */
504 struct pci_ops *ops; /* configuration access functions */
505 struct msi_controller *msi; /* MSI controller */
506 void *sysdata; /* hook for sys-specific extension */
507 struct proc_dir_entry *procdir; /* directory entry in /proc/bus/pci */
509 unsigned char number; /* bus number */
510 unsigned char primary; /* number of primary bridge */
511 unsigned char max_bus_speed; /* enum pci_bus_speed */
512 unsigned char cur_bus_speed; /* enum pci_bus_speed */
513 #ifdef CONFIG_PCI_DOMAINS_GENERIC
519 unsigned short bridge_ctl; /* manage NO_ISA/FBB/et al behaviors */
520 pci_bus_flags_t bus_flags; /* inherited by child buses */
521 struct device *bridge;
523 struct bin_attribute *legacy_io; /* legacy I/O for this bus */
524 struct bin_attribute *legacy_mem; /* legacy mem */
525 unsigned int is_added:1;
528 #define to_pci_bus(n) container_of(n, struct pci_bus, dev)
531 * Returns true if the PCI bus is root (behind host-PCI bridge),
534 * Some code assumes that "bus->self == NULL" means that bus is a root bus.
535 * This is incorrect because "virtual" buses added for SR-IOV (via
536 * virtfn_add_bus()) have "bus->self == NULL" but are not root buses.
538 static inline bool pci_is_root_bus(struct pci_bus *pbus)
540 return !(pbus->parent);
544 * pci_is_bridge - check if the PCI device is a bridge
547 * Return true if the PCI device is bridge whether it has subordinate
550 static inline bool pci_is_bridge(struct pci_dev *dev)
552 return dev->hdr_type == PCI_HEADER_TYPE_BRIDGE ||
553 dev->hdr_type == PCI_HEADER_TYPE_CARDBUS;
556 static inline struct pci_dev *pci_upstream_bridge(struct pci_dev *dev)
558 dev = pci_physfn(dev);
559 if (pci_is_root_bus(dev->bus))
562 return dev->bus->self;
565 struct device *pci_get_host_bridge_device(struct pci_dev *dev);
566 void pci_put_host_bridge_device(struct device *dev);
568 #ifdef CONFIG_PCI_MSI
569 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev)
571 return pci_dev->msi_enabled || pci_dev->msix_enabled;
574 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev) { return false; }
578 * Error values that may be returned by PCI functions.
580 #define PCIBIOS_SUCCESSFUL 0x00
581 #define PCIBIOS_FUNC_NOT_SUPPORTED 0x81
582 #define PCIBIOS_BAD_VENDOR_ID 0x83
583 #define PCIBIOS_DEVICE_NOT_FOUND 0x86
584 #define PCIBIOS_BAD_REGISTER_NUMBER 0x87
585 #define PCIBIOS_SET_FAILED 0x88
586 #define PCIBIOS_BUFFER_TOO_SMALL 0x89
589 * Translate above to generic errno for passing back through non-PCI code.
591 static inline int pcibios_err_to_errno(int err)
593 if (err <= PCIBIOS_SUCCESSFUL)
594 return err; /* Assume already errno */
597 case PCIBIOS_FUNC_NOT_SUPPORTED:
599 case PCIBIOS_BAD_VENDOR_ID:
601 case PCIBIOS_DEVICE_NOT_FOUND:
603 case PCIBIOS_BAD_REGISTER_NUMBER:
605 case PCIBIOS_SET_FAILED:
607 case PCIBIOS_BUFFER_TOO_SMALL:
614 /* Low-level architecture-dependent routines */
617 int (*add_bus)(struct pci_bus *bus);
618 void (*remove_bus)(struct pci_bus *bus);
619 void __iomem *(*map_bus)(struct pci_bus *bus, unsigned int devfn, int where);
620 int (*read)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 *val);
621 int (*write)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 val);
625 * ACPI needs to be able to access PCI config space before we've done a
626 * PCI bus scan and created pci_bus structures.
628 int raw_pci_read(unsigned int domain, unsigned int bus, unsigned int devfn,
629 int reg, int len, u32 *val);
630 int raw_pci_write(unsigned int domain, unsigned int bus, unsigned int devfn,
631 int reg, int len, u32 val);
633 #ifdef CONFIG_PCI_BUS_ADDR_T_64BIT
634 typedef u64 pci_bus_addr_t;
636 typedef u32 pci_bus_addr_t;
639 struct pci_bus_region {
640 pci_bus_addr_t start;
645 spinlock_t lock; /* protects list, index */
646 struct list_head list; /* for IDs added at runtime */
651 * PCI Error Recovery System (PCI-ERS). If a PCI device driver provides
652 * a set of callbacks in struct pci_error_handlers, that device driver
653 * will be notified of PCI bus errors, and will be driven to recovery
654 * when an error occurs.
657 typedef unsigned int __bitwise pci_ers_result_t;
659 enum pci_ers_result {
660 /* no result/none/not supported in device driver */
661 PCI_ERS_RESULT_NONE = (__force pci_ers_result_t) 1,
663 /* Device driver can recover without slot reset */
664 PCI_ERS_RESULT_CAN_RECOVER = (__force pci_ers_result_t) 2,
666 /* Device driver wants slot to be reset. */
667 PCI_ERS_RESULT_NEED_RESET = (__force pci_ers_result_t) 3,
669 /* Device has completely failed, is unrecoverable */
670 PCI_ERS_RESULT_DISCONNECT = (__force pci_ers_result_t) 4,
672 /* Device driver is fully recovered and operational */
673 PCI_ERS_RESULT_RECOVERED = (__force pci_ers_result_t) 5,
675 /* No AER capabilities registered for the driver */
676 PCI_ERS_RESULT_NO_AER_DRIVER = (__force pci_ers_result_t) 6,
679 /* PCI bus error event callbacks */
680 struct pci_error_handlers {
681 /* PCI bus error detected on this device */
682 pci_ers_result_t (*error_detected)(struct pci_dev *dev,
683 enum pci_channel_state error);
685 /* MMIO has been re-enabled, but not DMA */
686 pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev);
688 /* PCI slot has been reset */
689 pci_ers_result_t (*slot_reset)(struct pci_dev *dev);
691 /* PCI function reset prepare or completed */
692 void (*reset_notify)(struct pci_dev *dev, bool prepare);
694 /* Device driver may resume normal operations */
695 void (*resume)(struct pci_dev *dev);
701 struct list_head node;
703 const struct pci_device_id *id_table; /* must be non-NULL for probe to be called */
704 int (*probe) (struct pci_dev *dev, const struct pci_device_id *id); /* New device inserted */
705 void (*remove) (struct pci_dev *dev); /* Device removed (NULL if not a hot-plug capable driver) */
706 int (*suspend) (struct pci_dev *dev, pm_message_t state); /* Device suspended */
707 int (*suspend_late) (struct pci_dev *dev, pm_message_t state);
708 int (*resume_early) (struct pci_dev *dev);
709 int (*resume) (struct pci_dev *dev); /* Device woken up */
710 void (*shutdown) (struct pci_dev *dev);
711 int (*sriov_configure) (struct pci_dev *dev, int num_vfs); /* PF pdev */
712 const struct pci_error_handlers *err_handler;
713 struct device_driver driver;
714 struct pci_dynids dynids;
717 #define to_pci_driver(drv) container_of(drv, struct pci_driver, driver)
720 * PCI_DEVICE - macro used to describe a specific pci device
721 * @vend: the 16 bit PCI Vendor ID
722 * @dev: the 16 bit PCI Device ID
724 * This macro is used to create a struct pci_device_id that matches a
725 * specific device. The subvendor and subdevice fields will be set to
728 #define PCI_DEVICE(vend,dev) \
729 .vendor = (vend), .device = (dev), \
730 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
733 * PCI_DEVICE_SUB - macro used to describe a specific pci device with subsystem
734 * @vend: the 16 bit PCI Vendor ID
735 * @dev: the 16 bit PCI Device ID
736 * @subvend: the 16 bit PCI Subvendor ID
737 * @subdev: the 16 bit PCI Subdevice ID
739 * This macro is used to create a struct pci_device_id that matches a
740 * specific device with subsystem information.
742 #define PCI_DEVICE_SUB(vend, dev, subvend, subdev) \
743 .vendor = (vend), .device = (dev), \
744 .subvendor = (subvend), .subdevice = (subdev)
747 * PCI_DEVICE_CLASS - macro used to describe a specific pci device class
748 * @dev_class: the class, subclass, prog-if triple for this device
749 * @dev_class_mask: the class mask for this device
751 * This macro is used to create a struct pci_device_id that matches a
752 * specific PCI class. The vendor, device, subvendor, and subdevice
753 * fields will be set to PCI_ANY_ID.
755 #define PCI_DEVICE_CLASS(dev_class,dev_class_mask) \
756 .class = (dev_class), .class_mask = (dev_class_mask), \
757 .vendor = PCI_ANY_ID, .device = PCI_ANY_ID, \
758 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
761 * PCI_VDEVICE - macro used to describe a specific pci device in short form
762 * @vend: the vendor name
763 * @dev: the 16 bit PCI Device ID
765 * This macro is used to create a struct pci_device_id that matches a
766 * specific PCI device. The subvendor, and subdevice fields will be set
767 * to PCI_ANY_ID. The macro allows the next field to follow as the device
771 #define PCI_VDEVICE(vend, dev) \
772 .vendor = PCI_VENDOR_ID_##vend, .device = (dev), \
773 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, 0, 0
776 PCI_REASSIGN_ALL_RSRC = 0x00000001, /* ignore firmware setup */
777 PCI_REASSIGN_ALL_BUS = 0x00000002, /* reassign all bus numbers */
778 PCI_PROBE_ONLY = 0x00000004, /* use existing setup */
779 PCI_CAN_SKIP_ISA_ALIGN = 0x00000008, /* don't do ISA alignment */
780 PCI_ENABLE_PROC_DOMAINS = 0x00000010, /* enable domains in /proc */
781 PCI_COMPAT_DOMAIN_0 = 0x00000020, /* ... except domain 0 */
782 PCI_SCAN_ALL_PCIE_DEVS = 0x00000040, /* scan all, not just dev 0 */
785 /* these external functions are only available when PCI support is enabled */
788 extern unsigned int pci_flags;
790 static inline void pci_set_flags(int flags) { pci_flags = flags; }
791 static inline void pci_add_flags(int flags) { pci_flags |= flags; }
792 static inline void pci_clear_flags(int flags) { pci_flags &= ~flags; }
793 static inline int pci_has_flag(int flag) { return pci_flags & flag; }
795 void pcie_bus_configure_settings(struct pci_bus *bus);
797 enum pcie_bus_config_types {
798 PCIE_BUS_TUNE_OFF, /* don't touch MPS at all */
799 PCIE_BUS_DEFAULT, /* ensure MPS matches upstream bridge */
800 PCIE_BUS_SAFE, /* use largest MPS boot-time devices support */
801 PCIE_BUS_PERFORMANCE, /* use MPS and MRRS for best performance */
802 PCIE_BUS_PEER2PEER, /* set MPS = 128 for all devices */
805 extern enum pcie_bus_config_types pcie_bus_config;
807 extern struct bus_type pci_bus_type;
809 /* Do NOT directly access these two variables, unless you are arch-specific PCI
810 * code, or PCI core code. */
811 extern struct list_head pci_root_buses; /* list of all known PCI buses */
812 /* Some device drivers need know if PCI is initiated */
813 int no_pci_devices(void);
815 void pcibios_resource_survey_bus(struct pci_bus *bus);
816 void pcibios_bus_add_device(struct pci_dev *pdev);
817 void pcibios_add_bus(struct pci_bus *bus);
818 void pcibios_remove_bus(struct pci_bus *bus);
819 void pcibios_fixup_bus(struct pci_bus *);
820 int __must_check pcibios_enable_device(struct pci_dev *, int mask);
821 /* Architecture-specific versions may override this (weak) */
822 char *pcibios_setup(char *str);
824 /* Used only when drivers/pci/setup.c is used */
825 resource_size_t pcibios_align_resource(void *, const struct resource *,
828 void pcibios_update_irq(struct pci_dev *, int irq);
830 /* Weak but can be overriden by arch */
831 void pci_fixup_cardbus(struct pci_bus *);
833 /* Generic PCI functions used internally */
835 void pcibios_resource_to_bus(struct pci_bus *bus, struct pci_bus_region *region,
836 struct resource *res);
837 void pcibios_bus_to_resource(struct pci_bus *bus, struct resource *res,
838 struct pci_bus_region *region);
839 void pcibios_scan_specific_bus(int busn);
840 struct pci_bus *pci_find_bus(int domain, int busnr);
841 void pci_bus_add_devices(const struct pci_bus *bus);
842 struct pci_bus *pci_scan_bus(int bus, struct pci_ops *ops, void *sysdata);
843 struct pci_bus *pci_create_root_bus(struct device *parent, int bus,
844 struct pci_ops *ops, void *sysdata,
845 struct list_head *resources);
846 int pci_bus_insert_busn_res(struct pci_bus *b, int bus, int busmax);
847 int pci_bus_update_busn_res_end(struct pci_bus *b, int busmax);
848 void pci_bus_release_busn_res(struct pci_bus *b);
849 struct pci_bus *pci_scan_root_bus_msi(struct device *parent, int bus,
850 struct pci_ops *ops, void *sysdata,
851 struct list_head *resources,
852 struct msi_controller *msi);
853 struct pci_bus *pci_scan_root_bus(struct device *parent, int bus,
854 struct pci_ops *ops, void *sysdata,
855 struct list_head *resources);
856 struct pci_bus *pci_add_new_bus(struct pci_bus *parent, struct pci_dev *dev,
858 void pcie_update_link_speed(struct pci_bus *bus, u16 link_status);
859 struct pci_slot *pci_create_slot(struct pci_bus *parent, int slot_nr,
861 struct hotplug_slot *hotplug);
862 void pci_destroy_slot(struct pci_slot *slot);
864 void pci_dev_assign_slot(struct pci_dev *dev);
866 static inline void pci_dev_assign_slot(struct pci_dev *dev) { }
868 int pci_scan_slot(struct pci_bus *bus, int devfn);
869 struct pci_dev *pci_scan_single_device(struct pci_bus *bus, int devfn);
870 void pci_device_add(struct pci_dev *dev, struct pci_bus *bus);
871 unsigned int pci_scan_child_bus(struct pci_bus *bus);
872 void pci_bus_add_device(struct pci_dev *dev);
873 void pci_read_bridge_bases(struct pci_bus *child);
874 struct resource *pci_find_parent_resource(const struct pci_dev *dev,
875 struct resource *res);
876 struct pci_dev *pci_find_pcie_root_port(struct pci_dev *dev);
877 u8 pci_swizzle_interrupt_pin(const struct pci_dev *dev, u8 pin);
878 int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge);
879 u8 pci_common_swizzle(struct pci_dev *dev, u8 *pinp);
880 struct pci_dev *pci_dev_get(struct pci_dev *dev);
881 void pci_dev_put(struct pci_dev *dev);
882 void pci_remove_bus(struct pci_bus *b);
883 void pci_stop_and_remove_bus_device(struct pci_dev *dev);
884 void pci_stop_and_remove_bus_device_locked(struct pci_dev *dev);
885 void pci_stop_root_bus(struct pci_bus *bus);
886 void pci_remove_root_bus(struct pci_bus *bus);
887 void pci_setup_cardbus(struct pci_bus *bus);
888 void pcibios_setup_bridge(struct pci_bus *bus, unsigned long type);
889 void pci_sort_breadthfirst(void);
890 #define dev_is_pci(d) ((d)->bus == &pci_bus_type)
891 #define dev_is_pf(d) ((dev_is_pci(d) ? to_pci_dev(d)->is_physfn : false))
893 /* Generic PCI functions exported to card drivers */
895 enum pci_lost_interrupt_reason {
896 PCI_LOST_IRQ_NO_INFORMATION = 0,
897 PCI_LOST_IRQ_DISABLE_MSI,
898 PCI_LOST_IRQ_DISABLE_MSIX,
899 PCI_LOST_IRQ_DISABLE_ACPI,
901 enum pci_lost_interrupt_reason pci_lost_interrupt(struct pci_dev *dev);
902 int pci_find_capability(struct pci_dev *dev, int cap);
903 int pci_find_next_capability(struct pci_dev *dev, u8 pos, int cap);
904 int pci_find_ext_capability(struct pci_dev *dev, int cap);
905 int pci_find_next_ext_capability(struct pci_dev *dev, int pos, int cap);
906 int pci_find_ht_capability(struct pci_dev *dev, int ht_cap);
907 int pci_find_next_ht_capability(struct pci_dev *dev, int pos, int ht_cap);
908 struct pci_bus *pci_find_next_bus(const struct pci_bus *from);
910 struct pci_dev *pci_get_device(unsigned int vendor, unsigned int device,
911 struct pci_dev *from);
912 struct pci_dev *pci_get_subsys(unsigned int vendor, unsigned int device,
913 unsigned int ss_vendor, unsigned int ss_device,
914 struct pci_dev *from);
915 struct pci_dev *pci_get_slot(struct pci_bus *bus, unsigned int devfn);
916 struct pci_dev *pci_get_domain_bus_and_slot(int domain, unsigned int bus,
918 static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
921 return pci_get_domain_bus_and_slot(0, bus, devfn);
923 struct pci_dev *pci_get_class(unsigned int class, struct pci_dev *from);
924 int pci_dev_present(const struct pci_device_id *ids);
926 int pci_bus_read_config_byte(struct pci_bus *bus, unsigned int devfn,
928 int pci_bus_read_config_word(struct pci_bus *bus, unsigned int devfn,
929 int where, u16 *val);
930 int pci_bus_read_config_dword(struct pci_bus *bus, unsigned int devfn,
931 int where, u32 *val);
932 int pci_bus_write_config_byte(struct pci_bus *bus, unsigned int devfn,
934 int pci_bus_write_config_word(struct pci_bus *bus, unsigned int devfn,
936 int pci_bus_write_config_dword(struct pci_bus *bus, unsigned int devfn,
939 int pci_generic_config_read(struct pci_bus *bus, unsigned int devfn,
940 int where, int size, u32 *val);
941 int pci_generic_config_write(struct pci_bus *bus, unsigned int devfn,
942 int where, int size, u32 val);
943 int pci_generic_config_read32(struct pci_bus *bus, unsigned int devfn,
944 int where, int size, u32 *val);
945 int pci_generic_config_write32(struct pci_bus *bus, unsigned int devfn,
946 int where, int size, u32 val);
948 struct pci_ops *pci_bus_set_ops(struct pci_bus *bus, struct pci_ops *ops);
950 int pci_read_config_byte(const struct pci_dev *dev, int where, u8 *val);
951 int pci_read_config_word(const struct pci_dev *dev, int where, u16 *val);
952 int pci_read_config_dword(const struct pci_dev *dev, int where, u32 *val);
953 int pci_write_config_byte(const struct pci_dev *dev, int where, u8 val);
954 int pci_write_config_word(const struct pci_dev *dev, int where, u16 val);
955 int pci_write_config_dword(const struct pci_dev *dev, int where, u32 val);
957 int pcie_capability_read_word(struct pci_dev *dev, int pos, u16 *val);
958 int pcie_capability_read_dword(struct pci_dev *dev, int pos, u32 *val);
959 int pcie_capability_write_word(struct pci_dev *dev, int pos, u16 val);
960 int pcie_capability_write_dword(struct pci_dev *dev, int pos, u32 val);
961 int pcie_capability_clear_and_set_word(struct pci_dev *dev, int pos,
963 int pcie_capability_clear_and_set_dword(struct pci_dev *dev, int pos,
966 static inline int pcie_capability_set_word(struct pci_dev *dev, int pos,
969 return pcie_capability_clear_and_set_word(dev, pos, 0, set);
972 static inline int pcie_capability_set_dword(struct pci_dev *dev, int pos,
975 return pcie_capability_clear_and_set_dword(dev, pos, 0, set);
978 static inline int pcie_capability_clear_word(struct pci_dev *dev, int pos,
981 return pcie_capability_clear_and_set_word(dev, pos, clear, 0);
984 static inline int pcie_capability_clear_dword(struct pci_dev *dev, int pos,
987 return pcie_capability_clear_and_set_dword(dev, pos, clear, 0);
990 /* user-space driven config access */
991 int pci_user_read_config_byte(struct pci_dev *dev, int where, u8 *val);
992 int pci_user_read_config_word(struct pci_dev *dev, int where, u16 *val);
993 int pci_user_read_config_dword(struct pci_dev *dev, int where, u32 *val);
994 int pci_user_write_config_byte(struct pci_dev *dev, int where, u8 val);
995 int pci_user_write_config_word(struct pci_dev *dev, int where, u16 val);
996 int pci_user_write_config_dword(struct pci_dev *dev, int where, u32 val);
998 int __must_check pci_enable_device(struct pci_dev *dev);
999 int __must_check pci_enable_device_io(struct pci_dev *dev);
1000 int __must_check pci_enable_device_mem(struct pci_dev *dev);
1001 int __must_check pci_reenable_device(struct pci_dev *);
1002 int __must_check pcim_enable_device(struct pci_dev *pdev);
1003 void pcim_pin_device(struct pci_dev *pdev);
1005 static inline int pci_is_enabled(struct pci_dev *pdev)
1007 return (atomic_read(&pdev->enable_cnt) > 0);
1010 static inline int pci_is_managed(struct pci_dev *pdev)
1012 return pdev->is_managed;
1015 void pci_disable_device(struct pci_dev *dev);
1017 extern unsigned int pcibios_max_latency;
1018 void pci_set_master(struct pci_dev *dev);
1019 void pci_clear_master(struct pci_dev *dev);
1021 int pci_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state);
1022 int pci_set_cacheline_size(struct pci_dev *dev);
1023 #define HAVE_PCI_SET_MWI
1024 int __must_check pci_set_mwi(struct pci_dev *dev);
1025 int pci_try_set_mwi(struct pci_dev *dev);
1026 void pci_clear_mwi(struct pci_dev *dev);
1027 void pci_intx(struct pci_dev *dev, int enable);
1028 bool pci_intx_mask_supported(struct pci_dev *dev);
1029 bool pci_check_and_mask_intx(struct pci_dev *dev);
1030 bool pci_check_and_unmask_intx(struct pci_dev *dev);
1031 int pci_wait_for_pending(struct pci_dev *dev, int pos, u16 mask);
1032 int pci_wait_for_pending_transaction(struct pci_dev *dev);
1033 int pcix_get_max_mmrbc(struct pci_dev *dev);
1034 int pcix_get_mmrbc(struct pci_dev *dev);
1035 int pcix_set_mmrbc(struct pci_dev *dev, int mmrbc);
1036 int pcie_get_readrq(struct pci_dev *dev);
1037 int pcie_set_readrq(struct pci_dev *dev, int rq);
1038 int pcie_get_mps(struct pci_dev *dev);
1039 int pcie_set_mps(struct pci_dev *dev, int mps);
1040 int pcie_get_minimum_link(struct pci_dev *dev, enum pci_bus_speed *speed,
1041 enum pcie_link_width *width);
1042 void pcie_flr(struct pci_dev *dev);
1043 int __pci_reset_function(struct pci_dev *dev);
1044 int __pci_reset_function_locked(struct pci_dev *dev);
1045 int pci_reset_function(struct pci_dev *dev);
1046 int pci_try_reset_function(struct pci_dev *dev);
1047 int pci_probe_reset_slot(struct pci_slot *slot);
1048 int pci_reset_slot(struct pci_slot *slot);
1049 int pci_try_reset_slot(struct pci_slot *slot);
1050 int pci_probe_reset_bus(struct pci_bus *bus);
1051 int pci_reset_bus(struct pci_bus *bus);
1052 int pci_try_reset_bus(struct pci_bus *bus);
1053 void pci_reset_secondary_bus(struct pci_dev *dev);
1054 void pcibios_reset_secondary_bus(struct pci_dev *dev);
1055 void pci_reset_bridge_secondary_bus(struct pci_dev *dev);
1056 void pci_update_resource(struct pci_dev *dev, int resno);
1057 int __must_check pci_assign_resource(struct pci_dev *dev, int i);
1058 int __must_check pci_reassign_resource(struct pci_dev *dev, int i, resource_size_t add_size, resource_size_t align);
1059 int pci_select_bars(struct pci_dev *dev, unsigned long flags);
1060 bool pci_device_is_present(struct pci_dev *pdev);
1061 void pci_ignore_hotplug(struct pci_dev *dev);
1063 int __printf(6, 7) pci_request_irq(struct pci_dev *dev, unsigned int nr,
1064 irq_handler_t handler, irq_handler_t thread_fn, void *dev_id,
1065 const char *fmt, ...);
1066 void pci_free_irq(struct pci_dev *dev, unsigned int nr, void *dev_id);
1068 /* ROM control related routines */
1069 int pci_enable_rom(struct pci_dev *pdev);
1070 void pci_disable_rom(struct pci_dev *pdev);
1071 void __iomem __must_check *pci_map_rom(struct pci_dev *pdev, size_t *size);
1072 void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom);
1073 size_t pci_get_rom_size(struct pci_dev *pdev, void __iomem *rom, size_t size);
1074 void __iomem __must_check *pci_platform_rom(struct pci_dev *pdev, size_t *size);
1076 /* Power management related routines */
1077 int pci_save_state(struct pci_dev *dev);
1078 void pci_restore_state(struct pci_dev *dev);
1079 struct pci_saved_state *pci_store_saved_state(struct pci_dev *dev);
1080 int pci_load_saved_state(struct pci_dev *dev,
1081 struct pci_saved_state *state);
1082 int pci_load_and_free_saved_state(struct pci_dev *dev,
1083 struct pci_saved_state **state);
1084 struct pci_cap_saved_state *pci_find_saved_cap(struct pci_dev *dev, char cap);
1085 struct pci_cap_saved_state *pci_find_saved_ext_cap(struct pci_dev *dev,
1087 int pci_add_cap_save_buffer(struct pci_dev *dev, char cap, unsigned int size);
1088 int pci_add_ext_cap_save_buffer(struct pci_dev *dev,
1089 u16 cap, unsigned int size);
1090 int __pci_complete_power_transition(struct pci_dev *dev, pci_power_t state);
1091 int pci_set_power_state(struct pci_dev *dev, pci_power_t state);
1092 pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state);
1093 bool pci_pme_capable(struct pci_dev *dev, pci_power_t state);
1094 void pci_pme_active(struct pci_dev *dev, bool enable);
1095 int __pci_enable_wake(struct pci_dev *dev, pci_power_t state,
1096 bool runtime, bool enable);
1097 int pci_wake_from_d3(struct pci_dev *dev, bool enable);
1098 int pci_prepare_to_sleep(struct pci_dev *dev);
1099 int pci_back_from_sleep(struct pci_dev *dev);
1100 bool pci_dev_run_wake(struct pci_dev *dev);
1101 bool pci_check_pme_status(struct pci_dev *dev);
1102 void pci_pme_wakeup_bus(struct pci_bus *bus);
1103 void pci_d3cold_enable(struct pci_dev *dev);
1104 void pci_d3cold_disable(struct pci_dev *dev);
1106 static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
1109 return __pci_enable_wake(dev, state, false, enable);
1112 /* PCI Virtual Channel */
1113 int pci_save_vc_state(struct pci_dev *dev);
1114 void pci_restore_vc_state(struct pci_dev *dev);
1115 void pci_allocate_vc_save_buffers(struct pci_dev *dev);
1117 /* For use by arch with custom probe code */
1118 void set_pcie_port_type(struct pci_dev *pdev);
1119 void set_pcie_hotplug_bridge(struct pci_dev *pdev);
1121 /* Functions for PCI Hotplug drivers to use */
1122 int pci_bus_find_capability(struct pci_bus *bus, unsigned int devfn, int cap);
1123 unsigned int pci_rescan_bus_bridge_resize(struct pci_dev *bridge);
1124 unsigned int pci_rescan_bus(struct pci_bus *bus);
1125 void pci_lock_rescan_remove(void);
1126 void pci_unlock_rescan_remove(void);
1128 /* Vital product data routines */
1129 ssize_t pci_read_vpd(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
1130 ssize_t pci_write_vpd(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
1131 int pci_set_vpd_size(struct pci_dev *dev, size_t len);
1133 /* Helper functions for low-level code (drivers/pci/setup-[bus,res].c) */
1134 resource_size_t pcibios_retrieve_fw_addr(struct pci_dev *dev, int idx);
1135 void pci_bus_assign_resources(const struct pci_bus *bus);
1136 void pci_bus_claim_resources(struct pci_bus *bus);
1137 void pci_bus_size_bridges(struct pci_bus *bus);
1138 int pci_claim_resource(struct pci_dev *, int);
1139 int pci_claim_bridge_resource(struct pci_dev *bridge, int i);
1140 void pci_assign_unassigned_resources(void);
1141 void pci_assign_unassigned_bridge_resources(struct pci_dev *bridge);
1142 void pci_assign_unassigned_bus_resources(struct pci_bus *bus);
1143 void pci_assign_unassigned_root_bus_resources(struct pci_bus *bus);
1144 void pdev_enable_device(struct pci_dev *);
1145 int pci_enable_resources(struct pci_dev *, int mask);
1146 void pci_fixup_irqs(u8 (*)(struct pci_dev *, u8 *),
1147 int (*)(const struct pci_dev *, u8, u8));
1148 struct resource *pci_find_resource(struct pci_dev *dev, struct resource *res);
1149 #define HAVE_PCI_REQ_REGIONS 2
1150 int __must_check pci_request_regions(struct pci_dev *, const char *);
1151 int __must_check pci_request_regions_exclusive(struct pci_dev *, const char *);
1152 void pci_release_regions(struct pci_dev *);
1153 int __must_check pci_request_region(struct pci_dev *, int, const char *);
1154 int __must_check pci_request_region_exclusive(struct pci_dev *, int, const char *);
1155 void pci_release_region(struct pci_dev *, int);
1156 int pci_request_selected_regions(struct pci_dev *, int, const char *);
1157 int pci_request_selected_regions_exclusive(struct pci_dev *, int, const char *);
1158 void pci_release_selected_regions(struct pci_dev *, int);
1160 /* drivers/pci/bus.c */
1161 struct pci_bus *pci_bus_get(struct pci_bus *bus);
1162 void pci_bus_put(struct pci_bus *bus);
1163 void pci_add_resource(struct list_head *resources, struct resource *res);
1164 void pci_add_resource_offset(struct list_head *resources, struct resource *res,
1165 resource_size_t offset);
1166 void pci_free_resource_list(struct list_head *resources);
1167 void pci_bus_add_resource(struct pci_bus *bus, struct resource *res,
1168 unsigned int flags);
1169 struct resource *pci_bus_resource_n(const struct pci_bus *bus, int n);
1170 void pci_bus_remove_resources(struct pci_bus *bus);
1171 int devm_request_pci_bus_resources(struct device *dev,
1172 struct list_head *resources);
1174 #define pci_bus_for_each_resource(bus, res, i) \
1176 (res = pci_bus_resource_n(bus, i)) || i < PCI_BRIDGE_RESOURCE_NUM; \
1179 int __must_check pci_bus_alloc_resource(struct pci_bus *bus,
1180 struct resource *res, resource_size_t size,
1181 resource_size_t align, resource_size_t min,
1182 unsigned long type_mask,
1183 resource_size_t (*alignf)(void *,
1184 const struct resource *,
1190 int pci_register_io_range(phys_addr_t addr, resource_size_t size);
1191 unsigned long pci_address_to_pio(phys_addr_t addr);
1192 phys_addr_t pci_pio_to_address(unsigned long pio);
1193 int pci_remap_iospace(const struct resource *res, phys_addr_t phys_addr);
1194 void pci_unmap_iospace(struct resource *res);
1195 void __iomem *devm_pci_remap_cfgspace(struct device *dev,
1196 resource_size_t offset,
1197 resource_size_t size);
1198 void __iomem *devm_pci_remap_cfg_resource(struct device *dev,
1199 struct resource *res);
1201 static inline pci_bus_addr_t pci_bus_address(struct pci_dev *pdev, int bar)
1203 struct pci_bus_region region;
1205 pcibios_resource_to_bus(pdev->bus, ®ion, &pdev->resource[bar]);
1206 return region.start;
1209 /* Proper probing supporting hot-pluggable devices */
1210 int __must_check __pci_register_driver(struct pci_driver *, struct module *,
1211 const char *mod_name);
1214 * pci_register_driver must be a macro so that KBUILD_MODNAME can be expanded
1216 #define pci_register_driver(driver) \
1217 __pci_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
1219 void pci_unregister_driver(struct pci_driver *dev);
1222 * module_pci_driver() - Helper macro for registering a PCI driver
1223 * @__pci_driver: pci_driver struct
1225 * Helper macro for PCI drivers which do not do anything special in module
1226 * init/exit. This eliminates a lot of boilerplate. Each module may only
1227 * use this macro once, and calling it replaces module_init() and module_exit()
1229 #define module_pci_driver(__pci_driver) \
1230 module_driver(__pci_driver, pci_register_driver, \
1231 pci_unregister_driver)
1234 * builtin_pci_driver() - Helper macro for registering a PCI driver
1235 * @__pci_driver: pci_driver struct
1237 * Helper macro for PCI drivers which do not do anything special in their
1238 * init code. This eliminates a lot of boilerplate. Each driver may only
1239 * use this macro once, and calling it replaces device_initcall(...)
1241 #define builtin_pci_driver(__pci_driver) \
1242 builtin_driver(__pci_driver, pci_register_driver)
1244 struct pci_driver *pci_dev_driver(const struct pci_dev *dev);
1245 int pci_add_dynid(struct pci_driver *drv,
1246 unsigned int vendor, unsigned int device,
1247 unsigned int subvendor, unsigned int subdevice,
1248 unsigned int class, unsigned int class_mask,
1249 unsigned long driver_data);
1250 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
1251 struct pci_dev *dev);
1252 int pci_scan_bridge(struct pci_bus *bus, struct pci_dev *dev, int max,
1255 void pci_walk_bus(struct pci_bus *top, int (*cb)(struct pci_dev *, void *),
1257 int pci_cfg_space_size(struct pci_dev *dev);
1258 unsigned char pci_bus_max_busnr(struct pci_bus *bus);
1259 void pci_setup_bridge(struct pci_bus *bus);
1260 resource_size_t pcibios_window_alignment(struct pci_bus *bus,
1261 unsigned long type);
1262 resource_size_t pcibios_iov_resource_alignment(struct pci_dev *dev, int resno);
1264 #define PCI_VGA_STATE_CHANGE_BRIDGE (1 << 0)
1265 #define PCI_VGA_STATE_CHANGE_DECODES (1 << 1)
1267 int pci_set_vga_state(struct pci_dev *pdev, bool decode,
1268 unsigned int command_bits, u32 flags);
1270 #define PCI_IRQ_LEGACY (1 << 0) /* allow legacy interrupts */
1271 #define PCI_IRQ_MSI (1 << 1) /* allow MSI interrupts */
1272 #define PCI_IRQ_MSIX (1 << 2) /* allow MSI-X interrupts */
1273 #define PCI_IRQ_AFFINITY (1 << 3) /* auto-assign affinity */
1274 #define PCI_IRQ_ALL_TYPES \
1275 (PCI_IRQ_LEGACY | PCI_IRQ_MSI | PCI_IRQ_MSIX)
1277 /* kmem_cache style wrapper around pci_alloc_consistent() */
1279 #include <linux/pci-dma.h>
1280 #include <linux/dmapool.h>
1282 #define pci_pool dma_pool
1283 #define pci_pool_create(name, pdev, size, align, allocation) \
1284 dma_pool_create(name, &pdev->dev, size, align, allocation)
1285 #define pci_pool_destroy(pool) dma_pool_destroy(pool)
1286 #define pci_pool_alloc(pool, flags, handle) dma_pool_alloc(pool, flags, handle)
1287 #define pci_pool_zalloc(pool, flags, handle) \
1288 dma_pool_zalloc(pool, flags, handle)
1289 #define pci_pool_free(pool, vaddr, addr) dma_pool_free(pool, vaddr, addr)
1292 u32 vector; /* kernel uses to write allocated vector */
1293 u16 entry; /* driver uses to specify entry, OS writes */
1296 #ifdef CONFIG_PCI_MSI
1297 int pci_msi_vec_count(struct pci_dev *dev);
1298 void pci_disable_msi(struct pci_dev *dev);
1299 int pci_msix_vec_count(struct pci_dev *dev);
1300 int pci_enable_msix(struct pci_dev *dev, struct msix_entry *entries, int nvec);
1301 void pci_disable_msix(struct pci_dev *dev);
1302 void pci_restore_msi_state(struct pci_dev *dev);
1303 int pci_msi_enabled(void);
1304 int pci_enable_msi(struct pci_dev *dev);
1305 int pci_enable_msix_range(struct pci_dev *dev, struct msix_entry *entries,
1306 int minvec, int maxvec);
1307 static inline int pci_enable_msix_exact(struct pci_dev *dev,
1308 struct msix_entry *entries, int nvec)
1310 int rc = pci_enable_msix_range(dev, entries, nvec, nvec);
1315 int pci_alloc_irq_vectors_affinity(struct pci_dev *dev, unsigned int min_vecs,
1316 unsigned int max_vecs, unsigned int flags,
1317 const struct irq_affinity *affd);
1319 void pci_free_irq_vectors(struct pci_dev *dev);
1320 int pci_irq_vector(struct pci_dev *dev, unsigned int nr);
1321 const struct cpumask *pci_irq_get_affinity(struct pci_dev *pdev, int vec);
1322 int pci_irq_get_node(struct pci_dev *pdev, int vec);
1325 static inline int pci_msi_vec_count(struct pci_dev *dev) { return -ENOSYS; }
1326 static inline void pci_disable_msi(struct pci_dev *dev) { }
1327 static inline int pci_msix_vec_count(struct pci_dev *dev) { return -ENOSYS; }
1328 static inline int pci_enable_msix(struct pci_dev *dev,
1329 struct msix_entry *entries, int nvec)
1331 static inline void pci_disable_msix(struct pci_dev *dev) { }
1332 static inline void pci_restore_msi_state(struct pci_dev *dev) { }
1333 static inline int pci_msi_enabled(void) { return 0; }
1334 static inline int pci_enable_msi(struct pci_dev *dev)
1336 static inline int pci_enable_msix_range(struct pci_dev *dev,
1337 struct msix_entry *entries, int minvec, int maxvec)
1339 static inline int pci_enable_msix_exact(struct pci_dev *dev,
1340 struct msix_entry *entries, int nvec)
1344 pci_alloc_irq_vectors_affinity(struct pci_dev *dev, unsigned int min_vecs,
1345 unsigned int max_vecs, unsigned int flags,
1346 const struct irq_affinity *aff_desc)
1353 static inline void pci_free_irq_vectors(struct pci_dev *dev)
1357 static inline int pci_irq_vector(struct pci_dev *dev, unsigned int nr)
1359 if (WARN_ON_ONCE(nr > 0))
1363 static inline const struct cpumask *pci_irq_get_affinity(struct pci_dev *pdev,
1366 return cpu_possible_mask;
1369 static inline int pci_irq_get_node(struct pci_dev *pdev, int vec)
1371 return first_online_node;
1376 pci_alloc_irq_vectors(struct pci_dev *dev, unsigned int min_vecs,
1377 unsigned int max_vecs, unsigned int flags)
1379 return pci_alloc_irq_vectors_affinity(dev, min_vecs, max_vecs, flags,
1383 #ifdef CONFIG_PCIEPORTBUS
1384 extern bool pcie_ports_disabled;
1385 extern bool pcie_ports_auto;
1387 #define pcie_ports_disabled true
1388 #define pcie_ports_auto false
1391 #ifdef CONFIG_PCIEASPM
1392 bool pcie_aspm_support_enabled(void);
1394 static inline bool pcie_aspm_support_enabled(void) { return false; }
1397 #ifdef CONFIG_PCIEAER
1398 void pci_no_aer(void);
1399 bool pci_aer_available(void);
1400 int pci_aer_init(struct pci_dev *dev);
1402 static inline void pci_no_aer(void) { }
1403 static inline bool pci_aer_available(void) { return false; }
1404 static inline int pci_aer_init(struct pci_dev *d) { return -ENODEV; }
1407 #ifdef CONFIG_PCIE_ECRC
1408 void pcie_set_ecrc_checking(struct pci_dev *dev);
1409 void pcie_ecrc_get_policy(char *str);
1411 static inline void pcie_set_ecrc_checking(struct pci_dev *dev) { }
1412 static inline void pcie_ecrc_get_policy(char *str) { }
1415 #ifdef CONFIG_HT_IRQ
1416 /* The functions a driver should call */
1417 int ht_create_irq(struct pci_dev *dev, int idx);
1418 void ht_destroy_irq(unsigned int irq);
1419 #endif /* CONFIG_HT_IRQ */
1421 #ifdef CONFIG_PCI_ATS
1422 /* Address Translation Service */
1423 void pci_ats_init(struct pci_dev *dev);
1424 int pci_enable_ats(struct pci_dev *dev, int ps);
1425 void pci_disable_ats(struct pci_dev *dev);
1426 int pci_ats_queue_depth(struct pci_dev *dev);
1428 static inline void pci_ats_init(struct pci_dev *d) { }
1429 static inline int pci_enable_ats(struct pci_dev *d, int ps) { return -ENODEV; }
1430 static inline void pci_disable_ats(struct pci_dev *d) { }
1431 static inline int pci_ats_queue_depth(struct pci_dev *d) { return -ENODEV; }
1434 #ifdef CONFIG_PCIE_PTM
1435 int pci_enable_ptm(struct pci_dev *dev, u8 *granularity);
1437 static inline int pci_enable_ptm(struct pci_dev *dev, u8 *granularity)
1441 void pci_cfg_access_lock(struct pci_dev *dev);
1442 bool pci_cfg_access_trylock(struct pci_dev *dev);
1443 void pci_cfg_access_unlock(struct pci_dev *dev);
1446 * PCI domain support. Sometimes called PCI segment (eg by ACPI),
1447 * a PCI domain is defined to be a set of PCI buses which share
1448 * configuration space.
1450 #ifdef CONFIG_PCI_DOMAINS
1451 extern int pci_domains_supported;
1452 int pci_get_new_domain_nr(void);
1454 enum { pci_domains_supported = 0 };
1455 static inline int pci_domain_nr(struct pci_bus *bus) { return 0; }
1456 static inline int pci_proc_domain(struct pci_bus *bus) { return 0; }
1457 static inline int pci_get_new_domain_nr(void) { return -ENOSYS; }
1458 #endif /* CONFIG_PCI_DOMAINS */
1461 * Generic implementation for PCI domain support. If your
1462 * architecture does not need custom management of PCI
1463 * domains then this implementation will be used
1465 #ifdef CONFIG_PCI_DOMAINS_GENERIC
1466 static inline int pci_domain_nr(struct pci_bus *bus)
1468 return bus->domain_nr;
1471 int acpi_pci_bus_find_domain_nr(struct pci_bus *bus);
1473 static inline int acpi_pci_bus_find_domain_nr(struct pci_bus *bus)
1476 int pci_bus_find_domain_nr(struct pci_bus *bus, struct device *parent);
1479 /* some architectures require additional setup to direct VGA traffic */
1480 typedef int (*arch_set_vga_state_t)(struct pci_dev *pdev, bool decode,
1481 unsigned int command_bits, u32 flags);
1482 void pci_register_set_vga_state(arch_set_vga_state_t func);
1485 pci_request_io_regions(struct pci_dev *pdev, const char *name)
1487 return pci_request_selected_regions(pdev,
1488 pci_select_bars(pdev, IORESOURCE_IO), name);
1492 pci_release_io_regions(struct pci_dev *pdev)
1494 return pci_release_selected_regions(pdev,
1495 pci_select_bars(pdev, IORESOURCE_IO));
1499 pci_request_mem_regions(struct pci_dev *pdev, const char *name)
1501 return pci_request_selected_regions(pdev,
1502 pci_select_bars(pdev, IORESOURCE_MEM), name);
1506 pci_release_mem_regions(struct pci_dev *pdev)
1508 return pci_release_selected_regions(pdev,
1509 pci_select_bars(pdev, IORESOURCE_MEM));
1512 #else /* CONFIG_PCI is not enabled */
1514 static inline void pci_set_flags(int flags) { }
1515 static inline void pci_add_flags(int flags) { }
1516 static inline void pci_clear_flags(int flags) { }
1517 static inline int pci_has_flag(int flag) { return 0; }
1520 * If the system does not have PCI, clearly these return errors. Define
1521 * these as simple inline functions to avoid hair in drivers.
1524 #define _PCI_NOP(o, s, t) \
1525 static inline int pci_##o##_config_##s(struct pci_dev *dev, \
1527 { return PCIBIOS_FUNC_NOT_SUPPORTED; }
1529 #define _PCI_NOP_ALL(o, x) _PCI_NOP(o, byte, u8 x) \
1530 _PCI_NOP(o, word, u16 x) \
1531 _PCI_NOP(o, dword, u32 x)
1532 _PCI_NOP_ALL(read, *)
1533 _PCI_NOP_ALL(write,)
1535 static inline struct pci_dev *pci_get_device(unsigned int vendor,
1536 unsigned int device,
1537 struct pci_dev *from)
1540 static inline struct pci_dev *pci_get_subsys(unsigned int vendor,
1541 unsigned int device,
1542 unsigned int ss_vendor,
1543 unsigned int ss_device,
1544 struct pci_dev *from)
1547 static inline struct pci_dev *pci_get_class(unsigned int class,
1548 struct pci_dev *from)
1551 #define pci_dev_present(ids) (0)
1552 #define no_pci_devices() (1)
1553 #define pci_dev_put(dev) do { } while (0)
1555 static inline void pci_set_master(struct pci_dev *dev) { }
1556 static inline int pci_enable_device(struct pci_dev *dev) { return -EIO; }
1557 static inline void pci_disable_device(struct pci_dev *dev) { }
1558 static inline int pci_assign_resource(struct pci_dev *dev, int i)
1560 static inline int __pci_register_driver(struct pci_driver *drv,
1561 struct module *owner)
1563 static inline int pci_register_driver(struct pci_driver *drv)
1565 static inline void pci_unregister_driver(struct pci_driver *drv) { }
1566 static inline int pci_find_capability(struct pci_dev *dev, int cap)
1568 static inline int pci_find_next_capability(struct pci_dev *dev, u8 post,
1571 static inline int pci_find_ext_capability(struct pci_dev *dev, int cap)
1574 /* Power management related routines */
1575 static inline int pci_save_state(struct pci_dev *dev) { return 0; }
1576 static inline void pci_restore_state(struct pci_dev *dev) { }
1577 static inline int pci_set_power_state(struct pci_dev *dev, pci_power_t state)
1579 static inline int pci_wake_from_d3(struct pci_dev *dev, bool enable)
1581 static inline pci_power_t pci_choose_state(struct pci_dev *dev,
1584 static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
1588 static inline struct resource *pci_find_resource(struct pci_dev *dev,
1589 struct resource *res)
1591 static inline int pci_request_regions(struct pci_dev *dev, const char *res_name)
1593 static inline void pci_release_regions(struct pci_dev *dev) { }
1595 static inline unsigned long pci_address_to_pio(phys_addr_t addr) { return -1; }
1597 static inline void pci_block_cfg_access(struct pci_dev *dev) { }
1598 static inline int pci_block_cfg_access_in_atomic(struct pci_dev *dev)
1600 static inline void pci_unblock_cfg_access(struct pci_dev *dev) { }
1602 static inline struct pci_bus *pci_find_next_bus(const struct pci_bus *from)
1604 static inline struct pci_dev *pci_get_slot(struct pci_bus *bus,
1607 static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
1611 static inline int pci_domain_nr(struct pci_bus *bus) { return 0; }
1612 static inline struct pci_dev *pci_dev_get(struct pci_dev *dev) { return NULL; }
1613 static inline int pci_get_new_domain_nr(void) { return -ENOSYS; }
1615 #define dev_is_pci(d) (false)
1616 #define dev_is_pf(d) (false)
1617 #endif /* CONFIG_PCI */
1619 /* Include architecture-dependent settings and functions */
1621 #include <asm/pci.h>
1623 /* These two functions provide almost identical functionality. Depennding
1624 * on the architecture, one will be implemented as a wrapper around the
1625 * other (in drivers/pci/mmap.c).
1627 * pci_mmap_resource_range() maps a specific BAR, and vm->vm_pgoff
1628 * is expected to be an offset within that region.
1630 * pci_mmap_page_range() is the legacy architecture-specific interface,
1631 * which accepts a "user visible" resource address converted by
1632 * pci_resource_to_user(), as used in the legacy mmap() interface in
1635 int pci_mmap_resource_range(struct pci_dev *dev, int bar,
1636 struct vm_area_struct *vma,
1637 enum pci_mmap_state mmap_state, int write_combine);
1638 int pci_mmap_page_range(struct pci_dev *pdev, int bar,
1639 struct vm_area_struct *vma,
1640 enum pci_mmap_state mmap_state, int write_combine);
1642 #ifndef arch_can_pci_mmap_wc
1643 #define arch_can_pci_mmap_wc() 0
1646 #ifndef arch_can_pci_mmap_io
1647 #define arch_can_pci_mmap_io() 0
1648 #define pci_iobar_pfn(pdev, bar, vma) (-EINVAL)
1650 int pci_iobar_pfn(struct pci_dev *pdev, int bar, struct vm_area_struct *vma);
1653 #ifndef pci_root_bus_fwnode
1654 #define pci_root_bus_fwnode(bus) NULL
1657 /* these helpers provide future and backwards compatibility
1658 * for accessing popular PCI BAR info */
1659 #define pci_resource_start(dev, bar) ((dev)->resource[(bar)].start)
1660 #define pci_resource_end(dev, bar) ((dev)->resource[(bar)].end)
1661 #define pci_resource_flags(dev, bar) ((dev)->resource[(bar)].flags)
1662 #define pci_resource_len(dev,bar) \
1663 ((pci_resource_start((dev), (bar)) == 0 && \
1664 pci_resource_end((dev), (bar)) == \
1665 pci_resource_start((dev), (bar))) ? 0 : \
1667 (pci_resource_end((dev), (bar)) - \
1668 pci_resource_start((dev), (bar)) + 1))
1670 /* Similar to the helpers above, these manipulate per-pci_dev
1671 * driver-specific data. They are really just a wrapper around
1672 * the generic device structure functions of these calls.
1674 static inline void *pci_get_drvdata(struct pci_dev *pdev)
1676 return dev_get_drvdata(&pdev->dev);
1679 static inline void pci_set_drvdata(struct pci_dev *pdev, void *data)
1681 dev_set_drvdata(&pdev->dev, data);
1684 /* If you want to know what to call your pci_dev, ask this function.
1685 * Again, it's a wrapper around the generic device.
1687 static inline const char *pci_name(const struct pci_dev *pdev)
1689 return dev_name(&pdev->dev);
1693 /* Some archs don't want to expose struct resource to userland as-is
1694 * in sysfs and /proc
1696 #ifdef HAVE_ARCH_PCI_RESOURCE_TO_USER
1697 void pci_resource_to_user(const struct pci_dev *dev, int bar,
1698 const struct resource *rsrc,
1699 resource_size_t *start, resource_size_t *end);
1701 static inline void pci_resource_to_user(const struct pci_dev *dev, int bar,
1702 const struct resource *rsrc, resource_size_t *start,
1703 resource_size_t *end)
1705 *start = rsrc->start;
1708 #endif /* HAVE_ARCH_PCI_RESOURCE_TO_USER */
1712 * The world is not perfect and supplies us with broken PCI devices.
1713 * For at least a part of these bugs we need a work-around, so both
1714 * generic (drivers/pci/quirks.c) and per-architecture code can define
1715 * fixup hooks to be called for particular buggy devices.
1719 u16 vendor; /* You can use PCI_ANY_ID here of course */
1720 u16 device; /* You can use PCI_ANY_ID here of course */
1721 u32 class; /* You can use PCI_ANY_ID here too */
1722 unsigned int class_shift; /* should be 0, 8, 16 */
1723 void (*hook)(struct pci_dev *dev);
1726 enum pci_fixup_pass {
1727 pci_fixup_early, /* Before probing BARs */
1728 pci_fixup_header, /* After reading configuration header */
1729 pci_fixup_final, /* Final phase of device fixups */
1730 pci_fixup_enable, /* pci_enable_device() time */
1731 pci_fixup_resume, /* pci_device_resume() */
1732 pci_fixup_suspend, /* pci_device_suspend() */
1733 pci_fixup_resume_early, /* pci_device_resume_early() */
1734 pci_fixup_suspend_late, /* pci_device_suspend_late() */
1737 /* Anonymous variables would be nice... */
1738 #define DECLARE_PCI_FIXUP_SECTION(section, name, vendor, device, class, \
1739 class_shift, hook) \
1740 static const struct pci_fixup __PASTE(__pci_fixup_##name,__LINE__) __used \
1741 __attribute__((__section__(#section), aligned((sizeof(void *))))) \
1742 = { vendor, device, class, class_shift, hook };
1744 #define DECLARE_PCI_FIXUP_CLASS_EARLY(vendor, device, class, \
1745 class_shift, hook) \
1746 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early, \
1747 hook, vendor, device, class, class_shift, hook)
1748 #define DECLARE_PCI_FIXUP_CLASS_HEADER(vendor, device, class, \
1749 class_shift, hook) \
1750 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header, \
1751 hook, vendor, device, class, class_shift, hook)
1752 #define DECLARE_PCI_FIXUP_CLASS_FINAL(vendor, device, class, \
1753 class_shift, hook) \
1754 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final, \
1755 hook, vendor, device, class, class_shift, hook)
1756 #define DECLARE_PCI_FIXUP_CLASS_ENABLE(vendor, device, class, \
1757 class_shift, hook) \
1758 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable, \
1759 hook, vendor, device, class, class_shift, hook)
1760 #define DECLARE_PCI_FIXUP_CLASS_RESUME(vendor, device, class, \
1761 class_shift, hook) \
1762 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume, \
1763 resume##hook, vendor, device, class, \
1765 #define DECLARE_PCI_FIXUP_CLASS_RESUME_EARLY(vendor, device, class, \
1766 class_shift, hook) \
1767 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early, \
1768 resume_early##hook, vendor, device, \
1769 class, class_shift, hook)
1770 #define DECLARE_PCI_FIXUP_CLASS_SUSPEND(vendor, device, class, \
1771 class_shift, hook) \
1772 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend, \
1773 suspend##hook, vendor, device, class, \
1775 #define DECLARE_PCI_FIXUP_CLASS_SUSPEND_LATE(vendor, device, class, \
1776 class_shift, hook) \
1777 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend_late, \
1778 suspend_late##hook, vendor, device, \
1779 class, class_shift, hook)
1781 #define DECLARE_PCI_FIXUP_EARLY(vendor, device, hook) \
1782 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early, \
1783 hook, vendor, device, PCI_ANY_ID, 0, hook)
1784 #define DECLARE_PCI_FIXUP_HEADER(vendor, device, hook) \
1785 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header, \
1786 hook, vendor, device, PCI_ANY_ID, 0, hook)
1787 #define DECLARE_PCI_FIXUP_FINAL(vendor, device, hook) \
1788 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final, \
1789 hook, vendor, device, PCI_ANY_ID, 0, hook)
1790 #define DECLARE_PCI_FIXUP_ENABLE(vendor, device, hook) \
1791 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable, \
1792 hook, vendor, device, PCI_ANY_ID, 0, hook)
1793 #define DECLARE_PCI_FIXUP_RESUME(vendor, device, hook) \
1794 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume, \
1795 resume##hook, vendor, device, \
1796 PCI_ANY_ID, 0, hook)
1797 #define DECLARE_PCI_FIXUP_RESUME_EARLY(vendor, device, hook) \
1798 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early, \
1799 resume_early##hook, vendor, device, \
1800 PCI_ANY_ID, 0, hook)
1801 #define DECLARE_PCI_FIXUP_SUSPEND(vendor, device, hook) \
1802 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend, \
1803 suspend##hook, vendor, device, \
1804 PCI_ANY_ID, 0, hook)
1805 #define DECLARE_PCI_FIXUP_SUSPEND_LATE(vendor, device, hook) \
1806 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend_late, \
1807 suspend_late##hook, vendor, device, \
1808 PCI_ANY_ID, 0, hook)
1810 #ifdef CONFIG_PCI_QUIRKS
1811 void pci_fixup_device(enum pci_fixup_pass pass, struct pci_dev *dev);
1812 int pci_dev_specific_acs_enabled(struct pci_dev *dev, u16 acs_flags);
1813 int pci_dev_specific_enable_acs(struct pci_dev *dev);
1815 static inline void pci_fixup_device(enum pci_fixup_pass pass,
1816 struct pci_dev *dev) { }
1817 static inline int pci_dev_specific_acs_enabled(struct pci_dev *dev,
1822 static inline int pci_dev_specific_enable_acs(struct pci_dev *dev)
1828 void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen);
1829 void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr);
1830 void __iomem * const *pcim_iomap_table(struct pci_dev *pdev);
1831 int pcim_iomap_regions(struct pci_dev *pdev, int mask, const char *name);
1832 int pcim_iomap_regions_request_all(struct pci_dev *pdev, int mask,
1834 void pcim_iounmap_regions(struct pci_dev *pdev, int mask);
1836 extern int pci_pci_problems;
1837 #define PCIPCI_FAIL 1 /* No PCI PCI DMA */
1838 #define PCIPCI_TRITON 2
1839 #define PCIPCI_NATOMA 4
1840 #define PCIPCI_VIAETBF 8
1841 #define PCIPCI_VSFX 16
1842 #define PCIPCI_ALIMAGIK 32 /* Need low latency setting */
1843 #define PCIAGP_FAIL 64 /* No PCI to AGP DMA */
1845 extern unsigned long pci_cardbus_io_size;
1846 extern unsigned long pci_cardbus_mem_size;
1847 extern u8 pci_dfl_cache_line_size;
1848 extern u8 pci_cache_line_size;
1850 extern unsigned long pci_hotplug_io_size;
1851 extern unsigned long pci_hotplug_mem_size;
1852 extern unsigned long pci_hotplug_bus_size;
1854 /* Architecture-specific versions may override these (weak) */
1855 void pcibios_disable_device(struct pci_dev *dev);
1856 void pcibios_set_master(struct pci_dev *dev);
1857 int pcibios_set_pcie_reset_state(struct pci_dev *dev,
1858 enum pcie_reset_state state);
1859 int pcibios_add_device(struct pci_dev *dev);
1860 void pcibios_release_device(struct pci_dev *dev);
1861 void pcibios_penalize_isa_irq(int irq, int active);
1862 int pcibios_alloc_irq(struct pci_dev *dev);
1863 void pcibios_free_irq(struct pci_dev *dev);
1865 #ifdef CONFIG_HIBERNATE_CALLBACKS
1866 extern struct dev_pm_ops pcibios_pm_ops;
1869 #if defined(CONFIG_PCI_MMCONFIG) || defined(CONFIG_ACPI_MCFG)
1870 void __init pci_mmcfg_early_init(void);
1871 void __init pci_mmcfg_late_init(void);
1873 static inline void pci_mmcfg_early_init(void) { }
1874 static inline void pci_mmcfg_late_init(void) { }
1877 int pci_ext_cfg_avail(void);
1879 void __iomem *pci_ioremap_bar(struct pci_dev *pdev, int bar);
1880 void __iomem *pci_ioremap_wc_bar(struct pci_dev *pdev, int bar);
1882 #ifdef CONFIG_PCI_IOV
1883 int pci_iov_virtfn_bus(struct pci_dev *dev, int id);
1884 int pci_iov_virtfn_devfn(struct pci_dev *dev, int id);
1886 int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn);
1887 void pci_disable_sriov(struct pci_dev *dev);
1888 int pci_iov_add_virtfn(struct pci_dev *dev, int id, int reset);
1889 void pci_iov_remove_virtfn(struct pci_dev *dev, int id, int reset);
1890 int pci_num_vf(struct pci_dev *dev);
1891 int pci_vfs_assigned(struct pci_dev *dev);
1892 int pci_sriov_set_totalvfs(struct pci_dev *dev, u16 numvfs);
1893 int pci_sriov_get_totalvfs(struct pci_dev *dev);
1894 resource_size_t pci_iov_resource_size(struct pci_dev *dev, int resno);
1896 static inline int pci_iov_virtfn_bus(struct pci_dev *dev, int id)
1900 static inline int pci_iov_virtfn_devfn(struct pci_dev *dev, int id)
1904 static inline int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn)
1906 static inline int pci_iov_add_virtfn(struct pci_dev *dev, int id, int reset)
1910 static inline void pci_iov_remove_virtfn(struct pci_dev *dev,
1911 int id, int reset) { }
1912 static inline void pci_disable_sriov(struct pci_dev *dev) { }
1913 static inline int pci_num_vf(struct pci_dev *dev) { return 0; }
1914 static inline int pci_vfs_assigned(struct pci_dev *dev)
1916 static inline int pci_sriov_set_totalvfs(struct pci_dev *dev, u16 numvfs)
1918 static inline int pci_sriov_get_totalvfs(struct pci_dev *dev)
1920 static inline resource_size_t pci_iov_resource_size(struct pci_dev *dev, int resno)
1924 #if defined(CONFIG_HOTPLUG_PCI) || defined(CONFIG_HOTPLUG_PCI_MODULE)
1925 void pci_hp_create_module_link(struct pci_slot *pci_slot);
1926 void pci_hp_remove_module_link(struct pci_slot *pci_slot);
1930 * pci_pcie_cap - get the saved PCIe capability offset
1933 * PCIe capability offset is calculated at PCI device initialization
1934 * time and saved in the data structure. This function returns saved
1935 * PCIe capability offset. Using this instead of pci_find_capability()
1936 * reduces unnecessary search in the PCI configuration space. If you
1937 * need to calculate PCIe capability offset from raw device for some
1938 * reasons, please use pci_find_capability() instead.
1940 static inline int pci_pcie_cap(struct pci_dev *dev)
1942 return dev->pcie_cap;
1946 * pci_is_pcie - check if the PCI device is PCI Express capable
1949 * Returns: true if the PCI device is PCI Express capable, false otherwise.
1951 static inline bool pci_is_pcie(struct pci_dev *dev)
1953 return pci_pcie_cap(dev);
1957 * pcie_caps_reg - get the PCIe Capabilities Register
1960 static inline u16 pcie_caps_reg(const struct pci_dev *dev)
1962 return dev->pcie_flags_reg;
1966 * pci_pcie_type - get the PCIe device/port type
1969 static inline int pci_pcie_type(const struct pci_dev *dev)
1971 return (pcie_caps_reg(dev) & PCI_EXP_FLAGS_TYPE) >> 4;
1974 static inline struct pci_dev *pcie_find_root_port(struct pci_dev *dev)
1977 if (!pci_is_pcie(dev))
1979 if (pci_pcie_type(dev) == PCI_EXP_TYPE_ROOT_PORT)
1981 if (!dev->bus->self)
1983 dev = dev->bus->self;
1988 void pci_request_acs(void);
1989 bool pci_acs_enabled(struct pci_dev *pdev, u16 acs_flags);
1990 bool pci_acs_path_enabled(struct pci_dev *start,
1991 struct pci_dev *end, u16 acs_flags);
1993 #define PCI_VPD_LRDT 0x80 /* Large Resource Data Type */
1994 #define PCI_VPD_LRDT_ID(x) ((x) | PCI_VPD_LRDT)
1996 /* Large Resource Data Type Tag Item Names */
1997 #define PCI_VPD_LTIN_ID_STRING 0x02 /* Identifier String */
1998 #define PCI_VPD_LTIN_RO_DATA 0x10 /* Read-Only Data */
1999 #define PCI_VPD_LTIN_RW_DATA 0x11 /* Read-Write Data */
2001 #define PCI_VPD_LRDT_ID_STRING PCI_VPD_LRDT_ID(PCI_VPD_LTIN_ID_STRING)
2002 #define PCI_VPD_LRDT_RO_DATA PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RO_DATA)
2003 #define PCI_VPD_LRDT_RW_DATA PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RW_DATA)
2005 /* Small Resource Data Type Tag Item Names */
2006 #define PCI_VPD_STIN_END 0x0f /* End */
2008 #define PCI_VPD_SRDT_END (PCI_VPD_STIN_END << 3)
2010 #define PCI_VPD_SRDT_TIN_MASK 0x78
2011 #define PCI_VPD_SRDT_LEN_MASK 0x07
2012 #define PCI_VPD_LRDT_TIN_MASK 0x7f
2014 #define PCI_VPD_LRDT_TAG_SIZE 3
2015 #define PCI_VPD_SRDT_TAG_SIZE 1
2017 #define PCI_VPD_INFO_FLD_HDR_SIZE 3
2019 #define PCI_VPD_RO_KEYWORD_PARTNO "PN"
2020 #define PCI_VPD_RO_KEYWORD_MFR_ID "MN"
2021 #define PCI_VPD_RO_KEYWORD_VENDOR0 "V0"
2022 #define PCI_VPD_RO_KEYWORD_CHKSUM "RV"
2025 * pci_vpd_lrdt_size - Extracts the Large Resource Data Type length
2026 * @lrdt: Pointer to the beginning of the Large Resource Data Type tag
2028 * Returns the extracted Large Resource Data Type length.
2030 static inline u16 pci_vpd_lrdt_size(const u8 *lrdt)
2032 return (u16)lrdt[1] + ((u16)lrdt[2] << 8);
2036 * pci_vpd_lrdt_tag - Extracts the Large Resource Data Type Tag Item
2037 * @lrdt: Pointer to the beginning of the Large Resource Data Type tag
2039 * Returns the extracted Large Resource Data Type Tag item.
2041 static inline u16 pci_vpd_lrdt_tag(const u8 *lrdt)
2043 return (u16)(lrdt[0] & PCI_VPD_LRDT_TIN_MASK);
2047 * pci_vpd_srdt_size - Extracts the Small Resource Data Type length
2048 * @lrdt: Pointer to the beginning of the Small Resource Data Type tag
2050 * Returns the extracted Small Resource Data Type length.
2052 static inline u8 pci_vpd_srdt_size(const u8 *srdt)
2054 return (*srdt) & PCI_VPD_SRDT_LEN_MASK;
2058 * pci_vpd_srdt_tag - Extracts the Small Resource Data Type Tag Item
2059 * @lrdt: Pointer to the beginning of the Small Resource Data Type tag
2061 * Returns the extracted Small Resource Data Type Tag Item.
2063 static inline u8 pci_vpd_srdt_tag(const u8 *srdt)
2065 return ((*srdt) & PCI_VPD_SRDT_TIN_MASK) >> 3;
2069 * pci_vpd_info_field_size - Extracts the information field length
2070 * @lrdt: Pointer to the beginning of an information field header
2072 * Returns the extracted information field length.
2074 static inline u8 pci_vpd_info_field_size(const u8 *info_field)
2076 return info_field[2];
2080 * pci_vpd_find_tag - Locates the Resource Data Type tag provided
2081 * @buf: Pointer to buffered vpd data
2082 * @off: The offset into the buffer at which to begin the search
2083 * @len: The length of the vpd buffer
2084 * @rdt: The Resource Data Type to search for
2086 * Returns the index where the Resource Data Type was found or
2087 * -ENOENT otherwise.
2089 int pci_vpd_find_tag(const u8 *buf, unsigned int off, unsigned int len, u8 rdt);
2092 * pci_vpd_find_info_keyword - Locates an information field keyword in the VPD
2093 * @buf: Pointer to buffered vpd data
2094 * @off: The offset into the buffer at which to begin the search
2095 * @len: The length of the buffer area, relative to off, in which to search
2096 * @kw: The keyword to search for
2098 * Returns the index where the information field keyword was found or
2099 * -ENOENT otherwise.
2101 int pci_vpd_find_info_keyword(const u8 *buf, unsigned int off,
2102 unsigned int len, const char *kw);
2104 /* PCI <-> OF binding helpers */
2108 void pci_set_of_node(struct pci_dev *dev);
2109 void pci_release_of_node(struct pci_dev *dev);
2110 void pci_set_bus_of_node(struct pci_bus *bus);
2111 void pci_release_bus_of_node(struct pci_bus *bus);
2112 struct irq_domain *pci_host_bridge_of_msi_domain(struct pci_bus *bus);
2114 /* Arch may override this (weak) */
2115 struct device_node *pcibios_get_phb_of_node(struct pci_bus *bus);
2117 static inline struct device_node *
2118 pci_device_to_OF_node(const struct pci_dev *pdev)
2120 return pdev ? pdev->dev.of_node : NULL;
2123 static inline struct device_node *pci_bus_to_OF_node(struct pci_bus *bus)
2125 return bus ? bus->dev.of_node : NULL;
2128 #else /* CONFIG_OF */
2129 static inline void pci_set_of_node(struct pci_dev *dev) { }
2130 static inline void pci_release_of_node(struct pci_dev *dev) { }
2131 static inline void pci_set_bus_of_node(struct pci_bus *bus) { }
2132 static inline void pci_release_bus_of_node(struct pci_bus *bus) { }
2133 static inline struct device_node *
2134 pci_device_to_OF_node(const struct pci_dev *pdev) { return NULL; }
2135 static inline struct irq_domain *
2136 pci_host_bridge_of_msi_domain(struct pci_bus *bus) { return NULL; }
2137 #endif /* CONFIG_OF */
2140 struct irq_domain *pci_host_bridge_acpi_msi_domain(struct pci_bus *bus);
2143 pci_msi_register_fwnode_provider(struct fwnode_handle *(*fn)(struct device *));
2145 static inline struct irq_domain *
2146 pci_host_bridge_acpi_msi_domain(struct pci_bus *bus) { return NULL; }
2150 static inline struct eeh_dev *pci_dev_to_eeh_dev(struct pci_dev *pdev)
2152 return pdev->dev.archdata.edev;
2156 void pci_add_dma_alias(struct pci_dev *dev, u8 devfn);
2157 bool pci_devs_are_dma_aliases(struct pci_dev *dev1, struct pci_dev *dev2);
2158 int pci_for_each_dma_alias(struct pci_dev *pdev,
2159 int (*fn)(struct pci_dev *pdev,
2160 u16 alias, void *data), void *data);
2162 /* helper functions for operation of device flag */
2163 static inline void pci_set_dev_assigned(struct pci_dev *pdev)
2165 pdev->dev_flags |= PCI_DEV_FLAGS_ASSIGNED;
2167 static inline void pci_clear_dev_assigned(struct pci_dev *pdev)
2169 pdev->dev_flags &= ~PCI_DEV_FLAGS_ASSIGNED;
2171 static inline bool pci_is_dev_assigned(struct pci_dev *pdev)
2173 return (pdev->dev_flags & PCI_DEV_FLAGS_ASSIGNED) == PCI_DEV_FLAGS_ASSIGNED;
2177 * pci_ari_enabled - query ARI forwarding status
2180 * Returns true if ARI forwarding is enabled.
2182 static inline bool pci_ari_enabled(struct pci_bus *bus)
2184 return bus->self && bus->self->ari_enabled;
2187 /* provide the legacy pci_dma_* API */
2188 #include <linux/pci-dma-compat.h>
2190 #endif /* LINUX_PCI_H */