pci.h 60.8 KB
Newer Older
L
Linus Torvalds 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
/*
 *	pci.h
 *
 *	PCI defines and function prototypes
 *	Copyright 1994, Drew Eckhardt
 *	Copyright 1997--1999 Martin Mares <mj@ucw.cz>
 *
 *	For more information, please consult the following manuals (look at
 *	http://www.pcisig.com/ for how to get them):
 *
 *	PCI BIOS Specification
 *	PCI Local Bus Specification
 *	PCI to PCI Bridge Specification
 *	PCI System Design Guide
 */
#ifndef LINUX_PCI_H
#define LINUX_PCI_H


20 21
#include <linux/mod_devicetable.h>

L
Linus Torvalds 已提交
22
#include <linux/types.h>
23
#include <linux/init.h>
L
Linus Torvalds 已提交
24 25
#include <linux/ioport.h>
#include <linux/list.h>
26
#include <linux/compiler.h>
L
Linus Torvalds 已提交
27
#include <linux/errno.h>
A
Alex Chiang 已提交
28
#include <linux/kobject.h>
A
Arun Sharma 已提交
29
#include <linux/atomic.h>
L
Linus Torvalds 已提交
30
#include <linux/device.h>
31
#include <linux/io.h>
32
#include <linux/irqreturn.h>
33
#include <uapi/linux/pci.h>
L
Linus Torvalds 已提交
34

35 36 37
/* Include the ID list */
#include <linux/pci_ids.h>

A
Alex Chiang 已提交
38 39 40 41 42 43 44 45 46
/* pci_slot represents a physical slot */
struct pci_slot {
	struct pci_bus *bus;		/* The bus this slot is on */
	struct list_head list;		/* node in list of slots on this bus */
	struct hotplug_slot *hotplug;	/* Hotplug info (migrate over time) */
	unsigned char number;		/* PCI_SLOT(pci_dev->devfn) */
	struct kobject kobj;
};

47 48 49 50 51
static inline const char *pci_slot_name(const struct pci_slot *slot)
{
	return kobject_name(&slot->kobj);
}

L
Linus Torvalds 已提交
52 53 54 55 56 57 58 59 60 61 62 63
/* File state for mmap()s on /proc/bus/pci/X/Y */
enum pci_mmap_state {
	pci_mmap_io,
	pci_mmap_mem
};

/* This defines the direction arg to the DMA mapping routines. */
#define PCI_DMA_BIDIRECTIONAL	0
#define PCI_DMA_TODEVICE	1
#define PCI_DMA_FROMDEVICE	2
#define PCI_DMA_NONE		3

64 65 66 67 68 69 70 71 72 73 74
/*
 *  For PCI devices, the region numbers are assigned this way:
 */
enum {
	/* #0-5: standard PCI resources */
	PCI_STD_RESOURCES,
	PCI_STD_RESOURCE_END = 5,

	/* #6: expansion ROM resource */
	PCI_ROM_RESOURCE,

75 76 77 78 79 80
	/* device specific resources */
#ifdef CONFIG_PCI_IOV
	PCI_IOV_RESOURCES,
	PCI_IOV_RESOURCE_END = PCI_IOV_RESOURCES + PCI_SRIOV_NUM_BARS - 1,
#endif

81 82 83 84 85 86 87 88 89 90 91
	/* resources assigned to buses behind the bridge */
#define PCI_BRIDGE_RESOURCE_NUM 4

	PCI_BRIDGE_RESOURCES,
	PCI_BRIDGE_RESOURCE_END = PCI_BRIDGE_RESOURCES +
				  PCI_BRIDGE_RESOURCE_NUM - 1,

	/* total resources associated with a PCI device */
	PCI_NUM_RESOURCES,

	/* preserve this for compatibility */
92
	DEVICE_COUNT_RESOURCE = PCI_NUM_RESOURCES,
93
};
L
Linus Torvalds 已提交
94 95 96

typedef int __bitwise pci_power_t;

97 98 99
#define PCI_D0		((pci_power_t __force) 0)
#define PCI_D1		((pci_power_t __force) 1)
#define PCI_D2		((pci_power_t __force) 2)
L
Linus Torvalds 已提交
100 101
#define PCI_D3hot	((pci_power_t __force) 3)
#define PCI_D3cold	((pci_power_t __force) 4)
102
#define PCI_UNKNOWN	((pci_power_t __force) 5)
103
#define PCI_POWER_ERROR	((pci_power_t __force) -1)
L
Linus Torvalds 已提交
104

A
Alan Stern 已提交
105 106 107 108 109 110 111 112
/* Remember to update this when the list above changes! */
extern const char *pci_power_names[];

static inline const char *pci_power_name(pci_power_t state)
{
	return pci_power_names[1 + (int) state];
}

113 114 115 116
#define PCI_PM_D2_DELAY		200
#define PCI_PM_D3_WAIT		10
#define PCI_PM_D3COLD_WAIT	100
#define PCI_PM_BUS_WAIT		50
117

118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
/** The pci_channel state describes connectivity between the CPU and
 *  the pci device.  If some PCI bus between here and the pci device
 *  has crashed or locked up, this info is reflected here.
 */
typedef unsigned int __bitwise pci_channel_state_t;

enum pci_channel_state {
	/* I/O channel is in normal state */
	pci_channel_io_normal = (__force pci_channel_state_t) 1,

	/* I/O to channel is blocked */
	pci_channel_io_frozen = (__force pci_channel_state_t) 2,

	/* PCI card is dead */
	pci_channel_io_perm_failure = (__force pci_channel_state_t) 3,
};

B
Brian King 已提交
135 136 137 138 139 140 141 142 143 144 145 146 147
typedef unsigned int __bitwise pcie_reset_state_t;

enum pcie_reset_state {
	/* Reset is NOT asserted (Use to deassert reset) */
	pcie_deassert_reset = (__force pcie_reset_state_t) 1,

	/* Use #PERST to reset PCI-E device */
	pcie_warm_reset = (__force pcie_reset_state_t) 2,

	/* Use PCI-E Hot Reset to reset device */
	pcie_hot_reset = (__force pcie_reset_state_t) 3
};

148 149 150 151 152 153
typedef unsigned short __bitwise pci_dev_flags_t;
enum pci_dev_flags {
	/* INTX_DISABLE in PCI_COMMAND register disables MSI
	 * generation too.
	 */
	PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG = (__force pci_dev_flags_t) 1,
154 155
	/* Device configuration is irrevocably lost if disabled into D3 */
	PCI_DEV_FLAGS_NO_D3 = (__force pci_dev_flags_t) 2,
156 157
	/* Provide indication device is assigned by a Virtual Machine Manager */
	PCI_DEV_FLAGS_ASSIGNED = (__force pci_dev_flags_t) 4,
158 159
};

160 161 162 163 164
enum pci_irq_reroute_variant {
	INTEL_IRQ_REROUTE_VARIANT = 1,
	MAX_IRQ_REROUTE_VARIANTS = 3
};

165 166
typedef unsigned short __bitwise pci_bus_flags_t;
enum pci_bus_flags {
167 168
	PCI_BUS_FLAGS_NO_MSI   = (__force pci_bus_flags_t) 1,
	PCI_BUS_FLAGS_NO_MMRBC = (__force pci_bus_flags_t) 2,
169 170
};

171 172 173 174 175 176 177 178 179 180 181 182 183
/* Based on the PCI Hotplug Spec, but some values are made up by us */
enum pci_bus_speed {
	PCI_SPEED_33MHz			= 0x00,
	PCI_SPEED_66MHz			= 0x01,
	PCI_SPEED_66MHz_PCIX		= 0x02,
	PCI_SPEED_100MHz_PCIX		= 0x03,
	PCI_SPEED_133MHz_PCIX		= 0x04,
	PCI_SPEED_66MHz_PCIX_ECC	= 0x05,
	PCI_SPEED_100MHz_PCIX_ECC	= 0x06,
	PCI_SPEED_133MHz_PCIX_ECC	= 0x07,
	PCI_SPEED_66MHz_PCIX_266	= 0x09,
	PCI_SPEED_100MHz_PCIX_266	= 0x0a,
	PCI_SPEED_133MHz_PCIX_266	= 0x0b,
184 185 186 187 188
	AGP_UNKNOWN			= 0x0c,
	AGP_1X				= 0x0d,
	AGP_2X				= 0x0e,
	AGP_4X				= 0x0f,
	AGP_8X				= 0x10,
189 190 191 192 193
	PCI_SPEED_66MHz_PCIX_533	= 0x11,
	PCI_SPEED_100MHz_PCIX_533	= 0x12,
	PCI_SPEED_133MHz_PCIX_533	= 0x13,
	PCIE_SPEED_2_5GT		= 0x14,
	PCIE_SPEED_5_0GT		= 0x15,
194
	PCIE_SPEED_8_0GT		= 0x16,
195 196 197
	PCI_SPEED_UNKNOWN		= 0xff,
};

198
struct pci_cap_saved_data {
199
	char cap_nr;
200
	unsigned int size;
201 202 203
	u32 data[0];
};

204 205 206 207 208
struct pci_cap_saved_state {
	struct hlist_node next;
	struct pci_cap_saved_data cap;
};

S
Shaohua Li 已提交
209
struct pcie_link_state;
210
struct pci_vpd;
211
struct pci_sriov;
Y
Yu Zhao 已提交
212
struct pci_ats;
213

L
Linus Torvalds 已提交
214 215 216 217 218 219 220 221 222 223
/*
 * The pci_dev structure is used to describe PCI devices.
 */
struct pci_dev {
	struct list_head bus_list;	/* node in per-bus list */
	struct pci_bus	*bus;		/* bus this device is on */
	struct pci_bus	*subordinate;	/* bus this device bridges to */

	void		*sysdata;	/* hook for sys-specific extension */
	struct proc_dir_entry *procent;	/* device entry in /proc/bus/pci */
A
Alex Chiang 已提交
224
	struct pci_slot	*slot;		/* Physical slot this device is in */
L
Linus Torvalds 已提交
225 226 227 228 229 230 231

	unsigned int	devfn;		/* encoded device & function index */
	unsigned short	vendor;
	unsigned short	device;
	unsigned short	subsystem_vendor;
	unsigned short	subsystem_device;
	unsigned int	class;		/* 3 bytes: (base,sub,prog-if) */
A
Auke Kok 已提交
232
	u8		revision;	/* PCI revision, low byte of class word */
L
Linus Torvalds 已提交
233
	u8		hdr_type;	/* PCI header type (`multi' flag masked out) */
234
	u8		pcie_cap;	/* PCI-E capability offset */
235
	u8		pcie_mpss:3;	/* PCI-E Max Payload Size Supported */
L
Linus Torvalds 已提交
236
	u8		rom_base_reg;	/* which config register controls the ROM */
237
	u8		pin;  		/* which interrupt pin this device uses */
238
	u16		pcie_flags_reg;	/* cached PCI-E Capabilities Register */
L
Linus Torvalds 已提交
239 240 241 242 243 244 245 246

