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.26 2007/07/01 21:24:03 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 USB_DECLARE_DRIVER(uhid);
161 uhid_match(device_t self)
163 struct usb_attach_arg *uaa = device_get_ivars(self);
164 usb_interface_descriptor_t *id;
166 if (uaa->iface == NULL)
167 return (UMATCH_NONE);
168 id = usbd_get_interface_descriptor(uaa->iface);
169 if (id == NULL || id->bInterfaceClass != UICLASS_HID)
170 return (UMATCH_NONE);
172 return (uaa->matchlvl);
173 return (UMATCH_IFACECLASS_GENERIC);
177 uhid_attach(device_t self)
179 struct uhid_softc *sc = device_get_softc(self);
180 struct usb_attach_arg *uaa = device_get_ivars(self);
181 usbd_interface_handle iface = uaa->iface;
182 usb_interface_descriptor_t *id;
183 usb_endpoint_descriptor_t *ed;
189 sc->sc_udev = uaa->device;
190 sc->sc_iface = iface;
191 id = usbd_get_interface_descriptor(iface);
192 usbd_devinfo(uaa->device, 0, devinfo);
194 device_set_desc_copy(self, devinfo);
195 kprintf("%s: %s, iclass %d/%d\n", device_get_nameunit(sc->sc_dev),
196 devinfo, id->bInterfaceClass, id->bInterfaceSubClass);
198 ed = usbd_interface2endpoint_descriptor(iface, 0);
200 kprintf("%s: could not read endpoint descriptor\n",
201 device_get_nameunit(sc->sc_dev));
206 DPRINTFN(10,("uhid_attach: bLength=%d bDescriptorType=%d "
207 "bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d"
209 ed->bLength, ed->bDescriptorType,
210 ed->bEndpointAddress & UE_ADDR,
211 UE_GET_DIR(ed->bEndpointAddress)==UE_DIR_IN? "in" : "out",
212 ed->bmAttributes & UE_XFERTYPE,
213 UGETW(ed->wMaxPacketSize), ed->bInterval));
215 if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_IN ||
216 (ed->bmAttributes & UE_XFERTYPE) != UE_INTERRUPT) {
217 kprintf("%s: unexpected endpoint\n", device_get_nameunit(sc->sc_dev));
222 sc->sc_ep_addr = ed->bEndpointAddress;
224 if (uaa->vendor == USB_VENDOR_WACOM &&
225 uaa->product == USB_PRODUCT_WACOM_GRAPHIRE /* &&
226 uaa->revision == 0x???? */) { /* XXX should use revision */
227 /* The report descriptor for the Wacom Graphire is broken. */
228 size = sizeof uhid_graphire_report_descr;
229 desc = kmalloc(size, M_USBDEV, M_INTWAIT);
230 err = USBD_NORMAL_COMPLETION;
231 memcpy(desc, uhid_graphire_report_descr, size);
234 err = usbd_read_report_desc(uaa->iface, &desc, &size,M_USBDEV);
238 kprintf("%s: no report descriptor\n", device_get_nameunit(sc->sc_dev));
243 (void)usbd_set_idle(iface, 0, 0);
245 sc->sc_isize = hid_report_size(desc, size, hid_input, &sc->sc_iid);
246 sc->sc_osize = hid_report_size(desc, size, hid_output, &sc->sc_oid);
247 sc->sc_fsize = hid_report_size(desc, size, hid_feature, &sc->sc_fid);
249 sc->sc_repdesc = desc;
250 sc->sc_repdesc_size = size;
252 dev_ops_add(&uhid_ops, -1, device_get_unit(self));
253 make_dev(&uhid_ops, device_get_unit(self),
254 UID_ROOT, GID_OPERATOR,
255 0644, "uhid%d", device_get_unit(self));
261 uhid_detach(device_t self)
263 struct uhid_softc *sc = device_get_softc(self);
265 DPRINTF(("uhid_detach: sc=%p\n", sc));
268 if (sc->sc_intrpipe != NULL)
269 usbd_abort_pipe(sc->sc_intrpipe);
271 if (sc->sc_state & UHID_OPEN) {
273 if (--sc->sc_refcnt >= 0) {
276 /* Wait for processes to go away. */
277 usb_detach_wait(sc->sc_dev);
282 dev_ops_remove(&uhid_ops, -1, device_get_unit(self));
285 kfree(sc->sc_repdesc, M_USBDEV);
291 uhid_intr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status)
293 struct uhid_softc *sc = addr;
299 usbd_get_xfer_status(xfer, NULL, NULL, &cc, NULL);
300 DPRINTF(("uhid_intr: status=%d cc=%d\n", status, cc));
301 DPRINTF(("uhid_intr: data ="));
302 for (i = 0; i < cc; i++)
303 DPRINTF((" %02x", sc->sc_ibuf[i]));
308 if (status == USBD_CANCELLED)
311 if (status != USBD_NORMAL_COMPLETION) {
312 DPRINTF(("uhid_intr: status=%d\n", status));
313 if (status == USBD_STALLED)
314 sc->sc_state |= UHID_NEEDCLEAR;
318 (void) b_to_q(sc->sc_ibuf, sc->sc_isize, &sc->sc_q);
320 if (sc->sc_state & UHID_ASLP) {
321 sc->sc_state &= ~UHID_ASLP;
322 DPRINTFN(5, ("uhid_intr: waking %p\n", &sc->sc_q));
325 selwakeuppri(&sc->sc_rsel, 0);
326 if (sc->sc_async != NULL) {
327 DPRINTFN(3, ("uhid_intr: sending SIGIO %p\n", sc->sc_async));
328 ksignal(sc->sc_async, SIGIO);
333 uhidopen(struct dev_open_args *ap)
335 cdev_t dev = ap->a_head.a_dev;
336 struct uhid_softc *sc;
339 USB_GET_SC_OPEN(uhid, UHIDUNIT(dev), sc);
341 DPRINTF(("uhidopen: sc=%p\n", sc));
346 if (sc->sc_state & UHID_OPEN)
348 sc->sc_state |= UHID_OPEN;
350 if (clalloc(&sc->sc_q, UHID_BSIZE, 0) == -1) {
351 sc->sc_state &= ~UHID_OPEN;
355 sc->sc_ibuf = kmalloc(sc->sc_isize, M_USBDEV, M_WAITOK);
356 sc->sc_obuf = kmalloc(sc->sc_osize, M_USBDEV, M_WAITOK);
358 /* Set up interrupt pipe. */
359 err = usbd_open_pipe_intr(sc->sc_iface, sc->sc_ep_addr,
360 USBD_SHORT_XFER_OK, &sc->sc_intrpipe, sc, sc->sc_ibuf,
361 sc->sc_isize, uhid_intr, USBD_DEFAULT_INTERVAL);
363 DPRINTF(("uhidopen: usbd_open_pipe_intr failed, "
365 kfree(sc->sc_ibuf, M_USBDEV);
366 kfree(sc->sc_obuf, M_USBDEV);
367 sc->sc_ibuf = sc->sc_obuf = NULL;
369 sc->sc_state &= ~UHID_OPEN;
373 sc->sc_state &= ~UHID_IMMED;
381 uhidclose(struct dev_close_args *ap)
383 cdev_t dev = ap->a_head.a_dev;
384 struct uhid_softc *sc;
386 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
388 DPRINTF(("uhidclose: sc=%p\n", sc));
390 /* Disable interrupts. */
391 usbd_abort_pipe(sc->sc_intrpipe);
392 usbd_close_pipe(sc->sc_intrpipe);
395 ndflush(&sc->sc_q, sc->sc_q.c_cc);
398 kfree(sc->sc_ibuf, M_USBDEV);
399 kfree(sc->sc_obuf, M_USBDEV);
400 sc->sc_ibuf = sc->sc_obuf = NULL;
402 sc->sc_state &= ~UHID_OPEN;
410 uhid_do_read(struct uhid_softc *sc, struct uio *uio, int flag)
414 u_char buffer[UHID_CHUNK];
417 DPRINTFN(1, ("uhidread\n"));
418 if (sc->sc_state & UHID_IMMED) {
419 DPRINTFN(1, ("uhidread immed\n"));
421 err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
422 sc->sc_iid, buffer, sc->sc_isize);
425 return (uiomove(buffer, sc->sc_isize, uio));
429 while (sc->sc_q.c_cc == 0) {
430 if (flag & IO_NDELAY) {
432 return (EWOULDBLOCK);
434 sc->sc_state |= UHID_ASLP;
435 DPRINTFN(5, ("uhidread: sleep on %p\n", &sc->sc_q));
436 error = tsleep(&sc->sc_q, PCATCH, "uhidrea", 0);
437 DPRINTFN(5, ("uhidread: woke, error=%d\n", error));
441 sc->sc_state &= ~UHID_ASLP;
444 if (sc->sc_state & UHID_NEEDCLEAR) {
445 DPRINTFN(-1,("uhidread: clearing stall\n"));
446 sc->sc_state &= ~UHID_NEEDCLEAR;
447 usbd_clear_endpoint_stall(sc->sc_intrpipe);
452 /* Transfer as many chunks as possible. */
453 while (sc->sc_q.c_cc > 0 && uio->uio_resid > 0 && !error) {
454 length = min(sc->sc_q.c_cc, uio->uio_resid);
455 if (length > sizeof(buffer))
456 length = sizeof(buffer);
458 /* Remove a small chunk from the input queue. */
459 (void) q_to_b(&sc->sc_q, buffer, length);
460 DPRINTFN(5, ("uhidread: got %lu chars\n", (u_long)length));
462 /* Copy the data to the user process. */
463 if ((error = uiomove(buffer, length, uio)) != 0)
471 uhidread(struct dev_read_args *ap)
473 cdev_t dev = ap->a_head.a_dev;
474 struct uhid_softc *sc;
477 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
480 error = uhid_do_read(sc, ap->a_uio, ap->a_ioflag);
481 if (--sc->sc_refcnt < 0)
482 usb_detach_wakeup(sc->sc_dev);
487 uhid_do_write(struct uhid_softc *sc, struct uio *uio, int flag)
493 DPRINTFN(1, ("uhidwrite\n"));
500 if (uio->uio_resid != size)
502 error = uiomove(sc->sc_obuf, size, uio);
505 err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
506 sc->sc_obuf[0], sc->sc_obuf+1, size-1);
508 err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
509 0, sc->sc_obuf, size);
518 uhidwrite(struct dev_write_args *ap)
520 cdev_t dev = ap->a_head.a_dev;
521 struct uhid_softc *sc;
524 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
527 error = uhid_do_write(sc, ap->a_uio, ap->a_ioflag);
528 if (--sc->sc_refcnt < 0)
529 usb_detach_wakeup(sc->sc_dev);
534 uhid_do_ioctl(struct uhid_softc *sc, u_long cmd, caddr_t addr, int flag)
536 struct usb_ctl_report_desc *rd;
537 struct usb_ctl_report *re;
541 DPRINTFN(2, ("uhidioctl: cmd=%lx\n", cmd));
549 if (sc->sc_async != NULL)
551 sc->sc_async = curproc;
552 DPRINTF(("uhid_do_ioctl: FIOASYNC %p\n", sc->sc_async));
557 /* XXX this is not the most general solution. */
559 if (sc->sc_async == NULL)
561 if (*(int *)addr != sc->sc_async->p_pgid)
565 case USB_GET_REPORT_DESC:
566 rd = (struct usb_ctl_report_desc *)addr;
567 size = min(sc->sc_repdesc_size, sizeof rd->ucrd_data);
568 rd->ucrd_size = size;
569 memcpy(rd->ucrd_data, sc->sc_repdesc, size);
574 /* XXX should read into ibuf, but does it matter? */
575 err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
576 sc->sc_iid, sc->sc_ibuf, sc->sc_isize);
580 sc->sc_state |= UHID_IMMED;
582 sc->sc_state &= ~UHID_IMMED;
586 re = (struct usb_ctl_report *)addr;
587 switch (re->ucr_report) {
588 case UHID_INPUT_REPORT:
592 case UHID_OUTPUT_REPORT:
596 case UHID_FEATURE_REPORT:
603 err = usbd_get_report(sc->sc_iface, re->ucr_report, id, re->ucr_data,
610 re = (struct usb_ctl_report *)addr;
611 switch (re->ucr_report) {
612 case UHID_INPUT_REPORT:
616 case UHID_OUTPUT_REPORT:
620 case UHID_FEATURE_REPORT:
627 err = usbd_set_report(sc->sc_iface, re->ucr_report, id, re->ucr_data,
633 case USB_GET_REPORT_ID:
634 *(int *)addr = 0; /* XXX: we only support reportid 0? */
644 uhidioctl(struct dev_ioctl_args *ap)
646 cdev_t dev = ap->a_head.a_dev;
647 struct uhid_softc *sc;
650 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
653 error = uhid_do_ioctl(sc, ap->a_cmd, ap->a_data, ap->a_fflag);
654 if (--sc->sc_refcnt < 0)
655 usb_detach_wakeup(sc->sc_dev);
660 uhidpoll(struct dev_poll_args *ap)
662 cdev_t dev = ap->a_head.a_dev;
663 struct uhid_softc *sc;
666 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
672 if (ap->a_events & (POLLOUT | POLLWRNORM))
673 revents |= ap->a_events & (POLLOUT | POLLWRNORM);
674 if (ap->a_events & (POLLIN | POLLRDNORM)) {
675 if (sc->sc_q.c_cc > 0)
676 revents |= ap->a_events & (POLLIN | POLLRDNORM);
678 selrecord(curthread, &sc->sc_rsel);
681 ap->a_events = revents;
685 DRIVER_MODULE(uhid, uhub, uhid_driver, uhid_devclass, usbd_driver_load, 0);