xref: /freebsd/usr.bin/usbhidctl/usbhid.c (revision d3974088)
1 /*	$NetBSD: usbhid.c,v 1.14 2000/07/03 02:51:37 matt Exp $	*/
2 /*	$FreeBSD$ */
3 
4 /*
5  * Copyright (c) 1998 The NetBSD Foundation, Inc.
6  * All rights reserved.
7  *
8  * This code is derived from software contributed to The NetBSD Foundation
9  * by Lennart Augustsson (augustss@netbsd.org).
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions and the following disclaimer.
16  * 2. Redistributions in binary form must reproduce the above copyright
17  *    notice, this list of conditions and the following disclaimer in the
18  *    documentation and/or other materials provided with the distribution.
19  * 3. All advertising materials mentioning features or use of this software
20  *    must display the following acknowledgement:
21  *        This product includes software developed by the NetBSD
22  *        Foundation, Inc. and its contributors.
23  * 4. Neither the name of The NetBSD Foundation nor the names of its
24  *    contributors may be used to endorse or promote products derived
25  *    from this software without specific prior written permission.
26  *
27  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37  * POSSIBILITY OF SUCH DAMAGE.
38  */
39 
40 #include <stdio.h>
41 #include <stdlib.h>
42 #include <string.h>
43 #include <sys/types.h>
44 #include <fcntl.h>
45 #include <sys/ioctl.h>
46 #include <unistd.h>
47 #include <err.h>
48 #include <ctype.h>
49 #include <errno.h>
50 #include <libusbhid.h>
51 #include <dev/usb/usb.h>
52 #include <dev/usb/usbhid.h>
53 
54 int verbose = 0;
55 int all = 0;
56 int noname = 0;
57 
58 char **names;
59 int nnames;
60 
61 void prbits(int bits, char **strs, int n);
62 void usage(void);
63 void dumpitem(const char *label, struct hid_item *h);
64 void dumpitems(report_desc_t r);
65 void rev(struct hid_item **p);
66 void prdata(u_char *buf, struct hid_item *h);
67 void dumpdata(int f, report_desc_t r, int loop);
68 int gotname(char *n);
69 
70 int
71 gotname(char *n)
72 {
73 	int i;
74 
75 	for (i = 0; i < nnames; i++)
76 		if (strcmp(names[i], n) == 0)
77 			return 1;
78 	return 0;
79 }
80 
81 void
82 prbits(int bits, char **strs, int n)
83 {
84 	int i;
85 
86 	for(i = 0; i < n; i++, bits >>= 1)
87 		if (strs[i*2])
88 			printf("%s%s", i == 0 ? "" : ", ", strs[i*2 + (bits&1)]);
89 }
90 
91 void
92 usage(void)
93 {
94 	extern char *__progname;
95 
96 	fprintf(stderr, "usage: %s -f device [-l] [-n] [-r] [-t tablefile] [-v] name ...\n", __progname);
97 	fprintf(stderr, "       %s -f device [-l] [-n] [-r] [-t tablefile] [-v] -a\n", __progname);
98 	exit(1);
99 }
100 
101 void
102 dumpitem(const char *label, struct hid_item *h)
103 {
104 	if ((h->flags & HIO_CONST) && !verbose)
105 		return;
106 	printf("%s size=%d count=%d page=%s usage=%s%s", label,
107 	       h->report_size, h->report_count,
108 	       hid_usage_page(HID_PAGE(h->usage)),
109 	       hid_usage_in_page(h->usage),
110 	       h->flags & HIO_CONST ? " Const" : "");
111 	printf(", logical range %d..%d",
112 	       h->logical_minimum, h->logical_maximum);
113 	if (h->physical_minimum != h->physical_maximum)
114 		printf(", physical range %d..%d",
115 		       h->physical_minimum, h->physical_maximum);
116 	if (h->unit)
117 		printf(", unit=0x%02x exp=%d", h->unit, h->unit_exponent);
118 	printf("\n");
119 }
120 
121 void
122 dumpitems(report_desc_t r)
123 {
124 	struct hid_data *d;
125 	struct hid_item h;
126 	int size;
127 
128 	for (d = hid_start_parse(r, ~0); hid_get_item(d, &h); ) {
129 		switch (h.kind) {
130 		case hid_collection:
131 			printf("Collection page=%s usage=%s\n",
132 			       hid_usage_page(HID_PAGE(h.usage)),
133 			       hid_usage_in_page(h.usage));
134 			break;
135 		case hid_endcollection:
136 			printf("End collection\n");
137 			break;
138 		case hid_input:
139 			dumpitem("Input  ", &h);
140 			break;
141 		case hid_output:
142 			dumpitem("Output ", &h);
143 			break;
144 		case hid_feature:
145 			dumpitem("Feature", &h);
146 			break;
147 		}
148 	}
149 	hid_end_parse(d);
150 	size = hid_report_size(r, 0, hid_input);
151 	printf("Total   input size %d bytes\n", size);
152 
153 	size = hid_report_size(r, 0, hid_output);
154 	printf("Total  output size %d bytes\n", size);
155 
156 	size = hid_report_size(r, 0, hid_feature);
157 	printf("Total feature size %d bytes\n", size);
158 }
159 
160 void
161 rev(struct hid_item **p)
162 {
163 	struct hid_item *cur, *prev, *next;
164 
165 	prev = 0;
166 	cur = *p;
167 	while(cur != 0) {
168 		next = cur->next;
169 		cur->next = prev;
170 		prev = cur;
171 		cur = next;
172 	}
173 	*p = prev;
174 }
175 
176 void
177 prdata(u_char *buf, struct hid_item *h)
178 {
179 	u_int data;
180 	int i, pos;
181 
182 	pos = h->pos;
183 	for (i = 0; i < h->report_count; i++) {
184 		data = hid_get_data(buf, h);
185 		if (h->logical_minimum < 0)
186 			printf("%d", (int)data);
187 		else
188 			printf("%u", data);
189 		pos += h->report_size;
190 	}
191 }
192 
193 void
194 dumpdata(int f, report_desc_t rd, int loop)
195 {
196 	struct hid_data *d;
197 	struct hid_item h, *hids, *n;
198 	int r, dlen;
199 	u_char *dbuf;
200 	static int one = 1;
201 	u_int32_t colls[100];
202 	int sp = 0;
203 	int report_id;
204 	char namebuf[10000], *namep;
205 
206 	hids = 0;
207 	for (d = hid_start_parse(rd, 1<<hid_input);
208 	     hid_get_item(d, &h); ) {
209 		if (h.kind == hid_collection)
210 			colls[++sp] = h.usage;
211 		else if (h.kind == hid_endcollection)
212 			--sp;
213 		if (h.kind != hid_input || (h.flags & HIO_CONST))
214 			continue;
215 		h.next = hids;
216 		h.collection = colls[sp];
217 		hids = malloc(sizeof *hids);
218 		*hids = h;
219 	}
220 	hid_end_parse(d);
221 	rev(&hids);
222 	dlen = hid_report_size(rd, 0, hid_input);
223 	dbuf = malloc(dlen);
224 	if (!loop)
225 		if (ioctl(f, USB_SET_IMMED, &one) < 0) {
226 			if (errno == EOPNOTSUPP)
227 				warnx("device does not support immediate mode, only changes reported.");
228 			else
229 				err(1, "USB_SET_IMMED");
230 		}
231 	do {
232 		r = read(f, dbuf, dlen);
233 		if (r != dlen) {
234 			err(1, "bad read %d != %d", r, dlen);
235 		}
236 		for (n = hids; n; n = n->next) {
237 			namep = namebuf;
238 			namep += sprintf(namep, "%s:%s.",
239 					 hid_usage_page(HID_PAGE(n->collection)),
240 					 hid_usage_in_page(n->collection));
241 			namep += sprintf(namep, "%s:%s",
242 					 hid_usage_page(HID_PAGE(n->usage)),
243 					 hid_usage_in_page(n->usage));
244 			if (all || gotname(namebuf)) {
245 				if (!noname)
246 					printf("%s=", namebuf);
247 				prdata(dbuf + (report_id != 0), n);
248 				printf("\n");
249 			}
250 		}
251 		if (loop)
252 			printf("\n");
253 	} while (loop);
254 	free(dbuf);
255 }
256 
257 int
258 main(int argc, char **argv)
259 {
260 	int f;
261 	report_desc_t r;
262 	char devnam[100], *dev = 0;
263 	int ch;
264 	int repdump = 0;
265 	int loop = 0;
266 	char *table = 0;
267 
268 	while ((ch = getopt(argc, argv, "af:lnrt:v")) != -1) {
269 		switch(ch) {
270 		case 'a':
271 			all++;
272 			break;
273 		case 'f':
274 			dev = optarg;
275 			break;
276 		case 'l':
277 			loop ^= 1;
278 			break;
279 		case 'n':
280 			noname++;
281 			break;
282 		case 'r':
283 			repdump++;
284 			break;
285 		case 't':
286 			table = optarg;
287 			break;
288 		case 'v':
289 			verbose++;
290 			break;
291 		case '?':
292 		default:
293 			usage();
294 		}
295 	}
296 	argc -= optind;
297 	argv += optind;
298 	if (dev == 0)
299 		usage();
300 	names = argv;
301 	nnames = argc;
302 
303 	if (nnames == 0 && !all && !repdump)
304 		usage();
305 
306 	if (dev[0] != '/') {
307 		if (isdigit(dev[0]))
308 			snprintf(devnam, sizeof(devnam), "/dev/uhid%s", dev);
309 		else
310 			snprintf(devnam, sizeof(devnam), "/dev/%s", dev);
311 		dev = devnam;
312 	}
313 
314 	hid_init(table);
315 
316 	f = open(dev, O_RDWR);
317 	if (f < 0)
318 		err(1, "%s", dev);
319 
320 	r = hid_get_report_desc(f);
321 	if (r == 0)
322 		errx(1, "USB_GET_REPORT_DESC");
323 
324 	if (repdump) {
325 		printf("Report descriptor:\n");
326 		dumpitems(r);
327 	}
328 	if (nnames != 0 || all)
329 		dumpdata(f, r, loop);
330 
331 	hid_dispose_report_desc(r);
332 	exit(0);
333 }
334