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.14 2005/06/02 20:40:50 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>
83 #include <sys/thread2.h>
85 #include <bus/usb/usb.h>
86 #include <bus/usb/usbhid.h>
88 #include <bus/usb/usbdevs.h>
89 #include <bus/usb/usbdi.h>
90 #include <bus/usb/usbdi_util.h>
91 #include <bus/usb/hid.h>
93 /* Report descriptor for broken Wacom Graphire */
94 #include <bus/usb/ugraphire_rdesc.h>
97 #define DPRINTF(x) if (uhiddebug) logprintf x
98 #define DPRINTFN(n,x) if (uhiddebug>(n)) logprintf x
100 SYSCTL_NODE(_hw_usb, OID_AUTO, uhid, CTLFLAG_RW, 0, "USB uhid");
101 SYSCTL_INT(_hw_usb_uhid, OID_AUTO, debug, CTLFLAG_RW,
102 &uhiddebug, 0, "uhid debug level");
105 #define DPRINTFN(n,x)
109 USBBASEDEVICE sc_dev; /* base device */
110 usbd_device_handle sc_udev;
111 usbd_interface_handle sc_iface; /* interface */
112 usbd_pipe_handle sc_intrpipe; /* interrupt pipe */
129 struct selinfo sc_rsel;
130 struct proc *sc_async; /* process that wants SIGIO */
131 u_char sc_state; /* driver state */
132 #define UHID_OPEN 0x01 /* device is open */
133 #define UHID_ASLP 0x02 /* waiting for device data */
134 #define UHID_NEEDCLEAR 0x04 /* needs clearing endpoint stall */
135 #define UHID_IMMED 0x08 /* return read data immediately */
141 #define UHIDUNIT(dev) (minor(dev))
142 #define UHID_CHUNK 128 /* chunk size for read */
143 #define UHID_BSIZE 1020 /* buffer size */
145 #if defined(__NetBSD__) || defined(__OpenBSD__)
147 #elif defined(__FreeBSD__) || defined(__DragonFly__)
155 #define UHID_CDEV_MAJOR 122
157 Static struct cdevsw uhid_cdevsw = {
159 /* maj */ UHID_CDEV_MAJOR,
165 /* close */ uhidclose,
167 /* write */ uhidwrite,
168 /* ioctl */ uhidioctl,
171 /* strategy */ nostrategy,
177 Static void uhid_intr(usbd_xfer_handle, usbd_private_handle,
180 Static int uhid_do_read(struct uhid_softc *, struct uio *uio, int);
181 Static int uhid_do_write(struct uhid_softc *, struct uio *uio, int);
182 Static int uhid_do_ioctl(struct uhid_softc *, u_long, caddr_t, int,
185 USB_DECLARE_DRIVER(uhid);
189 USB_MATCH_START(uhid, uaa);
190 usb_interface_descriptor_t *id;
192 if (uaa->iface == NULL)
193 return (UMATCH_NONE);
194 id = usbd_get_interface_descriptor(uaa->iface);
195 if (id == NULL || id->bInterfaceClass != UICLASS_HID)
196 return (UMATCH_NONE);
198 return (uaa->matchlvl);
199 return (UMATCH_IFACECLASS_GENERIC);
204 USB_ATTACH_START(uhid, sc, uaa);
205 usbd_interface_handle iface = uaa->iface;
206 usb_interface_descriptor_t *id;
207 usb_endpoint_descriptor_t *ed;
213 sc->sc_udev = uaa->device;
214 sc->sc_iface = iface;
215 id = usbd_get_interface_descriptor(iface);
216 usbd_devinfo(uaa->device, 0, devinfo);
218 printf("%s: %s, iclass %d/%d\n", USBDEVNAME(sc->sc_dev),
219 devinfo, id->bInterfaceClass, id->bInterfaceSubClass);
221 ed = usbd_interface2endpoint_descriptor(iface, 0);
223 printf("%s: could not read endpoint descriptor\n",
224 USBDEVNAME(sc->sc_dev));
226 USB_ATTACH_ERROR_RETURN;
229 DPRINTFN(10,("uhid_attach: bLength=%d bDescriptorType=%d "
230 "bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d"
232 ed->bLength, ed->bDescriptorType,
233 ed->bEndpointAddress & UE_ADDR,
234 UE_GET_DIR(ed->bEndpointAddress)==UE_DIR_IN? "in" : "out",
235 ed->bmAttributes & UE_XFERTYPE,
236 UGETW(ed->wMaxPacketSize), ed->bInterval));
238 if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_IN ||
239 (ed->bmAttributes & UE_XFERTYPE) != UE_INTERRUPT) {
240 printf("%s: unexpected endpoint\n", USBDEVNAME(sc->sc_dev));
242 USB_ATTACH_ERROR_RETURN;
245 sc->sc_ep_addr = ed->bEndpointAddress;
247 if (uaa->vendor == USB_VENDOR_WACOM &&
248 uaa->product == USB_PRODUCT_WACOM_GRAPHIRE /* &&
249 uaa->revision == 0x???? */) { /* XXX should use revision */
250 /* The report descriptor for the Wacom Graphire is broken. */
251 size = sizeof uhid_graphire_report_descr;
252 desc = malloc(size, M_USBDEV, M_INTWAIT);
253 err = USBD_NORMAL_COMPLETION;
254 memcpy(desc, uhid_graphire_report_descr, size);
257 err = usbd_read_report_desc(uaa->iface, &desc, &size,M_USBDEV);
261 printf("%s: no report descriptor\n", USBDEVNAME(sc->sc_dev));
263 USB_ATTACH_ERROR_RETURN;
266 (void)usbd_set_idle(iface, 0, 0);
268 sc->sc_isize = hid_report_size(desc, size, hid_input, &sc->sc_iid);
269 sc->sc_osize = hid_report_size(desc, size, hid_output, &sc->sc_oid);
270 sc->sc_fsize = hid_report_size(desc, size, hid_feature, &sc->sc_fid);
272 sc->sc_repdesc = desc;
273 sc->sc_repdesc_size = size;
275 #if defined(__FreeBSD__) || defined(__DragonFly__)
276 cdevsw_add(&uhid_cdevsw, -1, device_get_unit(self));
277 make_dev(&uhid_cdevsw, device_get_unit(self),
278 UID_ROOT, GID_OPERATOR,
279 0644, "uhid%d", device_get_unit(self));
282 USB_ATTACH_SUCCESS_RETURN;
285 #if defined(__NetBSD__) || defined(__OpenBSD__)
287 uhid_activate(device_ptr_t self, enum devact act)
289 struct uhid_softc *sc = (struct uhid_softc *)self;
295 case DVACT_DEACTIVATE:
305 USB_DETACH_START(uhid, sc);
306 #if defined(__NetBSD__) || defined(__OpenBSD__)
310 #if defined(__NetBSD__) || defined(__OpenBSD__)
311 DPRINTF(("uhid_detach: sc=%p flags=%d\n", sc, flags));
313 DPRINTF(("uhid_detach: sc=%p\n", sc));
317 if (sc->sc_intrpipe != NULL)
318 usbd_abort_pipe(sc->sc_intrpipe);
320 if (sc->sc_state & UHID_OPEN) {
322 if (--sc->sc_refcnt >= 0) {
325 /* Wait for processes to go away. */
326 usb_detach_wait(USBDEV(sc->sc_dev));
331 #if defined(__NetBSD__) || defined(__OpenBSD__)
332 /* locate the major number */
333 for (maj = 0; maj < nchrdev; maj++)
334 if (cdevsw[maj].d_open == uhidopen)
337 /* Nuke the vnodes for any open instances (calls close). */
339 vdevgone(maj, mn, mn, VCHR);
340 #elif defined(__FreeBSD__) || defined(__DragonFly__)
341 cdevsw_remove(&uhid_cdevsw, -1, device_get_unit(self));
345 free(sc->sc_repdesc, M_USBDEV);
351 uhid_intr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status)
353 struct uhid_softc *sc = addr;
359 usbd_get_xfer_status(xfer, NULL, NULL, &cc, NULL);
360 DPRINTF(("uhid_intr: status=%d cc=%d\n", status, cc));
361 DPRINTF(("uhid_intr: data ="));
362 for (i = 0; i < cc; i++)
363 DPRINTF((" %02x", sc->sc_ibuf[i]));
368 if (status == USBD_CANCELLED)
371 if (status != USBD_NORMAL_COMPLETION) {
372 DPRINTF(("uhid_intr: status=%d\n", status));
373 if (status == USBD_STALLED)
374 sc->sc_state |= UHID_NEEDCLEAR;
378 (void) b_to_q(sc->sc_ibuf, sc->sc_isize, &sc->sc_q);
380 if (sc->sc_state & UHID_ASLP) {
381 sc->sc_state &= ~UHID_ASLP;
382 DPRINTFN(5, ("uhid_intr: waking %p\n", &sc->sc_q));
385 selwakeuppri(&sc->sc_rsel, 0);
386 if (sc->sc_async != NULL) {
387 DPRINTFN(3, ("uhid_intr: sending SIGIO %p\n", sc->sc_async));
388 PROC_LOCK(sc->sc_async);
389 psignal(sc->sc_async, SIGIO);
390 PROC_UNLOCK(sc->sc_async);
395 uhidopen(dev_t dev, int flag, int mode, usb_proc_ptr p)
397 struct uhid_softc *sc;
400 USB_GET_SC_OPEN(uhid, UHIDUNIT(dev), sc);
402 DPRINTF(("uhidopen: sc=%p\n", sc));
407 if (sc->sc_state & UHID_OPEN)
409 sc->sc_state |= UHID_OPEN;
411 if (clalloc(&sc->sc_q, UHID_BSIZE, 0) == -1) {
412 sc->sc_state &= ~UHID_OPEN;
416 sc->sc_ibuf = malloc(sc->sc_isize, M_USBDEV, M_WAITOK);
417 sc->sc_obuf = malloc(sc->sc_osize, M_USBDEV, M_WAITOK);
419 /* Set up interrupt pipe. */
420 err = usbd_open_pipe_intr(sc->sc_iface, sc->sc_ep_addr,
421 USBD_SHORT_XFER_OK, &sc->sc_intrpipe, sc, sc->sc_ibuf,
422 sc->sc_isize, uhid_intr, USBD_DEFAULT_INTERVAL);
424 DPRINTF(("uhidopen: usbd_open_pipe_intr failed, "
426 free(sc->sc_ibuf, M_USBDEV);
427 free(sc->sc_obuf, M_USBDEV);
428 sc->sc_ibuf = sc->sc_obuf = NULL;
430 sc->sc_state &= ~UHID_OPEN;
434 sc->sc_state &= ~UHID_IMMED;
442 uhidclose(dev_t dev, int flag, int mode, usb_proc_ptr p)
444 struct uhid_softc *sc;
446 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
448 DPRINTF(("uhidclose: sc=%p\n", sc));
450 /* Disable interrupts. */
451 usbd_abort_pipe(sc->sc_intrpipe);
452 usbd_close_pipe(sc->sc_intrpipe);
455 ndflush(&sc->sc_q, sc->sc_q.c_cc);
458 free(sc->sc_ibuf, M_USBDEV);
459 free(sc->sc_obuf, M_USBDEV);
460 sc->sc_ibuf = sc->sc_obuf = NULL;
462 sc->sc_state &= ~UHID_OPEN;
470 uhid_do_read(struct uhid_softc *sc, struct uio *uio, int flag)
474 u_char buffer[UHID_CHUNK];
477 DPRINTFN(1, ("uhidread\n"));
478 if (sc->sc_state & UHID_IMMED) {
479 DPRINTFN(1, ("uhidread immed\n"));
481 err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
482 sc->sc_iid, buffer, sc->sc_isize);
485 return (uiomove(buffer, sc->sc_isize, uio));
489 while (sc->sc_q.c_cc == 0) {
490 if (flag & IO_NDELAY) {
492 return (EWOULDBLOCK);
494 sc->sc_state |= UHID_ASLP;
495 DPRINTFN(5, ("uhidread: sleep on %p\n", &sc->sc_q));
496 error = tsleep(&sc->sc_q, PCATCH, "uhidrea", 0);
497 DPRINTFN(5, ("uhidread: woke, error=%d\n", error));
501 sc->sc_state &= ~UHID_ASLP;
504 if (sc->sc_state & UHID_NEEDCLEAR) {
505 DPRINTFN(-1,("uhidread: clearing stall\n"));
506 sc->sc_state &= ~UHID_NEEDCLEAR;
507 usbd_clear_endpoint_stall(sc->sc_intrpipe);
512 /* Transfer as many chunks as possible. */
513 while (sc->sc_q.c_cc > 0 && uio->uio_resid > 0 && !error) {
514 length = min(sc->sc_q.c_cc, uio->uio_resid);
515 if (length > sizeof(buffer))
516 length = sizeof(buffer);
518 /* Remove a small chunk from the input queue. */
519 (void) q_to_b(&sc->sc_q, buffer, length);
520 DPRINTFN(5, ("uhidread: got %lu chars\n", (u_long)length));
522 /* Copy the data to the user process. */
523 if ((error = uiomove(buffer, length, uio)) != 0)
531 uhidread(dev_t dev, struct uio *uio, int flag)
533 struct uhid_softc *sc;
536 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
539 error = uhid_do_read(sc, uio, flag);
540 if (--sc->sc_refcnt < 0)
541 usb_detach_wakeup(USBDEV(sc->sc_dev));
546 uhid_do_write(struct uhid_softc *sc, struct uio *uio, int flag)
552 DPRINTFN(1, ("uhidwrite\n"));
559 if (uio->uio_resid != size)
561 error = uiomove(sc->sc_obuf, size, uio);
564 err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
565 sc->sc_obuf[0], sc->sc_obuf+1, size-1);
567 err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
568 0, sc->sc_obuf, size);
577 uhidwrite(dev_t dev, struct uio *uio, int flag)
579 struct uhid_softc *sc;
582 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
585 error = uhid_do_write(sc, uio, flag);
586 if (--sc->sc_refcnt < 0)
587 usb_detach_wakeup(USBDEV(sc->sc_dev));
592 uhid_do_ioctl(struct uhid_softc *sc, u_long cmd, caddr_t addr, int flag,
595 struct usb_ctl_report_desc *rd;
596 struct usb_ctl_report *re;
600 DPRINTFN(2, ("uhidioctl: cmd=%lx\n", cmd));
607 /* All handled in the upper FS layer. */
612 if (sc->sc_async != NULL)
614 #if defined(__DragonFly__)
615 sc->sc_async = p->td_proc;
616 #elif __FreeBSD_version >= 500000
617 sc->sc_async = p->td_proc;
621 DPRINTF(("uhid_do_ioctl: FIOASYNC %p\n", sc->sc_async));
626 /* XXX this is not the most general solution. */
628 if (sc->sc_async == NULL)
630 if (*(int *)addr != sc->sc_async->p_pgid)
634 case USB_GET_REPORT_DESC:
635 rd = (struct usb_ctl_report_desc *)addr;
636 size = min(sc->sc_repdesc_size, sizeof rd->ucrd_data);
637 rd->ucrd_size = size;
638 memcpy(rd->ucrd_data, sc->sc_repdesc, size);
643 /* XXX should read into ibuf, but does it matter? */
644 err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
645 sc->sc_iid, sc->sc_ibuf, sc->sc_isize);
649 sc->sc_state |= UHID_IMMED;
651 sc->sc_state &= ~UHID_IMMED;
655 re = (struct usb_ctl_report *)addr;
656 switch (re->ucr_report) {
657 case UHID_INPUT_REPORT:
661 case UHID_OUTPUT_REPORT:
665 case UHID_FEATURE_REPORT:
672 err = usbd_get_report(sc->sc_iface, re->ucr_report, id, re->ucr_data,
679 re = (struct usb_ctl_report *)addr;
680 switch (re->ucr_report) {
681 case UHID_INPUT_REPORT:
685 case UHID_OUTPUT_REPORT:
689 case UHID_FEATURE_REPORT:
696 err = usbd_set_report(sc->sc_iface, re->ucr_report, id, re->ucr_data,
702 case USB_GET_REPORT_ID:
703 *(int *)addr = 0; /* XXX: we only support reportid 0? */
713 uhidioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, usb_proc_ptr p)
715 struct uhid_softc *sc;
718 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
721 error = uhid_do_ioctl(sc, cmd, addr, flag, p);
722 if (--sc->sc_refcnt < 0)
723 usb_detach_wakeup(USBDEV(sc->sc_dev));
728 uhidpoll(dev_t dev, int events, usb_proc_ptr p)
730 struct uhid_softc *sc;
733 USB_GET_SC(uhid, UHIDUNIT(dev), sc);
739 if (events & (POLLOUT | POLLWRNORM))
740 revents |= events & (POLLOUT | POLLWRNORM);
741 if (events & (POLLIN | POLLRDNORM)) {
742 if (sc->sc_q.c_cc > 0)
743 revents |= events & (POLLIN | POLLRDNORM);
745 selrecord(p, &sc->sc_rsel);
751 #if defined(__FreeBSD__) || defined(__DragonFly__)
752 DRIVER_MODULE(uhid, uhub, uhid_driver, uhid_devclass, usbd_driver_load, 0);