pci.h 62.9 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>

38 39 40 41 42 43 44 45 46 47 48 49 50 51 52
/*
 * The PCI interface treats multi-function devices as independent
 * devices.  The slot/function address of each device is encoded
 * in a single byte as follows:
 *
 *	7:3 = slot
 *	2:0 = function
 * PCI_DEVFN(), PCI_SLOT(), and PCI_FUNC() are defined uapi/linux/pci.h
 * In the interest of not exposing interfaces to user-space unnecessarily,
 * the following kernel only defines are being added here.
 */
#define PCI_DEVID(bus, devfn)  ((((u16)bus) << 8) | devfn)
/* return bus from PCI devid = ((u16)bus_number) << 8) | devfn */
#define PCI_BUS_NUM(x) (((x) >> 8) & 0xff)

A
Alex Chiang 已提交
53 54 55 56 57 58 59 60 61
/* 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;
};

62 63 64 65 66
static inline const char *pci_slot_name(const struct pci_slot *slot)
{
	return kobject_name(&slot->kobj);
}

L
Linus Torvalds 已提交
67 68 69 70 71 72 73 74 75 76 77 78
/* 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

79 80 81 82 83 84 85 86 87 88 89
/*
 *  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,

90 91 92 93 94 95
	/* device specific resources */
#ifdef CONFIG_PCI_IOV
	PCI_IOV_RESOURCES,
	PCI_IOV_RESOURCE_END = PCI_IOV_RESOURCES + PCI_SRIOV_NUM_BARS - 1,
#endif

96 97 98 99 100 101 102 103 104 105 106
	/* 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 */
107
	DEVICE_COUNT_RESOURCE = PCI_NUM_RESOURCES,
108
};
L
Linus Torvalds 已提交
109 110 111

typedef int __bitwise pci_power_t;

112 113 114
#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 已提交
115 116
#define PCI_D3hot	((pci_power_t __force) 3)
#define PCI_D3cold	((pci_power_t __force) 4)
117
#define PCI_UNKNOWN	((pci_power_t __force) 5)
118
#define PCI_POWER_ERROR	((pci_power_t __force) -1)
L
Linus Torvalds 已提交
119

A
Alan Stern 已提交
120 121 122 123 124 125 126 127
/* 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];
}

128 129 130 131
#define PCI_PM_D2_DELAY		200
#define PCI_PM_D3_WAIT		10
#define PCI_PM_D3COLD_WAIT	100
#define PCI_PM_BUS_WAIT		50
132

133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
/** 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 已提交
150 151 152 153 154 155 156 157 158 159 160 161 162
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
};

163 164 165 166 167 168
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,
169 170
	/* Device configuration is irrevocably lost if disabled into D3 */
	PCI_DEV_FLAGS_NO_D3 = (__force pci_dev_flags_t) 2,
171 172
	/* Provide indication device is assigned by a Virtual Machine Manager */
	PCI_DEV_FLAGS_ASSIGNED = (__force pci_dev_flags_t) 4,
173 174
};

175 176 177 178 179
enum pci_irq_reroute_variant {
	INTEL_IRQ_REROUTE_VARIANT = 1,
	MAX_IRQ_REROUTE_VARIANTS = 3
};

180 181
typedef unsigned short __bitwise pci_bus_flags_t;
enum pci_bus_flags {
182 183
	PCI_BUS_FLAGS_NO_MSI   = (__force pci_bus_flags_t) 1,
	PCI_BUS_FLAGS_NO_MMRBC = (__force pci_bus_flags_t) 2,
184 185
};

186 187 188 189 190 191 192 193 194 195 196 197 198
/* These values come from the PCI Express Spec */
enum pcie_link_width {
	PCIE_LNK_WIDTH_RESRV	= 0x00,
	PCIE_LNK_X1		= 0x01,
	PCIE_LNK_X2		= 0x02,
	PCIE_LNK_X4		= 0x04,
	PCIE_LNK_X8		= 0x08,
	PCIE_LNK_X12		= 0x0C,
	PCIE_LNK_X16		= 0x10,
	PCIE_LNK_X32		= 0x20,
	PCIE_LNK_WIDTH_UNKNOWN  = 0xFF,
};

199 200 201 202 203 204 205 206 207 208 209 210 211
/* 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,
212 213 214 215 216
	AGP_UNKNOWN			= 0x0c,
	AGP_1X				= 0x0d,
	AGP_2X				= 0x0e,
	AGP_4X				= 0x0f,
	AGP_8X				= 0x10,
217 218 219 220 221
	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,
222
	PCIE_SPEED_8_0GT		= 0x16,
223 224 225
	PCI_SPEED_UNKNOWN		= 0xff,
};

226
struct pci_cap_saved_data {
227
	char cap_nr;
228
	unsigned int size;
229 230 231
	u32 data[0];
};

232 233 234 235 236
struct pci_cap_saved_state {
	struct hlist_node next;
	struct pci_cap_saved_data cap;
};

S
Shaohua Li 已提交
237
struct pcie_link_state;
238
struct pci_vpd;
239
struct pci_sriov;
Y
Yu Zhao 已提交
240
struct pci_ats;
241

L
Linus Torvalds 已提交
242 243 244 245 246 247 248 249 250 251
/*
 * 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 已提交
252
	struct pci_slot	*slot;		/* Physical slot this device is in */
L
Linus Torvalds 已提交
253 254 255 256 257 258 259

	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 已提交
260
	u8		revision;	/* PCI revision, low byte of class word */
L
Linus Torvalds 已提交
261
	u8		hdr_type;	/* PCI header type (`multi' flag masked out) */
262
	u8		pcie_cap;	/* PCI-E capability offset */
263 264
	u8		msi_cap;	/* MSI capability offset */
	u8		msix_cap;	/* MSI-X capability offset */
265
	u8		pcie_mpss:3;	/* PCI-E Max Payload Size Supported */
L
Linus Torvalds 已提交
266
	u8		rom_base_reg;	/* which config register controls the ROM */
267
	u8		pin;  		/* which interrupt pin this device uses */
268
	u16		pcie_flags_reg;	/* cached PCI-E Capabilities Register */
L
Linus Torvalds 已提交
269 270 271 272 273 274 275 276

	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.  */

277 278
	struct device_dma_parameters dma_parms;

L
Linus Torvalds 已提交
279 280 281
	pci_power_t     current_state;  /* Current operating state. In ACPI-speak,
					   this is D0-D3, D0 being fully functional,
					   and D3 being off. */
282
	u8		pm_cap;		/* PM capability offset */
283 284
	unsigned int	pme_support:5;	/* Bitmask of states from which PME#
					   can be generated */
285
	unsigned int	pme_interrupt:1;
286
	unsigned int	pme_poll:1;	/* Poll device's PME status bit */
287 288
	unsigned int	d1_support:1;	/* Low power state D1 is supported */
	unsigned int	d2_support:1;	/* Low power state D2 is supported */
289 290 291
	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 已提交
292 293
	unsigned int	mmio_always_on:1;	/* disallow turning off io/mem
						   decoding during bar sizing */
