]> git.proxmox.com Git - mirror_ubuntu-focal-kernel.git/blob - include/linux/pci.h
projects / mirror_ubuntu-focal-kernel.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
PCI: Introduce INTx check & mask API
[mirror_ubuntu-focal-kernel.git] / include / linux / pci.h
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
20 #include <linux/pci_regs.h> /* The pci register defines */
21
22 /*
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:
26 *
27 * 7:3 = slot
28 * 2:0 = function
29 */
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)
33
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. */
40
41 #ifdef __KERNEL__
42
43 #include <linux/mod_devicetable.h>
44
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 <linux/atomic.h>
53 #include <linux/device.h>
54 #include <linux/io.h>
55 #include <linux/irqreturn.h>
56
57 /* Include the ID list */
58 #include <linux/pci_ids.h>
59
60 /* pci_slot represents a physical slot */
61 struct pci_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) */
66 struct kobject kobj;
67 };
68
69 static inline const char *pci_slot_name(const struct pci_slot *slot)
70 {
71 return kobject_name(&slot->kobj);
72 }
73
74 /* File state for mmap()s on /proc/bus/pci/X/Y */
75 enum pci_mmap_state {
76 pci_mmap_io,
77 pci_mmap_mem
78 };
79
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
85
86 /*
87 * For PCI devices, the region numbers are assigned this way:
88 */
89 enum {
90 /* #0-5: standard PCI resources */
91 PCI_STD_RESOURCES,
92 PCI_STD_RESOURCE_END = 5,
93
94 /* #6: expansion ROM resource */
95 PCI_ROM_RESOURCE,
96
97 /* device specific resources */
98 #ifdef CONFIG_PCI_IOV
99 PCI_IOV_RESOURCES,
100 PCI_IOV_RESOURCE_END = PCI_IOV_RESOURCES + PCI_SRIOV_NUM_BARS - 1,
101 #endif
102
103 /* resources assigned to buses behind the bridge */
104 #define PCI_BRIDGE_RESOURCE_NUM 4
105
106 PCI_BRIDGE_RESOURCES,
107 PCI_BRIDGE_RESOURCE_END = PCI_BRIDGE_RESOURCES +
108 PCI_BRIDGE_RESOURCE_NUM - 1,
109
110 /* total resources associated with a PCI device */
111 PCI_NUM_RESOURCES,
112
113 /* preserve this for compatibility */
114 DEVICE_COUNT_RESOURCE
115 };
116
117 typedef int __bitwise pci_power_t;
118
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)
126
127 /* Remember to update this when the list above changes! */
128 extern const char *pci_power_names[];
129
130 static inline const char *pci_power_name(pci_power_t state)
131 {
132 return pci_power_names[1 + (int) state];
133 }
134
135 #define PCI_PM_D2_DELAY 200
136 #define PCI_PM_D3_WAIT 10
137 #define PCI_PM_BUS_WAIT 50
138
139 /** The pci_channel state describes connectivity between the CPU and
140 * the pci device. If some PCI bus between here and the pci device
141 * has crashed or locked up, this info is reflected here.
142 */
143 typedef unsigned int __bitwise pci_channel_state_t;
144
145 enum pci_channel_state {
146 /* I/O channel is in normal state */
147 pci_channel_io_normal = (__force pci_channel_state_t) 1,
148
149 /* I/O to channel is blocked */
150 pci_channel_io_frozen = (__force pci_channel_state_t) 2,
151
152 /* PCI card is dead */
153 pci_channel_io_perm_failure = (__force pci_channel_state_t) 3,
154 };
155
156 typedef unsigned int __bitwise pcie_reset_state_t;
157
158 enum pcie_reset_state {
159 /* Reset is NOT asserted (Use to deassert reset) */
160 pcie_deassert_reset = (__force pcie_reset_state_t) 1,
161
162 /* Use #PERST to reset PCI-E device */
163 pcie_warm_reset = (__force pcie_reset_state_t) 2,
164
165 /* Use PCI-E Hot Reset to reset device */
166 pcie_hot_reset = (__force pcie_reset_state_t) 3
167 };
168
169 typedef unsigned short __bitwise pci_dev_flags_t;
170 enum pci_dev_flags {
171 /* INTX_DISABLE in PCI_COMMAND register disables MSI
172 * generation too.
173 */
174 PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG = (__force pci_dev_flags_t) 1,
175 /* Device configuration is irrevocably lost if disabled into D3 */
176 PCI_DEV_FLAGS_NO_D3 = (__force pci_dev_flags_t) 2,
177 /* Provide indication device is assigned by a Virtual Machine Manager */
178 PCI_DEV_FLAGS_ASSIGNED = (__force pci_dev_flags_t) 4,
179 };
180
181 enum pci_irq_reroute_variant {
182 INTEL_IRQ_REROUTE_VARIANT = 1,
183 MAX_IRQ_REROUTE_VARIANTS = 3
184 };
185
186 typedef unsigned short __bitwise pci_bus_flags_t;
187 enum pci_bus_flags {
188 PCI_BUS_FLAGS_NO_MSI = (__force pci_bus_flags_t) 1,
189 PCI_BUS_FLAGS_NO_MMRBC = (__force pci_bus_flags_t) 2,
190 };
191
192 /* Based on the PCI Hotplug Spec, but some values are made up by us */
193 enum pci_bus_speed {
194 PCI_SPEED_33MHz = 0x00,
195 PCI_SPEED_66MHz = 0x01,
196 PCI_SPEED_66MHz_PCIX = 0x02,
197 PCI_SPEED_100MHz_PCIX = 0x03,
198 PCI_SPEED_133MHz_PCIX = 0x04,
199 PCI_SPEED_66MHz_PCIX_ECC = 0x05,
200 PCI_SPEED_100MHz_PCIX_ECC = 0x06,
201 PCI_SPEED_133MHz_PCIX_ECC = 0x07,
202 PCI_SPEED_66MHz_PCIX_266 = 0x09,
203 PCI_SPEED_100MHz_PCIX_266 = 0x0a,
204 PCI_SPEED_133MHz_PCIX_266 = 0x0b,
205 AGP_UNKNOWN = 0x0c,
206 AGP_1X = 0x0d,
207 AGP_2X = 0x0e,
208 AGP_4X = 0x0f,
209 AGP_8X = 0x10,
210 PCI_SPEED_66MHz_PCIX_533 = 0x11,
211 PCI_SPEED_100MHz_PCIX_533 = 0x12,
212 PCI_SPEED_133MHz_PCIX_533 = 0x13,
213 PCIE_SPEED_2_5GT = 0x14,
214 PCIE_SPEED_5_0GT = 0x15,
215 PCIE_SPEED_8_0GT = 0x16,
216 PCI_SPEED_UNKNOWN = 0xff,
217 };
218
219 struct pci_cap_saved_data {
220 char cap_nr;
221 unsigned int size;
222 u32 data[0];
223 };
224
225 struct pci_cap_saved_state {
226 struct hlist_node next;
227 struct pci_cap_saved_data cap;
228 };
229
230 struct pcie_link_state;
231 struct pci_vpd;
232 struct pci_sriov;
233 struct pci_ats;
234
235 /*
236 * The pci_dev structure is used to describe PCI devices.
237 */
238 struct pci_dev {
239 struct list_head bus_list; /* node in per-bus list */
240 struct pci_bus *bus; /* bus this device is on */
241 struct pci_bus *subordinate; /* bus this device bridges to */
242
243 void *sysdata; /* hook for sys-specific extension */
244 struct proc_dir_entry *procent; /* device entry in /proc/bus/pci */
245 struct pci_slot *slot; /* Physical slot this device is in */
246
247 unsigned int devfn; /* encoded device & function index */
248 unsigned short vendor;
249 unsigned short device;
250 unsigned short subsystem_vendor;
251 unsigned short subsystem_device;
252 unsigned int class; /* 3 bytes: (base,sub,prog-if) */
253 u8 revision; /* PCI revision, low byte of class word */
254 u8 hdr_type; /* PCI header type (`multi' flag masked out) */
255 u8 pcie_cap; /* PCI-E capability offset */
256 u8 pcie_type:4; /* PCI-E device/port type */
257 u8 pcie_mpss:3; /* PCI-E Max Payload Size Supported */
258 u8 rom_base_reg; /* which config register controls the ROM */
259 u8 pin; /* which interrupt pin this device uses */
260
261 struct pci_driver *driver; /* which driver has allocated this device */
262 u64 dma_mask; /* Mask of the bits of bus address this
263 device implements. Normally this is
264 0xffffffff. You only need to change
265 this if your device has broken DMA
266 or supports 64-bit transfers. */
267
268 struct device_dma_parameters dma_parms;
269
270 pci_power_t current_state; /* Current operating state. In ACPI-speak,
271 this is D0-D3, D0 being fully functional,
272 and D3 being off. */
273 int pm_cap; /* PM capability offset in the
274 configuration space */
275 unsigned int pme_support:5; /* Bitmask of states from which PME#
276 can be generated */
277 unsigned int pme_interrupt:1;
278 unsigned int pme_poll:1; /* Poll device's PME status bit */
279 unsigned int d1_support:1; /* Low power state D1 is supported */
280 unsigned int d2_support:1; /* Low power state D2 is supported */
281 unsigned int no_d1d2:1; /* Only allow D0 and D3 */
282 unsigned int mmio_always_on:1; /* disallow turning off io/mem
283 decoding during bar sizing */
284 unsigned int wakeup_prepared:1;
285 unsigned int d3_delay; /* D3->D0 transition time in ms */
286
287 #ifdef CONFIG_PCIEASPM
288 struct pcie_link_state *link_state; /* ASPM link state. */
289 #endif
290
291 pci_channel_state_t error_state; /* current connectivity state */
292 struct device dev; /* Generic device interface */
293
294 int cfg_size; /* Size of configuration space */
295
296 /*
297 * Instead of touching interrupt line and base address registers
298 * directly, use the values stored here. They might be different!
299 */
300 unsigned int irq;
301 struct resource resource[DEVICE_COUNT_RESOURCE]; /* I/O and memory regions + expansion ROMs */
302 resource_size_t fw_addr[DEVICE_COUNT_RESOURCE]; /* FW-assigned addr */
303
304 /* These fields are used by common fixups */
305 unsigned int transparent:1; /* Transparent PCI bridge */
306 unsigned int multifunction:1;/* Part of multi-function device */
307 /* keep track of device state */
308 unsigned int is_added:1;
309 unsigned int is_busmaster:1; /* device is busmaster */
310 unsigned int no_msi:1; /* device may not use msi */
311 unsigned int block_cfg_access:1; /* config space access is blocked */
312 unsigned int broken_parity_status:1; /* Device generates false positive parity */
313 unsigned int irq_reroute_variant:2; /* device needs IRQ rerouting variant */
314 unsigned int msi_enabled:1;
315 unsigned int msix_enabled:1;
316 unsigned int ari_enabled:1; /* ARI forwarding */
317 unsigned int is_managed:1;
318 unsigned int is_pcie:1; /* Obsolete. Will be removed.
319 Use pci_is_pcie() instead */
320 unsigned int needs_freset:1; /* Dev requires fundamental reset */
321 unsigned int state_saved:1;
322 unsigned int is_physfn:1;
323 unsigned int is_virtfn:1;
324 unsigned int reset_fn:1;
325 unsigned int is_hotplug_bridge:1;
326 unsigned int __aer_firmware_first_valid:1;
327 unsigned int __aer_firmware_first:1;
328 pci_dev_flags_t dev_flags;
329 atomic_t enable_cnt; /* pci_enable_device has been called */
330
331 u32 saved_config_space[16]; /* config space saved at suspend time */
332 struct hlist_head saved_cap_space;
333 struct bin_attribute *rom_attr; /* attribute descriptor for sysfs ROM entry */
334 int rom_attr_enabled; /* has display of the rom attribute been enabled? */
335 struct bin_attribute *res_attr[DEVICE_COUNT_RESOURCE]; /* sysfs file for resources */
336 struct bin_attribute *res_attr_wc[DEVICE_COUNT_RESOURCE]; /* sysfs file for WC mapping of resources */
337 #ifdef CONFIG_PCI_MSI
338 struct list_head msi_list;
339 struct kset *msi_kset;
340 #endif
341 struct pci_vpd *vpd;
342 #ifdef CONFIG_PCI_ATS
343 union {
344 struct pci_sriov *sriov; /* SR-IOV capability related */
345 struct pci_dev *physfn; /* the PF this VF is associated with */
346 };
347 struct pci_ats *ats; /* Address Translation Service */
348 #endif
349 };
350
351 static inline struct pci_dev *pci_physfn(struct pci_dev *dev)
352 {
353 #ifdef CONFIG_PCI_IOV
354 if (dev->is_virtfn)
355 dev = dev->physfn;
356 #endif
357
358 return dev;
359 }
360
361 extern struct pci_dev *alloc_pci_dev(void);
362
363 #define pci_dev_b(n) list_entry(n, struct pci_dev, bus_list)
364 #define to_pci_dev(n) container_of(n, struct pci_dev, dev)
365 #define for_each_pci_dev(d) while ((d = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, d)) != NULL)
366
367 static inline int pci_channel_offline(struct pci_dev *pdev)
368 {
369 return (pdev->error_state != pci_channel_io_normal);
370 }
371
372 static inline struct pci_cap_saved_state *pci_find_saved_cap(
373 struct pci_dev *pci_dev, char cap)
374 {
375 struct pci_cap_saved_state *tmp;
376 struct hlist_node *pos;
377
378 hlist_for_each_entry(tmp, pos, &pci_dev->saved_cap_space, next) {
379 if (tmp->cap.cap_nr == cap)
380 return tmp;
381 }
382 return NULL;
383 }
384
385 static inline void pci_add_saved_cap(struct pci_dev *pci_dev,
386 struct pci_cap_saved_state *new_cap)
387 {
388 hlist_add_head(&new_cap->next, &pci_dev->saved_cap_space);
389 }
390
391 /*
392 * The first PCI_BRIDGE_RESOURCE_NUM PCI bus resources (those that correspond
393 * to P2P or CardBus bridge windows) go in a table. Additional ones (for
394 * buses below host bridges or subtractive decode bridges) go in the list.
395 * Use pci_bus_for_each_resource() to iterate through all the resources.
396 */
397
398 /*
399 * PCI_SUBTRACTIVE_DECODE means the bridge forwards the window implicitly
400 * and there's no way to program the bridge with the details of the window.
401 * This does not apply to ACPI _CRS windows, even with the _DEC subtractive-
402 * decode bit set, because they are explicit and can be programmed with _SRS.
403 */
404 #define PCI_SUBTRACTIVE_DECODE 0x1
405
406 struct pci_bus_resource {
407 struct list_head list;
408 struct resource *res;
409 unsigned int flags;
410 };
411
412 #define PCI_REGION_FLAG_MASK 0x0fU /* These bits of resource flags tell us the PCI region flags */
413
414 struct pci_bus {
415 struct list_head node; /* node in list of buses */
416 struct pci_bus *parent; /* parent bus this bridge is on */
417 struct list_head children; /* list of child buses */
418 struct list_head devices; /* list of devices on this bus */
419 struct pci_dev *self; /* bridge device as seen by parent */
420 struct list_head slots; /* list of slots on this bus */
421 struct resource *resource[PCI_BRIDGE_RESOURCE_NUM];
422 struct list_head resources; /* address space routed to this bus */
423
424 struct pci_ops *ops; /* configuration access functions */
425 void *sysdata; /* hook for sys-specific extension */
426 struct proc_dir_entry *procdir; /* directory entry in /proc/bus/pci */
427
428 unsigned char number; /* bus number */
429 unsigned char primary; /* number of primary bridge */
430 unsigned char secondary; /* number of secondary bridge */
431 unsigned char subordinate; /* max number of subordinate buses */
432 unsigned char max_bus_speed; /* enum pci_bus_speed */
433 unsigned char cur_bus_speed; /* enum pci_bus_speed */
434
435 char name[48];
436
437 unsigned short bridge_ctl; /* manage NO_ISA/FBB/et al behaviors */
438 pci_bus_flags_t bus_flags; /* Inherited by child busses */
439 struct device *bridge;
440 struct device dev;
441 struct bin_attribute *legacy_io; /* legacy I/O for this bus */
442 struct bin_attribute *legacy_mem; /* legacy mem */
443 unsigned int is_added:1;
444 };
445
446 #define pci_bus_b(n) list_entry(n, struct pci_bus, node)
447 #define to_pci_bus(n) container_of(n, struct pci_bus, dev)
448
449 /*
450 * Returns true if the pci bus is root (behind host-pci bridge),
451 * false otherwise
452 */
453 static inline bool pci_is_root_bus(struct pci_bus *pbus)
454 {
455 return !(pbus->parent);
456 }
457
458 #ifdef CONFIG_PCI_MSI
459 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev)
460 {
461 return pci_dev->msi_enabled || pci_dev->msix_enabled;
462 }
463 #else
464 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev) { return false; }
465 #endif
466
467 /*
468 * Error values that may be returned by PCI functions.
469 */
470 #define PCIBIOS_SUCCESSFUL 0x00
471 #define PCIBIOS_FUNC_NOT_SUPPORTED 0x81
472 #define PCIBIOS_BAD_VENDOR_ID 0x83
473 #define PCIBIOS_DEVICE_NOT_FOUND 0x86
474 #define PCIBIOS_BAD_REGISTER_NUMBER 0x87
475 #define PCIBIOS_SET_FAILED 0x88
476 #define PCIBIOS_BUFFER_TOO_SMALL 0x89
477
478 /* Low-level architecture-dependent routines */
479
480 struct pci_ops {
481 int (*read)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 *val);
482 int (*write)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 val);
483 };
484
485 /*
486 * ACPI needs to be able to access PCI config space before we've done a
487 * PCI bus scan and created pci_bus structures.
488 */
489 extern int raw_pci_read(unsigned int domain, unsigned int bus,
490 unsigned int devfn, int reg, int len, u32 *val);
491 extern int raw_pci_write(unsigned int domain, unsigned int bus,
492 unsigned int devfn, int reg, int len, u32 val);
493
494 struct pci_bus_region {
495 resource_size_t start;
496 resource_size_t end;
497 };
498
499 struct pci_dynids {
500 spinlock_t lock; /* protects list, index */
501 struct list_head list; /* for IDs added at runtime */
502 };
503
504 /* ---------------------------------------------------------------- */
505 /** PCI Error Recovery System (PCI-ERS). If a PCI device driver provides
506 * a set of callbacks in struct pci_error_handlers, then that device driver
507 * will be notified of PCI bus errors, and will be driven to recovery
508 * when an error occurs.
509 */
510
511 typedef unsigned int __bitwise pci_ers_result_t;
512
513 enum pci_ers_result {
514 /* no result/none/not supported in device driver */
515 PCI_ERS_RESULT_NONE = (__force pci_ers_result_t) 1,
516
517 /* Device driver can recover without slot reset */
518 PCI_ERS_RESULT_CAN_RECOVER = (__force pci_ers_result_t) 2,
519
520 /* Device driver wants slot to be reset. */
521 PCI_ERS_RESULT_NEED_RESET = (__force pci_ers_result_t) 3,
522
523 /* Device has completely failed, is unrecoverable */
524 PCI_ERS_RESULT_DISCONNECT = (__force pci_ers_result_t) 4,
525
526 /* Device driver is fully recovered and operational */
527 PCI_ERS_RESULT_RECOVERED = (__force pci_ers_result_t) 5,
528 };
529
530 /* PCI bus error event callbacks */
531 struct pci_error_handlers {
532 /* PCI bus error detected on this device */
533 pci_ers_result_t (*error_detected)(struct pci_dev *dev,
534 enum pci_channel_state error);
535
536 /* MMIO has been re-enabled, but not DMA */
537 pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev);
538
539 /* PCI Express link has been reset */
540 pci_ers_result_t (*link_reset)(struct pci_dev *dev);
541
542 /* PCI slot has been reset */
543 pci_ers_result_t (*slot_reset)(struct pci_dev *dev);
544
545 /* Device driver may resume normal operations */
546 void (*resume)(struct pci_dev *dev);
547 };
548
549 /* ---------------------------------------------------------------- */
550
551 struct module;
552 struct pci_driver {
553 struct list_head node;
554 const char *name;
555 const struct pci_device_id *id_table; /* must be non-NULL for probe to be called */
556 int (*probe) (struct pci_dev *dev, const struct pci_device_id *id); /* New device inserted */
557 void (*remove) (struct pci_dev *dev); /* Device removed (NULL if not a hot-plug capable driver) */
558 int (*suspend) (struct pci_dev *dev, pm_message_t state); /* Device suspended */
559 int (*suspend_late) (struct pci_dev *dev, pm_message_t state);
560 int (*resume_early) (struct pci_dev *dev);
561 int (*resume) (struct pci_dev *dev); /* Device woken up */
562 void (*shutdown) (struct pci_dev *dev);
563 struct pci_error_handlers *err_handler;
564 struct device_driver driver;
565 struct pci_dynids dynids;
566 };
567
568 #define to_pci_driver(drv) container_of(drv, struct pci_driver, driver)
569
570 /**
571 * DEFINE_PCI_DEVICE_TABLE - macro used to describe a pci device table
572 * @_table: device table name
573 *
574 * This macro is used to create a struct pci_device_id array (a device table)
575 * in a generic manner.
576 */
577 #define DEFINE_PCI_DEVICE_TABLE(_table) \
578 const struct pci_device_id _table[] __devinitconst
579
580 /**
581 * PCI_DEVICE - macro used to describe a specific pci device
582 * @vend: the 16 bit PCI Vendor ID
583 * @dev: the 16 bit PCI Device ID
584 *
585 * This macro is used to create a struct pci_device_id that matches a
586 * specific device. The subvendor and subdevice fields will be set to
587 * PCI_ANY_ID.
588 */
589 #define PCI_DEVICE(vend,dev) \
590 .vendor = (vend), .device = (dev), \
591 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
592
593 /**
594 * PCI_DEVICE_CLASS - macro used to describe a specific pci device class
595 * @dev_class: the class, subclass, prog-if triple for this device
596 * @dev_class_mask: the class mask for this device
597 *
598 * This macro is used to create a struct pci_device_id that matches a
599 * specific PCI class. The vendor, device, subvendor, and subdevice
600 * fields will be set to PCI_ANY_ID.
601 */
602 #define PCI_DEVICE_CLASS(dev_class,dev_class_mask) \
603 .class = (dev_class), .class_mask = (dev_class_mask), \
604 .vendor = PCI_ANY_ID, .device = PCI_ANY_ID, \
605 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
606
607 /**
608 * PCI_VDEVICE - macro used to describe a specific pci device in short form
609 * @vendor: the vendor name
610 * @device: the 16 bit PCI Device ID
611 *
612 * This macro is used to create a struct pci_device_id that matches a
613 * specific PCI device. The subvendor, and subdevice fields will be set
614 * to PCI_ANY_ID. The macro allows the next field to follow as the device
615 * private data.
616 */
617
618 #define PCI_VDEVICE(vendor, device) \
619 PCI_VENDOR_ID_##vendor, (device), \
620 PCI_ANY_ID, PCI_ANY_ID, 0, 0
621
622 /* these external functions are only available when PCI support is enabled */
623 #ifdef CONFIG_PCI
624
625 extern void pcie_bus_configure_settings(struct pci_bus *bus, u8 smpss);
626
627 enum pcie_bus_config_types {
628 PCIE_BUS_TUNE_OFF,
629 PCIE_BUS_SAFE,
630 PCIE_BUS_PERFORMANCE,
631 PCIE_BUS_PEER2PEER,
632 };
633
634 extern enum pcie_bus_config_types pcie_bus_config;
635
636 extern struct bus_type pci_bus_type;
637
638 /* Do NOT directly access these two variables, unless you are arch specific pci
639 * code, or pci core code. */
640 extern struct list_head pci_root_buses; /* list of all known PCI buses */
641 /* Some device drivers need know if pci is initiated */
642 extern int no_pci_devices(void);
643
644 void pcibios_fixup_bus(struct pci_bus *);
645 int __must_check pcibios_enable_device(struct pci_dev *, int mask);
646 char *pcibios_setup(char *str);
647
648 /* Used only when drivers/pci/setup.c is used */
649 resource_size_t pcibios_align_resource(void *, const struct resource *,
650 resource_size_t,
651 resource_size_t);
652 void pcibios_update_irq(struct pci_dev *, int irq);
653
654 /* Weak but can be overriden by arch */
655 void pci_fixup_cardbus(struct pci_bus *);
656
657 /* Generic PCI functions used internally */
658
659 void pcibios_scan_specific_bus(int busn);
660 extern struct pci_bus *pci_find_bus(int domain, int busnr);
661 void pci_bus_add_devices(const struct pci_bus *bus);
662 struct pci_bus *pci_scan_bus_parented(struct device *parent, int bus,
663 struct pci_ops *ops, void *sysdata);
664 static inline struct pci_bus * __devinit pci_scan_bus(int bus, struct pci_ops *ops,
665 void *sysdata)
666 {
667 struct pci_bus *root_bus;
668 root_bus = pci_scan_bus_parented(NULL, bus, ops, sysdata);
669 if (root_bus)
670 pci_bus_add_devices(root_bus);
671 return root_bus;
672 }
673 struct pci_bus *pci_create_bus(struct device *parent, int bus,
674 struct pci_ops *ops, void *sysdata);
675 struct pci_bus *pci_add_new_bus(struct pci_bus *parent, struct pci_dev *dev,
676 int busnr);
677 void pcie_update_link_speed(struct pci_bus *bus, u16 link_status);
678 struct pci_slot *pci_create_slot(struct pci_bus *parent, int slot_nr,
679 const char *name,
680 struct hotplug_slot *hotplug);
681 void pci_destroy_slot(struct pci_slot *slot);
682 void pci_renumber_slot(struct pci_slot *slot, int slot_nr);
683 int pci_scan_slot(struct pci_bus *bus, int devfn);
684 struct pci_dev *pci_scan_single_device(struct pci_bus *bus, int devfn);
685 void pci_device_add(struct pci_dev *dev, struct pci_bus *bus);
686 unsigned int pci_scan_child_bus(struct pci_bus *bus);
687 int __must_check pci_bus_add_device(struct pci_dev *dev);
688 void pci_read_bridge_bases(struct pci_bus *child);
689 struct resource *pci_find_parent_resource(const struct pci_dev *dev,
690 struct resource *res);
691 u8 pci_swizzle_interrupt_pin(struct pci_dev *dev, u8 pin);
692 int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge);
693 u8 pci_common_swizzle(struct pci_dev *dev, u8 *pinp);
694 extern struct pci_dev *pci_dev_get(struct pci_dev *dev);
695 extern void pci_dev_put(struct pci_dev *dev);
696 extern void pci_remove_bus(struct pci_bus *b);
697 extern void pci_remove_bus_device(struct pci_dev *dev);
698 extern void pci_stop_bus_device(struct pci_dev *dev);
699 void pci_setup_cardbus(struct pci_bus *bus);
700 extern void pci_sort_breadthfirst(void);
701 #define dev_is_pci(d) ((d)->bus == &pci_bus_type)
702 #define dev_is_pf(d) ((dev_is_pci(d) ? to_pci_dev(d)->is_physfn : false))
703 #define dev_num_vf(d) ((dev_is_pci(d) ? pci_num_vf(to_pci_dev(d)) : 0))
704
705 /* Generic PCI functions exported to card drivers */
706
707 enum pci_lost_interrupt_reason {
708 PCI_LOST_IRQ_NO_INFORMATION = 0,
709 PCI_LOST_IRQ_DISABLE_MSI,
710 PCI_LOST_IRQ_DISABLE_MSIX,
711 PCI_LOST_IRQ_DISABLE_ACPI,
712 };
713 enum pci_lost_interrupt_reason pci_lost_interrupt(struct pci_dev *dev);
714 int pci_find_capability(struct pci_dev *dev, int cap);
715 int pci_find_next_capability(struct pci_dev *dev, u8 pos, int cap);
716 int pci_find_ext_capability(struct pci_dev *dev, int cap);
717 int pci_bus_find_ext_capability(struct pci_bus *bus, unsigned int devfn,
718 int cap);
719 int pci_find_ht_capability(struct pci_dev *dev, int ht_cap);
720 int pci_find_next_ht_capability(struct pci_dev *dev, int pos, int ht_cap);
721 struct pci_bus *pci_find_next_bus(const struct pci_bus *from);
722
723 struct pci_dev *pci_get_device(unsigned int vendor, unsigned int device,
724 struct pci_dev *from);
725 struct pci_dev *pci_get_subsys(unsigned int vendor, unsigned int device,
726 unsigned int ss_vendor, unsigned int ss_device,
727 struct pci_dev *from);
728 struct pci_dev *pci_get_slot(struct pci_bus *bus, unsigned int devfn);
729 struct pci_dev *pci_get_domain_bus_and_slot(int domain, unsigned int bus,
730 unsigned int devfn);
731 static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
732 unsigned int devfn)
733 {
734 return pci_get_domain_bus_and_slot(0, bus, devfn);
735 }
736 struct pci_dev *pci_get_class(unsigned int class, struct pci_dev *from);
737 int pci_dev_present(const struct pci_device_id *ids);
738
739 int pci_bus_read_config_byte(struct pci_bus *bus, unsigned int devfn,
740 int where, u8 *val);
741 int pci_bus_read_config_word(struct pci_bus *bus, unsigned int devfn,
742 int where, u16 *val);
743 int pci_bus_read_config_dword(struct pci_bus *bus, unsigned int devfn,
744 int where, u32 *val);
745 int pci_bus_write_config_byte(struct pci_bus *bus, unsigned int devfn,
746 int where, u8 val);
747 int pci_bus_write_config_word(struct pci_bus *bus, unsigned int devfn,
748 int where, u16 val);
749 int pci_bus_write_config_dword(struct pci_bus *bus, unsigned int devfn,
750 int where, u32 val);
751 struct pci_ops *pci_bus_set_ops(struct pci_bus *bus, struct pci_ops *ops);
752
753 static inline int pci_read_config_byte(struct pci_dev *dev, int where, u8 *val)
754 {
755 return pci_bus_read_config_byte(dev->bus, dev->devfn, where, val);
756 }
757 static inline int pci_read_config_word(struct pci_dev *dev, int where, u16 *val)
758 {
759 return pci_bus_read_config_word(dev->bus, dev->devfn, where, val);
760 }
761 static inline int pci_read_config_dword(struct pci_dev *dev, int where,
762 u32 *val)
763 {
764 return pci_bus_read_config_dword(dev->bus, dev->devfn, where, val);
765 }
766 static inline int pci_write_config_byte(struct pci_dev *dev, int where, u8 val)
767 {
768 return pci_bus_write_config_byte(dev->bus, dev->devfn, where, val);
769 }
770 static inline int pci_write_config_word(struct pci_dev *dev, int where, u16 val)
771 {
772 return pci_bus_write_config_word(dev->bus, dev->devfn, where, val);
773 }
774 static inline int pci_write_config_dword(struct pci_dev *dev, int where,
775 u32 val)
776 {
777 return pci_bus_write_config_dword(dev->bus, dev->devfn, where, val);
778 }
779
780 int __must_check pci_enable_device(struct pci_dev *dev);
781 int __must_check pci_enable_device_io(struct pci_dev *dev);
782 int __must_check pci_enable_device_mem(struct pci_dev *dev);
783 int __must_check pci_reenable_device(struct pci_dev *);
784 int __must_check pcim_enable_device(struct pci_dev *pdev);
785 void pcim_pin_device(struct pci_dev *pdev);
786
787 static inline int pci_is_enabled(struct pci_dev *pdev)
788 {
789 return (atomic_read(&pdev->enable_cnt) > 0);
790 }
791
792 static inline int pci_is_managed(struct pci_dev *pdev)
793 {
794 return pdev->is_managed;
795 }
796
797 void pci_disable_device(struct pci_dev *dev);
798 void pci_set_master(struct pci_dev *dev);
799 void pci_clear_master(struct pci_dev *dev);
800 int pci_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state);
801 int pci_set_cacheline_size(struct pci_dev *dev);
802 #define HAVE_PCI_SET_MWI
803 int __must_check pci_set_mwi(struct pci_dev *dev);
804 int pci_try_set_mwi(struct pci_dev *dev);
805 void pci_clear_mwi(struct pci_dev *dev);
806 void pci_intx(struct pci_dev *dev, int enable);
807 bool pci_intx_mask_supported(struct pci_dev *dev);
808 bool pci_check_and_mask_intx(struct pci_dev *dev);
809 bool pci_check_and_unmask_intx(struct pci_dev *dev);
810 void pci_msi_off(struct pci_dev *dev);
811 int pci_set_dma_max_seg_size(struct pci_dev *dev, unsigned int size);
812 int pci_set_dma_seg_boundary(struct pci_dev *dev, unsigned long mask);
813 int pcix_get_max_mmrbc(struct pci_dev *dev);
814 int pcix_get_mmrbc(struct pci_dev *dev);
815 int pcix_set_mmrbc(struct pci_dev *dev, int mmrbc);
816 int pcie_get_readrq(struct pci_dev *dev);
817 int pcie_set_readrq(struct pci_dev *dev, int rq);
818 int pcie_get_mps(struct pci_dev *dev);
819 int pcie_set_mps(struct pci_dev *dev, int mps);
820 int __pci_reset_function(struct pci_dev *dev);
821 int pci_reset_function(struct pci_dev *dev);
822 void pci_update_resource(struct pci_dev *dev, int resno);
823 int __must_check pci_assign_resource(struct pci_dev *dev, int i);
824 int __must_check pci_reassign_resource(struct pci_dev *dev, int i, resource_size_t add_size, resource_size_t align);
825 int pci_select_bars(struct pci_dev *dev, unsigned long flags);
826
827 /* ROM control related routines */
828 int pci_enable_rom(struct pci_dev *pdev);
829 void pci_disable_rom(struct pci_dev *pdev);
830 void __iomem __must_check *pci_map_rom(struct pci_dev *pdev, size_t *size);
831 void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom);
832 size_t pci_get_rom_size(struct pci_dev *pdev, void __iomem *rom, size_t size);
833
834 /* Power management related routines */
835 int pci_save_state(struct pci_dev *dev);
836 void pci_restore_state(struct pci_dev *dev);
837 struct pci_saved_state *pci_store_saved_state(struct pci_dev *dev);
838 int pci_load_saved_state(struct pci_dev *dev, struct pci_saved_state *state);
839 int pci_load_and_free_saved_state(struct pci_dev *dev,
840 struct pci_saved_state **state);
841 int __pci_complete_power_transition(struct pci_dev *dev, pci_power_t state);
842 int pci_set_power_state(struct pci_dev *dev, pci_power_t state);
843 pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state);
844 bool pci_pme_capable(struct pci_dev *dev, pci_power_t state);
845 void pci_pme_active(struct pci_dev *dev, bool enable);
846 int __pci_enable_wake(struct pci_dev *dev, pci_power_t state,
847 bool runtime, bool enable);
848 int pci_wake_from_d3(struct pci_dev *dev, bool enable);
849 pci_power_t pci_target_state(struct pci_dev *dev);
850 int pci_prepare_to_sleep(struct pci_dev *dev);
851 int pci_back_from_sleep(struct pci_dev *dev);
852 bool pci_dev_run_wake(struct pci_dev *dev);
853 bool pci_check_pme_status(struct pci_dev *dev);
854 void pci_pme_wakeup_bus(struct pci_bus *bus);
855
856 static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
857 bool enable)
858 {
859 return __pci_enable_wake(dev, state, false, enable);
860 }
861
862 #define PCI_EXP_IDO_REQUEST (1<<0)
863 #define PCI_EXP_IDO_COMPLETION (1<<1)
864 void pci_enable_ido(struct pci_dev *dev, unsigned long type);
865 void pci_disable_ido(struct pci_dev *dev, unsigned long type);
866
867 enum pci_obff_signal_type {
868 PCI_EXP_OBFF_SIGNAL_L0 = 0,
869 PCI_EXP_OBFF_SIGNAL_ALWAYS = 1,
870 };
871 int pci_enable_obff(struct pci_dev *dev, enum pci_obff_signal_type);
872 void pci_disable_obff(struct pci_dev *dev);
873
874 bool pci_ltr_supported(struct pci_dev *dev);
875 int pci_enable_ltr(struct pci_dev *dev);
876 void pci_disable_ltr(struct pci_dev *dev);
877 int pci_set_ltr(struct pci_dev *dev, int snoop_lat_ns, int nosnoop_lat_ns);
878
879 /* For use by arch with custom probe code */
880 void set_pcie_port_type(struct pci_dev *pdev);
881 void set_pcie_hotplug_bridge(struct pci_dev *pdev);
882
883 /* Functions for PCI Hotplug drivers to use */
884 int pci_bus_find_capability(struct pci_bus *bus, unsigned int devfn, int cap);
885 #ifdef CONFIG_HOTPLUG
886 unsigned int pci_rescan_bus(struct pci_bus *bus);
887 #endif
888
889 /* Vital product data routines */
890 ssize_t pci_read_vpd(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
891 ssize_t pci_write_vpd(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
892 int pci_vpd_truncate(struct pci_dev *dev, size_t size);
893
894 /* Helper functions for low-level code (drivers/pci/setup-[bus,res].c) */
895 void pci_bus_assign_resources(const struct pci_bus *bus);
896 void pci_bus_size_bridges(struct pci_bus *bus);
897 int pci_claim_resource(struct pci_dev *, int);
898 void pci_assign_unassigned_resources(void);
899 void pci_assign_unassigned_bridge_resources(struct pci_dev *bridge);
900 void pdev_enable_device(struct pci_dev *);
901 void pdev_sort_resources(struct pci_dev *, struct resource_list *);
902 int pci_enable_resources(struct pci_dev *, int mask);
903 void pci_fixup_irqs(u8 (*)(struct pci_dev *, u8 *),
904 int (*)(const struct pci_dev *, u8, u8));
905 #define HAVE_PCI_REQ_REGIONS 2
906 int __must_check pci_request_regions(struct pci_dev *, const char *);
907 int __must_check pci_request_regions_exclusive(struct pci_dev *, const char *);
908 void pci_release_regions(struct pci_dev *);
909 int __must_check pci_request_region(struct pci_dev *, int, const char *);
910 int __must_check pci_request_region_exclusive(struct pci_dev *, int, const char *);
911 void pci_release_region(struct pci_dev *, int);
912 int pci_request_selected_regions(struct pci_dev *, int, const char *);
913 int pci_request_selected_regions_exclusive(struct pci_dev *, int, const char *);
914 void pci_release_selected_regions(struct pci_dev *, int);
915
916 /* drivers/pci/bus.c */
917 void pci_bus_add_resource(struct pci_bus *bus, struct resource *res, unsigned int flags);
918 struct resource *pci_bus_resource_n(const struct pci_bus *bus, int n);
919 void pci_bus_remove_resources(struct pci_bus *bus);
920
921 #define pci_bus_for_each_resource(bus, res, i) \
922 for (i = 0; \
923 (res = pci_bus_resource_n(bus, i)) || i < PCI_BRIDGE_RESOURCE_NUM; \
924 i++)
925
926 int __must_check pci_bus_alloc_resource(struct pci_bus *bus,
927 struct resource *res, resource_size_t size,
928 resource_size_t align, resource_size_t min,
929 unsigned int type_mask,
930 resource_size_t (*alignf)(void *,
931 const struct resource *,
932 resource_size_t,
933 resource_size_t),
934 void *alignf_data);
935 void pci_enable_bridges(struct pci_bus *bus);
936
937 /* Proper probing supporting hot-pluggable devices */
938 int __must_check __pci_register_driver(struct pci_driver *, struct module *,
939 const char *mod_name);
940
941 /*
942 * pci_register_driver must be a macro so that KBUILD_MODNAME can be expanded
943 */
944 #define pci_register_driver(driver) \
945 __pci_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
946
947 void pci_unregister_driver(struct pci_driver *dev);
948 void pci_remove_behind_bridge(struct pci_dev *dev);
949 struct pci_driver *pci_dev_driver(const struct pci_dev *dev);
950 int pci_add_dynid(struct pci_driver *drv,
951 unsigned int vendor, unsigned int device,
952 unsigned int subvendor, unsigned int subdevice,
953 unsigned int class, unsigned int class_mask,
954 unsigned long driver_data);
955 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
956 struct pci_dev *dev);
957 int pci_scan_bridge(struct pci_bus *bus, struct pci_dev *dev, int max,
958 int pass);
959
960 void pci_walk_bus(struct pci_bus *top, int (*cb)(struct pci_dev *, void *),
961 void *userdata);
962 int pci_cfg_space_size_ext(struct pci_dev *dev);
963 int pci_cfg_space_size(struct pci_dev *dev);
964 unsigned char pci_bus_max_busnr(struct pci_bus *bus);
965 void pci_setup_bridge(struct pci_bus *bus);
966
967 #define PCI_VGA_STATE_CHANGE_BRIDGE (1 << 0)
968 #define PCI_VGA_STATE_CHANGE_DECODES (1 << 1)
969
970 int pci_set_vga_state(struct pci_dev *pdev, bool decode,
971 unsigned int command_bits, u32 flags);
972 /* kmem_cache style wrapper around pci_alloc_consistent() */
973
974 #include <linux/pci-dma.h>
975 #include <linux/dmapool.h>
976
977 #define pci_pool dma_pool
978 #define pci_pool_create(name, pdev, size, align, allocation) \
979 dma_pool_create(name, &pdev->dev, size, align, allocation)
980 #define pci_pool_destroy(pool) dma_pool_destroy(pool)
981 #define pci_pool_alloc(pool, flags, handle) dma_pool_alloc(pool, flags, handle)
982 #define pci_pool_free(pool, vaddr, addr) dma_pool_free(pool, vaddr, addr)
983
984 enum pci_dma_burst_strategy {
985 PCI_DMA_BURST_INFINITY, /* make bursts as large as possible,
986 strategy_parameter is N/A */
987 PCI_DMA_BURST_BOUNDARY, /* disconnect at every strategy_parameter
988 byte boundaries */
989 PCI_DMA_BURST_MULTIPLE, /* disconnect at some multiple of
990 strategy_parameter byte boundaries */
991 };
992
993 struct msix_entry {
994 u32 vector; /* kernel uses to write allocated vector */
995 u16 entry; /* driver uses to specify entry, OS writes */
996 };
997
998
999 #ifndef CONFIG_PCI_MSI
1000 static inline int pci_enable_msi_block(struct pci_dev *dev, unsigned int nvec)
1001 {
1002 return -1;
1003 }
1004
1005 static inline void pci_msi_shutdown(struct pci_dev *dev)
1006 { }
1007 static inline void pci_disable_msi(struct pci_dev *dev)
1008 { }
1009
1010 static inline int pci_msix_table_size(struct pci_dev *dev)
1011 {
1012 return 0;
1013 }
1014 static inline int pci_enable_msix(struct pci_dev *dev,
1015 struct msix_entry *entries, int nvec)
1016 {
1017 return -1;
1018 }
1019
1020 static inline void pci_msix_shutdown(struct pci_dev *dev)
1021 { }
1022 static inline void pci_disable_msix(struct pci_dev *dev)
1023 { }
1024
1025 static inline void msi_remove_pci_irq_vectors(struct pci_dev *dev)
1026 { }
1027
1028 static inline void pci_restore_msi_state(struct pci_dev *dev)
1029 { }
1030 static inline int pci_msi_enabled(void)
1031 {
1032 return 0;
1033 }
1034 #else
1035 extern int pci_enable_msi_block(struct pci_dev *dev, unsigned int nvec);
1036 extern void pci_msi_shutdown(struct pci_dev *dev);
1037 extern void pci_disable_msi(struct pci_dev *dev);
1038 extern int pci_msix_table_size(struct pci_dev *dev);
1039 extern int pci_enable_msix(struct pci_dev *dev,
1040 struct msix_entry *entries, int nvec);
1041 extern void pci_msix_shutdown(struct pci_dev *dev);
1042 extern void pci_disable_msix(struct pci_dev *dev);
1043 extern void msi_remove_pci_irq_vectors(struct pci_dev *dev);
1044 extern void pci_restore_msi_state(struct pci_dev *dev);
1045 extern int pci_msi_enabled(void);
1046 #endif
1047
1048 #ifdef CONFIG_PCIEPORTBUS
1049 extern bool pcie_ports_disabled;
1050 extern bool pcie_ports_auto;
1051 #else
1052 #define pcie_ports_disabled true
1053 #define pcie_ports_auto false
1054 #endif
1055
1056 #ifndef CONFIG_PCIEASPM
1057 static inline int pcie_aspm_enabled(void) { return 0; }
1058 static inline bool pcie_aspm_support_enabled(void) { return false; }
1059 #else
1060 extern int pcie_aspm_enabled(void);
1061 extern bool pcie_aspm_support_enabled(void);
1062 #endif
1063
1064 #ifdef CONFIG_PCIEAER
1065 void pci_no_aer(void);
1066 bool pci_aer_available(void);
1067 #else
1068 static inline void pci_no_aer(void) { }
1069 static inline bool pci_aer_available(void) { return false; }
1070 #endif
1071
1072 #ifndef CONFIG_PCIE_ECRC
1073 static inline void pcie_set_ecrc_checking(struct pci_dev *dev)
1074 {
1075 return;
1076 }
1077 static inline void pcie_ecrc_get_policy(char *str) {};
1078 #else
1079 extern void pcie_set_ecrc_checking(struct pci_dev *dev);
1080 extern void pcie_ecrc_get_policy(char *str);
1081 #endif
1082
1083 #define pci_enable_msi(pdev) pci_enable_msi_block(pdev, 1)
1084
1085 #ifdef CONFIG_HT_IRQ
1086 /* The functions a driver should call */
1087 int ht_create_irq(struct pci_dev *dev, int idx);
1088 void ht_destroy_irq(unsigned int irq);
1089 #endif /* CONFIG_HT_IRQ */
1090
1091 extern void pci_cfg_access_lock(struct pci_dev *dev);
1092 extern bool pci_cfg_access_trylock(struct pci_dev *dev);
1093 extern void pci_cfg_access_unlock(struct pci_dev *dev);
1094
1095 /*
1096 * PCI domain support. Sometimes called PCI segment (eg by ACPI),
1097 * a PCI domain is defined to be a set of PCI busses which share
1098 * configuration space.
1099 */
1100 #ifdef CONFIG_PCI_DOMAINS
1101 extern int pci_domains_supported;
1102 #else
1103 enum { pci_domains_supported = 0 };
1104 static inline int pci_domain_nr(struct pci_bus *bus)
1105 {
1106 return 0;
1107 }
1108
1109 static inline int pci_proc_domain(struct pci_bus *bus)
1110 {
1111 return 0;
1112 }
1113 #endif /* CONFIG_PCI_DOMAINS */
1114
1115 /* some architectures require additional setup to direct VGA traffic */
1116 typedef int (*arch_set_vga_state_t)(struct pci_dev *pdev, bool decode,
1117 unsigned int command_bits, u32 flags);
1118 extern void pci_register_set_vga_state(arch_set_vga_state_t func);
1119
1120 #else /* CONFIG_PCI is not enabled */
1121
1122 /*
1123 * If the system does not have PCI, clearly these return errors. Define
1124 * these as simple inline functions to avoid hair in drivers.
1125 */
1126
1127 #define _PCI_NOP(o, s, t) \
1128 static inline int pci_##o##_config_##s(struct pci_dev *dev, \
1129 int where, t val) \
1130 { return PCIBIOS_FUNC_NOT_SUPPORTED; }
1131
1132 #define _PCI_NOP_ALL(o, x) _PCI_NOP(o, byte, u8 x) \
1133 _PCI_NOP(o, word, u16 x) \
1134 _PCI_NOP(o, dword, u32 x)
1135 _PCI_NOP_ALL(read, *)
1136 _PCI_NOP_ALL(write,)
1137
1138 static inline struct pci_dev *pci_get_device(unsigned int vendor,
1139 unsigned int device,
1140 struct pci_dev *from)
1141 {
1142 return NULL;
1143 }
1144
1145 static inline struct pci_dev *pci_get_subsys(unsigned int vendor,
1146 unsigned int device,
1147 unsigned int ss_vendor,
1148 unsigned int ss_device,
1149 struct pci_dev *from)
1150 {
1151 return NULL;
1152 }
1153
1154 static inline struct pci_dev *pci_get_class(unsigned int class,
1155 struct pci_dev *from)
1156 {
1157 return NULL;
1158 }
1159
1160 #define pci_dev_present(ids) (0)
1161 #define no_pci_devices() (1)
1162 #define pci_dev_put(dev) do { } while (0)
1163
1164 static inline void pci_set_master(struct pci_dev *dev)
1165 { }
1166
1167 static inline int pci_enable_device(struct pci_dev *dev)
1168 {
1169 return -EIO;
1170 }
1171
1172 static inline void pci_disable_device(struct pci_dev *dev)
1173 { }
1174
1175 static inline int pci_set_dma_mask(struct pci_dev *dev, u64 mask)
1176 {
1177 return -EIO;
1178 }
1179
1180 static inline int pci_set_consistent_dma_mask(struct pci_dev *dev, u64 mask)
1181 {
1182 return -EIO;
1183 }
1184
1185 static inline int pci_set_dma_max_seg_size(struct pci_dev *dev,
1186 unsigned int size)
1187 {
1188 return -EIO;
1189 }
1190
1191 static inline int pci_set_dma_seg_boundary(struct pci_dev *dev,
1192 unsigned long mask)
1193 {
1194 return -EIO;
1195 }
1196
1197 static inline int pci_assign_resource(struct pci_dev *dev, int i)
1198 {
1199 return -EBUSY;
1200 }
1201
1202 static inline int __pci_register_driver(struct pci_driver *drv,
1203 struct module *owner)
1204 {
1205 return 0;
1206 }
1207
1208 static inline int pci_register_driver(struct pci_driver *drv)
1209 {
1210 return 0;
1211 }
1212
1213 static inline void pci_unregister_driver(struct pci_driver *drv)
1214 { }
1215
1216 static inline int pci_find_capability(struct pci_dev *dev, int cap)
1217 {
1218 return 0;
1219 }
1220
1221 static inline int pci_find_next_capability(struct pci_dev *dev, u8 post,
1222 int cap)
1223 {
1224 return 0;
1225 }
1226
1227 static inline int pci_find_ext_capability(struct pci_dev *dev, int cap)
1228 {
1229 return 0;
1230 }
1231
1232 /* Power management related routines */
1233 static inline int pci_save_state(struct pci_dev *dev)
1234 {
1235 return 0;
1236 }
1237
1238 static inline void pci_restore_state(struct pci_dev *dev)
1239 { }
1240
1241 static inline int pci_set_power_state(struct pci_dev *dev, pci_power_t state)
1242 {
1243 return 0;
1244 }
1245
1246 static inline int pci_wake_from_d3(struct pci_dev *dev, bool enable)
1247 {
1248 return 0;
1249 }
1250
1251 static inline pci_power_t pci_choose_state(struct pci_dev *dev,
1252 pm_message_t state)
1253 {
1254 return PCI_D0;
1255 }
1256
1257 static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
1258 int enable)
1259 {
1260 return 0;
1261 }
1262
1263 static inline void pci_enable_ido(struct pci_dev *dev, unsigned long type)
1264 {
1265 }
1266
1267 static inline void pci_disable_ido(struct pci_dev *dev, unsigned long type)
1268 {
1269 }
1270
1271 static inline int pci_enable_obff(struct pci_dev *dev, unsigned long type)
1272 {
1273 return 0;
1274 }
1275
1276 static inline void pci_disable_obff(struct pci_dev *dev)
1277 {
1278 }
1279
1280 static inline int pci_request_regions(struct pci_dev *dev, const char *res_name)
1281 {
1282 return -EIO;
1283 }
1284
1285 static inline void pci_release_regions(struct pci_dev *dev)
1286 { }
1287
1288 #define pci_dma_burst_advice(pdev, strat, strategy_parameter) do { } while (0)
1289
1290 static inline void pci_block_cfg_access(struct pci_dev *dev)
1291 { }
1292
1293 static inline int pci_block_cfg_access_in_atomic(struct pci_dev *dev)
1294 { return 0; }
1295
1296 static inline void pci_unblock_cfg_access(struct pci_dev *dev)
1297 { }
1298
1299 static inline struct pci_bus *pci_find_next_bus(const struct pci_bus *from)
1300 { return NULL; }
1301
1302 static inline struct pci_dev *pci_get_slot(struct pci_bus *bus,
1303 unsigned int devfn)
1304 { return NULL; }
1305
1306 static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
1307 unsigned int devfn)
1308 { return NULL; }
1309
1310 static inline int pci_domain_nr(struct pci_bus *bus)
1311 { return 0; }
1312
1313 #define dev_is_pci(d) (false)
1314 #define dev_is_pf(d) (false)
1315 #define dev_num_vf(d) (0)
1316 #endif /* CONFIG_PCI */
1317
1318 /* Include architecture-dependent settings and functions */
1319
1320 #include <asm/pci.h>
1321
1322 #ifndef PCIBIOS_MAX_MEM_32
1323 #define PCIBIOS_MAX_MEM_32 (-1)
1324 #endif
1325
1326 /* these helpers provide future and backwards compatibility
1327 * for accessing popular PCI BAR info */
1328 #define pci_resource_start(dev, bar) ((dev)->resource[(bar)].start)
1329 #define pci_resource_end(dev, bar) ((dev)->resource[(bar)].end)
1330 #define pci_resource_flags(dev, bar) ((dev)->resource[(bar)].flags)
1331 #define pci_resource_len(dev,bar) \
1332 ((pci_resource_start((dev), (bar)) == 0 && \
1333 pci_resource_end((dev), (bar)) == \
1334 pci_resource_start((dev), (bar))) ? 0 : \
1335 \
1336 (pci_resource_end((dev), (bar)) - \
1337 pci_resource_start((dev), (bar)) + 1))
1338
1339 /* Similar to the helpers above, these manipulate per-pci_dev
1340 * driver-specific data. They are really just a wrapper around
1341 * the generic device structure functions of these calls.
1342 */
1343 static inline void *pci_get_drvdata(struct pci_dev *pdev)
1344 {
1345 return dev_get_drvdata(&pdev->dev);
1346 }
1347
1348 static inline void pci_set_drvdata(struct pci_dev *pdev, void *data)
1349 {
1350 dev_set_drvdata(&pdev->dev, data);
1351 }
1352
1353 /* If you want to know what to call your pci_dev, ask this function.
1354 * Again, it's a wrapper around the generic device.
1355 */
1356 static inline const char *pci_name(const struct pci_dev *pdev)
1357 {
1358 return dev_name(&pdev->dev);
1359 }
1360
1361
1362 /* Some archs don't want to expose struct resource to userland as-is
1363 * in sysfs and /proc
1364 */
1365 #ifndef HAVE_ARCH_PCI_RESOURCE_TO_USER
1366 static inline void pci_resource_to_user(const struct pci_dev *dev, int bar,
1367 const struct resource *rsrc, resource_size_t *start,
1368 resource_size_t *end)
1369 {
1370 *start = rsrc->start;
1371 *end = rsrc->end;
1372 }
1373 #endif /* HAVE_ARCH_PCI_RESOURCE_TO_USER */
1374
1375
1376 /*
1377 * The world is not perfect and supplies us with broken PCI devices.
1378 * For at least a part of these bugs we need a work-around, so both
1379 * generic (drivers/pci/quirks.c) and per-architecture code can define
1380 * fixup hooks to be called for particular buggy devices.
1381 */
1382
1383 struct pci_fixup {
1384 u16 vendor, device; /* You can use PCI_ANY_ID here of course */
1385 void (*hook)(struct pci_dev *dev);
1386 };
1387
1388 enum pci_fixup_pass {
1389 pci_fixup_early, /* Before probing BARs */
1390 pci_fixup_header, /* After reading configuration header */
1391 pci_fixup_final, /* Final phase of device fixups */
1392 pci_fixup_enable, /* pci_enable_device() time */
1393 pci_fixup_resume, /* pci_device_resume() */
1394 pci_fixup_suspend, /* pci_device_suspend */
1395 pci_fixup_resume_early, /* pci_device_resume_early() */
1396 };
1397
1398 /* Anonymous variables would be nice... */
1399 #define DECLARE_PCI_FIXUP_SECTION(section, name, vendor, device, hook) \
1400 static const struct pci_fixup __pci_fixup_##name __used \
1401 __attribute__((__section__(#section))) = { vendor, device, hook };
1402 #define DECLARE_PCI_FIXUP_EARLY(vendor, device, hook) \
1403 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early, \
1404 vendor##device##hook, vendor, device, hook)
1405 #define DECLARE_PCI_FIXUP_HEADER(vendor, device, hook) \
1406 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header, \
1407 vendor##device##hook, vendor, device, hook)
1408 #define DECLARE_PCI_FIXUP_FINAL(vendor, device, hook) \
1409 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final, \
1410 vendor##device##hook, vendor, device, hook)
1411 #define DECLARE_PCI_FIXUP_ENABLE(vendor, device, hook) \
1412 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable, \
1413 vendor##device##hook, vendor, device, hook)
1414 #define DECLARE_PCI_FIXUP_RESUME(vendor, device, hook) \
1415 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume, \
1416 resume##vendor##device##hook, vendor, device, hook)
1417 #define DECLARE_PCI_FIXUP_RESUME_EARLY(vendor, device, hook) \
1418 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early, \
1419 resume_early##vendor##device##hook, vendor, device, hook)
1420 #define DECLARE_PCI_FIXUP_SUSPEND(vendor, device, hook) \
1421 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend, \
1422 suspend##vendor##device##hook, vendor, device, hook)
1423
1424 #ifdef CONFIG_PCI_QUIRKS
1425 void pci_fixup_device(enum pci_fixup_pass pass, struct pci_dev *dev);
1426 #else
1427 static inline void pci_fixup_device(enum pci_fixup_pass pass,
1428 struct pci_dev *dev) {}
1429 #endif
1430
1431 void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen);
1432 void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr);
1433 void __iomem * const *pcim_iomap_table(struct pci_dev *pdev);
1434 int pcim_iomap_regions(struct pci_dev *pdev, u16 mask, const char *name);
1435 int pcim_iomap_regions_request_all(struct pci_dev *pdev, u16 mask,
1436 const char *name);
1437 void pcim_iounmap_regions(struct pci_dev *pdev, u16 mask);
1438
1439 extern int pci_pci_problems;
1440 #define PCIPCI_FAIL 1 /* No PCI PCI DMA */
1441 #define PCIPCI_TRITON 2
1442 #define PCIPCI_NATOMA 4
1443 #define PCIPCI_VIAETBF 8
1444 #define PCIPCI_VSFX 16
1445 #define PCIPCI_ALIMAGIK 32 /* Need low latency setting */
1446 #define PCIAGP_FAIL 64 /* No PCI to AGP DMA */
1447
1448 extern unsigned long pci_cardbus_io_size;
1449 extern unsigned long pci_cardbus_mem_size;
1450 extern u8 __devinitdata pci_dfl_cache_line_size;
1451 extern u8 pci_cache_line_size;
1452
1453 extern unsigned long pci_hotplug_io_size;
1454 extern unsigned long pci_hotplug_mem_size;
1455
1456 int pcibios_add_platform_entries(struct pci_dev *dev);
1457 void pcibios_disable_device(struct pci_dev *dev);
1458 int pcibios_set_pcie_reset_state(struct pci_dev *dev,
1459 enum pcie_reset_state state);
1460
1461 #ifdef CONFIG_PCI_MMCONFIG
1462 extern void __init pci_mmcfg_early_init(void);
1463 extern void __init pci_mmcfg_late_init(void);
1464 #else
1465 static inline void pci_mmcfg_early_init(void) { }
1466 static inline void pci_mmcfg_late_init(void) { }
1467 #endif
1468
1469 int pci_ext_cfg_avail(struct pci_dev *dev);
1470
1471 void __iomem *pci_ioremap_bar(struct pci_dev *pdev, int bar);
1472
1473 #ifdef CONFIG_PCI_IOV
1474 extern int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn);
1475 extern void pci_disable_sriov(struct pci_dev *dev);
1476 extern irqreturn_t pci_sriov_migration(struct pci_dev *dev);
1477 extern int pci_num_vf(struct pci_dev *dev);
1478 #else
1479 static inline int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn)
1480 {
1481 return -ENODEV;
1482 }
1483 static inline void pci_disable_sriov(struct pci_dev *dev)
1484 {
1485 }
1486 static inline irqreturn_t pci_sriov_migration(struct pci_dev *dev)
1487 {
1488 return IRQ_NONE;
1489 }
1490 static inline int pci_num_vf(struct pci_dev *dev)
1491 {
1492 return 0;
1493 }
1494 #endif
1495
1496 #if defined(CONFIG_HOTPLUG_PCI) || defined(CONFIG_HOTPLUG_PCI_MODULE)
1497 extern void pci_hp_create_module_link(struct pci_slot *pci_slot);
1498 extern void pci_hp_remove_module_link(struct pci_slot *pci_slot);
1499 #endif
1500
1501 /**
1502 * pci_pcie_cap - get the saved PCIe capability offset
1503 * @dev: PCI device
1504 *
1505 * PCIe capability offset is calculated at PCI device initialization
1506 * time and saved in the data structure. This function returns saved
1507 * PCIe capability offset. Using this instead of pci_find_capability()
1508 * reduces unnecessary search in the PCI configuration space. If you
1509 * need to calculate PCIe capability offset from raw device for some
1510 * reasons, please use pci_find_capability() instead.
1511 */
1512 static inline int pci_pcie_cap(struct pci_dev *dev)
1513 {
1514 return dev->pcie_cap;
1515 }
1516
1517 /**
1518 * pci_is_pcie - check if the PCI device is PCI Express capable
1519 * @dev: PCI device
1520 *
1521 * Retrun true if the PCI device is PCI Express capable, false otherwise.
1522 */
1523 static inline bool pci_is_pcie(struct pci_dev *dev)
1524 {
1525 return !!pci_pcie_cap(dev);
1526 }
1527
1528 void pci_request_acs(void);
1529
1530
1531 #define PCI_VPD_LRDT 0x80 /* Large Resource Data Type */
1532 #define PCI_VPD_LRDT_ID(x) (x | PCI_VPD_LRDT)
1533
1534 /* Large Resource Data Type Tag Item Names */
1535 #define PCI_VPD_LTIN_ID_STRING 0x02 /* Identifier String */
1536 #define PCI_VPD_LTIN_RO_DATA 0x10 /* Read-Only Data */
1537 #define PCI_VPD_LTIN_RW_DATA 0x11 /* Read-Write Data */
1538
1539 #define PCI_VPD_LRDT_ID_STRING PCI_VPD_LRDT_ID(PCI_VPD_LTIN_ID_STRING)
1540 #define PCI_VPD_LRDT_RO_DATA PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RO_DATA)
1541 #define PCI_VPD_LRDT_RW_DATA PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RW_DATA)
1542
1543 /* Small Resource Data Type Tag Item Names */
1544 #define PCI_VPD_STIN_END 0x78 /* End */
1545
1546 #define PCI_VPD_SRDT_END PCI_VPD_STIN_END
1547
1548 #define PCI_VPD_SRDT_TIN_MASK 0x78
1549 #define PCI_VPD_SRDT_LEN_MASK 0x07
1550
1551 #define PCI_VPD_LRDT_TAG_SIZE 3
1552 #define PCI_VPD_SRDT_TAG_SIZE 1
1553
1554 #define PCI_VPD_INFO_FLD_HDR_SIZE 3
1555
1556 #define PCI_VPD_RO_KEYWORD_PARTNO "PN"
1557 #define PCI_VPD_RO_KEYWORD_MFR_ID "MN"
1558 #define PCI_VPD_RO_KEYWORD_VENDOR0 "V0"
1559 #define PCI_VPD_RO_KEYWORD_CHKSUM "RV"
1560
1561 /**
1562 * pci_vpd_lrdt_size - Extracts the Large Resource Data Type length
1563 * @lrdt: Pointer to the beginning of the Large Resource Data Type tag
1564 *
1565 * Returns the extracted Large Resource Data Type length.
1566 */
1567 static inline u16 pci_vpd_lrdt_size(const u8 *lrdt)
1568 {
1569 return (u16)lrdt[1] + ((u16)lrdt[2] << 8);
1570 }
1571
1572 /**
1573 * pci_vpd_srdt_size - Extracts the Small Resource Data Type length
1574 * @lrdt: Pointer to the beginning of the Small Resource Data Type tag
1575 *
1576 * Returns the extracted Small Resource Data Type length.
1577 */
1578 static inline u8 pci_vpd_srdt_size(const u8 *srdt)
1579 {
1580 return (*srdt) & PCI_VPD_SRDT_LEN_MASK;
1581 }
1582
1583 /**
1584 * pci_vpd_info_field_size - Extracts the information field length
1585 * @lrdt: Pointer to the beginning of an information field header
1586 *
1587 * Returns the extracted information field length.
1588 */
1589 static inline u8 pci_vpd_info_field_size(const u8 *info_field)
1590 {
1591 return info_field[2];
1592 }
1593
1594 /**
1595 * pci_vpd_find_tag - Locates the Resource Data Type tag provided
1596 * @buf: Pointer to buffered vpd data
1597 * @off: The offset into the buffer at which to begin the search
1598 * @len: The length of the vpd buffer
1599 * @rdt: The Resource Data Type to search for
1600 *
1601 * Returns the index where the Resource Data Type was found or
1602 * -ENOENT otherwise.
1603 */
1604 int pci_vpd_find_tag(const u8 *buf, unsigned int off, unsigned int len, u8 rdt);
1605
1606 /**
1607 * pci_vpd_find_info_keyword - Locates an information field keyword in the VPD
1608 * @buf: Pointer to buffered vpd data
1609 * @off: The offset into the buffer at which to begin the search
1610 * @len: The length of the buffer area, relative to off, in which to search
1611 * @kw: The keyword to search for
1612 *
1613 * Returns the index where the information field keyword was found or
1614 * -ENOENT otherwise.
1615 */
1616 int pci_vpd_find_info_keyword(const u8 *buf, unsigned int off,
1617 unsigned int len, const char *kw);
1618
1619 /* PCI <-> OF binding helpers */
1620 #ifdef CONFIG_OF
1621 struct device_node;
1622 extern void pci_set_of_node(struct pci_dev *dev);
1623 extern void pci_release_of_node(struct pci_dev *dev);
1624 extern void pci_set_bus_of_node(struct pci_bus *bus);
1625 extern void pci_release_bus_of_node(struct pci_bus *bus);
1626
1627 /* Arch may override this (weak) */
1628 extern struct device_node * __weak pcibios_get_phb_of_node(struct pci_bus *bus);
1629
1630 static inline struct device_node *pci_device_to_OF_node(struct pci_dev *pdev)
1631 {
1632 return pdev ? pdev->dev.of_node : NULL;
1633 }
1634
1635 static inline struct device_node *pci_bus_to_OF_node(struct pci_bus *bus)
1636 {
1637 return bus ? bus->dev.of_node : NULL;
1638 }
1639
1640 #else /* CONFIG_OF */
1641 static inline void pci_set_of_node(struct pci_dev *dev) { }
1642 static inline void pci_release_of_node(struct pci_dev *dev) { }
1643 static inline void pci_set_bus_of_node(struct pci_bus *bus) { }
1644 static inline void pci_release_bus_of_node(struct pci_bus *bus) { }
1645 #endif /* CONFIG_OF */
1646
1647 /**
1648 * pci_find_upstream_pcie_bridge - find upstream PCIe-to-PCI bridge of a device
1649 * @pdev: the PCI device
1650 *
1651 * if the device is PCIE, return NULL
1652 * if the device isn't connected to a PCIe bridge (that is its parent is a
1653 * legacy PCI bridge and the bridge is directly connected to bus 0), return its
1654 * parent
1655 */
1656 struct pci_dev *pci_find_upstream_pcie_bridge(struct pci_dev *pdev);
1657
1658 #endif /* __KERNEL__ */
1659 #endif /* LINUX_PCI_H */
Ubuntu Focal Linux kernel mirror