parse.c revision 67217
167217Sn_hibma/* $NetBSD: parse.c,v 1.11 2000/09/24 02:19:54 augustss Exp $ */ 261560Sn_hibma 361560Sn_hibma/* 461560Sn_hibma * Copyright (c) 1999 Lennart Augustsson <augustss@netbsd.org> 561560Sn_hibma * All rights reserved. 661560Sn_hibma * 761560Sn_hibma * Redistribution and use in source and binary forms, with or without 861560Sn_hibma * modification, are permitted provided that the following conditions 961560Sn_hibma * are met: 1061560Sn_hibma * 1. Redistributions of source code must retain the above copyright 1161560Sn_hibma * notice, this list of conditions and the following disclaimer. 1261560Sn_hibma * 2. Redistributions in binary form must reproduce the above copyright 1361560Sn_hibma * notice, this list of conditions and the following disclaimer in the 1461560Sn_hibma * documentation and/or other materials provided with the distribution. 1561560Sn_hibma * 1661560Sn_hibma * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1761560Sn_hibma * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1861560Sn_hibma * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1961560Sn_hibma * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 2061560Sn_hibma * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2161560Sn_hibma * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2261560Sn_hibma * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2361560Sn_hibma * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2461560Sn_hibma * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2561560Sn_hibma * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2661560Sn_hibma * SUCH DAMAGE. 2761560Sn_hibma * 2861560Sn_hibma * $FreeBSD: head/lib/libusbhid/parse.c 67217 2000-10-16 18:13:59Z n_hibma $ 2961560Sn_hibma * 3061560Sn_hibma */ 3161560Sn_hibma 3261560Sn_hibma#include <assert.h> 3361560Sn_hibma#include <stdlib.h> 3461560Sn_hibma#include <string.h> 3561560Sn_hibma#include <sys/time.h> 3661560Sn_hibma 3761560Sn_hibma#include <dev/usb/usb.h> 3861560Sn_hibma#include <dev/usb/usbhid.h> 3961560Sn_hibma 4061560Sn_hibma#include "libusb.h" 4161560Sn_hibma#include "usbvar.h" 4261560Sn_hibma 4361560Sn_hibma#define MAXUSAGE 100 4461560Sn_hibmastruct hid_data { 4561560Sn_hibma u_char *start; 4661560Sn_hibma u_char *end; 4761560Sn_hibma u_char *p; 4861560Sn_hibma hid_item_t cur; 4961560Sn_hibma unsigned int usages[MAXUSAGE]; 5061560Sn_hibma int nusage; 5161560Sn_hibma int minset; 5261560Sn_hibma int multi; 5361560Sn_hibma int multimax; 5461560Sn_hibma int kindset; 5567217Sn_hibma 5667217Sn_hibma /* Absolute data position (bits) for input/output/feature. 5767217Sn_hibma Assumes that hid_input, hid_output and hid_feature have 5867217Sn_hibma values 0, 1 and 2. */ 5967217Sn_hibma unsigned int kindpos[3]; 6061560Sn_hibma}; 6161560Sn_hibma 6261560Sn_hibmastatic int min(int x, int y) { return x < y ? x : y; } 6361560Sn_hibma 6461560Sn_hibmastatic void 6561560Sn_hibmahid_clear_local(hid_item_t *c) 6661560Sn_hibma{ 6761560Sn_hibma c->usage = 0; 6861560Sn_hibma c->usage_minimum = 0; 6961560Sn_hibma c->usage_maximum = 0; 7061560Sn_hibma c->designator_index = 0; 7161560Sn_hibma c->designator_minimum = 0; 7261560Sn_hibma c->designator_maximum = 0; 7361560Sn_hibma c->string_index = 0; 7461560Sn_hibma c->string_minimum = 0; 7561560Sn_hibma c->string_maximum = 0; 7661560Sn_hibma c->set_delimiter = 0; 7761560Sn_hibma} 7861560Sn_hibma 7961560Sn_hibmahid_data_t 8061560Sn_hibmahid_start_parse(report_desc_t d, int kindset) 8161560Sn_hibma{ 8261560Sn_hibma struct hid_data *s; 8361560Sn_hibma 8461560Sn_hibma s = malloc(sizeof *s); 8561560Sn_hibma memset(s, 0, sizeof *s); 8661560Sn_hibma s->start = s->p = d->data; 8761560Sn_hibma s->end = d->data + d->size; 8861560Sn_hibma s->kindset = kindset; 8961560Sn_hibma return (s); 9061560Sn_hibma} 9161560Sn_hibma 9261560Sn_hibmavoid 9361560Sn_hibmahid_end_parse(hid_data_t s) 9461560Sn_hibma{ 9561560Sn_hibma while (s->cur.next) { 9661560Sn_hibma hid_item_t *hi = s->cur.next->next; 9761560Sn_hibma free(s->cur.next); 9861560Sn_hibma s->cur.next = hi; 9961560Sn_hibma } 10061560Sn_hibma free(s); 10161560Sn_hibma} 10261560Sn_hibma 10361560Sn_hibmaint 10461560Sn_hibmahid_get_item(hid_data_t s, hid_item_t *h) 10561560Sn_hibma{ 10661560Sn_hibma hid_item_t *c; 10767217Sn_hibma unsigned int bTag = 0, bType = 0, bSize; 10861560Sn_hibma unsigned char *data; 10961560Sn_hibma int dval; 11061560Sn_hibma unsigned char *p; 11161560Sn_hibma hid_item_t *hi; 11261560Sn_hibma int i; 11367217Sn_hibma hid_kind_t retkind; 11461560Sn_hibma 11561560Sn_hibma c = &s->cur; 11661560Sn_hibma 11761560Sn_hibma top: 11861560Sn_hibma if (s->multimax) { 11961560Sn_hibma if (s->multi < s->multimax) { 12061560Sn_hibma c->usage = s->usages[min(s->multi, s->nusage-1)]; 12161560Sn_hibma s->multi++; 12261560Sn_hibma *h = *c; 12367217Sn_hibma 12467217Sn_hibma /* 'multimax' is only non-zero if the current 12567217Sn_hibma item kind is input/output/feature */ 12667217Sn_hibma h->pos = s->kindpos[c->kind]; 12767217Sn_hibma s->kindpos[c->kind] += c->report_size; 12861560Sn_hibma h->next = 0; 12961560Sn_hibma return (1); 13061560Sn_hibma } else { 13161560Sn_hibma c->report_count = s->multimax; 13261560Sn_hibma s->multimax = 0; 13361560Sn_hibma s->nusage = 0; 13461560Sn_hibma hid_clear_local(c); 13561560Sn_hibma } 13661560Sn_hibma } 13761560Sn_hibma for (;;) { 13861560Sn_hibma p = s->p; 13961560Sn_hibma if (p >= s->end) 14061560Sn_hibma return (0); 14161560Sn_hibma 14261560Sn_hibma bSize = *p++; 14361560Sn_hibma if (bSize == 0xfe) { 14461560Sn_hibma /* long item */ 14561560Sn_hibma bSize = *p++; 14661560Sn_hibma bSize |= *p++ << 8; 14761560Sn_hibma bTag = *p++; 14861560Sn_hibma data = p; 14961560Sn_hibma p += bSize; 15061560Sn_hibma } else { 15161560Sn_hibma /* short item */ 15261560Sn_hibma bTag = bSize >> 4; 15361560Sn_hibma bType = (bSize >> 2) & 3; 15461560Sn_hibma bSize &= 3; 15561560Sn_hibma if (bSize == 3) bSize = 4; 15661560Sn_hibma data = p; 15761560Sn_hibma p += bSize; 15861560Sn_hibma } 15961560Sn_hibma s->p = p; 16061560Sn_hibma /* 16161560Sn_hibma * The spec is unclear if the data is signed or unsigned. 16261560Sn_hibma */ 16361560Sn_hibma switch(bSize) { 16461560Sn_hibma case 0: 16561560Sn_hibma dval = 0; 16661560Sn_hibma break; 16761560Sn_hibma case 1: 16861560Sn_hibma dval = (int8_t)*data++; 16961560Sn_hibma break; 17061560Sn_hibma case 2: 17161560Sn_hibma dval = *data++; 17261560Sn_hibma dval |= *data++ << 8; 17361560Sn_hibma dval = (int16_t)dval; 17461560Sn_hibma break; 17561560Sn_hibma case 4: 17661560Sn_hibma dval = *data++; 17761560Sn_hibma dval |= *data++ << 8; 17861560Sn_hibma dval |= *data++ << 16; 17961560Sn_hibma dval |= *data++ << 24; 18061560Sn_hibma break; 18161560Sn_hibma default: 18261560Sn_hibma return (-1); 18361560Sn_hibma } 18461560Sn_hibma 18561560Sn_hibma switch (bType) { 18661560Sn_hibma case 0: /* Main */ 18761560Sn_hibma switch (bTag) { 18861560Sn_hibma case 8: /* Input */ 18967217Sn_hibma retkind = hid_input; 19067217Sn_hibma ret: 19167217Sn_hibma if (!(s->kindset & (1 << retkind))) { 19267217Sn_hibma /* Drop the items of this kind */ 19367217Sn_hibma s->nusage = 0; 19461560Sn_hibma continue; 19567217Sn_hibma } 19667217Sn_hibma c->kind = retkind; 19761560Sn_hibma c->flags = dval; 19861560Sn_hibma if (c->flags & HIO_VARIABLE) { 19961560Sn_hibma s->multimax = c->report_count; 20061560Sn_hibma s->multi = 0; 20161560Sn_hibma c->report_count = 1; 20261560Sn_hibma if (s->minset) { 20361560Sn_hibma for (i = c->usage_minimum; 20461560Sn_hibma i <= c->usage_maximum; 20561560Sn_hibma i++) { 20661560Sn_hibma s->usages[s->nusage] = i; 20761560Sn_hibma if (s->nusage < MAXUSAGE-1) 20861560Sn_hibma s->nusage++; 20961560Sn_hibma } 21061560Sn_hibma s->minset = 0; 21161560Sn_hibma } 21261560Sn_hibma goto top; 21361560Sn_hibma } else { 21461560Sn_hibma if (s->minset) 21561560Sn_hibma c->usage = c->usage_minimum; 21661560Sn_hibma *h = *c; 21761560Sn_hibma h->next = 0; 21867217Sn_hibma h->pos = s->kindpos[c->kind]; 21967217Sn_hibma s->kindpos[c->kind] += c->report_size * c->report_count; 22061560Sn_hibma hid_clear_local(c); 22161560Sn_hibma s->minset = 0; 22261560Sn_hibma return (1); 22361560Sn_hibma } 22461560Sn_hibma case 9: /* Output */ 22567217Sn_hibma retkind = hid_output; 22661560Sn_hibma goto ret; 22761560Sn_hibma case 10: /* Collection */ 22861560Sn_hibma c->kind = hid_collection; 22961560Sn_hibma c->collection = dval; 23061560Sn_hibma c->collevel++; 23161560Sn_hibma *h = *c; 23261560Sn_hibma hid_clear_local(c); 23361560Sn_hibma c->report_ID = NO_REPORT_ID; 23461560Sn_hibma s->nusage = 0; 23561560Sn_hibma return (1); 23661560Sn_hibma case 11: /* Feature */ 23767217Sn_hibma retkind = hid_feature; 23861560Sn_hibma goto ret; 23961560Sn_hibma case 12: /* End collection */ 24061560Sn_hibma c->kind = hid_endcollection; 24161560Sn_hibma c->collevel--; 24261560Sn_hibma *h = *c; 24361560Sn_hibma /*hid_clear_local(c);*/ 24461560Sn_hibma s->nusage = 0; 24561560Sn_hibma return (1); 24661560Sn_hibma default: 24761560Sn_hibma return (-2); 24861560Sn_hibma } 24961560Sn_hibma 25061560Sn_hibma case 1: /* Global */ 25161560Sn_hibma switch (bTag) { 25261560Sn_hibma case 0: 25361560Sn_hibma c->_usage_page = dval << 16; 25461560Sn_hibma break; 25561560Sn_hibma case 1: 25661560Sn_hibma c->logical_minimum = dval; 25761560Sn_hibma break; 25861560Sn_hibma case 2: 25961560Sn_hibma c->logical_maximum = dval; 26061560Sn_hibma break; 26161560Sn_hibma case 3: 26261560Sn_hibma c->physical_maximum = dval; 26361560Sn_hibma break; 26461560Sn_hibma case 4: 26561560Sn_hibma c->physical_maximum = dval; 26661560Sn_hibma break; 26761560Sn_hibma case 5: 26861560Sn_hibma c->unit_exponent = dval; 26961560Sn_hibma break; 27061560Sn_hibma case 6: 27161560Sn_hibma c->unit = dval; 27261560Sn_hibma break; 27361560Sn_hibma case 7: 27461560Sn_hibma c->report_size = dval; 27561560Sn_hibma break; 27661560Sn_hibma case 8: 27761560Sn_hibma c->report_ID = dval; 27861560Sn_hibma break; 27961560Sn_hibma case 9: 28061560Sn_hibma c->report_count = dval; 28161560Sn_hibma break; 28261560Sn_hibma case 10: /* Push */ 28361560Sn_hibma hi = malloc(sizeof *hi); 28461560Sn_hibma *hi = s->cur; 28561560Sn_hibma c->next = hi; 28661560Sn_hibma break; 28761560Sn_hibma case 11: /* Pop */ 28861560Sn_hibma hi = c->next; 28961560Sn_hibma s->cur = *hi; 29061560Sn_hibma free(hi); 29161560Sn_hibma break; 29261560Sn_hibma default: 29361560Sn_hibma return (-3); 29461560Sn_hibma } 29561560Sn_hibma break; 29661560Sn_hibma case 2: /* Local */ 29761560Sn_hibma switch (bTag) { 29861560Sn_hibma case 0: 29961560Sn_hibma if (bSize == 1) 30061560Sn_hibma dval = c->_usage_page | (dval&0xff); 30161560Sn_hibma else if (bSize == 2) 30261560Sn_hibma dval = c->_usage_page | (dval&0xffff); 30361560Sn_hibma c->usage = dval; 30461560Sn_hibma if (s->nusage < MAXUSAGE) 30561560Sn_hibma s->usages[s->nusage++] = dval; 30661560Sn_hibma /* else XXX */ 30761560Sn_hibma break; 30861560Sn_hibma case 1: 30961560Sn_hibma s->minset = 1; 31061560Sn_hibma if (bSize == 1) 31161560Sn_hibma dval = c->_usage_page | (dval&0xff); 31261560Sn_hibma else if (bSize == 2) 31361560Sn_hibma dval = c->_usage_page | (dval&0xffff); 31461560Sn_hibma c->usage_minimum = dval; 31561560Sn_hibma break; 31661560Sn_hibma case 2: 31761560Sn_hibma if (bSize == 1) 31861560Sn_hibma dval = c->_usage_page | (dval&0xff); 31961560Sn_hibma else if (bSize == 2) 32061560Sn_hibma dval = c->_usage_page | (dval&0xffff); 32161560Sn_hibma c->usage_maximum = dval; 32261560Sn_hibma break; 32361560Sn_hibma case 3: 32461560Sn_hibma c->designator_index = dval; 32561560Sn_hibma break; 32661560Sn_hibma case 4: 32761560Sn_hibma c->designator_minimum = dval; 32861560Sn_hibma break; 32961560Sn_hibma case 5: 33061560Sn_hibma c->designator_maximum = dval; 33161560Sn_hibma break; 33261560Sn_hibma case 7: 33361560Sn_hibma c->string_index = dval; 33461560Sn_hibma break; 33561560Sn_hibma case 8: 33661560Sn_hibma c->string_minimum = dval; 33761560Sn_hibma break; 33861560Sn_hibma case 9: 33961560Sn_hibma c->string_maximum = dval; 34061560Sn_hibma break; 34161560Sn_hibma case 10: 34261560Sn_hibma c->set_delimiter = dval; 34361560Sn_hibma break; 34461560Sn_hibma default: 34561560Sn_hibma return (-4); 34661560Sn_hibma } 34761560Sn_hibma break; 34861560Sn_hibma default: 34961560Sn_hibma return (-5); 35061560Sn_hibma } 35161560Sn_hibma } 35261560Sn_hibma} 35361560Sn_hibma 35461560Sn_hibmaint 35567217Sn_hibmahid_report_size(report_desc_t r, unsigned int id, enum hid_kind k) 35661560Sn_hibma{ 35761560Sn_hibma struct hid_data *d; 35861560Sn_hibma hid_item_t h; 35967217Sn_hibma unsigned int size = 0; 36061560Sn_hibma 36161560Sn_hibma memset(&h, 0, sizeof h); 36267217Sn_hibma d = hid_start_parse(r, 1<<k); 36367217Sn_hibma while (hid_get_item(d, &h)) { 36467217Sn_hibma if (h.report_ID == id && h.kind == k) { 36567217Sn_hibma unsigned int newsize = h.pos + h.report_size; 36667217Sn_hibma if (newsize > size) 36767217Sn_hibma size = newsize; 36861560Sn_hibma } 36961560Sn_hibma } 37061560Sn_hibma hid_end_parse(d); 37167217Sn_hibma 37267217Sn_hibma if (id != NO_REPORT_ID) 37367217Sn_hibma size += 8; /* add 8 bits for the report ID */ 37467217Sn_hibma 37567217Sn_hibma return ((size + 7) / 8); /* return size in bytes */ 37661560Sn_hibma} 37761560Sn_hibma 37861560Sn_hibmaint 37967217Sn_hibmahid_locate(report_desc_t desc, unsigned int u, enum hid_kind k, hid_item_t *h) 38061560Sn_hibma{ 38161560Sn_hibma hid_data_t d; 38261560Sn_hibma 38361560Sn_hibma for (d = hid_start_parse(desc, 1<<k); hid_get_item(d, h); ) { 38461560Sn_hibma if (h->kind == k && !(h->flags & HIO_CONST) && h->usage == u) { 38561560Sn_hibma hid_end_parse(d); 38661560Sn_hibma return (1); 38761560Sn_hibma } 38861560Sn_hibma } 38961560Sn_hibma hid_end_parse(d); 39061560Sn_hibma h->report_size = 0; 39161560Sn_hibma return (0); 39261560Sn_hibma} 393