pciconf.c revision 166435 
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 166435 2007-02-02 19:54:17Z jhb $";
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, "aclrwbhv")) != -1) {
101		switch(c) {
102		case 'a':
103			attachedmode = 1;
104			break;
105
106		case 'c':
107			caps = 1;
108			break;
109
110		case 'l':
111			listmode = 1;
112			break;
113
114		case 'r':
115			readmode = 1;
116			break;
117
118		case 'w':
119			writemode = 1;
120			break;
121
122		case 'b':
123			byte = 1;
124			break;
125
126		case 'h':
127			isshort = 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
207			printf("%s%d@pci%d:%d:%d:\tclass=0x%06x card=0x%08x "
208			       "chip=0x%08x rev=0x%02x hdr=0x%02x\n",
209			       (p->pd_name && *p->pd_name) ? p->pd_name :
210			       "none",
211			       (p->pd_name && *p->pd_name) ? (int)p->pd_unit :
212			       none_count++,
213			       p->pc_sel.pc_bus, p->pc_sel.pc_dev,
214			       p->pc_sel.pc_func, (p->pc_class << 16) |
215			       (p->pc_subclass << 8) | p->pc_progif,
216			       (p->pc_subdevice << 16) | p->pc_subvendor,
217			       (p->pc_device << 16) | p->pc_vendor,
218			       p->pc_revid, p->pc_hdr);
219			if (verbose)
220				list_verbose(p);
221			if (caps)
222				list_caps(fd, p);
223		}
224	} while (pc.status == PCI_GETCONF_MORE_DEVS);
225
226	close(fd);
227}
228
229static void
230list_verbose(struct pci_conf *p)
231{
232	struct pci_vendor_info	*vi;
233	struct pci_device_info	*di;
234	const char *dp;
235
236	TAILQ_FOREACH(vi, &pci_vendors, link) {
237		if (vi->id == p->pc_vendor) {
238			printf("    vendor     = '%s'\n", vi->desc);
239			break;
240		}
241	}
242	if (vi == NULL) {
243		di = NULL;
244	} else {
245		TAILQ_FOREACH(di, &vi->devs, link) {
246			if (di->id == p->pc_device) {
247				printf("    device     = '%s'\n", di->desc);
248				break;
249			}
250		}
251	}
252	if ((dp = guess_class(p)) != NULL)
253		printf("    class      = %s\n", dp);
254	if ((dp = guess_subclass(p)) != NULL)
255		printf("    subclass   = %s\n", dp);
256}
257
258/*
259 * This is a direct cut-and-paste from the table in sys/dev/pci/pci.c.
260 */
261static struct
262{
263	int	class;
264	int	subclass;
265	const char *desc;
266} pci_nomatch_tab[] = {
267	{PCIC_OLD,		-1,			"old"},
268	{PCIC_OLD,		PCIS_OLD_NONVGA,	"non-VGA display device"},
269	{PCIC_OLD,		PCIS_OLD_VGA,		"VGA-compatible display device"},
270	{PCIC_STORAGE,		-1,			"mass storage"},
271	{PCIC_STORAGE,		PCIS_STORAGE_SCSI,	"SCSI"},
272	{PCIC_STORAGE,		PCIS_STORAGE_IDE,	"ATA"},
273	{PCIC_STORAGE,		PCIS_STORAGE_FLOPPY,	"floppy disk"},
274	{PCIC_STORAGE,		PCIS_STORAGE_IPI,	"IPI"},
275	{PCIC_STORAGE,		PCIS_STORAGE_RAID,	"RAID"},
276	{PCIC_NETWORK,		-1,			"network"},
277	{PCIC_NETWORK,		PCIS_NETWORK_ETHERNET,	"ethernet"},
278	{PCIC_NETWORK,		PCIS_NETWORK_TOKENRING,	"token ring"},
279	{PCIC_NETWORK,		PCIS_NETWORK_FDDI,	"fddi"},
280	{PCIC_NETWORK,		PCIS_NETWORK_ATM,	"ATM"},
281	{PCIC_NETWORK,		PCIS_NETWORK_ISDN,	"ISDN"},
282	{PCIC_DISPLAY,		-1,			"display"},
283	{PCIC_DISPLAY,		PCIS_DISPLAY_VGA,	"VGA"},
284	{PCIC_DISPLAY,		PCIS_DISPLAY_XGA,	"XGA"},
285	{PCIC_DISPLAY,		PCIS_DISPLAY_3D,	"3D"},
286	{PCIC_MULTIMEDIA,	-1,			"multimedia"},
287	{PCIC_MULTIMEDIA,	PCIS_MULTIMEDIA_VIDEO,	"video"},
288	{PCIC_MULTIMEDIA,	PCIS_MULTIMEDIA_AUDIO,	"audio"},
289	{PCIC_MULTIMEDIA,	PCIS_MULTIMEDIA_TELE,	"telephony"},
290	{PCIC_MEMORY,		-1,			"memory"},
291	{PCIC_MEMORY,		PCIS_MEMORY_RAM,	"RAM"},
292	{PCIC_MEMORY,		PCIS_MEMORY_FLASH,	"flash"},
293	{PCIC_BRIDGE,		-1,			"bridge"},
294	{PCIC_BRIDGE,		PCIS_BRIDGE_HOST,	"HOST-PCI"},
295	{PCIC_BRIDGE,		PCIS_BRIDGE_ISA,	"PCI-ISA"},
296	{PCIC_BRIDGE,		PCIS_BRIDGE_EISA,	"PCI-EISA"},
297	{PCIC_BRIDGE,		PCIS_BRIDGE_MCA,	"PCI-MCA"},
298	{PCIC_BRIDGE,		PCIS_BRIDGE_PCI,	"PCI-PCI"},
299	{PCIC_BRIDGE,		PCIS_BRIDGE_PCMCIA,	"PCI-PCMCIA"},
300	{PCIC_BRIDGE,		PCIS_BRIDGE_NUBUS,	"PCI-NuBus"},
301	{PCIC_BRIDGE,		PCIS_BRIDGE_CARDBUS,	"PCI-CardBus"},
302	{PCIC_BRIDGE,		PCIS_BRIDGE_RACEWAY,	"PCI-RACEway"},
303	{PCIC_SIMPLECOMM,	-1,			"simple comms"},
304	{PCIC_SIMPLECOMM,	PCIS_SIMPLECOMM_UART,	"UART"},	/* could detect 16550 */
305	{PCIC_SIMPLECOMM,	PCIS_SIMPLECOMM_PAR,	"parallel port"},
306	{PCIC_SIMPLECOMM,	PCIS_SIMPLECOMM_MULSER,	"multiport serial"},
307	{PCIC_SIMPLECOMM,	PCIS_SIMPLECOMM_MODEM,	"generic modem"},
308	{PCIC_BASEPERIPH,	-1,			"base peripheral"},
309	{PCIC_BASEPERIPH,	PCIS_BASEPERIPH_PIC,	"interrupt controller"},
310	{PCIC_BASEPERIPH,	PCIS_BASEPERIPH_DMA,	"DMA controller"},
311	{PCIC_BASEPERIPH,	PCIS_BASEPERIPH_TIMER,	"timer"},
312	{PCIC_BASEPERIPH,	PCIS_BASEPERIPH_RTC,	"realtime clock"},
313	{PCIC_BASEPERIPH,	PCIS_BASEPERIPH_PCIHOT,	"PCI hot-plug controller"},
314	{PCIC_INPUTDEV,		-1,			"input device"},
315	{PCIC_INPUTDEV,		PCIS_INPUTDEV_KEYBOARD,	"keyboard"},
316	{PCIC_INPUTDEV,		PCIS_INPUTDEV_DIGITIZER,"digitizer"},
317	{PCIC_INPUTDEV,		PCIS_INPUTDEV_MOUSE,	"mouse"},
318	{PCIC_INPUTDEV,		PCIS_INPUTDEV_SCANNER,	"scanner"},
319	{PCIC_INPUTDEV,		PCIS_INPUTDEV_GAMEPORT,	"gameport"},
320	{PCIC_DOCKING,		-1,			"docking station"},
321	{PCIC_PROCESSOR,	-1,			"processor"},
322	{PCIC_SERIALBUS,	-1,			"serial bus"},
323	{PCIC_SERIALBUS,	PCIS_SERIALBUS_FW,	"FireWire"},
324	{PCIC_SERIALBUS,	PCIS_SERIALBUS_ACCESS,	"AccessBus"},
325	{PCIC_SERIALBUS,	PCIS_SERIALBUS_SSA,	"SSA"},
326	{PCIC_SERIALBUS,	PCIS_SERIALBUS_USB,	"USB"},
327	{PCIC_SERIALBUS,	PCIS_SERIALBUS_FC,	"Fibre Channel"},
328	{PCIC_SERIALBUS,	PCIS_SERIALBUS_SMBUS,	"SMBus"},
329	{PCIC_WIRELESS,		-1,			"wireless controller"},
330	{PCIC_WIRELESS,		PCIS_WIRELESS_IRDA,	"iRDA"},
331	{PCIC_WIRELESS,		PCIS_WIRELESS_IR,	"IR"},
332	{PCIC_WIRELESS,		PCIS_WIRELESS_RF,	"RF"},
333	{PCIC_INTELLIIO,	-1,			"intelligent I/O controller"},
334	{PCIC_INTELLIIO,	PCIS_INTELLIIO_I2O,	"I2O"},
335	{PCIC_SATCOM,		-1,			"satellite communication"},
336	{PCIC_SATCOM,		PCIS_SATCOM_TV,		"sat TV"},
337	{PCIC_SATCOM,		PCIS_SATCOM_AUDIO,	"sat audio"},
338	{PCIC_SATCOM,		PCIS_SATCOM_VOICE,	"sat voice"},
339	{PCIC_SATCOM,		PCIS_SATCOM_DATA,	"sat data"},
340	{PCIC_CRYPTO,		-1,			"encrypt/decrypt"},
341	{PCIC_CRYPTO,		PCIS_CRYPTO_NETCOMP,	"network/computer crypto"},
342	{PCIC_CRYPTO,		PCIS_CRYPTO_NETCOMP,	"entertainment crypto"},
343	{PCIC_DASP,		-1,			"dasp"},
344	{PCIC_DASP,		PCIS_DASP_DPIO,		"DPIO module"},
345	{0, 0,		NULL}
346};
347
348static const char *
349guess_class(struct pci_conf *p)
350{
351	int	i;
352
353	for (i = 0; pci_nomatch_tab[i].desc != NULL; i++) {
354		if (pci_nomatch_tab[i].class == p->pc_class)
355			return(pci_nomatch_tab[i].desc);
356	}
357	return(NULL);
358}
359
360static const char *
361guess_subclass(struct pci_conf *p)
362{
363	int	i;
364
365	for (i = 0; pci_nomatch_tab[i].desc != NULL; i++) {
366		if ((pci_nomatch_tab[i].class == p->pc_class) &&
367		    (pci_nomatch_tab[i].subclass == p->pc_subclass))
368			return(pci_nomatch_tab[i].desc);
369	}
370	return(NULL);
371}
372
373static int
374load_vendors(void)
375{
376	const char *dbf;
377	FILE *db;
378	struct pci_vendor_info *cv;
379	struct pci_device_info *cd;
380	char buf[1024], str[1024];
381	char *ch;
382	int id, error;
383
384	/*
385	 * Locate the database and initialise.
386	 */
387	TAILQ_INIT(&pci_vendors);
388	if ((dbf = getenv("PCICONF_VENDOR_DATABASE")) == NULL)
389		dbf = _PATH_PCIVDB;
390	if ((db = fopen(dbf, "r")) == NULL)
391		return(1);
392	cv = NULL;
393	cd = NULL;
394	error = 0;
395
396	/*
397	 * Scan input lines from the database
398	 */
399	for (;;) {
400		if (fgets(buf, sizeof(buf), db) == NULL)
401			break;
402
403		if ((ch = strchr(buf, '#')) != NULL)
404			*ch = '\0';
405		ch = strchr(buf, '\0') - 1;
406		while (ch > buf && isspace(*ch))
407			*ch-- = '\0';
408		if (ch <= buf)
409			continue;
410
411		/* Can't handle subvendor / subdevice entries yet */
412		if (buf[0] == '\t' && buf[1] == '\t')
413			continue;
414
415		/* Check for vendor entry */
416		if (buf[0] != '\t' && sscanf(buf, "%04x %[^\n]", &id, str) == 2) {
417			if ((id == 0) || (strlen(str) < 1))
418				continue;
419			if ((cv = malloc(sizeof(struct pci_vendor_info))) == NULL) {
420				warn("allocating vendor entry");
421				error = 1;
422				break;
423			}
424			if ((cv->desc = strdup(str)) == NULL) {
425				free(cv);
426				warn("allocating vendor description");
427				error = 1;
428				break;
429			}
430			cv->id = id;
431			TAILQ_INIT(&cv->devs);
432			TAILQ_INSERT_TAIL(&pci_vendors, cv, link);
433			continue;
434		}
435
436		/* Check for device entry */
437		if (buf[0] == '\t' && sscanf(buf + 1, "%04x %[^\n]", &id, str) == 2) {
438			if ((id == 0) || (strlen(str) < 1))
439				continue;
440			if (cv == NULL) {
441				warnx("device entry with no vendor!");
442				continue;
443			}
444			if ((cd = malloc(sizeof(struct pci_device_info))) == NULL) {
445				warn("allocating device entry");
446				error = 1;
447				break;
448			}
449			if ((cd->desc = strdup(str)) == NULL) {
450				free(cd);
451				warn("allocating device description");
452				error = 1;
453				break;
454			}
455			cd->id = id;
456			TAILQ_INSERT_TAIL(&cv->devs, cd, link);
457			continue;
458		}
459
460		/* It's a comment or junk, ignore it */
461	}
462	if (ferror(db))
463		error = 1;
464	fclose(db);
465
466	return(error);
467}
468
469uint32_t
470read_config(int fd, struct pcisel *sel, long reg, int width)
471{
472	struct pci_io pi;
473
474	pi.pi_sel = *sel;
475	pi.pi_reg = reg;
476	pi.pi_width = width;
477
478	if (ioctl(fd, PCIOCREAD, &pi) < 0)
479		err(1, "ioctl(PCIOCREAD)");
480
481	return (pi.pi_data);
482}
483
484static struct pcisel
485getsel(const char *str)
486{
487	char *ep = strchr(str, '@');
488	char *epbase;
489	struct pcisel sel;
490
491	if (ep == NULL)
492		ep = (char *)str;
493	else
494		ep++;
495
496	epbase = ep;
497
498	if (strncmp(ep, "pci", 3) == 0) {
499		ep += 3;
500		sel.pc_bus = strtoul(ep, &ep, 0);
501		if (!ep || *ep++ != ':')
502			errx(1, "cannot parse selector %s", str);
503		sel.pc_dev = strtoul(ep, &ep, 0);
504		if (!ep || *ep != ':') {
505			sel.pc_func = 0;
506		} else {
507			ep++;
508			sel.pc_func = strtoul(ep, &ep, 0);
509		}
510		if (*ep == ':')
511			ep++;
512	}
513	if (*ep != '\x0' || ep == epbase)
514		errx(1, "cannot parse selector %s", str);
515	return sel;
516}
517
518static void
519readone(int fd, struct pcisel *sel, long reg, int width)
520{
521
522	printf("%0*x", width*2, read_config(fd, sel, reg, width));
523}
524
525static void
526readit(const char *name, const char *reg, int width)
527{
528	long rstart;
529	long rend;
530	long r;
531	char *end;
532	int i;
533	int fd;
534	struct pcisel sel;
535
536	fd = open(_PATH_DEVPCI, O_RDWR, 0);
537	if (fd < 0)
538		err(1, "%s", _PATH_DEVPCI);
539
540	rend = rstart = strtol(reg, &end, 0);
541	if (end && *end == ':') {
542		end++;
543		rend = strtol(end, (char **) 0, 0);
544	}
545	sel = getsel(name);
546	for (i = 1, r = rstart; r <= rend; i++, r += width) {
547		readone(fd, &sel, r, width);
548		if (i && !(i % 8)) putchar(' ');
549		putchar(i % (16/width) ? ' ' : '\n');
550	}
551	if (i % (16/width) != 1)
552		putchar('\n');
553	close(fd);
554}
555
556static void
557writeit(const char *name, const char *reg, const char *data, int width)
558{
559	int fd;
560	struct pci_io pi;
561
562	pi.pi_sel = getsel(name);
563	pi.pi_reg = strtoul(reg, (char **)0, 0); /* XXX error check */
564	pi.pi_width = width;
565	pi.pi_data = strtoul(data, (char **)0, 0); /* XXX error check */
566
567	fd = open(_PATH_DEVPCI, O_RDWR, 0);
568	if (fd < 0)
569		err(1, "%s", _PATH_DEVPCI);
570
571	if (ioctl(fd, PCIOCWRITE, &pi) < 0)
572		err(1, "ioctl(PCIOCWRITE)");
573}
574
575static void
576chkattached(const char *name, int width)
577{
578	int fd;
579	struct pci_io pi;
580
581	pi.pi_sel = getsel(name);
582	pi.pi_reg = 0;
583	pi.pi_width = width;
584	pi.pi_data = 0;
585
586	fd = open(_PATH_DEVPCI, O_RDWR, 0);
587	if (fd < 0)
588		err(1, "%s", _PATH_DEVPCI);
589
590	if (ioctl(fd, PCIOCATTACHED, &pi) < 0)
591		err(1, "ioctl(PCIOCATTACHED)");
592
593	exitstatus = pi.pi_data ? 0 : 2; /* exit(2), if NOT attached */
594	printf("%s: %s%s\n", name, pi.pi_data == 0 ? "not " : "", "attached");
595}
596