	struct pci_driver *driver;	/* which driver has allocated this device */
	u64		dma_mask;	/* Mask of the bits of bus address this
					   device implements.  Normally this is
					   0xffffffff.  You only need to change
					   this if your device has broken DMA
					   or supports 64-bit transfers.  */

247 248
	struct device_dma_parameters dma_parms;

L
Linus Torvalds 已提交
249 250 251
	pci_power_t     current_state;  /* Current operating state. In ACPI-speak,
					   this is D0-D3, D0 being fully functional,
					   and D3 being off. */
252 253 254 255
	int		pm_cap;		/* PM capability offset in the
					   configuration space */
	unsigned int	pme_support:5;	/* Bitmask of states from which PME#
					   can be generated */
256
	unsigned int	pme_interrupt:1;
257
	unsigned int	pme_poll:1;	/* Poll device's PME status bit */
258 259
	unsigned int	d1_support:1;	/* Low power state D1 is supported */
	unsigned int	d2_support:1;	/* Low power state D2 is supported */
260 261 262
	unsigned int	no_d1d2:1;	/* D1 and D2 are forbidden */
	unsigned int	no_d3cold:1;	/* D3cold is forbidden */
	unsigned int	d3cold_allowed:1;	/* D3cold is allowed by user */
J
Jacob Pan 已提交
263 264
	unsigned int	mmio_always_on:1;	/* disallow turning off io/mem
						   decoding during bar sizing */
265
	unsigned int	wakeup_prepared:1;
266 267 268 269
	unsigned int	runtime_d3cold:1;	/* whether go through runtime
						   D3cold, not set for devices
						   powered on/off by the
						   corresponding bridge */
270
	unsigned int	d3_delay;	/* D3->D0 transition time in ms */
271
	unsigned int	d3cold_delay;	/* D3cold->D0 transition time in ms */
L
Linus Torvalds 已提交
272

S
Shaohua Li 已提交
273 274 275 276
#ifdef CONFIG_PCIEASPM
	struct pcie_link_state	*link_state;	/* ASPM link state. */
#endif

277
	pci_channel_state_t error_state;	/* current connectivity state */
L
Linus Torvalds 已提交
278 279 280 281 282 283 284 285 286 287 288
	struct	device	dev;		/* Generic device interface */

	int		cfg_size;	/* Size of configuration space */

	/*
	 * Instead of touching interrupt line and base address registers
	 * directly, use the values stored here. They might be different!
	 */
	unsigned int	irq;
	struct resource resource[DEVICE_COUNT_RESOURCE]; /* I/O and memory regions + expansion ROMs */

289
	bool match_driver;		/* Skip attaching driver */
L
Linus Torvalds 已提交
290 291 292 293
	/* These fields are used by common fixups */
	unsigned int	transparent:1;	/* Transparent PCI bridge */
	unsigned int	multifunction:1;/* Part of multi-function device */
	/* keep track of device state */
294
	unsigned int	is_added:1;
L
Linus Torvalds 已提交
295
	unsigned int	is_busmaster:1; /* device is busmaster */
296
	unsigned int	no_msi:1;	/* device may not use msi */
297
	unsigned int	block_cfg_access:1;	/* config space access is blocked */
298
	unsigned int	broken_parity_status:1;	/* Device generates false positive parity */
299
	unsigned int	irq_reroute_variant:2;	/* device needs IRQ rerouting variant */
300 301
	unsigned int 	msi_enabled:1;
	unsigned int	msix_enabled:1;
Y
Yu Zhao 已提交
302
	unsigned int	ari_enabled:1;	/* ARI forwarding */
T
Tejun Heo 已提交
303
	unsigned int	is_managed:1;
K
Kenji Kaneshige 已提交
304 305
	unsigned int	is_pcie:1;	/* Obsolete. Will be removed.
					   Use pci_is_pcie() instead */
306
	unsigned int    needs_freset:1; /* Dev requires fundamental reset */
307
	unsigned int	state_saved:1;
308
	unsigned int	is_physfn:1;
309
	unsigned int	is_virtfn:1;
310
	unsigned int	reset_fn:1;
311
	unsigned int    is_hotplug_bridge:1;
312 313
	unsigned int    __aer_firmware_first_valid:1;
	unsigned int	__aer_firmware_first:1;
314
	unsigned int	broken_intx_masking:1;
315
	unsigned int	io_window_1k:1;	/* Intel P2P bridge 1K I/O windows */
316
	pci_dev_flags_t dev_flags;
317
	atomic_t	enable_cnt;	/* pci_enable_device has been called */
318

L
Linus Torvalds 已提交
319
	u32		saved_config_space[16]; /* config space saved at suspend time */
320
	struct hlist_head saved_cap_space;
L
Linus Torvalds 已提交
321 322 323
	struct bin_attribute *rom_attr; /* attribute descriptor for sysfs ROM entry */
	int rom_attr_enabled;		/* has display of the rom attribute been enabled? */
	struct bin_attribute *res_attr[DEVICE_COUNT_RESOURCE]; /* sysfs file for resources */
324
	struct bin_attribute *res_attr_wc[DEVICE_COUNT_RESOURCE]; /* sysfs file for WC mapping of resources */
E
Eric W. Biederman 已提交
325
#ifdef CONFIG_PCI_MSI
326
	struct list_head msi_list;
327
	struct kset *msi_kset;
E
Eric W. Biederman 已提交
328
#endif
329
	struct pci_vpd *vpd;
330
#ifdef CONFIG_PCI_ATS
331 332 333 334
	union {
		struct pci_sriov *sriov;	/* SR-IOV capability related */
		struct pci_dev *physfn;	/* the PF this VF is associated with */
	};
Y
Yu Zhao 已提交
335
	struct pci_ats	*ats;	/* Address Translation Service */
336
#endif
337
	phys_addr_t rom; /* Physical address of ROM if it's not from the BAR */
338
	size_t romlen; /* Length of ROM if it's not from the BAR */
L
Linus Torvalds 已提交
339 340
};

341 342 343 344 345 346 347 348 349 350
static inline struct pci_dev *pci_physfn(struct pci_dev *dev)
{
#ifdef CONFIG_PCI_IOV
	if (dev->is_virtfn)
		dev = dev->physfn;
#endif

	return dev;
}

351 352
extern struct pci_dev *alloc_pci_dev(void);

L
Linus Torvalds 已提交
353 354 355
#define	to_pci_dev(n) container_of(n, struct pci_dev, dev)
#define for_each_pci_dev(d) while ((d = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, d)) != NULL)

356 357 358 359 360
static inline int pci_channel_offline(struct pci_dev *pdev)
{
	return (pdev->error_state != pci_channel_io_normal);
}

Y
Yinghai Lu 已提交
361 362
extern struct resource busn_resource;

363 364 365 366 367
struct pci_host_bridge_window {
	struct list_head list;
	struct resource *res;		/* host bridge aperture (CPU address) */
	resource_size_t offset;		/* bus address + offset = CPU address */
};
368

369
struct pci_host_bridge {
370
	struct device dev;
371
	struct pci_bus *bus;		/* root bus */
372
	struct list_head windows;	/* pci_host_bridge_windows */
373 374
	void (*release_fn)(struct pci_host_bridge *);
	void *release_data;
375
};
376

377
#define	to_pci_host_bridge(n) container_of(n, struct pci_host_bridge, dev)
378 379 380
void pci_set_host_bridge_release(struct pci_host_bridge *bridge,
		     void (*release_fn)(struct pci_host_bridge *),
		     void *release_data);
381

382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
/*
 * The first PCI_BRIDGE_RESOURCE_NUM PCI bus resources (those that correspond
 * to P2P or CardBus bridge windows) go in a table.  Additional ones (for
 * buses below host bridges or subtractive decode bridges) go in the list.
 * Use pci_bus_for_each_resource() to iterate through all the resources.
 */

/*
 * PCI_SUBTRACTIVE_DECODE means the bridge forwards the window implicitly
 * and there's no way to program the bridge with the details of the window.
 * This does not apply to ACPI _CRS windows, even with the _DEC subtractive-
 * decode bit set, because they are explicit and can be programmed with _SRS.
 */
#define PCI_SUBTRACTIVE_DECODE	0x1

struct pci_bus_resource {
	struct list_head list;
	struct resource *res;
	unsigned int flags;
};
402 403

#define PCI_REGION_FLAG_MASK	0x0fU	/* These bits of resource flags tell us the PCI region flags */
L
Linus Torvalds 已提交
404 405 406 407 408 409 410

struct pci_bus {
	struct list_head node;		/* node in list of buses */
	struct pci_bus	*parent;	/* parent bus this bridge is on */
	struct list_head children;	/* list of child buses */
	struct list_head devices;	/* list of devices on this bus */
	struct pci_dev	*self;		/* bridge device as seen by parent */
A
Alex Chiang 已提交
411
	struct list_head slots;		/* list of slots on this bus */
412 413
	struct resource *resource[PCI_BRIDGE_RESOURCE_NUM];
	struct list_head resources;	/* address space routed to this bus */
Y
Yinghai Lu 已提交
414
	struct resource busn_res;	/* bus numbers routed to this bus */
L
Linus Torvalds 已提交
415 416 417 418 419 420 421

	struct pci_ops	*ops;		/* configuration access functions */
	void		*sysdata;	/* hook for sys-specific extension */
	struct proc_dir_entry *procdir;	/* directory entry in /proc/bus/pci */

	unsigned char	number;		/* bus number */
	unsigned char	primary;	/* number of primary bridge */
422 423
	unsigned char	max_bus_speed;	/* enum pci_bus_speed */
	unsigned char	cur_bus_speed;	/* enum pci_bus_speed */
L
Linus Torvalds 已提交
424 425 426 427

	char		name[48];

	unsigned short  bridge_ctl;	/* manage NO_ISA/FBB/et al behaviors */
428
	pci_bus_flags_t bus_flags;	/* Inherited by child busses */
L
Linus Torvalds 已提交
429
	struct device		*bridge;
430
	struct device		dev;
L
Linus Torvalds 已提交
431 432
	struct bin_attribute	*legacy_io; /* legacy I/O for this bus */
	struct bin_attribute	*legacy_mem; /* legacy mem */
433
	unsigned int		is_added:1;
L
Linus Torvalds 已提交
434 435 436
};

#define pci_bus_b(n)	list_entry(n, struct pci_bus, node)
437
#define to_pci_bus(n)	container_of(n, struct pci_bus, dev)
L
Linus Torvalds 已提交
438

K
Kenji Kaneshige 已提交
439 440 441 442 443 444 445 446 447
/*
 * Returns true if the pci bus is root (behind host-pci bridge),
 * false otherwise
 */
static inline bool pci_is_root_bus(struct pci_bus *pbus)
{
	return !(pbus->parent);
}

448 449 450 451 452 453 454 455 456
#ifdef CONFIG_PCI_MSI
static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev)
{
	return pci_dev->msi_enabled || pci_dev->msix_enabled;
}
#else
static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev) { return false; }
#endif

L
Linus Torvalds 已提交
457 458 459 460 461 462 463 464 465 466 467
/*
 * Error values that may be returned by PCI functions.
 */
