include/linux/pci.h

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