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