1 /* $NetBSD: hid.c,v 1.17 2001/11/13 06:24:53 lukem Exp $ */
7 * Copyright (c) 1998 The NetBSD Foundation, Inc.
10 * This code is derived from software contributed to The NetBSD Foundation
11 * by Lennart Augustsson (lennart@augustsson.net) at
12 * Carlstedt Research & Technology.
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
17 * 1. Redistributions of source code must retain the above copyright
18 * notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 * notice, this list of conditions and the following disclaimer in the
21 * documentation and/or other materials provided with the distribution.
23 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
24 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
25 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
26 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
27 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGE.
36 #include <sys/stdint.h>
37 #include <sys/stddef.h>
38 #include <sys/param.h>
39 #include <sys/queue.h>
40 #include <sys/types.h>
41 #include <sys/systm.h>
42 #include <sys/kernel.h>
44 #include <sys/module.h>
46 #include <sys/mutex.h>
47 #include <sys/condvar.h>
48 #include <sys/sysctl.h>
50 #include <sys/unistd.h>
51 #include <sys/callout.h>
52 #include <sys/malloc.h>
55 #include <dev/usb/usb.h>
56 #include <dev/usb/usbdi.h>
57 #include <dev/usb/usbdi_util.h>
58 #include <dev/usb/usbhid.h>
60 #define USB_DEBUG_VAR usb_debug
62 #include <dev/usb/usb_core.h>
63 #include <dev/usb/usb_debug.h>
64 #include <dev/usb/usb_process.h>
65 #include <dev/usb/usb_device.h>
66 #include <dev/usb/usb_request.h>
68 static void hid_clear_local(struct hid_item *);
69 static uint8_t hid_get_byte(struct hid_data *s, const uint16_t wSize);
84 struct hid_item cur[MAXPUSH];
85 struct hid_pos_data last_pos[MAXID];
86 int32_t usages_min[MAXUSAGE];
87 int32_t usages_max[MAXUSAGE];
88 int32_t usage_last; /* last seen usage */
89 uint32_t loc_size; /* last seen size */
90 uint32_t loc_count; /* last seen count */
91 uint8_t kindset; /* we have 5 kinds so 8 bits are enough */
92 uint8_t pushlevel; /* current pushlevel */
93 uint8_t ncount; /* end usage item count */
94 uint8_t icount; /* current usage item count */
95 uint8_t nusage; /* end "usages_min/max" index */
96 uint8_t iusage; /* current "usages_min/max" index */
97 uint8_t ousage; /* current "usages_min/max" offset */
98 uint8_t susage; /* usage set flags */
101 /*------------------------------------------------------------------------*
103 *------------------------------------------------------------------------*/
105 hid_clear_local(struct hid_item *c)
111 c->usage_minimum = 0;
112 c->usage_maximum = 0;
113 c->designator_index = 0;
114 c->designator_minimum = 0;
115 c->designator_maximum = 0;
117 c->string_minimum = 0;
118 c->string_maximum = 0;
119 c->set_delimiter = 0;
123 hid_switch_rid(struct hid_data *s, struct hid_item *c, int32_t next_rID)
127 /* check for same report ID - optimise */
129 if (c->report_ID == next_rID)
132 /* save current position for current rID */
134 if (c->report_ID == 0) {
137 for (i = 1; i != MAXID; i++) {
138 if (s->last_pos[i].rid == c->report_ID)
140 if (s->last_pos[i].rid == 0)
145 s->last_pos[i].rid = c->report_ID;
146 s->last_pos[i].pos = c->loc.pos;
149 /* store next report ID */
151 c->report_ID = next_rID;
153 /* lookup last position for next rID */
158 for (i = 1; i != MAXID; i++) {
159 if (s->last_pos[i].rid == next_rID)
161 if (s->last_pos[i].rid == 0)
166 s->last_pos[i].rid = next_rID;
167 c->loc.pos = s->last_pos[i].pos;
169 DPRINTF("Out of RID entries, position is set to zero!\n");
174 /*------------------------------------------------------------------------*
176 *------------------------------------------------------------------------*/
178 hid_start_parse(const void *d, usb_size_t len, int kindset)
182 if ((kindset-1) & kindset) {
183 DPRINTFN(0, "Only one bit can be "
184 "set in the kindset\n");
188 s = malloc(sizeof *s, M_TEMP, M_WAITOK | M_ZERO);
190 s->end = ((const uint8_t *)d) + len;
191 s->kindset = kindset;
195 /*------------------------------------------------------------------------*
197 *------------------------------------------------------------------------*/
199 hid_end_parse(struct hid_data *s)
207 /*------------------------------------------------------------------------*
208 * get byte from HID descriptor
209 *------------------------------------------------------------------------*/
211 hid_get_byte(struct hid_data *s, const uint16_t wSize)
218 /* check if end is reached */
222 /* read out a byte */
225 /* check if data pointer can be advanced by "wSize" bytes */
226 if ((s->end - ptr) < wSize)
237 /*------------------------------------------------------------------------*
239 *------------------------------------------------------------------------*/
241 hid_get_item(struct hid_data *s, struct hid_item *h)
244 unsigned int bTag, bType, bSize;
252 c = &s->cur[s->pushlevel];
255 /* check if there is an array of items */
256 if (s->icount < s->ncount) {
257 /* get current usage */
258 if (s->iusage < s->nusage) {
259 dval = s->usages_min[s->iusage] + s->ousage;
261 s->usage_last = dval;
262 if (dval == s->usages_max[s->iusage]) {
269 DPRINTFN(1, "Using last usage\n");
270 dval = s->usage_last;
274 * Only copy HID item, increment position and return
275 * if correct kindset!
277 if (s->kindset & (1 << c->kind)) {
279 DPRINTFN(1, "%u,%u,%u\n", h->loc.pos,
280 h->loc.size, h->loc.count);
281 c->loc.pos += c->loc.size * c->loc.count;
286 /* reset state variables */
296 while (s->p != s->end) {
298 bSize = hid_get_byte(s, 1);
301 bSize = hid_get_byte(s, 1);
302 bSize |= hid_get_byte(s, 1) << 8;
303 bTag = hid_get_byte(s, 1);
304 bType = 0xff; /* XXX what should it be */
308 bType = (bSize >> 2) & 3;
319 dval = (int8_t)hid_get_byte(s, 1);
323 dval = hid_get_byte(s, 1);
324 dval |= hid_get_byte(s, 1) << 8;
325 dval = (int16_t)dval;
329 dval = hid_get_byte(s, 1);
330 dval |= hid_get_byte(s, 1) << 8;
331 dval |= hid_get_byte(s, 1) << 16;
332 dval |= hid_get_byte(s, 1) << 24;
336 dval = hid_get_byte(s, bSize);
337 DPRINTFN(0, "bad length %u (data=0x%02x)\n",
349 c->loc.count = s->loc_count;
350 c->loc.size = s->loc_size;
352 if (c->flags & HIO_VARIABLE) {
353 /* range check usage count */
354 if (c->loc.count > 255) {
355 DPRINTFN(0, "Number of "
356 "items truncated to 255\n");
359 s->ncount = c->loc.count;
362 * The "top" loop will return
372 c->kind = hid_output;
375 case 10: /* Collection */
376 c->kind = hid_collection;
377 c->collection = dval;
379 c->usage = s->usage_last;
382 case 11: /* Feature */
383 c->kind = hid_feature;
386 case 12: /* End collection */
387 c->kind = hid_endcollection;
388 if (c->collevel == 0) {
389 DPRINTFN(0, "invalid end collection\n");
396 DPRINTFN(0, "Main bTag=%d\n", bTag);
403 c->_usage_page = dval << 16;
406 c->logical_minimum = dval;
409 c->logical_maximum = dval;
412 c->physical_minimum = dval;
415 c->physical_maximum = dval;
418 c->unit_exponent = dval;
424 /* mask because value is unsigned */
425 s->loc_size = dval & mask;
428 hid_switch_rid(s, c, dval & mask);
431 /* mask because value is unsigned */
432 s->loc_count = dval & mask;
436 if (s->pushlevel < MAXPUSH) {
437 s->cur[s->pushlevel] = *c;
438 /* store size and count */
439 c->loc.size = s->loc_size;
440 c->loc.count = s->loc_count;
441 /* update current item pointer */
442 c = &s->cur[s->pushlevel];
444 DPRINTFN(0, "Cannot push "
445 "item @ %d\n", s->pushlevel);
450 if (s->pushlevel < MAXPUSH) {
451 /* preserve position */
453 c = &s->cur[s->pushlevel];
454 /* restore size and count */
455 s->loc_size = c->loc.size;
456 s->loc_count = c->loc.count;
457 /* set default item location */
462 DPRINTFN(0, "Cannot pop "
463 "item @ %d\n", s->pushlevel);
467 DPRINTFN(0, "Global bTag=%d\n", bTag);
475 dval = (dval & mask) | c->_usage_page;
477 /* set last usage, in case of a collection */
478 s->usage_last = dval;
480 if (s->nusage < MAXUSAGE) {
481 s->usages_min[s->nusage] = dval;
482 s->usages_max[s->nusage] = dval;
485 DPRINTFN(0, "max usage reached\n");
488 /* clear any pending usage sets */
495 dval = (dval & mask) | c->_usage_page;
496 c->usage_minimum = dval;
503 dval = (dval & mask) | c->_usage_page;
504 c->usage_maximum = dval;
511 if ((s->nusage < MAXUSAGE) &&
512 (c->usage_minimum <= c->usage_maximum)) {
513 /* add usage range */
514 s->usages_min[s->nusage] =
516 s->usages_max[s->nusage] =
520 DPRINTFN(0, "Usage set dropped\n");
525 c->designator_index = dval;
528 c->designator_minimum = dval;
531 c->designator_maximum = dval;
534 c->string_index = dval;
537 c->string_minimum = dval;
540 c->string_maximum = dval;
543 c->set_delimiter = dval;
546 DPRINTFN(0, "Local bTag=%d\n", bTag);
551 DPRINTFN(0, "default bType=%d\n", bType);
558 /*------------------------------------------------------------------------*
560 *------------------------------------------------------------------------*/
562 hid_report_size(const void *buf, usb_size_t len, enum hid_kind k, uint8_t *id)
575 for (d = hid_start_parse(buf, len, 1 << k); hid_get_item(d, &h);) {
577 /* check for ID-byte presense */
578 if ((h.report_ID != 0) && !any_id) {
583 /* compute minimum */
584 if (lpos > h.loc.pos)
586 /* compute end position */
587 temp = h.loc.pos + (h.loc.size * h.loc.count);
588 /* compute maximum */
595 /* safety check - can happen in case of currupt descriptors */
601 /* check for ID byte */
607 /* return length in bytes rounded up */
608 return ((temp + 7) / 8);
611 /*------------------------------------------------------------------------*
613 *------------------------------------------------------------------------*/
615 hid_locate(const void *desc, usb_size_t size, int32_t u, enum hid_kind k,
616 uint8_t index, struct hid_location *loc, uint32_t *flags, uint8_t *id)
621 for (d = hid_start_parse(desc, size, 1 << k); hid_get_item(d, &h);) {
622 if (h.kind == k && !(h.flags & HIO_CONST) && h.usage == u) {
645 /*------------------------------------------------------------------------*
647 *------------------------------------------------------------------------*/
649 hid_get_data_sub(const uint8_t *buf, usb_size_t len, struct hid_location *loc,
652 uint32_t hpos = loc->pos;
653 uint32_t hsize = loc->size;
658 DPRINTFN(11, "hid_get_data: loc %d/%d\n", hpos, hsize);
660 /* Range check and limit */
666 /* Get data in a safe way */
674 data |= buf[rpos] << (8 * n);
677 /* Correctly shift down data */
678 data = (data >> (hpos % 8));
681 /* Mask and sign extend in one */
683 data = (int32_t)((int32_t)data << n) >> n;
685 data = (uint32_t)((uint32_t)data << n) >> n;
687 DPRINTFN(11, "hid_get_data: loc %d/%d = %lu\n",
688 loc->pos, loc->size, (long)data);
693 hid_get_data(const uint8_t *buf, usb_size_t len, struct hid_location *loc)
695 return (hid_get_data_sub(buf, len, loc, 1));
699 hid_get_data_unsigned(const uint8_t *buf, usb_size_t len, struct hid_location *loc)
701 return (hid_get_data_sub(buf, len, loc, 0));
704 /*------------------------------------------------------------------------*
706 *------------------------------------------------------------------------*/
708 hid_put_data_unsigned(uint8_t *buf, usb_size_t len,
709 struct hid_location *loc, unsigned int value)
711 uint32_t hpos = loc->pos;
712 uint32_t hsize = loc->size;
718 DPRINTFN(11, "hid_put_data: loc %d/%d = %u\n", hpos, hsize, value);
720 /* Range check and limit */
726 /* Put data in a safe way */
729 data = ((uint64_t)value) << (hpos % 8);
730 mask = ((1ULL << hsize) - 1ULL) << (hpos % 8);
735 buf[rpos] &= ~(mask >> (8 * n));
736 buf[rpos] |= (data >> (8 * n));
741 /*------------------------------------------------------------------------*
743 *------------------------------------------------------------------------*/
745 hid_is_collection(const void *desc, usb_size_t size, int32_t usage)
751 hd = hid_start_parse(desc, size, hid_input);
755 while ((err = hid_get_item(hd, &hi))) {
756 if (hi.kind == hid_collection &&
764 /*------------------------------------------------------------------------*
765 * hid_get_descriptor_from_usb
767 * This function will search for a HID descriptor between two USB
768 * interface descriptors.
771 * NULL: No more HID descriptors.
772 * Else: Pointer to HID descriptor.
773 *------------------------------------------------------------------------*/
774 struct usb_hid_descriptor *
775 hid_get_descriptor_from_usb(struct usb_config_descriptor *cd,
776 struct usb_interface_descriptor *id)
778 struct usb_descriptor *desc = (void *)id;
783 while ((desc = usb_desc_foreach(cd, desc))) {
784 if ((desc->bDescriptorType == UDESC_HID) &&
785 (desc->bLength >= USB_HID_DESCRIPTOR_SIZE(0))) {
788 if (desc->bDescriptorType == UDESC_INTERFACE) {
795 /*------------------------------------------------------------------------*
796 * usbd_req_get_hid_desc
798 * This function will read out an USB report descriptor from the USB
803 * Else: Success. The pointer should eventually be passed to free().
804 *------------------------------------------------------------------------*/
806 usbd_req_get_hid_desc(struct usb_device *udev, struct mtx *mtx,
807 void **descp, uint16_t *sizep,
808 struct malloc_type *mem, uint8_t iface_index)
810 struct usb_interface *iface = usbd_get_iface(udev, iface_index);
811 struct usb_hid_descriptor *hid;
814 if ((iface == NULL) || (iface->idesc == NULL)) {
815 return (USB_ERR_INVAL);
817 hid = hid_get_descriptor_from_usb
818 (usbd_get_config_descriptor(udev), iface->idesc);
821 return (USB_ERR_IOERROR);
823 *sizep = UGETW(hid->descrs[0].wDescriptorLength);
825 return (USB_ERR_IOERROR);
830 *descp = malloc(*sizep, mem, M_ZERO | M_WAITOK);
835 if (*descp == NULL) {
836 return (USB_ERR_NOMEM);
838 err = usbd_req_get_report_descriptor
839 (udev, mtx, *descp, *sizep, iface_index);
846 return (USB_ERR_NORMAL_COMPLETION);
849 /*------------------------------------------------------------------------*
852 * This function will decide if a USB descriptor belongs to a USB mouse.
855 * Zero: Not a USB mouse.
856 * Else: Is a USB mouse.
857 *------------------------------------------------------------------------*/
859 hid_is_mouse(const void *d_ptr, uint16_t d_len)
866 hd = hid_start_parse(d_ptr, d_len, 1 << hid_input);
873 while (hid_get_item(hd, &hi)) {
878 else if (hi.collection == 1 &&
880 HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_MOUSE))
883 case hid_endcollection:
891 HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_X) &&
892 (hi.flags & (HIO_CONST|HIO_RELATIVE)) == HIO_RELATIVE)
895 HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_Y) &&
896 (hi.flags & (HIO_CONST|HIO_RELATIVE)) == HIO_RELATIVE)
907 /*------------------------------------------------------------------------*
910 * This function will decide if a USB descriptor belongs to a USB keyboard.
913 * Zero: Not a USB keyboard.
914 * Else: Is a USB keyboard.
915 *------------------------------------------------------------------------*/
917 hid_is_keyboard(const void *d_ptr, uint16_t d_len)
919 if (hid_is_collection(d_ptr, d_len,
920 HID_USAGE2(HUP_GENERIC_DESKTOP, HUG_KEYBOARD)))