PCI: move enum pcie_link_width into pci.h
[deliverable/linux.git] / include / linux / pci.h
CommitLineData
1da177e4
LT
1/*
2 * pci.h
3 *
4 * PCI defines and function prototypes
5 * Copyright 1994, Drew Eckhardt
6 * Copyright 1997--1999 Martin Mares <mj@ucw.cz>
7 *
8 * For more information, please consult the following manuals (look at
9 * http://www.pcisig.com/ for how to get them):
10 *
11 * PCI BIOS Specification
12 * PCI Local Bus Specification
13 * PCI to PCI Bridge Specification
14 * PCI System Design Guide
15 */
1da177e4
LT
16#ifndef LINUX_PCI_H
17#define LINUX_PCI_H
18
1da177e4 19
778382e0
DW
20#include <linux/mod_devicetable.h>
21
1da177e4 22#include <linux/types.h>
98db6f19 23#include <linux/init.h>
1da177e4
LT
24#include <linux/ioport.h>
25#include <linux/list.h>
4a7fb636 26#include <linux/compiler.h>
1da177e4 27#include <linux/errno.h>
f46753c5 28#include <linux/kobject.h>
60063497 29#include <linux/atomic.h>
1da177e4 30#include <linux/device.h>
1388cc96 31#include <linux/io.h>
74bb1bcc 32#include <linux/irqreturn.h>
607ca46e 33#include <uapi/linux/pci.h>
1da177e4 34
7e7a43c3
AB
35/* Include the ID list */
36#include <linux/pci_ids.h>
37
85467136
SK
38/*
39 * The PCI interface treats multi-function devices as independent
40 * devices. The slot/function address of each device is encoded
41 * in a single byte as follows:
42 *
43 * 7:3 = slot
44 * 2:0 = function
45 * PCI_DEVFN(), PCI_SLOT(), and PCI_FUNC() are defined uapi/linux/pci.h
46 * In the interest of not exposing interfaces to user-space unnecessarily,
47 * the following kernel only defines are being added here.
48 */
49#define PCI_DEVID(bus, devfn) ((((u16)bus) << 8) | devfn)
50/* return bus from PCI devid = ((u16)bus_number) << 8) | devfn */
51#define PCI_BUS_NUM(x) (((x) >> 8) & 0xff)
52
f46753c5
AC
53/* pci_slot represents a physical slot */
54struct pci_slot {
55 struct pci_bus *bus; /* The bus this slot is on */
56 struct list_head list; /* node in list of slots on this bus */
57 struct hotplug_slot *hotplug; /* Hotplug info (migrate over time) */
58 unsigned char number; /* PCI_SLOT(pci_dev->devfn) */
59 struct kobject kobj;
60};
61
0ad772ec
AC
62static inline const char *pci_slot_name(const struct pci_slot *slot)
63{
64 return kobject_name(&slot->kobj);
65}
66
1da177e4
LT
67/* File state for mmap()s on /proc/bus/pci/X/Y */
68enum pci_mmap_state {
69 pci_mmap_io,
70 pci_mmap_mem
71};
72
73/* This defines the direction arg to the DMA mapping routines. */
74#define PCI_DMA_BIDIRECTIONAL 0
75#define PCI_DMA_TODEVICE 1
76#define PCI_DMA_FROMDEVICE 2
77#define PCI_DMA_NONE 3
78
fde09c6d
YZ
79/*
80 * For PCI devices, the region numbers are assigned this way:
81 */
82enum {
83 /* #0-5: standard PCI resources */
84 PCI_STD_RESOURCES,
85 PCI_STD_RESOURCE_END = 5,
86
87 /* #6: expansion ROM resource */
88 PCI_ROM_RESOURCE,
89
d1b054da
YZ
90 /* device specific resources */
91#ifdef CONFIG_PCI_IOV
92 PCI_IOV_RESOURCES,
93 PCI_IOV_RESOURCE_END = PCI_IOV_RESOURCES + PCI_SRIOV_NUM_BARS - 1,
94#endif
95
fde09c6d
YZ
96 /* resources assigned to buses behind the bridge */
97#define PCI_BRIDGE_RESOURCE_NUM 4
98
99 PCI_BRIDGE_RESOURCES,
100 PCI_BRIDGE_RESOURCE_END = PCI_BRIDGE_RESOURCES +
101 PCI_BRIDGE_RESOURCE_NUM - 1,
102
103 /* total resources associated with a PCI device */
104 PCI_NUM_RESOURCES,
105
106 /* preserve this for compatibility */
cda57bf9 107 DEVICE_COUNT_RESOURCE = PCI_NUM_RESOURCES,
fde09c6d 108};
1da177e4
LT
109
110typedef int __bitwise pci_power_t;
111
4352dfd5
GKH
112#define PCI_D0 ((pci_power_t __force) 0)
113#define PCI_D1 ((pci_power_t __force) 1)
114#define PCI_D2 ((pci_power_t __force) 2)
1da177e4
LT
115#define PCI_D3hot ((pci_power_t __force) 3)
116#define PCI_D3cold ((pci_power_t __force) 4)
3fe9d19f 117#define PCI_UNKNOWN ((pci_power_t __force) 5)
438510f6 118#define PCI_POWER_ERROR ((pci_power_t __force) -1)
1da177e4 119
00240c38
AS
120/* Remember to update this when the list above changes! */
121extern const char *pci_power_names[];
122
123static inline const char *pci_power_name(pci_power_t state)
124{
125 return pci_power_names[1 + (int) state];
126}
127
448bd857
HY
128#define PCI_PM_D2_DELAY 200
129#define PCI_PM_D3_WAIT 10
130#define PCI_PM_D3COLD_WAIT 100
131#define PCI_PM_BUS_WAIT 50
aa8c6c93 132
392a1ce7 133/** The pci_channel state describes connectivity between the CPU and
134 * the pci device. If some PCI bus between here and the pci device
135 * has crashed or locked up, this info is reflected here.
136 */
137typedef unsigned int __bitwise pci_channel_state_t;
138
139enum pci_channel_state {
140 /* I/O channel is in normal state */
141 pci_channel_io_normal = (__force pci_channel_state_t) 1,
142
143 /* I/O to channel is blocked */
144 pci_channel_io_frozen = (__force pci_channel_state_t) 2,
145
146 /* PCI card is dead */
147 pci_channel_io_perm_failure = (__force pci_channel_state_t) 3,
148};
149
f7bdd12d
BK
150typedef unsigned int __bitwise pcie_reset_state_t;
151
152enum pcie_reset_state {
153 /* Reset is NOT asserted (Use to deassert reset) */
154 pcie_deassert_reset = (__force pcie_reset_state_t) 1,
155
156 /* Use #PERST to reset PCI-E device */
157 pcie_warm_reset = (__force pcie_reset_state_t) 2,
158
159 /* Use PCI-E Hot Reset to reset device */
160 pcie_hot_reset = (__force pcie_reset_state_t) 3
161};
162
ba698ad4
DM
163typedef unsigned short __bitwise pci_dev_flags_t;
164enum pci_dev_flags {
165 /* INTX_DISABLE in PCI_COMMAND register disables MSI
166 * generation too.
167 */
168 PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG = (__force pci_dev_flags_t) 1,
979b1791
AC
169 /* Device configuration is irrevocably lost if disabled into D3 */
170 PCI_DEV_FLAGS_NO_D3 = (__force pci_dev_flags_t) 2,
6777829c
GR
171 /* Provide indication device is assigned by a Virtual Machine Manager */
172 PCI_DEV_FLAGS_ASSIGNED = (__force pci_dev_flags_t) 4,
ba698ad4
DM
173};
174
e1d3a908
SA
175enum pci_irq_reroute_variant {
176 INTEL_IRQ_REROUTE_VARIANT = 1,
177 MAX_IRQ_REROUTE_VARIANTS = 3
178};
179
6e325a62
MT
180typedef unsigned short __bitwise pci_bus_flags_t;
181enum pci_bus_flags {
d556ad4b
PO
182 PCI_BUS_FLAGS_NO_MSI = (__force pci_bus_flags_t) 1,
183 PCI_BUS_FLAGS_NO_MMRBC = (__force pci_bus_flags_t) 2,
6e325a62
MT
184};
185
59da381e
JK
186/* These values come from the PCI Express Spec */
187enum pcie_link_width {
188 PCIE_LNK_WIDTH_RESRV = 0x00,
189 PCIE_LNK_X1 = 0x01,
190 PCIE_LNK_X2 = 0x02,
191 PCIE_LNK_X4 = 0x04,
192 PCIE_LNK_X8 = 0x08,
193 PCIE_LNK_X12 = 0x0C,
194 PCIE_LNK_X16 = 0x10,
195 PCIE_LNK_X32 = 0x20,
196 PCIE_LNK_WIDTH_UNKNOWN = 0xFF,
197};
198
536c8cb4
MW
199/* Based on the PCI Hotplug Spec, but some values are made up by us */
200enum pci_bus_speed {
201 PCI_SPEED_33MHz = 0x00,
202 PCI_SPEED_66MHz = 0x01,
203 PCI_SPEED_66MHz_PCIX = 0x02,
204 PCI_SPEED_100MHz_PCIX = 0x03,
205 PCI_SPEED_133MHz_PCIX = 0x04,
206 PCI_SPEED_66MHz_PCIX_ECC = 0x05,
207 PCI_SPEED_100MHz_PCIX_ECC = 0x06,
208 PCI_SPEED_133MHz_PCIX_ECC = 0x07,
209 PCI_SPEED_66MHz_PCIX_266 = 0x09,
210 PCI_SPEED_100MHz_PCIX_266 = 0x0a,
211 PCI_SPEED_133MHz_PCIX_266 = 0x0b,
45b4cdd5
MW
212 AGP_UNKNOWN = 0x0c,
213 AGP_1X = 0x0d,
214 AGP_2X = 0x0e,
215 AGP_4X = 0x0f,
216 AGP_8X = 0x10,
536c8cb4
MW
217 PCI_SPEED_66MHz_PCIX_533 = 0x11,
218 PCI_SPEED_100MHz_PCIX_533 = 0x12,
219 PCI_SPEED_133MHz_PCIX_533 = 0x13,
220 PCIE_SPEED_2_5GT = 0x14,
221 PCIE_SPEED_5_0GT = 0x15,
9dfd97fe 222 PCIE_SPEED_8_0GT = 0x16,
536c8cb4
MW
223 PCI_SPEED_UNKNOWN = 0xff,
224};
225
24a4742f 226struct pci_cap_saved_data {
41017f0c 227 char cap_nr;
24a4742f 228 unsigned int size;
41017f0c
SL
229 u32 data[0];
230};
231
24a4742f
AW
232struct pci_cap_saved_state {
233 struct hlist_node next;
234 struct pci_cap_saved_data cap;
235};
236
7d715a6c 237struct pcie_link_state;
ee69439c 238struct pci_vpd;
d1b054da 239struct pci_sriov;
302b4215 240struct pci_ats;
ee69439c 241
1da177e4
LT
242/*
243 * The pci_dev structure is used to describe PCI devices.
244 */
245struct pci_dev {
1da177e4
LT
246 struct list_head bus_list; /* node in per-bus list */
247 struct pci_bus *bus; /* bus this device is on */
248 struct pci_bus *subordinate; /* bus this device bridges to */
249
250 void *sysdata; /* hook for sys-specific extension */
251 struct proc_dir_entry *procent; /* device entry in /proc/bus/pci */
f46753c5 252 struct pci_slot *slot; /* Physical slot this device is in */
1da177e4
LT
253
254 unsigned int devfn; /* encoded device & function index */
255 unsigned short vendor;
256 unsigned short device;
257 unsigned short subsystem_vendor;
258 unsigned short subsystem_device;
259 unsigned int class; /* 3 bytes: (base,sub,prog-if) */
b8a3a521 260 u8 revision; /* PCI revision, low byte of class word */
1da177e4 261 u8 hdr_type; /* PCI header type (`multi' flag masked out) */
0efea000 262 u8 pcie_cap; /* PCI-E capability offset */
e375b561
GS
263 u8 msi_cap; /* MSI capability offset */
264 u8 msix_cap; /* MSI-X capability offset */
b03e7495 265 u8 pcie_mpss:3; /* PCI-E Max Payload Size Supported */
1da177e4 266 u8 rom_base_reg; /* which config register controls the ROM */
ffeff788 267 u8 pin; /* which interrupt pin this device uses */
786e2288 268 u16 pcie_flags_reg; /* cached PCI-E Capabilities Register */
1da177e4
LT
269
270 struct pci_driver *driver; /* which driver has allocated this device */
271 u64 dma_mask; /* Mask of the bits of bus address this
272 device implements. Normally this is
273 0xffffffff. You only need to change
274 this if your device has broken DMA
275 or supports 64-bit transfers. */
276
4d57cdfa
FT
277 struct device_dma_parameters dma_parms;
278
1da177e4
LT
279 pci_power_t current_state; /* Current operating state. In ACPI-speak,
280 this is D0-D3, D0 being fully functional,
281 and D3 being off. */
703860ed 282 u8 pm_cap; /* PM capability offset */
337001b6
RW
283 unsigned int pme_support:5; /* Bitmask of states from which PME#
284 can be generated */
c7f48656 285 unsigned int pme_interrupt:1;
379021d5 286 unsigned int pme_poll:1; /* Poll device's PME status bit */
337001b6
RW
287 unsigned int d1_support:1; /* Low power state D1 is supported */
288 unsigned int d2_support:1; /* Low power state D2 is supported */
448bd857
HY
289 unsigned int no_d1d2:1; /* D1 and D2 are forbidden */
290 unsigned int no_d3cold:1; /* D3cold is forbidden */
291 unsigned int d3cold_allowed:1; /* D3cold is allowed by user */
253d2e54
JP
292 unsigned int mmio_always_on:1; /* disallow turning off io/mem
293 decoding during bar sizing */
e80bb09d 294 unsigned int wakeup_prepared:1;
448bd857
HY
295 unsigned int runtime_d3cold:1; /* whether go through runtime
296 D3cold, not set for devices
297 powered on/off by the
298 corresponding bridge */
1ae861e6 299 unsigned int d3_delay; /* D3->D0 transition time in ms */
448bd857 300 unsigned int d3cold_delay; /* D3cold->D0 transition time in ms */
1da177e4 301
7d715a6c
SL
302#ifdef CONFIG_PCIEASPM
303 struct pcie_link_state *link_state; /* ASPM link state. */
304#endif
305
392a1ce7 306 pci_channel_state_t error_state; /* current connectivity state */
1da177e4
LT
307 struct device dev; /* Generic device interface */
308
1da177e4
LT
309 int cfg_size; /* Size of configuration space */
310
311 /*
312 * Instead of touching interrupt line and base address registers
313 * directly, use the values stored here. They might be different!
314 */
315 unsigned int irq;
316 struct resource resource[DEVICE_COUNT_RESOURCE]; /* I/O and memory regions + expansion ROMs */
317
58d9a38f 318 bool match_driver; /* Skip attaching driver */
1da177e4
LT
319 /* These fields are used by common fixups */
320 unsigned int transparent:1; /* Transparent PCI bridge */
321 unsigned int multifunction:1;/* Part of multi-function device */
322 /* keep track of device state */
8a1bc901 323 unsigned int is_added:1;
1da177e4 324 unsigned int is_busmaster:1; /* device is busmaster */
4602b88d 325 unsigned int no_msi:1; /* device may not use msi */
fb51ccbf 326 unsigned int block_cfg_access:1; /* config space access is blocked */
bd8481e1 327 unsigned int broken_parity_status:1; /* Device generates false positive parity */
e1d3a908 328 unsigned int irq_reroute_variant:2; /* device needs IRQ rerouting variant */
99dc804d
SL
329 unsigned int msi_enabled:1;
330 unsigned int msix_enabled:1;
58c3a727 331 unsigned int ari_enabled:1; /* ARI forwarding */
9ac7849e 332 unsigned int is_managed:1;
6d3be84a
KK
333 unsigned int is_pcie:1; /* Obsolete. Will be removed.
334 Use pci_is_pcie() instead */
260d703a 335 unsigned int needs_freset:1; /* Dev requires fundamental reset */
aa8c6c93 336 unsigned int state_saved:1;
d1b054da 337 unsigned int is_physfn:1;
dd7cc44d 338 unsigned int is_virtfn:1;
711d5779 339 unsigned int reset_fn:1;
28760489 340 unsigned int is_hotplug_bridge:1;
affb72c3
HY
341 unsigned int __aer_firmware_first_valid:1;
342 unsigned int __aer_firmware_first:1;
fbebb9fd 343 unsigned int broken_intx_masking:1;
2b28ae19 344 unsigned int io_window_1k:1; /* Intel P2P bridge 1K I/O windows */
ba698ad4 345 pci_dev_flags_t dev_flags;
bae94d02 346 atomic_t enable_cnt; /* pci_enable_device has been called */
4602b88d 347
1da177e4 348 u32 saved_config_space[16]; /* config space saved at suspend time */
41017f0c 349 struct hlist_head saved_cap_space;
1da177e4
LT
350 struct bin_attribute *rom_attr; /* attribute descriptor for sysfs ROM entry */
351 int rom_attr_enabled; /* has display of the rom attribute been enabled? */
352 struct bin_attribute *res_attr[DEVICE_COUNT_RESOURCE]; /* sysfs file for resources */
45aec1ae 353 struct bin_attribute *res_attr_wc[DEVICE_COUNT_RESOURCE]; /* sysfs file for WC mapping of resources */
ded86d8d 354#ifdef CONFIG_PCI_MSI
4aa9bc95 355 struct list_head msi_list;
da8d1c8b 356 struct kset *msi_kset;
ded86d8d 357#endif
94e61088 358 struct pci_vpd *vpd;
466b3ddf 359#ifdef CONFIG_PCI_ATS
dd7cc44d
YZ
360 union {
361 struct pci_sriov *sriov; /* SR-IOV capability related */
362 struct pci_dev *physfn; /* the PF this VF is associated with */
363 };
302b4215 364 struct pci_ats *ats; /* Address Translation Service */
d1b054da 365#endif
dbd3fc33 366 phys_addr_t rom; /* Physical address of ROM if it's not from the BAR */
84c1b80e 367 size_t romlen; /* Length of ROM if it's not from the BAR */
1da177e4
LT
368};
369
dda56549
Y
370static inline struct pci_dev *pci_physfn(struct pci_dev *dev)
371{
372#ifdef CONFIG_PCI_IOV
373 if (dev->is_virtfn)
374 dev = dev->physfn;
375#endif
376
377 return dev;
378}
379
3c6e6ae7
GZ
380struct pci_dev *pci_alloc_dev(struct pci_bus *bus);
381struct pci_dev * __deprecated alloc_pci_dev(void);
65891215 382
1da177e4
LT
383#define to_pci_dev(n) container_of(n, struct pci_dev, dev)
384#define for_each_pci_dev(d) while ((d = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, d)) != NULL)
385
a7369f1f
LV
386static inline int pci_channel_offline(struct pci_dev *pdev)
387{
388 return (pdev->error_state != pci_channel_io_normal);
389}
390
67cdc827
YL
391extern struct resource busn_resource;
392
0efd5aab
BH
393struct pci_host_bridge_window {
394 struct list_head list;
395 struct resource *res; /* host bridge aperture (CPU address) */
396 resource_size_t offset; /* bus address + offset = CPU address */
397};
41017f0c 398
5a21d70d 399struct pci_host_bridge {
7b543663 400 struct device dev;
5a21d70d 401 struct pci_bus *bus; /* root bus */
0efd5aab 402 struct list_head windows; /* pci_host_bridge_windows */
4fa2649a
YL
403 void (*release_fn)(struct pci_host_bridge *);
404 void *release_data;
5a21d70d 405};
41017f0c 406
7b543663 407#define to_pci_host_bridge(n) container_of(n, struct pci_host_bridge, dev)
4fa2649a
YL
408void pci_set_host_bridge_release(struct pci_host_bridge *bridge,
409 void (*release_fn)(struct pci_host_bridge *),
410 void *release_data);
7b543663 411
6c0cc950
RW
412int pcibios_root_bridge_prepare(struct pci_host_bridge *bridge);
413
2fe2abf8
BH
414/*
415 * The first PCI_BRIDGE_RESOURCE_NUM PCI bus resources (those that correspond
416 * to P2P or CardBus bridge windows) go in a table. Additional ones (for
417 * buses below host bridges or subtractive decode bridges) go in the list.
418 * Use pci_bus_for_each_resource() to iterate through all the resources.
419 */
420
421/*
422 * PCI_SUBTRACTIVE_DECODE means the bridge forwards the window implicitly
423 * and there's no way to program the bridge with the details of the window.
424 * This does not apply to ACPI _CRS windows, even with the _DEC subtractive-
425 * decode bit set, because they are explicit and can be programmed with _SRS.
426 */
427#define PCI_SUBTRACTIVE_DECODE 0x1
428
429struct pci_bus_resource {
430 struct list_head list;
431 struct resource *res;
432 unsigned int flags;
433};
4352dfd5
GKH
434
435#define PCI_REGION_FLAG_MASK 0x0fU /* These bits of resource flags tell us the PCI region flags */
1da177e4
LT
436
437struct pci_bus {
438 struct list_head node; /* node in list of buses */
439 struct pci_bus *parent; /* parent bus this bridge is on */
440 struct list_head children; /* list of child buses */
441 struct list_head devices; /* list of devices on this bus */
442 struct pci_dev *self; /* bridge device as seen by parent */
f46753c5 443 struct list_head slots; /* list of slots on this bus */
2fe2abf8
BH
444 struct resource *resource[PCI_BRIDGE_RESOURCE_NUM];
445 struct list_head resources; /* address space routed to this bus */
92f02430 446 struct resource busn_res; /* bus numbers routed to this bus */
1da177e4
LT
447
448 struct pci_ops *ops; /* configuration access functions */
449 void *sysdata; /* hook for sys-specific extension */
450 struct proc_dir_entry *procdir; /* directory entry in /proc/bus/pci */
451
452 unsigned char number; /* bus number */
453 unsigned char primary; /* number of primary bridge */
3749c51a
MW
454 unsigned char max_bus_speed; /* enum pci_bus_speed */
455 unsigned char cur_bus_speed; /* enum pci_bus_speed */
1da177e4
LT
456
457 char name[48];
458
459 unsigned short bridge_ctl; /* manage NO_ISA/FBB/et al behaviors */
6e325a62 460 pci_bus_flags_t bus_flags; /* Inherited by child busses */
1da177e4 461 struct device *bridge;
fd7d1ced 462 struct device dev;
1da177e4
LT
463 struct bin_attribute *legacy_io; /* legacy I/O for this bus */
464 struct bin_attribute *legacy_mem; /* legacy mem */
cc74d96f 465 unsigned int is_added:1;
1da177e4
LT
466};
467
468#define pci_bus_b(n) list_entry(n, struct pci_bus, node)
fd7d1ced 469#define to_pci_bus(n) container_of(n, struct pci_bus, dev)
1da177e4 470
79af72d7
KK
471/*
472 * Returns true if the pci bus is root (behind host-pci bridge),
473 * false otherwise
474 */
475static inline bool pci_is_root_bus(struct pci_bus *pbus)
476{
477 return !(pbus->parent);
478}
479
16cf0ebc
RW
480#ifdef CONFIG_PCI_MSI
481static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev)
482{
483 return pci_dev->msi_enabled || pci_dev->msix_enabled;
484}
485#else
486static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev) { return false; }
487#endif
488
1da177e4
LT
489/*
490 * Error values that may be returned by PCI functions.
491 */
492#define PCIBIOS_SUCCESSFUL 0x00
493#define PCIBIOS_FUNC_NOT_SUPPORTED 0x81
494#define PCIBIOS_BAD_VENDOR_ID 0x83
495#define PCIBIOS_DEVICE_NOT_FOUND 0x86
496#define PCIBIOS_BAD_REGISTER_NUMBER 0x87
497#define PCIBIOS_SET_FAILED 0x88
498#define PCIBIOS_BUFFER_TOO_SMALL 0x89
499
a6961651
AW
500/*
501 * Translate above to generic errno for passing back through non-pci.
502 */
503static inline int pcibios_err_to_errno(int err)
504{
505 if (err <= PCIBIOS_SUCCESSFUL)
506 return err; /* Assume already errno */
507
508 switch (err) {
509 case PCIBIOS_FUNC_NOT_SUPPORTED:
510 return -ENOENT;
511 case PCIBIOS_BAD_VENDOR_ID:
512 return -EINVAL;
513 case PCIBIOS_DEVICE_NOT_FOUND:
514 return -ENODEV;
515 case PCIBIOS_BAD_REGISTER_NUMBER:
516 return -EFAULT;
517 case PCIBIOS_SET_FAILED:
518 return -EIO;
519 case PCIBIOS_BUFFER_TOO_SMALL:
520 return -ENOSPC;
521 }
522
523 return -ENOTTY;
524}
525
1da177e4
LT
526/* Low-level architecture-dependent routines */
527
528struct pci_ops {
529 int (*read)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 *val);
530 int (*write)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 val);
531};
532
b6ce068a
MW
533/*
534 * ACPI needs to be able to access PCI config space before we've done a
535 * PCI bus scan and created pci_bus structures.
536 */
f39d5b72
BH
537int raw_pci_read(unsigned int domain, unsigned int bus, unsigned int devfn,
538 int reg, int len, u32 *val);
539int raw_pci_write(unsigned int domain, unsigned int bus, unsigned int devfn,
540 int reg, int len, u32 val);
1da177e4
LT
541
542struct pci_bus_region {
c40a22e0
BH
543 resource_size_t start;
544 resource_size_t end;
1da177e4
LT
545};
546
547struct pci_dynids {
548 spinlock_t lock; /* protects list, index */
549 struct list_head list; /* for IDs added at runtime */
1da177e4
LT
550};
551
392a1ce7 552/* ---------------------------------------------------------------- */
553/** PCI Error Recovery System (PCI-ERS). If a PCI device driver provides
579082df 554 * a set of callbacks in struct pci_error_handlers, then that device driver
392a1ce7 555 * will be notified of PCI bus errors, and will be driven to recovery
556 * when an error occurs.
557 */
558
559typedef unsigned int __bitwise pci_ers_result_t;
560
561enum pci_ers_result {
562 /* no result/none/not supported in device driver */
563 PCI_ERS_RESULT_NONE = (__force pci_ers_result_t) 1,
564
565 /* Device driver can recover without slot reset */
566 PCI_ERS_RESULT_CAN_RECOVER = (__force pci_ers_result_t) 2,
567
568 /* Device driver wants slot to be reset. */
569 PCI_ERS_RESULT_NEED_RESET = (__force pci_ers_result_t) 3,
570
571 /* Device has completely failed, is unrecoverable */
572 PCI_ERS_RESULT_DISCONNECT = (__force pci_ers_result_t) 4,
573
574 /* Device driver is fully recovered and operational */
575 PCI_ERS_RESULT_RECOVERED = (__force pci_ers_result_t) 5,
918b4053
VMP
576
577 /* No AER capabilities registered for the driver */
578 PCI_ERS_RESULT_NO_AER_DRIVER = (__force pci_ers_result_t) 6,
392a1ce7 579};
580
581/* PCI bus error event callbacks */
05cca6e5 582struct pci_error_handlers {
392a1ce7 583 /* PCI bus error detected on this device */
584 pci_ers_result_t (*error_detected)(struct pci_dev *dev,
05cca6e5 585 enum pci_channel_state error);
392a1ce7 586
587 /* MMIO has been re-enabled, but not DMA */
588 pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev);
589
590 /* PCI Express link has been reset */
591 pci_ers_result_t (*link_reset)(struct pci_dev *dev);
592
593 /* PCI slot has been reset */
594 pci_ers_result_t (*slot_reset)(struct pci_dev *dev);
595
596 /* Device driver may resume normal operations */
597 void (*resume)(struct pci_dev *dev);
598};
599
600/* ---------------------------------------------------------------- */
601
1da177e4
LT
602struct module;
603struct pci_driver {
604 struct list_head node;
42b21932 605 const char *name;
1da177e4
LT
606 const struct pci_device_id *id_table; /* must be non-NULL for probe to be called */
607 int (*probe) (struct pci_dev *dev, const struct pci_device_id *id); /* New device inserted */
608 void (*remove) (struct pci_dev *dev); /* Device removed (NULL if not a hot-plug capable driver) */
609 int (*suspend) (struct pci_dev *dev, pm_message_t state); /* Device suspended */
cbd69dbb
LT
610 int (*suspend_late) (struct pci_dev *dev, pm_message_t state);
611 int (*resume_early) (struct pci_dev *dev);
1da177e4 612 int (*resume) (struct pci_dev *dev); /* Device woken up */
c8958177 613 void (*shutdown) (struct pci_dev *dev);
1789382a 614 int (*sriov_configure) (struct pci_dev *dev, int num_vfs); /* PF pdev */
49453028 615 const struct pci_error_handlers *err_handler;
1da177e4
LT
616 struct device_driver driver;
617 struct pci_dynids dynids;
618};
619
05cca6e5 620#define to_pci_driver(drv) container_of(drv, struct pci_driver, driver)
1da177e4 621
90a1ba0c 622/**
9f9351bb 623 * DEFINE_PCI_DEVICE_TABLE - macro used to describe a pci device table
90a1ba0c
JB
624 * @_table: device table name
625 *
626 * This macro is used to create a struct pci_device_id array (a device table)
627 * in a generic manner.
628 */
9f9351bb 629#define DEFINE_PCI_DEVICE_TABLE(_table) \
15856ad5 630 const struct pci_device_id _table[]
90a1ba0c 631
1da177e4
LT
632/**
633 * PCI_DEVICE - macro used to describe a specific pci device
634 * @vend: the 16 bit PCI Vendor ID
635 * @dev: the 16 bit PCI Device ID
636 *
637 * This macro is used to create a struct pci_device_id that matches a
638 * specific device. The subvendor and subdevice fields will be set to
639 * PCI_ANY_ID.
640 */
641#define PCI_DEVICE(vend,dev) \
642 .vendor = (vend), .device = (dev), \
643 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
644
3d567e0e
NNS
645/**
646 * PCI_DEVICE_SUB - macro used to describe a specific pci device with subsystem
647 * @vend: the 16 bit PCI Vendor ID
648 * @dev: the 16 bit PCI Device ID
649 * @subvend: the 16 bit PCI Subvendor ID
650 * @subdev: the 16 bit PCI Subdevice ID
651 *
652 * This macro is used to create a struct pci_device_id that matches a
653 * specific device with subsystem information.
654 */
655#define PCI_DEVICE_SUB(vend, dev, subvend, subdev) \
656 .vendor = (vend), .device = (dev), \
657 .subvendor = (subvend), .subdevice = (subdev)
658
1da177e4
LT
659/**
660 * PCI_DEVICE_CLASS - macro used to describe a specific pci device class
661 * @dev_class: the class, subclass, prog-if triple for this device
662 * @dev_class_mask: the class mask for this device
663 *
664 * This macro is used to create a struct pci_device_id that matches a
4352dfd5 665 * specific PCI class. The vendor, device, subvendor, and subdevice
1da177e4
LT
666 * fields will be set to PCI_ANY_ID.
667 */
668#define PCI_DEVICE_CLASS(dev_class,dev_class_mask) \
669 .class = (dev_class), .class_mask = (dev_class_mask), \
670 .vendor = PCI_ANY_ID, .device = PCI_ANY_ID, \
671 .subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
672
1597cacb
AC
673/**
674 * PCI_VDEVICE - macro used to describe a specific pci device in short form
c322b28a
ZY
675 * @vendor: the vendor name
676 * @device: the 16 bit PCI Device ID
1597cacb
AC
677 *
678 * This macro is used to create a struct pci_device_id that matches a
679 * specific PCI device. The subvendor, and subdevice fields will be set
680 * to PCI_ANY_ID. The macro allows the next field to follow as the device
681 * private data.
682 */
683
684#define PCI_VDEVICE(vendor, device) \
685 PCI_VENDOR_ID_##vendor, (device), \
686 PCI_ANY_ID, PCI_ANY_ID, 0, 0
687
1da177e4
LT
688/* these external functions are only available when PCI support is enabled */
689#ifdef CONFIG_PCI
690
f39d5b72 691void pcie_bus_configure_settings(struct pci_bus *bus, u8 smpss);
b03e7495
JM
692
693enum pcie_bus_config_types {
5f39e670 694 PCIE_BUS_TUNE_OFF,
b03e7495 695 PCIE_BUS_SAFE,
5f39e670 696 PCIE_BUS_PERFORMANCE,
b03e7495
JM
697 PCIE_BUS_PEER2PEER,
698};
699
700extern enum pcie_bus_config_types pcie_bus_config;
701
1da177e4
LT
702extern struct bus_type pci_bus_type;
703
704/* Do NOT directly access these two variables, unless you are arch specific pci
705 * code, or pci core code. */
706extern struct list_head pci_root_buses; /* list of all known PCI buses */
ed4aaadb 707/* Some device drivers need know if pci is initiated */
f39d5b72 708int no_pci_devices(void);
1da177e4 709
3c449ed0 710void pcibios_resource_survey_bus(struct pci_bus *bus);
10a95747
JL
711void pcibios_add_bus(struct pci_bus *bus);
712void pcibios_remove_bus(struct pci_bus *bus);
1da177e4 713void pcibios_fixup_bus(struct pci_bus *);
4a7fb636 714int __must_check pcibios_enable_device(struct pci_dev *, int mask);
2b6f2c35 715/* Architecture specific versions may override this (weak) */
05cca6e5 716char *pcibios_setup(char *str);
1da177e4
LT
717
718/* Used only when drivers/pci/setup.c is used */
3b7a17fc 719resource_size_t pcibios_align_resource(void *, const struct resource *,
b26b2d49 720 resource_size_t,
e31dd6e4 721 resource_size_t);
1da177e4
LT
722void pcibios_update_irq(struct pci_dev *, int irq);
723
2d1c8618
BH
724/* Weak but can be overriden by arch */
725void pci_fixup_cardbus(struct pci_bus *);
726
1da177e4
LT
727/* Generic PCI functions used internally */
728
36a66cd6
BH
729void pcibios_resource_to_bus(struct pci_dev *dev, struct pci_bus_region *region,
730 struct resource *res);
731void pcibios_bus_to_resource(struct pci_dev *dev, struct resource *res,
732 struct pci_bus_region *region);
d1fd4fb6 733void pcibios_scan_specific_bus(int busn);
f39d5b72 734struct pci_bus *pci_find_bus(int domain, int busnr);
c48f1670 735void pci_bus_add_devices(const struct pci_bus *bus);
05cca6e5
GKH
736struct pci_bus *pci_scan_bus_parented(struct device *parent, int bus,
737 struct pci_ops *ops, void *sysdata);
de4b2f76 738struct pci_bus *pci_scan_bus(int bus, struct pci_ops *ops, void *sysdata);
166c6370
BH
739struct pci_bus *pci_create_root_bus(struct device *parent, int bus,
740 struct pci_ops *ops, void *sysdata,
741 struct list_head *resources);
98a35831
YL
742int pci_bus_insert_busn_res(struct pci_bus *b, int bus, int busmax);
743int pci_bus_update_busn_res_end(struct pci_bus *b, int busmax);
744void pci_bus_release_busn_res(struct pci_bus *b);
15856ad5 745struct pci_bus *pci_scan_root_bus(struct device *parent, int bus,
a2ebb827
BH
746 struct pci_ops *ops, void *sysdata,
747 struct list_head *resources);
05cca6e5
GKH
748struct pci_bus *pci_add_new_bus(struct pci_bus *parent, struct pci_dev *dev,
749 int busnr);
3749c51a 750void pcie_update_link_speed(struct pci_bus *bus, u16 link_status);
f46753c5 751struct pci_slot *pci_create_slot(struct pci_bus *parent, int slot_nr,
828f3768
AC
752 const char *name,
753 struct hotplug_slot *hotplug);
f46753c5 754void pci_destroy_slot(struct pci_slot *slot);
d25b7c8d 755void pci_renumber_slot(struct pci_slot *slot, int slot_nr);
1da177e4 756int pci_scan_slot(struct pci_bus *bus, int devfn);
05cca6e5 757struct pci_dev *pci_scan_single_device(struct pci_bus *bus, int devfn);
cdb9b9f7 758void pci_device_add(struct pci_dev *dev, struct pci_bus *bus);
1da177e4 759unsigned int pci_scan_child_bus(struct pci_bus *bus);
b19441af 760int __must_check pci_bus_add_device(struct pci_dev *dev);
1da177e4 761void pci_read_bridge_bases(struct pci_bus *child);
05cca6e5
GKH
762struct resource *pci_find_parent_resource(const struct pci_dev *dev,
763 struct resource *res);
3df425f3 764u8 pci_swizzle_interrupt_pin(const struct pci_dev *dev, u8 pin);
1da177e4 765int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge);
68feac87 766u8 pci_common_swizzle(struct pci_dev *dev, u8 *pinp);
f39d5b72
BH
767struct pci_dev *pci_dev_get(struct pci_dev *dev);
768void pci_dev_put(struct pci_dev *dev);
769void pci_remove_bus(struct pci_bus *b);
770void pci_stop_and_remove_bus_device(struct pci_dev *dev);
cdfcc572
YL
771void pci_stop_root_bus(struct pci_bus *bus);
772void pci_remove_root_bus(struct pci_bus *bus);
b3743fa4 773void pci_setup_cardbus(struct pci_bus *bus);
f39d5b72 774void pci_sort_breadthfirst(void);
fb8a0d9d
WM
775#define dev_is_pci(d) ((d)->bus == &pci_bus_type)
776#define dev_is_pf(d) ((dev_is_pci(d) ? to_pci_dev(d)->is_physfn : false))
777#define dev_num_vf(d) ((dev_is_pci(d) ? pci_num_vf(to_pci_dev(d)) : 0))
1da177e4
LT
778
779/* Generic PCI functions exported to card drivers */
780
388c8c16
JB
781enum pci_lost_interrupt_reason {
782 PCI_LOST_IRQ_NO_INFORMATION = 0,
783 PCI_LOST_IRQ_DISABLE_MSI,
784 PCI_LOST_IRQ_DISABLE_MSIX,
785 PCI_LOST_IRQ_DISABLE_ACPI,
786};
787enum pci_lost_interrupt_reason pci_lost_interrupt(struct pci_dev *dev);
05cca6e5
GKH
788int pci_find_capability(struct pci_dev *dev, int cap);
789int pci_find_next_capability(struct pci_dev *dev, u8 pos, int cap);
790int pci_find_ext_capability(struct pci_dev *dev, int cap);
44a9a36f 791int pci_find_next_ext_capability(struct pci_dev *dev, int pos, int cap);
05cca6e5
GKH
792int pci_find_ht_capability(struct pci_dev *dev, int ht_cap);
793int pci_find_next_ht_capability(struct pci_dev *dev, int pos, int ht_cap);
29f3eb64 794struct pci_bus *pci_find_next_bus(const struct pci_bus *from);
1da177e4 795
d42552c3
AM
796struct pci_dev *pci_get_device(unsigned int vendor, unsigned int device,
797 struct pci_dev *from);
05cca6e5 798struct pci_dev *pci_get_subsys(unsigned int vendor, unsigned int device,
1da177e4 799 unsigned int ss_vendor, unsigned int ss_device,
b08508c4 800 struct pci_dev *from);
05cca6e5 801struct pci_dev *pci_get_slot(struct pci_bus *bus, unsigned int devfn);
3c299dc2
AP
802struct pci_dev *pci_get_domain_bus_and_slot(int domain, unsigned int bus,
803 unsigned int devfn);
804static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
805 unsigned int devfn)
806{
807 return pci_get_domain_bus_and_slot(0, bus, devfn);
808}
05cca6e5 809struct pci_dev *pci_get_class(unsigned int class, struct pci_dev *from);
1da177e4
LT
810int pci_dev_present(const struct pci_device_id *ids);
811
05cca6e5
GKH
812int pci_bus_read_config_byte(struct pci_bus *bus, unsigned int devfn,
813 int where, u8 *val);
814int pci_bus_read_config_word(struct pci_bus *bus, unsigned int devfn,
815 int where, u16 *val);
816int pci_bus_read_config_dword(struct pci_bus *bus, unsigned int devfn,
817 int where, u32 *val);
818int pci_bus_write_config_byte(struct pci_bus *bus, unsigned int devfn,
819 int where, u8 val);
820int pci_bus_write_config_word(struct pci_bus *bus, unsigned int devfn,
821 int where, u16 val);
822int pci_bus_write_config_dword(struct pci_bus *bus, unsigned int devfn,
823 int where, u32 val);
a72b46c3 824struct pci_ops *pci_bus_set_ops(struct pci_bus *bus, struct pci_ops *ops);
1da177e4 825
bf362f75 826static inline int pci_read_config_byte(const struct pci_dev *dev, int where, u8 *val)
1da177e4 827{
05cca6e5 828 return pci_bus_read_config_byte(dev->bus, dev->devfn, where, val);
1da177e4 829}
bf362f75 830static inline int pci_read_config_word(const struct pci_dev *dev, int where, u16 *val)
1da177e4 831{
05cca6e5 832 return pci_bus_read_config_word(dev->bus, dev->devfn, where, val);
1da177e4 833}
bf362f75 834static inline int pci_read_config_dword(const struct pci_dev *dev, int where,
05cca6e5 835 u32 *val)
1da177e4 836{
05cca6e5 837 return pci_bus_read_config_dword(dev->bus, dev->devfn, where, val);
1da177e4 838}
bf362f75 839static inline int pci_write_config_byte(const struct pci_dev *dev, int where, u8 val)
1da177e4 840{
05cca6e5 841 return pci_bus_write_config_byte(dev->bus, dev->devfn, where, val);
1da177e4 842}
bf362f75 843static inline int pci_write_config_word(const struct pci_dev *dev, int where, u16 val)
1da177e4 844{
05cca6e5 845 return pci_bus_write_config_word(dev->bus, dev->devfn, where, val);
1da177e4 846}
bf362f75 847static inline int pci_write_config_dword(const struct pci_dev *dev, int where,
05cca6e5 848 u32 val)
1da177e4 849{
05cca6e5 850 return pci_bus_write_config_dword(dev->bus, dev->devfn, where, val);
1da177e4
LT
851}
852
8c0d3a02
JL
853int pcie_capability_read_word(struct pci_dev *dev, int pos, u16 *val);
854int pcie_capability_read_dword(struct pci_dev *dev, int pos, u32 *val);
855int pcie_capability_write_word(struct pci_dev *dev, int pos, u16 val);
856int pcie_capability_write_dword(struct pci_dev *dev, int pos, u32 val);
857int pcie_capability_clear_and_set_word(struct pci_dev *dev, int pos,
858 u16 clear, u16 set);
859int pcie_capability_clear_and_set_dword(struct pci_dev *dev, int pos,
860 u32 clear, u32 set);
861
862static inline int pcie_capability_set_word(struct pci_dev *dev, int pos,
863 u16 set)
864{
865 return pcie_capability_clear_and_set_word(dev, pos, 0, set);
866}
867
868static inline int pcie_capability_set_dword(struct pci_dev *dev, int pos,
869 u32 set)
870{
871 return pcie_capability_clear_and_set_dword(dev, pos, 0, set);
872}
873
874static inline int pcie_capability_clear_word(struct pci_dev *dev, int pos,
875 u16 clear)
876{
877 return pcie_capability_clear_and_set_word(dev, pos, clear, 0);
878}
879
880static inline int pcie_capability_clear_dword(struct pci_dev *dev, int pos,
881 u32 clear)
882{
883 return pcie_capability_clear_and_set_dword(dev, pos, clear, 0);
884}
885
c63587d7
AW
886/* user-space driven config access */
887int pci_user_read_config_byte(struct pci_dev *dev, int where, u8 *val);
888int pci_user_read_config_word(struct pci_dev *dev, int where, u16 *val);
889int pci_user_read_config_dword(struct pci_dev *dev, int where, u32 *val);
890int pci_user_write_config_byte(struct pci_dev *dev, int where, u8 val);
891int pci_user_write_config_word(struct pci_dev *dev, int where, u16 val);
892int pci_user_write_config_dword(struct pci_dev *dev, int where, u32 val);
893
4a7fb636 894int __must_check pci_enable_device(struct pci_dev *dev);
b718989d
BH
895int __must_check pci_enable_device_io(struct pci_dev *dev);
896int __must_check pci_enable_device_mem(struct pci_dev *dev);
0b62e13b 897int __must_check pci_reenable_device(struct pci_dev *);
9ac7849e
TH
898int __must_check pcim_enable_device(struct pci_dev *pdev);
899void pcim_pin_device(struct pci_dev *pdev);
900
296ccb08
YS
901static inline int pci_is_enabled(struct pci_dev *pdev)
902{
903 return (atomic_read(&pdev->enable_cnt) > 0);
904}
905
9ac7849e
TH
906static inline int pci_is_managed(struct pci_dev *pdev)
907{
908 return pdev->is_managed;
909}
910
1da177e4 911void pci_disable_device(struct pci_dev *dev);
96c55900
MS
912
913extern unsigned int pcibios_max_latency;
1da177e4 914void pci_set_master(struct pci_dev *dev);
6a479079 915void pci_clear_master(struct pci_dev *dev);
96c55900 916
f7bdd12d 917int pci_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state);
15ea76d4 918int pci_set_cacheline_size(struct pci_dev *dev);
1da177e4 919#define HAVE_PCI_SET_MWI
4a7fb636 920int __must_check pci_set_mwi(struct pci_dev *dev);
694625c0 921int pci_try_set_mwi(struct pci_dev *dev);
1da177e4 922void pci_clear_mwi(struct pci_dev *dev);
a04ce0ff 923void pci_intx(struct pci_dev *dev, int enable);
a2e27787
JK
924bool pci_intx_mask_supported(struct pci_dev *dev);
925bool pci_check_and_mask_intx(struct pci_dev *dev);
926bool pci_check_and_unmask_intx(struct pci_dev *dev);
f5f2b131 927void pci_msi_off(struct pci_dev *dev);
4d57cdfa 928int pci_set_dma_max_seg_size(struct pci_dev *dev, unsigned int size);
59fc67de 929int pci_set_dma_seg_boundary(struct pci_dev *dev, unsigned long mask);
d556ad4b
PO
930int pcix_get_max_mmrbc(struct pci_dev *dev);
931int pcix_get_mmrbc(struct pci_dev *dev);
932int pcix_set_mmrbc(struct pci_dev *dev, int mmrbc);
2637e5b5 933int pcie_get_readrq(struct pci_dev *dev);
d556ad4b 934int pcie_set_readrq(struct pci_dev *dev, int rq);
b03e7495
JM
935int pcie_get_mps(struct pci_dev *dev);
936int pcie_set_mps(struct pci_dev *dev, int mps);
8c1c699f 937int __pci_reset_function(struct pci_dev *dev);
a96d627a 938int __pci_reset_function_locked(struct pci_dev *dev);
8dd7f803 939int pci_reset_function(struct pci_dev *dev);
14add80b 940void pci_update_resource(struct pci_dev *dev, int resno);
4a7fb636 941int __must_check pci_assign_resource(struct pci_dev *dev, int i);
2bbc6942 942int __must_check pci_reassign_resource(struct pci_dev *dev, int i, resource_size_t add_size, resource_size_t align);
c87deff7 943int pci_select_bars(struct pci_dev *dev, unsigned long flags);
1da177e4
LT
944
945/* ROM control related routines */
e416de5e
AC
946int pci_enable_rom(struct pci_dev *pdev);
947void pci_disable_rom(struct pci_dev *pdev);
144a50ea 948void __iomem __must_check *pci_map_rom(struct pci_dev *pdev, size_t *size);
1da177e4 949void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom);
97c44836 950size_t pci_get_rom_size(struct pci_dev *pdev, void __iomem *rom, size_t size);
fffe01f7 951void __iomem __must_check *pci_platform_rom(struct pci_dev *pdev, size_t *size);
1da177e4
LT
952
953/* Power management related routines */
954int pci_save_state(struct pci_dev *dev);
1d3c16a8 955void pci_restore_state(struct pci_dev *dev);
ffbdd3f7
AW
956struct pci_saved_state *pci_store_saved_state(struct pci_dev *dev);
957int pci_load_saved_state(struct pci_dev *dev, struct pci_saved_state *state);
958int pci_load_and_free_saved_state(struct pci_dev *dev,
959 struct pci_saved_state **state);
0e5dd46b 960int __pci_complete_power_transition(struct pci_dev *dev, pci_power_t state);
9c8550ee
LT
961int pci_set_power_state(struct pci_dev *dev, pci_power_t state);
962pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state);
e5899e1b 963bool pci_pme_capable(struct pci_dev *dev, pci_power_t state);
5a6c9b60 964void pci_pme_active(struct pci_dev *dev, bool enable);
6cbf8214
RW
965int __pci_enable_wake(struct pci_dev *dev, pci_power_t state,
966 bool runtime, bool enable);
0235c4fc 967int pci_wake_from_d3(struct pci_dev *dev, bool enable);
e5899e1b 968pci_power_t pci_target_state(struct pci_dev *dev);
404cc2d8
RW
969int pci_prepare_to_sleep(struct pci_dev *dev);
970int pci_back_from_sleep(struct pci_dev *dev);
b67ea761 971bool pci_dev_run_wake(struct pci_dev *dev);
bf4d2908 972bool pci_check_pme_status(struct pci_dev *dev);
bf4d2908 973void pci_pme_wakeup_bus(struct pci_bus *bus);
1da177e4 974
6cbf8214
RW
975static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
976 bool enable)
977{
978 return __pci_enable_wake(dev, state, false, enable);
979}
1da177e4 980
b48d4425
JB
981#define PCI_EXP_IDO_REQUEST (1<<0)
982#define PCI_EXP_IDO_COMPLETION (1<<1)
983void pci_enable_ido(struct pci_dev *dev, unsigned long type);
984void pci_disable_ido(struct pci_dev *dev, unsigned long type);
985
48a92a81 986enum pci_obff_signal_type {
688398bb
MS
987 PCI_EXP_OBFF_SIGNAL_L0 = 0,
988 PCI_EXP_OBFF_SIGNAL_ALWAYS = 1,
48a92a81
JB
989};
990int pci_enable_obff(struct pci_dev *dev, enum pci_obff_signal_type);
991void pci_disable_obff(struct pci_dev *dev);
992
51c2e0a7
JB
993int pci_enable_ltr(struct pci_dev *dev);
994void pci_disable_ltr(struct pci_dev *dev);
995int pci_set_ltr(struct pci_dev *dev, int snoop_lat_ns, int nosnoop_lat_ns);
996
bb209c82
BH
997/* For use by arch with custom probe code */
998void set_pcie_port_type(struct pci_dev *pdev);
999void set_pcie_hotplug_bridge(struct pci_dev *pdev);
1000
ce5ccdef 1001/* Functions for PCI Hotplug drivers to use */
05cca6e5 1002int pci_bus_find_capability(struct pci_bus *bus, unsigned int devfn, int cap);
2f320521 1003unsigned int pci_rescan_bus_bridge_resize(struct pci_dev *bridge);
3ed4fd96 1004unsigned int pci_rescan_bus(struct pci_bus *bus);
ce5ccdef 1005
287d19ce
SH
1006/* Vital product data routines */
1007ssize_t pci_read_vpd(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
1008ssize_t pci_write_vpd(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
db567943 1009int pci_vpd_truncate(struct pci_dev *dev, size_t size);
287d19ce 1010
1da177e4 1011/* Helper functions for low-level code (drivers/pci/setup-[bus,res].c) */
925845bd 1012resource_size_t pcibios_retrieve_fw_addr(struct pci_dev *dev, int idx);
ea741551 1013void pci_bus_assign_resources(const struct pci_bus *bus);
1da177e4
LT
1014void pci_bus_size_bridges(struct pci_bus *bus);
1015int pci_claim_resource(struct pci_dev *, int);
1016void pci_assign_unassigned_resources(void);
6841ec68 1017void pci_assign_unassigned_bridge_resources(struct pci_dev *bridge);
17787940 1018void pci_assign_unassigned_bus_resources(struct pci_bus *bus);
1da177e4 1019void pdev_enable_device(struct pci_dev *);
842de40d 1020int pci_enable_resources(struct pci_dev *, int mask);
1da177e4 1021void pci_fixup_irqs(u8 (*)(struct pci_dev *, u8 *),
d5341942 1022 int (*)(const struct pci_dev *, u8, u8));
1da177e4 1023#define HAVE_PCI_REQ_REGIONS 2
4a7fb636 1024int __must_check pci_request_regions(struct pci_dev *, const char *);
e8de1481 1025int __must_check pci_request_regions_exclusive(struct pci_dev *, const char *);
1da177e4 1026void pci_release_regions(struct pci_dev *);
4a7fb636 1027int __must_check pci_request_region(struct pci_dev *, int, const char *);
e8de1481 1028int __must_check pci_request_region_exclusive(struct pci_dev *, int, const char *);
1da177e4 1029void pci_release_region(struct pci_dev *, int);
c87deff7 1030int pci_request_selected_regions(struct pci_dev *, int, const char *);
e8de1481 1031int pci_request_selected_regions_exclusive(struct pci_dev *, int, const char *);
c87deff7 1032void pci_release_selected_regions(struct pci_dev *, int);
1da177e4
LT
1033
1034/* drivers/pci/bus.c */
fe830ef6
JL
1035struct pci_bus *pci_bus_get(struct pci_bus *bus);
1036void pci_bus_put(struct pci_bus *bus);
45ca9e97 1037void pci_add_resource(struct list_head *resources, struct resource *res);
0efd5aab
BH
1038void pci_add_resource_offset(struct list_head *resources, struct resource *res,
1039 resource_size_t offset);
45ca9e97 1040void pci_free_resource_list(struct list_head *resources);
2fe2abf8
BH
1041void pci_bus_add_resource(struct pci_bus *bus, struct resource *res, unsigned int flags);
1042struct resource *pci_bus_resource_n(const struct pci_bus *bus, int n);
1043void pci_bus_remove_resources(struct pci_bus *bus);
1044
89a74ecc 1045#define pci_bus_for_each_resource(bus, res, i) \
2fe2abf8
BH
1046 for (i = 0; \
1047 (res = pci_bus_resource_n(bus, i)) || i < PCI_BRIDGE_RESOURCE_NUM; \
1048 i++)
89a74ecc 1049
4a7fb636
AM
1050int __must_check pci_bus_alloc_resource(struct pci_bus *bus,
1051 struct resource *res, resource_size_t size,
1052 resource_size_t align, resource_size_t min,
1053 unsigned int type_mask,
3b7a17fc
DB
1054 resource_size_t (*alignf)(void *,
1055 const struct resource *,
b26b2d49
DB
1056 resource_size_t,
1057 resource_size_t),
4a7fb636 1058 void *alignf_data);
1da177e4
LT
1059void pci_enable_bridges(struct pci_bus *bus);
1060
863b18f4 1061/* Proper probing supporting hot-pluggable devices */
725522b5
GKH
1062int __must_check __pci_register_driver(struct pci_driver *, struct module *,
1063 const char *mod_name);
bba81165
AM
1064
1065/*
1066 * pci_register_driver must be a macro so that KBUILD_MODNAME can be expanded
1067 */
1068#define pci_register_driver(driver) \
1069 __pci_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
863b18f4 1070
05cca6e5 1071void pci_unregister_driver(struct pci_driver *dev);
aad4f400
GKH
1072
1073/**
1074 * module_pci_driver() - Helper macro for registering a PCI driver
1075 * @__pci_driver: pci_driver struct
1076 *
1077 * Helper macro for PCI drivers which do not do anything special in module
1078 * init/exit. This eliminates a lot of boilerplate. Each module may only
1079 * use this macro once, and calling it replaces module_init() and module_exit()
1080 */
1081#define module_pci_driver(__pci_driver) \
1082 module_driver(__pci_driver, pci_register_driver, \
1083 pci_unregister_driver)
1084
05cca6e5 1085struct pci_driver *pci_dev_driver(const struct pci_dev *dev);
9dba910e
TH
1086int pci_add_dynid(struct pci_driver *drv,
1087 unsigned int vendor, unsigned int device,
1088 unsigned int subvendor, unsigned int subdevice,
1089 unsigned int class, unsigned int class_mask,
1090 unsigned long driver_data);
05cca6e5
GKH
1091const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
1092 struct pci_dev *dev);
1093int pci_scan_bridge(struct pci_bus *bus, struct pci_dev *dev, int max,
1094 int pass);
1da177e4 1095
70298c6e 1096void pci_walk_bus(struct pci_bus *top, int (*cb)(struct pci_dev *, void *),
cecf4864 1097 void *userdata);
70b9f7dc 1098int pci_cfg_space_size_ext(struct pci_dev *dev);
ac7dc65a 1099int pci_cfg_space_size(struct pci_dev *dev);
05cca6e5 1100unsigned char pci_bus_max_busnr(struct pci_bus *bus);
e2444273 1101void pci_setup_bridge(struct pci_bus *bus);
ac5ad93e
GS
1102resource_size_t pcibios_window_alignment(struct pci_bus *bus,
1103 unsigned long type);
cecf4864 1104
3448a19d
DA
1105#define PCI_VGA_STATE_CHANGE_BRIDGE (1 << 0)
1106#define PCI_VGA_STATE_CHANGE_DECODES (1 << 1)
1107
deb2d2ec 1108int pci_set_vga_state(struct pci_dev *pdev, bool decode,
3448a19d 1109 unsigned int command_bits, u32 flags);
1da177e4
LT
1110/* kmem_cache style wrapper around pci_alloc_consistent() */
1111
f41b1771 1112#include <linux/pci-dma.h>
1da177e4
LT
1113#include <linux/dmapool.h>
1114
1115#define pci_pool dma_pool
1116#define pci_pool_create(name, pdev, size, align, allocation) \
1117 dma_pool_create(name, &pdev->dev, size, align, allocation)
1118#define pci_pool_destroy(pool) dma_pool_destroy(pool)
1119#define pci_pool_alloc(pool, flags, handle) dma_pool_alloc(pool, flags, handle)
1120#define pci_pool_free(pool, vaddr, addr) dma_pool_free(pool, vaddr, addr)
1121
e24c2d96
DM
1122enum pci_dma_burst_strategy {
1123 PCI_DMA_BURST_INFINITY, /* make bursts as large as possible,
1124 strategy_parameter is N/A */
1125 PCI_DMA_BURST_BOUNDARY, /* disconnect at every strategy_parameter
1126 byte boundaries */
1127 PCI_DMA_BURST_MULTIPLE, /* disconnect at some multiple of
1128 strategy_parameter byte boundaries */
1129};
1130
1da177e4 1131struct msix_entry {
16dbef4a 1132 u32 vector; /* kernel uses to write allocated vector */
1da177e4
LT
1133 u16 entry; /* driver uses to specify entry, OS writes */
1134};
1135
0366f8f7 1136
1da177e4 1137#ifndef CONFIG_PCI_MSI
1c8d7b0a 1138static inline int pci_enable_msi_block(struct pci_dev *dev, unsigned int nvec)
05cca6e5
GKH
1139{
1140 return -1;
1141}
1142
08261d87
AG
1143static inline int
1144pci_enable_msi_block_auto(struct pci_dev *dev, unsigned int *maxvec)
1145{
1146 return -1;
1147}
1148
d52877c7
YL
1149static inline void pci_msi_shutdown(struct pci_dev *dev)
1150{ }
05cca6e5
GKH
1151static inline void pci_disable_msi(struct pci_dev *dev)
1152{ }
1153
a52e2e35
RW
1154static inline int pci_msix_table_size(struct pci_dev *dev)
1155{
1156 return 0;
1157}
05cca6e5
GKH
1158static inline int pci_enable_msix(struct pci_dev *dev,
1159 struct msix_entry *entries, int nvec)
1160{
1161 return -1;
1162}
1163
d52877c7
YL
1164static inline void pci_msix_shutdown(struct pci_dev *dev)
1165{ }
05cca6e5
GKH
1166static inline void pci_disable_msix(struct pci_dev *dev)
1167{ }
1168
1169static inline void msi_remove_pci_irq_vectors(struct pci_dev *dev)
1170{ }
1171
1172static inline void pci_restore_msi_state(struct pci_dev *dev)
1173{ }
07ae95f9
AP
1174static inline int pci_msi_enabled(void)
1175{
1176 return 0;
1177}
1da177e4 1178#else
f39d5b72
BH
1179int pci_enable_msi_block(struct pci_dev *dev, unsigned int nvec);
1180int pci_enable_msi_block_auto(struct pci_dev *dev, unsigned int *maxvec);
1181void pci_msi_shutdown(struct pci_dev *dev);
1182void pci_disable_msi(struct pci_dev *dev);
1183int pci_msix_table_size(struct pci_dev *dev);
1184int pci_enable_msix(struct pci_dev *dev, struct msix_entry *entries, int nvec);
1185void pci_msix_shutdown(struct pci_dev *dev);
1186void pci_disable_msix(struct pci_dev *dev);
1187void msi_remove_pci_irq_vectors(struct pci_dev *dev);
1188void pci_restore_msi_state(struct pci_dev *dev);
1189int pci_msi_enabled(void);
1da177e4
LT
1190#endif
1191
ab0724ff 1192#ifdef CONFIG_PCIEPORTBUS
415e12b2
RW
1193extern bool pcie_ports_disabled;
1194extern bool pcie_ports_auto;
ab0724ff
MT
1195#else
1196#define pcie_ports_disabled true
1197#define pcie_ports_auto false
1198#endif
415e12b2 1199
3e1b1600 1200#ifndef CONFIG_PCIEASPM
8b8bae90
RW
1201static inline int pcie_aspm_enabled(void) { return 0; }
1202static inline bool pcie_aspm_support_enabled(void) { return false; }
3e1b1600 1203#else
f39d5b72
BH
1204int pcie_aspm_enabled(void);
1205bool pcie_aspm_support_enabled(void);
3e1b1600
AP
1206#endif
1207
415e12b2
RW
1208#ifdef CONFIG_PCIEAER
1209void pci_no_aer(void);
1210bool pci_aer_available(void);
1211#else
1212static inline void pci_no_aer(void) { }
1213static inline bool pci_aer_available(void) { return false; }
1214#endif
1215
43c16408
AP
1216#ifndef CONFIG_PCIE_ECRC
1217static inline void pcie_set_ecrc_checking(struct pci_dev *dev)
1218{
1219 return;
1220}
1221static inline void pcie_ecrc_get_policy(char *str) {};
1222#else
f39d5b72
BH
1223void pcie_set_ecrc_checking(struct pci_dev *dev);
1224void pcie_ecrc_get_policy(char *str);
43c16408
AP
1225#endif
1226
1c8d7b0a
MW
1227#define pci_enable_msi(pdev) pci_enable_msi_block(pdev, 1)
1228
8b955b0d 1229#ifdef CONFIG_HT_IRQ
8b955b0d
EB
1230/* The functions a driver should call */
1231int ht_create_irq(struct pci_dev *dev, int idx);
1232void ht_destroy_irq(unsigned int irq);
8b955b0d
EB
1233#endif /* CONFIG_HT_IRQ */
1234
f39d5b72
BH
1235void pci_cfg_access_lock(struct pci_dev *dev);
1236bool pci_cfg_access_trylock(struct pci_dev *dev);
1237void pci_cfg_access_unlock(struct pci_dev *dev);
e04b0ea2 1238
4352dfd5
GKH
1239/*
1240 * PCI domain support. Sometimes called PCI segment (eg by ACPI),
1241 * a PCI domain is defined to be a set of PCI busses which share
1242 * configuration space.
1243 */
32a2eea7
JG
1244#ifdef CONFIG_PCI_DOMAINS
1245extern int pci_domains_supported;
1246#else
1247enum { pci_domains_supported = 0 };
05cca6e5
GKH
1248static inline int pci_domain_nr(struct pci_bus *bus)
1249{
1250 return 0;
1251}
1252
4352dfd5
GKH
1253static inline int pci_proc_domain(struct pci_bus *bus)
1254{
1255 return 0;
1256}
32a2eea7 1257#endif /* CONFIG_PCI_DOMAINS */
1da177e4 1258
95a8b6ef
MT
1259/* some architectures require additional setup to direct VGA traffic */
1260typedef int (*arch_set_vga_state_t)(struct pci_dev *pdev, bool decode,
3448a19d 1261 unsigned int command_bits, u32 flags);
f39d5b72 1262void pci_register_set_vga_state(arch_set_vga_state_t func);
95a8b6ef 1263
4352dfd5 1264#else /* CONFIG_PCI is not enabled */
1da177e4
LT
1265
1266/*
1267 * If the system does not have PCI, clearly these return errors. Define
1268 * these as simple inline functions to avoid hair in drivers.
1269 */
1270
05cca6e5
GKH
1271#define _PCI_NOP(o, s, t) \
1272 static inline int pci_##o##_config_##s(struct pci_dev *dev, \
1273 int where, t val) \
1da177e4 1274 { return PCIBIOS_FUNC_NOT_SUPPORTED; }
05cca6e5
GKH
1275
1276#define _PCI_NOP_ALL(o, x) _PCI_NOP(o, byte, u8 x) \
1277 _PCI_NOP(o, word, u16 x) \
1278 _PCI_NOP(o, dword, u32 x)
1da177e4
LT
1279_PCI_NOP_ALL(read, *)
1280_PCI_NOP_ALL(write,)
1281
d42552c3 1282static inline struct pci_dev *pci_get_device(unsigned int vendor,
05cca6e5
GKH
1283 unsigned int device,
1284 struct pci_dev *from)
1285{
1286 return NULL;
1287}
d42552c3 1288
05cca6e5
GKH
1289static inline struct pci_dev *pci_get_subsys(unsigned int vendor,
1290 unsigned int device,
1291 unsigned int ss_vendor,
1292 unsigned int ss_device,
b08508c4 1293 struct pci_dev *from)
05cca6e5
GKH
1294{
1295 return NULL;
1296}
1da177e4 1297
05cca6e5
GKH
1298static inline struct pci_dev *pci_get_class(unsigned int class,
1299 struct pci_dev *from)
1300{
1301 return NULL;
1302}
1da177e4
LT
1303
1304#define pci_dev_present(ids) (0)
ed4aaadb 1305#define no_pci_devices() (1)
1da177e4
LT
1306#define pci_dev_put(dev) do { } while (0)
1307
05cca6e5
GKH
1308static inline void pci_set_master(struct pci_dev *dev)
1309{ }
1310
1311static inline int pci_enable_device(struct pci_dev *dev)
1312{
1313 return -EIO;
1314}
1315
1316static inline void pci_disable_device(struct pci_dev *dev)
1317{ }
1318
1319static inline int pci_set_dma_mask(struct pci_dev *dev, u64 mask)
1320{
1321 return -EIO;
1322}
1323
80be0385
RD
1324static inline int pci_set_consistent_dma_mask(struct pci_dev *dev, u64 mask)
1325{
1326 return -EIO;
1327}
1328
4d57cdfa
FT
1329static inline int pci_set_dma_max_seg_size(struct pci_dev *dev,
1330 unsigned int size)
1331{
1332 return -EIO;
1333}
1334
59fc67de
FT
1335static inline int pci_set_dma_seg_boundary(struct pci_dev *dev,
1336 unsigned long mask)
1337{
1338 return -EIO;
1339}
1340
05cca6e5
GKH
1341static inline int pci_assign_resource(struct pci_dev *dev, int i)
1342{
1343 return -EBUSY;
1344}
1345
1346static inline int __pci_register_driver(struct pci_driver *drv,
1347 struct module *owner)
1348{
1349 return 0;
1350}
1351
1352static inline int pci_register_driver(struct pci_driver *drv)
1353{
1354 return 0;
1355}
1356
1357static inline void pci_unregister_driver(struct pci_driver *drv)
1358{ }
1359
1360static inline int pci_find_capability(struct pci_dev *dev, int cap)
1361{
1362 return 0;
1363}
1364
1365static inline int pci_find_next_capability(struct pci_dev *dev, u8 post,
1366 int cap)
1367{
1368 return 0;
1369}
1370
1371static inline int pci_find_ext_capability(struct pci_dev *dev, int cap)
1372{
1373 return 0;
1374}
1375
1da177e4 1376/* Power management related routines */
05cca6e5
GKH
1377static inline int pci_save_state(struct pci_dev *dev)
1378{
1379 return 0;
1380}
1381
1d3c16a8
JM
1382static inline void pci_restore_state(struct pci_dev *dev)
1383{ }
1da177e4 1384
05cca6e5
GKH
1385static inline int pci_set_power_state(struct pci_dev *dev, pci_power_t state)
1386{
1387 return 0;
1388}
1389
3449248c
RD
1390static inline int pci_wake_from_d3(struct pci_dev *dev, bool enable)
1391{
1392 return 0;
1393}
1394
05cca6e5
GKH
1395static inline pci_power_t pci_choose_state(struct pci_dev *dev,
1396 pm_message_t state)
1397{
1398 return PCI_D0;
1399}
1400
1401static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
1402 int enable)
1403{
1404 return 0;
1405}
1406
b48d4425
JB
1407static inline void pci_enable_ido(struct pci_dev *dev, unsigned long type)
1408{
1409}
1410
1411static inline void pci_disable_ido(struct pci_dev *dev, unsigned long type)
1412{
1413}
1414
48a92a81
JB
1415static inline int pci_enable_obff(struct pci_dev *dev, unsigned long type)
1416{
1417 return 0;
1418}
1419
1420static inline void pci_disable_obff(struct pci_dev *dev)
1421{
1422}
1423
05cca6e5
GKH
1424static inline int pci_request_regions(struct pci_dev *dev, const char *res_name)
1425{
1426 return -EIO;
1427}
1428
1429static inline void pci_release_regions(struct pci_dev *dev)
1430{ }
0da0ead9 1431
a46e8126
KG
1432#define pci_dma_burst_advice(pdev, strat, strategy_parameter) do { } while (0)
1433
fb51ccbf 1434static inline void pci_block_cfg_access(struct pci_dev *dev)
05cca6e5
GKH
1435{ }
1436
fb51ccbf
JK
1437static inline int pci_block_cfg_access_in_atomic(struct pci_dev *dev)
1438{ return 0; }
1439
1440static inline void pci_unblock_cfg_access(struct pci_dev *dev)
05cca6e5 1441{ }
e04b0ea2 1442
d80d0217
RD
1443static inline struct pci_bus *pci_find_next_bus(const struct pci_bus *from)
1444{ return NULL; }
1445
1446static inline struct pci_dev *pci_get_slot(struct pci_bus *bus,
1447 unsigned int devfn)
1448{ return NULL; }
1449
1450static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
1451 unsigned int devfn)
1452{ return NULL; }
1453
92298e66
DA
1454static inline int pci_domain_nr(struct pci_bus *bus)
1455{ return 0; }
1456
12ea6cad
AW
1457static inline struct pci_dev *pci_dev_get(struct pci_dev *dev)
1458{ return NULL; }
1459
fb8a0d9d
WM
1460#define dev_is_pci(d) (false)
1461#define dev_is_pf(d) (false)
1462#define dev_num_vf(d) (0)
4352dfd5 1463#endif /* CONFIG_PCI */
1da177e4 1464
4352dfd5
GKH
1465/* Include architecture-dependent settings and functions */
1466
1467#include <asm/pci.h>
1da177e4 1468
1f82de10
YL
1469#ifndef PCIBIOS_MAX_MEM_32
1470#define PCIBIOS_MAX_MEM_32 (-1)
1471#endif
1472
1da177e4
LT
1473/* these helpers provide future and backwards compatibility
1474 * for accessing popular PCI BAR info */
05cca6e5
GKH
1475#define pci_resource_start(dev, bar) ((dev)->resource[(bar)].start)
1476#define pci_resource_end(dev, bar) ((dev)->resource[(bar)].end)
1477#define pci_resource_flags(dev, bar) ((dev)->resource[(bar)].flags)
1da177e4 1478#define pci_resource_len(dev,bar) \
05cca6e5
GKH
1479 ((pci_resource_start((dev), (bar)) == 0 && \
1480 pci_resource_end((dev), (bar)) == \
1481 pci_resource_start((dev), (bar))) ? 0 : \
1482 \
1483 (pci_resource_end((dev), (bar)) - \
1484 pci_resource_start((dev), (bar)) + 1))
1da177e4
LT
1485
1486/* Similar to the helpers above, these manipulate per-pci_dev
1487 * driver-specific data. They are really just a wrapper around
1488 * the generic device structure functions of these calls.
1489 */
05cca6e5 1490static inline void *pci_get_drvdata(struct pci_dev *pdev)
1da177e4
LT
1491{
1492 return dev_get_drvdata(&pdev->dev);
1493}
1494
05cca6e5 1495static inline void pci_set_drvdata(struct pci_dev *pdev, void *data)
1da177e4
LT
1496{
1497 dev_set_drvdata(&pdev->dev, data);
1498}
1499
1500/* If you want to know what to call your pci_dev, ask this function.
1501 * Again, it's a wrapper around the generic device.
1502 */
2fc90f61 1503static inline const char *pci_name(const struct pci_dev *pdev)
1da177e4 1504{
c6c4f070 1505 return dev_name(&pdev->dev);
1da177e4
LT
1506}
1507
2311b1f2
ME
1508
1509/* Some archs don't want to expose struct resource to userland as-is
1510 * in sysfs and /proc
1511 */
1512#ifndef HAVE_ARCH_PCI_RESOURCE_TO_USER
1513static inline void pci_resource_to_user(const struct pci_dev *dev, int bar,
05cca6e5 1514 const struct resource *rsrc, resource_size_t *start,
e31dd6e4 1515 resource_size_t *end)
2311b1f2
ME
1516{
1517 *start = rsrc->start;
1518 *end = rsrc->end;
1519}
1520#endif /* HAVE_ARCH_PCI_RESOURCE_TO_USER */
1521
1522
1da177e4
LT
1523/*
1524 * The world is not perfect and supplies us with broken PCI devices.
1525 * For at least a part of these bugs we need a work-around, so both
1526 * generic (drivers/pci/quirks.c) and per-architecture code can define
1527 * fixup hooks to be called for particular buggy devices.
1528 */
1529
1530struct pci_fixup {
f4ca5c6a
YL
1531 u16 vendor; /* You can use PCI_ANY_ID here of course */
1532 u16 device; /* You can use PCI_ANY_ID here of course */
1533 u32 class; /* You can use PCI_ANY_ID here too */
1534 unsigned int class_shift; /* should be 0, 8, 16 */
1da177e4
LT
1535 void (*hook)(struct pci_dev *dev);
1536};
1537
1538enum pci_fixup_pass {
1539 pci_fixup_early, /* Before probing BARs */
1540 pci_fixup_header, /* After reading configuration header */
1541 pci_fixup_final, /* Final phase of device fixups */
1542 pci_fixup_enable, /* pci_enable_device() time */
e1a2a51e
RW
1543 pci_fixup_resume, /* pci_device_resume() */
1544 pci_fixup_suspend, /* pci_device_suspend */
1545 pci_fixup_resume_early, /* pci_device_resume_early() */
1da177e4
LT
1546};
1547
1548/* Anonymous variables would be nice... */
f4ca5c6a
YL
1549#define DECLARE_PCI_FIXUP_SECTION(section, name, vendor, device, class, \
1550 class_shift, hook) \
769ae543 1551 static const struct pci_fixup __pci_fixup_##name __used \
f4ca5c6a
YL
1552 __attribute__((__section__(#section), aligned((sizeof(void *))))) \
1553 = { vendor, device, class, class_shift, hook };
1554
1555#define DECLARE_PCI_FIXUP_CLASS_EARLY(vendor, device, class, \
1556 class_shift, hook) \
1557 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early, \
1558 vendor##device##hook, vendor, device, class, class_shift, hook)
1559#define DECLARE_PCI_FIXUP_CLASS_HEADER(vendor, device, class, \
1560 class_shift, hook) \
1561 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header, \
1562 vendor##device##hook, vendor, device, class, class_shift, hook)
1563#define DECLARE_PCI_FIXUP_CLASS_FINAL(vendor, device, class, \
1564 class_shift, hook) \
1565 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final, \
1566 vendor##device##hook, vendor, device, class, class_shift, hook)
1567#define DECLARE_PCI_FIXUP_CLASS_ENABLE(vendor, device, class, \
1568 class_shift, hook) \
1569 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable, \
1570 vendor##device##hook, vendor, device, class, class_shift, hook)
1571#define DECLARE_PCI_FIXUP_CLASS_RESUME(vendor, device, class, \
1572 class_shift, hook) \
1573 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume, \
1574 resume##vendor##device##hook, vendor, device, class, \
1575 class_shift, hook)
1576#define DECLARE_PCI_FIXUP_CLASS_RESUME_EARLY(vendor, device, class, \
1577 class_shift, hook) \
1578 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early, \
1579 resume_early##vendor##device##hook, vendor, device, \
1580 class, class_shift, hook)
1581#define DECLARE_PCI_FIXUP_CLASS_SUSPEND(vendor, device, class, \
1582 class_shift, hook) \
1583 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend, \
1584 suspend##vendor##device##hook, vendor, device, class, \
1585 class_shift, hook)
1586
1da177e4
LT
1587#define DECLARE_PCI_FIXUP_EARLY(vendor, device, hook) \
1588 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early, \
f4ca5c6a 1589 vendor##device##hook, vendor, device, PCI_ANY_ID, 0, hook)
1da177e4
LT
1590#define DECLARE_PCI_FIXUP_HEADER(vendor, device, hook) \
1591 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header, \
f4ca5c6a 1592 vendor##device##hook, vendor, device, PCI_ANY_ID, 0, hook)
1da177e4
LT
1593#define DECLARE_PCI_FIXUP_FINAL(vendor, device, hook) \
1594 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final, \
f4ca5c6a 1595 vendor##device##hook, vendor, device, PCI_ANY_ID, 0, hook)
1da177e4
LT
1596#define DECLARE_PCI_FIXUP_ENABLE(vendor, device, hook) \
1597 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable, \
f4ca5c6a 1598 vendor##device##hook, vendor, device, PCI_ANY_ID, 0, hook)
1597cacb
AC
1599#define DECLARE_PCI_FIXUP_RESUME(vendor, device, hook) \
1600 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume, \
f4ca5c6a
YL
1601 resume##vendor##device##hook, vendor, device, \
1602 PCI_ANY_ID, 0, hook)
e1a2a51e
RW
1603#define DECLARE_PCI_FIXUP_RESUME_EARLY(vendor, device, hook) \
1604 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early, \
f4ca5c6a
YL
1605 resume_early##vendor##device##hook, vendor, device, \
1606 PCI_ANY_ID, 0, hook)
e1a2a51e
RW
1607#define DECLARE_PCI_FIXUP_SUSPEND(vendor, device, hook) \
1608 DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend, \
f4ca5c6a
YL
1609 suspend##vendor##device##hook, vendor, device, \
1610 PCI_ANY_ID, 0, hook)
1da177e4 1611
93177a74 1612#ifdef CONFIG_PCI_QUIRKS
1da177e4 1613void pci_fixup_device(enum pci_fixup_pass pass, struct pci_dev *dev);
12ea6cad 1614struct pci_dev *pci_get_dma_source(struct pci_dev *dev);
ad805758 1615int pci_dev_specific_acs_enabled(struct pci_dev *dev, u16 acs_flags);
93177a74
RW
1616#else
1617static inline void pci_fixup_device(enum pci_fixup_pass pass,
1618 struct pci_dev *dev) {}
12ea6cad
AW
1619static inline struct pci_dev *pci_get_dma_source(struct pci_dev *dev)
1620{
1621 return pci_dev_get(dev);
1622}
ad805758
AW
1623static inline int pci_dev_specific_acs_enabled(struct pci_dev *dev,
1624 u16 acs_flags)
1625{
1626 return -ENOTTY;
1627}
93177a74 1628#endif
1da177e4 1629
05cca6e5 1630void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen);
5ea81769 1631void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr);
05cca6e5 1632void __iomem * const *pcim_iomap_table(struct pci_dev *pdev);
fb7ebfe4
YL
1633int pcim_iomap_regions(struct pci_dev *pdev, int mask, const char *name);
1634int pcim_iomap_regions_request_all(struct pci_dev *pdev, int mask,
916fbfb7 1635 const char *name);
fb7ebfe4 1636void pcim_iounmap_regions(struct pci_dev *pdev, int mask);
5ea81769 1637
1da177e4 1638extern int pci_pci_problems;
236561e5 1639#define PCIPCI_FAIL 1 /* No PCI PCI DMA */
1da177e4
LT
1640#define PCIPCI_TRITON 2
1641#define PCIPCI_NATOMA 4
1642#define PCIPCI_VIAETBF 8
1643#define PCIPCI_VSFX 16
236561e5
AC
1644#define PCIPCI_ALIMAGIK 32 /* Need low latency setting */
1645#define PCIAGP_FAIL 64 /* No PCI to AGP DMA */
1da177e4 1646
4516a618
AN
1647extern unsigned long pci_cardbus_io_size;
1648extern unsigned long pci_cardbus_mem_size;
15856ad5 1649extern u8 pci_dfl_cache_line_size;
ac1aa47b 1650extern u8 pci_cache_line_size;
4516a618 1651
28760489
EB
1652extern unsigned long pci_hotplug_io_size;
1653extern unsigned long pci_hotplug_mem_size;
1654
cfce9fb8 1655/* Architecture specific versions may override these (weak) */
19792a08
AB
1656int pcibios_add_platform_entries(struct pci_dev *dev);
1657void pcibios_disable_device(struct pci_dev *dev);
cfce9fb8 1658void pcibios_set_master(struct pci_dev *dev);
19792a08
AB
1659int pcibios_set_pcie_reset_state(struct pci_dev *dev,
1660 enum pcie_reset_state state);
eca0d467 1661int pcibios_add_device(struct pci_dev *dev);
6ae32c53 1662void pcibios_release_device(struct pci_dev *dev);
575e3348 1663
7752d5cf 1664#ifdef CONFIG_PCI_MMCONFIG
f39d5b72
BH
1665void __init pci_mmcfg_early_init(void);
1666void __init pci_mmcfg_late_init(void);
7752d5cf 1667#else
bb63b421 1668static inline void pci_mmcfg_early_init(void) { }
7752d5cf
RH
1669static inline void pci_mmcfg_late_init(void) { }
1670#endif
1671
642c92da 1672int pci_ext_cfg_avail(void);
0ef5f8f6 1673
1684f5dd 1674void __iomem *pci_ioremap_bar(struct pci_dev *pdev, int bar);
aa42d7c6 1675
dd7cc44d 1676#ifdef CONFIG_PCI_IOV
f39d5b72
BH
1677int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn);
1678void pci_disable_sriov(struct pci_dev *dev);
1679irqreturn_t pci_sriov_migration(struct pci_dev *dev);
1680int pci_num_vf(struct pci_dev *dev);
5a8eb242 1681int pci_vfs_assigned(struct pci_dev *dev);
f39d5b72
BH
1682int pci_sriov_set_totalvfs(struct pci_dev *dev, u16 numvfs);
1683int pci_sriov_get_totalvfs(struct pci_dev *dev);
dd7cc44d
YZ
1684#else
1685static inline int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn)
1686{
1687 return -ENODEV;
1688}
1689static inline void pci_disable_sriov(struct pci_dev *dev)
1690{
1691}
74bb1bcc
YZ
1692static inline irqreturn_t pci_sriov_migration(struct pci_dev *dev)
1693{
1694 return IRQ_NONE;
1695}
fb8a0d9d
WM
1696static inline int pci_num_vf(struct pci_dev *dev)
1697{
1698 return 0;
1699}
5a8eb242
AD
1700static inline int pci_vfs_assigned(struct pci_dev *dev)
1701{
1702 return 0;
1703}
bff73156
DD
1704static inline int pci_sriov_set_totalvfs(struct pci_dev *dev, u16 numvfs)
1705{
1706 return 0;
1707}
1708static inline int pci_sriov_get_totalvfs(struct pci_dev *dev)
1709{
1710 return 0;
1711}
dd7cc44d
YZ
1712#endif
1713
c825bc94 1714#if defined(CONFIG_HOTPLUG_PCI) || defined(CONFIG_HOTPLUG_PCI_MODULE)
f39d5b72
BH
1715void pci_hp_create_module_link(struct pci_slot *pci_slot);
1716void pci_hp_remove_module_link(struct pci_slot *pci_slot);
c825bc94
KK
1717#endif
1718
d7b7e605
KK
1719/**
1720 * pci_pcie_cap - get the saved PCIe capability offset
1721 * @dev: PCI device
1722 *
1723 * PCIe capability offset is calculated at PCI device initialization
1724 * time and saved in the data structure. This function returns saved
1725 * PCIe capability offset. Using this instead of pci_find_capability()
1726 * reduces unnecessary search in the PCI configuration space. If you
1727 * need to calculate PCIe capability offset from raw device for some
1728 * reasons, please use pci_find_capability() instead.
1729 */
1730static inline int pci_pcie_cap(struct pci_dev *dev)
1731{
1732 return dev->pcie_cap;
1733}
1734
7eb776c4
KK
1735/**
1736 * pci_is_pcie - check if the PCI device is PCI Express capable
1737 * @dev: PCI device
1738 *
1739 * Retrun true if the PCI device is PCI Express capable, false otherwise.
1740 */
1741static inline bool pci_is_pcie(struct pci_dev *dev)
1742{
1743 return !!pci_pcie_cap(dev);
1744}
1745
7c9c003c
MS
1746/**
1747 * pcie_caps_reg - get the PCIe Capabilities Register
1748 * @dev: PCI device
1749 */
1750static inline u16 pcie_caps_reg(const struct pci_dev *dev)
1751{
1752 return dev->pcie_flags_reg;
1753}
1754
786e2288
YW
1755/**
1756 * pci_pcie_type - get the PCIe device/port type
1757 * @dev: PCI device
1758 */
1759static inline int pci_pcie_type(const struct pci_dev *dev)
1760{
1c531d82 1761 return (pcie_caps_reg(dev) & PCI_EXP_FLAGS_TYPE) >> 4;
786e2288
YW
1762}
1763
5d990b62 1764void pci_request_acs(void);
ad805758
AW
1765bool pci_acs_enabled(struct pci_dev *pdev, u16 acs_flags);
1766bool pci_acs_path_enabled(struct pci_dev *start,
1767 struct pci_dev *end, u16 acs_flags);
a2ce7662 1768
7ad506fa
MC
1769#define PCI_VPD_LRDT 0x80 /* Large Resource Data Type */
1770#define PCI_VPD_LRDT_ID(x) (x | PCI_VPD_LRDT)
1771
1772/* Large Resource Data Type Tag Item Names */
1773#define PCI_VPD_LTIN_ID_STRING 0x02 /* Identifier String */
1774#define PCI_VPD_LTIN_RO_DATA 0x10 /* Read-Only Data */
1775#define PCI_VPD_LTIN_RW_DATA 0x11 /* Read-Write Data */
1776
1777#define PCI_VPD_LRDT_ID_STRING PCI_VPD_LRDT_ID(PCI_VPD_LTIN_ID_STRING)
1778#define PCI_VPD_LRDT_RO_DATA PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RO_DATA)
1779#define PCI_VPD_LRDT_RW_DATA PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RW_DATA)
1780
1781/* Small Resource Data Type Tag Item Names */
1782#define PCI_VPD_STIN_END 0x78 /* End */
1783
1784#define PCI_VPD_SRDT_END PCI_VPD_STIN_END
1785
1786#define PCI_VPD_SRDT_TIN_MASK 0x78
1787#define PCI_VPD_SRDT_LEN_MASK 0x07
1788
1789#define PCI_VPD_LRDT_TAG_SIZE 3
1790#define PCI_VPD_SRDT_TAG_SIZE 1
a2ce7662 1791
e1d5bdab
MC
1792#define PCI_VPD_INFO_FLD_HDR_SIZE 3
1793
4067a854
MC
1794#define PCI_VPD_RO_KEYWORD_PARTNO "PN"
1795#define PCI_VPD_RO_KEYWORD_MFR_ID "MN"
1796#define PCI_VPD_RO_KEYWORD_VENDOR0 "V0"
d4894f3e 1797#define PCI_VPD_RO_KEYWORD_CHKSUM "RV"
4067a854 1798
a2ce7662
MC
1799/**
1800 * pci_vpd_lrdt_size - Extracts the Large Resource Data Type length
1801 * @lrdt: Pointer to the beginning of the Large Resource Data Type tag
1802 *
1803 * Returns the extracted Large Resource Data Type length.
1804 */
1805static inline u16 pci_vpd_lrdt_size(const u8 *lrdt)
1806{
1807 return (u16)lrdt[1] + ((u16)lrdt[2] << 8);
1808}
1809
7ad506fa
MC
1810/**
1811 * pci_vpd_srdt_size - Extracts the Small Resource Data Type length
1812 * @lrdt: Pointer to the beginning of the Small Resource Data Type tag
1813 *
1814 * Returns the extracted Small Resource Data Type length.
1815 */
1816static inline u8 pci_vpd_srdt_size(const u8 *srdt)
1817{
1818 return (*srdt) & PCI_VPD_SRDT_LEN_MASK;
1819}
1820
e1d5bdab
MC
1821/**
1822 * pci_vpd_info_field_size - Extracts the information field length
1823 * @lrdt: Pointer to the beginning of an information field header
1824 *
1825 * Returns the extracted information field length.
1826 */
1827static inline u8 pci_vpd_info_field_size(const u8 *info_field)
1828{
1829 return info_field[2];
1830}
1831
b55ac1b2
MC
1832/**
1833 * pci_vpd_find_tag - Locates the Resource Data Type tag provided
1834 * @buf: Pointer to buffered vpd data
1835 * @off: The offset into the buffer at which to begin the search
1836 * @len: The length of the vpd buffer
1837 * @rdt: The Resource Data Type to search for
1838 *
1839 * Returns the index where the Resource Data Type was found or
1840 * -ENOENT otherwise.
1841 */
1842int pci_vpd_find_tag(const u8 *buf, unsigned int off, unsigned int len, u8 rdt);
1843
4067a854
MC
1844/**
1845 * pci_vpd_find_info_keyword - Locates an information field keyword in the VPD
1846 * @buf: Pointer to buffered vpd data
1847 * @off: The offset into the buffer at which to begin the search
1848 * @len: The length of the buffer area, relative to off, in which to search
1849 * @kw: The keyword to search for
1850 *
1851 * Returns the index where the information field keyword was found or
1852 * -ENOENT otherwise.
1853 */
1854int pci_vpd_find_info_keyword(const u8 *buf, unsigned int off,
1855 unsigned int len, const char *kw);
1856
98d9f30c
BH
1857/* PCI <-> OF binding helpers */
1858#ifdef CONFIG_OF
1859struct device_node;
f39d5b72
BH
1860void pci_set_of_node(struct pci_dev *dev);
1861void pci_release_of_node(struct pci_dev *dev);
1862void pci_set_bus_of_node(struct pci_bus *bus);
1863void pci_release_bus_of_node(struct pci_bus *bus);
98d9f30c
BH
1864
1865/* Arch may override this (weak) */
723ec4d0 1866struct device_node *pcibios_get_phb_of_node(struct pci_bus *bus);
98d9f30c 1867
3df425f3
JC
1868static inline struct device_node *
1869pci_device_to_OF_node(const struct pci_dev *pdev)
64099d98
BH
1870{
1871 return pdev ? pdev->dev.of_node : NULL;
1872}
1873
ef3b4f8c
BH
1874static inline struct device_node *pci_bus_to_OF_node(struct pci_bus *bus)
1875{
1876 return bus ? bus->dev.of_node : NULL;
1877}
1878
98d9f30c
BH
1879#else /* CONFIG_OF */
1880static inline void pci_set_of_node(struct pci_dev *dev) { }
1881static inline void pci_release_of_node(struct pci_dev *dev) { }
1882static inline void pci_set_bus_of_node(struct pci_bus *bus) { }
1883static inline void pci_release_bus_of_node(struct pci_bus *bus) { }
1884#endif /* CONFIG_OF */
1885
eb740b5f
GS
1886#ifdef CONFIG_EEH
1887static inline struct eeh_dev *pci_dev_to_eeh_dev(struct pci_dev *pdev)
1888{
1889 return pdev->dev.archdata.edev;
1890}
1891#endif
1892
166e9278
OBC
1893/**
1894 * pci_find_upstream_pcie_bridge - find upstream PCIe-to-PCI bridge of a device
1895 * @pdev: the PCI device
1896 *
1897 * if the device is PCIE, return NULL
1898 * if the device isn't connected to a PCIe bridge (that is its parent is a
1899 * legacy PCI bridge and the bridge is directly connected to bus 0), return its
1900 * parent
1901 */
1902struct pci_dev *pci_find_upstream_pcie_bridge(struct pci_dev *pdev);
1903
1da177e4 1904#endif /* LINUX_PCI_H */
This page took 2.542424 seconds and 5 git commands to generate.