xref: /netbsd-src/sys/dev/pci/pci_subr.c (revision 5bbd2a12505d72a8177929a37b5cee489d0a1cfd)
1 /*	$NetBSD: pci_subr.c,v 1.92 2012/04/24 09:53:41 drochner Exp $	*/
2 
3 /*
4  * Copyright (c) 1997 Zubin D. Dittia.  All rights reserved.
5  * Copyright (c) 1995, 1996, 1998, 2000
6  *	Christopher G. Demetriou.  All rights reserved.
7  * Copyright (c) 1994 Charles M. Hannum.  All rights reserved.
8  *
9  * Redistribution and use in source and binary forms, with or without
10  * modification, are permitted provided that the following conditions
11  * are met:
12  * 1. Redistributions of source code must retain the above copyright
13  *    notice, this list of conditions and the following disclaimer.
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  * 3. All advertising materials mentioning features or use of this software
18  *    must display the following acknowledgement:
19  *	This product includes software developed by Charles M. Hannum.
20  * 4. The name of the author may not be used to endorse or promote products
21  *    derived from this software without specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
24  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
25  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
26  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
27  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
28  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
32  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 /*
36  * PCI autoconfiguration support functions.
37  *
38  * Note: This file is also built into a userland library (libpci).
39  * Pay attention to this when you make modifications.
40  */
41 
42 #include <sys/cdefs.h>
43 __KERNEL_RCSID(0, "$NetBSD: pci_subr.c,v 1.92 2012/04/24 09:53:41 drochner Exp $");
44 
45 #ifdef _KERNEL_OPT
46 #include "opt_pci.h"
47 #endif
48 
49 #include <sys/param.h>
50 
51 #ifdef _KERNEL
52 #include <sys/systm.h>
53 #include <sys/intr.h>
54 #include <sys/module.h>
55 #else
56 #include <pci.h>
57 #include <stdbool.h>
58 #include <stdio.h>
59 #endif
60 
61 #include <dev/pci/pcireg.h>
62 #ifdef _KERNEL
63 #include <dev/pci/pcivar.h>
64 #endif
65 
66 /*
67  * Descriptions of known PCI classes and subclasses.
68  *
69  * Subclasses are described in the same way as classes, but have a
70  * NULL subclass pointer.
71  */
72 struct pci_class {
73 	const char	*name;
74 	u_int		val;		/* as wide as pci_{,sub}class_t */
75 	const struct pci_class *subclasses;
76 };
77 
78 static const struct pci_class pci_subclass_prehistoric[] = {
79 	{ "miscellaneous",	PCI_SUBCLASS_PREHISTORIC_MISC,	NULL,	},
80 	{ "VGA",		PCI_SUBCLASS_PREHISTORIC_VGA,	NULL,	},
81 	{ NULL,			0,				NULL,	},
82 };
83 
84 static const struct pci_class pci_subclass_mass_storage[] = {
85 	{ "SCSI",		PCI_SUBCLASS_MASS_STORAGE_SCSI,	NULL,	},
86 	{ "IDE",		PCI_SUBCLASS_MASS_STORAGE_IDE,	NULL,	},
87 	{ "floppy",		PCI_SUBCLASS_MASS_STORAGE_FLOPPY, NULL, },
88 	{ "IPI",		PCI_SUBCLASS_MASS_STORAGE_IPI,	NULL,	},
89 	{ "RAID",		PCI_SUBCLASS_MASS_STORAGE_RAID,	NULL,	},
90 	{ "ATA",		PCI_SUBCLASS_MASS_STORAGE_ATA,	NULL,	},
91 	{ "SATA",		PCI_SUBCLASS_MASS_STORAGE_SATA,	NULL,	},
92 	{ "SAS",		PCI_SUBCLASS_MASS_STORAGE_SAS,	NULL,	},
93 	{ "miscellaneous",	PCI_SUBCLASS_MASS_STORAGE_MISC,	NULL,	},
94 	{ NULL,			0,				NULL,	},
95 };
96 
97 static const struct pci_class pci_subclass_network[] = {
98 	{ "ethernet",		PCI_SUBCLASS_NETWORK_ETHERNET,	NULL,	},
99 	{ "token ring",		PCI_SUBCLASS_NETWORK_TOKENRING,	NULL,	},
100 	{ "FDDI",		PCI_SUBCLASS_NETWORK_FDDI,	NULL,	},
101 	{ "ATM",		PCI_SUBCLASS_NETWORK_ATM,	NULL,	},
102 	{ "ISDN",		PCI_SUBCLASS_NETWORK_ISDN,	NULL,	},
103 	{ "WorldFip",		PCI_SUBCLASS_NETWORK_WORLDFIP,	NULL,	},
104 	{ "PCMIG Multi Computing", PCI_SUBCLASS_NETWORK_PCIMGMULTICOMP, NULL, },
105 	{ "miscellaneous",	PCI_SUBCLASS_NETWORK_MISC,	NULL,	},
106 	{ NULL,			0,				NULL,	},
107 };
108 
109 static const struct pci_class pci_subclass_display[] = {
110 	{ "VGA",		PCI_SUBCLASS_DISPLAY_VGA,	NULL,	},
111 	{ "XGA",		PCI_SUBCLASS_DISPLAY_XGA,	NULL,	},
112 	{ "3D",			PCI_SUBCLASS_DISPLAY_3D,	NULL,	},
113 	{ "miscellaneous",	PCI_SUBCLASS_DISPLAY_MISC,	NULL,	},
114 	{ NULL,			0,				NULL,	},
115 };
116 
117 static const struct pci_class pci_subclass_multimedia[] = {
118 	{ "video",		PCI_SUBCLASS_MULTIMEDIA_VIDEO,	NULL,	},
119 	{ "audio",		PCI_SUBCLASS_MULTIMEDIA_AUDIO,	NULL,	},
120 	{ "telephony",		PCI_SUBCLASS_MULTIMEDIA_TELEPHONY, NULL,},
121 	{ "miscellaneous",	PCI_SUBCLASS_MULTIMEDIA_MISC,	NULL,	},
122 	{ NULL,			0,				NULL,	},
123 };
124 
125 static const struct pci_class pci_subclass_memory[] = {
126 	{ "RAM",		PCI_SUBCLASS_MEMORY_RAM,	NULL,	},
127 	{ "flash",		PCI_SUBCLASS_MEMORY_FLASH,	NULL,	},
128 	{ "miscellaneous",	PCI_SUBCLASS_MEMORY_MISC,	NULL,	},
129 	{ NULL,			0,				NULL,	},
130 };
131 
132 static const struct pci_class pci_subclass_bridge[] = {
133 	{ "host",		PCI_SUBCLASS_BRIDGE_HOST,	NULL,	},
134 	{ "ISA",		PCI_SUBCLASS_BRIDGE_ISA,	NULL,	},
135 	{ "EISA",		PCI_SUBCLASS_BRIDGE_EISA,	NULL,	},
136 	{ "MicroChannel",	PCI_SUBCLASS_BRIDGE_MC,		NULL,	},
137 	{ "PCI",		PCI_SUBCLASS_BRIDGE_PCI,	NULL,	},
138 	{ "PCMCIA",		PCI_SUBCLASS_BRIDGE_PCMCIA,	NULL,	},
139 	{ "NuBus",		PCI_SUBCLASS_BRIDGE_NUBUS,	NULL,	},
140 	{ "CardBus",		PCI_SUBCLASS_BRIDGE_CARDBUS,	NULL,	},
141 	{ "RACEway",		PCI_SUBCLASS_BRIDGE_RACEWAY,	NULL,	},
142 	{ "Semi-transparent PCI", PCI_SUBCLASS_BRIDGE_STPCI,	NULL,	},
143 	{ "InfiniBand",		PCI_SUBCLASS_BRIDGE_INFINIBAND,	NULL,	},
144 	{ "miscellaneous",	PCI_SUBCLASS_BRIDGE_MISC,	NULL,	},
145 	{ NULL,			0,				NULL,	},
146 };
147 
148 static const struct pci_class pci_subclass_communications[] = {
149 	{ "serial",		PCI_SUBCLASS_COMMUNICATIONS_SERIAL,	NULL, },
150 	{ "parallel",		PCI_SUBCLASS_COMMUNICATIONS_PARALLEL,	NULL, },
151 	{ "multi-port serial",	PCI_SUBCLASS_COMMUNICATIONS_MPSERIAL,	NULL, },
152 	{ "modem",		PCI_SUBCLASS_COMMUNICATIONS_MODEM,	NULL, },
153 	{ "GPIB",		PCI_SUBCLASS_COMMUNICATIONS_GPIB,	NULL, },
154 	{ "smartcard",		PCI_SUBCLASS_COMMUNICATIONS_SMARTCARD,	NULL, },
155 	{ "miscellaneous",	PCI_SUBCLASS_COMMUNICATIONS_MISC,	NULL, },
156 	{ NULL,			0,					NULL, },
157 };
158 
159 static const struct pci_class pci_subclass_system[] = {
160 	{ "interrupt",		PCI_SUBCLASS_SYSTEM_PIC,	NULL,	},
161 	{ "8237 DMA",		PCI_SUBCLASS_SYSTEM_DMA,	NULL,	},
162 	{ "8254 timer",		PCI_SUBCLASS_SYSTEM_TIMER,	NULL,	},
163 	{ "RTC",		PCI_SUBCLASS_SYSTEM_RTC,	NULL,	},
164 	{ "PCI Hot-Plug",	PCI_SUBCLASS_SYSTEM_PCIHOTPLUG, NULL,	},
165 	{ "SD Host Controller",	PCI_SUBCLASS_SYSTEM_SDHC,	NULL,	},
166 	{ "miscellaneous",	PCI_SUBCLASS_SYSTEM_MISC,	NULL,	},
167 	{ NULL,			0,				NULL,	},
168 };
169 
170 static const struct pci_class pci_subclass_input[] = {
171 	{ "keyboard",		PCI_SUBCLASS_INPUT_KEYBOARD,	NULL,	},
172 	{ "digitizer",		PCI_SUBCLASS_INPUT_DIGITIZER,	NULL,	},
173 	{ "mouse",		PCI_SUBCLASS_INPUT_MOUSE,	NULL,	},
174 	{ "scanner",		PCI_SUBCLASS_INPUT_SCANNER,	NULL,	},
175 	{ "game port",		PCI_SUBCLASS_INPUT_GAMEPORT,	NULL,	},
176 	{ "miscellaneous",	PCI_SUBCLASS_INPUT_MISC,	NULL,	},
177 	{ NULL,			0,				NULL,	},
178 };
179 
180 static const struct pci_class pci_subclass_dock[] = {
181 	{ "generic",		PCI_SUBCLASS_DOCK_GENERIC,	NULL,	},
182 	{ "miscellaneous",	PCI_SUBCLASS_DOCK_MISC,		NULL,	},
183 	{ NULL,			0,				NULL,	},
184 };
185 
186 static const struct pci_class pci_subclass_processor[] = {
187 	{ "386",		PCI_SUBCLASS_PROCESSOR_386,	NULL,	},
188 	{ "486",		PCI_SUBCLASS_PROCESSOR_486,	NULL,	},
189 	{ "Pentium",		PCI_SUBCLASS_PROCESSOR_PENTIUM, NULL,	},
190 	{ "Alpha",		PCI_SUBCLASS_PROCESSOR_ALPHA,	NULL,	},
191 	{ "PowerPC",		PCI_SUBCLASS_PROCESSOR_POWERPC, NULL,	},
192 	{ "MIPS",		PCI_SUBCLASS_PROCESSOR_MIPS,	NULL,	},
193 	{ "Co-processor",	PCI_SUBCLASS_PROCESSOR_COPROC,	NULL,	},
194 	{ NULL,			0,				NULL,	},
195 };
196 
197 static const struct pci_class pci_subclass_serialbus[] = {
198 	{ "Firewire",		PCI_SUBCLASS_SERIALBUS_FIREWIRE, NULL,	},
199 	{ "ACCESS.bus",		PCI_SUBCLASS_SERIALBUS_ACCESS,	NULL,	},
200 	{ "SSA",		PCI_SUBCLASS_SERIALBUS_SSA,	NULL,	},
201 	{ "USB",		PCI_SUBCLASS_SERIALBUS_USB,	NULL,	},
202 	/* XXX Fiber Channel/_FIBRECHANNEL */
203 	{ "Fiber Channel",	PCI_SUBCLASS_SERIALBUS_FIBER,	NULL,	},
204 	{ "SMBus",		PCI_SUBCLASS_SERIALBUS_SMBUS,	NULL,	},
205 	{ "InfiniBand",		PCI_SUBCLASS_SERIALBUS_INFINIBAND, NULL,},
206 	{ "IPMI",		PCI_SUBCLASS_SERIALBUS_IPMI,	NULL,	},
207 	{ "SERCOS",		PCI_SUBCLASS_SERIALBUS_SERCOS,	NULL,	},
208 	{ "CANbus",		PCI_SUBCLASS_SERIALBUS_CANBUS,	NULL,	},
209 	{ NULL,			0,				NULL,	},
210 };
211 
212 static const struct pci_class pci_subclass_wireless[] = {
213 	{ "IrDA",		PCI_SUBCLASS_WIRELESS_IRDA,	NULL,	},
214 	{ "Consumer IR",	PCI_SUBCLASS_WIRELESS_CONSUMERIR, NULL,	},
215 	{ "RF",			PCI_SUBCLASS_WIRELESS_RF,	NULL,	},
216 	{ "bluetooth",		PCI_SUBCLASS_WIRELESS_BLUETOOTH, NULL,	},
217 	{ "broadband",		PCI_SUBCLASS_WIRELESS_BROADBAND, NULL,	},
218 	{ "802.11a (5 GHz)",	PCI_SUBCLASS_WIRELESS_802_11A,	NULL,	},
219 	{ "802.11b (2.4 GHz)",	PCI_SUBCLASS_WIRELESS_802_11B,	NULL,	},
220 	{ "miscellaneous",	PCI_SUBCLASS_WIRELESS_MISC,	NULL,	},
221 	{ NULL,			0,				NULL,	},
222 };
223 
224 static const struct pci_class pci_subclass_i2o[] = {
225 	{ "standard",		PCI_SUBCLASS_I2O_STANDARD,	NULL,	},
226 	{ NULL,			0,				NULL,	},
227 };
228 
229 static const struct pci_class pci_subclass_satcom[] = {
230 	{ "TV",			PCI_SUBCLASS_SATCOM_TV,	 	NULL,	},
231 	{ "audio",		PCI_SUBCLASS_SATCOM_AUDIO, 	NULL,	},
232 	{ "voice",		PCI_SUBCLASS_SATCOM_VOICE, 	NULL,	},
233 	{ "data",		PCI_SUBCLASS_SATCOM_DATA,	NULL,	},
234 	{ NULL,			0,				NULL,	},
235 };
236 
237 static const struct pci_class pci_subclass_crypto[] = {
238 	{ "network/computing",	PCI_SUBCLASS_CRYPTO_NETCOMP, 	NULL,	},
239 	{ "entertainment",	PCI_SUBCLASS_CRYPTO_ENTERTAINMENT, NULL,},
240 	{ "miscellaneous",	PCI_SUBCLASS_CRYPTO_MISC, 	NULL,	},
241 	{ NULL,			0,				NULL,	},
242 };
243 
244 static const struct pci_class pci_subclass_dasp[] = {
245 	{ "DPIO",		PCI_SUBCLASS_DASP_DPIO,		NULL,	},
246 	{ "Time and Frequency",	PCI_SUBCLASS_DASP_TIMEFREQ,	NULL,	},
247 	{ "synchronization",	PCI_SUBCLASS_DASP_SYNC,		NULL,	},
248 	{ "management",		PCI_SUBCLASS_DASP_MGMT,		NULL,	},
249 	{ "miscellaneous",	PCI_SUBCLASS_DASP_MISC,		NULL,	},
250 	{ NULL,			0,				NULL,	},
251 };
252 
253 static const struct pci_class pci_class[] = {
254 	{ "prehistoric",	PCI_CLASS_PREHISTORIC,
255 	    pci_subclass_prehistoric,				},
256 	{ "mass storage",	PCI_CLASS_MASS_STORAGE,
257 	    pci_subclass_mass_storage,				},
258 	{ "network",		PCI_CLASS_NETWORK,
259 	    pci_subclass_network,				},
260 	{ "display",		PCI_CLASS_DISPLAY,
261 	    pci_subclass_display,				},
262 	{ "multimedia",		PCI_CLASS_MULTIMEDIA,
263 	    pci_subclass_multimedia,				},
264 	{ "memory",		PCI_CLASS_MEMORY,
265 	    pci_subclass_memory,				},
266 	{ "bridge",		PCI_CLASS_BRIDGE,
267 	    pci_subclass_bridge,				},
268 	{ "communications",	PCI_CLASS_COMMUNICATIONS,
269 	    pci_subclass_communications,			},
270 	{ "system",		PCI_CLASS_SYSTEM,
271 	    pci_subclass_system,				},
272 	{ "input",		PCI_CLASS_INPUT,
273 	    pci_subclass_input,					},
274 	{ "dock",		PCI_CLASS_DOCK,
275 	    pci_subclass_dock,					},
276 	{ "processor",		PCI_CLASS_PROCESSOR,
277 	    pci_subclass_processor,				},
278 	{ "serial bus",		PCI_CLASS_SERIALBUS,
279 	    pci_subclass_serialbus,				},
280 	{ "wireless",		PCI_CLASS_WIRELESS,
281 	    pci_subclass_wireless,				},
282 	{ "I2O",		PCI_CLASS_I2O,
283 	    pci_subclass_i2o,					},
284 	{ "satellite comm",	PCI_CLASS_SATCOM,
285 	    pci_subclass_satcom,				},
286 	{ "crypto",		PCI_CLASS_CRYPTO,
287 	    pci_subclass_crypto,				},
288 	{ "DASP",		PCI_CLASS_DASP,
289 	    pci_subclass_dasp,					},
290 	{ "undefined",		PCI_CLASS_UNDEFINED,
291 	    NULL,						},
292 	{ NULL,			0,
293 	    NULL,						},
294 };
295 
296 void pci_load_verbose(void);
297 
298 #if defined(_KERNEL)
299 /*
300  * In kernel, these routines are provided and linked via the
301  * pciverbose module.
302  */
303 const char *pci_findvendor_stub(pcireg_t);
304 const char *pci_findproduct_stub(pcireg_t);
305 
306 const char *(*pci_findvendor)(pcireg_t) = pci_findvendor_stub;
307 const char *(*pci_findproduct)(pcireg_t) = pci_findproduct_stub;
308 const char *pci_unmatched = "";
309 #else
310 /*
311  * For userland we just set the vectors here.
312  */
313 const char *(*pci_findvendor)(pcireg_t id_reg) = pci_findvendor_real;
314 const char *(*pci_findproduct)(pcireg_t id_reg) = pci_findproduct_real;
315 const char *pci_unmatched = "unmatched ";
316 #endif
317 
318 int pciverbose_loaded = 0;
319 
320 #if defined(_KERNEL)
321 /*
322  * Routine to load the pciverbose kernel module as needed
323  */
324 void pci_load_verbose(void)
325 {
326 	if (pciverbose_loaded == 0)
327 		module_autoload("pciverbose", MODULE_CLASS_MISC);
328 }
329 
330 const char *pci_findvendor_stub(pcireg_t id_reg)
331 {
332 	pci_load_verbose();
333 	if (pciverbose_loaded)
334 		return pci_findvendor(id_reg);
335 	else
336 		return NULL;
337 }
338 
339 const char *pci_findproduct_stub(pcireg_t id_reg)
340 {
341 	pci_load_verbose();
342 	if (pciverbose_loaded)
343 		return pci_findproduct(id_reg);
344 	else
345 		return NULL;
346 }
347 #endif
348 
349 void
350 pci_devinfo(pcireg_t id_reg, pcireg_t class_reg, int showclass, char *cp,
351     size_t l)
352 {
353 	pci_vendor_id_t vendor;
354 	pci_product_id_t product;
355 	pci_class_t class;
356 	pci_subclass_t subclass;
357 	pci_interface_t interface;
358 	pci_revision_t revision;
359 	const char *unmatched = pci_unmatched;
360 	const char *vendor_namep, *product_namep;
361 	const struct pci_class *classp, *subclassp;
362 	char *ep;
363 
364 	ep = cp + l;
365 
366 	vendor = PCI_VENDOR(id_reg);
367 	product = PCI_PRODUCT(id_reg);
368 
369 	class = PCI_CLASS(class_reg);
370 	subclass = PCI_SUBCLASS(class_reg);
371 	interface = PCI_INTERFACE(class_reg);
372 	revision = PCI_REVISION(class_reg);
373 
374 	vendor_namep = pci_findvendor(id_reg);
375 	product_namep = pci_findproduct(id_reg);
376 
377 	classp = pci_class;
378 	while (classp->name != NULL) {
379 		if (class == classp->val)
380 			break;
381 		classp++;
382 	}
383 
384 	subclassp = (classp->name != NULL) ? classp->subclasses : NULL;
385 	while (subclassp && subclassp->name != NULL) {
386 		if (subclass == subclassp->val)
387 			break;
388 		subclassp++;
389 	}
390 
391 	if (vendor_namep == NULL)
392 		cp += snprintf(cp, ep - cp, "%svendor 0x%04x product 0x%04x",
393 		    unmatched, vendor, product);
394 	else if (product_namep != NULL)
395 		cp += snprintf(cp, ep - cp, "%s %s", vendor_namep,
396 		    product_namep);
397 	else
398 		cp += snprintf(cp, ep - cp, "%s product 0x%04x",
399 		    vendor_namep, product);
400 	if (showclass) {
401 		cp += snprintf(cp, ep - cp, " (");
402 		if (classp->name == NULL)
403 			cp += snprintf(cp, ep - cp,
404 			    "class 0x%02x, subclass 0x%02x", class, subclass);
405 		else {
406 			if (subclassp == NULL || subclassp->name == NULL)
407 				cp += snprintf(cp, ep - cp,
408 				    "%s, subclass 0x%02x",
409 				    classp->name, subclass);
410 			else
411 				cp += snprintf(cp, ep - cp, "%s %s",
412 				    subclassp->name, classp->name);
413 		}
414 		if (interface != 0)
415 			cp += snprintf(cp, ep - cp, ", interface 0x%02x",
416 			    interface);
417 		if (revision != 0)
418 			cp += snprintf(cp, ep - cp, ", revision 0x%02x",
419 			    revision);
420 		cp += snprintf(cp, ep - cp, ")");
421 	}
422 }
423 
424 #ifdef _KERNEL
425 void
426 pci_aprint_devinfo_fancy(const struct pci_attach_args *pa, const char *naive,
427 			 const char *known, int addrev)
428 {
429 	char devinfo[256];
430 
431 	if (known) {
432 		aprint_normal(": %s", known);
433 		if (addrev)
434 			aprint_normal(" (rev. 0x%02x)",
435 				      PCI_REVISION(pa->pa_class));
436 		aprint_normal("\n");
437 	} else {
438 		pci_devinfo(pa->pa_id, pa->pa_class, 0,
439 			    devinfo, sizeof(devinfo));
440 		aprint_normal(": %s (rev. 0x%02x)\n", devinfo,
441 			      PCI_REVISION(pa->pa_class));
442 	}
443 	if (naive)
444 		aprint_naive(": %s\n", naive);
445 	else
446 		aprint_naive("\n");
447 }
448 #endif
449 
450 /*
451  * Print out most of the PCI configuration registers.  Typically used
452  * in a device attach routine like this:
453  *
454  *	#ifdef MYDEV_DEBUG
455  *		printf("%s: ", device_xname(&sc->sc_dev));
456  *		pci_conf_print(pa->pa_pc, pa->pa_tag, NULL);
457  *	#endif
458  */
459 
460 #define	i2o(i)	((i) * 4)
461 #define	o2i(o)	((o) / 4)
462 #define	onoff2(str, bit, onstr, offstr)					\
463 	printf("      %s: %s\n", (str), (rval & (bit)) ? onstr : offstr);
464 #define	onoff(str, bit)	onoff2(str, bit, "on", "off")
465 
466 static void
467 pci_conf_print_common(
468 #ifdef _KERNEL
469     pci_chipset_tag_t pc, pcitag_t tag,
470 #endif
471     const pcireg_t *regs)
472 {
473 	const char *name;
474 	const struct pci_class *classp, *subclassp;
475 	pcireg_t rval;
476 
477 	rval = regs[o2i(PCI_ID_REG)];
478 	name = pci_findvendor(rval);
479 	if (name)
480 		printf("    Vendor Name: %s (0x%04x)\n", name,
481 		    PCI_VENDOR(rval));
482 	else
483 		printf("    Vendor ID: 0x%04x\n", PCI_VENDOR(rval));
484 	name = pci_findproduct(rval);
485 	if (name)
486 		printf("    Device Name: %s (0x%04x)\n", name,
487 		    PCI_PRODUCT(rval));
488 	else
489 		printf("    Device ID: 0x%04x\n", PCI_PRODUCT(rval));
490 
491 	rval = regs[o2i(PCI_COMMAND_STATUS_REG)];
492 
493 	printf("    Command register: 0x%04x\n", rval & 0xffff);
494 	onoff("I/O space accesses", PCI_COMMAND_IO_ENABLE);
495 	onoff("Memory space accesses", PCI_COMMAND_MEM_ENABLE);
496 	onoff("Bus mastering", PCI_COMMAND_MASTER_ENABLE);
497 	onoff("Special cycles", PCI_COMMAND_SPECIAL_ENABLE);
498 	onoff("MWI transactions", PCI_COMMAND_INVALIDATE_ENABLE);
499 	onoff("Palette snooping", PCI_COMMAND_PALETTE_ENABLE);
500 	onoff("Parity error checking", PCI_COMMAND_PARITY_ENABLE);
501 	onoff("Address/data stepping", PCI_COMMAND_STEPPING_ENABLE);
502 	onoff("System error (SERR)", PCI_COMMAND_SERR_ENABLE);
503 	onoff("Fast back-to-back transactions", PCI_COMMAND_BACKTOBACK_ENABLE);
504 	onoff("Interrupt disable", PCI_COMMAND_INTERRUPT_DISABLE);
505 
506 	printf("    Status register: 0x%04x\n", (rval >> 16) & 0xffff);
507 	onoff2("Interrupt status", PCI_STATUS_INT_STATUS, "active", "inactive");
508 	onoff("Capability List support", PCI_STATUS_CAPLIST_SUPPORT);
509 	onoff("66 MHz capable", PCI_STATUS_66MHZ_SUPPORT);
510 	onoff("User Definable Features (UDF) support", PCI_STATUS_UDF_SUPPORT);
511 	onoff("Fast back-to-back capable", PCI_STATUS_BACKTOBACK_SUPPORT);
512 	onoff("Data parity error detected", PCI_STATUS_PARITY_ERROR);
513 
514 	printf("      DEVSEL timing: ");
515 	switch (rval & PCI_STATUS_DEVSEL_MASK) {
516 	case PCI_STATUS_DEVSEL_FAST:
517 		printf("fast");
518 		break;
519 	case PCI_STATUS_DEVSEL_MEDIUM:
520 		printf("medium");
521 		break;
522 	case PCI_STATUS_DEVSEL_SLOW:
523 		printf("slow");
524 		break;
525 	default:
526 		printf("unknown/reserved");	/* XXX */
527 		break;
528 	}
529 	printf(" (0x%x)\n", (rval & PCI_STATUS_DEVSEL_MASK) >> 25);
530 
531 	onoff("Slave signaled Target Abort", PCI_STATUS_TARGET_TARGET_ABORT);
532 	onoff("Master received Target Abort", PCI_STATUS_MASTER_TARGET_ABORT);
533 	onoff("Master received Master Abort", PCI_STATUS_MASTER_ABORT);
534 	onoff("Asserted System Error (SERR)", PCI_STATUS_SPECIAL_ERROR);
535 	onoff("Parity error detected", PCI_STATUS_PARITY_DETECT);
536 
537 	rval = regs[o2i(PCI_CLASS_REG)];
538 	for (classp = pci_class; classp->name != NULL; classp++) {
539 		if (PCI_CLASS(rval) == classp->val)
540 			break;
541 	}
542 	subclassp = (classp->name != NULL) ? classp->subclasses : NULL;
543 	while (subclassp && subclassp->name != NULL) {
544 		if (PCI_SUBCLASS(rval) == subclassp->val)
545 			break;
546 		subclassp++;
547 	}
548 	if (classp->name != NULL) {
549 		printf("    Class Name: %s (0x%02x)\n", classp->name,
550 		    PCI_CLASS(rval));
551 		if (subclassp != NULL && subclassp->name != NULL)
552 			printf("    Subclass Name: %s (0x%02x)\n",
553 			    subclassp->name, PCI_SUBCLASS(rval));
554 		else
555 			printf("    Subclass ID: 0x%02x\n", PCI_SUBCLASS(rval));
556 	} else {
557 		printf("    Class ID: 0x%02x\n", PCI_CLASS(rval));
558 		printf("    Subclass ID: 0x%02x\n", PCI_SUBCLASS(rval));
559 	}
560 	printf("    Interface: 0x%02x\n", PCI_INTERFACE(rval));
561 	printf("    Revision ID: 0x%02x\n", PCI_REVISION(rval));
562 
563 	rval = regs[o2i(PCI_BHLC_REG)];
564 	printf("    BIST: 0x%02x\n", PCI_BIST(rval));
565 	printf("    Header Type: 0x%02x%s (0x%02x)\n", PCI_HDRTYPE_TYPE(rval),
566 	    PCI_HDRTYPE_MULTIFN(rval) ? "+multifunction" : "",
567 	    PCI_HDRTYPE(rval));
568 	printf("    Latency Timer: 0x%02x\n", PCI_LATTIMER(rval));
569 	printf("    Cache Line Size: 0x%02x\n", PCI_CACHELINE(rval));
570 }
571 
572 static int
573 pci_conf_print_bar(
574 #ifdef _KERNEL
575     pci_chipset_tag_t pc, pcitag_t tag,
576 #endif
577     const pcireg_t *regs, int reg, const char *name
578 #ifdef _KERNEL
579     , int sizebar
580 #endif
581     )
582 {
583 	int width;
584 	pcireg_t rval, rval64h;
585 #ifdef _KERNEL
586 	int s;
587 	pcireg_t mask, mask64h;
588 #endif
589 
590 	width = 4;
591 
592 	/*
593 	 * Section 6.2.5.1, `Address Maps', tells us that:
594 	 *
595 	 * 1) The builtin software should have already mapped the
596 	 * device in a reasonable way.
597 	 *
598 	 * 2) A device which wants 2^n bytes of memory will hardwire
599 	 * the bottom n bits of the address to 0.  As recommended,
600 	 * we write all 1s and see what we get back.
601 	 */
602 
603 	rval = regs[o2i(reg)];
604 	if (PCI_MAPREG_TYPE(rval) == PCI_MAPREG_TYPE_MEM &&
605 	    PCI_MAPREG_MEM_TYPE(rval) == PCI_MAPREG_MEM_TYPE_64BIT) {
606 		rval64h = regs[o2i(reg + 4)];
607 		width = 8;
608 	} else
609 		rval64h = 0;
610 
611 #ifdef _KERNEL
612 	/* XXX don't size unknown memory type? */
613 	if (rval != 0 && sizebar) {
614 		/*
615 		 * The following sequence seems to make some devices
616 		 * (e.g. host bus bridges, which don't normally
617 		 * have their space mapped) very unhappy, to
618 		 * the point of crashing the system.
619 		 *
620 		 * Therefore, if the mapping register is zero to
621 		 * start out with, don't bother trying.
622 		 */
623 		s = splhigh();
624 		pci_conf_write(pc, tag, reg, 0xffffffff);
625 		mask = pci_conf_read(pc, tag, reg);
626 		pci_conf_write(pc, tag, reg, rval);
627 		if (PCI_MAPREG_TYPE(rval) == PCI_MAPREG_TYPE_MEM &&
628 		    PCI_MAPREG_MEM_TYPE(rval) == PCI_MAPREG_MEM_TYPE_64BIT) {
629 			pci_conf_write(pc, tag, reg + 4, 0xffffffff);
630 			mask64h = pci_conf_read(pc, tag, reg + 4);
631 			pci_conf_write(pc, tag, reg + 4, rval64h);
632 		} else
633 			mask64h = 0;
634 		splx(s);
635 	} else
636 		mask = mask64h = 0;
637 #endif /* _KERNEL */
638 
639 	printf("    Base address register at 0x%02x", reg);
640 	if (name)
641 		printf(" (%s)", name);
642 	printf("\n      ");
643 	if (rval == 0) {
644 		printf("not implemented(?)\n");
645 		return width;
646 	}
647 	printf("type: ");
648 	if (PCI_MAPREG_TYPE(rval) == PCI_MAPREG_TYPE_MEM) {
649 		const char *type, *prefetch;
650 
651 		switch (PCI_MAPREG_MEM_TYPE(rval)) {
652 		case PCI_MAPREG_MEM_TYPE_32BIT:
653 			type = "32-bit";
654 			break;
655 		case PCI_MAPREG_MEM_TYPE_32BIT_1M:
656 			type = "32-bit-1M";
657 			break;
658 		case PCI_MAPREG_MEM_TYPE_64BIT:
659 			type = "64-bit";
660 			break;
661 		default:
662 			type = "unknown (XXX)";
663 			break;
664 		}
665 		if (PCI_MAPREG_MEM_PREFETCHABLE(rval))
666 			prefetch = "";
667 		else
668 			prefetch = "non";
669 		printf("%s %sprefetchable memory\n", type, prefetch);
670 		switch (PCI_MAPREG_MEM_TYPE(rval)) {
671 		case PCI_MAPREG_MEM_TYPE_64BIT:
672 			printf("      base: 0x%016llx, ",
673 			    PCI_MAPREG_MEM64_ADDR(
674 				((((long long) rval64h) << 32) | rval)));
675 #ifdef _KERNEL
676 			if (sizebar)
677 				printf("size: 0x%016llx",
678 				    PCI_MAPREG_MEM64_SIZE(
679 				      ((((long long) mask64h) << 32) | mask)));
680 			else
681 #endif /* _KERNEL */
682 				printf("not sized");
683 			printf("\n");
684 			break;
685 		case PCI_MAPREG_MEM_TYPE_32BIT:
686 		case PCI_MAPREG_MEM_TYPE_32BIT_1M:
687 		default:
688 			printf("      base: 0x%08x, ",
689 			    PCI_MAPREG_MEM_ADDR(rval));
690 #ifdef _KERNEL
691 			if (sizebar)
692 				printf("size: 0x%08x",
693 				    PCI_MAPREG_MEM_SIZE(mask));
694 			else
695 #endif /* _KERNEL */
696 				printf("not sized");
697 			printf("\n");
698 			break;
699 		}
700 	} else {
701 #ifdef _KERNEL
702 		if (sizebar)
703 			printf("%d-bit ", mask & ~0x0000ffff ? 32 : 16);
704 #endif /* _KERNEL */
705 		printf("i/o\n");
706 		printf("      base: 0x%08x, ", PCI_MAPREG_IO_ADDR(rval));
707 #ifdef _KERNEL
708 		if (sizebar)
709 			printf("size: 0x%08x", PCI_MAPREG_IO_SIZE(mask));
710 		else
711 #endif /* _KERNEL */
712 			printf("not sized");
713 		printf("\n");
714 	}
715 
716 	return width;
717 }
718 
719 static void
720 pci_conf_print_regs(const pcireg_t *regs, int first, int pastlast)
721 {
722 	int off, needaddr, neednl;
723 
724 	needaddr = 1;
725 	neednl = 0;
726 	for (off = first; off < pastlast; off += 4) {
727 		if ((off % 16) == 0 || needaddr) {
728 			printf("    0x%02x:", off);
729 			needaddr = 0;
730 		}
731 		printf(" 0x%08x", regs[o2i(off)]);
732 		neednl = 1;
733 		if ((off % 16) == 12) {
734 			printf("\n");
735 			neednl = 0;
736 		}
737 	}
738 	if (neednl)
739 		printf("\n");
740 }
741 
742 static void
743 pci_conf_print_type0(
744 #ifdef _KERNEL
745     pci_chipset_tag_t pc, pcitag_t tag,
746 #endif
747     const pcireg_t *regs
748 #ifdef _KERNEL
749     , int sizebars
750 #endif
751     )
752 {
753 	int off, width;
754 	pcireg_t rval;
755 
756 	for (off = PCI_MAPREG_START; off < PCI_MAPREG_END; off += width) {
757 #ifdef _KERNEL
758 		width = pci_conf_print_bar(pc, tag, regs, off, NULL, sizebars);
759 #else
760 		width = pci_conf_print_bar(regs, off, NULL);
761 #endif
762 	}
763 
764 	printf("    Cardbus CIS Pointer: 0x%08x\n", regs[o2i(0x28)]);
765 
766 	rval = regs[o2i(PCI_SUBSYS_ID_REG)];
767 	printf("    Subsystem vendor ID: 0x%04x\n", PCI_VENDOR(rval));
768 	printf("    Subsystem ID: 0x%04x\n", PCI_PRODUCT(rval));
769 
770 	/* XXX */
771 	printf("    Expansion ROM Base Address: 0x%08x\n", regs[o2i(0x30)]);
772 
773 	if (regs[o2i(PCI_COMMAND_STATUS_REG)] & PCI_STATUS_CAPLIST_SUPPORT)
774 		printf("    Capability list pointer: 0x%02x\n",
775 		    PCI_CAPLIST_PTR(regs[o2i(PCI_CAPLISTPTR_REG)]));
776 	else
777 		printf("    Reserved @ 0x34: 0x%08x\n", regs[o2i(0x34)]);
778 
779 	printf("    Reserved @ 0x38: 0x%08x\n", regs[o2i(0x38)]);
780 
781 	rval = regs[o2i(PCI_INTERRUPT_REG)];
782 	printf("    Maximum Latency: 0x%02x\n", (rval >> 24) & 0xff);
783 	printf("    Minimum Grant: 0x%02x\n", (rval >> 16) & 0xff);
784 	printf("    Interrupt pin: 0x%02x ", PCI_INTERRUPT_PIN(rval));
785 	switch (PCI_INTERRUPT_PIN(rval)) {
786 	case PCI_INTERRUPT_PIN_NONE:
787 		printf("(none)");
788 		break;
789 	case PCI_INTERRUPT_PIN_A:
790 		printf("(pin A)");
791 		break;
792 	case PCI_INTERRUPT_PIN_B:
793 		printf("(pin B)");
794 		break;
795 	case PCI_INTERRUPT_PIN_C:
796 		printf("(pin C)");
797 		break;
798 	case PCI_INTERRUPT_PIN_D:
799 		printf("(pin D)");
800 		break;
801 	default:
802 		printf("(? ? ?)");
803 		break;
804 	}
805 	printf("\n");
806 	printf("    Interrupt line: 0x%02x\n", PCI_INTERRUPT_LINE(rval));
807 }
808 
809 static void
810 pci_conf_print_pcie_cap(const pcireg_t *regs, int capoff)
811 {
812 	bool check_slot = false;
813 	static const char * const linkspeeds[] = {"2.5", "5.0", "8.0"};
814 
815 	printf("\n  PCI Express Capabilities Register\n");
816 	printf("    Capability version: %x\n",
817 	    (unsigned int)((regs[o2i(capoff)] & 0x000f0000) >> 16));
818 	printf("    Device type: ");
819 	switch ((regs[o2i(capoff)] & 0x00f00000) >> 20) {
820 	case 0x0:
821 		printf("PCI Express Endpoint device\n");
822 		break;
823 	case 0x1:
824 		printf("Legacy PCI Express Endpoint device\n");
825 		break;
826 	case 0x4:
827 		printf("Root Port of PCI Express Root Complex\n");
828 		check_slot = true;
829 		break;
830 	case 0x5:
831 		printf("Upstream Port of PCI Express Switch\n");
832 		break;
833 	case 0x6:
834 		printf("Downstream Port of PCI Express Switch\n");
835 		check_slot = true;
836 		break;
837 	case 0x7:
838 		printf("PCI Express to PCI/PCI-X Bridge\n");
839 		break;
840 	case 0x8:
841 		printf("PCI/PCI-X to PCI Express Bridge\n");
842 		break;
843 	default:
844 		printf("unknown\n");
845 		break;
846 	}
847 	if (check_slot && (regs[o2i(capoff)] & 0x01000000) != 0)
848 		printf("    Slot implemented\n");
849 	printf("    Interrupt Message Number: %x\n",
850 	    (unsigned int)((regs[o2i(capoff)] & 0x4e000000) >> 27));
851 	printf("    Link Capabilities Register: 0x%08x\n",
852 	    regs[o2i(capoff + 0x0c)]);
853 	printf("      Maximum Link Speed: ");
854 	if ((regs[o2i(capoff + 0x0c)] & 0x000f) < 1 ||
855 	    (regs[o2i(capoff + 0x0c)] & 0x000f) > 3) {
856 		printf("unknown %u value\n",
857 		    (regs[o2i(capoff + 0x0c)] & 0x000f));
858 	} else {
859 		printf("%sGb/s\n", linkspeeds[(regs[o2i(capoff + 0x0c)] & 0x000f) - 1]);
860 	}
861 	printf("      Maximum Link Width: x%u lanes\n",
862 	    (regs[o2i(capoff + 0x0c)] & 0x03f0) >> 4);
863 	printf("      Port Number: %u\n", regs[o2i(capoff + 0x0c)] >> 24);
864 	printf("    Link Status Register: 0x%04x\n",
865 	    regs[o2i(capoff + 0x10)] >> 16);
866 	printf("      Negotiated Link Speed: ");
867 	if (((regs[o2i(capoff + 0x10)] >> 16) & 0x000f) < 1 ||
868 	    ((regs[o2i(capoff + 0x10)] >> 16) & 0x000f) > 3) {
869 		printf("unknown %u value\n",
870 		    (regs[o2i(capoff + 0x10)] >> 16) & 0x000f);
871 	} else {
872 		printf("%sGb/s\n", linkspeeds[((regs[o2i(capoff + 0x10)] >> 16) & 0x000f) - 1]);
873 	}
874 	printf("      Negotiated Link Width: x%u lanes\n",
875 	    (regs[o2i(capoff + 0x10)] >> 20) & 0x003f);
876 	if ((regs[o2i(capoff + 0x18)] & 0x07ff) != 0) {
877 		printf("    Slot Control Register:\n");
878 		if ((regs[o2i(capoff + 0x18)] & 0x0001) != 0)
879 			printf("      Attention Button Pressed Enabled\n");
880 		if ((regs[o2i(capoff + 0x18)] & 0x0002) != 0)
881 			printf("      Power Fault Detected Enabled\n");
882 		if ((regs[o2i(capoff + 0x18)] & 0x0004) != 0)
883 			printf("      MRL Sensor Changed Enabled\n");
884 		if ((regs[o2i(capoff + 0x18)] & 0x0008) != 0)
885 			printf("      Presense Detected Changed Enabled\n");
886 		if ((regs[o2i(capoff + 0x18)] & 0x0010) != 0)
887 			printf("      Command Completed Interrupt Enabled\n");
888 		if ((regs[o2i(capoff + 0x18)] & 0x0020) != 0)
889 			printf("      Hot-Plug Interrupt Enabled\n");
890 		printf("      Attention Indicator Control: ");
891 		switch ((regs[o2i(capoff + 0x18)] & 0x00c0) >> 6) {
892 		case 0x0:
893 			printf("reserved\n");
894 			break;
895 		case 0x1:
896 			printf("on\n");
897 			break;
898 		case 0x2:
899 			printf("blink\n");
900 			break;
901 		case 0x3:
902 			printf("off\n");
903 			break;
904 		}
905 		printf("      Power Indicator Control: ");
906 		switch ((regs[o2i(capoff + 0x18)] & 0x0300) >> 8) {
907 		case 0x0:
908 			printf("reserved\n");
909 			break;
910 		case 0x1:
911 			printf("on\n");
912 			break;
913 		case 0x2:
914 			printf("blink\n");
915 			break;
916 		case 0x3:
917 			printf("off\n");
918 			break;
919 		}
920 		printf("      Power Controller Control: ");
921 		if ((regs[o2i(capoff + 0x18)] & 0x0400) != 0)
922 			printf("off\n");
923 		else
924 			printf("on\n");
925 	}
926 }
927 
928 static const char *
929 pci_conf_print_pcipm_cap_aux(uint16_t caps)
930 {
931 	switch ((caps >> 6) & 7) {
932 	case 0:	return "self-powered";
933 	case 1: return "55 mA";
934 	case 2: return "100 mA";
935 	case 3: return "160 mA";
936 	case 4: return "220 mA";
937 	case 5: return "270 mA";
938 	case 6: return "320 mA";
939 	case 7:
940 	default: return "375 mA";
941 	}
942 }
943 
944 static const char *
945 pci_conf_print_pcipm_cap_pmrev(uint8_t val)
946 {
947 	static const char unk[] = "unknown";
948 	static const char *pmrev[8] = {
949 		unk, "1.0", "1.1", "1.2", unk, unk, unk, unk
950 	};
951 	if (val > 7)
952 		return unk;
953 	return pmrev[val];
954 }
955 
956 static void
957 pci_conf_print_pcipm_cap(const pcireg_t *regs, int capoff)
958 {
959 	uint16_t caps, pmcsr;
960 
961 	caps = regs[o2i(capoff)] >> 16;
962 	pmcsr = regs[o2i(capoff + 0x04)] & 0xffff;
963 
964 	printf("\n  PCI Power Management Capabilities Register\n");
965 
966 	printf("    Capabilities register: 0x%04x\n", caps);
967 	printf("      Version: %s\n",
968 	    pci_conf_print_pcipm_cap_pmrev(caps & 0x3));
969 	printf("      PME# clock: %s\n", caps & 0x4 ? "on" : "off");
970 	printf("      Device specific initialization: %s\n",
971 	    caps & 0x20 ? "on" : "off");
972 	printf("      3.3V auxiliary current: %s\n",
973 	    pci_conf_print_pcipm_cap_aux(caps));
974 	printf("      D1 power management state support: %s\n",
975 	    (caps >> 9) & 1 ? "on" : "off");
976 	printf("      D2 power management state support: %s\n",
977 	    (caps >> 10) & 1 ? "on" : "off");
978 	printf("      PME# support: 0x%02x\n", caps >> 11);
979 
980 	printf("    Control/status register: 0x%04x\n", pmcsr);
981 	printf("      Power state: D%d\n", pmcsr & 3);
982 	printf("      PCI Express reserved: %s\n",
983 	    (pmcsr >> 2) & 1 ? "on" : "off");
984 	printf("      No soft reset: %s\n", (pmcsr >> 3) & 1 ? "on" : "off");
985 	printf("      PME# assertion %sabled\n",
986 	    (pmcsr >> 8) & 1 ? "en" : "dis");
987 	printf("      PME# status: %s\n", (pmcsr >> 15) ? "on" : "off");
988 }
989 
990 static void
991 pci_conf_print_msi_cap(const pcireg_t *regs, int capoff)
992 {
993 	uint32_t ctl, mmc, mme;
994 
995 	regs += o2i(capoff);
996 	ctl = *regs++;
997 	mmc = __SHIFTOUT(ctl, PCI_MSI_CTL_MMC_MASK);
998 	mme = __SHIFTOUT(ctl, PCI_MSI_CTL_MME_MASK);
999 
1000 	printf("\n  PCI Message Signaled Interrupt\n");
1001 
1002 	printf("    Message Control register: 0x%04x\n", ctl >> 16);
1003 	printf("      MSI Enabled: %s\n",
1004 	    ctl & PCI_MSI_CTL_MSI_ENABLE ? "yes" : "no");
1005 	printf("      Multiple Message Capable: %s (%d vector%s)\n",
1006 	    mmc > 0 ? "yes" : "no", 1 << mmc, mmc > 0 ? "s" : "");
1007 	printf("      Multiple Message Enabled: %s (%d vector%s)\n",
1008 	    mme > 0 ? "on" : "off", 1 << mme, mme > 0 ? "s" : "");
1009 	printf("      64 Bit Address Capable: %s\n",
1010 	    ctl & PCI_MSI_CTL_64BIT_ADDR ? "yes" : "no");
1011 	printf("      Per-Vector Masking Capable: %s\n",
1012 	    ctl & PCI_MSI_CTL_PERVEC_MASK ? "yes" : "no");
1013 	printf("    Message Address %sregister: 0x%08x\n",
1014 	    ctl & PCI_MSI_CTL_64BIT_ADDR ? "(lower) " : "", *regs++);
1015 	if (ctl & PCI_MSI_CTL_64BIT_ADDR) {
1016 		printf("    Message Address %sregister: 0x%08x\n",
1017 		    "(upper) ", *regs++);
1018 	}
1019 	printf("    Message Data register: 0x%08x\n", *regs++);
1020 	if (ctl & PCI_MSI_CTL_PERVEC_MASK) {
1021 		printf("    Vector Mask register: 0x%08x\n", *regs++);
1022 		printf("    Vector Pending register: 0x%08x\n", *regs++);
1023 	}
1024 }
1025 static void
1026 pci_conf_print_caplist(
1027 #ifdef _KERNEL
1028     pci_chipset_tag_t pc, pcitag_t tag,
1029 #endif
1030     const pcireg_t *regs, int capoff)
1031 {
1032 	int off;
1033 	pcireg_t rval;
1034 	int pcie_off = -1, pcipm_off = -1, msi_off = -1;
1035 
1036 	for (off = PCI_CAPLIST_PTR(regs[o2i(capoff)]);
1037 	     off != 0;
1038 	     off = PCI_CAPLIST_NEXT(regs[o2i(off)])) {
1039 		rval = regs[o2i(off)];
1040 		printf("  Capability register at 0x%02x\n", off);
1041 
1042 		printf("    type: 0x%02x (", PCI_CAPLIST_CAP(rval));
1043 		switch (PCI_CAPLIST_CAP(rval)) {
1044 		case PCI_CAP_RESERVED0:
1045 			printf("reserved");
1046 			break;
1047 		case PCI_CAP_PWRMGMT:
1048 			printf("Power Management, rev. %s",
1049 			    pci_conf_print_pcipm_cap_pmrev((rval >> 0) & 0x07));
1050 			pcipm_off = off;
1051 			break;
1052 		case PCI_CAP_AGP:
1053 			printf("AGP, rev. %d.%d",
1054 				PCI_CAP_AGP_MAJOR(rval),
1055 				PCI_CAP_AGP_MINOR(rval));
1056 			break;
1057 		case PCI_CAP_VPD:
1058 			printf("VPD");
1059 			break;
1060 		case PCI_CAP_SLOTID:
1061 			printf("SlotID");
1062 			break;
1063 		case PCI_CAP_MSI:
1064 			printf("MSI");
1065 			msi_off = off;
1066 			break;
1067 		case PCI_CAP_CPCI_HOTSWAP:
1068 			printf("CompactPCI Hot-swapping");
1069 			break;
1070 		case PCI_CAP_PCIX:
1071 			printf("PCI-X");
1072 			break;
1073 		case PCI_CAP_LDT:
1074 			printf("LDT");
1075 			break;
1076 		case PCI_CAP_VENDSPEC:
1077 			printf("Vendor-specific");
1078 			break;
1079 		case PCI_CAP_DEBUGPORT:
1080 			printf("Debug Port");
1081 			break;
1082 		case PCI_CAP_CPCI_RSRCCTL:
1083 			printf("CompactPCI Resource Control");
1084 			break;
1085 		case PCI_CAP_HOTPLUG:
1086 			printf("Hot-Plug");
1087 			break;
1088 		case PCI_CAP_AGP8:
1089 			printf("AGP 8x");
1090 			break;
1091 		case PCI_CAP_SECURE:
1092 			printf("Secure Device");
1093 			break;
1094 		case PCI_CAP_PCIEXPRESS:
1095 			printf("PCI Express");
1096 			pcie_off = off;
1097 			break;
1098 		case PCI_CAP_MSIX:
1099 			printf("MSI-X");
1100 			break;
1101 		case PCI_CAP_SATA:
1102 			printf("SATA");
1103 			break;
1104 		case PCI_CAP_PCIAF:
1105 			printf("Advanced Features");
1106 			break;
1107 		default:
1108 			printf("unknown");
1109 		}
1110 		printf(")\n");
1111 	}
1112 	if (msi_off != -1)
1113 		pci_conf_print_msi_cap(regs, msi_off);
1114 	if (pcipm_off != -1)
1115 		pci_conf_print_pcipm_cap(regs, pcipm_off);
1116 	if (pcie_off != -1)
1117 		pci_conf_print_pcie_cap(regs, pcie_off);
1118 }
1119 
1120 /* Print the Secondary Status Register. */
1121 static void
1122 pci_conf_print_ssr(pcireg_t rval)
1123 {
1124 	pcireg_t devsel;
1125 
1126 	printf("    Secondary status register: 0x%04x\n", rval); /* XXX bits */
1127 	onoff("66 MHz capable", __BIT(5));
1128 	onoff("User Definable Features (UDF) support", __BIT(6));
1129 	onoff("Fast back-to-back capable", __BIT(7));
1130 	onoff("Data parity error detected", __BIT(8));
1131 
1132 	printf("      DEVSEL timing: ");
1133 	devsel = __SHIFTOUT(rval, __BITS(10, 9));
1134 	switch (devsel) {
1135 	case 0:
1136 		printf("fast");
1137 		break;
1138 	case 1:
1139 		printf("medium");
1140 		break;
1141 	case 2:
1142 		printf("slow");
1143 		break;
1144 	default:
1145 		printf("unknown/reserved");	/* XXX */
1146 		break;
1147 	}
1148 	printf(" (0x%x)\n", devsel);
1149 
1150 	onoff("Signalled target abort", __BIT(11));
1151 	onoff("Received target abort", __BIT(12));
1152 	onoff("Received master abort", __BIT(13));
1153 	onoff("Received system error", __BIT(14));
1154 	onoff("Detected parity error", __BIT(15));
1155 }
1156 
1157 static void
1158 pci_conf_print_type1(
1159 #ifdef _KERNEL
1160     pci_chipset_tag_t pc, pcitag_t tag,
1161 #endif
1162     const pcireg_t *regs
1163 #ifdef _KERNEL
1164     , int sizebars
1165 #endif
1166     )
1167 {
1168 	int off, width;
1169 	pcireg_t rval;
1170 
1171 	/*
1172 	 * XXX these need to be printed in more detail, need to be
1173 	 * XXX checked against specs/docs, etc.
1174 	 *
1175 	 * This layout was cribbed from the TI PCI2030 PCI-to-PCI
1176 	 * Bridge chip documentation, and may not be correct with
1177 	 * respect to various standards. (XXX)
1178 	 */
1179 
1180 	for (off = 0x10; off < 0x18; off += width) {
1181 #ifdef _KERNEL
1182 		width = pci_conf_print_bar(pc, tag, regs, off, NULL, sizebars);
1183 #else
1184 		width = pci_conf_print_bar(regs, off, NULL);
1185 #endif
1186 	}
1187 
1188 	printf("    Primary bus number: 0x%02x\n",
1189 	    (regs[o2i(0x18)] >> 0) & 0xff);
1190 	printf("    Secondary bus number: 0x%02x\n",
1191 	    (regs[o2i(0x18)] >> 8) & 0xff);
1192 	printf("    Subordinate bus number: 0x%02x\n",
1193 	    (regs[o2i(0x18)] >> 16) & 0xff);
1194 	printf("    Secondary bus latency timer: 0x%02x\n",
1195 	    (regs[o2i(0x18)] >> 24) & 0xff);
1196 
1197 	pci_conf_print_ssr(__SHIFTOUT(regs[o2i(0x1c)], __BITS(31, 16)));
1198 
1199 	/* XXX Print more prettily */
1200 	printf("    I/O region:\n");
1201 	printf("      base register:  0x%02x\n", (regs[o2i(0x1c)] >> 0) & 0xff);
1202 	printf("      limit register: 0x%02x\n", (regs[o2i(0x1c)] >> 8) & 0xff);
1203 	printf("      base upper 16 bits register:  0x%04x\n",
1204 	    (regs[o2i(0x30)] >> 0) & 0xffff);
1205 	printf("      limit upper 16 bits register: 0x%04x\n",
1206 	    (regs[o2i(0x30)] >> 16) & 0xffff);
1207 
1208 	/* XXX Print more prettily */
1209 	printf("    Memory region:\n");
1210 	printf("      base register:  0x%04x\n",
1211 	    (regs[o2i(0x20)] >> 0) & 0xffff);
1212 	printf("      limit register: 0x%04x\n",
1213 	    (regs[o2i(0x20)] >> 16) & 0xffff);
1214 
1215 	/* XXX Print more prettily */
1216 	printf("    Prefetchable memory region:\n");
1217 	printf("      base register:  0x%04x\n",
1218 	    (regs[o2i(0x24)] >> 0) & 0xffff);
1219 	printf("      limit register: 0x%04x\n",
1220 	    (regs[o2i(0x24)] >> 16) & 0xffff);
1221 	printf("      base upper 32 bits register:  0x%08x\n", regs[o2i(0x28)]);
1222 	printf("      limit upper 32 bits register: 0x%08x\n", regs[o2i(0x2c)]);
1223 
1224 	if (regs[o2i(PCI_COMMAND_STATUS_REG)] & PCI_STATUS_CAPLIST_SUPPORT)
1225 		printf("    Capability list pointer: 0x%02x\n",
1226 		    PCI_CAPLIST_PTR(regs[o2i(PCI_CAPLISTPTR_REG)]));
1227 	else
1228 		printf("    Reserved @ 0x34: 0x%08x\n", regs[o2i(0x34)]);
1229 
1230 	/* XXX */
1231 	printf("    Expansion ROM Base Address: 0x%08x\n", regs[o2i(0x38)]);
1232 
1233 	printf("    Interrupt line: 0x%02x\n",
1234 	    (regs[o2i(0x3c)] >> 0) & 0xff);
1235 	printf("    Interrupt pin: 0x%02x ",
1236 	    (regs[o2i(0x3c)] >> 8) & 0xff);
1237 	switch ((regs[o2i(0x3c)] >> 8) & 0xff) {
1238 	case PCI_INTERRUPT_PIN_NONE:
1239 		printf("(none)");
1240 		break;
1241 	case PCI_INTERRUPT_PIN_A:
1242 		printf("(pin A)");
1243 		break;
1244 	case PCI_INTERRUPT_PIN_B:
1245 		printf("(pin B)");
1246 		break;
1247 	case PCI_INTERRUPT_PIN_C:
1248 		printf("(pin C)");
1249 		break;
1250 	case PCI_INTERRUPT_PIN_D:
1251 		printf("(pin D)");
1252 		break;
1253 	default:
1254 		printf("(? ? ?)");
1255 		break;
1256 	}
1257 	printf("\n");
1258 	rval = (regs[o2i(0x3c)] >> 16) & 0xffff;
1259 	printf("    Bridge control register: 0x%04x\n", rval); /* XXX bits */
1260 	onoff("Parity error response", 0x0001);
1261 	onoff("Secondary SERR forwarding", 0x0002);
1262 	onoff("ISA enable", 0x0004);
1263 	onoff("VGA enable", 0x0008);
1264 	onoff("Master abort reporting", 0x0020);
1265 	onoff("Secondary bus reset", 0x0040);
1266 	onoff("Fast back-to-back capable", 0x0080);
1267 }
1268 
1269 static void
1270 pci_conf_print_type2(
1271 #ifdef _KERNEL
1272     pci_chipset_tag_t pc, pcitag_t tag,
1273 #endif
1274     const pcireg_t *regs
1275 #ifdef _KERNEL
1276     , int sizebars
1277 #endif
1278     )
1279 {
1280 	pcireg_t rval;
1281 
1282 	/*
1283 	 * XXX these need to be printed in more detail, need to be
1284 	 * XXX checked against specs/docs, etc.
1285 	 *
1286 	 * This layout was cribbed from the TI PCI1420 PCI-to-CardBus
1287 	 * controller chip documentation, and may not be correct with
1288 	 * respect to various standards. (XXX)
1289 	 */
1290 
1291 #ifdef _KERNEL
1292 	pci_conf_print_bar(pc, tag, regs, 0x10,
1293 	    "CardBus socket/ExCA registers", sizebars);
1294 #else
1295 	pci_conf_print_bar(regs, 0x10, "CardBus socket/ExCA registers");
1296 #endif
1297 
1298 	if (regs[o2i(PCI_COMMAND_STATUS_REG)] & PCI_STATUS_CAPLIST_SUPPORT)
1299 		printf("    Capability list pointer: 0x%02x\n",
1300 		    PCI_CAPLIST_PTR(regs[o2i(PCI_CARDBUS_CAPLISTPTR_REG)]));
1301 	else
1302 		printf("    Reserved @ 0x14: 0x%04" PRIxMAX "\n",
1303 		       __SHIFTOUT(regs[o2i(0x14)], __BITS(15, 0)));
1304 	pci_conf_print_ssr(__SHIFTOUT(regs[o2i(0x14)], __BITS(31, 16)));
1305 
1306 	printf("    PCI bus number: 0x%02x\n",
1307 	    (regs[o2i(0x18)] >> 0) & 0xff);
1308 	printf("    CardBus bus number: 0x%02x\n",
1309 	    (regs[o2i(0x18)] >> 8) & 0xff);
1310 	printf("    Subordinate bus number: 0x%02x\n",
1311 	    (regs[o2i(0x18)] >> 16) & 0xff);
1312 	printf("    CardBus latency timer: 0x%02x\n",
1313 	    (regs[o2i(0x18)] >> 24) & 0xff);
1314 
1315 	/* XXX Print more prettily */
1316 	printf("    CardBus memory region 0:\n");
1317 	printf("      base register:  0x%08x\n", regs[o2i(0x1c)]);
1318 	printf("      limit register: 0x%08x\n", regs[o2i(0x20)]);
1319 	printf("    CardBus memory region 1:\n");
1320 	printf("      base register:  0x%08x\n", regs[o2i(0x24)]);
1321 	printf("      limit register: 0x%08x\n", regs[o2i(0x28)]);
1322 	printf("    CardBus I/O region 0:\n");
1323 	printf("      base register:  0x%08x\n", regs[o2i(0x2c)]);
1324 	printf("      limit register: 0x%08x\n", regs[o2i(0x30)]);
1325 	printf("    CardBus I/O region 1:\n");
1326 	printf("      base register:  0x%08x\n", regs[o2i(0x34)]);
1327 	printf("      limit register: 0x%08x\n", regs[o2i(0x38)]);
1328 
1329 	printf("    Interrupt line: 0x%02x\n",
1330 	    (regs[o2i(0x3c)] >> 0) & 0xff);
1331 	printf("    Interrupt pin: 0x%02x ",
1332 	    (regs[o2i(0x3c)] >> 8) & 0xff);
1333 	switch ((regs[o2i(0x3c)] >> 8) & 0xff) {
1334 	case PCI_INTERRUPT_PIN_NONE:
1335 		printf("(none)");
1336 		break;
1337 	case PCI_INTERRUPT_PIN_A:
1338 		printf("(pin A)");
1339 		break;
1340 	case PCI_INTERRUPT_PIN_B:
1341 		printf("(pin B)");
1342 		break;
1343 	case PCI_INTERRUPT_PIN_C:
1344 		printf("(pin C)");
1345 		break;
1346 	case PCI_INTERRUPT_PIN_D:
1347 		printf("(pin D)");
1348 		break;
1349 	default:
1350 		printf("(? ? ?)");
1351 		break;
1352 	}
1353 	printf("\n");
1354 	rval = (regs[o2i(0x3c)] >> 16) & 0xffff;
1355 	printf("    Bridge control register: 0x%04x\n", rval);
1356 	onoff("Parity error response", __BIT(0));
1357 	onoff("SERR# enable", __BIT(1));
1358 	onoff("ISA enable", __BIT(2));
1359 	onoff("VGA enable", __BIT(3));
1360 	onoff("Master abort mode", __BIT(5));
1361 	onoff("Secondary (CardBus) bus reset", __BIT(6));
1362 	onoff("Functional interrupts routed by ExCA registers", __BIT(7));
1363 	onoff("Memory window 0 prefetchable", __BIT(8));
1364 	onoff("Memory window 1 prefetchable", __BIT(9));
1365 	onoff("Write posting enable", __BIT(10));
1366 
1367 	rval = regs[o2i(0x40)];
1368 	printf("    Subsystem vendor ID: 0x%04x\n", PCI_VENDOR(rval));
1369 	printf("    Subsystem ID: 0x%04x\n", PCI_PRODUCT(rval));
1370 
1371 #ifdef _KERNEL
1372 	pci_conf_print_bar(pc, tag, regs, 0x44, "legacy-mode registers",
1373 	    sizebars);
1374 #else
1375 	pci_conf_print_bar(regs, 0x44, "legacy-mode registers");
1376 #endif
1377 }
1378 
1379 void
1380 pci_conf_print(
1381 #ifdef _KERNEL
1382     pci_chipset_tag_t pc, pcitag_t tag,
1383     void (*printfn)(pci_chipset_tag_t, pcitag_t, const pcireg_t *)
1384 #else
1385     int pcifd, u_int bus, u_int dev, u_int func
1386 #endif
1387     )
1388 {
1389 	pcireg_t regs[o2i(256)];
1390 	int off, capoff, endoff, hdrtype;
1391 	const char *typename;
1392 #ifdef _KERNEL
1393 	void (*typeprintfn)(pci_chipset_tag_t, pcitag_t, const pcireg_t *, int);
1394 	int sizebars;
1395 #else
1396 	void (*typeprintfn)(const pcireg_t *);
1397 #endif
1398 
1399 	printf("PCI configuration registers:\n");
1400 
1401 	for (off = 0; off < 256; off += 4) {
1402 #ifdef _KERNEL
1403 		regs[o2i(off)] = pci_conf_read(pc, tag, off);
1404 #else
1405 		if (pcibus_conf_read(pcifd, bus, dev, func, off,
1406 		    &regs[o2i(off)]) == -1)
1407 			regs[o2i(off)] = 0;
1408 #endif
1409 	}
1410 
1411 #ifdef _KERNEL
1412 	sizebars = 1;
1413 	if (PCI_CLASS(regs[o2i(PCI_CLASS_REG)]) == PCI_CLASS_BRIDGE &&
1414 	    PCI_SUBCLASS(regs[o2i(PCI_CLASS_REG)]) == PCI_SUBCLASS_BRIDGE_HOST)
1415 		sizebars = 0;
1416 #endif
1417 
1418 	/* common header */
1419 	printf("  Common header:\n");
1420 	pci_conf_print_regs(regs, 0, 16);
1421 
1422 	printf("\n");
1423 #ifdef _KERNEL
1424 	pci_conf_print_common(pc, tag, regs);
1425 #else
1426 	pci_conf_print_common(regs);
1427 #endif
1428 	printf("\n");
1429 
1430 	/* type-dependent header */
1431 	hdrtype = PCI_HDRTYPE_TYPE(regs[o2i(PCI_BHLC_REG)]);
1432 	switch (hdrtype) {		/* XXX make a table, eventually */
1433 	case 0:
1434 		/* Standard device header */
1435 		typename = "\"normal\" device";
1436 		typeprintfn = &pci_conf_print_type0;
1437 		capoff = PCI_CAPLISTPTR_REG;
1438 		endoff = 64;
1439 		break;
1440 	case 1:
1441 		/* PCI-PCI bridge header */
1442 		typename = "PCI-PCI bridge";
1443 		typeprintfn = &pci_conf_print_type1;
1444 		capoff = PCI_CAPLISTPTR_REG;
1445 		endoff = 64;
1446 		break;
1447 	case 2:
1448 		/* PCI-CardBus bridge header */
1449 		typename = "PCI-CardBus bridge";
1450 		typeprintfn = &pci_conf_print_type2;
1451 		capoff = PCI_CARDBUS_CAPLISTPTR_REG;
1452 		endoff = 72;
1453 		break;
1454 	default:
1455 		typename = NULL;
1456 		typeprintfn = 0;
1457 		capoff = -1;
1458 		endoff = 64;
1459 		break;
1460 	}
1461 	printf("  Type %d ", hdrtype);
1462 	if (typename != NULL)
1463 		printf("(%s) ", typename);
1464 	printf("header:\n");
1465 	pci_conf_print_regs(regs, 16, endoff);
1466 	printf("\n");
1467 	if (typeprintfn) {
1468 #ifdef _KERNEL
1469 		(*typeprintfn)(pc, tag, regs, sizebars);
1470 #else
1471 		(*typeprintfn)(regs);
1472 #endif
1473 	} else
1474 		printf("    Don't know how to pretty-print type %d header.\n",
1475 		    hdrtype);
1476 	printf("\n");
1477 
1478 	/* capability list, if present */
1479 	if ((regs[o2i(PCI_COMMAND_STATUS_REG)] & PCI_STATUS_CAPLIST_SUPPORT)
1480 		&& (capoff > 0)) {
1481 #ifdef _KERNEL
1482 		pci_conf_print_caplist(pc, tag, regs, capoff);
1483 #else
1484 		pci_conf_print_caplist(regs, capoff);
1485 #endif
1486 		printf("\n");
1487 	}
1488 
1489 	/* device-dependent header */
1490 	printf("  Device-dependent header:\n");
1491 	pci_conf_print_regs(regs, endoff, 256);
1492 	printf("\n");
1493 #ifdef _KERNEL
1494 	if (printfn)
1495 		(*printfn)(pc, tag, regs);
1496 	else
1497 		printf("    Don't know how to pretty-print device-dependent header.\n");
1498 	printf("\n");
1499 #endif /* _KERNEL */
1500 }
1501