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.29 2007/07/03 19:28:16 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/ioccom.h>
59 #include <sys/filio.h>
60 #include <sys/module.h>
62 #include <sys/ioccom.h>
65 #include <sys/select.h>
67 #include <sys/vnode.h>
69 #include <sys/sysctl.h>
70 #include <sys/thread2.h>
72 #include <bus/usb/usb.h>
73 #include <bus/usb/usbhid.h>
75 #include <bus/usb/usbdevs.h>
76 #include <bus/usb/usbdi.h>
77 #include <bus/usb/usbdi_util.h>
78 #include <bus/usb/hid.h>
80 /* Report descriptor for broken Wacom Graphire */
81 #include <bus/usb/ugraphire_rdesc.h>
84 #define DPRINTF(x) if (uhiddebug) kprintf x
85 #define DPRINTFN(n,x) if (uhiddebug>(n)) kprintf x
87 SYSCTL_NODE(_hw_usb, OID_AUTO, uhid, CTLFLAG_RW, 0, "USB uhid");
88 SYSCTL_INT(_hw_usb_uhid, OID_AUTO, debug, CTLFLAG_RW,
89 &uhiddebug, 0, "uhid debug level");
96 device_t sc_dev; /* base device */
97 usbd_device_handle sc_udev;
98 usbd_interface_handle sc_iface; /* interface */
99 usbd_pipe_handle sc_intrpipe; /* interrupt pipe */
116 struct selinfo sc_rsel;
117 struct proc *sc_async; /* process that wants SIGIO */
118 u_char sc_state; /* driver state */
119 #define UHID_OPEN 0x01 /* device is open */
120 #define UHID_ASLP 0x02 /* waiting for device data */
121 #define UHID_NEEDCLEAR 0x04 /* needs clearing endpoint stall */
122 #define UHID_IMMED 0x08 /* return read data immediately */
128 #define UHIDUNIT(dev) (minor(dev))
129 #define UHID_CHUNK 128 /* chunk size for read */
130 #define UHID_BSIZE 1020 /* buffer size */
139 #define UHID_CDEV_MAJOR 122
141 static struct dev_ops uhid_ops = {
142 { "uhid", UHID_CDEV_MAJOR, 0 },
144 .d_close = uhidclose,
146 .d_write = uhidwrite,
147 .d_ioctl = uhidioctl,
151 static void uhid_intr(usbd_xfer_handle, usbd_private_handle,
154 static int uhid_do_read(struct uhid_softc *, struct uio *uio, int);
155 static int uhid_do_write(struct uhid_softc *, struct uio *uio, int);
156 static int uhid_do_ioctl(struct uhid_softc *, u_long, caddr_t, int);
158 static device_probe_t uhid_match;
159 static device_attach_t uhid_attach;
160 static device_detach_t uhid_detach;
162 static devclass_t uhid_devclass;
164 static kobj_method_t uhid_methods[] = {
165 DEVMETHOD(device_probe, uhid_match),
166 DEVMETHOD(device_attach, uhid_attach),
167 DEVMETHOD(device_detach, uhid_detach),
171 static driver_t uhid_driver = {
174 sizeof(struct uhid_softc)
177 MODULE_DEPEND(uhid, usb, 1, 1, 1);
180 uhid_match(device_t self)
182 struct usb_attach_arg *uaa = device_get_ivars(self);
183 usb_interface_descriptor_t *id;
185 if (uaa->iface == NULL)
186 return (UMATCH_NONE);
187 id = usbd_get_interface_descriptor(uaa->iface);
188 if (id == NULL || id->bInterfaceClass != UICLASS_HID)
189 return (UMATCH_NONE);
191 return (uaa->matchlvl);
192 return (UMATCH_IFACECLASS_GENERIC);
196 uhid_attach(device_t self)
198 struct uhid_softc *sc = device_get_softc(self);
199 struct usb_attach_arg *uaa = device_get_ivars(self);
200 usbd_interface_handle iface = uaa->iface;
201 usb_interface_descriptor_t *id;
202 usb_endpoint_descriptor_t *ed;
208 sc->sc_udev = uaa->device;
209 sc->sc_iface = iface;
210 id = usbd_get_interface_descriptor(iface);
211 usbd_devinfo(uaa->device, 0, devinfo);
213 device_set_desc_copy(self, devinfo);
214 kprintf("%s: %s, iclass %d/%d\n", device_get_nameunit(sc->sc_dev),
215 devinfo, id->bInterfaceClass, id->bInterfaceSubClass);
217 ed = usbd_interface2endpoint_descriptor(iface, 0);
219 kprintf("%s: could not read endpoint descriptor\n",
220 device_get_nameunit(sc->sc_dev));
225 DPRINTFN(10,("uhid_attach: bLength=%d bDescriptorType=%d "
226 "bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d"
228 ed->bLength, ed->bDescriptorType,
229 ed->bEndpointAddress & UE_ADDR,
230 UE_GET_DIR(ed->bEndpointAddress)==UE_DIR_IN? "in" : "out",
231 ed->bmAttributes & UE_XFERTYPE,
232 UGETW(ed->wMaxPacketSize), ed->bInterval));
234 if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_IN ||
235 (ed->bmAttributes & UE_XFERTYPE) != UE_INTERRUPT) {
236 kprintf("%s: unexpected endpoint\n", device_get_nameunit(sc->sc_dev));
241 sc->sc_ep_addr = ed->bEndpointAddress;
243 if (uaa->vendor == USB_VENDOR_WACOM &&
244 uaa->product == USB_PRODUCT_WACOM_GRAPHIRE /* &&
245 uaa->revision == 0x???? */) { /* XXX should use revision */
246 /* The report descriptor for the Wacom Graphire is broken. */
247 size = sizeof uhid_graphire_report_descr;
248 desc = kmalloc(size, M_USBDEV, M_INTWAIT);
249 err = USBD_NORMAL_COMPLETION;
250 memcpy(desc, uhid_graphire_report_descr, size);
253 err = usbd_read_report_desc(uaa->iface, &desc, &size,M_USBDEV);
257 kprintf("%s: no report descriptor\n", device_get_nameunit(sc->sc_dev));
262 (void)usbd_set_idle(iface, 0, 0);
264 sc->sc_isize = hid_report_size(desc, size, hid_input, &sc->sc_iid);
265 sc->sc_osize = hid_report_size(desc, size, hid_output, &sc->sc_oid);
266 sc->sc_fsize = hid_report_size(desc, size, hid_feature, &sc->sc_fid);
268 sc->sc_repdesc = desc;
269 sc->sc_repdesc_size = size;
271 dev_ops_add(&uhid_ops, -1, device_get_unit(self));
272 make_dev(&uhid_ops, device_get_unit(self),
273 UID_ROOT, GID_OPERATOR,
274 0644, "uhid%d", device_get_unit(self));
280 uhid_detach(device_t self)
282 struct uhid_softc *sc = device_get_softc(self);
284 DPRINTF(("uhid_detach: sc=%p\n", sc));
287 if (sc->sc_intrpipe != NULL)
288 usbd_abort_pipe(sc->sc_intrpipe);
290 if (sc->sc_state & UHID_OPEN) {
292 if (--sc->sc_refcnt >= 0) {
295 /* Wait for processes to go away. */
296 usb_detach_wait(sc->sc_dev);
301 dev_ops_remove(&uhid_ops, -1, device_get_unit(self));
304 kfree(sc->sc_repdesc, M_USBDEV);
310 uhid_intr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status)
312 struct uhid_softc *sc = addr;
318 usbd_get_xfer_status(xfer, NULL, NULL, &cc, NULL);
319 DPRINTF(("uhid_intr: status=%d cc=%d\n", status, cc));
320 DPRINTF(("uhid_intr: data ="));
321 for (i = 0; i < cc; i++)
322 DPRINTF((" %02x", sc->sc_ibuf[i]));
327 if (status == USBD_CANCELLED)
330 if (status != USBD_NORMAL_COMPLETION) {
331 DPRINTF(("uhid_intr: status=%d\n", status));
332 if (status == USBD_STALLED)
333 sc->sc_state |= UHID_NEEDCLEAR;
337 (void) b_to_q(sc->sc_ibuf, sc->sc_isize, &sc->sc_q);
339 if (sc->sc_state & UHID_ASLP) {
340 sc->sc_state &= ~UHID_ASLP;
341 DPRINTFN(5, ("uhid_intr: waking %p\n", &sc->sc_q));
344 selwakeup(&sc->sc_rsel);
345 if (sc->sc_async != NULL) {
346 DPRINTFN(3, ("uhid_intr: sending SIGIO %p\n", sc->sc_async));
347 ksignal(sc->sc_async, SIGIO);
352 uhidopen(struct dev_open_args *ap)
354 cdev_t dev = ap->a_head.a_dev;
355 struct uhid_softc *sc;
358 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
362 DPRINTF(("uhidopen: sc=%p\n", sc));
367 if (sc->sc_state & UHID_OPEN)
369 sc->sc_state |= UHID_OPEN;
371 if ((clist_alloc_cblocks(&sc->sc_q, UHID_BSIZE,
372 UHID_BSIZE), 0) == -1) {
373 sc->sc_state &= ~UHID_OPEN;
377 sc->sc_ibuf = kmalloc(sc->sc_isize, M_USBDEV, M_WAITOK);
378 sc->sc_obuf = kmalloc(sc->sc_osize, M_USBDEV, M_WAITOK);
380 /* Set up interrupt pipe. */
381 err = usbd_open_pipe_intr(sc->sc_iface, sc->sc_ep_addr,
382 USBD_SHORT_XFER_OK, &sc->sc_intrpipe, sc, sc->sc_ibuf,
383 sc->sc_isize, uhid_intr, USBD_DEFAULT_INTERVAL);
385 DPRINTF(("uhidopen: usbd_open_pipe_intr failed, "
387 kfree(sc->sc_ibuf, M_USBDEV);
388 kfree(sc->sc_obuf, M_USBDEV);
389 sc->sc_ibuf = sc->sc_obuf = NULL;
391 sc->sc_state &= ~UHID_OPEN;
395 sc->sc_state &= ~UHID_IMMED;
403 uhidclose(struct dev_close_args *ap)
405 cdev_t dev = ap->a_head.a_dev;
406 struct uhid_softc *sc;
408 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
410 DPRINTF(("uhidclose: sc=%p\n", sc));
412 /* Disable interrupts. */
413 usbd_abort_pipe(sc->sc_intrpipe);
414 usbd_close_pipe(sc->sc_intrpipe);
417 ndflush(&sc->sc_q, sc->sc_q.c_cc);
418 clist_free_cblocks(&sc->sc_q);
420 kfree(sc->sc_ibuf, M_USBDEV);
421 kfree(sc->sc_obuf, M_USBDEV);
422 sc->sc_ibuf = sc->sc_obuf = NULL;
424 sc->sc_state &= ~UHID_OPEN;
432 uhid_do_read(struct uhid_softc *sc, struct uio *uio, int flag)
436 u_char buffer[UHID_CHUNK];
439 DPRINTFN(1, ("uhidread\n"));
440 if (sc->sc_state & UHID_IMMED) {
441 DPRINTFN(1, ("uhidread immed\n"));
443 err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
444 sc->sc_iid, buffer, sc->sc_isize);
447 return (uiomove(buffer, sc->sc_isize, uio));
451 while (sc->sc_q.c_cc == 0) {
452 if (flag & IO_NDELAY) {
454 return (EWOULDBLOCK);
456 sc->sc_state |= UHID_ASLP;
457 DPRINTFN(5, ("uhidread: sleep on %p\n", &sc->sc_q));
458 error = tsleep(&sc->sc_q, PCATCH, "uhidrea", 0);
459 DPRINTFN(5, ("uhidread: woke, error=%d\n", error));
463 sc->sc_state &= ~UHID_ASLP;
466 if (sc->sc_state & UHID_NEEDCLEAR) {
467 DPRINTFN(-1,("uhidread: clearing stall\n"));
468 sc->sc_state &= ~UHID_NEEDCLEAR;
469 usbd_clear_endpoint_stall(sc->sc_intrpipe);
474 /* Transfer as many chunks as possible. */
475 while (sc->sc_q.c_cc > 0 && uio->uio_resid > 0 && !error) {
476 length = min(sc->sc_q.c_cc, uio->uio_resid);
477 if (length > sizeof(buffer))
478 length = sizeof(buffer);
480 /* Remove a small chunk from the input queue. */
481 (void) q_to_b(&sc->sc_q, buffer, length);
482 DPRINTFN(5, ("uhidread: got %lu chars\n", (u_long)length));
484 /* Copy the data to the user process. */
485 if ((error = uiomove(buffer, length, uio)) != 0)
493 uhidread(struct dev_read_args *ap)
495 cdev_t dev = ap->a_head.a_dev;
496 struct uhid_softc *sc;
499 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
502 error = uhid_do_read(sc, ap->a_uio, ap->a_ioflag);
503 if (--sc->sc_refcnt < 0)
504 usb_detach_wakeup(sc->sc_dev);
509 uhid_do_write(struct uhid_softc *sc, struct uio *uio, int flag)
515 DPRINTFN(1, ("uhidwrite\n"));
522 if (uio->uio_resid != size)
524 error = uiomove(sc->sc_obuf, size, uio);
527 err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
528 sc->sc_obuf[0], sc->sc_obuf+1, size-1);
530 err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
531 0, sc->sc_obuf, size);
540 uhidwrite(struct dev_write_args *ap)
542 cdev_t dev = ap->a_head.a_dev;
543 struct uhid_softc *sc;
546 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
549 error = uhid_do_write(sc, ap->a_uio, ap->a_ioflag);
550 if (--sc->sc_refcnt < 0)
551 usb_detach_wakeup(sc->sc_dev);
556 uhid_do_ioctl(struct uhid_softc *sc, u_long cmd, caddr_t addr, int flag)
558 struct usb_ctl_report_desc *rd;
559 struct usb_ctl_report *re;
563 DPRINTFN(2, ("uhidioctl: cmd=%lx\n", cmd));
571 if (sc->sc_async != NULL)
573 sc->sc_async = curproc;
574 DPRINTF(("uhid_do_ioctl: FIOASYNC %p\n", sc->sc_async));
579 /* XXX this is not the most general solution. */
581 if (sc->sc_async == NULL)
583 if (*(int *)addr != sc->sc_async->p_pgid)
587 case USB_GET_REPORT_DESC:
588 rd = (struct usb_ctl_report_desc *)addr;
589 size = min(sc->sc_repdesc_size, sizeof rd->ucrd_data);
590 rd->ucrd_size = size;
591 memcpy(rd->ucrd_data, sc->sc_repdesc, size);
596 /* XXX should read into ibuf, but does it matter? */
597 err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
598 sc->sc_iid, sc->sc_ibuf, sc->sc_isize);
602 sc->sc_state |= UHID_IMMED;
604 sc->sc_state &= ~UHID_IMMED;
608 re = (struct usb_ctl_report *)addr;
609 switch (re->ucr_report) {
610 case UHID_INPUT_REPORT:
614 case UHID_OUTPUT_REPORT:
618 case UHID_FEATURE_REPORT:
625 err = usbd_get_report(sc->sc_iface, re->ucr_report, id, re->ucr_data,
632 re = (struct usb_ctl_report *)addr;
633 switch (re->ucr_report) {
634 case UHID_INPUT_REPORT:
638 case UHID_OUTPUT_REPORT:
642 case UHID_FEATURE_REPORT:
649 err = usbd_set_report(sc->sc_iface, re->ucr_report, id, re->ucr_data,
655 case USB_GET_REPORT_ID:
656 *(int *)addr = 0; /* XXX: we only support reportid 0? */
666 uhidioctl(struct dev_ioctl_args *ap)
668 cdev_t dev = ap->a_head.a_dev;
669 struct uhid_softc *sc;
672 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
675 error = uhid_do_ioctl(sc, ap->a_cmd, ap->a_data, ap->a_fflag);
676 if (--sc->sc_refcnt < 0)
677 usb_detach_wakeup(sc->sc_dev);
682 uhidpoll(struct dev_poll_args *ap)
684 cdev_t dev = ap->a_head.a_dev;
685 struct uhid_softc *sc;
688 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
694 if (ap->a_events & (POLLOUT | POLLWRNORM))
695 revents |= ap->a_events & (POLLOUT | POLLWRNORM);
696 if (ap->a_events & (POLLIN | POLLRDNORM)) {
697 if (sc->sc_q.c_cc > 0)
698 revents |= ap->a_events & (POLLIN | POLLRDNORM);
700 selrecord(curthread, &sc->sc_rsel);
703 ap->a_events = revents;
707 DRIVER_MODULE(uhid, uhub, uhid_driver, uhid_devclass, usbd_driver_load, 0);