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.32 2007/11/06 07:37:01 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/usbdi.h>
76 #include <bus/usb/usbdi_util.h>
77 #include <bus/usb/hid.h>
79 /* Report descriptor for broken Wacom Graphire */
80 #include <bus/usb/ugraphire_rdesc.h>
83 #define DPRINTF(x) if (uhiddebug) kprintf x
84 #define DPRINTFN(n,x) if (uhiddebug>(n)) kprintf x
86 SYSCTL_NODE(_hw_usb, OID_AUTO, uhid, CTLFLAG_RW, 0, "USB uhid");
87 SYSCTL_INT(_hw_usb_uhid, OID_AUTO, debug, CTLFLAG_RW,
88 &uhiddebug, 0, "uhid debug level");
95 device_t sc_dev; /* base device */
96 usbd_device_handle sc_udev;
97 usbd_interface_handle sc_iface; /* interface */
98 usbd_pipe_handle sc_intrpipe; /* interrupt pipe */
115 struct selinfo sc_rsel;
116 struct proc *sc_async; /* process that wants SIGIO */
117 u_char sc_state; /* driver state */
118 #define UHID_OPEN 0x01 /* device is open */
119 #define UHID_ASLP 0x02 /* waiting for device data */
120 #define UHID_NEEDCLEAR 0x04 /* needs clearing endpoint stall */
121 #define UHID_IMMED 0x08 /* return read data immediately */
127 #define UHIDUNIT(dev) (minor(dev))
128 #define UHID_CHUNK 128 /* chunk size for read */
129 #define UHID_BSIZE 1020 /* buffer size */
138 #define UHID_CDEV_MAJOR 122
140 static struct dev_ops uhid_ops = {
141 { "uhid", UHID_CDEV_MAJOR, 0 },
143 .d_close = uhidclose,
145 .d_write = uhidwrite,
146 .d_ioctl = uhidioctl,
150 static void uhid_intr(usbd_xfer_handle, usbd_private_handle,
153 static int uhid_do_read(struct uhid_softc *, struct uio *uio, int);
154 static int uhid_do_write(struct uhid_softc *, struct uio *uio, int);
155 static int uhid_do_ioctl(struct uhid_softc *, u_long, caddr_t, int);
157 static device_probe_t uhid_match;
158 static device_attach_t uhid_attach;
159 static device_detach_t uhid_detach;
161 static devclass_t uhid_devclass;
163 static kobj_method_t uhid_methods[] = {
164 DEVMETHOD(device_probe, uhid_match),
165 DEVMETHOD(device_attach, uhid_attach),
166 DEVMETHOD(device_detach, uhid_detach),
170 static driver_t uhid_driver = {
173 sizeof(struct uhid_softc)
176 MODULE_DEPEND(uhid, usb, 1, 1, 1);
179 uhid_match(device_t self)
181 struct usb_attach_arg *uaa = device_get_ivars(self);
182 usb_interface_descriptor_t *id;
184 if (uaa->iface == NULL)
185 return (UMATCH_NONE);
186 id = usbd_get_interface_descriptor(uaa->iface);
187 if (id == NULL || id->bInterfaceClass != UICLASS_HID)
188 return (UMATCH_NONE);
190 return (uaa->matchlvl);
191 return (UMATCH_IFACECLASS_GENERIC);
195 uhid_attach(device_t self)
197 struct uhid_softc *sc = device_get_softc(self);
198 struct usb_attach_arg *uaa = device_get_ivars(self);
199 usbd_interface_handle iface = uaa->iface;
200 usb_interface_descriptor_t *id;
201 usb_endpoint_descriptor_t *ed;
206 sc->sc_udev = uaa->device;
207 sc->sc_iface = iface;
208 id = usbd_get_interface_descriptor(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 dev_ops_add(&uhid_ops, -1, device_get_unit(self));
265 make_dev(&uhid_ops, device_get_unit(self),
266 UID_ROOT, GID_OPERATOR,
267 0644, "uhid%d", device_get_unit(self));
273 uhid_detach(device_t self)
275 struct uhid_softc *sc = device_get_softc(self);
277 DPRINTF(("uhid_detach: sc=%p\n", sc));
280 if (sc->sc_intrpipe != NULL)
281 usbd_abort_pipe(sc->sc_intrpipe);
283 if (sc->sc_state & UHID_OPEN) {
285 if (--sc->sc_refcnt >= 0) {
288 /* Wait for processes to go away. */
289 usb_detach_wait(sc->sc_dev);
294 dev_ops_remove(&uhid_ops, -1, device_get_unit(self));
297 kfree(sc->sc_repdesc, M_USBDEV);
303 uhid_intr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status)
305 struct uhid_softc *sc = addr;
311 usbd_get_xfer_status(xfer, NULL, NULL, &cc, NULL);
312 DPRINTF(("uhid_intr: status=%d cc=%d\n", status, cc));
313 DPRINTF(("uhid_intr: data ="));
314 for (i = 0; i < cc; i++)
315 DPRINTF((" %02x", sc->sc_ibuf[i]));
320 if (status == USBD_CANCELLED)
323 if (status != USBD_NORMAL_COMPLETION) {
324 DPRINTF(("uhid_intr: status=%d\n", status));
325 if (status == USBD_STALLED)
326 sc->sc_state |= UHID_NEEDCLEAR;
330 (void) b_to_q(sc->sc_ibuf, sc->sc_isize, &sc->sc_q);
332 if (sc->sc_state & UHID_ASLP) {
333 sc->sc_state &= ~UHID_ASLP;
334 DPRINTFN(5, ("uhid_intr: waking %p\n", &sc->sc_q));
337 selwakeup(&sc->sc_rsel);
338 if (sc->sc_async != NULL) {
339 DPRINTFN(3, ("uhid_intr: sending SIGIO %p\n", sc->sc_async));
340 ksignal(sc->sc_async, SIGIO);
345 uhidopen(struct dev_open_args *ap)
347 cdev_t dev = ap->a_head.a_dev;
348 struct uhid_softc *sc;
351 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
355 DPRINTF(("uhidopen: sc=%p\n", sc));
360 if (sc->sc_state & UHID_OPEN)
362 sc->sc_state |= UHID_OPEN;
364 if ((clist_alloc_cblocks(&sc->sc_q, UHID_BSIZE,
365 UHID_BSIZE), 0) == -1) {
366 sc->sc_state &= ~UHID_OPEN;
370 sc->sc_ibuf = kmalloc(sc->sc_isize, M_USBDEV, M_WAITOK);
371 sc->sc_obuf = kmalloc(sc->sc_osize, M_USBDEV, M_WAITOK);
373 /* Set up interrupt pipe. */
374 err = usbd_open_pipe_intr(sc->sc_iface, sc->sc_ep_addr,
375 USBD_SHORT_XFER_OK, &sc->sc_intrpipe, sc, sc->sc_ibuf,
376 sc->sc_isize, uhid_intr, USBD_DEFAULT_INTERVAL);
378 DPRINTF(("uhidopen: usbd_open_pipe_intr failed, "
380 kfree(sc->sc_ibuf, M_USBDEV);
381 kfree(sc->sc_obuf, M_USBDEV);
382 sc->sc_ibuf = sc->sc_obuf = NULL;
384 sc->sc_state &= ~UHID_OPEN;
388 sc->sc_state &= ~UHID_IMMED;
396 uhidclose(struct dev_close_args *ap)
398 cdev_t dev = ap->a_head.a_dev;
399 struct uhid_softc *sc;
401 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
403 DPRINTF(("uhidclose: sc=%p\n", sc));
405 /* Disable interrupts. */
406 usbd_abort_pipe(sc->sc_intrpipe);
407 usbd_close_pipe(sc->sc_intrpipe);
410 ndflush(&sc->sc_q, sc->sc_q.c_cc);
411 clist_free_cblocks(&sc->sc_q);
413 kfree(sc->sc_ibuf, M_USBDEV);
414 kfree(sc->sc_obuf, M_USBDEV);
415 sc->sc_ibuf = sc->sc_obuf = NULL;
417 sc->sc_state &= ~UHID_OPEN;
425 uhid_do_read(struct uhid_softc *sc, struct uio *uio, int flag)
429 u_char buffer[UHID_CHUNK];
432 DPRINTFN(1, ("uhidread\n"));
433 if (sc->sc_state & UHID_IMMED) {
434 DPRINTFN(1, ("uhidread immed\n"));
436 err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
437 sc->sc_iid, buffer, sc->sc_isize);
440 return (uiomove(buffer, sc->sc_isize, uio));
444 while (sc->sc_q.c_cc == 0) {
445 if (flag & IO_NDELAY) {
447 return (EWOULDBLOCK);
449 sc->sc_state |= UHID_ASLP;
450 DPRINTFN(5, ("uhidread: sleep on %p\n", &sc->sc_q));
451 error = tsleep(&sc->sc_q, PCATCH, "uhidrea", 0);
452 DPRINTFN(5, ("uhidread: woke, error=%d\n", error));
456 sc->sc_state &= ~UHID_ASLP;
459 if (sc->sc_state & UHID_NEEDCLEAR) {
460 DPRINTFN(-1,("uhidread: clearing stall\n"));
461 sc->sc_state &= ~UHID_NEEDCLEAR;
462 usbd_clear_endpoint_stall(sc->sc_intrpipe);
467 /* Transfer as many chunks as possible. */
468 while (sc->sc_q.c_cc > 0 && uio->uio_resid > 0 && !error) {
469 length = min(sc->sc_q.c_cc, uio->uio_resid);
470 if (length > sizeof(buffer))
471 length = sizeof(buffer);
473 /* Remove a small chunk from the input queue. */
474 (void) q_to_b(&sc->sc_q, buffer, length);
475 DPRINTFN(5, ("uhidread: got %lu chars\n", (u_long)length));
477 /* Copy the data to the user process. */
478 if ((error = uiomove(buffer, length, uio)) != 0)
486 uhidread(struct dev_read_args *ap)
488 cdev_t dev = ap->a_head.a_dev;
489 struct uhid_softc *sc;
492 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
495 error = uhid_do_read(sc, ap->a_uio, ap->a_ioflag);
496 if (--sc->sc_refcnt < 0)
497 usb_detach_wakeup(sc->sc_dev);
502 uhid_do_write(struct uhid_softc *sc, struct uio *uio, int flag)
508 DPRINTFN(1, ("uhidwrite\n"));
515 if (uio->uio_resid != size)
517 error = uiomove(sc->sc_obuf, size, uio);
520 err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
521 sc->sc_obuf[0], sc->sc_obuf+1, size-1);
523 err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
524 0, sc->sc_obuf, size);
533 uhidwrite(struct dev_write_args *ap)
535 cdev_t dev = ap->a_head.a_dev;
536 struct uhid_softc *sc;
539 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
542 error = uhid_do_write(sc, ap->a_uio, ap->a_ioflag);
543 if (--sc->sc_refcnt < 0)
544 usb_detach_wakeup(sc->sc_dev);
549 uhid_do_ioctl(struct uhid_softc *sc, u_long cmd, caddr_t addr, int flag)
551 struct usb_ctl_report_desc *rd;
552 struct usb_ctl_report *re;
556 DPRINTFN(2, ("uhidioctl: cmd=%lx\n", cmd));
564 if (sc->sc_async != NULL)
566 sc->sc_async = curproc;
567 DPRINTF(("uhid_do_ioctl: FIOASYNC %p\n", sc->sc_async));
572 /* XXX this is not the most general solution. */
574 if (sc->sc_async == NULL)
576 if (*(int *)addr != sc->sc_async->p_pgid)
580 case USB_GET_REPORT_DESC:
581 rd = (struct usb_ctl_report_desc *)addr;
582 size = min(sc->sc_repdesc_size, sizeof rd->ucrd_data);
583 rd->ucrd_size = size;
584 memcpy(rd->ucrd_data, sc->sc_repdesc, size);
589 /* XXX should read into ibuf, but does it matter? */
590 err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
591 sc->sc_iid, sc->sc_ibuf, sc->sc_isize);
595 sc->sc_state |= UHID_IMMED;
597 sc->sc_state &= ~UHID_IMMED;
601 re = (struct usb_ctl_report *)addr;
602 switch (re->ucr_report) {
603 case UHID_INPUT_REPORT:
607 case UHID_OUTPUT_REPORT:
611 case UHID_FEATURE_REPORT:
618 err = usbd_get_report(sc->sc_iface, re->ucr_report, id, re->ucr_data,
625 re = (struct usb_ctl_report *)addr;
626 switch (re->ucr_report) {
627 case UHID_INPUT_REPORT:
631 case UHID_OUTPUT_REPORT:
635 case UHID_FEATURE_REPORT:
642 err = usbd_set_report(sc->sc_iface, re->ucr_report, id, re->ucr_data,
648 case USB_GET_REPORT_ID:
649 *(int *)addr = 0; /* XXX: we only support reportid 0? */
659 uhidioctl(struct dev_ioctl_args *ap)
661 cdev_t dev = ap->a_head.a_dev;
662 struct uhid_softc *sc;
665 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
668 error = uhid_do_ioctl(sc, ap->a_cmd, ap->a_data, ap->a_fflag);
669 if (--sc->sc_refcnt < 0)
670 usb_detach_wakeup(sc->sc_dev);
675 uhidpoll(struct dev_poll_args *ap)
677 cdev_t dev = ap->a_head.a_dev;
678 struct uhid_softc *sc;
681 sc = devclass_get_softc(uhid_devclass, UHIDUNIT(dev));
687 if (ap->a_events & (POLLOUT | POLLWRNORM))
688 revents |= ap->a_events & (POLLOUT | POLLWRNORM);
689 if (ap->a_events & (POLLIN | POLLRDNORM)) {
690 if (sc->sc_q.c_cc > 0)
691 revents |= ap->a_events & (POLLIN | POLLRDNORM);
693 selrecord(curthread, &sc->sc_rsel);
696 ap->a_events = revents;
700 DRIVER_MODULE(uhid, uhub, uhid_driver, uhid_devclass, usbd_driver_load, 0);