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>
55 #include <linux/irqreturn.h>
57 /* Include the ID list */
58 #include <linux/pci_ids.h>
60 /* pci_slot represents a physical slot */
62 struct pci_bus *bus; /* The bus this slot is on */
63 struct list_head list; /* node in list of slots on this bus */
64 struct hotplug_slot *hotplug; /* Hotplug info (migrate over time) */
65 unsigned char number; /* PCI_SLOT(pci_dev->devfn) */
69 static inline const char *pci_slot_name(const struct pci_slot *slot)
71 return kobject_name(&slot->kobj);
74 /* File state for mmap()s on /proc/bus/pci/X/Y */
80 /* This defines the direction arg to the DMA mapping routines. */
81 #define PCI_DMA_BIDIRECTIONAL 0
82 #define PCI_DMA_TODEVICE 1
83 #define PCI_DMA_FROMDEVICE 2
84 #define PCI_DMA_NONE 3
87 * For PCI devices, the region numbers are assigned this way:
90 /* #0-5: standard PCI resources */
92 PCI_STD_RESOURCE_END = 5,
94 /* #6: expansion ROM resource */
97 /* device specific resources */
100 PCI_IOV_RESOURCE_END = PCI_IOV_RESOURCES + PCI_SRIOV_NUM_BARS - 1,
103 /* resources assigned to buses behind the bridge */
104 #define PCI_BRIDGE_RESOURCE_NUM 4
106 PCI_BRIDGE_RESOURCES,
107 PCI_BRIDGE_RESOURCE_END = PCI_BRIDGE_RESOURCES +
108 PCI_BRIDGE_RESOURCE_NUM - 1,
110 /* total resources associated with a PCI device */
113 /* preserve this for compatibility */
114 DEVICE_COUNT_RESOURCE
117 typedef int __bitwise pci_power_t;
119 #define PCI_D0 ((pci_power_t __force) 0)
120 #define PCI_D1 ((pci_power_t __force) 1)
121 #define PCI_D2 ((pci_power_t __force) 2)
122 #define PCI_D3hot ((pci_power_t __force) 3)
123 #define PCI_D3cold ((pci_power_t __force) 4)
124 #define PCI_UNKNOWN ((pci_power_t __force) 5)
125 #define PCI_POWER_ERROR ((pci_power_t __force) -1)
127 #define PCI_PM_D2_DELAY 200
128 #define PCI_PM_D3_WAIT 10
129 #define PCI_PM_BUS_WAIT 50
131 /** The pci_channel state describes connectivity between the CPU and
132 * the pci device. If some PCI bus between here and the pci device
133 * has crashed or locked up, this info is reflected here.
135 typedef unsigned int __bitwise pci_channel_state_t;
137 enum pci_channel_state {
138 /* I/O channel is in normal state */
139 pci_channel_io_normal = (__force pci_channel_state_t) 1,
141 /* I/O to channel is blocked */
142 pci_channel_io_frozen = (__force pci_channel_state_t) 2,
144 /* PCI card is dead */
145 pci_channel_io_perm_failure = (__force pci_channel_state_t) 3,
148 typedef unsigned int __bitwise pcie_reset_state_t;
150 enum pcie_reset_state {
151 /* Reset is NOT asserted (Use to deassert reset) */
152 pcie_deassert_reset = (__force pcie_reset_state_t) 1,
154 /* Use #PERST to reset PCI-E device */
155 pcie_warm_reset = (__force pcie_reset_state_t) 2,
157 /* Use PCI-E Hot Reset to reset device */
158 pcie_hot_reset = (__force pcie_reset_state_t) 3
161 typedef unsigned short __bitwise pci_dev_flags_t;
163 /* INTX_DISABLE in PCI_COMMAND register disables MSI
166 PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG = (__force pci_dev_flags_t) 1,
167 /* Device configuration is irrevocably lost if disabled into D3 */
168 PCI_DEV_FLAGS_NO_D3 = (__force pci_dev_flags_t) 2,
171 enum pci_irq_reroute_variant {
172 INTEL_IRQ_REROUTE_VARIANT = 1,
173 MAX_IRQ_REROUTE_VARIANTS = 3
176 typedef unsigned short __bitwise pci_bus_flags_t;
178 PCI_BUS_FLAGS_NO_MSI = (__force pci_bus_flags_t) 1,
179 PCI_BUS_FLAGS_NO_MMRBC = (__force pci_bus_flags_t) 2,
182 struct pci_cap_saved_state {
183 struct hlist_node next;
188 struct pcie_link_state;
193 * The pci_dev structure is used to describe PCI devices.
196 struct list_head bus_list; /* node in per-bus list */
197 struct pci_bus *bus; /* bus this device is on */
198 struct pci_bus *subordinate; /* bus this device bridges to */
200 void *sysdata; /* hook for sys-specific extension */
201 struct proc_dir_entry *procent; /* device entry in /proc/bus/pci */
202 struct pci_slot *slot; /* Physical slot this device is in */
204 unsigned int devfn; /* encoded device & function index */
205 unsigned short vendor;
206 unsigned short device;
207 unsigned short subsystem_vendor;
208 unsigned short subsystem_device;
209 unsigned int class; /* 3 bytes: (base,sub,prog-if) */
210 u8 revision; /* PCI revision, low byte of class word */
211 u8 hdr_type; /* PCI header type (`multi' flag masked out) */
212 u8 pcie_type; /* PCI-E device/port type */
213 u8 rom_base_reg; /* which config register controls the ROM */
214 u8 pin; /* which interrupt pin this device uses */
216 struct pci_driver *driver; /* which driver has allocated this device */
217 u64 dma_mask; /* Mask of the bits of bus address this
218 device implements. Normally this is
219 0xffffffff. You only need to change
220 this if your device has broken DMA
221 or supports 64-bit transfers. */
223 struct device_dma_parameters dma_parms;
225 pci_power_t current_state; /* Current operating state. In ACPI-speak,
226 this is D0-D3, D0 being fully functional,
228 int pm_cap; /* PM capability offset in the
229 configuration space */
230 unsigned int pme_support:5; /* Bitmask of states from which PME#
232 unsigned int d1_support:1; /* Low power state D1 is supported */
233 unsigned int d2_support:1; /* Low power state D2 is supported */
234 unsigned int no_d1d2:1; /* Only allow D0 and D3 */
236 #ifdef CONFIG_PCIEASPM
237 struct pcie_link_state *link_state; /* ASPM link state. */
240 pci_channel_state_t error_state; /* current connectivity state */
241 struct device dev; /* Generic device interface */
243 int cfg_size; /* Size of configuration space */
246 * Instead of touching interrupt line and base address registers
247 * directly, use the values stored here. They might be different!
250 struct resource resource[DEVICE_COUNT_RESOURCE]; /* I/O and memory regions + expansion ROMs */
252 /* These fields are used by common fixups */
253 unsigned int transparent:1; /* Transparent PCI bridge */
254 unsigned int multifunction:1;/* Part of multi-function device */
255 /* keep track of device state */
256 unsigned int is_added:1;
257 unsigned int is_busmaster:1; /* device is busmaster */
258 unsigned int no_msi:1; /* device may not use msi */
259 unsigned int block_ucfg_access:1; /* userspace config space access is blocked */
260 unsigned int broken_parity_status:1; /* Device generates false positive parity */
261 unsigned int irq_reroute_variant:2; /* device needs IRQ rerouting variant */
262 unsigned int msi_enabled:1;
263 unsigned int msix_enabled:1;
264 unsigned int ari_enabled:1; /* ARI forwarding */
265 unsigned int is_managed:1;
266 unsigned int is_pcie:1;
267 unsigned int state_saved:1;
268 unsigned int is_physfn:1;
269 unsigned int is_virtfn:1;
270 pci_dev_flags_t dev_flags;
271 atomic_t enable_cnt; /* pci_enable_device has been called */
273 u32 saved_config_space[16]; /* config space saved at suspend time */
274 struct hlist_head saved_cap_space;
275 struct bin_attribute *rom_attr; /* attribute descriptor for sysfs ROM entry */
276 int rom_attr_enabled; /* has display of the rom attribute been enabled? */
277 struct bin_attribute *res_attr[DEVICE_COUNT_RESOURCE]; /* sysfs file for resources */
278 struct bin_attribute *res_attr_wc[DEVICE_COUNT_RESOURCE]; /* sysfs file for WC mapping of resources */
279 #ifdef CONFIG_PCI_MSI
280 struct list_head msi_list;
283 #ifdef CONFIG_PCI_IOV
285 struct pci_sriov *sriov; /* SR-IOV capability related */
286 struct pci_dev *physfn; /* the PF this VF is associated with */
291 extern struct pci_dev *alloc_pci_dev(void);
293 #define pci_dev_b(n) list_entry(n, struct pci_dev, bus_list)
294 #define to_pci_dev(n) container_of(n, struct pci_dev, dev)
295 #define for_each_pci_dev(d) while ((d = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, d)) != NULL)
297 static inline int pci_channel_offline(struct pci_dev *pdev)
299 return (pdev->error_state != pci_channel_io_normal);
302 static inline struct pci_cap_saved_state *pci_find_saved_cap(
303 struct pci_dev *pci_dev, char cap)
305 struct pci_cap_saved_state *tmp;
306 struct hlist_node *pos;
308 hlist_for_each_entry(tmp, pos, &pci_dev->saved_cap_space, next) {
309 if (tmp->cap_nr == cap)
315 static inline void pci_add_saved_cap(struct pci_dev *pci_dev,
316 struct pci_cap_saved_state *new_cap)
318 hlist_add_head(&new_cap->next, &pci_dev->saved_cap_space);
321 #ifndef PCI_BUS_NUM_RESOURCES
322 #define PCI_BUS_NUM_RESOURCES 16
325 #define PCI_REGION_FLAG_MASK 0x0fU /* These bits of resource flags tell us the PCI region flags */
328 struct list_head node; /* node in list of buses */
329 struct pci_bus *parent; /* parent bus this bridge is on */
330 struct list_head children; /* list of child buses */
331 struct list_head devices; /* list of devices on this bus */
332 struct pci_dev *self; /* bridge device as seen by parent */
333 struct list_head slots; /* list of slots on this bus */
334 struct resource *resource[PCI_BUS_NUM_RESOURCES];
335 /* address space routed to this bus */
337 struct pci_ops *ops; /* configuration access functions */
338 void *sysdata; /* hook for sys-specific extension */
339 struct proc_dir_entry *procdir; /* directory entry in /proc/bus/pci */
341 unsigned char number; /* bus number */
342 unsigned char primary; /* number of primary bridge */
343 unsigned char secondary; /* number of secondary bridge */
344 unsigned char subordinate; /* max number of subordinate buses */
348 unsigned short bridge_ctl; /* manage NO_ISA/FBB/et al behaviors */
349 pci_bus_flags_t bus_flags; /* Inherited by child busses */
350 struct device *bridge;
352 struct bin_attribute *legacy_io; /* legacy I/O for this bus */
353 struct bin_attribute *legacy_mem; /* legacy mem */
354 unsigned int is_added:1;
357 #define pci_bus_b(n) list_entry(n, struct pci_bus, node)
358 #define to_pci_bus(n) container_of(n, struct pci_bus, dev)
361 * Returns true if the pci bus is root (behind host-pci bridge),
364 static inline bool pci_is_root_bus(struct pci_bus *pbus)
366 return !(pbus->parent);
369 #ifdef CONFIG_PCI_MSI
370 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev)
372 return pci_dev->msi_enabled || pci_dev->msix_enabled;
375 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev) { return false; }
379 * Error values that may be returned by PCI functions.
381 #define PCIBIOS_SUCCESSFUL 0x00
382 #define PCIBIOS_FUNC_NOT_SUPPORTED 0x81
383 #define PCIBIOS_BAD_VENDOR_ID 0x83
384 #define PCIBIOS_DEVICE_NOT_FOUND 0x86
385 #define PCIBIOS_BAD_REGISTER_NUMBER 0x87
386 #define PCIBIOS_SET_FAILED 0x88
387 #define PCIBIOS_BUFFER_TOO_SMALL 0x89
389 /* Low-level architecture-dependent routines */
392 int (*read)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 *val);
393 int (*write)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 val);
397 * ACPI needs to be able to access PCI config space before we've done a
398 * PCI bus scan and created pci_bus structures.
400 extern int raw_pci_read(unsigned int domain, unsigned int bus,
401 unsigned int devfn, int reg, int len, u32 *val);
402 extern int raw_pci_write(unsigned int domain, unsigned int bus,
403 unsigned int devfn, int reg, int len, u32 val);
405 struct pci_bus_region {
406 resource_size_t start;
411 spinlock_t lock; /* protects list, index */
412 struct list_head list; /* for IDs added at runtime */
415 /* ---------------------------------------------------------------- */
416 /** PCI Error Recovery System (PCI-ERS). If a PCI device driver provides
417 * a set of callbacks in struct pci_error_handlers, then that device driver
418 * will be notified of PCI bus errors, and will be driven to recovery
419 * when an error occurs.
422 typedef unsigned int __bitwise pci_ers_result_t;
424 enum pci_ers_result {
425 /* no result/none/not supported in device driver */
426 PCI_ERS_RESULT_NONE = (__force pci_ers_result_t) 1,
428 /* Device driver can recover without slot reset */
429 PCI_ERS_RESULT_CAN_RECOVER = (__force pci_ers_result_t) 2,
431 /* Device driver wants slot to be reset. */
432 PCI_ERS_RESULT_NEED_RESET = (__force pci_ers_result_t) 3,
434 /* Device has completely failed, is unrecoverable */
435 PCI_ERS_RESULT_DISCONNECT = (__force pci_ers_result_t) 4,
437 /* Device driver is fully recovered and operational */
438 PCI_ERS_RESULT_RECOVERED = (__force pci_ers_result_t) 5,
441 /* PCI bus error event callbacks */
442 struct pci_error_handlers {
443 /* PCI bus error detected on this device */
444 pci_ers_result_t (*error_detected)(struct pci_dev *dev,
445 enum pci_channel_state error);
447 /* MMIO has been re-enabled, but not DMA */
448 pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev);
450 /* PCI Express link has been reset */
451 pci_ers_result_t (*link_reset)(struct pci_dev *dev);
453 /* PCI slot has been reset */
454 pci_ers_result_t (*slot_reset)(struct pci_dev *dev);
456 /* Device driver may resume normal operations */
457 void (*resume)(struct pci_dev *dev);
460 /* ---------------------------------------------------------------- */
464 struct list_head node;
466 const struct pci_device_id *id_table; /* must be non-NULL for probe to be called */
467 int (*probe) (struct pci_dev *dev, const struct pci_device_id *id); /* New device inserted */
468 void (*remove) (struct pci_dev *dev); /* Device removed (NULL if not a hot-plug capable driver) */
469 int (*suspend) (struct pci_dev *dev, pm_message_t state); /* Device suspended */
470 int (*suspend_late) (struct pci_dev *dev, pm_message_t state);
471 int (*resume_early) (struct pci_dev *dev);
472 int (*resume) (struct pci_dev *dev); /* Device woken up */
473 void (*shutdown) (struct pci_dev *dev);
474 struct pci_error_handlers *err_handler;
475 struct device_driver driver;
476 struct pci_dynids dynids;
479 #define to_pci_driver(drv) container_of(drv, struct pci_driver, driver)
482 * DEFINE_PCI_DEVICE_TABLE - macro used to describe a pci device table
483 * @_table: device table name
485 * This macro is used to create a struct pci_device_id array (a device table)
486 * in a generic manner.
488 #define DEFINE_PCI_DEVICE_TABLE(_table) \
489 const struct pci_device_id _table[] __devinitconst
492 * PCI_DEVICE - macro used to describe a specific pci device
493 * @vend: the 16 bit PCI Vendor ID
494 * @dev: the 16 bit PCI Device ID
496 * This macro is used to create a struct pci_device_id that matches a
497 * specific device. The subvendor and subdevice fields will be set to
500 #define PCI_DEVICE(vend,dev) \
501 .vendor = (vend), .device = (dev), \
502 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
505 * PCI_DEVICE_CLASS - macro used to describe a specific pci device class
506 * @dev_class: the class, subclass, prog-if triple for this device
507 * @dev_class_mask: the class mask for this device
509 * This macro is used to create a struct pci_device_id that matches a
510 * specific PCI class. The vendor, device, subvendor, and subdevice
511 * fields will be set to PCI_ANY_ID.
513 #define PCI_DEVICE_CLASS(dev_class,dev_class_mask) \
514 .class = (dev_class), .class_mask = (dev_class_mask), \
515 .vendor = PCI_ANY_ID, .device = PCI_ANY_ID, \
516 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
519 * PCI_VDEVICE - macro used to describe a specific pci device in short form
520 * @vendor: the vendor name
521 * @device: the 16 bit PCI Device ID
523 * This macro is used to create a struct pci_device_id that matches a
524 * specific PCI device. The subvendor, and subdevice fields will be set
525 * to PCI_ANY_ID. The macro allows the next field to follow as the device
529 #define PCI_VDEVICE(vendor, device) \
530 PCI_VENDOR_ID_##vendor, (device), \
531 PCI_ANY_ID, PCI_ANY_ID, 0, 0
533 /* these external functions are only available when PCI support is enabled */
536 extern struct bus_type pci_bus_type;
538 /* Do NOT directly access these two variables, unless you are arch specific pci
539 * code, or pci core code. */
540 extern struct list_head pci_root_buses; /* list of all known PCI buses */
541 /* Some device drivers need know if pci is initiated */
542 extern int no_pci_devices(void);
544 void pcibios_fixup_bus(struct pci_bus *);
545 int __must_check pcibios_enable_device(struct pci_dev *, int mask);
546 char *pcibios_setup(char *str);
548 /* Used only when drivers/pci/setup.c is used */
549 void pcibios_align_resource(void *, struct resource *, resource_size_t,
551 void pcibios_update_irq(struct pci_dev *, int irq);
553 /* Generic PCI functions used internally */
555 extern struct pci_bus *pci_find_bus(int domain, int busnr);
556 void pci_bus_add_devices(const struct pci_bus *bus);
557 struct pci_bus *pci_scan_bus_parented(struct device *parent, int bus,
558 struct pci_ops *ops, void *sysdata);
559 static inline struct pci_bus * __devinit pci_scan_bus(int bus, struct pci_ops *ops,
562 struct pci_bus *root_bus;
563 root_bus = pci_scan_bus_parented(NULL, bus, ops, sysdata);
565 pci_bus_add_devices(root_bus);
568 struct pci_bus *pci_create_bus(struct device *parent, int bus,
569 struct pci_ops *ops, void *sysdata);
570 struct pci_bus *pci_add_new_bus(struct pci_bus *parent, struct pci_dev *dev,
572 struct pci_slot *pci_create_slot(struct pci_bus *parent, int slot_nr,
574 struct hotplug_slot *hotplug);
575 void pci_destroy_slot(struct pci_slot *slot);
576 void pci_renumber_slot(struct pci_slot *slot, int slot_nr);
577 int pci_scan_slot(struct pci_bus *bus, int devfn);
578 struct pci_dev *pci_scan_single_device(struct pci_bus *bus, int devfn);
579 void pci_device_add(struct pci_dev *dev, struct pci_bus *bus);
580 unsigned int pci_scan_child_bus(struct pci_bus *bus);
581 int __must_check pci_bus_add_device(struct pci_dev *dev);
582 void pci_read_bridge_bases(struct pci_bus *child);
583 struct resource *pci_find_parent_resource(const struct pci_dev *dev,
584 struct resource *res);
585 u8 pci_swizzle_interrupt_pin(struct pci_dev *dev, u8 pin);
586 int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge);
587 u8 pci_common_swizzle(struct pci_dev *dev, u8 *pinp);
588 extern struct pci_dev *pci_dev_get(struct pci_dev *dev);
589 extern void pci_dev_put(struct pci_dev *dev);
590 extern void pci_remove_bus(struct pci_bus *b);
591 extern void pci_remove_bus_device(struct pci_dev *dev);
592 extern void pci_stop_bus_device(struct pci_dev *dev);
593 void pci_setup_cardbus(struct pci_bus *bus);
594 extern void pci_sort_breadthfirst(void);
596 /* Generic PCI functions exported to card drivers */
598 #ifdef CONFIG_PCI_LEGACY
599 struct pci_dev __deprecated *pci_find_device(unsigned int vendor,
601 struct pci_dev *from);
602 struct pci_dev __deprecated *pci_find_slot(unsigned int bus,
604 #endif /* CONFIG_PCI_LEGACY */
606 enum pci_lost_interrupt_reason {
607 PCI_LOST_IRQ_NO_INFORMATION = 0,
608 PCI_LOST_IRQ_DISABLE_MSI,
609 PCI_LOST_IRQ_DISABLE_MSIX,
610 PCI_LOST_IRQ_DISABLE_ACPI,
612 enum pci_lost_interrupt_reason pci_lost_interrupt(struct pci_dev *dev);
613 int pci_find_capability(struct pci_dev *dev, int cap);
614 int pci_find_next_capability(struct pci_dev *dev, u8 pos, int cap);
615 int pci_find_ext_capability(struct pci_dev *dev, int cap);
616 int pci_find_ht_capability(struct pci_dev *dev, int ht_cap);
617 int pci_find_next_ht_capability(struct pci_dev *dev, int pos, int ht_cap);
618 struct pci_bus *pci_find_next_bus(const struct pci_bus *from);
620 struct pci_dev *pci_get_device(unsigned int vendor, unsigned int device,
621 struct pci_dev *from);
622 struct pci_dev *pci_get_subsys(unsigned int vendor, unsigned int device,
623 unsigned int ss_vendor, unsigned int ss_device,
624 struct pci_dev *from);
625 struct pci_dev *pci_get_slot(struct pci_bus *bus, unsigned int devfn);
626 struct pci_dev *pci_get_bus_and_slot(unsigned int bus, unsigned int devfn);
627 struct pci_dev *pci_get_class(unsigned int class, struct pci_dev *from);
628 int pci_dev_present(const struct pci_device_id *ids);
630 int pci_bus_read_config_byte(struct pci_bus *bus, unsigned int devfn,
632 int pci_bus_read_config_word(struct pci_bus *bus, unsigned int devfn,
633 int where, u16 *val);
634 int pci_bus_read_config_dword(struct pci_bus *bus, unsigned int devfn,
635 int where, u32 *val);
636 int pci_bus_write_config_byte(struct pci_bus *bus, unsigned int devfn,
638 int pci_bus_write_config_word(struct pci_bus *bus, unsigned int devfn,
640 int pci_bus_write_config_dword(struct pci_bus *bus, unsigned int devfn,
643 static inline int pci_read_config_byte(struct pci_dev *dev, int where, u8 *val)
645 return pci_bus_read_config_byte(dev->bus, dev->devfn, where, val);
647 static inline int pci_read_config_word(struct pci_dev *dev, int where, u16 *val)
649 return pci_bus_read_config_word(dev->bus, dev->devfn, where, val);
651 static inline int pci_read_config_dword(struct pci_dev *dev, int where,
654 return pci_bus_read_config_dword(dev->bus, dev->devfn, where, val);
656 static inline int pci_write_config_byte(struct pci_dev *dev, int where, u8 val)
658 return pci_bus_write_config_byte(dev->bus, dev->devfn, where, val);
660 static inline int pci_write_config_word(struct pci_dev *dev, int where, u16 val)
662 return pci_bus_write_config_word(dev->bus, dev->devfn, where, val);
664 static inline int pci_write_config_dword(struct pci_dev *dev, int where,
667 return pci_bus_write_config_dword(dev->bus, dev->devfn, where, val);
670 int __must_check pci_enable_device(struct pci_dev *dev);
671 int __must_check pci_enable_device_io(struct pci_dev *dev);
672 int __must_check pci_enable_device_mem(struct pci_dev *dev);
673 int __must_check pci_reenable_device(struct pci_dev *);
674 int __must_check pcim_enable_device(struct pci_dev *pdev);
675 void pcim_pin_device(struct pci_dev *pdev);
677 static inline int pci_is_enabled(struct pci_dev *pdev)
679 return (atomic_read(&pdev->enable_cnt) > 0);
682 static inline int pci_is_managed(struct pci_dev *pdev)
684 return pdev->is_managed;
687 void pci_disable_device(struct pci_dev *dev);
688 void pci_set_master(struct pci_dev *dev);
689 void pci_clear_master(struct pci_dev *dev);
690 int pci_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state);
691 #define HAVE_PCI_SET_MWI
692 int __must_check pci_set_mwi(struct pci_dev *dev);
693 int pci_try_set_mwi(struct pci_dev *dev);
694 void pci_clear_mwi(struct pci_dev *dev);
695 void pci_intx(struct pci_dev *dev, int enable);
696 void pci_msi_off(struct pci_dev *dev);
697 int pci_set_dma_mask(struct pci_dev *dev, u64 mask);
698 int pci_set_consistent_dma_mask(struct pci_dev *dev, u64 mask);
699 int pci_set_dma_max_seg_size(struct pci_dev *dev, unsigned int size);
700 int pci_set_dma_seg_boundary(struct pci_dev *dev, unsigned long mask);
701 int pcix_get_max_mmrbc(struct pci_dev *dev);
702 int pcix_get_mmrbc(struct pci_dev *dev);
703 int pcix_set_mmrbc(struct pci_dev *dev, int mmrbc);
704 int pcie_get_readrq(struct pci_dev *dev);
705 int pcie_set_readrq(struct pci_dev *dev, int rq);
706 int pci_reset_function(struct pci_dev *dev);
707 int pci_execute_reset_function(struct pci_dev *dev);
708 void pci_update_resource(struct pci_dev *dev, int resno);
709 int __must_check pci_assign_resource(struct pci_dev *dev, int i);
710 int pci_select_bars(struct pci_dev *dev, unsigned long flags);
712 /* ROM control related routines */
713 int pci_enable_rom(struct pci_dev *pdev);
714 void pci_disable_rom(struct pci_dev *pdev);
715 void __iomem __must_check *pci_map_rom(struct pci_dev *pdev, size_t *size);
716 void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom);
717 size_t pci_get_rom_size(struct pci_dev *pdev, void __iomem *rom, size_t size);
719 /* Power management related routines */
720 int pci_save_state(struct pci_dev *dev);
721 int pci_restore_state(struct pci_dev *dev);
722 int __pci_complete_power_transition(struct pci_dev *dev, pci_power_t state);
723 int pci_set_power_state(struct pci_dev *dev, pci_power_t state);
724 pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state);
725 bool pci_pme_capable(struct pci_dev *dev, pci_power_t state);
726 void pci_pme_active(struct pci_dev *dev, bool enable);
727 int pci_enable_wake(struct pci_dev *dev, pci_power_t state, int enable);
728 int pci_wake_from_d3(struct pci_dev *dev, bool enable);
729 pci_power_t pci_target_state(struct pci_dev *dev);
730 int pci_prepare_to_sleep(struct pci_dev *dev);
731 int pci_back_from_sleep(struct pci_dev *dev);
733 /* Functions for PCI Hotplug drivers to use */
734 int pci_bus_find_capability(struct pci_bus *bus, unsigned int devfn, int cap);
735 #ifdef CONFIG_HOTPLUG
736 unsigned int pci_rescan_bus(struct pci_bus *bus);
739 /* Vital product data routines */
740 ssize_t pci_read_vpd(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
741 ssize_t pci_write_vpd(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
742 int pci_vpd_truncate(struct pci_dev *dev, size_t size);
744 /* Helper functions for low-level code (drivers/pci/setup-[bus,res].c) */
745 void pci_bus_assign_resources(const struct pci_bus *bus);
746 void pci_bus_size_bridges(struct pci_bus *bus);
747 int pci_claim_resource(struct pci_dev *, int);
748 void pci_assign_unassigned_resources(void);
749 void pdev_enable_device(struct pci_dev *);
750 void pdev_sort_resources(struct pci_dev *, struct resource_list *);
751 int pci_enable_resources(struct pci_dev *, int mask);
752 void pci_fixup_irqs(u8 (*)(struct pci_dev *, u8 *),
753 int (*)(struct pci_dev *, u8, u8));
754 #define HAVE_PCI_REQ_REGIONS 2
755 int __must_check pci_request_regions(struct pci_dev *, const char *);
756 int __must_check pci_request_regions_exclusive(struct pci_dev *, const char *);
757 void pci_release_regions(struct pci_dev *);
758 int __must_check pci_request_region(struct pci_dev *, int, const char *);
759 int __must_check pci_request_region_exclusive(struct pci_dev *, int, const char *);
760 void pci_release_region(struct pci_dev *, int);
761 int pci_request_selected_regions(struct pci_dev *, int, const char *);
762 int pci_request_selected_regions_exclusive(struct pci_dev *, int, const char *);
763 void pci_release_selected_regions(struct pci_dev *, int);
765 /* drivers/pci/bus.c */
766 int __must_check pci_bus_alloc_resource(struct pci_bus *bus,
767 struct resource *res, resource_size_t size,
768 resource_size_t align, resource_size_t min,
769 unsigned int type_mask,
770 void (*alignf)(void *, struct resource *,
771 resource_size_t, resource_size_t),
773 void pci_enable_bridges(struct pci_bus *bus);
775 /* Proper probing supporting hot-pluggable devices */
776 int __must_check __pci_register_driver(struct pci_driver *, struct module *,
777 const char *mod_name);
780 * pci_register_driver must be a macro so that KBUILD_MODNAME can be expanded
782 #define pci_register_driver(driver) \
783 __pci_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
785 void pci_unregister_driver(struct pci_driver *dev);
786 void pci_remove_behind_bridge(struct pci_dev *dev);
787 struct pci_driver *pci_dev_driver(const struct pci_dev *dev);
788 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
789 struct pci_dev *dev);
790 int pci_scan_bridge(struct pci_bus *bus, struct pci_dev *dev, int max,
793 void pci_walk_bus(struct pci_bus *top, void (*cb)(struct pci_dev *, void *),
795 int pci_cfg_space_size_ext(struct pci_dev *dev);
796 int pci_cfg_space_size(struct pci_dev *dev);
797 unsigned char pci_bus_max_busnr(struct pci_bus *bus);
799 /* kmem_cache style wrapper around pci_alloc_consistent() */
801 #include <linux/dmapool.h>
803 #define pci_pool dma_pool
804 #define pci_pool_create(name, pdev, size, align, allocation) \
805 dma_pool_create(name, &pdev->dev, size, align, allocation)
806 #define pci_pool_destroy(pool) dma_pool_destroy(pool)
807 #define pci_pool_alloc(pool, flags, handle) dma_pool_alloc(pool, flags, handle)
808 #define pci_pool_free(pool, vaddr, addr) dma_pool_free(pool, vaddr, addr)
810 enum pci_dma_burst_strategy {
811 PCI_DMA_BURST_INFINITY, /* make bursts as large as possible,
812 strategy_parameter is N/A */
813 PCI_DMA_BURST_BOUNDARY, /* disconnect at every strategy_parameter
815 PCI_DMA_BURST_MULTIPLE, /* disconnect at some multiple of
816 strategy_parameter byte boundaries */
820 u32 vector; /* kernel uses to write allocated vector */
821 u16 entry; /* driver uses to specify entry, OS writes */
825 #ifndef CONFIG_PCI_MSI
826 static inline int pci_enable_msi_block(struct pci_dev *dev, unsigned int nvec)
831 static inline void pci_msi_shutdown(struct pci_dev *dev)
833 static inline void pci_disable_msi(struct pci_dev *dev)
836 static inline int pci_msix_table_size(struct pci_dev *dev)
840 static inline int pci_enable_msix(struct pci_dev *dev,
841 struct msix_entry *entries, int nvec)
846 static inline void pci_msix_shutdown(struct pci_dev *dev)
848 static inline void pci_disable_msix(struct pci_dev *dev)
851 static inline void msi_remove_pci_irq_vectors(struct pci_dev *dev)
854 static inline void pci_restore_msi_state(struct pci_dev *dev)
856 static inline int pci_msi_enabled(void)
861 extern int pci_enable_msi_block(struct pci_dev *dev, unsigned int nvec);
862 extern void pci_msi_shutdown(struct pci_dev *dev);
863 extern void pci_disable_msi(struct pci_dev *dev);
864 extern int pci_msix_table_size(struct pci_dev *dev);
865 extern int pci_enable_msix(struct pci_dev *dev,
866 struct msix_entry *entries, int nvec);
867 extern void pci_msix_shutdown(struct pci_dev *dev);
868 extern void pci_disable_msix(struct pci_dev *dev);
869 extern void msi_remove_pci_irq_vectors(struct pci_dev *dev);
870 extern void pci_restore_msi_state(struct pci_dev *dev);
871 extern int pci_msi_enabled(void);
874 #ifndef CONFIG_PCIEASPM
875 static inline int pcie_aspm_enabled(void)
880 extern int pcie_aspm_enabled(void);
883 #define pci_enable_msi(pdev) pci_enable_msi_block(pdev, 1)
886 /* The functions a driver should call */
887 int ht_create_irq(struct pci_dev *dev, int idx);
888 void ht_destroy_irq(unsigned int irq);
889 #endif /* CONFIG_HT_IRQ */
891 extern void pci_block_user_cfg_access(struct pci_dev *dev);
892 extern void pci_unblock_user_cfg_access(struct pci_dev *dev);
895 * PCI domain support. Sometimes called PCI segment (eg by ACPI),
896 * a PCI domain is defined to be a set of PCI busses which share
897 * configuration space.
899 #ifdef CONFIG_PCI_DOMAINS
900 extern int pci_domains_supported;
902 enum { pci_domains_supported = 0 };
903 static inline int pci_domain_nr(struct pci_bus *bus)
908 static inline int pci_proc_domain(struct pci_bus *bus)
912 #endif /* CONFIG_PCI_DOMAINS */
914 #else /* CONFIG_PCI is not enabled */
917 * If the system does not have PCI, clearly these return errors. Define
918 * these as simple inline functions to avoid hair in drivers.
921 #define _PCI_NOP(o, s, t) \
922 static inline int pci_##o##_config_##s(struct pci_dev *dev, \
924 { return PCIBIOS_FUNC_NOT_SUPPORTED; }
926 #define _PCI_NOP_ALL(o, x) _PCI_NOP(o, byte, u8 x) \
927 _PCI_NOP(o, word, u16 x) \
928 _PCI_NOP(o, dword, u32 x)
929 _PCI_NOP_ALL(read, *)
932 static inline struct pci_dev *pci_find_device(unsigned int vendor,
934 struct pci_dev *from)
939 static inline struct pci_dev *pci_find_slot(unsigned int bus,
945 static inline struct pci_dev *pci_get_device(unsigned int vendor,
947 struct pci_dev *from)
952 static inline struct pci_dev *pci_get_subsys(unsigned int vendor,
954 unsigned int ss_vendor,
955 unsigned int ss_device,
956 struct pci_dev *from)
961 static inline struct pci_dev *pci_get_class(unsigned int class,
962 struct pci_dev *from)
967 #define pci_dev_present(ids) (0)
968 #define no_pci_devices() (1)
969 #define pci_dev_put(dev) do { } while (0)
971 static inline void pci_set_master(struct pci_dev *dev)
974 static inline int pci_enable_device(struct pci_dev *dev)
979 static inline void pci_disable_device(struct pci_dev *dev)
982 static inline int pci_set_dma_mask(struct pci_dev *dev, u64 mask)
987 static inline int pci_set_consistent_dma_mask(struct pci_dev *dev, u64 mask)
992 static inline int pci_set_dma_max_seg_size(struct pci_dev *dev,
998 static inline int pci_set_dma_seg_boundary(struct pci_dev *dev,
1004 static inline int pci_assign_resource(struct pci_dev *dev, int i)
1009 static inline int __pci_register_driver(struct pci_driver *drv,
1010 struct module *owner)
1015 static inline int pci_register_driver(struct pci_driver *drv)
1020 static inline void pci_unregister_driver(struct pci_driver *drv)
1023 static inline int pci_find_capability(struct pci_dev *dev, int cap)
1028 static inline int pci_find_next_capability(struct pci_dev *dev, u8 post,
1034 static inline int pci_find_ext_capability(struct pci_dev *dev, int cap)
1039 /* Power management related routines */
1040 static inline int pci_save_state(struct pci_dev *dev)
1045 static inline int pci_restore_state(struct pci_dev *dev)
1050 static inline int pci_set_power_state(struct pci_dev *dev, pci_power_t state)
1055 static inline pci_power_t pci_choose_state(struct pci_dev *dev,
1061 static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
1067 static inline int pci_request_regions(struct pci_dev *dev, const char *res_name)
1072 static inline void pci_release_regions(struct pci_dev *dev)
1075 #define pci_dma_burst_advice(pdev, strat, strategy_parameter) do { } while (0)
1077 static inline void pci_block_user_cfg_access(struct pci_dev *dev)
1080 static inline void pci_unblock_user_cfg_access(struct pci_dev *dev)
1083 static inline struct pci_bus *pci_find_next_bus(const struct pci_bus *from)
1086 static inline struct pci_dev *pci_get_slot(struct pci_bus *bus,
1090 static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
1094 #endif /* CONFIG_PCI */
1096 /* Include architecture-dependent settings and functions */
1098 #include <asm/pci.h>
1100 /* these helpers provide future and backwards compatibility
1101 * for accessing popular PCI BAR info */
1102 #define pci_resource_start(dev, bar) ((dev)->resource[(bar)].start)
1103 #define pci_resource_end(dev, bar) ((dev)->resource[(bar)].end)
1104 #define pci_resource_flags(dev, bar) ((dev)->resource[(bar)].flags)
1105 #define pci_resource_len(dev,bar) \
1106 ((pci_resource_start((dev), (bar)) == 0 && \
1107 pci_resource_end((dev), (bar)) == \
1108 pci_resource_start((dev), (bar))) ? 0 : \
1110 (pci_resource_end((dev), (bar)) - \
1111 pci_resource_start((dev), (bar)) + 1))
1113 /* Similar to the helpers above, these manipulate per-pci_dev
1114 * driver-specific data. They are really just a wrapper around
1115 * the generic device structure functions of these calls.
1117 static inline void *pci_get_drvdata(struct pci_dev *pdev)
1119 return dev_get_drvdata(&pdev->dev);
1122 static inline void pci_set_drvdata(struct pci_dev *pdev, void *data)
1124 dev_set_drvdata(&pdev->dev, data);
1127 /* If you want to know what to call your pci_dev, ask this function.
1128 * Again, it's a wrapper around the generic device.
1130 static inline const char *pci_name(struct pci_dev *pdev)
1132 return dev_name(&pdev->dev);
1136 /* Some archs don't want to expose struct resource to userland as-is
1137 * in sysfs and /proc
1139 #ifndef HAVE_ARCH_PCI_RESOURCE_TO_USER
1140 static inline void pci_resource_to_user(const struct pci_dev *dev, int bar,
1141 const struct resource *rsrc, resource_size_t *start,
1142 resource_size_t *end)
1144 *start = rsrc->start;
1147 #endif /* HAVE_ARCH_PCI_RESOURCE_TO_USER */
1151 * The world is not perfect and supplies us with broken PCI devices.
1152 * For at least a part of these bugs we need a work-around, so both
1153 * generic (drivers/pci/quirks.c) and per-architecture code can define
1154 * fixup hooks to be called for particular buggy devices.
1158 u16 vendor, device; /* You can use PCI_ANY_ID here of course */
1159 void (*hook)(struct pci_dev *dev);
1162 enum pci_fixup_pass {
1163 pci_fixup_early, /* Before probing BARs */
1164 pci_fixup_header, /* After reading configuration header */
1165 pci_fixup_final, /* Final phase of device fixups */
1166 pci_fixup_enable, /* pci_enable_device() time */
1167 pci_fixup_resume, /* pci_device_resume() */
1168 pci_fixup_suspend, /* pci_device_suspend */
1169 pci_fixup_resume_early, /* pci_device_resume_early() */
1172 /* Anonymous variables would be nice... */
1173 #define DECLARE_PCI_FIXUP_SECTION(section, name, vendor, device, hook) \
1174 static const struct pci_fixup __pci_fixup_##name __used \
1175 __attribute__((__section__(#section))) = { vendor, device, hook };
1176 #define DECLARE_PCI_FIXUP_EARLY(vendor, device, hook) \
1177 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early, \
1178 vendor##device##hook, vendor, device, hook)
1179 #define DECLARE_PCI_FIXUP_HEADER(vendor, device, hook) \
1180 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header, \
1181 vendor##device##hook, vendor, device, hook)
1182 #define DECLARE_PCI_FIXUP_FINAL(vendor, device, hook) \
1183 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final, \
1184 vendor##device##hook, vendor, device, hook)
1185 #define DECLARE_PCI_FIXUP_ENABLE(vendor, device, hook) \
1186 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable, \
1187 vendor##device##hook, vendor, device, hook)
1188 #define DECLARE_PCI_FIXUP_RESUME(vendor, device, hook) \
1189 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume, \
1190 resume##vendor##device##hook, vendor, device, hook)
1191 #define DECLARE_PCI_FIXUP_RESUME_EARLY(vendor, device, hook) \
1192 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early, \
1193 resume_early##vendor##device##hook, vendor, device, hook)
1194 #define DECLARE_PCI_FIXUP_SUSPEND(vendor, device, hook) \
1195 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend, \
1196 suspend##vendor##device##hook, vendor, device, hook)
1199 void pci_fixup_device(enum pci_fixup_pass pass, struct pci_dev *dev);
1201 void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen);
1202 void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr);
1203 void __iomem * const *pcim_iomap_table(struct pci_dev *pdev);
1204 int pcim_iomap_regions(struct pci_dev *pdev, u16 mask, const char *name);
1205 int pcim_iomap_regions_request_all(struct pci_dev *pdev, u16 mask,
1207 void pcim_iounmap_regions(struct pci_dev *pdev, u16 mask);
1209 extern int pci_pci_problems;
1210 #define PCIPCI_FAIL 1 /* No PCI PCI DMA */
1211 #define PCIPCI_TRITON 2
1212 #define PCIPCI_NATOMA 4
1213 #define PCIPCI_VIAETBF 8
1214 #define PCIPCI_VSFX 16
1215 #define PCIPCI_ALIMAGIK 32 /* Need low latency setting */
1216 #define PCIAGP_FAIL 64 /* No PCI to AGP DMA */
1218 extern unsigned long pci_cardbus_io_size;
1219 extern unsigned long pci_cardbus_mem_size;
1221 int pcibios_add_platform_entries(struct pci_dev *dev);
1222 void pcibios_disable_device(struct pci_dev *dev);
1223 int pcibios_set_pcie_reset_state(struct pci_dev *dev,
1224 enum pcie_reset_state state);
1226 #ifdef CONFIG_PCI_MMCONFIG
1227 extern void __init pci_mmcfg_early_init(void);
1228 extern void __init pci_mmcfg_late_init(void);
1230 static inline void pci_mmcfg_early_init(void) { }
1231 static inline void pci_mmcfg_late_init(void) { }
1234 int pci_ext_cfg_avail(struct pci_dev *dev);
1236 void __iomem *pci_ioremap_bar(struct pci_dev *pdev, int bar);
1238 #ifdef CONFIG_PCI_IOV
1239 extern int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn);
1240 extern void pci_disable_sriov(struct pci_dev *dev);
1241 extern irqreturn_t pci_sriov_migration(struct pci_dev *dev);
1243 static inline int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn)
1247 static inline void pci_disable_sriov(struct pci_dev *dev)
1250 static inline irqreturn_t pci_sriov_migration(struct pci_dev *dev)
1256 #endif /* __KERNEL__ */
1257 #endif /* LINUX_PCI_H */