include/linux/pci.h

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