Sync libusbhid with other BSDs (breaks API compatibility). Sync usbhidctl
authorHasso Tepper <hasso@dragonflybsd.org>
Mon, 24 Nov 2008 17:15:17 +0000 (17:15 +0000)
committerHasso Tepper <hasso@dragonflybsd.org>
Mon, 24 Nov 2008 17:15:17 +0000 (17:15 +0000)
with FreeBSD.

Obtained-from: FreeBSD

lib/libusbhid/Makefile
lib/libusbhid/data.c
lib/libusbhid/descr.c
lib/libusbhid/parse.c
lib/libusbhid/usage.c
lib/libusbhid/usbhid.3
lib/libusbhid/usbhid.h [moved from lib/libusbhid/libusbhid.h with 87% similarity]
usr.bin/usbhidctl/usbhid.c
usr.bin/usbhidctl/usbhidctl.1

index 2f5b39e..bc9511c 100644 (file)
@@ -1,11 +1,11 @@
 #      $NetBSD: Makefile,v 1.5 1999/07/23 09:44:38 mrg Exp $
 #      $FreeBSD: src/lib/libusbhid/Makefile,v 1.6 2002/03/28 18:44:24 joe Exp $
-#      $DragonFly: src/lib/libusbhid/Makefile,v 1.6 2008/08/09 20:08:20 swildner Exp $
+#      $DragonFly: src/lib/libusbhid/Makefile,v 1.7 2008/11/24 17:15:17 hasso Exp $
 
 LIB=   usbhid
 MAN=   usbhid.3
 
-SHLIB_MAJOR= 1
+SHLIB_MAJOR= 2
 
 MLINKS=        usbhid.3 libusbhid.3 usbhid.3 hid_get_report_desc.3 \
        usbhid.3 hid_dispose_report_desc.3 \
@@ -20,7 +20,7 @@ MLINKS=       usbhid.3 libusbhid.3 usbhid.3 hid_get_report_desc.3 \
 
 SRCS=  descr.c parse.c usage.c data.c
 
-INCS=  libusbhid.h
+INCS=  usbhid.h
 
 .include <bsd.lib.mk>
 
index aeddbaf..b685673 100644 (file)
@@ -1,4 +1,4 @@
-/*     $NetBSD: data.c,v 1.8 2000/04/02 11:10:53 augustss Exp $        */
+/* $NetBSD: data.c,v 1.8 2000/04/02 11:10:53 augustss Exp $ */
 
 /*
  * Copyright (c) 1999 Lennart Augustsson <augustss@netbsd.org>
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  *
- * $FreeBSD: src/lib/libusbhid/data.c,v 1.5.2.1 2002/04/03 15:54:00 joe Exp $
- * $DragonFly: src/lib/libusbhid/data.c,v 1.2 2003/06/17 04:26:51 dillon Exp $
+ * $FreeBSD: src/lib/libusbhid/data.c,v 1.6 2003/04/09 01:52:48 mdodd Exp $
+ * $DragonFly: src/lib/libusbhid/data.c,v 1.3 2008/11/24 17:15:17 hasso Exp $
  */
 
 #include <assert.h>
 #include <stdlib.h>
-#include "libusbhid.h"
+#include "usbhid.h"
 
 int
 hid_get_data(const void *p, const hid_item_t *h)
index f29be11..b1968c2 100644 (file)
@@ -1,4 +1,4 @@
-/*     $NetBSD: descr.c,v 1.9 2000/09/24 02:13:24 augustss Exp $       */
+/* $NetBSD: descr.c,v 1.9 2000/09/24 02:13:24 augustss Exp $ */
 
 /*
  * Copyright (c) 1999 Lennart Augustsson <augustss@netbsd.org>
@@ -25,8 +25,8 @@
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  *
- * $FreeBSD: src/lib/libusbhid/descr.c,v 1.7.2.1 2002/04/03 15:54:00 joe Exp $
- * $DragonFly: src/lib/libusbhid/descr.c,v 1.4 2004/02/03 06:26:31 dillon Exp $
+ * $FreeBSD: src/lib/libusbhid/descr.c,v 1.8 2003/04/09 01:52:48 mdodd Exp $
+ * $DragonFly: src/lib/libusbhid/descr.c,v 1.5 2008/11/24 17:15:17 hasso Exp $
  */
 
 #include <sys/types.h>
@@ -41,7 +41,7 @@
 
 #include <bus/usb/usb.h>
 
-#include "libusbhid.h"
+#include "usbhid.h"
 #include "usbvar.h"
 
 report_desc_t
