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.12 2004/05/13 23:49:21 dillon 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 #if defined(__FreeBSD__) && __FreeBSD_version >= 500000
58 #include <sys/mutex.h>
60 #include <sys/signalvar.h>
61 #if defined(__NetBSD__) || defined(__OpenBSD__)
62 #include <sys/device.h>
63 #include <sys/ioctl.h>
65 #elif defined(__FreeBSD__) || defined(__DragonFly__)
66 #include <sys/ioccom.h>
67 #include <sys/filio.h>
68 #include <sys/module.h>
70 #include <sys/ioccom.h>
74 #if defined(__FreeBSD__) && __FreeBSD_version >= 500014
75 #include <sys/selinfo.h>
77 #include <sys/select.h>
80 #include <sys/vnode.h>
82 #include <sys/sysctl.h>
84 #include <bus/usb/usb.h>
85 #include <bus/usb/usbhid.h>
87 #include <bus/usb/usbdevs.h>
88 #include <bus/usb/usbdi.h>
89 #include <bus/usb/usbdi_util.h>
90 #include <bus/usb/hid.h>
92 /* Report descriptor for broken Wacom Graphire */
93 #include <bus/usb/ugraphire_rdesc.h>
96 #define DPRINTF(x) if (uhiddebug) logprintf x
97 #define DPRINTFN(n,x) if (uhiddebug>(n)) logprintf x
99 SYSCTL_NODE(_hw_usb, OID_AUTO, uhid, CTLFLAG_RW, 0, "USB uhid");
100 SYSCTL_INT(_hw_usb_uhid, OID_AUTO, debug, CTLFLAG_RW,
101 &uhiddebug, 0, "uhid debug level");
104 #define DPRINTFN(n,x)
108 USBBASEDEVICE sc_dev; /* base device */
109 usbd_device_handle sc_udev;
110 usbd_interface_handle sc_iface; /* interface */
111 usbd_pipe_handle sc_intrpipe; /* interrupt pipe */
128 struct selinfo sc_rsel;
129 struct proc *sc_async; /* process that wants SIGIO */
130 u_char sc_state; /* driver state */
131 #define UHID_OPEN 0x01 /* device is open */
132 #define UHID_ASLP 0x02 /* waiting for device data */
133 #define UHID_NEEDCLEAR 0x04 /* needs clearing endpoint stall */
134 #define UHID_IMMED 0x08 /* return read data immediately */
139 #if defined(__FreeBSD__) || defined(__DragonFly__)
144 #define UHIDUNIT(dev) (minor(dev))
145 #define UHID_CHUNK 128 /* chunk size for read */
146 #define UHID_BSIZE 1020 /* buffer size */
148 #if defined(__NetBSD__) || defined(__OpenBSD__)
150 #elif defined(__FreeBSD__) || defined(__DragonFly__)
158 #define UHID_CDEV_MAJOR 122
160 Static struct cdevsw uhid_cdevsw = {
162 /* maj */ UHID_CDEV_MAJOR,
168 /* close */ uhidclose,
170 /* write */ uhidwrite,
171 /* ioctl */ uhidioctl,
174 /* strategy */ nostrategy,
180 Static void uhid_intr(usbd_xfer_handle, usbd_private_handle,
183 Static int uhid_do_read(struct uhid_softc *, struct uio *uio, int);
184 Static int uhid_do_write(struct uhid_softc *, struct uio *uio, int);
185 Static int uhid_do_ioctl(struct uhid_softc *, u_long, caddr_t, int,
188 USB_DECLARE_DRIVER(uhid);
192 USB_MATCH_START(uhid, uaa);
193 usb_interface_descriptor_t *id;
195 if (uaa->iface == NULL)
196 return (UMATCH_NONE);
197 id = usbd_get_interface_descriptor(uaa->iface);
198 if (id == NULL || id->bInterfaceClass != UICLASS_HID)
199 return (UMATCH_NONE);
201 return (uaa->matchlvl);
202 return (UMATCH_IFACECLASS_GENERIC);
207 USB_ATTACH_START(uhid, sc, uaa);
208 usbd_interface_handle iface = uaa->iface;
209 usb_interface_descriptor_t *id;
210 usb_endpoint_descriptor_t *ed;
216 sc->sc_udev = uaa->device;
217 sc->sc_iface = iface;
218 id = usbd_get_interface_descriptor(iface);
219 usbd_devinfo(uaa->device, 0, devinfo);
221 printf("%s: %s, iclass %d/%d\n", USBDEVNAME(sc->sc_dev),
222 devinfo, id->bInterfaceClass, id->bInterfaceSubClass);
224 ed = usbd_interface2endpoint_descriptor(iface, 0);
226 printf("%s: could not read endpoint descriptor\n",
227 USBDEVNAME(sc->sc_dev));
229 USB_ATTACH_ERROR_RETURN;
232 DPRINTFN(10,("uhid_attach: bLength=%d bDescriptorType=%d "
233 "bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d"
235 ed->bLength, ed->bDescriptorType,
236 ed->bEndpointAddress & UE_ADDR,
237 UE_GET_DIR(ed->bEndpointAddress)==UE_DIR_IN? "in" : "out",
238 ed->bmAttributes & UE_XFERTYPE,
239 UGETW(ed->wMaxPacketSize), ed->bInterval));
241 if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_IN ||
242 (ed->bmAttributes & UE_XFERTYPE) != UE_INTERRUPT) {
243 printf("%s: unexpected endpoint\n", USBDEVNAME(sc->sc_dev));
245 USB_ATTACH_ERROR_RETURN;
248 sc->sc_ep_addr = ed->bEndpointAddress;
250 if (uaa->vendor == USB_VENDOR_WACOM &&
251 uaa->product == USB_PRODUCT_WACOM_GRAPHIRE /* &&
252 uaa->revision == 0x???? */) { /* XXX should use revision */
253 /* The report descriptor for the Wacom Graphire is broken. */
254 size = sizeof uhid_graphire_report_descr;
255 desc = malloc(size, M_USBDEV, M_INTWAIT);
256 err = USBD_NORMAL_COMPLETION;
257 memcpy(desc, uhid_graphire_report_descr, size);
260 err = usbd_read_report_desc(uaa->iface, &desc, &size,M_USBDEV);
264 printf("%s: no report descriptor\n", USBDEVNAME(sc->sc_dev));
266 USB_ATTACH_ERROR_RETURN;
269 (void)usbd_set_idle(iface, 0, 0);
271 sc->sc_isize = hid_report_size(desc, size, hid_input, &sc->sc_iid);
272 sc->sc_osize = hid_report_size(desc, size, hid_output, &sc->sc_oid);
273 sc->sc_fsize = hid_report_size(desc, size, hid_feature, &sc->sc_fid);
275 sc->sc_repdesc = desc;
276 sc->sc_repdesc_size = size;
278 #if defined(__FreeBSD__) || defined(__DragonFly__)
279 sc->dev = make_dev(&uhid_cdevsw, device_get_unit(self),
280 UID_ROOT, GID_OPERATOR,
281 0644, "uhid%d", device_get_unit(self));
284 USB_ATTACH_SUCCESS_RETURN;
287 #if defined(__NetBSD__) || defined(__OpenBSD__)
289 uhid_activate(device_ptr_t self, enum devact act)
291 struct uhid_softc *sc = (struct uhid_softc *)self;
297 case DVACT_DEACTIVATE:
307 USB_DETACH_START(uhid, sc);
309 #if defined(__NetBSD__) || defined(__OpenBSD__)
313 #if defined(__NetBSD__) || defined(__OpenBSD__)
314 DPRINTF(("uhid_detach: sc=%p flags=%d\n", sc, flags));
316 DPRINTF(("uhid_detach: sc=%p\n", sc));
320 if (sc->sc_intrpipe != NULL)
321 usbd_abort_pipe(sc->sc_intrpipe);
323 if (sc->sc_state & UHID_OPEN) {
325 if (--sc->sc_refcnt >= 0) {
328 /* Wait for processes to go away. */
329 usb_detach_wait(USBDEV(sc->sc_dev));
334 #if defined(__NetBSD__) || defined(__OpenBSD__)
335 /* locate the major number */
336 for (maj = 0; maj < nchrdev; maj++)
337 if (cdevsw[maj].d_open == uhidopen)
340 /* Nuke the vnodes for any open instances (calls close). */
342 vdevgone(maj, mn, mn, VCHR);
343 #elif defined(__FreeBSD__) || defined(__DragonFly__)
344 destroy_dev(sc->dev);
348 free(sc->sc_repdesc, M_USBDEV);
354 uhid_intr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status)
356 struct uhid_softc *sc = addr;
362 usbd_get_xfer_status(xfer, NULL, NULL, &cc, NULL);
363 DPRINTF(("uhid_intr: status=%d cc=%d\n", status, cc));
364 DPRINTF(("uhid_intr: data ="));
365 for (i = 0; i < cc; i++)
366 DPRINTF((" %02x", sc->sc_ibuf[i]));
371 if (status == USBD_CANCELLED)
374 if (status != USBD_NORMAL_COMPLETION) {
375 DPRINTF(("uhid_intr: status=%d\n", status));
376 if (status == USBD_STALLED)
377 sc->sc_state |= UHID_NEEDCLEAR;
381 (void) b_to_q(sc->sc_ibuf, sc->sc_isize, &sc->sc_q);
383 if (sc->sc_state & UHID_ASLP) {
384 sc->sc_state &= ~UHID_ASLP;
385 DPRINTFN(5, ("uhid_intr: waking %p\n", &sc->sc_q));
388 selwakeuppri(&sc->sc_rsel, 0);
389 if (sc->sc_async != NULL) {
390 DPRINTFN(3, ("uhid_intr: sending SIGIO %p\n", sc->sc_async));
391 PROC_LOCK(sc->sc_async);
392 psignal(sc->sc_async, SIGIO);
393 PROC_UNLOCK(sc->sc_async);
398 uhidopen(dev_t dev, int flag, int mode, usb_proc_ptr p)
400 struct uhid_softc *sc;
403 USB_GET_SC_OPEN(uhid, UHIDUNIT(dev), sc);
405 DPRINTF(("uhidopen: sc=%p\n", sc));
410 if (sc->sc_state & UHID_OPEN)
412 sc->sc_state |= UHID_OPEN;
414 if (clalloc(&sc->sc_q, UHID_BSIZE, 0) == -1) {
415 sc->sc_state &= ~UHID_OPEN;
419 sc->sc_ibuf = malloc(sc->sc_isize, M_USBDEV, M_WAITOK);
420 sc->sc_obuf = malloc(sc->sc_osize, M_USBDEV, M_WAITOK);
422 /* Set up interrupt pipe. */
423 err = usbd_open_pipe_intr(sc->sc_iface, sc->sc_ep_addr,
424 USBD_SHORT_XFER_OK, &sc->sc_intrpipe, sc, sc->sc_ibuf,
425 sc->sc_isize, uhid_intr, USBD_DEFAULT_INTERVAL);
427 DPRINTF(("uhidopen: usbd_open_pipe_intr failed, "
429 free(sc->sc_ibuf, M_USBDEV);
430 free(sc->sc_obuf, M_USBDEV);
431 sc->sc_ibuf = sc->sc_obuf = NULL;
433 sc->sc_state &= ~UHID_OPEN;
437 sc->sc_state &= ~UHID_IMMED;
445 uhidclose(dev_t dev, int flag, int mode, usb_proc_ptr p)
447 struct uhid_softc *sc;
449 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
451 DPRINTF(("uhidclose: sc=%p\n", sc));
453 /* Disable interrupts. */
454 usbd_abort_pipe(sc->sc_intrpipe);
455 usbd_close_pipe(sc->sc_intrpipe);
458 ndflush(&sc->sc_q, sc->sc_q.c_cc);
461 free(sc->sc_ibuf, M_USBDEV);
462 free(sc->sc_obuf, M_USBDEV);
463 sc->sc_ibuf = sc->sc_obuf = NULL;
465 sc->sc_state &= ~UHID_OPEN;
473 uhid_do_read(struct uhid_softc *sc, struct uio *uio, int flag)
478 u_char buffer[UHID_CHUNK];
481 DPRINTFN(1, ("uhidread\n"));
482 if (sc->sc_state & UHID_IMMED) {
483 DPRINTFN(1, ("uhidread immed\n"));
485 err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
486 sc->sc_iid, buffer, sc->sc_isize);
489 return (uiomove(buffer, sc->sc_isize, uio));
493 while (sc->sc_q.c_cc == 0) {
494 if (flag & IO_NDELAY) {
496 return (EWOULDBLOCK);
498 sc->sc_state |= UHID_ASLP;
499 DPRINTFN(5, ("uhidread: sleep on %p\n", &sc->sc_q));
500 error = tsleep(&sc->sc_q, PCATCH, "uhidrea", 0);
501 DPRINTFN(5, ("uhidread: woke, error=%d\n", error));
505 sc->sc_state &= ~UHID_ASLP;
508 if (sc->sc_state & UHID_NEEDCLEAR) {
509 DPRINTFN(-1,("uhidread: clearing stall\n"));
510 sc->sc_state &= ~UHID_NEEDCLEAR;
511 usbd_clear_endpoint_stall(sc->sc_intrpipe);
516 /* Transfer as many chunks as possible. */
517 while (sc->sc_q.c_cc > 0 && uio->uio_resid > 0 && !error) {
518 length = min(sc->sc_q.c_cc, uio->uio_resid);
519 if (length > sizeof(buffer))
520 length = sizeof(buffer);
522 /* Remove a small chunk from the input queue. */
523 (void) q_to_b(&sc->sc_q, buffer, length);
524 DPRINTFN(5, ("uhidread: got %lu chars\n", (u_long)length));
526 /* Copy the data to the user process. */
527 if ((error = uiomove(buffer, length, uio)) != 0)
535 uhidread(dev_t dev, struct uio *uio, int flag)
537 struct uhid_softc *sc;
540 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
543 error = uhid_do_read(sc, uio, flag);
544 if (--sc->sc_refcnt < 0)
545 usb_detach_wakeup(USBDEV(sc->sc_dev));
550 uhid_do_write(struct uhid_softc *sc, struct uio *uio, int flag)
556 DPRINTFN(1, ("uhidwrite\n"));
563 if (uio->uio_resid != size)
565 error = uiomove(sc->sc_obuf, size, uio);
568 err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
569 sc->sc_obuf[0], sc->sc_obuf+1, size-1);
571 err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
572 0, sc->sc_obuf, size);
581 uhidwrite(dev_t dev, struct uio *uio, int flag)
583 struct uhid_softc *sc;
586 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
589 error = uhid_do_write(sc, uio, flag);
590 if (--sc->sc_refcnt < 0)
591 usb_detach_wakeup(USBDEV(sc->sc_dev));
596 uhid_do_ioctl(struct uhid_softc *sc, u_long cmd, caddr_t addr, int flag,
599 struct usb_ctl_report_desc *rd;
600 struct usb_ctl_report *re;
604 DPRINTFN(2, ("uhidioctl: cmd=%lx\n", cmd));
611 /* All handled in the upper FS layer. */
616 if (sc->sc_async != NULL)
618 #if defined(__DragonFly__)
619 sc->sc_async = p->td_proc;
620 #elif __FreeBSD_version >= 500000
621 sc->sc_async = p->td_proc;
625 DPRINTF(("uhid_do_ioctl: FIOASYNC %p\n", sc->sc_async));
630 /* XXX this is not the most general solution. */
632 if (sc->sc_async == NULL)
634 if (*(int *)addr != sc->sc_async->p_pgid)
638 case USB_GET_REPORT_DESC:
639 rd = (struct usb_ctl_report_desc *)addr;
640 size = min(sc->sc_repdesc_size, sizeof rd->ucrd_data);
641 rd->ucrd_size = size;
642 memcpy(rd->ucrd_data, sc->sc_repdesc, size);
647 /* XXX should read into ibuf, but does it matter? */
648 err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
649 sc->sc_iid, sc->sc_ibuf, sc->sc_isize);
653 sc->sc_state |= UHID_IMMED;
655 sc->sc_state &= ~UHID_IMMED;
659 re = (struct usb_ctl_report *)addr;
660 switch (re->ucr_report) {
661 case UHID_INPUT_REPORT:
665 case UHID_OUTPUT_REPORT:
669 case UHID_FEATURE_REPORT:
676 err = usbd_get_report(sc->sc_iface, re->ucr_report, id, re->ucr_data,
683 re = (struct usb_ctl_report *)addr;
684 switch (re->ucr_report) {
685 case UHID_INPUT_REPORT:
689 case UHID_OUTPUT_REPORT:
693 case UHID_FEATURE_REPORT:
700 err = usbd_set_report(sc->sc_iface, re->ucr_report, id, re->ucr_data,
706 case USB_GET_REPORT_ID:
707 *(int *)addr = 0; /* XXX: we only support reportid 0? */
717 uhidioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, usb_proc_ptr p)
719 struct uhid_softc *sc;
722 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
725 error = uhid_do_ioctl(sc, cmd, addr, flag, p);
726 if (--sc->sc_refcnt < 0)
727 usb_detach_wakeup(USBDEV(sc->sc_dev));
732 uhidpoll(dev_t dev, int events, usb_proc_ptr p)
734 struct uhid_softc *sc;
738 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
744 if (events & (POLLOUT | POLLWRNORM))
745 revents |= events & (POLLOUT | POLLWRNORM);
746 if (events & (POLLIN | POLLRDNORM)) {
747 if (sc->sc_q.c_cc > 0)
748 revents |= events & (POLLIN | POLLRDNORM);
750 selrecord(p, &sc->sc_rsel);
757 #if defined(__FreeBSD__) || defined(__DragonFly__)
758 DRIVER_MODULE(uhid, uhub, uhid_driver, uhid_devclass, usbd_driver_load, 0);