#define PCIBIOS_SUCCESSFUL		0x00
#define PCIBIOS_FUNC_NOT_SUPPORTED	0x81
#define PCIBIOS_BAD_VENDOR_ID		0x83
#define PCIBIOS_DEVICE_NOT_FOUND	0x86
#define PCIBIOS_BAD_REGISTER_NUMBER	0x87
#define PCIBIOS_SET_FAILED		0x88
#define PCIBIOS_BUFFER_TOO_SMALL	0x89

468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493
/*
 * Translate above to generic errno for passing back through non-pci.
 */
static inline int pcibios_err_to_errno(int err)
{
	if (err <= PCIBIOS_SUCCESSFUL)
		return err; /* Assume already errno */

	switch (err) {
	case PCIBIOS_FUNC_NOT_SUPPORTED:
		return -ENOENT;
	case PCIBIOS_BAD_VENDOR_ID:
		return -EINVAL;
	case PCIBIOS_DEVICE_NOT_FOUND:
		return -ENODEV;
	case PCIBIOS_BAD_REGISTER_NUMBER:
		return -EFAULT;
	case PCIBIOS_SET_FAILED:
		return -EIO;
	case PCIBIOS_BUFFER_TOO_SMALL:
		return -ENOSPC;
	}

	return -ENOTTY;
}

L
Linus Torvalds 已提交
494 495 496 497 498 499 500
/* Low-level architecture-dependent routines */

struct pci_ops {
	int (*read)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 *val);
	int (*write)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 val);
};

501 502 503 504 505 506 507 508
/*
 * ACPI needs to be able to access PCI config space before we've done a
 * PCI bus scan and created pci_bus structures.
 */
extern int raw_pci_read(unsigned int domain, unsigned int bus,
			unsigned int devfn, int reg, int len, u32 *val);
extern int raw_pci_write(unsigned int domain, unsigned int bus,
			unsigned int devfn, int reg, int len, u32 val);
L
Linus Torvalds 已提交
509 510

struct pci_bus_region {
511 512
	resource_size_t start;
	resource_size_t end;
L
Linus Torvalds 已提交
513 514 515 516 517 518 519
};

struct pci_dynids {
	spinlock_t lock;            /* protects list, index */
	struct list_head list;      /* for IDs added at runtime */
};

520 521
/* ---------------------------------------------------------------- */
/** PCI Error Recovery System (PCI-ERS).  If a PCI device driver provides
522
 *  a set of callbacks in struct pci_error_handlers, then that device driver
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543
 *  will be notified of PCI bus errors, and will be driven to recovery
 *  when an error occurs.
 */

typedef unsigned int __bitwise pci_ers_result_t;

enum pci_ers_result {
	/* no result/none/not supported in device driver */
	PCI_ERS_RESULT_NONE = (__force pci_ers_result_t) 1,

	/* Device driver can recover without slot reset */
	PCI_ERS_RESULT_CAN_RECOVER = (__force pci_ers_result_t) 2,

	/* Device driver wants slot to be reset. */
	PCI_ERS_RESULT_NEED_RESET = (__force pci_ers_result_t) 3,

	/* Device has completely failed, is unrecoverable */
	PCI_ERS_RESULT_DISCONNECT = (__force pci_ers_result_t) 4,

	/* Device driver is fully recovered and operational */
	PCI_ERS_RESULT_RECOVERED = (__force pci_ers_result_t) 5,
544 545 546

	/* No AER capabilities registered for the driver */
	PCI_ERS_RESULT_NO_AER_DRIVER = (__force pci_ers_result_t) 6,
547 548 549
};

/* PCI bus error event callbacks */
550
struct pci_error_handlers {
551 552
	/* PCI bus error detected on this device */
	pci_ers_result_t (*error_detected)(struct pci_dev *dev,
553
					   enum pci_channel_state error);
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569

	/* MMIO has been re-enabled, but not DMA */
	pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev);

	/* PCI Express link has been reset */
	pci_ers_result_t (*link_reset)(struct pci_dev *dev);

	/* PCI slot has been reset */
	pci_ers_result_t (*slot_reset)(struct pci_dev *dev);

	/* Device driver may resume normal operations */
	void (*resume)(struct pci_dev *dev);
};

/* ---------------------------------------------------------------- */

L
Linus Torvalds 已提交
570 571 572
struct module;
struct pci_driver {
	struct list_head node;
573
	const char *name;
L
Linus Torvalds 已提交
574 575 576 577
	const struct pci_device_id *id_table;	/* must be non-NULL for probe to be called */
	int  (*probe)  (struct pci_dev *dev, const struct pci_device_id *id);	/* New device inserted */
	void (*remove) (struct pci_dev *dev);	/* Device removed (NULL if not a hot-plug capable driver) */
	int  (*suspend) (struct pci_dev *dev, pm_message_t state);	/* Device suspended */
L
Linus Torvalds 已提交
578 579
	int  (*suspend_late) (struct pci_dev *dev, pm_message_t state);
	int  (*resume_early) (struct pci_dev *dev);
L
Linus Torvalds 已提交
580
	int  (*resume) (struct pci_dev *dev);	                /* Device woken up */
G
Greg KH 已提交
581
	void (*shutdown) (struct pci_dev *dev);
582
	int (*sriov_configure) (struct pci_dev *dev, int num_vfs); /* PF pdev */
583
	const struct pci_error_handlers *err_handler;
L
Linus Torvalds 已提交
584 585 586 587
	struct device_driver	driver;
	struct pci_dynids dynids;
};

588
#define	to_pci_driver(drv) container_of(drv, struct pci_driver, driver)
L
Linus Torvalds 已提交
589

590
/**
591
 * DEFINE_PCI_DEVICE_TABLE - macro used to describe a pci device table
592 593 594 595 596
 * @_table: device table name
 *
 * This macro is used to create a struct pci_device_id array (a device table)
 * in a generic manner.
 */
597
#define DEFINE_PCI_DEVICE_TABLE(_table) \
B
Bill Pemberton 已提交
598
	const struct pci_device_id _table[]
599

L
Linus Torvalds 已提交
600 601 602 603 604 605 606 607 608 609 610 611 612
/**
 * PCI_DEVICE - macro used to describe a specific pci device
 * @vend: the 16 bit PCI Vendor ID
 * @dev: the 16 bit PCI Device ID
 *
 * This macro is used to create a struct pci_device_id that matches a
 * specific device.  The subvendor and subdevice fields will be set to
 * PCI_ANY_ID.
 */
#define PCI_DEVICE(vend,dev) \
	.vendor = (vend), .device = (dev), \
	.subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID

613 614 615 616 617 618 619 620 621 622 623 624 625 626
/**
 * PCI_DEVICE_SUB - macro used to describe a specific pci device with subsystem
 * @vend: the 16 bit PCI Vendor ID
 * @dev: the 16 bit PCI Device ID
 * @subvend: the 16 bit PCI Subvendor ID
 * @subdev: the 16 bit PCI Subdevice ID
 *
 * This macro is used to create a struct pci_device_id that matches a
 * specific device with subsystem information.
 */
#define PCI_DEVICE_SUB(vend, dev, subvend, subdev) \
	.vendor = (vend), .device = (dev), \
	.subvendor = (subvend), .subdevice = (subdev)

L
Linus Torvalds 已提交
627 628 629 630 631 632
/**
 * PCI_DEVICE_CLASS - macro used to describe a specific pci device class
 * @dev_class: the class, subclass, prog-if triple for this device
 * @dev_class_mask: the class mask for this device
 *
 * This macro is used to create a struct pci_device_id that matches a
633
 * specific PCI class.  The vendor, device, subvendor, and subdevice
L
Linus Torvalds 已提交
634 635 636 637 638 639 640
 * fields will be set to PCI_ANY_ID.
 */
#define PCI_DEVICE_CLASS(dev_class,dev_class_mask) \
	.class = (dev_class), .class_mask = (dev_class_mask), \
	.vendor = PCI_ANY_ID, .device = PCI_ANY_ID, \
	.subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID

641 642
/**
 * PCI_VDEVICE - macro used to describe a specific pci device in short form
643 644
 * @vendor: the vendor name
 * @device: the 16 bit PCI Device ID
645 646 647 648 649 650 651 652 653 654 655
 *
 * This macro is used to create a struct pci_device_id that matches a
 * specific PCI device.  The subvendor, and subdevice fields will be set
 * to PCI_ANY_ID. The macro allows the next field to follow as the device
 * private data.
 */

#define PCI_VDEVICE(vendor, device)		\
	PCI_VENDOR_ID_##vendor, (device),	\
	PCI_ANY_ID, PCI_ANY_ID, 0, 0

L
Linus Torvalds 已提交
656 657 658
/* these external functions are only available when PCI support is enabled */
#ifdef CONFIG_PCI

659 660 661
extern void pcie_bus_configure_settings(struct pci_bus *bus, u8 smpss);

enum pcie_bus_config_types {
662
	PCIE_BUS_TUNE_OFF,
663
	PCIE_BUS_SAFE,
664
	PCIE_BUS_PERFORMANCE,
665 666 667 668 669
	PCIE_BUS_PEER2PEER,
};

extern enum pcie_bus_config_types pcie_bus_config;

L
Linus Torvalds 已提交
670 671 672 673 674
extern struct bus_type pci_bus_type;

/* Do NOT directly access these two variables, unless you are arch specific pci
 * code, or pci core code. */
extern struct list_head pci_root_buses;	/* list of all known PCI buses */
Z
Zhang, Yanmin 已提交
675 676
/* Some device drivers need know if pci is initiated */
extern int no_pci_devices(void);
L
Linus Torvalds 已提交
677

678
void pcibios_resource_survey_bus(struct pci_bus *bus);
L
Linus Torvalds 已提交
679
void pcibios_fixup_bus(struct pci_bus *);
680
int __must_check pcibios_enable_device(struct pci_dev *, int mask);
681
/* Architecture specific versions may override this (weak) */
682
char *pcibios_setup(char *str);
L
Linus Torvalds 已提交
683 684

/* Used only when drivers/pci/setup.c is used */
685
resource_size_t pcibios_align_resource(void *, const struct resource *,
686
				resource_size_t,
687
				resource_size_t);
L
Linus Torvalds 已提交
688 689
void pcibios_update_irq(struct pci_dev *, int irq);

690 691 692
/* Weak but can be overriden by arch */
void pci_fixup_cardbus(struct pci_bus *);

L
Linus Torvalds 已提交
693 694
/* Generic PCI functions used internally */

695 696 697 698
void pcibios_resource_to_bus(struct pci_dev *dev, struct pci_bus_region *region,
			     struct resource *res);
void pcibios_bus_to_resource(struct pci_dev *dev, struct resource *res,
			     struct pci_bus_region *region);
699
void pcibios_scan_specific_bus(int busn);
L
Linus Torvalds 已提交
700
extern struct pci_bus *pci_find_bus(int domain, int busnr);
701
void pci_bus_add_devices(const struct pci_bus *bus);
702 703
struct pci_bus *pci_scan_bus_parented(struct device *parent, int bus,
				      struct pci_ops *ops, void *sysdata);
