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