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