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