2 * $NetBSD: uhid.c,v 1.46 2001/11/13 06:24:55 lukem Exp $
3 * $FreeBSD: src/sys/dev/usb/uhid.c,v 1.65 2003/11/09 09:17:22 tanimura Exp $
4 * $DragonFly: src/sys/dev/usbmisc/uhid/uhid.c,v 1.33 2008/08/14 20:55:53 hasso Exp $
7 /* Also already merged from NetBSD:
8 * $NetBSD: uhid.c,v 1.54 2002/09/23 05:51:21 simonb Exp $
12 * Copyright (c) 1998 The NetBSD Foundation, Inc.
13 * All rights reserved.
15 * This code is derived from software contributed to The NetBSD Foundation
16 * by Lennart Augustsson (lennart@augustsson.net) at
17 * Carlstedt Research & Technology.
19 * Redistribution and use in source and binary forms, with or without
20 * modification, are permitted provided that the following conditions
22 * 1. Redistributions of source code must retain the above copyright
23 * notice, this list of conditions and the following disclaimer.
24 * 2. Redistributions in binary form must reproduce the above copyright
25 * notice, this list of conditions and the following disclaimer in the
26 * documentation and/or other materials provided with the distribution.
27 * 3. All advertising materials mentioning features or use of this software
28 * must display the following acknowledgement:
29 * This product includes software developed by the NetBSD
30 * Foundation, Inc. and its contributors.
31 * 4. Neither the name of The NetBSD Foundation nor the names of its
32 * contributors may be used to endorse or promote products derived
33 * from this software without specific prior written permission.
35 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
36 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
37 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
38 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
39 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
40 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
41 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
42 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
43 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
44 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
45 * POSSIBILITY OF SUCH DAMAGE.
49 * HID spec: http://www.usb.org/developers/data/usbhid10.pdf
52 #include <sys/param.h>
53 #include <sys/systm.h>
54 #include <sys/kernel.h>
56 #include <sys/malloc.h>
57 #include <sys/signalvar.h>
58 #include <sys/filio.h>
59 #include <sys/module.h>
63 #include <sys/select.h>
65 #include <sys/vnode.h>
67 #include <sys/event.h>
68 #include <sys/sysctl.h>
69 #include <sys/thread2.h>
71 #include <bus/usb/usb.h>
72 #include <bus/usb/usbhid.h>
74 #include <bus/usb/usbdi.h>
75 #include <bus/usb/usbdi_util.h>
76 #include <bus/usb/hid.h>
78 /* Report descriptor for broken Wacom Graphire */
79 #include <bus/usb/ugraphire_rdesc.h>
82 #define DPRINTF(x) if (uhiddebug) kprintf x
83 #define DPRINTFN(n,x) if (uhiddebug>(n)) kprintf x
85 SYSCTL_NODE(_hw_usb, OID_AUTO, uhid, CTLFLAG_RW, 0, "USB uhid");
86 SYSCTL_INT(_hw_usb_uhid, OID_AUTO, debug, CTLFLAG_RW,
87 &uhiddebug, 0, "uhid debug level");
94 device_t sc_dev; /* base device */
95 usbd_device_handle sc_udev;
96 usbd_interface_handle sc_iface; /* interface */
97 usbd_pipe_handle sc_intrpipe; /* interrupt pipe */
114 struct selinfo sc_rsel;
115 struct proc *sc_async; /* process that wants SIGIO */
116 u_char sc_state; /* driver state */
117 #define UHID_OPEN 0x01 /* device is open */
118 #define UHID_ASLP 0x02 /* waiting for device data */
119 #define UHID_NEEDCLEAR 0x04 /* needs clearing endpoint stall */
120 #define UHID_IMMED 0x08 /* return read data immediately */
126 #define UHIDUNIT(dev) (minor(dev))
127 #define UHID_CHUNK 128 /* chunk size for read */
128 #define UHID_BSIZE 1020 /* buffer size */
136 d_kqfilter_t uhidkqfilter;
138 static void uhidfilt_detach(struct knote *);
139 static int uhidfilt_read(struct knote *, long);
140 static int uhidfilt_write(struct knote *, long);
142 #define UHID_CDEV_MAJOR 122
144 static struct dev_ops uhid_ops = {
145 { "uhid", UHID_CDEV_MAJOR, D_KQFILTER },
147 .d_close = uhidclose,
149 .d_write = uhidwrite,
150 .d_ioctl = uhidioctl,
152 .d_kqfilter = uhidkqfilter
155 static void uhid_intr(usbd_xfer_handle, usbd_private_handle,
158 static int uhid_do_read(struct uhid_softc *, struct uio *uio, int);
159 static int uhid_do_write(struct uhid_softc *, struct uio *uio, int);
160 static int uhid_do_ioctl(struct uhid_softc *, u_long, caddr_t, int);
162 static device_probe_t uhid_match;
163 static device_attach_t uhid_attach;
164 static device_detach_t uhid_detach;
166 static devclass_t uhid_devclass;
168 static kobj_method_t uhid_methods[] = {
169 DEVMETHOD(device_probe, uhid_match),
170 DEVMETHOD(device_attach, uhid_attach),
171 DEVMETHOD(device_detach, uhid_detach),
175 static driver_t uhid_driver = {
178 sizeof(struct uhid_softc)
181 MODULE_DEPEND(uhid, usb, 1, 1, 1);
184 uhid_match(device_t self)
186 struct usb_attach_arg *uaa = device_get_ivars(self);
187 usb_interface_descriptor_t *id;
189 if (uaa->iface == NULL)
190 return (UMATCH_NONE);
191 id = usbd_get_interface_descriptor(uaa->iface);
192 if (id == NULL || id->bInterfaceClass != UICLASS_HID)
193 return (UMATCH_NONE);
195 return (uaa->matchlvl);
196 return (UMATCH_IFACECLASS_GENERIC);
200 uhid_attach(device_t self)
202 struct uhid_softc *sc = device_get_softc(self);
203 struct usb_attach_arg *uaa = device_get_ivars(self);
204 usbd_interface_handle iface = uaa->iface;
205 usb_endpoint_descriptor_t *ed;
210 sc->sc_udev = uaa->device;
211 sc->sc_iface = iface;
214 ed = usbd_interface2endpoint_descriptor(iface, 0);
216 kprintf("%s: could not read endpoint descriptor\n",
217 device_get_nameunit(sc->sc_dev));
222 DPRINTFN(10,("uhid_attach: bLength=%d bDescriptorType=%d "
223 "bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d"
225 ed->bLength, ed->bDescriptorType,
226 ed->bEndpointAddress & UE_ADDR,
227 UE_GET_DIR(ed->bEndpointAddress)==UE_DIR_IN? "in" : "out",
228 ed->bmAttributes & UE_XFERTYPE,
229 UGETW(ed->wMaxPacketSize), ed->bInterval));
231 if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_IN ||
232 (ed->bmAttributes & UE_XFERTYPE) != UE_INTERRUPT) {
233 kprintf("%s: unexpected endpoint\n", device_get_nameunit(sc->sc_dev));
238 sc->sc_ep_addr = ed->bEndpointAddress;
240 /* The report descriptor for the Wacom Graphire is broken. */
241 if (uaa->vendor == 0x056a && uaa->product == 0x0010 /* &&
242 uaa->revision == 0x???? */) { /* XXX should use revision */
243 size = sizeof uhid_graphire_report_descr;
244 desc = kmalloc(size, M_USBDEV, M_INTWAIT);
245 err = USBD_NORMAL_COMPLETION;
246 memcpy(desc, uhid_graphire_report_descr, size);
249 err = usbd_read_report_desc(uaa->iface, &desc, &size,M_USBDEV);
253 kprintf("%s: no report descriptor\n", device_get_nameunit(sc->sc_dev));
258 (void)usbd_set_idle(iface, 0, 0);
260 sc->sc_isize = hid_report_size(desc, size, hid_input, &sc->sc_iid);
261 sc->sc_osize = hid_report_size(desc, size, hid_output, &sc->sc_oid);
262 sc->sc_fsize = hid_report_size(desc, size, hid_feature, &sc->sc_fid);
264 sc->sc_repdesc = desc;
265 sc->sc_repdesc_size = size;
267 make_dev(&uhid_ops, device_get_unit(self),
268 UID_ROOT, GID_OPERATOR,
269 0644, "uhid%d", device_get_unit(self));
275 uhid_detach(device_t self)
277 struct uhid_softc *sc = device_get_softc(self);
279 DPRINTF(("uhid_detach: sc=%p\n", sc));
282 if (sc->sc_intrpipe != NULL)
283 usbd_abort_pipe(sc->sc_intrpipe);
285 if (sc->sc_state & UHID_OPEN) {
287 if (--sc->sc_refcnt >= 0) {
290 /* Wait for processes to go away. */
291 usb_detach_wait(sc->sc_dev);
296 dev_ops_remove_minor(&uhid_ops, device_get_unit(self));
299 kfree(sc->sc_repdesc, M_USBDEV);
305 uhid_intr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status)
307 struct uhid_softc *sc = addr;
313 usbd_get_xfer_status(xfer, NULL, NULL, &cc, NULL);
314 DPRINTF(("uhid_intr: status=%d cc=%d\n", status, cc));
315 DPRINTF(("uhid_intr: data ="));
316 for (i = 0; i < cc; i++)
317 DPRINTF((" %02x", sc->sc_ibuf[i]));
322 if (status == USBD_CANCELLED)
325 if (status != USBD_NORMAL_COMPLETION) {
326 DPRINTF(("uhid_intr: status=%d\n", status));
327 if (status == USBD_STALLED)
328 sc->sc_state |= UHID_NEEDCLEAR;
332 (void) b_to_q(sc->sc_ibuf, sc->sc_isize, &sc->sc_q);
334 if (sc->sc_state & UHID_ASLP) {
335 sc->sc_state &= ~UHID_ASLP;
336 DPRINTFN(5, ("uhid_intr: waking %p\n", &sc->sc_q));
339 selwakeup(&sc->sc_rsel);
340 if (sc->sc_async != NULL) {
341 DPRINTFN(3, ("uhid_intr: sending SIGIO %p\n", sc->sc_async));
342 ksignal(sc->sc_async, SIGIO);
347 uhidopen(struct dev_open_args *ap)
349 cdev_t dev = ap->a_head.a_dev;
350 struct uhid_softc *sc;
353 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
357 DPRINTF(("uhidopen: sc=%p\n", sc));
362 if (sc->sc_state & UHID_OPEN)
364 sc->sc_state |= UHID_OPEN;
366 if ((clist_alloc_cblocks(&sc->sc_q, UHID_BSIZE,
367 UHID_BSIZE), 0) == -1) {
368 sc->sc_state &= ~UHID_OPEN;
372 sc->sc_ibuf = kmalloc(sc->sc_isize, M_USBDEV, M_WAITOK);
373 sc->sc_obuf = kmalloc(sc->sc_osize, M_USBDEV, M_WAITOK);
375 /* Set up interrupt pipe. */
376 err = usbd_open_pipe_intr(sc->sc_iface, sc->sc_ep_addr,
377 USBD_SHORT_XFER_OK, &sc->sc_intrpipe, sc, sc->sc_ibuf,
378 sc->sc_isize, uhid_intr, USBD_DEFAULT_INTERVAL);
380 DPRINTF(("uhidopen: usbd_open_pipe_intr failed, "
382 kfree(sc->sc_ibuf, M_USBDEV);
383 kfree(sc->sc_obuf, M_USBDEV);
384 sc->sc_ibuf = sc->sc_obuf = NULL;
386 sc->sc_state &= ~UHID_OPEN;
390 sc->sc_state &= ~UHID_IMMED;
398 uhidclose(struct dev_close_args *ap)
400 cdev_t dev = ap->a_head.a_dev;
401 struct uhid_softc *sc;
403 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
405 DPRINTF(("uhidclose: sc=%p\n", sc));
407 /* Disable interrupts. */
408 usbd_abort_pipe(sc->sc_intrpipe);
409 usbd_close_pipe(sc->sc_intrpipe);
412 ndflush(&sc->sc_q, sc->sc_q.c_cc);
413 clist_free_cblocks(&sc->sc_q);
415 kfree(sc->sc_ibuf, M_USBDEV);
416 kfree(sc->sc_obuf, M_USBDEV);
417 sc->sc_ibuf = sc->sc_obuf = NULL;
419 sc->sc_state &= ~UHID_OPEN;
427 uhid_do_read(struct uhid_softc *sc, struct uio *uio, int flag)
431 u_char buffer[UHID_CHUNK];
434 DPRINTFN(1, ("uhidread\n"));
435 if (sc->sc_state & UHID_IMMED) {
436 DPRINTFN(1, ("uhidread immed\n"));
438 err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
439 sc->sc_iid, buffer, sc->sc_isize);
442 return (uiomove(buffer, sc->sc_isize, uio));
446 while (sc->sc_q.c_cc == 0) {
447 if (flag & IO_NDELAY) {
449 return (EWOULDBLOCK);
451 sc->sc_state |= UHID_ASLP;
452 DPRINTFN(5, ("uhidread: sleep on %p\n", &sc->sc_q));
453 error = tsleep(&sc->sc_q, PCATCH, "uhidrea", 0);
454 DPRINTFN(5, ("uhidread: woke, error=%d\n", error));
458 sc->sc_state &= ~UHID_ASLP;
461 if (sc->sc_state & UHID_NEEDCLEAR) {
462 DPRINTFN(-1,("uhidread: clearing stall\n"));
463 sc->sc_state &= ~UHID_NEEDCLEAR;
464 usbd_clear_endpoint_stall(sc->sc_intrpipe);
469 /* Transfer as many chunks as possible. */
470 while (sc->sc_q.c_cc > 0 && uio->uio_resid > 0 && !error) {
471 length = szmin(sc->sc_q.c_cc, uio->uio_resid);
472 if (length > sizeof(buffer))
473 length = sizeof(buffer);
475 /* Remove a small chunk from the input queue. */
476 (void) q_to_b(&sc->sc_q, buffer, length);
477 DPRINTFN(5, ("uhidread: got %lu chars\n", (u_long)length));
479 /* Copy the data to the user process. */
480 if ((error = uiomove(buffer, length, uio)) != 0)
488 uhidread(struct dev_read_args *ap)
490 cdev_t dev = ap->a_head.a_dev;
491 struct uhid_softc *sc;
494 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
497 error = uhid_do_read(sc, ap->a_uio, ap->a_ioflag);
498 if (--sc->sc_refcnt < 0)
499 usb_detach_wakeup(sc->sc_dev);
504 uhid_do_write(struct uhid_softc *sc, struct uio *uio, int flag)
510 DPRINTFN(1, ("uhidwrite\n"));
516 if (uio->uio_resid != size)
518 error = uiomove(sc->sc_obuf, size, uio);
521 err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
522 sc->sc_obuf[0], sc->sc_obuf+1, size-1);
524 err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
525 0, sc->sc_obuf, size);
534 uhidwrite(struct dev_write_args *ap)
536 cdev_t dev = ap->a_head.a_dev;
537 struct uhid_softc *sc;
540 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
543 error = uhid_do_write(sc, ap->a_uio, ap->a_ioflag);
544 if (--sc->sc_refcnt < 0)
545 usb_detach_wakeup(sc->sc_dev);
550 uhid_do_ioctl(struct uhid_softc *sc, u_long cmd, caddr_t addr, int flag)
552 struct usb_ctl_report_desc *rd;
553 struct usb_ctl_report *re;
557 DPRINTFN(2, ("uhidioctl: cmd=%lx\n", cmd));
565 if (sc->sc_async != NULL)
567 sc->sc_async = curproc;
568 DPRINTF(("uhid_do_ioctl: FIOASYNC %p\n", sc->sc_async));
573 /* XXX this is not the most general solution. */
575 if (sc->sc_async == NULL)
577 if (*(int *)addr != sc->sc_async->p_pgid)
581 case USB_GET_REPORT_DESC:
582 rd = (struct usb_ctl_report_desc *)addr;
583 size = min(sc->sc_repdesc_size, sizeof rd->ucrd_data);
584 rd->ucrd_size = size;
585 memcpy(rd->ucrd_data, sc->sc_repdesc, size);
590 /* XXX should read into ibuf, but does it matter? */
591 err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
592 sc->sc_iid, sc->sc_ibuf, sc->sc_isize);
596 sc->sc_state |= UHID_IMMED;
598 sc->sc_state &= ~UHID_IMMED;
602 re = (struct usb_ctl_report *)addr;
603 switch (re->ucr_report) {
604 case UHID_INPUT_REPORT:
608 case UHID_OUTPUT_REPORT:
612 case UHID_FEATURE_REPORT:
619 err = usbd_get_report(sc->sc_iface, re->ucr_report, id, re->ucr_data,
626 re = (struct usb_ctl_report *)addr;
627 switch (re->ucr_report) {
628 case UHID_INPUT_REPORT:
632 case UHID_OUTPUT_REPORT:
636 case UHID_FEATURE_REPORT:
643 err = usbd_set_report(sc->sc_iface, re->ucr_report, id, re->ucr_data,
649 case USB_GET_REPORT_ID:
650 *(int *)addr = 0; /* XXX: we only support reportid 0? */
660 uhidioctl(struct dev_ioctl_args *ap)
662 cdev_t dev = ap->a_head.a_dev;
663 struct uhid_softc *sc;
666 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
669 error = uhid_do_ioctl(sc, ap->a_cmd, ap->a_data, ap->a_fflag);
670 if (--sc->sc_refcnt < 0)
671 usb_detach_wakeup(sc->sc_dev);
676 uhidpoll(struct dev_poll_args *ap)
678 cdev_t dev = ap->a_head.a_dev;
679 struct uhid_softc *sc;
682 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
688 if (ap->a_events & (POLLOUT | POLLWRNORM))
689 revents |= ap->a_events & (POLLOUT | POLLWRNORM);
690 if (ap->a_events & (POLLIN | POLLRDNORM)) {
691 if (sc->sc_q.c_cc > 0)
692 revents |= ap->a_events & (POLLIN | POLLRDNORM);
694 selrecord(curthread, &sc->sc_rsel);
697 ap->a_events = revents;
701 static struct filterops uhidfiltops_read =
702 { 1, NULL, uhidfilt_detach, uhidfilt_read };
703 static struct filterops uhidfiltops_write =
704 { 1, NULL, uhidfilt_detach, uhidfilt_write };
707 uhidkqfilter(struct dev_kqfilter_args *ap)
709 cdev_t dev = ap->a_head.a_dev;
710 struct knote *kn = ap->a_kn;
711 struct uhid_softc *sc;
714 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
723 switch (kn->kn_filter) {
725 kn->kn_fop = &uhidfiltops_read;
726 kn->kn_hook = (caddr_t)sc;
729 kn->kn_fop = &uhidfiltops_write;
730 kn->kn_hook = (caddr_t)sc;
738 klist = &sc->sc_rsel.si_note;
739 SLIST_INSERT_HEAD(klist, kn, kn_selnext);
746 uhidfilt_detach(struct knote *kn)
748 cdev_t dev = (cdev_t)kn->kn_hook;
749 struct uhid_softc *sc;
752 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
755 klist = &sc->sc_rsel.si_note;
756 SLIST_REMOVE(klist, kn, knote, kn_selnext);
761 uhidfilt_read(struct knote *kn, long hint)
763 cdev_t dev = (cdev_t)kn->kn_hook;
764 struct uhid_softc *sc;
767 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
770 if (sc->sc_q.c_cc > 0)
778 uhidfilt_write(struct knote *kn, long hint)
783 DRIVER_MODULE(uhid, uhub, uhid_driver, uhid_devclass, usbd_driver_load, 0);