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