blob: d18b1dd49faba947acd56a77e1ccbb55df562b0f [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
Linus Torvalds1da177e2005-04-16 15:20:36 -070023/*
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 */
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -080031#define PCI_DEVFN(slot, func) ((((slot) & 0x1f) << 3) | ((func) & 0x07))
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#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
David Woodhouse778382e2006-04-29 01:46:02 +010044#include <linux/mod_devicetable.h>
45
Linus Torvalds1da177e2005-04-16 15:20:36 -070046#include <linux/types.h>
Sam Ravnborg98db6f12008-04-29 22:38:48 +020047#include <linux/init.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070048#include <linux/ioport.h>
49#include <linux/list.h>
Andrew Morton4a7fb632006-08-14 22:43:17 -070050#include <linux/compiler.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070051#include <linux/errno.h>
Inaky Perez-Gonzalezbae94d02006-11-22 12:40:31 -080052#include <asm/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070053#include <linux/device.h>
54
Adrian Bunk7e7a43c2006-12-19 13:12:07 -080055/* Include the ID list */
56#include <linux/pci_ids.h>
57
Linus Torvalds1da177e2005-04-16 15:20:36 -070058/* File state for mmap()s on /proc/bus/pci/X/Y */
59enum pci_mmap_state {
60 pci_mmap_io,
61 pci_mmap_mem
62};
63
64/* This defines the direction arg to the DMA mapping routines. */
65#define PCI_DMA_BIDIRECTIONAL 0
66#define PCI_DMA_TODEVICE 1
67#define PCI_DMA_FROMDEVICE 2
68#define PCI_DMA_NONE 3
69
Linus Torvalds1da177e2005-04-16 15:20:36 -070070#define DEVICE_COUNT_RESOURCE 12
71
72typedef int __bitwise pci_power_t;
73
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -070074#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)
Linus Torvalds1da177e2005-04-16 15:20:36 -070077#define PCI_D3hot ((pci_power_t __force) 3)
78#define PCI_D3cold ((pci_power_t __force) 4)
Daniel Ritz3fe9d192005-08-17 15:32:19 -070079#define PCI_UNKNOWN ((pci_power_t __force) 5)
Pavel Machek438510f2005-04-16 15:25:24 -070080#define PCI_POWER_ERROR ((pci_power_t __force) -1)
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
linas392a1ce2005-11-16 17:10:41 -060082/** 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 */
86typedef unsigned int __bitwise pci_channel_state_t;
87
88enum 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
Brian Kingf7bdd122007-04-06 16:39:36 -050099typedef unsigned int __bitwise pcie_reset_state_t;
100
101enum pcie_reset_state {
102 /* Reset is NOT asserted (Use to deassert reset) */
103 pcie_deassert_reset = (__force pcie_reset_state_t) 1,
104
105 /* Use #PERST to reset PCI-E device */
106 pcie_warm_reset = (__force pcie_reset_state_t) 2,
107
108 /* Use PCI-E Hot Reset to reset device */
109 pcie_hot_reset = (__force pcie_reset_state_t) 3
110};
111
David Millerba698ad2007-10-25 01:16:30 -0700112typedef unsigned short __bitwise pci_dev_flags_t;
113enum pci_dev_flags {
114 /* INTX_DISABLE in PCI_COMMAND register disables MSI
115 * generation too.
116 */
117 PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG = (__force pci_dev_flags_t) 1,
118};
119
Michael S. Tsirkin6e325a62006-02-14 18:52:22 +0200120typedef unsigned short __bitwise pci_bus_flags_t;
121enum pci_bus_flags {
Peter Orubad556ad42007-05-15 13:59:13 +0200122 PCI_BUS_FLAGS_NO_MSI = (__force pci_bus_flags_t) 1,
123 PCI_BUS_FLAGS_NO_MMRBC = (__force pci_bus_flags_t) 2,
Michael S. Tsirkin6e325a62006-02-14 18:52:22 +0200124};
125
Shaohua Li41017f02006-02-08 17:11:38 +0800126struct pci_cap_saved_state {
127 struct hlist_node next;
128 char cap_nr;
129 u32 data[0];
130};
131
Shaohua Li7d715a62008-02-25 09:46:41 +0800132struct pcie_link_state;
Jesse Barnesee69439c2008-04-28 12:30:35 -0700133struct pci_vpd;
134
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135/*
136 * The pci_dev structure is used to describe PCI devices.
137 */
138struct pci_dev {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 struct list_head bus_list; /* node in per-bus list */
140 struct pci_bus *bus; /* bus this device is on */
141 struct pci_bus *subordinate; /* bus this device bridges to */
142
143 void *sysdata; /* hook for sys-specific extension */
144 struct proc_dir_entry *procent; /* device entry in /proc/bus/pci */
145
146 unsigned int devfn; /* encoded device & function index */
147 unsigned short vendor;
148 unsigned short device;
149 unsigned short subsystem_vendor;
150 unsigned short subsystem_device;
151 unsigned int class; /* 3 bytes: (base,sub,prog-if) */
Auke Kokb8a3a522007-06-08 15:46:30 -0700152 u8 revision; /* PCI revision, low byte of class word */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153 u8 hdr_type; /* PCI header type (`multi' flag masked out) */
Keshavamurthy, Anil S994a65e2007-10-21 16:41:46 -0700154 u8 pcie_type; /* PCI-E device/port type */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 u8 rom_base_reg; /* which config register controls the ROM */
Kristen Accardiffeff782005-11-02 16:24:32 -0800156 u8 pin; /* which interrupt pin this device uses */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
158 struct pci_driver *driver; /* which driver has allocated this device */
159 u64 dma_mask; /* Mask of the bits of bus address this
160 device implements. Normally this is
161 0xffffffff. You only need to change
162 this if your device has broken DMA
163 or supports 64-bit transfers. */
164
FUJITA Tomonori4d57cdf2008-02-04 22:27:55 -0800165 struct device_dma_parameters dma_parms;
166
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 pci_power_t current_state; /* Current operating state. In ACPI-speak,
168 this is D0-D3, D0 being fully functional,
169 and D3 being off. */
170
Shaohua Li7d715a62008-02-25 09:46:41 +0800171#ifdef CONFIG_PCIEASPM
172 struct pcie_link_state *link_state; /* ASPM link state. */
173#endif
174
linas392a1ce2005-11-16 17:10:41 -0600175 pci_channel_state_t error_state; /* current connectivity state */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 struct device dev; /* Generic device interface */
177
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 int cfg_size; /* Size of configuration space */
179
180 /*
181 * Instead of touching interrupt line and base address registers
182 * directly, use the values stored here. They might be different!
183 */
184 unsigned int irq;
185 struct resource resource[DEVICE_COUNT_RESOURCE]; /* I/O and memory regions + expansion ROMs */
186
187 /* These fields are used by common fixups */
188 unsigned int transparent:1; /* Transparent PCI bridge */
189 unsigned int multifunction:1;/* Part of multi-function device */
190 /* keep track of device state */
Greg Kroah-Hartman8a1bc902008-02-14 14:56:56 -0800191 unsigned int is_added:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192 unsigned int is_busmaster:1; /* device is busmaster */
Kristen Accardi4602b882005-08-16 15:15:58 -0700193 unsigned int no_msi:1; /* device may not use msi */
Kristen Carlson Accardiffadcc22006-07-12 08:59:00 -0700194 unsigned int no_d1d2:1; /* only allow d0 or d3 */
Brian Kinge04b0ea2005-09-27 01:21:55 -0700195 unsigned int block_ucfg_access:1; /* userspace config space access is blocked */
Doug Thompsonbd8481e2006-05-08 17:06:09 -0700196 unsigned int broken_parity_status:1; /* Device generates false positive parity */
Shaohua Li99dc8042006-05-26 10:58:27 +0800197 unsigned int msi_enabled:1;
198 unsigned int msix_enabled:1;
Tejun Heo9ac78492007-01-20 16:00:26 +0900199 unsigned int is_managed:1;
Keshavamurthy, Anil S994a65e2007-10-21 16:41:46 -0700200 unsigned int is_pcie:1;
David Millerba698ad2007-10-25 01:16:30 -0700201 pci_dev_flags_t dev_flags;
Inaky Perez-Gonzalezbae94d02006-11-22 12:40:31 -0800202 atomic_t enable_cnt; /* pci_enable_device has been called */
Kristen Accardi4602b882005-08-16 15:15:58 -0700203
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204 u32 saved_config_space[16]; /* config space saved at suspend time */
Shaohua Li41017f02006-02-08 17:11:38 +0800205 struct hlist_head saved_cap_space;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 struct bin_attribute *rom_attr; /* attribute descriptor for sysfs ROM entry */
207 int rom_attr_enabled; /* has display of the rom attribute been enabled? */
208 struct bin_attribute *res_attr[DEVICE_COUNT_RESOURCE]; /* sysfs file for resources */
venkatesh.pallipadi@intel.com45aec1ae2008-03-18 17:00:22 -0700209 struct bin_attribute *res_attr_wc[DEVICE_COUNT_RESOURCE]; /* sysfs file for WC mapping of resources */
Eric W. Biedermanded86d82007-01-28 12:42:52 -0700210#ifdef CONFIG_PCI_MSI
Michael Ellerman4aa9bc92007-04-05 17:19:10 +1000211 struct list_head msi_list;
Eric W. Biedermanded86d82007-01-28 12:42:52 -0700212#endif
Ben Hutchings94e61082008-03-05 16:52:39 +0000213 struct pci_vpd *vpd;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214};
215
Michael Ellerman65891212007-04-05 17:19:08 +1000216extern struct pci_dev *alloc_pci_dev(void);
217
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218#define pci_dev_b(n) list_entry(n, struct pci_dev, bus_list)
219#define to_pci_dev(n) container_of(n, struct pci_dev, dev)
220#define for_each_pci_dev(d) while ((d = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, d)) != NULL)
221
Linas Vepstasa7369f12006-12-12 16:55:59 -0600222static inline int pci_channel_offline(struct pci_dev *pdev)
223{
224 return (pdev->error_state != pci_channel_io_normal);
225}
226
Shaohua Li41017f02006-02-08 17:11:38 +0800227static inline struct pci_cap_saved_state *pci_find_saved_cap(
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800228 struct pci_dev *pci_dev, char cap)
Shaohua Li41017f02006-02-08 17:11:38 +0800229{
230 struct pci_cap_saved_state *tmp;
231 struct hlist_node *pos;
232
233 hlist_for_each_entry(tmp, pos, &pci_dev->saved_cap_space, next) {
234 if (tmp->cap_nr == cap)
235 return tmp;
236 }
237 return NULL;
238}
239
240static inline void pci_add_saved_cap(struct pci_dev *pci_dev,
241 struct pci_cap_saved_state *new_cap)
242{
243 hlist_add_head(&new_cap->next, &pci_dev->saved_cap_space);
244}
245
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246/*
247 * For PCI devices, the region numbers are assigned this way:
248 *
249 * 0-5 standard PCI regions
250 * 6 expansion ROM
251 * 7-10 bridges: address space assigned to buses behind the bridge
252 */
253
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700254#define PCI_ROM_RESOURCE 6
255#define PCI_BRIDGE_RESOURCES 7
256#define PCI_NUM_RESOURCES 11
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
258#ifndef PCI_BUS_NUM_RESOURCES
Yinghai Lu30a18d62008-02-19 03:21:20 -0800259#define PCI_BUS_NUM_RESOURCES 16
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260#endif
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700261
262#define PCI_REGION_FLAG_MASK 0x0fU /* These bits of resource flags tell us the PCI region flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
264struct pci_bus {
265 struct list_head node; /* node in list of buses */
266 struct pci_bus *parent; /* parent bus this bridge is on */
267 struct list_head children; /* list of child buses */
268 struct list_head devices; /* list of devices on this bus */
269 struct pci_dev *self; /* bridge device as seen by parent */
270 struct resource *resource[PCI_BUS_NUM_RESOURCES];
271 /* address space routed to this bus */
272
273 struct pci_ops *ops; /* configuration access functions */
274 void *sysdata; /* hook for sys-specific extension */
275 struct proc_dir_entry *procdir; /* directory entry in /proc/bus/pci */
276
277 unsigned char number; /* bus number */
278 unsigned char primary; /* number of primary bridge */
279 unsigned char secondary; /* number of secondary bridge */
280 unsigned char subordinate; /* max number of subordinate buses */
281
282 char name[48];
283
284 unsigned short bridge_ctl; /* manage NO_ISA/FBB/et al behaviors */
Michael S. Tsirkin6e325a62006-02-14 18:52:22 +0200285 pci_bus_flags_t bus_flags; /* Inherited by child busses */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 struct device *bridge;
Greg Kroah-Hartmanfd7d1ce2007-05-22 22:47:54 -0400287 struct device dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 struct bin_attribute *legacy_io; /* legacy I/O for this bus */
289 struct bin_attribute *legacy_mem; /* legacy mem */
Greg Kroah-Hartmancc74d962008-03-12 21:48:03 -0700290 unsigned int is_added:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291};
292
293#define pci_bus_b(n) list_entry(n, struct pci_bus, node)
Greg Kroah-Hartmanfd7d1ce2007-05-22 22:47:54 -0400294#define to_pci_bus(n) container_of(n, struct pci_bus, dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295
296/*
297 * Error values that may be returned by PCI functions.
298 */
299#define PCIBIOS_SUCCESSFUL 0x00
300#define PCIBIOS_FUNC_NOT_SUPPORTED 0x81
301#define PCIBIOS_BAD_VENDOR_ID 0x83
302#define PCIBIOS_DEVICE_NOT_FOUND 0x86
303#define PCIBIOS_BAD_REGISTER_NUMBER 0x87
304#define PCIBIOS_SET_FAILED 0x88
305#define PCIBIOS_BUFFER_TOO_SMALL 0x89
306
307/* Low-level architecture-dependent routines */
308
309struct pci_ops {
310 int (*read)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 *val);
311 int (*write)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 val);
312};
313
Matthew Wilcoxb6ce0682008-02-10 09:45:28 -0500314/*
315 * ACPI needs to be able to access PCI config space before we've done a
316 * PCI bus scan and created pci_bus structures.
317 */
318extern int raw_pci_read(unsigned int domain, unsigned int bus,
319 unsigned int devfn, int reg, int len, u32 *val);
320extern int raw_pci_write(unsigned int domain, unsigned int bus,
321 unsigned int devfn, int reg, int len, u32 val);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322
323struct pci_bus_region {
Benjamin Herrenschmidtc40a22e2007-12-10 17:32:15 +1100324 resource_size_t start;
325 resource_size_t end;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326};
327
328struct pci_dynids {
329 spinlock_t lock; /* protects list, index */
330 struct list_head list; /* for IDs added at runtime */
331 unsigned int use_driver_data:1; /* pci_driver->driver_data is used */
332};
333
linas392a1ce2005-11-16 17:10:41 -0600334/* ---------------------------------------------------------------- */
335/** PCI Error Recovery System (PCI-ERS). If a PCI device driver provides
Rolf Eike Beer579082d2007-07-10 13:35:05 +0200336 * a set of callbacks in struct pci_error_handlers, then that device driver
linas392a1ce2005-11-16 17:10:41 -0600337 * will be notified of PCI bus errors, and will be driven to recovery
338 * when an error occurs.
339 */
340
341typedef unsigned int __bitwise pci_ers_result_t;
342
343enum pci_ers_result {
344 /* no result/none/not supported in device driver */
345 PCI_ERS_RESULT_NONE = (__force pci_ers_result_t) 1,
346
347 /* Device driver can recover without slot reset */
348 PCI_ERS_RESULT_CAN_RECOVER = (__force pci_ers_result_t) 2,
349
350 /* Device driver wants slot to be reset. */
351 PCI_ERS_RESULT_NEED_RESET = (__force pci_ers_result_t) 3,
352
353 /* Device has completely failed, is unrecoverable */
354 PCI_ERS_RESULT_DISCONNECT = (__force pci_ers_result_t) 4,
355
356 /* Device driver is fully recovered and operational */
357 PCI_ERS_RESULT_RECOVERED = (__force pci_ers_result_t) 5,
358};
359
360/* PCI bus error event callbacks */
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800361struct pci_error_handlers {
linas392a1ce2005-11-16 17:10:41 -0600362 /* PCI bus error detected on this device */
363 pci_ers_result_t (*error_detected)(struct pci_dev *dev,
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800364 enum pci_channel_state error);
linas392a1ce2005-11-16 17:10:41 -0600365
366 /* MMIO has been re-enabled, but not DMA */
367 pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev);
368
369 /* PCI Express link has been reset */
370 pci_ers_result_t (*link_reset)(struct pci_dev *dev);
371
372 /* PCI slot has been reset */
373 pci_ers_result_t (*slot_reset)(struct pci_dev *dev);
374
375 /* Device driver may resume normal operations */
376 void (*resume)(struct pci_dev *dev);
377};
378
379/* ---------------------------------------------------------------- */
380
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381struct module;
382struct pci_driver {
383 struct list_head node;
384 char *name;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385 const struct pci_device_id *id_table; /* must be non-NULL for probe to be called */
386 int (*probe) (struct pci_dev *dev, const struct pci_device_id *id); /* New device inserted */
387 void (*remove) (struct pci_dev *dev); /* Device removed (NULL if not a hot-plug capable driver) */
388 int (*suspend) (struct pci_dev *dev, pm_message_t state); /* Device suspended */
Linus Torvaldscbd69db2006-06-24 14:50:29 -0700389 int (*suspend_late) (struct pci_dev *dev, pm_message_t state);
390 int (*resume_early) (struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391 int (*resume) (struct pci_dev *dev); /* Device woken up */
Greg KHc8958172005-04-08 14:53:31 +0900392 void (*shutdown) (struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393
linas392a1ce2005-11-16 17:10:41 -0600394 struct pci_error_handlers *err_handler;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 struct device_driver driver;
396 struct pci_dynids dynids;
397};
398
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800399#define to_pci_driver(drv) container_of(drv, struct pci_driver, driver)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400
401/**
Andrew Morton9f9351b2008-03-10 11:43:34 -0700402 * DEFINE_PCI_DEVICE_TABLE - macro used to describe a pci device table
Jonas Bonn90a1ba02008-02-22 11:02:21 +0100403 * @_table: device table name
404 *
405 * This macro is used to create a struct pci_device_id array (a device table)
406 * in a generic manner.
407 */
Andrew Morton9f9351b2008-03-10 11:43:34 -0700408#define DEFINE_PCI_DEVICE_TABLE(_table) \
Jonas Bonn90a1ba02008-02-22 11:02:21 +0100409 const struct pci_device_id _table[] __devinitconst
410
411/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412 * PCI_DEVICE - macro used to describe a specific pci device
413 * @vend: the 16 bit PCI Vendor ID
414 * @dev: the 16 bit PCI Device ID
415 *
416 * This macro is used to create a struct pci_device_id that matches a
417 * specific device. The subvendor and subdevice fields will be set to
418 * PCI_ANY_ID.
419 */
420#define PCI_DEVICE(vend,dev) \
421 .vendor = (vend), .device = (dev), \
422 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
423
424/**
425 * PCI_DEVICE_CLASS - macro used to describe a specific pci device class
426 * @dev_class: the class, subclass, prog-if triple for this device
427 * @dev_class_mask: the class mask for this device
428 *
429 * This macro is used to create a struct pci_device_id that matches a
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700430 * specific PCI class. The vendor, device, subvendor, and subdevice
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 * fields will be set to PCI_ANY_ID.
432 */
433#define PCI_DEVICE_CLASS(dev_class,dev_class_mask) \
434 .class = (dev_class), .class_mask = (dev_class_mask), \
435 .vendor = PCI_ANY_ID, .device = PCI_ANY_ID, \
436 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
437
Alan Cox1597cac2006-12-04 15:14:45 -0800438/**
439 * PCI_VDEVICE - macro used to describe a specific pci device in short form
440 * @vend: the vendor name
441 * @dev: the 16 bit PCI Device ID
442 *
443 * This macro is used to create a struct pci_device_id that matches a
444 * specific PCI device. The subvendor, and subdevice fields will be set
445 * to PCI_ANY_ID. The macro allows the next field to follow as the device
446 * private data.
447 */
448
449#define PCI_VDEVICE(vendor, device) \
450 PCI_VENDOR_ID_##vendor, (device), \
451 PCI_ANY_ID, PCI_ANY_ID, 0, 0
452
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453/* these external functions are only available when PCI support is enabled */
454#ifdef CONFIG_PCI
455
456extern struct bus_type pci_bus_type;
457
458/* Do NOT directly access these two variables, unless you are arch specific pci
459 * code, or pci core code. */
460extern struct list_head pci_root_buses; /* list of all known PCI buses */
Zhang, Yanmined4aaad2007-07-15 23:39:39 -0700461/* Some device drivers need know if pci is initiated */
462extern int no_pci_devices(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463
464void pcibios_fixup_bus(struct pci_bus *);
Andrew Morton4a7fb632006-08-14 22:43:17 -0700465int __must_check pcibios_enable_device(struct pci_dev *, int mask);
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800466char *pcibios_setup(char *str);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467
468/* Used only when drivers/pci/setup.c is used */
Greg Kroah-Hartmane31dd6e2006-06-12 17:06:02 -0700469void pcibios_align_resource(void *, struct resource *, resource_size_t,
470 resource_size_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471void pcibios_update_irq(struct pci_dev *, int irq);
472
473/* Generic PCI functions used internally */
474
475extern struct pci_bus *pci_find_bus(int domain, int busnr);
Rajesh Shahc431ada2005-04-28 00:25:45 -0700476void pci_bus_add_devices(struct pci_bus *bus);
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800477struct pci_bus *pci_scan_bus_parented(struct device *parent, int bus,
478 struct pci_ops *ops, void *sysdata);
Sam Ravnborg98db6f12008-04-29 22:38:48 +0200479static inline struct pci_bus * __devinit pci_scan_bus(int bus, struct pci_ops *ops,
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800480 void *sysdata)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481{
Rajesh Shahc431ada2005-04-28 00:25:45 -0700482 struct pci_bus *root_bus;
483 root_bus = pci_scan_bus_parented(NULL, bus, ops, sysdata);
484 if (root_bus)
485 pci_bus_add_devices(root_bus);
486 return root_bus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487}
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800488struct pci_bus *pci_create_bus(struct device *parent, int bus,
489 struct pci_ops *ops, void *sysdata);
490struct pci_bus *pci_add_new_bus(struct pci_bus *parent, struct pci_dev *dev,
491 int busnr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492int pci_scan_slot(struct pci_bus *bus, int devfn);
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800493struct pci_dev *pci_scan_single_device(struct pci_bus *bus, int devfn);
Paul Mackerrascdb9b9f2005-09-06 09:31:03 +1000494void pci_device_add(struct pci_dev *dev, struct pci_bus *bus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495unsigned int pci_scan_child_bus(struct pci_bus *bus);
Greg Kroah-Hartmanb19441a2006-08-28 11:43:25 -0700496int __must_check pci_bus_add_device(struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497void pci_read_bridge_bases(struct pci_bus *child);
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800498struct resource *pci_find_parent_resource(const struct pci_dev *dev,
499 struct resource *res);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge);
501extern struct pci_dev *pci_dev_get(struct pci_dev *dev);
502extern void pci_dev_put(struct pci_dev *dev);
503extern void pci_remove_bus(struct pci_bus *b);
504extern void pci_remove_bus_device(struct pci_dev *dev);
Satoru Takeuchi24f8aa92006-09-12 10:16:36 -0700505extern void pci_stop_bus_device(struct pci_dev *dev);
Dominik Brodowskib3743fa2005-09-09 13:03:23 -0700506void pci_setup_cardbus(struct pci_bus *bus);
Matt Domsch6b4b78f2006-09-29 15:23:23 -0500507extern void pci_sort_breadthfirst(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
509/* Generic PCI functions exported to card drivers */
510
Jeff Garzikbd3989e2007-10-29 09:48:09 -0400511#ifdef CONFIG_PCI_LEGACY
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800512struct pci_dev __deprecated *pci_find_device(unsigned int vendor,
513 unsigned int device,
514 const struct pci_dev *from);
515struct pci_dev __deprecated *pci_find_slot(unsigned int bus,
516 unsigned int devfn);
Jeff Garzikbd3989e2007-10-29 09:48:09 -0400517#endif /* CONFIG_PCI_LEGACY */
518
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800519int pci_find_capability(struct pci_dev *dev, int cap);
520int pci_find_next_capability(struct pci_dev *dev, u8 pos, int cap);
521int pci_find_ext_capability(struct pci_dev *dev, int cap);
522int pci_find_ht_capability(struct pci_dev *dev, int ht_cap);
523int pci_find_next_ht_capability(struct pci_dev *dev, int pos, int ht_cap);
Alan Cox29f3eb62006-10-16 16:20:21 -0700524struct pci_bus *pci_find_next_bus(const struct pci_bus *from);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
Andrew Mortond42552c2006-10-21 10:24:12 -0700526struct pci_dev *pci_get_device(unsigned int vendor, unsigned int device,
527 struct pci_dev *from);
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800528struct pci_dev *pci_get_subsys(unsigned int vendor, unsigned int device,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 unsigned int ss_vendor, unsigned int ss_device,
Greg Kroah-Hartman95247b52008-02-13 11:03:58 -0800530 const struct pci_dev *from);
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800531struct pci_dev *pci_get_slot(struct pci_bus *bus, unsigned int devfn);
532struct pci_dev *pci_get_bus_and_slot(unsigned int bus, unsigned int devfn);
533struct pci_dev *pci_get_class(unsigned int class, struct pci_dev *from);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534int pci_dev_present(const struct pci_device_id *ids);
535
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800536int pci_bus_read_config_byte(struct pci_bus *bus, unsigned int devfn,
537 int where, u8 *val);
538int pci_bus_read_config_word(struct pci_bus *bus, unsigned int devfn,
539 int where, u16 *val);
540int pci_bus_read_config_dword(struct pci_bus *bus, unsigned int devfn,
541 int where, u32 *val);
542int pci_bus_write_config_byte(struct pci_bus *bus, unsigned int devfn,
543 int where, u8 val);
544int pci_bus_write_config_word(struct pci_bus *bus, unsigned int devfn,
545 int where, u16 val);
546int pci_bus_write_config_dword(struct pci_bus *bus, unsigned int devfn,
547 int where, u32 val);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548
549static inline int pci_read_config_byte(struct pci_dev *dev, int where, u8 *val)
550{
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800551 return pci_bus_read_config_byte(dev->bus, dev->devfn, where, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552}
553static inline int pci_read_config_word(struct pci_dev *dev, int where, u16 *val)
554{
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800555 return pci_bus_read_config_word(dev->bus, dev->devfn, where, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556}
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800557static inline int pci_read_config_dword(struct pci_dev *dev, int where,
558 u32 *val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559{
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800560 return pci_bus_read_config_dword(dev->bus, dev->devfn, where, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561}
562static inline int pci_write_config_byte(struct pci_dev *dev, int where, u8 val)
563{
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800564 return pci_bus_write_config_byte(dev->bus, dev->devfn, where, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565}
566static inline int pci_write_config_word(struct pci_dev *dev, int where, u16 val)
567{
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800568 return pci_bus_write_config_word(dev->bus, dev->devfn, where, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569}
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800570static inline int pci_write_config_dword(struct pci_dev *dev, int where,
571 u32 val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572{
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800573 return pci_bus_write_config_dword(dev->bus, dev->devfn, where, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574}
575
Andrew Morton4a7fb632006-08-14 22:43:17 -0700576int __must_check pci_enable_device(struct pci_dev *dev);
Benjamin Herrenschmidtb7189892007-12-20 15:28:08 +1100577int __must_check pci_enable_device_io(struct pci_dev *dev);
578int __must_check pci_enable_device_mem(struct pci_dev *dev);
Tejun Heo0b62e132007-07-27 14:43:35 +0900579int __must_check pci_reenable_device(struct pci_dev *);
Tejun Heo9ac78492007-01-20 16:00:26 +0900580int __must_check pcim_enable_device(struct pci_dev *pdev);
581void pcim_pin_device(struct pci_dev *pdev);
582
583static inline int pci_is_managed(struct pci_dev *pdev)
584{
585 return pdev->is_managed;
586}
587
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588void pci_disable_device(struct pci_dev *dev);
589void pci_set_master(struct pci_dev *dev);
Brian Kingf7bdd122007-04-06 16:39:36 -0500590int pci_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591#define HAVE_PCI_SET_MWI
Andrew Morton4a7fb632006-08-14 22:43:17 -0700592int __must_check pci_set_mwi(struct pci_dev *dev);
Randy Dunlap694625c2007-07-09 11:55:54 -0700593int pci_try_set_mwi(struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594void pci_clear_mwi(struct pci_dev *dev);
Brett M Russa04ce0f2005-08-15 15:23:41 -0400595void pci_intx(struct pci_dev *dev, int enable);
Eric W. Biedermanf5f2b132007-03-05 00:30:07 -0800596void pci_msi_off(struct pci_dev *dev);
Linus Torvalds9c8550e2005-09-09 15:43:46 -0700597int pci_set_dma_mask(struct pci_dev *dev, u64 mask);
598int pci_set_consistent_dma_mask(struct pci_dev *dev, u64 mask);
FUJITA Tomonori4d57cdf2008-02-04 22:27:55 -0800599int pci_set_dma_max_seg_size(struct pci_dev *dev, unsigned int size);
FUJITA Tomonori59fc67d2008-02-04 22:28:14 -0800600int pci_set_dma_seg_boundary(struct pci_dev *dev, unsigned long mask);
Peter Orubad556ad42007-05-15 13:59:13 +0200601int pcix_get_max_mmrbc(struct pci_dev *dev);
602int pcix_get_mmrbc(struct pci_dev *dev);
603int pcix_set_mmrbc(struct pci_dev *dev, int mmrbc);
Brice Goglin2637e5b2007-08-14 12:43:48 +0200604int pcie_get_readrq(struct pci_dev *dev);
Peter Orubad556ad42007-05-15 13:59:13 +0200605int pcie_set_readrq(struct pci_dev *dev, int rq);
John W. Linville064b53db2005-07-27 10:19:44 -0400606void pci_update_resource(struct pci_dev *dev, struct resource *res, int resno);
Andrew Morton4a7fb632006-08-14 22:43:17 -0700607int __must_check pci_assign_resource(struct pci_dev *dev, int i);
Hidetoshi Setoc87deff2006-12-18 10:31:06 +0900608int pci_select_bars(struct pci_dev *dev, unsigned long flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609
610/* ROM control related routines */
Dave Jones144a50e2005-08-09 00:20:10 -0400611void __iomem __must_check *pci_map_rom(struct pci_dev *pdev, size_t *size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom);
John Kellerd7ad2252007-07-09 11:42:24 -0700613size_t pci_get_rom_size(void __iomem *rom, size_t size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614
615/* Power management related routines */
616int pci_save_state(struct pci_dev *dev);
617int pci_restore_state(struct pci_dev *dev);
Linus Torvalds9c8550e2005-09-09 15:43:46 -0700618int pci_set_power_state(struct pci_dev *dev, pci_power_t state);
619pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state);
620int pci_enable_wake(struct pci_dev *dev, pci_power_t state, int enable);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621
Kumar Galace5ccde2007-07-16 23:27:10 -0500622/* Functions for PCI Hotplug drivers to use */
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800623int pci_bus_find_capability(struct pci_bus *bus, unsigned int devfn, int cap);
Kumar Galace5ccde2007-07-16 23:27:10 -0500624
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625/* Helper functions for low-level code (drivers/pci/setup-[bus,res].c) */
626void pci_bus_assign_resources(struct pci_bus *bus);
627void pci_bus_size_bridges(struct pci_bus *bus);
628int pci_claim_resource(struct pci_dev *, int);
629void pci_assign_unassigned_resources(void);
630void pdev_enable_device(struct pci_dev *);
631void pdev_sort_resources(struct pci_dev *, struct resource_list *);
Bjorn Helgaas842de402008-03-04 11:56:47 -0700632int pci_enable_resources(struct pci_dev *, int mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633void pci_fixup_irqs(u8 (*)(struct pci_dev *, u8 *),
634 int (*)(struct pci_dev *, u8, u8));
635#define HAVE_PCI_REQ_REGIONS 2
Andrew Morton4a7fb632006-08-14 22:43:17 -0700636int __must_check pci_request_regions(struct pci_dev *, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637void pci_release_regions(struct pci_dev *);
Andrew Morton4a7fb632006-08-14 22:43:17 -0700638int __must_check pci_request_region(struct pci_dev *, int, const char *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639void pci_release_region(struct pci_dev *, int);
Hidetoshi Setoc87deff2006-12-18 10:31:06 +0900640int pci_request_selected_regions(struct pci_dev *, int, const char *);
641void pci_release_selected_regions(struct pci_dev *, int);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642
643/* drivers/pci/bus.c */
Andrew Morton4a7fb632006-08-14 22:43:17 -0700644int __must_check pci_bus_alloc_resource(struct pci_bus *bus,
645 struct resource *res, resource_size_t size,
646 resource_size_t align, resource_size_t min,
647 unsigned int type_mask,
648 void (*alignf)(void *, struct resource *,
649 resource_size_t, resource_size_t),
650 void *alignf_data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651void pci_enable_bridges(struct pci_bus *bus);
652
Laurent riffard863b18f2005-10-27 23:12:54 +0200653/* Proper probing supporting hot-pluggable devices */
Greg Kroah-Hartman725522b2007-01-15 11:50:02 -0800654int __must_check __pci_register_driver(struct pci_driver *, struct module *,
655 const char *mod_name);
Andrew Morton4a7fb632006-08-14 22:43:17 -0700656static inline int __must_check pci_register_driver(struct pci_driver *driver)
Laurent riffard863b18f2005-10-27 23:12:54 +0200657{
Greg Kroah-Hartman725522b2007-01-15 11:50:02 -0800658 return __pci_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
Laurent riffard863b18f2005-10-27 23:12:54 +0200659}
660
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800661void pci_unregister_driver(struct pci_driver *dev);
662void pci_remove_behind_bridge(struct pci_dev *dev);
663struct pci_driver *pci_dev_driver(const struct pci_dev *dev);
664const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
665 struct pci_dev *dev);
666int pci_scan_bridge(struct pci_bus *bus, struct pci_dev *dev, int max,
667 int pass);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668
Paul Mackerrascecf4862005-08-18 14:33:01 +1000669void pci_walk_bus(struct pci_bus *top, void (*cb)(struct pci_dev *, void *),
670 void *userdata);
Yinghai Lu70b9f7d2008-04-28 16:27:23 -0700671int pci_cfg_space_size_ext(struct pci_dev *dev);
Benjamin Herrenschmidtac7dc652005-12-13 18:09:16 +1100672int pci_cfg_space_size(struct pci_dev *dev);
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800673unsigned char pci_bus_max_busnr(struct pci_bus *bus);
Paul Mackerrascecf4862005-08-18 14:33:01 +1000674
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675/* kmem_cache style wrapper around pci_alloc_consistent() */
676
677#include <linux/dmapool.h>
678
679#define pci_pool dma_pool
680#define pci_pool_create(name, pdev, size, align, allocation) \
681 dma_pool_create(name, &pdev->dev, size, align, allocation)
682#define pci_pool_destroy(pool) dma_pool_destroy(pool)
683#define pci_pool_alloc(pool, flags, handle) dma_pool_alloc(pool, flags, handle)
684#define pci_pool_free(pool, vaddr, addr) dma_pool_free(pool, vaddr, addr)
685
David S. Millere24c2d92005-06-02 12:55:50 -0700686enum pci_dma_burst_strategy {
687 PCI_DMA_BURST_INFINITY, /* make bursts as large as possible,
688 strategy_parameter is N/A */
689 PCI_DMA_BURST_BOUNDARY, /* disconnect at every strategy_parameter
690 byte boundaries */
691 PCI_DMA_BURST_MULTIPLE, /* disconnect at some multiple of
692 strategy_parameter byte boundaries */
693};
694
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695struct msix_entry {
696 u16 vector; /* kernel uses to write allocated vector */
697 u16 entry; /* driver uses to specify entry, OS writes */
698};
699
Eric W. Biederman0366f8f2006-10-04 02:16:33 -0700700
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701#ifndef CONFIG_PCI_MSI
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800702static inline int pci_enable_msi(struct pci_dev *dev)
703{
704 return -1;
705}
706
Yinghai Lud52877c2008-04-23 14:58:09 -0700707static inline void pci_msi_shutdown(struct pci_dev *dev)
708{ }
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800709static inline void pci_disable_msi(struct pci_dev *dev)
710{ }
711
712static inline int pci_enable_msix(struct pci_dev *dev,
713 struct msix_entry *entries, int nvec)
714{
715 return -1;
716}
717
Yinghai Lud52877c2008-04-23 14:58:09 -0700718static inline void pci_msix_shutdown(struct pci_dev *dev)
719{ }
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800720static inline void pci_disable_msix(struct pci_dev *dev)
721{ }
722
723static inline void msi_remove_pci_irq_vectors(struct pci_dev *dev)
724{ }
725
726static inline void pci_restore_msi_state(struct pci_dev *dev)
727{ }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728#else
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729extern int pci_enable_msi(struct pci_dev *dev);
Yinghai Lud52877c2008-04-23 14:58:09 -0700730extern void pci_msi_shutdown(struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731extern void pci_disable_msi(struct pci_dev *dev);
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800732extern int pci_enable_msix(struct pci_dev *dev,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 struct msix_entry *entries, int nvec);
Yinghai Lud52877c2008-04-23 14:58:09 -0700734extern void pci_msix_shutdown(struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735extern void pci_disable_msix(struct pci_dev *dev);
736extern void msi_remove_pci_irq_vectors(struct pci_dev *dev);
Linas Vepstas94688cf2007-11-07 15:43:59 -0600737extern void pci_restore_msi_state(struct pci_dev *dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738#endif
739
Eric W. Biederman8b955b02006-10-04 02:16:55 -0700740#ifdef CONFIG_HT_IRQ
Eric W. Biederman8b955b02006-10-04 02:16:55 -0700741/* The functions a driver should call */
742int ht_create_irq(struct pci_dev *dev, int idx);
743void ht_destroy_irq(unsigned int irq);
Eric W. Biederman8b955b02006-10-04 02:16:55 -0700744#endif /* CONFIG_HT_IRQ */
745
Brian Kinge04b0ea2005-09-27 01:21:55 -0700746extern void pci_block_user_cfg_access(struct pci_dev *dev);
747extern void pci_unblock_user_cfg_access(struct pci_dev *dev);
748
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700749/*
750 * PCI domain support. Sometimes called PCI segment (eg by ACPI),
751 * a PCI domain is defined to be a set of PCI busses which share
752 * configuration space.
753 */
Jeff Garzik32a2eea2007-10-11 16:57:27 -0400754#ifdef CONFIG_PCI_DOMAINS
755extern int pci_domains_supported;
756#else
757enum { pci_domains_supported = 0 };
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800758static inline int pci_domain_nr(struct pci_bus *bus)
759{
760 return 0;
761}
762
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700763static inline int pci_proc_domain(struct pci_bus *bus)
764{
765 return 0;
766}
Jeff Garzik32a2eea2007-10-11 16:57:27 -0400767#endif /* CONFIG_PCI_DOMAINS */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700769#else /* CONFIG_PCI is not enabled */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770
771/*
772 * If the system does not have PCI, clearly these return errors. Define
773 * these as simple inline functions to avoid hair in drivers.
774 */
775
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800776#define _PCI_NOP(o, s, t) \
777 static inline int pci_##o##_config_##s(struct pci_dev *dev, \
778 int where, t val) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 { return PCIBIOS_FUNC_NOT_SUPPORTED; }
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800780
781#define _PCI_NOP_ALL(o, x) _PCI_NOP(o, byte, u8 x) \
782 _PCI_NOP(o, word, u16 x) \
783 _PCI_NOP(o, dword, u32 x)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784_PCI_NOP_ALL(read, *)
785_PCI_NOP_ALL(write,)
786
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800787static inline struct pci_dev *pci_find_device(unsigned int vendor,
788 unsigned int device,
789 const struct pci_dev *from)
790{
791 return NULL;
792}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700793
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800794static inline struct pci_dev *pci_find_slot(unsigned int bus,
795 unsigned int devfn)
796{
797 return NULL;
798}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799
Andrew Mortond42552c2006-10-21 10:24:12 -0700800static inline struct pci_dev *pci_get_device(unsigned int vendor,
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800801 unsigned int device,
802 struct pci_dev *from)
803{
804 return NULL;
805}
Andrew Mortond42552c2006-10-21 10:24:12 -0700806
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800807static inline struct pci_dev *pci_get_subsys(unsigned int vendor,
808 unsigned int device,
809 unsigned int ss_vendor,
810 unsigned int ss_device,
Greg Kroah-Hartman95247b52008-02-13 11:03:58 -0800811 const struct pci_dev *from)
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800812{
813 return NULL;
814}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800816static inline struct pci_dev *pci_get_class(unsigned int class,
817 struct pci_dev *from)
818{
819 return NULL;
820}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821
822#define pci_dev_present(ids) (0)
Zhang, Yanmined4aaad2007-07-15 23:39:39 -0700823#define no_pci_devices() (1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824#define pci_dev_put(dev) do { } while (0)
825
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800826static inline void pci_set_master(struct pci_dev *dev)
827{ }
828
829static inline int pci_enable_device(struct pci_dev *dev)
830{
831 return -EIO;
832}
833
834static inline void pci_disable_device(struct pci_dev *dev)
835{ }
836
837static inline int pci_set_dma_mask(struct pci_dev *dev, u64 mask)
838{
839 return -EIO;
840}
841
FUJITA Tomonori4d57cdf2008-02-04 22:27:55 -0800842static inline int pci_set_dma_max_seg_size(struct pci_dev *dev,
843 unsigned int size)
844{
845 return -EIO;
846}
847
FUJITA Tomonori59fc67d2008-02-04 22:28:14 -0800848static inline int pci_set_dma_seg_boundary(struct pci_dev *dev,
849 unsigned long mask)
850{
851 return -EIO;
852}
853
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800854static inline int pci_assign_resource(struct pci_dev *dev, int i)
855{
856 return -EBUSY;
857}
858
859static inline int __pci_register_driver(struct pci_driver *drv,
860 struct module *owner)
861{
862 return 0;
863}
864
865static inline int pci_register_driver(struct pci_driver *drv)
866{
867 return 0;
868}
869
870static inline void pci_unregister_driver(struct pci_driver *drv)
871{ }
872
873static inline int pci_find_capability(struct pci_dev *dev, int cap)
874{
875 return 0;
876}
877
878static inline int pci_find_next_capability(struct pci_dev *dev, u8 post,
879 int cap)
880{
881 return 0;
882}
883
884static inline int pci_find_ext_capability(struct pci_dev *dev, int cap)
885{
886 return 0;
887}
888
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889/* Power management related routines */
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800890static inline int pci_save_state(struct pci_dev *dev)
891{
892 return 0;
893}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800895static inline int pci_restore_state(struct pci_dev *dev)
896{
897 return 0;
898}
899
900static inline int pci_set_power_state(struct pci_dev *dev, pci_power_t state)
901{
902 return 0;
903}
904
905static inline pci_power_t pci_choose_state(struct pci_dev *dev,
906 pm_message_t state)
907{
908 return PCI_D0;
909}
910
911static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
912 int enable)
913{
914 return 0;
915}
916
917static inline int pci_request_regions(struct pci_dev *dev, const char *res_name)
918{
919 return -EIO;
920}
921
922static inline void pci_release_regions(struct pci_dev *dev)
923{ }
Sergei Shtylyov0da0ead2007-04-01 21:13:58 +0400924
Kumar Galaa46e8122005-07-29 12:16:27 -0700925#define pci_dma_burst_advice(pdev, strat, strategy_parameter) do { } while (0)
926
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800927static inline void pci_block_user_cfg_access(struct pci_dev *dev)
928{ }
929
930static inline void pci_unblock_user_cfg_access(struct pci_dev *dev)
931{ }
Brian Kinge04b0ea2005-09-27 01:21:55 -0700932
Randy Dunlapd80d0212007-07-01 12:06:37 -0700933static inline struct pci_bus *pci_find_next_bus(const struct pci_bus *from)
934{ return NULL; }
935
936static inline struct pci_dev *pci_get_slot(struct pci_bus *bus,
937 unsigned int devfn)
938{ return NULL; }
939
940static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
941 unsigned int devfn)
942{ return NULL; }
943
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700944#endif /* CONFIG_PCI */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945
Greg Kroah-Hartman4352dfd2005-07-28 11:37:33 -0700946/* Include architecture-dependent settings and functions */
947
948#include <asm/pci.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949
950/* these helpers provide future and backwards compatibility
951 * for accessing popular PCI BAR info */
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800952#define pci_resource_start(dev, bar) ((dev)->resource[(bar)].start)
953#define pci_resource_end(dev, bar) ((dev)->resource[(bar)].end)
954#define pci_resource_flags(dev, bar) ((dev)->resource[(bar)].flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955#define pci_resource_len(dev,bar) \
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800956 ((pci_resource_start((dev), (bar)) == 0 && \
957 pci_resource_end((dev), (bar)) == \
958 pci_resource_start((dev), (bar))) ? 0 : \
959 \
960 (pci_resource_end((dev), (bar)) - \
961 pci_resource_start((dev), (bar)) + 1))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962
963/* Similar to the helpers above, these manipulate per-pci_dev
964 * driver-specific data. They are really just a wrapper around
965 * the generic device structure functions of these calls.
966 */
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800967static inline void *pci_get_drvdata(struct pci_dev *pdev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700968{
969 return dev_get_drvdata(&pdev->dev);
970}
971
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800972static inline void pci_set_drvdata(struct pci_dev *pdev, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973{
974 dev_set_drvdata(&pdev->dev, data);
975}
976
977/* If you want to know what to call your pci_dev, ask this function.
978 * Again, it's a wrapper around the generic device.
979 */
980static inline char *pci_name(struct pci_dev *pdev)
981{
982 return pdev->dev.bus_id;
983}
984
Michael Ellerman2311b1f2005-05-13 17:44:10 +1000985
986/* Some archs don't want to expose struct resource to userland as-is
987 * in sysfs and /proc
988 */
989#ifndef HAVE_ARCH_PCI_RESOURCE_TO_USER
990static inline void pci_resource_to_user(const struct pci_dev *dev, int bar,
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -0800991 const struct resource *rsrc, resource_size_t *start,
Greg Kroah-Hartmane31dd6e2006-06-12 17:06:02 -0700992 resource_size_t *end)
Michael Ellerman2311b1f2005-05-13 17:44:10 +1000993{
994 *start = rsrc->start;
995 *end = rsrc->end;
996}
997#endif /* HAVE_ARCH_PCI_RESOURCE_TO_USER */
998
999
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000/*
1001 * The world is not perfect and supplies us with broken PCI devices.
1002 * For at least a part of these bugs we need a work-around, so both
1003 * generic (drivers/pci/quirks.c) and per-architecture code can define
1004 * fixup hooks to be called for particular buggy devices.
1005 */
1006
1007struct pci_fixup {
1008 u16 vendor, device; /* You can use PCI_ANY_ID here of course */
1009 void (*hook)(struct pci_dev *dev);
1010};
1011
1012enum pci_fixup_pass {
1013 pci_fixup_early, /* Before probing BARs */
1014 pci_fixup_header, /* After reading configuration header */
1015 pci_fixup_final, /* Final phase of device fixups */
1016 pci_fixup_enable, /* pci_enable_device() time */
Alan Cox1597cac2006-12-04 15:14:45 -08001017 pci_fixup_resume, /* pci_enable_device() time */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018};
1019
1020/* Anonymous variables would be nice... */
1021#define DECLARE_PCI_FIXUP_SECTION(section, name, vendor, device, hook) \
Adrian Bunk3ff6eec2008-01-24 22:16:20 +01001022 static const struct pci_fixup __pci_fixup_##name __used \
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 __attribute__((__section__(#section))) = { vendor, device, hook };
1024#define DECLARE_PCI_FIXUP_EARLY(vendor, device, hook) \
1025 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early, \
1026 vendor##device##hook, vendor, device, hook)
1027#define DECLARE_PCI_FIXUP_HEADER(vendor, device, hook) \
1028 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header, \
1029 vendor##device##hook, vendor, device, hook)
1030#define DECLARE_PCI_FIXUP_FINAL(vendor, device, hook) \
1031 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final, \
1032 vendor##device##hook, vendor, device, hook)
1033#define DECLARE_PCI_FIXUP_ENABLE(vendor, device, hook) \
1034 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable, \
1035 vendor##device##hook, vendor, device, hook)
Alan Cox1597cac2006-12-04 15:14:45 -08001036#define DECLARE_PCI_FIXUP_RESUME(vendor, device, hook) \
1037 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume, \
1038 resume##vendor##device##hook, vendor, device, hook)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039
1040
1041void pci_fixup_device(enum pci_fixup_pass pass, struct pci_dev *dev);
1042
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -08001043void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen);
Al Viro5ea81762007-02-11 15:41:31 +00001044void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr);
Greg Kroah-Hartman05cca6e2008-01-30 15:21:33 -08001045void __iomem * const *pcim_iomap_table(struct pci_dev *pdev);
Al Viro5ea81762007-02-11 15:41:31 +00001046int pcim_iomap_regions(struct pci_dev *pdev, u16 mask, const char *name);
Tejun Heo916fbfb2008-03-12 15:26:34 +09001047int pcim_iomap_regions_request_all(struct pci_dev *pdev, u16 mask,
1048 const char *name);
Tejun Heoec04b072007-03-09 19:45:58 +09001049void pcim_iounmap_regions(struct pci_dev *pdev, u16 mask);
Al Viro5ea81762007-02-11 15:41:31 +00001050
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051extern int pci_pci_problems;
Alan Cox236561e2006-09-30 23:27:03 -07001052#define PCIPCI_FAIL 1 /* No PCI PCI DMA */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053#define PCIPCI_TRITON 2
1054#define PCIPCI_NATOMA 4
1055#define PCIPCI_VIAETBF 8
1056#define PCIPCI_VSFX 16
Alan Cox236561e2006-09-30 23:27:03 -07001057#define PCIPCI_ALIMAGIK 32 /* Need low latency setting */
1058#define PCIAGP_FAIL 64 /* No PCI to AGP DMA */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059
Atsushi Nemoto4516a612007-02-05 16:36:06 -08001060extern unsigned long pci_cardbus_io_size;
1061extern unsigned long pci_cardbus_mem_size;
1062
Michael Ellermana2cd52c2007-05-08 12:03:08 +10001063extern int pcibios_add_platform_entries(struct pci_dev *dev);
Michael Ellerman575e3342007-05-08 12:03:07 +10001064
Robert Hancock7752d5c2008-02-15 01:27:20 -08001065#ifdef CONFIG_PCI_MMCONFIG
Yinghai Lubb63b422008-02-28 23:56:50 -08001066extern void __init pci_mmcfg_early_init(void);
Robert Hancock7752d5c2008-02-15 01:27:20 -08001067extern void __init pci_mmcfg_late_init(void);
1068#else
Yinghai Lubb63b422008-02-28 23:56:50 -08001069static inline void pci_mmcfg_early_init(void) { }
Robert Hancock7752d5c2008-02-15 01:27:20 -08001070static inline void pci_mmcfg_late_init(void) { }
1071#endif
1072
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073#endif /* __KERNEL__ */
1074#endif /* LINUX_PCI_H */