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