pciconf.c revision 182707 
1/*
2 * Copyright 1996 Massachusetts Institute of Technology
3 *
4 * Permission to use, copy, modify, and distribute this software and
5 * its documentation for any purpose and without fee is hereby
6 * granted, provided that both the above copyright notice and this
7 * permission notice appear in all copies, that both the above
8 * copyright notice and this permission notice appear in all
9 * supporting documentation, and that the name of M.I.T. not be used
10 * in advertising or publicity pertaining to distribution of the
11 * software without specific, written prior permission.  M.I.T. makes
12 * no representations about the suitability of this software for any
13 * purpose.  It is provided "as is" without express or implied
14 * warranty.
15 *
16 * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''.  M.I.T. DISCLAIMS
17 * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
18 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
20 * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
23 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
26 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 */
29
30#ifndef lint
31static const char rcsid[] =
32  "$FreeBSD: head/usr.sbin/pciconf/pciconf.c 182707 2008-09-03 07:03:38Z imp $";
33#endif /* not lint */
34
35#include <sys/types.h>
36#include <sys/fcntl.h>
37
38#include <ctype.h>
39#include <err.h>
40#include <stdlib.h>
41#include <stdio.h>
42#include <string.h>
43#include <unistd.h>
44#include <sys/pciio.h>
45#include <sys/queue.h>
46
47#include <dev/pci/pcireg.h>
48
49#include "pathnames.h"
50#include "pciconf.h"
51
52struct pci_device_info
53{
54    TAILQ_ENTRY(pci_device_info)	link;
55    int					id;
56    char				*desc;
57};
58
59struct pci_vendor_info
60{
61    TAILQ_ENTRY(pci_vendor_info)	link;
62    TAILQ_HEAD(,pci_device_info)	devs;
63    int					id;
64    char				*desc;
65};
66
67TAILQ_HEAD(,pci_vendor_info)	pci_vendors;
68
69static void list_devs(int verbose, int caps);
70static void list_verbose(struct pci_conf *p);
71static const char *guess_class(struct pci_conf *p);
72static const char *guess_subclass(struct pci_conf *p);
73static int load_vendors(void);
74static void readit(const char *, const char *, int);
75static void writeit(const char *, const char *, const char *, int);
76static void chkattached(const char *, int);
77
78static int exitstatus = 0;
79
80static void
81usage(void)
82{
83	fprintf(stderr, "%s\n%s\n%s\n%s\n",
84		"usage: pciconf -l [-cv]",
85		"       pciconf -a selector",
86		"       pciconf -r [-b | -h] selector addr[:addr2]",
87		"       pciconf -w [-b | -h] selector addr value");
88	exit (1);
89}
90
91int
92main(int argc, char **argv)
93{
94	int c;
95	int listmode, readmode, writemode, attachedmode, caps, verbose;
96	int byte, isshort;
97
98	listmode = readmode = writemode = attachedmode = caps = verbose = byte = isshort = 0;
99
100	while ((c = getopt(argc, argv, "abchlrwv")) != -1) {
101		switch(c) {
102		case 'a':
103			attachedmode = 1;
104			break;
105
106		case 'b':
107			byte = 1;
108			break;
109
110		case 'c':
111			caps = 1;
112			break;
113
114		case 'h':
115			isshort = 1;
116			break;
117
118		case 'l':
119			listmode = 1;
120			break;
121
122		case 'r':
123			readmode = 1;
124			break;
125
126		case 'w':
127			writemode = 1;
128			break;
129
130		case 'v':
131			verbose = 1;
132			break;
133
134		default:
135			usage();
136		}
137	}
138
139	if ((listmode && optind != argc)
140	    || (writemode && optind + 3 != argc)
141	    || (readmode && optind + 2 != argc)
142	    || (attachedmode && optind + 1 != argc))
143		usage();
144
145	if (listmode) {
146		list_devs(verbose, caps);
147	} else if (attachedmode) {
148		chkattached(argv[optind],
149		       byte ? 1 : isshort ? 2 : 4);
150	} else if (readmode) {
151		readit(argv[optind], argv[optind + 1],
152		       byte ? 1 : isshort ? 2 : 4);
153	} else if (writemode) {
154		writeit(argv[optind], argv[optind + 1], argv[optind + 2],
155		       byte ? 1 : isshort ? 2 : 4);
156	} else {
157		usage();
158	}
159
160	return exitstatus;
161}
162
163static void
164list_devs(int verbose, int caps)
165{
166	int fd;
167	struct pci_conf_io pc;
168	struct pci_conf conf[255], *p;
169	int none_count = 0;
170
171	if (verbose)
172		load_vendors();
173
174	fd = open(_PATH_DEVPCI, caps ? O_RDWR : O_RDONLY, 0);
175	if (fd < 0)
176		err(1, "%s", _PATH_DEVPCI);
177
178	bzero(&pc, sizeof(struct pci_conf_io));
179	pc.match_buf_len = sizeof(conf);
180	pc.matches = conf;
181
182	do {
183		if (ioctl(fd, PCIOCGETCONF, &pc) == -1)
184			err(1, "ioctl(PCIOCGETCONF)");
185
186		/*
187		 * 255 entries should be more than enough for most people,
188		 * but if someone has more devices, and then changes things
189		 * around between ioctls, we'll do the cheezy thing and
190		 * just bail.  The alternative would be to go back to the
191		 * beginning of the list, and print things twice, which may
192		 * not be desireable.
193		 */
194		if (pc.status == PCI_GETCONF_LIST_CHANGED) {
195			warnx("PCI device list changed, please try again");
196			exitstatus = 1;
197			close(fd);
198			return;
199		} else if (pc.status ==  PCI_GETCONF_ERROR) {
200			warnx("error returned from PCIOCGETCONF ioctl");
201			exitstatus = 1;
202			close(fd);
203			return;
204		}
205		for (p = conf; p < &conf[pc.num_matches]; p++) {
206			printf("%s%d@pci%d:%d:%d:%d:\tclass=0x%06x card=0x%08x "
207			       "chip=0x%08x rev=0x%02x hdr=0x%02x\n",
208			       (p->pd_name && *p->pd_name) ? p->pd_name :
209			       "none",
210			       (p->pd_name && *p->pd_name) ? (int)p->pd_unit :
211			       none_count++, p->pc_sel.pc_domain,
212			       p->pc_sel.pc_bus, p->pc_sel.pc_dev,
213			       p->pc_sel.pc_func, (p->pc_class << 16) |
214			       (p->pc_subclass << 8) | p->pc_progif,
215			       (p->pc_subdevice << 16) | p->pc_subvendor,
216			       (p->pc_device << 16) | p->pc_vendor,
217			       p->pc_revid, p->pc_hdr);
218			if (verbose)
219				list_verbose(p);
220			if (caps)
221				list_caps(fd, p);
222		}
223	} while (pc.status == PCI_GETCONF_MORE_DEVS);
224
225	close(fd);
226}
227
228static void
229list_verbose(struct pci_conf *p)
230{
231	struct pci_vendor_info	*vi;
232	struct pci_device_info	*di;
233	const char *dp;
234
235	TAILQ_FOREACH(vi, &pci_vendors, link) {
236		if (vi->id == p->pc_vendor) {
237			printf("    vendor     = '%s'\n", vi->desc);
238			break;
239		}
240	}
241	if (vi == NULL) {
242		di = NULL;
243	} else {
244		TAILQ_FOREACH(di, &vi->devs, link) {
245			if (di->id == p->pc_device) {
246				printf("    device     = '%s'\n", di->desc);
247				break;
248			}
249		}
250	}
251	if ((dp = guess_class(p)) != NULL)
252		printf("    class      = %s\n", dp);
253	if ((dp = guess_subclass(p)) != NULL)
254		printf("    subclass   = %s\n", dp);
255}
256
257/*
258 * This is a direct cut-and-paste from the table in sys/dev/pci/pci.c.
259 */
260static struct
261{
262	int	class;
263	int	subclass;
264	const char *desc;
265} pci_nomatch_tab[] = {
266	{PCIC_OLD,		-1,			"old"},
267	{PCIC_OLD,		PCIS_OLD_NONVGA,	"non-VGA display device"},
268	{PCIC_OLD,		PCIS_OLD_VGA,		"VGA-compatible display device"},
269	{PCIC_STORAGE,		-1,			"mass storage"},
270	{PCIC_STORAGE,		PCIS_STORAGE_SCSI,	"SCSI"},
271	{PCIC_STORAGE,		PCIS_STORAGE_IDE,	"ATA"},
272	{PCIC_STORAGE,		PCIS_STORAGE_FLOPPY,	"floppy disk"},
273	{PCIC_STORAGE,		PCIS_STORAGE_IPI,	"IPI"},
274	{PCIC_STORAGE,		PCIS_STORAGE_RAID,	"RAID"},
275	{PCIC_NETWORK,		-1,			"network"},
276	{PCIC_NETWORK,		PCIS_NETWORK_ETHERNET,	"ethernet"},
277	{PCIC_NETWORK,		PCIS_NETWORK_TOKENRING,	"token ring"},
278	{PCIC_NETWORK,		PCIS_NETWORK_FDDI,	"fddi"},
279	{PCIC_NETWORK,		PCIS_NETWORK_ATM,	"ATM"},
280	{PCIC_NETWORK,		PCIS_NETWORK_ISDN,	"ISDN"},
281	{PCIC_DISPLAY,		-1,			"display"},
282	{PCIC_DISPLAY,		PCIS_DISPLAY_VGA,	"VGA"},
283	{PCIC_DISPLAY,		PCIS_DISPLAY_XGA,	"XGA"},
284	{PCIC_DISPLAY,		PCIS_DISPLAY_3D,	"3D"},
285	{PCIC_MULTIMEDIA,	-1,			"multimedia"},
286	{PCIC_MULTIMEDIA,	PCIS_MULTIMEDIA_VIDEO,	"video"},
287	{PCIC_MULTIMEDIA,	PCIS_MULTIMEDIA_AUDIO,	"audio"},
288	{PCIC_MULTIMEDIA,	PCIS_MULTIMEDIA_TELE,	"telephony"},
289	{PCIC_MEMORY,		-1,			"memory"},
290	{PCIC_MEMORY,		PCIS_MEMORY_RAM,	"RAM"},
291	{PCIC_MEMORY,		PCIS_MEMORY_FLASH,	"flash"},
292	{PCIC_BRIDGE,		-1,			"bridge"},
293	{PCIC_BRIDGE,		PCIS_BRIDGE_HOST,	"HOST-PCI"},
294	{PCIC_BRIDGE,		PCIS_BRIDGE_ISA,	"PCI-ISA"},
295	{PCIC_BRIDGE,		PCIS_BRIDGE_EISA,	"PCI-EISA"},
296	{PCIC_BRIDGE,		PCIS_BRIDGE_MCA,	"PCI-MCA"},
297	{PCIC_BRIDGE,		PCIS_BRIDGE_PCI,	"PCI-PCI"},
298	{PCIC_BRIDGE,		PCIS_BRIDGE_PCMCIA,	"PCI-PCMCIA"},
299	{PCIC_BRIDGE,		PCIS_BRIDGE_NUBUS,	"PCI-NuBus"},
300	{PCIC_BRIDGE,		PCIS_BRIDGE_CARDBUS,	"PCI-CardBus"},
301	{PCIC_BRIDGE,		PCIS_BRIDGE_RACEWAY,	"PCI-RACEway"},
302	{PCIC_SIMPLECOMM,	-1,			"simple comms"},
303	{PCIC_SIMPLECOMM,	PCIS_SIMPLECOMM_UART,	"UART"},	/* could detect 16550 */
304	{PCIC_SIMPLECOMM,	PCIS_SIMPLECOMM_PAR,	"parallel port"},
305	{PCIC_SIMPLECOMM,	PCIS_SIMPLECOMM_MULSER,	"multiport serial"},
306	{PCIC_SIMPLECOMM,	PCIS_SIMPLECOMM_MODEM,	"generic modem"},
307	{PCIC_BASEPERIPH,	-1,			"base peripheral"},
308	{PCIC_BASEPERIPH,	PCIS_BASEPERIPH_PIC,	"interrupt controller"},
309	{PCIC_BASEPERIPH,	PCIS_BASEPERIPH_DMA,	"DMA controller"},
310	{PCIC_BASEPERIPH,	PCIS_BASEPERIPH_TIMER,	"timer"},
311	{PCIC_BASEPERIPH,	PCIS_BASEPERIPH_RTC,	"realtime clock"},
312	{PCIC_BASEPERIPH,	PCIS_BASEPERIPH_PCIHOT,	"PCI hot-plug controller"},
313	{PCIC_INPUTDEV,		-1,			"input device"},
314	{PCIC_INPUTDEV,		PCIS_INPUTDEV_KEYBOARD,	"keyboard"},
315	{PCIC_INPUTDEV,		PCIS_INPUTDEV_DIGITIZER,"digitizer"},
316	{PCIC_INPUTDEV,		PCIS_INPUTDEV_MOUSE,	"mouse"},
317	{PCIC_INPUTDEV,		PCIS_INPUTDEV_SCANNER,	"scanner"},
318	{PCIC_INPUTDEV,		PCIS_INPUTDEV_GAMEPORT,	"gameport"},
319	{PCIC_DOCKING,		-1,			"docking station"},
320	{PCIC_PROCESSOR,	-1,			"processor"},
321	{PCIC_SERIALBUS,	-1,			"serial bus"},
322	{PCIC_SERIALBUS,	PCIS_SERIALBUS_FW,	"FireWire"},
323	{PCIC_SERIALBUS,	PCIS_SERIALBUS_ACCESS,	"AccessBus"},
324	{PCIC_SERIALBUS,	PCIS_SERIALBUS_SSA,	"SSA"},
325	{PCIC_SERIALBUS,	PCIS_SERIALBUS_USB,	"USB"},
326	{PCIC_SERIALBUS,	PCIS_SERIALBUS_FC,	"Fibre Channel"},
327	{PCIC_SERIALBUS,	PCIS_SERIALBUS_SMBUS,	"SMBus"},
328	{PCIC_WIRELESS,		-1,			"wireless controller"},
329	{PCIC_WIRELESS,		PCIS_WIRELESS_IRDA,	"iRDA"},
330	{PCIC_WIRELESS,		PCIS_WIRELESS_IR,	"IR"},
331	{PCIC_WIRELESS,		PCIS_WIRELESS_RF,	"RF"},
332	{PCIC_INTELLIIO,	-1,			"intelligent I/O controller"},
333	{PCIC_INTELLIIO,	PCIS_INTELLIIO_I2O,	"I2O"},
334	{PCIC_SATCOM,		-1,			"satellite communication"},
335	{PCIC_SATCOM,		PCIS_SATCOM_TV,		"sat TV"},
336	{PCIC_SATCOM,		PCIS_SATCOM_AUDIO,	"sat audio"},
337	{PCIC_SATCOM,		PCIS_SATCOM_VOICE,	"sat voice"},
338	{PCIC_SATCOM,		PCIS_SATCOM_DATA,	"sat data"},
339	{PCIC_CRYPTO,		-1,			"encrypt/decrypt"},
340	{PCIC_CRYPTO,		PCIS_CRYPTO_NETCOMP,	"network/computer crypto"},
341	{PCIC_CRYPTO,		PCIS_CRYPTO_NETCOMP,	"entertainment crypto"},
342	{PCIC_DASP,		-1,			"dasp"},
343	{PCIC_DASP,		PCIS_DASP_DPIO,		"DPIO module"},
344	{0, 0,		NULL}
345};
346
347static const char *
348guess_class(struct pci_conf *p)
349{
350	int	i;
351
352	for (i = 0; pci_nomatch_tab[i].desc != NULL; i++) {
353		if (pci_nomatch_tab[i].class == p->pc_class)
354			return(pci_nomatch_tab[i].desc);
355	}
356	return(NULL);
357}
358
359static const char *
360guess_subclass(struct pci_conf *p)
361{
362	int	i;
363
364	for (i = 0; pci_nomatch_tab[i].desc != NULL; i++) {
365		if ((pci_nomatch_tab[i].class == p->pc_class) &&
366		    (pci_nomatch_tab[i].subclass == p->pc_subclass))
367			return(pci_nomatch_tab[i].desc);
368	}
369	return(NULL);
370}
371
372static int
373load_vendors(void)
374{
375	const char *dbf;
376	FILE *db;
377	struct pci_vendor_info *cv;
378	struct pci_device_info *cd;
379	char buf[1024], str[1024];
380	char *ch;
381	int id, error;
382
383	/*
384	 * Locate the database and initialise.
385	 */
386	TAILQ_INIT(&pci_vendors);
387	if ((dbf = getenv("PCICONF_VENDOR_DATABASE")) == NULL)
388		dbf = _PATH_PCIVDB;
389	if ((db = fopen(dbf, "r")) == NULL)
390		return(1);
391	cv = NULL;
392	cd = NULL;
393	error = 0;
394
395	/*
396	 * Scan input lines from the database
397	 */
398	for (;;) {
399		if (fgets(buf, sizeof(buf), db) == NULL)
400			break;
401
402		if ((ch = strchr(buf, '#')) != NULL)
403			*ch = '\0';
404		ch = strchr(buf, '\0') - 1;
405		while (ch > buf && isspace(*ch))
406			*ch-- = '\0';
407		if (ch <= buf)
408			continue;
409
410		/* Can't handle subvendor / subdevice entries yet */
411		if (buf[0] == '\t' && buf[1] == '\t')
412			continue;
413
414		/* Check for vendor entry */
415		if (buf[0] != '\t' && sscanf(buf, "%04x %[^\n]", &id, str) == 2) {
416			if ((id == 0) || (strlen(str) < 1))
417				continue;
418			if ((cv = malloc(sizeof(struct pci_vendor_info))) == NULL) {
419				warn("allocating vendor entry");
420				error = 1;
421				break;
422			}
423			if ((cv->desc = strdup(str)) == NULL) {
424				free(cv);
425				warn("allocating vendor description");
426				error = 1;
427				break;
428			}
429			cv->id = id;
430			TAILQ_INIT(&cv->devs);
431			TAILQ_INSERT_TAIL(&pci_vendors, cv, link);
432			continue;
433		}
434
435		/* Check for device entry */
436		if (buf[0] == '\t' && sscanf(buf + 1, "%04x %[^\n]", &id, str) == 2) {
437			if ((id == 0) || (strlen(str) < 1))
438				continue;
439			if (cv == NULL) {
440				warnx("device entry with no vendor!");
441				continue;
442			}
443			if ((cd = malloc(sizeof(struct pci_device_info))) == NULL) {
444				warn("allocating device entry");
445				error = 1;
446				break;
447			}
448			if ((cd->desc = strdup(str)) == NULL) {
449				free(cd);
450				warn("allocating device description");
451				error = 1;
452				break;
453			}
454			cd->id = id;
455			TAILQ_INSERT_TAIL(&cv->devs, cd, link);
456			continue;
457		}
458
459		/* It's a comment or junk, ignore it */
460	}
461	if (ferror(db))
462		error = 1;
463	fclose(db);
464
465	return(error);
466}
467
468uint32_t
469read_config(int fd, struct pcisel *sel, long reg, int width)
470{
471	struct pci_io pi;
472
473	pi.pi_sel = *sel;
474	pi.pi_reg = reg;
475	pi.pi_width = width;
476
477	if (ioctl(fd, PCIOCREAD, &pi) < 0)
478		err(1, "ioctl(PCIOCREAD)");
479
480	return (pi.pi_data);
481}
482
483static struct pcisel
484getsel(const char *str)
485{
486	char *ep = strchr(str, '@');
487	char *epbase;
488	struct pcisel sel;
489	unsigned long selarr[4];
490	int i;
491
492	if (ep == NULL)
493		ep = (char *)str;
494	else
495		ep++;
496
497	epbase = ep;
498
499	if (strncmp(ep, "pci", 3) == 0) {
500		ep += 3;
501		i = 0;
502		do {
503			selarr[i++] = strtoul(ep, &ep, 10);
504		} while ((*ep == ':' || *ep == '.') && *++ep != '\0' && i < 4);
505
506		if (i > 2)
507			sel.pc_func = selarr[--i];
508		else
509			sel.pc_func = 0;
510		sel.pc_dev = selarr[--i];
511		sel.pc_bus = selarr[--i];
512		if (i > 0)
513			sel.pc_domain = selarr[--i];
514		else
515			sel.pc_domain = 0;
516	}
517	if (*ep != '\x0' || ep == epbase)
518		errx(1, "cannot parse selector %s", str);
519	return sel;
520}
521
522static void
523readone(int fd, struct pcisel *sel, long reg, int width)
524{
525
526	printf("%0*x", width*2, read_config(fd, sel, reg, width));
527}
528
529static void
530readit(const char *name, const char *reg, int width)
531{
532	long rstart;
533	long rend;
534	long r;
535	char *end;
536	int i;
537	int fd;
538	struct pcisel sel;
539
540	fd = open(_PATH_DEVPCI, O_RDWR, 0);
541	if (fd < 0)
542		err(1, "%s", _PATH_DEVPCI);
543
544	rend = rstart = strtol(reg, &end, 0);
545	if (end && *end == ':') {
546		end++;
547		rend = strtol(end, (char **) 0, 0);
548	}
549	sel = getsel(name);
550	for (i = 1, r = rstart; r <= rend; i++, r += width) {
551		readone(fd, &sel, r, width);
552		if (i && !(i % 8)) putchar(' ');
553		putchar(i % (16/width) ? ' ' : '\n');
554	}
555	if (i % (16/width) != 1)
556		putchar('\n');
557	close(fd);
558}
559
560static void
561writeit(const char *name, const char *reg, const char *data, int width)
562{
563	int fd;
564	struct pci_io pi;
565
566	pi.pi_sel = getsel(name);
567	pi.pi_reg = strtoul(reg, (char **)0, 0); /* XXX error check */
568	pi.pi_width = width;
569	pi.pi_data = strtoul(data, (char **)0, 0); /* XXX error check */
570
571	fd = open(_PATH_DEVPCI, O_RDWR, 0);
572	if (fd < 0)
573		err(1, "%s", _PATH_DEVPCI);
574
575	if (ioctl(fd, PCIOCWRITE, &pi) < 0)
576		err(1, "ioctl(PCIOCWRITE)");
577}
578
579static void
580chkattached(const char *name, int width)
581{
582	int fd;
583	struct pci_io pi;
584
585	pi.pi_sel = getsel(name);
586	pi.pi_reg = 0;
587	pi.pi_width = width;
588	pi.pi_data = 0;
589
590	fd = open(_PATH_DEVPCI, O_RDWR, 0);
591	if (fd < 0)
592		err(1, "%s", _PATH_DEVPCI);
593
594	if (ioctl(fd, PCIOCATTACHED, &pi) < 0)
595		err(1, "ioctl(PCIOCATTACHED)");
596
597	exitstatus = pi.pi_data ? 0 : 2; /* exit(2), if NOT attached */
598	printf("%s: %s%s\n", name, pi.pi_data == 0 ? "not " : "", "attached");
599}
600