294
	unsigned int	wakeup_prepared:1;
295 296 297 298
	unsigned int	runtime_d3cold:1;	/* whether go through runtime
						   D3cold, not set for devices
						   powered on/off by the
						   corresponding bridge */
299
	unsigned int	d3_delay;	/* D3->D0 transition time in ms */
300
	unsigned int	d3cold_delay;	/* D3cold->D0 transition time in ms */
L
Linus Torvalds 已提交
301

S
Shaohua Li 已提交
302 303 304 305
#ifdef CONFIG_PCIEASPM
	struct pcie_link_state	*link_state;	/* ASPM link state. */
#endif

306
	pci_channel_state_t error_state;	/* current connectivity state */
L
Linus Torvalds 已提交
307 308 309 310 311 312 313 314 315 316 317
	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 */

318
	bool match_driver;		/* Skip attaching driver */
L
Linus Torvalds 已提交
319 320 321 322
	/* 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 */
323
	unsigned int	is_added:1;
L
Linus Torvalds 已提交
324
	unsigned int	is_busmaster:1; /* device is busmaster */
325
	unsigned int	no_msi:1;	/* device may not use msi */
326
	unsigned int	block_cfg_access:1;	/* config space access is blocked */
327
	unsigned int	broken_parity_status:1;	/* Device generates false positive parity */
328
	unsigned int	irq_reroute_variant:2;	/* device needs IRQ rerouting variant */
329 330
	unsigned int 	msi_enabled:1;
	unsigned int	msix_enabled:1;
Y
Yu Zhao 已提交
331
	unsigned int	ari_enabled:1;	/* ARI forwarding */
T
Tejun Heo 已提交
332
	unsigned int	is_managed:1;
333
	unsigned int    needs_freset:1; /* Dev requires fundamental reset */
334
	unsigned int	state_saved:1;
335
	unsigned int	is_physfn:1;
336
	unsigned int	is_virtfn:1;
337
	unsigned int	reset_fn:1;
338
	unsigned int    is_hotplug_bridge:1;
339 340
	unsigned int    __aer_firmware_first_valid:1;
	unsigned int	__aer_firmware_first:1;
341
	unsigned int	broken_intx_masking:1;
342
	unsigned int	io_window_1k:1;	/* Intel P2P bridge 1K I/O windows */
343
	pci_dev_flags_t dev_flags;
344
	atomic_t	enable_cnt;	/* pci_enable_device has been called */
345

L
Linus Torvalds 已提交
346
	u32		saved_config_space[16]; /* config space saved at suspend time */
347
	struct hlist_head saved_cap_space;
L
Linus Torvalds 已提交
348 349 350
	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 */
351
	struct bin_attribute *res_attr_wc[DEVICE_COUNT_RESOURCE]; /* sysfs file for WC mapping of resources */
E
Eric W. Biederman 已提交
352
#ifdef CONFIG_PCI_MSI
353
	struct list_head msi_list;
354
	struct kset *msi_kset;
E
Eric W. Biederman 已提交
355
#endif
356
	struct pci_vpd *vpd;
357
#ifdef CONFIG_PCI_ATS
358 359 360 361
	union {
		struct pci_sriov *sriov;	/* SR-IOV capability related */
		struct pci_dev *physfn;	/* the PF this VF is associated with */
	};
Y
Yu Zhao 已提交
362
	struct pci_ats	*ats;	/* Address Translation Service */
363
#endif
364
	phys_addr_t rom; /* Physical address of ROM if it's not from the BAR */
365
	size_t romlen; /* Length of ROM if it's not from the BAR */
L
Linus Torvalds 已提交
366 367
};

368 369 370 371 372 373 374 375 376 377
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;
}

378 379
struct pci_dev *pci_alloc_dev(struct pci_bus *bus);
struct pci_dev * __deprecated alloc_pci_dev(void);
380

L
Linus Torvalds 已提交
381 382 383
#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)

384 385 386 387 388
static inline int pci_channel_offline(struct pci_dev *pdev)
{
	return (pdev->error_state != pci_channel_io_normal);
}

Y
Yinghai Lu 已提交
389 390
extern struct resource busn_resource;

391 392 393 394 395
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 */
};
396

397
struct pci_host_bridge {
398
	struct device dev;
399
	struct pci_bus *bus;		/* root bus */
400
	struct list_head windows;	/* pci_host_bridge_windows */
401 402
	void (*release_fn)(struct pci_host_bridge *);
	void *release_data;
403
};
404

405
#define	to_pci_host_bridge(n) container_of(n, struct pci_host_bridge, dev)
406 407 408
void pci_set_host_bridge_release(struct pci_host_bridge *bridge,
		     void (*release_fn)(struct pci_host_bridge *),
		     void *release_data);
409

410 411
int pcibios_root_bridge_prepare(struct pci_host_bridge *bridge);

412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431
/*
 * 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;
};
432 433

#define PCI_REGION_FLAG_MASK	0x0fU	/* These bits of resource flags tell us the PCI region flags */
L
Linus Torvalds 已提交
434 435 436 437 438 439 440

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 已提交
441
	struct list_head slots;		/* list of slots on this bus */
442 443
	struct resource *resource[PCI_BRIDGE_RESOURCE_NUM];
	struct list_head resources;	/* address space routed to this bus */
Y
Yinghai Lu 已提交
444
	struct resource busn_res;	/* bus numbers routed to this bus */
L
Linus Torvalds 已提交
445 446

	struct pci_ops	*ops;		/* configuration access functions */
447
	struct msi_chip	*msi;		/* MSI controller */
L
Linus Torvalds 已提交
448 449 450 451 452
	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 */
453 454
	unsigned char	max_bus_speed;	/* enum pci_bus_speed */
	unsigned char	cur_bus_speed;	/* enum pci_bus_speed */
L
Linus Torvalds 已提交
455 456 457 458

	char		name[48];

	unsigned short  bridge_ctl;	/* manage NO_ISA/FBB/et al behaviors */
459
	pci_bus_flags_t bus_flags;	/* Inherited by child busses */
L
Linus Torvalds 已提交
460
	struct device		*bridge;
461
	struct device		dev;
L
Linus Torvalds 已提交
462 463
	struct bin_attribute	*legacy_io; /* legacy I/O for this bus */
	struct bin_attribute	*legacy_mem; /* legacy mem */
464
	unsigned int		is_added:1;
L
Linus Torvalds 已提交
465 466 467
};

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

K
Kenji Kaneshige 已提交
470 471 472
/*
 * Returns true if the pci bus is root (behind host-pci bridge),
 * false otherwise
473 474 475 476
 *
 * Some code assumes that "bus->self == NULL" means that bus is a root bus.
 * This is incorrect because "virtual" buses added for SR-IOV (via
 * virtfn_add_bus()) have "bus->self == NULL" but are not root buses.
K
Kenji Kaneshige 已提交
477 478 479 480 481 482
 */
static inline bool pci_is_root_bus(struct pci_bus *pbus)
{
	return !(pbus->parent);
}

