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