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