704
struct pci_bus *pci_scan_bus(int bus, struct pci_ops *ops, void *sysdata);
705 706 707
struct pci_bus *pci_create_root_bus(struct device *parent, int bus,
				    struct pci_ops *ops, void *sysdata,
				    struct list_head *resources);
708 709 710
int pci_bus_insert_busn_res(struct pci_bus *b, int bus, int busmax);
int pci_bus_update_busn_res_end(struct pci_bus *b, int busmax);
void pci_bus_release_busn_res(struct pci_bus *b);
B
Bill Pemberton 已提交
711
struct pci_bus *pci_scan_root_bus(struct device *parent, int bus,
712 713
					     struct pci_ops *ops, void *sysdata,
					     struct list_head *resources);
714 715
struct pci_bus *pci_add_new_bus(struct pci_bus *parent, struct pci_dev *dev,
				int busnr);
716
void pcie_update_link_speed(struct pci_bus *bus, u16 link_status);
A
Alex Chiang 已提交
717
struct pci_slot *pci_create_slot(struct pci_bus *parent, int slot_nr,
718 719
				 const char *name,
				 struct hotplug_slot *hotplug);
A
Alex Chiang 已提交
720
void pci_destroy_slot(struct pci_slot *slot);
721
void pci_renumber_slot(struct pci_slot *slot, int slot_nr);
L
Linus Torvalds 已提交
722
int pci_scan_slot(struct pci_bus *bus, int devfn);
723
struct pci_dev *pci_scan_single_device(struct pci_bus *bus, int devfn);
724
void pci_device_add(struct pci_dev *dev, struct pci_bus *bus);
L
Linus Torvalds 已提交
725
unsigned int pci_scan_child_bus(struct pci_bus *bus);
726
int __must_check pci_bus_add_device(struct pci_dev *dev);
L
Linus Torvalds 已提交
727
void pci_read_bridge_bases(struct pci_bus *child);
728 729
struct resource *pci_find_parent_resource(const struct pci_dev *dev,
					  struct resource *res);
730
u8 pci_swizzle_interrupt_pin(const struct pci_dev *dev, u8 pin);
L
Linus Torvalds 已提交
731
int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge);
732
u8 pci_common_swizzle(struct pci_dev *dev, u8 *pinp);
L
Linus Torvalds 已提交
733 734 735
extern struct pci_dev *pci_dev_get(struct pci_dev *dev);
extern void pci_dev_put(struct pci_dev *dev);
extern void pci_remove_bus(struct pci_bus *b);
736
extern void pci_stop_and_remove_bus_device(struct pci_dev *dev);
737 738
void pci_stop_root_bus(struct pci_bus *bus);
void pci_remove_root_bus(struct pci_bus *bus);
739
void pci_setup_cardbus(struct pci_bus *bus);
740
extern void pci_sort_breadthfirst(void);
741 742 743
#define dev_is_pci(d) ((d)->bus == &pci_bus_type)
#define dev_is_pf(d) ((dev_is_pci(d) ? to_pci_dev(d)->is_physfn : false))
#define dev_num_vf(d) ((dev_is_pci(d) ? pci_num_vf(to_pci_dev(d)) : 0))
L
Linus Torvalds 已提交
744 745 746

/* Generic PCI functions exported to card drivers */

747 748 749 750 751 752 753
enum pci_lost_interrupt_reason {
	PCI_LOST_IRQ_NO_INFORMATION = 0,
	PCI_LOST_IRQ_DISABLE_MSI,
	PCI_LOST_IRQ_DISABLE_MSIX,
	PCI_LOST_IRQ_DISABLE_ACPI,
};
enum pci_lost_interrupt_reason pci_lost_interrupt(struct pci_dev *dev);
754 755 756
int pci_find_capability(struct pci_dev *dev, int cap);
int pci_find_next_capability(struct pci_dev *dev, u8 pos, int cap);
int pci_find_ext_capability(struct pci_dev *dev, int cap);
757
int pci_find_next_ext_capability(struct pci_dev *dev, int pos, int cap);
758 759
int pci_find_ht_capability(struct pci_dev *dev, int ht_cap);
int pci_find_next_ht_capability(struct pci_dev *dev, int pos, int ht_cap);
A
Alan Cox 已提交
760
struct pci_bus *pci_find_next_bus(const struct pci_bus *from);
L
Linus Torvalds 已提交
761

762 763
struct pci_dev *pci_get_device(unsigned int vendor, unsigned int device,
				struct pci_dev *from);
764
struct pci_dev *pci_get_subsys(unsigned int vendor, unsigned int device,
L
Linus Torvalds 已提交
765
				unsigned int ss_vendor, unsigned int ss_device,
766
				struct pci_dev *from);
767
struct pci_dev *pci_get_slot(struct pci_bus *bus, unsigned int devfn);
768 769 770 771 772 773 774
struct pci_dev *pci_get_domain_bus_and_slot(int domain, unsigned int bus,
					    unsigned int devfn);
static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
						   unsigned int devfn)
{
	return pci_get_domain_bus_and_slot(0, bus, devfn);
}
775
struct pci_dev *pci_get_class(unsigned int class, struct pci_dev *from);
L
Linus Torvalds 已提交
776 777
int pci_dev_present(const struct pci_device_id *ids);

778 779 780 781 782 783 784 785 786 787 788 789
int pci_bus_read_config_byte(struct pci_bus *bus, unsigned int devfn,
			     int where, u8 *val);
int pci_bus_read_config_word(struct pci_bus *bus, unsigned int devfn,
			     int where, u16 *val);
int pci_bus_read_config_dword(struct pci_bus *bus, unsigned int devfn,
			      int where, u32 *val);
int pci_bus_write_config_byte(struct pci_bus *bus, unsigned int devfn,
			      int where, u8 val);
int pci_bus_write_config_word(struct pci_bus *bus, unsigned int devfn,
			      int where, u16 val);
int pci_bus_write_config_dword(struct pci_bus *bus, unsigned int devfn,
			       int where, u32 val);
H
Huang Ying 已提交
790
struct pci_ops *pci_bus_set_ops(struct pci_bus *bus, struct pci_ops *ops);
L
Linus Torvalds 已提交
791

792
static inline int pci_read_config_byte(const struct pci_dev *dev, int where, u8 *val)
L
Linus Torvalds 已提交
793
{
794
	return pci_bus_read_config_byte(dev->bus, dev->devfn, where, val);
L
Linus Torvalds 已提交
795
}
796
static inline int pci_read_config_word(const struct pci_dev *dev, int where, u16 *val)
L
Linus Torvalds 已提交
797
{
798
	return pci_bus_read_config_word(dev->bus, dev->devfn, where, val);
L
Linus Torvalds 已提交
799
}
800
static inline int pci_read_config_dword(const struct pci_dev *dev, int where,
801
					u32 *val)
L
Linus Torvalds 已提交
802
{
803
	return pci_bus_read_config_dword(dev->bus, dev->devfn, where, val);
L
Linus Torvalds 已提交
804
}
805
static inline int pci_write_config_byte(const struct pci_dev *dev, int where, u8 val)
L
Linus Torvalds 已提交
806
{
807
	return pci_bus_write_config_byte(dev->bus, dev->devfn, where, val);
L
Linus Torvalds 已提交
808
}
809
static inline int pci_write_config_word(const struct pci_dev *dev, int where, u16 val)
L
Linus Torvalds 已提交
810
{
811
	return pci_bus_write_config_word(dev->bus, dev->devfn, where, val);
L
Linus Torvalds 已提交
812
}
813
static inline int pci_write_config_dword(const struct pci_dev *dev, int where,
814
					 u32 val)
L
Linus Torvalds 已提交
815
{
816
	return pci_bus_write_config_dword(dev->bus, dev->devfn, where, val);
L
Linus Torvalds 已提交
817 818
}

819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
int pcie_capability_read_word(struct pci_dev *dev, int pos, u16 *val);
int pcie_capability_read_dword(struct pci_dev *dev, int pos, u32 *val);
int pcie_capability_write_word(struct pci_dev *dev, int pos, u16 val);
int pcie_capability_write_dword(struct pci_dev *dev, int pos, u32 val);
int pcie_capability_clear_and_set_word(struct pci_dev *dev, int pos,
				       u16 clear, u16 set);
int pcie_capability_clear_and_set_dword(struct pci_dev *dev, int pos,
					u32 clear, u32 set);

static inline int pcie_capability_set_word(struct pci_dev *dev, int pos,
					   u16 set)
{
	return pcie_capability_clear_and_set_word(dev, pos, 0, set);
}

static inline int pcie_capability_set_dword(struct pci_dev *dev, int pos,
					    u32 set)
{
	return pcie_capability_clear_and_set_dword(dev, pos, 0, set);
}

static inline int pcie_capability_clear_word(struct pci_dev *dev, int pos,
					     u16 clear)
{
	return pcie_capability_clear_and_set_word(dev, pos, clear, 0);
}

static inline int pcie_capability_clear_dword(struct pci_dev *dev, int pos,
					      u32 clear)
{
	return pcie_capability_clear_and_set_dword(dev, pos, clear, 0);
}

852 853 854 855 856 857 858 859
/* user-space driven config access */
int pci_user_read_config_byte(struct pci_dev *dev, int where, u8 *val);
int pci_user_read_config_word(struct pci_dev *dev, int where, u16 *val);
int pci_user_read_config_dword(struct pci_dev *dev, int where, u32 *val);
int pci_user_write_config_byte(struct pci_dev *dev, int where, u8 val);
int pci_user_write_config_word(struct pci_dev *dev, int where, u16 val);
int pci_user_write_config_dword(struct pci_dev *dev, int where, u32 val);

860
int __must_check pci_enable_device(struct pci_dev *dev);
861 862
int __must_check pci_enable_device_io(struct pci_dev *dev);
int __must_check pci_enable_device_mem(struct pci_dev *dev);
863
int __must_check pci_reenable_device(struct pci_dev *);
T
Tejun Heo 已提交
864 865 866
int __must_check pcim_enable_device(struct pci_dev *pdev);
void pcim_pin_device(struct pci_dev *pdev);

867 868 869 870 871
static inline int pci_is_enabled(struct pci_dev *pdev)
{
	return (atomic_read(&pdev->enable_cnt) > 0);
}

T
Tejun Heo 已提交
872 873 874 875 876
static inline int pci_is_managed(struct pci_dev *pdev)
{
	return pdev->is_managed;
}

L
Linus Torvalds 已提交
877
void pci_disable_device(struct pci_dev *dev);
878 879

extern unsigned int pcibios_max_latency;
L
Linus Torvalds 已提交
880
void pci_set_master(struct pci_dev *dev);
881
void pci_clear_master(struct pci_dev *dev);
882

