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