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