483 484 485 486 487 488 489 490 491
#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 已提交
492 493 494 495 496 497 498 499 500 501 502
/*
 * 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

503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528
/*
 * 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 已提交
529 530 531 532 533 534 535
/* 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);
};

536 537 538 539
/*
 * ACPI needs to be able to access PCI config space before we've done a
 * PCI bus scan and created pci_bus structures.
 */
540 541 542 543
int raw_pci_read(unsigned int domain, unsigned int bus, unsigned int devfn,
		 int reg, int len, u32 *val);
int raw_pci_write(unsigned int domain, unsigned int bus, unsigned int devfn,
		  int reg, int len, u32 val);
L
Linus Torvalds 已提交
544 545

struct pci_bus_region {
546 547
	resource_size_t start;
	resource_size_t end;
L
Linus Torvalds 已提交
548 549 550 551 552 553 554
};

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

555 556
/* ---------------------------------------------------------------- */
/** PCI Error Recovery System (PCI-ERS).  If a PCI device driver provides
557
 *  a set of callbacks in struct pci_error_handlers, then that device driver
558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578
 *  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,
579 580 581

	/* No AER capabilities registered for the driver */
	PCI_ERS_RESULT_NO_AER_DRIVER = (__force pci_ers_result_t) 6,
582 583 584
};

/* PCI bus error event callbacks */
585
struct pci_error_handlers {
586 587
	/* PCI bus error detected on this device */
	pci_ers_result_t (*error_detected)(struct pci_dev *dev,
588
					   enum pci_channel_state error);
589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604

	/* 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 已提交
605 606 607
struct module;
struct pci_driver {
	struct list_head node;
608
	const char *name;
L
Linus Torvalds 已提交
609 610 611 612
	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 已提交
613 614
	int  (*suspend_late) (struct pci_dev *dev, pm_message_t state);
	int  (*resume_early) (struct pci_dev *dev);
L
Linus Torvalds 已提交
615
	int  (*resume) (struct pci_dev *dev);	                /* Device woken up */
G
Greg KH 已提交
616
	void (*shutdown) (struct pci_dev *dev);
617
	int (*sriov_configure) (struct pci_dev *dev, int num_vfs); /* PF pdev */
618
	const struct pci_error_handlers *err_handler;
L
Linus Torvalds 已提交
619 620 621 622
	struct device_driver	driver;
	struct pci_dynids dynids;
};

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

625
/**
626
 * DEFINE_PCI_DEVICE_TABLE - macro used to describe a pci device table
627 628 629 630 631
 * @_table: device table name
 *
 * This macro is used to create a struct pci_device_id array (a device table)
 * in a generic manner.
 */
632
#define DEFINE_PCI_DEVICE_TABLE(_table) \
B
Bill Pemberton 已提交
633
	const struct pci_device_id _table[]
634

L
Linus Torvalds 已提交
635 636 637 638 639 640 641 642 643 644 645 646 647
/**
 * 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

648 649 650 651 652 653 654 655 656 657 658 659 660 661
/**
 * 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 已提交
662 663 664 665 666 667
/**
 * 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
668
 * specific PCI class.  The vendor, device, subvendor, and subdevice
L
Linus Torvalds 已提交
669 670 671 672 673 674 675
 * 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

676 677
/**
 * PCI_VDEVICE - macro used to describe a specific pci device in short form
678 679
 * @vendor: the vendor name
 * @device: the 16 bit PCI Device ID
680 681 682 683 684 685 686 687 688 689 690
 *
 * 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 已提交
691 692 693
/* these external functions are only available when PCI support is enabled */
#ifdef CONFIG_PCI

694
void pcie_bus_configure_settings(struct pci_bus *bus);
695 696

enum pcie_bus_config_types {
697
	PCIE_BUS_TUNE_OFF,
698
	PCIE_BUS_SAFE,
699
	PCIE_BUS_PERFORMANCE,
700 701 702 703 704
	PCIE_BUS_PEER2PEER,
};

extern enum pcie_bus_config_types pcie_bus_config;

L
Linus Torvalds 已提交
705 706 707 708 709
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 已提交
710
/* Some device drivers need know if pci is initiated */
711
int no_pci_devices(void);
L
Linus Torvalds 已提交
712

713
void pcibios_resource_survey_bus(struct pci_bus *bus);
714 715
void pcibios_add_bus(struct pci_bus *bus);
void pcibios_remove_bus(struct pci_bus *bus);
L
Linus Torvalds 已提交
716
void pcibios_fixup_bus(struct pci_bus *);
717
int __must_check pcibios_enable_device(struct pci_dev *, int mask);
718
/* Architecture specific versions may override this (weak) */
719
char *pcibios_setup(char *str);
L
Linus Torvalds 已提交
720 721

/* Used only when drivers/pci/setup.c is used */
722
resource_size_t pcibios_align_resource(void *, const struct resource *,
723
				resource_size_t,
724
				resource_size_t);
L
Linus Torvalds 已提交
725 726
void pcibios_update_irq(struct pci_dev *, int irq);

727 728 729
/* Weak but can be overriden by arch */
void pci_fixup_cardbus(struct pci_bus *);

L
Linus Torvalds 已提交
730 731
/* Generic PCI functions used internally */

732 733 734 735
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);
736
void pcibios_scan_specific_bus(int busn);
737
struct pci_bus *pci_find_bus(int domain, int busnr);
738
void pci_bus_add_devices(const struct pci_bus *bus);
739 740
struct pci_bus *pci_scan_bus_parented(struct device *parent, int bus,
				      struct pci_ops *ops, void *sysdata);
741
struct pci_bus *pci_scan_bus(int bus, struct pci_ops *ops, void *sysdata);
742 743 744
struct pci_bus *pci_create_root_bus(struct device *parent, int bus,
				    struct pci_ops *ops, void *sysdata,
				    struct list_head *resources);
745 746 747
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 已提交
748
struct pci_bus *pci_scan_root_bus(struct device *parent, int bus,
749 750
					     struct pci_ops *ops, void *sysdata,
					     struct list_head *resources);
751 752
struct pci_bus *pci_add_new_bus(struct pci_bus *parent, struct pci_dev *dev,
				int busnr);
753
void pcie_update_link_speed(struct pci_bus *bus, u16 link_status);
A
Alex Chiang 已提交
754
struct pci_slot *pci_create_slot(struct pci_bus *parent, int slot_nr,
755 756
				 const char *name,
				 struct hotplug_slot *hotplug);
A
Alex Chiang 已提交
757
void pci_destroy_slot(struct pci_slot *slot);
758
void pci_renumber_slot(struct pci_slot *slot, int slot_nr);
L
Linus Torvalds 已提交
759
int pci_scan_slot(struct pci_bus *bus, int devfn);
760
struct pci_dev *pci_scan_single_device(struct pci_bus *bus, int devfn);
761
void pci_device_add(struct pci_dev *dev, struct pci_bus *bus);
L
Linus Torvalds 已提交
762
unsigned int pci_scan_child_bus(struct pci_bus *bus);
763
int __must_check pci_bus_add_device(struct pci_dev *dev);
L
Linus Torvalds 已提交
764
void pci_read_bridge_bases(struct pci_bus *child);
765 766
struct resource *pci_find_parent_resource(const struct pci_dev *dev,
					  struct resource *res);
