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 */
75 /*------------------------------------------------------------------------*
77 *------------------------------------------------------------------------*/
79 hid_clear_local(hid_item_t *c)
85 c->designator_index = 0;
86 c->designator_minimum = 0;
87 c->designator_maximum = 0;
89 c->string_minimum = 0;
90 c->string_maximum = 0;
95 hid_switch_rid(struct hid_data *s, struct hid_item *c, int32_t next_rID)
99 /* check for same report ID - optimise */
101 if (c->report_ID == next_rID)
104 /* save current position for current rID */
106 if (c->report_ID == 0) {
109 for (i = 1; i != MAXID; i++) {
110 if (s->last_pos[i].rid == c->report_ID)
112 if (s->last_pos[i].rid == 0)
117 s->last_pos[i].rid = c->report_ID;
118 for (j = 0; j < ITEMTYPES; j++)
119 s->last_pos[i].pos[j] = s->pos[j];
122 /* store next report ID */
124 c->report_ID = next_rID;
126 /* lookup last position for next rID */
131 for (i = 1; i != MAXID; i++) {
132 if (s->last_pos[i].rid == next_rID)
134 if (s->last_pos[i].rid == 0)
139 s->last_pos[i].rid = next_rID;
140 for (j = 0; j < ITEMTYPES; j++)
141 s->pos[j] = s->last_pos[i].pos[j];
143 for (j = 0; j < ITEMTYPES; j++)
144 s->pos[j] = 0; /* Out of RID entries. */
148 /*------------------------------------------------------------------------*
150 *------------------------------------------------------------------------*/
152 hid_start_parse(report_desc_t d, int kindset, int id __unused)
156 s = malloc(sizeof *s);
157 memset(s, 0, sizeof *s);
158 s->start = s->p = d->data;
159 s->end = d->data + d->size;
160 s->kindset = kindset;
164 /*------------------------------------------------------------------------*
166 *------------------------------------------------------------------------*/
168 hid_end_parse(hid_data_t s)
177 /*------------------------------------------------------------------------*
178 * get byte from HID descriptor
179 *------------------------------------------------------------------------*/
181 hid_get_byte(struct hid_data *s, const uint16_t wSize)
188 /* check if end is reached */
192 /* read out a byte */
195 /* check if data pointer can be advanced by "wSize" bytes */
196 if ((s->end - ptr) < wSize)
207 /*------------------------------------------------------------------------*
209 *------------------------------------------------------------------------*/
211 hid_get_item(hid_data_t s, hid_item_t *h)
214 unsigned int bTag, bType, bSize;
221 c = &s->cur[s->pushlevel];
224 /* check if there is an array of items */
225 if (s->icount < s->ncount) {
226 /* get current usage */
227 if (s->iusage < s->nusage) {
228 dval = s->usages_min[s->iusage] + s->ousage;
230 s->usage_last = dval;
231 if (dval == s->usages_max[s->iusage]) {
238 /* Using last usage */
239 dval = s->usage_last;
243 * Only copy HID item, increment position and return
244 * if correct kindset!
246 if (s->kindset & (1 << c->kind)) {
248 h->pos = s->pos[c->kind];
249 s->pos[c->kind] += c->report_size * c->report_count;
254 /* reset state variables */
264 while (s->p != s->end) {
266 bSize = hid_get_byte(s, 1);
269 bSize = hid_get_byte(s, 1);
270 bSize |= hid_get_byte(s, 1) << 8;
271 bTag = hid_get_byte(s, 1);
272 bType = 0xff; /* XXX what should it be */
276 bType = (bSize >> 2) & 3;
288 dval = (int8_t)hid_get_byte(s, 1);
292 dval = hid_get_byte(s, 1);
293 dval |= hid_get_byte(s, 1) << 8;
294 dval = (int16_t)dval;
298 dval = hid_get_byte(s, 1);
299 dval |= hid_get_byte(s, 1) << 8;
300 dval |= hid_get_byte(s, 1) << 16;
301 dval |= hid_get_byte(s, 1) << 24;
305 dval = hid_get_byte(s, bSize);
316 c->report_count = s->loc_count;
317 c->report_size = s->loc_size;
319 if (c->flags & HIO_VARIABLE) {
320 /* range check usage count */
321 if (c->report_count > 255) {
324 s->ncount = c->report_count;
327 * The "top" loop will return
331 c->usage_minimum = 0;
332 c->usage_maximum = 0;
339 c->kind = hid_output;
342 case 10: /* Collection */
343 c->kind = hid_collection;
344 c->collection = dval;
346 c->usage = s->usage_last;
349 case 11: /* Feature */
350 c->kind = hid_feature;
353 case 12: /* End collection */
354 c->kind = hid_endcollection;
355 if (c->collevel == 0) {
356 /* Invalid end collection. */
370 c->_usage_page = dval << 16;
373 c->logical_minimum = dval;
376 c->logical_maximum = dval;
379 c->physical_minimum = dval;
382 c->physical_maximum = dval;
385 c->unit_exponent = dval;
391 /* mask because value is unsigned */
392 s->loc_size = dval & mask;
395 hid_switch_rid(s, c, dval & mask);
398 /* mask because value is unsigned */
399 s->loc_count = dval & mask;
403 if (s->pushlevel < MAXPUSH) {
404 s->cur[s->pushlevel] = *c;
405 /* store size and count */
406 c->report_size = s->loc_size;
407 c->report_count = s->loc_count;
408 /* update current item pointer */
409 c = &s->cur[s->pushlevel];
414 if (s->pushlevel < MAXPUSH) {
415 c = &s->cur[s->pushlevel];
416 /* restore size and count */
417 s->loc_size = c->report_size;
418 s->loc_count = c->report_count;
431 dval = (dval & mask) | c->_usage_page;
433 /* set last usage, in case of a collection */
434 s->usage_last = dval;
436 if (s->nusage < MAXUSAGE) {
437 s->usages_min[s->nusage] = dval;
438 s->usages_max[s->nusage] = dval;
443 /* clear any pending usage sets */
450 dval = (dval & mask) | c->_usage_page;
451 c->usage_minimum = dval;
458 dval = (dval & mask) | c->_usage_page;
459 c->usage_maximum = dval;
466 if ((s->nusage < MAXUSAGE) &&
467 (c->usage_minimum <= c->usage_maximum)) {
468 /* add usage range */
469 s->usages_min[s->nusage] =
471 s->usages_max[s->nusage] =
480 c->designator_index = dval;
483 c->designator_minimum = dval;
486 c->designator_maximum = dval;
489 c->string_index = dval;
492 c->string_minimum = dval;
495 c->string_maximum = dval;
498 c->set_delimiter = dval;
512 hid_report_size(report_desc_t r, enum hid_kind k, int id)
524 memset(&h, 0, sizeof h);
525 for (d = hid_start_parse(r, 1 << k, id); hid_get_item(d, &h); ) {
526 if ((h.report_ID == id || id < 0) && h.kind == k) {
527 /* compute minimum */
530 /* compute end position */
531 temp = h.pos + (h.report_size * h.report_count);
532 /* compute maximum */
535 if (h.report_ID != 0)
541 /* safety check - can happen in case of currupt descriptors */
547 /* return length in bytes rounded up */
548 return ((temp + 7) / 8 + report_id);
552 hid_locate(report_desc_t desc, unsigned int u, enum hid_kind k,
553 hid_item_t *h, int id)
557 for (d = hid_start_parse(desc, 1 << k, id); hid_get_item(d, h); ) {
558 if (h->kind == k && !(h->flags & HIO_CONST) && h->usage == u) {