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
  17 #ifndef LINUX_PCI_H
  18 #define LINUX_PCI_H
  19
  20 /* Include the pci register defines */
  21 #include <linux/pci_regs.h>
  22
  23 /*
  24  * The PCI interface treats multi-function devices as independent
  25  * devices.  The slot/function address of each device is encoded
  26  * in a single byte as follows:
  27  *
  28  *      7:3 = slot
  29  *      2:0 = function
  30  */
  31 #define PCI_DEVFN(slot, func)   ((((slot) & 0x1f) << 3) | ((func) & 0x07))
  32 #define PCI_SLOT(devfn)         (((devfn) >> 3) & 0x1f)
  33 #define PCI_FUNC(devfn)         ((devfn) & 0x07)
  34
  35 /* Ioctls for /proc/bus/pci/X/Y nodes. */
  36 #define PCIIOC_BASE             ('P' << 24 | 'C' << 16 | 'I' << 8)
  37 #define PCIIOC_CONTROLLER       (PCIIOC_BASE | 0x00)    /* Get controller for PCI device. */
  38 #define PCIIOC_MMAP_IS_IO       (PCIIOC_BASE | 0x01)    /* Set mmap state to I/O space. */
  39 #define PCIIOC_MMAP_IS_MEM      (PCIIOC_BASE | 0x02)    /* Set mmap state to MEM space. */
  40 #define PCIIOC_WRITE_COMBINE    (PCIIOC_BASE | 0x03)    /* Enable/disable write-combining. */
  41
  42 #ifdef __KERNEL__
  43
  44 #include <linux/mod_devicetable.h>
  45
  46 #include <linux/types.h>
  47 #include <linux/init.h>
  48 #include <linux/ioport.h>
  49 #include <linux/list.h>
  50 #include <linux/compiler.h>
  51 #include <linux/errno.h>
  52 #include <asm/atomic.h>
  53 #include <linux/device.h>
  54
  55 /* Include the ID list */
  56 #include <linux/pci_ids.h>
  57
  58 /* File state for mmap()s on /proc/bus/pci/X/Y */
  59 enum pci_mmap_state {
  60         pci_mmap_io,
  61         pci_mmap_mem
  62 };
  63
  64 /* This defines the direction arg to the DMA mapping routines. */
  65 #define PCI_DMA_BIDIRECTIONAL   0
  66 #define PCI_DMA_TODEVICE        1
  67 #define PCI_DMA_FROMDEVICE      2
  68 #define PCI_DMA_NONE            3
  69
  70 #define DEVICE_COUNT_RESOURCE   12
  71
  72 typedef int __bitwise pci_power_t;
  73
  74 #define PCI_D0          ((pci_power_t __force) 0)
  75 #define PCI_D1          ((pci_power_t __force) 1)
  76 #define PCI_D2          ((pci_power_t __force) 2)
  77 #define PCI_D3hot       ((pci_power_t __force) 3)
  78 #define PCI_D3cold      ((pci_power_t __force) 4)
  79 #define PCI_UNKNOWN     ((pci_power_t __force) 5)
  80 #define PCI_POWER_ERROR ((pci_power_t __force) -1)
  81
  82 /** The pci_channel state describes connectivity between the CPU and
  83  *  the pci device.  If some PCI bus between here and the pci device
  84  *  has crashed or locked up, this info is reflected here.
  85  */
  86 typedef unsigned int __bitwise pci_channel_state_t;
  87
  88 enum pci_channel_state {
  89         /* I/O channel is in normal state */
  90         pci_channel_io_normal = (__force pci_channel_state_t) 1,
  91
  92         /* I/O to channel is blocked */
  93         pci_channel_io_frozen = (__force pci_channel_state_t) 2,
  94
  95         /* PCI card is dead */
  96         pci_channel_io_perm_failure = (__force pci_channel_state_t) 3,
  97 };
  98
  99 typedef unsigned int __bitwise pcie_reset_state_t;
 100
 101 enum pcie_reset_state {
 102         /* Reset is NOT asserted (Use to deassert reset) */
 103         pcie_deassert_reset = (__force pcie_reset_state_t) 1,
 104
 105         /* Use #PERST to reset PCI-E device */
 106         pcie_warm_reset = (__force pcie_reset_state_t) 2,
 107
 108         /* Use PCI-E Hot Reset to reset device */
 109         pcie_hot_reset = (__force pcie_reset_state_t) 3
 110 };
 111
 112 typedef unsigned short __bitwise pci_dev_flags_t;
 113 enum pci_dev_flags {
 114         /* INTX_DISABLE in PCI_COMMAND register disables MSI
 115          * generation too.
 116          */
 117         PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG = (__force pci_dev_flags_t) 1,
 118 };
 119
 120 enum pci_irq_reroute_variant {
 121         INTEL_IRQ_REROUTE_VARIANT = 1,
 122         MAX_IRQ_REROUTE_VARIANTS = 3
 123 };
 124
 125 typedef unsigned short __bitwise pci_bus_flags_t;
 126 enum pci_bus_flags {
 127         PCI_BUS_FLAGS_NO_MSI   = (__force pci_bus_flags_t) 1,
 128         PCI_BUS_FLAGS_NO_MMRBC = (__force pci_bus_flags_t) 2,
 129 };
 130
 131 struct pci_cap_saved_state {
 132         struct hlist_node next;
 133         char cap_nr;
 134         u32 data[0];
 135 };
 136
 137 struct pcie_link_state;
 138 struct pci_vpd;
 139
 140 /*
 141  * The pci_dev structure is used to describe PCI devices.
 142  */
 143 struct pci_dev {
 144         struct list_head bus_list;      /* node in per-bus list */
 145         struct pci_bus  *bus;           /* bus this device is on */
 146         struct pci_bus  *subordinate;   /* bus this device bridges to */
 147
 148         void            *sysdata;       /* hook for sys-specific extension */
 149         struct proc_dir_entry *procent; /* device entry in /proc/bus/pci */
 150
 151         unsigned int    devfn;          /* encoded device & function index */
 152         unsigned short  vendor;
 153         unsigned short  device;
 154         unsigned short  subsystem_vendor;
 155         unsigned short  subsystem_device;
 156         unsigned int    class;          /* 3 bytes: (base,sub,prog-if) */
 157         u8              revision;       /* PCI revision, low byte of class word */
 158         u8              hdr_type;       /* PCI header type (`multi' flag masked out) */
 159         u8              pcie_type;      /* PCI-E device/port type */
 160         u8              rom_base_reg;   /* which config register controls the ROM */
 161         u8              pin;            /* which interrupt pin this device uses */
 162
 163         struct pci_driver *driver;      /* which driver has allocated this device */
 164         u64             dma_mask;       /* Mask of the bits of bus address this
 165                                            device implements.  Normally this is
 166                                            0xffffffff.  You only need to change
 167                                            this if your device has broken DMA
 168                                            or supports 64-bit transfers.  */
 169
 170         struct device_dma_parameters dma_parms;
 171
 172         pci_power_t     current_state;  /* Current operating state. In ACPI-speak,
 173                                            this is D0-D3, D0 being fully functional,
 174                                            and D3 being off. */
 175
 176 #ifdef CONFIG_PCIEASPM
 177         struct pcie_link_state  *link_state;    /* ASPM link state. */
 178 #endif
 179
 180         pci_channel_state_t error_state;        /* current connectivity state */
 181         struct  device  dev;            /* Generic device interface */
 182
 183         int             cfg_size;       /* Size of configuration space */
 184
 185         /*
 186          * Instead of touching interrupt line and base address registers
 187          * directly, use the values stored here. They might be different!
 188          */
 189         unsigned int    irq;
 190         struct resource resource[DEVICE_COUNT_RESOURCE]; /* I/O and memory regions + expansion ROMs */
 191
 192         /* These fields are used by common fixups */
 193         unsigned int    transparent:1;  /* Transparent PCI bridge */
 194         unsigned int    multifunction:1;/* Part of multi-function device */
 195         /* keep track of device state */
 196         unsigned int    is_added:1;
 197         unsigned int    is_busmaster:1; /* device is busmaster */
 198         unsigned int    no_msi:1;       /* device may not use msi */
 199         unsigned int    no_d1d2:1;   /* only allow d0 or d3 */
 200         unsigned int    block_ucfg_access:1;    /* userspace config space access is blocked */
 201         unsigned int    broken_parity_status:1; /* Device generates false positive parity */
 202         unsigned int    irq_reroute_variant:2;  /* device needs IRQ rerouting variant */
 203         unsigned int    msi_enabled:1;
 204         unsigned int    msix_enabled:1;
 205         unsigned int    is_managed:1;
 206         unsigned int    is_pcie:1;
 207         pci_dev_flags_t dev_flags;
 208         atomic_t        enable_cnt;     /* pci_enable_device has been called */
 209
 210         u32             saved_config_space[16]; /* config space saved at suspend time */
 211         struct hlist_head saved_cap_space;
 212         struct bin_attribute *rom_attr; /* attribute descriptor for sysfs ROM entry */
 213         int rom_attr_enabled;           /* has display of the rom attribute been enabled? */
 214         struct bin_attribute *res_attr[DEVICE_COUNT_RESOURCE]; /* sysfs file for resources */
 215         struct bin_attribute *res_attr_wc[DEVICE_COUNT_RESOURCE]; /* sysfs file for WC mapping of resources */
 216 #ifdef CONFIG_PCI_MSI
 217         struct list_head msi_list;
 218 #endif
 219         struct pci_vpd *vpd;
 220 };
 221
 222 extern struct pci_dev *alloc_pci_dev(void);
 223
 224 #define pci_dev_b(n) list_entry(n, struct pci_dev, bus_list)
 225 #define to_pci_dev(n) container_of(n, struct pci_dev, dev)
 226 #define for_each_pci_dev(d) while ((d = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, d)) != NULL)
 227
 228 static inline int pci_channel_offline(struct pci_dev *pdev)
 229 {
 230         return (pdev->error_state != pci_channel_io_normal);
 231 }
 232
 233 static inline struct pci_cap_saved_state *pci_find_saved_cap(
 234         struct pci_dev *pci_dev, char cap)
 235 {
 236         struct pci_cap_saved_state *tmp;
 237         struct hlist_node *pos;
 238
 239         hlist_for_each_entry(tmp, pos, &pci_dev->saved_cap_space, next) {
 240                 if (tmp->cap_nr == cap)
 241                         return tmp;
 242         }
 243         return NULL;
 244 }
 245
 246 static inline void pci_add_saved_cap(struct pci_dev *pci_dev,
 247         struct pci_cap_saved_state *new_cap)
 248 {
 249         hlist_add_head(&new_cap->next, &pci_dev->saved_cap_space);
 250 }
 251
 252 /*
 253  *  For PCI devices, the region numbers are assigned this way:
 254  *
 255  *      0-5     standard PCI regions
 256  *      6       expansion ROM
 257  *      7-10    bridges: address space assigned to buses behind the bridge
 258  */
 259
 260 #define PCI_ROM_RESOURCE        6
 261 #define PCI_BRIDGE_RESOURCES    7
 262 #define PCI_NUM_RESOURCES       11
 263
 264 #ifndef PCI_BUS_NUM_RESOURCES
 265 #define PCI_BUS_NUM_RESOURCES   16
 266 #endif
 267
 268 #define PCI_REGION_FLAG_MASK    0x0fU   /* These bits of resource flags tell us the PCI region flags */
 269
 270 struct pci_bus {
 271         struct list_head node;          /* node in list of buses */
 272         struct pci_bus  *parent;        /* parent bus this bridge is on */
 273         struct list_head children;      /* list of child buses */
 274         struct list_head devices;       /* list of devices on this bus */
 275         struct pci_dev  *self;          /* bridge device as seen by parent */
 276         struct resource *resource[PCI_BUS_NUM_RESOURCES];
 277                                         /* address space routed to this bus */
 278
 279         struct pci_ops  *ops;           /* configuration access functions */
 280         void            *sysdata;       /* hook for sys-specific extension */
 281         struct proc_dir_entry *procdir; /* directory entry in /proc/bus/pci */
 282
 283         unsigned char   number;         /* bus number */
 284         unsigned char   primary;        /* number of primary bridge */
 285         unsigned char   secondary;      /* number of secondary bridge */
 286         unsigned char   subordinate;    /* max number of subordinate buses */
 287
 288         char            name[48];
 289
 290         unsigned short  bridge_ctl;     /* manage NO_ISA/FBB/et al behaviors */
 291         pci_bus_flags_t bus_flags;      /* Inherited by child busses */
 292         struct device           *bridge;
 293         struct device           dev;
 294         struct bin_attribute    *legacy_io; /* legacy I/O for this bus */
 295         struct bin_attribute    *legacy_mem; /* legacy mem */
 296         unsigned int            is_added:1;
 297 };
 298
 299 #define pci_bus_b(n)    list_entry(n, struct pci_bus, node)
 300 #define to_pci_bus(n)   container_of(n, struct pci_bus, dev)
 301
 302 /*
 303  * Error values that may be returned by PCI functions.
 304  */
 305 #define PCIBIOS_SUCCESSFUL              0x00
 306 #define PCIBIOS_FUNC_NOT_SUPPORTED      0x81
 307 #define PCIBIOS_BAD_VENDOR_ID           0x83
 308 #define PCIBIOS_DEVICE_NOT_FOUND        0x86
 309 #define PCIBIOS_BAD_REGISTER_NUMBER     0x87
 310 #define PCIBIOS_SET_FAILED              0x88
 311 #define PCIBIOS_BUFFER_TOO_SMALL        0x89
 312
 313 /* Low-level architecture-dependent routines */
 314
 315 struct pci_ops {
 316         int (*read)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 *val);
 317         int (*write)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 val);
 318 };
 319
 320 /*
 321  * ACPI needs to be able to access PCI config space before we've done a
 322  * PCI bus scan and created pci_bus structures.
 323  */
 324 extern int raw_pci_read(unsigned int domain, unsigned int bus,
 325                         unsigned int devfn, int reg, int len, u32 *val);
 326 extern int raw_pci_write(unsigned int domain, unsigned int bus,
 327                         unsigned int devfn, int reg, int len, u32 val);
 328
 329 struct pci_bus_region {
 330         resource_size_t start;
 331         resource_size_t end;
 332 };
 333
 334 struct pci_dynids {
 335         spinlock_t lock;            /* protects list, index */
 336         struct list_head list;      /* for IDs added at runtime */
 337         unsigned int use_driver_data:1; /* pci_driver->driver_data is used */
 338 };
 339
 340 /* ---------------------------------------------------------------- */
 341 /** PCI Error Recovery System (PCI-ERS).  If a PCI device driver provides
 342  *  a set of callbacks in struct pci_error_handlers, then that device driver
 343  *  will be notified of PCI bus errors, and will be driven to recovery
 344  *  when an error occurs.
 345  */
 346
 347 typedef unsigned int __bitwise pci_ers_result_t;
 348
 349 enum pci_ers_result {
 350         /* no result/none/not supported in device driver */
 351         PCI_ERS_RESULT_NONE = (__force pci_ers_result_t) 1,
 352
 353         /* Device driver can recover without slot reset */
 354         PCI_ERS_RESULT_CAN_RECOVER = (__force pci_ers_result_t) 2,
 355
 356         /* Device driver wants slot to be reset. */
 357         PCI_ERS_RESULT_NEED_RESET = (__force pci_ers_result_t) 3,
 358
 359         /* Device has completely failed, is unrecoverable */
 360         PCI_ERS_RESULT_DISCONNECT = (__force pci_ers_result_t) 4,
 361
 362         /* Device driver is fully recovered and operational */
 363         PCI_ERS_RESULT_RECOVERED = (__force pci_ers_result_t) 5,
 364 };
 365
 366 /* PCI bus error event callbacks */
 367 struct pci_error_handlers {
 368         /* PCI bus error detected on this device */
 369         pci_ers_result_t (*error_detected)(struct pci_dev *dev,
 370                                            enum pci_channel_state error);
 371
 372         /* MMIO has been re-enabled, but not DMA */
 373         pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev);
 374
 375         /* PCI Express link has been reset */
 376         pci_ers_result_t (*link_reset)(struct pci_dev *dev);
 377
 378         /* PCI slot has been reset */
 379         pci_ers_result_t (*slot_reset)(struct pci_dev *dev);
 380
 381         /* Device driver may resume normal operations */
 382         void (*resume)(struct pci_dev *dev);
 383 };
 384
 385 /* ---------------------------------------------------------------- */
 386
 387 struct module;
 388 struct pci_driver {
 389         struct list_head node;
 390         char *name;
 391         const struct pci_device_id *id_table;   /* must be non-NULL for probe to be called */
 392         int  (*probe)  (struct pci_dev *dev, const struct pci_device_id *id);   /* New device inserted */
 393         void (*remove) (struct pci_dev *dev);   /* Device removed (NULL if not a hot-plug capable driver) */
 394         int  (*suspend) (struct pci_dev *dev, pm_message_t state);      /* Device suspended */
 395         int  (*suspend_late) (struct pci_dev *dev, pm_message_t state);
 396         int  (*resume_early) (struct pci_dev *dev);
 397         int  (*resume) (struct pci_dev *dev);                   /* Device woken up */
 398         void (*shutdown) (struct pci_dev *dev);
 399
 400         struct pci_error_handlers *err_handler;
 401         struct device_driver    driver;
 402         struct pci_dynids dynids;
 403 };
 404
 405 #define to_pci_driver(drv) container_of(drv, struct pci_driver, driver)
 406
 407 /**
 408  * DEFINE_PCI_DEVICE_TABLE - macro used to describe a pci device table
 409  * @_table: device table name
 410  *
 411  * This macro is used to create a struct pci_device_id array (a device table)
 412  * in a generic manner.
 413  */
 414 #define DEFINE_PCI_DEVICE_TABLE(_table) \
 415         const struct pci_device_id _table[] __devinitconst
 416
 417 /**
 418  * PCI_DEVICE - macro used to describe a specific pci device
 419  * @vend: the 16 bit PCI Vendor ID
 420  * @dev: the 16 bit PCI Device ID
 421  *
 422  * This macro is used to create a struct pci_device_id that matches a
 423  * specific device.  The subvendor and subdevice fields will be set to
 424  * PCI_ANY_ID.
 425  */
 426 #define PCI_DEVICE(vend,dev) \
 427         .vendor = (vend), .device = (dev), \
 428         .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
 429
 430 /**
 431  * PCI_DEVICE_CLASS - macro used to describe a specific pci device class
 432  * @dev_class: the class, subclass, prog-if triple for this device
 433  * @dev_class_mask: the class mask for this device
 434  *
 435  * This macro is used to create a struct pci_device_id that matches a
 436  * specific PCI class.  The vendor, device, subvendor, and subdevice
 437  * fields will be set to PCI_ANY_ID.
 438  */
 439 #define PCI_DEVICE_CLASS(dev_class,dev_class_mask) \
 440         .class = (dev_class), .class_mask = (dev_class_mask), \
 441         .vendor = PCI_ANY_ID, .device = PCI_ANY_ID, \
 442         .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
 443
 444 /**
 445  * PCI_VDEVICE - macro used to describe a specific pci device in short form
 446  * @vend: the vendor name
 447  * @dev: the 16 bit PCI Device ID
 448  *
 449  * This macro is used to create a struct pci_device_id that matches a
 450  * specific PCI device.  The subvendor, and subdevice fields will be set
 451  * to PCI_ANY_ID. The macro allows the next field to follow as the device
 452  * private data.
 453  */
 454
 455 #define PCI_VDEVICE(vendor, device)             \
 456         PCI_VENDOR_ID_##vendor, (device),       \
 457         PCI_ANY_ID, PCI_ANY_ID, 0, 0
 458
 459 /* these external functions are only available when PCI support is enabled */
 460 #ifdef CONFIG_PCI
 461
 462 extern struct bus_type pci_bus_type;
 463
 464 /* Do NOT directly access these two variables, unless you are arch specific pci
 465  * code, or pci core code. */
 466 extern struct list_head pci_root_buses; /* list of all known PCI buses */
 467 /* Some device drivers need know if pci is initiated */
 468 extern int no_pci_devices(void);
 469
 470 void pcibios_fixup_bus(struct pci_bus *);
 471 int __must_check pcibios_enable_device(struct pci_dev *, int mask);
 472 char *pcibios_setup(char *str);
 473
 474 /* Used only when drivers/pci/setup.c is used */
 475 void pcibios_align_resource(void *, struct resource *, resource_size_t,
 476                                 resource_size_t);
 477 void pcibios_update_irq(struct pci_dev *, int irq);
 478
 479 /* Generic PCI functions used internally */
 480
 481 extern struct pci_bus *pci_find_bus(int domain, int busnr);
 482 void pci_bus_add_devices(struct pci_bus *bus);
 483 struct pci_bus *pci_scan_bus_parented(struct device *parent, int bus,
 484                                       struct pci_ops *ops, void *sysdata);
 485 static inline struct pci_bus * __devinit pci_scan_bus(int bus, struct pci_ops *ops,
 486                                            void *sysdata)
 487 {
 488         struct pci_bus *root_bus;
 489         root_bus = pci_scan_bus_parented(NULL, bus, ops, sysdata);
 490         if (root_bus)
 491                 pci_bus_add_devices(root_bus);
 492         return root_bus;
 493 }
 494 struct pci_bus *pci_create_bus(struct device *parent, int bus,
 495                                struct pci_ops *ops, void *sysdata);
 496 struct pci_bus *pci_add_new_bus(struct pci_bus *parent, struct pci_dev *dev,
 497                                 int busnr);
 498 int pci_scan_slot(struct pci_bus *bus, int devfn);
 499 struct pci_dev *pci_scan_single_device(struct pci_bus *bus, int devfn);
 500 void pci_device_add(struct pci_dev *dev, struct pci_bus *bus);
 501 unsigned int pci_scan_child_bus(struct pci_bus *bus);
 502 int __must_check pci_bus_add_device(struct pci_dev *dev);
 503 void pci_read_bridge_bases(struct pci_bus *child);
 504 struct resource *pci_find_parent_resource(const struct pci_dev *dev,
 505                                           struct resource *res);
 506 int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge);
 507 extern struct pci_dev *pci_dev_get(struct pci_dev *dev);
 508 extern void pci_dev_put(struct pci_dev *dev);
 509 extern void pci_remove_bus(struct pci_bus *b);
 510 extern void pci_remove_bus_device(struct pci_dev *dev);
 511 extern void pci_stop_bus_device(struct pci_dev *dev);
 512 void pci_setup_cardbus(struct pci_bus *bus);
 513 extern void pci_sort_breadthfirst(void);
 514
 515 /* Generic PCI functions exported to card drivers */
 516
 517 #ifdef CONFIG_PCI_LEGACY
 518 struct pci_dev __deprecated *pci_find_device(unsigned int vendor,
 519                                              unsigned int device,
 520                                              const struct pci_dev *from);
 521 struct pci_dev __deprecated *pci_find_slot(unsigned int bus,
 522                                            unsigned int devfn);
 523 #endif /* CONFIG_PCI_LEGACY */
 524
 525 int pci_find_capability(struct pci_dev *dev, int cap);
 526 int pci_find_next_capability(struct pci_dev *dev, u8 pos, int cap);
 527 int pci_find_ext_capability(struct pci_dev *dev, int cap);
 528 int pci_find_ht_capability(struct pci_dev *dev, int ht_cap);
 529 int pci_find_next_ht_capability(struct pci_dev *dev, int pos, int ht_cap);
 530 struct pci_bus *pci_find_next_bus(const struct pci_bus *from);
 531
 532 struct pci_dev *pci_get_device(unsigned int vendor, unsigned int device,
 533                                 struct pci_dev *from);
 534 struct pci_dev *pci_get_subsys(unsigned int vendor, unsigned int device,
 535                                 unsigned int ss_vendor, unsigned int ss_device,
 536                                 const struct pci_dev *from);
 537 struct pci_dev *pci_get_slot(struct pci_bus *bus, unsigned int devfn);
 538 struct pci_dev *pci_get_bus_and_slot(unsigned int bus, unsigned int devfn);
 539 struct pci_dev *pci_get_class(unsigned int class, struct pci_dev *from);
 540 int pci_dev_present(const struct pci_device_id *ids);
 541
 542 int pci_bus_read_config_byte(struct pci_bus *bus, unsigned int devfn,
 543                              int where, u8 *val);
 544 int pci_bus_read_config_word(struct pci_bus *bus, unsigned int devfn,
 545                              int where, u16 *val);
 546 int pci_bus_read_config_dword(struct pci_bus *bus, unsigned int devfn,
 547                               int where, u32 *val);
 548 int pci_bus_write_config_byte(struct pci_bus *bus, unsigned int devfn,
 549                               int where, u8 val);
 550 int pci_bus_write_config_word(struct pci_bus *bus, unsigned int devfn,
 551                               int where, u16 val);
 552 int pci_bus_write_config_dword(struct pci_bus *bus, unsigned int devfn,
 553                                int where, u32 val);
 554
 555 static inline int pci_read_config_byte(struct pci_dev *dev, int where, u8 *val)
 556 {
 557         return pci_bus_read_config_byte(dev->bus, dev->devfn, where, val);
 558 }
 559 static inline int pci_read_config_word(struct pci_dev *dev, int where, u16 *val)
 560 {
 561         return pci_bus_read_config_word(dev->bus, dev->devfn, where, val);
 562 }
 563 static inline int pci_read_config_dword(struct pci_dev *dev, int where,
 564                                         u32 *val)
 565 {
 566         return pci_bus_read_config_dword(dev->bus, dev->devfn, where, val);
 567 }
 568 static inline int pci_write_config_byte(struct pci_dev *dev, int where, u8 val)
 569 {
 570         return pci_bus_write_config_byte(dev->bus, dev->devfn, where, val);
 571 }
 572 static inline int pci_write_config_word(struct pci_dev *dev, int where, u16 val)
 573 {
 574         return pci_bus_write_config_word(dev->bus, dev->devfn, where, val);
 575 }
 576 static inline int pci_write_config_dword(struct pci_dev *dev, int where,
 577                                          u32 val)
 578 {
 579         return pci_bus_write_config_dword(dev->bus, dev->devfn, where, val);
 580 }
 581
 582 int __must_check pci_enable_device(struct pci_dev *dev);
 583 int __must_check pci_enable_device_io(struct pci_dev *dev);
 584 int __must_check pci_enable_device_mem(struct pci_dev *dev);
 585 int __must_check pci_reenable_device(struct pci_dev *);
 586 int __must_check pcim_enable_device(struct pci_dev *pdev);
 587 void pcim_pin_device(struct pci_dev *pdev);
 588
 589 static inline int pci_is_managed(struct pci_dev *pdev)
 590 {
 591         return pdev->is_managed;
 592 }
 593
 594 void pci_disable_device(struct pci_dev *dev);
 595 void pci_set_master(struct pci_dev *dev);
 596 int pci_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state);
 597 #define HAVE_PCI_SET_MWI
 598 int __must_check pci_set_mwi(struct pci_dev *dev);
 599 int pci_try_set_mwi(struct pci_dev *dev);
 600 void pci_clear_mwi(struct pci_dev *dev);
 601 void pci_intx(struct pci_dev *dev, int enable);
 602 void pci_msi_off(struct pci_dev *dev);
 603 int pci_set_dma_mask(struct pci_dev *dev, u64 mask);
 604 int pci_set_consistent_dma_mask(struct pci_dev *dev, u64 mask);
 605 int pci_set_dma_max_seg_size(struct pci_dev *dev, unsigned int size);
 606 int pci_set_dma_seg_boundary(struct pci_dev *dev, unsigned long mask);
 607 int pcix_get_max_mmrbc(struct pci_dev *dev);
 608 int pcix_get_mmrbc(struct pci_dev *dev);
 609 int pcix_set_mmrbc(struct pci_dev *dev, int mmrbc);
 610 int pcie_get_readrq(struct pci_dev *dev);
 611 int pcie_set_readrq(struct pci_dev *dev, int rq);
 612 void pci_update_resource(struct pci_dev *dev, struct resource *res, int resno);
 613 int __must_check pci_assign_resource(struct pci_dev *dev, int i);
 614 int pci_select_bars(struct pci_dev *dev, unsigned long flags);
 615
 616 /* ROM control related routines */
 617 void __iomem __must_check *pci_map_rom(struct pci_dev *pdev, size_t *size);
 618 void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom);
 619 size_t pci_get_rom_size(void __iomem *rom, size_t size);
 620
 621 /* Power management related routines */
 622 int pci_save_state(struct pci_dev *dev);
 623 int pci_restore_state(struct pci_dev *dev);
 624 int pci_set_power_state(struct pci_dev *dev, pci_power_t state);
 625 pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state);
 626 int pci_enable_wake(struct pci_dev *dev, pci_power_t state, int enable);
 627
 628 /* Functions for PCI Hotplug drivers to use */
 629 int pci_bus_find_capability(struct pci_bus *bus, unsigned int devfn, int cap);
 630
 631 /* Helper functions for low-level code (drivers/pci/setup-[bus,res].c) */
 632 void pci_bus_assign_resources(struct pci_bus *bus);
 633 void pci_bus_size_bridges(struct pci_bus *bus);
 634 int pci_claim_resource(struct pci_dev *, int);
 635 void pci_assign_unassigned_resources(void);
 636 void pdev_enable_device(struct pci_dev *);
 637 void pdev_sort_resources(struct pci_dev *, struct resource_list *);
 638 int pci_enable_resources(struct pci_dev *, int mask);
 639 void pci_fixup_irqs(u8 (*)(struct pci_dev *, u8 *),
 640                     int (*)(struct pci_dev *, u8, u8));
 641 #define HAVE_PCI_REQ_REGIONS    2
 642 int __must_check pci_request_regions(struct pci_dev *, const char *);
 643 void pci_release_regions(struct pci_dev *);
 644 int __must_check pci_request_region(struct pci_dev *, int, const char *);
 645 void pci_release_region(struct pci_dev *, int);
 646 int pci_request_selected_regions(struct pci_dev *, int, const char *);
 647 void pci_release_selected_regions(struct pci_dev *, int);
 648
 649 /* drivers/pci/bus.c */
 650 int __must_check pci_bus_alloc_resource(struct pci_bus *bus,
 651                         struct resource *res, resource_size_t size,
 652                         resource_size_t align, resource_size_t min,
 653                         unsigned int type_mask,
 654                         void (*alignf)(void *, struct resource *,
 655                                 resource_size_t, resource_size_t),
 656                         void *alignf_data);
 657 void pci_enable_bridges(struct pci_bus *bus);
 658
 659 /* Proper probing supporting hot-pluggable devices */
 660 int __must_check __pci_register_driver(struct pci_driver *, struct module *,
 661                                        const char *mod_name);
 662 static inline int __must_check pci_register_driver(struct pci_driver *driver)
 663 {
 664         return __pci_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
 665 }
 666
 667 void pci_unregister_driver(struct pci_driver *dev);
 668 void pci_remove_behind_bridge(struct pci_dev *dev);
 669 struct pci_driver *pci_dev_driver(const struct pci_dev *dev);
 670 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
 671                                          struct pci_dev *dev);
 672 int pci_scan_bridge(struct pci_bus *bus, struct pci_dev *dev, int max,
 673                     int pass);
 674
 675 void pci_walk_bus(struct pci_bus *top, void (*cb)(struct pci_dev *, void *),
 676                   void *userdata);
 677 int pci_cfg_space_size_ext(struct pci_dev *dev);
 678 int pci_cfg_space_size(struct pci_dev *dev);
 679 unsigned char pci_bus_max_busnr(struct pci_bus *bus);
 680
 681 /* kmem_cache style wrapper around pci_alloc_consistent() */
 682
 683 #include <linux/dmapool.h>
 684
 685 #define pci_pool dma_pool
 686 #define pci_pool_create(name, pdev, size, align, allocation) \
 687                 dma_pool_create(name, &pdev->dev, size, align, allocation)
 688 #define pci_pool_destroy(pool) dma_pool_destroy(pool)
 689 #define pci_pool_alloc(pool, flags, handle) dma_pool_alloc(pool, flags, handle)
 690 #define pci_pool_free(pool, vaddr, addr) dma_pool_free(pool, vaddr, addr)
 691
 692 enum pci_dma_burst_strategy {
 693         PCI_DMA_BURST_INFINITY, /* make bursts as large as possible,
 694                                    strategy_parameter is N/A */
 695         PCI_DMA_BURST_BOUNDARY, /* disconnect at every strategy_parameter
 696                                    byte boundaries */
 697         PCI_DMA_BURST_MULTIPLE, /* disconnect at some multiple of
 698                                    strategy_parameter byte boundaries */
 699 };
 700
 701 struct msix_entry {
 702         u16     vector; /* kernel uses to write allocated vector */
 703         u16     entry;  /* driver uses to specify entry, OS writes */
 704 };
 705
 706
 707 #ifndef CONFIG_PCI_MSI
 708 static inline int pci_enable_msi(struct pci_dev *dev)
 709 {
 710         return -1;
 711 }
 712
 713 static inline void pci_msi_shutdown(struct pci_dev *dev)
 714 { }
 715 static inline void pci_disable_msi(struct pci_dev *dev)
 716 { }
 717
 718 static inline int pci_enable_msix(struct pci_dev *dev,
 719                                   struct msix_entry *entries, int nvec)
 720 {
 721         return -1;
 722 }
 723
 724 static inline void pci_msix_shutdown(struct pci_dev *dev)
 725 { }
 726 static inline void pci_disable_msix(struct pci_dev *dev)
 727 { }
 728
 729 static inline void msi_remove_pci_irq_vectors(struct pci_dev *dev)
 730 { }
 731
 732 static inline void pci_restore_msi_state(struct pci_dev *dev)
 733 { }
 734 #else
 735 extern int pci_enable_msi(struct pci_dev *dev);
 736 extern void pci_msi_shutdown(struct pci_dev *dev);
 737 extern void pci_disable_msi(struct pci_dev *dev);
 738 extern int pci_enable_msix(struct pci_dev *dev,
 739         struct msix_entry *entries, int nvec);
 740 extern void pci_msix_shutdown(struct pci_dev *dev);
 741 extern void pci_disable_msix(struct pci_dev *dev);
 742 extern void msi_remove_pci_irq_vectors(struct pci_dev *dev);
 743 extern void pci_restore_msi_state(struct pci_dev *dev);
 744 #endif
 745
 746 #ifdef CONFIG_HT_IRQ
 747 /* The functions a driver should call */
 748 int  ht_create_irq(struct pci_dev *dev, int idx);
 749 void ht_destroy_irq(unsigned int irq);
 750 #endif /* CONFIG_HT_IRQ */
 751
 752 extern void pci_block_user_cfg_access(struct pci_dev *dev);
 753 extern void pci_unblock_user_cfg_access(struct pci_dev *dev);
 754
 755 /*
 756  * PCI domain support.  Sometimes called PCI segment (eg by ACPI),
 757  * a PCI domain is defined to be a set of PCI busses which share
 758  * configuration space.
 759  */
 760 #ifdef CONFIG_PCI_DOMAINS
 761 extern int pci_domains_supported;
 762 #else
 763 enum { pci_domains_supported = 0 };
 764 static inline int pci_domain_nr(struct pci_bus *bus)
 765 {
 766         return 0;
 767 }
 768
 769 static inline int pci_proc_domain(struct pci_bus *bus)
 770 {
 771         return 0;
 772 }
 773 #endif /* CONFIG_PCI_DOMAINS */
 774
 775 #else /* CONFIG_PCI is not enabled */
 776
 777 /*
 778  *  If the system does not have PCI, clearly these return errors.  Define
 779  *  these as simple inline functions to avoid hair in drivers.
 780  */
 781
 782 #define _PCI_NOP(o, s, t) \
 783         static inline int pci_##o##_config_##s(struct pci_dev *dev, \
 784                                                 int where, t val) \
 785                 { return PCIBIOS_FUNC_NOT_SUPPORTED; }
 786
 787 #define _PCI_NOP_ALL(o, x)      _PCI_NOP(o, byte, u8 x) \
 788                                 _PCI_NOP(o, word, u16 x) \
 789                                 _PCI_NOP(o, dword, u32 x)
 790 _PCI_NOP_ALL(read, *)
 791 _PCI_NOP_ALL(write,)
 792
 793 static inline struct pci_dev *pci_find_device(unsigned int vendor,
 794                                               unsigned int device,
 795                                               const struct pci_dev *from)
 796 {
 797         return NULL;
 798 }
 799
 800 static inline struct pci_dev *pci_find_slot(unsigned int bus,
 801                                             unsigned int devfn)
 802 {
 803         return NULL;
 804 }
 805
 806 static inline struct pci_dev *pci_get_device(unsigned int vendor,
 807                                              unsigned int device,
 808                                              struct pci_dev *from)
 809 {
 810         return NULL;
 811 }
 812
 813 static inline struct pci_dev *pci_get_subsys(unsigned int vendor,
 814                                              unsigned int device,
 815                                              unsigned int ss_vendor,
 816                                              unsigned int ss_device,
 817                                              const struct pci_dev *from)
 818 {
 819         return NULL;
 820 }
 821
 822 static inline struct pci_dev *pci_get_class(unsigned int class,
 823                                             struct pci_dev *from)
 824 {
 825         return NULL;
 826 }
 827
 828 #define pci_dev_present(ids)    (0)
 829 #define no_pci_devices()        (1)
 830 #define pci_dev_put(dev)        do { } while (0)
 831
 832 static inline void pci_set_master(struct pci_dev *dev)
 833 { }
 834
 835 static inline int pci_enable_device(struct pci_dev *dev)
 836 {
 837         return -EIO;
 838 }
 839
 840 static inline void pci_disable_device(struct pci_dev *dev)
 841 { }
 842
 843 static inline int pci_set_dma_mask(struct pci_dev *dev, u64 mask)
 844 {
 845         return -EIO;
 846 }
 847
 848 static inline int pci_set_dma_max_seg_size(struct pci_dev *dev,
 849                                         unsigned int size)
 850 {
 851         return -EIO;
 852 }
 853
 854 static inline int pci_set_dma_seg_boundary(struct pci_dev *dev,
 855                                         unsigned long mask)
 856 {
 857         return -EIO;
 858 }
 859
 860 static inline int pci_assign_resource(struct pci_dev *dev, int i)
 861 {
 862         return -EBUSY;
 863 }
 864
 865 static inline int __pci_register_driver(struct pci_driver *drv,
 866                                         struct module *owner)
 867 {
 868         return 0;
 869 }
 870
 871 static inline int pci_register_driver(struct pci_driver *drv)
 872 {
 873         return 0;
 874 }
 875
 876 static inline void pci_unregister_driver(struct pci_driver *drv)
 877 { }
 878
 879 static inline int pci_find_capability(struct pci_dev *dev, int cap)
 880 {
 881         return 0;
 882 }
 883
 884 static inline int pci_find_next_capability(struct pci_dev *dev, u8 post,
 885                                            int cap)
 886 {
 887         return 0;
 888 }
 889
 890 static inline int pci_find_ext_capability(struct pci_dev *dev, int cap)
 891 {
 892         return 0;
 893 }
 894
 895 /* Power management related routines */
 896 static inline int pci_save_state(struct pci_dev *dev)
 897 {
 898         return 0;
 899 }
 900
 901 static inline int pci_restore_state(struct pci_dev *dev)
 902 {
 903         return 0;
 904 }
 905
 906 static inline int pci_set_power_state(struct pci_dev *dev, pci_power_t state)
 907 {
 908         return 0;
 909 }
 910
 911 static inline pci_power_t pci_choose_state(struct pci_dev *dev,
 912                                            pm_message_t state)
 913 {
 914         return PCI_D0;
 915 }
 916
 917 static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
 918                                   int enable)
 919 {
 920         return 0;
 921 }
 922
 923 static inline int pci_request_regions(struct pci_dev *dev, const char *res_name)
 924 {
 925         return -EIO;
 926 }
 927
 928 static inline void pci_release_regions(struct pci_dev *dev)
 929 { }
 930
 931 #define pci_dma_burst_advice(pdev, strat, strategy_parameter) do { } while (0)
 932
 933 static inline void pci_block_user_cfg_access(struct pci_dev *dev)
 934 { }
 935
 936 static inline void pci_unblock_user_cfg_access(struct pci_dev *dev)
 937 { }
 938
 939 static inline struct pci_bus *pci_find_next_bus(const struct pci_bus *from)
 940 { return NULL; }
 941
 942 static inline struct pci_dev *pci_get_slot(struct pci_bus *bus,
 943                                                 unsigned int devfn)
 944 { return NULL; }
 945
 946 static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
 947                                                 unsigned int devfn)
 948 { return NULL; }
 949
 950 #endif /* CONFIG_PCI */
 951
 952 /* Include architecture-dependent settings and functions */
 953
 954 #include <asm/pci.h>
 955
 956 /* these helpers provide future and backwards compatibility
 957  * for accessing popular PCI BAR info */
 958 #define pci_resource_start(dev, bar)    ((dev)->resource[(bar)].start)
 959 #define pci_resource_end(dev, bar)      ((dev)->resource[(bar)].end)
 960 #define pci_resource_flags(dev, bar)    ((dev)->resource[(bar)].flags)
 961 #define pci_resource_len(dev,bar) \
 962         ((pci_resource_start((dev), (bar)) == 0 &&      \
 963           pci_resource_end((dev), (bar)) ==             \
 964           pci_resource_start((dev), (bar))) ? 0 :       \
 965                                                         \
 966          (pci_resource_end((dev), (bar)) -              \
 967           pci_resource_start((dev), (bar)) + 1))
 968
 969 /* Similar to the helpers above, these manipulate per-pci_dev
 970  * driver-specific data.  They are really just a wrapper around
 971  * the generic device structure functions of these calls.
 972  */
 973 static inline void *pci_get_drvdata(struct pci_dev *pdev)
 974 {
 975         return dev_get_drvdata(&pdev->dev);
 976 }
 977
 978 static inline void pci_set_drvdata(struct pci_dev *pdev, void *data)
 979 {
 980         dev_set_drvdata(&pdev->dev, data);
 981 }
 982
 983 /* If you want to know what to call your pci_dev, ask this function.
 984  * Again, it's a wrapper around the generic device.
 985  */
 986 static inline char *pci_name(struct pci_dev *pdev)
 987 {
 988         return pdev->dev.bus_id;
 989 }
 990
 991
 992 /* Some archs don't want to expose struct resource to userland as-is
 993  * in sysfs and /proc
 994  */
 995 #ifndef HAVE_ARCH_PCI_RESOURCE_TO_USER
 996 static inline void pci_resource_to_user(const struct pci_dev *dev, int bar,
 997                 const struct resource *rsrc, resource_size_t *start,
 998                 resource_size_t *end)
 999 {
1000         *start = rsrc->start;
1001         *end = rsrc->end;
1002 }
1003 #endif /* HAVE_ARCH_PCI_RESOURCE_TO_USER */
1004
1005
1006 /*
1007  *  The world is not perfect and supplies us with broken PCI devices.
1008  *  For at least a part of these bugs we need a work-around, so both
1009  *  generic (drivers/pci/quirks.c) and per-architecture code can define
1010  *  fixup hooks to be called for particular buggy devices.
1011  */
1012
1013 struct pci_fixup {
1014         u16 vendor, device;     /* You can use PCI_ANY_ID here of course */
1015         void (*hook)(struct pci_dev *dev);
1016 };
1017
1018 enum pci_fixup_pass {
1019         pci_fixup_early,        /* Before probing BARs */
1020         pci_fixup_header,       /* After reading configuration header */
1021         pci_fixup_final,        /* Final phase of device fixups */
1022         pci_fixup_enable,       /* pci_enable_device() time */
1023         pci_fixup_resume,       /* pci_enable_device() time */
1024 };
1025
1026 /* Anonymous variables would be nice... */
1027 #define DECLARE_PCI_FIXUP_SECTION(section, name, vendor, device, hook)  \
1028         static const struct pci_fixup __pci_fixup_##name __used         \
1029         __attribute__((__section__(#section))) = { vendor, device, hook };
1030 #define DECLARE_PCI_FIXUP_EARLY(vendor, device, hook)                   \
1031         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early,                     \
1032                         vendor##device##hook, vendor, device, hook)
1033 #define DECLARE_PCI_FIXUP_HEADER(vendor, device, hook)                  \
1034         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header,                    \
1035                         vendor##device##hook, vendor, device, hook)
1036 #define DECLARE_PCI_FIXUP_FINAL(vendor, device, hook)                   \
1037         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final,                     \
1038                         vendor##device##hook, vendor, device, hook)
1039 #define DECLARE_PCI_FIXUP_ENABLE(vendor, device, hook)                  \
1040         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable,                    \
1041                         vendor##device##hook, vendor, device, hook)
1042 #define DECLARE_PCI_FIXUP_RESUME(vendor, device, hook)                  \
1043         DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume,                    \
1044                         resume##vendor##device##hook, vendor, device, hook)
1045
1046
1047 void pci_fixup_device(enum pci_fixup_pass pass, struct pci_dev *dev);
1048
1049 void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen);
1050 void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr);
1051 void __iomem * const *pcim_iomap_table(struct pci_dev *pdev);
1052 int pcim_iomap_regions(struct pci_dev *pdev, u16 mask, const char *name);
1053 int pcim_iomap_regions_request_all(struct pci_dev *pdev, u16 mask,
1054                                    const char *name);
1055 void pcim_iounmap_regions(struct pci_dev *pdev, u16 mask);
1056
1057 extern int pci_pci_problems;
1058 #define PCIPCI_FAIL             1       /* No PCI PCI DMA */
1059 #define PCIPCI_TRITON           2
1060 #define PCIPCI_NATOMA           4
1061 #define PCIPCI_VIAETBF          8
1062 #define PCIPCI_VSFX             16
1063 #define PCIPCI_ALIMAGIK         32      /* Need low latency setting */
1064 #define PCIAGP_FAIL             64      /* No PCI to AGP DMA */
1065
1066 extern unsigned long pci_cardbus_io_size;
1067 extern unsigned long pci_cardbus_mem_size;
1068
1069 extern int pcibios_add_platform_entries(struct pci_dev *dev);
1070
1071 #ifdef CONFIG_PCI_MMCONFIG
1072 extern void __init pci_mmcfg_early_init(void);
1073 extern void __init pci_mmcfg_late_init(void);
1074 #else
1075 static inline void pci_mmcfg_early_init(void) { }
1076 static inline void pci_mmcfg_late_init(void) { }
1077 #endif
1078
1079 #endif /* __KERNEL__ */
1080 #endif /* LINUX_PCI_H */