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