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