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