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 <unistd.h> 46 #include <err.h> 47 #include <ctype.h> 48 #include <errno.h> 49 #include <usbhid.h> 50 #include <dev/usb/usbhid.h> 51 52 int verbose = 0; 53 int all = 0; 54 int noname = 0; 55 int hexdump = 0; 56 static int reportid; 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, 97 "usage: %s -f device " 98 "[-l] [-n] [-r] [-t tablefile] [-v] [-x] name ...\n", 99 __progname); 100 fprintf(stderr, 101 " %s -f device " 102 "[-l] [-n] [-r] [-t tablefile] [-v] [-x] -a\n", 103 __progname); 104 exit(1); 105 } 106 107 void 108 dumpitem(const char *label, struct hid_item *h) 109 { 110 if ((h->flags & HIO_CONST) && !verbose) 111 return; 112 printf("%s size=%d count=%d page=%s usage=%s%s", label, 113 h->report_size, h->report_count, 114 hid_usage_page(HID_PAGE(h->usage)), 115 hid_usage_in_page(h->usage), 116 h->flags & HIO_CONST ? " Const" : ""); 117 printf(", logical range %d..%d", 118 h->logical_minimum, h->logical_maximum); 119 if (h->physical_minimum != h->physical_maximum) 120 printf(", physical range %d..%d", 121 h->physical_minimum, h->physical_maximum); 122 if (h->unit) 123 printf(", unit=0x%02x exp=%d", h->unit, h->unit_exponent); 124 printf("\n"); 125 } 126 127 void 128 dumpitems(report_desc_t r) 129 { 130 struct hid_data *d; 131 struct hid_item h; 132 int size; 133 134 for (d = hid_start_parse(r, ~0, reportid); hid_get_item(d, &h); ) { 135 switch (h.kind) { 136 case hid_collection: 137 printf("Collection page=%s usage=%s\n", 138 hid_usage_page(HID_PAGE(h.usage)), 139 hid_usage_in_page(h.usage)); 140 break; 141 case hid_endcollection: 142 printf("End collection\n"); 143 break; 144 case hid_input: 145 dumpitem("Input ", &h); 146 break; 147 case hid_output: 148 dumpitem("Output ", &h); 149 break; 150 case hid_feature: 151 dumpitem("Feature", &h); 152 break; 153 } 154 } 155 hid_end_parse(d); 156 size = hid_report_size(r, hid_input, 0); 157 printf("Total input size %d bytes\n", size); 158 159 size = hid_report_size(r, hid_output, 0); 160 printf("Total output size %d bytes\n", size); 161 162 size = hid_report_size(r, hid_feature, 0); 163 printf("Total feature size %d bytes\n", size); 164 } 165 166 void 167 rev(struct hid_item **p) 168 { 169 struct hid_item *cur, *prev, *next; 170 171 prev = 0; 172 cur = *p; 173 while(cur != 0) { 174 next = cur->next; 175 cur->next = prev; 176 prev = cur; 177 cur = next; 178 } 179 *p = prev; 180 } 181 182 void 183 prdata(u_char *buf, struct hid_item *h) 184 { 185 u_int data; 186 int i, pos; 187 188 pos = h->pos; 189 for (i = 0; i < h->report_count; i++) { 190 data = hid_get_data(buf, h); 191 if (h->logical_minimum < 0) 192 printf("%d", (int)data); 193 else 194 printf("%u", data); 195 if (hexdump) 196 printf(" [0x%x]", data); 197 pos += h->report_size; 198 } 199 } 200 201 void 202 dumpdata(int f, report_desc_t rd, int loop) 203 { 204 struct hid_data *d; 205 struct hid_item h, *hids, *n; 206 int r, dlen; 207 u_char *dbuf; 208 u_int32_t colls[100]; 209 int sp = 0; 210 char namebuf[10000], *namep; 211 212 hids = 0; 213 for (d = hid_start_parse(rd, 1<<hid_input, reportid); 214 hid_get_item(d, &h); ) { 215 if (h.kind == hid_collection) 216 colls[++sp] = h.usage; 217 else if (h.kind == hid_endcollection) 218 --sp; 219 if (h.kind != hid_input || (h.flags & HIO_CONST)) 220 continue; 221 h.next = hids; 222 h.collection = colls[sp]; 223 hids = malloc(sizeof *hids); 224 *hids = h; 225 } 226 hid_end_parse(d); 227 rev(&hids); 228 dlen = hid_report_size(rd, hid_input, 0); 229 dbuf = malloc(dlen); 230 if (!loop) 231 if (hid_set_immed(f, 1) < 0) { 232 if (errno == EOPNOTSUPP) 233 warnx("device does not support immediate mode, only changes reported."); 234 else 235 err(1, "USB_SET_IMMED"); 236 } 237 do { 238 r = read(f, dbuf, dlen); 239 if (r != dlen) { 240 err(1, "bad read %d != %d", r, dlen); 241 } 242 for (n = hids; n; n = n->next) { 243 namep = namebuf; 244 namep += sprintf(namep, "%s:%s.", 245 hid_usage_page(HID_PAGE(n->collection)), 246 hid_usage_in_page(n->collection)); 247 namep += sprintf(namep, "%s:%s", 248 hid_usage_page(HID_PAGE(n->usage)), 249 hid_usage_in_page(n->usage)); 250 if (all || gotname(namebuf)) { 251 if (!noname) 252 printf("%s=", namebuf); 253 prdata(dbuf + (reportid != 0), n); 254 printf("\n"); 255 } 256 } 257 if (loop) 258 printf("\n"); 259 } while (loop); 260 free(dbuf); 261 } 262 263 int 264 main(int argc, char **argv) 265 { 266 int f; 267 report_desc_t r; 268 char devnam[100], *dev = 0; 269 int ch; 270 int repdump = 0; 271 int loop = 0; 272 char *table = 0; 273 274 while ((ch = getopt(argc, argv, "af:lnrt:vx")) != -1) { 275 switch(ch) { 276 case 'a': 277 all++; 278 break; 279 case 'f': 280 dev = optarg; 281 break; 282 case 'l': 283 loop ^= 1; 284 break; 285 case 'n': 286 noname++; 287 break; 288 case 'r': 289 repdump++; 290 break; 291 case 't': 292 table = optarg; 293 break; 294 case 'v': 295 verbose++; 296 break; 297 case 'x': 298 hexdump = 1; 299 break; 300 case '?': 301 default: 302 usage(); 303 } 304 } 305 argc -= optind; 306 argv += optind; 307 if (dev == 0) 308 usage(); 309 names = argv; 310 nnames = argc; 311 312 if (nnames == 0 && !all && !repdump) 313 usage(); 314 315 if (dev[0] != '/') { 316 if (isdigit(dev[0])) 317 snprintf(devnam, sizeof(devnam), "/dev/uhid%s", dev); 318 else 319 snprintf(devnam, sizeof(devnam), "/dev/%s", dev); 320 dev = devnam; 321 } 322 323 hid_init(table); 324 325 f = open(dev, O_RDWR); 326 if (f < 0) 327 err(1, "%s", dev); 328 329 r = hid_get_report_desc(f); 330 if (r == 0) 331 errx(1, "USB_GET_REPORT_DESC"); 332 333 if (repdump) { 334 printf("Report descriptor:\n"); 335 dumpitems(r); 336 } 337 if (nnames != 0 || all) 338 dumpdata(f, r, loop); 339 340 hid_dispose_report_desc(r); 341 exit(0); 342 } 343