4 * PCI defines and function prototypes
5 * Copyright 1994, Drew Eckhardt
6 * Copyright 1997--1999 Martin Mares <mj@ucw.cz>
8 * For more information, please consult the following manuals (look at
9 * http://www.pcisig.com/ for how to get them):
11 * PCI BIOS Specification
12 * PCI Local Bus Specification
13 * PCI to PCI Bridge Specification
14 * PCI System Design Guide
20 #include <linux/pci_regs.h> /* The pci register defines */
23 * The PCI interface treats multi-function devices as independent
24 * devices. The slot/function address of each device is encoded
25 * in a single byte as follows:
30 #define PCI_DEVFN(slot, func) ((((slot) & 0x1f) << 3) | ((func) & 0x07))
31 #define PCI_SLOT(devfn) (((devfn) >> 3) & 0x1f)
32 #define PCI_FUNC(devfn) ((devfn) & 0x07)
34 /* Ioctls for /proc/bus/pci/X/Y nodes. */
35 #define PCIIOC_BASE ('P' << 24 | 'C' << 16 | 'I' << 8)
36 #define PCIIOC_CONTROLLER (PCIIOC_BASE | 0x00) /* Get controller for PCI device. */
37 #define PCIIOC_MMAP_IS_IO (PCIIOC_BASE | 0x01) /* Set mmap state to I/O space. */
38 #define PCIIOC_MMAP_IS_MEM (PCIIOC_BASE | 0x02) /* Set mmap state to MEM space. */
39 #define PCIIOC_WRITE_COMBINE (PCIIOC_BASE | 0x03) /* Enable/disable write-combining. */
43 #include <linux/mod_devicetable.h>
45 #include <linux/types.h>
46 #include <linux/init.h>
47 #include <linux/ioport.h>
48 #include <linux/list.h>
49 #include <linux/compiler.h>
50 #include <linux/errno.h>
51 #include <linux/kobject.h>
52 #include <asm/atomic.h>
53 #include <linux/device.h>
56 /* Include the ID list */
57 #include <linux/pci_ids.h>
59 /* pci_slot represents a physical slot */
61 struct pci_bus *bus; /* The bus this slot is on */
62 struct list_head list; /* node in list of slots on this bus */
63 struct hotplug_slot *hotplug; /* Hotplug info (migrate over time) */
64 unsigned char number; /* PCI_SLOT(pci_dev->devfn) */
68 static inline const char *pci_slot_name(const struct pci_slot *slot)
70 return kobject_name(&slot->kobj);
73 /* File state for mmap()s on /proc/bus/pci/X/Y */
79 /* This defines the direction arg to the DMA mapping routines. */
80 #define PCI_DMA_BIDIRECTIONAL 0
81 #define PCI_DMA_TODEVICE 1
82 #define PCI_DMA_FROMDEVICE 2
83 #define PCI_DMA_NONE 3
86 * For PCI devices, the region numbers are assigned this way:
89 /* #0-5: standard PCI resources */
91 PCI_STD_RESOURCE_END = 5,
93 /* #6: expansion ROM resource */
96 /* device specific resources */
99 PCI_IOV_RESOURCE_END = PCI_IOV_RESOURCES + PCI_SRIOV_NUM_BARS - 1,
102 /* resources assigned to buses behind the bridge */
103 #define PCI_BRIDGE_RESOURCE_NUM 4
105 PCI_BRIDGE_RESOURCES,
106 PCI_BRIDGE_RESOURCE_END = PCI_BRIDGE_RESOURCES +
107 PCI_BRIDGE_RESOURCE_NUM - 1,
109 /* total resources associated with a PCI device */
112 /* preserve this for compatibility */
113 DEVICE_COUNT_RESOURCE
116 typedef int __bitwise pci_power_t;
118 #define PCI_D0 ((pci_power_t __force) 0)
119 #define PCI_D1 ((pci_power_t __force) 1)
120 #define PCI_D2 ((pci_power_t __force) 2)
121 #define PCI_D3hot ((pci_power_t __force) 3)
122 #define PCI_D3cold ((pci_power_t __force) 4)
123 #define PCI_UNKNOWN ((pci_power_t __force) 5)
124 #define PCI_POWER_ERROR ((pci_power_t __force) -1)
126 #define PCI_PM_D2_DELAY 200
127 #define PCI_PM_D3_WAIT 10
128 #define PCI_PM_BUS_WAIT 50
130 /** The pci_channel state describes connectivity between the CPU and
131 * the pci device. If some PCI bus between here and the pci device
132 * has crashed or locked up, this info is reflected here.
134 typedef unsigned int __bitwise pci_channel_state_t;
136 enum pci_channel_state {
137 /* I/O channel is in normal state */
138 pci_channel_io_normal = (__force pci_channel_state_t) 1,
140 /* I/O to channel is blocked */
141 pci_channel_io_frozen = (__force pci_channel_state_t) 2,
143 /* PCI card is dead */
144 pci_channel_io_perm_failure = (__force pci_channel_state_t) 3,
147 typedef unsigned int __bitwise pcie_reset_state_t;
149 enum pcie_reset_state {
150 /* Reset is NOT asserted (Use to deassert reset) */
151 pcie_deassert_reset = (__force pcie_reset_state_t) 1,
153 /* Use #PERST to reset PCI-E device */
154 pcie_warm_reset = (__force pcie_reset_state_t) 2,
156 /* Use PCI-E Hot Reset to reset device */
157 pcie_hot_reset = (__force pcie_reset_state_t) 3
160 typedef unsigned short __bitwise pci_dev_flags_t;
162 /* INTX_DISABLE in PCI_COMMAND register disables MSI
165 PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG = (__force pci_dev_flags_t) 1,
166 /* Device configuration is irrevocably lost if disabled into D3 */
167 PCI_DEV_FLAGS_NO_D3 = (__force pci_dev_flags_t) 2,
170 enum pci_irq_reroute_variant {
171 INTEL_IRQ_REROUTE_VARIANT = 1,
172 MAX_IRQ_REROUTE_VARIANTS = 3
175 typedef unsigned short __bitwise pci_bus_flags_t;
177 PCI_BUS_FLAGS_NO_MSI = (__force pci_bus_flags_t) 1,
178 PCI_BUS_FLAGS_NO_MMRBC = (__force pci_bus_flags_t) 2,
181 struct pci_cap_saved_state {
182 struct hlist_node next;
187 struct pcie_link_state;
192 * The pci_dev structure is used to describe PCI devices.
195 struct list_head bus_list; /* node in per-bus list */
196 struct pci_bus *bus; /* bus this device is on */
197 struct pci_bus *subordinate; /* bus this device bridges to */
199 void *sysdata; /* hook for sys-specific extension */
200 struct proc_dir_entry *procent; /* device entry in /proc/bus/pci */
201 struct pci_slot *slot; /* Physical slot this device is in */
203 unsigned int devfn; /* encoded device & function index */
204 unsigned short vendor;
205 unsigned short device;
206 unsigned short subsystem_vendor;
207 unsigned short subsystem_device;
208 unsigned int class; /* 3 bytes: (base,sub,prog-if) */
209 u8 revision; /* PCI revision, low byte of class word */
210 u8 hdr_type; /* PCI header type (`multi' flag masked out) */
211 u8 pcie_type; /* PCI-E device/port type */
212 u8 rom_base_reg; /* which config register controls the ROM */
213 u8 pin; /* which interrupt pin this device uses */
215 struct pci_driver *driver; /* which driver has allocated this device */
216 u64 dma_mask; /* Mask of the bits of bus address this
217 device implements. Normally this is
218 0xffffffff. You only need to change
219 this if your device has broken DMA
220 or supports 64-bit transfers. */
222 struct device_dma_parameters dma_parms;
224 pci_power_t current_state; /* Current operating state. In ACPI-speak,
225 this is D0-D3, D0 being fully functional,
227 int pm_cap; /* PM capability offset in the
228 configuration space */
229 unsigned int pme_support:5; /* Bitmask of states from which PME#
231 unsigned int d1_support:1; /* Low power state D1 is supported */
232 unsigned int d2_support:1; /* Low power state D2 is supported */
233 unsigned int no_d1d2:1; /* Only allow D0 and D3 */
235 #ifdef CONFIG_PCIEASPM
236 struct pcie_link_state *link_state; /* ASPM link state. */
239 pci_channel_state_t error_state; /* current connectivity state */
240 struct device dev; /* Generic device interface */
242 int cfg_size; /* Size of configuration space */
245 * Instead of touching interrupt line and base address registers
246 * directly, use the values stored here. They might be different!
249 struct resource resource[DEVICE_COUNT_RESOURCE]; /* I/O and memory regions + expansion ROMs */
251 /* These fields are used by common fixups */
252 unsigned int transparent:1; /* Transparent PCI bridge */
253 unsigned int multifunction:1;/* Part of multi-function device */
254 /* keep track of device state */
255 unsigned int is_added:1;
256 unsigned int is_busmaster:1; /* device is busmaster */
257 unsigned int no_msi:1; /* device may not use msi */
258 unsigned int block_ucfg_access:1; /* userspace config space access is blocked */
259 unsigned int broken_parity_status:1; /* Device generates false positive parity */
260 unsigned int irq_reroute_variant:2; /* device needs IRQ rerouting variant */
261 unsigned int msi_enabled:1;
262 unsigned int msix_enabled:1;
263 unsigned int ari_enabled:1; /* ARI forwarding */
264 unsigned int is_managed:1;
265 unsigned int is_pcie:1;
266 unsigned int state_saved:1;
267 unsigned int is_physfn:1;
268 unsigned int is_virtfn:1;
269 pci_dev_flags_t dev_flags;
270 atomic_t enable_cnt; /* pci_enable_device has been called */
272 u32 saved_config_space[16]; /* config space saved at suspend time */
273 struct hlist_head saved_cap_space;
274 struct bin_attribute *rom_attr; /* attribute descriptor for sysfs ROM entry */
275 int rom_attr_enabled; /* has display of the rom attribute been enabled? */
276 struct bin_attribute *res_attr[DEVICE_COUNT_RESOURCE]; /* sysfs file for resources */
277 struct bin_attribute *res_attr_wc[DEVICE_COUNT_RESOURCE]; /* sysfs file for WC mapping of resources */
278 #ifdef CONFIG_PCI_MSI
279 struct list_head msi_list;
282 #ifdef CONFIG_PCI_IOV
284 struct pci_sriov *sriov; /* SR-IOV capability related */
285 struct pci_dev *physfn; /* the PF this VF is associated with */
290 extern struct pci_dev *alloc_pci_dev(void);
292 #define pci_dev_b(n) list_entry(n, struct pci_dev, bus_list)
293 #define to_pci_dev(n) container_of(n, struct pci_dev, dev)
294 #define for_each_pci_dev(d) while ((d = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, d)) != NULL)
296 static inline int pci_channel_offline(struct pci_dev *pdev)
298 return (pdev->error_state != pci_channel_io_normal);
301 static inline struct pci_cap_saved_state *pci_find_saved_cap(
302 struct pci_dev *pci_dev, char cap)
304 struct pci_cap_saved_state *tmp;
305 struct hlist_node *pos;
307 hlist_for_each_entry(tmp, pos, &pci_dev->saved_cap_space, next) {
308 if (tmp->cap_nr == cap)
314 static inline void pci_add_saved_cap(struct pci_dev *pci_dev,
315 struct pci_cap_saved_state *new_cap)
317 hlist_add_head(&new_cap->next, &pci_dev->saved_cap_space);
320 #ifndef PCI_BUS_NUM_RESOURCES
321 #define PCI_BUS_NUM_RESOURCES 16
324 #define PCI_REGION_FLAG_MASK 0x0fU /* These bits of resource flags tell us the PCI region flags */
327 struct list_head node; /* node in list of buses */
328 struct pci_bus *parent; /* parent bus this bridge is on */
329 struct list_head children; /* list of child buses */
330 struct list_head devices; /* list of devices on this bus */
331 struct pci_dev *self; /* bridge device as seen by parent */
332 struct list_head slots; /* list of slots on this bus */
333 struct resource *resource[PCI_BUS_NUM_RESOURCES];
334 /* address space routed to this bus */
336 struct pci_ops *ops; /* configuration access functions */
337 void *sysdata; /* hook for sys-specific extension */
338 struct proc_dir_entry *procdir; /* directory entry in /proc/bus/pci */
340 unsigned char number; /* bus number */
341 unsigned char primary; /* number of primary bridge */
342 unsigned char secondary; /* number of secondary bridge */
343 unsigned char subordinate; /* max number of subordinate buses */
347 unsigned short bridge_ctl; /* manage NO_ISA/FBB/et al behaviors */
348 pci_bus_flags_t bus_flags; /* Inherited by child busses */
349 struct device *bridge;
351 struct bin_attribute *legacy_io; /* legacy I/O for this bus */
352 struct bin_attribute *legacy_mem; /* legacy mem */
353 unsigned int is_added:1;
356 #define pci_bus_b(n) list_entry(n, struct pci_bus, node)
357 #define to_pci_bus(n) container_of(n, struct pci_bus, dev)
359 #ifdef CONFIG_PCI_MSI
360 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev)
362 return pci_dev->msi_enabled || pci_dev->msix_enabled;
365 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev) { return false; }
369 * Error values that may be returned by PCI functions.
371 #define PCIBIOS_SUCCESSFUL 0x00
372 #define PCIBIOS_FUNC_NOT_SUPPORTED 0x81
373 #define PCIBIOS_BAD_VENDOR_ID 0x83
374 #define PCIBIOS_DEVICE_NOT_FOUND 0x86
375 #define PCIBIOS_BAD_REGISTER_NUMBER 0x87
376 #define PCIBIOS_SET_FAILED 0x88
377 #define PCIBIOS_BUFFER_TOO_SMALL 0x89
379 /* Low-level architecture-dependent routines */
382 int (*read)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 *val);
383 int (*write)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 val);
387 * ACPI needs to be able to access PCI config space before we've done a
388 * PCI bus scan and created pci_bus structures.
390 extern int raw_pci_read(unsigned int domain, unsigned int bus,
391 unsigned int devfn, int reg, int len, u32 *val);
392 extern int raw_pci_write(unsigned int domain, unsigned int bus,
393 unsigned int devfn, int reg, int len, u32 val);
395 struct pci_bus_region {
396 resource_size_t start;
401 spinlock_t lock; /* protects list, index */
402 struct list_head list; /* for IDs added at runtime */
405 /* ---------------------------------------------------------------- */
406 /** PCI Error Recovery System (PCI-ERS). If a PCI device driver provides
407 * a set of callbacks in struct pci_error_handlers, then that device driver
408 * will be notified of PCI bus errors, and will be driven to recovery
409 * when an error occurs.
412 typedef unsigned int __bitwise pci_ers_result_t;
414 enum pci_ers_result {
415 /* no result/none/not supported in device driver */
416 PCI_ERS_RESULT_NONE = (__force pci_ers_result_t) 1,
418 /* Device driver can recover without slot reset */
419 PCI_ERS_RESULT_CAN_RECOVER = (__force pci_ers_result_t) 2,
421 /* Device driver wants slot to be reset. */
422 PCI_ERS_RESULT_NEED_RESET = (__force pci_ers_result_t) 3,
424 /* Device has completely failed, is unrecoverable */
425 PCI_ERS_RESULT_DISCONNECT = (__force pci_ers_result_t) 4,
427 /* Device driver is fully recovered and operational */
428 PCI_ERS_RESULT_RECOVERED = (__force pci_ers_result_t) 5,
431 /* PCI bus error event callbacks */
432 struct pci_error_handlers {
433 /* PCI bus error detected on this device */
434 pci_ers_result_t (*error_detected)(struct pci_dev *dev,
435 enum pci_channel_state error);
437 /* MMIO has been re-enabled, but not DMA */
438 pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev);
440 /* PCI Express link has been reset */
441 pci_ers_result_t (*link_reset)(struct pci_dev *dev);
443 /* PCI slot has been reset */
444 pci_ers_result_t (*slot_reset)(struct pci_dev *dev);
446 /* Device driver may resume normal operations */
447 void (*resume)(struct pci_dev *dev);
450 /* ---------------------------------------------------------------- */
454 struct list_head node;
456 const struct pci_device_id *id_table; /* must be non-NULL for probe to be called */
457 int (*probe) (struct pci_dev *dev, const struct pci_device_id *id); /* New device inserted */
458 void (*remove) (struct pci_dev *dev); /* Device removed (NULL if not a hot-plug capable driver) */
459 int (*suspend) (struct pci_dev *dev, pm_message_t state); /* Device suspended */
460 int (*suspend_late) (struct pci_dev *dev, pm_message_t state);
461 int (*resume_early) (struct pci_dev *dev);
462 int (*resume) (struct pci_dev *dev); /* Device woken up */
463 void (*shutdown) (struct pci_dev *dev);
464 struct pci_error_handlers *err_handler;
465 struct device_driver driver;
466 struct pci_dynids dynids;
469 #define to_pci_driver(drv) container_of(drv, struct pci_driver, driver)
472 * DEFINE_PCI_DEVICE_TABLE - macro used to describe a pci device table
473 * @_table: device table name
475 * This macro is used to create a struct pci_device_id array (a device table)
476 * in a generic manner.
478 #define DEFINE_PCI_DEVICE_TABLE(_table) \
479 const struct pci_device_id _table[] __devinitconst
482 * PCI_DEVICE - macro used to describe a specific pci device
483 * @vend: the 16 bit PCI Vendor ID
484 * @dev: the 16 bit PCI Device ID
486 * This macro is used to create a struct pci_device_id that matches a
487 * specific device. The subvendor and subdevice fields will be set to
490 #define PCI_DEVICE(vend,dev) \
491 .vendor = (vend), .device = (dev), \
492 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
495 * PCI_DEVICE_CLASS - macro used to describe a specific pci device class
496 * @dev_class: the class, subclass, prog-if triple for this device
497 * @dev_class_mask: the class mask for this device
499 * This macro is used to create a struct pci_device_id that matches a
500 * specific PCI class. The vendor, device, subvendor, and subdevice
501 * fields will be set to PCI_ANY_ID.
503 #define PCI_DEVICE_CLASS(dev_class,dev_class_mask) \
504 .class = (dev_class), .class_mask = (dev_class_mask), \
505 .vendor = PCI_ANY_ID, .device = PCI_ANY_ID, \
506 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
509 * PCI_VDEVICE - macro used to describe a specific pci device in short form
510 * @vendor: the vendor name
511 * @device: the 16 bit PCI Device ID
513 * This macro is used to create a struct pci_device_id that matches a
514 * specific PCI device. The subvendor, and subdevice fields will be set
515 * to PCI_ANY_ID. The macro allows the next field to follow as the device
519 #define PCI_VDEVICE(vendor, device) \
520 PCI_VENDOR_ID_##vendor, (device), \
521 PCI_ANY_ID, PCI_ANY_ID, 0, 0
523 /* these external functions are only available when PCI support is enabled */
526 extern struct bus_type pci_bus_type;
528 /* Do NOT directly access these two variables, unless you are arch specific pci
529 * code, or pci core code. */
530 extern struct list_head pci_root_buses; /* list of all known PCI buses */
531 /* Some device drivers need know if pci is initiated */
532 extern int no_pci_devices(void);
534 void pcibios_fixup_bus(struct pci_bus *);
535 int __must_check pcibios_enable_device(struct pci_dev *, int mask);
536 char *pcibios_setup(char *str);
538 /* Used only when drivers/pci/setup.c is used */
539 void pcibios_align_resource(void *, struct resource *, resource_size_t,
541 void pcibios_update_irq(struct pci_dev *, int irq);
543 /* Generic PCI functions used internally */
545 extern struct pci_bus *pci_find_bus(int domain, int busnr);
546 void pci_bus_add_devices(const struct pci_bus *bus);
547 struct pci_bus *pci_scan_bus_parented(struct device *parent, int bus,
548 struct pci_ops *ops, void *sysdata);
549 static inline struct pci_bus * __devinit pci_scan_bus(int bus, struct pci_ops *ops,
552 struct pci_bus *root_bus;
553 root_bus = pci_scan_bus_parented(NULL, bus, ops, sysdata);
555 pci_bus_add_devices(root_bus);
558 struct pci_bus *pci_create_bus(struct device *parent, int bus,
559 struct pci_ops *ops, void *sysdata);
560 struct pci_bus *pci_add_new_bus(struct pci_bus *parent, struct pci_dev *dev,
562 struct pci_slot *pci_create_slot(struct pci_bus *parent, int slot_nr,
564 struct hotplug_slot *hotplug);
565 void pci_destroy_slot(struct pci_slot *slot);
566 void pci_renumber_slot(struct pci_slot *slot, int slot_nr);
567 int pci_scan_slot(struct pci_bus *bus, int devfn);
568 struct pci_dev *pci_scan_single_device(struct pci_bus *bus, int devfn);
569 void pci_device_add(struct pci_dev *dev, struct pci_bus *bus);
570 unsigned int pci_scan_child_bus(struct pci_bus *bus);
571 int __must_check pci_bus_add_device(struct pci_dev *dev);
572 void pci_read_bridge_bases(struct pci_bus *child);
573 struct resource *pci_find_parent_resource(const struct pci_dev *dev,
574 struct resource *res);
575 u8 pci_swizzle_interrupt_pin(struct pci_dev *dev, u8 pin);
576 int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge);
577 u8 pci_common_swizzle(struct pci_dev *dev, u8 *pinp);
578 extern struct pci_dev *pci_dev_get(struct pci_dev *dev);
579 extern void pci_dev_put(struct pci_dev *dev);
580 extern void pci_remove_bus(struct pci_bus *b);
581 extern void pci_remove_bus_device(struct pci_dev *dev);
582 extern void pci_stop_bus_device(struct pci_dev *dev);
583 void pci_setup_cardbus(struct pci_bus *bus);
584 extern void pci_sort_breadthfirst(void);
586 /* Generic PCI functions exported to card drivers */
588 #ifdef CONFIG_PCI_LEGACY
589 struct pci_dev __deprecated *pci_find_device(unsigned int vendor,
591 struct pci_dev *from);
592 struct pci_dev __deprecated *pci_find_slot(unsigned int bus,
594 #endif /* CONFIG_PCI_LEGACY */
596 enum pci_lost_interrupt_reason {
597 PCI_LOST_IRQ_NO_INFORMATION = 0,
598 PCI_LOST_IRQ_DISABLE_MSI,
599 PCI_LOST_IRQ_DISABLE_MSIX,
600 PCI_LOST_IRQ_DISABLE_ACPI,
602 enum pci_lost_interrupt_reason pci_lost_interrupt(struct pci_dev *dev);
603 int pci_find_capability(struct pci_dev *dev, int cap);
604 int pci_find_next_capability(struct pci_dev *dev, u8 pos, int cap);
605 int pci_find_ext_capability(struct pci_dev *dev, int cap);
606 int pci_find_ht_capability(struct pci_dev *dev, int ht_cap);
607 int pci_find_next_ht_capability(struct pci_dev *dev, int pos, int ht_cap);
608 struct pci_bus *pci_find_next_bus(const struct pci_bus *from);
610 struct pci_dev *pci_get_device(unsigned int vendor, unsigned int device,
611 struct pci_dev *from);
612 struct pci_dev *pci_get_subsys(unsigned int vendor, unsigned int device,
613 unsigned int ss_vendor, unsigned int ss_device,
614 struct pci_dev *from);
615 struct pci_dev *pci_get_slot(struct pci_bus *bus, unsigned int devfn);
616 struct pci_dev *pci_get_bus_and_slot(unsigned int bus, unsigned int devfn);
617 struct pci_dev *pci_get_class(unsigned int class, struct pci_dev *from);
618 int pci_dev_present(const struct pci_device_id *ids);
620 int pci_bus_read_config_byte(struct pci_bus *bus, unsigned int devfn,
622 int pci_bus_read_config_word(struct pci_bus *bus, unsigned int devfn,
623 int where, u16 *val);
624 int pci_bus_read_config_dword(struct pci_bus *bus, unsigned int devfn,
625 int where, u32 *val);
626 int pci_bus_write_config_byte(struct pci_bus *bus, unsigned int devfn,
628 int pci_bus_write_config_word(struct pci_bus *bus, unsigned int devfn,
630 int pci_bus_write_config_dword(struct pci_bus *bus, unsigned int devfn,
633 static inline int pci_read_config_byte(struct pci_dev *dev, int where, u8 *val)
635 return pci_bus_read_config_byte(dev->bus, dev->devfn, where, val);
637 static inline int pci_read_config_word(struct pci_dev *dev, int where, u16 *val)
639 return pci_bus_read_config_word(dev->bus, dev->devfn, where, val);
641 static inline int pci_read_config_dword(struct pci_dev *dev, int where,
644 return pci_bus_read_config_dword(dev->bus, dev->devfn, where, val);
646 static inline int pci_write_config_byte(struct pci_dev *dev, int where, u8 val)
648 return pci_bus_write_config_byte(dev->bus, dev->devfn, where, val);
650 static inline int pci_write_config_word(struct pci_dev *dev, int where, u16 val)
652 return pci_bus_write_config_word(dev->bus, dev->devfn, where, val);
654 static inline int pci_write_config_dword(struct pci_dev *dev, int where,
657 return pci_bus_write_config_dword(dev->bus, dev->devfn, where, val);
660 int __must_check pci_enable_device(struct pci_dev *dev);
661 int __must_check pci_enable_device_io(struct pci_dev *dev);
662 int __must_check pci_enable_device_mem(struct pci_dev *dev);
663 int __must_check pci_reenable_device(struct pci_dev *);
664 int __must_check pcim_enable_device(struct pci_dev *pdev);
665 void pcim_pin_device(struct pci_dev *pdev);
667 static inline int pci_is_managed(struct pci_dev *pdev)
669 return pdev->is_managed;
672 void pci_disable_device(struct pci_dev *dev);
673 void pci_set_master(struct pci_dev *dev);
674 void pci_clear_master(struct pci_dev *dev);
675 int pci_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state);
676 #define HAVE_PCI_SET_MWI
677 int __must_check pci_set_mwi(struct pci_dev *dev);
678 int pci_try_set_mwi(struct pci_dev *dev);
679 void pci_clear_mwi(struct pci_dev *dev);
680 void pci_intx(struct pci_dev *dev, int enable);
681 void pci_msi_off(struct pci_dev *dev);
682 int pci_set_dma_mask(struct pci_dev *dev, u64 mask);
683 int pci_set_consistent_dma_mask(struct pci_dev *dev, u64 mask);
684 int pci_set_dma_max_seg_size(struct pci_dev *dev, unsigned int size);
685 int pci_set_dma_seg_boundary(struct pci_dev *dev, unsigned long mask);
686 int pcix_get_max_mmrbc(struct pci_dev *dev);
687 int pcix_get_mmrbc(struct pci_dev *dev);
688 int pcix_set_mmrbc(struct pci_dev *dev, int mmrbc);
689 int pcie_get_readrq(struct pci_dev *dev);
690 int pcie_set_readrq(struct pci_dev *dev, int rq);
691 int pci_reset_function(struct pci_dev *dev);
692 int pci_execute_reset_function(struct pci_dev *dev);
693 void pci_update_resource(struct pci_dev *dev, int resno);
694 int __must_check pci_assign_resource(struct pci_dev *dev, int i);
695 int pci_select_bars(struct pci_dev *dev, unsigned long flags);
697 /* ROM control related routines */
698 int pci_enable_rom(struct pci_dev *pdev);
699 void pci_disable_rom(struct pci_dev *pdev);
700 void __iomem __must_check *pci_map_rom(struct pci_dev *pdev, size_t *size);
701 void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom);
702 size_t pci_get_rom_size(struct pci_dev *pdev, void __iomem *rom, size_t size);
704 /* Power management related routines */
705 int pci_save_state(struct pci_dev *dev);
706 int pci_restore_state(struct pci_dev *dev);
707 int pci_set_power_state(struct pci_dev *dev, pci_power_t state);
708 pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state);
709 bool pci_pme_capable(struct pci_dev *dev, pci_power_t state);
710 void pci_pme_active(struct pci_dev *dev, bool enable);
711 int pci_enable_wake(struct pci_dev *dev, pci_power_t state, int enable);
712 int pci_wake_from_d3(struct pci_dev *dev, bool enable);
713 pci_power_t pci_target_state(struct pci_dev *dev);
714 int pci_prepare_to_sleep(struct pci_dev *dev);
715 int pci_back_from_sleep(struct pci_dev *dev);
717 /* Functions for PCI Hotplug drivers to use */
718 int pci_bus_find_capability(struct pci_bus *bus, unsigned int devfn, int cap);
720 /* Vital product data routines */
721 ssize_t pci_read_vpd(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
722 ssize_t pci_write_vpd(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
723 int pci_vpd_truncate(struct pci_dev *dev, size_t size);
725 /* Helper functions for low-level code (drivers/pci/setup-[bus,res].c) */
726 void pci_bus_assign_resources(const struct pci_bus *bus);
727 void pci_bus_size_bridges(struct pci_bus *bus);
728 int pci_claim_resource(struct pci_dev *, int);
729 void pci_assign_unassigned_resources(void);
730 void pdev_enable_device(struct pci_dev *);
731 void pdev_sort_resources(struct pci_dev *, struct resource_list *);
732 int pci_enable_resources(struct pci_dev *, int mask);
733 void pci_fixup_irqs(u8 (*)(struct pci_dev *, u8 *),
734 int (*)(struct pci_dev *, u8, u8));
735 #define HAVE_PCI_REQ_REGIONS 2
736 int __must_check pci_request_regions(struct pci_dev *, const char *);
737 int __must_check pci_request_regions_exclusive(struct pci_dev *, const char *);
738 void pci_release_regions(struct pci_dev *);
739 int __must_check pci_request_region(struct pci_dev *, int, const char *);
740 int __must_check pci_request_region_exclusive(struct pci_dev *, int, const char *);
741 void pci_release_region(struct pci_dev *, int);
742 int pci_request_selected_regions(struct pci_dev *, int, const char *);
743 int pci_request_selected_regions_exclusive(struct pci_dev *, int, const char *);
744 void pci_release_selected_regions(struct pci_dev *, int);
746 /* drivers/pci/bus.c */
747 int __must_check pci_bus_alloc_resource(struct pci_bus *bus,
748 struct resource *res, resource_size_t size,
749 resource_size_t align, resource_size_t min,
750 unsigned int type_mask,
751 void (*alignf)(void *, struct resource *,
752 resource_size_t, resource_size_t),
754 void pci_enable_bridges(struct pci_bus *bus);
756 /* Proper probing supporting hot-pluggable devices */
757 int __must_check __pci_register_driver(struct pci_driver *, struct module *,
758 const char *mod_name);
761 * pci_register_driver must be a macro so that KBUILD_MODNAME can be expanded
763 #define pci_register_driver(driver) \
764 __pci_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
766 void pci_unregister_driver(struct pci_driver *dev);
767 void pci_remove_behind_bridge(struct pci_dev *dev);
768 struct pci_driver *pci_dev_driver(const struct pci_dev *dev);
769 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
770 struct pci_dev *dev);
771 int pci_scan_bridge(struct pci_bus *bus, struct pci_dev *dev, int max,
774 void pci_walk_bus(struct pci_bus *top, void (*cb)(struct pci_dev *, void *),
776 int pci_cfg_space_size_ext(struct pci_dev *dev);
777 int pci_cfg_space_size(struct pci_dev *dev);
778 unsigned char pci_bus_max_busnr(struct pci_bus *bus);
780 /* kmem_cache style wrapper around pci_alloc_consistent() */
782 #include <linux/dmapool.h>
784 #define pci_pool dma_pool
785 #define pci_pool_create(name, pdev, size, align, allocation) \
786 dma_pool_create(name, &pdev->dev, size, align, allocation)
787 #define pci_pool_destroy(pool) dma_pool_destroy(pool)
788 #define pci_pool_alloc(pool, flags, handle) dma_pool_alloc(pool, flags, handle)
789 #define pci_pool_free(pool, vaddr, addr) dma_pool_free(pool, vaddr, addr)
791 enum pci_dma_burst_strategy {
792 PCI_DMA_BURST_INFINITY, /* make bursts as large as possible,
793 strategy_parameter is N/A */
794 PCI_DMA_BURST_BOUNDARY, /* disconnect at every strategy_parameter
796 PCI_DMA_BURST_MULTIPLE, /* disconnect at some multiple of
797 strategy_parameter byte boundaries */
801 u32 vector; /* kernel uses to write allocated vector */
802 u16 entry; /* driver uses to specify entry, OS writes */
806 #ifndef CONFIG_PCI_MSI
807 static inline int pci_enable_msi_block(struct pci_dev *dev, unsigned int nvec)
812 static inline void pci_msi_shutdown(struct pci_dev *dev)
814 static inline void pci_disable_msi(struct pci_dev *dev)
817 static inline int pci_msix_table_size(struct pci_dev *dev)
821 static inline int pci_enable_msix(struct pci_dev *dev,
822 struct msix_entry *entries, int nvec)
827 static inline void pci_msix_shutdown(struct pci_dev *dev)
829 static inline void pci_disable_msix(struct pci_dev *dev)
832 static inline void msi_remove_pci_irq_vectors(struct pci_dev *dev)
835 static inline void pci_restore_msi_state(struct pci_dev *dev)
837 static inline int pci_msi_enabled(void)
842 extern int pci_enable_msi_block(struct pci_dev *dev, unsigned int nvec);
843 extern void pci_msi_shutdown(struct pci_dev *dev);
844 extern void pci_disable_msi(struct pci_dev *dev);
845 extern int pci_msix_table_size(struct pci_dev *dev);
846 extern int pci_enable_msix(struct pci_dev *dev,
847 struct msix_entry *entries, int nvec);
848 extern void pci_msix_shutdown(struct pci_dev *dev);
849 extern void pci_disable_msix(struct pci_dev *dev);
850 extern void msi_remove_pci_irq_vectors(struct pci_dev *dev);
851 extern void pci_restore_msi_state(struct pci_dev *dev);
852 extern int pci_msi_enabled(void);
855 #ifndef CONFIG_PCIEASPM
856 static inline int pcie_aspm_enabled(void)
861 extern int pcie_aspm_enabled(void);
864 #define pci_enable_msi(pdev) pci_enable_msi_block(pdev, 1)
867 /* The functions a driver should call */
868 int ht_create_irq(struct pci_dev *dev, int idx);
869 void ht_destroy_irq(unsigned int irq);
870 #endif /* CONFIG_HT_IRQ */
872 extern void pci_block_user_cfg_access(struct pci_dev *dev);
873 extern void pci_unblock_user_cfg_access(struct pci_dev *dev);
876 * PCI domain support. Sometimes called PCI segment (eg by ACPI),
877 * a PCI domain is defined to be a set of PCI busses which share
878 * configuration space.
880 #ifdef CONFIG_PCI_DOMAINS
881 extern int pci_domains_supported;
883 enum { pci_domains_supported = 0 };
884 static inline int pci_domain_nr(struct pci_bus *bus)
889 static inline int pci_proc_domain(struct pci_bus *bus)
893 #endif /* CONFIG_PCI_DOMAINS */
895 #else /* CONFIG_PCI is not enabled */
898 * If the system does not have PCI, clearly these return errors. Define
899 * these as simple inline functions to avoid hair in drivers.
902 #define _PCI_NOP(o, s, t) \
903 static inline int pci_##o##_config_##s(struct pci_dev *dev, \
905 { return PCIBIOS_FUNC_NOT_SUPPORTED; }
907 #define _PCI_NOP_ALL(o, x) _PCI_NOP(o, byte, u8 x) \
908 _PCI_NOP(o, word, u16 x) \
909 _PCI_NOP(o, dword, u32 x)
910 _PCI_NOP_ALL(read, *)
913 static inline struct pci_dev *pci_find_device(unsigned int vendor,
915 struct pci_dev *from)
920 static inline struct pci_dev *pci_find_slot(unsigned int bus,
926 static inline struct pci_dev *pci_get_device(unsigned int vendor,
928 struct pci_dev *from)
933 static inline struct pci_dev *pci_get_subsys(unsigned int vendor,
935 unsigned int ss_vendor,
936 unsigned int ss_device,
937 struct pci_dev *from)
942 static inline struct pci_dev *pci_get_class(unsigned int class,
943 struct pci_dev *from)
948 #define pci_dev_present(ids) (0)
949 #define no_pci_devices() (1)
950 #define pci_dev_put(dev) do { } while (0)
952 static inline void pci_set_master(struct pci_dev *dev)
955 static inline int pci_enable_device(struct pci_dev *dev)
960 static inline void pci_disable_device(struct pci_dev *dev)
963 static inline int pci_set_dma_mask(struct pci_dev *dev, u64 mask)
968 static inline int pci_set_consistent_dma_mask(struct pci_dev *dev, u64 mask)
973 static inline int pci_set_dma_max_seg_size(struct pci_dev *dev,
979 static inline int pci_set_dma_seg_boundary(struct pci_dev *dev,
985 static inline int pci_assign_resource(struct pci_dev *dev, int i)
990 static inline int __pci_register_driver(struct pci_driver *drv,
991 struct module *owner)
996 static inline int pci_register_driver(struct pci_driver *drv)
1001 static inline void pci_unregister_driver(struct pci_driver *drv)
1004 static inline int pci_find_capability(struct pci_dev *dev, int cap)
1009 static inline int pci_find_next_capability(struct pci_dev *dev, u8 post,
1015 static inline int pci_find_ext_capability(struct pci_dev *dev, int cap)
1020 /* Power management related routines */
1021 static inline int pci_save_state(struct pci_dev *dev)
1026 static inline int pci_restore_state(struct pci_dev *dev)
1031 static inline int pci_set_power_state(struct pci_dev *dev, pci_power_t state)
1036 static inline pci_power_t pci_choose_state(struct pci_dev *dev,
1042 static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
1048 static inline int pci_request_regions(struct pci_dev *dev, const char *res_name)
1053 static inline void pci_release_regions(struct pci_dev *dev)
1056 #define pci_dma_burst_advice(pdev, strat, strategy_parameter) do { } while (0)
1058 static inline void pci_block_user_cfg_access(struct pci_dev *dev)
1061 static inline void pci_unblock_user_cfg_access(struct pci_dev *dev)
1064 static inline struct pci_bus *pci_find_next_bus(const struct pci_bus *from)
1067 static inline struct pci_dev *pci_get_slot(struct pci_bus *bus,
1071 static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
1075 #endif /* CONFIG_PCI */
1077 /* Include architecture-dependent settings and functions */
1079 #include <asm/pci.h>
1081 /* these helpers provide future and backwards compatibility
1082 * for accessing popular PCI BAR info */
1083 #define pci_resource_start(dev, bar) ((dev)->resource[(bar)].start)
1084 #define pci_resource_end(dev, bar) ((dev)->resource[(bar)].end)
1085 #define pci_resource_flags(dev, bar) ((dev)->resource[(bar)].flags)
1086 #define pci_resource_len(dev,bar) \
1087 ((pci_resource_start((dev), (bar)) == 0 && \
1088 pci_resource_end((dev), (bar)) == \
1089 pci_resource_start((dev), (bar))) ? 0 : \
1091 (pci_resource_end((dev), (bar)) - \
1092 pci_resource_start((dev), (bar)) + 1))
1094 /* Similar to the helpers above, these manipulate per-pci_dev
1095 * driver-specific data. They are really just a wrapper around
1096 * the generic device structure functions of these calls.
1098 static inline void *pci_get_drvdata(struct pci_dev *pdev)
1100 return dev_get_drvdata(&pdev->dev);
1103 static inline void pci_set_drvdata(struct pci_dev *pdev, void *data)
1105 dev_set_drvdata(&pdev->dev, data);
1108 /* If you want to know what to call your pci_dev, ask this function.
1109 * Again, it's a wrapper around the generic device.
1111 static inline const char *pci_name(struct pci_dev *pdev)
1113 return dev_name(&pdev->dev);
1117 /* Some archs don't want to expose struct resource to userland as-is
1118 * in sysfs and /proc
1120 #ifndef HAVE_ARCH_PCI_RESOURCE_TO_USER
1121 static inline void pci_resource_to_user(const struct pci_dev *dev, int bar,
1122 const struct resource *rsrc, resource_size_t *start,
1123 resource_size_t *end)
1125 *start = rsrc->start;
1128 #endif /* HAVE_ARCH_PCI_RESOURCE_TO_USER */
1132 * The world is not perfect and supplies us with broken PCI devices.
1133 * For at least a part of these bugs we need a work-around, so both
1134 * generic (drivers/pci/quirks.c) and per-architecture code can define
1135 * fixup hooks to be called for particular buggy devices.
1139 u16 vendor, device; /* You can use PCI_ANY_ID here of course */
1140 void (*hook)(struct pci_dev *dev);
1143 enum pci_fixup_pass {
1144 pci_fixup_early, /* Before probing BARs */
1145 pci_fixup_header, /* After reading configuration header */
1146 pci_fixup_final, /* Final phase of device fixups */
1147 pci_fixup_enable, /* pci_enable_device() time */
1148 pci_fixup_resume, /* pci_device_resume() */
1149 pci_fixup_suspend, /* pci_device_suspend */
1150 pci_fixup_resume_early, /* pci_device_resume_early() */
1153 /* Anonymous variables would be nice... */
1154 #define DECLARE_PCI_FIXUP_SECTION(section, name, vendor, device, hook) \
1155 static const struct pci_fixup __pci_fixup_##name __used \
1156 __attribute__((__section__(#section))) = { vendor, device, hook };
1157 #define DECLARE_PCI_FIXUP_EARLY(vendor, device, hook) \
1158 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early, \
1159 vendor##device##hook, vendor, device, hook)
1160 #define DECLARE_PCI_FIXUP_HEADER(vendor, device, hook) \
1161 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header, \
1162 vendor##device##hook, vendor, device, hook)
1163 #define DECLARE_PCI_FIXUP_FINAL(vendor, device, hook) \
1164 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final, \
1165 vendor##device##hook, vendor, device, hook)
1166 #define DECLARE_PCI_FIXUP_ENABLE(vendor, device, hook) \
1167 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable, \
1168 vendor##device##hook, vendor, device, hook)
1169 #define DECLARE_PCI_FIXUP_RESUME(vendor, device, hook) \
1170 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume, \
1171 resume##vendor##device##hook, vendor, device, hook)
1172 #define DECLARE_PCI_FIXUP_RESUME_EARLY(vendor, device, hook) \
1173 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early, \
1174 resume_early##vendor##device##hook, vendor, device, hook)
1175 #define DECLARE_PCI_FIXUP_SUSPEND(vendor, device, hook) \
1176 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend, \
1177 suspend##vendor##device##hook, vendor, device, hook)
1180 void pci_fixup_device(enum pci_fixup_pass pass, struct pci_dev *dev);
1182 void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen);
1183 void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr);
1184 void __iomem * const *pcim_iomap_table(struct pci_dev *pdev);
1185 int pcim_iomap_regions(struct pci_dev *pdev, u16 mask, const char *name);
1186 int pcim_iomap_regions_request_all(struct pci_dev *pdev, u16 mask,
1188 void pcim_iounmap_regions(struct pci_dev *pdev, u16 mask);
1190 extern int pci_pci_problems;
1191 #define PCIPCI_FAIL 1 /* No PCI PCI DMA */
1192 #define PCIPCI_TRITON 2
1193 #define PCIPCI_NATOMA 4
1194 #define PCIPCI_VIAETBF 8
1195 #define PCIPCI_VSFX 16
1196 #define PCIPCI_ALIMAGIK 32 /* Need low latency setting */
1197 #define PCIAGP_FAIL 64 /* No PCI to AGP DMA */
1199 extern unsigned long pci_cardbus_io_size;
1200 extern unsigned long pci_cardbus_mem_size;
1202 int pcibios_add_platform_entries(struct pci_dev *dev);
1203 void pcibios_disable_device(struct pci_dev *dev);
1204 int pcibios_set_pcie_reset_state(struct pci_dev *dev,
1205 enum pcie_reset_state state);
1207 #ifdef CONFIG_PCI_MMCONFIG
1208 extern void __init pci_mmcfg_early_init(void);
1209 extern void __init pci_mmcfg_late_init(void);
1211 static inline void pci_mmcfg_early_init(void) { }
1212 static inline void pci_mmcfg_late_init(void) { }
1215 int pci_ext_cfg_avail(struct pci_dev *dev);
1217 void __iomem *pci_ioremap_bar(struct pci_dev *pdev, int bar);
1219 #ifdef CONFIG_PCI_IOV
1220 extern int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn);
1221 extern void pci_disable_sriov(struct pci_dev *dev);
1223 static inline int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn)
1227 static inline void pci_disable_sriov(struct pci_dev *dev)
1232 #endif /* __KERNEL__ */
1233 #endif /* LINUX_PCI_H */