include/linux/pci.h

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