index 8614c64..5f4564c 100644 (file)
@@ -1,7 +1,7 @@
-/*     $NetBSD: parse.c,v 1.11 2000/09/24 02:19:54 augustss Exp $      */
+/* $NetBSD: parse.c,v 1.11 2000/09/24 02:19:54 augustss Exp $ */
 
 /*
- * Copyright (c) 1999 Lennart Augustsson <augustss@netbsd.org>
+ * Copyright (c) 1999, 2001 Lennart Augustsson <augustss@netbsd.org>
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -25,8 +25,8 @@
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  *
- * $FreeBSD: src/lib/libusbhid/parse.c,v 1.6.2.1 2002/04/03 15:54:00 joe Exp $
- * $DragonFly: src/lib/libusbhid/parse.c,v 1.3 2003/08/08 04:18:35 dillon Exp $
+ * $FreeBSD: src/lib/libusbhid/parse.c,v 1.10 2004/02/11 21:09:13 emax Exp $
+ * $DragonFly: src/lib/libusbhid/parse.c,v 1.4 2008/11/24 17:15:17 hasso Exp $
  */
 
 #include <assert.h>
@@ -37,7 +37,7 @@
 #include <bus/usb/usb.h>
 #include <bus/usb/usbhid.h>
 
-#include "libusbhid.h"
+#include "usbhid.h"
 #include "usbvar.h"
 
 #define MAXUSAGE 100
@@ -49,18 +49,30 @@ struct hid_data {
        unsigned int usages[MAXUSAGE];
        int nusage;
        int minset;
+       int logminsize;
        int multi;
        int multimax;
        int kindset;
+       int reportid;
 
-       /* Absolute data position (bits) for input/output/feature.
-           Assumes that hid_input, hid_output and hid_feature have
-           values 0, 1 and 2. */
-        unsigned int kindpos[3];
+       /*
+        * The start of collection item has no report ID set, so save
+        * it until we know the ID.
+        */
+       hid_item_t savedcoll;
+       u_char hassavedcoll;
+       /*
+        * Absolute data position (bits) for input/output/feature.
+        *  Assumes that hid_input, hid_output and hid_feature have
+        *  values 0, 1 and 2.
+        */
+       unsigned int kindpos[3];
 };
 
 static int min(int x, int y) { return x < y ? x : y; }
 
+static int hid_get_item_raw(hid_data_t s, hid_item_t *h);
+
 static void
 hid_clear_local(hid_item_t *c)
 {
@@ -77,7 +89,7 @@ hid_clear_local(hid_item_t *c)
 }
 
 hid_data_t
-hid_start_parse(report_desc_t d, int kindset)
+hid_start_parse(report_desc_t d, int kindset, int id)
 {
        struct hid_data *s;
 
@@ -86,6 +98,8 @@ hid_start_parse(report_desc_t d, int kindset)
        s->start = s->p = d->data;
        s->end = d->data + d->size;
        s->kindset = kindset;
+       s->reportid = id;
+       s->hassavedcoll = 0;
        return (s);
 }
 
@@ -102,6 +116,31 @@ hid_end_parse(hid_data_t s)
 
 int
 hid_get_item(hid_data_t s, hid_item_t *h)
