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 $ */
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>
48 #include <sys/malloc.h>
49 #include <sys/signalvar.h>
50 #if defined(__NetBSD__) || defined(__OpenBSD__)
51 #include <sys/device.h>
52 #include <sys/ioctl.h>
53 #elif defined(__FreeBSD__)
54 #include <sys/ioccom.h>
55 #include <sys/filio.h>
56 #include <sys/module.h>
58 #include <sys/ioccom.h>
63 #include <sys/select.h>
65 #include <sys/vnode.h>
67 #include <sys/sysctl.h>
69 #include <dev/usb/usb.h>
70 #include <dev/usb/usbhid.h>
72 #include <dev/usb/usbdi.h>
73 #include <dev/usb/usbdi_util.h>
74 #include <dev/usb/hid.h>
76 #if defined(__FreeBSD__) && defined(__i386__)
77 #include <i386/isa/intr_machdep.h>
81 #define DPRINTF(x) if (uhiddebug) logprintf x
82 #define DPRINTFN(n,x) if (uhiddebug>(n)) logprintf x
84 SYSCTL_NODE(_hw_usb, OID_AUTO, uhid, CTLFLAG_RW, 0, "USB uhid");
85 SYSCTL_INT(_hw_usb_uhid, OID_AUTO, debug, CTLFLAG_RW,
86 &uhiddebug, 0, "uhid debug level");
93 USBBASEDEVICE sc_dev; /* base device */
94 usbd_device_handle sc_udev;
95 usbd_interface_handle sc_iface; /* interface */
96 usbd_pipe_handle sc_intrpipe; /* interrupt pipe */
113 struct selinfo sc_rsel;
114 struct proc *sc_async; /* process that wants SIGIO */
115 u_char sc_state; /* driver state */
116 #define UHID_OPEN 0x01 /* device is open */
117 #define UHID_ASLP 0x02 /* waiting for device data */
118 #define UHID_NEEDCLEAR 0x04 /* needs clearing endpoint stall */
119 #define UHID_IMMED 0x08 /* return read data immediately */
124 #if defined(__FreeBSD__)
129 #define UHIDUNIT(dev) (minor(dev))
130 #define UHID_CHUNK 128 /* chunk size for read */
131 #define UHID_BSIZE 1020 /* buffer size */
133 #if defined(__NetBSD__) || defined(__OpenBSD__)
135 #elif defined(__FreeBSD__)
143 #define UHID_CDEV_MAJOR 122
145 Static struct cdevsw uhid_cdevsw = {
147 /* close */ uhidclose,
149 /* write */ uhidwrite,
150 /* ioctl */ uhidioctl,
153 /* strategy */ nostrategy,
155 /* maj */ UHID_CDEV_MAJOR,
163 Static void uhid_intr(usbd_xfer_handle, usbd_private_handle,
166 Static int uhid_do_read(struct uhid_softc *, struct uio *uio, int);
167 Static int uhid_do_write(struct uhid_softc *, struct uio *uio, int);
168 Static int uhid_do_ioctl(struct uhid_softc *, u_long, caddr_t, int,
171 USB_DECLARE_DRIVER(uhid);
175 USB_MATCH_START(uhid, uaa);
176 usb_interface_descriptor_t *id;
178 if (uaa->iface == NULL)
179 return (UMATCH_NONE);
180 id = usbd_get_interface_descriptor(uaa->iface);
181 if (id == NULL || id->bInterfaceClass != UICLASS_HID)
182 return (UMATCH_NONE);
183 return (UMATCH_IFACECLASS_GENERIC);
188 USB_ATTACH_START(uhid, sc, uaa);
189 usbd_interface_handle iface = uaa->iface;
190 usb_interface_descriptor_t *id;
191 usb_endpoint_descriptor_t *ed;
197 sc->sc_udev = uaa->device;
198 sc->sc_iface = iface;
199 id = usbd_get_interface_descriptor(iface);
200 usbd_devinfo(uaa->device, 0, devinfo);
202 printf("%s: %s, iclass %d/%d\n", USBDEVNAME(sc->sc_dev),
203 devinfo, id->bInterfaceClass, id->bInterfaceSubClass);
205 ed = usbd_interface2endpoint_descriptor(iface, 0);
207 printf("%s: could not read endpoint descriptor\n",
208 USBDEVNAME(sc->sc_dev));
210 USB_ATTACH_ERROR_RETURN;
213 DPRINTFN(10,("uhid_attach: bLength=%d bDescriptorType=%d "
214 "bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d"
216 ed->bLength, ed->bDescriptorType,
217 ed->bEndpointAddress & UE_ADDR,
218 UE_GET_DIR(ed->bEndpointAddress)==UE_DIR_IN? "in" : "out",
219 ed->bmAttributes & UE_XFERTYPE,
220 UGETW(ed->wMaxPacketSize), ed->bInterval));
222 if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_IN ||
223 (ed->bmAttributes & UE_XFERTYPE) != UE_INTERRUPT) {
224 printf("%s: unexpected endpoint\n", USBDEVNAME(sc->sc_dev));
226 USB_ATTACH_ERROR_RETURN;
229 sc->sc_ep_addr = ed->bEndpointAddress;
232 err = usbd_alloc_report_desc(uaa->iface, &desc, &size, M_USBDEV);
234 printf("%s: no report descriptor\n", USBDEVNAME(sc->sc_dev));
236 USB_ATTACH_ERROR_RETURN;
239 (void)usbd_set_idle(iface, 0, 0);
241 sc->sc_isize = hid_report_size(desc, size, hid_input, &sc->sc_iid);
242 sc->sc_osize = hid_report_size(desc, size, hid_output, &sc->sc_oid);
243 sc->sc_fsize = hid_report_size(desc, size, hid_feature, &sc->sc_fid);
245 sc->sc_repdesc = desc;
246 sc->sc_repdesc_size = size;
248 #if defined(__FreeBSD__)
249 sc->dev = make_dev(&uhid_cdevsw, device_get_unit(self),
250 UID_ROOT, GID_OPERATOR,
251 0644, "uhid%d", device_get_unit(self));
254 USB_ATTACH_SUCCESS_RETURN;
257 #if defined(__NetBSD__) || defined(__OpenBSD__)
259 uhid_activate(device_ptr_t self, enum devact act)
261 struct uhid_softc *sc = (struct uhid_softc *)self;
268 case DVACT_DEACTIVATE:
278 USB_DETACH_START(uhid, sc);
280 #if defined(__NetBSD__) || defined(__OpenBSD__)
282 #elif defined(__FreeBSD__)
286 #if defined(__NetBSD__) || defined(__OpenBSD__)
287 DPRINTF(("uhid_detach: sc=%p flags=%d\n", sc, flags));
289 DPRINTF(("uhid_detach: sc=%p\n", sc));
293 if (sc->sc_intrpipe != NULL)
294 usbd_abort_pipe(sc->sc_intrpipe);
296 if (sc->sc_state & UHID_OPEN) {
298 if (--sc->sc_refcnt >= 0) {
301 /* Wait for processes to go away. */
302 usb_detach_wait(USBDEV(sc->sc_dev));
307 #if defined(__NetBSD__) || defined(__OpenBSD__)
308 /* locate the major number */
309 for (maj = 0; maj < nchrdev; maj++)
310 if (cdevsw[maj].d_open == uhidopen)
313 /* Nuke the vnodes for any open instances (calls close). */
315 vdevgone(maj, mn, mn, VCHR);
316 #elif defined(__FreeBSD__)
317 vp = SLIST_FIRST(&sc->dev->si_hlist);
319 VOP_REVOKE(vp, REVOKEALL);
321 destroy_dev(sc->dev);
324 free(sc->sc_repdesc, M_USBDEV);
330 uhid_intr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status)
332 struct uhid_softc *sc = addr;
338 usbd_get_xfer_status(xfer, NULL, NULL, &cc, NULL);
339 DPRINTF(("uhid_intr: status=%d cc=%d\n", status, cc));
340 DPRINTF(("uhid_intr: data ="));
341 for (i = 0; i < cc; i++)
342 DPRINTF((" %02x", sc->sc_ibuf[i]));
347 if (status == USBD_CANCELLED)
350 if (status != USBD_NORMAL_COMPLETION) {
351 DPRINTF(("uhid_intr: status=%d\n", status));
352 sc->sc_state |= UHID_NEEDCLEAR;
356 (void) b_to_q(sc->sc_ibuf, sc->sc_isize, &sc->sc_q);
358 if (sc->sc_state & UHID_ASLP) {
359 sc->sc_state &= ~UHID_ASLP;
360 DPRINTFN(5, ("uhid_intr: waking %p\n", sc));
363 selwakeup(&sc->sc_rsel);
364 if (sc->sc_async != NULL) {
365 DPRINTFN(3, ("uhid_intr: sending SIGIO %p\n", sc->sc_async));
366 psignal(sc->sc_async, SIGIO);
371 uhidopen(dev_t dev, int flag, int mode, usb_proc_ptr p)
373 struct uhid_softc *sc;
375 #if defined(__FreeBSD__) && defined(__i386__)
376 static int hid_opened;
378 if (hid_opened == 0) {
381 tty_imask |= bio_imask;
388 USB_GET_SC_OPEN(uhid, UHIDUNIT(dev), sc);
390 DPRINTF(("uhidopen: sc=%p\n", sc));
395 if (sc->sc_state & UHID_OPEN)
397 sc->sc_state |= UHID_OPEN;
399 if (clalloc(&sc->sc_q, UHID_BSIZE, 0) == -1) {
400 sc->sc_state &= ~UHID_OPEN;
404 sc->sc_ibuf = malloc(sc->sc_isize, M_USBDEV, M_WAITOK);
405 sc->sc_obuf = malloc(sc->sc_osize, M_USBDEV, M_WAITOK);
407 /* Set up interrupt pipe. */
408 err = usbd_open_pipe_intr(sc->sc_iface, sc->sc_ep_addr,
409 USBD_SHORT_XFER_OK, &sc->sc_intrpipe, sc, sc->sc_ibuf,
410 sc->sc_isize, uhid_intr, USBD_DEFAULT_INTERVAL);
412 DPRINTF(("uhidopen: usbd_open_pipe_intr failed, "
414 free(sc->sc_ibuf, M_USBDEV);
415 free(sc->sc_obuf, M_USBDEV);
416 sc->sc_state &= ~UHID_OPEN;
420 sc->sc_state &= ~UHID_IMMED;
428 uhidclose(dev_t dev, int flag, int mode, usb_proc_ptr p)
430 struct uhid_softc *sc;
432 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
434 DPRINTF(("uhidclose: sc=%p\n", sc));
436 /* Disable interrupts. */
437 usbd_abort_pipe(sc->sc_intrpipe);
438 usbd_close_pipe(sc->sc_intrpipe);
441 ndflush(&sc->sc_q, sc->sc_q.c_cc);
444 free(sc->sc_ibuf, M_USBDEV);
445 free(sc->sc_obuf, M_USBDEV);
447 sc->sc_state &= ~UHID_OPEN;
455 uhid_do_read(struct uhid_softc *sc, struct uio *uio, int flag)
460 u_char buffer[UHID_CHUNK];
463 DPRINTFN(1, ("uhidread\n"));
464 if (sc->sc_state & UHID_IMMED) {
465 DPRINTFN(1, ("uhidread immed\n"));
467 err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
468 sc->sc_iid, buffer, sc->sc_isize);
471 return (uiomove(buffer, sc->sc_isize, uio));
475 while (sc->sc_q.c_cc == 0) {
476 if (flag & IO_NDELAY) {
478 return (EWOULDBLOCK);
480 sc->sc_state |= UHID_ASLP;
481 DPRINTFN(5, ("uhidread: sleep on %p\n", sc));
482 error = tsleep(&sc->sc_q, PZERO | PCATCH, "uhidrea", 0);
483 DPRINTFN(5, ("uhidread: woke, error=%d\n", error));
487 sc->sc_state &= ~UHID_ASLP;
490 if (sc->sc_state & UHID_NEEDCLEAR) {
491 DPRINTFN(-1,("uhidread: clearing stall\n"));
492 sc->sc_state &= ~UHID_NEEDCLEAR;
493 usbd_clear_endpoint_stall(sc->sc_intrpipe);
498 /* Transfer as many chunks as possible. */
499 while (sc->sc_q.c_cc > 0 && uio->uio_resid > 0 && !error) {
500 length = min(sc->sc_q.c_cc, uio->uio_resid);
501 if (length > sizeof(buffer))
502 length = sizeof(buffer);
504 /* Remove a small chunk from the input queue. */
505 (void) q_to_b(&sc->sc_q, buffer, length);
506 DPRINTFN(5, ("uhidread: got %lu chars\n", (u_long)length));
508 /* Copy the data to the user process. */
509 if ((error = uiomove(buffer, length, uio)) != 0)
517 uhidread(dev_t dev, struct uio *uio, int flag)
519 struct uhid_softc *sc;
522 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
525 error = uhid_do_read(sc, uio, flag);
526 if (--sc->sc_refcnt < 0)
527 usb_detach_wakeup(USBDEV(sc->sc_dev));
532 uhid_do_write(struct uhid_softc *sc, struct uio *uio, int flag)
538 DPRINTFN(1, ("uhidwrite\n"));
545 if (uio->uio_resid != size)
547 error = uiomove(sc->sc_obuf, size, uio);
550 err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
551 sc->sc_obuf[0], sc->sc_obuf+1, size-1);
553 err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
554 0, sc->sc_obuf, size);
563 uhidwrite(dev_t dev, struct uio *uio, int flag)
565 struct uhid_softc *sc;
568 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
571 error = uhid_do_write(sc, uio, flag);
572 if (--sc->sc_refcnt < 0)
573 usb_detach_wakeup(USBDEV(sc->sc_dev));
578 uhid_do_ioctl(struct uhid_softc *sc, u_long cmd, caddr_t addr, int flag,
581 struct usb_ctl_report_desc *rd;
582 struct usb_ctl_report *re;
586 DPRINTFN(2, ("uhidioctl: cmd=%lx\n", cmd));
593 /* All handled in the upper FS layer. */
598 if (sc->sc_async != NULL)
601 DPRINTF(("uhid_do_ioctl: FIOASYNC %p\n", p));
606 /* XXX this is not the most general solution. */
608 if (sc->sc_async == NULL)
610 if (*(int *)addr != sc->sc_async->p_pgid)
614 case USB_GET_REPORT_DESC:
615 rd = (struct usb_ctl_report_desc *)addr;
616 size = min(sc->sc_repdesc_size, sizeof rd->ucrd_data);
617 rd->ucrd_size = size;
618 memcpy(rd->ucrd_data, sc->sc_repdesc, size);
623 /* XXX should read into ibuf, but does it matter? */
624 err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
625 sc->sc_iid, sc->sc_ibuf, sc->sc_isize);
629 sc->sc_state |= UHID_IMMED;
631 sc->sc_state &= ~UHID_IMMED;
635 re = (struct usb_ctl_report *)addr;
636 switch (re->ucr_report) {
637 case UHID_INPUT_REPORT:
641 case UHID_OUTPUT_REPORT:
645 case UHID_FEATURE_REPORT:
652 err = usbd_get_report(sc->sc_iface, re->ucr_report, id, re->ucr_data,
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_set_report(sc->sc_iface, re->ucr_report, id, re->ucr_data,
689 uhidioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, usb_proc_ptr p)
691 struct uhid_softc *sc;
694 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
697 error = uhid_do_ioctl(sc, cmd, addr, flag, p);
698 if (--sc->sc_refcnt < 0)
699 usb_detach_wakeup(USBDEV(sc->sc_dev));
704 uhidpoll(dev_t dev, int events, usb_proc_ptr p)
706 struct uhid_softc *sc;
710 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
716 if (events & (POLLOUT | POLLWRNORM))
717 revents |= events & (POLLOUT | POLLWRNORM);
718 if (events & (POLLIN | POLLRDNORM)) {
719 if (sc->sc_q.c_cc > 0)
720 revents |= events & (POLLIN | POLLRDNORM);
722 selrecord(p, &sc->sc_rsel);
729 #if defined(__FreeBSD__)
730 DRIVER_MODULE(uhid, uhub, uhid_driver, uhid_devclass, usbd_driver_load, 0);