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 * PCI Express ASPM defines and function prototypes
10 * Copyright (c) 2007 Intel Corp.
11 * Zhang Yanmin (yanmin.zhang@intel.com)
12 * Shaohua Li (shaohua.li@intel.com)
14 * For more information, please consult the following manuals (look at
15 * http://www.pcisig.com/ for how to get them):
17 * PCI BIOS Specification
18 * PCI Local Bus Specification
19 * PCI to PCI Bridge Specification
20 * PCI Express Specification
21 * PCI System Design Guide
27 #include <linux/mod_devicetable.h>
29 #include <linux/types.h>
30 #include <linux/init.h>
31 #include <linux/ioport.h>
32 #include <linux/list.h>
33 #include <linux/compiler.h>
34 #include <linux/errno.h>
35 #include <linux/kobject.h>
36 #include <linux/atomic.h>
37 #include <linux/device.h>
38 #include <linux/interrupt.h>
40 #include <linux/resource_ext.h>
41 #include <uapi/linux/pci.h>
43 #include <linux/pci_ids.h>
45 #define PCI_STATUS_ERROR_BITS (PCI_STATUS_DETECTED_PARITY | \
46 PCI_STATUS_SIG_SYSTEM_ERROR | \
47 PCI_STATUS_REC_MASTER_ABORT | \
48 PCI_STATUS_REC_TARGET_ABORT | \
49 PCI_STATUS_SIG_TARGET_ABORT | \
52 /* Number of reset methods used in pci_reset_fn_methods array in pci.c */
53 #define PCI_NUM_RESET_METHODS 7
55 #define PCI_RESET_PROBE true
56 #define PCI_RESET_DO_RESET false
59 * The PCI interface treats multi-function devices as independent
60 * devices. The slot/function address of each device is encoded
61 * in a single byte as follows:
66 * PCI_DEVFN(), PCI_SLOT(), and PCI_FUNC() are defined in uapi/linux/pci.h.
67 * In the interest of not exposing interfaces to user-space unnecessarily,
68 * the following kernel-only defines are being added here.
70 #define PCI_DEVID(bus, devfn) ((((u16)(bus)) << 8) | (devfn))
71 /* return bus from PCI devid = ((u16)bus_number) << 8) | devfn */
72 #define PCI_BUS_NUM(x) (((x) >> 8) & 0xff)
74 /* pci_slot represents a physical slot */
76 struct pci_bus *bus; /* Bus this slot is on */
77 struct list_head list; /* Node in list of slots */
78 struct hotplug_slot *hotplug; /* Hotplug info (move here) */
79 unsigned char number; /* PCI_SLOT(pci_dev->devfn) */
83 static inline const char *pci_slot_name(const struct pci_slot *slot)
85 return kobject_name(&slot->kobj);
88 /* File state for mmap()s on /proc/bus/pci/X/Y */
94 /* For PCI devices, the region numbers are assigned this way: */
96 /* #0-5: standard PCI resources */
98 PCI_STD_RESOURCE_END = PCI_STD_RESOURCES + PCI_STD_NUM_BARS - 1,
100 /* #6: expansion ROM resource */
103 /* Device-specific resources */
104 #ifdef CONFIG_PCI_IOV
106 PCI_IOV_RESOURCE_END = PCI_IOV_RESOURCES + PCI_SRIOV_NUM_BARS - 1,
109 /* PCI-to-PCI (P2P) bridge windows */
110 #define PCI_BRIDGE_IO_WINDOW (PCI_BRIDGE_RESOURCES + 0)
111 #define PCI_BRIDGE_MEM_WINDOW (PCI_BRIDGE_RESOURCES + 1)
112 #define PCI_BRIDGE_PREF_MEM_WINDOW (PCI_BRIDGE_RESOURCES + 2)
114 /* CardBus bridge windows */
115 #define PCI_CB_BRIDGE_IO_0_WINDOW (PCI_BRIDGE_RESOURCES + 0)
116 #define PCI_CB_BRIDGE_IO_1_WINDOW (PCI_BRIDGE_RESOURCES + 1)
117 #define PCI_CB_BRIDGE_MEM_0_WINDOW (PCI_BRIDGE_RESOURCES + 2)
118 #define PCI_CB_BRIDGE_MEM_1_WINDOW (PCI_BRIDGE_RESOURCES + 3)
120 /* Total number of bridge resources for P2P and CardBus */
121 #define PCI_BRIDGE_RESOURCE_NUM 4
123 /* Resources assigned to buses behind the bridge */
124 PCI_BRIDGE_RESOURCES,
125 PCI_BRIDGE_RESOURCE_END = PCI_BRIDGE_RESOURCES +
126 PCI_BRIDGE_RESOURCE_NUM - 1,
128 /* Total resources associated with a PCI device */
131 /* Preserve this for compatibility */
132 DEVICE_COUNT_RESOURCE = PCI_NUM_RESOURCES,
136 * enum pci_interrupt_pin - PCI INTx interrupt values
137 * @PCI_INTERRUPT_UNKNOWN: Unknown or unassigned interrupt
138 * @PCI_INTERRUPT_INTA: PCI INTA pin
139 * @PCI_INTERRUPT_INTB: PCI INTB pin
140 * @PCI_INTERRUPT_INTC: PCI INTC pin
141 * @PCI_INTERRUPT_INTD: PCI INTD pin
143 * Corresponds to values for legacy PCI INTx interrupts, as can be found in the
144 * PCI_INTERRUPT_PIN register.
146 enum pci_interrupt_pin {
147 PCI_INTERRUPT_UNKNOWN,
154 /* The number of legacy PCI INTx interrupts */
155 #define PCI_NUM_INTX 4
158 * pci_power_t values must match the bits in the Capabilities PME_Support
159 * and Control/Status PowerState fields in the Power Management capability.
161 typedef int __bitwise pci_power_t;
163 #define PCI_D0 ((pci_power_t __force) 0)
164 #define PCI_D1 ((pci_power_t __force) 1)
165 #define PCI_D2 ((pci_power_t __force) 2)
166 #define PCI_D3hot ((pci_power_t __force) 3)
167 #define PCI_D3cold ((pci_power_t __force) 4)
168 #define PCI_UNKNOWN ((pci_power_t __force) 5)
169 #define PCI_POWER_ERROR ((pci_power_t __force) -1)
171 /* Remember to update this when the list above changes! */
172 extern const char *pci_power_names[];
174 static inline const char *pci_power_name(pci_power_t state)
176 return pci_power_names[1 + (__force int) state];
180 * typedef pci_channel_state_t
182 * The pci_channel state describes connectivity between the CPU and
183 * the PCI device. If some PCI bus between here and the PCI device
184 * has crashed or locked up, this info is reflected here.
186 typedef unsigned int __bitwise pci_channel_state_t;
189 /* I/O channel is in normal state */
190 pci_channel_io_normal = (__force pci_channel_state_t) 1,
192 /* I/O to channel is blocked */
193 pci_channel_io_frozen = (__force pci_channel_state_t) 2,
195 /* PCI card is dead */
196 pci_channel_io_perm_failure = (__force pci_channel_state_t) 3,
199 typedef unsigned int __bitwise pcie_reset_state_t;
201 enum pcie_reset_state {
202 /* Reset is NOT asserted (Use to deassert reset) */
203 pcie_deassert_reset = (__force pcie_reset_state_t) 1,
205 /* Use #PERST to reset PCIe device */
206 pcie_warm_reset = (__force pcie_reset_state_t) 2,
208 /* Use PCIe Hot Reset to reset device */
209 pcie_hot_reset = (__force pcie_reset_state_t) 3
212 typedef unsigned short __bitwise pci_dev_flags_t;
214 /* INTX_DISABLE in PCI_COMMAND register disables MSI too */
215 PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG = (__force pci_dev_flags_t) (1 << 0),
216 /* Device configuration is irrevocably lost if disabled into D3 */
217 PCI_DEV_FLAGS_NO_D3 = (__force pci_dev_flags_t) (1 << 1),
218 /* Provide indication device is assigned by a Virtual Machine Manager */
219 PCI_DEV_FLAGS_ASSIGNED = (__force pci_dev_flags_t) (1 << 2),
220 /* Flag for quirk use to store if quirk-specific ACS is enabled */
221 PCI_DEV_FLAGS_ACS_ENABLED_QUIRK = (__force pci_dev_flags_t) (1 << 3),
222 /* Use a PCIe-to-PCI bridge alias even if !pci_is_pcie */
223 PCI_DEV_FLAG_PCIE_BRIDGE_ALIAS = (__force pci_dev_flags_t) (1 << 5),
224 /* Do not use bus resets for device */
225 PCI_DEV_FLAGS_NO_BUS_RESET = (__force pci_dev_flags_t) (1 << 6),
226 /* Do not use PM reset even if device advertises NoSoftRst- */
227 PCI_DEV_FLAGS_NO_PM_RESET = (__force pci_dev_flags_t) (1 << 7),
228 /* Get VPD from function 0 VPD */
229 PCI_DEV_FLAGS_VPD_REF_F0 = (__force pci_dev_flags_t) (1 << 8),
230 /* A non-root bridge where translation occurs, stop alias search here */
231 PCI_DEV_FLAGS_BRIDGE_XLATE_ROOT = (__force pci_dev_flags_t) (1 << 9),
232 /* Do not use FLR even if device advertises PCI_AF_CAP */
233 PCI_DEV_FLAGS_NO_FLR_RESET = (__force pci_dev_flags_t) (1 << 10),
234 /* Don't use Relaxed Ordering for TLPs directed at this device */
235 PCI_DEV_FLAGS_NO_RELAXED_ORDERING = (__force pci_dev_flags_t) (1 << 11),
238 enum pci_irq_reroute_variant {
239 INTEL_IRQ_REROUTE_VARIANT = 1,
240 MAX_IRQ_REROUTE_VARIANTS = 3
243 typedef unsigned short __bitwise pci_bus_flags_t;
245 PCI_BUS_FLAGS_NO_MSI = (__force pci_bus_flags_t) 1,
246 PCI_BUS_FLAGS_NO_MMRBC = (__force pci_bus_flags_t) 2,
247 PCI_BUS_FLAGS_NO_AERSID = (__force pci_bus_flags_t) 4,
248 PCI_BUS_FLAGS_NO_EXTCFG = (__force pci_bus_flags_t) 8,
251 /* Values from Link Status register, PCIe r3.1, sec 7.8.8 */
252 enum pcie_link_width {
253 PCIE_LNK_WIDTH_RESRV = 0x00,
261 PCIE_LNK_WIDTH_UNKNOWN = 0xff,
264 /* See matching string table in pci_speed_string() */
266 PCI_SPEED_33MHz = 0x00,
267 PCI_SPEED_66MHz = 0x01,
268 PCI_SPEED_66MHz_PCIX = 0x02,
269 PCI_SPEED_100MHz_PCIX = 0x03,
270 PCI_SPEED_133MHz_PCIX = 0x04,
271 PCI_SPEED_66MHz_PCIX_ECC = 0x05,
272 PCI_SPEED_100MHz_PCIX_ECC = 0x06,
273 PCI_SPEED_133MHz_PCIX_ECC = 0x07,
274 PCI_SPEED_66MHz_PCIX_266 = 0x09,
275 PCI_SPEED_100MHz_PCIX_266 = 0x0a,
276 PCI_SPEED_133MHz_PCIX_266 = 0x0b,
282 PCI_SPEED_66MHz_PCIX_533 = 0x11,
283 PCI_SPEED_100MHz_PCIX_533 = 0x12,
284 PCI_SPEED_133MHz_PCIX_533 = 0x13,
285 PCIE_SPEED_2_5GT = 0x14,
286 PCIE_SPEED_5_0GT = 0x15,
287 PCIE_SPEED_8_0GT = 0x16,
288 PCIE_SPEED_16_0GT = 0x17,
289 PCIE_SPEED_32_0GT = 0x18,
290 PCIE_SPEED_64_0GT = 0x19,
291 PCI_SPEED_UNKNOWN = 0xff,
294 enum pci_bus_speed pcie_get_speed_cap(struct pci_dev *dev);
295 enum pcie_link_width pcie_get_width_cap(struct pci_dev *dev);
297 struct pci_cap_saved_data {
304 struct pci_cap_saved_state {
305 struct hlist_node next;
306 struct pci_cap_saved_data cap;
310 struct pcie_link_state;
316 /* The pci_dev structure describes PCI devices */
318 struct list_head bus_list; /* Node in per-bus list */
319 struct pci_bus *bus; /* Bus this device is on */
320 struct pci_bus *subordinate; /* Bus this device bridges to */
322 void *sysdata; /* Hook for sys-specific extension */
323 struct proc_dir_entry *procent; /* Device entry in /proc/bus/pci */
324 struct pci_slot *slot; /* Physical slot this device is in */
326 unsigned int devfn; /* Encoded device & function index */
327 unsigned short vendor;
328 unsigned short device;
329 unsigned short subsystem_vendor;
330 unsigned short subsystem_device;
331 unsigned int class; /* 3 bytes: (base,sub,prog-if) */
332 u8 revision; /* PCI revision, low byte of class word */
333 u8 hdr_type; /* PCI header type (`multi' flag masked out) */
334 #ifdef CONFIG_PCIEAER
335 u16 aer_cap; /* AER capability offset */
336 struct aer_stats *aer_stats; /* AER stats for this device */
338 #ifdef CONFIG_PCIEPORTBUS
339 struct rcec_ea *rcec_ea; /* RCEC cached endpoint association */
340 struct pci_dev *rcec; /* Associated RCEC device */
342 u32 devcap; /* PCIe Device Capabilities */
343 u8 pcie_cap; /* PCIe capability offset */
344 u8 msi_cap; /* MSI capability offset */
345 u8 msix_cap; /* MSI-X capability offset */
346 u8 pcie_mpss:3; /* PCIe Max Payload Size Supported */
347 u8 rom_base_reg; /* Config register controlling ROM */
348 u8 pin; /* Interrupt pin this device uses */
349 u16 pcie_flags_reg; /* Cached PCIe Capabilities Register */
350 unsigned long *dma_alias_mask;/* Mask of enabled devfn aliases */
352 struct pci_driver *driver; /* Driver bound to this device */
353 u64 dma_mask; /* Mask of the bits of bus address this
354 device implements. Normally this is
355 0xffffffff. You only need to change
356 this if your device has broken DMA
357 or supports 64-bit transfers. */
359 struct device_dma_parameters dma_parms;
361 pci_power_t current_state; /* Current operating state. In ACPI,
362 this is D0-D3, D0 being fully
363 functional, and D3 being off. */
364 unsigned int imm_ready:1; /* Supports Immediate Readiness */
365 u8 pm_cap; /* PM capability offset */
366 unsigned int pme_support:5; /* Bitmask of states from which PME#
368 unsigned int pme_poll:1; /* Poll device's PME status bit */
369 unsigned int d1_support:1; /* Low power state D1 is supported */
370 unsigned int d2_support:1; /* Low power state D2 is supported */
371 unsigned int no_d1d2:1; /* D1 and D2 are forbidden */
372 unsigned int no_d3cold:1; /* D3cold is forbidden */
373 unsigned int bridge_d3:1; /* Allow D3 for bridge */
374 unsigned int d3cold_allowed:1; /* D3cold is allowed by user */
375 unsigned int mmio_always_on:1; /* Disallow turning off io/mem
376 decoding during BAR sizing */
377 unsigned int wakeup_prepared:1;
378 unsigned int runtime_d3cold:1; /* Whether go through runtime
379 D3cold, not set for devices
380 powered on/off by the
381 corresponding bridge */
382 unsigned int skip_bus_pm:1; /* Internal: Skip bus-level PM */
383 unsigned int ignore_hotplug:1; /* Ignore hotplug events */
384 unsigned int hotplug_user_indicators:1; /* SlotCtl indicators
385 controlled exclusively by
387 unsigned int clear_retrain_link:1; /* Need to clear Retrain Link
389 unsigned int d3hot_delay; /* D3hot->D0 transition time in ms */
390 unsigned int d3cold_delay; /* D3cold->D0 transition time in ms */
392 #ifdef CONFIG_PCIEASPM
393 struct pcie_link_state *link_state; /* ASPM link state */
394 unsigned int ltr_path:1; /* Latency Tolerance Reporting
395 supported from root to here */
396 u16 l1ss; /* L1SS Capability pointer */
398 unsigned int eetlp_prefix_path:1; /* End-to-End TLP Prefix */
400 pci_channel_state_t error_state; /* Current connectivity state */
401 struct device dev; /* Generic device interface */
403 int cfg_size; /* Size of config space */
406 * Instead of touching interrupt line and base address registers
407 * directly, use the values stored here. They might be different!
410 struct resource resource[DEVICE_COUNT_RESOURCE]; /* I/O and memory regions + expansion ROMs */
412 bool match_driver; /* Skip attaching driver */
414 unsigned int transparent:1; /* Subtractive decode bridge */
415 unsigned int io_window:1; /* Bridge has I/O window */
416 unsigned int pref_window:1; /* Bridge has pref mem window */
417 unsigned int pref_64_window:1; /* Pref mem window is 64-bit */
418 unsigned int multifunction:1; /* Multi-function device */
420 unsigned int is_busmaster:1; /* Is busmaster */
421 unsigned int no_msi:1; /* May not use MSI */
422 unsigned int no_64bit_msi:1; /* May only use 32-bit MSIs */
423 unsigned int block_cfg_access:1; /* Config space access blocked */
424 unsigned int broken_parity_status:1; /* Generates false positive parity */
425 unsigned int irq_reroute_variant:2; /* Needs IRQ rerouting variant */
426 unsigned int msi_enabled:1;
427 unsigned int msix_enabled:1;
428 unsigned int ari_enabled:1; /* ARI forwarding */
429 unsigned int ats_enabled:1; /* Address Translation Svc */
430 unsigned int pasid_enabled:1; /* Process Address Space ID */
431 unsigned int pri_enabled:1; /* Page Request Interface */
432 unsigned int is_managed:1;
433 unsigned int needs_freset:1; /* Requires fundamental reset */
434 unsigned int state_saved:1;
435 unsigned int is_physfn:1;
436 unsigned int is_virtfn:1;
437 unsigned int is_hotplug_bridge:1;
438 unsigned int shpc_managed:1; /* SHPC owned by shpchp */
439 unsigned int is_thunderbolt:1; /* Thunderbolt controller */
441 * Devices marked being untrusted are the ones that can potentially
442 * execute DMA attacks and similar. They are typically connected
443 * through external ports such as Thunderbolt but not limited to
444 * that. When an IOMMU is enabled they should be getting full
445 * mappings to make sure they cannot access arbitrary memory.
447 unsigned int untrusted:1;
449 * Info from the platform, e.g., ACPI or device tree, may mark a
450 * device as "external-facing". An external-facing device is
451 * itself internal but devices downstream from it are external.
453 unsigned int external_facing:1;
454 unsigned int broken_intx_masking:1; /* INTx masking can't be used */
455 unsigned int io_window_1k:1; /* Intel bridge 1K I/O windows */
456 unsigned int irq_managed:1;
457 unsigned int non_compliant_bars:1; /* Broken BARs; ignore them */
458 unsigned int is_probed:1; /* Device probing in progress */
459 unsigned int link_active_reporting:1;/* Device capable of reporting link active */
460 unsigned int no_vf_scan:1; /* Don't scan for VFs after IOV enablement */
461 unsigned int no_command_memory:1; /* No PCI_COMMAND_MEMORY */
462 pci_dev_flags_t dev_flags;
463 atomic_t enable_cnt; /* pci_enable_device has been called */
465 u32 saved_config_space[16]; /* Config space saved at suspend time */
466 struct hlist_head saved_cap_space;
467 int rom_attr_enabled; /* Display of ROM attribute enabled? */
468 struct bin_attribute *res_attr[DEVICE_COUNT_RESOURCE]; /* sysfs file for resources */
469 struct bin_attribute *res_attr_wc[DEVICE_COUNT_RESOURCE]; /* sysfs file for WC mapping of resources */
471 #ifdef CONFIG_HOTPLUG_PCI_PCIE
472 unsigned int broken_cmd_compl:1; /* No compl for some cmds */
474 #ifdef CONFIG_PCIE_PTM
475 unsigned int ptm_root:1;
476 unsigned int ptm_enabled:1;
479 #ifdef CONFIG_PCI_MSI
480 const struct attribute_group **msi_irq_groups;
483 #ifdef CONFIG_PCIE_DPC
485 unsigned int dpc_rp_extensions:1;
488 #ifdef CONFIG_PCI_ATS
490 struct pci_sriov *sriov; /* PF: SR-IOV info */
491 struct pci_dev *physfn; /* VF: related PF */
493 u16 ats_cap; /* ATS Capability offset */
494 u8 ats_stu; /* ATS Smallest Translation Unit */
496 #ifdef CONFIG_PCI_PRI
497 u16 pri_cap; /* PRI Capability offset */
498 u32 pri_reqs_alloc; /* Number of PRI requests allocated */
499 unsigned int pasid_required:1; /* PRG Response PASID Required */
501 #ifdef CONFIG_PCI_PASID
502 u16 pasid_cap; /* PASID Capability offset */
505 #ifdef CONFIG_PCI_P2PDMA
506 struct pci_p2pdma __rcu *p2pdma;
508 u16 acs_cap; /* ACS Capability offset */
509 phys_addr_t rom; /* Physical address if not from BAR */
510 size_t romlen; /* Length if not from BAR */
511 char *driver_override; /* Driver name to force a match */
513 unsigned long priv_flags; /* Private flags for the PCI driver */
515 /* These methods index pci_reset_fn_methods[] */
516 u8 reset_methods[PCI_NUM_RESET_METHODS]; /* In priority order */
519 static inline struct pci_dev *pci_physfn(struct pci_dev *dev)
521 #ifdef CONFIG_PCI_IOV
528 struct pci_dev *pci_alloc_dev(struct pci_bus *bus);
530 #define to_pci_dev(n) container_of(n, struct pci_dev, dev)
531 #define for_each_pci_dev(d) while ((d = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, d)) != NULL)
533 static inline int pci_channel_offline(struct pci_dev *pdev)
535 return (pdev->error_state != pci_channel_io_normal);
538 struct pci_host_bridge {
540 struct pci_bus *bus; /* Root bus */
542 struct pci_ops *child_ops;
545 struct list_head windows; /* resource_entry */
546 struct list_head dma_ranges; /* dma ranges resource list */
547 u8 (*swizzle_irq)(struct pci_dev *, u8 *); /* Platform IRQ swizzler */
548 int (*map_irq)(const struct pci_dev *, u8, u8);
549 void (*release_fn)(struct pci_host_bridge *);
551 unsigned int ignore_reset_delay:1; /* For entire hierarchy */
552 unsigned int no_ext_tags:1; /* No Extended Tags */
553 unsigned int native_aer:1; /* OS may use PCIe AER */
554 unsigned int native_pcie_hotplug:1; /* OS may use PCIe hotplug */
555 unsigned int native_shpc_hotplug:1; /* OS may use SHPC hotplug */
556 unsigned int native_pme:1; /* OS may use PCIe PME */
557 unsigned int native_ltr:1; /* OS may use PCIe LTR */
558 unsigned int native_dpc:1; /* OS may use PCIe DPC */
559 unsigned int preserve_config:1; /* Preserve FW resource setup */
560 unsigned int size_windows:1; /* Enable root bus sizing */
561 unsigned int msi_domain:1; /* Bridge wants MSI domain */
563 /* Resource alignment requirements */
564 resource_size_t (*align_resource)(struct pci_dev *dev,
565 const struct resource *res,
566 resource_size_t start,
567 resource_size_t size,
568 resource_size_t align);
569 unsigned long private[] ____cacheline_aligned;
572 #define to_pci_host_bridge(n) container_of(n, struct pci_host_bridge, dev)
574 static inline void *pci_host_bridge_priv(struct pci_host_bridge *bridge)
576 return (void *)bridge->private;
579 static inline struct pci_host_bridge *pci_host_bridge_from_priv(void *priv)
581 return container_of(priv, struct pci_host_bridge, private);
584 struct pci_host_bridge *pci_alloc_host_bridge(size_t priv);
585 struct pci_host_bridge *devm_pci_alloc_host_bridge(struct device *dev,
587 void pci_free_host_bridge(struct pci_host_bridge *bridge);
588 struct pci_host_bridge *pci_find_host_bridge(struct pci_bus *bus);
590 void pci_set_host_bridge_release(struct pci_host_bridge *bridge,
591 void (*release_fn)(struct pci_host_bridge *),
594 int pcibios_root_bridge_prepare(struct pci_host_bridge *bridge);
597 * The first PCI_BRIDGE_RESOURCE_NUM PCI bus resources (those that correspond
598 * to P2P or CardBus bridge windows) go in a table. Additional ones (for
599 * buses below host bridges or subtractive decode bridges) go in the list.
600 * Use pci_bus_for_each_resource() to iterate through all the resources.
604 * PCI_SUBTRACTIVE_DECODE means the bridge forwards the window implicitly
605 * and there's no way to program the bridge with the details of the window.
606 * This does not apply to ACPI _CRS windows, even with the _DEC subtractive-
607 * decode bit set, because they are explicit and can be programmed with _SRS.
609 #define PCI_SUBTRACTIVE_DECODE 0x1
611 struct pci_bus_resource {
612 struct list_head list;
613 struct resource *res;
617 #define PCI_REGION_FLAG_MASK 0x0fU /* These bits of resource flags tell us the PCI region flags */
620 struct list_head node; /* Node in list of buses */
621 struct pci_bus *parent; /* Parent bus this bridge is on */
622 struct list_head children; /* List of child buses */
623 struct list_head devices; /* List of devices on this bus */
624 struct pci_dev *self; /* Bridge device as seen by parent */
625 struct list_head slots; /* List of slots on this bus;
626 protected by pci_slot_mutex */
627 struct resource *resource[PCI_BRIDGE_RESOURCE_NUM];
628 struct list_head resources; /* Address space routed to this bus */
629 struct resource busn_res; /* Bus numbers routed to this bus */
631 struct pci_ops *ops; /* Configuration access functions */
632 void *sysdata; /* Hook for sys-specific extension */
633 struct proc_dir_entry *procdir; /* Directory entry in /proc/bus/pci */
635 unsigned char number; /* Bus number */
636 unsigned char primary; /* Number of primary bridge */
637 unsigned char max_bus_speed; /* enum pci_bus_speed */
638 unsigned char cur_bus_speed; /* enum pci_bus_speed */
639 #ifdef CONFIG_PCI_DOMAINS_GENERIC
645 unsigned short bridge_ctl; /* Manage NO_ISA/FBB/et al behaviors */
646 pci_bus_flags_t bus_flags; /* Inherited by child buses */
647 struct device *bridge;
649 struct bin_attribute *legacy_io; /* Legacy I/O for this bus */
650 struct bin_attribute *legacy_mem; /* Legacy mem */
651 unsigned int is_added:1;
654 #define to_pci_bus(n) container_of(n, struct pci_bus, dev)
656 static inline u16 pci_dev_id(struct pci_dev *dev)
658 return PCI_DEVID(dev->bus->number, dev->devfn);
662 * Returns true if the PCI bus is root (behind host-PCI bridge),
665 * Some code assumes that "bus->self == NULL" means that bus is a root bus.
666 * This is incorrect because "virtual" buses added for SR-IOV (via
667 * virtfn_add_bus()) have "bus->self == NULL" but are not root buses.
669 static inline bool pci_is_root_bus(struct pci_bus *pbus)
671 return !(pbus->parent);
675 * pci_is_bridge - check if the PCI device is a bridge
678 * Return true if the PCI device is bridge whether it has subordinate
681 static inline bool pci_is_bridge(struct pci_dev *dev)
683 return dev->hdr_type == PCI_HEADER_TYPE_BRIDGE ||
684 dev->hdr_type == PCI_HEADER_TYPE_CARDBUS;
687 #define for_each_pci_bridge(dev, bus) \
688 list_for_each_entry(dev, &bus->devices, bus_list) \
689 if (!pci_is_bridge(dev)) {} else
691 static inline struct pci_dev *pci_upstream_bridge(struct pci_dev *dev)
693 dev = pci_physfn(dev);
694 if (pci_is_root_bus(dev->bus))
697 return dev->bus->self;
700 #ifdef CONFIG_PCI_MSI
701 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev)
703 return pci_dev->msi_enabled || pci_dev->msix_enabled;
706 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev) { return false; }
709 /* Error values that may be returned by PCI functions */
710 #define PCIBIOS_SUCCESSFUL 0x00
711 #define PCIBIOS_FUNC_NOT_SUPPORTED 0x81
712 #define PCIBIOS_BAD_VENDOR_ID 0x83
713 #define PCIBIOS_DEVICE_NOT_FOUND 0x86
714 #define PCIBIOS_BAD_REGISTER_NUMBER 0x87
715 #define PCIBIOS_SET_FAILED 0x88
716 #define PCIBIOS_BUFFER_TOO_SMALL 0x89
718 /* Translate above to generic errno for passing back through non-PCI code */
719 static inline int pcibios_err_to_errno(int err)
721 if (err <= PCIBIOS_SUCCESSFUL)
722 return err; /* Assume already errno */
725 case PCIBIOS_FUNC_NOT_SUPPORTED:
727 case PCIBIOS_BAD_VENDOR_ID:
729 case PCIBIOS_DEVICE_NOT_FOUND:
731 case PCIBIOS_BAD_REGISTER_NUMBER:
733 case PCIBIOS_SET_FAILED:
735 case PCIBIOS_BUFFER_TOO_SMALL:
742 /* Low-level architecture-dependent routines */
745 int (*add_bus)(struct pci_bus *bus);
746 void (*remove_bus)(struct pci_bus *bus);
747 void __iomem *(*map_bus)(struct pci_bus *bus, unsigned int devfn, int where);
748 int (*read)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 *val);
749 int (*write)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 val);
753 * ACPI needs to be able to access PCI config space before we've done a
754 * PCI bus scan and created pci_bus structures.
756 int raw_pci_read(unsigned int domain, unsigned int bus, unsigned int devfn,
757 int reg, int len, u32 *val);
758 int raw_pci_write(unsigned int domain, unsigned int bus, unsigned int devfn,
759 int reg, int len, u32 val);
761 #ifdef CONFIG_ARCH_DMA_ADDR_T_64BIT
762 typedef u64 pci_bus_addr_t;
764 typedef u32 pci_bus_addr_t;
767 struct pci_bus_region {
768 pci_bus_addr_t start;
773 spinlock_t lock; /* Protects list, index */
774 struct list_head list; /* For IDs added at runtime */
779 * PCI Error Recovery System (PCI-ERS). If a PCI device driver provides
780 * a set of callbacks in struct pci_error_handlers, that device driver
781 * will be notified of PCI bus errors, and will be driven to recovery
782 * when an error occurs.
785 typedef unsigned int __bitwise pci_ers_result_t;
787 enum pci_ers_result {
788 /* No result/none/not supported in device driver */
789 PCI_ERS_RESULT_NONE = (__force pci_ers_result_t) 1,
791 /* Device driver can recover without slot reset */
792 PCI_ERS_RESULT_CAN_RECOVER = (__force pci_ers_result_t) 2,
794 /* Device driver wants slot to be reset */
795 PCI_ERS_RESULT_NEED_RESET = (__force pci_ers_result_t) 3,
797 /* Device has completely failed, is unrecoverable */
798 PCI_ERS_RESULT_DISCONNECT = (__force pci_ers_result_t) 4,
800 /* Device driver is fully recovered and operational */
801 PCI_ERS_RESULT_RECOVERED = (__force pci_ers_result_t) 5,
803 /* No AER capabilities registered for the driver */
804 PCI_ERS_RESULT_NO_AER_DRIVER = (__force pci_ers_result_t) 6,
807 /* PCI bus error event callbacks */
808 struct pci_error_handlers {
809 /* PCI bus error detected on this device */
810 pci_ers_result_t (*error_detected)(struct pci_dev *dev,
811 pci_channel_state_t error);
813 /* MMIO has been re-enabled, but not DMA */
814 pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev);
816 /* PCI slot has been reset */
817 pci_ers_result_t (*slot_reset)(struct pci_dev *dev);
819 /* PCI function reset prepare or completed */
820 void (*reset_prepare)(struct pci_dev *dev);
821 void (*reset_done)(struct pci_dev *dev);
823 /* Device driver may resume normal operations */
824 void (*resume)(struct pci_dev *dev);
831 * struct pci_driver - PCI driver structure
832 * @node: List of driver structures.
833 * @name: Driver name.
834 * @id_table: Pointer to table of device IDs the driver is
835 * interested in. Most drivers should export this
836 * table using MODULE_DEVICE_TABLE(pci,...).
837 * @probe: This probing function gets called (during execution
838 * of pci_register_driver() for already existing
839 * devices or later if a new device gets inserted) for
840 * all PCI devices which match the ID table and are not
841 * "owned" by the other drivers yet. This function gets
842 * passed a "struct pci_dev \*" for each device whose
843 * entry in the ID table matches the device. The probe
844 * function returns zero when the driver chooses to
845 * take "ownership" of the device or an error code
846 * (negative number) otherwise.
847 * The probe function always gets called from process
848 * context, so it can sleep.
849 * @remove: The remove() function gets called whenever a device
850 * being handled by this driver is removed (either during
851 * deregistration of the driver or when it's manually
852 * pulled out of a hot-pluggable slot).
853 * The remove function always gets called from process
854 * context, so it can sleep.
855 * @suspend: Put device into low power state.
856 * @resume: Wake device from low power state.
857 * (Please see Documentation/power/pci.rst for descriptions
858 * of PCI Power Management and the related functions.)
859 * @shutdown: Hook into reboot_notifier_list (kernel/sys.c).
860 * Intended to stop any idling DMA operations.
861 * Useful for enabling wake-on-lan (NIC) or changing
862 * the power state of a device before reboot.
863 * e.g. drivers/net/e100.c.
864 * @sriov_configure: Optional driver callback to allow configuration of
865 * number of VFs to enable via sysfs "sriov_numvfs" file.
866 * @sriov_set_msix_vec_count: PF Driver callback to change number of MSI-X
867 * vectors on a VF. Triggered via sysfs "sriov_vf_msix_count".
868 * This will change MSI-X Table Size in the VF Message Control
870 * @sriov_get_vf_total_msix: PF driver callback to get the total number of
871 * MSI-X vectors available for distribution to the VFs.
872 * @err_handler: See Documentation/PCI/pci-error-recovery.rst
873 * @groups: Sysfs attribute groups.
874 * @dev_groups: Attributes attached to the device that will be
875 * created once it is bound to the driver.
876 * @driver: Driver model structure.
877 * @dynids: List of dynamically added device IDs.
880 struct list_head node;
882 const struct pci_device_id *id_table; /* Must be non-NULL for probe to be called */
883 int (*probe)(struct pci_dev *dev, const struct pci_device_id *id); /* New device inserted */
884 void (*remove)(struct pci_dev *dev); /* Device removed (NULL if not a hot-plug capable driver) */
885 int (*suspend)(struct pci_dev *dev, pm_message_t state); /* Device suspended */
886 int (*resume)(struct pci_dev *dev); /* Device woken up */
887 void (*shutdown)(struct pci_dev *dev);
888 int (*sriov_configure)(struct pci_dev *dev, int num_vfs); /* On PF */
889 int (*sriov_set_msix_vec_count)(struct pci_dev *vf, int msix_vec_count); /* On PF */
890 u32 (*sriov_get_vf_total_msix)(struct pci_dev *pf);
891 const struct pci_error_handlers *err_handler;
892 const struct attribute_group **groups;
893 const struct attribute_group **dev_groups;
894 struct device_driver driver;
895 struct pci_dynids dynids;
898 #define to_pci_driver(drv) container_of(drv, struct pci_driver, driver)
901 * PCI_DEVICE - macro used to describe a specific PCI device
902 * @vend: the 16 bit PCI Vendor ID
903 * @dev: the 16 bit PCI Device ID
905 * This macro is used to create a struct pci_device_id that matches a
906 * specific device. The subvendor and subdevice fields will be set to
909 #define PCI_DEVICE(vend,dev) \
910 .vendor = (vend), .device = (dev), \
911 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
914 * PCI_DEVICE_SUB - macro used to describe a specific PCI device with subsystem
915 * @vend: the 16 bit PCI Vendor ID
916 * @dev: the 16 bit PCI Device ID
917 * @subvend: the 16 bit PCI Subvendor ID
918 * @subdev: the 16 bit PCI Subdevice ID
920 * This macro is used to create a struct pci_device_id that matches a
921 * specific device with subsystem information.
923 #define PCI_DEVICE_SUB(vend, dev, subvend, subdev) \
924 .vendor = (vend), .device = (dev), \
925 .subvendor = (subvend), .subdevice = (subdev)
928 * PCI_DEVICE_CLASS - macro used to describe a specific PCI device class
929 * @dev_class: the class, subclass, prog-if triple for this device
930 * @dev_class_mask: the class mask for this device
932 * This macro is used to create a struct pci_device_id that matches a
933 * specific PCI class. The vendor, device, subvendor, and subdevice
934 * fields will be set to PCI_ANY_ID.
936 #define PCI_DEVICE_CLASS(dev_class,dev_class_mask) \
937 .class = (dev_class), .class_mask = (dev_class_mask), \
938 .vendor = PCI_ANY_ID, .device = PCI_ANY_ID, \
939 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
942 * PCI_VDEVICE - macro used to describe a specific PCI device in short form
943 * @vend: the vendor name
944 * @dev: the 16 bit PCI Device ID
946 * This macro is used to create a struct pci_device_id that matches a
947 * specific PCI device. The subvendor, and subdevice fields will be set
948 * to PCI_ANY_ID. The macro allows the next field to follow as the device
951 #define PCI_VDEVICE(vend, dev) \
952 .vendor = PCI_VENDOR_ID_##vend, .device = (dev), \
953 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, 0, 0
956 * PCI_DEVICE_DATA - macro used to describe a specific PCI device in very short form
957 * @vend: the vendor name (without PCI_VENDOR_ID_ prefix)
958 * @dev: the device name (without PCI_DEVICE_ID_<vend>_ prefix)
959 * @data: the driver data to be filled
961 * This macro is used to create a struct pci_device_id that matches a
962 * specific PCI device. The subvendor, and subdevice fields will be set
965 #define PCI_DEVICE_DATA(vend, dev, data) \
966 .vendor = PCI_VENDOR_ID_##vend, .device = PCI_DEVICE_ID_##vend##_##dev, \
967 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, 0, 0, \
968 .driver_data = (kernel_ulong_t)(data)
971 PCI_REASSIGN_ALL_RSRC = 0x00000001, /* Ignore firmware setup */
972 PCI_REASSIGN_ALL_BUS = 0x00000002, /* Reassign all bus numbers */
973 PCI_PROBE_ONLY = 0x00000004, /* Use existing setup */
974 PCI_CAN_SKIP_ISA_ALIGN = 0x00000008, /* Don't do ISA alignment */
975 PCI_ENABLE_PROC_DOMAINS = 0x00000010, /* Enable domains in /proc */
976 PCI_COMPAT_DOMAIN_0 = 0x00000020, /* ... except domain 0 */
977 PCI_SCAN_ALL_PCIE_DEVS = 0x00000040, /* Scan all, not just dev 0 */
980 #define PCI_IRQ_LEGACY (1 << 0) /* Allow legacy interrupts */
981 #define PCI_IRQ_MSI (1 << 1) /* Allow MSI interrupts */
982 #define PCI_IRQ_MSIX (1 << 2) /* Allow MSI-X interrupts */
983 #define PCI_IRQ_AFFINITY (1 << 3) /* Auto-assign affinity */
985 /* These external functions are only available when PCI support is enabled */
988 extern unsigned int pci_flags;
990 static inline void pci_set_flags(int flags) { pci_flags = flags; }
991 static inline void pci_add_flags(int flags) { pci_flags |= flags; }
992 static inline void pci_clear_flags(int flags) { pci_flags &= ~flags; }
993 static inline int pci_has_flag(int flag) { return pci_flags & flag; }
995 void pcie_bus_configure_settings(struct pci_bus *bus);
997 enum pcie_bus_config_types {
998 PCIE_BUS_TUNE_OFF, /* Don't touch MPS at all */
999 PCIE_BUS_DEFAULT, /* Ensure MPS matches upstream bridge */
1000 PCIE_BUS_SAFE, /* Use largest MPS boot-time devices support */
1001 PCIE_BUS_PERFORMANCE, /* Use MPS and MRRS for best performance */
1002 PCIE_BUS_PEER2PEER, /* Set MPS = 128 for all devices */
1005 extern enum pcie_bus_config_types pcie_bus_config;
1007 extern struct bus_type pci_bus_type;
1009 /* Do NOT directly access these two variables, unless you are arch-specific PCI
1010 * code, or PCI core code. */
1011 extern struct list_head pci_root_buses; /* List of all known PCI buses */
1012 /* Some device drivers need know if PCI is initiated */
1013 int no_pci_devices(void);
1015 void pcibios_resource_survey_bus(struct pci_bus *bus);
1016 void pcibios_bus_add_device(struct pci_dev *pdev);
1017 void pcibios_add_bus(struct pci_bus *bus);
1018 void pcibios_remove_bus(struct pci_bus *bus);
1019 void pcibios_fixup_bus(struct pci_bus *);
1020 int __must_check pcibios_enable_device(struct pci_dev *, int mask);
1021 /* Architecture-specific versions may override this (weak) */
1022 char *pcibios_setup(char *str);
1024 /* Used only when drivers/pci/setup.c is used */
1025 resource_size_t pcibios_align_resource(void *, const struct resource *,
1029 /* Weak but can be overridden by arch */
1030 void pci_fixup_cardbus(struct pci_bus *);
1032 /* Generic PCI functions used internally */
1034 void pcibios_resource_to_bus(struct pci_bus *bus, struct pci_bus_region *region,
1035 struct resource *res);
1036 void pcibios_bus_to_resource(struct pci_bus *bus, struct resource *res,
1037 struct pci_bus_region *region);
1038 void pcibios_scan_specific_bus(int busn);
1039 struct pci_bus *pci_find_bus(int domain, int busnr);
1040 void pci_bus_add_devices(const struct pci_bus *bus);
1041 struct pci_bus *pci_scan_bus(int bus, struct pci_ops *ops, void *sysdata);
1042 struct pci_bus *pci_create_root_bus(struct device *parent, int bus,
1043 struct pci_ops *ops, void *sysdata,
1044 struct list_head *resources);
1045 int pci_host_probe(struct pci_host_bridge *bridge);
1046 int pci_bus_insert_busn_res(struct pci_bus *b, int bus, int busmax);
1047 int pci_bus_update_busn_res_end(struct pci_bus *b, int busmax);
1048 void pci_bus_release_busn_res(struct pci_bus *b);
1049 struct pci_bus *pci_scan_root_bus(struct device *parent, int bus,
1050 struct pci_ops *ops, void *sysdata,
1051 struct list_head *resources);
1052 int pci_scan_root_bus_bridge(struct pci_host_bridge *bridge);
1053 struct pci_bus *pci_add_new_bus(struct pci_bus *parent, struct pci_dev *dev,
1055 struct pci_slot *pci_create_slot(struct pci_bus *parent, int slot_nr,
1057 struct hotplug_slot *hotplug);
1058 void pci_destroy_slot(struct pci_slot *slot);
1060 void pci_dev_assign_slot(struct pci_dev *dev);
1062 static inline void pci_dev_assign_slot(struct pci_dev *dev) { }
1064 int pci_scan_slot(struct pci_bus *bus, int devfn);
1065 struct pci_dev *pci_scan_single_device(struct pci_bus *bus, int devfn);
1066 void pci_device_add(struct pci_dev *dev, struct pci_bus *bus);
1067 unsigned int pci_scan_child_bus(struct pci_bus *bus);
1068 void pci_bus_add_device(struct pci_dev *dev);
1069 void pci_read_bridge_bases(struct pci_bus *child);
1070 struct resource *pci_find_parent_resource(const struct pci_dev *dev,
1071 struct resource *res);
1072 u8 pci_swizzle_interrupt_pin(const struct pci_dev *dev, u8 pin);
1073 int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge);
1074 u8 pci_common_swizzle(struct pci_dev *dev, u8 *pinp);
1075 struct pci_dev *pci_dev_get(struct pci_dev *dev);
1076 void pci_dev_put(struct pci_dev *dev);
1077 void pci_remove_bus(struct pci_bus *b);
1078 void pci_stop_and_remove_bus_device(struct pci_dev *dev);
1079 void pci_stop_and_remove_bus_device_locked(struct pci_dev *dev);
1080 void pci_stop_root_bus(struct pci_bus *bus);
1081 void pci_remove_root_bus(struct pci_bus *bus);
1082 void pci_setup_cardbus(struct pci_bus *bus);
1083 void pcibios_setup_bridge(struct pci_bus *bus, unsigned long type);
1084 void pci_sort_breadthfirst(void);
1085 #define dev_is_pci(d) ((d)->bus == &pci_bus_type)
1086 #define dev_is_pf(d) ((dev_is_pci(d) ? to_pci_dev(d)->is_physfn : false))
1088 /* Generic PCI functions exported to card drivers */
1090 u8 pci_bus_find_capability(struct pci_bus *bus, unsigned int devfn, int cap);
1091 u8 pci_find_capability(struct pci_dev *dev, int cap);
1092 u8 pci_find_next_capability(struct pci_dev *dev, u8 pos, int cap);
1093 u8 pci_find_ht_capability(struct pci_dev *dev, int ht_cap);
1094 u8 pci_find_next_ht_capability(struct pci_dev *dev, u8 pos, int ht_cap);
1095 u16 pci_find_ext_capability(struct pci_dev *dev, int cap);
1096 u16 pci_find_next_ext_capability(struct pci_dev *dev, u16 pos, int cap);
1097 struct pci_bus *pci_find_next_bus(const struct pci_bus *from);
1098 u16 pci_find_vsec_capability(struct pci_dev *dev, u16 vendor, int cap);
1100 u64 pci_get_dsn(struct pci_dev *dev);
1102 struct pci_dev *pci_get_device(unsigned int vendor, unsigned int device,
1103 struct pci_dev *from);
1104 struct pci_dev *pci_get_subsys(unsigned int vendor, unsigned int device,
1105 unsigned int ss_vendor, unsigned int ss_device,
1106 struct pci_dev *from);
1107 struct pci_dev *pci_get_slot(struct pci_bus *bus, unsigned int devfn);
1108 struct pci_dev *pci_get_domain_bus_and_slot(int domain, unsigned int bus,
1109 unsigned int devfn);
1110 struct pci_dev *pci_get_class(unsigned int class, struct pci_dev *from);
1111 int pci_dev_present(const struct pci_device_id *ids);
1113 int pci_bus_read_config_byte(struct pci_bus *bus, unsigned int devfn,
1114 int where, u8 *val);
1115 int pci_bus_read_config_word(struct pci_bus *bus, unsigned int devfn,
1116 int where, u16 *val);
1117 int pci_bus_read_config_dword(struct pci_bus *bus, unsigned int devfn,
1118 int where, u32 *val);
1119 int pci_bus_write_config_byte(struct pci_bus *bus, unsigned int devfn,
1121 int pci_bus_write_config_word(struct pci_bus *bus, unsigned int devfn,
1122 int where, u16 val);
1123 int pci_bus_write_config_dword(struct pci_bus *bus, unsigned int devfn,
1124 int where, u32 val);
1126 int pci_generic_config_read(struct pci_bus *bus, unsigned int devfn,
1127 int where, int size, u32 *val);
1128 int pci_generic_config_write(struct pci_bus *bus, unsigned int devfn,
1129 int where, int size, u32 val);
1130 int pci_generic_config_read32(struct pci_bus *bus, unsigned int devfn,
1131 int where, int size, u32 *val);
1132 int pci_generic_config_write32(struct pci_bus *bus, unsigned int devfn,
1133 int where, int size, u32 val);
1135 struct pci_ops *pci_bus_set_ops(struct pci_bus *bus, struct pci_ops *ops);
1137 int pci_read_config_byte(const struct pci_dev *dev, int where, u8 *val);
1138 int pci_read_config_word(const struct pci_dev *dev, int where, u16 *val);
1139 int pci_read_config_dword(const struct pci_dev *dev, int where, u32 *val);
1140 int pci_write_config_byte(const struct pci_dev *dev, int where, u8 val);
1141 int pci_write_config_word(const struct pci_dev *dev, int where, u16 val);
1142 int pci_write_config_dword(const struct pci_dev *dev, int where, u32 val);
1144 int pcie_capability_read_word(struct pci_dev *dev, int pos, u16 *val);
1145 int pcie_capability_read_dword(struct pci_dev *dev, int pos, u32 *val);
1146 int pcie_capability_write_word(struct pci_dev *dev, int pos, u16 val);
1147 int pcie_capability_write_dword(struct pci_dev *dev, int pos, u32 val);
1148 int pcie_capability_clear_and_set_word(struct pci_dev *dev, int pos,
1149 u16 clear, u16 set);
1150 int pcie_capability_clear_and_set_dword(struct pci_dev *dev, int pos,
1151 u32 clear, u32 set);
1153 static inline int pcie_capability_set_word(struct pci_dev *dev, int pos,
1156 return pcie_capability_clear_and_set_word(dev, pos, 0, set);
1159 static inline int pcie_capability_set_dword(struct pci_dev *dev, int pos,
1162 return pcie_capability_clear_and_set_dword(dev, pos, 0, set);
1165 static inline int pcie_capability_clear_word(struct pci_dev *dev, int pos,
1168 return pcie_capability_clear_and_set_word(dev, pos, clear, 0);
1171 static inline int pcie_capability_clear_dword(struct pci_dev *dev, int pos,
1174 return pcie_capability_clear_and_set_dword(dev, pos, clear, 0);
1177 /* User-space driven config access */
1178 int pci_user_read_config_byte(struct pci_dev *dev, int where, u8 *val);
1179 int pci_user_read_config_word(struct pci_dev *dev, int where, u16 *val);
1180 int pci_user_read_config_dword(struct pci_dev *dev, int where, u32 *val);
1181 int pci_user_write_config_byte(struct pci_dev *dev, int where, u8 val);
1182 int pci_user_write_config_word(struct pci_dev *dev, int where, u16 val);
1183 int pci_user_write_config_dword(struct pci_dev *dev, int where, u32 val);
1185 int __must_check pci_enable_device(struct pci_dev *dev);
1186 int __must_check pci_enable_device_io(struct pci_dev *dev);
1187 int __must_check pci_enable_device_mem(struct pci_dev *dev);
1188 int __must_check pci_reenable_device(struct pci_dev *);
1189 int __must_check pcim_enable_device(struct pci_dev *pdev);
1190 void pcim_pin_device(struct pci_dev *pdev);
1192 static inline bool pci_intx_mask_supported(struct pci_dev *pdev)
1195 * INTx masking is supported if PCI_COMMAND_INTX_DISABLE is
1196 * writable and no quirk has marked the feature broken.
1198 return !pdev->broken_intx_masking;
1201 static inline int pci_is_enabled(struct pci_dev *pdev)
1203 return (atomic_read(&pdev->enable_cnt) > 0);
1206 static inline int pci_is_managed(struct pci_dev *pdev)
1208 return pdev->is_managed;
1211 void pci_disable_device(struct pci_dev *dev);
1213 extern unsigned int pcibios_max_latency;
1214 void pci_set_master(struct pci_dev *dev);
1215 void pci_clear_master(struct pci_dev *dev);
1217 int pci_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state);
1218 int pci_set_cacheline_size(struct pci_dev *dev);
1219 int __must_check pci_set_mwi(struct pci_dev *dev);
1220 int __must_check pcim_set_mwi(struct pci_dev *dev);
1221 int pci_try_set_mwi(struct pci_dev *dev);
1222 void pci_clear_mwi(struct pci_dev *dev);
1223 void pci_disable_parity(struct pci_dev *dev);
1224 void pci_intx(struct pci_dev *dev, int enable);
1225 bool pci_check_and_mask_intx(struct pci_dev *dev);
1226 bool pci_check_and_unmask_intx(struct pci_dev *dev);
1227 int pci_wait_for_pending(struct pci_dev *dev, int pos, u16 mask);
1228 int pci_wait_for_pending_transaction(struct pci_dev *dev);
1229 int pcix_get_max_mmrbc(struct pci_dev *dev);
1230 int pcix_get_mmrbc(struct pci_dev *dev);
1231 int pcix_set_mmrbc(struct pci_dev *dev, int mmrbc);
1232 int pcie_get_readrq(struct pci_dev *dev);
1233 int pcie_set_readrq(struct pci_dev *dev, int rq);
1234 int pcie_get_mps(struct pci_dev *dev);
1235 int pcie_set_mps(struct pci_dev *dev, int mps);
1236 u32 pcie_bandwidth_available(struct pci_dev *dev, struct pci_dev **limiting_dev,
1237 enum pci_bus_speed *speed,
1238 enum pcie_link_width *width);
1239 void pcie_print_link_status(struct pci_dev *dev);
1240 int pcie_reset_flr(struct pci_dev *dev, bool probe);
1241 int pcie_flr(struct pci_dev *dev);
1242 int __pci_reset_function_locked(struct pci_dev *dev);
1243 int pci_reset_function(struct pci_dev *dev);
1244 int pci_reset_function_locked(struct pci_dev *dev);
1245 int pci_try_reset_function(struct pci_dev *dev);
1246 int pci_probe_reset_slot(struct pci_slot *slot);
1247 int pci_probe_reset_bus(struct pci_bus *bus);
1248 int pci_reset_bus(struct pci_dev *dev);
1249 void pci_reset_secondary_bus(struct pci_dev *dev);
1250 void pcibios_reset_secondary_bus(struct pci_dev *dev);
1251 void pci_update_resource(struct pci_dev *dev, int resno);
1252 int __must_check pci_assign_resource(struct pci_dev *dev, int i);
1253 int __must_check pci_reassign_resource(struct pci_dev *dev, int i, resource_size_t add_size, resource_size_t align);
1254 void pci_release_resource(struct pci_dev *dev, int resno);
1255 static inline int pci_rebar_bytes_to_size(u64 bytes)
1257 bytes = roundup_pow_of_two(bytes);
1259 /* Return BAR size as defined in the resizable BAR specification */
1260 return max(ilog2(bytes), 20) - 20;
1263 u32 pci_rebar_get_possible_sizes(struct pci_dev *pdev, int bar);
1264 int __must_check pci_resize_resource(struct pci_dev *dev, int i, int size);
1265 int pci_select_bars(struct pci_dev *dev, unsigned long flags);
1266 bool pci_device_is_present(struct pci_dev *pdev);
1267 void pci_ignore_hotplug(struct pci_dev *dev);
1268 struct pci_dev *pci_real_dma_dev(struct pci_dev *dev);
1269 int pci_status_get_and_clear_errors(struct pci_dev *pdev);
1271 int __printf(6, 7) pci_request_irq(struct pci_dev *dev, unsigned int nr,
1272 irq_handler_t handler, irq_handler_t thread_fn, void *dev_id,
1273 const char *fmt, ...);
1274 void pci_free_irq(struct pci_dev *dev, unsigned int nr, void *dev_id);
1276 /* ROM control related routines */
1277 int pci_enable_rom(struct pci_dev *pdev);
1278 void pci_disable_rom(struct pci_dev *pdev);
1279 void __iomem __must_check *pci_map_rom(struct pci_dev *pdev, size_t *size);
1280 void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom);
1282 /* Power management related routines */
1283 int pci_save_state(struct pci_dev *dev);
1284 void pci_restore_state(struct pci_dev *dev);
1285 struct pci_saved_state *pci_store_saved_state(struct pci_dev *dev);
1286 int pci_load_saved_state(struct pci_dev *dev,
1287 struct pci_saved_state *state);
1288 int pci_load_and_free_saved_state(struct pci_dev *dev,
1289 struct pci_saved_state **state);
1290 struct pci_cap_saved_state *pci_find_saved_cap(struct pci_dev *dev, char cap);
1291 struct pci_cap_saved_state *pci_find_saved_ext_cap(struct pci_dev *dev,
1293 int pci_add_cap_save_buffer(struct pci_dev *dev, char cap, unsigned int size);
1294 int pci_add_ext_cap_save_buffer(struct pci_dev *dev,
1295 u16 cap, unsigned int size);
1296 int pci_platform_power_transition(struct pci_dev *dev, pci_power_t state);
1297 int pci_set_power_state(struct pci_dev *dev, pci_power_t state);
1298 pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state);
1299 bool pci_pme_capable(struct pci_dev *dev, pci_power_t state);
1300 void pci_pme_active(struct pci_dev *dev, bool enable);
1301 int pci_enable_wake(struct pci_dev *dev, pci_power_t state, bool enable);
1302 int pci_wake_from_d3(struct pci_dev *dev, bool enable);
1303 int pci_prepare_to_sleep(struct pci_dev *dev);
1304 int pci_back_from_sleep(struct pci_dev *dev);
1305 bool pci_dev_run_wake(struct pci_dev *dev);
1306 void pci_d3cold_enable(struct pci_dev *dev);
1307 void pci_d3cold_disable(struct pci_dev *dev);
1308 bool pcie_relaxed_ordering_enabled(struct pci_dev *dev);
1309 void pci_resume_bus(struct pci_bus *bus);
1310 void pci_bus_set_current_state(struct pci_bus *bus, pci_power_t state);
1312 /* For use by arch with custom probe code */
1313 void set_pcie_port_type(struct pci_dev *pdev);
1314 void set_pcie_hotplug_bridge(struct pci_dev *pdev);
1316 /* Functions for PCI Hotplug drivers to use */
1317 unsigned int pci_rescan_bus_bridge_resize(struct pci_dev *bridge);
1318 unsigned int pci_rescan_bus(struct pci_bus *bus);
1319 void pci_lock_rescan_remove(void);
1320 void pci_unlock_rescan_remove(void);
1322 /* Vital Product Data routines */
1323 ssize_t pci_read_vpd(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
1324 ssize_t pci_write_vpd(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
1326 /* Helper functions for low-level code (drivers/pci/setup-[bus,res].c) */
1327 resource_size_t pcibios_retrieve_fw_addr(struct pci_dev *dev, int idx);
1328 void pci_bus_assign_resources(const struct pci_bus *bus);
1329 void pci_bus_claim_resources(struct pci_bus *bus);
1330 void pci_bus_size_bridges(struct pci_bus *bus);
1331 int pci_claim_resource(struct pci_dev *, int);
1332 int pci_claim_bridge_resource(struct pci_dev *bridge, int i);
1333 void pci_assign_unassigned_resources(void);
1334 void pci_assign_unassigned_bridge_resources(struct pci_dev *bridge);
1335 void pci_assign_unassigned_bus_resources(struct pci_bus *bus);
1336 void pci_assign_unassigned_root_bus_resources(struct pci_bus *bus);
1337 int pci_reassign_bridge_resources(struct pci_dev *bridge, unsigned long type);
1338 void pdev_enable_device(struct pci_dev *);
1339 int pci_enable_resources(struct pci_dev *, int mask);
1340 void pci_assign_irq(struct pci_dev *dev);
1341 struct resource *pci_find_resource(struct pci_dev *dev, struct resource *res);
1342 #define HAVE_PCI_REQ_REGIONS 2
1343 int __must_check pci_request_regions(struct pci_dev *, const char *);
1344 int __must_check pci_request_regions_exclusive(struct pci_dev *, const char *);
1345 void pci_release_regions(struct pci_dev *);
1346 int __must_check pci_request_region(struct pci_dev *, int, const char *);
1347 void pci_release_region(struct pci_dev *, int);
1348 int pci_request_selected_regions(struct pci_dev *, int, const char *);
1349 int pci_request_selected_regions_exclusive(struct pci_dev *, int, const char *);
1350 void pci_release_selected_regions(struct pci_dev *, int);
1352 /* drivers/pci/bus.c */
1353 void pci_add_resource(struct list_head *resources, struct resource *res);
1354 void pci_add_resource_offset(struct list_head *resources, struct resource *res,
1355 resource_size_t offset);
1356 void pci_free_resource_list(struct list_head *resources);
1357 void pci_bus_add_resource(struct pci_bus *bus, struct resource *res,
1358 unsigned int flags);
1359 struct resource *pci_bus_resource_n(const struct pci_bus *bus, int n);
1360 void pci_bus_remove_resources(struct pci_bus *bus);
1361 int devm_request_pci_bus_resources(struct device *dev,
1362 struct list_head *resources);
1364 /* Temporary until new and working PCI SBR API in place */
1365 int pci_bridge_secondary_bus_reset(struct pci_dev *dev);
1367 #define pci_bus_for_each_resource(bus, res, i) \
1369 (res = pci_bus_resource_n(bus, i)) || i < PCI_BRIDGE_RESOURCE_NUM; \
1372 int __must_check pci_bus_alloc_resource(struct pci_bus *bus,
1373 struct resource *res, resource_size_t size,
1374 resource_size_t align, resource_size_t min,
1375 unsigned long type_mask,
1376 resource_size_t (*alignf)(void *,
1377 const struct resource *,
1383 int pci_register_io_range(struct fwnode_handle *fwnode, phys_addr_t addr,
1384 resource_size_t size);
1385 unsigned long pci_address_to_pio(phys_addr_t addr);
1386 phys_addr_t pci_pio_to_address(unsigned long pio);
1387 int pci_remap_iospace(const struct resource *res, phys_addr_t phys_addr);
1388 int devm_pci_remap_iospace(struct device *dev, const struct resource *res,
1389 phys_addr_t phys_addr);
1390 void pci_unmap_iospace(struct resource *res);
1391 void __iomem *devm_pci_remap_cfgspace(struct device *dev,
1392 resource_size_t offset,
1393 resource_size_t size);
1394 void __iomem *devm_pci_remap_cfg_resource(struct device *dev,
1395 struct resource *res);
1397 static inline pci_bus_addr_t pci_bus_address(struct pci_dev *pdev, int bar)
1399 struct pci_bus_region region;
1401 pcibios_resource_to_bus(pdev->bus, ®ion, &pdev->resource[bar]);
1402 return region.start;
1405 /* Proper probing supporting hot-pluggable devices */
1406 int __must_check __pci_register_driver(struct pci_driver *, struct module *,
1407 const char *mod_name);
1409 /* pci_register_driver() must be a macro so KBUILD_MODNAME can be expanded */
1410 #define pci_register_driver(driver) \
1411 __pci_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
1413 void pci_unregister_driver(struct pci_driver *dev);
1416 * module_pci_driver() - Helper macro for registering a PCI driver
1417 * @__pci_driver: pci_driver struct
1419 * Helper macro for PCI drivers which do not do anything special in module
1420 * init/exit. This eliminates a lot of boilerplate. Each module may only
1421 * use this macro once, and calling it replaces module_init() and module_exit()
1423 #define module_pci_driver(__pci_driver) \
1424 module_driver(__pci_driver, pci_register_driver, pci_unregister_driver)
1427 * builtin_pci_driver() - Helper macro for registering a PCI driver
1428 * @__pci_driver: pci_driver struct
1430 * Helper macro for PCI drivers which do not do anything special in their
1431 * init code. This eliminates a lot of boilerplate. Each driver may only
1432 * use this macro once, and calling it replaces device_initcall(...)
1434 #define builtin_pci_driver(__pci_driver) \
1435 builtin_driver(__pci_driver, pci_register_driver)
1437 struct pci_driver *pci_dev_driver(const struct pci_dev *dev);
1438 int pci_add_dynid(struct pci_driver *drv,
1439 unsigned int vendor, unsigned int device,
1440 unsigned int subvendor, unsigned int subdevice,
1441 unsigned int class, unsigned int class_mask,
1442 unsigned long driver_data);
1443 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
1444 struct pci_dev *dev);
1445 int pci_scan_bridge(struct pci_bus *bus, struct pci_dev *dev, int max,
1448 void pci_walk_bus(struct pci_bus *top, int (*cb)(struct pci_dev *, void *),
1450 int pci_cfg_space_size(struct pci_dev *dev);
1451 unsigned char pci_bus_max_busnr(struct pci_bus *bus);
1452 void pci_setup_bridge(struct pci_bus *bus);
1453 resource_size_t pcibios_window_alignment(struct pci_bus *bus,
1454 unsigned long type);
1456 #define PCI_VGA_STATE_CHANGE_BRIDGE (1 << 0)
1457 #define PCI_VGA_STATE_CHANGE_DECODES (1 << 1)
1459 int pci_set_vga_state(struct pci_dev *pdev, bool decode,
1460 unsigned int command_bits, u32 flags);
1463 * Virtual interrupts allow for more interrupts to be allocated
1464 * than the device has interrupts for. These are not programmed
1465 * into the device's MSI-X table and must be handled by some
1466 * other driver means.
1468 #define PCI_IRQ_VIRTUAL (1 << 4)
1470 #define PCI_IRQ_ALL_TYPES \
1471 (PCI_IRQ_LEGACY | PCI_IRQ_MSI | PCI_IRQ_MSIX)
1473 /* kmem_cache style wrapper around pci_alloc_consistent() */
1475 #include <linux/dmapool.h>
1477 #define pci_pool dma_pool
1478 #define pci_pool_create(name, pdev, size, align, allocation) \
1479 dma_pool_create(name, &pdev->dev, size, align, allocation)
1480 #define pci_pool_destroy(pool) dma_pool_destroy(pool)
1481 #define pci_pool_alloc(pool, flags, handle) dma_pool_alloc(pool, flags, handle)
1482 #define pci_pool_zalloc(pool, flags, handle) \
1483 dma_pool_zalloc(pool, flags, handle)
1484 #define pci_pool_free(pool, vaddr, addr) dma_pool_free(pool, vaddr, addr)
1487 u32 vector; /* Kernel uses to write allocated vector */
1488 u16 entry; /* Driver uses to specify entry, OS writes */
1491 #ifdef CONFIG_PCI_MSI
1492 int pci_msi_vec_count(struct pci_dev *dev);
1493 void pci_disable_msi(struct pci_dev *dev);
1494 int pci_msix_vec_count(struct pci_dev *dev);
1495 void pci_disable_msix(struct pci_dev *dev);
1496 void pci_restore_msi_state(struct pci_dev *dev);
1497 int pci_msi_enabled(void);
1498 int pci_enable_msi(struct pci_dev *dev);
1499 int pci_enable_msix_range(struct pci_dev *dev, struct msix_entry *entries,
1500 int minvec, int maxvec);
1501 static inline int pci_enable_msix_exact(struct pci_dev *dev,
1502 struct msix_entry *entries, int nvec)
1504 int rc = pci_enable_msix_range(dev, entries, nvec, nvec);
1509 int pci_alloc_irq_vectors_affinity(struct pci_dev *dev, unsigned int min_vecs,
1510 unsigned int max_vecs, unsigned int flags,
1511 struct irq_affinity *affd);
1513 void pci_free_irq_vectors(struct pci_dev *dev);
1514 int pci_irq_vector(struct pci_dev *dev, unsigned int nr);
1515 const struct cpumask *pci_irq_get_affinity(struct pci_dev *pdev, int vec);
1518 static inline int pci_msi_vec_count(struct pci_dev *dev) { return -ENOSYS; }
1519 static inline void pci_disable_msi(struct pci_dev *dev) { }
1520 static inline int pci_msix_vec_count(struct pci_dev *dev) { return -ENOSYS; }
1521 static inline void pci_disable_msix(struct pci_dev *dev) { }
1522 static inline void pci_restore_msi_state(struct pci_dev *dev) { }
1523 static inline int pci_msi_enabled(void) { return 0; }
1524 static inline int pci_enable_msi(struct pci_dev *dev)
1526 static inline int pci_enable_msix_range(struct pci_dev *dev,
1527 struct msix_entry *entries, int minvec, int maxvec)
1529 static inline int pci_enable_msix_exact(struct pci_dev *dev,
1530 struct msix_entry *entries, int nvec)
1534 pci_alloc_irq_vectors_affinity(struct pci_dev *dev, unsigned int min_vecs,
1535 unsigned int max_vecs, unsigned int flags,
1536 struct irq_affinity *aff_desc)
1538 if ((flags & PCI_IRQ_LEGACY) && min_vecs == 1 && dev->irq)
1543 static inline void pci_free_irq_vectors(struct pci_dev *dev)
1547 static inline int pci_irq_vector(struct pci_dev *dev, unsigned int nr)
1549 if (WARN_ON_ONCE(nr > 0))
1553 static inline const struct cpumask *pci_irq_get_affinity(struct pci_dev *pdev,
1556 return cpu_possible_mask;
1561 * pci_irqd_intx_xlate() - Translate PCI INTx value to an IRQ domain hwirq
1562 * @d: the INTx IRQ domain
1563 * @node: the DT node for the device whose interrupt we're translating
1564 * @intspec: the interrupt specifier data from the DT
1565 * @intsize: the number of entries in @intspec
1566 * @out_hwirq: pointer at which to write the hwirq number
1567 * @out_type: pointer at which to write the interrupt type
1569 * Translate a PCI INTx interrupt number from device tree in the range 1-4, as
1570 * stored in the standard PCI_INTERRUPT_PIN register, to a value in the range
1571 * 0-3 suitable for use in a 4 entry IRQ domain. That is, subtract one from the
1572 * INTx value to obtain the hwirq number.
1574 * Returns 0 on success, or -EINVAL if the interrupt specifier is out of range.
1576 static inline int pci_irqd_intx_xlate(struct irq_domain *d,
1577 struct device_node *node,
1579 unsigned int intsize,
1580 unsigned long *out_hwirq,
1581 unsigned int *out_type)
1583 const u32 intx = intspec[0];
1585 if (intx < PCI_INTERRUPT_INTA || intx > PCI_INTERRUPT_INTD)
1588 *out_hwirq = intx - PCI_INTERRUPT_INTA;
1592 #ifdef CONFIG_PCIEPORTBUS
1593 extern bool pcie_ports_disabled;
1594 extern bool pcie_ports_native;
1596 #define pcie_ports_disabled true
1597 #define pcie_ports_native false
1600 #define PCIE_LINK_STATE_L0S BIT(0)
1601 #define PCIE_LINK_STATE_L1 BIT(1)
1602 #define PCIE_LINK_STATE_CLKPM BIT(2)
1603 #define PCIE_LINK_STATE_L1_1 BIT(3)
1604 #define PCIE_LINK_STATE_L1_2 BIT(4)
1605 #define PCIE_LINK_STATE_L1_1_PCIPM BIT(5)
1606 #define PCIE_LINK_STATE_L1_2_PCIPM BIT(6)
1608 #ifdef CONFIG_PCIEASPM
1609 int pci_disable_link_state(struct pci_dev *pdev, int state);
1610 int pci_disable_link_state_locked(struct pci_dev *pdev, int state);
1611 void pcie_no_aspm(void);
1612 bool pcie_aspm_support_enabled(void);
1613 bool pcie_aspm_enabled(struct pci_dev *pdev);
1615 static inline int pci_disable_link_state(struct pci_dev *pdev, int state)
1617 static inline int pci_disable_link_state_locked(struct pci_dev *pdev, int state)
1619 static inline void pcie_no_aspm(void) { }
1620 static inline bool pcie_aspm_support_enabled(void) { return false; }
1621 static inline bool pcie_aspm_enabled(struct pci_dev *pdev) { return false; }
1624 #ifdef CONFIG_PCIEAER
1625 bool pci_aer_available(void);
1627 static inline bool pci_aer_available(void) { return false; }
1630 bool pci_ats_disabled(void);
1632 void pci_cfg_access_lock(struct pci_dev *dev);
1633 bool pci_cfg_access_trylock(struct pci_dev *dev);
1634 void pci_cfg_access_unlock(struct pci_dev *dev);
1636 int pci_dev_trylock(struct pci_dev *dev);
1637 void pci_dev_unlock(struct pci_dev *dev);
1640 * PCI domain support. Sometimes called PCI segment (eg by ACPI),
1641 * a PCI domain is defined to be a set of PCI buses which share
1642 * configuration space.
1644 #ifdef CONFIG_PCI_DOMAINS
1645 extern int pci_domains_supported;
1647 enum { pci_domains_supported = 0 };
1648 static inline int pci_domain_nr(struct pci_bus *bus) { return 0; }
1649 static inline int pci_proc_domain(struct pci_bus *bus) { return 0; }
1650 #endif /* CONFIG_PCI_DOMAINS */
1653 * Generic implementation for PCI domain support. If your
1654 * architecture does not need custom management of PCI
1655 * domains then this implementation will be used
1657 #ifdef CONFIG_PCI_DOMAINS_GENERIC
1658 static inline int pci_domain_nr(struct pci_bus *bus)
1660 return bus->domain_nr;
1663 int acpi_pci_bus_find_domain_nr(struct pci_bus *bus);
1665 static inline int acpi_pci_bus_find_domain_nr(struct pci_bus *bus)
1668 int pci_bus_find_domain_nr(struct pci_bus *bus, struct device *parent);
1671 /* Some architectures require additional setup to direct VGA traffic */
1672 typedef int (*arch_set_vga_state_t)(struct pci_dev *pdev, bool decode,
1673 unsigned int command_bits, u32 flags);
1674 void pci_register_set_vga_state(arch_set_vga_state_t func);
1677 pci_request_io_regions(struct pci_dev *pdev, const char *name)
1679 return pci_request_selected_regions(pdev,
1680 pci_select_bars(pdev, IORESOURCE_IO), name);
1684 pci_release_io_regions(struct pci_dev *pdev)
1686 return pci_release_selected_regions(pdev,
1687 pci_select_bars(pdev, IORESOURCE_IO));
1691 pci_request_mem_regions(struct pci_dev *pdev, const char *name)
1693 return pci_request_selected_regions(pdev,
1694 pci_select_bars(pdev, IORESOURCE_MEM), name);
1698 pci_release_mem_regions(struct pci_dev *pdev)
1700 return pci_release_selected_regions(pdev,
1701 pci_select_bars(pdev, IORESOURCE_MEM));
1704 #else /* CONFIG_PCI is not enabled */
1706 static inline void pci_set_flags(int flags) { }
1707 static inline void pci_add_flags(int flags) { }
1708 static inline void pci_clear_flags(int flags) { }
1709 static inline int pci_has_flag(int flag) { return 0; }
1712 * If the system does not have PCI, clearly these return errors. Define
1713 * these as simple inline functions to avoid hair in drivers.
1715 #define _PCI_NOP(o, s, t) \
1716 static inline int pci_##o##_config_##s(struct pci_dev *dev, \
1718 { return PCIBIOS_FUNC_NOT_SUPPORTED; }
1720 #define _PCI_NOP_ALL(o, x) _PCI_NOP(o, byte, u8 x) \
1721 _PCI_NOP(o, word, u16 x) \
1722 _PCI_NOP(o, dword, u32 x)
1723 _PCI_NOP_ALL(read, *)
1724 _PCI_NOP_ALL(write,)
1726 static inline struct pci_dev *pci_get_device(unsigned int vendor,
1727 unsigned int device,
1728 struct pci_dev *from)
1731 static inline struct pci_dev *pci_get_subsys(unsigned int vendor,
1732 unsigned int device,
1733 unsigned int ss_vendor,
1734 unsigned int ss_device,
1735 struct pci_dev *from)
1738 static inline struct pci_dev *pci_get_class(unsigned int class,
1739 struct pci_dev *from)
1742 #define pci_dev_present(ids) (0)
1743 #define no_pci_devices() (1)
1744 #define pci_dev_put(dev) do { } while (0)
1746 static inline void pci_set_master(struct pci_dev *dev) { }
1747 static inline int pci_enable_device(struct pci_dev *dev) { return -EIO; }
1748 static inline void pci_disable_device(struct pci_dev *dev) { }
1749 static inline int pcim_enable_device(struct pci_dev *pdev) { return -EIO; }
1750 static inline int pci_assign_resource(struct pci_dev *dev, int i)
1752 static inline int __pci_register_driver(struct pci_driver *drv,
1753 struct module *owner)
1755 static inline int pci_register_driver(struct pci_driver *drv)
1757 static inline void pci_unregister_driver(struct pci_driver *drv) { }
1758 static inline u8 pci_find_capability(struct pci_dev *dev, int cap)
1760 static inline int pci_find_next_capability(struct pci_dev *dev, u8 post,
1763 static inline int pci_find_ext_capability(struct pci_dev *dev, int cap)
1766 static inline u64 pci_get_dsn(struct pci_dev *dev)
1769 /* Power management related routines */
1770 static inline int pci_save_state(struct pci_dev *dev) { return 0; }
1771 static inline void pci_restore_state(struct pci_dev *dev) { }
1772 static inline int pci_set_power_state(struct pci_dev *dev, pci_power_t state)
1774 static inline int pci_wake_from_d3(struct pci_dev *dev, bool enable)
1776 static inline pci_power_t pci_choose_state(struct pci_dev *dev,
1779 static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
1783 static inline struct resource *pci_find_resource(struct pci_dev *dev,
1784 struct resource *res)
1786 static inline int pci_request_regions(struct pci_dev *dev, const char *res_name)
1788 static inline void pci_release_regions(struct pci_dev *dev) { }
1790 static inline int pci_register_io_range(struct fwnode_handle *fwnode,
1791 phys_addr_t addr, resource_size_t size)
1794 static inline unsigned long pci_address_to_pio(phys_addr_t addr) { return -1; }
1796 static inline struct pci_bus *pci_find_next_bus(const struct pci_bus *from)
1798 static inline struct pci_dev *pci_get_slot(struct pci_bus *bus,
1801 static inline struct pci_dev *pci_get_domain_bus_and_slot(int domain,
1802 unsigned int bus, unsigned int devfn)
1805 static inline int pci_domain_nr(struct pci_bus *bus) { return 0; }
1806 static inline struct pci_dev *pci_dev_get(struct pci_dev *dev) { return NULL; }
1808 #define dev_is_pci(d) (false)
1809 #define dev_is_pf(d) (false)
1810 static inline bool pci_acs_enabled(struct pci_dev *pdev, u16 acs_flags)
1812 static inline int pci_irqd_intx_xlate(struct irq_domain *d,
1813 struct device_node *node,
1815 unsigned int intsize,
1816 unsigned long *out_hwirq,
1817 unsigned int *out_type)
1820 static inline const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
1821 struct pci_dev *dev)
1823 static inline bool pci_ats_disabled(void) { return true; }
1825 static inline int pci_irq_vector(struct pci_dev *dev, unsigned int nr)
1831 pci_alloc_irq_vectors_affinity(struct pci_dev *dev, unsigned int min_vecs,
1832 unsigned int max_vecs, unsigned int flags,
1833 struct irq_affinity *aff_desc)
1837 #endif /* CONFIG_PCI */
1840 pci_alloc_irq_vectors(struct pci_dev *dev, unsigned int min_vecs,
1841 unsigned int max_vecs, unsigned int flags)
1843 return pci_alloc_irq_vectors_affinity(dev, min_vecs, max_vecs, flags,
1847 /* Include architecture-dependent settings and functions */
1849 #include <asm/pci.h>
1851 /* These two functions provide almost identical functionality. Depending
1852 * on the architecture, one will be implemented as a wrapper around the
1853 * other (in drivers/pci/mmap.c).
1855 * pci_mmap_resource_range() maps a specific BAR, and vm->vm_pgoff
1856 * is expected to be an offset within that region.
1858 * pci_mmap_page_range() is the legacy architecture-specific interface,
1859 * which accepts a "user visible" resource address converted by
1860 * pci_resource_to_user(), as used in the legacy mmap() interface in
1863 int pci_mmap_resource_range(struct pci_dev *dev, int bar,
1864 struct vm_area_struct *vma,
1865 enum pci_mmap_state mmap_state, int write_combine);
1866 int pci_mmap_page_range(struct pci_dev *pdev, int bar,
1867 struct vm_area_struct *vma,
1868 enum pci_mmap_state mmap_state, int write_combine);
1870 #ifndef arch_can_pci_mmap_wc
1871 #define arch_can_pci_mmap_wc() 0
1874 #ifndef arch_can_pci_mmap_io
1875 #define arch_can_pci_mmap_io() 0
1876 #define pci_iobar_pfn(pdev, bar, vma) (-EINVAL)
1878 int pci_iobar_pfn(struct pci_dev *pdev, int bar, struct vm_area_struct *vma);
1881 #ifndef pci_root_bus_fwnode
1882 #define pci_root_bus_fwnode(bus) NULL
1886 * These helpers provide future and backwards compatibility
1887 * for accessing popular PCI BAR info
1889 #define pci_resource_start(dev, bar) ((dev)->resource[(bar)].start)
1890 #define pci_resource_end(dev, bar) ((dev)->resource[(bar)].end)
1891 #define pci_resource_flags(dev, bar) ((dev)->resource[(bar)].flags)
1892 #define pci_resource_len(dev,bar) \
1893 ((pci_resource_start((dev), (bar)) == 0 && \
1894 pci_resource_end((dev), (bar)) == \
1895 pci_resource_start((dev), (bar))) ? 0 : \
1897 (pci_resource_end((dev), (bar)) - \
1898 pci_resource_start((dev), (bar)) + 1))
1901 * Similar to the helpers above, these manipulate per-pci_dev
1902 * driver-specific data. They are really just a wrapper around
1903 * the generic device structure functions of these calls.
1905 static inline void *pci_get_drvdata(struct pci_dev *pdev)
1907 return dev_get_drvdata(&pdev->dev);
1910 static inline void pci_set_drvdata(struct pci_dev *pdev, void *data)
1912 dev_set_drvdata(&pdev->dev, data);
1915 static inline const char *pci_name(const struct pci_dev *pdev)
1917 return dev_name(&pdev->dev);
1920 void pci_resource_to_user(const struct pci_dev *dev, int bar,
1921 const struct resource *rsrc,
1922 resource_size_t *start, resource_size_t *end);
1925 * The world is not perfect and supplies us with broken PCI devices.
1926 * For at least a part of these bugs we need a work-around, so both
1927 * generic (drivers/pci/quirks.c) and per-architecture code can define
1928 * fixup hooks to be called for particular buggy devices.
1932 u16 vendor; /* Or PCI_ANY_ID */
1933 u16 device; /* Or PCI_ANY_ID */
1934 u32 class; /* Or PCI_ANY_ID */
1935 unsigned int class_shift; /* should be 0, 8, 16 */
1936 #ifdef CONFIG_HAVE_ARCH_PREL32_RELOCATIONS
1939 void (*hook)(struct pci_dev *dev);
1943 enum pci_fixup_pass {
1944 pci_fixup_early, /* Before probing BARs */
1945 pci_fixup_header, /* After reading configuration header */
1946 pci_fixup_final, /* Final phase of device fixups */
1947 pci_fixup_enable, /* pci_enable_device() time */
1948 pci_fixup_resume, /* pci_device_resume() */
1949 pci_fixup_suspend, /* pci_device_suspend() */
1950 pci_fixup_resume_early, /* pci_device_resume_early() */
1951 pci_fixup_suspend_late, /* pci_device_suspend_late() */
1954 #ifdef CONFIG_HAVE_ARCH_PREL32_RELOCATIONS
1955 #define ___DECLARE_PCI_FIXUP_SECTION(sec, name, vendor, device, class, \
1956 class_shift, hook) \
1957 __ADDRESSABLE(hook) \
1958 asm(".section " #sec ", \"a\" \n" \
1960 ".short " #vendor ", " #device " \n" \
1961 ".long " #class ", " #class_shift " \n" \
1962 ".long " #hook " - . \n" \
1966 * Clang's LTO may rename static functions in C, but has no way to
1967 * handle such renamings when referenced from inline asm. To work
1968 * around this, create global C stubs for these cases.
1970 #ifdef CONFIG_LTO_CLANG
1971 #define __DECLARE_PCI_FIXUP_SECTION(sec, name, vendor, device, class, \
1972 class_shift, hook, stub) \
1973 void __cficanonical stub(struct pci_dev *dev); \
1974 void __cficanonical stub(struct pci_dev *dev) \
1978 ___DECLARE_PCI_FIXUP_SECTION(sec, name, vendor, device, class, \
1981 #define __DECLARE_PCI_FIXUP_SECTION(sec, name, vendor, device, class, \
1982 class_shift, hook, stub) \
1983 ___DECLARE_PCI_FIXUP_SECTION(sec, name, vendor, device, class, \
1987 #define DECLARE_PCI_FIXUP_SECTION(sec, name, vendor, device, class, \
1988 class_shift, hook) \
1989 __DECLARE_PCI_FIXUP_SECTION(sec, name, vendor, device, class, \
1990 class_shift, hook, __UNIQUE_ID(hook))
1992 /* Anonymous variables would be nice... */
1993 #define DECLARE_PCI_FIXUP_SECTION(section, name, vendor, device, class, \
1994 class_shift, hook) \
1995 static const struct pci_fixup __PASTE(__pci_fixup_##name,__LINE__) __used \
1996 __attribute__((__section__(#section), aligned((sizeof(void *))))) \
1997 = { vendor, device, class, class_shift, hook };
2000 #define DECLARE_PCI_FIXUP_CLASS_EARLY(vendor, device, class, \
2001 class_shift, hook) \
2002 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early, \
2003 hook, vendor, device, class, class_shift, hook)
2004 #define DECLARE_PCI_FIXUP_CLASS_HEADER(vendor, device, class, \
2005 class_shift, hook) \
2006 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header, \
2007 hook, vendor, device, class, class_shift, hook)
2008 #define DECLARE_PCI_FIXUP_CLASS_FINAL(vendor, device, class, \
2009 class_shift, hook) \
2010 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final, \
2011 hook, vendor, device, class, class_shift, hook)
2012 #define DECLARE_PCI_FIXUP_CLASS_ENABLE(vendor, device, class, \
2013 class_shift, hook) \
2014 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable, \
2015 hook, vendor, device, class, class_shift, hook)
2016 #define DECLARE_PCI_FIXUP_CLASS_RESUME(vendor, device, class, \
2017 class_shift, hook) \
2018 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume, \
2019 resume##hook, vendor, device, class, class_shift, hook)
2020 #define DECLARE_PCI_FIXUP_CLASS_RESUME_EARLY(vendor, device, class, \
2021 class_shift, hook) \
2022 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early, \
2023 resume_early##hook, vendor, device, class, class_shift, hook)
2024 #define DECLARE_PCI_FIXUP_CLASS_SUSPEND(vendor, device, class, \
2025 class_shift, hook) \
2026 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend, \
2027 suspend##hook, vendor, device, class, class_shift, hook)
2028 #define DECLARE_PCI_FIXUP_CLASS_SUSPEND_LATE(vendor, device, class, \
2029 class_shift, hook) \
2030 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend_late, \
2031 suspend_late##hook, vendor, device, class, class_shift, hook)
2033 #define DECLARE_PCI_FIXUP_EARLY(vendor, device, hook) \
2034 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early, \
2035 hook, vendor, device, PCI_ANY_ID, 0, hook)
2036 #define DECLARE_PCI_FIXUP_HEADER(vendor, device, hook) \
2037 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header, \
2038 hook, vendor, device, PCI_ANY_ID, 0, hook)
2039 #define DECLARE_PCI_FIXUP_FINAL(vendor, device, hook) \
2040 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final, \
2041 hook, vendor, device, PCI_ANY_ID, 0, hook)
2042 #define DECLARE_PCI_FIXUP_ENABLE(vendor, device, hook) \
2043 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable, \
2044 hook, vendor, device, PCI_ANY_ID, 0, hook)
2045 #define DECLARE_PCI_FIXUP_RESUME(vendor, device, hook) \
2046 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume, \
2047 resume##hook, vendor, device, PCI_ANY_ID, 0, hook)
2048 #define DECLARE_PCI_FIXUP_RESUME_EARLY(vendor, device, hook) \
2049 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early, \
2050 resume_early##hook, vendor, device, PCI_ANY_ID, 0, hook)
2051 #define DECLARE_PCI_FIXUP_SUSPEND(vendor, device, hook) \
2052 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend, \
2053 suspend##hook, vendor, device, PCI_ANY_ID, 0, hook)
2054 #define DECLARE_PCI_FIXUP_SUSPEND_LATE(vendor, device, hook) \
2055 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend_late, \
2056 suspend_late##hook, vendor, device, PCI_ANY_ID, 0, hook)
2058 #ifdef CONFIG_PCI_QUIRKS
2059 void pci_fixup_device(enum pci_fixup_pass pass, struct pci_dev *dev);
2061 static inline void pci_fixup_device(enum pci_fixup_pass pass,
2062 struct pci_dev *dev) { }
2065 void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen);
2066 void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr);
2067 void __iomem * const *pcim_iomap_table(struct pci_dev *pdev);
2068 int pcim_iomap_regions(struct pci_dev *pdev, int mask, const char *name);
2069 int pcim_iomap_regions_request_all(struct pci_dev *pdev, int mask,
2071 void pcim_iounmap_regions(struct pci_dev *pdev, int mask);
2073 extern int pci_pci_problems;
2074 #define PCIPCI_FAIL 1 /* No PCI PCI DMA */
2075 #define PCIPCI_TRITON 2
2076 #define PCIPCI_NATOMA 4
2077 #define PCIPCI_VIAETBF 8
2078 #define PCIPCI_VSFX 16
2079 #define PCIPCI_ALIMAGIK 32 /* Need low latency setting */
2080 #define PCIAGP_FAIL 64 /* No PCI to AGP DMA */
2082 extern unsigned long pci_cardbus_io_size;
2083 extern unsigned long pci_cardbus_mem_size;
2084 extern u8 pci_dfl_cache_line_size;
2085 extern u8 pci_cache_line_size;
2087 /* Architecture-specific versions may override these (weak) */
2088 void pcibios_disable_device(struct pci_dev *dev);
2089 void pcibios_set_master(struct pci_dev *dev);
2090 int pcibios_set_pcie_reset_state(struct pci_dev *dev,
2091 enum pcie_reset_state state);
2092 int pcibios_add_device(struct pci_dev *dev);
2093 void pcibios_release_device(struct pci_dev *dev);
2095 void pcibios_penalize_isa_irq(int irq, int active);
2097 static inline void pcibios_penalize_isa_irq(int irq, int active) {}
2099 int pcibios_alloc_irq(struct pci_dev *dev);
2100 void pcibios_free_irq(struct pci_dev *dev);
2101 resource_size_t pcibios_default_alignment(void);
2103 #if defined(CONFIG_PCI_MMCONFIG) || defined(CONFIG_ACPI_MCFG)
2104 void __init pci_mmcfg_early_init(void);
2105 void __init pci_mmcfg_late_init(void);
2107 static inline void pci_mmcfg_early_init(void) { }
2108 static inline void pci_mmcfg_late_init(void) { }
2111 int pci_ext_cfg_avail(void);
2113 void __iomem *pci_ioremap_bar(struct pci_dev *pdev, int bar);
2114 void __iomem *pci_ioremap_wc_bar(struct pci_dev *pdev, int bar);
2116 #ifdef CONFIG_PCI_IOV
2117 int pci_iov_virtfn_bus(struct pci_dev *dev, int id);
2118 int pci_iov_virtfn_devfn(struct pci_dev *dev, int id);
2120 int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn);
2121 void pci_disable_sriov(struct pci_dev *dev);
2123 int pci_iov_sysfs_link(struct pci_dev *dev, struct pci_dev *virtfn, int id);
2124 int pci_iov_add_virtfn(struct pci_dev *dev, int id);
2125 void pci_iov_remove_virtfn(struct pci_dev *dev, int id);
2126 int pci_num_vf(struct pci_dev *dev);
2127 int pci_vfs_assigned(struct pci_dev *dev);
2128 int pci_sriov_set_totalvfs(struct pci_dev *dev, u16 numvfs);
2129 int pci_sriov_get_totalvfs(struct pci_dev *dev);
2130 int pci_sriov_configure_simple(struct pci_dev *dev, int nr_virtfn);
2131 resource_size_t pci_iov_resource_size(struct pci_dev *dev, int resno);
2132 void pci_vf_drivers_autoprobe(struct pci_dev *dev, bool probe);
2134 /* Arch may override these (weak) */
2135 int pcibios_sriov_enable(struct pci_dev *pdev, u16 num_vfs);
2136 int pcibios_sriov_disable(struct pci_dev *pdev);
2137 resource_size_t pcibios_iov_resource_alignment(struct pci_dev *dev, int resno);
2139 static inline int pci_iov_virtfn_bus(struct pci_dev *dev, int id)
2143 static inline int pci_iov_virtfn_devfn(struct pci_dev *dev, int id)
2147 static inline int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn)
2150 static inline int pci_iov_sysfs_link(struct pci_dev *dev,
2151 struct pci_dev *virtfn, int id)
2155 static inline int pci_iov_add_virtfn(struct pci_dev *dev, int id)
2159 static inline void pci_iov_remove_virtfn(struct pci_dev *dev,
2161 static inline void pci_disable_sriov(struct pci_dev *dev) { }
2162 static inline int pci_num_vf(struct pci_dev *dev) { return 0; }
2163 static inline int pci_vfs_assigned(struct pci_dev *dev)
2165 static inline int pci_sriov_set_totalvfs(struct pci_dev *dev, u16 numvfs)
2167 static inline int pci_sriov_get_totalvfs(struct pci_dev *dev)
2169 #define pci_sriov_configure_simple NULL
2170 static inline resource_size_t pci_iov_resource_size(struct pci_dev *dev, int resno)
2172 static inline void pci_vf_drivers_autoprobe(struct pci_dev *dev, bool probe) { }
2175 #if defined(CONFIG_HOTPLUG_PCI) || defined(CONFIG_HOTPLUG_PCI_MODULE)
2176 void pci_hp_create_module_link(struct pci_slot *pci_slot);
2177 void pci_hp_remove_module_link(struct pci_slot *pci_slot);
2181 * pci_pcie_cap - get the saved PCIe capability offset
2184 * PCIe capability offset is calculated at PCI device initialization
2185 * time and saved in the data structure. This function returns saved
2186 * PCIe capability offset. Using this instead of pci_find_capability()
2187 * reduces unnecessary search in the PCI configuration space. If you
2188 * need to calculate PCIe capability offset from raw device for some
2189 * reasons, please use pci_find_capability() instead.
2191 static inline int pci_pcie_cap(struct pci_dev *dev)
2193 return dev->pcie_cap;
2197 * pci_is_pcie - check if the PCI device is PCI Express capable
2200 * Returns: true if the PCI device is PCI Express capable, false otherwise.
2202 static inline bool pci_is_pcie(struct pci_dev *dev)
2204 return pci_pcie_cap(dev);
2208 * pcie_caps_reg - get the PCIe Capabilities Register
2211 static inline u16 pcie_caps_reg(const struct pci_dev *dev)
2213 return dev->pcie_flags_reg;
2217 * pci_pcie_type - get the PCIe device/port type
2220 static inline int pci_pcie_type(const struct pci_dev *dev)
2222 return (pcie_caps_reg(dev) & PCI_EXP_FLAGS_TYPE) >> 4;
2226 * pcie_find_root_port - Get the PCIe root port device
2229 * Traverse up the parent chain and return the PCIe Root Port PCI Device
2230 * for a given PCI/PCIe Device.
2232 static inline struct pci_dev *pcie_find_root_port(struct pci_dev *dev)
2235 if (pci_is_pcie(dev) &&
2236 pci_pcie_type(dev) == PCI_EXP_TYPE_ROOT_PORT)
2238 dev = pci_upstream_bridge(dev);
2244 void pci_request_acs(void);
2245 bool pci_acs_enabled(struct pci_dev *pdev, u16 acs_flags);
2246 bool pci_acs_path_enabled(struct pci_dev *start,
2247 struct pci_dev *end, u16 acs_flags);
2248 int pci_enable_atomic_ops_to_root(struct pci_dev *dev, u32 cap_mask);
2250 #define PCI_VPD_LRDT 0x80 /* Large Resource Data Type */
2251 #define PCI_VPD_LRDT_ID(x) ((x) | PCI_VPD_LRDT)
2253 /* Large Resource Data Type Tag Item Names */
2254 #define PCI_VPD_LTIN_ID_STRING 0x02 /* Identifier String */
2255 #define PCI_VPD_LTIN_RO_DATA 0x10 /* Read-Only Data */
2256 #define PCI_VPD_LTIN_RW_DATA 0x11 /* Read-Write Data */
2258 #define PCI_VPD_LRDT_ID_STRING PCI_VPD_LRDT_ID(PCI_VPD_LTIN_ID_STRING)
2259 #define PCI_VPD_LRDT_RO_DATA PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RO_DATA)
2260 #define PCI_VPD_LRDT_RW_DATA PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RW_DATA)
2262 /* Small Resource Data Type Tag Item Names */
2263 #define PCI_VPD_STIN_END 0x0f /* End */
2265 #define PCI_VPD_SRDT_END (PCI_VPD_STIN_END << 3)
2267 #define PCI_VPD_SRDT_TIN_MASK 0x78
2268 #define PCI_VPD_SRDT_LEN_MASK 0x07
2269 #define PCI_VPD_LRDT_TIN_MASK 0x7f
2271 #define PCI_VPD_LRDT_TAG_SIZE 3
2272 #define PCI_VPD_SRDT_TAG_SIZE 1
2274 #define PCI_VPD_INFO_FLD_HDR_SIZE 3
2276 #define PCI_VPD_RO_KEYWORD_PARTNO "PN"
2277 #define PCI_VPD_RO_KEYWORD_SERIALNO "SN"
2278 #define PCI_VPD_RO_KEYWORD_MFR_ID "MN"
2279 #define PCI_VPD_RO_KEYWORD_VENDOR0 "V0"
2280 #define PCI_VPD_RO_KEYWORD_CHKSUM "RV"
2283 * pci_vpd_lrdt_size - Extracts the Large Resource Data Type length
2284 * @lrdt: Pointer to the beginning of the Large Resource Data Type tag
2286 * Returns the extracted Large Resource Data Type length.
2288 static inline u16 pci_vpd_lrdt_size(const u8 *lrdt)
2290 return (u16)lrdt[1] + ((u16)lrdt[2] << 8);
2294 * pci_vpd_lrdt_tag - Extracts the Large Resource Data Type Tag Item
2295 * @lrdt: Pointer to the beginning of the Large Resource Data Type tag
2297 * Returns the extracted Large Resource Data Type Tag item.
2299 static inline u16 pci_vpd_lrdt_tag(const u8 *lrdt)
2301 return (u16)(lrdt[0] & PCI_VPD_LRDT_TIN_MASK);
2305 * pci_vpd_srdt_size - Extracts the Small Resource Data Type length
2306 * @srdt: Pointer to the beginning of the Small Resource Data Type tag
2308 * Returns the extracted Small Resource Data Type length.
2310 static inline u8 pci_vpd_srdt_size(const u8 *srdt)
2312 return (*srdt) & PCI_VPD_SRDT_LEN_MASK;
2316 * pci_vpd_srdt_tag - Extracts the Small Resource Data Type Tag Item
2317 * @srdt: Pointer to the beginning of the Small Resource Data Type tag
2319 * Returns the extracted Small Resource Data Type Tag Item.
2321 static inline u8 pci_vpd_srdt_tag(const u8 *srdt)
2323 return ((*srdt) & PCI_VPD_SRDT_TIN_MASK) >> 3;
2327 * pci_vpd_info_field_size - Extracts the information field length
2328 * @info_field: Pointer to the beginning of an information field header
2330 * Returns the extracted information field length.
2332 static inline u8 pci_vpd_info_field_size(const u8 *info_field)
2334 return info_field[2];
2338 * pci_vpd_find_tag - Locates the Resource Data Type tag provided
2339 * @buf: Pointer to buffered vpd data
2340 * @len: The length of the vpd buffer
2341 * @rdt: The Resource Data Type to search for
2343 * Returns the index where the Resource Data Type was found or
2344 * -ENOENT otherwise.
2346 int pci_vpd_find_tag(const u8 *buf, unsigned int len, u8 rdt);
2349 * pci_vpd_find_info_keyword - Locates an information field keyword in the VPD
2350 * @buf: Pointer to buffered vpd data
2351 * @off: The offset into the buffer at which to begin the search
2352 * @len: The length of the buffer area, relative to off, in which to search
2353 * @kw: The keyword to search for
2355 * Returns the index where the information field keyword was found or
2356 * -ENOENT otherwise.
2358 int pci_vpd_find_info_keyword(const u8 *buf, unsigned int off,
2359 unsigned int len, const char *kw);
2361 /* PCI <-> OF binding helpers */
2365 struct irq_domain *pci_host_bridge_of_msi_domain(struct pci_bus *bus);
2366 bool pci_host_of_has_msi_map(struct device *dev);
2368 /* Arch may override this (weak) */
2369 struct device_node *pcibios_get_phb_of_node(struct pci_bus *bus);
2371 #else /* CONFIG_OF */
2372 static inline struct irq_domain *
2373 pci_host_bridge_of_msi_domain(struct pci_bus *bus) { return NULL; }
2374 static inline bool pci_host_of_has_msi_map(struct device *dev) { return false; }
2375 #endif /* CONFIG_OF */
2377 static inline struct device_node *
2378 pci_device_to_OF_node(const struct pci_dev *pdev)
2380 return pdev ? pdev->dev.of_node : NULL;
2383 static inline struct device_node *pci_bus_to_OF_node(struct pci_bus *bus)
2385 return bus ? bus->dev.of_node : NULL;
2389 struct irq_domain *pci_host_bridge_acpi_msi_domain(struct pci_bus *bus);
2392 pci_msi_register_fwnode_provider(struct fwnode_handle *(*fn)(struct device *));
2393 bool pci_pr3_present(struct pci_dev *pdev);
2395 static inline struct irq_domain *
2396 pci_host_bridge_acpi_msi_domain(struct pci_bus *bus) { return NULL; }
2397 static inline bool pci_pr3_present(struct pci_dev *pdev) { return false; }
2401 static inline struct eeh_dev *pci_dev_to_eeh_dev(struct pci_dev *pdev)
2403 return pdev->dev.archdata.edev;
2407 void pci_add_dma_alias(struct pci_dev *dev, u8 devfn_from, unsigned nr_devfns);
2408 bool pci_devs_are_dma_aliases(struct pci_dev *dev1, struct pci_dev *dev2);
2409 int pci_for_each_dma_alias(struct pci_dev *pdev,
2410 int (*fn)(struct pci_dev *pdev,
2411 u16 alias, void *data), void *data);
2413 /* Helper functions for operation of device flag */
2414 static inline void pci_set_dev_assigned(struct pci_dev *pdev)
2416 pdev->dev_flags |= PCI_DEV_FLAGS_ASSIGNED;
2418 static inline void pci_clear_dev_assigned(struct pci_dev *pdev)
2420 pdev->dev_flags &= ~PCI_DEV_FLAGS_ASSIGNED;
2422 static inline bool pci_is_dev_assigned(struct pci_dev *pdev)
2424 return (pdev->dev_flags & PCI_DEV_FLAGS_ASSIGNED) == PCI_DEV_FLAGS_ASSIGNED;
2428 * pci_ari_enabled - query ARI forwarding status
2431 * Returns true if ARI forwarding is enabled.
2433 static inline bool pci_ari_enabled(struct pci_bus *bus)
2435 return bus->self && bus->self->ari_enabled;
2439 * pci_is_thunderbolt_attached - whether device is on a Thunderbolt daisy chain
2440 * @pdev: PCI device to check
2442 * Walk upwards from @pdev and check for each encountered bridge if it's part
2443 * of a Thunderbolt controller. Reaching the host bridge means @pdev is not
2444 * Thunderbolt-attached. (But rather soldered to the mainboard usually.)
2446 static inline bool pci_is_thunderbolt_attached(struct pci_dev *pdev)
2448 struct pci_dev *parent = pdev;
2450 if (pdev->is_thunderbolt)
2453 while ((parent = pci_upstream_bridge(parent)))
2454 if (parent->is_thunderbolt)
2460 #if defined(CONFIG_PCIEPORTBUS) || defined(CONFIG_EEH)
2461 void pci_uevent_ers(struct pci_dev *pdev, enum pci_ers_result err_type);
2464 /* Provide the legacy pci_dma_* API */
2465 #include <linux/pci-dma-compat.h>
2467 #define pci_printk(level, pdev, fmt, arg...) \
2468 dev_printk(level, &(pdev)->dev, fmt, ##arg)
2470 #define pci_emerg(pdev, fmt, arg...) dev_emerg(&(pdev)->dev, fmt, ##arg)
2471 #define pci_alert(pdev, fmt, arg...) dev_alert(&(pdev)->dev, fmt, ##arg)
2472 #define pci_crit(pdev, fmt, arg...) dev_crit(&(pdev)->dev, fmt, ##arg)
2473 #define pci_err(pdev, fmt, arg...) dev_err(&(pdev)->dev, fmt, ##arg)
2474 #define pci_warn(pdev, fmt, arg...) dev_warn(&(pdev)->dev, fmt, ##arg)
2475 #define pci_notice(pdev, fmt, arg...) dev_notice(&(pdev)->dev, fmt, ##arg)
2476 #define pci_info(pdev, fmt, arg...) dev_info(&(pdev)->dev, fmt, ##arg)
2477 #define pci_dbg(pdev, fmt, arg...) dev_dbg(&(pdev)->dev, fmt, ##arg)
2479 #define pci_notice_ratelimited(pdev, fmt, arg...) \
2480 dev_notice_ratelimited(&(pdev)->dev, fmt, ##arg)
2482 #define pci_info_ratelimited(pdev, fmt, arg...) \
2483 dev_info_ratelimited(&(pdev)->dev, fmt, ##arg)
2485 #define pci_WARN(pdev, condition, fmt, arg...) \
2486 WARN(condition, "%s %s: " fmt, \
2487 dev_driver_string(&(pdev)->dev), pci_name(pdev), ##arg)
2489 #define pci_WARN_ONCE(pdev, condition, fmt, arg...) \
2490 WARN_ONCE(condition, "%s %s: " fmt, \
2491 dev_driver_string(&(pdev)->dev), pci_name(pdev), ##arg)
2493 #endif /* LINUX_PCI_H */