blob: 5c3a4176eb64a732546e5ef6c75c61e06a7e1212 [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
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -070020/* Include the pci register defines */
21#include <linux/pci_regs.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070022
23/* Include the ID list */
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/pci_ids.h>
25
26/*
27 * The PCI interface treats multi-function devices as independent
28 * devices. The slot/function address of each device is encoded
29 * in a single byte as follows:
30 *
31 * 7:3 = slot
32 * 2:0 = function
33 */
34#define PCI_DEVFN(slot,func) ((((slot) & 0x1f) << 3) | ((func) & 0x07))
35#define PCI_SLOT(devfn) (((devfn) >> 3) & 0x1f)
36#define PCI_FUNC(devfn) ((devfn) & 0x07)
37
38/* Ioctls for /proc/bus/pci/X/Y nodes. */
39#define PCIIOC_BASE ('P' << 24 | 'C' << 16 | 'I' << 8)
40#define PCIIOC_CONTROLLER (PCIIOC_BASE | 0x00) /* Get controller for PCI device. */
41#define PCIIOC_MMAP_IS_IO (PCIIOC_BASE | 0x01) /* Set mmap state to I/O space. */
42#define PCIIOC_MMAP_IS_MEM (PCIIOC_BASE | 0x02) /* Set mmap state to MEM space. */
43#define PCIIOC_WRITE_COMBINE (PCIIOC_BASE | 0x03) /* Enable/disable write-combining. */
44
45#ifdef __KERNEL__
46
David Woodhouse778382e2006-04-29 01:46:02 +010047#include <linux/mod_devicetable.h>
48
Linus Torvalds1da177e2005-04-16 15:20:36 -070049#include <linux/types.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070050#include <linux/ioport.h>
51#include <linux/list.h>
Andrew Morton4a7fb632006-08-14 22:43:17 -070052#include <linux/compiler.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070053#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
linas392a1ce2005-11-16 17:10:41 -060081/** 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 */
85typedef unsigned int __bitwise pci_channel_state_t;
86
87enum 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
Michael S. Tsirkin6e325a62006-02-14 18:52:22 +020098typedef unsigned short __bitwise pci_bus_flags_t;
99enum pci_bus_flags {
Roland Dreiere7782722006-03-30 12:55:10 -0800100 PCI_BUS_FLAGS_NO_MSI = (__force pci_bus_flags_t) 1,
Michael S. Tsirkin6e325a62006-02-14 18:52:22 +0200101};
102
Shaohua Li41017f02006-02-08 17:11:38 +0800103struct pci_cap_saved_state {
104 struct hlist_node next;
105 char cap_nr;
106 u32 data[0];
107};
108
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109/*
110 * The pci_dev structure is used to describe PCI devices.
111 */
112struct pci_dev {
113 struct list_head global_list; /* node in list of all PCI devices */
114 struct list_head bus_list; /* node in per-bus list */
115 struct pci_bus *bus; /* bus this device is on */
116 struct pci_bus *subordinate; /* bus this device bridges to */
117
118 void *sysdata; /* hook for sys-specific extension */
119 struct proc_dir_entry *procent; /* device entry in /proc/bus/pci */
120
121 unsigned int devfn; /* encoded device & function index */
122 unsigned short vendor;
123 unsigned short device;
124 unsigned short subsystem_vendor;
125 unsigned short subsystem_device;
126 unsigned int class; /* 3 bytes: (base,sub,prog-if) */
127 u8 hdr_type; /* PCI header type (`multi' flag masked out) */
128 u8 rom_base_reg; /* which config register controls the ROM */
Kristen Accardiffeff782005-11-02 16:24:32 -0800129 u8 pin; /* which interrupt pin this device uses */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
131 struct pci_driver *driver; /* which driver has allocated this device */
132 u64 dma_mask; /* Mask of the bits of bus address this
133 device implements. Normally this is
134 0xffffffff. You only need to change
135 this if your device has broken DMA
136 or supports 64-bit transfers. */
137
138 pci_power_t current_state; /* Current operating state. In ACPI-speak,
139 this is D0-D3, D0 being fully functional,
140 and D3 being off. */
141
linas392a1ce2005-11-16 17:10:41 -0600142 pci_channel_state_t error_state; /* current connectivity state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143 struct device dev; /* Generic device interface */
144
145 /* device is compatible with these IDs */
146 unsigned short vendor_compatible[DEVICE_COUNT_COMPATIBLE];
147 unsigned short device_compatible[DEVICE_COUNT_COMPATIBLE];
148
149 int cfg_size; /* Size of configuration space */
150
151 /*
152 * Instead of touching interrupt line and base address registers
153 * directly, use the values stored here. They might be different!
154 */
155 unsigned int irq;
156 struct resource resource[DEVICE_COUNT_RESOURCE]; /* I/O and memory regions + expansion ROMs */
157
158 /* These fields are used by common fixups */
159 unsigned int transparent:1; /* Transparent PCI bridge */
160 unsigned int multifunction:1;/* Part of multi-function device */
161 /* keep track of device state */
162 unsigned int is_enabled:1; /* pci_enable_device has been called */
163 unsigned int is_busmaster:1; /* device is busmaster */
Kristen Accardi4602b882005-08-16 15:15:58 -0700164 unsigned int no_msi:1; /* device may not use msi */
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700165 unsigned int no_d1d2:1; /* only allow d0 or d3 */
Brian Kinge04b0ea2005-09-27 01:21:55 -0700166 unsigned int block_ucfg_access:1; /* userspace config space access is blocked */
Doug Thompsonbd8481e2006-05-08 17:06:09 -0700167 unsigned int broken_parity_status:1; /* Device generates false positive parity */
Shaohua Li99dc8042006-05-26 10:58:27 +0800168 unsigned int msi_enabled:1;
169 unsigned int msix_enabled:1;
Kristen Accardi4602b882005-08-16 15:15:58 -0700170
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 u32 saved_config_space[16]; /* config space saved at suspend time */
Shaohua Li41017f02006-02-08 17:11:38 +0800172 struct hlist_head saved_cap_space;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173 struct bin_attribute *rom_attr; /* attribute descriptor for sysfs ROM entry */
174 int rom_attr_enabled; /* has display of the rom attribute been enabled? */
175 struct bin_attribute *res_attr[DEVICE_COUNT_RESOURCE]; /* sysfs file for resources */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176};
177
178#define pci_dev_g(n) list_entry(n, struct pci_dev, global_list)
179#define pci_dev_b(n) list_entry(n, struct pci_dev, bus_list)
180#define to_pci_dev(n) container_of(n, struct pci_dev, dev)
181#define for_each_pci_dev(d) while ((d = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, d)) != NULL)
182
Shaohua Li41017f02006-02-08 17:11:38 +0800183static inline struct pci_cap_saved_state *pci_find_saved_cap(
184 struct pci_dev *pci_dev,char cap)
185{
186 struct pci_cap_saved_state *tmp;
187 struct hlist_node *pos;
188
189 hlist_for_each_entry(tmp, pos, &pci_dev->saved_cap_space, next) {
190 if (tmp->cap_nr == cap)
191 return tmp;
192 }
193 return NULL;
194}
195
196static inline void pci_add_saved_cap(struct pci_dev *pci_dev,
197 struct pci_cap_saved_state *new_cap)
198{
199 hlist_add_head(&new_cap->next, &pci_dev->saved_cap_space);
200}
201
202static inline void pci_remove_saved_cap(struct pci_cap_saved_state *cap)
203{
204 hlist_del(&cap->next);
205}
206
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207/*
208 * For PCI devices, the region numbers are assigned this way:
209 *
210 * 0-5 standard PCI regions
211 * 6 expansion ROM
212 * 7-10 bridges: address space assigned to buses behind the bridge
213 */
214
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700215#define PCI_ROM_RESOURCE 6
216#define PCI_BRIDGE_RESOURCES 7
217#define PCI_NUM_RESOURCES 11
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
219#ifndef PCI_BUS_NUM_RESOURCES
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700220#define PCI_BUS_NUM_RESOURCES 8
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221#endif
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700222
223#define PCI_REGION_FLAG_MASK 0x0fU /* These bits of resource flags tell us the PCI region flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
225struct pci_bus {
226 struct list_head node; /* node in list of buses */
227 struct pci_bus *parent; /* parent bus this bridge is on */
228 struct list_head children; /* list of child buses */
229 struct list_head devices; /* list of devices on this bus */
230 struct pci_dev *self; /* bridge device as seen by parent */
231 struct resource *resource[PCI_BUS_NUM_RESOURCES];
232 /* address space routed to this bus */
233
234 struct pci_ops *ops; /* configuration access functions */
235 void *sysdata; /* hook for sys-specific extension */
236 struct proc_dir_entry *procdir; /* directory entry in /proc/bus/pci */
237
238 unsigned char number; /* bus number */
239 unsigned char primary; /* number of primary bridge */
240 unsigned char secondary; /* number of secondary bridge */
241 unsigned char subordinate; /* max number of subordinate buses */
242
243 char name[48];
244
245 unsigned short bridge_ctl; /* manage NO_ISA/FBB/et al behaviors */
Michael S. Tsirkin6e325a62006-02-14 18:52:22 +0200246 pci_bus_flags_t bus_flags; /* Inherited by child busses */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247 struct device *bridge;
248 struct class_device class_dev;
249 struct bin_attribute *legacy_io; /* legacy I/O for this bus */
250 struct bin_attribute *legacy_mem; /* legacy mem */
251};
252
253#define pci_bus_b(n) list_entry(n, struct pci_bus, node)
254#define to_pci_bus(n) container_of(n, struct pci_bus, class_dev)
255
256/*
257 * Error values that may be returned by PCI functions.
258 */
259#define PCIBIOS_SUCCESSFUL 0x00
260#define PCIBIOS_FUNC_NOT_SUPPORTED 0x81
261#define PCIBIOS_BAD_VENDOR_ID 0x83
262#define PCIBIOS_DEVICE_NOT_FOUND 0x86
263#define PCIBIOS_BAD_REGISTER_NUMBER 0x87
264#define PCIBIOS_SET_FAILED 0x88
265#define PCIBIOS_BUFFER_TOO_SMALL 0x89
266
267/* Low-level architecture-dependent routines */
268
269struct pci_ops {
270 int (*read)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 *val);
271 int (*write)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 val);
272};
273
274struct pci_raw_ops {
275 int (*read)(unsigned int domain, unsigned int bus, unsigned int devfn,
276 int reg, int len, u32 *val);
277 int (*write)(unsigned int domain, unsigned int bus, unsigned int devfn,
278 int reg, int len, u32 val);
279};
280
281extern struct pci_raw_ops *raw_pci_ops;
282
283struct pci_bus_region {
284 unsigned long start;
285 unsigned long end;
286};
287
288struct pci_dynids {
289 spinlock_t lock; /* protects list, index */
290 struct list_head list; /* for IDs added at runtime */
291 unsigned int use_driver_data:1; /* pci_driver->driver_data is used */
292};
293
linas392a1ce2005-11-16 17:10:41 -0600294/* ---------------------------------------------------------------- */
295/** PCI Error Recovery System (PCI-ERS). If a PCI device driver provides
296 * a set fof callbacks in struct pci_error_handlers, then that device driver
297 * will be notified of PCI bus errors, and will be driven to recovery
298 * when an error occurs.
299 */
300
301typedef unsigned int __bitwise pci_ers_result_t;
302
303enum pci_ers_result {
304 /* no result/none/not supported in device driver */
305 PCI_ERS_RESULT_NONE = (__force pci_ers_result_t) 1,
306
307 /* Device driver can recover without slot reset */
308 PCI_ERS_RESULT_CAN_RECOVER = (__force pci_ers_result_t) 2,
309
310 /* Device driver wants slot to be reset. */
311 PCI_ERS_RESULT_NEED_RESET = (__force pci_ers_result_t) 3,
312
313 /* Device has completely failed, is unrecoverable */
314 PCI_ERS_RESULT_DISCONNECT = (__force pci_ers_result_t) 4,
315
316 /* Device driver is fully recovered and operational */
317 PCI_ERS_RESULT_RECOVERED = (__force pci_ers_result_t) 5,
318};
319
320/* PCI bus error event callbacks */
321struct pci_error_handlers
322{
323 /* PCI bus error detected on this device */
324 pci_ers_result_t (*error_detected)(struct pci_dev *dev,
325 enum pci_channel_state error);
326
327 /* MMIO has been re-enabled, but not DMA */
328 pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev);
329
330 /* PCI Express link has been reset */
331 pci_ers_result_t (*link_reset)(struct pci_dev *dev);
332
333 /* PCI slot has been reset */
334 pci_ers_result_t (*slot_reset)(struct pci_dev *dev);
335
336 /* Device driver may resume normal operations */
337 void (*resume)(struct pci_dev *dev);
338};
339
340/* ---------------------------------------------------------------- */
341
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342struct module;
343struct pci_driver {
344 struct list_head node;
345 char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 const struct pci_device_id *id_table; /* must be non-NULL for probe to be called */
347 int (*probe) (struct pci_dev *dev, const struct pci_device_id *id); /* New device inserted */
348 void (*remove) (struct pci_dev *dev); /* Device removed (NULL if not a hot-plug capable driver) */
349 int (*suspend) (struct pci_dev *dev, pm_message_t state); /* Device suspended */
Linus Torvaldscbd69db2006-06-24 14:50:29 -0700350 int (*suspend_late) (struct pci_dev *dev, pm_message_t state);
351 int (*resume_early) (struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 int (*resume) (struct pci_dev *dev); /* Device woken up */
Pavel Machek438510f2005-04-16 15:25:24 -0700353 int (*enable_wake) (struct pci_dev *dev, pci_power_t state, int enable); /* Enable wake event */
Greg KHc8958172005-04-08 14:53:31 +0900354 void (*shutdown) (struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355
linas392a1ce2005-11-16 17:10:41 -0600356 struct pci_error_handlers *err_handler;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 struct device_driver driver;
358 struct pci_dynids dynids;
Alan Cox50b00752006-08-16 17:42:18 +0100359
360 int multithread_probe;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361};
362
363#define to_pci_driver(drv) container_of(drv,struct pci_driver, driver)
364
365/**
366 * PCI_DEVICE - macro used to describe a specific pci device
367 * @vend: the 16 bit PCI Vendor ID
368 * @dev: the 16 bit PCI Device ID
369 *
370 * This macro is used to create a struct pci_device_id that matches a
371 * specific device. The subvendor and subdevice fields will be set to
372 * PCI_ANY_ID.
373 */
374#define PCI_DEVICE(vend,dev) \
375 .vendor = (vend), .device = (dev), \
376 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
377
378/**
379 * PCI_DEVICE_CLASS - macro used to describe a specific pci device class
380 * @dev_class: the class, subclass, prog-if triple for this device
381 * @dev_class_mask: the class mask for this device
382 *
383 * This macro is used to create a struct pci_device_id that matches a
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700384 * specific PCI class. The vendor, device, subvendor, and subdevice
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 * fields will be set to PCI_ANY_ID.
386 */
387#define PCI_DEVICE_CLASS(dev_class,dev_class_mask) \
388 .class = (dev_class), .class_mask = (dev_class_mask), \
389 .vendor = PCI_ANY_ID, .device = PCI_ANY_ID, \
390 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
391
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700392/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393 * pci_module_init is obsolete, this stays here till we fix up all usages of it
394 * in the tree.
395 */
396#define pci_module_init pci_register_driver
397
398/* these external functions are only available when PCI support is enabled */
399#ifdef CONFIG_PCI
400
401extern struct bus_type pci_bus_type;
402
403/* Do NOT directly access these two variables, unless you are arch specific pci
404 * code, or pci core code. */
405extern struct list_head pci_root_buses; /* list of all known PCI buses */
406extern struct list_head pci_devices; /* list of all devices */
407
408void pcibios_fixup_bus(struct pci_bus *);
Andrew Morton4a7fb632006-08-14 22:43:17 -0700409int __must_check pcibios_enable_device(struct pci_dev *, int mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410char *pcibios_setup (char *str);
411
412/* Used only when drivers/pci/setup.c is used */
Greg Kroah-Hartmane31dd6e2006-06-12 17:06:02 -0700413void pcibios_align_resource(void *, struct resource *, resource_size_t,
414 resource_size_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415void pcibios_update_irq(struct pci_dev *, int irq);
416
417/* Generic PCI functions used internally */
418
419extern struct pci_bus *pci_find_bus(int domain, int busnr);
Rajesh Shahc431ada2005-04-28 00:25:45 -0700420void pci_bus_add_devices(struct pci_bus *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421struct pci_bus *pci_scan_bus_parented(struct device *parent, int bus, struct pci_ops *ops, void *sysdata);
422static inline struct pci_bus *pci_scan_bus(int bus, struct pci_ops *ops, void *sysdata)
423{
Rajesh Shahc431ada2005-04-28 00:25:45 -0700424 struct pci_bus *root_bus;
425 root_bus = pci_scan_bus_parented(NULL, bus, ops, sysdata);
426 if (root_bus)
427 pci_bus_add_devices(root_bus);
428 return root_bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429}
Paul Mackerrascdb9b9f2005-09-06 09:31:03 +1000430struct pci_bus *pci_create_bus(struct device *parent, int bus, struct pci_ops *ops, void *sysdata);
431struct pci_bus * pci_add_new_bus(struct pci_bus *parent, struct pci_dev *dev, int busnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432int pci_scan_slot(struct pci_bus *bus, int devfn);
433struct pci_dev * pci_scan_single_device(struct pci_bus *bus, int devfn);
Paul Mackerrascdb9b9f2005-09-06 09:31:03 +1000434void pci_device_add(struct pci_dev *dev, struct pci_bus *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435unsigned int pci_scan_child_bus(struct pci_bus *bus);
Greg Kroah-Hartmanb19441a2006-08-28 11:43:25 -0700436int __must_check pci_bus_add_device(struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437void pci_read_bridge_bases(struct pci_bus *child);
438struct resource *pci_find_parent_resource(const struct pci_dev *dev, struct resource *res);
439int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge);
440extern struct pci_dev *pci_dev_get(struct pci_dev *dev);
441extern void pci_dev_put(struct pci_dev *dev);
442extern void pci_remove_bus(struct pci_bus *b);
443extern void pci_remove_bus_device(struct pci_dev *dev);
Satoru Takeuchi24f8aa92006-09-12 10:16:36 -0700444extern void pci_stop_bus_device(struct pci_dev *dev);
Dominik Brodowskib3743fa2005-09-09 13:03:23 -0700445void pci_setup_cardbus(struct pci_bus *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446
447/* Generic PCI functions exported to card drivers */
448
449struct pci_dev *pci_find_device (unsigned int vendor, unsigned int device, const struct pci_dev *from);
450struct pci_dev *pci_find_device_reverse (unsigned int vendor, unsigned int device, const struct pci_dev *from);
451struct pci_dev *pci_find_slot (unsigned int bus, unsigned int devfn);
452int pci_find_capability (struct pci_dev *dev, int cap);
Roland Dreier24a4e372005-10-28 17:35:34 -0700453int pci_find_next_capability (struct pci_dev *dev, u8 pos, int cap);
Brice Goglin3a720d72006-05-23 06:10:01 -0400454int pci_find_ext_capability (struct pci_dev *dev, int cap);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455struct pci_bus * pci_find_next_bus(const struct pci_bus *from);
456
457struct pci_dev *pci_get_device (unsigned int vendor, unsigned int device, struct pci_dev *from);
458struct pci_dev *pci_get_subsys (unsigned int vendor, unsigned int device,
459 unsigned int ss_vendor, unsigned int ss_device,
460 struct pci_dev *from);
461struct pci_dev *pci_get_slot (struct pci_bus *bus, unsigned int devfn);
462struct pci_dev *pci_get_class (unsigned int class, struct pci_dev *from);
463int pci_dev_present(const struct pci_device_id *ids);
464
465int pci_bus_read_config_byte (struct pci_bus *bus, unsigned int devfn, int where, u8 *val);
466int pci_bus_read_config_word (struct pci_bus *bus, unsigned int devfn, int where, u16 *val);
467int pci_bus_read_config_dword (struct pci_bus *bus, unsigned int devfn, int where, u32 *val);
468int pci_bus_write_config_byte (struct pci_bus *bus, unsigned int devfn, int where, u8 val);
469int pci_bus_write_config_word (struct pci_bus *bus, unsigned int devfn, int where, u16 val);
470int pci_bus_write_config_dword (struct pci_bus *bus, unsigned int devfn, int where, u32 val);
471
472static inline int pci_read_config_byte(struct pci_dev *dev, int where, u8 *val)
473{
474 return pci_bus_read_config_byte (dev->bus, dev->devfn, where, val);
475}
476static inline int pci_read_config_word(struct pci_dev *dev, int where, u16 *val)
477{
478 return pci_bus_read_config_word (dev->bus, dev->devfn, where, val);
479}
480static inline int pci_read_config_dword(struct pci_dev *dev, int where, u32 *val)
481{
482 return pci_bus_read_config_dword (dev->bus, dev->devfn, where, val);
483}
484static inline int pci_write_config_byte(struct pci_dev *dev, int where, u8 val)
485{
486 return pci_bus_write_config_byte (dev->bus, dev->devfn, where, val);
487}
488static inline int pci_write_config_word(struct pci_dev *dev, int where, u16 val)
489{
490 return pci_bus_write_config_word (dev->bus, dev->devfn, where, val);
491}
492static inline int pci_write_config_dword(struct pci_dev *dev, int where, u32 val)
493{
494 return pci_bus_write_config_dword (dev->bus, dev->devfn, where, val);
495}
496
Andrew Morton4a7fb632006-08-14 22:43:17 -0700497int __must_check pci_enable_device(struct pci_dev *dev);
498int __must_check pci_enable_device_bars(struct pci_dev *dev, int mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499void pci_disable_device(struct pci_dev *dev);
500void pci_set_master(struct pci_dev *dev);
501#define HAVE_PCI_SET_MWI
Andrew Morton4a7fb632006-08-14 22:43:17 -0700502int __must_check pci_set_mwi(struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503void pci_clear_mwi(struct pci_dev *dev);
Brett M Russa04ce0f2005-08-15 15:23:41 -0400504void pci_intx(struct pci_dev *dev, int enable);
Linus Torvalds9c8550e2005-09-09 15:43:46 -0700505int pci_set_dma_mask(struct pci_dev *dev, u64 mask);
506int pci_set_consistent_dma_mask(struct pci_dev *dev, u64 mask);
John W. Linville064b53d2005-07-27 10:19:44 -0400507void pci_update_resource(struct pci_dev *dev, struct resource *res, int resno);
Andrew Morton4a7fb632006-08-14 22:43:17 -0700508int __must_check pci_assign_resource(struct pci_dev *dev, int i);
509int __must_check pci_assign_resource_fixed(struct pci_dev *dev, int i);
John W. Linville064b53d2005-07-27 10:19:44 -0400510void pci_restore_bars(struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511
512/* ROM control related routines */
Dave Jones144a50e2005-08-09 00:20:10 -0400513void __iomem __must_check *pci_map_rom(struct pci_dev *pdev, size_t *size);
514void __iomem __must_check *pci_map_rom_copy(struct pci_dev *pdev, size_t *size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom);
516void pci_remove_rom(struct pci_dev *pdev);
517
518/* Power management related routines */
519int pci_save_state(struct pci_dev *dev);
520int pci_restore_state(struct pci_dev *dev);
Linus Torvalds9c8550e2005-09-09 15:43:46 -0700521int pci_set_power_state(struct pci_dev *dev, pci_power_t state);
522pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state);
523int pci_enable_wake(struct pci_dev *dev, pci_power_t state, int enable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524
525/* Helper functions for low-level code (drivers/pci/setup-[bus,res].c) */
526void pci_bus_assign_resources(struct pci_bus *bus);
527void pci_bus_size_bridges(struct pci_bus *bus);
528int pci_claim_resource(struct pci_dev *, int);
529void pci_assign_unassigned_resources(void);
530void pdev_enable_device(struct pci_dev *);
531void pdev_sort_resources(struct pci_dev *, struct resource_list *);
532void pci_fixup_irqs(u8 (*)(struct pci_dev *, u8 *),
533 int (*)(struct pci_dev *, u8, u8));
534#define HAVE_PCI_REQ_REGIONS 2
Andrew Morton4a7fb632006-08-14 22:43:17 -0700535int __must_check pci_request_regions(struct pci_dev *, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536void pci_release_regions(struct pci_dev *);
Andrew Morton4a7fb632006-08-14 22:43:17 -0700537int __must_check pci_request_region(struct pci_dev *, int, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538void pci_release_region(struct pci_dev *, int);
539
540/* drivers/pci/bus.c */
Andrew Morton4a7fb632006-08-14 22:43:17 -0700541int __must_check pci_bus_alloc_resource(struct pci_bus *bus,
542 struct resource *res, resource_size_t size,
543 resource_size_t align, resource_size_t min,
544 unsigned int type_mask,
545 void (*alignf)(void *, struct resource *,
546 resource_size_t, resource_size_t),
547 void *alignf_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548void pci_enable_bridges(struct pci_bus *bus);
549
Laurent riffard863b18f2005-10-27 23:12:54 +0200550/* Proper probing supporting hot-pluggable devices */
Andrew Morton4a7fb632006-08-14 22:43:17 -0700551int __must_check __pci_register_driver(struct pci_driver *, struct module *);
552static inline int __must_check pci_register_driver(struct pci_driver *driver)
Laurent riffard863b18f2005-10-27 23:12:54 +0200553{
554 return __pci_register_driver(driver, THIS_MODULE);
555}
556
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557void pci_unregister_driver(struct pci_driver *);
558void pci_remove_behind_bridge(struct pci_dev *);
559struct pci_driver *pci_dev_driver(const struct pci_dev *);
Greg Kroah-Hartman75865852005-06-30 02:18:12 -0700560const struct pci_device_id *pci_match_device(struct pci_driver *drv, struct pci_dev *dev);
561const struct pci_device_id *pci_match_id(const struct pci_device_id *ids, struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562int pci_scan_bridge(struct pci_bus *bus, struct pci_dev * dev, int max, int pass);
563
Paul Mackerrascecf4862005-08-18 14:33:01 +1000564void pci_walk_bus(struct pci_bus *top, void (*cb)(struct pci_dev *, void *),
565 void *userdata);
Benjamin Herrenschmidtac7dc652005-12-13 18:09:16 +1100566int pci_cfg_space_size(struct pci_dev *dev);
Kristen Accardib82db5c2006-01-17 16:56:56 -0800567unsigned char pci_bus_max_busnr(struct pci_bus* bus);
Paul Mackerrascecf4862005-08-18 14:33:01 +1000568
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569/* kmem_cache style wrapper around pci_alloc_consistent() */
570
571#include <linux/dmapool.h>
572
573#define pci_pool dma_pool
574#define pci_pool_create(name, pdev, size, align, allocation) \
575 dma_pool_create(name, &pdev->dev, size, align, allocation)
576#define pci_pool_destroy(pool) dma_pool_destroy(pool)
577#define pci_pool_alloc(pool, flags, handle) dma_pool_alloc(pool, flags, handle)
578#define pci_pool_free(pool, vaddr, addr) dma_pool_free(pool, vaddr, addr)
579
David S. Millere24c2d92005-06-02 12:55:50 -0700580enum pci_dma_burst_strategy {
581 PCI_DMA_BURST_INFINITY, /* make bursts as large as possible,
582 strategy_parameter is N/A */
583 PCI_DMA_BURST_BOUNDARY, /* disconnect at every strategy_parameter
584 byte boundaries */
585 PCI_DMA_BURST_MULTIPLE, /* disconnect at some multiple of
586 strategy_parameter byte boundaries */
587};
588
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589#if defined(CONFIG_ISA) || defined(CONFIG_EISA)
590extern struct pci_dev *isa_bridge;
591#endif
592
593struct msix_entry {
594 u16 vector; /* kernel uses to write allocated vector */
595 u16 entry; /* driver uses to specify entry, OS writes */
596};
597
598#ifndef CONFIG_PCI_MSI
599static inline void pci_scan_msi_device(struct pci_dev *dev) {}
600static inline int pci_enable_msi(struct pci_dev *dev) {return -1;}
601static inline void pci_disable_msi(struct pci_dev *dev) {}
602static inline int pci_enable_msix(struct pci_dev* dev,
603 struct msix_entry *entries, int nvec) {return -1;}
604static inline void pci_disable_msix(struct pci_dev *dev) {}
605static inline void msi_remove_pci_irq_vectors(struct pci_dev *dev) {}
606#else
607extern void pci_scan_msi_device(struct pci_dev *dev);
608extern int pci_enable_msi(struct pci_dev *dev);
609extern void pci_disable_msi(struct pci_dev *dev);
610extern int pci_enable_msix(struct pci_dev* dev,
611 struct msix_entry *entries, int nvec);
612extern void pci_disable_msix(struct pci_dev *dev);
613extern void msi_remove_pci_irq_vectors(struct pci_dev *dev);
614#endif
615
Brian Kinge04b0ea2005-09-27 01:21:55 -0700616extern void pci_block_user_cfg_access(struct pci_dev *dev);
617extern void pci_unblock_user_cfg_access(struct pci_dev *dev);
618
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700619/*
620 * PCI domain support. Sometimes called PCI segment (eg by ACPI),
621 * a PCI domain is defined to be a set of PCI busses which share
622 * configuration space.
623 */
624#ifndef CONFIG_PCI_DOMAINS
625static inline int pci_domain_nr(struct pci_bus *bus) { return 0; }
626static inline int pci_proc_domain(struct pci_bus *bus)
627{
628 return 0;
629}
630#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700632#else /* CONFIG_PCI is not enabled */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633
634/*
635 * If the system does not have PCI, clearly these return errors. Define
636 * these as simple inline functions to avoid hair in drivers.
637 */
638
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639#define _PCI_NOP(o,s,t) \
640 static inline int pci_##o##_config_##s (struct pci_dev *dev, int where, t val) \
641 { return PCIBIOS_FUNC_NOT_SUPPORTED; }
642#define _PCI_NOP_ALL(o,x) _PCI_NOP(o,byte,u8 x) \
643 _PCI_NOP(o,word,u16 x) \
644 _PCI_NOP(o,dword,u32 x)
645_PCI_NOP_ALL(read, *)
646_PCI_NOP_ALL(write,)
647
648static inline struct pci_dev *pci_find_device(unsigned int vendor, unsigned int device, const struct pci_dev *from)
649{ return NULL; }
650
651static inline struct pci_dev *pci_find_slot(unsigned int bus, unsigned int devfn)
652{ return NULL; }
653
654static inline struct pci_dev *pci_get_device (unsigned int vendor, unsigned int device, struct pci_dev *from)
655{ return NULL; }
656
657static inline struct pci_dev *pci_get_subsys (unsigned int vendor, unsigned int device,
658unsigned int ss_vendor, unsigned int ss_device, struct pci_dev *from)
659{ return NULL; }
660
661static inline struct pci_dev *pci_get_class(unsigned int class, struct pci_dev *from)
662{ return NULL; }
663
664#define pci_dev_present(ids) (0)
665#define pci_dev_put(dev) do { } while (0)
666
667static inline void pci_set_master(struct pci_dev *dev) { }
668static inline int pci_enable_device(struct pci_dev *dev) { return -EIO; }
669static inline void pci_disable_device(struct pci_dev *dev) { }
670static inline int pci_set_dma_mask(struct pci_dev *dev, u64 mask) { return -EIO; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671static inline int pci_assign_resource(struct pci_dev *dev, int i) { return -EBUSY;}
Laurent riffard863b18f2005-10-27 23:12:54 +0200672static inline int __pci_register_driver(struct pci_driver *drv, struct module *owner) { return 0;}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700673static inline int pci_register_driver(struct pci_driver *drv) { return 0;}
674static inline void pci_unregister_driver(struct pci_driver *drv) { }
675static inline int pci_find_capability (struct pci_dev *dev, int cap) {return 0; }
Roland Dreier24a4e372005-10-28 17:35:34 -0700676static inline int pci_find_next_capability (struct pci_dev *dev, u8 post, int cap) { return 0; }
Brice Goglin3a720d72006-05-23 06:10:01 -0400677static inline int pci_find_ext_capability (struct pci_dev *dev, int cap) {return 0; }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678static inline const struct pci_device_id *pci_match_device(const struct pci_device_id *ids, const struct pci_dev *dev) { return NULL; }
679
680/* Power management related routines */
681static inline int pci_save_state(struct pci_dev *dev) { return 0; }
682static inline int pci_restore_state(struct pci_dev *dev) { return 0; }
683static inline int pci_set_power_state(struct pci_dev *dev, pci_power_t state) { return 0; }
Pavel Machek438510f2005-04-16 15:25:24 -0700684static 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 -0700685static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state, int enable) { return 0; }
686
687#define isa_bridge ((struct pci_dev *)NULL)
688
Kumar Galaa46e8122005-07-29 12:16:27 -0700689#define pci_dma_burst_advice(pdev, strat, strategy_parameter) do { } while (0)
690
Brian Kinge04b0ea2005-09-27 01:21:55 -0700691static inline void pci_block_user_cfg_access(struct pci_dev *dev) { }
692static inline void pci_unblock_user_cfg_access(struct pci_dev *dev) { }
693
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700694#endif /* CONFIG_PCI */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700696/* Include architecture-dependent settings and functions */
697
698#include <asm/pci.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699
700/* these helpers provide future and backwards compatibility
701 * for accessing popular PCI BAR info */
702#define pci_resource_start(dev,bar) ((dev)->resource[(bar)].start)
703#define pci_resource_end(dev,bar) ((dev)->resource[(bar)].end)
704#define pci_resource_flags(dev,bar) ((dev)->resource[(bar)].flags)
705#define pci_resource_len(dev,bar) \
706 ((pci_resource_start((dev),(bar)) == 0 && \
707 pci_resource_end((dev),(bar)) == \
708 pci_resource_start((dev),(bar))) ? 0 : \
709 \
710 (pci_resource_end((dev),(bar)) - \
711 pci_resource_start((dev),(bar)) + 1))
712
713/* Similar to the helpers above, these manipulate per-pci_dev
714 * driver-specific data. They are really just a wrapper around
715 * the generic device structure functions of these calls.
716 */
717static inline void *pci_get_drvdata (struct pci_dev *pdev)
718{
719 return dev_get_drvdata(&pdev->dev);
720}
721
722static inline void pci_set_drvdata (struct pci_dev *pdev, void *data)
723{
724 dev_set_drvdata(&pdev->dev, data);
725}
726
727/* If you want to know what to call your pci_dev, ask this function.
728 * Again, it's a wrapper around the generic device.
729 */
730static inline char *pci_name(struct pci_dev *pdev)
731{
732 return pdev->dev.bus_id;
733}
734
Michael Ellerman2311b1f2005-05-13 17:44:10 +1000735
736/* Some archs don't want to expose struct resource to userland as-is
737 * in sysfs and /proc
738 */
739#ifndef HAVE_ARCH_PCI_RESOURCE_TO_USER
740static inline void pci_resource_to_user(const struct pci_dev *dev, int bar,
Greg Kroah-Hartmane31dd6e2006-06-12 17:06:02 -0700741 const struct resource *rsrc, resource_size_t *start,
742 resource_size_t *end)
Michael Ellerman2311b1f2005-05-13 17:44:10 +1000743{
744 *start = rsrc->start;
745 *end = rsrc->end;
746}
747#endif /* HAVE_ARCH_PCI_RESOURCE_TO_USER */
748
749
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750/*
751 * The world is not perfect and supplies us with broken PCI devices.
752 * For at least a part of these bugs we need a work-around, so both
753 * generic (drivers/pci/quirks.c) and per-architecture code can define
754 * fixup hooks to be called for particular buggy devices.
755 */
756
757struct pci_fixup {
758 u16 vendor, device; /* You can use PCI_ANY_ID here of course */
759 void (*hook)(struct pci_dev *dev);
760};
761
762enum pci_fixup_pass {
763 pci_fixup_early, /* Before probing BARs */
764 pci_fixup_header, /* After reading configuration header */
765 pci_fixup_final, /* Final phase of device fixups */
766 pci_fixup_enable, /* pci_enable_device() time */
767};
768
769/* Anonymous variables would be nice... */
770#define DECLARE_PCI_FIXUP_SECTION(section, name, vendor, device, hook) \
akpm@osdl.org74d863e2005-07-25 23:28:14 -0700771 static const struct pci_fixup __pci_fixup_##name __attribute_used__ \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 __attribute__((__section__(#section))) = { vendor, device, hook };
773#define DECLARE_PCI_FIXUP_EARLY(vendor, device, hook) \
774 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early, \
775 vendor##device##hook, vendor, device, hook)
776#define DECLARE_PCI_FIXUP_HEADER(vendor, device, hook) \
777 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header, \
778 vendor##device##hook, vendor, device, hook)
779#define DECLARE_PCI_FIXUP_FINAL(vendor, device, hook) \
780 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final, \
781 vendor##device##hook, vendor, device, hook)
782#define DECLARE_PCI_FIXUP_ENABLE(vendor, device, hook) \
783 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable, \
784 vendor##device##hook, vendor, device, hook)
785
786
787void pci_fixup_device(enum pci_fixup_pass pass, struct pci_dev *dev);
788
789extern int pci_pci_problems;
790#define PCIPCI_FAIL 1
791#define PCIPCI_TRITON 2
792#define PCIPCI_NATOMA 4
793#define PCIPCI_VIAETBF 8
794#define PCIPCI_VSFX 16
795#define PCIPCI_ALIMAGIK 32
796
797#endif /* __KERNEL__ */
798#endif /* LINUX_PCI_H */