B
Brian King 已提交
883
int pci_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state);
T
Tejun Heo 已提交
884
int pci_set_cacheline_size(struct pci_dev *dev);
L
Linus Torvalds 已提交
885
#define HAVE_PCI_SET_MWI
886
int __must_check pci_set_mwi(struct pci_dev *dev);
R
Randy Dunlap 已提交
887
int pci_try_set_mwi(struct pci_dev *dev);
L
Linus Torvalds 已提交
888
void pci_clear_mwi(struct pci_dev *dev);
B
Brett M Russ 已提交
889
void pci_intx(struct pci_dev *dev, int enable);
890 891 892
bool pci_intx_mask_supported(struct pci_dev *dev);
bool pci_check_and_mask_intx(struct pci_dev *dev);
bool pci_check_and_unmask_intx(struct pci_dev *dev);
893
void pci_msi_off(struct pci_dev *dev);
894
int pci_set_dma_max_seg_size(struct pci_dev *dev, unsigned int size);
895
int pci_set_dma_seg_boundary(struct pci_dev *dev, unsigned long mask);
896 897 898
int pcix_get_max_mmrbc(struct pci_dev *dev);
int pcix_get_mmrbc(struct pci_dev *dev);
int pcix_set_mmrbc(struct pci_dev *dev, int mmrbc);
899
int pcie_get_readrq(struct pci_dev *dev);
900
int pcie_set_readrq(struct pci_dev *dev, int rq);
901 902
int pcie_get_mps(struct pci_dev *dev);
int pcie_set_mps(struct pci_dev *dev, int mps);
Y
Yu Zhao 已提交
903
int __pci_reset_function(struct pci_dev *dev);
904
int __pci_reset_function_locked(struct pci_dev *dev);
905
int pci_reset_function(struct pci_dev *dev);
906
void pci_update_resource(struct pci_dev *dev, int resno);
907
int __must_check pci_assign_resource(struct pci_dev *dev, int i);
908
int __must_check pci_reassign_resource(struct pci_dev *dev, int i, resource_size_t add_size, resource_size_t align);
909
int pci_select_bars(struct pci_dev *dev, unsigned long flags);
L
Linus Torvalds 已提交
910 911

/* ROM control related routines */
A
Alan Cox 已提交
912 913
int pci_enable_rom(struct pci_dev *pdev);
void pci_disable_rom(struct pci_dev *pdev);
914
void __iomem __must_check *pci_map_rom(struct pci_dev *pdev, size_t *size);
L
Linus Torvalds 已提交
915
void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom);
916
size_t pci_get_rom_size(struct pci_dev *pdev, void __iomem *rom, size_t size);
L
Linus Torvalds 已提交
917 918 919

/* Power management related routines */
int pci_save_state(struct pci_dev *dev);
920
void pci_restore_state(struct pci_dev *dev);
921 922 923 924
struct pci_saved_state *pci_store_saved_state(struct pci_dev *dev);
int pci_load_saved_state(struct pci_dev *dev, struct pci_saved_state *state);
int pci_load_and_free_saved_state(struct pci_dev *dev,
				  struct pci_saved_state **state);
925
int __pci_complete_power_transition(struct pci_dev *dev, pci_power_t state);
926 927
int pci_set_power_state(struct pci_dev *dev, pci_power_t state);
pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state);
928
bool pci_pme_capable(struct pci_dev *dev, pci_power_t state);
929
void pci_pme_active(struct pci_dev *dev, bool enable);
930 931
int __pci_enable_wake(struct pci_dev *dev, pci_power_t state,
		      bool runtime, bool enable);
932
int pci_wake_from_d3(struct pci_dev *dev, bool enable);
933
pci_power_t pci_target_state(struct pci_dev *dev);
934 935
int pci_prepare_to_sleep(struct pci_dev *dev);
int pci_back_from_sleep(struct pci_dev *dev);
936
bool pci_dev_run_wake(struct pci_dev *dev);
937 938
bool pci_check_pme_status(struct pci_dev *dev);
void pci_pme_wakeup_bus(struct pci_bus *bus);
L
Linus Torvalds 已提交
939

940 941 942 943 944
static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
				  bool enable)
{
	return __pci_enable_wake(dev, state, false, enable);
}
L
Linus Torvalds 已提交
945

946 947 948 949 950
#define PCI_EXP_IDO_REQUEST	(1<<0)
#define PCI_EXP_IDO_COMPLETION	(1<<1)
void pci_enable_ido(struct pci_dev *dev, unsigned long type);
void pci_disable_ido(struct pci_dev *dev, unsigned long type);

951
enum pci_obff_signal_type {
952 953
	PCI_EXP_OBFF_SIGNAL_L0 = 0,
	PCI_EXP_OBFF_SIGNAL_ALWAYS = 1,
954 955 956 957
};
int pci_enable_obff(struct pci_dev *dev, enum pci_obff_signal_type);
void pci_disable_obff(struct pci_dev *dev);

958 959 960 961
int pci_enable_ltr(struct pci_dev *dev);
void pci_disable_ltr(struct pci_dev *dev);
int pci_set_ltr(struct pci_dev *dev, int snoop_lat_ns, int nosnoop_lat_ns);

962 963 964 965
/* For use by arch with custom probe code */
void set_pcie_port_type(struct pci_dev *pdev);
void set_pcie_hotplug_bridge(struct pci_dev *pdev);

966
/* Functions for PCI Hotplug drivers to use */
967
int pci_bus_find_capability(struct pci_bus *bus, unsigned int devfn, int cap);
968
unsigned int pci_rescan_bus_bridge_resize(struct pci_dev *bridge);
A
Alex Chiang 已提交
969
unsigned int pci_rescan_bus(struct pci_bus *bus);
970

