Pileus Git - ~andy/linux/blob - include/linux/pci.h

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