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