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