109d308a8SNick Hibma /* $NetBSD: usbhid.c,v 1.14 2000/07/03 02:51:37 matt Exp $ */ 209d308a8SNick Hibma /* $FreeBSD$ */ 309d308a8SNick Hibma 409d308a8SNick Hibma /* 509d308a8SNick Hibma * Copyright (c) 1998 The NetBSD Foundation, Inc. 609d308a8SNick Hibma * All rights reserved. 709d308a8SNick Hibma * 809d308a8SNick Hibma * This code is derived from software contributed to The NetBSD Foundation 909d308a8SNick Hibma * by Lennart Augustsson (augustss@netbsd.org). 1009d308a8SNick Hibma * 1109d308a8SNick Hibma * Redistribution and use in source and binary forms, with or without 1209d308a8SNick Hibma * modification, are permitted provided that the following conditions 1309d308a8SNick Hibma * are met: 1409d308a8SNick Hibma * 1. Redistributions of source code must retain the above copyright 1509d308a8SNick Hibma * notice, this list of conditions and the following disclaimer. 1609d308a8SNick Hibma * 2. Redistributions in binary form must reproduce the above copyright 1709d308a8SNick Hibma * notice, this list of conditions and the following disclaimer in the 1809d308a8SNick Hibma * documentation and/or other materials provided with the distribution. 1909d308a8SNick Hibma * 2009d308a8SNick Hibma * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 2109d308a8SNick Hibma * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 2209d308a8SNick Hibma * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 2309d308a8SNick Hibma * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 2409d308a8SNick Hibma * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 2509d308a8SNick Hibma * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 2609d308a8SNick Hibma * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 2709d308a8SNick Hibma * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 2809d308a8SNick Hibma * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 2909d308a8SNick Hibma * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 3009d308a8SNick Hibma * POSSIBILITY OF SUCH DAMAGE. 3109d308a8SNick Hibma */ 3209d308a8SNick Hibma 3309d308a8SNick Hibma #include <stdio.h> 3409d308a8SNick Hibma #include <stdlib.h> 3509d308a8SNick Hibma #include <string.h> 3609d308a8SNick Hibma #include <sys/types.h> 3709d308a8SNick Hibma #include <fcntl.h> 3809d308a8SNick Hibma #include <unistd.h> 3909d308a8SNick Hibma #include <err.h> 4009d308a8SNick Hibma #include <ctype.h> 4109d308a8SNick Hibma #include <errno.h> 42cf0e07e5SMatthew N. Dodd #include <usbhid.h> 43bf41796cSAndrew Thompson #include <dev/usb/usbhid.h> 4409d308a8SNick Hibma 4509d308a8SNick Hibma int verbose = 0; 4609d308a8SNick Hibma int all = 0; 4709d308a8SNick Hibma int noname = 0; 489a2a66f1SGreg Lehey int hexdump = 0; 4909d308a8SNick Hibma 5009d308a8SNick Hibma char **names; 5109d308a8SNick Hibma int nnames; 5209d308a8SNick Hibma 5309d308a8SNick Hibma void prbits(int bits, char **strs, int n); 5409d308a8SNick Hibma void usage(void); 551a27f4f2SMark Murray void dumpitem(const char *label, struct hid_item *h); 5609d308a8SNick Hibma void dumpitems(report_desc_t r); 5709d308a8SNick Hibma void rev(struct hid_item **p); 5809d308a8SNick Hibma void prdata(u_char *buf, struct hid_item *h); 5909d308a8SNick Hibma void dumpdata(int f, report_desc_t r, int loop); 6009d308a8SNick Hibma int gotname(char *n); 6109d308a8SNick Hibma 6209d308a8SNick Hibma int 6309d308a8SNick Hibma gotname(char *n) 6409d308a8SNick Hibma { 6509d308a8SNick Hibma int i; 6609d308a8SNick Hibma 6709d308a8SNick Hibma for (i = 0; i < nnames; i++) 6809d308a8SNick Hibma if (strcmp(names[i], n) == 0) 6909d308a8SNick Hibma return 1; 7009d308a8SNick Hibma return 0; 7109d308a8SNick Hibma } 7209d308a8SNick Hibma 7309d308a8SNick Hibma void 7409d308a8SNick Hibma prbits(int bits, char **strs, int n) 7509d308a8SNick Hibma { 7609d308a8SNick Hibma int i; 7709d308a8SNick Hibma 7809d308a8SNick Hibma for(i = 0; i < n; i++, bits >>= 1) 7909d308a8SNick Hibma if (strs[i*2]) 8009d308a8SNick Hibma printf("%s%s", i == 0 ? "" : ", ", strs[i*2 + (bits&1)]); 8109d308a8SNick Hibma } 8209d308a8SNick Hibma 8309d308a8SNick Hibma void 8409d308a8SNick Hibma usage(void) 8509d308a8SNick Hibma { 8609d308a8SNick Hibma 879a2a66f1SGreg Lehey fprintf(stderr, 889a2a66f1SGreg Lehey "usage: %s -f device " 89eb29cfddSGreg Lehey "[-l] [-n] [-r] [-t tablefile] [-v] [-x] name ...\n", 901946089bSXin LI getprogname()); 919a2a66f1SGreg Lehey fprintf(stderr, 929a2a66f1SGreg Lehey " %s -f device " 93eb29cfddSGreg Lehey "[-l] [-n] [-r] [-t tablefile] [-v] [-x] -a\n", 941946089bSXin LI getprogname()); 9509d308a8SNick Hibma exit(1); 9609d308a8SNick Hibma } 9709d308a8SNick Hibma 9809d308a8SNick Hibma void 991a27f4f2SMark Murray dumpitem(const char *label, struct hid_item *h) 10009d308a8SNick Hibma { 10109d308a8SNick Hibma if ((h->flags & HIO_CONST) && !verbose) 10209d308a8SNick Hibma return; 1031bee2ec7SAlexander Motin printf("%s rid=%d size=%d count=%d page=%s usage=%s%s%s", label, 1041bee2ec7SAlexander Motin h->report_ID, h->report_size, h->report_count, 10509d308a8SNick Hibma hid_usage_page(HID_PAGE(h->usage)), 10609d308a8SNick Hibma hid_usage_in_page(h->usage), 1071bee2ec7SAlexander Motin h->flags & HIO_CONST ? " Const" : "", 1081bee2ec7SAlexander Motin h->flags & HIO_VARIABLE ? "" : " Array"); 10909d308a8SNick Hibma printf(", logical range %d..%d", 11009d308a8SNick Hibma h->logical_minimum, h->logical_maximum); 11109d308a8SNick Hibma if (h->physical_minimum != h->physical_maximum) 11209d308a8SNick Hibma printf(", physical range %d..%d", 11309d308a8SNick Hibma h->physical_minimum, h->physical_maximum); 11409d308a8SNick Hibma if (h->unit) 11509d308a8SNick Hibma printf(", unit=0x%02x exp=%d", h->unit, h->unit_exponent); 11609d308a8SNick Hibma printf("\n"); 11709d308a8SNick Hibma } 11809d308a8SNick Hibma 1191bee2ec7SAlexander Motin static const char * 1201bee2ec7SAlexander Motin hid_collection_type(int32_t type) 1211bee2ec7SAlexander Motin { 1221bee2ec7SAlexander Motin static char num[8]; 1231bee2ec7SAlexander Motin 1241bee2ec7SAlexander Motin switch (type) { 1251bee2ec7SAlexander Motin case 0: return ("Physical"); 1261bee2ec7SAlexander Motin case 1: return ("Application"); 1271bee2ec7SAlexander Motin case 2: return ("Logical"); 1281bee2ec7SAlexander Motin case 3: return ("Report"); 1291bee2ec7SAlexander Motin case 4: return ("Named_Array"); 1301bee2ec7SAlexander Motin case 5: return ("Usage_Switch"); 1311bee2ec7SAlexander Motin case 6: return ("Usage_Modifier"); 1321bee2ec7SAlexander Motin } 1331bee2ec7SAlexander Motin snprintf(num, sizeof(num), "0x%02x", type); 1341bee2ec7SAlexander Motin return (num); 1351bee2ec7SAlexander Motin } 1361bee2ec7SAlexander Motin 13709d308a8SNick Hibma void 13809d308a8SNick Hibma dumpitems(report_desc_t r) 13909d308a8SNick Hibma { 14009d308a8SNick Hibma struct hid_data *d; 14109d308a8SNick Hibma struct hid_item h; 1421d10fe50SNick Hibma int size; 14309d308a8SNick Hibma 1441bee2ec7SAlexander Motin for (d = hid_start_parse(r, ~0, -1); hid_get_item(d, &h); ) { 14509d308a8SNick Hibma switch (h.kind) { 14609d308a8SNick Hibma case hid_collection: 1471bee2ec7SAlexander Motin printf("Collection type=%s page=%s usage=%s\n", 1481bee2ec7SAlexander Motin hid_collection_type(h.collection), 14909d308a8SNick Hibma hid_usage_page(HID_PAGE(h.usage)), 15009d308a8SNick Hibma hid_usage_in_page(h.usage)); 15109d308a8SNick Hibma break; 15209d308a8SNick Hibma case hid_endcollection: 15309d308a8SNick Hibma printf("End collection\n"); 15409d308a8SNick Hibma break; 15509d308a8SNick Hibma case hid_input: 15609d308a8SNick Hibma dumpitem("Input ", &h); 15709d308a8SNick Hibma break; 15809d308a8SNick Hibma case hid_output: 15909d308a8SNick Hibma dumpitem("Output ", &h); 16009d308a8SNick Hibma break; 16109d308a8SNick Hibma case hid_feature: 16209d308a8SNick Hibma dumpitem("Feature", &h); 16309d308a8SNick Hibma break; 16409d308a8SNick Hibma } 16509d308a8SNick Hibma } 16609d308a8SNick Hibma hid_end_parse(d); 1671bee2ec7SAlexander Motin size = hid_report_size(r, hid_input, -1); 1681a2cdef4SNick Hibma printf("Total input size %d bytes\n", size); 16909d308a8SNick Hibma 1701bee2ec7SAlexander Motin size = hid_report_size(r, hid_output, -1); 1711d10fe50SNick Hibma printf("Total output size %d bytes\n", size); 17209d308a8SNick Hibma 1731bee2ec7SAlexander Motin size = hid_report_size(r, hid_feature, -1); 1741d10fe50SNick Hibma printf("Total feature size %d bytes\n", size); 17509d308a8SNick Hibma } 17609d308a8SNick Hibma 17709d308a8SNick Hibma void 17809d308a8SNick Hibma rev(struct hid_item **p) 17909d308a8SNick Hibma { 18009d308a8SNick Hibma struct hid_item *cur, *prev, *next; 18109d308a8SNick Hibma 18209d308a8SNick Hibma prev = 0; 18309d308a8SNick Hibma cur = *p; 18409d308a8SNick Hibma while(cur != 0) { 18509d308a8SNick Hibma next = cur->next; 18609d308a8SNick Hibma cur->next = prev; 18709d308a8SNick Hibma prev = cur; 18809d308a8SNick Hibma cur = next; 18909d308a8SNick Hibma } 19009d308a8SNick Hibma *p = prev; 19109d308a8SNick Hibma } 19209d308a8SNick Hibma 19309d308a8SNick Hibma void 19409d308a8SNick Hibma prdata(u_char *buf, struct hid_item *h) 19509d308a8SNick Hibma { 19609d308a8SNick Hibma u_int data; 19709d308a8SNick Hibma int i, pos; 19809d308a8SNick Hibma 19909d308a8SNick Hibma pos = h->pos; 20009d308a8SNick Hibma for (i = 0; i < h->report_count; i++) { 20109d308a8SNick Hibma data = hid_get_data(buf, h); 2021bee2ec7SAlexander Motin if (i > 0) 2031bee2ec7SAlexander Motin printf(" "); 20409d308a8SNick Hibma if (h->logical_minimum < 0) 20509d308a8SNick Hibma printf("%d", (int)data); 20609d308a8SNick Hibma else 20709d308a8SNick Hibma printf("%u", data); 2089a2a66f1SGreg Lehey if (hexdump) 2099a2a66f1SGreg Lehey printf(" [0x%x]", data); 2101bee2ec7SAlexander Motin h->pos += h->report_size; 21109d308a8SNick Hibma } 2121bee2ec7SAlexander Motin h->pos = pos; 21309d308a8SNick Hibma } 21409d308a8SNick Hibma 21509d308a8SNick Hibma void 21609d308a8SNick Hibma dumpdata(int f, report_desc_t rd, int loop) 21709d308a8SNick Hibma { 21809d308a8SNick Hibma struct hid_data *d; 21909d308a8SNick Hibma struct hid_item h, *hids, *n; 22009d308a8SNick Hibma int r, dlen; 22109d308a8SNick Hibma u_char *dbuf; 22209d308a8SNick Hibma u_int32_t colls[100]; 22309d308a8SNick Hibma int sp = 0; 22409d308a8SNick Hibma char namebuf[10000], *namep; 22509d308a8SNick Hibma 22609d308a8SNick Hibma hids = 0; 2271bee2ec7SAlexander Motin for (d = hid_start_parse(rd, 1<<hid_input, -1); 22809d308a8SNick Hibma hid_get_item(d, &h); ) { 22909d308a8SNick Hibma if (h.kind == hid_collection) 23009d308a8SNick Hibma colls[++sp] = h.usage; 23109d308a8SNick Hibma else if (h.kind == hid_endcollection) 23209d308a8SNick Hibma --sp; 23309d308a8SNick Hibma if (h.kind != hid_input || (h.flags & HIO_CONST)) 23409d308a8SNick Hibma continue; 23509d308a8SNick Hibma h.next = hids; 23609d308a8SNick Hibma h.collection = colls[sp]; 23709d308a8SNick Hibma hids = malloc(sizeof *hids); 23809d308a8SNick Hibma *hids = h; 23909d308a8SNick Hibma } 24009d308a8SNick Hibma hid_end_parse(d); 24109d308a8SNick Hibma rev(&hids); 2421bee2ec7SAlexander Motin dlen = hid_report_size(rd, hid_input, -1); 24309d308a8SNick Hibma dbuf = malloc(dlen); 24409d308a8SNick Hibma if (!loop) 2457e474656SAlfred Perlstein if (hid_set_immed(f, 1) < 0) { 24609d308a8SNick Hibma if (errno == EOPNOTSUPP) 24709d308a8SNick Hibma warnx("device does not support immediate mode, only changes reported."); 24809d308a8SNick Hibma else 24909d308a8SNick Hibma err(1, "USB_SET_IMMED"); 25009d308a8SNick Hibma } 25109d308a8SNick Hibma do { 25209d308a8SNick Hibma r = read(f, dbuf, dlen); 2531bee2ec7SAlexander Motin if (r < 1) { 2541bee2ec7SAlexander Motin err(1, "read error"); 25509d308a8SNick Hibma } 25609d308a8SNick Hibma for (n = hids; n; n = n->next) { 2571bee2ec7SAlexander Motin if (n->report_ID != 0 && dbuf[0] != n->report_ID) 2581bee2ec7SAlexander Motin continue; 25909d308a8SNick Hibma namep = namebuf; 26009d308a8SNick Hibma namep += sprintf(namep, "%s:%s.", 26109d308a8SNick Hibma hid_usage_page(HID_PAGE(n->collection)), 26209d308a8SNick Hibma hid_usage_in_page(n->collection)); 26309d308a8SNick Hibma namep += sprintf(namep, "%s:%s", 26409d308a8SNick Hibma hid_usage_page(HID_PAGE(n->usage)), 26509d308a8SNick Hibma hid_usage_in_page(n->usage)); 26609d308a8SNick Hibma if (all || gotname(namebuf)) { 26709d308a8SNick Hibma if (!noname) 26809d308a8SNick Hibma printf("%s=", namebuf); 2691bee2ec7SAlexander Motin prdata(dbuf, n); 27009d308a8SNick Hibma printf("\n"); 27109d308a8SNick Hibma } 27209d308a8SNick Hibma } 27309d308a8SNick Hibma if (loop) 27409d308a8SNick Hibma printf("\n"); 27509d308a8SNick Hibma } while (loop); 27609d308a8SNick Hibma free(dbuf); 27709d308a8SNick Hibma } 27809d308a8SNick Hibma 27909d308a8SNick Hibma int 28009d308a8SNick Hibma main(int argc, char **argv) 28109d308a8SNick Hibma { 28209d308a8SNick Hibma int f; 28309d308a8SNick Hibma report_desc_t r; 2841a27f4f2SMark Murray char devnam[100], *dev = 0; 28509d308a8SNick Hibma int ch; 28609d308a8SNick Hibma int repdump = 0; 28709d308a8SNick Hibma int loop = 0; 28809d308a8SNick Hibma char *table = 0; 28909d308a8SNick Hibma 2909a2a66f1SGreg Lehey while ((ch = getopt(argc, argv, "af:lnrt:vx")) != -1) { 29109d308a8SNick Hibma switch(ch) { 29209d308a8SNick Hibma case 'a': 29309d308a8SNick Hibma all++; 29409d308a8SNick Hibma break; 29509d308a8SNick Hibma case 'f': 29609d308a8SNick Hibma dev = optarg; 29709d308a8SNick Hibma break; 29809d308a8SNick Hibma case 'l': 29909d308a8SNick Hibma loop ^= 1; 30009d308a8SNick Hibma break; 30109d308a8SNick Hibma case 'n': 30209d308a8SNick Hibma noname++; 30309d308a8SNick Hibma break; 30409d308a8SNick Hibma case 'r': 30509d308a8SNick Hibma repdump++; 30609d308a8SNick Hibma break; 30709d308a8SNick Hibma case 't': 30809d308a8SNick Hibma table = optarg; 30909d308a8SNick Hibma break; 31009d308a8SNick Hibma case 'v': 31109d308a8SNick Hibma verbose++; 31209d308a8SNick Hibma break; 3139a2a66f1SGreg Lehey case 'x': 314eb29cfddSGreg Lehey hexdump = 1; 3159a2a66f1SGreg Lehey break; 31609d308a8SNick Hibma case '?': 31709d308a8SNick Hibma default: 31809d308a8SNick Hibma usage(); 31909d308a8SNick Hibma } 32009d308a8SNick Hibma } 32109d308a8SNick Hibma argc -= optind; 32209d308a8SNick Hibma argv += optind; 32309d308a8SNick Hibma if (dev == 0) 32409d308a8SNick Hibma usage(); 32509d308a8SNick Hibma names = argv; 32609d308a8SNick Hibma nnames = argc; 32709d308a8SNick Hibma 32809d308a8SNick Hibma if (nnames == 0 && !all && !repdump) 32909d308a8SNick Hibma usage(); 33009d308a8SNick Hibma 33109d308a8SNick Hibma if (dev[0] != '/') { 33209d308a8SNick Hibma if (isdigit(dev[0])) 3331a27f4f2SMark Murray snprintf(devnam, sizeof(devnam), "/dev/uhid%s", dev); 33409d308a8SNick Hibma else 3351a27f4f2SMark Murray snprintf(devnam, sizeof(devnam), "/dev/%s", dev); 3361a27f4f2SMark Murray dev = devnam; 33709d308a8SNick Hibma } 33809d308a8SNick Hibma 33909d308a8SNick Hibma hid_init(table); 34009d308a8SNick Hibma 34109d308a8SNick Hibma f = open(dev, O_RDWR); 34209d308a8SNick Hibma if (f < 0) 34309d308a8SNick Hibma err(1, "%s", dev); 34409d308a8SNick Hibma 34509d308a8SNick Hibma r = hid_get_report_desc(f); 34609d308a8SNick Hibma if (r == 0) 34709d308a8SNick Hibma errx(1, "USB_GET_REPORT_DESC"); 34809d308a8SNick Hibma 34909d308a8SNick Hibma if (repdump) { 35009d308a8SNick Hibma printf("Report descriptor:\n"); 35109d308a8SNick Hibma dumpitems(r); 35209d308a8SNick Hibma } 35309d308a8SNick Hibma if (nnames != 0 || all) 35409d308a8SNick Hibma dumpdata(f, r, loop); 35509d308a8SNick Hibma 35609d308a8SNick Hibma hid_dispose_report_desc(r); 35709d308a8SNick Hibma exit(0); 35809d308a8SNick Hibma } 359