include/linux/pci.h

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