1 /* $NetBSD: hid.c,v 1.17 2001/11/13 06:24:53 lukem Exp $ */
5 * Copyright (c) 1998 The NetBSD Foundation, Inc.
8 * This code is derived from software contributed to The NetBSD Foundation
9 * by Lennart Augustsson (lennart@augustsson.net) at
10 * Carlstedt Research & Technology.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
21 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
23 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
25 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
34 #include <sys/stdint.h>
35 #include <sys/param.h>
36 #include <sys/queue.h>
37 #include <sys/types.h>
38 #include <sys/systm.h>
39 #include <sys/kernel.h>
41 #include <sys/module.h>
43 #include <sys/mutex.h>
44 #include <sys/condvar.h>
45 #include <sys/sysctl.h>
46 #include <sys/unistd.h>
47 #include <sys/callout.h>
48 #include <sys/malloc.h>
51 #include <bus/u4b/usb.h>
52 #include <bus/u4b/usbdi.h>
53 #include <bus/u4b/usbdi_util.h>
54 #include <bus/u4b/usbhid.h>
56 #define USB_DEBUG_VAR usb_debug
58 #include <bus/u4b/usb_core.h>
59 #include <bus/u4b/usb_debug.h>
60 #include <bus/u4b/usb_process.h>
61 #include <bus/u4b/usb_device.h>
62 #include <bus/u4b/usb_request.h>
64 static void hid_clear_local(struct hid_item *);
65 static uint8_t hid_get_byte(struct hid_data *s, const uint16_t wSize);
80 struct hid_item cur[MAXPUSH];
81 struct hid_pos_data last_pos[MAXID];
82 int32_t usages_min[MAXUSAGE];
83 int32_t usages_max[MAXUSAGE];
84 int32_t usage_last; /* last seen usage */
85 uint32_t loc_size; /* last seen size */
86 uint32_t loc_count; /* last seen count */
87 uint8_t kindset; /* we have 5 kinds so 8 bits are enough */
88 uint8_t pushlevel; /* current pushlevel */
89 uint8_t ncount; /* end usage item count */
90 uint8_t icount; /* current usage item count */
91 uint8_t nusage; /* end "usages_min/max" index */
92 uint8_t iusage; /* current "usages_min/max" index */
93 uint8_t ousage; /* current "usages_min/max" offset */
94 uint8_t susage; /* usage set flags */
97 /*------------------------------------------------------------------------*
99 *------------------------------------------------------------------------*/
101 hid_clear_local(struct hid_item *c)
107 c->usage_minimum = 0;
108 c->usage_maximum = 0;
109 c->designator_index = 0;
110 c->designator_minimum = 0;
111 c->designator_maximum = 0;
113 c->string_minimum = 0;
114 c->string_maximum = 0;
115 c->set_delimiter = 0;
119 hid_switch_rid(struct hid_data *s, struct hid_item *c, int32_t next_rID)
123 /* check for same report ID - optimise */
125 if (c->report_ID == next_rID)
128 /* save current position for current rID */
130 if (c->report_ID == 0) {
133 for (i = 1; i != MAXID; i++) {
134 if (s->last_pos[i].rid == c->report_ID)
136 if (s->last_pos[i].rid == 0)
141 s->last_pos[i].rid = c->report_ID;
142 s->last_pos[i].pos = c->loc.pos;
145 /* store next report ID */
147 c->report_ID = next_rID;
149 /* lookup last position for next rID */
154 for (i = 1; i != MAXID; i++) {
155 if (s->last_pos[i].rid == next_rID)
157 if (s->last_pos[i].rid == 0)
162 s->last_pos[i].rid = next_rID;
163 c->loc.pos = s->last_pos[i].pos;
165 DPRINTF("Out of RID entries, position is set to zero!\n");
170 /*------------------------------------------------------------------------*
172 *------------------------------------------------------------------------*/
174 hid_start_parse(const void *d, usb_size_t len, int kindset)
178 if ((kindset-1) & kindset) {
179 DPRINTFN(0, "Only one bit can be "
180 "set in the kindset\n");
184 s = kmalloc(sizeof *s, M_TEMP, M_WAITOK | M_ZERO);
186 s->end = ((const uint8_t *)d) + len;
187 s->kindset = kindset;
191 /*------------------------------------------------------------------------*
193 *------------------------------------------------------------------------*/
195 hid_end_parse(struct hid_data *s)
203 /*------------------------------------------------------------------------*
204 * get byte from HID descriptor
205 *------------------------------------------------------------------------*/
207 hid_get_byte(struct hid_data *s, const uint16_t wSize)
214 /* check if end is reached */
218 /* read out a byte */
221 /* check if data pointer can be advanced by "wSize" bytes */
222 if ((s->end - ptr) < wSize)
233 /*------------------------------------------------------------------------*
235 *------------------------------------------------------------------------*/
237 hid_get_item(struct hid_data *s, struct hid_item *h)
240 unsigned int bTag, bType, bSize;
248 c = &s->cur[s->pushlevel];
251 /* check if there is an array of items */
252 if (s->icount < s->ncount) {
253 /* get current usage */
254 if (s->iusage < s->nusage) {
255 dval = s->usages_min[s->iusage] + s->ousage;
257 s->usage_last = dval;
258 if (dval == s->usages_max[s->iusage]) {
265 DPRINTFN(1, "Using last usage\n");
266 dval = s->usage_last;
270 * Only copy HID item, increment position and return
271 * if correct kindset!
273 if (s->kindset & (1 << c->kind)) {
275 DPRINTFN(1, "%u,%u,%u\n", h->loc.pos,
276 h->loc.size, h->loc.count);
277 c->loc.pos += c->loc.size * c->loc.count;
282 /* reset state variables */
292 while (s->p != s->end) {
294 bSize = hid_get_byte(s, 1);
297 bSize = hid_get_byte(s, 1);
298 bSize |= hid_get_byte(s, 1) << 8;
299 bTag = hid_get_byte(s, 1);
300 bType = 0xff; /* XXX what should it be */
304 bType = (bSize >> 2) & 3;
315 dval = (int8_t)hid_get_byte(s, 1);
319 dval = hid_get_byte(s, 1);
320 dval |= hid_get_byte(s, 1) << 8;
321 dval = (int16_t)dval;
325 dval = hid_get_byte(s, 1);
326 dval |= hid_get_byte(s, 1) << 8;
327 dval |= hid_get_byte(s, 1) << 16;
328 dval |= hid_get_byte(s, 1) << 24;
332 dval = hid_get_byte(s, bSize);
333 DPRINTFN(0, "bad length %u (data=0x%02x)\n",
345 c->loc.count = s->loc_count;
346 c->loc.size = s->loc_size;
348 if (c->flags & HIO_VARIABLE) {
349 /* range check usage count */
350 if (c->loc.count > 255) {
351 DPRINTFN(0, "Number of "
352 "items truncated to 255\n");
355 s->ncount = c->loc.count;
358 * The "top" loop will return
368 c->kind = hid_output;
371 case 10: /* Collection */
372 c->kind = hid_collection;
373 c->collection = dval;
375 c->usage = s->usage_last;
378 case 11: /* Feature */
379 c->kind = hid_feature;
382 case 12: /* End collection */
383 c->kind = hid_endcollection;
384 if (c->collevel == 0) {
385 DPRINTFN(0, "invalid end collection\n");
392 DPRINTFN(0, "Main bTag=%d\n", bTag);
399 c->_usage_page = dval << 16;
402 c->logical_minimum = dval;
405 c->logical_maximum = dval;
408 c->physical_minimum = dval;
411 c->physical_maximum = dval;
414 c->unit_exponent = dval;
420 /* mask because value is unsigned */
421 s->loc_size = dval & mask;
424 hid_switch_rid(s, c, dval & mask);
427 /* mask because value is unsigned */
428 s->loc_count = dval & mask;
432 if (s->pushlevel < MAXPUSH) {
433 s->cur[s->pushlevel] = *c;
434 /* store size and count */
435 c->loc.size = s->loc_size;
436 c->loc.count = s->loc_count;
437 /* update current item pointer */
438 c = &s->cur[s->pushlevel];
440 DPRINTFN(0, "Cannot push "
441 "item @ %d\n", s->pushlevel);
446 if (s->pushlevel < MAXPUSH) {
447 /* preserve position */
449 c = &s->cur[s->pushlevel];
450 /* restore size and count */
451 s->loc_size = c->loc.size;
452 s->loc_count = c->loc.count;
453 /* set default item location */
458 DPRINTFN(0, "Cannot pop "
459 "item @ %d\n", s->pushlevel);
463 DPRINTFN(0, "Global bTag=%d\n", bTag);
471 dval = (dval & mask) | c->_usage_page;
473 /* set last usage, in case of a collection */
474 s->usage_last = dval;
476 if (s->nusage < MAXUSAGE) {
477 s->usages_min[s->nusage] = dval;
478 s->usages_max[s->nusage] = dval;
481 DPRINTFN(0, "max usage reached\n");
484 /* clear any pending usage sets */
491 dval = (dval & mask) | c->_usage_page;
492 c->usage_minimum = dval;
499 dval = (dval & mask) | c->_usage_page;
500 c->usage_maximum = dval;
507 if ((s->nusage < MAXUSAGE) &&
508 (c->usage_minimum <= c->usage_maximum)) {
509 /* add usage range */
510 s->usages_min[s->nusage] =
512 s->usages_max[s->nusage] =
516 DPRINTFN(0, "Usage set dropped\n");
521 c->designator_index = dval;
524 c->designator_minimum = dval;
527 c->designator_maximum = dval;
530 c->string_index = dval;
533 c->string_minimum = dval;
536 c->string_maximum = dval;
539 c->set_delimiter = dval;
542 DPRINTFN(0, "Local bTag=%d\n", bTag);
547 DPRINTFN(0, "default bType=%d\n", bType);
554 /*------------------------------------------------------------------------*
556 *------------------------------------------------------------------------*/
558 hid_report_size(const void *buf, usb_size_t len, enum hid_kind k, uint8_t *id)
571 for (d = hid_start_parse(buf, len, 1 << k); hid_get_item(d, &h);) {
573 /* check for ID-byte presense */
574 if ((h.report_ID != 0) && !any_id) {
579 /* compute minimum */
580 if (lpos > h.loc.pos)
582 /* compute end position */
583 temp = h.loc.pos + (h.loc.size * h.loc.count);
584 /* compute maximum */
591 /* safety check - can happen in case of currupt descriptors */
597 /* check for ID byte */
603 /* return length in bytes rounded up */
604 return ((temp + 7) / 8);
607 /*------------------------------------------------------------------------*
609 *------------------------------------------------------------------------*/
611 hid_locate(const void *desc, usb_size_t size, int32_t u, enum hid_kind k,
612 uint8_t index, struct hid_location *loc, uint32_t *flags, uint8_t *id)
617 for (d = hid_start_parse(desc, size, 1 << k); hid_get_item(d, &h);) {
618 if (h.kind == k && !(h.flags & HIO_CONST) && h.usage == u) {
641 /*------------------------------------------------------------------------*
643 *------------------------------------------------------------------------*/
645 hid_get_data_sub(const uint8_t *buf, usb_size_t len, struct hid_location *loc,
648 uint32_t hpos = loc->pos;
649 uint32_t hsize = loc->size;
654 DPRINTFN(11, "hid_get_data: loc %d/%d\n", hpos, hsize);
656 /* Range check and limit */
662 /* Get data in a safe way */
670 data |= buf[rpos] << (8 * n);
673 /* Correctly shift down data */
674 data = (data >> (hpos % 8));
677 /* Mask and sign extend in one */
679 data = (int32_t)((int32_t)data << n) >> n;
681 data = (uint32_t)((uint32_t)data << n) >> n;
683 DPRINTFN(11, "hid_get_data: loc %d/%d = %lu\n",
684 loc->pos, loc->size, (long)data);
689 hid_get_data(const uint8_t *buf, usb_size_t len, struct hid_location *loc)
691 return (hid_get_data_sub(buf, len, loc, 1));
695 hid_get_data_unsigned(const uint8_t *buf, usb_size_t len, struct hid_location *loc)
697 return (hid_get_data_sub(buf, len, loc, 0));
700 /*------------------------------------------------------------------------*
702 *------------------------------------------------------------------------*/
704 hid_put_data_unsigned(uint8_t *buf, usb_size_t len,
705 struct hid_location *loc, unsigned int value)
707 uint32_t hpos = loc->pos;
708 uint32_t hsize = loc->size;
714 DPRINTFN(11, "hid_put_data: loc %d/%d = %u\n", hpos, hsize, value);
716 /* Range check and limit */
722 /* Put data in a safe way */
725 data = ((uint64_t)value) << (hpos % 8);
726 mask = ((1ULL << hsize) - 1ULL) << (hpos % 8);
731 buf[rpos] &= ~(mask >> (8 * n));
732 buf[rpos] |= (data >> (8 * n));
737 /*------------------------------------------------------------------------*
739 *------------------------------------------------------------------------*/
741 hid_is_collection(const void *desc, usb_size_t size, int32_t usage)
747 hd = hid_start_parse(desc, size, hid_input);
751 while ((err = hid_get_item(hd, &hi))) {
752 if (hi.kind == hid_collection &&
760 /*------------------------------------------------------------------------*
761 * hid_get_descriptor_from_usb
763 * This function will search for a HID descriptor between two USB
764 * interface descriptors.
767 * NULL: No more HID descriptors.
768 * Else: Pointer to HID descriptor.
769 *------------------------------------------------------------------------*/
770 struct usb_hid_descriptor *
771 hid_get_descriptor_from_usb(struct usb_config_descriptor *cd,
772 struct usb_interface_descriptor *id)
774 struct usb_descriptor *desc = (void *)id;
779 while ((desc = usb_desc_foreach(cd, desc))) {
780 if ((desc->bDescriptorType == UDESC_HID) &&
781 (desc->bLength >= USB_HID_DESCRIPTOR_SIZE(0))) {
784 if (desc->bDescriptorType == UDESC_INTERFACE) {
791 /*------------------------------------------------------------------------*
792 * usbd_req_get_hid_desc
794 * This function will read out an USB report descriptor from the USB
799 * Else: Success. The pointer should eventually be passed to free().
800 *------------------------------------------------------------------------*/
802 usbd_req_get_hid_desc(struct usb_device *udev, struct lock *lock,
803 void **descp, uint16_t *sizep,
804 struct malloc_type *mem, uint8_t iface_index)
806 struct usb_interface *iface = usbd_get_iface(udev, iface_index);
807 struct usb_hid_descriptor *hid;
810 if ((iface == NULL) || (iface->idesc == NULL)) {
811 return (USB_ERR_INVAL);
813 hid = hid_get_descriptor_from_usb
814 (usbd_get_config_descriptor(udev), iface->idesc);
817 return (USB_ERR_IOERROR);
819 *sizep = UGETW(hid->descrs[0].wDescriptorLength);
821 return (USB_ERR_IOERROR);
824 lockmgr(lock, LK_RELEASE);
826 *descp = kmalloc(*sizep, mem, M_ZERO | M_WAITOK);
829 lockmgr(lock, LK_EXCLUSIVE);
831 if (*descp == NULL) {
832 return (USB_ERR_NOMEM);
834 err = usbd_req_get_report_descriptor
835 (udev, lock, *descp, *sizep, iface_index);
842 return (USB_ERR_NORMAL_COMPLETION);
845 /*------------------------------------------------------------------------*
848 * This function will decide if a USB descriptor belongs to a USB mouse.
851 * Zero: Not a USB mouse.
852 * Else: Is a USB mouse.
853 *------------------------------------------------------------------------*/
855 hid_is_mouse(const void *d_ptr, uint16_t d_len)
862 hd = hid_start_parse(d_ptr, d_len, 1 << hid_input);
869 while (hid_get_item(hd, &hi)) {
874 else if (hi.collection == 1 &&
876 HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_MOUSE))
879 case hid_endcollection:
887 HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_X) &&
888 (hi.flags & (HIO_CONST|HIO_RELATIVE)) == HIO_RELATIVE)
891 HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_Y) &&
892 (hi.flags & (HIO_CONST|HIO_RELATIVE)) == HIO_RELATIVE)
903 /*------------------------------------------------------------------------*
906 * This function will decide if a USB descriptor belongs to a USB keyboard.
909 * Zero: Not a USB keyboard.
910 * Else: Is a USB keyboard.
911 *------------------------------------------------------------------------*/
913 hid_is_keyboard(const void *d_ptr, uint16_t d_len)
915 if (hid_is_collection(d_ptr, d_len,
916 HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_KEYBOARD)))