971 972 973
/* Vital product data routines */
ssize_t pci_read_vpd(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
ssize_t pci_write_vpd(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
974
int pci_vpd_truncate(struct pci_dev *dev, size_t size);
975

L
Linus Torvalds 已提交
976
/* Helper functions for low-level code (drivers/pci/setup-[bus,res].c) */
977
resource_size_t pcibios_retrieve_fw_addr(struct pci_dev *dev, int idx);
978
void pci_bus_assign_resources(const struct pci_bus *bus);
L
Linus Torvalds 已提交
979 980 981
void pci_bus_size_bridges(struct pci_bus *bus);
int pci_claim_resource(struct pci_dev *, int);
void pci_assign_unassigned_resources(void);
982
void pci_assign_unassigned_bridge_resources(struct pci_dev *bridge);
983
void pci_assign_unassigned_bus_resources(struct pci_bus *bus);
L
Linus Torvalds 已提交
984
void pdev_enable_device(struct pci_dev *);
985
int pci_enable_resources(struct pci_dev *, int mask);
L
Linus Torvalds 已提交
986
void pci_fixup_irqs(u8 (*)(struct pci_dev *, u8 *),
987
		    int (*)(const struct pci_dev *, u8, u8));
L
Linus Torvalds 已提交
988
#define HAVE_PCI_REQ_REGIONS	2
989
int __must_check pci_request_regions(struct pci_dev *, const char *);
990
int __must_check pci_request_regions_exclusive(struct pci_dev *, const char *);
L
Linus Torvalds 已提交
991
void pci_release_regions(struct pci_dev *);
992
int __must_check pci_request_region(struct pci_dev *, int, const char *);
993
int __must_check pci_request_region_exclusive(struct pci_dev *, int, const char *);
L
Linus Torvalds 已提交
994
void pci_release_region(struct pci_dev *, int);
995
int pci_request_selected_regions(struct pci_dev *, int, const char *);
996
int pci_request_selected_regions_exclusive(struct pci_dev *, int, const char *);
997
void pci_release_selected_regions(struct pci_dev *, int);
L
Linus Torvalds 已提交
998 999

/* drivers/pci/bus.c */
1000
void pci_add_resource(struct list_head *resources, struct resource *res);
1001 1002
void pci_add_resource_offset(struct list_head *resources, struct resource *res,
			     resource_size_t offset);
1003
void pci_free_resource_list(struct list_head *resources);
1004 1005 1006 1007
void pci_bus_add_resource(struct pci_bus *bus, struct resource *res, unsigned int flags);
struct resource *pci_bus_resource_n(const struct pci_bus *bus, int n);
void pci_bus_remove_resources(struct pci_bus *bus);

1008
#define pci_bus_for_each_resource(bus, res, i)				\
1009 1010 1011
	for (i = 0;							\
	    (res = pci_bus_resource_n(bus, i)) || i < PCI_BRIDGE_RESOURCE_NUM; \
	     i++)
1012

1013 1014 1015 1016
int __must_check pci_bus_alloc_resource(struct pci_bus *bus,
			struct resource *res, resource_size_t size,
			resource_size_t align, resource_size_t min,
			unsigned int type_mask,
1017 1018
			resource_size_t (*alignf)(void *,
						  const struct resource *,
1019 1020
						  resource_size_t,
						  resource_size_t),
1021
			void *alignf_data);
L
Linus Torvalds 已提交
1022 1023
void pci_enable_bridges(struct pci_bus *bus);

1024
/* Proper probing supporting hot-pluggable devices */
1025 1026
int __must_check __pci_register_driver(struct pci_driver *, struct module *,
				       const char *mod_name);
1027 1028 1029 1030 1031 1032

/*
 * pci_register_driver must be a macro so that KBUILD_MODNAME can be expanded
 */
#define pci_register_driver(driver)		\
	__pci_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
1033

1034
void pci_unregister_driver(struct pci_driver *dev);
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047

/**
 * module_pci_driver() - Helper macro for registering a PCI driver
 * @__pci_driver: pci_driver struct
 *
 * Helper macro for PCI drivers which do not do anything special in module
 * init/exit. This eliminates a lot of boilerplate. Each module may only
 * use this macro once, and calling it replaces module_init() and module_exit()
 */
#define module_pci_driver(__pci_driver) \
	module_driver(__pci_driver, pci_register_driver, \
		       pci_unregister_driver)

1048
struct pci_driver *pci_dev_driver(const struct pci_dev *dev);
T
Tejun Heo 已提交
1049 1050 1051 1052 1053
int pci_add_dynid(struct pci_driver *drv,
		  unsigned int vendor, unsigned int device,
		  unsigned int subvendor, unsigned int subdevice,
		  unsigned int class, unsigned int class_mask,
		  unsigned long driver_data);
1054 1055 1056 1057
const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
					 struct pci_dev *dev);
int pci_scan_bridge(struct pci_bus *bus, struct pci_dev *dev, int max,
		    int pass);
L
Linus Torvalds 已提交
1058

1059
void pci_walk_bus(struct pci_bus *top, int (*cb)(struct pci_dev *, void *),
1060
		  void *userdata);
1061
int pci_cfg_space_size_ext(struct pci_dev *dev);
1062
int pci_cfg_space_size(struct pci_dev *dev);
1063
unsigned char pci_bus_max_busnr(struct pci_bus *bus);
1064
void pci_setup_bridge(struct pci_bus *bus);
1065 1066
resource_size_t pcibios_window_alignment(struct pci_bus *bus,
					 unsigned long type);
1067

1068 1069 1070
#define PCI_VGA_STATE_CHANGE_BRIDGE (1 << 0)
#define PCI_VGA_STATE_CHANGE_DECODES (1 << 1)

1071
int pci_set_vga_state(struct pci_dev *pdev, bool decode,
1072
		      unsigned int command_bits, u32 flags);
L
Linus Torvalds 已提交
1073 1074
/* kmem_cache style wrapper around pci_alloc_consistent() */

1075
#include <linux/pci-dma.h>
L
Linus Torvalds 已提交
1076 1077 1078 1079 1080 1081 1082 1083 1084
#include <linux/dmapool.h>

#define	pci_pool dma_pool
#define pci_pool_create(name, pdev, size, align, allocation) \
		dma_pool_create(name, &pdev->dev, size, align, allocation)
#define	pci_pool_destroy(pool) dma_pool_destroy(pool)
#define	pci_pool_alloc(pool, flags, handle) dma_pool_alloc(pool, flags, handle)
#define	pci_pool_free(pool, vaddr, addr) dma_pool_free(pool, vaddr, addr)

1085 1086 1087 1088 1089 1090 1091 1092 1093
enum pci_dma_burst_strategy {
	PCI_DMA_BURST_INFINITY,	/* make bursts as large as possible,
				   strategy_parameter is N/A */
	PCI_DMA_BURST_BOUNDARY, /* disconnect at every strategy_parameter
				   byte boundaries */
	PCI_DMA_BURST_MULTIPLE, /* disconnect at some multiple of
				   strategy_parameter byte boundaries */
};

L
Linus Torvalds 已提交
1094
struct msix_entry {
Y
Yinghai Lu 已提交
1095
	u32	vector;	/* kernel uses to write allocated vector */
L
Linus Torvalds 已提交
1096 1097 1098
	u16	entry;	/* driver uses to specify entry, OS writes */
};

1099

L
Linus Torvalds 已提交
1100
#ifndef CONFIG_PCI_MSI
1101
static inline int pci_enable_msi_block(struct pci_dev *dev, unsigned int nvec)
1102 1103 1104 1105
{
	return -1;
}

1106 1107
static inline void pci_msi_shutdown(struct pci_dev *dev)
{ }
1108 1109 1110
static inline void pci_disable_msi(struct pci_dev *dev)
{ }

1111 1112 1113 1114
static inline int pci_msix_table_size(struct pci_dev *dev)
{
	return 0;
}
1115 1116 1117 1118 1119 1120
static inline int pci_enable_msix(struct pci_dev *dev,
				  struct msix_entry *entries, int nvec)
{
	return -1;
}

1121 1122
static inline void pci_msix_shutdown(struct pci_dev *dev)
{ }
1123 1124 1125 1126 1127 1128 1129 1130
static inline void pci_disable_msix(struct pci_dev *dev)
{ }

static inline void msi_remove_pci_irq_vectors(struct pci_dev *dev)
{ }

static inline void pci_restore_msi_state(struct pci_dev *dev)
{ }
1131 1132 1133 1134
static inline int pci_msi_enabled(void)
{
	return 0;
}
L
Linus Torvalds 已提交
1135
#else
1136
extern int pci_enable_msi_block(struct pci_dev *dev, unsigned int nvec);
1137
extern void pci_msi_shutdown(struct pci_dev *dev);
L
Linus Torvalds 已提交
1138
extern void pci_disable_msi(struct pci_dev *dev);
1139
extern int pci_msix_table_size(struct pci_dev *dev);
1140
extern int pci_enable_msix(struct pci_dev *dev,
L
Linus Torvalds 已提交
1141
	struct msix_entry *entries, int nvec);
1142
extern void pci_msix_shutdown(struct pci_dev *dev);
L
Linus Torvalds 已提交
1143 1144
extern void pci_disable_msix(struct pci_dev *dev);
extern void msi_remove_pci_irq_vectors(struct pci_dev *dev);
1145
extern void pci_restore_msi_state(struct pci_dev *dev);
1146
extern int pci_msi_enabled(void);
L
Linus Torvalds 已提交
1147 1148
#endif

1149
#ifdef CONFIG_PCIEPORTBUS
1150 1151
extern bool pcie_ports_disabled;
extern bool pcie_ports_auto;
1152 1153 1154 1155
#else
#define pcie_ports_disabled	true
#define pcie_ports_auto		false
#endif
1156

1157
#ifndef CONFIG_PCIEASPM
1158 1159
static inline int pcie_aspm_enabled(void) { return 0; }
static inline bool pcie_aspm_support_enabled(void) { return false; }
1160 1161
#else
extern int pcie_aspm_enabled(void);
1162
extern bool pcie_aspm_support_enabled(void);
1163 1164
#endif

1165 1166 1167 1168 1169 1170 1171 1172
#ifdef CONFIG_PCIEAER
void pci_no_aer(void);
bool pci_aer_available(void);
#else
static inline void pci_no_aer(void) { }
static inline bool pci_aer_available(void) { return false; }
#endif

1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183
#ifndef CONFIG_PCIE_ECRC
static inline void pcie_set_ecrc_checking(struct pci_dev *dev)
{
	return;
}
static inline void pcie_ecrc_get_policy(char *str) {};
#else
extern void pcie_set_ecrc_checking(struct pci_dev *dev);
extern void pcie_ecrc_get_policy(char *str);
#endif

1184 1185
#define pci_enable_msi(pdev)	pci_enable_msi_block(pdev, 1)

1186 1187 1188 1189 1190 1191
#ifdef CONFIG_HT_IRQ
/* The functions a driver should call */
int  ht_create_irq(struct pci_dev *dev, int idx);
void ht_destroy_irq(unsigned int irq);
#endif /* CONFIG_HT_IRQ */

1192 1193 1194
extern void pci_cfg_access_lock(struct pci_dev *dev);
extern bool pci_cfg_access_trylock(struct pci_dev *dev);
extern void pci_cfg_access_unlock(struct pci_dev *dev);
1195

1196 1197 1198 1199 1200
/*
 * PCI domain support.  Sometimes called PCI segment (eg by ACPI),
 * a PCI domain is defined to be a set of PCI busses which share
 * configuration space.
 */
1201 1202 1203 1204
#ifdef CONFIG_PCI_DOMAINS
extern int pci_domains_supported;
#else
enum { pci_domains_supported = 0 };
1205 1206 1207 1208 1209
static inline int pci_domain_nr(struct pci_bus *bus)
{
	return 0;
}

1210 1211 1212 1213
static inline int pci_proc_domain(struct pci_bus *bus)
{
	return 0;
}
1214
#endif /* CONFIG_PCI_DOMAINS */
L
Linus Torvalds 已提交
1215

1216 1217
/* some architectures require additional setup to direct VGA traffic */
typedef int (*arch_set_vga_state_t)(struct pci_dev *pdev, bool decode,
1218
		      unsigned int command_bits, u32 flags);
1219 1220
extern void pci_register_set_vga_state(arch_set_vga_state_t func);

1221
#else /* CONFIG_PCI is not enabled */
L
Linus Torvalds 已提交
1222 1223 1224 1225 1226 1227

/*
 *  If the system does not have PCI, clearly these return errors.  Define
 *  these as simple inline functions to avoid hair in drivers.
 */

1228 1229 1230
#define _PCI_NOP(o, s, t) \
	static inline int pci_##o##_config_##s(struct pci_dev *dev, \
						int where, t val) \
L
Linus Torvalds 已提交
1231
		{ return PCIBIOS_FUNC_NOT_SUPPORTED; }
1232 1233 1234 1235

#define _PCI_NOP_ALL(o, x)	_PCI_NOP(o, byte, u8 x) \
				_PCI_NOP(o, word, u16 x) \
				_PCI_NOP(o, dword, u32 x)
L
Linus Torvalds 已提交
1236 1237 1238
_PCI_NOP_ALL(read, *)
_PCI_NOP_ALL(write,)

1239
static inline struct pci_dev *pci_get_device(unsigned int vendor,
1240 1241 1242 1243 1244
					     unsigned int device,
					     struct pci_dev *from)
{
	return NULL;
}
1245

1246 1247 1248 1249
static inline struct pci_dev *pci_get_subsys(unsigned int vendor,
					     unsigned int device,
					     unsigned int ss_vendor,
					     unsigned int ss_device,
1250
					     struct pci_dev *from)
1251 1252 1253
{
	return NULL;
}
L
Linus Torvalds 已提交
1254

1255 1256 1257 1258 1259
static inline struct pci_dev *pci_get_class(unsigned int class,
					    struct pci_dev *from)
{
	return NULL;
}
L
Linus Torvalds 已提交
1260 1261

#define pci_dev_present(ids)	(0)
Z
Zhang, Yanmin 已提交
1262
#define no_pci_devices()	(1)
L
Linus Torvalds 已提交
1263 1264
#define pci_dev_put(dev)	do { } while (0)

1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280
static inline void pci_set_master(struct pci_dev *dev)
{ }

static inline int pci_enable_device(struct pci_dev *dev)
{
	return -EIO;
}

static inline void pci_disable_device(struct pci_dev *dev)
{ }

static inline int pci_set_dma_mask(struct pci_dev *dev, u64 mask)
{
	return -EIO;
}

1281 1282 1283 1284 1285
static inline int pci_set_consistent_dma_mask(struct pci_dev *dev, u64 mask)
{
	return -EIO;
}

1286 1287 1288 1289 1290 1291
static inline int pci_set_dma_max_seg_size(struct pci_dev *dev,
					unsigned int size)
{
	return -EIO;
}

1292 1293 1294 1295 1296 1297
static inline int pci_set_dma_seg_boundary(struct pci_dev *dev,
					unsigned long mask)
{
	return -EIO;
}

1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332
static inline int pci_assign_resource(struct pci_dev *dev, int i)
{
	return -EBUSY;
}

static inline int __pci_register_driver(struct pci_driver *drv,
					struct module *owner)
{
	return 0;
}

static inline int pci_register_driver(struct pci_driver *drv)
{
	return 0;
}

static inline void pci_unregister_driver(struct pci_driver *drv)
{ }

static inline int pci_find_capability(struct pci_dev *dev, int cap)
{
	return 0;
}

static inline int pci_find_next_capability(struct pci_dev *dev, u8 post,
					   int cap)
{
	return 0;
}

static inline int pci_find_ext_capability(struct pci_dev *dev, int cap)
{
	return 0;
}

L
Linus Torvalds 已提交
1333
/* Power management related routines */
1334 1335 1336 1337 1338
static inline int pci_save_state(struct pci_dev *dev)
{
	return 0;
}

1339 1340
static inline void pci_restore_state(struct pci_dev *dev)
{ }
L
Linus Torvalds 已提交
1341

1342 1343 1344 1345 1346
static inline int pci_set_power_state(struct pci_dev *dev, pci_power_t state)
{
	return 0;
}

1347 1348 1349 1350 1351
static inline int pci_wake_from_d3(struct pci_dev *dev, bool enable)
{
	return 0;
}

1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363
static inline pci_power_t pci_choose_state(struct pci_dev *dev,
					   pm_message_t state)
{
	return PCI_D0;
}

static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
				  int enable)
{
	return 0;
}

1364 1365 1366 1367 1368 1369 1370 1371
static inline void pci_enable_ido(struct pci_dev *dev, unsigned long type)
{
}

