xref: /freebsd/sys/dev/pci/pcivar.h (revision 732a02b4e77866604a120a275c082bb6221bd2ff)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright 1997, Stefan Esser <se@freebsd.org>
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice unmodified, this list of conditions, and the following
11  *    disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26  *
27  * $FreeBSD$
28  *
29  */
30 
31 #ifndef _PCIVAR_H_
32 #define	_PCIVAR_H_
33 
34 #include <sys/queue.h>
35 #include <sys/_eventhandler.h>
36 
37 /* some PCI bus constants */
38 #define	PCI_MAXMAPS_0	6	/* max. no. of memory/port maps */
39 #define	PCI_MAXMAPS_1	2	/* max. no. of maps for PCI to PCI bridge */
40 #define	PCI_MAXMAPS_2	1	/* max. no. of maps for CardBus bridge */
41 
42 typedef uint64_t pci_addr_t;
43 
44 /* Config registers for PCI-PCI and PCI-Cardbus bridges. */
45 struct pcicfg_bridge {
46     uint8_t	br_seclat;
47     uint8_t	br_subbus;
48     uint8_t	br_secbus;
49     uint8_t	br_pribus;
50     uint16_t	br_control;
51 };
52 
53 /* Interesting values for PCI power management */
54 struct pcicfg_pp {
55     uint16_t	pp_cap;		/* PCI power management capabilities */
56     uint8_t	pp_status;	/* conf. space addr. of PM control/status reg */
57     uint8_t	pp_bse;		/* conf. space addr. of PM BSE reg */
58     uint8_t	pp_data;	/* conf. space addr. of PM data reg */
59 };
60 
61 struct pci_map {
62     pci_addr_t	pm_value;	/* Raw BAR value */
63     pci_addr_t	pm_size;
64     uint16_t	pm_reg;
65     STAILQ_ENTRY(pci_map) pm_link;
66 };
67 
68 struct vpd_readonly {
69     char	keyword[2];
70     char	*value;
71     int		len;
72 };
73 
74 struct vpd_write {
75     char	keyword[2];
76     char	*value;
77     int 	start;
78     int 	len;
79 };
80 
81 struct pcicfg_vpd {
82     uint8_t	vpd_reg;	/* base register, + 2 for addr, + 4 data */
83     char	vpd_cached;
84     char	*vpd_ident;	/* string identifier */
85     int 	vpd_rocnt;
86     struct vpd_readonly *vpd_ros;
87     int 	vpd_wcnt;
88     struct vpd_write *vpd_w;
89 };
90 
91 /* Interesting values for PCI MSI */
92 struct pcicfg_msi {
93     uint16_t	msi_ctrl;	/* Message Control */
94     uint8_t	msi_location;	/* Offset of MSI capability registers. */
95     uint8_t	msi_msgnum;	/* Number of messages */
96     int		msi_alloc;	/* Number of allocated messages. */
97     uint64_t	msi_addr;	/* Contents of address register. */
98     uint16_t	msi_data;	/* Contents of data register. */
99     u_int	msi_handlers;
100 };
101 
102 /* Interesting values for PCI MSI-X */
103 struct msix_vector {
104     uint64_t	mv_address;	/* Contents of address register. */
105     uint32_t	mv_data;	/* Contents of data register. */
106     int		mv_irq;
107 };
108 
109 struct msix_table_entry {
110     u_int	mte_vector;	/* 1-based index into msix_vectors array. */
111     u_int	mte_handlers;
112 };
113 
114 struct pcicfg_msix {
115     uint16_t	msix_ctrl;	/* Message Control */
116     uint16_t	msix_msgnum;	/* Number of messages */
117     uint8_t	msix_location;	/* Offset of MSI-X capability registers. */
118     uint8_t	msix_table_bar;	/* BAR containing vector table. */
119     uint8_t	msix_pba_bar;	/* BAR containing PBA. */
120     uint32_t	msix_table_offset;
121     uint32_t	msix_pba_offset;
122     int		msix_alloc;	/* Number of allocated vectors. */
123     int		msix_table_len;	/* Length of virtual table. */
124     struct msix_table_entry *msix_table; /* Virtual table. */
125     struct msix_vector *msix_vectors;	/* Array of allocated vectors. */
126     struct resource *msix_table_res;	/* Resource containing vector table. */
127     struct resource *msix_pba_res;	/* Resource containing PBA. */
128 };
129 
130 /* Interesting values for HyperTransport */
131 struct pcicfg_ht {
132     uint8_t	ht_slave;	/* Non-zero if device is an HT slave. */
133     uint8_t	ht_msimap;	/* Offset of MSI mapping cap registers. */
134     uint16_t	ht_msictrl;	/* MSI mapping control */
135     uint64_t	ht_msiaddr;	/* MSI mapping base address */
136 };
137 
138 /* Interesting values for PCI-express */
139 struct pcicfg_pcie {
140     uint8_t	pcie_location;	/* Offset of PCI-e capability registers. */
141     uint8_t	pcie_type;	/* Device type. */
142     uint16_t	pcie_flags;	/* Device capabilities register. */
143     uint16_t	pcie_device_ctl; /* Device control register. */
144     uint16_t	pcie_link_ctl;	/* Link control register. */
145     uint16_t	pcie_slot_ctl;	/* Slot control register. */
146     uint16_t	pcie_root_ctl;	/* Root control register. */
147     uint16_t	pcie_device_ctl2; /* Second device control register. */
148     uint16_t	pcie_link_ctl2;	/* Second link control register. */
149     uint16_t	pcie_slot_ctl2;	/* Second slot control register. */
150 };
151 
152 struct pcicfg_pcix {
153     uint16_t	pcix_command;
154     uint8_t	pcix_location;	/* Offset of PCI-X capability registers. */
155 };
156 
157 struct pcicfg_vf {
158        int index;
159 };
160 
161 struct pci_ea_entry {
162     int		eae_bei;
163     uint32_t	eae_flags;
164     uint64_t	eae_base;
165     uint64_t	eae_max_offset;
166     uint32_t	eae_cfg_offset;
167     STAILQ_ENTRY(pci_ea_entry) eae_link;
168 };
169 
170 struct pcicfg_ea {
171     int ea_location;	/* Structure offset in Configuration Header */
172     STAILQ_HEAD(, pci_ea_entry) ea_entries;	/* EA entries */
173 };
174 
175 #define	PCICFG_VF	0x0001 /* Device is an SR-IOV Virtual Function */
176 
177 /* config header information common to all header types */
178 typedef struct pcicfg {
179     device_t	dev;		/* device which owns this */
180 
181     STAILQ_HEAD(, pci_map) maps; /* BARs */
182 
183     uint16_t	subvendor;	/* card vendor ID */
184     uint16_t	subdevice;	/* card device ID, assigned by card vendor */
185     uint16_t	vendor;		/* chip vendor ID */
186     uint16_t	device;		/* chip device ID, assigned by chip vendor */
187 
188     uint16_t	cmdreg;		/* disable/enable chip and PCI options */
189     uint16_t	statreg;	/* supported PCI features and error state */
190 
191     uint8_t	baseclass;	/* chip PCI class */
192     uint8_t	subclass;	/* chip PCI subclass */
193     uint8_t	progif;		/* chip PCI programming interface */
194     uint8_t	revid;		/* chip revision ID */
195 
196     uint8_t	hdrtype;	/* chip config header type */
197     uint8_t	cachelnsz;	/* cache line size in 4byte units */
198     uint8_t	intpin;		/* PCI interrupt pin */
199     uint8_t	intline;	/* interrupt line (IRQ for PC arch) */
200 
201     uint8_t	mingnt;		/* min. useful bus grant time in 250ns units */
202     uint8_t	maxlat;		/* max. tolerated bus grant latency in 250ns */
203     uint8_t	lattimer;	/* latency timer in units of 30ns bus cycles */
204 
205     uint8_t	mfdev;		/* multi-function device (from hdrtype reg) */
206     uint8_t	nummaps;	/* actual number of PCI maps used */
207 
208     uint32_t	domain;		/* PCI domain */
209     uint8_t	bus;		/* config space bus address */
210     uint8_t	slot;		/* config space slot address */
211     uint8_t	func;		/* config space function number */
212 
213     uint32_t	flags;		/* flags defined above */
214 
215     struct pcicfg_bridge bridge; /* Bridges */
216     struct pcicfg_pp pp;	/* Power management */
217     struct pcicfg_vpd vpd;	/* Vital product data */
218     struct pcicfg_msi msi;	/* PCI MSI */
219     struct pcicfg_msix msix;	/* PCI MSI-X */
220     struct pcicfg_ht ht;	/* HyperTransport */
221     struct pcicfg_pcie pcie;	/* PCI Express */
222     struct pcicfg_pcix pcix;	/* PCI-X */
223     struct pcicfg_iov *iov;	/* SR-IOV */
224     struct pcicfg_vf vf;	/* SR-IOV Virtual Function */
225     struct pcicfg_ea ea;	/* Enhanced Allocation */
226 } pcicfgregs;
227 
228 /* additional type 1 device config header information (PCI to PCI bridge) */
229 
230 typedef struct {
231     pci_addr_t	pmembase;	/* base address of prefetchable memory */
232     pci_addr_t	pmemlimit;	/* topmost address of prefetchable memory */
233     uint32_t	membase;	/* base address of memory window */
234     uint32_t	memlimit;	/* topmost address of memory window */
235     uint32_t	iobase;		/* base address of port window */
236     uint32_t	iolimit;	/* topmost address of port window */
237     uint16_t	secstat;	/* secondary bus status register */
238     uint16_t	bridgectl;	/* bridge control register */
239     uint8_t	seclat;		/* CardBus latency timer */
240 } pcih1cfgregs;
241 
242 /* additional type 2 device config header information (CardBus bridge) */
243 
244 typedef struct {
245     uint32_t	membase0;	/* base address of memory window */
246     uint32_t	memlimit0;	/* topmost address of memory window */
247     uint32_t	membase1;	/* base address of memory window */
248     uint32_t	memlimit1;	/* topmost address of memory window */
249     uint32_t	iobase0;	/* base address of port window */
250     uint32_t	iolimit0;	/* topmost address of port window */
251     uint32_t	iobase1;	/* base address of port window */
252     uint32_t	iolimit1;	/* topmost address of port window */
253     uint32_t	pccardif;	/* PC Card 16bit IF legacy more base addr. */
254     uint16_t	secstat;	/* secondary bus status register */
255     uint16_t	bridgectl;	/* bridge control register */
256     uint8_t	seclat;		/* CardBus latency timer */
257 } pcih2cfgregs;
258 
259 extern uint32_t pci_numdevs;
260 
261 /*
262  * The bitfield has to be stable and match the fields below (so that
263  * match_flag_vendor must be bit 0) so we have to do the endian dance. We can't
264  * use enums or #define constants because then the macros for subsetting matches
265  * wouldn't work. These tables are parsed by devmatch and others to connect
266  * modules with devices on the PCI bus.
267  */
268 struct pci_device_table {
269 #if BYTE_ORDER == LITTLE_ENDIAN
270 	uint16_t
271 		match_flag_vendor:1,
272 		match_flag_device:1,
273 		match_flag_subvendor:1,
274 		match_flag_subdevice:1,
275 		match_flag_class:1,
276 		match_flag_subclass:1,
277 		match_flag_revid:1,
278 		match_flag_unused:9;
279 #else
280 	uint16_t
281 		match_flag_unused:9,
282 		match_flag_revid:1,
283 		match_flag_subclass:1,
284 		match_flag_class:1,
285 		match_flag_subdevice:1,
286 		match_flag_subvendor:1,
287 		match_flag_device:1,
288 		match_flag_vendor:1;
289 #endif
290 	uint16_t	vendor;
291 	uint16_t	device;
292 	uint16_t	subvendor;
293 	uint16_t	subdevice;
294 	uint16_t	class_id;
295 	uint16_t	subclass;
296 	uint16_t	revid;
297 	uint16_t	unused;
298 	uintptr_t	driver_data;
299 	char		*descr;
300 };
301 
302 #define	PCI_DEV(v, d)							\
303 	.match_flag_vendor = 1, .vendor = (v),				\
304 	.match_flag_device = 1, .device = (d)
305 #define	PCI_SUBDEV(sv, sd)						\
306 	.match_flag_subvendor = 1, .subvendor = (sv),			\
307 	.match_flag_subdevice = 1, .subdevice = (sd)
308 #define	PCI_CLASS(x)							\
309 	.match_flag_class = 1, .class_id = (x)
310 #define	PCI_SUBCLASS(x)							\
311 	.match_flag_subclass = 1, .subclass = (x)
312 #define	PCI_REVID(x)							\
313 	.match_flag_revid = 1, .revid = (x)
314 #define	PCI_DESCR(x)							\
315 	.descr = (x)
316 #define PCI_PNP_STR							\
317 	"M16:mask;U16:vendor;U16:device;U16:subvendor;U16:subdevice;"	\
318 	"U16:class;U16:subclass;U16:revid;"
319 #define PCI_PNP_INFO(table)						\
320 	MODULE_PNP_INFO(PCI_PNP_STR, pci, table, table,			\
321 	    sizeof(table) / sizeof(table[0]))
322 
323 const struct pci_device_table *pci_match_device(device_t child,
324     const struct pci_device_table *id, size_t nelt);
325 #define PCI_MATCH(child, table) \
326 	pci_match_device(child, (table), nitems(table));
327 
328 /* Only if the prerequisites are present */
329 #if defined(_SYS_BUS_H_) && defined(_SYS_PCIIO_H_)
330 struct pci_devinfo {
331         STAILQ_ENTRY(pci_devinfo) pci_links;
332 	struct resource_list resources;
333 	pcicfgregs		cfg;
334 	struct pci_conf		conf;
335 };
336 #endif
337 
338 #ifdef _SYS_BUS_H_
339 
340 #include "pci_if.h"
341 
342 enum pci_device_ivars {
343     PCI_IVAR_SUBVENDOR,
344     PCI_IVAR_SUBDEVICE,
345     PCI_IVAR_VENDOR,
346     PCI_IVAR_DEVICE,
347     PCI_IVAR_DEVID,
348     PCI_IVAR_CLASS,
349     PCI_IVAR_SUBCLASS,
350     PCI_IVAR_PROGIF,
351     PCI_IVAR_REVID,
352     PCI_IVAR_INTPIN,
353     PCI_IVAR_IRQ,
354     PCI_IVAR_DOMAIN,
355     PCI_IVAR_BUS,
356     PCI_IVAR_SLOT,
357     PCI_IVAR_FUNCTION,
358     PCI_IVAR_ETHADDR,
359     PCI_IVAR_CMDREG,
360     PCI_IVAR_CACHELNSZ,
361     PCI_IVAR_MINGNT,
362     PCI_IVAR_MAXLAT,
363     PCI_IVAR_LATTIMER
364 };
365 
366 /*
367  * Simplified accessors for pci devices
368  */
369 #define	PCI_ACCESSOR(var, ivar, type)					\
370 	__BUS_ACCESSOR(pci, var, PCI, ivar, type)
371 
372 PCI_ACCESSOR(subvendor,		SUBVENDOR,	uint16_t)
373 PCI_ACCESSOR(subdevice,		SUBDEVICE,	uint16_t)
374 PCI_ACCESSOR(vendor,		VENDOR,		uint16_t)
375 PCI_ACCESSOR(device,		DEVICE,		uint16_t)
376 PCI_ACCESSOR(devid,		DEVID,		uint32_t)
377 PCI_ACCESSOR(class,		CLASS,		uint8_t)
378 PCI_ACCESSOR(subclass,		SUBCLASS,	uint8_t)
379 PCI_ACCESSOR(progif,		PROGIF,		uint8_t)
380 PCI_ACCESSOR(revid,		REVID,		uint8_t)
381 PCI_ACCESSOR(intpin,		INTPIN,		uint8_t)
382 PCI_ACCESSOR(irq,		IRQ,		uint8_t)
383 PCI_ACCESSOR(domain,		DOMAIN,		uint32_t)
384 PCI_ACCESSOR(bus,		BUS,		uint8_t)
385 PCI_ACCESSOR(slot,		SLOT,		uint8_t)
386 PCI_ACCESSOR(function,		FUNCTION,	uint8_t)
387 PCI_ACCESSOR(ether,		ETHADDR,	uint8_t *)
388 PCI_ACCESSOR(cmdreg,		CMDREG,		uint8_t)
389 PCI_ACCESSOR(cachelnsz,		CACHELNSZ,	uint8_t)
390 PCI_ACCESSOR(mingnt,		MINGNT,		uint8_t)
391 PCI_ACCESSOR(maxlat,		MAXLAT,		uint8_t)
392 PCI_ACCESSOR(lattimer,		LATTIMER,	uint8_t)
393 
394 #undef PCI_ACCESSOR
395 
396 /*
397  * Operations on configuration space.
398  */
399 static __inline uint32_t
400 pci_read_config(device_t dev, int reg, int width)
401 {
402     return PCI_READ_CONFIG(device_get_parent(dev), dev, reg, width);
403 }
404 
405 static __inline void
406 pci_write_config(device_t dev, int reg, uint32_t val, int width)
407 {
408     PCI_WRITE_CONFIG(device_get_parent(dev), dev, reg, val, width);
409 }
410 
411 /*
412  * Ivars for pci bridges.
413  */
414 
415 /*typedef enum pci_device_ivars pcib_device_ivars;*/
416 enum pcib_device_ivars {
417 	PCIB_IVAR_DOMAIN,
418 	PCIB_IVAR_BUS
419 };
420 
421 #define	PCIB_ACCESSOR(var, ivar, type)					 \
422     __BUS_ACCESSOR(pcib, var, PCIB, ivar, type)
423 
424 PCIB_ACCESSOR(domain,		DOMAIN,		uint32_t)
425 PCIB_ACCESSOR(bus,		BUS,		uint32_t)
426 
427 #undef PCIB_ACCESSOR
428 
429 /*
430  * PCI interrupt validation.  Invalid interrupt values such as 0 or 128
431  * on i386 or other platforms should be mapped out in the MD pcireadconf
432  * code and not here, since the only MI invalid IRQ is 255.
433  */
434 #define	PCI_INVALID_IRQ		255
435 #define	PCI_INTERRUPT_VALID(x)	((x) != PCI_INVALID_IRQ)
436 
437 /*
438  * Convenience functions.
439  *
440  * These should be used in preference to manually manipulating
441  * configuration space.
442  */
443 static __inline int
444 pci_enable_busmaster(device_t dev)
445 {
446     return(PCI_ENABLE_BUSMASTER(device_get_parent(dev), dev));
447 }
448 
449 static __inline int
450 pci_disable_busmaster(device_t dev)
451 {
452     return(PCI_DISABLE_BUSMASTER(device_get_parent(dev), dev));
453 }
454 
455 static __inline int
456 pci_enable_io(device_t dev, int space)
457 {
458     return(PCI_ENABLE_IO(device_get_parent(dev), dev, space));
459 }
460 
461 static __inline int
462 pci_disable_io(device_t dev, int space)
463 {
464     return(PCI_DISABLE_IO(device_get_parent(dev), dev, space));
465 }
466 
467 static __inline int
468 pci_get_vpd_ident(device_t dev, const char **identptr)
469 {
470     return(PCI_GET_VPD_IDENT(device_get_parent(dev), dev, identptr));
471 }
472 
473 static __inline int
474 pci_get_vpd_readonly(device_t dev, const char *kw, const char **vptr)
475 {
476     return(PCI_GET_VPD_READONLY(device_get_parent(dev), dev, kw, vptr));
477 }
478 
479 /*
480  * Check if the address range falls within the VGA defined address range(s)
481  */
482 static __inline int
483 pci_is_vga_ioport_range(rman_res_t start, rman_res_t end)
484 {
485 
486 	return (((start >= 0x3b0 && end <= 0x3bb) ||
487 	    (start >= 0x3c0 && end <= 0x3df)) ? 1 : 0);
488 }
489 
490 static __inline int
491 pci_is_vga_memory_range(rman_res_t start, rman_res_t end)
492 {
493 
494 	return ((start >= 0xa0000 && end <= 0xbffff) ? 1 : 0);
495 }
496 
497 /*
498  * PCI power states are as defined by ACPI:
499  *
500  * D0	State in which device is on and running.  It is receiving full
501  *	power from the system and delivering full functionality to the user.
502  * D1	Class-specific low-power state in which device context may or may not
503  *	be lost.  Buses in D1 cannot do anything to the bus that would force
504  *	devices on that bus to lose context.
505  * D2	Class-specific low-power state in which device context may or may
506  *	not be lost.  Attains greater power savings than D1.  Buses in D2
507  *	can cause devices on that bus to lose some context.  Devices in D2
508  *	must be prepared for the bus to be in D2 or higher.
509  * D3	State in which the device is off and not running.  Device context is
510  *	lost.  Power can be removed from the device.
511  */
512 #define	PCI_POWERSTATE_D0	0
513 #define	PCI_POWERSTATE_D1	1
514 #define	PCI_POWERSTATE_D2	2
515 #define	PCI_POWERSTATE_D3	3
516 #define	PCI_POWERSTATE_UNKNOWN	-1
517 
518 static __inline int
519 pci_set_powerstate(device_t dev, int state)
520 {
521     return PCI_SET_POWERSTATE(device_get_parent(dev), dev, state);
522 }
523 
524 static __inline int
525 pci_get_powerstate(device_t dev)
526 {
527     return PCI_GET_POWERSTATE(device_get_parent(dev), dev);
528 }
529 
530 static __inline int
531 pci_find_cap(device_t dev, int capability, int *capreg)
532 {
533     return (PCI_FIND_CAP(device_get_parent(dev), dev, capability, capreg));
534 }
535 
536 static __inline int
537 pci_find_next_cap(device_t dev, int capability, int start, int *capreg)
538 {
539     return (PCI_FIND_NEXT_CAP(device_get_parent(dev), dev, capability, start,
540         capreg));
541 }
542 
543 static __inline int
544 pci_find_extcap(device_t dev, int capability, int *capreg)
545 {
546     return (PCI_FIND_EXTCAP(device_get_parent(dev), dev, capability, capreg));
547 }
548 
549 static __inline int
550 pci_find_next_extcap(device_t dev, int capability, int start, int *capreg)
551 {
552     return (PCI_FIND_NEXT_EXTCAP(device_get_parent(dev), dev, capability,
553         start, capreg));
554 }
555 
556 static __inline int
557 pci_find_htcap(device_t dev, int capability, int *capreg)
558 {
559     return (PCI_FIND_HTCAP(device_get_parent(dev), dev, capability, capreg));
560 }
561 
562 static __inline int
563 pci_find_next_htcap(device_t dev, int capability, int start, int *capreg)
564 {
565     return (PCI_FIND_NEXT_HTCAP(device_get_parent(dev), dev, capability,
566         start, capreg));
567 }
568 
569 static __inline int
570 pci_alloc_msi(device_t dev, int *count)
571 {
572     return (PCI_ALLOC_MSI(device_get_parent(dev), dev, count));
573 }
574 
575 static __inline int
576 pci_alloc_msix(device_t dev, int *count)
577 {
578     return (PCI_ALLOC_MSIX(device_get_parent(dev), dev, count));
579 }
580 
581 static __inline void
582 pci_enable_msi(device_t dev, uint64_t address, uint16_t data)
583 {
584     PCI_ENABLE_MSI(device_get_parent(dev), dev, address, data);
585 }
586 
587 static __inline void
588 pci_enable_msix(device_t dev, u_int index, uint64_t address, uint32_t data)
589 {
590     PCI_ENABLE_MSIX(device_get_parent(dev), dev, index, address, data);
591 }
592 
593 static __inline void
594 pci_disable_msi(device_t dev)
595 {
596     PCI_DISABLE_MSI(device_get_parent(dev), dev);
597 }
598 
599 static __inline int
600 pci_remap_msix(device_t dev, int count, const u_int *vectors)
601 {
602     return (PCI_REMAP_MSIX(device_get_parent(dev), dev, count, vectors));
603 }
604 
605 static __inline int
606 pci_release_msi(device_t dev)
607 {
608     return (PCI_RELEASE_MSI(device_get_parent(dev), dev));
609 }
610 
611 static __inline int
612 pci_msi_count(device_t dev)
613 {
614     return (PCI_MSI_COUNT(device_get_parent(dev), dev));
615 }
616 
617 static __inline int
618 pci_msix_count(device_t dev)
619 {
620     return (PCI_MSIX_COUNT(device_get_parent(dev), dev));
621 }
622 
623 static __inline int
624 pci_msix_pba_bar(device_t dev)
625 {
626     return (PCI_MSIX_PBA_BAR(device_get_parent(dev), dev));
627 }
628 
629 static __inline int
630 pci_msix_table_bar(device_t dev)
631 {
632     return (PCI_MSIX_TABLE_BAR(device_get_parent(dev), dev));
633 }
634 
635 static __inline int
636 pci_get_id(device_t dev, enum pci_id_type type, uintptr_t *id)
637 {
638     return (PCI_GET_ID(device_get_parent(dev), dev, type, id));
639 }
640 
641 /*
642  * This is the deprecated interface, there is no way to tell the difference
643  * between a failure and a valid value that happens to be the same as the
644  * failure value.
645  */
646 static __inline uint16_t
647 pci_get_rid(device_t dev)
648 {
649     uintptr_t rid;
650 
651     if (pci_get_id(dev, PCI_ID_RID, &rid) != 0)
652         return (0);
653 
654     return (rid);
655 }
656 
657 static __inline void
658 pci_child_added(device_t dev)
659 {
660 
661     return (PCI_CHILD_ADDED(device_get_parent(dev), dev));
662 }
663 
664 device_t pci_find_bsf(uint8_t, uint8_t, uint8_t);
665 device_t pci_find_dbsf(uint32_t, uint8_t, uint8_t, uint8_t);
666 device_t pci_find_device(uint16_t, uint16_t);
667 device_t pci_find_class(uint8_t class, uint8_t subclass);
668 
669 /* Can be used by drivers to manage the MSI-X table. */
670 int	pci_pending_msix(device_t dev, u_int index);
671 
672 int	pci_msi_device_blacklisted(device_t dev);
673 int	pci_msix_device_blacklisted(device_t dev);
674 
675 void	pci_ht_map_msi(device_t dev, uint64_t addr);
676 
677 device_t pci_find_pcie_root_port(device_t dev);
678 int	pci_get_max_payload(device_t dev);
679 int	pci_get_max_read_req(device_t dev);
680 void	pci_restore_state(device_t dev);
681 void	pci_save_state(device_t dev);
682 int	pci_set_max_read_req(device_t dev, int size);
683 int	pci_power_reset(device_t dev);
684 uint32_t pcie_read_config(device_t dev, int reg, int width);
685 void	pcie_write_config(device_t dev, int reg, uint32_t value, int width);
686 uint32_t pcie_adjust_config(device_t dev, int reg, uint32_t mask,
687 	    uint32_t value, int width);
688 bool	pcie_flr(device_t dev, u_int max_delay, bool force);
689 int	pcie_get_max_completion_timeout(device_t dev);
690 bool	pcie_wait_for_pending_transactions(device_t dev, u_int max_delay);
691 int	pcie_link_reset(device_t port, int pcie_location);
692 
693 void	pci_print_faulted_dev(void);
694 
695 #endif	/* _SYS_BUS_H_ */
696 
697 /*
698  * cdev switch for control device, initialised in generic PCI code
699  */
700 extern struct cdevsw pcicdev;
701 
702 /*
703  * List of all PCI devices, generation count for the list.
704  */
705 STAILQ_HEAD(devlist, pci_devinfo);
706 
707 extern struct devlist	pci_devq;
708 extern uint32_t	pci_generation;
709 
710 struct pci_map *pci_find_bar(device_t dev, int reg);
711 int	pci_bar_enabled(device_t dev, struct pci_map *pm);
712 struct pcicfg_vpd *pci_fetch_vpd_list(device_t dev);
713 
714 #define	VGA_PCI_BIOS_SHADOW_ADDR	0xC0000
715 #define	VGA_PCI_BIOS_SHADOW_SIZE	131072
716 
717 int	vga_pci_is_boot_display(device_t dev);
718 void *	vga_pci_map_bios(device_t dev, size_t *size);
719 void	vga_pci_unmap_bios(device_t dev, void *bios);
720 int	vga_pci_repost(device_t dev);
721 
722 /**
723  * Global eventhandlers invoked when PCI devices are added or removed
724  * from the system.
725  */
726 typedef void (*pci_event_fn)(void *arg, device_t dev);
727 EVENTHANDLER_DECLARE(pci_add_device, pci_event_fn);
728 EVENTHANDLER_DECLARE(pci_delete_device, pci_event_fn);
729 
730 #endif /* _PCIVAR_H_ */
731