xref: /linux/include/linux/pci.h (revision c34e9ab9a612ee8b18273398ef75c207b01f516d)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  *	pci.h
4  *
5  *	PCI defines and function prototypes
6  *	Copyright 1994, Drew Eckhardt
7  *	Copyright 1997--1999 Martin Mares <mj@ucw.cz>
8  *
9  *	PCI Express ASPM defines and function prototypes
10  *	Copyright (c) 2007 Intel Corp.
11  *		Zhang Yanmin (yanmin.zhang@intel.com)
12  *		Shaohua Li (shaohua.li@intel.com)
13  *
14  *	For more information, please consult the following manuals (look at
15  *	http://www.pcisig.com/ for how to get them):
16  *
17  *	PCI BIOS Specification
18  *	PCI Local Bus Specification
19  *	PCI to PCI Bridge Specification
20  *	PCI Express Specification
21  *	PCI System Design Guide
22  */
23 #ifndef LINUX_PCI_H
24 #define LINUX_PCI_H
25 
26 #include <linux/args.h>
27 #include <linux/mod_devicetable.h>
28 
29 #include <linux/types.h>
30 #include <linux/init.h>
31 #include <linux/ioport.h>
32 #include <linux/list.h>
33 #include <linux/compiler.h>
34 #include <linux/errno.h>
35 #include <linux/kobject.h>
36 #include <linux/atomic.h>
37 #include <linux/device.h>
38 #include <linux/interrupt.h>
39 #include <linux/io.h>
40 #include <linux/resource_ext.h>
41 #include <linux/msi_api.h>
42 #include <uapi/linux/pci.h>
43 
44 #include <linux/pci_ids.h>
45 
46 #define PCI_STATUS_ERROR_BITS (PCI_STATUS_DETECTED_PARITY  | \
47 			       PCI_STATUS_SIG_SYSTEM_ERROR | \
48 			       PCI_STATUS_REC_MASTER_ABORT | \
49 			       PCI_STATUS_REC_TARGET_ABORT | \
50 			       PCI_STATUS_SIG_TARGET_ABORT | \
51 			       PCI_STATUS_PARITY)
52 
53 /* Number of reset methods used in pci_reset_fn_methods array in pci.c */
54 #define PCI_NUM_RESET_METHODS 8
55 
56 #define PCI_RESET_PROBE		true
57 #define PCI_RESET_DO_RESET	false
58 
59 /*
60  * The PCI interface treats multi-function devices as independent
61  * devices.  The slot/function address of each device is encoded
62  * in a single byte as follows:
63  *
64  *	7:3 = slot
65  *	2:0 = function
66  *
67  * PCI_DEVFN(), PCI_SLOT(), and PCI_FUNC() are defined in uapi/linux/pci.h.
68  * In the interest of not exposing interfaces to user-space unnecessarily,
69  * the following kernel-only defines are being added here.
70  */
71 #define PCI_DEVID(bus, devfn)	((((u16)(bus)) << 8) | (devfn))
72 /* return bus from PCI devid = ((u16)bus_number) << 8) | devfn */
73 #define PCI_BUS_NUM(x) (((x) >> 8) & 0xff)
74 
75 /* pci_slot represents a physical slot */
76 struct pci_slot {
77 	struct pci_bus		*bus;		/* Bus this slot is on */
78 	struct list_head	list;		/* Node in list of slots */
79 	struct hotplug_slot	*hotplug;	/* Hotplug info (move here) */
80 	unsigned char		number;		/* PCI_SLOT(pci_dev->devfn) */
81 	struct kobject		kobj;
82 };
83 
84 static inline const char *pci_slot_name(const struct pci_slot *slot)
85 {
86 	return kobject_name(&slot->kobj);
87 }
88 
89 /* File state for mmap()s on /proc/bus/pci/X/Y */
90 enum pci_mmap_state {
91 	pci_mmap_io,
92 	pci_mmap_mem
93 };
94 
95 /* For PCI devices, the region numbers are assigned this way: */
96 enum {
97 	/* #0-5: standard PCI resources */
98 	PCI_STD_RESOURCES,
99 	PCI_STD_RESOURCE_END = PCI_STD_RESOURCES + PCI_STD_NUM_BARS - 1,
100 
101 	/* #6: expansion ROM resource */
102 	PCI_ROM_RESOURCE,
103 
104 	/* Device-specific resources */
105 #ifdef CONFIG_PCI_IOV
106 	PCI_IOV_RESOURCES,
107 	PCI_IOV_RESOURCE_END = PCI_IOV_RESOURCES + PCI_SRIOV_NUM_BARS - 1,
108 #endif
109 
110 /* PCI-to-PCI (P2P) bridge windows */
111 #define PCI_BRIDGE_IO_WINDOW		(PCI_BRIDGE_RESOURCES + 0)
112 #define PCI_BRIDGE_MEM_WINDOW		(PCI_BRIDGE_RESOURCES + 1)
113 #define PCI_BRIDGE_PREF_MEM_WINDOW	(PCI_BRIDGE_RESOURCES + 2)
114 
115 /* CardBus bridge windows */
116 #define PCI_CB_BRIDGE_IO_0_WINDOW	(PCI_BRIDGE_RESOURCES + 0)
117 #define PCI_CB_BRIDGE_IO_1_WINDOW	(PCI_BRIDGE_RESOURCES + 1)
118 #define PCI_CB_BRIDGE_MEM_0_WINDOW	(PCI_BRIDGE_RESOURCES + 2)
119 #define PCI_CB_BRIDGE_MEM_1_WINDOW	(PCI_BRIDGE_RESOURCES + 3)
120 
121 /* Total number of bridge resources for P2P and CardBus */
122 #define PCI_BRIDGE_RESOURCE_NUM 4
123 
124 	/* Resources assigned to buses behind the bridge */
125 	PCI_BRIDGE_RESOURCES,
126 	PCI_BRIDGE_RESOURCE_END = PCI_BRIDGE_RESOURCES +
127 				  PCI_BRIDGE_RESOURCE_NUM - 1,
128 
129 	/* Total resources associated with a PCI device */
130 	PCI_NUM_RESOURCES,
131 
132 	/* Preserve this for compatibility */
133 	DEVICE_COUNT_RESOURCE = PCI_NUM_RESOURCES,
134 };
135 
136 /**
137  * enum pci_interrupt_pin - PCI INTx interrupt values
138  * @PCI_INTERRUPT_UNKNOWN: Unknown or unassigned interrupt
139  * @PCI_INTERRUPT_INTA: PCI INTA pin
140  * @PCI_INTERRUPT_INTB: PCI INTB pin
141  * @PCI_INTERRUPT_INTC: PCI INTC pin
142  * @PCI_INTERRUPT_INTD: PCI INTD pin
143  *
144  * Corresponds to values for legacy PCI INTx interrupts, as can be found in the
145  * PCI_INTERRUPT_PIN register.
146  */
147 enum pci_interrupt_pin {
148 	PCI_INTERRUPT_UNKNOWN,
149 	PCI_INTERRUPT_INTA,
150 	PCI_INTERRUPT_INTB,
151 	PCI_INTERRUPT_INTC,
152 	PCI_INTERRUPT_INTD,
153 };
154 
155 /* The number of legacy PCI INTx interrupts */
156 #define PCI_NUM_INTX	4
157 
158 /*
159  * Reading from a device that doesn't respond typically returns ~0.  A
160  * successful read from a device may also return ~0, so you need additional
161  * information to reliably identify errors.
162  */
163 #define PCI_ERROR_RESPONSE		(~0ULL)
164 #define PCI_SET_ERROR_RESPONSE(val)	(*(val) = ((typeof(*(val))) PCI_ERROR_RESPONSE))
165 #define PCI_POSSIBLE_ERROR(val)		((val) == ((typeof(val)) PCI_ERROR_RESPONSE))
166 
167 /*
168  * pci_power_t values must match the bits in the Capabilities PME_Support
169  * and Control/Status PowerState fields in the Power Management capability.
170  */
171 typedef int __bitwise pci_power_t;
172 
173 #define PCI_D0		((pci_power_t __force) 0)
174 #define PCI_D1		((pci_power_t __force) 1)
175 #define PCI_D2		((pci_power_t __force) 2)
176 #define PCI_D3hot	((pci_power_t __force) 3)
177 #define PCI_D3cold	((pci_power_t __force) 4)
178 #define PCI_UNKNOWN	((pci_power_t __force) 5)
179 #define PCI_POWER_ERROR	((pci_power_t __force) -1)
180 
181 /* Remember to update this when the list above changes! */
182 extern const char *pci_power_names[];
183 
184 static inline const char *pci_power_name(pci_power_t state)
185 {
186 	return pci_power_names[1 + (__force int) state];
187 }
188 
189 /**
190  * typedef pci_channel_state_t
191  *
192  * The pci_channel state describes connectivity between the CPU and
193  * the PCI device.  If some PCI bus between here and the PCI device
194  * has crashed or locked up, this info is reflected here.
195  */
196 typedef unsigned int __bitwise pci_channel_state_t;
197 
198 enum {
199 	/* I/O channel is in normal state */
200 	pci_channel_io_normal = (__force pci_channel_state_t) 1,
201 
202 	/* I/O to channel is blocked */
203 	pci_channel_io_frozen = (__force pci_channel_state_t) 2,
204 
205 	/* PCI card is dead */
206 	pci_channel_io_perm_failure = (__force pci_channel_state_t) 3,
207 };
208 
209 typedef unsigned int __bitwise pcie_reset_state_t;
210 
211 enum pcie_reset_state {
212 	/* Reset is NOT asserted (Use to deassert reset) */
213 	pcie_deassert_reset = (__force pcie_reset_state_t) 1,
214 
215 	/* Use #PERST to reset PCIe device */
216 	pcie_warm_reset = (__force pcie_reset_state_t) 2,
217 
218 	/* Use PCIe Hot Reset to reset device */
219 	pcie_hot_reset = (__force pcie_reset_state_t) 3
220 };
221 
222 typedef unsigned short __bitwise pci_dev_flags_t;
223 enum pci_dev_flags {
224 	/* INTX_DISABLE in PCI_COMMAND register disables MSI too */
225 	PCI_DEV_FLAGS_MSI_INTX_DISABLE_BUG = (__force pci_dev_flags_t) (1 << 0),
226 	/* Device configuration is irrevocably lost if disabled into D3 */
227 	PCI_DEV_FLAGS_NO_D3 = (__force pci_dev_flags_t) (1 << 1),
228 	/* Provide indication device is assigned by a Virtual Machine Manager */
229 	PCI_DEV_FLAGS_ASSIGNED = (__force pci_dev_flags_t) (1 << 2),
230 	/* Flag for quirk use to store if quirk-specific ACS is enabled */
231 	PCI_DEV_FLAGS_ACS_ENABLED_QUIRK = (__force pci_dev_flags_t) (1 << 3),
232 	/* Use a PCIe-to-PCI bridge alias even if !pci_is_pcie */
233 	PCI_DEV_FLAG_PCIE_BRIDGE_ALIAS = (__force pci_dev_flags_t) (1 << 5),
234 	/* Do not use bus resets for device */
235 	PCI_DEV_FLAGS_NO_BUS_RESET = (__force pci_dev_flags_t) (1 << 6),
236 	/* Do not use PM reset even if device advertises NoSoftRst- */
237 	PCI_DEV_FLAGS_NO_PM_RESET = (__force pci_dev_flags_t) (1 << 7),
238 	/* Get VPD from function 0 VPD */
239 	PCI_DEV_FLAGS_VPD_REF_F0 = (__force pci_dev_flags_t) (1 << 8),
240 	/* A non-root bridge where translation occurs, stop alias search here */
241 	PCI_DEV_FLAGS_BRIDGE_XLATE_ROOT = (__force pci_dev_flags_t) (1 << 9),
242 	/* Do not use FLR even if device advertises PCI_AF_CAP */
243 	PCI_DEV_FLAGS_NO_FLR_RESET = (__force pci_dev_flags_t) (1 << 10),
244 	/* Don't use Relaxed Ordering for TLPs directed at this device */
245 	PCI_DEV_FLAGS_NO_RELAXED_ORDERING = (__force pci_dev_flags_t) (1 << 11),
246 	/* Device does honor MSI masking despite saying otherwise */
247 	PCI_DEV_FLAGS_HAS_MSI_MASKING = (__force pci_dev_flags_t) (1 << 12),
248 };
249 
250 enum pci_irq_reroute_variant {
251 	INTEL_IRQ_REROUTE_VARIANT = 1,
252 	MAX_IRQ_REROUTE_VARIANTS = 3
253 };
254 
255 typedef unsigned short __bitwise pci_bus_flags_t;
256 enum pci_bus_flags {
257 	PCI_BUS_FLAGS_NO_MSI	= (__force pci_bus_flags_t) 1,
258 	PCI_BUS_FLAGS_NO_MMRBC	= (__force pci_bus_flags_t) 2,
259 	PCI_BUS_FLAGS_NO_AERSID	= (__force pci_bus_flags_t) 4,
260 	PCI_BUS_FLAGS_NO_EXTCFG	= (__force pci_bus_flags_t) 8,
261 };
262 
263 /* Values from Link Status register, PCIe r3.1, sec 7.8.8 */
264 enum pcie_link_width {
265 	PCIE_LNK_WIDTH_RESRV	= 0x00,
266 	PCIE_LNK_X1		= 0x01,
267 	PCIE_LNK_X2		= 0x02,
268 	PCIE_LNK_X4		= 0x04,
269 	PCIE_LNK_X8		= 0x08,
270 	PCIE_LNK_X12		= 0x0c,
271 	PCIE_LNK_X16		= 0x10,
272 	PCIE_LNK_X32		= 0x20,
273 	PCIE_LNK_WIDTH_UNKNOWN	= 0xff,
274 };
275 
276 /* See matching string table in pci_speed_string() */
277 enum pci_bus_speed {
278 	PCI_SPEED_33MHz			= 0x00,
279 	PCI_SPEED_66MHz			= 0x01,
280 	PCI_SPEED_66MHz_PCIX		= 0x02,
281 	PCI_SPEED_100MHz_PCIX		= 0x03,
282 	PCI_SPEED_133MHz_PCIX		= 0x04,
283 	PCI_SPEED_66MHz_PCIX_ECC	= 0x05,
284 	PCI_SPEED_100MHz_PCIX_ECC	= 0x06,
285 	PCI_SPEED_133MHz_PCIX_ECC	= 0x07,
286 	PCI_SPEED_66MHz_PCIX_266	= 0x09,
287 	PCI_SPEED_100MHz_PCIX_266	= 0x0a,
288 	PCI_SPEED_133MHz_PCIX_266	= 0x0b,
289 	AGP_UNKNOWN			= 0x0c,
290 	AGP_1X				= 0x0d,
291 	AGP_2X				= 0x0e,
292 	AGP_4X				= 0x0f,
293 	AGP_8X				= 0x10,
294 	PCI_SPEED_66MHz_PCIX_533	= 0x11,
295 	PCI_SPEED_100MHz_PCIX_533	= 0x12,
296 	PCI_SPEED_133MHz_PCIX_533	= 0x13,
297 	PCIE_SPEED_2_5GT		= 0x14,
298 	PCIE_SPEED_5_0GT		= 0x15,
299 	PCIE_SPEED_8_0GT		= 0x16,
300 	PCIE_SPEED_16_0GT		= 0x17,
301 	PCIE_SPEED_32_0GT		= 0x18,
302 	PCIE_SPEED_64_0GT		= 0x19,
303 	PCI_SPEED_UNKNOWN		= 0xff,
304 };
305 
306 enum pci_bus_speed pcie_get_speed_cap(struct pci_dev *dev);
307 enum pcie_link_width pcie_get_width_cap(struct pci_dev *dev);
308 
309 struct pci_vpd {
310 	struct mutex	lock;
311 	unsigned int	len;
312 	u8		cap;
313 };
314 
315 struct irq_affinity;
316 struct pcie_bwctrl_data;
317 struct pcie_link_state;
318 struct pci_sriov;
319 struct pci_p2pdma;
320 struct rcec_ea;
321 
322 /* struct pci_dev - describes a PCI device
323  *
324  * @supported_speeds:	PCIe Supported Link Speeds Vector (+ reserved 0 at
325  *			LSB). 0 when the supported speeds cannot be
326  *			determined (e.g., for Root Complex Integrated
327  *			Endpoints without the relevant Capability
328  *			Registers).
329  */
330 struct pci_dev {
331 	struct list_head bus_list;	/* Node in per-bus list */
332 	struct pci_bus	*bus;		/* Bus this device is on */
333 	struct pci_bus	*subordinate;	/* Bus this device bridges to */
334 
335 	void		*sysdata;	/* Hook for sys-specific extension */
336 	struct proc_dir_entry *procent;	/* Device entry in /proc/bus/pci */
337 	struct pci_slot	*slot;		/* Physical slot this device is in */
338 
339 	unsigned int	devfn;		/* Encoded device & function index */
340 	unsigned short	vendor;
341 	unsigned short	device;
342 	unsigned short	subsystem_vendor;
343 	unsigned short	subsystem_device;
344 	unsigned int	class;		/* 3 bytes: (base,sub,prog-if) */
345 	u8		revision;	/* PCI revision, low byte of class word */
346 	u8		hdr_type;	/* PCI header type (`multi' flag masked out) */
347 #ifdef CONFIG_PCIEAER
348 	u16		aer_cap;	/* AER capability offset */
349 	struct aer_stats *aer_stats;	/* AER stats for this device */
350 #endif
351 #ifdef CONFIG_PCIEPORTBUS
352 	struct rcec_ea	*rcec_ea;	/* RCEC cached endpoint association */
353 	struct pci_dev  *rcec;          /* Associated RCEC device */
354 #endif
355 	u32		devcap;		/* PCIe Device Capabilities */
356 	u8		pcie_cap;	/* PCIe capability offset */
357 	u8		msi_cap;	/* MSI capability offset */
358 	u8		msix_cap;	/* MSI-X capability offset */
359 	u8		pcie_mpss:3;	/* PCIe Max Payload Size Supported */
360 	u8		rom_base_reg;	/* Config register controlling ROM */
361 	u8		pin;		/* Interrupt pin this device uses */
362 	u16		pcie_flags_reg;	/* Cached PCIe Capabilities Register */
363 	unsigned long	*dma_alias_mask;/* Mask of enabled devfn aliases */
364 
365 	struct pci_driver *driver;	/* Driver bound to this device */
366 	u64		dma_mask;	/* Mask of the bits of bus address this
367 					   device implements.  Normally this is
368 					   0xffffffff.  You only need to change
369 					   this if your device has broken DMA
370 					   or supports 64-bit transfers.  */
371 
372 	struct device_dma_parameters dma_parms;
373 
374 	pci_power_t	current_state;	/* Current operating state. In ACPI,
375 					   this is D0-D3, D0 being fully
376 					   functional, and D3 being off. */
377 	u8		pm_cap;		/* PM capability offset */
378 	unsigned int	pme_support:5;	/* Bitmask of states from which PME#
379 					   can be generated */
380 	unsigned int	pme_poll:1;	/* Poll device's PME status bit */
381 	unsigned int	pinned:1;	/* Whether this dev is pinned */
382 	unsigned int	config_rrs_sv:1; /* Config RRS software visibility */
383 	unsigned int	imm_ready:1;	/* Supports Immediate Readiness */
384 	unsigned int	d1_support:1;	/* Low power state D1 is supported */
385 	unsigned int	d2_support:1;	/* Low power state D2 is supported */
386 	unsigned int	no_d1d2:1;	/* D1 and D2 are forbidden */
387 	unsigned int	no_d3cold:1;	/* D3cold is forbidden */
388 	unsigned int	bridge_d3:1;	/* Allow D3 for bridge */
389 	unsigned int	d3cold_allowed:1;	/* D3cold is allowed by user */
390 	unsigned int	mmio_always_on:1;	/* Disallow turning off io/mem
391 						   decoding during BAR sizing */
392 	unsigned int	wakeup_prepared:1;
393 	unsigned int	skip_bus_pm:1;	/* Internal: Skip bus-level PM */
394 	unsigned int	ignore_hotplug:1;	/* Ignore hotplug events */
395 	unsigned int	hotplug_user_indicators:1; /* SlotCtl indicators
396 						      controlled exclusively by
397 						      user sysfs */
398 	unsigned int	clear_retrain_link:1;	/* Need to clear Retrain Link
399 						   bit manually */
400 	unsigned int	d3hot_delay;	/* D3hot->D0 transition time in ms */
401 	unsigned int	d3cold_delay;	/* D3cold->D0 transition time in ms */
402 
403 	u16		l1ss;		/* L1SS Capability pointer */
404 #ifdef CONFIG_PCIEASPM
405 	struct pcie_link_state	*link_state;	/* ASPM link state */
406 	unsigned int	ltr_path:1;	/* Latency Tolerance Reporting
407 					   supported from root to here */
408 #endif
409 	unsigned int	pasid_no_tlp:1;		/* PASID works without TLP Prefix */
410 	unsigned int	eetlp_prefix_path:1;	/* End-to-End TLP Prefix */
411 
412 	pci_channel_state_t error_state;	/* Current connectivity state */
413 	struct device	dev;			/* Generic device interface */
414 
415 	int		cfg_size;		/* Size of config space */
416 
417 	/*
418 	 * Instead of touching interrupt line and base address registers
419 	 * directly, use the values stored here. They might be different!
420 	 */
421 	unsigned int	irq;
422 	struct resource resource[DEVICE_COUNT_RESOURCE]; /* I/O and memory regions + expansion ROMs */
423 	struct resource driver_exclusive_resource;	 /* driver exclusive resource ranges */
424 
425 	bool		match_driver;		/* Skip attaching driver */
426 
427 	unsigned int	transparent:1;		/* Subtractive decode bridge */
428 	unsigned int	io_window:1;		/* Bridge has I/O window */
429 	unsigned int	pref_window:1;		/* Bridge has pref mem window */
430 	unsigned int	pref_64_window:1;	/* Pref mem window is 64-bit */
431 	unsigned int	multifunction:1;	/* Multi-function device */
432 
433 	unsigned int	is_busmaster:1;		/* Is busmaster */
434 	unsigned int	no_msi:1;		/* May not use MSI */
435 	unsigned int	no_64bit_msi:1;		/* May only use 32-bit MSIs */
436 	unsigned int	block_cfg_access:1;	/* Config space access blocked */
437 	unsigned int	broken_parity_status:1;	/* Generates false positive parity */
438 	unsigned int	irq_reroute_variant:2;	/* Needs IRQ rerouting variant */
439 	unsigned int	msi_enabled:1;
440 	unsigned int	msix_enabled:1;
441 	unsigned int	ari_enabled:1;		/* ARI forwarding */
442 	unsigned int	ats_enabled:1;		/* Address Translation Svc */
443 	unsigned int	pasid_enabled:1;	/* Process Address Space ID */
444 	unsigned int	pri_enabled:1;		/* Page Request Interface */
445 	unsigned int	tph_enabled:1;		/* TLP Processing Hints */
446 	unsigned int	is_managed:1;		/* Managed via devres */
447 	unsigned int	is_msi_managed:1;	/* MSI release via devres installed */
448 	unsigned int	needs_freset:1;		/* Requires fundamental reset */
449 	unsigned int	state_saved:1;
450 	unsigned int	is_physfn:1;
451 	unsigned int	is_virtfn:1;
452 	unsigned int	is_hotplug_bridge:1;
453 	unsigned int	shpc_managed:1;		/* SHPC owned by shpchp */
454 	unsigned int	is_thunderbolt:1;	/* Thunderbolt controller */
455 	/*
456 	 * Devices marked being untrusted are the ones that can potentially
457 	 * execute DMA attacks and similar. They are typically connected
458 	 * through external ports such as Thunderbolt but not limited to
459 	 * that. When an IOMMU is enabled they should be getting full
460 	 * mappings to make sure they cannot access arbitrary memory.
461 	 */
462 	unsigned int	untrusted:1;
463 	/*
464 	 * Info from the platform, e.g., ACPI or device tree, may mark a
465 	 * device as "external-facing".  An external-facing device is
466 	 * itself internal but devices downstream from it are external.
467 	 */
468 	unsigned int	external_facing:1;
469 	unsigned int	broken_intx_masking:1;	/* INTx masking can't be used */
470 	unsigned int	io_window_1k:1;		/* Intel bridge 1K I/O windows */
471 	unsigned int	irq_managed:1;
472 	unsigned int	non_compliant_bars:1;	/* Broken BARs; ignore them */
473 	unsigned int	is_probed:1;		/* Device probing in progress */
474 	unsigned int	link_active_reporting:1;/* Device capable of reporting link active */
475 	unsigned int	no_vf_scan:1;		/* Don't scan for VFs after IOV enablement */
476 	unsigned int	no_command_memory:1;	/* No PCI_COMMAND_MEMORY */
477 	unsigned int	rom_bar_overlap:1;	/* ROM BAR disable broken */
478 	unsigned int	rom_attr_enabled:1;	/* Display of ROM attribute enabled? */
479 	pci_dev_flags_t dev_flags;
480 	atomic_t	enable_cnt;	/* pci_enable_device has been called */
481 
482 	spinlock_t	pcie_cap_lock;		/* Protects RMW ops in capability accessors */
483 	u32		saved_config_space[16]; /* Config space saved at suspend time */
484 	struct hlist_head saved_cap_space;
485 	struct bin_attribute *res_attr[DEVICE_COUNT_RESOURCE]; /* sysfs file for resources */
486 	struct bin_attribute *res_attr_wc[DEVICE_COUNT_RESOURCE]; /* sysfs file for WC mapping of resources */
487 
488 #ifdef CONFIG_HOTPLUG_PCI_PCIE
489 	unsigned int	broken_cmd_compl:1;	/* No compl for some cmds */
490 #endif
491 #ifdef CONFIG_PCIE_PTM
492 	u16		ptm_cap;		/* PTM Capability */
493 	unsigned int	ptm_root:1;
494 	unsigned int	ptm_enabled:1;
495 	u8		ptm_granularity;
496 #endif
497 #ifdef CONFIG_PCI_MSI
498 	void __iomem	*msix_base;
499 	raw_spinlock_t	msi_lock;
500 #endif
501 	struct pci_vpd	vpd;
502 #ifdef CONFIG_PCIE_DPC
503 	u16		dpc_cap;
504 	unsigned int	dpc_rp_extensions:1;
505 	u8		dpc_rp_log_size;
506 #endif
507 	struct pcie_bwctrl_data		*link_bwctrl;
508 #ifdef CONFIG_PCI_ATS
509 	union {
510 		struct pci_sriov	*sriov;		/* PF: SR-IOV info */
511 		struct pci_dev		*physfn;	/* VF: related PF */
512 	};
513 	u16		ats_cap;	/* ATS Capability offset */
514 	u8		ats_stu;	/* ATS Smallest Translation Unit */
515 #endif
516 #ifdef CONFIG_PCI_PRI
517 	u16		pri_cap;	/* PRI Capability offset */
518 	u32		pri_reqs_alloc; /* Number of PRI requests allocated */
519 	unsigned int	pasid_required:1; /* PRG Response PASID Required */
520 #endif
521 #ifdef CONFIG_PCI_PASID
522 	u16		pasid_cap;	/* PASID Capability offset */
523 	u16		pasid_features;
524 #endif
525 #ifdef CONFIG_PCI_P2PDMA
526 	struct pci_p2pdma __rcu *p2pdma;
527 #endif
528 #ifdef CONFIG_PCI_DOE
529 	struct xarray	doe_mbs;	/* Data Object Exchange mailboxes */
530 #endif
531 #ifdef CONFIG_PCI_NPEM
532 	struct npem	*npem;		/* Native PCIe Enclosure Management */
533 #endif
534 	u16		acs_cap;	/* ACS Capability offset */
535 	u8		supported_speeds; /* Supported Link Speeds Vector */
536 	phys_addr_t	rom;		/* Physical address if not from BAR */
537 	size_t		romlen;		/* Length if not from BAR */
538 	/*
539 	 * Driver name to force a match.  Do not set directly, because core
540 	 * frees it.  Use driver_set_override() to set or clear it.
541 	 */
542 	const char	*driver_override;
543 
544 	unsigned long	priv_flags;	/* Private flags for the PCI driver */
545 
546 	/* These methods index pci_reset_fn_methods[] */
547 	u8 reset_methods[PCI_NUM_RESET_METHODS]; /* In priority order */
548 
549 #ifdef CONFIG_PCIE_TPH
550 	u16		tph_cap;	/* TPH capability offset */
551 	u8		tph_mode;	/* TPH mode */
552 	u8		tph_req_type;	/* TPH requester type */
553 #endif
554 };
555 
556 static inline struct pci_dev *pci_physfn(struct pci_dev *dev)
557 {
558 #ifdef CONFIG_PCI_IOV
559 	if (dev->is_virtfn)
560 		dev = dev->physfn;
561 #endif
562 	return dev;
563 }
564 
565 struct pci_dev *pci_alloc_dev(struct pci_bus *bus);
566 
567 #define	to_pci_dev(n) container_of(n, struct pci_dev, dev)
568 #define for_each_pci_dev(d) while ((d = pci_get_device(PCI_ANY_ID, PCI_ANY_ID, d)) != NULL)
569 
570 static inline int pci_channel_offline(struct pci_dev *pdev)
571 {
572 	return (pdev->error_state != pci_channel_io_normal);
573 }
574 
575 /*
576  * Currently in ACPI spec, for each PCI host bridge, PCI Segment
577  * Group number is limited to a 16-bit value, therefore (int)-1 is
578  * not a valid PCI domain number, and can be used as a sentinel
579  * value indicating ->domain_nr is not set by the driver (and
580  * CONFIG_PCI_DOMAINS_GENERIC=y archs will set it with
581  * pci_bus_find_domain_nr()).
582  */
583 #define PCI_DOMAIN_NR_NOT_SET (-1)
584 
585 struct pci_host_bridge {
586 	struct device	dev;
587 	struct pci_bus	*bus;		/* Root bus */
588 	struct pci_ops	*ops;
589 	struct pci_ops	*child_ops;
590 	void		*sysdata;
591 	int		busnr;
592 	int		domain_nr;
593 	struct list_head windows;	/* resource_entry */
594 	struct list_head dma_ranges;	/* dma ranges resource list */
595 	u8 (*swizzle_irq)(struct pci_dev *, u8 *); /* Platform IRQ swizzler */
596 	int (*map_irq)(const struct pci_dev *, u8, u8);
597 	void (*release_fn)(struct pci_host_bridge *);
598 	void		*release_data;
599 	unsigned int	ignore_reset_delay:1;	/* For entire hierarchy */
600 	unsigned int	no_ext_tags:1;		/* No Extended Tags */
601 	unsigned int	no_inc_mrrs:1;		/* No Increase MRRS */
602 	unsigned int	native_aer:1;		/* OS may use PCIe AER */
603 	unsigned int	native_pcie_hotplug:1;	/* OS may use PCIe hotplug */
604 	unsigned int	native_shpc_hotplug:1;	/* OS may use SHPC hotplug */
605 	unsigned int	native_pme:1;		/* OS may use PCIe PME */
606 	unsigned int	native_ltr:1;		/* OS may use PCIe LTR */
607 	unsigned int	native_dpc:1;		/* OS may use PCIe DPC */
608 	unsigned int	native_cxl_error:1;	/* OS may use CXL RAS/Events */
609 	unsigned int	preserve_config:1;	/* Preserve FW resource setup */
610 	unsigned int	size_windows:1;		/* Enable root bus sizing */
611 	unsigned int	msi_domain:1;		/* Bridge wants MSI domain */
612 
613 	/* Resource alignment requirements */
614 	resource_size_t (*align_resource)(struct pci_dev *dev,
615 			const struct resource *res,
616 			resource_size_t start,
617 			resource_size_t size,
618 			resource_size_t align);
619 	unsigned long	private[] ____cacheline_aligned;
620 };
621 
622 #define	to_pci_host_bridge(n) container_of(n, struct pci_host_bridge, dev)
623 
624 static inline void *pci_host_bridge_priv(struct pci_host_bridge *bridge)
625 {
626 	return (void *)bridge->private;
627 }
628 
629 static inline struct pci_host_bridge *pci_host_bridge_from_priv(void *priv)
630 {
631 	return container_of(priv, struct pci_host_bridge, private);
632 }
633 
634 struct pci_host_bridge *pci_alloc_host_bridge(size_t priv);
635 struct pci_host_bridge *devm_pci_alloc_host_bridge(struct device *dev,
636 						   size_t priv);
637 void pci_free_host_bridge(struct pci_host_bridge *bridge);
638 struct pci_host_bridge *pci_find_host_bridge(struct pci_bus *bus);
639 
640 void pci_set_host_bridge_release(struct pci_host_bridge *bridge,
641 				 void (*release_fn)(struct pci_host_bridge *),
642 				 void *release_data);
643 
644 int pcibios_root_bridge_prepare(struct pci_host_bridge *bridge);
645 
646 #define PCI_REGION_FLAG_MASK	0x0fU	/* These bits of resource flags tell us the PCI region flags */
647 
648 struct pci_bus {
649 	struct list_head node;		/* Node in list of buses */
650 	struct pci_bus	*parent;	/* Parent bus this bridge is on */
651 	struct list_head children;	/* List of child buses */
652 	struct list_head devices;	/* List of devices on this bus */
653 	struct pci_dev	*self;		/* Bridge device as seen by parent */
654 	struct list_head slots;		/* List of slots on this bus;
655 					   protected by pci_slot_mutex */
656 	struct resource *resource[PCI_BRIDGE_RESOURCE_NUM];
657 	struct list_head resources;	/* Address space routed to this bus */
658 	struct resource busn_res;	/* Bus numbers routed to this bus */
659 
660 	struct pci_ops	*ops;		/* Configuration access functions */
661 	void		*sysdata;	/* Hook for sys-specific extension */
662 	struct proc_dir_entry *procdir;	/* Directory entry in /proc/bus/pci */
663 
664 	unsigned char	number;		/* Bus number */
665 	unsigned char	primary;	/* Number of primary bridge */
666 	unsigned char	max_bus_speed;	/* enum pci_bus_speed */
667 	unsigned char	cur_bus_speed;	/* enum pci_bus_speed */
668 #ifdef CONFIG_PCI_DOMAINS_GENERIC
669 	int		domain_nr;
670 #endif
671 
672 	char		name[48];
673 
674 	unsigned short	bridge_ctl;	/* Manage NO_ISA/FBB/et al behaviors */
675 	pci_bus_flags_t bus_flags;	/* Inherited by child buses */
676 	struct device		*bridge;
677 	struct device		dev;
678 	struct bin_attribute	*legacy_io;	/* Legacy I/O for this bus */
679 	struct bin_attribute	*legacy_mem;	/* Legacy mem */
680 	unsigned int		is_added:1;
681 	unsigned int		unsafe_warn:1;	/* warned about RW1C config write */
682 };
683 
684 #define to_pci_bus(n)	container_of(n, struct pci_bus, dev)
685 
686 static inline u16 pci_dev_id(struct pci_dev *dev)
687 {
688 	return PCI_DEVID(dev->bus->number, dev->devfn);
689 }
690 
691 /*
692  * Returns true if the PCI bus is root (behind host-PCI bridge),
693  * false otherwise
694  *
695  * Some code assumes that "bus->self == NULL" means that bus is a root bus.
696  * This is incorrect because "virtual" buses added for SR-IOV (via
697  * virtfn_add_bus()) have "bus->self == NULL" but are not root buses.
698  */
699 static inline bool pci_is_root_bus(struct pci_bus *pbus)
700 {
701 	return !(pbus->parent);
702 }
703 
704 /**
705  * pci_is_bridge - check if the PCI device is a bridge
706  * @dev: PCI device
707  *
708  * Return true if the PCI device is bridge whether it has subordinate
709  * or not.
710  */
711 static inline bool pci_is_bridge(struct pci_dev *dev)
712 {
713 	return dev->hdr_type == PCI_HEADER_TYPE_BRIDGE ||
714 		dev->hdr_type == PCI_HEADER_TYPE_CARDBUS;
715 }
716 
717 /**
718  * pci_is_vga - check if the PCI device is a VGA device
719  * @pdev: PCI device
720  *
721  * The PCI Code and ID Assignment spec, r1.15, secs 1.4 and 1.1, define
722  * VGA Base Class and Sub-Classes:
723  *
724  *   03 00  PCI_CLASS_DISPLAY_VGA      VGA-compatible or 8514-compatible
725  *   00 01  PCI_CLASS_NOT_DEFINED_VGA  VGA-compatible (before Class Code)
726  *
727  * Return true if the PCI device is a VGA device and uses the legacy VGA
728  * resources ([mem 0xa0000-0xbffff], [io 0x3b0-0x3bb], [io 0x3c0-0x3df] and
729  * aliases).
730  */
731 static inline bool pci_is_vga(struct pci_dev *pdev)
732 {
733 	if ((pdev->class >> 8) == PCI_CLASS_DISPLAY_VGA)
734 		return true;
735 
736 	if ((pdev->class >> 8) == PCI_CLASS_NOT_DEFINED_VGA)
737 		return true;
738 
739 	return false;
740 }
741 
742 #define for_each_pci_bridge(dev, bus)				\
743 	list_for_each_entry(dev, &bus->devices, bus_list)	\
744 		if (!pci_is_bridge(dev)) {} else
745 
746 static inline struct pci_dev *pci_upstream_bridge(struct pci_dev *dev)
747 {
748 	dev = pci_physfn(dev);
749 	if (pci_is_root_bus(dev->bus))
750 		return NULL;
751 
752 	return dev->bus->self;
753 }
754 
755 #ifdef CONFIG_PCI_MSI
756 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev)
757 {
758 	return pci_dev->msi_enabled || pci_dev->msix_enabled;
759 }
760 #else
761 static inline bool pci_dev_msi_enabled(struct pci_dev *pci_dev) { return false; }
762 #endif
763 
764 /* Error values that may be returned by PCI functions */
765 #define PCIBIOS_SUCCESSFUL		0x00
766 #define PCIBIOS_FUNC_NOT_SUPPORTED	0x81
767 #define PCIBIOS_BAD_VENDOR_ID		0x83
768 #define PCIBIOS_DEVICE_NOT_FOUND	0x86
769 #define PCIBIOS_BAD_REGISTER_NUMBER	0x87
770 #define PCIBIOS_SET_FAILED		0x88
771 #define PCIBIOS_BUFFER_TOO_SMALL	0x89
772 
773 /* Translate above to generic errno for passing back through non-PCI code */
774 static inline int pcibios_err_to_errno(int err)
775 {
776 	if (err <= PCIBIOS_SUCCESSFUL)
777 		return err; /* Assume already errno */
778 
779 	switch (err) {
780 	case PCIBIOS_FUNC_NOT_SUPPORTED:
781 		return -ENOENT;
782 	case PCIBIOS_BAD_VENDOR_ID:
783 		return -ENOTTY;
784 	case PCIBIOS_DEVICE_NOT_FOUND:
785 		return -ENODEV;
786 	case PCIBIOS_BAD_REGISTER_NUMBER:
787 		return -EFAULT;
788 	case PCIBIOS_SET_FAILED:
789 		return -EIO;
790 	case PCIBIOS_BUFFER_TOO_SMALL:
791 		return -ENOSPC;
792 	}
793 
794 	return -ERANGE;
795 }
796 
797 /* Low-level architecture-dependent routines */
798 
799 struct pci_ops {
800 	int (*add_bus)(struct pci_bus *bus);
801 	void (*remove_bus)(struct pci_bus *bus);
802 	void __iomem *(*map_bus)(struct pci_bus *bus, unsigned int devfn, int where);
803 	int (*read)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 *val);
804 	int (*write)(struct pci_bus *bus, unsigned int devfn, int where, int size, u32 val);
805 };
806 
807 /*
808  * ACPI needs to be able to access PCI config space before we've done a
809  * PCI bus scan and created pci_bus structures.
810  */
811 int raw_pci_read(unsigned int domain, unsigned int bus, unsigned int devfn,
812 		 int reg, int len, u32 *val);
813 int raw_pci_write(unsigned int domain, unsigned int bus, unsigned int devfn,
814 		  int reg, int len, u32 val);
815 
816 #ifdef CONFIG_ARCH_DMA_ADDR_T_64BIT
817 typedef u64 pci_bus_addr_t;
818 #else
819 typedef u32 pci_bus_addr_t;
820 #endif
821 
822 struct pci_bus_region {
823 	pci_bus_addr_t	start;
824 	pci_bus_addr_t	end;
825 };
826 
827 struct pci_dynids {
828 	spinlock_t		lock;	/* Protects list, index */
829 	struct list_head	list;	/* For IDs added at runtime */
830 };
831 
832 
833 /*
834  * PCI Error Recovery System (PCI-ERS).  If a PCI device driver provides
835  * a set of callbacks in struct pci_error_handlers, that device driver
836  * will be notified of PCI bus errors, and will be driven to recovery
837  * when an error occurs.
838  */
839 
840 typedef unsigned int __bitwise pci_ers_result_t;
841 
842 enum pci_ers_result {
843 	/* No result/none/not supported in device driver */
844 	PCI_ERS_RESULT_NONE = (__force pci_ers_result_t) 1,
845 
846 	/* Device driver can recover without slot reset */
847 	PCI_ERS_RESULT_CAN_RECOVER = (__force pci_ers_result_t) 2,
848 
849 	/* Device driver wants slot to be reset */
850 	PCI_ERS_RESULT_NEED_RESET = (__force pci_ers_result_t) 3,
851 
852 	/* Device has completely failed, is unrecoverable */
853 	PCI_ERS_RESULT_DISCONNECT = (__force pci_ers_result_t) 4,
854 
855 	/* Device driver is fully recovered and operational */
856 	PCI_ERS_RESULT_RECOVERED = (__force pci_ers_result_t) 5,
857 
858 	/* No AER capabilities registered for the driver */
859 	PCI_ERS_RESULT_NO_AER_DRIVER = (__force pci_ers_result_t) 6,
860 };
861 
862 /* PCI bus error event callbacks */
863 struct pci_error_handlers {
864 	/* PCI bus error detected on this device */
865 	pci_ers_result_t (*error_detected)(struct pci_dev *dev,
866 					   pci_channel_state_t error);
867 
868 	/* MMIO has been re-enabled, but not DMA */
869 	pci_ers_result_t (*mmio_enabled)(struct pci_dev *dev);
870 
871 	/* PCI slot has been reset */
872 	pci_ers_result_t (*slot_reset)(struct pci_dev *dev);
873 
874 	/* PCI function reset prepare or completed */
875 	void (*reset_prepare)(struct pci_dev *dev);
876 	void (*reset_done)(struct pci_dev *dev);
877 
878 	/* Device driver may resume normal operations */
879 	void (*resume)(struct pci_dev *dev);
880 
881 	/* Allow device driver to record more details of a correctable error */
882 	void (*cor_error_detected)(struct pci_dev *dev);
883 };
884 
885 
886 struct module;
887 
888 /**
889  * struct pci_driver - PCI driver structure
890  * @name:	Driver name.
891  * @id_table:	Pointer to table of device IDs the driver is
892  *		interested in.  Most drivers should export this
893  *		table using MODULE_DEVICE_TABLE(pci,...).
894  * @probe:	This probing function gets called (during execution
895  *		of pci_register_driver() for already existing
896  *		devices or later if a new device gets inserted) for
897  *		all PCI devices which match the ID table and are not
898  *		"owned" by the other drivers yet. This function gets
899  *		passed a "struct pci_dev \*" for each device whose
900  *		entry in the ID table matches the device. The probe
901  *		function returns zero when the driver chooses to
902  *		take "ownership" of the device or an error code
903  *		(negative number) otherwise.
904  *		The probe function always gets called from process
905  *		context, so it can sleep.
906  * @remove:	The remove() function gets called whenever a device
907  *		being handled by this driver is removed (either during
908  *		deregistration of the driver or when it's manually
909  *		pulled out of a hot-pluggable slot).
910  *		The remove function always gets called from process
911  *		context, so it can sleep.
912  * @suspend:	Put device into low power state.
913  * @resume:	Wake device from low power state.
914  *		(Please see Documentation/power/pci.rst for descriptions
915  *		of PCI Power Management and the related functions.)
916  * @shutdown:	Hook into reboot_notifier_list (kernel/sys.c).
917  *		Intended to stop any idling DMA operations.
918  *		Useful for enabling wake-on-lan (NIC) or changing
919  *		the power state of a device before reboot.
920  *		e.g. drivers/net/e100.c.
921  * @sriov_configure: Optional driver callback to allow configuration of
922  *		number of VFs to enable via sysfs "sriov_numvfs" file.
923  * @sriov_set_msix_vec_count: PF Driver callback to change number of MSI-X
924  *              vectors on a VF. Triggered via sysfs "sriov_vf_msix_count".
925  *              This will change MSI-X Table Size in the VF Message Control
926  *              registers.
927  * @sriov_get_vf_total_msix: PF driver callback to get the total number of
928  *              MSI-X vectors available for distribution to the VFs.
929  * @err_handler: See Documentation/PCI/pci-error-recovery.rst
930  * @groups:	Sysfs attribute groups.
931  * @dev_groups: Attributes attached to the device that will be
932  *              created once it is bound to the driver.
933  * @driver:	Driver model structure.
934  * @dynids:	List of dynamically added device IDs.
935  * @driver_managed_dma: Device driver doesn't use kernel DMA API for DMA.
936  *		For most device drivers, no need to care about this flag
937  *		as long as all DMAs are handled through the kernel DMA API.
938  *		For some special ones, for example VFIO drivers, they know
939  *		how to manage the DMA themselves and set this flag so that
940  *		the IOMMU layer will allow them to setup and manage their
941  *		own I/O address space.
942  */
943 struct pci_driver {
944 	const char		*name;
945 	const struct pci_device_id *id_table;	/* Must be non-NULL for probe to be called */
946 	int  (*probe)(struct pci_dev *dev, const struct pci_device_id *id);	/* New device inserted */
947 	void (*remove)(struct pci_dev *dev);	/* Device removed (NULL if not a hot-plug capable driver) */
948 	int  (*suspend)(struct pci_dev *dev, pm_message_t state);	/* Device suspended */
949 	int  (*resume)(struct pci_dev *dev);	/* Device woken up */
950 	void (*shutdown)(struct pci_dev *dev);
951 	int  (*sriov_configure)(struct pci_dev *dev, int num_vfs); /* On PF */
952 	int  (*sriov_set_msix_vec_count)(struct pci_dev *vf, int msix_vec_count); /* On PF */
953 	u32  (*sriov_get_vf_total_msix)(struct pci_dev *pf);
954 	const struct pci_error_handlers *err_handler;
955 	const struct attribute_group **groups;
956 	const struct attribute_group **dev_groups;
957 	struct device_driver	driver;
958 	struct pci_dynids	dynids;
959 	bool driver_managed_dma;
960 };
961 
962 #define to_pci_driver(__drv)	\
963 	( __drv ? container_of_const(__drv, struct pci_driver, driver) : NULL )
964 
965 /**
966  * PCI_DEVICE - macro used to describe a specific PCI device
967  * @vend: the 16 bit PCI Vendor ID
968  * @dev: the 16 bit PCI Device ID
969  *
970  * This macro is used to create a struct pci_device_id that matches a
971  * specific device.  The subvendor and subdevice fields will be set to
972  * PCI_ANY_ID.
973  */
974 #define PCI_DEVICE(vend,dev) \
975 	.vendor = (vend), .device = (dev), \
976 	.subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
977 
978 /**
979  * PCI_DEVICE_DRIVER_OVERRIDE - macro used to describe a PCI device with
980  *                              override_only flags.
981  * @vend: the 16 bit PCI Vendor ID
982  * @dev: the 16 bit PCI Device ID
983  * @driver_override: the 32 bit PCI Device override_only
984  *
985  * This macro is used to create a struct pci_device_id that matches only a
986  * driver_override device. The subvendor and subdevice fields will be set to
987  * PCI_ANY_ID.
988  */
989 #define PCI_DEVICE_DRIVER_OVERRIDE(vend, dev, driver_override) \
990 	.vendor = (vend), .device = (dev), .subvendor = PCI_ANY_ID, \
991 	.subdevice = PCI_ANY_ID, .override_only = (driver_override)
992 
993 /**
994  * PCI_DRIVER_OVERRIDE_DEVICE_VFIO - macro used to describe a VFIO
995  *                                   "driver_override" PCI device.
996  * @vend: the 16 bit PCI Vendor ID
997  * @dev: the 16 bit PCI Device ID
998  *
999  * This macro is used to create a struct pci_device_id that matches a
1000  * specific device. The subvendor and subdevice fields will be set to
1001  * PCI_ANY_ID and the driver_override will be set to
1002  * PCI_ID_F_VFIO_DRIVER_OVERRIDE.
1003  */
1004 #define PCI_DRIVER_OVERRIDE_DEVICE_VFIO(vend, dev) \
1005 	PCI_DEVICE_DRIVER_OVERRIDE(vend, dev, PCI_ID_F_VFIO_DRIVER_OVERRIDE)
1006 
1007 /**
1008  * PCI_DEVICE_SUB - macro used to describe a specific PCI device with subsystem
1009  * @vend: the 16 bit PCI Vendor ID
1010  * @dev: the 16 bit PCI Device ID
1011  * @subvend: the 16 bit PCI Subvendor ID
1012  * @subdev: the 16 bit PCI Subdevice ID
1013  *
1014  * This macro is used to create a struct pci_device_id that matches a
1015  * specific device with subsystem information.
1016  */
1017 #define PCI_DEVICE_SUB(vend, dev, subvend, subdev) \
1018 	.vendor = (vend), .device = (dev), \
1019 	.subvendor = (subvend), .subdevice = (subdev)
1020 
1021 /**
1022  * PCI_DEVICE_CLASS - macro used to describe a specific PCI device class
1023  * @dev_class: the class, subclass, prog-if triple for this device
1024  * @dev_class_mask: the class mask for this device
1025  *
1026  * This macro is used to create a struct pci_device_id that matches a
1027  * specific PCI class.  The vendor, device, subvendor, and subdevice
1028  * fields will be set to PCI_ANY_ID.
1029  */
1030 #define PCI_DEVICE_CLASS(dev_class,dev_class_mask) \
1031 	.class = (dev_class), .class_mask = (dev_class_mask), \
1032 	.vendor = PCI_ANY_ID, .device = PCI_ANY_ID, \
1033 	.subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID
1034 
1035 /**
1036  * PCI_VDEVICE - macro used to describe a specific PCI device in short form
1037  * @vend: the vendor name
1038  * @dev: the 16 bit PCI Device ID
1039  *
1040  * This macro is used to create a struct pci_device_id that matches a
1041  * specific PCI device.  The subvendor, and subdevice fields will be set
1042  * to PCI_ANY_ID. The macro allows the next field to follow as the device
1043  * private data.
1044  */
1045 #define PCI_VDEVICE(vend, dev) \
1046 	.vendor = PCI_VENDOR_ID_##vend, .device = (dev), \
1047 	.subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, 0, 0
1048 
1049 /**
1050  * PCI_DEVICE_DATA - macro used to describe a specific PCI device in very short form
1051  * @vend: the vendor name (without PCI_VENDOR_ID_ prefix)
1052  * @dev: the device name (without PCI_DEVICE_ID_<vend>_ prefix)
1053  * @data: the driver data to be filled
1054  *
1055  * This macro is used to create a struct pci_device_id that matches a
1056  * specific PCI device.  The subvendor, and subdevice fields will be set
1057  * to PCI_ANY_ID.
1058  */
1059 #define PCI_DEVICE_DATA(vend, dev, data) \
1060 	.vendor = PCI_VENDOR_ID_##vend, .device = PCI_DEVICE_ID_##vend##_##dev, \
1061 	.subvendor = PCI_ANY_ID, .subdevice = PCI_ANY_ID, 0, 0, \
1062 	.driver_data = (kernel_ulong_t)(data)
1063 
1064 enum {
1065 	PCI_REASSIGN_ALL_RSRC	= 0x00000001,	/* Ignore firmware setup */
1066 	PCI_REASSIGN_ALL_BUS	= 0x00000002,	/* Reassign all bus numbers */
1067 	PCI_PROBE_ONLY		= 0x00000004,	/* Use existing setup */
1068 	PCI_CAN_SKIP_ISA_ALIGN	= 0x00000008,	/* Don't do ISA alignment */
1069 	PCI_ENABLE_PROC_DOMAINS	= 0x00000010,	/* Enable domains in /proc */
1070 	PCI_COMPAT_DOMAIN_0	= 0x00000020,	/* ... except domain 0 */
1071 	PCI_SCAN_ALL_PCIE_DEVS	= 0x00000040,	/* Scan all, not just dev 0 */
1072 };
1073 
1074 #define PCI_IRQ_INTX		(1 << 0) /* Allow INTx interrupts */
1075 #define PCI_IRQ_MSI		(1 << 1) /* Allow MSI interrupts */
1076 #define PCI_IRQ_MSIX		(1 << 2) /* Allow MSI-X interrupts */
1077 #define PCI_IRQ_AFFINITY	(1 << 3) /* Auto-assign affinity */
1078 
1079 /* These external functions are only available when PCI support is enabled */
1080 #ifdef CONFIG_PCI
1081 
1082 extern unsigned int pci_flags;
1083 
1084 static inline void pci_set_flags(int flags) { pci_flags = flags; }
1085 static inline void pci_add_flags(int flags) { pci_flags |= flags; }
1086 static inline void pci_clear_flags(int flags) { pci_flags &= ~flags; }
1087 static inline int pci_has_flag(int flag) { return pci_flags & flag; }
1088 
1089 void pcie_bus_configure_settings(struct pci_bus *bus);
1090 
1091 enum pcie_bus_config_types {
1092 	PCIE_BUS_TUNE_OFF,	/* Don't touch MPS at all */
1093 	PCIE_BUS_DEFAULT,	/* Ensure MPS matches upstream bridge */
1094 	PCIE_BUS_SAFE,		/* Use largest MPS boot-time devices support */
1095 	PCIE_BUS_PERFORMANCE,	/* Use MPS and MRRS for best performance */
1096 	PCIE_BUS_PEER2PEER,	/* Set MPS = 128 for all devices */
1097 };
1098 
1099 extern enum pcie_bus_config_types pcie_bus_config;
1100 
1101 extern const struct bus_type pci_bus_type;
1102 
1103 /* Do NOT directly access these two variables, unless you are arch-specific PCI
1104  * code, or PCI core code. */
1105 extern struct list_head pci_root_buses;	/* List of all known PCI buses */
1106 /* Some device drivers need know if PCI is initiated */
1107 int no_pci_devices(void);
1108 
1109 void pcibios_resource_survey_bus(struct pci_bus *bus);
1110 void pcibios_bus_add_device(struct pci_dev *pdev);
1111 void pcibios_add_bus(struct pci_bus *bus);
1112 void pcibios_remove_bus(struct pci_bus *bus);
1113 void pcibios_fixup_bus(struct pci_bus *);
1114 int __must_check pcibios_enable_device(struct pci_dev *, int mask);
1115 /* Architecture-specific versions may override this (weak) */
1116 char *pcibios_setup(char *str);
1117 
1118 /* Used only when drivers/pci/setup.c is used */
1119 resource_size_t pcibios_align_resource(void *, const struct resource *,
1120 				resource_size_t,
1121 				resource_size_t);
1122 
1123 /* Weak but can be overridden by arch */
1124 void pci_fixup_cardbus(struct pci_bus *);
1125 
1126 /* Generic PCI functions used internally */
1127 
1128 void pcibios_resource_to_bus(struct pci_bus *bus, struct pci_bus_region *region,
1129 			     struct resource *res);
1130 void pcibios_bus_to_resource(struct pci_bus *bus, struct resource *res,
1131 			     struct pci_bus_region *region);
1132 void pcibios_scan_specific_bus(int busn);
1133 struct pci_bus *pci_find_bus(int domain, int busnr);
1134 void pci_bus_add_devices(const struct pci_bus *bus);
1135 struct pci_bus *pci_scan_bus(int bus, struct pci_ops *ops, void *sysdata);
1136 struct pci_bus *pci_create_root_bus(struct device *parent, int bus,
1137 				    struct pci_ops *ops, void *sysdata,
1138 				    struct list_head *resources);
1139 int pci_host_probe(struct pci_host_bridge *bridge);
1140 int pci_bus_insert_busn_res(struct pci_bus *b, int bus, int busmax);
1141 int pci_bus_update_busn_res_end(struct pci_bus *b, int busmax);
1142 void pci_bus_release_busn_res(struct pci_bus *b);
1143 struct pci_bus *pci_scan_root_bus(struct device *parent, int bus,
1144 				  struct pci_ops *ops, void *sysdata,
1145 				  struct list_head *resources);
1146 int pci_scan_root_bus_bridge(struct pci_host_bridge *bridge);
1147 struct pci_bus *pci_add_new_bus(struct pci_bus *parent, struct pci_dev *dev,
1148 				int busnr);
1149 struct pci_slot *pci_create_slot(struct pci_bus *parent, int slot_nr,
1150 				 const char *name,
1151 				 struct hotplug_slot *hotplug);
1152 void pci_destroy_slot(struct pci_slot *slot);
1153 #ifdef CONFIG_SYSFS
1154 void pci_dev_assign_slot(struct pci_dev *dev);
1155 #else
1156 static inline void pci_dev_assign_slot(struct pci_dev *dev) { }
1157 #endif
1158 int pci_scan_slot(struct pci_bus *bus, int devfn);
1159 struct pci_dev *pci_scan_single_device(struct pci_bus *bus, int devfn);
1160 void pci_device_add(struct pci_dev *dev, struct pci_bus *bus);
1161 unsigned int pci_scan_child_bus(struct pci_bus *bus);
1162 void pci_bus_add_device(struct pci_dev *dev);
1163 void pci_read_bridge_bases(struct pci_bus *child);
1164 struct resource *pci_find_parent_resource(const struct pci_dev *dev,
1165 					  struct resource *res);
1166 u8 pci_swizzle_interrupt_pin(const struct pci_dev *dev, u8 pin);
1167 int pci_get_interrupt_pin(struct pci_dev *dev, struct pci_dev **bridge);
1168 u8 pci_common_swizzle(struct pci_dev *dev, u8 *pinp);
1169 struct pci_dev *pci_dev_get(struct pci_dev *dev);
1170 void pci_dev_put(struct pci_dev *dev);
1171 DEFINE_FREE(pci_dev_put, struct pci_dev *, if (_T) pci_dev_put(_T))
1172 void pci_remove_bus(struct pci_bus *b);
1173 void pci_stop_and_remove_bus_device(struct pci_dev *dev);
1174 void pci_stop_and_remove_bus_device_locked(struct pci_dev *dev);
1175 void pci_stop_root_bus(struct pci_bus *bus);
1176 void pci_remove_root_bus(struct pci_bus *bus);
1177 void pci_setup_cardbus(struct pci_bus *bus);
1178 void pcibios_setup_bridge(struct pci_bus *bus, unsigned long type);
1179 void pci_sort_breadthfirst(void);
1180 #define dev_is_pci(d) ((d)->bus == &pci_bus_type)
1181 #define dev_is_pf(d) ((dev_is_pci(d) ? to_pci_dev(d)->is_physfn : false))
1182 
1183 /* Generic PCI functions exported to card drivers */
1184 
1185 u8 pci_bus_find_capability(struct pci_bus *bus, unsigned int devfn, int cap);
1186 u8 pci_find_capability(struct pci_dev *dev, int cap);
1187 u8 pci_find_next_capability(struct pci_dev *dev, u8 pos, int cap);
1188 u8 pci_find_ht_capability(struct pci_dev *dev, int ht_cap);
1189 u8 pci_find_next_ht_capability(struct pci_dev *dev, u8 pos, int ht_cap);
1190 u16 pci_find_ext_capability(struct pci_dev *dev, int cap);
1191 u16 pci_find_next_ext_capability(struct pci_dev *dev, u16 pos, int cap);
1192 struct pci_bus *pci_find_next_bus(const struct pci_bus *from);
1193 u16 pci_find_vsec_capability(struct pci_dev *dev, u16 vendor, int cap);
1194 u16 pci_find_dvsec_capability(struct pci_dev *dev, u16 vendor, u16 dvsec);
1195 
1196 u64 pci_get_dsn(struct pci_dev *dev);
1197 
1198 struct pci_dev *pci_get_device(unsigned int vendor, unsigned int device,
1199 			       struct pci_dev *from);
1200 struct pci_dev *pci_get_subsys(unsigned int vendor, unsigned int device,
1201 			       unsigned int ss_vendor, unsigned int ss_device,
1202 			       struct pci_dev *from);
1203 struct pci_dev *pci_get_slot(struct pci_bus *bus, unsigned int devfn);
1204 struct pci_dev *pci_get_domain_bus_and_slot(int domain, unsigned int bus,
1205 					    unsigned int devfn);
1206 struct pci_dev *pci_get_class(unsigned int class, struct pci_dev *from);
1207 struct pci_dev *pci_get_base_class(unsigned int class, struct pci_dev *from);
1208 
1209 int pci_dev_present(const struct pci_device_id *ids);
1210 
1211 int pci_bus_read_config_byte(struct pci_bus *bus, unsigned int devfn,
1212 			     int where, u8 *val);
1213 int pci_bus_read_config_word(struct pci_bus *bus, unsigned int devfn,
1214 			     int where, u16 *val);
1215 int pci_bus_read_config_dword(struct pci_bus *bus, unsigned int devfn,
1216 			      int where, u32 *val);
1217 int pci_bus_write_config_byte(struct pci_bus *bus, unsigned int devfn,
1218 			      int where, u8 val);
1219 int pci_bus_write_config_word(struct pci_bus *bus, unsigned int devfn,
1220 			      int where, u16 val);
1221 int pci_bus_write_config_dword(struct pci_bus *bus, unsigned int devfn,
1222 			       int where, u32 val);
1223 
1224 int pci_generic_config_read(struct pci_bus *bus, unsigned int devfn,
1225 			    int where, int size, u32 *val);
1226 int pci_generic_config_write(struct pci_bus *bus, unsigned int devfn,
1227 			    int where, int size, u32 val);
1228 int pci_generic_config_read32(struct pci_bus *bus, unsigned int devfn,
1229 			      int where, int size, u32 *val);
1230 int pci_generic_config_write32(struct pci_bus *bus, unsigned int devfn,
1231 			       int where, int size, u32 val);
1232 
1233 struct pci_ops *pci_bus_set_ops(struct pci_bus *bus, struct pci_ops *ops);
1234 
1235 int pci_read_config_byte(const struct pci_dev *dev, int where, u8 *val);
1236 int pci_read_config_word(const struct pci_dev *dev, int where, u16 *val);
1237 int pci_read_config_dword(const struct pci_dev *dev, int where, u32 *val);
1238 int pci_write_config_byte(const struct pci_dev *dev, int where, u8 val);
1239 int pci_write_config_word(const struct pci_dev *dev, int where, u16 val);
1240 int pci_write_config_dword(const struct pci_dev *dev, int where, u32 val);
1241 void pci_clear_and_set_config_dword(const struct pci_dev *dev, int pos,
1242 				    u32 clear, u32 set);
1243 
1244 int pcie_capability_read_word(struct pci_dev *dev, int pos, u16 *val);
1245 int pcie_capability_read_dword(struct pci_dev *dev, int pos, u32 *val);
1246 int pcie_capability_write_word(struct pci_dev *dev, int pos, u16 val);
1247 int pcie_capability_write_dword(struct pci_dev *dev, int pos, u32 val);
1248 int pcie_capability_clear_and_set_word_unlocked(struct pci_dev *dev, int pos,
1249 						u16 clear, u16 set);
1250 int pcie_capability_clear_and_set_word_locked(struct pci_dev *dev, int pos,
1251 					      u16 clear, u16 set);
1252 int pcie_capability_clear_and_set_dword(struct pci_dev *dev, int pos,
1253 					u32 clear, u32 set);
1254 
1255 /**
1256  * pcie_capability_clear_and_set_word - RMW accessor for PCI Express Capability Registers
1257  * @dev:	PCI device structure of the PCI Express device
1258  * @pos:	PCI Express Capability Register
1259  * @clear:	Clear bitmask
1260  * @set:	Set bitmask
1261  *
1262  * Perform a Read-Modify-Write (RMW) operation using @clear and @set
1263  * bitmasks on PCI Express Capability Register at @pos. Certain PCI Express
1264  * Capability Registers are accessed concurrently in RMW fashion, hence
1265  * require locking which is handled transparently to the caller.
1266  */
1267 static inline int pcie_capability_clear_and_set_word(struct pci_dev *dev,
1268 						     int pos,
1269 						     u16 clear, u16 set)
1270 {
1271 	switch (pos) {
1272 	case PCI_EXP_LNKCTL:
1273 	case PCI_EXP_LNKCTL2:
1274 	case PCI_EXP_RTCTL:
1275 		return pcie_capability_clear_and_set_word_locked(dev, pos,
1276 								 clear, set);
1277 	default:
1278 		return pcie_capability_clear_and_set_word_unlocked(dev, pos,
1279 								   clear, set);
1280 	}
1281 }
1282 
1283 static inline int pcie_capability_set_word(struct pci_dev *dev, int pos,
1284 					   u16 set)
1285 {
1286 	return pcie_capability_clear_and_set_word(dev, pos, 0, set);
1287 }
1288 
1289 static inline int pcie_capability_set_dword(struct pci_dev *dev, int pos,
1290 					    u32 set)
1291 {
1292 	return pcie_capability_clear_and_set_dword(dev, pos, 0, set);
1293 }
1294 
1295 static inline int pcie_capability_clear_word(struct pci_dev *dev, int pos,
1296 					     u16 clear)
1297 {
1298 	return pcie_capability_clear_and_set_word(dev, pos, clear, 0);
1299 }
1300 
1301 static inline int pcie_capability_clear_dword(struct pci_dev *dev, int pos,
1302 					      u32 clear)
1303 {
1304 	return pcie_capability_clear_and_set_dword(dev, pos, clear, 0);
1305 }
1306 
1307 /* User-space driven config access */
1308 int pci_user_read_config_byte(struct pci_dev *dev, int where, u8 *val);
1309 int pci_user_read_config_word(struct pci_dev *dev, int where, u16 *val);
1310 int pci_user_read_config_dword(struct pci_dev *dev, int where, u32 *val);
1311 int pci_user_write_config_byte(struct pci_dev *dev, int where, u8 val);
1312 int pci_user_write_config_word(struct pci_dev *dev, int where, u16 val);
1313 int pci_user_write_config_dword(struct pci_dev *dev, int where, u32 val);
1314 
1315 int __must_check pci_enable_device(struct pci_dev *dev);
1316 int __must_check pci_enable_device_mem(struct pci_dev *dev);
1317 int __must_check pci_reenable_device(struct pci_dev *);
1318 int __must_check pcim_enable_device(struct pci_dev *pdev);
1319 void pcim_pin_device(struct pci_dev *pdev);
1320 
1321 static inline bool pci_intx_mask_supported(struct pci_dev *pdev)
1322 {
1323 	/*
1324 	 * INTx masking is supported if PCI_COMMAND_INTX_DISABLE is
1325 	 * writable and no quirk has marked the feature broken.
1326 	 */
1327 	return !pdev->broken_intx_masking;
1328 }
1329 
1330 static inline int pci_is_enabled(struct pci_dev *pdev)
1331 {
1332 	return (atomic_read(&pdev->enable_cnt) > 0);
1333 }
1334 
1335 static inline int pci_is_managed(struct pci_dev *pdev)
1336 {
1337 	return pdev->is_managed;
1338 }
1339 
1340 void pci_disable_device(struct pci_dev *dev);
1341 
1342 extern unsigned int pcibios_max_latency;
1343 void pci_set_master(struct pci_dev *dev);
1344 void pci_clear_master(struct pci_dev *dev);
1345 
1346 int pci_set_pcie_reset_state(struct pci_dev *dev, enum pcie_reset_state state);
1347 int pci_set_cacheline_size(struct pci_dev *dev);
1348 int __must_check pci_set_mwi(struct pci_dev *dev);
1349 int __must_check pcim_set_mwi(struct pci_dev *dev);
1350 int pci_try_set_mwi(struct pci_dev *dev);
1351 void pci_clear_mwi(struct pci_dev *dev);
1352 void pci_disable_parity(struct pci_dev *dev);
1353 void pci_intx(struct pci_dev *dev, int enable);
1354 bool pci_check_and_mask_intx(struct pci_dev *dev);
1355 bool pci_check_and_unmask_intx(struct pci_dev *dev);
1356 int pci_wait_for_pending(struct pci_dev *dev, int pos, u16 mask);
1357 int pci_wait_for_pending_transaction(struct pci_dev *dev);
1358 int pcix_get_max_mmrbc(struct pci_dev *dev);
1359 int pcix_get_mmrbc(struct pci_dev *dev);
1360 int pcix_set_mmrbc(struct pci_dev *dev, int mmrbc);
1361 int pcie_get_readrq(struct pci_dev *dev);
1362 int pcie_set_readrq(struct pci_dev *dev, int rq);
1363 int pcie_get_mps(struct pci_dev *dev);
1364 int pcie_set_mps(struct pci_dev *dev, int mps);
1365 u32 pcie_bandwidth_available(struct pci_dev *dev, struct pci_dev **limiting_dev,
1366 			     enum pci_bus_speed *speed,
1367 			     enum pcie_link_width *width);
1368 int pcie_link_speed_mbps(struct pci_dev *pdev);
1369 void pcie_print_link_status(struct pci_dev *dev);
1370 int pcie_reset_flr(struct pci_dev *dev, bool probe);
1371 int pcie_flr(struct pci_dev *dev);
1372 int __pci_reset_function_locked(struct pci_dev *dev);
1373 int pci_reset_function(struct pci_dev *dev);
1374 int pci_reset_function_locked(struct pci_dev *dev);
1375 int pci_try_reset_function(struct pci_dev *dev);
1376 int pci_probe_reset_slot(struct pci_slot *slot);
1377 int pci_probe_reset_bus(struct pci_bus *bus);
1378 int pci_reset_bus(struct pci_dev *dev);
1379 void pci_reset_secondary_bus(struct pci_dev *dev);
1380 void pcibios_reset_secondary_bus(struct pci_dev *dev);
1381 void pci_update_resource(struct pci_dev *dev, int resno);
1382 int __must_check pci_assign_resource(struct pci_dev *dev, int i);
1383 int __must_check pci_reassign_resource(struct pci_dev *dev, int i, resource_size_t add_size, resource_size_t align);
1384 void pci_release_resource(struct pci_dev *dev, int resno);
1385 static inline int pci_rebar_bytes_to_size(u64 bytes)
1386 {
1387 	bytes = roundup_pow_of_two(bytes);
1388 
1389 	/* Return BAR size as defined in the resizable BAR specification */
1390 	return max(ilog2(bytes), 20) - 20;
1391 }
1392 
1393 u32 pci_rebar_get_possible_sizes(struct pci_dev *pdev, int bar);
1394 int __must_check pci_resize_resource(struct pci_dev *dev, int i, int size);
1395 int pci_select_bars(struct pci_dev *dev, unsigned long flags);
1396 bool pci_device_is_present(struct pci_dev *pdev);
1397 void pci_ignore_hotplug(struct pci_dev *dev);
1398 struct pci_dev *pci_real_dma_dev(struct pci_dev *dev);
1399 int pci_status_get_and_clear_errors(struct pci_dev *pdev);
1400 
1401 int __printf(6, 7) pci_request_irq(struct pci_dev *dev, unsigned int nr,
1402 		irq_handler_t handler, irq_handler_t thread_fn, void *dev_id,
1403 		const char *fmt, ...);
1404 void pci_free_irq(struct pci_dev *dev, unsigned int nr, void *dev_id);
1405 
1406 /* ROM control related routines */
1407 int pci_enable_rom(struct pci_dev *pdev);
1408 void pci_disable_rom(struct pci_dev *pdev);
1409 void __iomem __must_check *pci_map_rom(struct pci_dev *pdev, size_t *size);
1410 void pci_unmap_rom(struct pci_dev *pdev, void __iomem *rom);
1411 
1412 /* Power management related routines */
1413 int pci_save_state(struct pci_dev *dev);
1414 void pci_restore_state(struct pci_dev *dev);
1415 struct pci_saved_state *pci_store_saved_state(struct pci_dev *dev);
1416 int pci_load_saved_state(struct pci_dev *dev,
1417 			 struct pci_saved_state *state);
1418 int pci_load_and_free_saved_state(struct pci_dev *dev,
1419 				  struct pci_saved_state **state);
1420 int pci_platform_power_transition(struct pci_dev *dev, pci_power_t state);
1421 int pci_set_power_state(struct pci_dev *dev, pci_power_t state);
1422 int pci_set_power_state_locked(struct pci_dev *dev, pci_power_t state);
1423 pci_power_t pci_choose_state(struct pci_dev *dev, pm_message_t state);
1424 bool pci_pme_capable(struct pci_dev *dev, pci_power_t state);
1425 void pci_pme_active(struct pci_dev *dev, bool enable);
1426 int pci_enable_wake(struct pci_dev *dev, pci_power_t state, bool enable);
1427 int pci_wake_from_d3(struct pci_dev *dev, bool enable);
1428 int pci_prepare_to_sleep(struct pci_dev *dev);
1429 int pci_back_from_sleep(struct pci_dev *dev);
1430 bool pci_dev_run_wake(struct pci_dev *dev);
1431 void pci_d3cold_enable(struct pci_dev *dev);
1432 void pci_d3cold_disable(struct pci_dev *dev);
1433 bool pcie_relaxed_ordering_enabled(struct pci_dev *dev);
1434 void pci_resume_bus(struct pci_bus *bus);
1435 void pci_bus_set_current_state(struct pci_bus *bus, pci_power_t state);
1436 
1437 /* For use by arch with custom probe code */
1438 void set_pcie_port_type(struct pci_dev *pdev);
1439 void set_pcie_hotplug_bridge(struct pci_dev *pdev);
1440 
1441 /* Functions for PCI Hotplug drivers to use */
1442 unsigned int pci_rescan_bus_bridge_resize(struct pci_dev *bridge);
1443 unsigned int pci_rescan_bus(struct pci_bus *bus);
1444 void pci_lock_rescan_remove(void);
1445 void pci_unlock_rescan_remove(void);
1446 
1447 /* Vital Product Data routines */
1448 ssize_t pci_read_vpd(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
1449 ssize_t pci_write_vpd(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
1450 ssize_t pci_read_vpd_any(struct pci_dev *dev, loff_t pos, size_t count, void *buf);
1451 ssize_t pci_write_vpd_any(struct pci_dev *dev, loff_t pos, size_t count, const void *buf);
1452 
1453 /* Helper functions for low-level code (drivers/pci/setup-[bus,res].c) */
1454 resource_size_t pcibios_retrieve_fw_addr(struct pci_dev *dev, int idx);
1455 void pci_bus_assign_resources(const struct pci_bus *bus);
1456 void pci_bus_claim_resources(struct pci_bus *bus);
1457 void pci_bus_size_bridges(struct pci_bus *bus);
1458 int pci_claim_resource(struct pci_dev *, int);
1459 int pci_claim_bridge_resource(struct pci_dev *bridge, int i);
1460 void pci_assign_unassigned_resources(void);
1461 void pci_assign_unassigned_bridge_resources(struct pci_dev *bridge);
1462 void pci_assign_unassigned_bus_resources(struct pci_bus *bus);
1463 void pci_assign_unassigned_root_bus_resources(struct pci_bus *bus);
1464 int pci_reassign_bridge_resources(struct pci_dev *bridge, unsigned long type);
1465 int pci_enable_resources(struct pci_dev *, int mask);
1466 void pci_assign_irq(struct pci_dev *dev);
1467 struct resource *pci_find_resource(struct pci_dev *dev, struct resource *res);
1468 #define HAVE_PCI_REQ_REGIONS	2
1469 int __must_check pci_request_regions(struct pci_dev *, const char *);
1470 int __must_check pci_request_regions_exclusive(struct pci_dev *, const char *);
1471 void pci_release_regions(struct pci_dev *);
1472 int __must_check pci_request_region(struct pci_dev *, int, const char *);
1473 void pci_release_region(struct pci_dev *, int);
1474 int pci_request_selected_regions(struct pci_dev *, int, const char *);
1475 int pci_request_selected_regions_exclusive(struct pci_dev *, int, const char *);
1476 void pci_release_selected_regions(struct pci_dev *, int);
1477 
1478 static inline __must_check struct resource *
1479 pci_request_config_region_exclusive(struct pci_dev *pdev, unsigned int offset,
1480 				    unsigned int len, const char *name)
1481 {
1482 	return __request_region(&pdev->driver_exclusive_resource, offset, len,
1483 				name, IORESOURCE_EXCLUSIVE);
1484 }
1485 
1486 static inline void pci_release_config_region(struct pci_dev *pdev,
1487 					     unsigned int offset,
1488 					     unsigned int len)
1489 {
1490 	__release_region(&pdev->driver_exclusive_resource, offset, len);
1491 }
1492 
1493 /* drivers/pci/bus.c */
1494 void pci_add_resource(struct list_head *resources, struct resource *res);
1495 void pci_add_resource_offset(struct list_head *resources, struct resource *res,
1496 			     resource_size_t offset);
1497 void pci_free_resource_list(struct list_head *resources);
1498 void pci_bus_add_resource(struct pci_bus *bus, struct resource *res);
1499 struct resource *pci_bus_resource_n(const struct pci_bus *bus, int n);
1500 void pci_bus_remove_resources(struct pci_bus *bus);
1501 void pci_bus_remove_resource(struct pci_bus *bus, struct resource *res);
1502 int devm_request_pci_bus_resources(struct device *dev,
1503 				   struct list_head *resources);
1504 
1505 /* Temporary until new and working PCI SBR API in place */
1506 int pci_bridge_secondary_bus_reset(struct pci_dev *dev);
1507 
1508 #define __pci_bus_for_each_res0(bus, res, ...)				\
1509 	for (unsigned int __b = 0;					\
1510 	     (res = pci_bus_resource_n(bus, __b)) || __b < PCI_BRIDGE_RESOURCE_NUM; \
1511 	     __b++)
1512 
1513 #define __pci_bus_for_each_res1(bus, res, __b)				\
1514 	for (__b = 0;							\
1515 	     (res = pci_bus_resource_n(bus, __b)) || __b < PCI_BRIDGE_RESOURCE_NUM; \
1516 	     __b++)
1517 
1518 /**
1519  * pci_bus_for_each_resource - iterate over PCI bus resources
1520  * @bus: the PCI bus
1521  * @res: pointer to the current resource
1522  * @...: optional index of the current resource
1523  *
1524  * Iterate over PCI bus resources. The first part is to go over PCI bus
1525  * resource array, which has at most the %PCI_BRIDGE_RESOURCE_NUM entries.
1526  * After that continue with the separate list of the additional resources,
1527  * if not empty. That's why the Logical OR is being used.
1528  *
1529  * Possible usage:
1530  *
1531  *	struct pci_bus *bus = ...;
1532  *	struct resource *res;
1533  *	unsigned int i;
1534  *
1535  * 	// With optional index
1536  * 	pci_bus_for_each_resource(bus, res, i)
1537  * 		pr_info("PCI bus resource[%u]: %pR\n", i, res);
1538  *
1539  * 	// Without index
1540  * 	pci_bus_for_each_resource(bus, res)
1541  * 		_do_something_(res);
1542  */
1543 #define pci_bus_for_each_resource(bus, res, ...)			\
1544 	CONCATENATE(__pci_bus_for_each_res, COUNT_ARGS(__VA_ARGS__))	\
1545 		    (bus, res, __VA_ARGS__)
1546 
1547 int __must_check pci_bus_alloc_resource(struct pci_bus *bus,
1548 			struct resource *res, resource_size_t size,
1549 			resource_size_t align, resource_size_t min,
1550 			unsigned long type_mask,
1551 			resource_alignf alignf,
1552 			void *alignf_data);
1553 
1554 
1555 int pci_register_io_range(const struct fwnode_handle *fwnode, phys_addr_t addr,
1556 			resource_size_t size);
1557 unsigned long pci_address_to_pio(phys_addr_t addr);
1558 phys_addr_t pci_pio_to_address(unsigned long pio);
1559 int pci_remap_iospace(const struct resource *res, phys_addr_t phys_addr);
1560 int devm_pci_remap_iospace(struct device *dev, const struct resource *res,
1561 			   phys_addr_t phys_addr);
1562 void pci_unmap_iospace(struct resource *res);
1563 void __iomem *devm_pci_remap_cfgspace(struct device *dev,
1564 				      resource_size_t offset,
1565 				      resource_size_t size);
1566 void __iomem *devm_pci_remap_cfg_resource(struct device *dev,
1567 					  struct resource *res);
1568 
1569 static inline pci_bus_addr_t pci_bus_address(struct pci_dev *pdev, int bar)
1570 {
1571 	struct pci_bus_region region;
1572 
1573 	pcibios_resource_to_bus(pdev->bus, &region, &pdev->resource[bar]);
1574 	return region.start;
1575 }
1576 
1577 /* Proper probing supporting hot-pluggable devices */
1578 int __must_check __pci_register_driver(struct pci_driver *, struct module *,
1579 				       const char *mod_name);
1580 
1581 /* pci_register_driver() must be a macro so KBUILD_MODNAME can be expanded */
1582 #define pci_register_driver(driver)		\
1583 	__pci_register_driver(driver, THIS_MODULE, KBUILD_MODNAME)
1584 
1585 void pci_unregister_driver(struct pci_driver *dev);
1586 
1587 /**
1588  * module_pci_driver() - Helper macro for registering a PCI driver
1589  * @__pci_driver: pci_driver struct
1590  *
1591  * Helper macro for PCI drivers which do not do anything special in module
1592  * init/exit. This eliminates a lot of boilerplate. Each module may only
1593  * use this macro once, and calling it replaces module_init() and module_exit()
1594  */
1595 #define module_pci_driver(__pci_driver) \
1596 	module_driver(__pci_driver, pci_register_driver, pci_unregister_driver)
1597 
1598 /**
1599  * builtin_pci_driver() - Helper macro for registering a PCI driver
1600  * @__pci_driver: pci_driver struct
1601  *
1602  * Helper macro for PCI drivers which do not do anything special in their
1603  * init code. This eliminates a lot of boilerplate. Each driver may only
1604  * use this macro once, and calling it replaces device_initcall(...)
1605  */
1606 #define builtin_pci_driver(__pci_driver) \
1607 	builtin_driver(__pci_driver, pci_register_driver)
1608 
1609 struct pci_driver *pci_dev_driver(const struct pci_dev *dev);
1610 int pci_add_dynid(struct pci_driver *drv,
1611 		  unsigned int vendor, unsigned int device,
1612 		  unsigned int subvendor, unsigned int subdevice,
1613 		  unsigned int class, unsigned int class_mask,
1614 		  unsigned long driver_data);
1615 const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
1616 					 struct pci_dev *dev);
1617 int pci_scan_bridge(struct pci_bus *bus, struct pci_dev *dev, int max,
1618 		    int pass);
1619 
1620 void pci_walk_bus(struct pci_bus *top, int (*cb)(struct pci_dev *, void *),
1621 		  void *userdata);
1622 int pci_cfg_space_size(struct pci_dev *dev);
1623 unsigned char pci_bus_max_busnr(struct pci_bus *bus);
1624 void pci_setup_bridge(struct pci_bus *bus);
1625 resource_size_t pcibios_window_alignment(struct pci_bus *bus,
1626 					 unsigned long type);
1627 
1628 #define PCI_VGA_STATE_CHANGE_BRIDGE (1 << 0)
1629 #define PCI_VGA_STATE_CHANGE_DECODES (1 << 1)
1630 
1631 int pci_set_vga_state(struct pci_dev *pdev, bool decode,
1632 		      unsigned int command_bits, u32 flags);
1633 
1634 /*
1635  * Virtual interrupts allow for more interrupts to be allocated
1636  * than the device has interrupts for. These are not programmed
1637  * into the device's MSI-X table and must be handled by some
1638  * other driver means.
1639  */
1640 #define PCI_IRQ_VIRTUAL		(1 << 4)
1641 
1642 #define PCI_IRQ_ALL_TYPES	(PCI_IRQ_INTX | PCI_IRQ_MSI | PCI_IRQ_MSIX)
1643 
1644 #include <linux/dmapool.h>
1645 
1646 struct msix_entry {
1647 	u32	vector;	/* Kernel uses to write allocated vector */
1648 	u16	entry;	/* Driver uses to specify entry, OS writes */
1649 };
1650 
1651 #ifdef CONFIG_PCI_MSI
1652 int pci_msi_vec_count(struct pci_dev *dev);
1653 void pci_disable_msi(struct pci_dev *dev);
1654 int pci_msix_vec_count(struct pci_dev *dev);
1655 void pci_disable_msix(struct pci_dev *dev);
1656 void pci_restore_msi_state(struct pci_dev *dev);
1657 int pci_msi_enabled(void);
1658 int pci_enable_msi(struct pci_dev *dev);
1659 int pci_enable_msix_range(struct pci_dev *dev, struct msix_entry *entries,
1660 			  int minvec, int maxvec);
1661 static inline int pci_enable_msix_exact(struct pci_dev *dev,
1662 					struct msix_entry *entries, int nvec)
1663 {
1664 	int rc = pci_enable_msix_range(dev, entries, nvec, nvec);
1665 	if (rc < 0)
1666 		return rc;
1667 	return 0;
1668 }
1669 int pci_alloc_irq_vectors(struct pci_dev *dev, unsigned int min_vecs,
1670 			  unsigned int max_vecs, unsigned int flags);
1671 int pci_alloc_irq_vectors_affinity(struct pci_dev *dev, unsigned int min_vecs,
1672 				   unsigned int max_vecs, unsigned int flags,
1673 				   struct irq_affinity *affd);
1674 
1675 bool pci_msix_can_alloc_dyn(struct pci_dev *dev);
1676 struct msi_map pci_msix_alloc_irq_at(struct pci_dev *dev, unsigned int index,
1677 				     const struct irq_affinity_desc *affdesc);
1678 void pci_msix_free_irq(struct pci_dev *pdev, struct msi_map map);
1679 
1680 void pci_free_irq_vectors(struct pci_dev *dev);
1681 int pci_irq_vector(struct pci_dev *dev, unsigned int nr);
1682 const struct cpumask *pci_irq_get_affinity(struct pci_dev *pdev, int vec);
1683 
1684 #else
1685 static inline int pci_msi_vec_count(struct pci_dev *dev) { return -ENOSYS; }
1686 static inline void pci_disable_msi(struct pci_dev *dev) { }
1687 static inline int pci_msix_vec_count(struct pci_dev *dev) { return -ENOSYS; }
1688 static inline void pci_disable_msix(struct pci_dev *dev) { }
1689 static inline void pci_restore_msi_state(struct pci_dev *dev) { }
1690 static inline int pci_msi_enabled(void) { return 0; }
1691 static inline int pci_enable_msi(struct pci_dev *dev)
1692 { return -ENOSYS; }
1693 static inline int pci_enable_msix_range(struct pci_dev *dev,
1694 			struct msix_entry *entries, int minvec, int maxvec)
1695 { return -ENOSYS; }
1696 static inline int pci_enable_msix_exact(struct pci_dev *dev,
1697 			struct msix_entry *entries, int nvec)
1698 { return -ENOSYS; }
1699 
1700 static inline int
1701 pci_alloc_irq_vectors_affinity(struct pci_dev *dev, unsigned int min_vecs,
1702 			       unsigned int max_vecs, unsigned int flags,
1703 			       struct irq_affinity *aff_desc)
1704 {
1705 	if ((flags & PCI_IRQ_INTX) && min_vecs == 1 && dev->irq)
1706 		return 1;
1707 	return -ENOSPC;
1708 }
1709 static inline int
1710 pci_alloc_irq_vectors(struct pci_dev *dev, unsigned int min_vecs,
1711 		      unsigned int max_vecs, unsigned int flags)
1712 {
1713 	return pci_alloc_irq_vectors_affinity(dev, min_vecs, max_vecs,
1714 					      flags, NULL);
1715 }
1716 
1717 static inline bool pci_msix_can_alloc_dyn(struct pci_dev *dev)
1718 { return false; }
1719 static inline struct msi_map pci_msix_alloc_irq_at(struct pci_dev *dev, unsigned int index,
1720 						   const struct irq_affinity_desc *affdesc)
1721 {
1722 	struct msi_map map = { .index = -ENOSYS, };
1723 
1724 	return map;
1725 }
1726 
1727 static inline void pci_msix_free_irq(struct pci_dev *pdev, struct msi_map map)
1728 {
1729 }
1730 
1731 static inline void pci_free_irq_vectors(struct pci_dev *dev)
1732 {
1733 }
1734 
1735 static inline int pci_irq_vector(struct pci_dev *dev, unsigned int nr)
1736 {
1737 	if (WARN_ON_ONCE(nr > 0))
1738 		return -EINVAL;
1739 	return dev->irq;
1740 }
1741 static inline const struct cpumask *pci_irq_get_affinity(struct pci_dev *pdev,
1742 		int vec)
1743 {
1744 	return cpu_possible_mask;
1745 }
1746 #endif
1747 
1748 /**
1749  * pci_irqd_intx_xlate() - Translate PCI INTx value to an IRQ domain hwirq
1750  * @d: the INTx IRQ domain
1751  * @node: the DT node for the device whose interrupt we're translating
1752  * @intspec: the interrupt specifier data from the DT
1753  * @intsize: the number of entries in @intspec
1754  * @out_hwirq: pointer at which to write the hwirq number
1755  * @out_type: pointer at which to write the interrupt type
1756  *
1757  * Translate a PCI INTx interrupt number from device tree in the range 1-4, as
1758  * stored in the standard PCI_INTERRUPT_PIN register, to a value in the range
1759  * 0-3 suitable for use in a 4 entry IRQ domain. That is, subtract one from the
1760  * INTx value to obtain the hwirq number.
1761  *
1762  * Returns 0 on success, or -EINVAL if the interrupt specifier is out of range.
1763  */
1764 static inline int pci_irqd_intx_xlate(struct irq_domain *d,
1765 				      struct device_node *node,
1766 				      const u32 *intspec,
1767 				      unsigned int intsize,
1768 				      unsigned long *out_hwirq,
1769 				      unsigned int *out_type)
1770 {
1771 	const u32 intx = intspec[0];
1772 
1773 	if (intx < PCI_INTERRUPT_INTA || intx > PCI_INTERRUPT_INTD)
1774 		return -EINVAL;
1775 
1776 	*out_hwirq = intx - PCI_INTERRUPT_INTA;
1777 	return 0;
1778 }
1779 
1780 #ifdef CONFIG_PCIEPORTBUS
1781 extern bool pcie_ports_disabled;
1782 extern bool pcie_ports_native;
1783 
1784 int pcie_set_target_speed(struct pci_dev *port, enum pci_bus_speed speed_req,
1785 			  bool use_lt);
1786 #else
1787 #define pcie_ports_disabled	true
1788 #define pcie_ports_native	false
1789 
1790 static inline int pcie_set_target_speed(struct pci_dev *port,
1791 					enum pci_bus_speed speed_req,
1792 					bool use_lt)
1793 {
1794 	return -EOPNOTSUPP;
1795 }
1796 #endif
1797 
1798 #define PCIE_LINK_STATE_L0S		(BIT(0) | BIT(1)) /* Upstr/dwnstr L0s */
1799 #define PCIE_LINK_STATE_L1		BIT(2)	/* L1 state */
1800 #define PCIE_LINK_STATE_L1_1		BIT(3)	/* ASPM L1.1 state */
1801 #define PCIE_LINK_STATE_L1_2		BIT(4)	/* ASPM L1.2 state */
1802 #define PCIE_LINK_STATE_L1_1_PCIPM	BIT(5)	/* PCI-PM L1.1 state */
1803 #define PCIE_LINK_STATE_L1_2_PCIPM	BIT(6)	/* PCI-PM L1.2 state */
1804 #define PCIE_LINK_STATE_ASPM_ALL	(PCIE_LINK_STATE_L0S		|\
1805 					 PCIE_LINK_STATE_L1		|\
1806 					 PCIE_LINK_STATE_L1_1		|\
1807 					 PCIE_LINK_STATE_L1_2		|\
1808 					 PCIE_LINK_STATE_L1_1_PCIPM	|\
1809 					 PCIE_LINK_STATE_L1_2_PCIPM)
1810 #define PCIE_LINK_STATE_CLKPM		BIT(7)
1811 #define PCIE_LINK_STATE_ALL		(PCIE_LINK_STATE_ASPM_ALL	|\
1812 					 PCIE_LINK_STATE_CLKPM)
1813 
1814 #ifdef CONFIG_PCIEASPM
1815 int pci_disable_link_state(struct pci_dev *pdev, int state);
1816 int pci_disable_link_state_locked(struct pci_dev *pdev, int state);
1817 int pci_enable_link_state(struct pci_dev *pdev, int state);
1818 int pci_enable_link_state_locked(struct pci_dev *pdev, int state);
1819 void pcie_no_aspm(void);
1820 bool pcie_aspm_support_enabled(void);
1821 bool pcie_aspm_enabled(struct pci_dev *pdev);
1822 #else
1823 static inline int pci_disable_link_state(struct pci_dev *pdev, int state)
1824 { return 0; }
1825 static inline int pci_disable_link_state_locked(struct pci_dev *pdev, int state)
1826 { return 0; }
1827 static inline int pci_enable_link_state(struct pci_dev *pdev, int state)
1828 { return 0; }
1829 static inline int pci_enable_link_state_locked(struct pci_dev *pdev, int state)
1830 { return 0; }
1831 static inline void pcie_no_aspm(void) { }
1832 static inline bool pcie_aspm_support_enabled(void) { return false; }
1833 static inline bool pcie_aspm_enabled(struct pci_dev *pdev) { return false; }
1834 #endif
1835 
1836 #ifdef CONFIG_PCIEAER
1837 bool pci_aer_available(void);
1838 #else
1839 static inline bool pci_aer_available(void) { return false; }
1840 #endif
1841 
1842 bool pci_ats_disabled(void);
1843 
1844 #ifdef CONFIG_PCIE_PTM
1845 int pci_enable_ptm(struct pci_dev *dev, u8 *granularity);
1846 void pci_disable_ptm(struct pci_dev *dev);
1847 bool pcie_ptm_enabled(struct pci_dev *dev);
1848 #else
1849 static inline int pci_enable_ptm(struct pci_dev *dev, u8 *granularity)
1850 { return -EINVAL; }
1851 static inline void pci_disable_ptm(struct pci_dev *dev) { }
1852 static inline bool pcie_ptm_enabled(struct pci_dev *dev)
1853 { return false; }
1854 #endif
1855 
1856 void pci_cfg_access_lock(struct pci_dev *dev);
1857 bool pci_cfg_access_trylock(struct pci_dev *dev);
1858 void pci_cfg_access_unlock(struct pci_dev *dev);
1859 
1860 void pci_dev_lock(struct pci_dev *dev);
1861 int pci_dev_trylock(struct pci_dev *dev);
1862 void pci_dev_unlock(struct pci_dev *dev);
1863 DEFINE_GUARD(pci_dev, struct pci_dev *, pci_dev_lock(_T), pci_dev_unlock(_T))
1864 
1865 /*
1866  * PCI domain support.  Sometimes called PCI segment (eg by ACPI),
1867  * a PCI domain is defined to be a set of PCI buses which share
1868  * configuration space.
1869  */
1870 #ifdef CONFIG_PCI_DOMAINS
1871 extern int pci_domains_supported;
1872 #else
1873 enum { pci_domains_supported = 0 };
1874 static inline int pci_domain_nr(struct pci_bus *bus) { return 0; }
1875 static inline int pci_proc_domain(struct pci_bus *bus) { return 0; }
1876 #endif /* CONFIG_PCI_DOMAINS */
1877 
1878 /*
1879  * Generic implementation for PCI domain support. If your
1880  * architecture does not need custom management of PCI
1881  * domains then this implementation will be used
1882  */
1883 #ifdef CONFIG_PCI_DOMAINS_GENERIC
1884 static inline int pci_domain_nr(struct pci_bus *bus)
1885 {
1886 	return bus->domain_nr;
1887 }
1888 #ifdef CONFIG_ACPI
1889 int acpi_pci_bus_find_domain_nr(struct pci_bus *bus);
1890 #else
1891 static inline int acpi_pci_bus_find_domain_nr(struct pci_bus *bus)
1892 { return 0; }
1893 #endif
1894 int pci_bus_find_domain_nr(struct pci_bus *bus, struct device *parent);
1895 void pci_bus_release_domain_nr(struct device *parent, int domain_nr);
1896 #endif
1897 
1898 /* Some architectures require additional setup to direct VGA traffic */
1899 typedef int (*arch_set_vga_state_t)(struct pci_dev *pdev, bool decode,
1900 				    unsigned int command_bits, u32 flags);
1901 void pci_register_set_vga_state(arch_set_vga_state_t func);
1902 
1903 static inline int
1904 pci_request_io_regions(struct pci_dev *pdev, const char *name)
1905 {
1906 	return pci_request_selected_regions(pdev,
1907 			    pci_select_bars(pdev, IORESOURCE_IO), name);
1908 }
1909 
1910 static inline void
1911 pci_release_io_regions(struct pci_dev *pdev)
1912 {
1913 	return pci_release_selected_regions(pdev,
1914 			    pci_select_bars(pdev, IORESOURCE_IO));
1915 }
1916 
1917 static inline int
1918 pci_request_mem_regions(struct pci_dev *pdev, const char *name)
1919 {
1920 	return pci_request_selected_regions(pdev,
1921 			    pci_select_bars(pdev, IORESOURCE_MEM), name);
1922 }
1923 
1924 static inline void
1925 pci_release_mem_regions(struct pci_dev *pdev)
1926 {
1927 	return pci_release_selected_regions(pdev,
1928 			    pci_select_bars(pdev, IORESOURCE_MEM));
1929 }
1930 
1931 #else /* CONFIG_PCI is not enabled */
1932 
1933 static inline void pci_set_flags(int flags) { }
1934 static inline void pci_add_flags(int flags) { }
1935 static inline void pci_clear_flags(int flags) { }
1936 static inline int pci_has_flag(int flag) { return 0; }
1937 
1938 /*
1939  * If the system does not have PCI, clearly these return errors.  Define
1940  * these as simple inline functions to avoid hair in drivers.
1941  */
1942 #define _PCI_NOP(o, s, t) \
1943 	static inline int pci_##o##_config_##s(struct pci_dev *dev, \
1944 						int where, t val) \
1945 		{ return PCIBIOS_FUNC_NOT_SUPPORTED; }
1946 
1947 #define _PCI_NOP_ALL(o, x)	_PCI_NOP(o, byte, u8 x) \
1948 				_PCI_NOP(o, word, u16 x) \
1949 				_PCI_NOP(o, dword, u32 x)
1950 _PCI_NOP_ALL(read, *)
1951 _PCI_NOP_ALL(write,)
1952 
1953 static inline struct pci_dev *pci_get_device(unsigned int vendor,
1954 					     unsigned int device,
1955 					     struct pci_dev *from)
1956 { return NULL; }
1957 
1958 static inline struct pci_dev *pci_get_subsys(unsigned int vendor,
1959 					     unsigned int device,
1960 					     unsigned int ss_vendor,
1961 					     unsigned int ss_device,
1962 					     struct pci_dev *from)
1963 { return NULL; }
1964 
1965 static inline struct pci_dev *pci_get_class(unsigned int class,
1966 					    struct pci_dev *from)
1967 { return NULL; }
1968 
1969 static inline struct pci_dev *pci_get_base_class(unsigned int class,
1970 						 struct pci_dev *from)
1971 { return NULL; }
1972 
1973 static inline int pci_dev_present(const struct pci_device_id *ids)
1974 { return 0; }
1975 
1976 #define no_pci_devices()	(1)
1977 #define pci_dev_put(dev)	do { } while (0)
1978 
1979 static inline void pci_set_master(struct pci_dev *dev) { }
1980 static inline void pci_clear_master(struct pci_dev *dev) { }
1981 static inline int pci_enable_device(struct pci_dev *dev) { return -EIO; }
1982 static inline void pci_disable_device(struct pci_dev *dev) { }
1983 static inline int pcim_enable_device(struct pci_dev *pdev) { return -EIO; }
1984 static inline int pci_assign_resource(struct pci_dev *dev, int i)
1985 { return -EBUSY; }
1986 static inline int __must_check __pci_register_driver(struct pci_driver *drv,
1987 						     struct module *owner,
1988 						     const char *mod_name)
1989 { return 0; }
1990 static inline int pci_register_driver(struct pci_driver *drv)
1991 { return 0; }
1992 static inline void pci_unregister_driver(struct pci_driver *drv) { }
1993 static inline u8 pci_find_capability(struct pci_dev *dev, int cap)
1994 { return 0; }
1995 static inline u8 pci_find_next_capability(struct pci_dev *dev, u8 post, int cap)
1996 { return 0; }
1997 static inline u16 pci_find_ext_capability(struct pci_dev *dev, int cap)
1998 { return 0; }
1999 
2000 static inline u64 pci_get_dsn(struct pci_dev *dev)
2001 { return 0; }
2002 
2003 /* Power management related routines */
2004 static inline int pci_save_state(struct pci_dev *dev) { return 0; }
2005 static inline void pci_restore_state(struct pci_dev *dev) { }
2006 static inline int pci_set_power_state(struct pci_dev *dev, pci_power_t state)
2007 { return 0; }
2008 static inline int pci_set_power_state_locked(struct pci_dev *dev, pci_power_t state)
2009 { return 0; }
2010 static inline int pci_wake_from_d3(struct pci_dev *dev, bool enable)
2011 { return 0; }
2012 static inline pci_power_t pci_choose_state(struct pci_dev *dev,
2013 					   pm_message_t state)
2014 { return PCI_D0; }
2015 static inline int pci_enable_wake(struct pci_dev *dev, pci_power_t state,
2016 				  int enable)
2017 { return 0; }
2018 
2019 static inline struct resource *pci_find_resource(struct pci_dev *dev,
2020 						 struct resource *res)
2021 { return NULL; }
2022 static inline int pci_request_regions(struct pci_dev *dev, const char *res_name)
2023 { return -EIO; }
2024 static inline void pci_release_regions(struct pci_dev *dev) { }
2025 
2026 static inline int pci_register_io_range(const struct fwnode_handle *fwnode,
2027 					phys_addr_t addr, resource_size_t size)
2028 { return -EINVAL; }
2029 
2030 static inline unsigned long pci_address_to_pio(phys_addr_t addr) { return -1; }
2031 
2032 static inline struct pci_bus *pci_find_next_bus(const struct pci_bus *from)
2033 { return NULL; }
2034 static inline struct pci_dev *pci_get_slot(struct pci_bus *bus,
2035 						unsigned int devfn)
2036 { return NULL; }
2037 static inline struct pci_dev *pci_get_domain_bus_and_slot(int domain,
2038 					unsigned int bus, unsigned int devfn)
2039 { return NULL; }
2040 
2041 static inline int pci_domain_nr(struct pci_bus *bus) { return 0; }
2042 static inline struct pci_dev *pci_dev_get(struct pci_dev *dev) { return NULL; }
2043 
2044 #define dev_is_pci(d) (false)
2045 #define dev_is_pf(d) (false)
2046 static inline bool pci_acs_enabled(struct pci_dev *pdev, u16 acs_flags)
2047 { return false; }
2048 static inline int pci_irqd_intx_xlate(struct irq_domain *d,
2049 				      struct device_node *node,
2050 				      const u32 *intspec,
2051 				      unsigned int intsize,
2052 				      unsigned long *out_hwirq,
2053 				      unsigned int *out_type)
2054 { return -EINVAL; }
2055 
2056 static inline const struct pci_device_id *pci_match_id(const struct pci_device_id *ids,
2057 							 struct pci_dev *dev)
2058 { return NULL; }
2059 static inline bool pci_ats_disabled(void) { return true; }
2060 
2061 static inline int pci_irq_vector(struct pci_dev *dev, unsigned int nr)
2062 {
2063 	return -EINVAL;
2064 }
2065 
2066 static inline int
2067 pci_alloc_irq_vectors_affinity(struct pci_dev *dev, unsigned int min_vecs,
2068 			       unsigned int max_vecs, unsigned int flags,
2069 			       struct irq_affinity *aff_desc)
2070 {
2071 	return -ENOSPC;
2072 }
2073 static inline int
2074 pci_alloc_irq_vectors(struct pci_dev *dev, unsigned int min_vecs,
2075 		      unsigned int max_vecs, unsigned int flags)
2076 {
2077 	return -ENOSPC;
2078 }
2079 #endif /* CONFIG_PCI */
2080 
2081 /* Include architecture-dependent settings and functions */
2082 
2083 #include <asm/pci.h>
2084 
2085 /*
2086  * pci_mmap_resource_range() maps a specific BAR, and vm->vm_pgoff
2087  * is expected to be an offset within that region.
2088  *
2089  */
2090 int pci_mmap_resource_range(struct pci_dev *dev, int bar,
2091 			    struct vm_area_struct *vma,
2092 			    enum pci_mmap_state mmap_state, int write_combine);
2093 
2094 #ifndef arch_can_pci_mmap_wc
2095 #define arch_can_pci_mmap_wc()		0
2096 #endif
2097 
2098 #ifndef arch_can_pci_mmap_io
2099 #define arch_can_pci_mmap_io()		0
2100 #define pci_iobar_pfn(pdev, bar, vma) (-EINVAL)
2101 #else
2102 int pci_iobar_pfn(struct pci_dev *pdev, int bar, struct vm_area_struct *vma);
2103 #endif
2104 
2105 #ifndef pci_root_bus_fwnode
2106 #define pci_root_bus_fwnode(bus)	NULL
2107 #endif
2108 
2109 /*
2110  * These helpers provide future and backwards compatibility
2111  * for accessing popular PCI BAR info
2112  */
2113 #define pci_resource_n(dev, bar)	(&(dev)->resource[(bar)])
2114 #define pci_resource_start(dev, bar)	(pci_resource_n(dev, bar)->start)
2115 #define pci_resource_end(dev, bar)	(pci_resource_n(dev, bar)->end)
2116 #define pci_resource_flags(dev, bar)	(pci_resource_n(dev, bar)->flags)
2117 #define pci_resource_len(dev,bar)					\
2118 	(pci_resource_end((dev), (bar)) ? 				\
2119 	 resource_size(pci_resource_n((dev), (bar))) : 0)
2120 
2121 #define __pci_dev_for_each_res0(dev, res, ...)				  \
2122 	for (unsigned int __b = 0;					  \
2123 	     __b < PCI_NUM_RESOURCES && (res = pci_resource_n(dev, __b)); \
2124 	     __b++)
2125 
2126 #define __pci_dev_for_each_res1(dev, res, __b)				  \
2127 	for (__b = 0;							  \
2128 	     __b < PCI_NUM_RESOURCES && (res = pci_resource_n(dev, __b)); \
2129 	     __b++)
2130 
2131 #define pci_dev_for_each_resource(dev, res, ...)			\
2132 	CONCATENATE(__pci_dev_for_each_res, COUNT_ARGS(__VA_ARGS__)) 	\
2133 		    (dev, res, __VA_ARGS__)
2134 
2135 /*
2136  * Similar to the helpers above, these manipulate per-pci_dev
2137  * driver-specific data.  They are really just a wrapper around
2138  * the generic device structure functions of these calls.
2139  */
2140 static inline void *pci_get_drvdata(struct pci_dev *pdev)
2141 {
2142 	return dev_get_drvdata(&pdev->dev);
2143 }
2144 
2145 static inline void pci_set_drvdata(struct pci_dev *pdev, void *data)
2146 {
2147 	dev_set_drvdata(&pdev->dev, data);
2148 }
2149 
2150 static inline const char *pci_name(const struct pci_dev *pdev)
2151 {
2152 	return dev_name(&pdev->dev);
2153 }
2154 
2155 void pci_resource_to_user(const struct pci_dev *dev, int bar,
2156 			  const struct resource *rsrc,
2157 			  resource_size_t *start, resource_size_t *end);
2158 
2159 /*
2160  * The world is not perfect and supplies us with broken PCI devices.
2161  * For at least a part of these bugs we need a work-around, so both
2162  * generic (drivers/pci/quirks.c) and per-architecture code can define
2163  * fixup hooks to be called for particular buggy devices.
2164  */
2165 
2166 struct pci_fixup {
2167 	u16 vendor;			/* Or PCI_ANY_ID */
2168 	u16 device;			/* Or PCI_ANY_ID */
2169 	u32 class;			/* Or PCI_ANY_ID */
2170 	unsigned int class_shift;	/* should be 0, 8, 16 */
2171 #ifdef CONFIG_HAVE_ARCH_PREL32_RELOCATIONS
2172 	int hook_offset;
2173 #else
2174 	void (*hook)(struct pci_dev *dev);
2175 #endif
2176 };
2177 
2178 enum pci_fixup_pass {
2179 	pci_fixup_early,	/* Before probing BARs */
2180 	pci_fixup_header,	/* After reading configuration header */
2181 	pci_fixup_final,	/* Final phase of device fixups */
2182 	pci_fixup_enable,	/* pci_enable_device() time */
2183 	pci_fixup_resume,	/* pci_device_resume() */
2184 	pci_fixup_suspend,	/* pci_device_suspend() */
2185 	pci_fixup_resume_early, /* pci_device_resume_early() */
2186 	pci_fixup_suspend_late,	/* pci_device_suspend_late() */
2187 };
2188 
2189 #ifdef CONFIG_HAVE_ARCH_PREL32_RELOCATIONS
2190 #define ___DECLARE_PCI_FIXUP_SECTION(sec, name, vendor, device, class,	\
2191 				    class_shift, hook)			\
2192 	__ADDRESSABLE(hook)						\
2193 	asm(".section "	#sec ", \"a\"				\n"	\
2194 	    ".balign	16					\n"	\
2195 	    ".short "	#vendor ", " #device "			\n"	\
2196 	    ".long "	#class ", " #class_shift "		\n"	\
2197 	    ".long "	#hook " - .				\n"	\
2198 	    ".previous						\n");
2199 
2200 /*
2201  * Clang's LTO may rename static functions in C, but has no way to
2202  * handle such renamings when referenced from inline asm. To work
2203  * around this, create global C stubs for these cases.
2204  */
2205 #ifdef CONFIG_LTO_CLANG
2206 #define __DECLARE_PCI_FIXUP_SECTION(sec, name, vendor, device, class,	\
2207 				  class_shift, hook, stub)		\
2208 	void stub(struct pci_dev *dev);					\
2209 	void stub(struct pci_dev *dev)					\
2210 	{ 								\
2211 		hook(dev); 						\
2212 	}								\
2213 	___DECLARE_PCI_FIXUP_SECTION(sec, name, vendor, device, class,	\
2214 				  class_shift, stub)
2215 #else
2216 #define __DECLARE_PCI_FIXUP_SECTION(sec, name, vendor, device, class,	\
2217 				  class_shift, hook, stub)		\
2218 	___DECLARE_PCI_FIXUP_SECTION(sec, name, vendor, device, class,	\
2219 				  class_shift, hook)
2220 #endif
2221 
2222 #define DECLARE_PCI_FIXUP_SECTION(sec, name, vendor, device, class,	\
2223 				  class_shift, hook)			\
2224 	__DECLARE_PCI_FIXUP_SECTION(sec, name, vendor, device, class,	\
2225 				  class_shift, hook, __UNIQUE_ID(hook))
2226 #else
2227 /* Anonymous variables would be nice... */
2228 #define DECLARE_PCI_FIXUP_SECTION(section, name, vendor, device, class,	\
2229 				  class_shift, hook)			\
2230 	static const struct pci_fixup __PASTE(__pci_fixup_##name,__LINE__) __used	\
2231 	__attribute__((__section__(#section), aligned((sizeof(void *)))))    \
2232 		= { vendor, device, class, class_shift, hook };
2233 #endif
2234 
2235 #define DECLARE_PCI_FIXUP_CLASS_EARLY(vendor, device, class,		\
2236 					 class_shift, hook)		\
2237 	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early,			\
2238 		hook, vendor, device, class, class_shift, hook)
2239 #define DECLARE_PCI_FIXUP_CLASS_HEADER(vendor, device, class,		\
2240 					 class_shift, hook)		\
2241 	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header,			\
2242 		hook, vendor, device, class, class_shift, hook)
2243 #define DECLARE_PCI_FIXUP_CLASS_FINAL(vendor, device, class,		\
2244 					 class_shift, hook)		\
2245 	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final,			\
2246 		hook, vendor, device, class, class_shift, hook)
2247 #define DECLARE_PCI_FIXUP_CLASS_ENABLE(vendor, device, class,		\
2248 					 class_shift, hook)		\
2249 	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable,			\
2250 		hook, vendor, device, class, class_shift, hook)
2251 #define DECLARE_PCI_FIXUP_CLASS_RESUME(vendor, device, class,		\
2252 					 class_shift, hook)		\
2253 	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume,			\
2254 		resume##hook, vendor, device, class, class_shift, hook)
2255 #define DECLARE_PCI_FIXUP_CLASS_RESUME_EARLY(vendor, device, class,	\
2256 					 class_shift, hook)		\
2257 	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early,		\
2258 		resume_early##hook, vendor, device, class, class_shift, hook)
2259 #define DECLARE_PCI_FIXUP_CLASS_SUSPEND(vendor, device, class,		\
2260 					 class_shift, hook)		\
2261 	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend,			\
2262 		suspend##hook, vendor, device, class, class_shift, hook)
2263 #define DECLARE_PCI_FIXUP_CLASS_SUSPEND_LATE(vendor, device, class,	\
2264 					 class_shift, hook)		\
2265 	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend_late,		\
2266 		suspend_late##hook, vendor, device, class, class_shift, hook)
2267 
2268 #define DECLARE_PCI_FIXUP_EARLY(vendor, device, hook)			\
2269 	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_early,			\
2270 		hook, vendor, device, PCI_ANY_ID, 0, hook)
2271 #define DECLARE_PCI_FIXUP_HEADER(vendor, device, hook)			\
2272 	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_header,			\
2273 		hook, vendor, device, PCI_ANY_ID, 0, hook)
2274 #define DECLARE_PCI_FIXUP_FINAL(vendor, device, hook)			\
2275 	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_final,			\
2276 		hook, vendor, device, PCI_ANY_ID, 0, hook)
2277 #define DECLARE_PCI_FIXUP_ENABLE(vendor, device, hook)			\
2278 	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_enable,			\
2279 		hook, vendor, device, PCI_ANY_ID, 0, hook)
2280 #define DECLARE_PCI_FIXUP_RESUME(vendor, device, hook)			\
2281 	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume,			\
2282 		resume##hook, vendor, device, PCI_ANY_ID, 0, hook)
2283 #define DECLARE_PCI_FIXUP_RESUME_EARLY(vendor, device, hook)		\
2284 	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_resume_early,		\
2285 		resume_early##hook, vendor, device, PCI_ANY_ID, 0, hook)
2286 #define DECLARE_PCI_FIXUP_SUSPEND(vendor, device, hook)			\
2287 	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend,			\
2288 		suspend##hook, vendor, device, PCI_ANY_ID, 0, hook)
2289 #define DECLARE_PCI_FIXUP_SUSPEND_LATE(vendor, device, hook)		\
2290 	DECLARE_PCI_FIXUP_SECTION(.pci_fixup_suspend_late,		\
2291 		suspend_late##hook, vendor, device, PCI_ANY_ID, 0, hook)
2292 
2293 #ifdef CONFIG_PCI_QUIRKS
2294 void pci_fixup_device(enum pci_fixup_pass pass, struct pci_dev *dev);
2295 #else
2296 static inline void pci_fixup_device(enum pci_fixup_pass pass,
2297 				    struct pci_dev *dev) { }
2298 #endif
2299 
2300 int pcim_request_all_regions(struct pci_dev *pdev, const char *name);
2301 void __iomem *pcim_iomap(struct pci_dev *pdev, int bar, unsigned long maxlen);
2302 void __iomem *pcim_iomap_region(struct pci_dev *pdev, int bar,
2303 				const char *name);
2304 void pcim_iounmap_region(struct pci_dev *pdev, int bar);
2305 void pcim_iounmap(struct pci_dev *pdev, void __iomem *addr);
2306 void __iomem * const *pcim_iomap_table(struct pci_dev *pdev);
2307 int pcim_request_region(struct pci_dev *pdev, int bar, const char *name);
2308 int pcim_iomap_regions(struct pci_dev *pdev, int mask, const char *name);
2309 void pcim_iounmap_regions(struct pci_dev *pdev, int mask);
2310 void __iomem *pcim_iomap_range(struct pci_dev *pdev, int bar,
2311 				unsigned long offset, unsigned long len);
2312 
2313 extern int pci_pci_problems;
2314 #define PCIPCI_FAIL		1	/* No PCI PCI DMA */
2315 #define PCIPCI_TRITON		2
2316 #define PCIPCI_NATOMA		4
2317 #define PCIPCI_VIAETBF		8
2318 #define PCIPCI_VSFX		16
2319 #define PCIPCI_ALIMAGIK		32	/* Need low latency setting */
2320 #define PCIAGP_FAIL		64	/* No PCI to AGP DMA */
2321 
2322 extern unsigned long pci_cardbus_io_size;
2323 extern unsigned long pci_cardbus_mem_size;
2324 extern u8 pci_dfl_cache_line_size;
2325 extern u8 pci_cache_line_size;
2326 
2327 /* Architecture-specific versions may override these (weak) */
2328 void pcibios_disable_device(struct pci_dev *dev);
2329 void pcibios_set_master(struct pci_dev *dev);
2330 int pcibios_set_pcie_reset_state(struct pci_dev *dev,
2331 				 enum pcie_reset_state state);
2332 int pcibios_device_add(struct pci_dev *dev);
2333 void pcibios_release_device(struct pci_dev *dev);
2334 #ifdef CONFIG_PCI
2335 void pcibios_penalize_isa_irq(int irq, int active);
2336 #else
2337 static inline void pcibios_penalize_isa_irq(int irq, int active) {}
2338 #endif
2339 int pcibios_alloc_irq(struct pci_dev *dev);
2340 void pcibios_free_irq(struct pci_dev *dev);
2341 resource_size_t pcibios_default_alignment(void);
2342 
2343 #if !defined(HAVE_PCI_MMAP) && !defined(ARCH_GENERIC_PCI_MMAP_RESOURCE)
2344 extern int pci_create_resource_files(struct pci_dev *dev);
2345 extern void pci_remove_resource_files(struct pci_dev *dev);
2346 #endif
2347 
2348 #if defined(CONFIG_PCI_MMCONFIG) || defined(CONFIG_ACPI_MCFG)
2349 void __init pci_mmcfg_early_init(void);
2350 void __init pci_mmcfg_late_init(void);
2351 #else
2352 static inline void pci_mmcfg_early_init(void) { }
2353 static inline void pci_mmcfg_late_init(void) { }
2354 #endif
2355 
2356 int pci_ext_cfg_avail(void);
2357 
2358 void __iomem *pci_ioremap_bar(struct pci_dev *pdev, int bar);
2359 void __iomem *pci_ioremap_wc_bar(struct pci_dev *pdev, int bar);
2360 
2361 #ifdef CONFIG_PCI_IOV
2362 int pci_iov_virtfn_bus(struct pci_dev *dev, int id);
2363 int pci_iov_virtfn_devfn(struct pci_dev *dev, int id);
2364 int pci_iov_vf_id(struct pci_dev *dev);
2365 void *pci_iov_get_pf_drvdata(struct pci_dev *dev, struct pci_driver *pf_driver);
2366 int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn);
2367 void pci_disable_sriov(struct pci_dev *dev);
2368 
2369 int pci_iov_sysfs_link(struct pci_dev *dev, struct pci_dev *virtfn, int id);
2370 int pci_iov_add_virtfn(struct pci_dev *dev, int id);
2371 void pci_iov_remove_virtfn(struct pci_dev *dev, int id);
2372 int pci_num_vf(struct pci_dev *dev);
2373 int pci_vfs_assigned(struct pci_dev *dev);
2374 int pci_sriov_set_totalvfs(struct pci_dev *dev, u16 numvfs);
2375 int pci_sriov_get_totalvfs(struct pci_dev *dev);
2376 int pci_sriov_configure_simple(struct pci_dev *dev, int nr_virtfn);
2377 resource_size_t pci_iov_resource_size(struct pci_dev *dev, int resno);
2378 void pci_vf_drivers_autoprobe(struct pci_dev *dev, bool probe);
2379 
2380 /* Arch may override these (weak) */
2381 int pcibios_sriov_enable(struct pci_dev *pdev, u16 num_vfs);
2382 int pcibios_sriov_disable(struct pci_dev *pdev);
2383 resource_size_t pcibios_iov_resource_alignment(struct pci_dev *dev, int resno);
2384 #else
2385 static inline int pci_iov_virtfn_bus(struct pci_dev *dev, int id)
2386 {
2387 	return -ENOSYS;
2388 }
2389 static inline int pci_iov_virtfn_devfn(struct pci_dev *dev, int id)
2390 {
2391 	return -ENOSYS;
2392 }
2393 
2394 static inline int pci_iov_vf_id(struct pci_dev *dev)
2395 {
2396 	return -ENOSYS;
2397 }
2398 
2399 static inline void *pci_iov_get_pf_drvdata(struct pci_dev *dev,
2400 					   struct pci_driver *pf_driver)
2401 {
2402 	return ERR_PTR(-EINVAL);
2403 }
2404 
2405 static inline int pci_enable_sriov(struct pci_dev *dev, int nr_virtfn)
2406 { return -ENODEV; }
2407 
2408 static inline int pci_iov_sysfs_link(struct pci_dev *dev,
2409 				     struct pci_dev *virtfn, int id)
2410 {
2411 	return -ENODEV;
2412 }
2413 static inline int pci_iov_add_virtfn(struct pci_dev *dev, int id)
2414 {
2415 	return -ENOSYS;
2416 }
2417 static inline void pci_iov_remove_virtfn(struct pci_dev *dev,
2418 					 int id) { }
2419 static inline void pci_disable_sriov(struct pci_dev *dev) { }
2420 static inline int pci_num_vf(struct pci_dev *dev) { return 0; }
2421 static inline int pci_vfs_assigned(struct pci_dev *dev)
2422 { return 0; }
2423 static inline int pci_sriov_set_totalvfs(struct pci_dev *dev, u16 numvfs)
2424 { return 0; }
2425 static inline int pci_sriov_get_totalvfs(struct pci_dev *dev)
2426 { return 0; }
2427 #define pci_sriov_configure_simple	NULL
2428 static inline resource_size_t pci_iov_resource_size(struct pci_dev *dev, int resno)
2429 { return 0; }
2430 static inline void pci_vf_drivers_autoprobe(struct pci_dev *dev, bool probe) { }
2431 #endif
2432 
2433 #if defined(CONFIG_HOTPLUG_PCI) || defined(CONFIG_HOTPLUG_PCI_MODULE)
2434 void pci_hp_create_module_link(struct pci_slot *pci_slot);
2435 void pci_hp_remove_module_link(struct pci_slot *pci_slot);
2436 #endif
2437 
2438 /**
2439  * pci_pcie_cap - get the saved PCIe capability offset
2440  * @dev: PCI device
2441  *
2442  * PCIe capability offset is calculated at PCI device initialization
2443  * time and saved in the data structure. This function returns saved
2444  * PCIe capability offset. Using this instead of pci_find_capability()
2445  * reduces unnecessary search in the PCI configuration space. If you
2446  * need to calculate PCIe capability offset from raw device for some
2447  * reasons, please use pci_find_capability() instead.
2448  */
2449 static inline int pci_pcie_cap(struct pci_dev *dev)
2450 {
2451 	return dev->pcie_cap;
2452 }
2453 
2454 /**
2455  * pci_is_pcie - check if the PCI device is PCI Express capable
2456  * @dev: PCI device
2457  *
2458  * Returns: true if the PCI device is PCI Express capable, false otherwise.
2459  */
2460 static inline bool pci_is_pcie(struct pci_dev *dev)
2461 {
2462 	return pci_pcie_cap(dev);
2463 }
2464 
2465 /**
2466  * pcie_caps_reg - get the PCIe Capabilities Register
2467  * @dev: PCI device
2468  */
2469 static inline u16 pcie_caps_reg(const struct pci_dev *dev)
2470 {
2471 	return dev->pcie_flags_reg;
2472 }
2473 
2474 /**
2475  * pci_pcie_type - get the PCIe device/port type
2476  * @dev: PCI device
2477  */
2478 static inline int pci_pcie_type(const struct pci_dev *dev)
2479 {
2480 	return (pcie_caps_reg(dev) & PCI_EXP_FLAGS_TYPE) >> 4;
2481 }
2482 
2483 /**
2484  * pcie_find_root_port - Get the PCIe root port device
2485  * @dev: PCI device
2486  *
2487  * Traverse up the parent chain and return the PCIe Root Port PCI Device
2488  * for a given PCI/PCIe Device.
2489  */
2490 static inline struct pci_dev *pcie_find_root_port(struct pci_dev *dev)
2491 {
2492 	while (dev) {
2493 		if (pci_is_pcie(dev) &&
2494 		    pci_pcie_type(dev) == PCI_EXP_TYPE_ROOT_PORT)
2495 			return dev;
2496 		dev = pci_upstream_bridge(dev);
2497 	}
2498 
2499 	return NULL;
2500 }
2501 
2502 static inline bool pci_dev_is_disconnected(const struct pci_dev *dev)
2503 {
2504 	/*
2505 	 * error_state is set in pci_dev_set_io_state() using xchg/cmpxchg()
2506 	 * and read w/o common lock. READ_ONCE() ensures compiler cannot cache
2507 	 * the value (e.g. inside the loop in pci_dev_wait()).
2508 	 */
2509 	return READ_ONCE(dev->error_state) == pci_channel_io_perm_failure;
2510 }
2511 
2512 void pci_request_acs(void);
2513 bool pci_acs_enabled(struct pci_dev *pdev, u16 acs_flags);
2514 bool pci_acs_path_enabled(struct pci_dev *start,
2515 			  struct pci_dev *end, u16 acs_flags);
2516 int pci_enable_atomic_ops_to_root(struct pci_dev *dev, u32 cap_mask);
2517 
2518 #define PCI_VPD_LRDT			0x80	/* Large Resource Data Type */
2519 #define PCI_VPD_LRDT_ID(x)		((x) | PCI_VPD_LRDT)
2520 
2521 /* Large Resource Data Type Tag Item Names */
2522 #define PCI_VPD_LTIN_ID_STRING		0x02	/* Identifier String */
2523 #define PCI_VPD_LTIN_RO_DATA		0x10	/* Read-Only Data */
2524 #define PCI_VPD_LTIN_RW_DATA		0x11	/* Read-Write Data */
2525 
2526 #define PCI_VPD_LRDT_ID_STRING		PCI_VPD_LRDT_ID(PCI_VPD_LTIN_ID_STRING)
2527 #define PCI_VPD_LRDT_RO_DATA		PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RO_DATA)
2528 #define PCI_VPD_LRDT_RW_DATA		PCI_VPD_LRDT_ID(PCI_VPD_LTIN_RW_DATA)
2529 
2530 #define PCI_VPD_RO_KEYWORD_PARTNO	"PN"
2531 #define PCI_VPD_RO_KEYWORD_SERIALNO	"SN"
2532 #define PCI_VPD_RO_KEYWORD_MFR_ID	"MN"
2533 #define PCI_VPD_RO_KEYWORD_VENDOR0	"V0"
2534 #define PCI_VPD_RO_KEYWORD_CHKSUM	"RV"
2535 
2536 /**
2537  * pci_vpd_alloc - Allocate buffer and read VPD into it
2538  * @dev: PCI device
2539  * @size: pointer to field where VPD length is returned
2540  *
2541  * Returns pointer to allocated buffer or an ERR_PTR in case of failure
2542  */
2543 void *pci_vpd_alloc(struct pci_dev *dev, unsigned int *size);
2544 
2545 /**
2546  * pci_vpd_find_id_string - Locate id string in VPD
2547  * @buf: Pointer to buffered VPD data
2548  * @len: The length of the buffer area in which to search
2549  * @size: Pointer to field where length of id string is returned
2550  *
2551  * Returns the index of the id string or -ENOENT if not found.
2552  */
2553 int pci_vpd_find_id_string(const u8 *buf, unsigned int len, unsigned int *size);
2554 
2555 /**
2556  * pci_vpd_find_ro_info_keyword - Locate info field keyword in VPD RO section
2557  * @buf: Pointer to buffered VPD data
2558  * @len: The length of the buffer area in which to search
2559  * @kw: The keyword to search for
2560  * @size: Pointer to field where length of found keyword data is returned
2561  *
2562  * Returns the index of the information field keyword data or -ENOENT if
2563  * not found.
2564  */
2565 int pci_vpd_find_ro_info_keyword(const void *buf, unsigned int len,
2566 				 const char *kw, unsigned int *size);
2567 
2568 /**
2569  * pci_vpd_check_csum - Check VPD checksum
2570  * @buf: Pointer to buffered VPD data
2571  * @len: VPD size
2572  *
2573  * Returns 1 if VPD has no checksum, otherwise 0 or an errno
2574  */
2575 int pci_vpd_check_csum(const void *buf, unsigned int len);
2576 
2577 /* PCI <-> OF binding helpers */
2578 #ifdef CONFIG_OF
2579 struct device_node;
2580 struct irq_domain;
2581 struct irq_domain *pci_host_bridge_of_msi_domain(struct pci_bus *bus);
2582 bool pci_host_of_has_msi_map(struct device *dev);
2583 
2584 /* Arch may override this (weak) */
2585 struct device_node *pcibios_get_phb_of_node(struct pci_bus *bus);
2586 
2587 #else	/* CONFIG_OF */
2588 static inline struct irq_domain *
2589 pci_host_bridge_of_msi_domain(struct pci_bus *bus) { return NULL; }
2590 static inline bool pci_host_of_has_msi_map(struct device *dev) { return false; }
2591 #endif  /* CONFIG_OF */
2592 
2593 static inline struct device_node *
2594 pci_device_to_OF_node(const struct pci_dev *pdev)
2595 {
2596 	return pdev ? pdev->dev.of_node : NULL;
2597 }
2598 
2599 static inline struct device_node *pci_bus_to_OF_node(struct pci_bus *bus)
2600 {
2601 	return bus ? bus->dev.of_node : NULL;
2602 }
2603 
2604 #ifdef CONFIG_ACPI
2605 struct irq_domain *pci_host_bridge_acpi_msi_domain(struct pci_bus *bus);
2606 
2607 void
2608 pci_msi_register_fwnode_provider(struct fwnode_handle *(*fn)(struct device *));
2609 bool pci_pr3_present(struct pci_dev *pdev);
2610 #else
2611 static inline struct irq_domain *
2612 pci_host_bridge_acpi_msi_domain(struct pci_bus *bus) { return NULL; }
2613 static inline bool pci_pr3_present(struct pci_dev *pdev) { return false; }
2614 #endif
2615 
2616 #if defined(CONFIG_X86) && defined(CONFIG_ACPI)
2617 bool arch_pci_dev_is_removable(struct pci_dev *pdev);
2618 #else
2619 static inline bool arch_pci_dev_is_removable(struct pci_dev *pdev) { return false; }
2620 #endif
2621 
2622 #ifdef CONFIG_EEH
2623 static inline struct eeh_dev *pci_dev_to_eeh_dev(struct pci_dev *pdev)
2624 {
2625 	return pdev->dev.archdata.edev;
2626 }
2627 #endif
2628 
2629 void pci_add_dma_alias(struct pci_dev *dev, u8 devfn_from, unsigned nr_devfns);
2630 bool pci_devs_are_dma_aliases(struct pci_dev *dev1, struct pci_dev *dev2);
2631 int pci_for_each_dma_alias(struct pci_dev *pdev,
2632 			   int (*fn)(struct pci_dev *pdev,
2633 				     u16 alias, void *data), void *data);
2634 
2635 /* Helper functions for operation of device flag */
2636 static inline void pci_set_dev_assigned(struct pci_dev *pdev)
2637 {
2638 	pdev->dev_flags |= PCI_DEV_FLAGS_ASSIGNED;
2639 }
2640 static inline void pci_clear_dev_assigned(struct pci_dev *pdev)
2641 {
2642 	pdev->dev_flags &= ~PCI_DEV_FLAGS_ASSIGNED;
2643 }
2644 static inline bool pci_is_dev_assigned(struct pci_dev *pdev)
2645 {
2646 	return (pdev->dev_flags & PCI_DEV_FLAGS_ASSIGNED) == PCI_DEV_FLAGS_ASSIGNED;
2647 }
2648 
2649 /**
2650  * pci_ari_enabled - query ARI forwarding status
2651  * @bus: the PCI bus
2652  *
2653  * Returns true if ARI forwarding is enabled.
2654  */
2655 static inline bool pci_ari_enabled(struct pci_bus *bus)
2656 {
2657 	return bus->self && bus->self->ari_enabled;
2658 }
2659 
2660 /**
2661  * pci_is_thunderbolt_attached - whether device is on a Thunderbolt daisy chain
2662  * @pdev: PCI device to check
2663  *
2664  * Walk upwards from @pdev and check for each encountered bridge if it's part
2665  * of a Thunderbolt controller.  Reaching the host bridge means @pdev is not
2666  * Thunderbolt-attached.  (But rather soldered to the mainboard usually.)
2667  */
2668 static inline bool pci_is_thunderbolt_attached(struct pci_dev *pdev)
2669 {
2670 	struct pci_dev *parent = pdev;
2671 
2672 	if (pdev->is_thunderbolt)
2673 		return true;
2674 
2675 	while ((parent = pci_upstream_bridge(parent)))
2676 		if (parent->is_thunderbolt)
2677 			return true;
2678 
2679 	return false;
2680 }
2681 
2682 #if defined(CONFIG_PCIEPORTBUS) || defined(CONFIG_EEH)
2683 void pci_uevent_ers(struct pci_dev *pdev, enum  pci_ers_result err_type);
2684 #endif
2685 
2686 #include <linux/dma-mapping.h>
2687 
2688 #define pci_printk(level, pdev, fmt, arg...) \
2689 	dev_printk(level, &(pdev)->dev, fmt, ##arg)
2690 
2691 #define pci_emerg(pdev, fmt, arg...)	dev_emerg(&(pdev)->dev, fmt, ##arg)
2692 #define pci_alert(pdev, fmt, arg...)	dev_alert(&(pdev)->dev, fmt, ##arg)
2693 #define pci_crit(pdev, fmt, arg...)	dev_crit(&(pdev)->dev, fmt, ##arg)
2694 #define pci_err(pdev, fmt, arg...)	dev_err(&(pdev)->dev, fmt, ##arg)
2695 #define pci_warn(pdev, fmt, arg...)	dev_warn(&(pdev)->dev, fmt, ##arg)
2696 #define pci_warn_once(pdev, fmt, arg...) dev_warn_once(&(pdev)->dev, fmt, ##arg)
2697 #define pci_notice(pdev, fmt, arg...)	dev_notice(&(pdev)->dev, fmt, ##arg)
2698 #define pci_info(pdev, fmt, arg...)	dev_info(&(pdev)->dev, fmt, ##arg)
2699 #define pci_dbg(pdev, fmt, arg...)	dev_dbg(&(pdev)->dev, fmt, ##arg)
2700 
2701 #define pci_notice_ratelimited(pdev, fmt, arg...) \
2702 	dev_notice_ratelimited(&(pdev)->dev, fmt, ##arg)
2703 
2704 #define pci_info_ratelimited(pdev, fmt, arg...) \
2705 	dev_info_ratelimited(&(pdev)->dev, fmt, ##arg)
2706 
2707 #define pci_WARN(pdev, condition, fmt, arg...) \
2708 	WARN(condition, "%s %s: " fmt, \
2709 	     dev_driver_string(&(pdev)->dev), pci_name(pdev), ##arg)
2710 
2711 #define pci_WARN_ONCE(pdev, condition, fmt, arg...) \
2712 	WARN_ONCE(condition, "%s %s: " fmt, \
2713 		  dev_driver_string(&(pdev)->dev), pci_name(pdev), ##arg)
2714 
2715 #endif /* LINUX_PCI_H */
2716