static inline void pci_disable_ido(struct pci_dev *dev, unsigned long type)
{
}

1372 1373 1374 1375 1376 1377 1378 1379 1380
static inline int pci_enable_obff(struct pci_dev *dev, unsigned long type)
{
	return 0;
}

static inline void pci_disable_obff(struct pci_dev *dev)
{
}

1381 1382 1383 1384 1385 1386 1387
static inline int pci_request_regions(struct pci_dev *dev, const char *res_name)
{
	return -EIO;
}

static inline void pci_release_regions(struct pci_dev *dev)
{ }
1388

1389 1390
#define pci_dma_burst_advice(pdev, strat, strategy_parameter) do { } while (0)

1391
static inline void pci_block_cfg_access(struct pci_dev *dev)
1392 1393
{ }

1394 1395 1396 1397
static inline int pci_block_cfg_access_in_atomic(struct pci_dev *dev)
{ return 0; }

static inline void pci_unblock_cfg_access(struct pci_dev *dev)
1398
{ }
1399

R
Randy Dunlap 已提交
1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410
static inline struct pci_bus *pci_find_next_bus(const struct pci_bus *from)
{ return NULL; }

static inline struct pci_dev *pci_get_slot(struct pci_bus *bus,
						unsigned int devfn)
{ return NULL; }

static inline struct pci_dev *pci_get_bus_and_slot(unsigned int bus,
						unsigned int devfn)
{ return NULL; }

1411 1412 1413
static inline int pci_domain_nr(struct pci_bus *bus)
{ return 0; }

1414 1415 1416
static inline struct pci_dev *pci_dev_get(struct pci_dev *dev)
{ return NULL; }

1417 1418 1419
#define dev_is_pci(d) (false)
#define dev_is_pf(d) (false)
#define dev_num_vf(d) (0)
1420
#endif /* CONFIG_PCI */
L
Linus Torvalds 已提交
1421

1422 1423 1424
/* Include architecture-dependent settings and functions */

#include <asm/pci.h>
L
Linus Torvalds 已提交
1425

1426 1427 1428 1429
#ifndef PCIBIOS_MAX_MEM_32
#define PCIBIOS_MAX_MEM_32 (-1)
#endif

L
Linus Torvalds 已提交
1430 1431
/* these helpers provide future and backwards compatibility
 * for accessing popular PCI BAR info */
1432 1433 1434
#define pci_resource_start(dev, bar)	((dev)->resource[(bar)].start)
#define pci_resource_end(dev, bar)	((dev)->resource[(bar)].end)
#define pci_resource_flags(dev, bar)	((dev)->resource[(bar)].flags)
L
Linus Torvalds 已提交
1435
#define pci_resource_len(dev,bar) \
1436 1437 1438 1439 1440 1441
	((pci_resource_start((dev), (bar)) == 0 &&	\
	  pci_resource_end((dev), (bar)) ==		\
	  pci_resource_start((dev), (bar))) ? 0 :	\
							\
	 (pci_resource_end((dev), (bar)) -		\
	  pci_resource_start((dev), (bar)) + 1))
L
Linus Torvalds 已提交
1442 1443 1444 1445 1446

/* Similar to the helpers above, these manipulate per-pci_dev
 * driver-specific data.  They are really just a wrapper around
 * the generic device structure functions of these calls.
 */
1447
static inline void *pci_get_drvdata(struct pci_dev *pdev)
L
Linus Torvalds 已提交
1448 1449 1450 1451
{
	return dev_get_drvdata(&pdev->dev);
}

1452
static inline void pci_set_drvdata(struct pci_dev *pdev, void *data)
L
Linus Torvalds 已提交
1453 1454 1455 1456 1457 1458 1459
{
	dev_set_drvdata(&pdev->dev, data);
}

/* If you want to know what to call your pci_dev, ask this function.
 * Again, it's a wrapper around the generic device.
 */
1460
static inline const char *pci_name(const struct pci_dev *pdev)
L
Linus Torvalds 已提交
1461
{
G
Greg KH 已提交
1462
	return dev_name(&pdev->dev);
L
Linus Torvalds 已提交
1463 1464
}

1465 1466 1467 1468 1469 1470

/* Some archs don't want to expose struct resource to userland as-is
 * in sysfs and /proc
 */
#ifndef HAVE_ARCH_PCI_RESOURCE_TO_USER
static inline void pci_resource_to_user(const struct pci_dev *dev, int bar,
1471
		const struct resource *rsrc, resource_size_t *start,
1472
		resource_size_t *end)
1473 1474 1475 1476 1477 1478 1479
{
	*start = rsrc->start;
	*end = rsrc->end;
}
#endif /* HAVE_ARCH_PCI_RESOURCE_TO_USER */


L
Linus Torvalds 已提交
1480 1481 1482 1483 1484 1485 1486 1487
/*
 *  The world is not perfect and supplies us with broken PCI devices.
 *  For at least a part of these bugs we need a work-around, so both
 *  generic (drivers/pci/quirks.c) and per-architecture code can define
 *  fixup hooks to be called for particular buggy devices.
 */

struct pci_fixup {
1488 1489 1490 1491
	u16 vendor;		/* You can use PCI_ANY_ID here of course */
	u16 device;		/* You can use PCI_ANY_ID here of course */
	u32 class;		/* You can use PCI_ANY_ID here too */
	unsigned int class_shift;	/* should be 0, 8, 16 */
L
Linus Torvalds 已提交
1492 1493 1494 1495 1496 1497 1498 1499
	void (*hook)(struct pci_dev *dev);
};

enum pci_fixup_pass {
	pci_fixup_early,	/* Before probing BARs */
	pci_fixup_header,	/* After reading configuration header */
	pci_fixup_final,	/* Final phase of device fixups */
	pci_fixup_enable,	/* pci_enable_device() time */
1500 1501 1502
	pci_fixup_resume,	/* pci_device_resume() */
	pci_fixup_suspend,	/* pci_device_suspend */
	pci_fixup_resume_early, /* pci_device_resume_early() */
L
Linus Torvalds 已提交
1503 1504 1505
};

/* Anonymous variables would be nice... */
1506 1507
#define DECLARE_PCI_FIXUP_SECTION(section, name, vendor, device, class,	\
				  class_shift, hook)			\
1508
	static const struct pci_fixup __pci_fixup_##name __used		\
1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543
	__attribute__((__section__(#section), aligned((sizeof(void *)))))    \
		= { vendor, device, class, class_shift, hook };

#define DECLARE_PCI_FIXUP_CLASS_EARLY(vendor, device, class,		\
					 class_shift, hook)		\
	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early,			\
		vendor##device##hook, vendor, device, class, class_shift, hook)
#define DECLARE_PCI_FIXUP_CLASS_HEADER(vendor, device, class,		\
					 class_shift, hook)		\
	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header,			\
		vendor##device##hook, vendor, device, class, class_shift, hook)
#define DECLARE_PCI_FIXUP_CLASS_FINAL(vendor, device, class,		\
					 class_shift, hook)		\
	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final,			\
		vendor##device##hook, vendor, device, class, class_shift, hook)
#define DECLARE_PCI_FIXUP_CLASS_ENABLE(vendor, device, class,		\
					 class_shift, hook)		\
	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable,			\
		vendor##device##hook, vendor, device, class, class_shift, hook)
#define DECLARE_PCI_FIXUP_CLASS_RESUME(vendor, device, class,		\
					 class_shift, hook)		\
	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume,			\
		resume##vendor##device##hook, vendor, device, class,	\
		class_shift, hook)
#define DECLARE_PCI_FIXUP_CLASS_RESUME_EARLY(vendor, device, class,	\
					 class_shift, hook)		\
	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early,		\
		resume_early##vendor##device##hook, vendor, device,	\
		class, class_shift, hook)
#define DECLARE_PCI_FIXUP_CLASS_SUSPEND(vendor, device, class,		\
					 class_shift, hook)		\
	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend,			\
		suspend##vendor##device##hook, vendor, device, class,	\
		class_shift, hook)

L
Linus Torvalds 已提交
1544 1545
#define DECLARE_PCI_FIXUP_EARLY(vendor, device, hook)			\
	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early,			\
1546
		vendor##device##hook, vendor, device, PCI_ANY_ID, 0, hook)
L
Linus Torvalds 已提交
1547 1548
#define DECLARE_PCI_FIXUP_HEADER(vendor, device, hook)			\
	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header,			\
1549
		vendor##device##hook, vendor, device, PCI_ANY_ID, 0, hook)
L
Linus Torvalds 已提交
1550 1551
#define DECLARE_PCI_FIXUP_FINAL(vendor, device, hook)			\
	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final,			\
1552
		vendor##device##hook, vendor, device, PCI_ANY_ID, 0, hook)
L
Linus Torvalds 已提交
1553 1554
#define DECLARE_PCI_FIXUP_ENABLE(vendor, device, hook)			\
	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable,			\
1555
		vendor##device##hook, vendor, device, PCI_ANY_ID, 0, hook)
1556 1557
#define DECLARE_PCI_FIXUP_RESUME(vendor, device, hook)			\
	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume,			\
1558 1559
		resume##vendor##device##hook, vendor, device,		\
		PCI_ANY_ID, 0, hook)
1560 1561
#define DECLARE_PCI_FIXUP_RESUME_EARLY(vendor, device, hook)		\
	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early,		\
1562 1563
		resume_early##vendor##device##hook, vendor, device,	\
		PCI_ANY_ID, 0, hook)
1564 1565
#define DECLARE_PCI_FIXUP_SUSPEND(vendor, device, hook)			\
	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend,			\
1566 1567
		suspend##vendor##device##hook, vendor, device,		\
		PCI_ANY_ID, 0, hook)
L
Linus Torvalds 已提交
1568

1569
#ifdef CONFIG_PCI_QUIRKS
L
Linus Torvalds 已提交
1570
void pci_fixup_device(enum pci_fixup_pass pass, struct pci_dev *dev);
1571
struct pci_dev *pci_get_dma_source(struct pci_dev *dev);
1572
int pci_dev_specific_acs_enabled(struct pci_dev *dev, u16 acs_flags);
1573 1574 1575
#else
static inline void pci_fixup_device(enum pci_fixup_pass pass,
				    struct pci_dev *dev) {}
1576 1577 1578 1579
static inline struct pci_dev *pci_get_dma_source(struct pci_dev *dev)
{
	return pci_dev_get(dev);
}
1580 1581 1582 1583 1584
static inline int pci_dev_specific_acs_enabled(struct pci_dev *dev,
					       u16 acs_flags)
{
	return -ENOTTY;
}
1585
#endif
L
Linus Torvalds 已提交
1586

1587
void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen);
A
Al Viro 已提交
1588
void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr);
1589
void __iomem * const *pcim_iomap_table(struct pci_dev *pdev);
1590 1591
int pcim_iomap_regions(struct pci_dev *pdev, int mask, const char *name);
int pcim_iomap_regions_request_all(struct pci_dev *pdev, int mask,
1592
				   const char *name);
1593
void pcim_iounmap_regions(struct pci_dev *pdev, int mask);
A
Al Viro 已提交
1594

