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