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