include/linux/pci.h

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