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