OSDN Git Service

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