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