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