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