+{
+       int r;
+
+       for (;;) {
+               r = hid_get_item_raw(s, h);
+               if (r <= 0)
+                       break;
+               if (h->report_ID == s->reportid || s->reportid == -1)
+                       break;
+       }
+       return (r);
+}
+
+#define REPORT_SAVED_COLL \
+       do { \
+               if (s->hassavedcoll) { \
+                       *h = s->savedcoll; \
+                       h->report_ID = c->report_ID; \
+                       s->hassavedcoll = 0; \
+                       return (1); \
+               } \
+       } while(/*LINTED*/ 0)
+
+static int
+hid_get_item_raw(hid_data_t s, hid_item_t *h)
 {
        hid_item_t *c;
        unsigned int bTag = 0, bType = 0, bSize;
@@ -109,6 +148,7 @@ hid_get_item(hid_data_t s, hid_item_t *h)
        int dval;
        unsigned char *p;
        hid_item_t *hi;
+       hid_item_t nc;
        int i;
        hid_kind_t retkind;
 
@@ -116,13 +156,21 @@ hid_get_item(hid_data_t s, hid_item_t *h)
 
  top:
        if (s->multimax) {
+               REPORT_SAVED_COLL;
+               if (c->logical_minimum >= c->logical_maximum) {
+                       if (s->logminsize == 1)
+                               c->logical_minimum =(int8_t)c->logical_minimum;
+                       else if (s->logminsize == 2)
+                               c->logical_minimum =(int16_t)c->logical_minimum;
+               }
                if (s->multi < s->multimax) {
                        c->usage = s->usages[min(s->multi, s->nusage-1)];
                        s->multi++;
                        *h = *c;
-
-                       /* 'multimax' is only non-zero if the current
-                           item kind is input/output/feature */
+                       /*
+                        * 'multimax' is only non-zero if the current
+                         *  item kind is input/output/feature
+                        */
                        h->pos = s->kindpos[c->kind];
                        s->kindpos[c->kind] += c->report_size;
                        h->next = 0;
@@ -165,12 +213,11 @@ hid_get_item(hid_data_t s, hid_item_t *h)
                        dval = 0;
                        break;
                case 1:
-                       dval = (int8_t)*data++;
+                       dval = *data++;
                        break;
                case 2:
                        dval = *data++;
                        dval |= *data++ << 8;
-                       dval = (int16_t)dval;
                        break;
                case 4:
                        dval = *data++;
@@ -207,6 +254,8 @@ hid_get_item(hid_data_t s, hid_item_t *h)
                                                        if (s->nusage < MAXUSAGE-1)
                                                                s->nusage++;
                                                }
+                                               c->usage_minimum = 0;
+                                               c->usage_maximum = 0;
                                                s->minset = 0;
                                        }
                                        goto top;
@@ -216,7 +265,8 @@ hid_get_item(hid_data_t s, hid_item_t *h)
                                        *h = *c;
                                        h->next = 0;
                                        h->pos = s->kindpos[c->kind];
-                                       s->kindpos[c->kind] += c->report_size * c->report_count;
+                                       s->kindpos[c->kind] +=
+                                           c->report_size * c->report_count;
                                        hid_clear_local(c);
                                        s->minset = 0;
                                        return (1);
@@ -228,15 +278,25 @@ hid_get_item(hid_data_t s, hid_item_t *h)
                                c->kind = hid_collection;
                                c->collection = dval;
                                c->collevel++;
-                               *h = *c;
+                               nc = *c;
                                hid_clear_local(c);
-                               c->report_ID = NO_REPORT_ID;
+                               /*c->report_ID = NO_REPORT_ID;*/
                                s->nusage = 0;
-                               return (1);
+                               if (s->hassavedcoll) {
+                                       *h = s->savedcoll;
+                                       h->report_ID = nc.report_ID;
+                                       s->savedcoll = nc;
+                                       return (1);
+                               } else {
+                                       s->hassavedcoll = 1;
+                                       s->savedcoll = nc;
+                               }
+                               break;
                        case 11:        /* Feature */
                                retkind = hid_feature;
                                goto ret;
                        case 12:        /* End collection */
+                               REPORT_SAVED_COLL;
                                c->kind = hid_endcollection;
                                c->collevel--;
                                *h = *c;
@@ -246,6 +306,7 @@ hid_get_item(hid_data_t s, hid_item_t *h)
                        default:
                                return (-2);
                        }
