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