1 /* $NetBSD: uhid.c,v 1.45 2001/10/26 17:58:21 augustss Exp $ */
5 * Copyright (c) 1998 The NetBSD Foundation, Inc.
8 * This code is derived from software contributed to The NetBSD Foundation
9 * by Lennart Augustsson (lennart@augustsson.net) at
10 * Carlstedt Research & Technology.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. All advertising materials mentioning features or use of this software
21 * must display the following acknowledgement:
22 * This product includes software developed by the NetBSD
23 * Foundation, Inc. and its contributors.
24 * 4. Neither the name of The NetBSD Foundation nor the names of its
25 * contributors may be used to endorse or promote products derived
26 * from this software without specific prior written permission.
28 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
32 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38 * POSSIBILITY OF SUCH DAMAGE.
42 * HID spec: http://www.usb.org/developers/data/usbhid10.pdf
45 #include <sys/param.h>
46 #include <sys/systm.h>
47 #include <sys/kernel.h>
49 #include <sys/malloc.h>
50 #include <sys/mutex.h>
51 #include <sys/signalvar.h>
52 #if defined(__NetBSD__) || defined(__OpenBSD__)
53 #include <sys/device.h>
54 #include <sys/ioctl.h>
56 #elif defined(__FreeBSD__)
57 #include <sys/ioccom.h>
58 #include <sys/filio.h>
59 #include <sys/module.h>
61 #include <sys/ioccom.h>
65 #if __FreeBSD_version >= 500014
66 #include <sys/selinfo.h>
68 #include <sys/select.h>
71 #include <sys/vnode.h>
73 #include <sys/sysctl.h>
75 #include <dev/usb/usb.h>
76 #include <dev/usb/usbhid.h>
78 #include <dev/usb/usbdevs.h>
79 #include <dev/usb/usbdi.h>
80 #include <dev/usb/usbdi_util.h>
81 #include <dev/usb/hid.h>
83 /* Report descriptor for broken Wacom Graphire */
84 #include <dev/usb/ugraphire_rdesc.h>
87 #define DPRINTF(x) if (uhiddebug) logprintf x
88 #define DPRINTFN(n,x) if (uhiddebug>(n)) logprintf x
90 SYSCTL_NODE(_hw_usb, OID_AUTO, uhid, CTLFLAG_RW, 0, "USB uhid");
91 SYSCTL_INT(_hw_usb_uhid, OID_AUTO, debug, CTLFLAG_RW,
92 &uhiddebug, 0, "uhid debug level");
99 USBBASEDEVICE sc_dev; /* base device */
100 usbd_device_handle sc_udev;
101 usbd_interface_handle sc_iface; /* interface */
102 usbd_pipe_handle sc_intrpipe; /* interrupt pipe */
119 struct selinfo sc_rsel;
120 struct proc *sc_async; /* process that wants SIGIO */
121 u_char sc_state; /* driver state */
122 #define UHID_OPEN 0x01 /* device is open */
123 #define UHID_ASLP 0x02 /* waiting for device data */
124 #define UHID_NEEDCLEAR 0x04 /* needs clearing endpoint stall */
125 #define UHID_IMMED 0x08 /* return read data immediately */
130 #if defined(__FreeBSD__)
135 #define UHIDUNIT(dev) (minor(dev))
136 #define UHID_CHUNK 128 /* chunk size for read */
137 #define UHID_BSIZE 1020 /* buffer size */
139 #if defined(__NetBSD__) || defined(__OpenBSD__)
141 #elif defined(__FreeBSD__)
149 #define UHID_CDEV_MAJOR 122
151 Static struct cdevsw uhid_cdevsw = {
153 /* close */ uhidclose,
155 /* write */ uhidwrite,
156 /* ioctl */ uhidioctl,
159 /* strategy */ nostrategy,
161 /* maj */ UHID_CDEV_MAJOR,
165 #if __FreeBSD_version < 500014
171 Static void uhid_intr(usbd_xfer_handle, usbd_private_handle,
174 Static int uhid_do_read(struct uhid_softc *, struct uio *uio, int);
175 Static int uhid_do_write(struct uhid_softc *, struct uio *uio, int);
176 Static int uhid_do_ioctl(struct uhid_softc *, u_long, caddr_t, int,
179 USB_DECLARE_DRIVER(uhid);
183 USB_MATCH_START(uhid, uaa);
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);
198 USB_ATTACH_START(uhid, sc, uaa);
199 usbd_interface_handle iface = uaa->iface;
200 usb_interface_descriptor_t *id;
201 usb_endpoint_descriptor_t *ed;
207 sc->sc_udev = uaa->device;
208 sc->sc_iface = iface;
209 id = usbd_get_interface_descriptor(iface);
210 usbd_devinfo(uaa->device, 0, devinfo);
212 printf("%s: %s, iclass %d/%d\n", USBDEVNAME(sc->sc_dev),
213 devinfo, id->bInterfaceClass, id->bInterfaceSubClass);
215 ed = usbd_interface2endpoint_descriptor(iface, 0);
217 printf("%s: could not read endpoint descriptor\n",
218 USBDEVNAME(sc->sc_dev));
220 USB_ATTACH_ERROR_RETURN;
223 DPRINTFN(10,("uhid_attach: bLength=%d bDescriptorType=%d "
224 "bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d"
226 ed->bLength, ed->bDescriptorType,
227 ed->bEndpointAddress & UE_ADDR,
228 UE_GET_DIR(ed->bEndpointAddress)==UE_DIR_IN? "in" : "out",
229 ed->bmAttributes & UE_XFERTYPE,
230 UGETW(ed->wMaxPacketSize), ed->bInterval));
232 if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_IN ||
233 (ed->bmAttributes & UE_XFERTYPE) != UE_INTERRUPT) {
234 printf("%s: unexpected endpoint\n", USBDEVNAME(sc->sc_dev));
236 USB_ATTACH_ERROR_RETURN;
239 sc->sc_ep_addr = ed->bEndpointAddress;
241 if (uaa->vendor == USB_VENDOR_WACOM &&
242 uaa->product == USB_PRODUCT_WACOM_GRAPHIRE /* &&
243 uaa->revision == 0x???? */) { /* XXX should use revision */
244 /* The report descriptor for the Wacom Graphire is broken. */
245 size = sizeof uhid_graphire_report_descr;
246 desc = malloc(size, M_USBDEV, M_NOWAIT);
250 err = USBD_NORMAL_COMPLETION;
251 memcpy(desc, uhid_graphire_report_descr, size);
255 err = usbd_read_report_desc(uaa->iface, &desc, &size,M_USBDEV);
259 printf("%s: no report descriptor\n", USBDEVNAME(sc->sc_dev));
261 USB_ATTACH_ERROR_RETURN;
264 (void)usbd_set_idle(iface, 0, 0);
266 sc->sc_isize = hid_report_size(desc, size, hid_input, &sc->sc_iid);
267 sc->sc_osize = hid_report_size(desc, size, hid_output, &sc->sc_oid);
268 sc->sc_fsize = hid_report_size(desc, size, hid_feature, &sc->sc_fid);
270 sc->sc_repdesc = desc;
271 sc->sc_repdesc_size = size;
273 #if defined(__FreeBSD__)
274 sc->dev = make_dev(&uhid_cdevsw, device_get_unit(self),
275 UID_ROOT, GID_OPERATOR,
276 0644, "uhid%d", device_get_unit(self));
279 USB_ATTACH_SUCCESS_RETURN;
282 #if defined(__NetBSD__) || defined(__OpenBSD__)
284 uhid_activate(device_ptr_t self, enum devact act)
286 struct uhid_softc *sc = (struct uhid_softc *)self;
293 case DVACT_DEACTIVATE:
303 USB_DETACH_START(uhid, sc);
305 #if defined(__NetBSD__) || defined(__OpenBSD__)
307 #elif defined(__FreeBSD__)
311 #if defined(__NetBSD__) || defined(__OpenBSD__)
312 DPRINTF(("uhid_detach: sc=%p flags=%d\n", sc, flags));
314 DPRINTF(("uhid_detach: sc=%p\n", sc));
318 if (sc->sc_intrpipe != NULL)
319 usbd_abort_pipe(sc->sc_intrpipe);
321 if (sc->sc_state & UHID_OPEN) {
323 if (--sc->sc_refcnt >= 0) {
326 /* Wait for processes to go away. */
327 usb_detach_wait(USBDEV(sc->sc_dev));
332 #if defined(__NetBSD__) || defined(__OpenBSD__)
333 /* locate the major number */
334 for (maj = 0; maj < nchrdev; maj++)
335 if (cdevsw[maj].d_open == uhidopen)
338 /* Nuke the vnodes for any open instances (calls close). */
340 vdevgone(maj, mn, mn, VCHR);
341 #elif defined(__FreeBSD__)
342 vp = SLIST_FIRST(&sc->dev->si_hlist);
344 VOP_REVOKE(vp, REVOKEALL);
346 destroy_dev(sc->dev);
350 free(sc->sc_repdesc, M_USBDEV);
356 uhid_intr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status)
358 struct uhid_softc *sc = addr;
364 usbd_get_xfer_status(xfer, NULL, NULL, &cc, NULL);
365 DPRINTF(("uhid_intr: status=%d cc=%d\n", status, cc));
366 DPRINTF(("uhid_intr: data ="));
367 for (i = 0; i < cc; i++)
368 DPRINTF((" %02x", sc->sc_ibuf[i]));
373 if (status == USBD_CANCELLED)
376 if (status != USBD_NORMAL_COMPLETION) {
377 DPRINTF(("uhid_intr: status=%d\n", status));
378 if (status == USBD_STALLED)
379 sc->sc_state |= UHID_NEEDCLEAR;
383 (void) b_to_q(sc->sc_ibuf, sc->sc_isize, &sc->sc_q);
385 if (sc->sc_state & UHID_ASLP) {
386 sc->sc_state &= ~UHID_ASLP;
387 DPRINTFN(5, ("uhid_intr: waking %p\n", &sc->sc_q));
390 selwakeup(&sc->sc_rsel);
391 if (sc->sc_async != NULL) {
392 DPRINTFN(3, ("uhid_intr: sending SIGIO %p\n", sc->sc_async));
393 PROC_LOCK(sc->sc_async);
394 psignal(sc->sc_async, SIGIO);
395 PROC_UNLOCK(sc->sc_async);
400 uhidopen(dev_t dev, int flag, int mode, usb_proc_ptr p)
402 struct uhid_softc *sc;
405 USB_GET_SC_OPEN(uhid, UHIDUNIT(dev), sc);
407 DPRINTF(("uhidopen: sc=%p\n", sc));
412 if (sc->sc_state & UHID_OPEN)
414 sc->sc_state |= UHID_OPEN;
416 if (clalloc(&sc->sc_q, UHID_BSIZE, 0) == -1) {
417 sc->sc_state &= ~UHID_OPEN;
421 sc->sc_ibuf = malloc(sc->sc_isize, M_USBDEV, M_WAITOK);
422 sc->sc_obuf = malloc(sc->sc_osize, M_USBDEV, M_WAITOK);
424 /* Set up interrupt pipe. */
425 err = usbd_open_pipe_intr(sc->sc_iface, sc->sc_ep_addr,
426 USBD_SHORT_XFER_OK, &sc->sc_intrpipe, sc, sc->sc_ibuf,
427 sc->sc_isize, uhid_intr, USBD_DEFAULT_INTERVAL);
429 DPRINTF(("uhidopen: usbd_open_pipe_intr failed, "
431 free(sc->sc_ibuf, M_USBDEV);
432 free(sc->sc_obuf, M_USBDEV);
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);
464 sc->sc_state &= ~UHID_OPEN;
472 uhid_do_read(struct uhid_softc *sc, struct uio *uio, int flag)
477 u_char buffer[UHID_CHUNK];
480 DPRINTFN(1, ("uhidread\n"));
481 if (sc->sc_state & UHID_IMMED) {
482 DPRINTFN(1, ("uhidread immed\n"));
484 err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
485 sc->sc_iid, buffer, sc->sc_isize);
488 return (uiomove(buffer, sc->sc_isize, uio));
492 while (sc->sc_q.c_cc == 0) {
493 if (flag & IO_NDELAY) {
495 return (EWOULDBLOCK);
497 sc->sc_state |= UHID_ASLP;
498 DPRINTFN(5, ("uhidread: sleep on %p\n", &sc->sc_q));
499 error = tsleep(&sc->sc_q, PZERO | PCATCH, "uhidrea", 0);
500 DPRINTFN(5, ("uhidread: woke, error=%d\n", error));
504 sc->sc_state &= ~UHID_ASLP;
507 if (sc->sc_state & UHID_NEEDCLEAR) {
508 DPRINTFN(-1,("uhidread: clearing stall\n"));
509 sc->sc_state &= ~UHID_NEEDCLEAR;
510 usbd_clear_endpoint_stall(sc->sc_intrpipe);
515 /* Transfer as many chunks as possible. */
516 while (sc->sc_q.c_cc > 0 && uio->uio_resid > 0 && !error) {
517 length = min(sc->sc_q.c_cc, uio->uio_resid);
518 if (length > sizeof(buffer))
519 length = sizeof(buffer);
521 /* Remove a small chunk from the input queue. */
522 (void) q_to_b(&sc->sc_q, buffer, length);
523 DPRINTFN(5, ("uhidread: got %lu chars\n", (u_long)length));
525 /* Copy the data to the user process. */
526 if ((error = uiomove(buffer, length, uio)) != 0)
534 uhidread(dev_t dev, struct uio *uio, int flag)
536 struct uhid_softc *sc;
539 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
542 error = uhid_do_read(sc, uio, flag);
543 if (--sc->sc_refcnt < 0)
544 usb_detach_wakeup(USBDEV(sc->sc_dev));
549 uhid_do_write(struct uhid_softc *sc, struct uio *uio, int flag)
555 DPRINTFN(1, ("uhidwrite\n"));
562 if (uio->uio_resid != size)
564 error = uiomove(sc->sc_obuf, size, uio);
567 err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
568 sc->sc_obuf[0], sc->sc_obuf+1, size-1);
570 err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
571 0, sc->sc_obuf, size);
580 uhidwrite(dev_t dev, struct uio *uio, int flag)
582 struct uhid_softc *sc;
585 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
588 error = uhid_do_write(sc, uio, flag);
589 if (--sc->sc_refcnt < 0)
590 usb_detach_wakeup(USBDEV(sc->sc_dev));
595 uhid_do_ioctl(struct uhid_softc *sc, u_long cmd, caddr_t addr, int flag,
598 struct usb_ctl_report_desc *rd;
599 struct usb_ctl_report *re;
603 DPRINTFN(2, ("uhidioctl: cmd=%lx\n", cmd));
610 /* All handled in the upper FS layer. */
615 if (sc->sc_async != NULL)
617 sc->sc_async = p->td_proc; /* XXXKSE */
618 DPRINTF(("uhid_do_ioctl: FIOASYNC %p\n", p->td_proc));
623 /* XXX this is not the most general solution. */
625 if (sc->sc_async == NULL)
627 if (*(int *)addr != sc->sc_async->p_pgid)
631 case USB_GET_REPORT_DESC:
632 rd = (struct usb_ctl_report_desc *)addr;
633 size = min(sc->sc_repdesc_size, sizeof rd->ucrd_data);
634 rd->ucrd_size = size;
635 memcpy(rd->ucrd_data, sc->sc_repdesc, size);
640 /* XXX should read into ibuf, but does it matter? */
641 err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
642 sc->sc_iid, sc->sc_ibuf, sc->sc_isize);
646 sc->sc_state |= UHID_IMMED;
648 sc->sc_state &= ~UHID_IMMED;
652 re = (struct usb_ctl_report *)addr;
653 switch (re->ucr_report) {
654 case UHID_INPUT_REPORT:
658 case UHID_OUTPUT_REPORT:
662 case UHID_FEATURE_REPORT:
669 err = usbd_get_report(sc->sc_iface, re->ucr_report, id, re->ucr_data,
676 re = (struct usb_ctl_report *)addr;
677 switch (re->ucr_report) {
678 case UHID_INPUT_REPORT:
682 case UHID_OUTPUT_REPORT:
686 case UHID_FEATURE_REPORT:
693 err = usbd_set_report(sc->sc_iface, re->ucr_report, id, re->ucr_data,
706 uhidioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, usb_proc_ptr p)
708 struct uhid_softc *sc;
711 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
714 error = uhid_do_ioctl(sc, cmd, addr, flag, p);
715 if (--sc->sc_refcnt < 0)
716 usb_detach_wakeup(USBDEV(sc->sc_dev));
721 uhidpoll(dev_t dev, int events, usb_proc_ptr p)
723 struct uhid_softc *sc;
727 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
733 if (events & (POLLOUT | POLLWRNORM))
734 revents |= events & (POLLOUT | POLLWRNORM);
735 if (events & (POLLIN | POLLRDNORM)) {
736 if (sc->sc_q.c_cc > 0)
737 revents |= events & (POLLIN | POLLRDNORM);
739 selrecord(p, &sc->sc_rsel);
746 #if defined(__FreeBSD__)
747 DRIVER_MODULE(uhid, uhub, uhid_driver, uhid_devclass, usbd_driver_load, 0);