767
u8 pci_swizzle_interrupt_pin(const struct pci_dev *dev, u8 pin);
L
Linus Torvalds 已提交
768
int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge);
769
u8 pci_common_swizzle(struct pci_dev *dev, u8 *pinp);
770 771 772 773
struct pci_dev *pci_dev_get(struct pci_dev *dev);
void pci_dev_put(struct pci_dev *dev);
void pci_remove_bus(struct pci_bus *b);
void pci_stop_and_remove_bus_device(struct pci_dev *dev);
774 775
void pci_stop_root_bus(struct pci_bus *bus);
void pci_remove_root_bus(struct pci_bus *bus);
776
void pci_setup_cardbus(struct pci_bus *bus);
777
void pci_sort_breadthfirst(void);
778 779 780
#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 已提交
781 782 783

/* Generic PCI functions exported to card drivers */

784 785 786 787 788 789 790
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);
791 792 793
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);
794
int pci_find_next_ext_capability(struct pci_dev *dev, int pos, int cap);
795 796
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 已提交
797
struct pci_bus *pci_find_next_bus(const struct pci_bus *from);
L
Linus Torvalds 已提交
798

799 800
struct pci_dev *pci_get_device(unsigned int vendor, unsigned int device,
				struct pci_dev *from);
801
struct pci_dev *pci_get_subsys(unsigned int vendor, unsigned int device,
L
Linus Torvalds 已提交
802
				unsigned int ss_vendor, unsigned int ss_device,
803
				struct pci_dev *from);
804
struct pci_dev *pci_get_slot(struct pci_bus *bus, unsigned int devfn);
805 806 807 808 809 810 811
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);
}
812
struct pci_dev *pci_get_class(unsigned int class, struct pci_dev *from);
L
Linus Torvalds 已提交
813 814
int pci_dev_present(const struct pci_device_id *ids);

815 816 817 818 819 820 821 822 823 824 825 826
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 已提交
827
struct pci_ops *pci_bus_set_ops(struct pci_bus *bus, struct pci_ops *ops);
L
Linus Torvalds 已提交
828

829
static inline int pci_read_config_byte(const struct pci_dev *dev, int where, u8 *val)
L
Linus Torvalds 已提交
830
{
831
	return pci_bus_read_config_byte(dev->bus, dev->devfn, where, val);
L
Linus Torvalds 已提交
832
}
833
static inline int pci_read_config_word(const struct pci_dev *dev, int where, u16 *val)
L
Linus Torvalds 已提交
834
{
835
	return pci_bus_read_config_word(dev->bus, dev->devfn, where, val);
L
Linus Torvalds 已提交
836
}
837
static inline int pci_read_config_dword(const struct pci_dev *dev, int where,
838
					u32 *val)
L
Linus Torvalds 已提交
839
{
840
	return pci_bus_read_config_dword(dev->bus, dev->devfn, where, val);
L
Linus Torvalds 已提交
841
}
842
static inline int pci_write_config_byte(const struct pci_dev *dev, int where, u8 val)
L
Linus Torvalds 已提交
843
{
844
	return pci_bus_write_config_byte(dev->bus, dev->devfn, where, val);
L
Linus Torvalds 已提交
845
}
846
static inline int pci_write_config_word(const struct pci_dev *dev, int where, u16 val)
L
Linus Torvalds 已提交
847
{
848
	return pci_bus_write_config_word(dev->bus, dev->devfn, where, val);
L
Linus Torvalds 已提交
849
}
850
static inline int pci_write_config_dword(const struct pci_dev *dev, int where,
851
					 u32 val)
L
Linus Torvalds 已提交
852
{
853
	return pci_bus_write_config_dword(dev->bus, dev->devfn, where, val);
L
Linus Torvalds 已提交
854 855
}

856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
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);
}

889 890 891 892 893 894 895 896
/* 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);

897
int __must_check pci_enable_device(struct pci_dev *dev);
898 899
int __must_check pci_enable_device_io(struct pci_dev *dev);
int __must_check pci_enable_device_mem(struct pci_dev *dev);
900
int __must_check pci_reenable_device(struct pci_dev *);
T
Tejun Heo 已提交
901 902 903
int __must_check pcim_enable_device(struct pci_dev *pdev);
void pcim_pin_device(struct pci_dev *pdev);

904 905 906 907 908
static inline int pci_is_enabled(struct pci_dev *pdev)
{
	return (atomic_read(&pdev->enable_cnt) > 0);
}

T
Tejun Heo 已提交
909 910 911 912 913
static inline int pci_is_managed(struct pci_dev *pdev)
{
	return pdev->is_managed;
}

L
Linus Torvalds 已提交
914
void pci_disable_device(struct pci_dev *dev);
915 916

extern unsigned int pcibios_max_latency;
L
Linus Torvalds 已提交
917
void pci_set_master(struct pci_dev *dev);
918
void pci_clear_master(struct pci_dev *dev);
919

B
Brian King 已提交
920
int pci_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state);
T
Tejun Heo 已提交
921
int pci_set_cacheline_size(struct pci_dev *dev);
L
Linus Torvalds 已提交
922
#define HAVE_PCI_SET_MWI
923
int __must_check pci_set_mwi(struct pci_dev *dev);
R
Randy Dunlap 已提交
924
int pci_try_set_mwi(struct pci_dev *dev);
L
Linus Torvalds 已提交
925
void pci_clear_mwi(struct pci_dev *dev);
B
Brett M Russ 已提交
926
void pci_intx(struct pci_dev *dev, int enable);
927 928 929
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);
930
void pci_msi_off(struct pci_dev *dev);
931
int pci_set_dma_max_seg_size(struct pci_dev *dev, unsigned int size);
932
int pci_set_dma_seg_boundary(struct pci_dev *dev, unsigned long mask);
933
int pci_wait_for_pending_transaction(struct pci_dev *dev);
934 935 936
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);
937
int pcie_get_readrq(struct pci_dev *dev);
938
int pcie_set_readrq(struct pci_dev *dev, int rq);
939 940
int pcie_get_mps(struct pci_dev *dev);
int pcie_set_mps(struct pci_dev *dev, int mps);
941 942
int pcie_get_minimum_link(struct pci_dev *dev, enum pci_bus_speed *speed,
			  enum pcie_link_width *width);
Y
Yu Zhao 已提交
943
int __pci_reset_function(struct pci_dev *dev);
944
int __pci_reset_function_locked(struct pci_dev *dev);
945
int pci_reset_function(struct pci_dev *dev);
946
int pci_probe_reset_slot(struct pci_slot *slot);
947
int pci_reset_slot(struct pci_slot *slot);
948
int pci_probe_reset_bus(struct pci_bus *bus);
949
int pci_reset_bus(struct pci_bus *bus);
950
void pci_reset_bridge_secondary_bus(struct pci_dev *dev);
951
void pci_update_resource(struct pci_dev *dev, int resno);
952
int __must_check pci_assign_resource(struct pci_dev *dev, int i);
953
int __must_check pci_reassign_resource(struct pci_dev *dev, int i, resource_size_t add_size, resource_size_t align);
954
int pci_select_bars(struct pci_dev *dev, unsigned long flags);
L
Linus Torvalds 已提交
955 956

/* ROM control related routines */
A
Alan Cox 已提交
957 958
int pci_enable_rom(struct pci_dev *pdev);
void pci_disable_rom(struct pci_dev *pdev);
959
void __iomem __must_check *pci_map_rom(struct pci_dev *pdev, size_t *size);
L
Linus Torvalds 已提交
960
void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom);
961
size_t pci_get_rom_size(struct pci_dev *pdev, void __iomem *rom, size_t size);
962
void __iomem __must_check *pci_platform_rom(struct pci_dev *pdev, size_t *size);
L
Linus Torvalds 已提交
963 964 965

