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