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