]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - include/linux/pci.h
PCI / ACPI: Identify untrusted PCI devices
[mirror_ubuntu-bionic-kernel.git] / include / linux / pci.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3 * pci.h
4 *
5 * PCI defines and function prototypes
6 * Copyright 1994, Drew Eckhardt
7 * Copyright 1997--1999 Martin Mares <mj@ucw.cz>
8 *
9 * For more information, please consult the following manuals (look at
10 * http://www.pcisig.com/ for how to get them):
11 *
12 * PCI BIOS Specification
13 * PCI Local Bus Specification
14 * PCI to PCI Bridge Specification
15 * PCI System Design Guide
16 */
17 #ifndef LINUX_PCI_H
18 #define LINUX_PCI_H
19
20
21 #include <linux/mod_devicetable.h>
22
23 #include <linux/types.h>
24 #include <linux/init.h>
25 #include <linux/ioport.h>
26 #include <linux/list.h>
27 #include <linux/compiler.h>
28 #include <linux/errno.h>
29 #include <linux/kobject.h>
30 #include <linux/atomic.h>
31 #include <linux/device.h>
32 #include <linux/interrupt.h>
33 #include <linux/io.h>
34 #include <linux/resource_ext.h>
35 #include <uapi/linux/pci.h>
36
37 #include <linux/pci_ids.h>
38
39 /*
40 * The PCI interface treats multi-function devices as independent
41 * devices. The slot/function address of each device is encoded
42 * in a single byte as follows:
43 *
44 * 7:3 = slot
45 * 2:0 = function
46 *
47 * PCI_DEVFN(), PCI_SLOT(), and PCI_FUNC() are defined in uapi/linux/pci.h.
48 * In the interest of not exposing interfaces to user-space unnecessarily,
49 * the following kernel-only defines are being added here.
50 */
51 #define PCI_DEVID(bus, devfn) ((((u16)(bus)) << 8) | (devfn))
52 /* return bus from PCI devid = ((u16)bus_number) << 8) | devfn */
53 #define PCI_BUS_NUM(x) (((x) >> 8) & 0xff)
54
55 /* pci_slot represents a physical slot */
56 struct pci_slot {
57 struct pci_bus *bus; /* The bus this slot is on */
58 struct list_head list; /* node in list of slots on this bus */
59 struct hotplug_slot *hotplug; /* Hotplug info (migrate over time) */
60 unsigned char number; /* PCI_SLOT(pci_dev->devfn) */
61 struct kobject kobj;
62 };
63
64 static inline const char *pci_slot_name(const struct pci_slot *slot)
65 {
66 return kobject_name(&slot->kobj);
67 }
68
69 /* File state for mmap()s on /proc/bus/pci/X/Y */
70 enum pci_mmap_state {
71 pci_mmap_io,
72 pci_mmap_mem
73 };
74
75 /*
76 * For PCI devices, the region numbers are assigned this way:
77 */
78 enum {
79 /* #0-5: standard PCI resources */
80 PCI_STD_RESOURCES,
81 PCI_STD_RESOURCE_END = 5,
82
83 /* #6: expansion ROM resource */
84 PCI_ROM_RESOURCE,
85
86 /* device specific resources */
87 #ifdef CONFIG_PCI_IOV
88 PCI_IOV_RESOURCES,
89 PCI_IOV_RESOURCE_END = PCI_IOV_RESOURCES + PCI_SRIOV_NUM_BARS - 1,
90 #endif
91
92 /* resources assigned to buses behind the bridge */
93 #define PCI_BRIDGE_RESOURCE_NUM 4
94
95 PCI_BRIDGE_RESOURCES,
96 PCI_BRIDGE_RESOURCE_END = PCI_BRIDGE_RESOURCES +
97 PCI_BRIDGE_RESOURCE_NUM - 1,
98
99 /* total resources associated with a PCI device */
100 PCI_NUM_RESOURCES,
101
102 /* preserve this for compatibility */
103 DEVICE_COUNT_RESOURCE = PCI_NUM_RESOURCES,
104 };
105
106 /**
107 * enum pci_interrupt_pin - PCI INTx interrupt values
108 * @PCI_INTERRUPT_UNKNOWN: Unknown or unassigned interrupt
109 * @PCI_INTERRUPT_INTA: PCI INTA pin
110 * @PCI_INTERRUPT_INTB: PCI INTB pin
111 * @PCI_INTERRUPT_INTC: PCI INTC pin
112 * @PCI_INTERRUPT_INTD: PCI INTD pin
113 *
114 * Corresponds to values for legacy PCI INTx interrupts, as can be found in the
115 * PCI_INTERRUPT_PIN register.
116 */
117 enum pci_interrupt_pin {
118 PCI_INTERRUPT_UNKNOWN,
119 PCI_INTERRUPT_INTA,
120 PCI_INTERRUPT_INTB,
121 PCI_INTERRUPT_INTC,
122 PCI_INTERRUPT_INTD,
123 };
124
125 /* The number of legacy PCI INTx interrupts */
126 #define PCI_NUM_INTX 4
127
128 /*
129 * pci_power_t values must match the bits in the Capabilities PME_Support
130 * and Control/Status PowerState fields in the Power Management capability.
131 */
132 typedef int __bitwise pci_power_t;
133
134 #define PCI_D0 ((pci_power_t __force) 0)
135 #define PCI_D1 ((pci_power_t __force) 1)
136 #define PCI_D2 ((pci_power_t __force) 2)
137 #define PCI_D3hot ((pci_power_t __force) 3)
138 #define PCI_D3cold ((pci_power_t __force) 4)
139 #define PCI_UNKNOWN ((pci_power_t __force) 5)
140 #define PCI_POWER_ERROR ((pci_power_t __force) -1)
141
142 /* Remember to update this when the list above changes! */
143 extern const char *pci_power_names[];
144
145 static inline const char *pci_power_name(pci_power_t state)
146 {
147 return pci_power_names[1 + (__force int) state];
148 }
149
150 #define PCI_PM_D2_DELAY 200
151 #define PCI_PM_D3_WAIT 10
152 #define PCI_PM_D3COLD_WAIT 100
153 #define PCI_PM_BUS_WAIT 50
154
155 /** The pci_channel state describes connectivity between the CPU and
156 * the pci device. If some PCI bus between here and the pci device
157 * has crashed or locked up, this info is reflected here.
158 */
159 typedef unsigned int __bitwise pci_channel_state_t;
160
161 enum pci_channel_state {
162 /* I/O channel is in normal state */
163 pci_channel_io_normal = (__force pci_channel_state_t) 1,
164
165 /* I/O to channel is blocked */
166 pci_channel_io_frozen = (__force pci_channel_state_t) 2,
167
168 /* PCI card is dead */
169 pci_channel_io_perm_failure = (__force pci_channel_state_t) 3,
170 };
171
172 typedef unsigned int __bitwise pcie_reset_state_t;
173
174 enum pcie_reset_state {
175 /* Reset is NOT asserted (Use to deassert reset) */
176 pcie_deassert_reset = (__force pcie_reset_state_t) 1,
177
178 /* Use #PERST to reset PCIe device */
179 pcie_warm_reset = (__force pcie_reset_state_t) 2,
180
181 /* Use PCIe Hot Reset to reset device */
182 pcie_hot_reset = (__force pcie_reset_state_t) 3
183 };
184
185 typedef unsigned short __bitwise pci_dev_flags_t;
186 enum pci_dev_flags {
187 /* INTX_DISABLE in PCI_COMMAND register disables MSI
188 * generation too.
189 */
190 PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG = (__force pci_dev_flags_t) (1 << 0),
191 /* Device configuration is irrevocably lost if disabled into D3 */
192 PCI_DEV_FLAGS_NO_D3 = (__force pci_dev_flags_t) (1 << 1),
193 /* Provide indication device is assigned by a Virtual Machine Manager */
194 PCI_DEV_FLAGS_ASSIGNED = (__force pci_dev_flags_t) (1 << 2),
195 /* Flag for quirk use to store if quirk-specific ACS is enabled */
196 PCI_DEV_FLAGS_ACS_ENABLED_QUIRK = (__force pci_dev_flags_t) (1 << 3),
197 /* Use a PCIe-to-PCI bridge alias even if !pci_is_pcie */
198 PCI_DEV_FLAG_PCIE_BRIDGE_ALIAS = (__force pci_dev_flags_t) (1 << 5),
199 /* Do not use bus resets for device */
200 PCI_DEV_FLAGS_NO_BUS_RESET = (__force pci_dev_flags_t) (1 << 6),
201 /* Do not use PM reset even if device advertises NoSoftRst- */
202 PCI_DEV_FLAGS_NO_PM_RESET = (__force pci_dev_flags_t) (1 << 7),
203 /* Get VPD from function 0 VPD */
204 PCI_DEV_FLAGS_VPD_REF_F0 = (__force pci_dev_flags_t) (1 << 8),
205 /* a non-root bridge where translation occurs, stop alias search here */
206 PCI_DEV_FLAGS_BRIDGE_XLATE_ROOT = (__force pci_dev_flags_t) (1 << 9),
207 /* Do not use FLR even if device advertises PCI_AF_CAP */
208 PCI_DEV_FLAGS_NO_FLR_RESET = (__force pci_dev_flags_t) (1 << 10),
209 /* Don't use Relaxed Ordering for TLPs directed at this device */
210 PCI_DEV_FLAGS_NO_RELAXED_ORDERING = (__force pci_dev_flags_t) (1 << 11),
211 };
212
213 enum pci_irq_reroute_variant {
214 INTEL_IRQ_REROUTE_VARIANT = 1,
215 MAX_IRQ_REROUTE_VARIANTS = 3
216 };
217
218 typedef unsigned short __bitwise pci_bus_flags_t;
219 enum pci_bus_flags {
220 PCI_BUS_FLAGS_NO_MSI = (__force pci_bus_flags_t) 1,
221 PCI_BUS_FLAGS_NO_MMRBC = (__force pci_bus_flags_t) 2,
222 PCI_BUS_FLAGS_NO_AERSID = (__force pci_bus_flags_t) 4,
223 };
224
225 /* These values come from the PCI Express Spec */
226 enum pcie_link_width {
227 PCIE_LNK_WIDTH_RESRV = 0x00,
228 PCIE_LNK_X1 = 0x01,
229 PCIE_LNK_X2 = 0x02,
230 PCIE_LNK_X4 = 0x04,
231 PCIE_LNK_X8 = 0x08,
232 PCIE_LNK_X12 = 0x0C,
233 PCIE_LNK_X16 = 0x10,
234 PCIE_LNK_X32 = 0x20,
235 PCIE_LNK_WIDTH_UNKNOWN = 0xFF,
236 };
237
238 /* Based on the PCI Hotplug Spec, but some values are made up by us */
239 enum pci_bus_speed {
240 PCI_SPEED_33MHz = 0x00,
241 PCI_SPEED_66MHz = 0x01,
242 PCI_SPEED_66MHz_PCIX = 0x02,
243 PCI_SPEED_100MHz_PCIX = 0x03,
244 PCI_SPEED_133MHz_PCIX = 0x04,
245 PCI_SPEED_66MHz_PCIX_ECC = 0x05,
246 PCI_SPEED_100MHz_PCIX_ECC = 0x06,
247 PCI_SPEED_133MHz_PCIX_ECC = 0x07,
248 PCI_SPEED_66MHz_PCIX_266 = 0x09,
249 PCI_SPEED_100MHz_PCIX_266 = 0x0a,
250 PCI_SPEED_133MHz_PCIX_266 = 0x0b,
251 AGP_UNKNOWN = 0x0c,
252 AGP_1X = 0x0d,
253 AGP_2X = 0x0e,
254 AGP_4X = 0x0f,
255 AGP_8X = 0x10,
256 PCI_SPEED_66MHz_PCIX_533 = 0x11,
257 PCI_SPEED_100MHz_PCIX_533 = 0x12,
258 PCI_SPEED_133MHz_PCIX_533 = 0x13,
259 PCIE_SPEED_2_5GT = 0x14,
260 PCIE_SPEED_5_0GT = 0x15,
261 PCIE_SPEED_8_0GT = 0x16,
262 PCIE_SPEED_16_0GT = 0x17,
263 PCI_SPEED_UNKNOWN = 0xff,
264 };
265
266 struct pci_cap_saved_data {
267 u16 cap_nr;
268 bool cap_extended;
269 unsigned int size;
270 u32 data[0];
271 };
272
273 struct pci_cap_saved_state {
274 struct hlist_node next;
275 struct pci_cap_saved_data cap;
276 };
277
278 struct irq_affinity;
279 struct pcie_link_state;
280 struct pci_vpd;
281 struct pci_sriov;
282 struct pci_ats;
283
284 /*
285 * The pci_dev structure is used to describe PCI devices.
286 */
287 struct pci_dev {
288 struct list_head bus_list; /* node in per-bus list */
289 struct pci_bus *bus; /* bus this device is on */
290 struct pci_bus *subordinate; /* bus this device bridges to */
291
292 void *sysdata; /* hook for sys-specific extension */
293 struct proc_dir_entry *procent; /* device entry in /proc/bus/pci */
294 struct pci_slot *slot; /* Physical slot this device is in */
295
296 unsigned int devfn; /* encoded device & function index */
297 unsigned short vendor;
298 unsigned short device;
299 unsigned short subsystem_vendor;
300 unsigned short subsystem_device;
301 unsigned int class; /* 3 bytes: (base,sub,prog-if) */
302 u8 revision; /* PCI revision, low byte of class word */
303 u8 hdr_type; /* PCI header type (`multi' flag masked out) */
304 #ifdef CONFIG_PCIEAER
305 u16 aer_cap; /* AER capability offset */
306 #endif
307 u8 pcie_cap; /* PCIe capability offset */
308 u8 msi_cap; /* MSI capability offset */
309 u8 msix_cap; /* MSI-X capability offset */
310 u8 pcie_mpss:3; /* PCIe Max Payload Size Supported */
311 u8 rom_base_reg; /* which config register controls the ROM */
312 u8 pin; /* which interrupt pin this device uses */
313 u16 pcie_flags_reg; /* cached PCIe Capabilities Register */
314 unsigned long *dma_alias_mask;/* mask of enabled devfn aliases */
315
316 struct pci_driver *driver; /* which driver has allocated this device */
317 u64 dma_mask; /* Mask of the bits of bus address this
318 device implements. Normally this is
319 0xffffffff. You only need to change
320 this if your device has broken DMA
321 or supports 64-bit transfers. */
322
323 struct device_dma_parameters dma_parms;
324
325 pci_power_t current_state; /* Current operating state. In ACPI-speak,
326 this is D0-D3, D0 being fully functional,
327 and D3 being off. */
328 u8 pm_cap; /* PM capability offset */
329 unsigned int pme_support:5; /* Bitmask of states from which PME#
330 can be generated */
331 unsigned int pme_poll:1; /* Poll device's PME status bit */
332 unsigned int d1_support:1; /* Low power state D1 is supported */
333 unsigned int d2_support:1; /* Low power state D2 is supported */
334 unsigned int no_d1d2:1; /* D1 and D2 are forbidden */
335 unsigned int no_d3cold:1; /* D3cold is forbidden */
336 unsigned int bridge_d3:1; /* Allow D3 for bridge */
337 unsigned int d3cold_allowed:1; /* D3cold is allowed by user */
338 unsigned int mmio_always_on:1; /* disallow turning off io/mem
339 decoding during bar sizing */
340 unsigned int wakeup_prepared:1;
341 unsigned int runtime_d3cold:1; /* whether go through runtime
342 D3cold, not set for devices
343 powered on/off by the
344 corresponding bridge */
345 unsigned int ignore_hotplug:1; /* Ignore hotplug events */
346 unsigned int hotplug_user_indicators:1; /* SlotCtl indicators
347 controlled exclusively by
348 user sysfs */
349 unsigned int d3_delay; /* D3->D0 transition time in ms */
350 unsigned int d3cold_delay; /* D3cold->D0 transition time in ms */
351
352 #ifdef CONFIG_PCIEASPM
353 struct pcie_link_state *link_state; /* ASPM link state */
354 unsigned int ltr_path:1; /* Latency Tolerance Reporting
355 supported from root to here */
356 #endif
357
358 pci_channel_state_t error_state; /* current connectivity state */
359 struct device dev; /* Generic device interface */
360
361 int cfg_size; /* Size of configuration space */
362
363 /*
364 * Instead of touching interrupt line and base address registers
365 * directly, use the values stored here. They might be different!
366 */
367 unsigned int irq;
368 struct resource resource[DEVICE_COUNT_RESOURCE]; /* I/O and memory regions + expansion ROMs */
369
370 bool match_driver; /* Skip attaching driver */
371 /* These fields are used by common fixups */
372 unsigned int transparent:1; /* Subtractive decode PCI bridge */
373 unsigned int multifunction:1;/* Part of multi-function device */
374 /* keep track of device state */
375 unsigned int is_added:1;
376 unsigned int is_busmaster:1; /* device is busmaster */
377 unsigned int no_msi:1; /* device may not use msi */
378 unsigned int no_64bit_msi:1; /* device may only use 32-bit MSIs */
379 unsigned int block_cfg_access:1; /* config space access is blocked */
380 unsigned int broken_parity_status:1; /* Device generates false positive parity */
381 unsigned int irq_reroute_variant:2; /* device needs IRQ rerouting variant */
382 unsigned int msi_enabled:1;
383 unsigned int msix_enabled:1;
384 unsigned int ari_enabled:1; /* ARI forwarding */
385 unsigned int ats_enabled:1; /* Address Translation Service */
386 unsigned int pasid_enabled:1; /* Process Address Space ID */
387 unsigned int pri_enabled:1; /* Page Request Interface */
388 unsigned int is_managed:1;
389 unsigned int needs_freset:1; /* Dev requires fundamental reset */
390 unsigned int state_saved:1;
391 unsigned int is_physfn:1;
392 unsigned int is_virtfn:1;
393 unsigned int reset_fn:1;
394 unsigned int is_hotplug_bridge:1;
395 unsigned int is_thunderbolt:1; /* Thunderbolt controller */
396 /*
397 * Devices marked being untrusted are the ones that can potentially
398 * execute DMA attacks and similar. They are typically connected
399 * through external ports such as Thunderbolt but not limited to
400 * that. When an IOMMU is enabled they should be getting full
401 * mappings to make sure they cannot access arbitrary memory.
402 */
403 unsigned int untrusted:1;
404 unsigned int __aer_firmware_first_valid:1;
405 unsigned int __aer_firmware_first:1;
406 unsigned int broken_intx_masking:1; /* INTx masking can't be used */
407 unsigned int io_window_1k:1; /* Intel P2P bridge 1K I/O windows */
408 unsigned int irq_managed:1;
409 unsigned int has_secondary_link:1;
410 unsigned int non_compliant_bars:1; /* broken BARs; ignore them */
411 unsigned int is_probed:1; /* device probing in progress */
412 pci_dev_flags_t dev_flags;
413 atomic_t enable_cnt; /* pci_enable_device has been called */
414
415 u32 saved_config_space[16]; /* config space saved at suspend time */
416 struct hlist_head saved_cap_space;
417 struct bin_attribute *rom_attr; /* attribute descriptor for sysfs ROM entry */
418 int rom_attr_enabled; /* has display of the rom attribute been enabled? */
419 struct bin_attribute *res_attr[DEVICE_COUNT_RESOURCE]; /* sysfs file for resources */
420 struct bin_attribute *res_attr_wc[DEVICE_COUNT_RESOURCE]; /* sysfs file for WC mapping of resources */
421
422 #ifdef CONFIG_PCIE_PTM
423 unsigned int ptm_root:1;
424 unsigned int ptm_enabled:1;
425 u8 ptm_granularity;
426 #endif
427 #ifdef CONFIG_PCI_MSI
428 const struct attribute_group **msi_irq_groups;
429 #endif
430 struct pci_vpd *vpd;
431 #ifdef CONFIG_PCI_ATS
432 union {
433 struct pci_sriov *sriov; /* SR-IOV capability related */
434 struct pci_dev *physfn; /* the PF this VF is associated with */
435 };
436 u16 ats_cap; /* ATS Capability offset */
437 u8 ats_stu; /* ATS Smallest Translation Unit */
438 atomic_t ats_ref_cnt; /* number of VFs with ATS enabled */
439 #endif
440 #ifdef CONFIG_PCI_PRI
441 u32 pri_reqs_alloc; /* Number of PRI requests allocated */
442 #endif
443 #ifdef CONFIG_PCI_PASID
444 u16 pasid_features;
445 #endif
446 phys_addr_t rom; /* Physical address of ROM if it's not from the BAR */
447 size_t romlen; /* Length of ROM if it's not from the BAR */
448 char *driver_override; /* Driver name to force a match */
449
450 unsigned long priv_flags; /* Private flags for the pci driver */
451 };
452
453 static inline struct pci_dev *pci_physfn(struct pci_dev *dev)
454 {
455 #ifdef CONFIG_PCI_IOV
456 if (dev->is_virtfn)
457 dev = dev->physfn;
458 #endif
459 return dev;
460 }
461
462 struct pci_dev *pci_alloc_dev(struct pci_bus *bus);
463
464 #define to_pci_dev(n) container_of(n, struct pci_dev, dev)
465 #define for_each_pci_dev(d) while ((d = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, d)) != NULL)
466
467 static inline int pci_channel_offline(struct pci_dev *pdev)
468 {
469 return (pdev->error_state != pci_channel_io_normal);
470 }
471
472 struct pci_host_bridge {
473 struct device dev;
474 struct pci_bus *bus; /* root bus */
475 struct pci_ops *ops;
476 void *sysdata;
477 int busnr;
478 struct list_head windows; /* resource_entry */
479 u8 (*swizzle_irq)(struct pci_dev *, u8 *); /* platform IRQ swizzler */
480 int (*map_irq)(const struct pci_dev *, u8, u8);
481 void (*release_fn)(struct pci_host_bridge *);
482 void *release_data;
483 struct msi_controller *msi;
484 unsigned int ignore_reset_delay:1; /* for entire hierarchy */
485 unsigned int no_ext_tags:1; /* no Extended Tags */
486 /* Resource alignment requirements */
487 resource_size_t (*align_resource)(struct pci_dev *dev,
488 const struct resource *res,
489 resource_size_t start,
490 resource_size_t size,
491 resource_size_t align);
492 unsigned long private[0] ____cacheline_aligned;
493 };
494
495 #define to_pci_host_bridge(n) container_of(n, struct pci_host_bridge, dev)
496
497 static inline void *pci_host_bridge_priv(struct pci_host_bridge *bridge)
498 {
499 return (void *)bridge->private;
500 }
501
502 static inline struct pci_host_bridge *pci_host_bridge_from_priv(void *priv)
503 {
504 return container_of(priv, struct pci_host_bridge, private);
505 }
506
507 struct pci_host_bridge *pci_alloc_host_bridge(size_t priv);
508 struct pci_host_bridge *devm_pci_alloc_host_bridge(struct device *dev,
509 size_t priv);
510 void pci_free_host_bridge(struct pci_host_bridge *bridge);
511 struct pci_host_bridge *pci_find_host_bridge(struct pci_bus *bus);
512
513 void pci_set_host_bridge_release(struct pci_host_bridge *bridge,
514 void (*release_fn)(struct pci_host_bridge *),
515 void *release_data);
516
517 int pcibios_root_bridge_prepare(struct pci_host_bridge *bridge);
518
519 /*
520 * The first PCI_BRIDGE_RESOURCE_NUM PCI bus resources (those that correspond
521 * to P2P or CardBus bridge windows) go in a table. Additional ones (for
522 * buses below host bridges or subtractive decode bridges) go in the list.
523 * Use pci_bus_for_each_resource() to iterate through all the resources.
524 */
525
526 /*
527 * PCI_SUBTRACTIVE_DECODE means the bridge forwards the window implicitly
528 * and there's no way to program the bridge with the details of the window.
529 * This does not apply to ACPI _CRS windows, even with the _DEC subtractive-
530 * decode bit set, because they are explicit and can be programmed with _SRS.
531 */
532 #define PCI_SUBTRACTIVE_DECODE 0x1
533
534 struct pci_bus_resource {
535 struct list_head list;
536 struct resource *res;
537 unsigned int flags;
538 };
539
540 #define PCI_REGION_FLAG_MASK 0x0fU /* These bits of resource flags tell us the PCI region flags */
541
542 struct pci_bus {
543 struct list_head node; /* node in list of buses */
544 struct pci_bus *parent; /* parent bus this bridge is on */
545 struct list_head children; /* list of child buses */
546 struct list_head devices; /* list of devices on this bus */
547 struct pci_dev *self; /* bridge device as seen by parent */
548 struct list_head slots; /* list of slots on this bus;
549 protected by pci_slot_mutex */
550 struct resource *resource[PCI_BRIDGE_RESOURCE_NUM];
551 struct list_head resources; /* address space routed to this bus */
552 struct resource busn_res; /* bus numbers routed to this bus */
553
554 struct pci_ops *ops; /* configuration access functions */
555 struct msi_controller *msi; /* MSI controller */
556 void *sysdata; /* hook for sys-specific extension */
557 struct proc_dir_entry *procdir; /* directory entry in /proc/bus/pci */
558
559 unsigned char number; /* bus number */
560 unsigned char primary; /* number of primary bridge */
561 unsigned char max_bus_speed; /* enum pci_bus_speed */
562 unsigned char cur_bus_speed; /* enum pci_bus_speed */
563 #ifdef CONFIG_PCI_DOMAINS_GENERIC
564 int domain_nr;
565 #endif
566
567 char name[48];
568
569 unsigned short bridge_ctl; /* manage NO_ISA/FBB/et al behaviors */
570 pci_bus_flags_t bus_flags; /* inherited by child buses */
571 struct device *bridge;
572 struct device dev;
573 struct bin_attribute *legacy_io; /* legacy I/O for this bus */
574 struct bin_attribute *legacy_mem; /* legacy mem */
575 unsigned int is_added:1;
576 };
577
578 #define to_pci_bus(n) container_of(n, struct pci_bus, dev)
579
580 /*
581 * Returns true if the PCI bus is root (behind host-PCI bridge),
582 * false otherwise
583 *
584 * Some code assumes that "bus->self == NULL" means that bus is a root bus.
585 * This is incorrect because "virtual" buses added for SR-IOV (via
586 * virtfn_add_bus()) have "bus->self == NULL" but are not root buses.
587 */
588 static inline bool pci_is_root_bus(struct pci_bus *pbus)
589 {
590 return !(pbus->parent);
591 }
592
593 /**
594 * pci_is_bridge - check if the PCI device is a bridge
595 * @dev: PCI device
596 *
597 * Return true if the PCI device is bridge whether it has subordinate
598 * or not.
599 */
600 static inline bool pci_is_bridge(struct pci_dev *dev)
601 {
602 return dev->hdr_type == PCI_HEADER_TYPE_BRIDGE ||
603 dev->hdr_type == PCI_HEADER_TYPE_CARDBUS;
604 }
605
606 #define for_each_pci_bridge(dev, bus) \
607 list_for_each_entry(dev, &bus->devices, bus_list) \
608 if (!pci_is_bridge(dev)) {} else
609
610 static inline struct pci_dev *pci_upstream_bridge(struct pci_dev *dev)
611 {
612 dev = pci_physfn(dev);
613 if (pci_is_root_bus(dev->bus))
614 return NULL;
615
616 return dev->bus->self;
617 }
618
619 struct device *pci_get_host_bridge_device(struct pci_dev *dev);
620 void pci_put_host_bridge_device(struct device *dev);
621
622 #ifdef CONFIG_PCI_MSI
623 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev)
624 {
625 return pci_dev->msi_enabled || pci_dev->msix_enabled;
626 }
627 #else
628 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev) { return false; }
629 #endif
630
631 /*
632 * Error values that may be returned by PCI functions.
633 */
634 #define PCIBIOS_SUCCESSFUL 0x00
635 #define PCIBIOS_FUNC_NOT_SUPPORTED 0x81
636 #define PCIBIOS_BAD_VENDOR_ID 0x83
637 #define PCIBIOS_DEVICE_NOT_FOUND 0x86
638 #define PCIBIOS_BAD_REGISTER_NUMBER 0x87
639 #define PCIBIOS_SET_FAILED 0x88
640 #define PCIBIOS_BUFFER_TOO_SMALL 0x89
641
642 /*
643 * Translate above to generic errno for passing back through non-PCI code.
644 */
645 static inline int pcibios_err_to_errno(int err)
646 {
647 if (err <= PCIBIOS_SUCCESSFUL)
648 return err; /* Assume already errno */
649
650 switch (err) {
651 case PCIBIOS_FUNC_NOT_SUPPORTED:
652 return -ENOENT;
653 case PCIBIOS_BAD_VENDOR_ID:
654 return -ENOTTY;
655 case PCIBIOS_DEVICE_NOT_FOUND:
656 return -ENODEV;
657 case PCIBIOS_BAD_REGISTER_NUMBER:
658 return -EFAULT;
659 case PCIBIOS_SET_FAILED:
660 return -EIO;
661 case PCIBIOS_BUFFER_TOO_SMALL:
662 return -ENOSPC;
663 }
664
665 return -ERANGE;
666 }
667
668 /* Low-level architecture-dependent routines */
669
670 struct pci_ops {
671 int (*add_bus)(struct pci_bus *bus);
672 void (*remove_bus)(struct pci_bus *bus);
673 void __iomem *(*map_bus)(struct pci_bus *bus, unsigned int devfn, int where);
674 int (*read)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 *val);
675 int (*write)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 val);
676 };
677
678 /*
679 * ACPI needs to be able to access PCI config space before we've done a
680 * PCI bus scan and created pci_bus structures.
681 */
682 int raw_pci_read(unsigned int domain, unsigned int bus, unsigned int devfn,
683 int reg, int len, u32 *val);
684 int raw_pci_write(unsigned int domain, unsigned int bus, unsigned int devfn,
685 int reg, int len, u32 val);
686
687 #ifdef CONFIG_PCI_BUS_ADDR_T_64BIT
688 typedef u64 pci_bus_addr_t;
689 #else
690 typedef u32 pci_bus_addr_t;
691 #endif
692
693 struct pci_bus_region {
694 pci_bus_addr_t start;
695 pci_bus_addr_t end;
696 };
697
698 struct pci_dynids {
699 spinlock_t lock; /* protects list, index */
700 struct list_head list; /* for IDs added at runtime */
701 };
702
703
704 /*
705 * PCI Error Recovery System (PCI-ERS). If a PCI device driver provides
706 * a set of callbacks in struct pci_error_handlers, that device driver
707 * will be notified of PCI bus errors, and will be driven to recovery
708 * when an error occurs.
709 */
710
711 typedef unsigned int __bitwise pci_ers_result_t;
712
713 enum pci_ers_result {
714 /* no result/none/not supported in device driver */
715 PCI_ERS_RESULT_NONE = (__force pci_ers_result_t) 1,
716
717 /* Device driver can recover without slot reset */
718 PCI_ERS_RESULT_CAN_RECOVER = (__force pci_ers_result_t) 2,
719
720 /* Device driver wants slot to be reset. */
721 PCI_ERS_RESULT_NEED_RESET = (__force pci_ers_result_t) 3,
722
723 /* Device has completely failed, is unrecoverable */
724 PCI_ERS_RESULT_DISCONNECT = (__force pci_ers_result_t) 4,
725
726 /* Device driver is fully recovered and operational */
727 PCI_ERS_RESULT_RECOVERED = (__force pci_ers_result_t) 5,
728
729 /* No AER capabilities registered for the driver */
730 PCI_ERS_RESULT_NO_AER_DRIVER = (__force pci_ers_result_t) 6,
731 };
732
733 /* PCI bus error event callbacks */
734 struct pci_error_handlers {
735 /* PCI bus error detected on this device */
736 pci_ers_result_t (*error_detected)(struct pci_dev *dev,
737 enum pci_channel_state error);
738
739 /* MMIO has been re-enabled, but not DMA */
740 pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev);
741
742 /* PCI slot has been reset */
743 pci_ers_result_t (*slot_reset)(struct pci_dev *dev);
744
745 /* PCI function reset prepare or completed */
746 void (*reset_prepare)(struct pci_dev *dev);
747 void (*reset_done)(struct pci_dev *dev);
748
749 /* Device driver may resume normal operations */
750 void (*resume)(struct pci_dev *dev);
751 };
752
753
754 struct module;
755 struct pci_driver {
756 struct list_head node;
757 const char *name;
758 const struct pci_device_id *id_table; /* must be non-NULL for probe to be called */
759 int (*probe) (struct pci_dev *dev, const struct pci_device_id *id); /* New device inserted */
760 void (*remove) (struct pci_dev *dev); /* Device removed (NULL if not a hot-plug capable driver) */
761 int (*suspend) (struct pci_dev *dev, pm_message_t state); /* Device suspended */
762 int (*suspend_late) (struct pci_dev *dev, pm_message_t state);
763 int (*resume_early) (struct pci_dev *dev);
764 int (*resume) (struct pci_dev *dev); /* Device woken up */
765 void (*shutdown) (struct pci_dev *dev);
766 int (*sriov_configure) (struct pci_dev *dev, int num_vfs); /* PF pdev */
767 const struct pci_error_handlers *err_handler;
768 const struct attribute_group **groups;
769 struct device_driver driver;
770 struct pci_dynids dynids;
771 };
772
773 #define to_pci_driver(drv) container_of(drv, struct pci_driver, driver)
774
775 /**
776 * PCI_DEVICE - macro used to describe a specific pci device
777 * @vend: the 16 bit PCI Vendor ID
778 * @dev: the 16 bit PCI Device ID
779 *
780 * This macro is used to create a struct pci_device_id that matches a
781 * specific device. The subvendor and subdevice fields will be set to
782 * PCI_ANY_ID.
783 */
784 #define PCI_DEVICE(vend,dev) \
785 .vendor = (vend), .device = (dev), \
786 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
787
788 /**
789 * PCI_DEVICE_SUB - macro used to describe a specific pci device with subsystem
790 * @vend: the 16 bit PCI Vendor ID
791 * @dev: the 16 bit PCI Device ID
792 * @subvend: the 16 bit PCI Subvendor ID
793 * @subdev: the 16 bit PCI Subdevice ID
794 *
795 * This macro is used to create a struct pci_device_id that matches a
796 * specific device with subsystem information.
797 */
798 #define PCI_DEVICE_SUB(vend, dev, subvend, subdev) \
799 .vendor = (vend), .device = (dev), \
800 .subvendor = (subvend), .subdevice = (subdev)
801
802 /**
803 * PCI_DEVICE_CLASS - macro used to describe a specific pci device class
804 * @dev_class: the class, subclass, prog-if triple for this device
805 * @dev_class_mask: the class mask for this device
806 *
807 * This macro is used to create a struct pci_device_id that matches a
808 * specific PCI class. The vendor, device, subvendor, and subdevice
809 * fields will be set to PCI_ANY_ID.
810 */
811 #define PCI_DEVICE_CLASS(dev_class,dev_class_mask) \
812 .class = (dev_class), .class_mask = (dev_class_mask), \
813 .vendor = PCI_ANY_ID, .device = PCI_ANY_ID, \
814 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
815
816 /**
817 * PCI_VDEVICE - macro used to describe a specific pci device in short form
818 * @vend: the vendor name
819 * @dev: the 16 bit PCI Device ID
820 *
821 * This macro is used to create a struct pci_device_id that matches a
822 * specific PCI device. The subvendor, and subdevice fields will be set
823 * to PCI_ANY_ID. The macro allows the next field to follow as the device
824 * private data.
825 */
826
827 #define PCI_VDEVICE(vend, dev) \
828 .vendor = PCI_VENDOR_ID_##vend, .device = (dev), \
829 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, 0, 0
830
831 enum {
832 PCI_REASSIGN_ALL_RSRC = 0x00000001, /* ignore firmware setup */
833 PCI_REASSIGN_ALL_BUS = 0x00000002, /* reassign all bus numbers */
834 PCI_PROBE_ONLY = 0x00000004, /* use existing setup */
835 PCI_CAN_SKIP_ISA_ALIGN = 0x00000008, /* don't do ISA alignment */
836 PCI_ENABLE_PROC_DOMAINS = 0x00000010, /* enable domains in /proc */
837 PCI_COMPAT_DOMAIN_0 = 0x00000020, /* ... except domain 0 */
838 PCI_SCAN_ALL_PCIE_DEVS = 0x00000040, /* scan all, not just dev 0 */
839 };
840
841 /* these external functions are only available when PCI support is enabled */
842 #ifdef CONFIG_PCI
843
844 extern unsigned int pci_flags;
845
846 static inline void pci_set_flags(int flags) { pci_flags = flags; }
847 static inline void pci_add_flags(int flags) { pci_flags |= flags; }
848 static inline void pci_clear_flags(int flags) { pci_flags &= ~flags; }
849 static inline int pci_has_flag(int flag) { return pci_flags & flag; }
850
851 void pcie_bus_configure_settings(struct pci_bus *bus);
852
853 enum pcie_bus_config_types {
854 PCIE_BUS_TUNE_OFF, /* don't touch MPS at all */
855 PCIE_BUS_DEFAULT, /* ensure MPS matches upstream bridge */
856 PCIE_BUS_SAFE, /* use largest MPS boot-time devices support */
857 PCIE_BUS_PERFORMANCE, /* use MPS and MRRS for best performance */
858 PCIE_BUS_PEER2PEER, /* set MPS = 128 for all devices */
859 };
860
861 extern enum pcie_bus_config_types pcie_bus_config;
862
863 extern struct bus_type pci_bus_type;
864
865 /* Do NOT directly access these two variables, unless you are arch-specific PCI
866 * code, or PCI core code. */
867 extern struct list_head pci_root_buses; /* list of all known PCI buses */
868 /* Some device drivers need know if PCI is initiated */
869 int no_pci_devices(void);
870
871 void pcibios_resource_survey_bus(struct pci_bus *bus);
872 void pcibios_bus_add_device(struct pci_dev *pdev);
873 void pcibios_add_bus(struct pci_bus *bus);
874 void pcibios_remove_bus(struct pci_bus *bus);
875 void pcibios_fixup_bus(struct pci_bus *);
876 int __must_check pcibios_enable_device(struct pci_dev *, int mask);
877 /* Architecture-specific versions may override this (weak) */
878 char *pcibios_setup(char *str);
879
880 /* Used only when drivers/pci/setup.c is used */
881 resource_size_t pcibios_align_resource(void *, const struct resource *,
882 resource_size_t,
883 resource_size_t);
884
885 /* Weak but can be overriden by arch */
886 void pci_fixup_cardbus(struct pci_bus *);
887
888 /* Generic PCI functions used internally */
889
890 void pcibios_resource_to_bus(struct pci_bus *bus, struct pci_bus_region *region,
891 struct resource *res);
892 void pcibios_bus_to_resource(struct pci_bus *bus, struct resource *res,
893 struct pci_bus_region *region);
894 void pcibios_scan_specific_bus(int busn);
895 struct pci_bus *pci_find_bus(int domain, int busnr);
896 void pci_bus_add_devices(const struct pci_bus *bus);
897 struct pci_bus *pci_scan_bus(int bus, struct pci_ops *ops, void *sysdata);
898 struct pci_bus *pci_create_root_bus(struct device *parent, int bus,
899 struct pci_ops *ops, void *sysdata,
900 struct list_head *resources);
901 int pci_bus_insert_busn_res(struct pci_bus *b, int bus, int busmax);
902 int pci_bus_update_busn_res_end(struct pci_bus *b, int busmax);
903 void pci_bus_release_busn_res(struct pci_bus *b);
904 struct pci_bus *pci_scan_root_bus(struct device *parent, int bus,
905 struct pci_ops *ops, void *sysdata,
906 struct list_head *resources);
907 int pci_scan_root_bus_bridge(struct pci_host_bridge *bridge);
908 struct pci_bus *pci_add_new_bus(struct pci_bus *parent, struct pci_dev *dev,
909 int busnr);
910 void pcie_update_link_speed(struct pci_bus *bus, u16 link_status);
911 struct pci_slot *pci_create_slot(struct pci_bus *parent, int slot_nr,
912 const char *name,
913 struct hotplug_slot *hotplug);
914 void pci_destroy_slot(struct pci_slot *slot);
915 #ifdef CONFIG_SYSFS
916 void pci_dev_assign_slot(struct pci_dev *dev);
917 #else
918 static inline void pci_dev_assign_slot(struct pci_dev *dev) { }
919 #endif
920 int pci_scan_slot(struct pci_bus *bus, int devfn);
921 struct pci_dev *pci_scan_single_device(struct pci_bus *bus, int devfn);
922 void pci_device_add(struct pci_dev *dev, struct pci_bus *bus);
923 unsigned int pci_scan_child_bus(struct pci_bus *bus);
924 void pci_bus_add_device(struct pci_dev *dev);
925 void pci_read_bridge_bases(struct pci_bus *child);
926 struct resource *pci_find_parent_resource(const struct pci_dev *dev,
927 struct resource *res);
928 struct pci_dev *pci_find_pcie_root_port(struct pci_dev *dev);
929 u8 pci_swizzle_interrupt_pin(const struct pci_dev *dev, u8 pin);
930 int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge);
931 u8 pci_common_swizzle(struct pci_dev *dev, u8 *pinp);
932 struct pci_dev *pci_dev_get(struct pci_dev *dev);
933 void pci_dev_put(struct pci_dev *dev);
934 void pci_remove_bus(struct pci_bus *b);
935 void pci_stop_and_remove_bus_device(struct pci_dev *dev);
936 void pci_stop_and_remove_bus_device_locked(struct pci_dev *dev);
937 void pci_stop_root_bus(struct pci_bus *bus);
938 void pci_remove_root_bus(struct pci_bus *bus);
939 void pci_setup_cardbus(struct pci_bus *bus);
940 void pcibios_setup_bridge(struct pci_bus *bus, unsigned long type);
941 void pci_sort_breadthfirst(void);
942 #define dev_is_pci(d) ((d)->bus == &pci_bus_type)
943 #define dev_is_pf(d) ((dev_is_pci(d) ? to_pci_dev(d)->is_physfn : false))
944
945 /* Generic PCI functions exported to card drivers */
946
947 enum pci_lost_interrupt_reason {
948 PCI_LOST_IRQ_NO_INFORMATION = 0,
949 PCI_LOST_IRQ_DISABLE_MSI,
950 PCI_LOST_IRQ_DISABLE_MSIX,
951 PCI_LOST_IRQ_DISABLE_ACPI,
952 };
953 enum pci_lost_interrupt_reason pci_lost_interrupt(struct pci_dev *dev);
954 int pci_find_capability(struct pci_dev *dev, int cap);
955 int pci_find_next_capability(struct pci_dev *dev, u8 pos, int cap);
956 int pci_find_ext_capability(struct pci_dev *dev, int cap);
957 int pci_find_next_ext_capability(struct pci_dev *dev, int pos, int cap);
958 int pci_find_ht_capability(struct pci_dev *dev, int ht_cap);
959 int pci_find_next_ht_capability(struct pci_dev *dev, int pos, int ht_cap);
960 struct pci_bus *pci_find_next_bus(const struct pci_bus *from);
961
962 struct pci_dev *pci_get_device(unsigned int vendor, unsigned int device,
963 struct pci_dev *from);
964 struct pci_dev *pci_get_subsys(unsigned int vendor, unsigned int device,
965 unsigned int ss_vendor, unsigned int ss_device,
966 struct pci_dev *from);
967 struct pci_dev *pci_get_slot(struct pci_bus *bus, unsigned int devfn);
968 struct pci_dev *pci_get_domain_bus_and_slot(int domain, unsigned int bus,
969 unsigned int devfn);
970 static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
971 unsigned int devfn)
972 {
973 return pci_get_domain_bus_and_slot(0, bus, devfn);
974 }
975 struct pci_dev *pci_get_class(unsigned int class, struct pci_dev *from);
976 int pci_dev_present(const struct pci_device_id *ids);
977
978 int pci_bus_read_config_byte(struct pci_bus *bus, unsigned int devfn,
979 int where, u8 *val);
980 int pci_bus_read_config_word(struct pci_bus *bus, unsigned int devfn,
981 int where, u16 *val);
982 int pci_bus_read_config_dword(struct pci_bus *bus, unsigned int devfn,
983 int where, u32 *val);
984 int pci_bus_write_config_byte(struct pci_bus *bus, unsigned int devfn,
985 int where, u8 val);
986 int pci_bus_write_config_word(struct pci_bus *bus, unsigned int devfn,
987 int where, u16 val);
988 int pci_bus_write_config_dword(struct pci_bus *bus, unsigned int devfn,
989 int where, u32 val);
990
991 int pci_generic_config_read(struct pci_bus *bus, unsigned int devfn,
992 int where, int size, u32 *val);
993 int pci_generic_config_write(struct pci_bus *bus, unsigned int devfn,
994 int where, int size, u32 val);
995 int pci_generic_config_read32(struct pci_bus *bus, unsigned int devfn,
996 int where, int size, u32 *val);
997 int pci_generic_config_write32(struct pci_bus *bus, unsigned int devfn,
998 int where, int size, u32 val);
999
1000 struct pci_ops *pci_bus_set_ops(struct pci_bus *bus, struct pci_ops *ops);
1001
1002 int pci_read_config_byte(const struct pci_dev *dev, int where, u8 *val);
1003 int pci_read_config_word(const struct pci_dev *dev, int where, u16 *val);
1004 int pci_read_config_dword(const struct pci_dev *dev, int where, u32 *val);
1005 int pci_write_config_byte(const struct pci_dev *dev, int where, u8 val);
1006 int pci_write_config_word(const struct pci_dev *dev, int where, u16 val);
1007 int pci_write_config_dword(const struct pci_dev *dev, int where, u32 val);
1008
1009 int pcie_capability_read_word(struct pci_dev *dev, int pos, u16 *val);
1010 int pcie_capability_read_dword(struct pci_dev *dev, int pos, u32 *val);
1011 int pcie_capability_write_word(struct pci_dev *dev, int pos, u16 val);
1012 int pcie_capability_write_dword(struct pci_dev *dev, int pos, u32 val);
1013 int pcie_capability_clear_and_set_word(struct pci_dev *dev, int pos,
1014 u16 clear, u16 set);
1015 int pcie_capability_clear_and_set_dword(struct pci_dev *dev, int pos,
1016 u32 clear, u32 set);
1017
1018 static inline int pcie_capability_set_word(struct pci_dev *dev, int pos,
1019 u16 set)
1020 {
1021 return pcie_capability_clear_and_set_word(dev, pos, 0, set);
1022 }
1023
1024 static inline int pcie_capability_set_dword(struct pci_dev *dev, int pos,
1025 u32 set)
1026 {
1027 return pcie_capability_clear_and_set_dword(dev, pos, 0, set);
1028 }
1029
1030 static inline int pcie_capability_clear_word(struct pci_dev *dev, int pos,
1031 u16 clear)
1032 {
1033 return pcie_capability_clear_and_set_word(dev, pos, clear, 0);
1034 }
1035
1036 static inline int pcie_capability_clear_dword(struct pci_dev *dev, int pos,
1037 u32 clear)
1038 {
1039 return pcie_capability_clear_and_set_dword(dev, pos, clear, 0);
1040 }
1041
1042 /* user-space driven config access */
1043 int pci_user_read_config_byte(struct pci_dev *dev, int where, u8 *val);
1044 int pci_user_read_config_word(struct pci_dev *dev, int where, u16 *val);
1045 int pci_user_read_config_dword(struct pci_dev *dev, int where, u32 *val);
1046 int pci_user_write_config_byte(struct pci_dev *dev, int where, u8 val);
1047 int pci_user_write_config_word(struct pci_dev *dev, int where, u16 val);
1048 int pci_user_write_config_dword(struct pci_dev *dev, int where, u32 val);
1049
1050 int __must_check pci_enable_device(struct pci_dev *dev);
1051 int __must_check pci_enable_device_io(struct pci_dev *dev);
1052 int __must_check pci_enable_device_mem(struct pci_dev *dev);
1053 int __must_check pci_reenable_device(struct pci_dev *);
1054 int __must_check pcim_enable_device(struct pci_dev *pdev);
1055 void pcim_pin_device(struct pci_dev *pdev);
1056
1057 static inline bool pci_intx_mask_supported(struct pci_dev *pdev)
1058 {
1059 /*
1060 * INTx masking is supported if PCI_COMMAND_INTX_DISABLE is
1061 * writable and no quirk has marked the feature broken.
1062 */
1063 return !pdev->broken_intx_masking;
1064 }
1065
1066 static inline int pci_is_enabled(struct pci_dev *pdev)
1067 {
1068 return (atomic_read(&pdev->enable_cnt) > 0);
1069 }
1070
1071 static inline int pci_is_managed(struct pci_dev *pdev)
1072 {
1073 return pdev->is_managed;
1074 }
1075
1076 void pci_disable_device(struct pci_dev *dev);
1077
1078 extern unsigned int pcibios_max_latency;
1079 void pci_set_master(struct pci_dev *dev);
1080 void pci_clear_master(struct pci_dev *dev);
1081
1082 int pci_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state);
1083 int pci_set_cacheline_size(struct pci_dev *dev);
1084 #define HAVE_PCI_SET_MWI
1085 int __must_check pci_set_mwi(struct pci_dev *dev);
1086 int __must_check pcim_set_mwi(struct pci_dev *dev);
1087 int pci_try_set_mwi(struct pci_dev *dev);
1088 void pci_clear_mwi(struct pci_dev *dev);
1089 void pci_intx(struct pci_dev *dev, int enable);
1090 bool pci_check_and_mask_intx(struct pci_dev *dev);
1091 bool pci_check_and_unmask_intx(struct pci_dev *dev);
1092 int pci_wait_for_pending(struct pci_dev *dev, int pos, u16 mask);
1093 int pci_wait_for_pending_transaction(struct pci_dev *dev);
1094 int pcix_get_max_mmrbc(struct pci_dev *dev);
1095 int pcix_get_mmrbc(struct pci_dev *dev);
1096 int pcix_set_mmrbc(struct pci_dev *dev, int mmrbc);
1097 int pcie_get_readrq(struct pci_dev *dev);
1098 int pcie_set_readrq(struct pci_dev *dev, int rq);
1099 int pcie_get_mps(struct pci_dev *dev);
1100 int pcie_set_mps(struct pci_dev *dev, int mps);
1101 int pcie_get_minimum_link(struct pci_dev *dev, enum pci_bus_speed *speed,
1102 enum pcie_link_width *width);
1103 void pcie_flr(struct pci_dev *dev);
1104 int __pci_reset_function_locked(struct pci_dev *dev);
1105 int pci_reset_function(struct pci_dev *dev);
1106 int pci_reset_function_locked(struct pci_dev *dev);
1107 int pci_try_reset_function(struct pci_dev *dev);
1108 int pci_probe_reset_slot(struct pci_slot *slot);
1109 int pci_reset_slot(struct pci_slot *slot);
1110 int pci_try_reset_slot(struct pci_slot *slot);
1111 int pci_probe_reset_bus(struct pci_bus *bus);
1112 int pci_reset_bus(struct pci_bus *bus);
1113 int pci_try_reset_bus(struct pci_bus *bus);
1114 void pci_reset_secondary_bus(struct pci_dev *dev);
1115 void pcibios_reset_secondary_bus(struct pci_dev *dev);
1116 void pci_reset_bridge_secondary_bus(struct pci_dev *dev);
1117 void pci_update_resource(struct pci_dev *dev, int resno);
1118 int __must_check pci_assign_resource(struct pci_dev *dev, int i);
1119 int __must_check pci_reassign_resource(struct pci_dev *dev, int i, resource_size_t add_size, resource_size_t align);
1120 void pci_release_resource(struct pci_dev *dev, int resno);
1121 int __must_check pci_resize_resource(struct pci_dev *dev, int i, int size);
1122 int pci_select_bars(struct pci_dev *dev, unsigned long flags);
1123 bool pci_device_is_present(struct pci_dev *pdev);
1124 void pci_ignore_hotplug(struct pci_dev *dev);
1125
1126 int __printf(6, 7) pci_request_irq(struct pci_dev *dev, unsigned int nr,
1127 irq_handler_t handler, irq_handler_t thread_fn, void *dev_id,
1128 const char *fmt, ...);
1129 void pci_free_irq(struct pci_dev *dev, unsigned int nr, void *dev_id);
1130
1131 /* ROM control related routines */
1132 int pci_enable_rom(struct pci_dev *pdev);
1133 void pci_disable_rom(struct pci_dev *pdev);
1134 void __iomem __must_check *pci_map_rom(struct pci_dev *pdev, size_t *size);
1135 void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom);
1136 size_t pci_get_rom_size(struct pci_dev *pdev, void __iomem *rom, size_t size);
1137 void __iomem __must_check *pci_platform_rom(struct pci_dev *pdev, size_t *size);
1138
1139 /* Power management related routines */
1140 int pci_save_state(struct pci_dev *dev);
1141 void pci_restore_state(struct pci_dev *dev);
1142 struct pci_saved_state *pci_store_saved_state(struct pci_dev *dev);
1143 int pci_load_saved_state(struct pci_dev *dev,
1144 struct pci_saved_state *state);
1145 int pci_load_and_free_saved_state(struct pci_dev *dev,
1146 struct pci_saved_state **state);
1147 struct pci_cap_saved_state *pci_find_saved_cap(struct pci_dev *dev, char cap);
1148 struct pci_cap_saved_state *pci_find_saved_ext_cap(struct pci_dev *dev,
1149 u16 cap);
1150 int pci_add_cap_save_buffer(struct pci_dev *dev, char cap, unsigned int size);
1151 int pci_add_ext_cap_save_buffer(struct pci_dev *dev,
1152 u16 cap, unsigned int size);
1153 int __pci_complete_power_transition(struct pci_dev *dev, pci_power_t state);
1154 int pci_set_power_state(struct pci_dev *dev, pci_power_t state);
1155 pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state);
1156 bool pci_pme_capable(struct pci_dev *dev, pci_power_t state);
1157 void pci_pme_active(struct pci_dev *dev, bool enable);
1158 int pci_enable_wake(struct pci_dev *dev, pci_power_t state, bool enable);
1159 int pci_wake_from_d3(struct pci_dev *dev, bool enable);
1160 int pci_prepare_to_sleep(struct pci_dev *dev);
1161 int pci_back_from_sleep(struct pci_dev *dev);
1162 bool pci_dev_run_wake(struct pci_dev *dev);
1163 bool pci_check_pme_status(struct pci_dev *dev);
1164 void pci_pme_wakeup_bus(struct pci_bus *bus);
1165 void pci_d3cold_enable(struct pci_dev *dev);
1166 void pci_d3cold_disable(struct pci_dev *dev);
1167 bool pcie_relaxed_ordering_enabled(struct pci_dev *dev);
1168
1169 /* PCI Virtual Channel */
1170 int pci_save_vc_state(struct pci_dev *dev);
1171 void pci_restore_vc_state(struct pci_dev *dev);
1172 void pci_allocate_vc_save_buffers(struct pci_dev *dev);
1173
1174 /* For use by arch with custom probe code */
1175 void set_pcie_port_type(struct pci_dev *pdev);
1176 void set_pcie_hotplug_bridge(struct pci_dev *pdev);
1177
1178 /* Functions for PCI Hotplug drivers to use */
1179 int pci_bus_find_capability(struct pci_bus *bus, unsigned int devfn, int cap);
1180 unsigned int pci_rescan_bus_bridge_resize(struct pci_dev *bridge);
1181 unsigned int pci_rescan_bus(struct pci_bus *bus);
1182 void pci_lock_rescan_remove(void);
1183 void pci_unlock_rescan_remove(void);
1184
1185 /* Vital product data routines */
1186 ssize_t pci_read_vpd(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
1187 ssize_t pci_write_vpd(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
1188 int pci_set_vpd_size(struct pci_dev *dev, size_t len);
1189
1190 /* Helper functions for low-level code (drivers/pci/setup-[bus,res].c) */
1191 resource_size_t pcibios_retrieve_fw_addr(struct pci_dev *dev, int idx);
1192 void pci_bus_assign_resources(const struct pci_bus *bus);
1193 void pci_bus_claim_resources(struct pci_bus *bus);
1194 void pci_bus_size_bridges(struct pci_bus *bus);
1195 int pci_claim_resource(struct pci_dev *, int);
1196 int pci_claim_bridge_resource(struct pci_dev *bridge, int i);
1197 void pci_assign_unassigned_resources(void);
1198 void pci_assign_unassigned_bridge_resources(struct pci_dev *bridge);
1199 void pci_assign_unassigned_bus_resources(struct pci_bus *bus);
1200 void pci_assign_unassigned_root_bus_resources(struct pci_bus *bus);
1201 int pci_reassign_bridge_resources(struct pci_dev *bridge, unsigned long type);
1202 void pdev_enable_device(struct pci_dev *);
1203 int pci_enable_resources(struct pci_dev *, int mask);
1204 void pci_assign_irq(struct pci_dev *dev);
1205 struct resource *pci_find_resource(struct pci_dev *dev, struct resource *res);
1206 #define HAVE_PCI_REQ_REGIONS 2
1207 int __must_check pci_request_regions(struct pci_dev *, const char *);
1208 int __must_check pci_request_regions_exclusive(struct pci_dev *, const char *);
1209 void pci_release_regions(struct pci_dev *);
1210 int __must_check pci_request_region(struct pci_dev *, int, const char *);
1211 int __must_check pci_request_region_exclusive(struct pci_dev *, int, const char *);
1212 void pci_release_region(struct pci_dev *, int);
1213 int pci_request_selected_regions(struct pci_dev *, int, const char *);
1214 int pci_request_selected_regions_exclusive(struct pci_dev *, int, const char *);
1215 void pci_release_selected_regions(struct pci_dev *, int);
1216
1217 /* drivers/pci/bus.c */
1218 struct pci_bus *pci_bus_get(struct pci_bus *bus);
1219 void pci_bus_put(struct pci_bus *bus);
1220 void pci_add_resource(struct list_head *resources, struct resource *res);
1221 void pci_add_resource_offset(struct list_head *resources, struct resource *res,
1222 resource_size_t offset);
1223 void pci_free_resource_list(struct list_head *resources);
1224 void pci_bus_add_resource(struct pci_bus *bus, struct resource *res,
1225 unsigned int flags);
1226 struct resource *pci_bus_resource_n(const struct pci_bus *bus, int n);
1227 void pci_bus_remove_resources(struct pci_bus *bus);
1228 int devm_request_pci_bus_resources(struct device *dev,
1229 struct list_head *resources);
1230
1231 #define pci_bus_for_each_resource(bus, res, i) \
1232 for (i = 0; \
1233 (res = pci_bus_resource_n(bus, i)) || i < PCI_BRIDGE_RESOURCE_NUM; \
1234 i++)
1235
1236 int __must_check pci_bus_alloc_resource(struct pci_bus *bus,
1237 struct resource *res, resource_size_t size,
1238 resource_size_t align, resource_size_t min,
1239 unsigned long type_mask,
1240 resource_size_t (*alignf)(void *,
1241 const struct resource *,
1242 resource_size_t,
1243 resource_size_t),
1244 void *alignf_data);
1245
1246
1247 int pci_register_io_range(struct fwnode_handle *fwnode, phys_addr_t addr,
1248 resource_size_t size);
1249 unsigned long pci_address_to_pio(phys_addr_t addr);
1250 phys_addr_t pci_pio_to_address(unsigned long pio);
1251 int pci_remap_iospace(const struct resource *res, phys_addr_t phys_addr);
1252 void pci_unmap_iospace(struct resource *res);
1253 void __iomem *devm_pci_remap_cfgspace(struct device *dev,
1254 resource_size_t offset,
1255 resource_size_t size);
1256 void __iomem *devm_pci_remap_cfg_resource(struct device *dev,
1257 struct resource *res);
1258
1259 static inline pci_bus_addr_t pci_bus_address(struct pci_dev *pdev, int bar)
1260 {
1261 struct pci_bus_region region;
1262
1263 pcibios_resource_to_bus(pdev->bus, &region, &pdev->resource[bar]);
1264 return region.start;
1265 }
1266
1267 /* Proper probing supporting hot-pluggable devices */
1268 int __must_check __pci_register_driver(struct pci_driver *, struct module *,
1269 const char *mod_name);
1270
1271 /*
1272 * pci_register_driver must be a macro so that KBUILD_MODNAME can be expanded
1273 */
1274 #define pci_register_driver(driver) \
1275 __pci_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
1276
1277 void pci_unregister_driver(struct pci_driver *dev);
1278
1279 /**
1280 * module_pci_driver() - Helper macro for registering a PCI driver
1281 * @__pci_driver: pci_driver struct
1282 *
1283 * Helper macro for PCI drivers which do not do anything special in module
1284 * init/exit. This eliminates a lot of boilerplate. Each module may only
1285 * use this macro once, and calling it replaces module_init() and module_exit()
1286 */
1287 #define module_pci_driver(__pci_driver) \
1288 module_driver(__pci_driver, pci_register_driver, \
1289 pci_unregister_driver)
1290
1291 /**
1292 * builtin_pci_driver() - Helper macro for registering a PCI driver
1293 * @__pci_driver: pci_driver struct
1294 *
1295 * Helper macro for PCI drivers which do not do anything special in their
1296 * init code. This eliminates a lot of boilerplate. Each driver may only
1297 * use this macro once, and calling it replaces device_initcall(...)
1298 */
1299 #define builtin_pci_driver(__pci_driver) \
1300 builtin_driver(__pci_driver, pci_register_driver)
1301
1302 struct pci_driver *pci_dev_driver(const struct pci_dev *dev);
1303 int pci_add_dynid(struct pci_driver *drv,
1304 unsigned int vendor, unsigned int device,
1305 unsigned int subvendor, unsigned int subdevice,
1306 unsigned int class, unsigned int class_mask,
1307 unsigned long driver_data);
1308 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
1309 struct pci_dev *dev);
1310 int pci_scan_bridge(struct pci_bus *bus, struct pci_dev *dev, int max,
1311 int pass);
1312
1313 void pci_walk_bus(struct pci_bus *top, int (*cb)(struct pci_dev *, void *),
1314 void *userdata);
1315 int pci_cfg_space_size(struct pci_dev *dev);
1316 unsigned char pci_bus_max_busnr(struct pci_bus *bus);
1317 void pci_setup_bridge(struct pci_bus *bus);
1318 resource_size_t pcibios_window_alignment(struct pci_bus *bus,
1319 unsigned long type);
1320 resource_size_t pcibios_iov_resource_alignment(struct pci_dev *dev, int resno);
1321
1322 #define PCI_VGA_STATE_CHANGE_BRIDGE (1 << 0)
1323 #define PCI_VGA_STATE_CHANGE_DECODES (1 << 1)
1324
1325 int pci_set_vga_state(struct pci_dev *pdev, bool decode,
1326 unsigned int command_bits, u32 flags);
1327
1328 #define PCI_IRQ_LEGACY (1 << 0) /* allow legacy interrupts */
1329 #define PCI_IRQ_MSI (1 << 1) /* allow MSI interrupts */
1330 #define PCI_IRQ_MSIX (1 << 2) /* allow MSI-X interrupts */
1331 #define PCI_IRQ_AFFINITY (1 << 3) /* auto-assign affinity */
1332 #define PCI_IRQ_ALL_TYPES \
1333 (PCI_IRQ_LEGACY | PCI_IRQ_MSI | PCI_IRQ_MSIX)
1334
1335 /* kmem_cache style wrapper around pci_alloc_consistent() */
1336
1337 #include <linux/pci-dma.h>
1338 #include <linux/dmapool.h>
1339
1340 #define pci_pool dma_pool
1341 #define pci_pool_create(name, pdev, size, align, allocation) \
1342 dma_pool_create(name, &pdev->dev, size, align, allocation)
1343 #define pci_pool_destroy(pool) dma_pool_destroy(pool)
1344 #define pci_pool_alloc(pool, flags, handle) dma_pool_alloc(pool, flags, handle)
1345 #define pci_pool_zalloc(pool, flags, handle) \
1346 dma_pool_zalloc(pool, flags, handle)
1347 #define pci_pool_free(pool, vaddr, addr) dma_pool_free(pool, vaddr, addr)
1348
1349 struct msix_entry {
1350 u32 vector; /* kernel uses to write allocated vector */
1351 u16 entry; /* driver uses to specify entry, OS writes */
1352 };
1353
1354 #ifdef CONFIG_PCI_MSI
1355 int pci_msi_vec_count(struct pci_dev *dev);
1356 void pci_disable_msi(struct pci_dev *dev);
1357 int pci_msix_vec_count(struct pci_dev *dev);
1358 void pci_disable_msix(struct pci_dev *dev);
1359 void pci_restore_msi_state(struct pci_dev *dev);
1360 int pci_msi_enabled(void);
1361 int pci_enable_msi(struct pci_dev *dev);
1362 int pci_enable_msix_range(struct pci_dev *dev, struct msix_entry *entries,
1363 int minvec, int maxvec);
1364 static inline int pci_enable_msix_exact(struct pci_dev *dev,
1365 struct msix_entry *entries, int nvec)
1366 {
1367 int rc = pci_enable_msix_range(dev, entries, nvec, nvec);
1368 if (rc < 0)
1369 return rc;
1370 return 0;
1371 }
1372 int pci_alloc_irq_vectors_affinity(struct pci_dev *dev, unsigned int min_vecs,
1373 unsigned int max_vecs, unsigned int flags,
1374 const struct irq_affinity *affd);
1375
1376 void pci_free_irq_vectors(struct pci_dev *dev);
1377 int pci_irq_vector(struct pci_dev *dev, unsigned int nr);
1378 const struct cpumask *pci_irq_get_affinity(struct pci_dev *pdev, int vec);
1379 int pci_irq_get_node(struct pci_dev *pdev, int vec);
1380
1381 #else
1382 static inline int pci_msi_vec_count(struct pci_dev *dev) { return -ENOSYS; }
1383 static inline void pci_disable_msi(struct pci_dev *dev) { }
1384 static inline int pci_msix_vec_count(struct pci_dev *dev) { return -ENOSYS; }
1385 static inline void pci_disable_msix(struct pci_dev *dev) { }
1386 static inline void pci_restore_msi_state(struct pci_dev *dev) { }
1387 static inline int pci_msi_enabled(void) { return 0; }
1388 static inline int pci_enable_msi(struct pci_dev *dev)
1389 { return -ENOSYS; }
1390 static inline int pci_enable_msix_range(struct pci_dev *dev,
1391 struct msix_entry *entries, int minvec, int maxvec)
1392 { return -ENOSYS; }
1393 static inline int pci_enable_msix_exact(struct pci_dev *dev,
1394 struct msix_entry *entries, int nvec)
1395 { return -ENOSYS; }
1396
1397 static inline int
1398 pci_alloc_irq_vectors_affinity(struct pci_dev *dev, unsigned int min_vecs,
1399 unsigned int max_vecs, unsigned int flags,
1400 const struct irq_affinity *aff_desc)
1401 {
1402 if ((flags & PCI_IRQ_LEGACY) && min_vecs == 1 && dev->irq)
1403 return 1;
1404 return -ENOSPC;
1405 }
1406
1407 static inline void pci_free_irq_vectors(struct pci_dev *dev)
1408 {
1409 }
1410
1411 static inline int pci_irq_vector(struct pci_dev *dev, unsigned int nr)
1412 {
1413 if (WARN_ON_ONCE(nr > 0))
1414 return -EINVAL;
1415 return dev->irq;
1416 }
1417 static inline const struct cpumask *pci_irq_get_affinity(struct pci_dev *pdev,
1418 int vec)
1419 {
1420 return cpu_possible_mask;
1421 }
1422
1423 static inline int pci_irq_get_node(struct pci_dev *pdev, int vec)
1424 {
1425 return first_online_node;
1426 }
1427 #endif
1428
1429 static inline int
1430 pci_alloc_irq_vectors(struct pci_dev *dev, unsigned int min_vecs,
1431 unsigned int max_vecs, unsigned int flags)
1432 {
1433 return pci_alloc_irq_vectors_affinity(dev, min_vecs, max_vecs, flags,
1434 NULL);
1435 }
1436
1437 /**
1438 * pci_irqd_intx_xlate() - Translate PCI INTx value to an IRQ domain hwirq
1439 * @d: the INTx IRQ domain
1440 * @node: the DT node for the device whose interrupt we're translating
1441 * @intspec: the interrupt specifier data from the DT
1442 * @intsize: the number of entries in @intspec
1443 * @out_hwirq: pointer at which to write the hwirq number
1444 * @out_type: pointer at which to write the interrupt type
1445 *
1446 * Translate a PCI INTx interrupt number from device tree in the range 1-4, as
1447 * stored in the standard PCI_INTERRUPT_PIN register, to a value in the range
1448 * 0-3 suitable for use in a 4 entry IRQ domain. That is, subtract one from the
1449 * INTx value to obtain the hwirq number.
1450 *
1451 * Returns 0 on success, or -EINVAL if the interrupt specifier is out of range.
1452 */
1453 static inline int pci_irqd_intx_xlate(struct irq_domain *d,
1454 struct device_node *node,
1455 const u32 *intspec,
1456 unsigned int intsize,
1457 unsigned long *out_hwirq,
1458 unsigned int *out_type)
1459 {
1460 const u32 intx = intspec[0];
1461
1462 if (intx < PCI_INTERRUPT_INTA || intx > PCI_INTERRUPT_INTD)
1463 return -EINVAL;
1464
1465 *out_hwirq = intx - PCI_INTERRUPT_INTA;
1466 return 0;
1467 }
1468
1469 #ifdef CONFIG_PCIEPORTBUS
1470 extern bool pcie_ports_disabled;
1471 extern bool pcie_ports_auto;
1472 #else
1473 #define pcie_ports_disabled true
1474 #define pcie_ports_auto false
1475 #endif
1476
1477 #ifdef CONFIG_PCIEASPM
1478 bool pcie_aspm_support_enabled(void);
1479 #else
1480 static inline bool pcie_aspm_support_enabled(void) { return false; }
1481 #endif
1482
1483 #ifdef CONFIG_PCIEAER
1484 void pci_no_aer(void);
1485 bool pci_aer_available(void);
1486 int pci_aer_init(struct pci_dev *dev);
1487 #else
1488 static inline void pci_no_aer(void) { }
1489 static inline bool pci_aer_available(void) { return false; }
1490 static inline int pci_aer_init(struct pci_dev *d) { return -ENODEV; }
1491 #endif
1492
1493 #ifdef CONFIG_PCIE_ECRC
1494 void pcie_set_ecrc_checking(struct pci_dev *dev);
1495 void pcie_ecrc_get_policy(char *str);
1496 #else
1497 static inline void pcie_set_ecrc_checking(struct pci_dev *dev) { }
1498 static inline void pcie_ecrc_get_policy(char *str) { }
1499 #endif
1500
1501 #ifdef CONFIG_PCI_ATS
1502 /* Address Translation Service */
1503 void pci_ats_init(struct pci_dev *dev);
1504 int pci_enable_ats(struct pci_dev *dev, int ps);
1505 void pci_disable_ats(struct pci_dev *dev);
1506 int pci_ats_queue_depth(struct pci_dev *dev);
1507 #else
1508 static inline void pci_ats_init(struct pci_dev *d) { }
1509 static inline int pci_enable_ats(struct pci_dev *d, int ps) { return -ENODEV; }
1510 static inline void pci_disable_ats(struct pci_dev *d) { }
1511 static inline int pci_ats_queue_depth(struct pci_dev *d) { return -ENODEV; }
1512 #endif
1513
1514 #ifdef CONFIG_PCIE_PTM
1515 int pci_enable_ptm(struct pci_dev *dev, u8 *granularity);
1516 #else
1517 static inline int pci_enable_ptm(struct pci_dev *dev, u8 *granularity)
1518 { return -EINVAL; }
1519 #endif
1520
1521 void pci_cfg_access_lock(struct pci_dev *dev);
1522 bool pci_cfg_access_trylock(struct pci_dev *dev);
1523 void pci_cfg_access_unlock(struct pci_dev *dev);
1524
1525 /*
1526 * PCI domain support. Sometimes called PCI segment (eg by ACPI),
1527 * a PCI domain is defined to be a set of PCI buses which share
1528 * configuration space.
1529 */
1530 #ifdef CONFIG_PCI_DOMAINS
1531 extern int pci_domains_supported;
1532 int pci_get_new_domain_nr(void);
1533 #else
1534 enum { pci_domains_supported = 0 };
1535 static inline int pci_domain_nr(struct pci_bus *bus) { return 0; }
1536 static inline int pci_proc_domain(struct pci_bus *bus) { return 0; }
1537 static inline int pci_get_new_domain_nr(void) { return -ENOSYS; }
1538 #endif /* CONFIG_PCI_DOMAINS */
1539
1540 /*
1541 * Generic implementation for PCI domain support. If your
1542 * architecture does not need custom management of PCI
1543 * domains then this implementation will be used
1544 */
1545 #ifdef CONFIG_PCI_DOMAINS_GENERIC
1546 static inline int pci_domain_nr(struct pci_bus *bus)
1547 {
1548 return bus->domain_nr;
1549 }
1550 #ifdef CONFIG_ACPI
1551 int acpi_pci_bus_find_domain_nr(struct pci_bus *bus);
1552 #else
1553 static inline int acpi_pci_bus_find_domain_nr(struct pci_bus *bus)
1554 { return 0; }
1555 #endif
1556 int pci_bus_find_domain_nr(struct pci_bus *bus, struct device *parent);
1557 #endif
1558
1559 /* some architectures require additional setup to direct VGA traffic */
1560 typedef int (*arch_set_vga_state_t)(struct pci_dev *pdev, bool decode,
1561 unsigned int command_bits, u32 flags);
1562 void pci_register_set_vga_state(arch_set_vga_state_t func);
1563
1564 static inline int
1565 pci_request_io_regions(struct pci_dev *pdev, const char *name)
1566 {
1567 return pci_request_selected_regions(pdev,
1568 pci_select_bars(pdev, IORESOURCE_IO), name);
1569 }
1570
1571 static inline void
1572 pci_release_io_regions(struct pci_dev *pdev)
1573 {
1574 return pci_release_selected_regions(pdev,
1575 pci_select_bars(pdev, IORESOURCE_IO));
1576 }
1577
1578 static inline int
1579 pci_request_mem_regions(struct pci_dev *pdev, const char *name)
1580 {
1581 return pci_request_selected_regions(pdev,
1582 pci_select_bars(pdev, IORESOURCE_MEM), name);
1583 }
1584
1585 static inline void
1586 pci_release_mem_regions(struct pci_dev *pdev)
1587 {
1588 return pci_release_selected_regions(pdev,
1589 pci_select_bars(pdev, IORESOURCE_MEM));
1590 }
1591
1592 #else /* CONFIG_PCI is not enabled */
1593
1594 static inline void pci_set_flags(int flags) { }
1595 static inline void pci_add_flags(int flags) { }
1596 static inline void pci_clear_flags(int flags) { }
1597 static inline int pci_has_flag(int flag) { return 0; }
1598
1599 /*
1600 * If the system does not have PCI, clearly these return errors. Define
1601 * these as simple inline functions to avoid hair in drivers.
1602 */
1603
1604 #define _PCI_NOP(o, s, t) \
1605 static inline int pci_##o##_config_##s(struct pci_dev *dev, \
1606 int where, t val) \
1607 { return PCIBIOS_FUNC_NOT_SUPPORTED; }
1608
1609 #define _PCI_NOP_ALL(o, x) _PCI_NOP(o, byte, u8 x) \
1610 _PCI_NOP(o, word, u16 x) \
1611 _PCI_NOP(o, dword, u32 x)
1612 _PCI_NOP_ALL(read, *)
1613 _PCI_NOP_ALL(write,)
1614
1615 static inline struct pci_dev *pci_get_device(unsigned int vendor,
1616 unsigned int device,
1617 struct pci_dev *from)
1618 { return NULL; }
1619
1620 static inline struct pci_dev *pci_get_subsys(unsigned int vendor,
1621 unsigned int device,
1622 unsigned int ss_vendor,
1623 unsigned int ss_device,
1624 struct pci_dev *from)
1625 { return NULL; }
1626
1627 static inline struct pci_dev *pci_get_class(unsigned int class,
1628 struct pci_dev *from)
1629 { return NULL; }
1630
1631 #define pci_dev_present(ids) (0)
1632 #define no_pci_devices() (1)
1633 #define pci_dev_put(dev) do { } while (0)
1634
1635 static inline void pci_set_master(struct pci_dev *dev) { }
1636 static inline int pci_enable_device(struct pci_dev *dev) { return -EIO; }
1637 static inline void pci_disable_device(struct pci_dev *dev) { }
1638 static inline int pci_assign_resource(struct pci_dev *dev, int i)
1639 { return -EBUSY; }
1640 static inline int __pci_register_driver(struct pci_driver *drv,
1641 struct module *owner)
1642 { return 0; }
1643 static inline int pci_register_driver(struct pci_driver *drv)
1644 { return 0; }
1645 static inline void pci_unregister_driver(struct pci_driver *drv) { }
1646 static inline int pci_find_capability(struct pci_dev *dev, int cap)
1647 { return 0; }
1648 static inline int pci_find_next_capability(struct pci_dev *dev, u8 post,
1649 int cap)
1650 { return 0; }
1651 static inline int pci_find_ext_capability(struct pci_dev *dev, int cap)
1652 { return 0; }
1653
1654 /* Power management related routines */
1655 static inline int pci_save_state(struct pci_dev *dev) { return 0; }
1656 static inline void pci_restore_state(struct pci_dev *dev) { }
1657 static inline int pci_set_power_state(struct pci_dev *dev, pci_power_t state)
1658 { return 0; }
1659 static inline int pci_wake_from_d3(struct pci_dev *dev, bool enable)
1660 { return 0; }
1661 static inline pci_power_t pci_choose_state(struct pci_dev *dev,
1662 pm_message_t state)
1663 { return PCI_D0; }
1664 static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
1665 int enable)
1666 { return 0; }
1667
1668 static inline struct resource *pci_find_resource(struct pci_dev *dev,
1669 struct resource *res)
1670 { return NULL; }
1671 static inline int pci_request_regions(struct pci_dev *dev, const char *res_name)
1672 { return -EIO; }
1673 static inline void pci_release_regions(struct pci_dev *dev) { }
1674
1675 static inline unsigned long pci_address_to_pio(phys_addr_t addr) { return -1; }
1676
1677 static inline void pci_block_cfg_access(struct pci_dev *dev) { }
1678 static inline int pci_block_cfg_access_in_atomic(struct pci_dev *dev)
1679 { return 0; }
1680 static inline void pci_unblock_cfg_access(struct pci_dev *dev) { }
1681
1682 static inline struct pci_bus *pci_find_next_bus(const struct pci_bus *from)
1683 { return NULL; }
1684 static inline struct pci_dev *pci_get_slot(struct pci_bus *bus,
1685 unsigned int devfn)
1686 { return NULL; }
1687 static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
1688 unsigned int devfn)
1689 { return NULL; }
1690 static inline struct pci_dev *pci_get_domain_bus_and_slot(int domain,
1691 unsigned int bus, unsigned int devfn)
1692 { return NULL; }
1693
1694 static inline int pci_domain_nr(struct pci_bus *bus) { return 0; }
1695 static inline struct pci_dev *pci_dev_get(struct pci_dev *dev) { return NULL; }
1696 static inline int pci_get_new_domain_nr(void) { return -ENOSYS; }
1697
1698 #define dev_is_pci(d) (false)
1699 #define dev_is_pf(d) (false)
1700 static inline bool pci_acs_enabled(struct pci_dev *pdev, u16 acs_flags)
1701 { return false; }
1702 static inline int pci_irqd_intx_xlate(struct irq_domain *d,
1703 struct device_node *node,
1704 const u32 *intspec,
1705 unsigned int intsize,
1706 unsigned long *out_hwirq,
1707 unsigned int *out_type)
1708 { return -EINVAL; }
1709 #endif /* CONFIG_PCI */
1710
1711 /* Include architecture-dependent settings and functions */
1712
1713 #include <asm/pci.h>
1714
1715 /* These two functions provide almost identical functionality. Depennding
1716 * on the architecture, one will be implemented as a wrapper around the
1717 * other (in drivers/pci/mmap.c).
1718 *
1719 * pci_mmap_resource_range() maps a specific BAR, and vm->vm_pgoff
1720 * is expected to be an offset within that region.
1721 *
1722 * pci_mmap_page_range() is the legacy architecture-specific interface,
1723 * which accepts a "user visible" resource address converted by
1724 * pci_resource_to_user(), as used in the legacy mmap() interface in
1725 * /proc/bus/pci/.
1726 */
1727 int pci_mmap_resource_range(struct pci_dev *dev, int bar,
1728 struct vm_area_struct *vma,
1729 enum pci_mmap_state mmap_state, int write_combine);
1730 int pci_mmap_page_range(struct pci_dev *pdev, int bar,
1731 struct vm_area_struct *vma,
1732 enum pci_mmap_state mmap_state, int write_combine);
1733
1734 #ifndef arch_can_pci_mmap_wc
1735 #define arch_can_pci_mmap_wc() 0
1736 #endif
1737
1738 #ifndef arch_can_pci_mmap_io
1739 #define arch_can_pci_mmap_io() 0
1740 #define pci_iobar_pfn(pdev, bar, vma) (-EINVAL)
1741 #else
1742 int pci_iobar_pfn(struct pci_dev *pdev, int bar, struct vm_area_struct *vma);
1743 #endif
1744
1745 #ifndef pci_root_bus_fwnode
1746 #define pci_root_bus_fwnode(bus) NULL
1747 #endif
1748
1749 /* these helpers provide future and backwards compatibility
1750 * for accessing popular PCI BAR info */
1751 #define pci_resource_start(dev, bar) ((dev)->resource[(bar)].start)
1752 #define pci_resource_end(dev, bar) ((dev)->resource[(bar)].end)
1753 #define pci_resource_flags(dev, bar) ((dev)->resource[(bar)].flags)
1754 #define pci_resource_len(dev,bar) \
1755 ((pci_resource_start((dev), (bar)) == 0 && \
1756 pci_resource_end((dev), (bar)) == \
1757 pci_resource_start((dev), (bar))) ? 0 : \
1758 \
1759 (pci_resource_end((dev), (bar)) - \
1760 pci_resource_start((dev), (bar)) + 1))
1761
1762 /* Similar to the helpers above, these manipulate per-pci_dev
1763 * driver-specific data. They are really just a wrapper around
1764 * the generic device structure functions of these calls.
1765 */
1766 static inline void *pci_get_drvdata(struct pci_dev *pdev)
1767 {
1768 return dev_get_drvdata(&pdev->dev);
1769 }
1770
1771 static inline void pci_set_drvdata(struct pci_dev *pdev, void *data)
1772 {
1773 dev_set_drvdata(&pdev->dev, data);
1774 }
1775
1776 /* If you want to know what to call your pci_dev, ask this function.
1777 * Again, it's a wrapper around the generic device.
1778 */
1779 static inline const char *pci_name(const struct pci_dev *pdev)
1780 {
1781 return dev_name(&pdev->dev);
1782 }
1783
1784
1785 /* Some archs don't want to expose struct resource to userland as-is
1786 * in sysfs and /proc
1787 */
1788 #ifdef HAVE_ARCH_PCI_RESOURCE_TO_USER
1789 void pci_resource_to_user(const struct pci_dev *dev, int bar,
1790 const struct resource *rsrc,
1791 resource_size_t *start, resource_size_t *end);
1792 #else
1793 static inline void pci_resource_to_user(const struct pci_dev *dev, int bar,
1794 const struct resource *rsrc, resource_size_t *start,
1795 resource_size_t *end)
1796 {
1797 *start = rsrc->start;
1798 *end = rsrc->end;
1799 }
1800 #endif /* HAVE_ARCH_PCI_RESOURCE_TO_USER */
1801
1802
1803 /*
1804 * The world is not perfect and supplies us with broken PCI devices.
1805 * For at least a part of these bugs we need a work-around, so both
1806 * generic (drivers/pci/quirks.c) and per-architecture code can define
1807 * fixup hooks to be called for particular buggy devices.
1808 */
1809
1810 struct pci_fixup {
1811 u16 vendor; /* You can use PCI_ANY_ID here of course */
1812 u16 device; /* You can use PCI_ANY_ID here of course */
1813 u32 class; /* You can use PCI_ANY_ID here too */
1814 unsigned int class_shift; /* should be 0, 8, 16 */
1815 void (*hook)(struct pci_dev *dev);
1816 };
1817
1818 enum pci_fixup_pass {
1819 pci_fixup_early, /* Before probing BARs */
1820 pci_fixup_header, /* After reading configuration header */
1821 pci_fixup_final, /* Final phase of device fixups */
1822 pci_fixup_enable, /* pci_enable_device() time */
1823 pci_fixup_resume, /* pci_device_resume() */
1824 pci_fixup_suspend, /* pci_device_suspend() */
1825 pci_fixup_resume_early, /* pci_device_resume_early() */
1826 pci_fixup_suspend_late, /* pci_device_suspend_late() */
1827 };
1828
1829 /* Anonymous variables would be nice... */
1830 #define DECLARE_PCI_FIXUP_SECTION(section, name, vendor, device, class, \
1831 class_shift, hook) \
1832 static const struct pci_fixup __PASTE(__pci_fixup_##name,__LINE__) __used \
1833 __attribute__((__section__(#section), aligned((sizeof(void *))))) \
1834 = { vendor, device, class, class_shift, hook };
1835
1836 #define DECLARE_PCI_FIXUP_CLASS_EARLY(vendor, device, class, \
1837 class_shift, hook) \
1838 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early, \
1839 hook, vendor, device, class, class_shift, hook)
1840 #define DECLARE_PCI_FIXUP_CLASS_HEADER(vendor, device, class, \
1841 class_shift, hook) \
1842 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header, \
1843 hook, vendor, device, class, class_shift, hook)
1844 #define DECLARE_PCI_FIXUP_CLASS_FINAL(vendor, device, class, \
1845 class_shift, hook) \
1846 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final, \
1847 hook, vendor, device, class, class_shift, hook)
1848 #define DECLARE_PCI_FIXUP_CLASS_ENABLE(vendor, device, class, \
1849 class_shift, hook) \
1850 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable, \
1851 hook, vendor, device, class, class_shift, hook)
1852 #define DECLARE_PCI_FIXUP_CLASS_RESUME(vendor, device, class, \
1853 class_shift, hook) \
1854 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume, \
1855 resume##hook, vendor, device, class, \
1856 class_shift, hook)
1857 #define DECLARE_PCI_FIXUP_CLASS_RESUME_EARLY(vendor, device, class, \
1858 class_shift, hook) \
1859 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early, \
1860 resume_early##hook, vendor, device, \
1861 class, class_shift, hook)
1862 #define DECLARE_PCI_FIXUP_CLASS_SUSPEND(vendor, device, class, \
1863 class_shift, hook) \
1864 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend, \
1865 suspend##hook, vendor, device, class, \
1866 class_shift, hook)
1867 #define DECLARE_PCI_FIXUP_CLASS_SUSPEND_LATE(vendor, device, class, \
1868 class_shift, hook) \
1869 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend_late, \
1870 suspend_late##hook, vendor, device, \
1871 class, class_shift, hook)
1872
1873 #define DECLARE_PCI_FIXUP_EARLY(vendor, device, hook) \
1874 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early, \
1875 hook, vendor, device, PCI_ANY_ID, 0, hook)
1876 #define DECLARE_PCI_FIXUP_HEADER(vendor, device, hook) \
1877 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header, \
1878 hook, vendor, device, PCI_ANY_ID, 0, hook)
1879 #define DECLARE_PCI_FIXUP_FINAL(vendor, device, hook) \
1880 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final, \
1881 hook, vendor, device, PCI_ANY_ID, 0, hook)
1882 #define DECLARE_PCI_FIXUP_ENABLE(vendor, device, hook) \
1883 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable, \
1884 hook, vendor, device, PCI_ANY_ID, 0, hook)
1885 #define DECLARE_PCI_FIXUP_RESUME(vendor, device, hook) \
1886 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume, \
1887 resume##hook, vendor, device, \
1888 PCI_ANY_ID, 0, hook)
1889 #define DECLARE_PCI_FIXUP_RESUME_EARLY(vendor, device, hook) \
1890 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early, \
1891 resume_early##hook, vendor, device, \
1892 PCI_ANY_ID, 0, hook)
1893 #define DECLARE_PCI_FIXUP_SUSPEND(vendor, device, hook) \
1894 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend, \
1895 suspend##hook, vendor, device, \
1896 PCI_ANY_ID, 0, hook)
1897 #define DECLARE_PCI_FIXUP_SUSPEND_LATE(vendor, device, hook) \
1898 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend_late, \
1899 suspend_late##hook, vendor, device, \
1900 PCI_ANY_ID, 0, hook)
1901
1902 #ifdef CONFIG_PCI_QUIRKS
1903 void pci_fixup_device(enum pci_fixup_pass pass, struct pci_dev *dev);
1904 int pci_dev_specific_acs_enabled(struct pci_dev *dev, u16 acs_flags);
1905 int pci_dev_specific_enable_acs(struct pci_dev *dev);
1906 #else
1907 static inline void pci_fixup_device(enum pci_fixup_pass pass,
1908 struct pci_dev *dev) { }
1909 static inline int pci_dev_specific_acs_enabled(struct pci_dev *dev,
1910 u16 acs_flags)
1911 {
1912 return -ENOTTY;
1913 }
1914 static inline int pci_dev_specific_enable_acs(struct pci_dev *dev)
1915 {
1916 return -ENOTTY;
1917 }
1918 #endif
1919
1920 void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen);
1921 void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr);
1922 void __iomem * const *pcim_iomap_table(struct pci_dev *pdev);
1923 int pcim_iomap_regions(struct pci_dev *pdev, int mask, const char *name);
1924 int pcim_iomap_regions_request_all(struct pci_dev *pdev, int mask,
1925 const char *name);
1926 void pcim_iounmap_regions(struct pci_dev *pdev, int mask);
1927
1928 extern int pci_pci_problems;
1929 #define PCIPCI_FAIL 1 /* No PCI PCI DMA */
1930 #define PCIPCI_TRITON 2
1931 #define PCIPCI_NATOMA 4
1932 #define PCIPCI_VIAETBF 8
1933 #define PCIPCI_VSFX 16
1934 #define PCIPCI_ALIMAGIK 32 /* Need low latency setting */
1935 #define PCIAGP_FAIL 64 /* No PCI to AGP DMA */
1936
1937 extern unsigned long pci_cardbus_io_size;
1938 extern unsigned long pci_cardbus_mem_size;
1939 extern u8 pci_dfl_cache_line_size;
1940 extern u8 pci_cache_line_size;
1941
1942 extern unsigned long pci_hotplug_io_size;
1943 extern unsigned long pci_hotplug_mem_size;
1944 extern unsigned long pci_hotplug_bus_size;
1945
1946 /* Architecture-specific versions may override these (weak) */
1947 void pcibios_disable_device(struct pci_dev *dev);
1948 void pcibios_set_master(struct pci_dev *dev);
1949 int pcibios_set_pcie_reset_state(struct pci_dev *dev,
1950 enum pcie_reset_state state);
1951 int pcibios_add_device(struct pci_dev *dev);
1952 void pcibios_release_device(struct pci_dev *dev);
1953 void pcibios_penalize_isa_irq(int irq, int active);
1954 int pcibios_alloc_irq(struct pci_dev *dev);
1955 void pcibios_free_irq(struct pci_dev *dev);
1956
1957 #ifdef CONFIG_HIBERNATE_CALLBACKS
1958 extern struct dev_pm_ops pcibios_pm_ops;
1959 #endif
1960
1961 #if defined(CONFIG_PCI_MMCONFIG) || defined(CONFIG_ACPI_MCFG)
1962 void __init pci_mmcfg_early_init(void);
1963 void __init pci_mmcfg_late_init(void);
1964 #else
1965 static inline void pci_mmcfg_early_init(void) { }
1966 static inline void pci_mmcfg_late_init(void) { }
1967 #endif
1968
1969 int pci_ext_cfg_avail(void);
1970
1971 void __iomem *pci_ioremap_bar(struct pci_dev *pdev, int bar);
1972 void __iomem *pci_ioremap_wc_bar(struct pci_dev *pdev, int bar);
1973
1974 #ifdef CONFIG_PCI_IOV
1975 int pci_iov_virtfn_bus(struct pci_dev *dev, int id);
1976 int pci_iov_virtfn_devfn(struct pci_dev *dev, int id);
1977
1978 int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn);
1979 void pci_disable_sriov(struct pci_dev *dev);
1980 int pci_iov_add_virtfn(struct pci_dev *dev, int id);
1981 void pci_iov_remove_virtfn(struct pci_dev *dev, int id);
1982 int pci_num_vf(struct pci_dev *dev);
1983 int pci_vfs_assigned(struct pci_dev *dev);
1984 int pci_sriov_set_totalvfs(struct pci_dev *dev, u16 numvfs);
1985 int pci_sriov_get_totalvfs(struct pci_dev *dev);
1986 resource_size_t pci_iov_resource_size(struct pci_dev *dev, int resno);
1987 #else
1988 static inline int pci_iov_virtfn_bus(struct pci_dev *dev, int id)
1989 {
1990 return -ENOSYS;
1991 }
1992 static inline int pci_iov_virtfn_devfn(struct pci_dev *dev, int id)
1993 {
1994 return -ENOSYS;
1995 }
1996 static inline int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn)
1997 { return -ENODEV; }
1998 static inline int pci_iov_add_virtfn(struct pci_dev *dev, int id)
1999 {
2000 return -ENOSYS;
2001 }
2002 static inline void pci_iov_remove_virtfn(struct pci_dev *dev,
2003 int id) { }
2004 static inline void pci_disable_sriov(struct pci_dev *dev) { }
2005 static inline int pci_num_vf(struct pci_dev *dev) { return 0; }
2006 static inline int pci_vfs_assigned(struct pci_dev *dev)
2007 { return 0; }
2008 static inline int pci_sriov_set_totalvfs(struct pci_dev *dev, u16 numvfs)
2009 { return 0; }
2010 static inline int pci_sriov_get_totalvfs(struct pci_dev *dev)
2011 { return 0; }
2012 static inline resource_size_t pci_iov_resource_size(struct pci_dev *dev, int resno)
2013 { return 0; }
2014 #endif
2015
2016 #if defined(CONFIG_HOTPLUG_PCI) || defined(CONFIG_HOTPLUG_PCI_MODULE)
2017 void pci_hp_create_module_link(struct pci_slot *pci_slot);
2018 void pci_hp_remove_module_link(struct pci_slot *pci_slot);
2019 #endif
2020
2021 /**
2022 * pci_pcie_cap - get the saved PCIe capability offset
2023 * @dev: PCI device
2024 *
2025 * PCIe capability offset is calculated at PCI device initialization
2026 * time and saved in the data structure. This function returns saved
2027 * PCIe capability offset. Using this instead of pci_find_capability()
2028 * reduces unnecessary search in the PCI configuration space. If you
2029 * need to calculate PCIe capability offset from raw device for some
2030 * reasons, please use pci_find_capability() instead.
2031 */
2032 static inline int pci_pcie_cap(struct pci_dev *dev)
2033 {
2034 return dev->pcie_cap;
2035 }
2036
2037 /**
2038 * pci_is_pcie - check if the PCI device is PCI Express capable
2039 * @dev: PCI device
2040 *
2041 * Returns: true if the PCI device is PCI Express capable, false otherwise.
2042 */
2043 static inline bool pci_is_pcie(struct pci_dev *dev)
2044 {
2045 return pci_pcie_cap(dev);
2046 }
2047
2048 /**
2049 * pcie_caps_reg - get the PCIe Capabilities Register
2050 * @dev: PCI device
2051 */
2052 static inline u16 pcie_caps_reg(const struct pci_dev *dev)
2053 {
2054 return dev->pcie_flags_reg;
2055 }
2056
2057 /**
2058 * pci_pcie_type - get the PCIe device/port type
2059 * @dev: PCI device
2060 */
2061 static inline int pci_pcie_type(const struct pci_dev *dev)
2062 {
2063 return (pcie_caps_reg(dev) & PCI_EXP_FLAGS_TYPE) >> 4;
2064 }
2065
2066 static inline struct pci_dev *pcie_find_root_port(struct pci_dev *dev)
2067 {
2068 while (1) {
2069 if (!pci_is_pcie(dev))
2070 break;
2071 if (pci_pcie_type(dev) == PCI_EXP_TYPE_ROOT_PORT)
2072 return dev;
2073 if (!dev->bus->self)
2074 break;
2075 dev = dev->bus->self;
2076 }
2077 return NULL;
2078 }
2079
2080 void pci_request_acs(void);
2081 bool pci_acs_enabled(struct pci_dev *pdev, u16 acs_flags);
2082 bool pci_acs_path_enabled(struct pci_dev *start,
2083 struct pci_dev *end, u16 acs_flags);
2084
2085 #define PCI_VPD_LRDT 0x80 /* Large Resource Data Type */
2086 #define PCI_VPD_LRDT_ID(x) ((x) | PCI_VPD_LRDT)
2087
2088 /* Large Resource Data Type Tag Item Names */
2089 #define PCI_VPD_LTIN_ID_STRING 0x02 /* Identifier String */
2090 #define PCI_VPD_LTIN_RO_DATA 0x10 /* Read-Only Data */
2091 #define PCI_VPD_LTIN_RW_DATA 0x11 /* Read-Write Data */
2092
2093 #define PCI_VPD_LRDT_ID_STRING PCI_VPD_LRDT_ID(PCI_VPD_LTIN_ID_STRING)
2094 #define PCI_VPD_LRDT_RO_DATA PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RO_DATA)
2095 #define PCI_VPD_LRDT_RW_DATA PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RW_DATA)
2096
2097 /* Small Resource Data Type Tag Item Names */
2098 #define PCI_VPD_STIN_END 0x0f /* End */
2099
2100 #define PCI_VPD_SRDT_END (PCI_VPD_STIN_END << 3)
2101
2102 #define PCI_VPD_SRDT_TIN_MASK 0x78
2103 #define PCI_VPD_SRDT_LEN_MASK 0x07
2104 #define PCI_VPD_LRDT_TIN_MASK 0x7f
2105
2106 #define PCI_VPD_LRDT_TAG_SIZE 3
2107 #define PCI_VPD_SRDT_TAG_SIZE 1
2108
2109 #define PCI_VPD_INFO_FLD_HDR_SIZE 3
2110
2111 #define PCI_VPD_RO_KEYWORD_PARTNO "PN"
2112 #define PCI_VPD_RO_KEYWORD_MFR_ID "MN"
2113 #define PCI_VPD_RO_KEYWORD_VENDOR0 "V0"
2114 #define PCI_VPD_RO_KEYWORD_CHKSUM "RV"
2115
2116 /**
2117 * pci_vpd_lrdt_size - Extracts the Large Resource Data Type length
2118 * @lrdt: Pointer to the beginning of the Large Resource Data Type tag
2119 *
2120 * Returns the extracted Large Resource Data Type length.
2121 */
2122 static inline u16 pci_vpd_lrdt_size(const u8 *lrdt)
2123 {
2124 return (u16)lrdt[1] + ((u16)lrdt[2] << 8);
2125 }
2126
2127 /**
2128 * pci_vpd_lrdt_tag - Extracts the Large Resource Data Type Tag Item
2129 * @lrdt: Pointer to the beginning of the Large Resource Data Type tag
2130 *
2131 * Returns the extracted Large Resource Data Type Tag item.
2132 */
2133 static inline u16 pci_vpd_lrdt_tag(const u8 *lrdt)
2134 {
2135 return (u16)(lrdt[0] & PCI_VPD_LRDT_TIN_MASK);
2136 }
2137
2138 /**
2139 * pci_vpd_srdt_size - Extracts the Small Resource Data Type length
2140 * @srdt: Pointer to the beginning of the Small Resource Data Type tag
2141 *
2142 * Returns the extracted Small Resource Data Type length.
2143 */
2144 static inline u8 pci_vpd_srdt_size(const u8 *srdt)
2145 {
2146 return (*srdt) & PCI_VPD_SRDT_LEN_MASK;
2147 }
2148
2149 /**
2150 * pci_vpd_srdt_tag - Extracts the Small Resource Data Type Tag Item
2151 * @srdt: Pointer to the beginning of the Small Resource Data Type tag
2152 *
2153 * Returns the extracted Small Resource Data Type Tag Item.
2154 */
2155 static inline u8 pci_vpd_srdt_tag(const u8 *srdt)
2156 {
2157 return ((*srdt) & PCI_VPD_SRDT_TIN_MASK) >> 3;
2158 }
2159
2160 /**
2161 * pci_vpd_info_field_size - Extracts the information field length
2162 * @lrdt: Pointer to the beginning of an information field header
2163 *
2164 * Returns the extracted information field length.
2165 */
2166 static inline u8 pci_vpd_info_field_size(const u8 *info_field)
2167 {
2168 return info_field[2];
2169 }
2170
2171 /**
2172 * pci_vpd_find_tag - Locates the Resource Data Type tag provided
2173 * @buf: Pointer to buffered vpd data
2174 * @off: The offset into the buffer at which to begin the search
2175 * @len: The length of the vpd buffer
2176 * @rdt: The Resource Data Type to search for
2177 *
2178 * Returns the index where the Resource Data Type was found or
2179 * -ENOENT otherwise.
2180 */
2181 int pci_vpd_find_tag(const u8 *buf, unsigned int off, unsigned int len, u8 rdt);
2182
2183 /**
2184 * pci_vpd_find_info_keyword - Locates an information field keyword in the VPD
2185 * @buf: Pointer to buffered vpd data
2186 * @off: The offset into the buffer at which to begin the search
2187 * @len: The length of the buffer area, relative to off, in which to search
2188 * @kw: The keyword to search for
2189 *
2190 * Returns the index where the information field keyword was found or
2191 * -ENOENT otherwise.
2192 */
2193 int pci_vpd_find_info_keyword(const u8 *buf, unsigned int off,
2194 unsigned int len, const char *kw);
2195
2196 /* PCI <-> OF binding helpers */
2197 #ifdef CONFIG_OF
2198 struct device_node;
2199 struct irq_domain;
2200 void pci_set_of_node(struct pci_dev *dev);
2201 void pci_release_of_node(struct pci_dev *dev);
2202 void pci_set_bus_of_node(struct pci_bus *bus);
2203 void pci_release_bus_of_node(struct pci_bus *bus);
2204 struct irq_domain *pci_host_bridge_of_msi_domain(struct pci_bus *bus);
2205
2206 /* Arch may override this (weak) */
2207 struct device_node *pcibios_get_phb_of_node(struct pci_bus *bus);
2208
2209 static inline struct device_node *
2210 pci_device_to_OF_node(const struct pci_dev *pdev)
2211 {
2212 return pdev ? pdev->dev.of_node : NULL;
2213 }
2214
2215 static inline struct device_node *pci_bus_to_OF_node(struct pci_bus *bus)
2216 {
2217 return bus ? bus->dev.of_node : NULL;
2218 }
2219
2220 #else /* CONFIG_OF */
2221 static inline void pci_set_of_node(struct pci_dev *dev) { }
2222 static inline void pci_release_of_node(struct pci_dev *dev) { }
2223 static inline void pci_set_bus_of_node(struct pci_bus *bus) { }
2224 static inline void pci_release_bus_of_node(struct pci_bus *bus) { }
2225 static inline struct device_node *
2226 pci_device_to_OF_node(const struct pci_dev *pdev) { return NULL; }
2227 static inline struct irq_domain *
2228 pci_host_bridge_of_msi_domain(struct pci_bus *bus) { return NULL; }
2229 #endif /* CONFIG_OF */
2230
2231 #ifdef CONFIG_ACPI
2232 struct irq_domain *pci_host_bridge_acpi_msi_domain(struct pci_bus *bus);
2233
2234 void
2235 pci_msi_register_fwnode_provider(struct fwnode_handle *(*fn)(struct device *));
2236 #else
2237 static inline struct irq_domain *
2238 pci_host_bridge_acpi_msi_domain(struct pci_bus *bus) { return NULL; }
2239 #endif
2240
2241 #ifdef CONFIG_EEH
2242 static inline struct eeh_dev *pci_dev_to_eeh_dev(struct pci_dev *pdev)
2243 {
2244 return pdev->dev.archdata.edev;
2245 }
2246 #endif
2247
2248 void pci_add_dma_alias(struct pci_dev *dev, u8 devfn);
2249 bool pci_devs_are_dma_aliases(struct pci_dev *dev1, struct pci_dev *dev2);
2250 int pci_for_each_dma_alias(struct pci_dev *pdev,
2251 int (*fn)(struct pci_dev *pdev,
2252 u16 alias, void *data), void *data);
2253
2254 /* helper functions for operation of device flag */
2255 static inline void pci_set_dev_assigned(struct pci_dev *pdev)
2256 {
2257 pdev->dev_flags |= PCI_DEV_FLAGS_ASSIGNED;
2258 }
2259 static inline void pci_clear_dev_assigned(struct pci_dev *pdev)
2260 {
2261 pdev->dev_flags &= ~PCI_DEV_FLAGS_ASSIGNED;
2262 }
2263 static inline bool pci_is_dev_assigned(struct pci_dev *pdev)
2264 {
2265 return (pdev->dev_flags & PCI_DEV_FLAGS_ASSIGNED) == PCI_DEV_FLAGS_ASSIGNED;
2266 }
2267
2268 /**
2269 * pci_ari_enabled - query ARI forwarding status
2270 * @bus: the PCI bus
2271 *
2272 * Returns true if ARI forwarding is enabled.
2273 */
2274 static inline bool pci_ari_enabled(struct pci_bus *bus)
2275 {
2276 return bus->self && bus->self->ari_enabled;
2277 }
2278
2279 /**
2280 * pci_is_thunderbolt_attached - whether device is on a Thunderbolt daisy chain
2281 * @pdev: PCI device to check
2282 *
2283 * Walk upwards from @pdev and check for each encountered bridge if it's part
2284 * of a Thunderbolt controller. Reaching the host bridge means @pdev is not
2285 * Thunderbolt-attached. (But rather soldered to the mainboard usually.)
2286 */
2287 static inline bool pci_is_thunderbolt_attached(struct pci_dev *pdev)
2288 {
2289 struct pci_dev *parent = pdev;
2290
2291 if (pdev->is_thunderbolt)
2292 return true;
2293
2294 while ((parent = pci_upstream_bridge(parent)))
2295 if (parent->is_thunderbolt)
2296 return true;
2297
2298 return false;
2299 }
2300
2301 /* provide the legacy pci_dma_* API */
2302 #include <linux/pci-dma-compat.h>
2303
2304 #endif /* LINUX_PCI_H */