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