1 /* $NetBSD: parse.c,v 1.11 2000/09/24 02:19:54 augustss Exp $ */
4 * SPDX-License-Identifier: BSD-2-Clause-NetBSD
6 * Copyright (c) 1999, 2001 Lennart Augustsson <augustss@netbsd.org>
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
39 #include <dev/usb/usb.h>
40 #include <dev/usb/usbhid.h>
52 uint32_t pos[ITEMTYPES];
59 struct hid_item cur[MAXPUSH];
60 struct hid_pos_data last_pos[MAXID];
61 uint32_t pos[ITEMTYPES];
62 int32_t usages_min[MAXUSAGE];
63 int32_t usages_max[MAXUSAGE];
64 int32_t usage_last; /* last seen usage */
65 uint32_t loc_size; /* last seen size */
66 uint32_t loc_count; /* last seen count */
67 uint8_t kindset; /* we have 5 kinds so 8 bits are enough */
68 uint8_t pushlevel; /* current pushlevel */
69 uint8_t ncount; /* end usage item count */
70 uint8_t icount; /* current usage item count */
71 uint8_t nusage; /* end "usages_min/max" index */
72 uint8_t iusage; /* current "usages_min/max" index */
73 uint8_t ousage; /* current "usages_min/max" offset */
74 uint8_t susage; /* usage set flags */
75 int32_t reportid; /* requested report ID */
78 /*------------------------------------------------------------------------*
80 *------------------------------------------------------------------------*/
82 hid_clear_local(hid_item_t *c)
88 c->designator_index = 0;
89 c->designator_minimum = 0;
90 c->designator_maximum = 0;
92 c->string_minimum = 0;
93 c->string_maximum = 0;
98 hid_switch_rid(struct hid_data *s, struct hid_item *c, int32_t next_rID)
102 /* check for same report ID - optimise */
104 if (c->report_ID == next_rID)
107 /* save current position for current rID */
109 if (c->report_ID == 0) {
112 for (i = 1; i != MAXID; i++) {
113 if (s->last_pos[i].rid == c->report_ID)
115 if (s->last_pos[i].rid == 0)
120 s->last_pos[i].rid = c->report_ID;
121 for (j = 0; j < ITEMTYPES; j++)
122 s->last_pos[i].pos[j] = s->pos[j];
125 /* store next report ID */
127 c->report_ID = next_rID;
129 /* lookup last position for next rID */
134 for (i = 1; i != MAXID; i++) {
135 if (s->last_pos[i].rid == next_rID)
137 if (s->last_pos[i].rid == 0)
142 s->last_pos[i].rid = next_rID;
143 for (j = 0; j < ITEMTYPES; j++)
144 s->pos[j] = s->last_pos[i].pos[j];
146 for (j = 0; j < ITEMTYPES; j++)
147 s->pos[j] = 0; /* Out of RID entries. */
151 /*------------------------------------------------------------------------*
153 *------------------------------------------------------------------------*/
155 hid_start_parse(report_desc_t d, int kindset, int id)
159 s = malloc(sizeof *s);
160 memset(s, 0, sizeof *s);
161 s->start = s->p = d->data;
162 s->end = d->data + d->size;
163 s->kindset = kindset;
168 /*------------------------------------------------------------------------*
170 *------------------------------------------------------------------------*/
172 hid_end_parse(hid_data_t s)
181 /*------------------------------------------------------------------------*
182 * get byte from HID descriptor
183 *------------------------------------------------------------------------*/
185 hid_get_byte(struct hid_data *s, const uint16_t wSize)
192 /* check if end is reached */
196 /* read out a byte */
199 /* check if data pointer can be advanced by "wSize" bytes */
200 if ((s->end - ptr) < wSize)
211 /*------------------------------------------------------------------------*
213 *------------------------------------------------------------------------*/
215 hid_get_item_raw(hid_data_t s, hid_item_t *h)
218 unsigned int bTag, bType, bSize;
225 c = &s->cur[s->pushlevel];
228 /* check if there is an array of items */
229 if (s->icount < s->ncount) {
230 /* get current usage */
231 if (s->iusage < s->nusage) {
232 dval = s->usages_min[s->iusage] + s->ousage;
234 s->usage_last = dval;
235 if (dval == s->usages_max[s->iusage]) {
242 /* Using last usage */
243 dval = s->usage_last;
247 * Only copy HID item, increment position and return
248 * if correct kindset!
250 if (s->kindset & (1 << c->kind)) {
252 h->pos = s->pos[c->kind];
253 s->pos[c->kind] += c->report_size * c->report_count;
258 /* reset state variables */
268 while (s->p != s->end) {
270 bSize = hid_get_byte(s, 1);
273 bSize = hid_get_byte(s, 1);
274 bSize |= hid_get_byte(s, 1) << 8;
275 bTag = hid_get_byte(s, 1);
276 bType = 0xff; /* XXX what should it be */
280 bType = (bSize >> 2) & 3;
292 dval = (int8_t)hid_get_byte(s, 1);
296 dval = hid_get_byte(s, 1);
297 dval |= hid_get_byte(s, 1) << 8;
298 dval = (int16_t)dval;
302 dval = hid_get_byte(s, 1);
303 dval |= hid_get_byte(s, 1) << 8;
304 dval |= hid_get_byte(s, 1) << 16;
305 dval |= hid_get_byte(s, 1) << 24;
309 dval = hid_get_byte(s, bSize);
320 c->report_count = s->loc_count;
321 c->report_size = s->loc_size;
323 if (c->flags & HIO_VARIABLE) {
324 /* range check usage count */
325 if (c->report_count > 255) {
328 s->ncount = c->report_count;
331 * The "top" loop will return
335 c->usage_minimum = 0;
336 c->usage_maximum = 0;
343 c->kind = hid_output;
346 case 10: /* Collection */
347 c->kind = hid_collection;
348 c->collection = dval;
350 c->usage = s->usage_last;
353 case 11: /* Feature */
354 c->kind = hid_feature;
357 case 12: /* End collection */
358 c->kind = hid_endcollection;
359 if (c->collevel == 0) {
360 /* Invalid end collection. */
374 c->_usage_page = dval << 16;
377 c->logical_minimum = dval;
380 c->logical_maximum = dval;
383 c->physical_minimum = dval;
386 c->physical_maximum = dval;
389 c->unit_exponent = dval;
395 /* mask because value is unsigned */
396 s->loc_size = dval & mask;
399 hid_switch_rid(s, c, dval & mask);
402 /* mask because value is unsigned */
403 s->loc_count = dval & mask;
407 if (s->pushlevel < MAXPUSH) {
408 s->cur[s->pushlevel] = *c;
409 /* store size and count */
410 c->report_size = s->loc_size;
411 c->report_count = s->loc_count;
412 /* update current item pointer */
413 c = &s->cur[s->pushlevel];
418 if (s->pushlevel < MAXPUSH) {
419 c = &s->cur[s->pushlevel];
420 /* restore size and count */
421 s->loc_size = c->report_size;
422 s->loc_count = c->report_count;
435 dval = (dval & mask) | c->_usage_page;
437 /* set last usage, in case of a collection */
438 s->usage_last = dval;
440 if (s->nusage < MAXUSAGE) {
441 s->usages_min[s->nusage] = dval;
442 s->usages_max[s->nusage] = dval;
447 /* clear any pending usage sets */
454 dval = (dval & mask) | c->_usage_page;
455 c->usage_minimum = dval;
462 dval = (dval & mask) | c->_usage_page;
463 c->usage_maximum = dval;
470 if ((s->nusage < MAXUSAGE) &&
471 (c->usage_minimum <= c->usage_maximum)) {
472 /* add usage range */
473 s->usages_min[s->nusage] =
475 s->usages_max[s->nusage] =
484 c->designator_index = dval;
487 c->designator_minimum = dval;
490 c->designator_maximum = dval;
493 c->string_index = dval;
496 c->string_minimum = dval;
499 c->string_maximum = dval;
502 c->set_delimiter = dval;
516 hid_get_item(hid_data_t s, hid_item_t *h)
521 r = hid_get_item_raw(s, h);
522 if (r <= 0 || s->reportid == -1 || h->report_ID == s->reportid)
529 hid_report_size(report_desc_t r, enum hid_kind k, int id)
541 memset(&h, 0, sizeof h);
542 for (d = hid_start_parse(r, 1 << k, id); hid_get_item(d, &h); ) {
544 /* compute minimum */
547 /* compute end position */
548 temp = h.pos + (h.report_size * h.report_count);
549 /* compute maximum */
552 if (h.report_ID != 0)
558 /* safety check - can happen in case of currupt descriptors */
564 /* return length in bytes rounded up */
565 return ((temp + 7) / 8 + report_id);
569 hid_locate(report_desc_t desc, unsigned int u, enum hid_kind k,
570 hid_item_t *h, int id)
574 for (d = hid_start_parse(desc, 1 << k, id); hid_get_item(d, h); ) {
575 if (h->kind == k && !(h->flags & HIO_CONST) && h->usage == u) {