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>
66 #include <sys/event.h>
67 #include <sys/sysctl.h>
68 #include <sys/thread2.h>
70 #include <bus/usb/usb.h>
71 #include <bus/usb/usbhid.h>
73 #include <bus/usb/usbdi.h>
74 #include <bus/usb/usbdi_util.h>
75 #include <bus/usb/hid.h>
77 /* Report descriptor for broken Wacom Graphire */
78 #include <bus/usb/ugraphire_rdesc.h>
81 #define DPRINTF(x) if (uhiddebug) kprintf x
82 #define DPRINTFN(n,x) if (uhiddebug>(n)) kprintf x
84 SYSCTL_NODE(_hw_usb, OID_AUTO, uhid, CTLFLAG_RW, 0, "USB uhid");
85 SYSCTL_INT(_hw_usb_uhid, OID_AUTO, debug, CTLFLAG_RW,
86 &uhiddebug, 0, "uhid debug level");
93 device_t sc_dev; /* base device */
94 usbd_device_handle sc_udev;
95 usbd_interface_handle sc_iface; /* interface */
96 usbd_pipe_handle sc_intrpipe; /* interrupt pipe */
113 struct selinfo sc_rsel;
114 struct proc *sc_async; /* process that wants SIGIO */
115 u_char sc_state; /* driver state */
116 #define UHID_OPEN 0x01 /* device is open */
117 #define UHID_ASLP 0x02 /* waiting for device data */
118 #define UHID_NEEDCLEAR 0x04 /* needs clearing endpoint stall */
119 #define UHID_IMMED 0x08 /* return read data immediately */
125 #define UHIDUNIT(dev) (minor(dev))
126 #define UHID_CHUNK 128 /* chunk size for read */
127 #define UHID_BSIZE 1020 /* buffer size */
134 d_kqfilter_t uhidkqfilter;
136 static void uhidfilt_detach(struct knote *);
137 static int uhidfilt_read(struct knote *, long);
138 static int uhidfilt_write(struct knote *, long);
140 #define UHID_CDEV_MAJOR 122
142 static struct dev_ops uhid_ops = {
143 { "uhid", UHID_CDEV_MAJOR, D_KQFILTER },
145 .d_close = uhidclose,
147 .d_write = uhidwrite,
148 .d_ioctl = uhidioctl,
149 .d_kqfilter = uhidkqfilter
152 static void uhid_intr(usbd_xfer_handle, usbd_private_handle,
155 static int uhid_do_read(struct uhid_softc *, struct uio *uio, int);
156 static int uhid_do_write(struct uhid_softc *, struct uio *uio, int);
157 static int uhid_do_ioctl(struct uhid_softc *, u_long, caddr_t, int);
159 static device_probe_t uhid_match;
160 static device_attach_t uhid_attach;
161 static device_detach_t uhid_detach;
163 static devclass_t uhid_devclass;
165 static kobj_method_t uhid_methods[] = {
166 DEVMETHOD(device_probe, uhid_match),
167 DEVMETHOD(device_attach, uhid_attach),
168 DEVMETHOD(device_detach, uhid_detach),
172 static driver_t uhid_driver = {
175 sizeof(struct uhid_softc)
178 MODULE_DEPEND(uhid, usb, 1, 1, 1);
181 uhid_match(device_t self)
183 struct usb_attach_arg *uaa = device_get_ivars(self);
184 usb_interface_descriptor_t *id;
186 if (uaa->iface == NULL)
187 return (UMATCH_NONE);
188 id = usbd_get_interface_descriptor(uaa->iface);
189 if (id == NULL || id->bInterfaceClass != UICLASS_HID)
190 return (UMATCH_NONE);
192 return (uaa->matchlvl);
193 return (UMATCH_IFACECLASS_GENERIC);
197 uhid_attach(device_t self)
199 struct uhid_softc *sc = device_get_softc(self);
200 struct usb_attach_arg *uaa = device_get_ivars(self);
201 usbd_interface_handle iface = uaa->iface;
202 usb_endpoint_descriptor_t *ed;
207 sc->sc_udev = uaa->device;
208 sc->sc_iface = iface;
211 ed = usbd_interface2endpoint_descriptor(iface, 0);
213 kprintf("%s: could not read endpoint descriptor\n",
214 device_get_nameunit(sc->sc_dev));
219 DPRINTFN(10,("uhid_attach: bLength=%d bDescriptorType=%d "
220 "bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d"
222 ed->bLength, ed->bDescriptorType,
223 ed->bEndpointAddress & UE_ADDR,
224 UE_GET_DIR(ed->bEndpointAddress)==UE_DIR_IN? "in" : "out",
225 ed->bmAttributes & UE_XFERTYPE,
226 UGETW(ed->wMaxPacketSize), ed->bInterval));
228 if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_IN ||
229 (ed->bmAttributes & UE_XFERTYPE) != UE_INTERRUPT) {
230 kprintf("%s: unexpected endpoint\n", device_get_nameunit(sc->sc_dev));
235 sc->sc_ep_addr = ed->bEndpointAddress;
237 /* The report descriptor for the Wacom Graphire is broken. */
238 if (uaa->vendor == 0x056a && uaa->product == 0x0010 /* &&
239 uaa->revision == 0x???? */) { /* XXX should use revision */
240 size = sizeof uhid_graphire_report_descr;
241 desc = kmalloc(size, M_USBDEV, M_INTWAIT);
242 err = USBD_NORMAL_COMPLETION;
243 memcpy(desc, uhid_graphire_report_descr, size);
246 err = usbd_read_report_desc(uaa->iface, &desc, &size,M_USBDEV);
250 kprintf("%s: no report descriptor\n", device_get_nameunit(sc->sc_dev));
255 (void)usbd_set_idle(iface, 0, 0);
257 sc->sc_isize = hid_report_size(desc, size, hid_input, &sc->sc_iid);
258 sc->sc_osize = hid_report_size(desc, size, hid_output, &sc->sc_oid);
259 sc->sc_fsize = hid_report_size(desc, size, hid_feature, &sc->sc_fid);
261 sc->sc_repdesc = desc;
262 sc->sc_repdesc_size = size;
264 make_dev(&uhid_ops, device_get_unit(self),
265 UID_ROOT, GID_OPERATOR,
266 0644, "uhid%d", device_get_unit(self));
272 uhid_detach(device_t self)
274 struct uhid_softc *sc = device_get_softc(self);
276 DPRINTF(("uhid_detach: sc=%p\n", sc));
279 if (sc->sc_intrpipe != NULL)
280 usbd_abort_pipe(sc->sc_intrpipe);
282 if (sc->sc_state & UHID_OPEN) {
284 if (--sc->sc_refcnt >= 0) {
287 /* Wait for processes to go away. */
288 usb_detach_wait(sc->sc_dev);
293 dev_ops_remove_minor(&uhid_ops, device_get_unit(self));
296 kfree(sc->sc_repdesc, M_USBDEV);
302 uhid_intr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status)
304 struct uhid_softc *sc = addr;
310 usbd_get_xfer_status(xfer, NULL, NULL, &cc, NULL);
311 DPRINTF(("uhid_intr: status=%d cc=%d\n", status, cc));
312 DPRINTF(("uhid_intr: data ="));
313 for (i = 0; i < cc; i++)
314 DPRINTF((" %02x", sc->sc_ibuf[i]));
319 if (status == USBD_CANCELLED)
322 if (status != USBD_NORMAL_COMPLETION) {
323 DPRINTF(("uhid_intr: status=%d\n", status));
324 if (status == USBD_STALLED)
325 sc->sc_state |= UHID_NEEDCLEAR;
329 (void) b_to_q(sc->sc_ibuf, sc->sc_isize, &sc->sc_q);
331 if (sc->sc_state & UHID_ASLP) {
332 sc->sc_state &= ~UHID_ASLP;
333 DPRINTFN(5, ("uhid_intr: waking %p\n", &sc->sc_q));
336 selwakeup(&sc->sc_rsel);
337 if (sc->sc_async != NULL) {
338 DPRINTFN(3, ("uhid_intr: sending SIGIO %p\n", sc->sc_async));
339 ksignal(sc->sc_async, SIGIO);
344 uhidopen(struct dev_open_args *ap)
346 cdev_t dev = ap->a_head.a_dev;
347 struct uhid_softc *sc;
350 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
354 DPRINTF(("uhidopen: sc=%p\n", sc));
359 if (sc->sc_state & UHID_OPEN)
361 sc->sc_state |= UHID_OPEN;
363 if ((clist_alloc_cblocks(&sc->sc_q, UHID_BSIZE,
364 UHID_BSIZE), 0) == -1) {
365 sc->sc_state &= ~UHID_OPEN;
369 sc->sc_ibuf = kmalloc(sc->sc_isize, M_USBDEV, M_WAITOK);
370 sc->sc_obuf = kmalloc(sc->sc_osize, M_USBDEV, M_WAITOK);
372 /* Set up interrupt pipe. */
373 err = usbd_open_pipe_intr(sc->sc_iface, sc->sc_ep_addr,
374 USBD_SHORT_XFER_OK, &sc->sc_intrpipe, sc, sc->sc_ibuf,
375 sc->sc_isize, uhid_intr, USBD_DEFAULT_INTERVAL);
377 DPRINTF(("uhidopen: usbd_open_pipe_intr failed, "
379 kfree(sc->sc_ibuf, M_USBDEV);
380 kfree(sc->sc_obuf, M_USBDEV);
381 sc->sc_ibuf = sc->sc_obuf = NULL;
383 sc->sc_state &= ~UHID_OPEN;
387 sc->sc_state &= ~UHID_IMMED;
395 uhidclose(struct dev_close_args *ap)
397 cdev_t dev = ap->a_head.a_dev;
398 struct uhid_softc *sc;
400 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
402 DPRINTF(("uhidclose: sc=%p\n", sc));
404 /* Disable interrupts. */
405 usbd_abort_pipe(sc->sc_intrpipe);
406 usbd_close_pipe(sc->sc_intrpipe);
409 ndflush(&sc->sc_q, sc->sc_q.c_cc);
410 clist_free_cblocks(&sc->sc_q);
412 kfree(sc->sc_ibuf, M_USBDEV);
413 kfree(sc->sc_obuf, M_USBDEV);
414 sc->sc_ibuf = sc->sc_obuf = NULL;
416 sc->sc_state &= ~UHID_OPEN;
424 uhid_do_read(struct uhid_softc *sc, struct uio *uio, int flag)
428 u_char buffer[UHID_CHUNK];
431 DPRINTFN(1, ("uhidread\n"));
432 if (sc->sc_state & UHID_IMMED) {
433 DPRINTFN(1, ("uhidread immed\n"));
435 err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
436 sc->sc_iid, buffer, sc->sc_isize);
439 return (uiomove(buffer, sc->sc_isize, uio));
443 while (sc->sc_q.c_cc == 0) {
444 if (flag & IO_NDELAY) {
446 return (EWOULDBLOCK);
448 sc->sc_state |= UHID_ASLP;
449 DPRINTFN(5, ("uhidread: sleep on %p\n", &sc->sc_q));
450 error = tsleep(&sc->sc_q, PCATCH, "uhidrea", 0);
451 DPRINTFN(5, ("uhidread: woke, error=%d\n", error));
455 sc->sc_state &= ~UHID_ASLP;
458 if (sc->sc_state & UHID_NEEDCLEAR) {
459 DPRINTFN(-1,("uhidread: clearing stall\n"));
460 sc->sc_state &= ~UHID_NEEDCLEAR;
461 usbd_clear_endpoint_stall(sc->sc_intrpipe);
466 /* Transfer as many chunks as possible. */
467 while (sc->sc_q.c_cc > 0 && uio->uio_resid > 0 && !error) {
468 length = szmin(sc->sc_q.c_cc, uio->uio_resid);
469 if (length > sizeof(buffer))
470 length = sizeof(buffer);
472 /* Remove a small chunk from the input queue. */
473 (void) q_to_b(&sc->sc_q, buffer, length);
474 DPRINTFN(5, ("uhidread: got %lu chars\n", (u_long)length));
476 /* Copy the data to the user process. */
477 if ((error = uiomove(buffer, length, uio)) != 0)
485 uhidread(struct dev_read_args *ap)
487 cdev_t dev = ap->a_head.a_dev;
488 struct uhid_softc *sc;
491 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
494 error = uhid_do_read(sc, ap->a_uio, ap->a_ioflag);
495 if (--sc->sc_refcnt < 0)
496 usb_detach_wakeup(sc->sc_dev);
501 uhid_do_write(struct uhid_softc *sc, struct uio *uio, int flag)
507 DPRINTFN(1, ("uhidwrite\n"));
513 if (uio->uio_resid != size)
515 error = uiomove(sc->sc_obuf, size, uio);
518 err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
519 sc->sc_obuf[0], sc->sc_obuf+1, size-1);
521 err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
522 0, sc->sc_obuf, size);
531 uhidwrite(struct dev_write_args *ap)
533 cdev_t dev = ap->a_head.a_dev;
534 struct uhid_softc *sc;
537 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
540 error = uhid_do_write(sc, ap->a_uio, ap->a_ioflag);
541 if (--sc->sc_refcnt < 0)
542 usb_detach_wakeup(sc->sc_dev);
547 uhid_do_ioctl(struct uhid_softc *sc, u_long cmd, caddr_t addr, int flag)
549 struct usb_ctl_report_desc *rd;
550 struct usb_ctl_report *re;
554 DPRINTFN(2, ("uhidioctl: cmd=%lx\n", cmd));
562 if (sc->sc_async != NULL)
564 sc->sc_async = curproc;
565 DPRINTF(("uhid_do_ioctl: FIOASYNC %p\n", sc->sc_async));
570 /* XXX this is not the most general solution. */
572 if (sc->sc_async == NULL)
574 if (*(int *)addr != sc->sc_async->p_pgid)
578 case USB_GET_REPORT_DESC:
579 rd = (struct usb_ctl_report_desc *)addr;
580 size = min(sc->sc_repdesc_size, sizeof rd->ucrd_data);
581 rd->ucrd_size = size;
582 memcpy(rd->ucrd_data, sc->sc_repdesc, size);
587 /* XXX should read into ibuf, but does it matter? */
588 err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
589 sc->sc_iid, sc->sc_ibuf, sc->sc_isize);
593 sc->sc_state |= UHID_IMMED;
595 sc->sc_state &= ~UHID_IMMED;
599 re = (struct usb_ctl_report *)addr;
600 switch (re->ucr_report) {
601 case UHID_INPUT_REPORT:
605 case UHID_OUTPUT_REPORT:
609 case UHID_FEATURE_REPORT:
616 err = usbd_get_report(sc->sc_iface, re->ucr_report, id, re->ucr_data,
623 re = (struct usb_ctl_report *)addr;
624 switch (re->ucr_report) {
625 case UHID_INPUT_REPORT:
629 case UHID_OUTPUT_REPORT:
633 case UHID_FEATURE_REPORT:
640 err = usbd_set_report(sc->sc_iface, re->ucr_report, id, re->ucr_data,
646 case USB_GET_REPORT_ID:
647 *(int *)addr = 0; /* XXX: we only support reportid 0? */
657 uhidioctl(struct dev_ioctl_args *ap)
659 cdev_t dev = ap->a_head.a_dev;
660 struct uhid_softc *sc;
663 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
666 error = uhid_do_ioctl(sc, ap->a_cmd, ap->a_data, ap->a_fflag);
667 if (--sc->sc_refcnt < 0)
668 usb_detach_wakeup(sc->sc_dev);
672 static struct filterops uhidfiltops_read =
673 { 1, NULL, uhidfilt_detach, uhidfilt_read };
674 static struct filterops uhidfiltops_write =
675 { 1, NULL, uhidfilt_detach, uhidfilt_write };
678 uhidkqfilter(struct dev_kqfilter_args *ap)
680 cdev_t dev = ap->a_head.a_dev;
681 struct knote *kn = ap->a_kn;
682 struct uhid_softc *sc;
685 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
694 switch (kn->kn_filter) {
696 kn->kn_fop = &uhidfiltops_read;
697 kn->kn_hook = (caddr_t)sc;
700 kn->kn_fop = &uhidfiltops_write;
701 kn->kn_hook = (caddr_t)sc;
704 ap->a_result = EOPNOTSUPP;
709 klist = &sc->sc_rsel.si_note;
710 SLIST_INSERT_HEAD(klist, kn, kn_selnext);
717 uhidfilt_detach(struct knote *kn)
719 cdev_t dev = (cdev_t)kn->kn_hook;
720 struct uhid_softc *sc;
723 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
726 klist = &sc->sc_rsel.si_note;
727 SLIST_REMOVE(klist, kn, knote, kn_selnext);
732 uhidfilt_read(struct knote *kn, long hint)
734 cdev_t dev = (cdev_t)kn->kn_hook;
735 struct uhid_softc *sc;
738 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
741 if (sc->sc_q.c_cc > 0)
749 uhidfilt_write(struct knote *kn, long hint)
754 DRIVER_MODULE(uhid, uhub, uhid_driver, uhid_devclass, usbd_driver_load, 0);