/* Power management related routines */
int pci_save_state(struct pci_dev *dev);
966
void pci_restore_state(struct pci_dev *dev);
967 968 969 970
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);
971
int __pci_complete_power_transition(struct pci_dev *dev, pci_power_t state);
972 973
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);
974
bool pci_pme_capable(struct pci_dev *dev, pci_power_t state);
975
void pci_pme_active(struct pci_dev *dev, bool enable);
976 977
int __pci_enable_wake(struct pci_dev *dev, pci_power_t state,
		      bool runtime, bool enable);
978
int pci_wake_from_d3(struct pci_dev *dev, bool enable);
979
pci_power_t pci_target_state(struct pci_dev *dev);
980 981
int pci_prepare_to_sleep(struct pci_dev *dev);
int pci_back_from_sleep(struct pci_dev *dev);
982
bool pci_dev_run_wake(struct pci_dev *dev);
983 984
bool pci_check_pme_status(struct pci_dev *dev);
void pci_pme_wakeup_bus(struct pci_bus *bus);
L
Linus Torvalds 已提交
985

986 987 988 989 990
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 已提交
991

992 993 994 995 996
#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);

997
enum pci_obff_signal_type {
998 999
	PCI_EXP_OBFF_SIGNAL_L0 = 0,
	PCI_EXP_OBFF_SIGNAL_ALWAYS = 1,
1000 1001 1002 1003
};
int pci_enable_obff(struct pci_dev *dev, enum pci_obff_signal_type);
void pci_disable_obff(struct pci_dev *dev);

1004 1005 1006 1007
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);

1008 1009 1010 1011
/* 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);

1012
/* Functions for PCI Hotplug drivers to use */
1013
int pci_bus_find_capability(struct pci_bus *bus, unsigned int devfn, int cap);
1014
unsigned int pci_rescan_bus_bridge_resize(struct pci_dev *bridge);
A
Alex Chiang 已提交
1015
unsigned int pci_rescan_bus(struct pci_bus *bus);
1016

1017 1018 1019
/* 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);
1020
int pci_vpd_truncate(struct pci_dev *dev, size_t size);
1021

L
Linus Torvalds 已提交
1022
/* Helper functions for low-level code (drivers/pci/setup-[bus,res].c) */
1023
resource_size_t pcibios_retrieve_fw_addr(struct pci_dev *dev, int idx);
1024
void pci_bus_assign_resources(const struct pci_bus *bus);
L
Linus Torvalds 已提交
1025 1026 1027
void pci_bus_size_bridges(struct pci_bus *bus);
int pci_claim_resource(struct pci_dev *, int);
void pci_assign_unassigned_resources(void);
1028
void pci_assign_unassigned_bridge_resources(struct pci_dev *bridge);
1029
void pci_assign_unassigned_bus_resources(struct pci_bus *bus);
1030
void pci_assign_unassigned_root_bus_resources(struct pci_bus *bus);
L
Linus Torvalds 已提交
1031
void pdev_enable_device(struct pci_dev *);
1032
int pci_enable_resources(struct pci_dev *, int mask);
L
Linus Torvalds 已提交
1033
void pci_fixup_irqs(u8 (*)(struct pci_dev *, u8 *),
1034
		    int (*)(const struct pci_dev *, u8, u8));
L
Linus Torvalds 已提交
1035
#define HAVE_PCI_REQ_REGIONS	2
1036
int __must_check pci_request_regions(struct pci_dev *, const char *);
1037
int __must_check pci_request_regions_exclusive(struct pci_dev *, const char *);
L
Linus Torvalds 已提交
1038
void pci_release_regions(struct pci_dev *);
1039
int __must_check pci_request_region(struct pci_dev *, int, const char *);
1040
int __must_check pci_request_region_exclusive(struct pci_dev *, int, const char *);
L
Linus Torvalds 已提交
1041
void pci_release_region(struct pci_dev *, int);
1042
int pci_request_selected_regions(struct pci_dev *, int, const char *);
1043
int pci_request_selected_regions_exclusive(struct pci_dev *, int, const char *);
1044
void pci_release_selected_regions(struct pci_dev *, int);
L
Linus Torvalds 已提交
1045 1046

/* drivers/pci/bus.c */
1047 1048
struct pci_bus *pci_bus_get(struct pci_bus *bus);
void pci_bus_put(struct pci_bus *bus);
1049
void pci_add_resource(struct list_head *resources, struct resource *res);
1050 1051
void pci_add_resource_offset(struct list_head *resources, struct resource *res,
			     resource_size_t offset);
1052
void pci_free_resource_list(struct list_head *resources);
1053 1054 1055 1056
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);

1057
#define pci_bus_for_each_resource(bus, res, i)				\
1058 1059 1060
	for (i = 0;							\
	    (res = pci_bus_resource_n(bus, i)) || i < PCI_BRIDGE_RESOURCE_NUM; \
	     i++)
1061

1062 1063 1064 1065
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,
1066 1067
			resource_size_t (*alignf)(void *,
						  const struct resource *,
1068 1069
						  resource_size_t,
						  resource_size_t),
1070
			void *alignf_data);
L
Linus Torvalds 已提交
1071

1072
/* Proper probing supporting hot-pluggable devices */
1073 1074
int __must_check __pci_register_driver(struct pci_driver *, struct module *,
				       const char *mod_name);
1075 1076 1077 1078 1079 1080

/*
 * 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)
1081

1082
void pci_unregister_driver(struct pci_driver *dev);
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095

/**
 * 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)

1096
struct pci_driver *pci_dev_driver(const struct pci_dev *dev);
T
Tejun Heo 已提交
1097 1098 1099 1100 1101
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);
1102 1103 1104 1105
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 已提交
1106

1107
void pci_walk_bus(struct pci_bus *top, int (*cb)(struct pci_dev *, void *),
1108
		  void *userdata);
1109
int pci_cfg_space_size_ext(struct pci_dev *dev);
1110
int pci_cfg_space_size(struct pci_dev *dev);
1111
unsigned char pci_bus_max_busnr(struct pci_bus *bus);
1112
void pci_setup_bridge(struct pci_bus *bus);
1113 1114
resource_size_t pcibios_window_alignment(struct pci_bus *bus,
					 unsigned long type);
1115

1116 1117 1118
#define PCI_VGA_STATE_CHANGE_BRIDGE (1 << 0)
#define PCI_VGA_STATE_CHANGE_DECODES (1 << 1)

1119
int pci_set_vga_state(struct pci_dev *pdev, bool decode,
1120
		      unsigned int command_bits, u32 flags);
L
Linus Torvalds 已提交
1121 1122
/* kmem_cache style wrapper around pci_alloc_consistent() */