+                       break;
 
                case 1:         /* Global */
                        switch (bTag) {
@@ -254,6 +315,7 @@ hid_get_item(hid_data_t s, hid_item_t *h)
                                break;
                        case 1:
                                c->logical_minimum = dval;
+                               s->logminsize = bSize;
                                break;
                        case 2:
                                c->logical_maximum = dval;
@@ -275,6 +337,9 @@ hid_get_item(hid_data_t s, hid_item_t *h)
                                break;
                        case 8:
                                c->report_ID = dval;
+                               s->kindpos[hid_input] =
+                                   s->kindpos[hid_output] =
+                                   s->kindpos[hid_feature] = 0;
                                break;
                        case 9:
                                c->report_count = dval;
@@ -296,29 +361,17 @@ hid_get_item(hid_data_t s, hid_item_t *h)
                case 2:         /* Local */
                        switch (bTag) {
                        case 0:
-                               if (bSize == 1)
-                                       dval = c->_usage_page | (dval&0xff);
-                               else if (bSize == 2)
-                                       dval = c->_usage_page | (dval&0xffff);
-                               c->usage = dval;
+                               c->usage = c->_usage_page | dval;
                                if (s->nusage < MAXUSAGE)
-                                       s->usages[s->nusage++] = dval;
+                                       s->usages[s->nusage++] = c->usage;
                                /* else XXX */
                                break;
                        case 1:
                                s->minset = 1;
-                               if (bSize == 1)
-                                       dval = c->_usage_page | (dval&0xff);
-                               else if (bSize == 2)
-                                       dval = c->_usage_page | (dval&0xffff);
-                               c->usage_minimum = dval;
+                               c->usage_minimum = c->_usage_page | dval;
                                break;
                        case 2:
-                               if (bSize == 1)
-                                       dval = c->_usage_page | (dval&0xff);
-                               else if (bSize == 2)
-                                       dval = c->_usage_page | (dval&0xffff);
-                               c->usage_maximum = dval;
+                               c->usage_maximum = c->_usage_page | dval;
                                break;
                        case 3:
                                c->designator_index = dval;
@@ -352,35 +405,30 @@ hid_get_item(hid_data_t s, hid_item_t *h)
 }
 
 int
-hid_report_size(report_desc_t r, unsigned int id, enum hid_kind k)
+hid_report_size(report_desc_t r, enum hid_kind k, int id)
 {
        struct hid_data *d;
        hid_item_t h;
-       unsigned int size = 0;
+       int size;
 
        memset(&h, 0, sizeof h);
-       d = hid_start_parse(r, 1<<k);
-       while (hid_get_item(d, &h)) {
+       size = 0;
+       for (d = hid_start_parse(r, 1<<k, id); hid_get_item(d, &h); ) {
                if (h.report_ID == id && h.kind == k) {
-                       unsigned int newsize = h.pos + h.report_size;
-                       if (newsize > size)
-                           size = newsize;
+                       size = d->kindpos[k];
                }
        }
        hid_end_parse(d);
-
-       if (id != NO_REPORT_ID)
-               size += 8;              /* add 8 bits for the report ID */
-
-       return ((size + 7) / 8);        /* return size in bytes */
+       return ((size + 7) / 8);
 }
 
 int
-hid_locate(report_desc_t desc, unsigned int u, enum hid_kind k, hid_item_t *h)
+hid_locate(report_desc_t desc, unsigned int u, enum hid_kind k,
+          hid_item_t *h, int id)
 {
        hid_data_t d;
 
-       for (d = hid_start_parse(desc, 1<<k); hid_get_item(d, h); ) {
+       for (d = hid_start_parse(desc, 1<<k, id); hid_get_item(d, h); ) {
                if (h->kind == k && !(h->flags & HIO_CONST) && h->usage == u) {
                        hid_end_parse(d);
                        return (1);
index c5d8988..29a8ab6 100644 (file)
@@ -1,4 +1,4 @@
-/*     $NetBSD: usage.c,v 1.8 2000/10/10 19:23:58 is Exp $     */
+/* $NetBSD: usage.c,v 1.8 2000/10/10 19:23:58 is Exp $ */
 
 /*
  * Copyright (c) 1999 Lennart Augustsson <augustss@netbsd.org>
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  *
- * $FreeBSD: src/lib/libusbhid/usage.c,v 1.6.2.1 2002/04/03 15:54:00 joe Exp $
- * $DragonFly: src/lib/libusbhid/usage.c,v 1.2 2003/06/17 04:26:51 dillon Exp $
+ * $FreeBSD: src/lib/libusbhid/usage.c,v 1.8 2003/04/09 01:52:48 mdodd Exp $
+ * $DragonFly: src/lib/libusbhid/usage.c,v 1.3 2008/11/24 17:15:17 hasso Exp $
  */
 
+#include <assert.h>
 #include <ctype.h>
 #include <err.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 
-#include "libusbhid.h"
+#include "usbhid.h"
 
 #define _PATH_HIDTABLE "/usr/share/misc/usb_hid_usages"
 
@@ -96,7 +97,7 @@ hid_init(const char *hidname)
                        no = -1;
                else if (sscanf(line, " 0x%x %[^\n]", &no, name) != 2 &&
                         sscanf(line, " %d %[^\n]", &no, name) != 2)
-                       errx(1, "file %s, line %d, syntax error\n",
+                       errx(1, "file %s, line %d, syntax error",
                             hidname, lineno);
                for (p = name; *p; p++)
                        if (isspace(*p) || *p == '.')
@@ -106,7 +107,7 @@ hid_init(const char *hidname)
                        err(1, "strdup");
                if (isspace(line[0])) {
                        if (!curpage)
-                               errx(1, "file %s, line %d, syntax error\n",
+                               errx(1, "file %s, line %d, syntax error",
                                     hidname, lineno);
                        if (curpage->pagesize >= curpage->pagesizemax) {
                                curpage->pagesizemax += 10;
@@ -160,7 +161,7 @@ hid_usage_page(int i)
        int k;
 
        if (!pages)
-               errx(1, "no hid table\n");
+               errx(1, "no hid table");
 
        for (k = 0; k < npages; k++)
                if (pages[k].usage == i)
@@ -185,8 +186,9 @@ hid_usage_in_page(unsigned int u)
        for (j = 0; j < pages[k].pagesize; j++) {
                us = pages[k].page_contents[j].usage;
                if (us == -1) {
-                       sprintf(b, "%s %d",
-                           pages[k].page_contents[j].name, i);
+                       sprintf(b,
+                           fmtcheck(pages[k].page_contents[j].name, "%d"),
+                           i);
                        return b;
                }
                if (us == i)
@@ -203,7 +205,7 @@ hid_parse_usage_page(const char *name)
        int k;
 
        if (!pages)
-               errx(1, "no hid table\n");
+               errx(1, "no hid table");
 
        for (k = 0; k < npages; k++)
                if (strcmp(pages[k].name, name) == 0)
@@ -215,10 +217,11 @@ hid_parse_usage_page(const char *name)
 int
 hid_parse_usage_in_page(const char *name)
 {
-       const char *sep = strchr(name, ':');
+       const char *sep;
        int k, j;
        unsigned int l;
 
+       sep = strchr(name, ':');
        if (sep == NULL)
                return -1;
        l = sep - name;
index b7402ad..53c806d 100644 (file)
@@ -1,8 +1,6 @@
 .\"    $NetBSD: usb.3,v 1.13 2000/09/24 02:17:52 augustss Exp $
-.\"    $FreeBSD: src/lib/libusbhid/usbhid.3,v 1.11.2.1 2002/04/03 15:54:00 joe Exp $
-.\"    $DragonFly: src/lib/libusbhid/usbhid.3,v 1.8 2008/09/07 08:21:57 swildner Exp $
 .\"
-.\" Copyright (c) 1999 Lennart Augustsson <augustss@netbsd.org>
+.\" Copyright (c) 1999, 2001 Lennart Augustsson <augustss@NetBSD.org>
 .\" All rights reserved.
 .\"
 .\" Redistribution and use in source and binary forms, with or without
 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 .\" SUCH DAMAGE.
 .\"
-.Dd May 11, 1999
+.\" $FreeBSD: src/lib/libusbhid/usbhid.3,v 1.18 2005/11/24 11:26:36 ru Exp $
+.\" $DragonFly: src/lib/libusbhid/usbhid.3,v 1.9 2008/11/24 17:15:17 hasso Exp $
+.\"
+.Dd December 29, 2001
 .Dt USBHID 3
 .Os
 .Sh NAME
@@ -41,8 +42,6 @@
 .Nm hid_locate ,
 .Nm hid_usage_page ,
 .Nm hid_usage_in_page ,
-.Nm hid_parse_usage_page ,
-.Nm hid_parse_usage_in_page ,
 .Nm hid_init ,
 .Nm hid_get_data ,
 .Nm hid_set_data
@@ -50,7 +49,7 @@
 .Sh LIBRARY
 .Lb libusbhid
 .Sh SYNOPSIS
-.In libusbhid.h
+.In usbhid.h
 .Ft report_desc_t
 .Fn hid_get_report_desc "int file"
 .Ft report_desc_t
 .Ft void
 .Fn hid_dispose_report_desc "report_desc_t d"
 .Ft hid_data_t
-.Fn hid_start_parse "report_desc_t d" "int kindset"
+.Fn hid_start_parse "report_desc_t d" "int kindset" "int id"
 .Ft void
 .Fn hid_end_parse "hid_data_t s"
 .Ft int
 .Fn hid_get_item "hid_data_t s" "hid_item_t *h"
 .Ft int
-.Fn hid_report_size "report_desc_t d" "unsigned int id" "hid_kind_t k"
+.Fn hid_report_size "report_desc_t d" "hid_kind_t k" "int id"
 .Ft int
-.Fn hid_locate "report_desc_t d" "unsigned int usage" "hid_kind_t k" "hid_item_t *h"
-.Ft const char *
+.Fn hid_locate "report_desc_t d" "u_int usage" "hid_kind_t k" "hid_item_t *h" "int id"
+.Ft "const char *"
 .Fn hid_usage_page "int i"
-.Ft const char *
-.Fn hid_usage_in_page "unsigned int u"
+.Ft "const char *"
+.Fn hid_usage_in_page "u_int u"
 .Ft int
-.Fn hid_parse_usage_page "const char *name"
+.Fn hid_parse_usage_page "const char *"
 .Ft int
-.Fn hid_parse_usage_in_page "const char *name"
+.Fn hid_parse_usage_in_page "const char *"
 .Ft void
 .Fn hid_init "const char *file"
 .Ft int
 .Fn hid_get_data "const void *data" "const hid_item_t *h"
 .Ft void
-.Fn hid_set_data "void *p" "const hid_item_t *h" "int data"
+.Fn hid_set_data "void *buf" "const hid_item_t *h" "int data"
 .Sh DESCRIPTION
 The
 .Nm
 library provides routines to extract data from USB Human Interface Devices.
-.Ss INTRODUCTION
-USB HID devices send and receive data laid out in a device dependent
-way.  The
+.Ss Introduction
+USB HID devices send and receive data layed out in a device dependent way.
+The
 .Nm
 library contains routines to extract the
-.Em report descriptor
+.Em "report descriptor"
 which contains the data layout information and then use this information.
 .Pp
 The routines can be divided into four parts: extraction of the descriptor,
 parsing of the descriptor, translating to/from symbolic names, and
 data manipulation.
-.Ss DESCRIPTOR FUNCTIONS
+.Ss Descriptor Functions
 A report descriptor can be obtained by calling
 .Fn hid_get_report_desc
 with a file descriptor obtained by opening a
 .Xr uhid 4
-device. Alternatively a data buffer containing the report descriptor can be
+device.
+Alternatively a data buffer containing the report descriptor can be
 passed into
 .Fn hid_use_report_desc .
-The data is copied into an internal structure. When the report descriptor
+The data is copied into an internal structure.
+When the report descriptor
 is no longer needed it should be freed by calling
 .Fn hid_dispose_report_desc .
 The type
-.Fa report_desc_t
+.Vt report_desc_t
 is opaque and should be used when calling the parsing functions.
 If
 .Fn hid_dispose_report_desc
 fails it will return
-.Fa NULL .
-.Ss DESCRIPTOR PARSING FUNCTIONS
+.Dv NULL .
+.Ss Descriptor Parsing Functions
 To parse the report descriptor the
 .Fn hid_start_parse
 function should be called with a report descriptor and a set that
-describes which items that are interesting.  The set is obtained
-by or-ing together values
+describes which items that are interesting.
+The set is obtained by OR-ing together values
 .Fa "(1 << k)"
 where
 .Fa k
 is an item of type
-.Fa hid_kind_t .
+.Vt hid_kind_t .
+The report ID (if present) is given by
+.Fa id .
 The function returns
-.Fa NULL
+.Dv NULL
 if the initialization fails, otherwise an opaque value to be used
 in subsequent calls.
 After parsing the
@@ -143,23 +146,26 @@ The struct pointed to by
 .Fa h
 will be filled with the relevant data for the item.
 The definition of
-.Fa hid_item_t
+.Vt hid_item_t
 can be found in
-.In libusbhid.h
+.In usbhid.h
 and the meaning of the components in the USB HID documentation.
 .Pp
 Data should be read/written to the device in the size of
-the report.  The size of a report (of a certain kind) can be
-computed by the
+the report.
+The size of a report (of a certain kind) can be computed by the
 .Fn hid_report_size
 function.
+If the report is prefixed by an ID byte it is given by
+.Fa id .
 .Pp
 To locate a single item the
 .Fn hid_locate
-function can be used.  It should be given the usage code of
+function can be used.
+It should be given the usage code of
 the item and its kind and it will fill the item and return
 non-zero if the item was found.
-.Ss NAME TRANSLATION FUNCTIONS
+.Ss Name Translation Functions
 The function
 .Fn hid_usage_page
 will return the symbolic name of a usage page, and the function
@@ -175,16 +181,17 @@ are the inverses of
 .Fn hid_usage_page
 and
 .Fn hid_usage_in_page .
-They take a usage string and return the number of the usage, or -1
+They take a usage string and return the number of the usage, or \-1
 if it cannot be found.
 .Pp
 Before any of these functions can be called the usage table
 must be parsed, this is done by calling
 .Fn hid_init
-with the name of the table.  Passing
-.Fa NULL
+with the name of the table.
+Passing
+.Dv NULL
 to this function will cause it to use the default table.
-.Ss DATA EXTRACTION FUNCTIONS
+.Ss Data Extraction Functions
 Given the data obtained from a HID device and an item in the
 report descriptor the
 .Fn hid_get_data
@@ -193,15 +200,17 @@ Conversely
 .Fn hid_set_data
 can be used to put data into a report (which must be zeroed first).
 .Sh FILES
-.Pa /usr/share/misc/usb_hid_usages
+.Bl -tag -width ".Pa /usr/share/misc/usb_hid_usages"
+.It Pa /usr/share/misc/usb_hid_usages
 The default HID usage table.
+.El
 .Sh EXAMPLES
 Not yet.
 .Sh SEE ALSO
 The
 .Tn USB
 specifications can be found at
-.Pa http://www.usb.org/developers/docs.htm .
+.Pa http://www.usb.org/developers/docs/ .
 .Pp
 .Xr uhid 4 ,
 .Xr usb 4
similarity index 87%
rename from lib/libusbhid/libusbhid.h
rename to lib/libusbhid/usbhid.h
index b371e68..f87af45 100644 (file)
@@ -25,9 +25,8 @@
  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  * SUCH DAMAGE.
  *
- * $FreeBSD: src/lib/libusbhid/libusbhid.h,v 1.7.2.1 2002/04/03 15:54:00 joe Exp $
- * $DragonFly: src/lib/libusbhid/Attic/libusbhid.h,v 1.2 2003/06/17 04:26:51 dillon Exp $
- *
+ * $FreeBSD: src/lib/libusbhid/usbhid.h,v 1.11 2004/06/03 15:04:24 des Exp $
+ * $DragonFly: src/lib/libusbhid/usbhid.h,v 1.1 2008/11/24 17:15:17 hasso Exp $
  */
 
 #include <sys/cdefs.h>
@@ -37,12 +36,16 @@ typedef struct report_desc *report_desc_t;
 typedef struct hid_data *hid_data_t;
 
 typedef enum hid_kind {
-       hid_input, hid_output, hid_feature, hid_collection, hid_endcollection
+       hid_input = 0,
+       hid_output = 1,
+       hid_feature = 2,
+       hid_collection,
+       hid_endcollection
 } hid_kind_t;
 
 typedef struct hid_item {
        /* Global */
-       int _usage_page;
+       unsigned int _usage_page;
        int logical_minimum;
        int logical_maximum;
        int physical_minimum;
@@ -78,25 +81,29 @@ typedef struct hid_item {
 #define HID_PAGE(u) (((u) >> 16) & 0xffff)
 #define HID_USAGE(u) ((u) & 0xffff)
 
+__BEGIN_DECLS
+
 /* Obtaining a report descriptor, descr.c: */
 report_desc_t hid_get_report_desc(int file);
 report_desc_t hid_use_report_desc(unsigned char *data, unsigned int size);
 void hid_dispose_report_desc(report_desc_t);
 
 /* Parsing of a HID report descriptor, parse.c: */
-hid_data_t hid_start_parse(report_desc_t d, int kindset);
+hid_data_t hid_start_parse(report_desc_t d, int kindset, int id);
 void hid_end_parse(hid_data_t s);
 int hid_get_item(hid_data_t s, hid_item_t *h);
-int hid_report_size(report_desc_t d, unsigned int id, enum hid_kind k);
-int hid_locate(report_desc_t d, unsigned int usage, enum hid_kind k, hid_item_t *h);
+int hid_report_size(report_desc_t d, enum hid_kind k, int id);
+int hid_locate(report_desc_t d, unsigned int usage, enum hid_kind k, hid_item_t *h, int id);
 
 /* Conversion to/from usage names, usage.c: */
-int hid_parse_usage_page(const char *name);
-int hid_parse_usage_in_page(const char *name);
 const char *hid_usage_page(int i);
 const char *hid_usage_in_page(unsigned int u);
 void hid_init(const char *file);
+int hid_parse_usage_in_page(const char *name);
+int hid_parse_usage_page(const char *name);
 
 /* Extracting/insertion of data, data.c: */
 int hid_get_data(const void *p, const hid_item_t *h);
 void hid_set_data(void *p, const hid_item_t *h, int data);
+
+__END_DECLS
index ada93e7..56a5968 100644 (file)
@@ -1,6 +1,6 @@
-/*     $NetBSD: usbhid.c,v 1.14 2000/07/03 02:51:37 matt Exp $ */
-/*     $FreeBSD: src/usr.bin/usbhidctl/usbhid.c,v 1.6.2.1 2002/04/03 16:48:25 joe Exp $ */
-/*     $DragonFly: src/usr.bin/usbhidctl/usbhid.c,v 1.3 2003/08/08 04:18:44 dillon Exp $ */
+/* $NetBSD: usbhid.c,v 1.14 2000/07/03 02:51:37 matt Exp $ */
+/* $FreeBSD: src/usr.bin/usbhidctl/usbhid.c,v 1.12 2007/12/21 03:40:36 imp Exp $ */
+/* $DragonFly: src/usr.bin/usbhidctl/usbhid.c,v 1.4 2008/11/24 17:15:17 hasso Exp $ */
 
 /*
  * Copyright (c) 1998 The NetBSD Foundation, Inc.
 #include <err.h>
 #include <ctype.h>
 #include <errno.h>
-#include <libusbhid.h>
+#include <usbhid.h>
 #include <bus/usb/usb.h>
 #include <bus/usb/usbhid.h>
 
 int verbose = 0;
 int all = 0;
 int noname = 0;
+int hexdump = 0;
+static int reportid;
 
 char **names;
 int nnames;
@@ -94,8 +96,14 @@ usage(void)
 {
        extern char *__progname;
 
-       fprintf(stderr, "Usage: %s -f device [-l] [-n] [-r] [-t tablefile] [-v] name ...\n", __progname);
-       fprintf(stderr, "       %s -f device [-l] [-n] [-r] [-t tablefile] [-v] -a\n", __progname);
+       fprintf(stderr,
+                "usage: %s -f device "
+                "[-l] [-n] [-r] [-t tablefile] [-v] [-x] name ...\n",
+                __progname);
+       fprintf(stderr,
+                "       %s -f device "
+                "[-l] [-n] [-r] [-t tablefile] [-v] [-x] -a\n",
+                __progname);
        exit(1);
 }
 
@@ -105,8 +113,8 @@ dumpitem(const char *label, struct hid_item *h)
        if ((h->flags & HIO_CONST) && !verbose)
                return;
        printf("%s size=%d count=%d page=%s usage=%s%s", label,
-              h->report_size, h->report_count, 
-              hid_usage_page(HID_PAGE(h->usage)), 
+              h->report_size, h->report_count,
+              hid_usage_page(HID_PAGE(h->usage)),
               hid_usage_in_page(h->usage),
               h->flags & HIO_CONST ? " Const" : "");
        printf(", logical range %d..%d",
@@ -126,11 +134,11 @@ dumpitems(report_desc_t r)
        struct hid_item h;
        int size;
 
-       for (d = hid_start_parse(r, ~0); hid_get_item(d, &h); ) {
+       for (d = hid_start_parse(r, ~0, reportid); hid_get_item(d, &h); ) {
                switch (h.kind) {
                case hid_collection:
                        printf("Collection page=%s usage=%s\n",
-                              hid_usage_page(HID_PAGE(h.usage)), 
+                              hid_usage_page(HID_PAGE(h.usage)),
                               hid_usage_in_page(h.usage));
                        break;
                case hid_endcollection:
@@ -148,13 +156,13 @@ dumpitems(report_desc_t r)
                }
        }
        hid_end_parse(d);
-       size = hid_report_size(r, 0, hid_input);
+       size = hid_report_size(r, hid_input, 0);
        printf("Total   input size %d bytes\n", size);
 
-       size = hid_report_size(r, 0, hid_output);
+       size = hid_report_size(r, hid_output, 0);
        printf("Total  output size %d bytes\n", size);
 
-       size = hid_report_size(r, 0, hid_feature);
+       size = hid_report_size(r, hid_feature, 0);
        printf("Total feature size %d bytes\n", size);
 }
 
@@ -187,6 +195,8 @@ prdata(u_char *buf, struct hid_item *h)
                        printf("%d", (int)data);
                else
                        printf("%u", data);
+                if (hexdump)
+                       printf(" [0x%x]", data);
                pos += h->report_size;
        }
 }
@@ -201,11 +211,10 @@ dumpdata(int f, report_desc_t rd, int loop)
        static int one = 1;
        u_int32_t colls[100];
        int sp = 0;
-       int report_id;
        char namebuf[10000], *namep;
 
        hids = 0;
-       for (d = hid_start_parse(rd, 1<<hid_input); 
+       for (d = hid_start_parse(rd, 1<<hid_input, reportid);
             hid_get_item(d, &h); ) {
                if (h.kind == hid_collection)
                        colls[++sp] = h.usage;
@@ -220,7 +229,7 @@ dumpdata(int f, report_desc_t rd, int loop)
        }
        hid_end_parse(d);
        rev(&hids);
-       dlen = hid_report_size(rd, 0, hid_input);
+       dlen = hid_report_size(rd, hid_input, 0);
        dbuf = malloc(dlen);
        if (!loop)
                if (ioctl(f, USB_SET_IMMED, &one) < 0) {
@@ -245,7 +254,7 @@ dumpdata(int f, report_desc_t rd, int loop)
                        if (all || gotname(namebuf)) {
                                if (!noname)
                                        printf("%s=", namebuf);
-                               prdata(dbuf + (report_id != 0), n);
+                               prdata(dbuf + (reportid != 0), n);
                                printf("\n");
                        }
                }
@@ -266,7 +275,7 @@ main(int argc, char **argv)
        int loop = 0;
        char *table = 0;
 
-       while ((ch = getopt(argc, argv, "af:lnrt:v")) != -1) {
+       while ((ch = getopt(argc, argv, "af:lnrt:vx")) != -1) {
                switch(ch) {
                case 'a':
                        all++;
@@ -289,6 +298,9 @@ main(int argc, char **argv)
                case 'v':
                        verbose++;
                        break;
+               case 'x':
+                       hexdump = 1;
+                       break;
                case '?':
                default:
                        usage();
@@ -319,9 +331,9 @@ main(int argc, char **argv)
                err(1, "%s", dev);
 
        r = hid_get_report_desc(f);
-       if (r == 0) 
+       if (r == 0)
                errx(1, "USB_GET_REPORT_DESC");
-              
+
        if (repdump) {
                printf("Report descriptor:\n");
                dumpitems(r);
index 2407c79..2d62fe2 100644 (file)
@@ -1,6 +1,6 @@
 .\" $NetBSD: usbhidctl.1,v 1.8 1999/05/11 21:03:58 augustss Exp $
-.\" $FreeBSD: src/usr.bin/usbhidctl/usbhidctl.1,v 1.2.2.2 2002/06/21 15:29:59 charnier Exp $
-.\" $DragonFly: src/usr.bin/usbhidctl/usbhidctl.1,v 1.4 2006/02/17 19:39:14 swildner Exp $
+.\" $FreeBSD: src/usr.bin/usbhidctl/usbhidctl.1,v 1.7 2006/11/23 05:08:06 grog Exp $
+.\" $DragonFly: src/usr.bin/usbhidctl/usbhidctl.1,v 1.5 2008/11/24 17:15:17 hasso Exp $
 .\"
 .\" Copyright (c) 1998 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -36,7 +36,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd July 12, 1998
+.Dd November 23, 2006
 .Dt USBHIDCTL 1
 .Os
 .Sh NAME
@@ -51,6 +51,7 @@
 .Op Fl r
 .Op Fl t Ar table
 .Op Fl v
+.Op Fl x
 .Op Ar item ...
 .Sh DESCRIPTION
 The
@@ -76,11 +77,14 @@ Dump the report descriptor.
 Specify a path name for the HID usage table file.
 .It Fl v
 Be verbose.
+.It Fl x
+Dump data in hexadecimal as well as decimal.
 .El
 .Sh FILES
 .Pa /usr/share/misc/usb_hid_usages
 The default HID usage table.
 .Sh SEE ALSO
+.Xr usbhid 3 ,
 .Xr uhid 4 ,
 .Xr usb 4
 .Sh HISTORY