1 /* $NetBSD: parse.c,v 1.11 2000/09/24 02:19:54 augustss Exp $ */
4 * Copyright (c) 1999, 2001 Lennart Augustsson <augustss@netbsd.org>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
37 #include <dev/usb/usb.h>
38 #include <dev/usb/usbhid.h>
50 uint32_t pos[ITEMTYPES];
57 struct hid_item cur[MAXPUSH];
58 struct hid_pos_data last_pos[MAXID];
59 uint32_t pos[ITEMTYPES];
60 int32_t usages_min[MAXUSAGE];
61 int32_t usages_max[MAXUSAGE];
62 int32_t usage_last; /* last seen usage */
63 uint32_t loc_size; /* last seen size */
64 uint32_t loc_count; /* last seen count */
65 uint8_t kindset; /* we have 5 kinds so 8 bits are enough */
66 uint8_t pushlevel; /* current pushlevel */
67 uint8_t ncount; /* end usage item count */
68 uint8_t icount; /* current usage item count */
69 uint8_t nusage; /* end "usages_min/max" index */
70 uint8_t iusage; /* current "usages_min/max" index */
71 uint8_t ousage; /* current "usages_min/max" offset */
72 uint8_t susage; /* usage set flags */
73 int32_t reportid; /* requested report ID */
76 /*------------------------------------------------------------------------*
78 *------------------------------------------------------------------------*/
80 hid_clear_local(hid_item_t *c)
86 c->designator_index = 0;
87 c->designator_minimum = 0;
88 c->designator_maximum = 0;
90 c->string_minimum = 0;
91 c->string_maximum = 0;
96 hid_switch_rid(struct hid_data *s, struct hid_item *c, int32_t next_rID)
100 /* check for same report ID - optimise */
102 if (c->report_ID == next_rID)
105 /* save current position for current rID */
107 if (c->report_ID == 0) {
110 for (i = 1; i != MAXID; i++) {
111 if (s->last_pos[i].rid == c->report_ID)
113 if (s->last_pos[i].rid == 0)
118 s->last_pos[i].rid = c->report_ID;
119 for (j = 0; j < ITEMTYPES; j++)
120 s->last_pos[i].pos[j] = s->pos[j];
123 /* store next report ID */
125 c->report_ID = next_rID;
127 /* lookup last position for next rID */
132 for (i = 1; i != MAXID; i++) {
133 if (s->last_pos[i].rid == next_rID)
135 if (s->last_pos[i].rid == 0)
140 s->last_pos[i].rid = next_rID;
141 for (j = 0; j < ITEMTYPES; j++)
142 s->pos[j] = s->last_pos[i].pos[j];
144 for (j = 0; j < ITEMTYPES; j++)
145 s->pos[j] = 0; /* Out of RID entries. */
149 /*------------------------------------------------------------------------*
151 *------------------------------------------------------------------------*/
153 hid_start_parse(report_desc_t d, int kindset, int id)
157 s = malloc(sizeof *s);
158 memset(s, 0, sizeof *s);
159 s->start = s->p = d->data;
160 s->end = d->data + d->size;
161 s->kindset = kindset;
166 /*------------------------------------------------------------------------*
168 *------------------------------------------------------------------------*/
170 hid_end_parse(hid_data_t s)
179 /*------------------------------------------------------------------------*
180 * get byte from HID descriptor
181 *------------------------------------------------------------------------*/
183 hid_get_byte(struct hid_data *s, const uint16_t wSize)
190 /* check if end is reached */
194 /* read out a byte */
197 /* check if data pointer can be advanced by "wSize" bytes */
198 if ((s->end - ptr) < wSize)
209 /*------------------------------------------------------------------------*
211 *------------------------------------------------------------------------*/
213 hid_get_item_raw(hid_data_t s, hid_item_t *h)
216 unsigned int bTag, bType, bSize;
223 c = &s->cur[s->pushlevel];
226 /* check if there is an array of items */
227 if (s->icount < s->ncount) {
228 /* get current usage */
229 if (s->iusage < s->nusage) {
230 dval = s->usages_min[s->iusage] + s->ousage;
232 s->usage_last = dval;
233 if (dval == s->usages_max[s->iusage]) {
240 /* Using last usage */
241 dval = s->usage_last;
245 * Only copy HID item, increment position and return
246 * if correct kindset!
248 if (s->kindset & (1 << c->kind)) {
250 h->pos = s->pos[c->kind];
251 s->pos[c->kind] += c->report_size * c->report_count;
256 /* reset state variables */
266 while (s->p != s->end) {
268 bSize = hid_get_byte(s, 1);
271 bSize = hid_get_byte(s, 1);
272 bSize |= hid_get_byte(s, 1) << 8;
273 bTag = hid_get_byte(s, 1);
274 bType = 0xff; /* XXX what should it be */
278 bType = (bSize >> 2) & 3;
290 dval = (int8_t)hid_get_byte(s, 1);
294 dval = hid_get_byte(s, 1);
295 dval |= hid_get_byte(s, 1) << 8;
296 dval = (int16_t)dval;
300 dval = hid_get_byte(s, 1);
301 dval |= hid_get_byte(s, 1) << 8;
302 dval |= hid_get_byte(s, 1) << 16;
303 dval |= hid_get_byte(s, 1) << 24;
307 dval = hid_get_byte(s, bSize);
318 c->report_count = s->loc_count;
319 c->report_size = s->loc_size;
321 if (c->flags & HIO_VARIABLE) {
322 /* range check usage count */
323 if (c->report_count > 255) {
326 s->ncount = c->report_count;
329 * The "top" loop will return
333 c->usage_minimum = 0;
334 c->usage_maximum = 0;
341 c->kind = hid_output;
344 case 10: /* Collection */
345 c->kind = hid_collection;
346 c->collection = dval;
348 c->usage = s->usage_last;
351 case 11: /* Feature */
352 c->kind = hid_feature;
355 case 12: /* End collection */
356 c->kind = hid_endcollection;
357 if (c->collevel == 0) {
358 /* Invalid end collection. */
372 c->_usage_page = dval << 16;
375 c->logical_minimum = dval;
378 c->logical_maximum = dval;
381 c->physical_minimum = dval;
384 c->physical_maximum = dval;
387 c->unit_exponent = dval;
393 /* mask because value is unsigned */
394 s->loc_size = dval & mask;
397 hid_switch_rid(s, c, dval & mask);
400 /* mask because value is unsigned */
401 s->loc_count = dval & mask;
405 if (s->pushlevel < MAXPUSH) {
406 s->cur[s->pushlevel] = *c;
407 /* store size and count */
408 c->report_size = s->loc_size;
409 c->report_count = s->loc_count;
410 /* update current item pointer */
411 c = &s->cur[s->pushlevel];
416 if (s->pushlevel < MAXPUSH) {
417 c = &s->cur[s->pushlevel];
418 /* restore size and count */
419 s->loc_size = c->report_size;
420 s->loc_count = c->report_count;
433 dval = (dval & mask) | c->_usage_page;
435 /* set last usage, in case of a collection */
436 s->usage_last = dval;
438 if (s->nusage < MAXUSAGE) {
439 s->usages_min[s->nusage] = dval;
440 s->usages_max[s->nusage] = dval;
445 /* clear any pending usage sets */
452 dval = (dval & mask) | c->_usage_page;
453 c->usage_minimum = dval;
460 dval = (dval & mask) | c->_usage_page;
461 c->usage_maximum = dval;
468 if ((s->nusage < MAXUSAGE) &&
469 (c->usage_minimum <= c->usage_maximum)) {
470 /* add usage range */
471 s->usages_min[s->nusage] =
473 s->usages_max[s->nusage] =
482 c->designator_index = dval;
485 c->designator_minimum = dval;
488 c->designator_maximum = dval;
491 c->string_index = dval;
494 c->string_minimum = dval;
497 c->string_maximum = dval;
500 c->set_delimiter = dval;
514 hid_get_item(hid_data_t s, hid_item_t *h)
519 r = hid_get_item_raw(s, h);
520 if (r <= 0 || s->reportid == -1 || h->report_ID == s->reportid)
527 hid_report_size(report_desc_t r, enum hid_kind k, int id)
539 memset(&h, 0, sizeof h);
540 for (d = hid_start_parse(r, 1 << k, id); hid_get_item(d, &h); ) {
542 /* compute minimum */
545 /* compute end position */
546 temp = h.pos + (h.report_size * h.report_count);
547 /* compute maximum */
550 if (h.report_ID != 0)
556 /* safety check - can happen in case of currupt descriptors */
562 /* return length in bytes rounded up */
563 return ((temp + 7) / 8 + report_id);
567 hid_locate(report_desc_t desc, unsigned int u, enum hid_kind k,
568 hid_item_t *h, int id)
572 for (d = hid_start_parse(desc, 1 << k, id); hid_get_item(d, h); ) {
573 if (h->kind == k && !(h->flags & HIO_CONST) && h->usage == u) {