1123
#include <linux/pci-dma.h>
L
Linus Torvalds 已提交
1124 1125 1126 1127 1128 1129 1130 1131 1132
#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)

1133 1134 1135 1136 1137 1138 1139 1140 1141
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 已提交
1142
struct msix_entry {
Y
Yinghai Lu 已提交
1143
	u32	vector;	/* kernel uses to write allocated vector */
L
Linus Torvalds 已提交
1144 1145 1146
	u16	entry;	/* driver uses to specify entry, OS writes */
};

1147

L
Linus Torvalds 已提交
1148
#ifndef CONFIG_PCI_MSI
1149
static inline int pci_enable_msi_block(struct pci_dev *dev, unsigned int nvec)
1150 1151 1152 1153
{
	return -1;
}

1154 1155 1156 1157 1158 1159
static inline int
pci_enable_msi_block_auto(struct pci_dev *dev, unsigned int *maxvec)
{
	return -1;
}

1160 1161
static inline void pci_msi_shutdown(struct pci_dev *dev)
{ }
1162 1163 1164
static inline void pci_disable_msi(struct pci_dev *dev)
{ }

1165 1166 1167 1168
static inline int pci_msix_table_size(struct pci_dev *dev)
{
	return 0;
}
1169 1170 1171 1172 1173 1174
static inline int pci_enable_msix(struct pci_dev *dev,
				  struct msix_entry *entries, int nvec)
{
	return -1;
}

1175 1176
static inline void pci_msix_shutdown(struct pci_dev *dev)
{ }
1177 1178 1179 1180 1181 1182 1183 1184
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)
{ }
1185 1186 1187 1188
static inline int pci_msi_enabled(void)
{
	return 0;
}
L
Linus Torvalds 已提交
1189
#else
1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
int pci_enable_msi_block(struct pci_dev *dev, unsigned int nvec);
int pci_enable_msi_block_auto(struct pci_dev *dev, unsigned int *maxvec);
void pci_msi_shutdown(struct pci_dev *dev);
void pci_disable_msi(struct pci_dev *dev);
int pci_msix_table_size(struct pci_dev *dev);
int pci_enable_msix(struct pci_dev *dev, struct msix_entry *entries, int nvec);
void pci_msix_shutdown(struct pci_dev *dev);
void pci_disable_msix(struct pci_dev *dev);
void msi_remove_pci_irq_vectors(struct pci_dev *dev);
void pci_restore_msi_state(struct pci_dev *dev);
int pci_msi_enabled(void);
L
Linus Torvalds 已提交
1201 1202
#endif

1203
#ifdef CONFIG_PCIEPORTBUS
1204 1205
extern bool pcie_ports_disabled;
extern bool pcie_ports_auto;
1206 1207 1208 1209
#else
#define pcie_ports_disabled	true
#define pcie_ports_auto		false
#endif
1210

1211
#ifndef CONFIG_PCIEASPM
1212 1213
static inline int pcie_aspm_enabled(void) { return 0; }
static inline bool pcie_aspm_support_enabled(void) { return false; }
1214
#else
1215 1216
int pcie_aspm_enabled(void);
bool pcie_aspm_support_enabled(void);
1217 1218
#endif

1219 1220 1221 1222 1223 1224 1225 1226
#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

1227 1228 1229 1230 1231 1232 1233
#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
1234 1235
void pcie_set_ecrc_checking(struct pci_dev *dev);
void pcie_ecrc_get_policy(char *str);
1236 1237
#endif

1238 1239
#define pci_enable_msi(pdev)	pci_enable_msi_block(pdev, 1)

1240 1241 1242 1243 1244 1245
#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 */

1246 1247 1248
void pci_cfg_access_lock(struct pci_dev *dev);
bool pci_cfg_access_trylock(struct pci_dev *dev);
void pci_cfg_access_unlock(struct pci_dev *dev);
1249

1250 1251 1252 1253 1254
/*
 * 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.
 */
1255 1256 1257 1258
#ifdef CONFIG_PCI_DOMAINS
extern int pci_domains_supported;
#else
enum { pci_domains_supported = 0 };
1259 1260 1261 1262 1263
static inline int pci_domain_nr(struct pci_bus *bus)
{
	return 0;
}

1264 1265 1266 1267
static inline int pci_proc_domain(struct pci_bus *bus)
{
	return 0;
}
1268
#endif /* CONFIG_PCI_DOMAINS */
L
Linus Torvalds 已提交
1269

1270 1271
/* some architectures require additional setup to direct VGA traffic */
typedef int (*arch_set_vga_state_t)(struct pci_dev *pdev, bool decode,
1272
		      unsigned int command_bits, u32 flags);
1273
void pci_register_set_vga_state(arch_set_vga_state_t func);
1274

1275
#else /* CONFIG_PCI is not enabled */
L
Linus Torvalds 已提交
1276 1277 1278 1279 1280 1281

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

1282 1283 1284
#define _PCI_NOP(o, s, t) \
	static inline int pci_##o##_config_##s(struct pci_dev *dev, \
						int where, t val) \
L
Linus Torvalds 已提交
1285
		{ return PCIBIOS_FUNC_NOT_SUPPORTED; }
1286 1287 1288 1289

#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 已提交
1290 1291 1292
_PCI_NOP_ALL(read, *)
_PCI_NOP_ALL(write,)

1293
static inline struct pci_dev *pci_get_device(unsigned int vendor,
1294 1295 1296 1297 1298
					     unsigned int device,
					     struct pci_dev *from)
{
	return NULL;
}
1299

1300 1301 1302 1303
static inline struct pci_dev *pci_get_subsys(unsigned int vendor,
					     unsigned int device,
					     unsigned int ss_vendor,
					     unsigned int ss_device,
1304
					     struct pci_dev *from)
1305 1306 1307
{
	return NULL;
}
L
Linus Torvalds 已提交
1308

1309 1310 1311 1312 1313
static inline struct pci_dev *pci_get_class(unsigned int class,
					    struct pci_dev *from)
{
	return NULL;
}
L
Linus Torvalds 已提交
1314 1315

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

1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334
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;
}

1335 1336 1337 1338 1339
static inline int pci_set_consistent_dma_mask(struct pci_dev *dev, u64 mask)
{
	return -EIO;
}

1340 1341 1342 1343 1344 1345
static inline int pci_set_dma_max_seg_size(struct pci_dev *dev,
					unsigned int size)
{
	return -EIO;
}

