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