include/linux/pci.h

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