parse.c revision 113273
167217Sn_hibma/* $NetBSD: parse.c,v 1.11 2000/09/24 02:19:54 augustss Exp $ */ 261560Sn_hibma 361560Sn_hibma/* 4113273Smdodd * Copyright (c) 1999, 2001 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 2984224Sdillon#include <sys/cdefs.h> 3084224Sdillon__FBSDID("$FreeBSD: head/lib/libusbhid/parse.c 113273 2003-04-09 01:52:49Z mdodd $"); 3184224Sdillon 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 40113273Smdodd#include "usbhid.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; 52113273Smdodd int logminsize; 5361560Sn_hibma int multi; 5461560Sn_hibma int multimax; 5561560Sn_hibma int kindset; 56113273Smdodd int reportid; 5767217Sn_hibma 58113273Smdodd /* 59113273Smdodd * The start of collection item has no report ID set, so save 60113273Smdodd * it until we know the ID. 61113273Smdodd */ 62113273Smdodd hid_item_t savedcoll; 63113273Smdodd u_char hassavedcoll; 64113273Smdodd /* 65113273Smdodd * Absolute data position (bits) for input/output/feature. 66113273Smdodd * Assumes that hid_input, hid_output and hid_feature have 67113273Smdodd * values 0, 1 and 2. 68113273Smdodd */ 69113273Smdodd unsigned int kindpos[3]; 7061560Sn_hibma}; 7161560Sn_hibma 7261560Sn_hibmastatic int min(int x, int y) { return x < y ? x : y; } 7361560Sn_hibma 74113273Smdoddstatic int hid_get_item_raw(hid_data_t s, hid_item_t *h); 75113273Smdodd 7661560Sn_hibmastatic void 7761560Sn_hibmahid_clear_local(hid_item_t *c) 7861560Sn_hibma{ 7961560Sn_hibma c->usage = 0; 8061560Sn_hibma c->usage_minimum = 0; 8161560Sn_hibma c->usage_maximum = 0; 8261560Sn_hibma c->designator_index = 0; 8361560Sn_hibma c->designator_minimum = 0; 8461560Sn_hibma c->designator_maximum = 0; 8561560Sn_hibma c->string_index = 0; 8661560Sn_hibma c->string_minimum = 0; 8761560Sn_hibma c->string_maximum = 0; 8861560Sn_hibma c->set_delimiter = 0; 89113193Smdodd c->report_size = 0; 9061560Sn_hibma} 9161560Sn_hibma 9261560Sn_hibmahid_data_t 93113273Smdoddhid_start_parse(report_desc_t d, int kindset, int id) 9461560Sn_hibma{ 9561560Sn_hibma struct hid_data *s; 9661560Sn_hibma 9761560Sn_hibma s = malloc(sizeof *s); 9861560Sn_hibma memset(s, 0, sizeof *s); 9961560Sn_hibma s->start = s->p = d->data; 10061560Sn_hibma s->end = d->data + d->size; 10161560Sn_hibma s->kindset = kindset; 102113273Smdodd s->reportid = id; 103113273Smdodd s->hassavedcoll = 0; 10461560Sn_hibma return (s); 10561560Sn_hibma} 10661560Sn_hibma 10761560Sn_hibmavoid 10861560Sn_hibmahid_end_parse(hid_data_t s) 10961560Sn_hibma{ 11061560Sn_hibma while (s->cur.next) { 11161560Sn_hibma hid_item_t *hi = s->cur.next->next; 11261560Sn_hibma free(s->cur.next); 11361560Sn_hibma s->cur.next = hi; 11461560Sn_hibma } 11561560Sn_hibma free(s); 11661560Sn_hibma} 11761560Sn_hibma 11861560Sn_hibmaint 11961560Sn_hibmahid_get_item(hid_data_t s, hid_item_t *h) 12061560Sn_hibma{ 121113273Smdodd int r; 122113273Smdodd 123113273Smdodd for (;;) { 124113273Smdodd r = hid_get_item_raw(s, h); 125113273Smdodd if (r <= 0) 126113273Smdodd break; 127113273Smdodd if (h->report_ID == s->reportid || s->reportid == -1) 128113273Smdodd break; 129113273Smdodd } 130113273Smdodd return (r); 131113273Smdodd} 132113273Smdodd 133113273Smdodd#define REPORT_SAVED_COLL \ 134113273Smdodd do { \ 135113273Smdodd if (s->hassavedcoll) { \ 136113273Smdodd *h = s->savedcoll; \ 137113273Smdodd h->report_ID = c->report_ID; \ 138113273Smdodd s->hassavedcoll = 0; \ 139113273Smdodd return (1); \ 140113273Smdodd } \ 141113273Smdodd } while(/*LINTED*/ 0) 142113273Smdodd 143113273Smdoddstatic int 144113273Smdoddhid_get_item_raw(hid_data_t s, hid_item_t *h) 145113273Smdodd{ 14661560Sn_hibma hid_item_t *c; 14767217Sn_hibma unsigned int bTag = 0, bType = 0, bSize; 14861560Sn_hibma unsigned char *data; 14961560Sn_hibma int dval; 15061560Sn_hibma unsigned char *p; 15161560Sn_hibma hid_item_t *hi; 152113273Smdodd hid_item_t nc; 15361560Sn_hibma int i; 15467217Sn_hibma hid_kind_t retkind; 15561560Sn_hibma 15661560Sn_hibma c = &s->cur; 15761560Sn_hibma 15861560Sn_hibma top: 15961560Sn_hibma if (s->multimax) { 160113273Smdodd REPORT_SAVED_COLL; 161113273Smdodd if (c->logical_minimum >= c->logical_maximum) { 162113273Smdodd if (s->logminsize == 1) 163113273Smdodd c->logical_minimum =(int8_t)c->logical_minimum; 164113273Smdodd else if (s->logminsize == 2) 165113273Smdodd c->logical_minimum =(int16_t)c->logical_minimum; 166113273Smdodd } 16761560Sn_hibma if (s->multi < s->multimax) { 16861560Sn_hibma c->usage = s->usages[min(s->multi, s->nusage-1)]; 16961560Sn_hibma s->multi++; 17061560Sn_hibma *h = *c; 171113273Smdodd /* 172113273Smdodd * 'multimax' is only non-zero if the current 173113273Smdodd * item kind is input/output/feature 174113273Smdodd */ 17567217Sn_hibma h->pos = s->kindpos[c->kind]; 17667217Sn_hibma s->kindpos[c->kind] += c->report_size; 17761560Sn_hibma h->next = 0; 17861560Sn_hibma return (1); 17961560Sn_hibma } else { 18061560Sn_hibma c->report_count = s->multimax; 18161560Sn_hibma s->multimax = 0; 18261560Sn_hibma s->nusage = 0; 18361560Sn_hibma hid_clear_local(c); 18461560Sn_hibma } 18561560Sn_hibma } 18661560Sn_hibma for (;;) { 18761560Sn_hibma p = s->p; 18861560Sn_hibma if (p >= s->end) 18961560Sn_hibma return (0); 19061560Sn_hibma 19161560Sn_hibma bSize = *p++; 19261560Sn_hibma if (bSize == 0xfe) { 19361560Sn_hibma /* long item */ 19461560Sn_hibma bSize = *p++; 19561560Sn_hibma bSize |= *p++ << 8; 19661560Sn_hibma bTag = *p++; 19761560Sn_hibma data = p; 19861560Sn_hibma p += bSize; 19961560Sn_hibma } else { 20061560Sn_hibma /* short item */ 20161560Sn_hibma bTag = bSize >> 4; 20261560Sn_hibma bType = (bSize >> 2) & 3; 20361560Sn_hibma bSize &= 3; 20461560Sn_hibma if (bSize == 3) bSize = 4; 20561560Sn_hibma data = p; 20661560Sn_hibma p += bSize; 20761560Sn_hibma } 20861560Sn_hibma s->p = p; 20961560Sn_hibma /* 21061560Sn_hibma * The spec is unclear if the data is signed or unsigned. 21161560Sn_hibma */ 21261560Sn_hibma switch(bSize) { 21361560Sn_hibma case 0: 21461560Sn_hibma dval = 0; 21561560Sn_hibma break; 21661560Sn_hibma case 1: 21761560Sn_hibma dval = (int8_t)*data++; 21861560Sn_hibma break; 21961560Sn_hibma case 2: 22061560Sn_hibma dval = *data++; 22161560Sn_hibma dval |= *data++ << 8; 22261560Sn_hibma dval = (int16_t)dval; 22361560Sn_hibma break; 22461560Sn_hibma case 4: 22561560Sn_hibma dval = *data++; 22661560Sn_hibma dval |= *data++ << 8; 22761560Sn_hibma dval |= *data++ << 16; 22861560Sn_hibma dval |= *data++ << 24; 22961560Sn_hibma break; 23061560Sn_hibma default: 23161560Sn_hibma return (-1); 23261560Sn_hibma } 23361560Sn_hibma 23461560Sn_hibma switch (bType) { 23561560Sn_hibma case 0: /* Main */ 23661560Sn_hibma switch (bTag) { 23761560Sn_hibma case 8: /* Input */ 23867217Sn_hibma retkind = hid_input; 23967217Sn_hibma ret: 24067217Sn_hibma if (!(s->kindset & (1 << retkind))) { 24167217Sn_hibma /* Drop the items of this kind */ 24267217Sn_hibma s->nusage = 0; 24361560Sn_hibma continue; 24467217Sn_hibma } 24567217Sn_hibma c->kind = retkind; 24661560Sn_hibma c->flags = dval; 24761560Sn_hibma if (c->flags & HIO_VARIABLE) { 24861560Sn_hibma s->multimax = c->report_count; 24961560Sn_hibma s->multi = 0; 25061560Sn_hibma c->report_count = 1; 25161560Sn_hibma if (s->minset) { 25261560Sn_hibma for (i = c->usage_minimum; 25361560Sn_hibma i <= c->usage_maximum; 25461560Sn_hibma i++) { 25561560Sn_hibma s->usages[s->nusage] = i; 25661560Sn_hibma if (s->nusage < MAXUSAGE-1) 25761560Sn_hibma s->nusage++; 25861560Sn_hibma } 259113273Smdodd c->usage_minimum = 0; 260113273Smdodd c->usage_maximum = 0; 26161560Sn_hibma s->minset = 0; 26261560Sn_hibma } 26361560Sn_hibma goto top; 26461560Sn_hibma } else { 26561560Sn_hibma if (s->minset) 26661560Sn_hibma c->usage = c->usage_minimum; 26761560Sn_hibma *h = *c; 26861560Sn_hibma h->next = 0; 26967217Sn_hibma h->pos = s->kindpos[c->kind]; 270113273Smdodd s->kindpos[c->kind] += 271113273Smdodd c->report_size * c->report_count; 27261560Sn_hibma hid_clear_local(c); 27361560Sn_hibma s->minset = 0; 27461560Sn_hibma return (1); 27561560Sn_hibma } 27661560Sn_hibma case 9: /* Output */ 27767217Sn_hibma retkind = hid_output; 27861560Sn_hibma goto ret; 27961560Sn_hibma case 10: /* Collection */ 28061560Sn_hibma c->kind = hid_collection; 28161560Sn_hibma c->collection = dval; 28261560Sn_hibma c->collevel++; 283113273Smdodd nc = *c; 28461560Sn_hibma hid_clear_local(c); 285113273Smdodd /*c->report_ID = NO_REPORT_ID;*/ 28661560Sn_hibma s->nusage = 0; 287113273Smdodd if (s->hassavedcoll) { 288113273Smdodd *h = s->savedcoll; 289113273Smdodd h->report_ID = nc.report_ID; 290113273Smdodd s->savedcoll = nc; 291113273Smdodd return (1); 292113273Smdodd } else { 293113273Smdodd s->hassavedcoll = 1; 294113273Smdodd s->savedcoll = nc; 295113273Smdodd } 296113273Smdodd break; 29761560Sn_hibma case 11: /* Feature */ 29867217Sn_hibma retkind = hid_feature; 29961560Sn_hibma goto ret; 30061560Sn_hibma case 12: /* End collection */ 301113273Smdodd REPORT_SAVED_COLL; 30261560Sn_hibma c->kind = hid_endcollection; 30361560Sn_hibma c->collevel--; 30461560Sn_hibma *h = *c; 30561560Sn_hibma /*hid_clear_local(c);*/ 30661560Sn_hibma s->nusage = 0; 30761560Sn_hibma return (1); 30861560Sn_hibma default: 30961560Sn_hibma return (-2); 31061560Sn_hibma } 311113273Smdodd break; 31261560Sn_hibma 31361560Sn_hibma case 1: /* Global */ 31461560Sn_hibma switch (bTag) { 31561560Sn_hibma case 0: 31661560Sn_hibma c->_usage_page = dval << 16; 31761560Sn_hibma break; 31861560Sn_hibma case 1: 31961560Sn_hibma c->logical_minimum = dval; 320113273Smdodd s->logminsize = bSize; 32161560Sn_hibma break; 32261560Sn_hibma case 2: 32361560Sn_hibma c->logical_maximum = dval; 32461560Sn_hibma break; 32561560Sn_hibma case 3: 32661560Sn_hibma c->physical_maximum = dval; 32761560Sn_hibma break; 32861560Sn_hibma case 4: 32961560Sn_hibma c->physical_maximum = dval; 33061560Sn_hibma break; 33161560Sn_hibma case 5: 33261560Sn_hibma c->unit_exponent = dval; 33361560Sn_hibma break; 33461560Sn_hibma case 6: 33561560Sn_hibma c->unit = dval; 33661560Sn_hibma break; 33761560Sn_hibma case 7: 33861560Sn_hibma c->report_size = dval; 33961560Sn_hibma break; 34061560Sn_hibma case 8: 34161560Sn_hibma c->report_ID = dval; 342113273Smdodd s->kindpos[hid_input] = 343113273Smdodd s->kindpos[hid_output] = 344113273Smdodd s->kindpos[hid_feature] = 0; 34561560Sn_hibma break; 34661560Sn_hibma case 9: 34761560Sn_hibma c->report_count = dval; 34861560Sn_hibma break; 34961560Sn_hibma case 10: /* Push */ 35061560Sn_hibma hi = malloc(sizeof *hi); 35161560Sn_hibma *hi = s->cur; 35261560Sn_hibma c->next = hi; 35361560Sn_hibma break; 35461560Sn_hibma case 11: /* Pop */ 35561560Sn_hibma hi = c->next; 35661560Sn_hibma s->cur = *hi; 35761560Sn_hibma free(hi); 35861560Sn_hibma break; 35961560Sn_hibma default: 36061560Sn_hibma return (-3); 36161560Sn_hibma } 36261560Sn_hibma break; 36361560Sn_hibma case 2: /* Local */ 36461560Sn_hibma switch (bTag) { 36561560Sn_hibma case 0: 366113273Smdodd c->usage = c->_usage_page | dval; 36761560Sn_hibma if (s->nusage < MAXUSAGE) 368113273Smdodd s->usages[s->nusage++] = c->usage; 36961560Sn_hibma /* else XXX */ 37061560Sn_hibma break; 37161560Sn_hibma case 1: 37261560Sn_hibma s->minset = 1; 373113273Smdodd c->usage_minimum = c->_usage_page | dval; 37461560Sn_hibma break; 37561560Sn_hibma case 2: 376113273Smdodd c->usage_maximum = c->_usage_page | dval; 37761560Sn_hibma break; 37861560Sn_hibma case 3: 37961560Sn_hibma c->designator_index = dval; 38061560Sn_hibma break; 38161560Sn_hibma case 4: 38261560Sn_hibma c->designator_minimum = dval; 38361560Sn_hibma break; 38461560Sn_hibma case 5: 38561560Sn_hibma c->designator_maximum = dval; 38661560Sn_hibma break; 38761560Sn_hibma case 7: 38861560Sn_hibma c->string_index = dval; 38961560Sn_hibma break; 39061560Sn_hibma case 8: 39161560Sn_hibma c->string_minimum = dval; 39261560Sn_hibma break; 39361560Sn_hibma case 9: 39461560Sn_hibma c->string_maximum = dval; 39561560Sn_hibma break; 39661560Sn_hibma case 10: 39761560Sn_hibma c->set_delimiter = dval; 39861560Sn_hibma break; 39961560Sn_hibma default: 40061560Sn_hibma return (-4); 40161560Sn_hibma } 40261560Sn_hibma break; 40361560Sn_hibma default: 40461560Sn_hibma return (-5); 40561560Sn_hibma } 40661560Sn_hibma } 40761560Sn_hibma} 40861560Sn_hibma 40961560Sn_hibmaint 410113273Smdoddhid_report_size(report_desc_t r, enum hid_kind k, int id) 41161560Sn_hibma{ 41261560Sn_hibma struct hid_data *d; 41361560Sn_hibma hid_item_t h; 414113273Smdodd int size; 41561560Sn_hibma 41661560Sn_hibma memset(&h, 0, sizeof h); 417113273Smdodd size = 0; 418113273Smdodd for (d = hid_start_parse(r, 1<<k, id); hid_get_item(d, &h); ) { 41967217Sn_hibma if (h.report_ID == id && h.kind == k) { 420113273Smdodd size = d->kindpos[k]; 42161560Sn_hibma } 42261560Sn_hibma } 42361560Sn_hibma hid_end_parse(d); 424113273Smdodd return ((size + 7) / 8); 42561560Sn_hibma} 42661560Sn_hibma 42761560Sn_hibmaint 428113273Smdoddhid_locate(report_desc_t desc, unsigned int u, enum hid_kind k, 429113273Smdodd hid_item_t *h, int id) 43061560Sn_hibma{ 43161560Sn_hibma hid_data_t d; 43261560Sn_hibma 433113273Smdodd for (d = hid_start_parse(desc, 1<<k, id); hid_get_item(d, h); ) { 43461560Sn_hibma if (h->kind == k && !(h->flags & HIO_CONST) && h->usage == u) { 43561560Sn_hibma hid_end_parse(d); 43661560Sn_hibma return (1); 43761560Sn_hibma } 43861560Sn_hibma } 43961560Sn_hibma hid_end_parse(d); 44061560Sn_hibma h->report_size = 0; 44161560Sn_hibma return (0); 44261560Sn_hibma} 443