include/linux/pci.h

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