PCI: remove pci_find_present
[deliverable/linux.git] / include / linux / pci.h
CommitLineData
1da177e4
LT
1/*
2 * pci.h
3 *
4 * PCI defines and function prototypes
5 * Copyright 1994, Drew Eckhardt
6 * Copyright 1997--1999 Martin Mares <mj@ucw.cz>
7 *
8 * For more information, please consult the following manuals (look at
9 * http://www.pcisig.com/ for how to get them):
10 *
11 * PCI BIOS Specification
12 * PCI Local Bus Specification
13 * PCI to PCI Bridge Specification
14 * PCI System Design Guide
15 */
16
17#ifndef LINUX_PCI_H
18#define LINUX_PCI_H
19
4352dfd5
GKH
20/* Include the pci register defines */
21#include <linux/pci_regs.h>
1da177e4 22
1da177e4
LT
23/*
24 * The PCI interface treats multi-function devices as independent
25 * devices. The slot/function address of each device is encoded
26 * in a single byte as follows:
27 *
28 * 7:3 = slot
29 * 2:0 = function
30 */
05cca6e5 31#define PCI_DEVFN(slot, func) ((((slot) & 0x1f) << 3) | ((func) & 0x07))
1da177e4
LT
32#define PCI_SLOT(devfn) (((devfn) >> 3) & 0x1f)
33#define PCI_FUNC(devfn) ((devfn) & 0x07)
34
35/* Ioctls for /proc/bus/pci/X/Y nodes. */
36#define PCIIOC_BASE ('P' << 24 | 'C' << 16 | 'I' << 8)
37#define PCIIOC_CONTROLLER (PCIIOC_BASE | 0x00) /* Get controller for PCI device. */
38#define PCIIOC_MMAP_IS_IO (PCIIOC_BASE | 0x01) /* Set mmap state to I/O space. */
39#define PCIIOC_MMAP_IS_MEM (PCIIOC_BASE | 0x02) /* Set mmap state to MEM space. */
40#define PCIIOC_WRITE_COMBINE (PCIIOC_BASE | 0x03) /* Enable/disable write-combining. */
41
42#ifdef __KERNEL__
43
778382e0
DW
44#include <linux/mod_devicetable.h>
45
1da177e4 46#include <linux/types.h>
1da177e4
LT
47#include <linux/ioport.h>
48#include <linux/list.h>
4a7fb636 49#include <linux/compiler.h>
1da177e4 50#include <linux/errno.h>
bae94d02 51#include <asm/atomic.h>
1da177e4
LT
52#include <linux/device.h>
53
7e7a43c3
AB
54/* Include the ID list */
55#include <linux/pci_ids.h>
56
1da177e4
LT
57/* File state for mmap()s on /proc/bus/pci/X/Y */
58enum pci_mmap_state {
59 pci_mmap_io,
60 pci_mmap_mem
61};
62
63/* This defines the direction arg to the DMA mapping routines. */
64#define PCI_DMA_BIDIRECTIONAL 0
65#define PCI_DMA_TODEVICE 1
66#define PCI_DMA_FROMDEVICE 2
67#define PCI_DMA_NONE 3
68
1da177e4
LT
69#define DEVICE_COUNT_RESOURCE 12
70
71typedef int __bitwise pci_power_t;
72
4352dfd5
GKH
73#define PCI_D0 ((pci_power_t __force) 0)
74#define PCI_D1 ((pci_power_t __force) 1)
75#define PCI_D2 ((pci_power_t __force) 2)
1da177e4
LT
76#define PCI_D3hot ((pci_power_t __force) 3)
77#define PCI_D3cold ((pci_power_t __force) 4)
3fe9d19f 78#define PCI_UNKNOWN ((pci_power_t __force) 5)
438510f6 79#define PCI_POWER_ERROR ((pci_power_t __force) -1)
1da177e4 80
392a1ce7 81/** The pci_channel state describes connectivity between the CPU and
82 * the pci device. If some PCI bus between here and the pci device
83 * has crashed or locked up, this info is reflected here.
84 */
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
f7bdd12d
BK
98typedef unsigned int __bitwise pcie_reset_state_t;
99
100enum pcie_reset_state {
101 /* Reset is NOT asserted (Use to deassert reset) */
102 pcie_deassert_reset = (__force pcie_reset_state_t) 1,
103
104 /* Use #PERST to reset PCI-E device */
105 pcie_warm_reset = (__force pcie_reset_state_t) 2,
106
107 /* Use PCI-E Hot Reset to reset device */
108 pcie_hot_reset = (__force pcie_reset_state_t) 3
109};
110
ba698ad4
DM
111typedef unsigned short __bitwise pci_dev_flags_t;
112enum pci_dev_flags {
113 /* INTX_DISABLE in PCI_COMMAND register disables MSI
114 * generation too.
115 */
116 PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG = (__force pci_dev_flags_t) 1,
117};
118
6e325a62
MT
119typedef unsigned short __bitwise pci_bus_flags_t;
120enum pci_bus_flags {
d556ad4b
PO
121 PCI_BUS_FLAGS_NO_MSI = (__force pci_bus_flags_t) 1,
122 PCI_BUS_FLAGS_NO_MMRBC = (__force pci_bus_flags_t) 2,
6e325a62
MT
123};
124
41017f0c
SL
125struct pci_cap_saved_state {
126 struct hlist_node next;
127 char cap_nr;
128 u32 data[0];
129};
130
1da177e4
LT
131/*
132 * The pci_dev structure is used to describe PCI devices.
133 */
134struct pci_dev {
135 struct list_head global_list; /* node in list of all PCI devices */
136 struct list_head bus_list; /* node in per-bus list */
137 struct pci_bus *bus; /* bus this device is on */
138 struct pci_bus *subordinate; /* bus this device bridges to */
139
140 void *sysdata; /* hook for sys-specific extension */
141 struct proc_dir_entry *procent; /* device entry in /proc/bus/pci */
142
143 unsigned int devfn; /* encoded device & function index */
144 unsigned short vendor;
145 unsigned short device;
146 unsigned short subsystem_vendor;
147 unsigned short subsystem_device;
148 unsigned int class; /* 3 bytes: (base,sub,prog-if) */
b8a3a521 149 u8 revision; /* PCI revision, low byte of class word */
1da177e4 150 u8 hdr_type; /* PCI header type (`multi' flag masked out) */
994a65e2 151 u8 pcie_type; /* PCI-E device/port type */
1da177e4 152 u8 rom_base_reg; /* which config register controls the ROM */
ffeff788 153 u8 pin; /* which interrupt pin this device uses */
1da177e4
LT
154
155 struct pci_driver *driver; /* which driver has allocated this device */
156 u64 dma_mask; /* Mask of the bits of bus address this
157 device implements. Normally this is
158 0xffffffff. You only need to change
159 this if your device has broken DMA
160 or supports 64-bit transfers. */
161
4d57cdfa
FT
162 struct device_dma_parameters dma_parms;
163
1da177e4
LT
164 pci_power_t current_state; /* Current operating state. In ACPI-speak,
165 this is D0-D3, D0 being fully functional,
166 and D3 being off. */
167
392a1ce7 168 pci_channel_state_t error_state; /* current connectivity state */
1da177e4
LT
169 struct device dev; /* Generic device interface */
170
1da177e4
LT
171 int cfg_size; /* Size of configuration space */
172
173 /*
174 * Instead of touching interrupt line and base address registers
175 * directly, use the values stored here. They might be different!
176 */
177 unsigned int irq;
178 struct resource resource[DEVICE_COUNT_RESOURCE]; /* I/O and memory regions + expansion ROMs */
179
180 /* These fields are used by common fixups */
181 unsigned int transparent:1; /* Transparent PCI bridge */
182 unsigned int multifunction:1;/* Part of multi-function device */
183 /* keep track of device state */
1da177e4 184 unsigned int is_busmaster:1; /* device is busmaster */
4602b88d 185 unsigned int no_msi:1; /* device may not use msi */
ffadcc2f 186 unsigned int no_d1d2:1; /* only allow d0 or d3 */
e04b0ea2 187 unsigned int block_ucfg_access:1; /* userspace config space access is blocked */
bd8481e1 188 unsigned int broken_parity_status:1; /* Device generates false positive parity */
99dc804d
SL
189 unsigned int msi_enabled:1;
190 unsigned int msix_enabled:1;
9ac7849e 191 unsigned int is_managed:1;
994a65e2 192 unsigned int is_pcie:1;
ba698ad4 193 pci_dev_flags_t dev_flags;
bae94d02 194 atomic_t enable_cnt; /* pci_enable_device has been called */
4602b88d 195
1da177e4 196 u32 saved_config_space[16]; /* config space saved at suspend time */
41017f0c 197 struct hlist_head saved_cap_space;
1da177e4
LT
198 struct bin_attribute *rom_attr; /* attribute descriptor for sysfs ROM entry */
199 int rom_attr_enabled; /* has display of the rom attribute been enabled? */
200 struct bin_attribute *res_attr[DEVICE_COUNT_RESOURCE]; /* sysfs file for resources */
ded86d8d 201#ifdef CONFIG_PCI_MSI
4aa9bc95 202 struct list_head msi_list;
ded86d8d 203#endif
1da177e4
LT
204};
205
65891215
ME
206extern struct pci_dev *alloc_pci_dev(void);
207
1da177e4
LT
208#define pci_dev_g(n) list_entry(n, struct pci_dev, global_list)
209#define pci_dev_b(n) list_entry(n, struct pci_dev, bus_list)
210#define to_pci_dev(n) container_of(n, struct pci_dev, dev)
211#define for_each_pci_dev(d) while ((d = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, d)) != NULL)
212
a7369f1f
LV
213static inline int pci_channel_offline(struct pci_dev *pdev)
214{
215 return (pdev->error_state != pci_channel_io_normal);
216}
217
41017f0c 218static inline struct pci_cap_saved_state *pci_find_saved_cap(
05cca6e5 219 struct pci_dev *pci_dev, char cap)
41017f0c
SL
220{
221 struct pci_cap_saved_state *tmp;
222 struct hlist_node *pos;
223
224 hlist_for_each_entry(tmp, pos, &pci_dev->saved_cap_space, next) {
225 if (tmp->cap_nr == cap)
226 return tmp;
227 }
228 return NULL;
229}
230
231static inline void pci_add_saved_cap(struct pci_dev *pci_dev,
232 struct pci_cap_saved_state *new_cap)
233{
234 hlist_add_head(&new_cap->next, &pci_dev->saved_cap_space);
235}
236
1da177e4
LT
237/*
238 * For PCI devices, the region numbers are assigned this way:
239 *
240 * 0-5 standard PCI regions
241 * 6 expansion ROM
242 * 7-10 bridges: address space assigned to buses behind the bridge
243 */
244
4352dfd5
GKH
245#define PCI_ROM_RESOURCE 6
246#define PCI_BRIDGE_RESOURCES 7
247#define PCI_NUM_RESOURCES 11
1da177e4
LT
248
249#ifndef PCI_BUS_NUM_RESOURCES
4352dfd5 250#define PCI_BUS_NUM_RESOURCES 8
1da177e4 251#endif
4352dfd5
GKH
252
253#define PCI_REGION_FLAG_MASK 0x0fU /* These bits of resource flags tell us the PCI region flags */
1da177e4
LT
254
255struct pci_bus {
256 struct list_head node; /* node in list of buses */
257 struct pci_bus *parent; /* parent bus this bridge is on */
258 struct list_head children; /* list of child buses */
259 struct list_head devices; /* list of devices on this bus */
260 struct pci_dev *self; /* bridge device as seen by parent */
261 struct resource *resource[PCI_BUS_NUM_RESOURCES];
262 /* address space routed to this bus */
263
264 struct pci_ops *ops; /* configuration access functions */
265 void *sysdata; /* hook for sys-specific extension */
266 struct proc_dir_entry *procdir; /* directory entry in /proc/bus/pci */
267
268 unsigned char number; /* bus number */
269 unsigned char primary; /* number of primary bridge */
270 unsigned char secondary; /* number of secondary bridge */
271 unsigned char subordinate; /* max number of subordinate buses */
272
273 char name[48];
274
275 unsigned short bridge_ctl; /* manage NO_ISA/FBB/et al behaviors */
6e325a62 276 pci_bus_flags_t bus_flags; /* Inherited by child busses */
1da177e4 277 struct device *bridge;
fd7d1ced 278 struct device dev;
1da177e4
LT
279 struct bin_attribute *legacy_io; /* legacy I/O for this bus */
280 struct bin_attribute *legacy_mem; /* legacy mem */
cc74d96f 281 unsigned int is_added:1;
1da177e4
LT
282};
283
284#define pci_bus_b(n) list_entry(n, struct pci_bus, node)
fd7d1ced 285#define to_pci_bus(n) container_of(n, struct pci_bus, dev)
1da177e4
LT
286
287/*
288 * Error values that may be returned by PCI functions.
289 */
290#define PCIBIOS_SUCCESSFUL 0x00
291#define PCIBIOS_FUNC_NOT_SUPPORTED 0x81
292#define PCIBIOS_BAD_VENDOR_ID 0x83
293#define PCIBIOS_DEVICE_NOT_FOUND 0x86
294#define PCIBIOS_BAD_REGISTER_NUMBER 0x87
295#define PCIBIOS_SET_FAILED 0x88
296#define PCIBIOS_BUFFER_TOO_SMALL 0x89
297
298/* Low-level architecture-dependent routines */
299
300struct pci_ops {
301 int (*read)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 *val);
302 int (*write)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 val);
303};
304
b6ce068a
MW
305/*
306 * ACPI needs to be able to access PCI config space before we've done a
307 * PCI bus scan and created pci_bus structures.
308 */
309extern int raw_pci_read(unsigned int domain, unsigned int bus,
310 unsigned int devfn, int reg, int len, u32 *val);
311extern int raw_pci_write(unsigned int domain, unsigned int bus,
312 unsigned int devfn, int reg, int len, u32 val);
1da177e4
LT
313
314struct pci_bus_region {
c40a22e0
BH
315 resource_size_t start;
316 resource_size_t end;
1da177e4
LT
317};
318
319struct pci_dynids {
320 spinlock_t lock; /* protects list, index */
321 struct list_head list; /* for IDs added at runtime */
322 unsigned int use_driver_data:1; /* pci_driver->driver_data is used */
323};
324
392a1ce7 325/* ---------------------------------------------------------------- */
326/** PCI Error Recovery System (PCI-ERS). If a PCI device driver provides
579082df 327 * a set of callbacks in struct pci_error_handlers, then that device driver
392a1ce7 328 * will be notified of PCI bus errors, and will be driven to recovery
329 * when an error occurs.
330 */
331
332typedef unsigned int __bitwise pci_ers_result_t;
333
334enum pci_ers_result {
335 /* no result/none/not supported in device driver */
336 PCI_ERS_RESULT_NONE = (__force pci_ers_result_t) 1,
337
338 /* Device driver can recover without slot reset */
339 PCI_ERS_RESULT_CAN_RECOVER = (__force pci_ers_result_t) 2,
340
341 /* Device driver wants slot to be reset. */
342 PCI_ERS_RESULT_NEED_RESET = (__force pci_ers_result_t) 3,
343
344 /* Device has completely failed, is unrecoverable */
345 PCI_ERS_RESULT_DISCONNECT = (__force pci_ers_result_t) 4,
346
347 /* Device driver is fully recovered and operational */
348 PCI_ERS_RESULT_RECOVERED = (__force pci_ers_result_t) 5,
349};
350
351/* PCI bus error event callbacks */
05cca6e5 352struct pci_error_handlers {
392a1ce7 353 /* PCI bus error detected on this device */
354 pci_ers_result_t (*error_detected)(struct pci_dev *dev,
05cca6e5 355 enum pci_channel_state error);
392a1ce7 356
357 /* MMIO has been re-enabled, but not DMA */
358 pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev);
359
360 /* PCI Express link has been reset */
361 pci_ers_result_t (*link_reset)(struct pci_dev *dev);
362
363 /* PCI slot has been reset */
364 pci_ers_result_t (*slot_reset)(struct pci_dev *dev);
365
366 /* Device driver may resume normal operations */
367 void (*resume)(struct pci_dev *dev);
368};
369
370/* ---------------------------------------------------------------- */
371
1da177e4
LT
372struct module;
373struct pci_driver {
374 struct list_head node;
375 char *name;
1da177e4
LT
376 const struct pci_device_id *id_table; /* must be non-NULL for probe to be called */
377 int (*probe) (struct pci_dev *dev, const struct pci_device_id *id); /* New device inserted */
378 void (*remove) (struct pci_dev *dev); /* Device removed (NULL if not a hot-plug capable driver) */
379 int (*suspend) (struct pci_dev *dev, pm_message_t state); /* Device suspended */
cbd69dbb
LT
380 int (*suspend_late) (struct pci_dev *dev, pm_message_t state);
381 int (*resume_early) (struct pci_dev *dev);
1da177e4 382 int (*resume) (struct pci_dev *dev); /* Device woken up */
c8958177 383 void (*shutdown) (struct pci_dev *dev);
1da177e4 384
392a1ce7 385 struct pci_error_handlers *err_handler;
1da177e4
LT
386 struct device_driver driver;
387 struct pci_dynids dynids;
388};
389
05cca6e5 390#define to_pci_driver(drv) container_of(drv, struct pci_driver, driver)
1da177e4 391
90a1ba0c 392/**
9f9351bb 393 * DEFINE_PCI_DEVICE_TABLE - macro used to describe a pci device table
90a1ba0c
JB
394 * @_table: device table name
395 *
396 * This macro is used to create a struct pci_device_id array (a device table)
397 * in a generic manner.
398 */
9f9351bb 399#define DEFINE_PCI_DEVICE_TABLE(_table) \
90a1ba0c
JB
400 const struct pci_device_id _table[] __devinitconst
401
1da177e4
LT
402/**
403 * PCI_DEVICE - macro used to describe a specific pci device
404 * @vend: the 16 bit PCI Vendor ID
405 * @dev: the 16 bit PCI Device ID
406 *
407 * This macro is used to create a struct pci_device_id that matches a
408 * specific device. The subvendor and subdevice fields will be set to
409 * PCI_ANY_ID.
410 */
411#define PCI_DEVICE(vend,dev) \
412 .vendor = (vend), .device = (dev), \
413 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
414
415/**
416 * PCI_DEVICE_CLASS - macro used to describe a specific pci device class
417 * @dev_class: the class, subclass, prog-if triple for this device
418 * @dev_class_mask: the class mask for this device
419 *
420 * This macro is used to create a struct pci_device_id that matches a
4352dfd5 421 * specific PCI class. The vendor, device, subvendor, and subdevice
1da177e4
LT
422 * fields will be set to PCI_ANY_ID.
423 */
424#define PCI_DEVICE_CLASS(dev_class,dev_class_mask) \
425 .class = (dev_class), .class_mask = (dev_class_mask), \
426 .vendor = PCI_ANY_ID, .device = PCI_ANY_ID, \
427 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
428
1597cacb
AC
429/**
430 * PCI_VDEVICE - macro used to describe a specific pci device in short form
431 * @vend: the vendor name
432 * @dev: the 16 bit PCI Device ID
433 *
434 * This macro is used to create a struct pci_device_id that matches a
435 * specific PCI device. The subvendor, and subdevice fields will be set
436 * to PCI_ANY_ID. The macro allows the next field to follow as the device
437 * private data.
438 */
439
440#define PCI_VDEVICE(vendor, device) \
441 PCI_VENDOR_ID_##vendor, (device), \
442 PCI_ANY_ID, PCI_ANY_ID, 0, 0
443
1da177e4
LT
444/* these external functions are only available when PCI support is enabled */
445#ifdef CONFIG_PCI
446
447extern struct bus_type pci_bus_type;
448
449/* Do NOT directly access these two variables, unless you are arch specific pci
450 * code, or pci core code. */
451extern struct list_head pci_root_buses; /* list of all known PCI buses */
452extern struct list_head pci_devices; /* list of all devices */
ed4aaadb
ZY
453/* Some device drivers need know if pci is initiated */
454extern int no_pci_devices(void);
1da177e4
LT
455
456void pcibios_fixup_bus(struct pci_bus *);
4a7fb636 457int __must_check pcibios_enable_device(struct pci_dev *, int mask);
05cca6e5 458char *pcibios_setup(char *str);
1da177e4
LT
459
460/* Used only when drivers/pci/setup.c is used */
e31dd6e4
GKH
461void pcibios_align_resource(void *, struct resource *, resource_size_t,
462 resource_size_t);
1da177e4
LT
463void pcibios_update_irq(struct pci_dev *, int irq);
464
465/* Generic PCI functions used internally */
466
467extern struct pci_bus *pci_find_bus(int domain, int busnr);
c431ada4 468void pci_bus_add_devices(struct pci_bus *bus);
05cca6e5
GKH
469struct pci_bus *pci_scan_bus_parented(struct device *parent, int bus,
470 struct pci_ops *ops, void *sysdata);
471static inline struct pci_bus *pci_scan_bus(int bus, struct pci_ops *ops,
472 void *sysdata)
1da177e4 473{
c431ada4
RS
474 struct pci_bus *root_bus;
475 root_bus = pci_scan_bus_parented(NULL, bus, ops, sysdata);
476 if (root_bus)
477 pci_bus_add_devices(root_bus);
478 return root_bus;
1da177e4 479}
05cca6e5
GKH
480struct pci_bus *pci_create_bus(struct device *parent, int bus,
481 struct pci_ops *ops, void *sysdata);
482struct pci_bus *pci_add_new_bus(struct pci_bus *parent, struct pci_dev *dev,
483 int busnr);
1da177e4 484int pci_scan_slot(struct pci_bus *bus, int devfn);
05cca6e5 485struct pci_dev *pci_scan_single_device(struct pci_bus *bus, int devfn);
cdb9b9f7 486void pci_device_add(struct pci_dev *dev, struct pci_bus *bus);
1da177e4 487unsigned int pci_scan_child_bus(struct pci_bus *bus);
b19441af 488int __must_check pci_bus_add_device(struct pci_dev *dev);
1da177e4 489void pci_read_bridge_bases(struct pci_bus *child);
05cca6e5
GKH
490struct resource *pci_find_parent_resource(const struct pci_dev *dev,
491 struct resource *res);
1da177e4
LT
492int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge);
493extern struct pci_dev *pci_dev_get(struct pci_dev *dev);
494extern void pci_dev_put(struct pci_dev *dev);
495extern void pci_remove_bus(struct pci_bus *b);
496extern void pci_remove_bus_device(struct pci_dev *dev);
24f8aa9b 497extern void pci_stop_bus_device(struct pci_dev *dev);
b3743fa4 498void pci_setup_cardbus(struct pci_bus *bus);
6b4b78fe 499extern void pci_sort_breadthfirst(void);
1da177e4
LT
500
501/* Generic PCI functions exported to card drivers */
502
bd3989e0 503#ifdef CONFIG_PCI_LEGACY
05cca6e5
GKH
504struct pci_dev __deprecated *pci_find_device(unsigned int vendor,
505 unsigned int device,
506 const struct pci_dev *from);
507struct pci_dev __deprecated *pci_find_slot(unsigned int bus,
508 unsigned int devfn);
bd3989e0
JG
509#endif /* CONFIG_PCI_LEGACY */
510
05cca6e5
GKH
511int pci_find_capability(struct pci_dev *dev, int cap);
512int pci_find_next_capability(struct pci_dev *dev, u8 pos, int cap);
513int pci_find_ext_capability(struct pci_dev *dev, int cap);
514int pci_find_ht_capability(struct pci_dev *dev, int ht_cap);
515int pci_find_next_ht_capability(struct pci_dev *dev, int pos, int ht_cap);
29f3eb64 516struct pci_bus *pci_find_next_bus(const struct pci_bus *from);
1da177e4 517
d42552c3
AM
518struct pci_dev *pci_get_device(unsigned int vendor, unsigned int device,
519 struct pci_dev *from);
520struct pci_dev *pci_get_device_reverse(unsigned int vendor, unsigned int device,
521 struct pci_dev *from);
522
05cca6e5 523struct pci_dev *pci_get_subsys(unsigned int vendor, unsigned int device,
1da177e4
LT
524 unsigned int ss_vendor, unsigned int ss_device,
525 struct pci_dev *from);
05cca6e5
GKH
526struct pci_dev *pci_get_slot(struct pci_bus *bus, unsigned int devfn);
527struct pci_dev *pci_get_bus_and_slot(unsigned int bus, unsigned int devfn);
528struct pci_dev *pci_get_class(unsigned int class, struct pci_dev *from);
1da177e4
LT
529int pci_dev_present(const struct pci_device_id *ids);
530
05cca6e5
GKH
531int pci_bus_read_config_byte(struct pci_bus *bus, unsigned int devfn,
532 int where, u8 *val);
533int pci_bus_read_config_word(struct pci_bus *bus, unsigned int devfn,
534 int where, u16 *val);
535int pci_bus_read_config_dword(struct pci_bus *bus, unsigned int devfn,
536 int where, u32 *val);
537int pci_bus_write_config_byte(struct pci_bus *bus, unsigned int devfn,
538 int where, u8 val);
539int pci_bus_write_config_word(struct pci_bus *bus, unsigned int devfn,
540 int where, u16 val);
541int pci_bus_write_config_dword(struct pci_bus *bus, unsigned int devfn,
542 int where, u32 val);
1da177e4
LT
543
544static inline int pci_read_config_byte(struct pci_dev *dev, int where, u8 *val)
545{
05cca6e5 546 return pci_bus_read_config_byte(dev->bus, dev->devfn, where, val);
1da177e4
LT
547}
548static inline int pci_read_config_word(struct pci_dev *dev, int where, u16 *val)
549{
05cca6e5 550 return pci_bus_read_config_word(dev->bus, dev->devfn, where, val);
1da177e4 551}
05cca6e5
GKH
552static inline int pci_read_config_dword(struct pci_dev *dev, int where,
553 u32 *val)
1da177e4 554{
05cca6e5 555 return pci_bus_read_config_dword(dev->bus, dev->devfn, where, val);
1da177e4
LT
556}
557static inline int pci_write_config_byte(struct pci_dev *dev, int where, u8 val)
558{
05cca6e5 559 return pci_bus_write_config_byte(dev->bus, dev->devfn, where, val);
1da177e4
LT
560}
561static inline int pci_write_config_word(struct pci_dev *dev, int where, u16 val)
562{
05cca6e5 563 return pci_bus_write_config_word(dev->bus, dev->devfn, where, val);
1da177e4 564}
05cca6e5
GKH
565static inline int pci_write_config_dword(struct pci_dev *dev, int where,
566 u32 val)
1da177e4 567{
05cca6e5 568 return pci_bus_write_config_dword(dev->bus, dev->devfn, where, val);
1da177e4
LT
569}
570
4a7fb636 571int __must_check pci_enable_device(struct pci_dev *dev);
b718989d
BH
572int __must_check pci_enable_device_io(struct pci_dev *dev);
573int __must_check pci_enable_device_mem(struct pci_dev *dev);
0b62e13b 574int __must_check pci_reenable_device(struct pci_dev *);
9ac7849e
TH
575int __must_check pcim_enable_device(struct pci_dev *pdev);
576void pcim_pin_device(struct pci_dev *pdev);
577
578static inline int pci_is_managed(struct pci_dev *pdev)
579{
580 return pdev->is_managed;
581}
582
1da177e4
LT
583void pci_disable_device(struct pci_dev *dev);
584void pci_set_master(struct pci_dev *dev);
f7bdd12d 585int pci_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state);
1da177e4 586#define HAVE_PCI_SET_MWI
4a7fb636 587int __must_check pci_set_mwi(struct pci_dev *dev);
694625c0 588int pci_try_set_mwi(struct pci_dev *dev);
1da177e4 589void pci_clear_mwi(struct pci_dev *dev);
a04ce0ff 590void pci_intx(struct pci_dev *dev, int enable);
f5f2b131 591void pci_msi_off(struct pci_dev *dev);
9c8550ee
LT
592int pci_set_dma_mask(struct pci_dev *dev, u64 mask);
593int pci_set_consistent_dma_mask(struct pci_dev *dev, u64 mask);
4d57cdfa 594int pci_set_dma_max_seg_size(struct pci_dev *dev, unsigned int size);
59fc67de 595int pci_set_dma_seg_boundary(struct pci_dev *dev, unsigned long mask);
d556ad4b
PO
596int pcix_get_max_mmrbc(struct pci_dev *dev);
597int pcix_get_mmrbc(struct pci_dev *dev);
598int pcix_set_mmrbc(struct pci_dev *dev, int mmrbc);
2637e5b5 599int pcie_get_readrq(struct pci_dev *dev);
d556ad4b 600int pcie_set_readrq(struct pci_dev *dev, int rq);
064b53db 601void pci_update_resource(struct pci_dev *dev, struct resource *res, int resno);
4a7fb636 602int __must_check pci_assign_resource(struct pci_dev *dev, int i);
c87deff7 603int pci_select_bars(struct pci_dev *dev, unsigned long flags);
1da177e4
LT
604
605/* ROM control related routines */
144a50ea 606void __iomem __must_check *pci_map_rom(struct pci_dev *pdev, size_t *size);
1da177e4 607void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom);
d7ad2254 608size_t pci_get_rom_size(void __iomem *rom, size_t size);
1da177e4
LT
609
610/* Power management related routines */
611int pci_save_state(struct pci_dev *dev);
612int pci_restore_state(struct pci_dev *dev);
9c8550ee
LT
613int pci_set_power_state(struct pci_dev *dev, pci_power_t state);
614pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state);
615int pci_enable_wake(struct pci_dev *dev, pci_power_t state, int enable);
1da177e4 616
ce5ccdef 617/* Functions for PCI Hotplug drivers to use */
05cca6e5 618int pci_bus_find_capability(struct pci_bus *bus, unsigned int devfn, int cap);
ce5ccdef 619
1da177e4
LT
620/* Helper functions for low-level code (drivers/pci/setup-[bus,res].c) */
621void pci_bus_assign_resources(struct pci_bus *bus);
622void pci_bus_size_bridges(struct pci_bus *bus);
623int pci_claim_resource(struct pci_dev *, int);
624void pci_assign_unassigned_resources(void);
625void pdev_enable_device(struct pci_dev *);
626void pdev_sort_resources(struct pci_dev *, struct resource_list *);
627void pci_fixup_irqs(u8 (*)(struct pci_dev *, u8 *),
628 int (*)(struct pci_dev *, u8, u8));
629#define HAVE_PCI_REQ_REGIONS 2
4a7fb636 630int __must_check pci_request_regions(struct pci_dev *, const char *);
1da177e4 631void pci_release_regions(struct pci_dev *);
4a7fb636 632int __must_check pci_request_region(struct pci_dev *, int, const char *);
1da177e4 633void pci_release_region(struct pci_dev *, int);
c87deff7
HS
634int pci_request_selected_regions(struct pci_dev *, int, const char *);
635void pci_release_selected_regions(struct pci_dev *, int);
1da177e4
LT
636
637/* drivers/pci/bus.c */
4a7fb636
AM
638int __must_check pci_bus_alloc_resource(struct pci_bus *bus,
639 struct resource *res, resource_size_t size,
640 resource_size_t align, resource_size_t min,
641 unsigned int type_mask,
642 void (*alignf)(void *, struct resource *,
643 resource_size_t, resource_size_t),
644 void *alignf_data);
1da177e4
LT
645void pci_enable_bridges(struct pci_bus *bus);
646
863b18f4 647/* Proper probing supporting hot-pluggable devices */
725522b5
GKH
648int __must_check __pci_register_driver(struct pci_driver *, struct module *,
649 const char *mod_name);
4a7fb636 650static inline int __must_check pci_register_driver(struct pci_driver *driver)
863b18f4 651{
725522b5 652 return __pci_register_driver(driver, THIS_MODULE, KBUILD_MODNAME);
863b18f4
L
653}
654
05cca6e5
GKH
655void pci_unregister_driver(struct pci_driver *dev);
656void pci_remove_behind_bridge(struct pci_dev *dev);
657struct pci_driver *pci_dev_driver(const struct pci_dev *dev);
658const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
659 struct pci_dev *dev);
660int pci_scan_bridge(struct pci_bus *bus, struct pci_dev *dev, int max,
661 int pass);
1da177e4 662
cecf4864
PM
663void pci_walk_bus(struct pci_bus *top, void (*cb)(struct pci_dev *, void *),
664 void *userdata);
ac7dc65a 665int pci_cfg_space_size(struct pci_dev *dev);
05cca6e5 666unsigned char pci_bus_max_busnr(struct pci_bus *bus);
cecf4864 667
1da177e4
LT
668/* kmem_cache style wrapper around pci_alloc_consistent() */
669
670#include <linux/dmapool.h>
671
672#define pci_pool dma_pool
673#define pci_pool_create(name, pdev, size, align, allocation) \
674 dma_pool_create(name, &pdev->dev, size, align, allocation)
675#define pci_pool_destroy(pool) dma_pool_destroy(pool)
676#define pci_pool_alloc(pool, flags, handle) dma_pool_alloc(pool, flags, handle)
677#define pci_pool_free(pool, vaddr, addr) dma_pool_free(pool, vaddr, addr)
678
e24c2d96
DM
679enum pci_dma_burst_strategy {
680 PCI_DMA_BURST_INFINITY, /* make bursts as large as possible,
681 strategy_parameter is N/A */
682 PCI_DMA_BURST_BOUNDARY, /* disconnect at every strategy_parameter
683 byte boundaries */
684 PCI_DMA_BURST_MULTIPLE, /* disconnect at some multiple of
685 strategy_parameter byte boundaries */
686};
687
1da177e4
LT
688struct msix_entry {
689 u16 vector; /* kernel uses to write allocated vector */
690 u16 entry; /* driver uses to specify entry, OS writes */
691};
692
0366f8f7 693
1da177e4 694#ifndef CONFIG_PCI_MSI
05cca6e5
GKH
695static inline int pci_enable_msi(struct pci_dev *dev)
696{
697 return -1;
698}
699
700static inline void pci_disable_msi(struct pci_dev *dev)
701{ }
702
703static inline int pci_enable_msix(struct pci_dev *dev,
704 struct msix_entry *entries, int nvec)
705{
706 return -1;
707}
708
709static inline void pci_disable_msix(struct pci_dev *dev)
710{ }
711
712static inline void msi_remove_pci_irq_vectors(struct pci_dev *dev)
713{ }
714
715static inline void pci_restore_msi_state(struct pci_dev *dev)
716{ }
1da177e4 717#else
1da177e4
LT
718extern int pci_enable_msi(struct pci_dev *dev);
719extern void pci_disable_msi(struct pci_dev *dev);
05cca6e5 720extern int pci_enable_msix(struct pci_dev *dev,
1da177e4
LT
721 struct msix_entry *entries, int nvec);
722extern void pci_disable_msix(struct pci_dev *dev);
723extern void msi_remove_pci_irq_vectors(struct pci_dev *dev);
94688cf2 724extern void pci_restore_msi_state(struct pci_dev *dev);
1da177e4
LT
725#endif
726
8b955b0d 727#ifdef CONFIG_HT_IRQ
8b955b0d
EB
728/* The functions a driver should call */
729int ht_create_irq(struct pci_dev *dev, int idx);
730void ht_destroy_irq(unsigned int irq);
8b955b0d
EB
731#endif /* CONFIG_HT_IRQ */
732
e04b0ea2
BK
733extern void pci_block_user_cfg_access(struct pci_dev *dev);
734extern void pci_unblock_user_cfg_access(struct pci_dev *dev);
735
4352dfd5
GKH
736/*
737 * PCI domain support. Sometimes called PCI segment (eg by ACPI),
738 * a PCI domain is defined to be a set of PCI busses which share
739 * configuration space.
740 */
32a2eea7
JG
741#ifdef CONFIG_PCI_DOMAINS
742extern int pci_domains_supported;
743#else
744enum { pci_domains_supported = 0 };
05cca6e5
GKH
745static inline int pci_domain_nr(struct pci_bus *bus)
746{
747 return 0;
748}
749
4352dfd5
GKH
750static inline int pci_proc_domain(struct pci_bus *bus)
751{
752 return 0;
753}
32a2eea7 754#endif /* CONFIG_PCI_DOMAINS */
1da177e4 755
4352dfd5 756#else /* CONFIG_PCI is not enabled */
1da177e4
LT
757
758/*
759 * If the system does not have PCI, clearly these return errors. Define
760 * these as simple inline functions to avoid hair in drivers.
761 */
762
05cca6e5
GKH
763#define _PCI_NOP(o, s, t) \
764 static inline int pci_##o##_config_##s(struct pci_dev *dev, \
765 int where, t val) \
1da177e4 766 { return PCIBIOS_FUNC_NOT_SUPPORTED; }
05cca6e5
GKH
767
768#define _PCI_NOP_ALL(o, x) _PCI_NOP(o, byte, u8 x) \
769 _PCI_NOP(o, word, u16 x) \
770 _PCI_NOP(o, dword, u32 x)
1da177e4
LT
771_PCI_NOP_ALL(read, *)
772_PCI_NOP_ALL(write,)
773
05cca6e5
GKH
774static inline struct pci_dev *pci_find_device(unsigned int vendor,
775 unsigned int device,
776 const struct pci_dev *from)
777{
778 return NULL;
779}
1da177e4 780
05cca6e5
GKH
781static inline struct pci_dev *pci_find_slot(unsigned int bus,
782 unsigned int devfn)
783{
784 return NULL;
785}
1da177e4 786
d42552c3 787static inline struct pci_dev *pci_get_device(unsigned int vendor,
05cca6e5
GKH
788 unsigned int device,
789 struct pci_dev *from)
790{
791 return NULL;
792}
d42552c3
AM
793
794static inline struct pci_dev *pci_get_device_reverse(unsigned int vendor,
05cca6e5
GKH
795 unsigned int device,
796 struct pci_dev *from)
797{
798 return NULL;
799}
1da177e4 800
05cca6e5
GKH
801static inline struct pci_dev *pci_get_subsys(unsigned int vendor,
802 unsigned int device,
803 unsigned int ss_vendor,
804 unsigned int ss_device,
805 struct pci_dev *from)
806{
807 return NULL;
808}
1da177e4 809
05cca6e5
GKH
810static inline struct pci_dev *pci_get_class(unsigned int class,
811 struct pci_dev *from)
812{
813 return NULL;
814}
1da177e4
LT
815
816#define pci_dev_present(ids) (0)
ed4aaadb 817#define no_pci_devices() (1)
1da177e4
LT
818#define pci_dev_put(dev) do { } while (0)
819
05cca6e5
GKH
820static inline void pci_set_master(struct pci_dev *dev)
821{ }
822
823static inline int pci_enable_device(struct pci_dev *dev)
824{
825 return -EIO;
826}
827
828static inline void pci_disable_device(struct pci_dev *dev)
829{ }
830
831static inline int pci_set_dma_mask(struct pci_dev *dev, u64 mask)
832{
833 return -EIO;
834}
835
4d57cdfa
FT
836static inline int pci_set_dma_max_seg_size(struct pci_dev *dev,
837 unsigned int size)
838{
839 return -EIO;
840}
841
59fc67de
FT
842static inline int pci_set_dma_seg_boundary(struct pci_dev *dev,
843 unsigned long mask)
844{
845 return -EIO;
846}
847
05cca6e5
GKH
848static inline int pci_assign_resource(struct pci_dev *dev, int i)
849{
850 return -EBUSY;
851}
852
853static inline int __pci_register_driver(struct pci_driver *drv,
854 struct module *owner)
855{
856 return 0;
857}
858
859static inline int pci_register_driver(struct pci_driver *drv)
860{
861 return 0;
862}
863
864static inline void pci_unregister_driver(struct pci_driver *drv)
865{ }
866
867static inline int pci_find_capability(struct pci_dev *dev, int cap)
868{
869 return 0;
870}
871
872static inline int pci_find_next_capability(struct pci_dev *dev, u8 post,
873 int cap)
874{
875 return 0;
876}
877
878static inline int pci_find_ext_capability(struct pci_dev *dev, int cap)
879{
880 return 0;
881}
882
1da177e4 883/* Power management related routines */
05cca6e5
GKH
884static inline int pci_save_state(struct pci_dev *dev)
885{
886 return 0;
887}
888
889static inline int pci_restore_state(struct pci_dev *dev)
890{
891 return 0;
892}
1da177e4 893
05cca6e5
GKH
894static inline int pci_set_power_state(struct pci_dev *dev, pci_power_t state)
895{
896 return 0;
897}
898
899static inline pci_power_t pci_choose_state(struct pci_dev *dev,
900 pm_message_t state)
901{
902 return PCI_D0;
903}
904
905static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
906 int enable)
907{
908 return 0;
909}
910
911static inline int pci_request_regions(struct pci_dev *dev, const char *res_name)
912{
913 return -EIO;
914}
915
916static inline void pci_release_regions(struct pci_dev *dev)
917{ }
0da0ead9 918
a46e8126
KG
919#define pci_dma_burst_advice(pdev, strat, strategy_parameter) do { } while (0)
920
05cca6e5
GKH
921static inline void pci_block_user_cfg_access(struct pci_dev *dev)
922{ }
923
924static inline void pci_unblock_user_cfg_access(struct pci_dev *dev)
925{ }
e04b0ea2 926
d80d0217
RD
927static inline struct pci_bus *pci_find_next_bus(const struct pci_bus *from)
928{ return NULL; }
929
930static inline struct pci_dev *pci_get_slot(struct pci_bus *bus,
931 unsigned int devfn)
932{ return NULL; }
933
934static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
935 unsigned int devfn)
936{ return NULL; }
937
4352dfd5 938#endif /* CONFIG_PCI */
1da177e4 939
4352dfd5
GKH
940/* Include architecture-dependent settings and functions */
941
942#include <asm/pci.h>
1da177e4
LT
943
944/* these helpers provide future and backwards compatibility
945 * for accessing popular PCI BAR info */
05cca6e5
GKH
946#define pci_resource_start(dev, bar) ((dev)->resource[(bar)].start)
947#define pci_resource_end(dev, bar) ((dev)->resource[(bar)].end)
948#define pci_resource_flags(dev, bar) ((dev)->resource[(bar)].flags)
1da177e4 949#define pci_resource_len(dev,bar) \
05cca6e5
GKH
950 ((pci_resource_start((dev), (bar)) == 0 && \
951 pci_resource_end((dev), (bar)) == \
952 pci_resource_start((dev), (bar))) ? 0 : \
953 \
954 (pci_resource_end((dev), (bar)) - \
955 pci_resource_start((dev), (bar)) + 1))
1da177e4
LT
956
957/* Similar to the helpers above, these manipulate per-pci_dev
958 * driver-specific data. They are really just a wrapper around
959 * the generic device structure functions of these calls.
960 */
05cca6e5 961static inline void *pci_get_drvdata(struct pci_dev *pdev)
1da177e4
LT
962{
963 return dev_get_drvdata(&pdev->dev);
964}
965
05cca6e5 966static inline void pci_set_drvdata(struct pci_dev *pdev, void *data)
1da177e4
LT
967{
968 dev_set_drvdata(&pdev->dev, data);
969}
970
971/* If you want to know what to call your pci_dev, ask this function.
972 * Again, it's a wrapper around the generic device.
973 */
974static inline char *pci_name(struct pci_dev *pdev)
975{
976 return pdev->dev.bus_id;
977}
978
2311b1f2
ME
979
980/* Some archs don't want to expose struct resource to userland as-is
981 * in sysfs and /proc
982 */
983#ifndef HAVE_ARCH_PCI_RESOURCE_TO_USER
984static inline void pci_resource_to_user(const struct pci_dev *dev, int bar,
05cca6e5 985 const struct resource *rsrc, resource_size_t *start,
e31dd6e4 986 resource_size_t *end)
2311b1f2
ME
987{
988 *start = rsrc->start;
989 *end = rsrc->end;
990}
991#endif /* HAVE_ARCH_PCI_RESOURCE_TO_USER */
992
993
1da177e4
LT
994/*
995 * The world is not perfect and supplies us with broken PCI devices.
996 * For at least a part of these bugs we need a work-around, so both
997 * generic (drivers/pci/quirks.c) and per-architecture code can define
998 * fixup hooks to be called for particular buggy devices.
999 */
1000
1001struct pci_fixup {
1002 u16 vendor, device; /* You can use PCI_ANY_ID here of course */
1003 void (*hook)(struct pci_dev *dev);
1004};
1005
1006enum pci_fixup_pass {
1007 pci_fixup_early, /* Before probing BARs */
1008 pci_fixup_header, /* After reading configuration header */
1009 pci_fixup_final, /* Final phase of device fixups */
1010 pci_fixup_enable, /* pci_enable_device() time */
1597cacb 1011 pci_fixup_resume, /* pci_enable_device() time */
1da177e4
LT
1012};
1013
1014/* Anonymous variables would be nice... */
1015#define DECLARE_PCI_FIXUP_SECTION(section, name, vendor, device, hook) \
3ff6eecc 1016 static const struct pci_fixup __pci_fixup_##name __used \
1da177e4
LT
1017 __attribute__((__section__(#section))) = { vendor, device, hook };
1018#define DECLARE_PCI_FIXUP_EARLY(vendor, device, hook) \
1019 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early, \
1020 vendor##device##hook, vendor, device, hook)
1021#define DECLARE_PCI_FIXUP_HEADER(vendor, device, hook) \
1022 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header, \
1023 vendor##device##hook, vendor, device, hook)
1024#define DECLARE_PCI_FIXUP_FINAL(vendor, device, hook) \
1025 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final, \
1026 vendor##device##hook, vendor, device, hook)
1027#define DECLARE_PCI_FIXUP_ENABLE(vendor, device, hook) \
1028 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable, \
1029 vendor##device##hook, vendor, device, hook)
1597cacb
AC
1030#define DECLARE_PCI_FIXUP_RESUME(vendor, device, hook) \
1031 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume, \
1032 resume##vendor##device##hook, vendor, device, hook)
1da177e4
LT
1033
1034
1035void pci_fixup_device(enum pci_fixup_pass pass, struct pci_dev *dev);
1036
05cca6e5 1037void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen);
5ea81769 1038void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr);
05cca6e5 1039void __iomem * const *pcim_iomap_table(struct pci_dev *pdev);
5ea81769 1040int pcim_iomap_regions(struct pci_dev *pdev, u16 mask, const char *name);
916fbfb7
TH
1041int pcim_iomap_regions_request_all(struct pci_dev *pdev, u16 mask,
1042 const char *name);
ec04b075 1043void pcim_iounmap_regions(struct pci_dev *pdev, u16 mask);
5ea81769 1044
1da177e4 1045extern int pci_pci_problems;
236561e5 1046#define PCIPCI_FAIL 1 /* No PCI PCI DMA */
1da177e4
LT
1047#define PCIPCI_TRITON 2
1048#define PCIPCI_NATOMA 4
1049#define PCIPCI_VIAETBF 8
1050#define PCIPCI_VSFX 16
236561e5
AC
1051#define PCIPCI_ALIMAGIK 32 /* Need low latency setting */
1052#define PCIAGP_FAIL 64 /* No PCI to AGP DMA */
1da177e4 1053
4516a618
AN
1054extern unsigned long pci_cardbus_io_size;
1055extern unsigned long pci_cardbus_mem_size;
1056
a2cd52ca 1057extern int pcibios_add_platform_entries(struct pci_dev *dev);
575e3348 1058
1da177e4
LT
1059#endif /* __KERNEL__ */
1060#endif /* LINUX_PCI_H */
This page took 0.509653 seconds and 5 git commands to generate.