blob: 3596ac94ecff74916f88499fb0e4bfa02a1fe1ff [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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 <linux/mod_devicetable.h>
21
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -070022/* Include the pci register defines */
23#include <linux/pci_regs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
25/* Include the ID list */
Linus Torvalds1da177e2005-04-16 15:20:36 -070026#include <linux/pci_ids.h>
27
28/*
29 * The PCI interface treats multi-function devices as independent
30 * devices. The slot/function address of each device is encoded
31 * in a single byte as follows:
32 *
33 * 7:3 = slot
34 * 2:0 = function
35 */
36#define PCI_DEVFN(slot,func) ((((slot) & 0x1f) << 3) | ((func) & 0x07))
37#define PCI_SLOT(devfn) (((devfn) >> 3) & 0x1f)
38#define PCI_FUNC(devfn) ((devfn) & 0x07)
39
40/* Ioctls for /proc/bus/pci/X/Y nodes. */
41#define PCIIOC_BASE ('P' << 24 | 'C' << 16 | 'I' << 8)
42#define PCIIOC_CONTROLLER (PCIIOC_BASE | 0x00) /* Get controller for PCI device. */
43#define PCIIOC_MMAP_IS_IO (PCIIOC_BASE | 0x01) /* Set mmap state to I/O space. */
44#define PCIIOC_MMAP_IS_MEM (PCIIOC_BASE | 0x02) /* Set mmap state to MEM space. */
45#define PCIIOC_WRITE_COMBINE (PCIIOC_BASE | 0x03) /* Enable/disable write-combining. */
46
47#ifdef __KERNEL__
48
49#include <linux/types.h>
50#include <linux/config.h>
51#include <linux/ioport.h>
52#include <linux/list.h>
53#include <linux/errno.h>
54#include <linux/device.h>
55
56/* File state for mmap()s on /proc/bus/pci/X/Y */
57enum pci_mmap_state {
58 pci_mmap_io,
59 pci_mmap_mem
60};
61
62/* This defines the direction arg to the DMA mapping routines. */
63#define PCI_DMA_BIDIRECTIONAL 0
64#define PCI_DMA_TODEVICE 1
65#define PCI_DMA_FROMDEVICE 2
66#define PCI_DMA_NONE 3
67
68#define DEVICE_COUNT_COMPATIBLE 4
69#define DEVICE_COUNT_RESOURCE 12
70
71typedef int __bitwise pci_power_t;
72
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -070073#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)
Linus Torvalds1da177e2005-04-16 15:20:36 -070076#define PCI_D3hot ((pci_power_t __force) 3)
77#define PCI_D3cold ((pci_power_t __force) 4)
Daniel Ritz3fe9d192005-08-17 15:32:19 -070078#define PCI_UNKNOWN ((pci_power_t __force) 5)
Pavel Machek438510f2005-04-16 15:25:24 -070079#define PCI_POWER_ERROR ((pci_power_t __force) -1)
Linus Torvalds1da177e2005-04-16 15:20:36 -070080
81/*
82 * The pci_dev structure is used to describe PCI devices.
83 */
84struct pci_dev {
85 struct list_head global_list; /* node in list of all PCI devices */
86 struct list_head bus_list; /* node in per-bus list */
87 struct pci_bus *bus; /* bus this device is on */
88 struct pci_bus *subordinate; /* bus this device bridges to */
89
90 void *sysdata; /* hook for sys-specific extension */
91 struct proc_dir_entry *procent; /* device entry in /proc/bus/pci */
92
93 unsigned int devfn; /* encoded device & function index */
94 unsigned short vendor;
95 unsigned short device;
96 unsigned short subsystem_vendor;
97 unsigned short subsystem_device;
98 unsigned int class; /* 3 bytes: (base,sub,prog-if) */
99 u8 hdr_type; /* PCI header type (`multi' flag masked out) */
100 u8 rom_base_reg; /* which config register controls the ROM */
101
102 struct pci_driver *driver; /* which driver has allocated this device */
103 u64 dma_mask; /* Mask of the bits of bus address this
104 device implements. Normally this is
105 0xffffffff. You only need to change
106 this if your device has broken DMA
107 or supports 64-bit transfers. */
108
109 pci_power_t current_state; /* Current operating state. In ACPI-speak,
110 this is D0-D3, D0 being fully functional,
111 and D3 being off. */
112
113 struct device dev; /* Generic device interface */
114
115 /* device is compatible with these IDs */
116 unsigned short vendor_compatible[DEVICE_COUNT_COMPATIBLE];
117 unsigned short device_compatible[DEVICE_COUNT_COMPATIBLE];
118
119 int cfg_size; /* Size of configuration space */
120
121 /*
122 * Instead of touching interrupt line and base address registers
123 * directly, use the values stored here. They might be different!
124 */
125 unsigned int irq;
126 struct resource resource[DEVICE_COUNT_RESOURCE]; /* I/O and memory regions + expansion ROMs */
127
128 /* These fields are used by common fixups */
129 unsigned int transparent:1; /* Transparent PCI bridge */
130 unsigned int multifunction:1;/* Part of multi-function device */
131 /* keep track of device state */
132 unsigned int is_enabled:1; /* pci_enable_device has been called */
133 unsigned int is_busmaster:1; /* device is busmaster */
Kristen Accardi4602b882005-08-16 15:15:58 -0700134 unsigned int no_msi:1; /* device may not use msi */
Brian Kinge04b0ea2005-09-27 01:21:55 -0700135 unsigned int block_ucfg_access:1; /* userspace config space access is blocked */
Kristen Accardi4602b882005-08-16 15:15:58 -0700136
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137 u32 saved_config_space[16]; /* config space saved at suspend time */
138 struct bin_attribute *rom_attr; /* attribute descriptor for sysfs ROM entry */
139 int rom_attr_enabled; /* has display of the rom attribute been enabled? */
140 struct bin_attribute *res_attr[DEVICE_COUNT_RESOURCE]; /* sysfs file for resources */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141};
142
143#define pci_dev_g(n) list_entry(n, struct pci_dev, global_list)
144#define pci_dev_b(n) list_entry(n, struct pci_dev, bus_list)
145#define to_pci_dev(n) container_of(n, struct pci_dev, dev)
146#define for_each_pci_dev(d) while ((d = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, d)) != NULL)
147
148/*
149 * For PCI devices, the region numbers are assigned this way:
150 *
151 * 0-5 standard PCI regions
152 * 6 expansion ROM
153 * 7-10 bridges: address space assigned to buses behind the bridge
154 */
155
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700156#define PCI_ROM_RESOURCE 6
157#define PCI_BRIDGE_RESOURCES 7
158#define PCI_NUM_RESOURCES 11
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159
160#ifndef PCI_BUS_NUM_RESOURCES
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700161#define PCI_BUS_NUM_RESOURCES 8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162#endif
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700163
164#define PCI_REGION_FLAG_MASK 0x0fU /* These bits of resource flags tell us the PCI region flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165
166struct pci_bus {
167 struct list_head node; /* node in list of buses */
168 struct pci_bus *parent; /* parent bus this bridge is on */
169 struct list_head children; /* list of child buses */
170 struct list_head devices; /* list of devices on this bus */
171 struct pci_dev *self; /* bridge device as seen by parent */
172 struct resource *resource[PCI_BUS_NUM_RESOURCES];
173 /* address space routed to this bus */
174
175 struct pci_ops *ops; /* configuration access functions */
176 void *sysdata; /* hook for sys-specific extension */
177 struct proc_dir_entry *procdir; /* directory entry in /proc/bus/pci */
178
179 unsigned char number; /* bus number */
180 unsigned char primary; /* number of primary bridge */
181 unsigned char secondary; /* number of secondary bridge */
182 unsigned char subordinate; /* max number of subordinate buses */
183
184 char name[48];
185
186 unsigned short bridge_ctl; /* manage NO_ISA/FBB/et al behaviors */
187 unsigned short pad2;
188 struct device *bridge;
189 struct class_device class_dev;
190 struct bin_attribute *legacy_io; /* legacy I/O for this bus */
191 struct bin_attribute *legacy_mem; /* legacy mem */
192};
193
194#define pci_bus_b(n) list_entry(n, struct pci_bus, node)
195#define to_pci_bus(n) container_of(n, struct pci_bus, class_dev)
196
197/*
198 * Error values that may be returned by PCI functions.
199 */
200#define PCIBIOS_SUCCESSFUL 0x00
201#define PCIBIOS_FUNC_NOT_SUPPORTED 0x81
202#define PCIBIOS_BAD_VENDOR_ID 0x83
203#define PCIBIOS_DEVICE_NOT_FOUND 0x86
204#define PCIBIOS_BAD_REGISTER_NUMBER 0x87
205#define PCIBIOS_SET_FAILED 0x88
206#define PCIBIOS_BUFFER_TOO_SMALL 0x89
207
208/* Low-level architecture-dependent routines */
209
210struct pci_ops {
211 int (*read)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 *val);
212 int (*write)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 val);
213};
214
215struct pci_raw_ops {
216 int (*read)(unsigned int domain, unsigned int bus, unsigned int devfn,
217 int reg, int len, u32 *val);
218 int (*write)(unsigned int domain, unsigned int bus, unsigned int devfn,
219 int reg, int len, u32 val);
220};
221
222extern struct pci_raw_ops *raw_pci_ops;
223
224struct pci_bus_region {
225 unsigned long start;
226 unsigned long end;
227};
228
229struct pci_dynids {
230 spinlock_t lock; /* protects list, index */
231 struct list_head list; /* for IDs added at runtime */
232 unsigned int use_driver_data:1; /* pci_driver->driver_data is used */
233};
234
235struct module;
236struct pci_driver {
237 struct list_head node;
238 char *name;
239 struct module *owner;
240 const struct pci_device_id *id_table; /* must be non-NULL for probe to be called */
241 int (*probe) (struct pci_dev *dev, const struct pci_device_id *id); /* New device inserted */
242 void (*remove) (struct pci_dev *dev); /* Device removed (NULL if not a hot-plug capable driver) */
243 int (*suspend) (struct pci_dev *dev, pm_message_t state); /* Device suspended */
244 int (*resume) (struct pci_dev *dev); /* Device woken up */
Pavel Machek438510f2005-04-16 15:25:24 -0700245 int (*enable_wake) (struct pci_dev *dev, pci_power_t state, int enable); /* Enable wake event */
Greg KHc8958172005-04-08 14:53:31 +0900246 void (*shutdown) (struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
248 struct device_driver driver;
249 struct pci_dynids dynids;
250};
251
252#define to_pci_driver(drv) container_of(drv,struct pci_driver, driver)
253
254/**
255 * PCI_DEVICE - macro used to describe a specific pci device
256 * @vend: the 16 bit PCI Vendor ID
257 * @dev: the 16 bit PCI Device ID
258 *
259 * This macro is used to create a struct pci_device_id that matches a
260 * specific device. The subvendor and subdevice fields will be set to
261 * PCI_ANY_ID.
262 */
263#define PCI_DEVICE(vend,dev) \
264 .vendor = (vend), .device = (dev), \
265 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
266
267/**
268 * PCI_DEVICE_CLASS - macro used to describe a specific pci device class
269 * @dev_class: the class, subclass, prog-if triple for this device
270 * @dev_class_mask: the class mask for this device
271 *
272 * This macro is used to create a struct pci_device_id that matches a
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700273 * specific PCI class. The vendor, device, subvendor, and subdevice
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 * fields will be set to PCI_ANY_ID.
275 */
276#define PCI_DEVICE_CLASS(dev_class,dev_class_mask) \
277 .class = (dev_class), .class_mask = (dev_class_mask), \
278 .vendor = PCI_ANY_ID, .device = PCI_ANY_ID, \
279 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
280
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700281/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282 * pci_module_init is obsolete, this stays here till we fix up all usages of it
283 * in the tree.
284 */
285#define pci_module_init pci_register_driver
286
287/* these external functions are only available when PCI support is enabled */
288#ifdef CONFIG_PCI
289
290extern struct bus_type pci_bus_type;
291
292/* Do NOT directly access these two variables, unless you are arch specific pci
293 * code, or pci core code. */
294extern struct list_head pci_root_buses; /* list of all known PCI buses */
295extern struct list_head pci_devices; /* list of all devices */
296
297void pcibios_fixup_bus(struct pci_bus *);
298int pcibios_enable_device(struct pci_dev *, int mask);
299char *pcibios_setup (char *str);
300
301/* Used only when drivers/pci/setup.c is used */
302void pcibios_align_resource(void *, struct resource *,
303 unsigned long, unsigned long);
304void pcibios_update_irq(struct pci_dev *, int irq);
305
306/* Generic PCI functions used internally */
307
308extern struct pci_bus *pci_find_bus(int domain, int busnr);
Rajesh Shahc431ada2005-04-28 00:25:45 -0700309void pci_bus_add_devices(struct pci_bus *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310struct pci_bus *pci_scan_bus_parented(struct device *parent, int bus, struct pci_ops *ops, void *sysdata);
311static inline struct pci_bus *pci_scan_bus(int bus, struct pci_ops *ops, void *sysdata)
312{
Rajesh Shahc431ada2005-04-28 00:25:45 -0700313 struct pci_bus *root_bus;
314 root_bus = pci_scan_bus_parented(NULL, bus, ops, sysdata);
315 if (root_bus)
316 pci_bus_add_devices(root_bus);
317 return root_bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318}
Paul Mackerrascdb9b9f2005-09-06 09:31:03 +1000319struct pci_bus *pci_create_bus(struct device *parent, int bus, struct pci_ops *ops, void *sysdata);
320struct pci_bus * pci_add_new_bus(struct pci_bus *parent, struct pci_dev *dev, int busnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321int pci_scan_slot(struct pci_bus *bus, int devfn);
322struct pci_dev * pci_scan_single_device(struct pci_bus *bus, int devfn);
Paul Mackerrascdb9b9f2005-09-06 09:31:03 +1000323void pci_device_add(struct pci_dev *dev, struct pci_bus *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324unsigned int pci_scan_child_bus(struct pci_bus *bus);
325void pci_bus_add_device(struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326void pci_read_bridge_bases(struct pci_bus *child);
327struct resource *pci_find_parent_resource(const struct pci_dev *dev, struct resource *res);
328int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge);
329extern struct pci_dev *pci_dev_get(struct pci_dev *dev);
330extern void pci_dev_put(struct pci_dev *dev);
331extern void pci_remove_bus(struct pci_bus *b);
332extern void pci_remove_bus_device(struct pci_dev *dev);
Dominik Brodowskib3743fa2005-09-09 13:03:23 -0700333void pci_setup_cardbus(struct pci_bus *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334
335/* Generic PCI functions exported to card drivers */
336
337struct pci_dev *pci_find_device (unsigned int vendor, unsigned int device, const struct pci_dev *from);
338struct pci_dev *pci_find_device_reverse (unsigned int vendor, unsigned int device, const struct pci_dev *from);
339struct pci_dev *pci_find_slot (unsigned int bus, unsigned int devfn);
340int pci_find_capability (struct pci_dev *dev, int cap);
341int pci_find_ext_capability (struct pci_dev *dev, int cap);
342struct pci_bus * pci_find_next_bus(const struct pci_bus *from);
343
344struct pci_dev *pci_get_device (unsigned int vendor, unsigned int device, struct pci_dev *from);
345struct pci_dev *pci_get_subsys (unsigned int vendor, unsigned int device,
346 unsigned int ss_vendor, unsigned int ss_device,
347 struct pci_dev *from);
348struct pci_dev *pci_get_slot (struct pci_bus *bus, unsigned int devfn);
349struct pci_dev *pci_get_class (unsigned int class, struct pci_dev *from);
350int pci_dev_present(const struct pci_device_id *ids);
351
352int pci_bus_read_config_byte (struct pci_bus *bus, unsigned int devfn, int where, u8 *val);
353int pci_bus_read_config_word (struct pci_bus *bus, unsigned int devfn, int where, u16 *val);
354int pci_bus_read_config_dword (struct pci_bus *bus, unsigned int devfn, int where, u32 *val);
355int pci_bus_write_config_byte (struct pci_bus *bus, unsigned int devfn, int where, u8 val);
356int pci_bus_write_config_word (struct pci_bus *bus, unsigned int devfn, int where, u16 val);
357int pci_bus_write_config_dword (struct pci_bus *bus, unsigned int devfn, int where, u32 val);
358
359static inline int pci_read_config_byte(struct pci_dev *dev, int where, u8 *val)
360{
361 return pci_bus_read_config_byte (dev->bus, dev->devfn, where, val);
362}
363static inline int pci_read_config_word(struct pci_dev *dev, int where, u16 *val)
364{
365 return pci_bus_read_config_word (dev->bus, dev->devfn, where, val);
366}
367static inline int pci_read_config_dword(struct pci_dev *dev, int where, u32 *val)
368{
369 return pci_bus_read_config_dword (dev->bus, dev->devfn, where, val);
370}
371static inline int pci_write_config_byte(struct pci_dev *dev, int where, u8 val)
372{
373 return pci_bus_write_config_byte (dev->bus, dev->devfn, where, val);
374}
375static inline int pci_write_config_word(struct pci_dev *dev, int where, u16 val)
376{
377 return pci_bus_write_config_word (dev->bus, dev->devfn, where, val);
378}
379static inline int pci_write_config_dword(struct pci_dev *dev, int where, u32 val)
380{
381 return pci_bus_write_config_dword (dev->bus, dev->devfn, where, val);
382}
383
Linus Torvalds9c8550e2005-09-09 15:43:46 -0700384int pci_enable_device(struct pci_dev *dev);
385int pci_enable_device_bars(struct pci_dev *dev, int mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386void pci_disable_device(struct pci_dev *dev);
387void pci_set_master(struct pci_dev *dev);
388#define HAVE_PCI_SET_MWI
Linus Torvalds9c8550e2005-09-09 15:43:46 -0700389int pci_set_mwi(struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390void pci_clear_mwi(struct pci_dev *dev);
Brett M Russa04ce0f2005-08-15 15:23:41 -0400391void pci_intx(struct pci_dev *dev, int enable);
Linus Torvalds9c8550e2005-09-09 15:43:46 -0700392int pci_set_dma_mask(struct pci_dev *dev, u64 mask);
393int pci_set_consistent_dma_mask(struct pci_dev *dev, u64 mask);
John W. Linville064b53db2005-07-27 10:19:44 -0400394void pci_update_resource(struct pci_dev *dev, struct resource *res, int resno);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395int pci_assign_resource(struct pci_dev *dev, int i);
John W. Linville064b53db2005-07-27 10:19:44 -0400396void pci_restore_bars(struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397
398/* ROM control related routines */
Dave Jones144a50e2005-08-09 00:20:10 -0400399void __iomem __must_check *pci_map_rom(struct pci_dev *pdev, size_t *size);
400void __iomem __must_check *pci_map_rom_copy(struct pci_dev *pdev, size_t *size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom);
402void pci_remove_rom(struct pci_dev *pdev);
403
404/* Power management related routines */
405int pci_save_state(struct pci_dev *dev);
406int pci_restore_state(struct pci_dev *dev);
Linus Torvalds9c8550e2005-09-09 15:43:46 -0700407int pci_set_power_state(struct pci_dev *dev, pci_power_t state);
408pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state);
409int pci_enable_wake(struct pci_dev *dev, pci_power_t state, int enable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410
411/* Helper functions for low-level code (drivers/pci/setup-[bus,res].c) */
412void pci_bus_assign_resources(struct pci_bus *bus);
413void pci_bus_size_bridges(struct pci_bus *bus);
414int pci_claim_resource(struct pci_dev *, int);
415void pci_assign_unassigned_resources(void);
416void pdev_enable_device(struct pci_dev *);
417void pdev_sort_resources(struct pci_dev *, struct resource_list *);
418void pci_fixup_irqs(u8 (*)(struct pci_dev *, u8 *),
419 int (*)(struct pci_dev *, u8, u8));
420#define HAVE_PCI_REQ_REGIONS 2
421int pci_request_regions(struct pci_dev *, char *);
422void pci_release_regions(struct pci_dev *);
423int pci_request_region(struct pci_dev *, int, char *);
424void pci_release_region(struct pci_dev *, int);
425
426/* drivers/pci/bus.c */
427int pci_bus_alloc_resource(struct pci_bus *bus, struct resource *res,
428 unsigned long size, unsigned long align,
429 unsigned long min, unsigned int type_mask,
430 void (*alignf)(void *, struct resource *,
431 unsigned long, unsigned long),
432 void *alignf_data);
433void pci_enable_bridges(struct pci_bus *bus);
434
435/* New-style probing supporting hot-pluggable devices */
436int pci_register_driver(struct pci_driver *);
437void pci_unregister_driver(struct pci_driver *);
438void pci_remove_behind_bridge(struct pci_dev *);
439struct pci_driver *pci_dev_driver(const struct pci_dev *);
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700440const struct pci_device_id *pci_match_device(struct pci_driver *drv, struct pci_dev *dev);
441const struct pci_device_id *pci_match_id(const struct pci_device_id *ids, struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442int pci_scan_bridge(struct pci_bus *bus, struct pci_dev * dev, int max, int pass);
443
Paul Mackerrascecf4862005-08-18 14:33:01 +1000444void pci_walk_bus(struct pci_bus *top, void (*cb)(struct pci_dev *, void *),
445 void *userdata);
446
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447/* kmem_cache style wrapper around pci_alloc_consistent() */
448
449#include <linux/dmapool.h>
450
451#define pci_pool dma_pool
452#define pci_pool_create(name, pdev, size, align, allocation) \
453 dma_pool_create(name, &pdev->dev, size, align, allocation)
454#define pci_pool_destroy(pool) dma_pool_destroy(pool)
455#define pci_pool_alloc(pool, flags, handle) dma_pool_alloc(pool, flags, handle)
456#define pci_pool_free(pool, vaddr, addr) dma_pool_free(pool, vaddr, addr)
457
David S. Millere24c2d92005-06-02 12:55:50 -0700458enum pci_dma_burst_strategy {
459 PCI_DMA_BURST_INFINITY, /* make bursts as large as possible,
460 strategy_parameter is N/A */
461 PCI_DMA_BURST_BOUNDARY, /* disconnect at every strategy_parameter
462 byte boundaries */
463 PCI_DMA_BURST_MULTIPLE, /* disconnect at some multiple of
464 strategy_parameter byte boundaries */
465};
466
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467#if defined(CONFIG_ISA) || defined(CONFIG_EISA)
468extern struct pci_dev *isa_bridge;
469#endif
470
471struct msix_entry {
472 u16 vector; /* kernel uses to write allocated vector */
473 u16 entry; /* driver uses to specify entry, OS writes */
474};
475
476#ifndef CONFIG_PCI_MSI
477static inline void pci_scan_msi_device(struct pci_dev *dev) {}
478static inline int pci_enable_msi(struct pci_dev *dev) {return -1;}
479static inline void pci_disable_msi(struct pci_dev *dev) {}
480static inline int pci_enable_msix(struct pci_dev* dev,
481 struct msix_entry *entries, int nvec) {return -1;}
482static inline void pci_disable_msix(struct pci_dev *dev) {}
483static inline void msi_remove_pci_irq_vectors(struct pci_dev *dev) {}
484#else
485extern void pci_scan_msi_device(struct pci_dev *dev);
486extern int pci_enable_msi(struct pci_dev *dev);
487extern void pci_disable_msi(struct pci_dev *dev);
488extern int pci_enable_msix(struct pci_dev* dev,
489 struct msix_entry *entries, int nvec);
490extern void pci_disable_msix(struct pci_dev *dev);
491extern void msi_remove_pci_irq_vectors(struct pci_dev *dev);
492#endif
493
Brian Kinge04b0ea2005-09-27 01:21:55 -0700494extern void pci_block_user_cfg_access(struct pci_dev *dev);
495extern void pci_unblock_user_cfg_access(struct pci_dev *dev);
496
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700497/*
498 * PCI domain support. Sometimes called PCI segment (eg by ACPI),
499 * a PCI domain is defined to be a set of PCI busses which share
500 * configuration space.
501 */
502#ifndef CONFIG_PCI_DOMAINS
503static inline int pci_domain_nr(struct pci_bus *bus) { return 0; }
504static inline int pci_proc_domain(struct pci_bus *bus)
505{
506 return 0;
507}
508#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700510#else /* CONFIG_PCI is not enabled */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511
512/*
513 * If the system does not have PCI, clearly these return errors. Define
514 * these as simple inline functions to avoid hair in drivers.
515 */
516
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517#define _PCI_NOP(o,s,t) \
518 static inline int pci_##o##_config_##s (struct pci_dev *dev, int where, t val) \
519 { return PCIBIOS_FUNC_NOT_SUPPORTED; }
520#define _PCI_NOP_ALL(o,x) _PCI_NOP(o,byte,u8 x) \
521 _PCI_NOP(o,word,u16 x) \
522 _PCI_NOP(o,dword,u32 x)
523_PCI_NOP_ALL(read, *)
524_PCI_NOP_ALL(write,)
525
526static inline struct pci_dev *pci_find_device(unsigned int vendor, unsigned int device, const struct pci_dev *from)
527{ return NULL; }
528
529static inline struct pci_dev *pci_find_slot(unsigned int bus, unsigned int devfn)
530{ return NULL; }
531
532static inline struct pci_dev *pci_get_device (unsigned int vendor, unsigned int device, struct pci_dev *from)
533{ return NULL; }
534
535static inline struct pci_dev *pci_get_subsys (unsigned int vendor, unsigned int device,
536unsigned int ss_vendor, unsigned int ss_device, struct pci_dev *from)
537{ return NULL; }
538
539static inline struct pci_dev *pci_get_class(unsigned int class, struct pci_dev *from)
540{ return NULL; }
541
542#define pci_dev_present(ids) (0)
543#define pci_dev_put(dev) do { } while (0)
544
545static inline void pci_set_master(struct pci_dev *dev) { }
546static inline int pci_enable_device(struct pci_dev *dev) { return -EIO; }
547static inline void pci_disable_device(struct pci_dev *dev) { }
548static inline int pci_set_dma_mask(struct pci_dev *dev, u64 mask) { return -EIO; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549static inline int pci_assign_resource(struct pci_dev *dev, int i) { return -EBUSY;}
550static inline int pci_register_driver(struct pci_driver *drv) { return 0;}
551static inline void pci_unregister_driver(struct pci_driver *drv) { }
552static inline int pci_find_capability (struct pci_dev *dev, int cap) {return 0; }
553static inline int pci_find_ext_capability (struct pci_dev *dev, int cap) {return 0; }
554static inline const struct pci_device_id *pci_match_device(const struct pci_device_id *ids, const struct pci_dev *dev) { return NULL; }
555
556/* Power management related routines */
557static inline int pci_save_state(struct pci_dev *dev) { return 0; }
558static inline int pci_restore_state(struct pci_dev *dev) { return 0; }
559static inline int pci_set_power_state(struct pci_dev *dev, pci_power_t state) { return 0; }
Pavel Machek438510f2005-04-16 15:25:24 -0700560static inline pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state) { return PCI_D0; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state, int enable) { return 0; }
562
563#define isa_bridge ((struct pci_dev *)NULL)
564
Kumar Galaa46e8122005-07-29 12:16:27 -0700565#define pci_dma_burst_advice(pdev, strat, strategy_parameter) do { } while (0)
566
Brian Kinge04b0ea2005-09-27 01:21:55 -0700567static inline void pci_block_user_cfg_access(struct pci_dev *dev) { }
568static inline void pci_unblock_user_cfg_access(struct pci_dev *dev) { }
569
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700570#endif /* CONFIG_PCI */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700572/* Include architecture-dependent settings and functions */
573
574#include <asm/pci.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575
576/* these helpers provide future and backwards compatibility
577 * for accessing popular PCI BAR info */
578#define pci_resource_start(dev,bar) ((dev)->resource[(bar)].start)
579#define pci_resource_end(dev,bar) ((dev)->resource[(bar)].end)
580#define pci_resource_flags(dev,bar) ((dev)->resource[(bar)].flags)
581#define pci_resource_len(dev,bar) \
582 ((pci_resource_start((dev),(bar)) == 0 && \
583 pci_resource_end((dev),(bar)) == \
584 pci_resource_start((dev),(bar))) ? 0 : \
585 \
586 (pci_resource_end((dev),(bar)) - \
587 pci_resource_start((dev),(bar)) + 1))
588
589/* Similar to the helpers above, these manipulate per-pci_dev
590 * driver-specific data. They are really just a wrapper around
591 * the generic device structure functions of these calls.
592 */
593static inline void *pci_get_drvdata (struct pci_dev *pdev)
594{
595 return dev_get_drvdata(&pdev->dev);
596}
597
598static inline void pci_set_drvdata (struct pci_dev *pdev, void *data)
599{
600 dev_set_drvdata(&pdev->dev, data);
601}
602
603/* If you want to know what to call your pci_dev, ask this function.
604 * Again, it's a wrapper around the generic device.
605 */
606static inline char *pci_name(struct pci_dev *pdev)
607{
608 return pdev->dev.bus_id;
609}
610
Michael Ellerman2311b1f2005-05-13 17:44:10 +1000611
612/* Some archs don't want to expose struct resource to userland as-is
613 * in sysfs and /proc
614 */
615#ifndef HAVE_ARCH_PCI_RESOURCE_TO_USER
616static inline void pci_resource_to_user(const struct pci_dev *dev, int bar,
617 const struct resource *rsrc, u64 *start, u64 *end)
618{
619 *start = rsrc->start;
620 *end = rsrc->end;
621}
622#endif /* HAVE_ARCH_PCI_RESOURCE_TO_USER */
623
624
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625/*
626 * The world is not perfect and supplies us with broken PCI devices.
627 * For at least a part of these bugs we need a work-around, so both
628 * generic (drivers/pci/quirks.c) and per-architecture code can define
629 * fixup hooks to be called for particular buggy devices.
630 */
631
632struct pci_fixup {
633 u16 vendor, device; /* You can use PCI_ANY_ID here of course */
634 void (*hook)(struct pci_dev *dev);
635};
636
637enum pci_fixup_pass {
638 pci_fixup_early, /* Before probing BARs */
639 pci_fixup_header, /* After reading configuration header */
640 pci_fixup_final, /* Final phase of device fixups */
641 pci_fixup_enable, /* pci_enable_device() time */
642};
643
644/* Anonymous variables would be nice... */
645#define DECLARE_PCI_FIXUP_SECTION(section, name, vendor, device, hook) \
akpm@osdl.org74d863e2005-07-25 23:28:14 -0700646 static const struct pci_fixup __pci_fixup_##name __attribute_used__ \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 __attribute__((__section__(#section))) = { vendor, device, hook };
648#define DECLARE_PCI_FIXUP_EARLY(vendor, device, hook) \
649 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early, \
650 vendor##device##hook, vendor, device, hook)
651#define DECLARE_PCI_FIXUP_HEADER(vendor, device, hook) \
652 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header, \
653 vendor##device##hook, vendor, device, hook)
654#define DECLARE_PCI_FIXUP_FINAL(vendor, device, hook) \
655 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final, \
656 vendor##device##hook, vendor, device, hook)
657#define DECLARE_PCI_FIXUP_ENABLE(vendor, device, hook) \
658 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable, \
659 vendor##device##hook, vendor, device, hook)
660
661
662void pci_fixup_device(enum pci_fixup_pass pass, struct pci_dev *dev);
663
664extern int pci_pci_problems;
665#define PCIPCI_FAIL 1
666#define PCIPCI_TRITON 2
667#define PCIPCI_NATOMA 4
668#define PCIPCI_VIAETBF 8
669#define PCIPCI_VSFX 16
670#define PCIPCI_ALIMAGIK 32
671
672#endif /* __KERNEL__ */
673#endif /* LINUX_PCI_H */