1 /* $NetBSD: uhid.c,v 1.38 2000/04/27 15:26:48 augustss Exp $ */
2 /* $FreeBSD: src/sys/dev/usb/uhid.c,v 1.27.2.12 2002/11/06 20:23:50 joe Exp $ */
3 /* $DragonFly: src/sys/dev/usbmisc/uhid/uhid.c,v 1.3 2003/06/23 17:55:36 dillon Exp $ */
6 * Copyright (c) 1998 The NetBSD Foundation, Inc.
9 * This code is derived from software contributed to The NetBSD Foundation
10 * by Lennart Augustsson (lennart@augustsson.net) at
11 * Carlstedt Research & Technology.
13 * Redistribution and use in source and binary forms, with or without
14 * modification, are permitted provided that the following conditions
16 * 1. Redistributions of source code must retain the above copyright
17 * notice, this list of conditions and the following disclaimer.
18 * 2. Redistributions in binary form must reproduce the above copyright
19 * notice, this list of conditions and the following disclaimer in the
20 * documentation and/or other materials provided with the distribution.
21 * 3. All advertising materials mentioning features or use of this software
22 * must display the following acknowledgement:
23 * This product includes software developed by the NetBSD
24 * Foundation, Inc. and its contributors.
25 * 4. Neither the name of The NetBSD Foundation nor the names of its
26 * contributors may be used to endorse or promote products derived
27 * from this software without specific prior written permission.
29 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
30 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
31 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
32 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
33 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
34 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
35 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
36 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
37 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
39 * POSSIBILITY OF SUCH DAMAGE.
43 * HID spec: http://www.usb.org/developers/data/usbhid10.pdf
46 #include <sys/param.h>
47 #include <sys/systm.h>
48 #include <sys/kernel.h>
49 #include <sys/malloc.h>
50 #include <sys/signalvar.h>
51 #if defined(__NetBSD__) || defined(__OpenBSD__)
52 #include <sys/device.h>
53 #include <sys/ioctl.h>
54 #elif defined(__FreeBSD__)
55 #include <sys/ioccom.h>
56 #include <sys/filio.h>
57 #include <sys/module.h>
59 #include <sys/ioccom.h>
64 #include <sys/select.h>
66 #include <sys/vnode.h>
68 #include <sys/sysctl.h>
70 #include <dev/usb/usb.h>
71 #include <dev/usb/usbhid.h>
73 #include <dev/usb/usbdi.h>
74 #include <dev/usb/usbdi_util.h>
75 #include <dev/usb/hid.h>
77 #if defined(__FreeBSD__) && defined(__i386__)
78 #include <i386/isa/intr_machdep.h>
82 #define DPRINTF(x) if (uhiddebug) logprintf x
83 #define DPRINTFN(n,x) if (uhiddebug>(n)) logprintf x
85 SYSCTL_NODE(_hw_usb, OID_AUTO, uhid, CTLFLAG_RW, 0, "USB uhid");
86 SYSCTL_INT(_hw_usb_uhid, OID_AUTO, debug, CTLFLAG_RW,
87 &uhiddebug, 0, "uhid debug level");
94 USBBASEDEVICE sc_dev; /* base device */
95 usbd_device_handle sc_udev;
96 usbd_interface_handle sc_iface; /* interface */
97 usbd_pipe_handle sc_intrpipe; /* interrupt pipe */
114 struct selinfo sc_rsel;
115 struct proc *sc_async; /* process that wants SIGIO */
116 u_char sc_state; /* driver state */
117 #define UHID_OPEN 0x01 /* device is open */
118 #define UHID_ASLP 0x02 /* waiting for device data */
119 #define UHID_NEEDCLEAR 0x04 /* needs clearing endpoint stall */
120 #define UHID_IMMED 0x08 /* return read data immediately */
125 #if defined(__FreeBSD__)
130 #define UHIDUNIT(dev) (minor(dev))
131 #define UHID_CHUNK 128 /* chunk size for read */
132 #define UHID_BSIZE 1020 /* buffer size */
134 #if defined(__NetBSD__) || defined(__OpenBSD__)
136 #elif defined(__FreeBSD__)
144 #define UHID_CDEV_MAJOR 122
146 Static struct cdevsw uhid_cdevsw = {
148 /* close */ uhidclose,
150 /* write */ uhidwrite,
151 /* ioctl */ uhidioctl,
154 /* strategy */ nostrategy,
156 /* maj */ UHID_CDEV_MAJOR,
164 Static void uhid_intr(usbd_xfer_handle, usbd_private_handle,
167 Static int uhid_do_read(struct uhid_softc *, struct uio *uio, int);
168 Static int uhid_do_write(struct uhid_softc *, struct uio *uio, int);
169 Static int uhid_do_ioctl(struct uhid_softc *, u_long, caddr_t, int,
172 USB_DECLARE_DRIVER(uhid);
176 USB_MATCH_START(uhid, uaa);
177 usb_interface_descriptor_t *id;
179 if (uaa->iface == NULL)
180 return (UMATCH_NONE);
181 id = usbd_get_interface_descriptor(uaa->iface);
182 if (id == NULL || id->bInterfaceClass != UICLASS_HID)
183 return (UMATCH_NONE);
184 return (UMATCH_IFACECLASS_GENERIC);
189 USB_ATTACH_START(uhid, sc, uaa);
190 usbd_interface_handle iface = uaa->iface;
191 usb_interface_descriptor_t *id;
192 usb_endpoint_descriptor_t *ed;
198 sc->sc_udev = uaa->device;
199 sc->sc_iface = iface;
200 id = usbd_get_interface_descriptor(iface);
201 usbd_devinfo(uaa->device, 0, devinfo);
203 printf("%s: %s, iclass %d/%d\n", USBDEVNAME(sc->sc_dev),
204 devinfo, id->bInterfaceClass, id->bInterfaceSubClass);
206 ed = usbd_interface2endpoint_descriptor(iface, 0);
208 printf("%s: could not read endpoint descriptor\n",
209 USBDEVNAME(sc->sc_dev));
211 USB_ATTACH_ERROR_RETURN;
214 DPRINTFN(10,("uhid_attach: bLength=%d bDescriptorType=%d "
215 "bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d"
217 ed->bLength, ed->bDescriptorType,
218 ed->bEndpointAddress & UE_ADDR,
219 UE_GET_DIR(ed->bEndpointAddress)==UE_DIR_IN? "in" : "out",
220 ed->bmAttributes & UE_XFERTYPE,
221 UGETW(ed->wMaxPacketSize), ed->bInterval));
223 if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_IN ||
224 (ed->bmAttributes & UE_XFERTYPE) != UE_INTERRUPT) {
225 printf("%s: unexpected endpoint\n", USBDEVNAME(sc->sc_dev));
227 USB_ATTACH_ERROR_RETURN;
230 sc->sc_ep_addr = ed->bEndpointAddress;
233 err = usbd_alloc_report_desc(uaa->iface, &desc, &size, M_USBDEV);
235 printf("%s: no report descriptor\n", USBDEVNAME(sc->sc_dev));
237 USB_ATTACH_ERROR_RETURN;
240 (void)usbd_set_idle(iface, 0, 0);
242 sc->sc_isize = hid_report_size(desc, size, hid_input, &sc->sc_iid);
243 sc->sc_osize = hid_report_size(desc, size, hid_output, &sc->sc_oid);
244 sc->sc_fsize = hid_report_size(desc, size, hid_feature, &sc->sc_fid);
246 sc->sc_repdesc = desc;
247 sc->sc_repdesc_size = size;
249 #if defined(__FreeBSD__)
250 sc->dev = make_dev(&uhid_cdevsw, device_get_unit(self),
251 UID_ROOT, GID_OPERATOR,
252 0644, "uhid%d", device_get_unit(self));
255 USB_ATTACH_SUCCESS_RETURN;
258 #if defined(__NetBSD__) || defined(__OpenBSD__)
260 uhid_activate(device_ptr_t self, enum devact act)
262 struct uhid_softc *sc = (struct uhid_softc *)self;
269 case DVACT_DEACTIVATE:
279 USB_DETACH_START(uhid, sc);
281 #if defined(__NetBSD__) || defined(__OpenBSD__)
283 #elif defined(__FreeBSD__)
287 #if defined(__NetBSD__) || defined(__OpenBSD__)
288 DPRINTF(("uhid_detach: sc=%p flags=%d\n", sc, flags));
290 DPRINTF(("uhid_detach: sc=%p\n", sc));
294 if (sc->sc_intrpipe != NULL)
295 usbd_abort_pipe(sc->sc_intrpipe);
297 if (sc->sc_state & UHID_OPEN) {
299 if (--sc->sc_refcnt >= 0) {
302 /* Wait for processes to go away. */
303 usb_detach_wait(USBDEV(sc->sc_dev));
308 #if defined(__NetBSD__) || defined(__OpenBSD__)
309 /* locate the major number */
310 for (maj = 0; maj < nchrdev; maj++)
311 if (cdevsw[maj].d_open == uhidopen)
314 /* Nuke the vnodes for any open instances (calls close). */
316 vdevgone(maj, mn, mn, VCHR);
317 #elif defined(__FreeBSD__)
318 vp = SLIST_FIRST(&sc->dev->si_hlist);
320 VOP_REVOKE(vp, REVOKEALL);
322 destroy_dev(sc->dev);
325 free(sc->sc_repdesc, M_USBDEV);
331 uhid_intr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status)
333 struct uhid_softc *sc = addr;
339 usbd_get_xfer_status(xfer, NULL, NULL, &cc, NULL);
340 DPRINTF(("uhid_intr: status=%d cc=%d\n", status, cc));
341 DPRINTF(("uhid_intr: data ="));
342 for (i = 0; i < cc; i++)
343 DPRINTF((" %02x", sc->sc_ibuf[i]));
348 if (status == USBD_CANCELLED)
351 if (status != USBD_NORMAL_COMPLETION) {
352 DPRINTF(("uhid_intr: status=%d\n", status));
353 sc->sc_state |= UHID_NEEDCLEAR;
357 (void) b_to_q(sc->sc_ibuf, sc->sc_isize, &sc->sc_q);
359 if (sc->sc_state & UHID_ASLP) {
360 sc->sc_state &= ~UHID_ASLP;
361 DPRINTFN(5, ("uhid_intr: waking %p\n", sc));
364 selwakeup(&sc->sc_rsel);
365 if (sc->sc_async != NULL) {
366 DPRINTFN(3, ("uhid_intr: sending SIGIO %p\n", sc->sc_async));
367 psignal(sc->sc_async, SIGIO);
372 uhidopen(dev_t dev, int flag, int mode, usb_proc_ptr p)
374 struct uhid_softc *sc;
376 #if defined(__FreeBSD__) && defined(__i386__)
377 static int hid_opened;
379 if (hid_opened == 0) {
382 tty_imask |= bio_imask;
389 USB_GET_SC_OPEN(uhid, UHIDUNIT(dev), sc);
391 DPRINTF(("uhidopen: sc=%p\n", sc));
396 if (sc->sc_state & UHID_OPEN)
398 sc->sc_state |= UHID_OPEN;
400 if (clalloc(&sc->sc_q, UHID_BSIZE, 0) == -1) {
401 sc->sc_state &= ~UHID_OPEN;
405 sc->sc_ibuf = malloc(sc->sc_isize, M_USBDEV, M_WAITOK);
406 sc->sc_obuf = malloc(sc->sc_osize, M_USBDEV, M_WAITOK);
408 /* Set up interrupt pipe. */
409 err = usbd_open_pipe_intr(sc->sc_iface, sc->sc_ep_addr,
410 USBD_SHORT_XFER_OK, &sc->sc_intrpipe, sc, sc->sc_ibuf,
411 sc->sc_isize, uhid_intr, USBD_DEFAULT_INTERVAL);
413 DPRINTF(("uhidopen: usbd_open_pipe_intr failed, "
415 free(sc->sc_ibuf, M_USBDEV);
416 free(sc->sc_obuf, M_USBDEV);
417 sc->sc_state &= ~UHID_OPEN;
421 sc->sc_state &= ~UHID_IMMED;
429 uhidclose(dev_t dev, int flag, int mode, usb_proc_ptr p)
431 struct uhid_softc *sc;
433 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
435 DPRINTF(("uhidclose: sc=%p\n", sc));
437 /* Disable interrupts. */
438 usbd_abort_pipe(sc->sc_intrpipe);
439 usbd_close_pipe(sc->sc_intrpipe);
442 ndflush(&sc->sc_q, sc->sc_q.c_cc);
445 free(sc->sc_ibuf, M_USBDEV);
446 free(sc->sc_obuf, M_USBDEV);
448 sc->sc_state &= ~UHID_OPEN;
456 uhid_do_read(struct uhid_softc *sc, struct uio *uio, int flag)
461 u_char buffer[UHID_CHUNK];
464 DPRINTFN(1, ("uhidread\n"));
465 if (sc->sc_state & UHID_IMMED) {
466 DPRINTFN(1, ("uhidread immed\n"));
468 err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
469 sc->sc_iid, buffer, sc->sc_isize);
472 return (uiomove(buffer, sc->sc_isize, uio));
476 while (sc->sc_q.c_cc == 0) {
477 if (flag & IO_NDELAY) {
479 return (EWOULDBLOCK);
481 sc->sc_state |= UHID_ASLP;
482 DPRINTFN(5, ("uhidread: sleep on %p\n", sc));
483 error = tsleep(&sc->sc_q, PZERO | PCATCH, "uhidrea", 0);
484 DPRINTFN(5, ("uhidread: woke, error=%d\n", error));
488 sc->sc_state &= ~UHID_ASLP;
491 if (sc->sc_state & UHID_NEEDCLEAR) {
492 DPRINTFN(-1,("uhidread: clearing stall\n"));
493 sc->sc_state &= ~UHID_NEEDCLEAR;
494 usbd_clear_endpoint_stall(sc->sc_intrpipe);
499 /* Transfer as many chunks as possible. */
500 while (sc->sc_q.c_cc > 0 && uio->uio_resid > 0 && !error) {
501 length = min(sc->sc_q.c_cc, uio->uio_resid);
502 if (length > sizeof(buffer))
503 length = sizeof(buffer);
505 /* Remove a small chunk from the input queue. */
506 (void) q_to_b(&sc->sc_q, buffer, length);
507 DPRINTFN(5, ("uhidread: got %lu chars\n", (u_long)length));
509 /* Copy the data to the user process. */
510 if ((error = uiomove(buffer, length, uio)) != 0)
518 uhidread(dev_t dev, struct uio *uio, int flag)
520 struct uhid_softc *sc;
523 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
526 error = uhid_do_read(sc, uio, flag);
527 if (--sc->sc_refcnt < 0)
528 usb_detach_wakeup(USBDEV(sc->sc_dev));
533 uhid_do_write(struct uhid_softc *sc, struct uio *uio, int flag)
539 DPRINTFN(1, ("uhidwrite\n"));
546 if (uio->uio_resid != size)
548 error = uiomove(sc->sc_obuf, size, uio);
551 err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
552 sc->sc_obuf[0], sc->sc_obuf+1, size-1);
554 err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
555 0, sc->sc_obuf, size);
564 uhidwrite(dev_t dev, struct uio *uio, int flag)
566 struct uhid_softc *sc;
569 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
572 error = uhid_do_write(sc, uio, flag);
573 if (--sc->sc_refcnt < 0)
574 usb_detach_wakeup(USBDEV(sc->sc_dev));
579 uhid_do_ioctl(struct uhid_softc *sc, u_long cmd, caddr_t addr, int flag,
582 struct usb_ctl_report_desc *rd;
583 struct usb_ctl_report *re;
587 DPRINTFN(2, ("uhidioctl: cmd=%lx\n", cmd));
594 /* All handled in the upper FS layer. */
599 if (sc->sc_async != NULL)
601 sc->sc_async = p->td_proc;
602 DPRINTF(("uhid_do_ioctl: FIOASYNC %p\n", p));
607 /* XXX this is not the most general solution. */
609 if (sc->sc_async == NULL)
611 if (*(int *)addr != sc->sc_async->p_pgid)
615 case USB_GET_REPORT_DESC:
616 rd = (struct usb_ctl_report_desc *)addr;
617 size = min(sc->sc_repdesc_size, sizeof rd->ucrd_data);
618 rd->ucrd_size = size;
619 memcpy(rd->ucrd_data, sc->sc_repdesc, size);
624 /* XXX should read into ibuf, but does it matter? */
625 err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
626 sc->sc_iid, sc->sc_ibuf, sc->sc_isize);
630 sc->sc_state |= UHID_IMMED;
632 sc->sc_state &= ~UHID_IMMED;
636 re = (struct usb_ctl_report *)addr;
637 switch (re->ucr_report) {
638 case UHID_INPUT_REPORT:
642 case UHID_OUTPUT_REPORT:
646 case UHID_FEATURE_REPORT:
653 err = usbd_get_report(sc->sc_iface, re->ucr_report, id, re->ucr_data,
660 re = (struct usb_ctl_report *)addr;
661 switch (re->ucr_report) {
662 case UHID_INPUT_REPORT:
666 case UHID_OUTPUT_REPORT:
670 case UHID_FEATURE_REPORT:
677 err = usbd_set_report(sc->sc_iface, re->ucr_report, id, re->ucr_data,
690 uhidioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, usb_proc_ptr p)
692 struct uhid_softc *sc;
695 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
698 error = uhid_do_ioctl(sc, cmd, addr, flag, p);
699 if (--sc->sc_refcnt < 0)
700 usb_detach_wakeup(USBDEV(sc->sc_dev));
705 uhidpoll(dev_t dev, int events, usb_proc_ptr p)
707 struct uhid_softc *sc;
711 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
717 if (events & (POLLOUT | POLLWRNORM))
718 revents |= events & (POLLOUT | POLLWRNORM);
719 if (events & (POLLIN | POLLRDNORM)) {
720 if (sc->sc_q.c_cc > 0)
721 revents |= events & (POLLIN | POLLRDNORM);
723 selrecord(p, &sc->sc_rsel);
730 #if defined(__FreeBSD__)
731 DRIVER_MODULE(uhid, uhub, uhid_driver, uhid_devclass, usbd_driver_load, 0);