1346 1347 1348 1349 1350 1351
static inline int pci_set_dma_seg_boundary(struct pci_dev *dev,
					unsigned long mask)
{
	return -EIO;
}

1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386
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 已提交
1387
/* Power management related routines */
1388 1389 1390 1391 1392
static inline int pci_save_state(struct pci_dev *dev)
{
	return 0;
}

1393 1394
static inline void pci_restore_state(struct pci_dev *dev)
{ }
L
Linus Torvalds 已提交
1395

1396 1397 1398 1399 1400
static inline int pci_set_power_state(struct pci_dev *dev, pci_power_t state)
{
	return 0;
}

1401 1402 1403 1404 1405
static inline int pci_wake_from_d3(struct pci_dev *dev, bool enable)
{
	return 0;
}

1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417
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;
}

1418 1419 1420 1421 1422 1423 1424 1425
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)
{
}

1426 1427 1428 1429 1430 1431 1432 1433 1434
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)
{
}

1435 1436 1437 1438 1439 1440 1441
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)
{ }
1442

1443 1444
#define pci_dma_burst_advice(pdev, strat, strategy_parameter) do { } while (0)

1445
static inline void pci_block_cfg_access(struct pci_dev *dev)
1446 1447
{ }

1448 1449 1450 1451
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)
1452
{ }
1453

R
Randy Dunlap 已提交
1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464
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; }

1465 1466 1467
static inline int pci_domain_nr(struct pci_bus *bus)
{ return 0; }

1468 1469 1470
static inline struct pci_dev *pci_dev_get(struct pci_dev *dev)
{ return NULL; }

1471 1472 1473
#define dev_is_pci(d) (false)
#define dev_is_pf(d) (false)
#define dev_num_vf(d) (0)
1474
#endif /* CONFIG_PCI */
L
Linus Torvalds 已提交
1475

1476 1477 1478
/* Include architecture-dependent settings and functions */

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

1480 1481 1482 1483
#ifndef PCIBIOS_MAX_MEM_32
#define PCIBIOS_MAX_MEM_32 (-1)
#endif

L
Linus Torvalds 已提交
1484 1485
/* these helpers provide future and backwards compatibility
 * for accessing popular PCI BAR info */
1486 1487 1488
#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 已提交
1489
#define pci_resource_len(dev,bar) \
1490 1491 1492 1493 1494 1495
	((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 已提交
1496 1497 1498 1499 1500

/* 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.
 */
1501
static inline void *pci_get_drvdata(struct pci_dev *pdev)
L
Linus Torvalds 已提交
1502 1503 1504 1505
{
	return dev_get_drvdata(&pdev->dev);
}

1506
static inline void pci_set_drvdata(struct pci_dev *pdev, void *data)
L
Linus Torvalds 已提交
1507 1508 1509 1510 1511 1512 1513
{
	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.
 */
1514
static inline const char *pci_name(const struct pci_dev *pdev)
L
Linus Torvalds 已提交
1515
{
G
Greg KH 已提交
1516
	return dev_name(&pdev->dev);
L
Linus Torvalds 已提交
1517 1518
}

1519 1520 1521 1522 1523 1524

/* 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,
1525
		const struct resource *rsrc, resource_size_t *start,
1526
		resource_size_t *end)
1527 1528 1529 1530 1531 1532 1533
{
	*start = rsrc->start;
	*end = rsrc->end;
}
#endif /* HAVE_ARCH_PCI_RESOURCE_TO_USER */


L
Linus Torvalds 已提交
1534 1535 1536 1537 1538 1539 1540 1541
/*
 *  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 {
1542 1543 1544 1545
	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 已提交
1546 1547 1548 1549 1550 1551 1552 1553
	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 */
1554 1555 1556
	pci_fixup_resume,	/* pci_device_resume() */
	pci_fixup_suspend,	/* pci_device_suspend */
	pci_fixup_resume_early, /* pci_device_resume_early() */
L
Linus Torvalds 已提交
1557 1558 1559
};

/* Anonymous variables would be nice... */
1560 1561
#define DECLARE_PCI_FIXUP_SECTION(section, name, vendor, device, class,	\
				  class_shift, hook)			\
1562
	static const struct pci_fixup __pci_fixup_##name __used		\
1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597
	__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 已提交
1598 1599
#define DECLARE_PCI_FIXUP_EARLY(vendor, device, hook)			\
	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early,			\
1600
		vendor##device##hook, vendor, device, PCI_ANY_ID, 0, hook)
L
Linus Torvalds 已提交
1601 1602
#define DECLARE_PCI_FIXUP_HEADER(vendor, device, hook)			\
	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header,			\
1603
		vendor##device##hook, vendor, device, PCI_ANY_ID, 0, hook)
L
Linus Torvalds 已提交
1604 1605
#define DECLARE_PCI_FIXUP_FINAL(vendor, device, hook)			\
	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final,			\
1606
		vendor##device##hook, vendor, device, PCI_ANY_ID, 0, hook)
L
Linus Torvalds 已提交
1607 1608
#define DECLARE_PCI_FIXUP_ENABLE(vendor, device, hook)			\
	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable,			\
1609
		vendor##device##hook, vendor, device, PCI_ANY_ID, 0, hook)
1610 1611
#define DECLARE_PCI_FIXUP_RESUME(vendor, device, hook)			\
	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume,			\
1612 1613
		resume##vendor##device##hook, vendor, device,		\
		PCI_ANY_ID, 0, hook)
1614 1615
#define DECLARE_PCI_FIXUP_RESUME_EARLY(vendor, device, hook)		\
	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early,		\
1616 1617
		resume_early##vendor##device##hook, vendor, device,	\
		PCI_ANY_ID, 0, hook)
1618 1619
#define DECLARE_PCI_FIXUP_SUSPEND(vendor, device, hook)			\
	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend,			\
1620 1621
		suspend##vendor##device##hook, vendor, device,		\
		PCI_ANY_ID, 0, hook)
L
Linus Torvalds 已提交
1622

1623
#ifdef CONFIG_PCI_QUIRKS
L
Linus Torvalds 已提交
1624
void pci_fixup_device(enum pci_fixup_pass pass, struct pci_dev *dev);
1625
struct pci_dev *pci_get_dma_source(struct pci_dev *dev);
1626
int pci_dev_specific_acs_enabled(struct pci_dev *dev, u16 acs_flags);
1627 1628 1629
#else
static inline void pci_fixup_device(enum pci_fixup_pass pass,
				    struct pci_dev *dev) {}
1630 1631 1632 1633
static inline struct pci_dev *pci_get_dma_source(struct pci_dev *dev)
{
	return pci_dev_get(dev);
}
1634 1635 1636 1637 1638
static inline int pci_dev_specific_acs_enabled(struct pci_dev *dev,
					       u16 acs_flags)
{
	return -ENOTTY;
}
1639
#endif
L
Linus Torvalds 已提交
1640

1641
void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen);
A
Al Viro 已提交
1642
void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr);
1643
void __iomem * const *pcim_iomap_table(struct pci_dev *pdev);
1644 1645
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,
1646
				   const char *name);