L
Linus Torvalds 已提交
1595
extern int pci_pci_problems;
A
Alan Cox 已提交
1596
#define PCIPCI_FAIL		1	/* No PCI PCI DMA */
L
Linus Torvalds 已提交
1597 1598 1599 1600
#define PCIPCI_TRITON		2
#define PCIPCI_NATOMA		4
#define PCIPCI_VIAETBF		8
#define PCIPCI_VSFX		16
A
Alan Cox 已提交
1601 1602
#define PCIPCI_ALIMAGIK		32	/* Need low latency setting */
#define PCIAGP_FAIL		64	/* No PCI to AGP DMA */
L
Linus Torvalds 已提交
1603

1604 1605
extern unsigned long pci_cardbus_io_size;
extern unsigned long pci_cardbus_mem_size;
B
Bill Pemberton 已提交
1606
extern u8 pci_dfl_cache_line_size;
1607
extern u8 pci_cache_line_size;
1608

1609 1610 1611
extern unsigned long pci_hotplug_io_size;
extern unsigned long pci_hotplug_mem_size;

1612
/* Architecture specific versions may override these (weak) */
1613 1614
int pcibios_add_platform_entries(struct pci_dev *dev);
void pcibios_disable_device(struct pci_dev *dev);
1615
void pcibios_set_master(struct pci_dev *dev);
1616 1617
int pcibios_set_pcie_reset_state(struct pci_dev *dev,
				 enum pcie_reset_state state);
M
Matthew Garrett 已提交
1618
int pcibios_add_device(struct pci_dev *dev);
1619

1620
#ifdef CONFIG_PCI_MMCONFIG
1621
extern void __init pci_mmcfg_early_init(void);
1622 1623
extern void __init pci_mmcfg_late_init(void);
#else
1624
static inline void pci_mmcfg_early_init(void) { }
1625 1626 1627
static inline void pci_mmcfg_late_init(void) { }
#endif

1628
int pci_ext_cfg_avail(void);
1629

A
Andrew Morton 已提交
1630
void __iomem *pci_ioremap_bar(struct pci_dev *pdev, int bar);
1631

1632 1633 1634
#ifdef CONFIG_PCI_IOV
extern int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn);
extern void pci_disable_sriov(struct pci_dev *dev);
1635
extern irqreturn_t pci_sriov_migration(struct pci_dev *dev);
1636
extern int pci_num_vf(struct pci_dev *dev);
1637 1638
extern int pci_sriov_set_totalvfs(struct pci_dev *dev, u16 numvfs);
extern int pci_sriov_get_totalvfs(struct pci_dev *dev);
1639 1640 1641 1642 1643 1644 1645 1646
#else
static inline int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn)
{
	return -ENODEV;
}
static inline void pci_disable_sriov(struct pci_dev *dev)
{
}
1647 1648 1649 1650
static inline irqreturn_t pci_sriov_migration(struct pci_dev *dev)
{
	return IRQ_NONE;
}
1651 1652 1653 1654
static inline int pci_num_vf(struct pci_dev *dev)
{
	return 0;
}
1655 1656 1657 1658 1659 1660 1661 1662
static inline int pci_sriov_set_totalvfs(struct pci_dev *dev, u16 numvfs)
{
	return 0;
}
static inline int pci_sriov_get_totalvfs(struct pci_dev *dev)
{
	return 0;
}
1663 1664
#endif

1665 1666 1667 1668 1669
#if defined(CONFIG_HOTPLUG_PCI) || defined(CONFIG_HOTPLUG_PCI_MODULE)
extern void pci_hp_create_module_link(struct pci_slot *pci_slot);
extern void pci_hp_remove_module_link(struct pci_slot *pci_slot);
#endif

K
Kenji Kaneshige 已提交
1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685
/**
 * pci_pcie_cap - get the saved PCIe capability offset
 * @dev: PCI device
 *
 * PCIe capability offset is calculated at PCI device initialization
 * time and saved in the data structure. This function returns saved
 * PCIe capability offset. Using this instead of pci_find_capability()
 * reduces unnecessary search in the PCI configuration space. If you
 * need to calculate PCIe capability offset from raw device for some
 * reasons, please use pci_find_capability() instead.
 */
static inline int pci_pcie_cap(struct pci_dev *dev)
{
	return dev->pcie_cap;
}

K
Kenji Kaneshige 已提交
1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696
/**
 * pci_is_pcie - check if the PCI device is PCI Express capable
 * @dev: PCI device
 *
 * Retrun true if the PCI device is PCI Express capable, false otherwise.
 */
static inline bool pci_is_pcie(struct pci_dev *dev)
{
	return !!pci_pcie_cap(dev);
}

1697 1698 1699 1700 1701 1702 1703 1704 1705
/**
 * pci_pcie_type - get the PCIe device/port type
 * @dev: PCI device
 */
static inline int pci_pcie_type(const struct pci_dev *dev)
{
	return (dev->pcie_flags_reg & PCI_EXP_FLAGS_TYPE) >> 4;
}

C
Chris Wright 已提交
1706
void pci_request_acs(void);
1707 1708 1709
bool pci_acs_enabled(struct pci_dev *pdev, u16 acs_flags);
bool pci_acs_path_enabled(struct pci_dev *start,
			  struct pci_dev *end, u16 acs_flags);
1710

1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732
#define PCI_VPD_LRDT			0x80	/* Large Resource Data Type */
#define PCI_VPD_LRDT_ID(x)		(x | PCI_VPD_LRDT)

/* Large Resource Data Type Tag Item Names */
#define PCI_VPD_LTIN_ID_STRING		0x02	/* Identifier String */
#define PCI_VPD_LTIN_RO_DATA		0x10	/* Read-Only Data */
#define PCI_VPD_LTIN_RW_DATA		0x11	/* Read-Write Data */

#define PCI_VPD_LRDT_ID_STRING		PCI_VPD_LRDT_ID(PCI_VPD_LTIN_ID_STRING)
#define PCI_VPD_LRDT_RO_DATA		PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RO_DATA)
#define PCI_VPD_LRDT_RW_DATA		PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RW_DATA)

/* Small Resource Data Type Tag Item Names */
#define PCI_VPD_STIN_END		0x78	/* End */

#define PCI_VPD_SRDT_END		PCI_VPD_STIN_END

#define PCI_VPD_SRDT_TIN_MASK		0x78
#define PCI_VPD_SRDT_LEN_MASK		0x07

#define PCI_VPD_LRDT_TAG_SIZE		3
#define PCI_VPD_SRDT_TAG_SIZE		1
1733

1734 1735
#define PCI_VPD_INFO_FLD_HDR_SIZE	3

1736 1737 1738
#define PCI_VPD_RO_KEYWORD_PARTNO	"PN"
#define PCI_VPD_RO_KEYWORD_MFR_ID	"MN"
#define PCI_VPD_RO_KEYWORD_VENDOR0	"V0"
1739
#define PCI_VPD_RO_KEYWORD_CHKSUM	"RV"
1740

1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751
/**
 * pci_vpd_lrdt_size - Extracts the Large Resource Data Type length
 * @lrdt: Pointer to the beginning of the Large Resource Data Type tag
 *
 * Returns the extracted Large Resource Data Type length.
 */
static inline u16 pci_vpd_lrdt_size(const u8 *lrdt)
{
	return (u16)lrdt[1] + ((u16)lrdt[2] << 8);
}

1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762
/**
 * pci_vpd_srdt_size - Extracts the Small Resource Data Type length
 * @lrdt: Pointer to the beginning of the Small Resource Data Type tag
 *
 * Returns the extracted Small Resource Data Type length.
 */
static inline u8 pci_vpd_srdt_size(const u8 *srdt)
{
	return (*srdt) & PCI_VPD_SRDT_LEN_MASK;
}

1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773
/**
 * pci_vpd_info_field_size - Extracts the information field length
 * @lrdt: Pointer to the beginning of an information field header
 *
 * Returns the extracted information field length.
 */
static inline u8 pci_vpd_info_field_size(const u8 *info_field)
{
	return info_field[2];
}

1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785
/**
 * pci_vpd_find_tag - Locates the Resource Data Type tag provided
 * @buf: Pointer to buffered vpd data
 * @off: The offset into the buffer at which to begin the search
 * @len: The length of the vpd buffer
 * @rdt: The Resource Data Type to search for
 *
 * Returns the index where the Resource Data Type was found or
 * -ENOENT otherwise.
 */
int pci_vpd_find_tag(const u8 *buf, unsigned int off, unsigned int len, u8 rdt);

1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798
/**
 * pci_vpd_find_info_keyword - Locates an information field keyword in the VPD
 * @buf: Pointer to buffered vpd data
 * @off: The offset into the buffer at which to begin the search
 * @len: The length of the buffer area, relative to off, in which to search
 * @kw: The keyword to search for
 *
 * Returns the index where the information field keyword was found or
 * -ENOENT otherwise.
 */
int pci_vpd_find_info_keyword(const u8 *buf, unsigned int off,
			      unsigned int len, const char *kw);

1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809
/* PCI <-> OF binding helpers */
#ifdef CONFIG_OF
struct device_node;
extern void pci_set_of_node(struct pci_dev *dev);
extern void pci_release_of_node(struct pci_dev *dev);
extern void pci_set_bus_of_node(struct pci_bus *bus);
extern void pci_release_bus_of_node(struct pci_bus *bus);

/* Arch may override this (weak) */
extern struct device_node * __weak pcibios_get_phb_of_node(struct pci_bus *bus);

1810 1811
static inline struct device_node *
pci_device_to_OF_node(const struct pci_dev *pdev)
1812 1813 1814 1815
{
	return pdev ? pdev->dev.of_node : NULL;
}

1816 1817 1818 1819 1820
static inline struct device_node *pci_bus_to_OF_node(struct pci_bus *bus)
{
	return bus ? bus->dev.of_node : NULL;
}

1821 1822 1823 1824 1825 1826 1827
#else /* CONFIG_OF */
static inline void pci_set_of_node(struct pci_dev *dev) { }
static inline void pci_release_of_node(struct pci_dev *dev) { }
static inline void pci_set_bus_of_node(struct pci_bus *bus) { }
static inline void pci_release_bus_of_node(struct pci_bus *bus) { }
#endif  /* CONFIG_OF */

G
Gavin Shan 已提交
1828 1829 1830 1831 1832 1833 1834
#ifdef CONFIG_EEH
static inline struct eeh_dev *pci_dev_to_eeh_dev(struct pci_dev *pdev)
{
	return pdev->dev.archdata.edev;
}
#endif

1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845
/**
 * pci_find_upstream_pcie_bridge - find upstream PCIe-to-PCI bridge of a device
 * @pdev: the PCI device
 *
 * if the device is PCIE, return NULL
 * if the device isn't connected to a PCIe bridge (that is its parent is a
 * legacy PCI bridge and the bridge is directly connected to bus 0), return its
 * parent
 */
struct pci_dev *pci_find_upstream_pcie_bridge(struct pci_dev *pdev);

L
Linus Torvalds 已提交
1846
#endif /* LINUX_PCI_H */