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