1647
void pcim_iounmap_regions(struct pci_dev *pdev, int mask);
A
Al Viro 已提交
1648

L
Linus Torvalds 已提交
1649
extern int pci_pci_problems;
A
Alan Cox 已提交
1650
#define PCIPCI_FAIL		1	/* No PCI PCI DMA */
L
Linus Torvalds 已提交
1651 1652 1653 1654
#define PCIPCI_TRITON		2
#define PCIPCI_NATOMA		4
#define PCIPCI_VIAETBF		8
#define PCIPCI_VSFX		16
A
Alan Cox 已提交
1655 1656
#define PCIPCI_ALIMAGIK		32	/* Need low latency setting */
#define PCIAGP_FAIL		64	/* No PCI to AGP DMA */
L
Linus Torvalds 已提交
1657

1658 1659
extern unsigned long pci_cardbus_io_size;
extern unsigned long pci_cardbus_mem_size;
B
Bill Pemberton 已提交
1660
extern u8 pci_dfl_cache_line_size;
1661
extern u8 pci_cache_line_size;
1662

1663 1664 1665
extern unsigned long pci_hotplug_io_size;
extern unsigned long pci_hotplug_mem_size;

1666
/* Architecture specific versions may override these (weak) */
1667 1668
int pcibios_add_platform_entries(struct pci_dev *dev);
void pcibios_disable_device(struct pci_dev *dev);
1669
void pcibios_set_master(struct pci_dev *dev);
1670 1671
int pcibios_set_pcie_reset_state(struct pci_dev *dev,
				 enum pcie_reset_state state);
M
Matthew Garrett 已提交
1672
int pcibios_add_device(struct pci_dev *dev);
1673
void pcibios_release_device(struct pci_dev *dev);
1674

1675 1676 1677 1678
#ifdef CONFIG_HIBERNATE_CALLBACKS
extern struct dev_pm_ops pcibios_pm_ops;
#endif

1679
#ifdef CONFIG_PCI_MMCONFIG
1680 1681
void __init pci_mmcfg_early_init(void);
void __init pci_mmcfg_late_init(void);
1682
#else
1683
static inline void pci_mmcfg_early_init(void) { }
1684 1685 1686
static inline void pci_mmcfg_late_init(void) { }
#endif

1687
int pci_ext_cfg_avail(void);
1688

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

1691
#ifdef CONFIG_PCI_IOV
1692 1693 1694 1695
int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn);
void pci_disable_sriov(struct pci_dev *dev);
irqreturn_t pci_sriov_migration(struct pci_dev *dev);
int pci_num_vf(struct pci_dev *dev);
1696
int pci_vfs_assigned(struct pci_dev *dev);
1697 1698
int pci_sriov_set_totalvfs(struct pci_dev *dev, u16 numvfs);
int pci_sriov_get_totalvfs(struct pci_dev *dev);
1699 1700 1701 1702 1703 1704 1705 1706
#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)
{
}
1707 1708 1709 1710
static inline irqreturn_t pci_sriov_migration(struct pci_dev *dev)
{
	return IRQ_NONE;
}
1711 1712 1713 1714
static inline int pci_num_vf(struct pci_dev *dev)
{
	return 0;
}
1715 1716 1717 1718
static inline int pci_vfs_assigned(struct pci_dev *dev)
{
	return 0;
}
1719 1720 1721 1722 1723 1724 1725 1726
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;
}
1727 1728
#endif

1729
#if defined(CONFIG_HOTPLUG_PCI) || defined(CONFIG_HOTPLUG_PCI_MODULE)
1730 1731
void pci_hp_create_module_link(struct pci_slot *pci_slot);
void pci_hp_remove_module_link(struct pci_slot *pci_slot);
1732 1733
#endif

K
Kenji Kaneshige 已提交
1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749
/**
 * 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 已提交
1750 1751 1752 1753
/**
 * pci_is_pcie - check if the PCI device is PCI Express capable
 * @dev: PCI device
 *
1754
 * Returns: true if the PCI device is PCI Express capable, false otherwise.
K
Kenji Kaneshige 已提交
1755 1756 1757
 */
static inline bool pci_is_pcie(struct pci_dev *dev)
{
1758
	return pci_pcie_cap(dev);
K
Kenji Kaneshige 已提交
1759 1760
}

1761 1762 1763 1764 1765 1766 1767 1768 1769
/**
 * pcie_caps_reg - get the PCIe Capabilities Register
 * @dev: PCI device
 */
static inline u16 pcie_caps_reg(const struct pci_dev *dev)
{
	return dev->pcie_flags_reg;
}

1770 1771 1772 1773 1774 1775
/**
 * pci_pcie_type - get the PCIe device/port type
 * @dev: PCI device
 */
static inline int pci_pcie_type(const struct pci_dev *dev)
{
1776
	return (pcie_caps_reg(dev) & PCI_EXP_FLAGS_TYPE) >> 4;
1777 1778
}

C
Chris Wright 已提交
1779
void pci_request_acs(void);
1780 1781 1782
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);
1783

1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805
#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
1806

1807 1808
#define PCI_VPD_INFO_FLD_HDR_SIZE	3

1809 1810 1811
#define PCI_VPD_RO_KEYWORD_PARTNO	"PN"
#define PCI_VPD_RO_KEYWORD_MFR_ID	"MN"
#define PCI_VPD_RO_KEYWORD_VENDOR0	"V0"
1812
#define PCI_VPD_RO_KEYWORD_CHKSUM	"RV"
1813

1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824
/**
 * 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);
}

1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835
/**
 * 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;
}

1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846
/**
 * 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];
}

1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858
/**
 * 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);

1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871
/**
 * 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);

1872 1873 1874
/* PCI <-> OF binding helpers */
#ifdef CONFIG_OF
struct device_node;
1875 1876 1877 1878
void pci_set_of_node(struct pci_dev *dev);
void pci_release_of_node(struct pci_dev *dev);
void pci_set_bus_of_node(struct pci_bus *bus);
void pci_release_bus_of_node(struct pci_bus *bus);
1879 1880

/* Arch may override this (weak) */
1881
struct device_node *pcibios_get_phb_of_node(struct pci_bus *bus);
1882

1883 1884
static inline struct device_node *
pci_device_to_OF_node(const struct pci_dev *pdev)
1885 1886 1887 1888
{
	return pdev ? pdev->dev.of_node : NULL;
}

1889 1890 1891 1892 1893
static inline struct device_node *pci_bus_to_OF_node(struct pci_bus *bus)
{
	return bus ? bus->dev.of_node : NULL;
}

1894 1895 1896 1897 1898 1899 1900
#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 已提交
1901 1902 1903 1904 1905 1906 1907
#ifdef CONFIG_EEH
static inline struct eeh_dev *pci_dev_to_eeh_dev(struct pci_dev *pdev)
{
	return pdev->dev.archdata.edev;
}
#endif

1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918
/**
 * 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 已提交
1919
#endif /* LINUX_PCI_H */