Home | History | Annotate | Line # | Download | only in usb
uhid.c revision 1.42.2.3
      1  1.42.2.3   nathanw /*	$NetBSD: uhid.c,v 1.42.2.3 2001/11/14 19:16:17 nathanw Exp $	*/
      2      1.28  augustss /*	$FreeBSD: src/sys/dev/usb/uhid.c,v 1.22 1999/11/17 22:33:43 n_hibma Exp $	*/
      3       1.1  augustss 
      4       1.1  augustss /*
      5       1.1  augustss  * Copyright (c) 1998 The NetBSD Foundation, Inc.
      6       1.1  augustss  * All rights reserved.
      7       1.1  augustss  *
      8       1.6  augustss  * This code is derived from software contributed to The NetBSD Foundation
      9      1.38  augustss  * by Lennart Augustsson (lennart (at) augustsson.net) at
     10       1.6  augustss  * Carlstedt Research & Technology.
     11       1.1  augustss  *
     12       1.1  augustss  * Redistribution and use in source and binary forms, with or without
     13       1.1  augustss  * modification, are permitted provided that the following conditions
     14       1.1  augustss  * are met:
     15       1.1  augustss  * 1. Redistributions of source code must retain the above copyright
     16       1.1  augustss  *    notice, this list of conditions and the following disclaimer.
     17       1.1  augustss  * 2. Redistributions in binary form must reproduce the above copyright
     18       1.1  augustss  *    notice, this list of conditions and the following disclaimer in the
     19       1.1  augustss  *    documentation and/or other materials provided with the distribution.
     20       1.1  augustss  * 3. All advertising materials mentioning features or use of this software
     21       1.1  augustss  *    must display the following acknowledgement:
     22       1.1  augustss  *        This product includes software developed by the NetBSD
     23       1.1  augustss  *        Foundation, Inc. and its contributors.
     24       1.1  augustss  * 4. Neither the name of The NetBSD Foundation nor the names of its
     25       1.1  augustss  *    contributors may be used to endorse or promote products derived
     26       1.1  augustss  *    from this software without specific prior written permission.
     27       1.1  augustss  *
     28       1.1  augustss  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     29       1.1  augustss  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     30       1.1  augustss  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     31       1.1  augustss  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     32       1.1  augustss  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     33       1.1  augustss  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     34       1.1  augustss  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     35       1.1  augustss  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     36       1.1  augustss  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     37       1.1  augustss  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     38       1.1  augustss  * POSSIBILITY OF SUCH DAMAGE.
     39       1.1  augustss  */
     40       1.1  augustss 
     41      1.15  augustss /*
     42      1.41  augustss  * HID spec: http://www.usb.org/developers/data/devclass/hid1_1.pdf
     43      1.15  augustss  */
     44       1.1  augustss 
     45  1.42.2.3   nathanw #include <sys/cdefs.h>
     46  1.42.2.3   nathanw __KERNEL_RCSID(0, "$NetBSD: uhid.c,v 1.42.2.3 2001/11/14 19:16:17 nathanw Exp $");
     47  1.42.2.3   nathanw 
     48       1.1  augustss #include <sys/param.h>
     49       1.1  augustss #include <sys/systm.h>
     50       1.1  augustss #include <sys/kernel.h>
     51       1.1  augustss #include <sys/malloc.h>
     52      1.37  augustss #include <sys/signalvar.h>
     53      1.20  augustss #if defined(__NetBSD__) || defined(__OpenBSD__)
     54      1.14  augustss #include <sys/device.h>
     55      1.12  augustss #include <sys/ioctl.h>
     56      1.12  augustss #elif defined(__FreeBSD__)
     57      1.12  augustss #include <sys/ioccom.h>
     58      1.12  augustss #include <sys/filio.h>
     59      1.12  augustss #include <sys/module.h>
     60      1.12  augustss #include <sys/bus.h>
     61      1.14  augustss #include <sys/ioccom.h>
     62      1.12  augustss #endif
     63      1.18  augustss #include <sys/conf.h>
     64       1.1  augustss #include <sys/tty.h>
     65       1.1  augustss #include <sys/file.h>
     66       1.1  augustss #include <sys/select.h>
     67       1.1  augustss #include <sys/proc.h>
     68       1.1  augustss #include <sys/vnode.h>
     69       1.1  augustss #include <sys/poll.h>
     70       1.1  augustss 
     71       1.1  augustss #include <dev/usb/usb.h>
     72       1.1  augustss #include <dev/usb/usbhid.h>
     73       1.1  augustss 
     74      1.42  augustss #include <dev/usb/usbdevs.h>
     75       1.1  augustss #include <dev/usb/usbdi.h>
     76       1.1  augustss #include <dev/usb/usbdi_util.h>
     77       1.1  augustss #include <dev/usb/hid.h>
     78       1.1  augustss #include <dev/usb/usb_quirks.h>
     79       1.1  augustss 
     80      1.42  augustss /* Report descriptor for broken Wacom Graphire */
     81      1.42  augustss #include <dev/usb/ugraphire_rdesc.h>
     82      1.42  augustss 
     83      1.26  augustss #ifdef UHID_DEBUG
     84      1.19  augustss #define DPRINTF(x)	if (uhiddebug) logprintf x
     85      1.19  augustss #define DPRINTFN(n,x)	if (uhiddebug>(n)) logprintf x
     86       1.1  augustss int	uhiddebug = 0;
     87       1.1  augustss #else
     88       1.1  augustss #define DPRINTF(x)
     89       1.1  augustss #define DPRINTFN(n,x)
     90       1.1  augustss #endif
     91       1.1  augustss 
     92       1.1  augustss struct uhid_softc {
     93      1.24  augustss 	USBBASEDEVICE sc_dev;			/* base device */
     94      1.32  augustss 	usbd_device_handle sc_udev;
     95       1.1  augustss 	usbd_interface_handle sc_iface;	/* interface */
     96       1.1  augustss 	usbd_pipe_handle sc_intrpipe;	/* interrupt pipe */
     97       1.1  augustss 	int sc_ep_addr;
     98       1.1  augustss 
     99       1.1  augustss 	int sc_isize;
    100       1.1  augustss 	int sc_osize;
    101       1.2  augustss 	int sc_fsize;
    102       1.1  augustss 	u_int8_t sc_iid;
    103       1.1  augustss 	u_int8_t sc_oid;
    104       1.2  augustss 	u_int8_t sc_fid;
    105       1.1  augustss 
    106      1.33  augustss 	u_char *sc_ibuf;
    107      1.33  augustss 	u_char *sc_obuf;
    108       1.1  augustss 
    109       1.1  augustss 	void *sc_repdesc;
    110       1.1  augustss 	int sc_repdesc_size;
    111       1.1  augustss 
    112       1.1  augustss 	struct clist sc_q;
    113       1.1  augustss 	struct selinfo sc_rsel;
    114      1.37  augustss 	struct proc *sc_async;	/* process that wants SIGIO */
    115       1.1  augustss 	u_char sc_state;	/* driver state */
    116       1.1  augustss #define	UHID_OPEN	0x01	/* device is open */
    117       1.5  augustss #define	UHID_ASLP	0x02	/* waiting for device data */
    118       1.1  augustss #define UHID_NEEDCLEAR	0x04	/* needs clearing endpoint stall */
    119       1.2  augustss #define UHID_IMMED	0x08	/* return read data immediately */
    120      1.18  augustss 
    121      1.18  augustss 	int sc_refcnt;
    122      1.18  augustss 	u_char sc_dying;
    123       1.1  augustss };
    124       1.1  augustss 
    125       1.1  augustss #define	UHIDUNIT(dev)	(minor(dev))
    126       1.1  augustss #define	UHID_CHUNK	128	/* chunk size for read */
    127       1.1  augustss #define	UHID_BSIZE	1020	/* buffer size */
    128       1.1  augustss 
    129      1.20  augustss #if defined(__NetBSD__) || defined(__OpenBSD__)
    130      1.19  augustss cdev_decl(uhid);
    131      1.19  augustss #elif defined(__FreeBSD__)
    132      1.19  augustss d_open_t	uhidopen;
    133      1.19  augustss d_close_t	uhidclose;
    134      1.19  augustss d_read_t	uhidread;
    135      1.19  augustss d_write_t	uhidwrite;
    136      1.19  augustss d_ioctl_t	uhidioctl;
    137      1.19  augustss d_poll_t	uhidpoll;
    138      1.19  augustss 
    139      1.19  augustss #define		UHID_CDEV_MAJOR 122
    140      1.19  augustss 
    141      1.36  augustss Static struct cdevsw uhid_cdevsw = {
    142      1.19  augustss 	/* open */	uhidopen,
    143      1.19  augustss 	/* close */	uhidclose,
    144      1.19  augustss 	/* read */	uhidread,
    145      1.19  augustss 	/* write */	uhidwrite,
    146      1.19  augustss 	/* ioctl */	uhidioctl,
    147      1.19  augustss 	/* poll */	uhidpoll,
    148      1.19  augustss 	/* mmap */	nommap,
    149      1.19  augustss 	/* strategy */	nostrategy,
    150      1.19  augustss 	/* name */	"uhid",
    151      1.19  augustss 	/* maj */	UHID_CDEV_MAJOR,
    152      1.19  augustss 	/* dump */	nodump,
    153      1.19  augustss 	/* psize */	nopsize,
    154      1.19  augustss 	/* flags */	0,
    155      1.19  augustss 	/* bmaj */	-1
    156      1.19  augustss };
    157      1.19  augustss #endif
    158      1.19  augustss 
    159      1.39  augustss Static void uhid_intr(usbd_xfer_handle, usbd_private_handle, usbd_status);
    160      1.18  augustss 
    161      1.39  augustss Static int uhid_do_read(struct uhid_softc *, struct uio *uio, int);
    162      1.39  augustss Static int uhid_do_write(struct uhid_softc *, struct uio *uio, int);
    163      1.39  augustss Static int uhid_do_ioctl(struct uhid_softc*, u_long, caddr_t, int,struct proc*);
    164       1.1  augustss 
    165      1.12  augustss USB_DECLARE_DRIVER(uhid);
    166       1.1  augustss 
    167      1.12  augustss USB_MATCH(uhid)
    168       1.1  augustss {
    169      1.12  augustss 	USB_MATCH_START(uhid, uaa);
    170       1.1  augustss 	usb_interface_descriptor_t *id;
    171       1.1  augustss 
    172      1.28  augustss 	if (uaa->iface == NULL)
    173       1.1  augustss 		return (UMATCH_NONE);
    174       1.1  augustss 	id = usbd_get_interface_descriptor(uaa->iface);
    175      1.34  augustss 	if (id == NULL || id->bInterfaceClass != UICLASS_HID)
    176       1.1  augustss 		return (UMATCH_NONE);
    177  1.42.2.1   nathanw 	if (uaa->matchlvl)
    178  1.42.2.1   nathanw 		return (uaa->matchlvl);
    179       1.1  augustss 	return (UMATCH_IFACECLASS_GENERIC);
    180       1.1  augustss }
    181       1.1  augustss 
    182      1.12  augustss USB_ATTACH(uhid)
    183       1.1  augustss {
    184      1.12  augustss 	USB_ATTACH_START(uhid, sc, uaa);
    185       1.1  augustss 	usbd_interface_handle iface = uaa->iface;
    186       1.1  augustss 	usb_interface_descriptor_t *id;
    187       1.1  augustss 	usb_endpoint_descriptor_t *ed;
    188       1.1  augustss 	int size;
    189       1.1  augustss 	void *desc;
    190      1.27  augustss 	usbd_status err;
    191       1.1  augustss 	char devinfo[1024];
    192       1.1  augustss 
    193      1.32  augustss 	sc->sc_udev = uaa->device;
    194       1.1  augustss 	sc->sc_iface = iface;
    195       1.1  augustss 	id = usbd_get_interface_descriptor(iface);
    196       1.1  augustss 	usbd_devinfo(uaa->device, 0, devinfo);
    197      1.12  augustss 	USB_ATTACH_SETUP;
    198      1.12  augustss 	printf("%s: %s, iclass %d/%d\n", USBDEVNAME(sc->sc_dev),
    199       1.7  augustss 	       devinfo, id->bInterfaceClass, id->bInterfaceSubClass);
    200      1.12  augustss 
    201       1.1  augustss 	ed = usbd_interface2endpoint_descriptor(iface, 0);
    202      1.27  augustss 	if (ed == NULL) {
    203       1.1  augustss 		printf("%s: could not read endpoint descriptor\n",
    204      1.12  augustss 		       USBDEVNAME(sc->sc_dev));
    205      1.18  augustss 		sc->sc_dying = 1;
    206      1.12  augustss 		USB_ATTACH_ERROR_RETURN;
    207       1.1  augustss 	}
    208       1.1  augustss 
    209      1.11  augustss 	DPRINTFN(10,("uhid_attach: bLength=%d bDescriptorType=%d "
    210      1.11  augustss 		     "bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d"
    211      1.11  augustss 		     " bInterval=%d\n",
    212      1.11  augustss 		     ed->bLength, ed->bDescriptorType,
    213      1.11  augustss 		     ed->bEndpointAddress & UE_ADDR,
    214      1.23  augustss 		     UE_GET_DIR(ed->bEndpointAddress)==UE_DIR_IN? "in" : "out",
    215      1.11  augustss 		     ed->bmAttributes & UE_XFERTYPE,
    216      1.11  augustss 		     UGETW(ed->wMaxPacketSize), ed->bInterval));
    217       1.1  augustss 
    218      1.23  augustss 	if (UE_GET_DIR(ed->bEndpointAddress) != UE_DIR_IN ||
    219       1.1  augustss 	    (ed->bmAttributes & UE_XFERTYPE) != UE_INTERRUPT) {
    220      1.12  augustss 		printf("%s: unexpected endpoint\n", USBDEVNAME(sc->sc_dev));
    221      1.18  augustss 		sc->sc_dying = 1;
    222      1.12  augustss 		USB_ATTACH_ERROR_RETURN;
    223       1.1  augustss 	}
    224       1.1  augustss 
    225       1.1  augustss 	sc->sc_ep_addr = ed->bEndpointAddress;
    226       1.1  augustss 
    227      1.42  augustss 	if (uaa->vendor == USB_VENDOR_WACOM &&
    228      1.42  augustss 	    uaa->product == USB_PRODUCT_WACOM_GRAPHIRE /* &&
    229      1.42  augustss 	    uaa->revision == 0x???? */) { /* XXX should use revision */
    230      1.42  augustss 		/* The report descriptor for the Wacom Graphire is broken. */
    231      1.42  augustss 		size = sizeof uhid_graphire_report_descr;
    232      1.42  augustss 		desc = malloc(size, M_USBDEV, M_NOWAIT);
    233      1.42  augustss 		if (desc == NULL)
    234      1.42  augustss 			err = USBD_NOMEM;
    235      1.42  augustss 		else {
    236      1.42  augustss 			err = USBD_NORMAL_COMPLETION;
    237      1.42  augustss 			memcpy(desc, uhid_graphire_report_descr, size);
    238      1.42  augustss 		}
    239      1.42  augustss 	} else {
    240      1.42  augustss 		desc = NULL;
    241  1.42.2.3   nathanw 		err = usbd_read_report_desc(uaa->iface, &desc, &size,M_USBDEV);
    242      1.42  augustss 	}
    243      1.27  augustss 	if (err) {
    244      1.12  augustss 		printf("%s: no report descriptor\n", USBDEVNAME(sc->sc_dev));
    245      1.18  augustss 		sc->sc_dying = 1;
    246      1.12  augustss 		USB_ATTACH_ERROR_RETURN;
    247       1.1  augustss 	}
    248       1.1  augustss 
    249       1.1  augustss 	(void)usbd_set_idle(iface, 0, 0);
    250       1.1  augustss 
    251       1.2  augustss 	sc->sc_isize = hid_report_size(desc, size, hid_input,   &sc->sc_iid);
    252       1.2  augustss 	sc->sc_osize = hid_report_size(desc, size, hid_output,  &sc->sc_oid);
    253       1.2  augustss 	sc->sc_fsize = hid_report_size(desc, size, hid_feature, &sc->sc_fid);
    254       1.1  augustss 
    255       1.1  augustss 	sc->sc_repdesc = desc;
    256       1.1  augustss 	sc->sc_repdesc_size = size;
    257      1.12  augustss 
    258      1.28  augustss #ifdef __FreeBSD__
    259      1.28  augustss 	{
    260      1.28  augustss 		static int global_init_done = 0;
    261      1.28  augustss 
    262      1.28  augustss 		if (!global_init_done) {
    263      1.28  augustss 			cdevsw_add(&uhid_cdevsw);
    264      1.28  augustss 			global_init_done = 1;
    265      1.28  augustss 		}
    266      1.28  augustss 	}
    267      1.28  augustss #endif
    268      1.28  augustss 
    269      1.32  augustss 	usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev,
    270      1.32  augustss 			   USBDEV(sc->sc_dev));
    271      1.32  augustss 
    272      1.12  augustss 	USB_ATTACH_SUCCESS_RETURN;
    273       1.1  augustss }
    274       1.1  augustss 
    275      1.26  augustss #if defined(__NetBSD__) || defined(__OpenBSD__)
    276      1.18  augustss int
    277      1.39  augustss uhid_activate(device_ptr_t self, enum devact act)
    278      1.18  augustss {
    279      1.21  augustss 	struct uhid_softc *sc = (struct uhid_softc *)self;
    280      1.21  augustss 
    281      1.21  augustss 	switch (act) {
    282      1.21  augustss 	case DVACT_ACTIVATE:
    283      1.21  augustss 		return (EOPNOTSUPP);
    284      1.21  augustss 		break;
    285      1.21  augustss 
    286      1.21  augustss 	case DVACT_DEACTIVATE:
    287      1.21  augustss 		sc->sc_dying = 1;
    288      1.21  augustss 		break;
    289      1.21  augustss 	}
    290      1.18  augustss 	return (0);
    291      1.12  augustss }
    292      1.26  augustss #endif
    293      1.12  augustss 
    294      1.26  augustss USB_DETACH(uhid)
    295       1.1  augustss {
    296      1.26  augustss 	USB_DETACH_START(uhid, sc);
    297      1.26  augustss 	int s;
    298      1.26  augustss #if defined(__NetBSD__) || defined(__OpenBSD__)
    299      1.18  augustss 	int maj, mn;
    300      1.18  augustss 
    301      1.18  augustss 	DPRINTF(("uhid_detach: sc=%p flags=%d\n", sc, flags));
    302      1.26  augustss #else
    303      1.26  augustss 	DPRINTF(("uhid_detach: sc=%p\n", sc));
    304      1.26  augustss #endif
    305       1.3  augustss 
    306      1.18  augustss 	sc->sc_dying = 1;
    307      1.27  augustss 	if (sc->sc_intrpipe != NULL)
    308      1.18  augustss 		usbd_abort_pipe(sc->sc_intrpipe);
    309      1.18  augustss 
    310      1.18  augustss 	if (sc->sc_state & UHID_OPEN) {
    311      1.18  augustss 		s = splusb();
    312      1.18  augustss 		if (--sc->sc_refcnt >= 0) {
    313      1.18  augustss 			/* Wake everyone */
    314      1.18  augustss 			wakeup(&sc->sc_q);
    315      1.18  augustss 			/* Wait for processes to go away. */
    316      1.24  augustss 			usb_detach_wait(USBDEV(sc->sc_dev));
    317      1.18  augustss 		}
    318      1.18  augustss 		splx(s);
    319      1.18  augustss 	}
    320      1.18  augustss 
    321      1.26  augustss #if defined(__NetBSD__) || defined(__OpenBSD__)
    322      1.18  augustss 	/* locate the major number */
    323      1.18  augustss 	for (maj = 0; maj < nchrdev; maj++)
    324      1.18  augustss 		if (cdevsw[maj].d_open == uhidopen)
    325      1.18  augustss 			break;
    326      1.18  augustss 
    327      1.18  augustss 	/* Nuke the vnodes for any open instances (calls close). */
    328      1.18  augustss 	mn = self->dv_unit;
    329      1.18  augustss 	vdevgone(maj, mn, mn, VCHR);
    330      1.26  augustss #elif defined(__FreeBSD__)
    331      1.26  augustss 	/* XXX not implemented yet */
    332      1.26  augustss #endif
    333      1.18  augustss 
    334      1.40  augustss 	if (sc->sc_repdesc)
    335      1.40  augustss 		free(sc->sc_repdesc, M_USBDEV);
    336      1.32  augustss 
    337      1.32  augustss 	usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev,
    338      1.32  augustss 			   USBDEV(sc->sc_dev));
    339      1.18  augustss 
    340      1.18  augustss 	return (0);
    341       1.1  augustss }
    342       1.1  augustss 
    343       1.1  augustss void
    344      1.39  augustss uhid_intr(usbd_xfer_handle xfer, usbd_private_handle addr, usbd_status status)
    345       1.1  augustss {
    346       1.1  augustss 	struct uhid_softc *sc = addr;
    347       1.1  augustss 
    348      1.33  augustss #ifdef UHID_DEBUG
    349      1.33  augustss 	if (uhiddebug > 5) {
    350      1.33  augustss 		u_int32_t cc, i;
    351      1.33  augustss 
    352      1.33  augustss 		usbd_get_xfer_status(xfer, NULL, NULL, &cc, NULL);
    353      1.33  augustss 		DPRINTF(("uhid_intr: status=%d cc=%d\n", status, cc));
    354      1.33  augustss 		DPRINTF(("uhid_intr: data ="));
    355      1.33  augustss 		for (i = 0; i < cc; i++)
    356      1.33  augustss 			DPRINTF((" %02x", sc->sc_ibuf[i]));
    357      1.33  augustss 		DPRINTF(("\n"));
    358      1.33  augustss 	}
    359      1.33  augustss #endif
    360       1.1  augustss 
    361       1.1  augustss 	if (status == USBD_CANCELLED)
    362       1.1  augustss 		return;
    363       1.1  augustss 
    364       1.1  augustss 	if (status != USBD_NORMAL_COMPLETION) {
    365       1.1  augustss 		DPRINTF(("uhid_intr: status=%d\n", status));
    366       1.1  augustss 		sc->sc_state |= UHID_NEEDCLEAR;
    367       1.1  augustss 		return;
    368       1.1  augustss 	}
    369       1.1  augustss 
    370       1.1  augustss 	(void) b_to_q(sc->sc_ibuf, sc->sc_isize, &sc->sc_q);
    371       1.1  augustss 
    372       1.1  augustss 	if (sc->sc_state & UHID_ASLP) {
    373       1.1  augustss 		sc->sc_state &= ~UHID_ASLP;
    374  1.42.2.2   nathanw 		DPRINTFN(5, ("uhid_intr: waking %p\n", &sc->sc_q));
    375      1.18  augustss 		wakeup(&sc->sc_q);
    376       1.1  augustss 	}
    377       1.1  augustss 	selwakeup(&sc->sc_rsel);
    378      1.37  augustss 	if (sc->sc_async != NULL) {
    379      1.37  augustss 		DPRINTFN(3, ("uhid_intr: sending SIGIO %p\n", sc->sc_async));
    380      1.37  augustss 		psignal(sc->sc_async, SIGIO);
    381      1.37  augustss 	}
    382       1.1  augustss }
    383       1.1  augustss 
    384       1.1  augustss int
    385      1.39  augustss uhidopen(dev_t dev, int flag, int mode, struct proc *p)
    386       1.1  augustss {
    387      1.25  augustss 	struct uhid_softc *sc;
    388      1.27  augustss 	usbd_status err;
    389      1.25  augustss 
    390      1.12  augustss 	USB_GET_SC_OPEN(uhid, UHIDUNIT(dev), sc);
    391       1.1  augustss 
    392      1.18  augustss 	DPRINTF(("uhidopen: sc=%p\n", sc));
    393       1.1  augustss 
    394      1.18  augustss 	if (sc->sc_dying)
    395      1.18  augustss 		return (ENXIO);
    396       1.1  augustss 
    397       1.1  augustss 	if (sc->sc_state & UHID_OPEN)
    398      1.12  augustss 		return (EBUSY);
    399      1.17  augustss 	sc->sc_state |= UHID_OPEN;
    400       1.1  augustss 
    401      1.17  augustss 	if (clalloc(&sc->sc_q, UHID_BSIZE, 0) == -1) {
    402      1.17  augustss 		sc->sc_state &= ~UHID_OPEN;
    403      1.12  augustss 		return (ENOMEM);
    404      1.17  augustss 	}
    405       1.1  augustss 
    406      1.18  augustss 	sc->sc_ibuf = malloc(sc->sc_isize, M_USBDEV, M_WAITOK);
    407      1.18  augustss 	sc->sc_obuf = malloc(sc->sc_osize, M_USBDEV, M_WAITOK);
    408       1.1  augustss 
    409       1.1  augustss 	/* Set up interrupt pipe. */
    410      1.27  augustss 	err = usbd_open_pipe_intr(sc->sc_iface, sc->sc_ep_addr,
    411      1.27  augustss 		  USBD_SHORT_XFER_OK, &sc->sc_intrpipe, sc, sc->sc_ibuf,
    412      1.31  augustss 		  sc->sc_isize, uhid_intr, USBD_DEFAULT_INTERVAL);
    413      1.27  augustss 	if (err) {
    414      1.11  augustss 		DPRINTF(("uhidopen: usbd_open_pipe_intr failed, "
    415      1.27  augustss 			 "error=%d\n",err));
    416      1.18  augustss 		free(sc->sc_ibuf, M_USBDEV);
    417      1.18  augustss 		free(sc->sc_obuf, M_USBDEV);
    418       1.1  augustss 		sc->sc_state &= ~UHID_OPEN;
    419       1.1  augustss 		return (EIO);
    420       1.1  augustss 	}
    421      1.17  augustss 
    422      1.17  augustss 	sc->sc_state &= ~UHID_IMMED;
    423      1.17  augustss 
    424      1.37  augustss 	sc->sc_async = 0;
    425      1.37  augustss 
    426      1.12  augustss 	return (0);
    427       1.1  augustss }
    428       1.1  augustss 
    429       1.1  augustss int
    430      1.39  augustss uhidclose(dev_t dev, int flag, int mode, struct proc *p)
    431       1.1  augustss {
    432      1.25  augustss 	struct uhid_softc *sc;
    433      1.25  augustss 
    434      1.12  augustss 	USB_GET_SC(uhid, UHIDUNIT(dev), sc);
    435       1.1  augustss 
    436       1.1  augustss 	DPRINTF(("uhidclose: sc=%p\n", sc));
    437       1.1  augustss 
    438       1.1  augustss 	/* Disable interrupts. */
    439       1.1  augustss 	usbd_abort_pipe(sc->sc_intrpipe);
    440       1.1  augustss 	usbd_close_pipe(sc->sc_intrpipe);
    441      1.18  augustss 	sc->sc_intrpipe = 0;
    442       1.1  augustss 
    443       1.1  augustss 	clfree(&sc->sc_q);
    444       1.1  augustss 
    445      1.18  augustss 	free(sc->sc_ibuf, M_USBDEV);
    446      1.18  augustss 	free(sc->sc_obuf, M_USBDEV);
    447      1.17  augustss 
    448      1.17  augustss 	sc->sc_state &= ~UHID_OPEN;
    449       1.1  augustss 
    450      1.37  augustss 	sc->sc_async = 0;
    451      1.37  augustss 
    452      1.12  augustss 	return (0);
    453       1.1  augustss }
    454       1.1  augustss 
    455       1.1  augustss int
    456      1.39  augustss uhid_do_read(struct uhid_softc *sc, struct uio *uio, int flag)
    457       1.1  augustss {
    458       1.1  augustss 	int s;
    459       1.1  augustss 	int error = 0;
    460       1.1  augustss 	size_t length;
    461       1.1  augustss 	u_char buffer[UHID_CHUNK];
    462      1.27  augustss 	usbd_status err;
    463       1.1  augustss 
    464       1.1  augustss 	DPRINTFN(1, ("uhidread\n"));
    465       1.2  augustss 	if (sc->sc_state & UHID_IMMED) {
    466       1.2  augustss 		DPRINTFN(1, ("uhidread immed\n"));
    467       1.2  augustss 
    468      1.27  augustss 		err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
    469      1.16  augustss 				    sc->sc_iid, buffer, sc->sc_isize);
    470      1.27  augustss 		if (err)
    471       1.2  augustss 			return (EIO);
    472       1.2  augustss 		return (uiomove(buffer, sc->sc_isize, uio));
    473       1.2  augustss 	}
    474       1.2  augustss 
    475      1.10  augustss 	s = splusb();
    476       1.1  augustss 	while (sc->sc_q.c_cc == 0) {
    477       1.1  augustss 		if (flag & IO_NDELAY) {
    478       1.1  augustss 			splx(s);
    479      1.18  augustss 			return (EWOULDBLOCK);
    480       1.1  augustss 		}
    481       1.1  augustss 		sc->sc_state |= UHID_ASLP;
    482  1.42.2.2   nathanw 		DPRINTFN(5, ("uhidread: sleep on %p\n", &sc->sc_q));
    483      1.18  augustss 		error = tsleep(&sc->sc_q, PZERO | PCATCH, "uhidrea", 0);
    484       1.1  augustss 		DPRINTFN(5, ("uhidread: woke, error=%d\n", error));
    485      1.18  augustss 		if (sc->sc_dying)
    486      1.18  augustss 			error = EIO;
    487       1.1  augustss 		if (error) {
    488       1.1  augustss 			sc->sc_state &= ~UHID_ASLP;
    489      1.18  augustss 			break;
    490       1.1  augustss 		}
    491       1.1  augustss 		if (sc->sc_state & UHID_NEEDCLEAR) {
    492       1.1  augustss 			DPRINTFN(-1,("uhidread: clearing stall\n"));
    493       1.1  augustss 			sc->sc_state &= ~UHID_NEEDCLEAR;
    494       1.1  augustss 			usbd_clear_endpoint_stall(sc->sc_intrpipe);
    495       1.1  augustss 		}
    496       1.1  augustss 	}
    497       1.1  augustss 	splx(s);
    498       1.1  augustss 
    499       1.1  augustss 	/* Transfer as many chunks as possible. */
    500      1.18  augustss 	while (sc->sc_q.c_cc > 0 && uio->uio_resid > 0 && !error) {
    501       1.1  augustss 		length = min(sc->sc_q.c_cc, uio->uio_resid);
    502       1.1  augustss 		if (length > sizeof(buffer))
    503       1.1  augustss 			length = sizeof(buffer);
    504       1.1  augustss 
    505       1.1  augustss 		/* Remove a small chunk from the input queue. */
    506       1.1  augustss 		(void) q_to_b(&sc->sc_q, buffer, length);
    507      1.29  augustss 		DPRINTFN(5, ("uhidread: got %lu chars\n", (u_long)length));
    508       1.1  augustss 
    509       1.1  augustss 		/* Copy the data to the user process. */
    510       1.1  augustss 		if ((error = uiomove(buffer, length, uio)) != 0)
    511       1.1  augustss 			break;
    512       1.1  augustss 	}
    513       1.1  augustss 
    514       1.1  augustss 	return (error);
    515       1.1  augustss }
    516       1.1  augustss 
    517       1.1  augustss int
    518      1.39  augustss uhidread(dev_t dev, struct uio *uio, int flag)
    519       1.1  augustss {
    520      1.25  augustss 	struct uhid_softc *sc;
    521      1.25  augustss 	int error;
    522      1.25  augustss 
    523      1.18  augustss 	USB_GET_SC(uhid, UHIDUNIT(dev), sc);
    524      1.18  augustss 
    525      1.18  augustss 	sc->sc_refcnt++;
    526      1.18  augustss 	error = uhid_do_read(sc, uio, flag);
    527      1.18  augustss 	if (--sc->sc_refcnt < 0)
    528      1.24  augustss 		usb_detach_wakeup(USBDEV(sc->sc_dev));
    529      1.18  augustss 	return (error);
    530      1.18  augustss }
    531      1.18  augustss 
    532      1.18  augustss int
    533      1.39  augustss uhid_do_write(struct uhid_softc *sc, struct uio *uio, int flag)
    534      1.18  augustss {
    535       1.1  augustss 	int error;
    536       1.1  augustss 	int size;
    537      1.27  augustss 	usbd_status err;
    538       1.1  augustss 
    539      1.18  augustss 	DPRINTFN(1, ("uhidwrite\n"));
    540      1.18  augustss 
    541      1.18  augustss 	if (sc->sc_dying)
    542       1.1  augustss 		return (EIO);
    543       1.1  augustss 
    544       1.1  augustss 	size = sc->sc_osize;
    545       1.1  augustss 	error = 0;
    546      1.18  augustss 	if (uio->uio_resid != size)
    547      1.18  augustss 		return (EINVAL);
    548      1.18  augustss 	error = uiomove(sc->sc_obuf, size, uio);
    549      1.18  augustss 	if (!error) {
    550       1.1  augustss 		if (sc->sc_oid)
    551      1.27  augustss 			err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
    552      1.27  augustss 				  sc->sc_obuf[0], sc->sc_obuf+1, size-1);
    553       1.1  augustss 		else
    554      1.27  augustss 			err = usbd_set_report(sc->sc_iface, UHID_OUTPUT_REPORT,
    555      1.27  augustss 				  0, sc->sc_obuf, size);
    556      1.27  augustss 		if (err)
    557       1.1  augustss 			error = EIO;
    558       1.1  augustss 	}
    559      1.18  augustss 
    560       1.1  augustss 	return (error);
    561       1.1  augustss }
    562       1.1  augustss 
    563       1.1  augustss int
    564      1.39  augustss uhidwrite(dev_t dev, struct uio *uio, int flag)
    565      1.18  augustss {
    566      1.25  augustss 	struct uhid_softc *sc;
    567      1.25  augustss 	int error;
    568      1.25  augustss 
    569      1.18  augustss 	USB_GET_SC(uhid, UHIDUNIT(dev), sc);
    570      1.18  augustss 
    571      1.18  augustss 	sc->sc_refcnt++;
    572      1.18  augustss 	error = uhid_do_write(sc, uio, flag);
    573      1.18  augustss 	if (--sc->sc_refcnt < 0)
    574      1.24  augustss 		usb_detach_wakeup(USBDEV(sc->sc_dev));
    575      1.18  augustss 	return (error);
    576      1.18  augustss }
    577      1.18  augustss 
    578      1.18  augustss int
    579      1.39  augustss uhid_do_ioctl(struct uhid_softc *sc, u_long cmd, caddr_t addr,
    580      1.39  augustss 	      int flag, struct proc *p)
    581       1.1  augustss {
    582       1.1  augustss 	struct usb_ctl_report_desc *rd;
    583       1.2  augustss 	struct usb_ctl_report *re;
    584       1.2  augustss 	int size, id;
    585      1.27  augustss 	usbd_status err;
    586       1.1  augustss 
    587      1.18  augustss 	DPRINTFN(2, ("uhidioctl: cmd=%lx\n", cmd));
    588      1.18  augustss 
    589      1.18  augustss 	if (sc->sc_dying)
    590       1.1  augustss 		return (EIO);
    591       1.1  augustss 
    592       1.1  augustss 	switch (cmd) {
    593       1.2  augustss 	case FIONBIO:
    594       1.2  augustss 		/* All handled in the upper FS layer. */
    595      1.37  augustss 		break;
    596      1.37  augustss 
    597      1.37  augustss 	case FIOASYNC:
    598      1.37  augustss 		if (*(int *)addr) {
    599      1.37  augustss 			if (sc->sc_async != NULL)
    600      1.37  augustss 				return (EBUSY);
    601      1.37  augustss 			sc->sc_async = p;
    602      1.37  augustss 			DPRINTF(("uhid_do_ioctl: FIOASYNC %p\n", p));
    603      1.37  augustss 		} else
    604      1.37  augustss 			sc->sc_async = NULL;
    605      1.37  augustss 		break;
    606      1.37  augustss 
    607      1.37  augustss 	/* XXX this is not the most general solution. */
    608      1.37  augustss 	case TIOCSPGRP:
    609      1.37  augustss 		if (sc->sc_async == NULL)
    610      1.37  augustss 			return (EINVAL);
    611      1.37  augustss 		if (*(int *)addr != sc->sc_async->p_pgid)
    612      1.37  augustss 			return (EPERM);
    613       1.2  augustss 		break;
    614       1.2  augustss 
    615       1.1  augustss 	case USB_GET_REPORT_DESC:
    616       1.1  augustss 		rd = (struct usb_ctl_report_desc *)addr;
    617       1.1  augustss 		size = min(sc->sc_repdesc_size, sizeof rd->data);
    618       1.1  augustss 		rd->size = size;
    619       1.1  augustss 		memcpy(rd->data, sc->sc_repdesc, size);
    620       1.1  augustss 		break;
    621       1.2  augustss 
    622       1.2  augustss 	case USB_SET_IMMED:
    623       1.9  augustss 		if (*(int *)addr) {
    624      1.27  augustss 			/* XXX should read into ibuf, but does it matter? */
    625      1.27  augustss 			err = usbd_get_report(sc->sc_iface, UHID_INPUT_REPORT,
    626      1.27  augustss 				  sc->sc_iid, sc->sc_ibuf, sc->sc_isize);
    627      1.27  augustss 			if (err)
    628       1.9  augustss 				return (EOPNOTSUPP);
    629      1.12  augustss 
    630       1.2  augustss 			sc->sc_state |=  UHID_IMMED;
    631       1.9  augustss 		} else
    632       1.2  augustss 			sc->sc_state &= ~UHID_IMMED;
    633       1.2  augustss 		break;
    634       1.2  augustss 
    635       1.2  augustss 	case USB_GET_REPORT:
    636       1.2  augustss 		re = (struct usb_ctl_report *)addr;
    637       1.2  augustss 		switch (re->report) {
    638       1.2  augustss 		case UHID_INPUT_REPORT:
    639       1.2  augustss 			size = sc->sc_isize;
    640       1.2  augustss 			id = sc->sc_iid;
    641       1.2  augustss 			break;
    642       1.2  augustss 		case UHID_OUTPUT_REPORT:
    643       1.2  augustss 			size = sc->sc_osize;
    644       1.2  augustss 			id = sc->sc_oid;
    645       1.2  augustss 			break;
    646       1.2  augustss 		case UHID_FEATURE_REPORT:
    647       1.2  augustss 			size = sc->sc_fsize;
    648       1.2  augustss 			id = sc->sc_fid;
    649       1.2  augustss 			break;
    650       1.2  augustss 		default:
    651       1.2  augustss 			return (EINVAL);
    652       1.2  augustss 		}
    653      1.27  augustss 		err = usbd_get_report(sc->sc_iface, re->report, id, re->data,
    654      1.35  augustss 			  size);
    655      1.35  augustss 		if (err)
    656      1.35  augustss 			return (EIO);
    657      1.35  augustss 		break;
    658      1.35  augustss 
    659      1.35  augustss 	case USB_SET_REPORT:
    660      1.35  augustss 		re = (struct usb_ctl_report *)addr;
    661      1.35  augustss 		switch (re->report) {
    662      1.35  augustss 		case UHID_INPUT_REPORT:
    663      1.35  augustss 			size = sc->sc_isize;
    664      1.35  augustss 			id = sc->sc_iid;
    665      1.35  augustss 			break;
    666      1.35  augustss 		case UHID_OUTPUT_REPORT:
    667      1.35  augustss 			size = sc->sc_osize;
    668      1.35  augustss 			id = sc->sc_oid;
    669      1.35  augustss 			break;
    670      1.35  augustss 		case UHID_FEATURE_REPORT:
    671      1.35  augustss 			size = sc->sc_fsize;
    672      1.35  augustss 			id = sc->sc_fid;
    673      1.35  augustss 			break;
    674      1.35  augustss 		default:
    675      1.35  augustss 			return (EINVAL);
    676      1.35  augustss 		}
    677      1.35  augustss 		err = usbd_set_report(sc->sc_iface, re->report, id, re->data,
    678      1.27  augustss 			  size);
    679      1.27  augustss 		if (err)
    680       1.2  augustss 			return (EIO);
    681       1.2  augustss 		break;
    682       1.2  augustss 
    683       1.1  augustss 	default:
    684       1.1  augustss 		return (EINVAL);
    685       1.1  augustss 	}
    686       1.1  augustss 	return (0);
    687       1.1  augustss }
    688       1.1  augustss 
    689       1.1  augustss int
    690      1.39  augustss uhidioctl(dev_t dev, u_long cmd, caddr_t addr, int flag, struct proc *p)
    691      1.18  augustss {
    692      1.25  augustss 	struct uhid_softc *sc;
    693      1.25  augustss 	int error;
    694      1.25  augustss 
    695      1.18  augustss 	USB_GET_SC(uhid, UHIDUNIT(dev), sc);
    696      1.18  augustss 
    697      1.18  augustss 	sc->sc_refcnt++;
    698      1.18  augustss 	error = uhid_do_ioctl(sc, cmd, addr, flag, p);
    699      1.18  augustss 	if (--sc->sc_refcnt < 0)
    700      1.24  augustss 		usb_detach_wakeup(USBDEV(sc->sc_dev));
    701      1.18  augustss 	return (error);
    702      1.18  augustss }
    703      1.18  augustss 
    704      1.18  augustss int
    705      1.39  augustss uhidpoll(dev_t dev, int events, struct proc *p)
    706       1.1  augustss {
    707      1.25  augustss 	struct uhid_softc *sc;
    708       1.1  augustss 	int revents = 0;
    709       1.1  augustss 	int s;
    710      1.25  augustss 
    711      1.12  augustss 	USB_GET_SC(uhid, UHIDUNIT(dev), sc);
    712       1.1  augustss 
    713      1.18  augustss 	if (sc->sc_dying)
    714       1.1  augustss 		return (EIO);
    715       1.1  augustss 
    716      1.10  augustss 	s = splusb();
    717       1.1  augustss 	if (events & (POLLOUT | POLLWRNORM))
    718       1.1  augustss 		revents |= events & (POLLOUT | POLLWRNORM);
    719       1.4     veego 	if (events & (POLLIN | POLLRDNORM)) {
    720       1.1  augustss 		if (sc->sc_q.c_cc > 0)
    721       1.1  augustss 			revents |= events & (POLLIN | POLLRDNORM);
    722       1.1  augustss 		else
    723       1.1  augustss 			selrecord(p, &sc->sc_rsel);
    724       1.4     veego 	}
    725       1.1  augustss 
    726       1.1  augustss 	splx(s);
    727       1.1  augustss 	return (revents);
    728       1.1  augustss }
    729      1.12  augustss 
    730      1.12  augustss #if defined(__FreeBSD__)
    731      1.28  augustss DRIVER_MODULE(uhid, uhub, uhid_driver, uhid_devclass, usbd_driver_load, 0);
    732      1.12  augustss #endif
    733