Home | History | Annotate | Line # | Download | only in usb
uhidev.c revision 1.73
      1  1.73    bouyer /*	$NetBSD: uhidev.c,v 1.73 2017/12/10 17:03:07 bouyer Exp $	*/
      2   1.1  augustss 
      3   1.1  augustss /*
      4  1.56       mrg  * Copyright (c) 2001, 2012 The NetBSD Foundation, Inc.
      5   1.1  augustss  * All rights reserved.
      6   1.1  augustss  *
      7   1.1  augustss  * This code is derived from software contributed to The NetBSD Foundation
      8   1.1  augustss  * by Lennart Augustsson (lennart (at) augustsson.net) at
      9  1.56       mrg  * Carlstedt Research & Technology and Matthew R. Green (mrg (at) eterna.com.au).
     10   1.1  augustss  *
     11   1.1  augustss  * Redistribution and use in source and binary forms, with or without
     12   1.1  augustss  * modification, are permitted provided that the following conditions
     13   1.1  augustss  * are met:
     14   1.1  augustss  * 1. Redistributions of source code must retain the above copyright
     15   1.1  augustss  *    notice, this list of conditions and the following disclaimer.
     16   1.1  augustss  * 2. Redistributions in binary form must reproduce the above copyright
     17   1.1  augustss  *    notice, this list of conditions and the following disclaimer in the
     18   1.1  augustss  *    documentation and/or other materials provided with the distribution.
     19   1.1  augustss  *
     20   1.1  augustss  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     21   1.1  augustss  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     22   1.1  augustss  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     23   1.1  augustss  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     24   1.1  augustss  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     25   1.1  augustss  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     26   1.1  augustss  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     27   1.1  augustss  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     28   1.1  augustss  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     29   1.1  augustss  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     30   1.1  augustss  * POSSIBILITY OF SUCH DAMAGE.
     31   1.1  augustss  */
     32   1.1  augustss 
     33   1.1  augustss /*
     34  1.14  augustss  * HID spec: http://www.usb.org/developers/devclass_docs/HID1_11.pdf
     35   1.1  augustss  */
     36  1.15     lukem 
     37  1.15     lukem #include <sys/cdefs.h>
     38  1.73    bouyer __KERNEL_RCSID(0, "$NetBSD: uhidev.c,v 1.73 2017/12/10 17:03:07 bouyer Exp $");
     39  1.66  jakllsch 
     40  1.66  jakllsch #ifdef _KERNEL_OPT
     41  1.66  jakllsch #include "opt_usb.h"
     42  1.66  jakllsch #endif
     43   1.1  augustss 
     44   1.1  augustss #include <sys/param.h>
     45   1.1  augustss #include <sys/systm.h>
     46   1.1  augustss #include <sys/kernel.h>
     47  1.65     skrll #include <sys/kmem.h>
     48   1.1  augustss #include <sys/signalvar.h>
     49   1.1  augustss #include <sys/device.h>
     50   1.1  augustss #include <sys/ioctl.h>
     51   1.1  augustss #include <sys/conf.h>
     52  1.64  riastrad #include <sys/rndsource.h>
     53   1.1  augustss 
     54   1.1  augustss #include <dev/usb/usb.h>
     55   1.1  augustss #include <dev/usb/usbhid.h>
     56   1.1  augustss 
     57   1.1  augustss #include <dev/usb/usbdevs.h>
     58   1.1  augustss #include <dev/usb/usbdi.h>
     59   1.1  augustss #include <dev/usb/usbdi_util.h>
     60   1.1  augustss #include <dev/usb/usb_quirks.h>
     61   1.1  augustss 
     62   1.1  augustss #include <dev/usb/uhidev.h>
     63  1.73    bouyer #include <dev/hid/hid.h>
     64   1.1  augustss 
     65   1.1  augustss /* Report descriptor for broken Wacom Graphire */
     66   1.1  augustss #include <dev/usb/ugraphire_rdesc.h>
     67  1.51  jmcneill /* Report descriptor for game controllers in "XInput" mode */
     68  1.51  jmcneill #include <dev/usb/xinput_rdesc.h>
     69  1.62  jmcneill /* Report descriptor for Xbox One controllers */
     70  1.62  jmcneill #include <dev/usb/x1input_rdesc.h>
     71   1.1  augustss 
     72  1.22  drochner #include "locators.h"
     73  1.22  drochner 
     74   1.1  augustss #ifdef UHIDEV_DEBUG
     75  1.48    dyoung #define DPRINTF(x)	if (uhidevdebug) printf x
     76  1.48    dyoung #define DPRINTFN(n,x)	if (uhidevdebug>(n)) printf x
     77   1.1  augustss int	uhidevdebug = 0;
     78   1.1  augustss #else
     79   1.1  augustss #define DPRINTF(x)
     80   1.1  augustss #define DPRINTFN(n,x)
     81   1.1  augustss #endif
     82   1.1  augustss 
     83  1.65     skrll Static void uhidev_intr(struct usbd_xfer *, void *, usbd_status);
     84   1.1  augustss 
     85  1.29  drochner Static int uhidev_maxrepid(void *, int);
     86  1.29  drochner Static int uhidevprint(void *, const char *);
     87   1.1  augustss 
     88  1.41      cube int uhidev_match(device_t, cfdata_t, void *);
     89  1.39    dyoung void uhidev_attach(device_t, device_t, void *);
     90  1.39    dyoung void uhidev_childdet(device_t, device_t);
     91  1.39    dyoung int uhidev_detach(device_t, int);
     92  1.39    dyoung int uhidev_activate(device_t, enum devact);
     93  1.39    dyoung extern struct cfdriver uhidev_cd;
     94  1.41      cube CFATTACH_DECL2_NEW(uhidev, sizeof(struct uhidev_softc), uhidev_match,
     95  1.39    dyoung     uhidev_attach, uhidev_detach, uhidev_activate, NULL, uhidev_childdet);
     96   1.1  augustss 
     97  1.58     skrll int
     98  1.48    dyoung uhidev_match(device_t parent, cfdata_t match, void *aux)
     99   1.1  augustss {
    100  1.65     skrll 	struct usbif_attach_arg *uiaa = aux;
    101   1.6  augustss 
    102  1.51  jmcneill 	/* Game controllers in "XInput" mode */
    103  1.65     skrll 	if (USBIF_IS_XINPUT(uiaa))
    104  1.51  jmcneill 		return UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO;
    105  1.62  jmcneill 	/* Xbox One controllers */
    106  1.69     skrll 	if (USBIF_IS_X1INPUT(uiaa) && uiaa->uiaa_ifaceno == 0)
    107  1.62  jmcneill 		return UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO;
    108  1.62  jmcneill 
    109  1.65     skrll 	if (uiaa->uiaa_class != UICLASS_HID)
    110  1.65     skrll 		return UMATCH_NONE;
    111  1.65     skrll 	if (usbd_get_quirks(uiaa->uiaa_device)->uq_flags & UQ_HID_IGNORE)
    112  1.65     skrll 		return UMATCH_NONE;
    113  1.65     skrll 	return UMATCH_IFACECLASS_GENERIC;
    114   1.1  augustss }
    115   1.1  augustss 
    116  1.58     skrll void
    117  1.48    dyoung uhidev_attach(device_t parent, device_t self, void *aux)
    118   1.1  augustss {
    119  1.48    dyoung 	struct uhidev_softc *sc = device_private(self);
    120  1.65     skrll 	struct usbif_attach_arg *uiaa = aux;
    121  1.65     skrll 	struct usbd_interface *iface = uiaa->uiaa_iface;
    122   1.1  augustss 	usb_interface_descriptor_t *id;
    123   1.1  augustss 	usb_endpoint_descriptor_t *ed;
    124   1.1  augustss 	struct uhidev_attach_arg uha;
    125  1.42  drochner 	device_t dev;
    126  1.42  drochner 	struct uhidev *csc;
    127  1.44     rafal 	int maxinpktsize, size, nrepid, repid, repsz;
    128  1.32  christos 	int *repsizes;
    129  1.25     skrll 	int i;
    130  1.19  jdolecek 	void *desc;
    131  1.20  augustss 	const void *descptr;
    132   1.1  augustss 	usbd_status err;
    133  1.26  augustss 	char *devinfop;
    134  1.28  drochner 	int locs[UHIDBUSCF_NLOCS];
    135   1.6  augustss 
    136  1.41      cube 	sc->sc_dev = self;
    137  1.65     skrll 	sc->sc_udev = uiaa->uiaa_device;
    138   1.1  augustss 	sc->sc_iface = iface;
    139  1.43    plunky 
    140  1.43    plunky 	aprint_naive("\n");
    141  1.43    plunky 	aprint_normal("\n");
    142  1.43    plunky 
    143  1.65     skrll 	mutex_init(&sc->sc_lock, MUTEX_DEFAULT, IPL_SOFTUSB);
    144  1.56       mrg 
    145   1.1  augustss 	id = usbd_get_interface_descriptor(iface);
    146  1.26  augustss 
    147  1.65     skrll 	devinfop = usbd_devinfo_alloc(uiaa->uiaa_device, 0);
    148  1.41      cube 	aprint_normal_dev(self, "%s, iclass %d/%d\n",
    149  1.26  augustss 	       devinfop, id->bInterfaceClass, id->bInterfaceSubClass);
    150  1.26  augustss 	usbd_devinfo_free(devinfop);
    151   1.1  augustss 
    152  1.38  jmcneill 	if (!pmf_device_register(self, NULL, NULL))
    153  1.38  jmcneill 		aprint_error_dev(self, "couldn't establish power handler\n");
    154  1.38  jmcneill 
    155  1.72     ryoon 	if (uiaa->uiaa_vendor == USB_VENDOR_WACOM) {
    156  1.72     ryoon 		if (uiaa->uiaa_product == USB_PRODUCT_WACOM_XD0912U) {
    157  1.72     ryoon 		/*
    158  1.72     ryoon 		 * Wacom Intuos2 (XD-0912-U) requires longer idle time to
    159  1.72     ryoon 		 * initialize the device with 0x0202.
    160  1.72     ryoon 		 */
    161  1.72     ryoon 			DELAY(500000);
    162  1.72     ryoon 		}
    163  1.72     ryoon 	}
    164   1.1  augustss 	(void)usbd_set_idle(iface, 0, 0);
    165   1.1  augustss 
    166  1.71  jakllsch 	if ((usbd_get_quirks(sc->sc_udev)->uq_flags & UQ_NO_SET_PROTO) == 0)
    167   1.1  augustss 		(void)usbd_set_protocol(iface, 1);
    168   1.1  augustss 
    169  1.44     rafal 	maxinpktsize = 0;
    170  1.25     skrll 	sc->sc_iep_addr = sc->sc_oep_addr = -1;
    171  1.25     skrll 	for (i = 0; i < id->bNumEndpoints; i++) {
    172  1.25     skrll 		ed = usbd_interface2endpoint_descriptor(iface, i);
    173  1.25     skrll 		if (ed == NULL) {
    174  1.41      cube 			aprint_error_dev(self,
    175  1.41      cube 			    "could not read endpoint descriptor\n");
    176  1.25     skrll 			sc->sc_dying = 1;
    177  1.48    dyoung 			return;
    178  1.25     skrll 		}
    179  1.25     skrll 
    180  1.25     skrll 		DPRINTFN(10,("uhidev_attach: bLength=%d bDescriptorType=%d "
    181  1.25     skrll 		    "bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d"
    182  1.25     skrll 		    " bInterval=%d\n",
    183  1.25     skrll 		    ed->bLength, ed->bDescriptorType,
    184  1.25     skrll 		    ed->bEndpointAddress & UE_ADDR,
    185  1.25     skrll 		    UE_GET_DIR(ed->bEndpointAddress)==UE_DIR_IN? "in" : "out",
    186  1.25     skrll 		    ed->bmAttributes & UE_XFERTYPE,
    187  1.25     skrll 		    UGETW(ed->wMaxPacketSize), ed->bInterval));
    188  1.25     skrll 
    189  1.25     skrll 		if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
    190  1.25     skrll 		    (ed->bmAttributes & UE_XFERTYPE) == UE_INTERRUPT) {
    191  1.44     rafal 			maxinpktsize = UGETW(ed->wMaxPacketSize);
    192  1.25     skrll 			sc->sc_iep_addr = ed->bEndpointAddress;
    193  1.25     skrll 		} else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
    194  1.25     skrll 		    (ed->bmAttributes & UE_XFERTYPE) == UE_INTERRUPT) {
    195  1.25     skrll 			sc->sc_oep_addr = ed->bEndpointAddress;
    196  1.25     skrll 		} else {
    197  1.41      cube 			aprint_verbose_dev(self, "endpoint %d: ignored\n", i);
    198  1.25     skrll 		}
    199   1.1  augustss 	}
    200   1.1  augustss 
    201  1.25     skrll 	/*
    202  1.25     skrll 	 * Check that we found an input interrupt endpoint. The output interrupt
    203  1.25     skrll 	 * endpoint is optional
    204  1.25     skrll 	 */
    205  1.25     skrll 	if (sc->sc_iep_addr == -1) {
    206  1.41      cube 		aprint_error_dev(self, "no input interrupt endpoint\n");
    207   1.1  augustss 		sc->sc_dying = 1;
    208  1.48    dyoung 		return;
    209   1.1  augustss 	}
    210   1.1  augustss 
    211   1.1  augustss 	/* XXX need to extend this */
    212  1.20  augustss 	descptr = NULL;
    213  1.65     skrll 	if (uiaa->uiaa_vendor == USB_VENDOR_WACOM) {
    214  1.72     ryoon 		static uByte reportbuf[3];
    215  1.17  augustss 
    216   1.1  augustss 		/* The report descriptor for the Wacom Graphire is broken. */
    217  1.65     skrll 		switch (uiaa->uiaa_product) {
    218  1.33      ghen 		case USB_PRODUCT_WACOM_GRAPHIRE3_4X5:
    219  1.33      ghen 		case USB_PRODUCT_WACOM_GRAPHIRE3_6X8:
    220  1.33      ghen 		case USB_PRODUCT_WACOM_GRAPHIRE4_4X5: /* The 6x8 too? */
    221  1.17  augustss 			/*
    222  1.17  augustss 			 * The Graphire3 needs 0x0202 to be written to
    223  1.17  augustss 			 * feature report ID 2 before it'll start
    224  1.17  augustss 			 * returning digitizer data.
    225  1.17  augustss 			 */
    226  1.72     ryoon 			reportbuf[0] = 0x02;
    227  1.72     ryoon 			reportbuf[1] = 0x02;
    228  1.65     skrll 			usbd_set_report(uiaa->uiaa_iface, UHID_FEATURE_REPORT, 2,
    229  1.72     ryoon 			    &reportbuf, 2);
    230  1.17  augustss 
    231  1.65     skrll 			size = sizeof(uhid_graphire3_4x5_report_descr);
    232  1.17  augustss 			descptr = uhid_graphire3_4x5_report_descr;
    233  1.17  augustss 			break;
    234  1.72     ryoon 		case USB_PRODUCT_WACOM_GRAPHIRE:
    235  1.72     ryoon 		case USB_PRODUCT_WACOM_GRAPHIRE2:
    236  1.72     ryoon 		case USB_PRODUCT_WACOM_XD0912U:
    237  1.72     ryoon 		case USB_PRODUCT_WACOM_CTH690K0:
    238  1.72     ryoon 			reportbuf[0] = 0x02;
    239  1.72     ryoon 			reportbuf[1] = 0x02;
    240  1.72     ryoon 			usbd_set_report(uiaa->uiaa_iface, UHID_FEATURE_REPORT, 2,
    241  1.72     ryoon 			    &reportbuf, 2);
    242  1.72     ryoon 			break;
    243  1.20  augustss 		default:
    244  1.20  augustss 			/* Keep descriptor */
    245  1.20  augustss 			break;
    246  1.17  augustss 		}
    247  1.17  augustss 	}
    248  1.65     skrll 	if (USBIF_IS_XINPUT(uiaa)) {
    249  1.65     skrll 		size = sizeof(uhid_xinput_report_descr);
    250  1.51  jmcneill 		descptr = uhid_xinput_report_descr;
    251  1.51  jmcneill 	}
    252  1.65     skrll 	if (USBIF_IS_X1INPUT(uiaa)) {
    253  1.62  jmcneill 		sc->sc_flags |= UHIDEV_F_XB1;
    254  1.65     skrll 		size = sizeof(uhid_x1input_report_descr);
    255  1.62  jmcneill 		descptr = uhid_x1input_report_descr;
    256  1.62  jmcneill 	}
    257  1.17  augustss 
    258  1.17  augustss 	if (descptr) {
    259  1.65     skrll 		desc = kmem_alloc(size, KM_SLEEP);
    260  1.70       chs 		err = USBD_NORMAL_COMPLETION;
    261  1.70       chs 		memcpy(desc, descptr, size);
    262   1.1  augustss 	} else {
    263   1.1  augustss 		desc = NULL;
    264  1.65     skrll 		err = usbd_read_report_desc(uiaa->uiaa_iface, &desc, &size);
    265   1.1  augustss 	}
    266   1.1  augustss 	if (err) {
    267  1.41      cube 		aprint_error_dev(self, "no report descriptor\n");
    268   1.1  augustss 		sc->sc_dying = 1;
    269  1.48    dyoung 		return;
    270   1.1  augustss 	}
    271   1.6  augustss 
    272  1.65     skrll 	if (uiaa->uiaa_vendor == USB_VENDOR_HOSIDEN &&
    273  1.65     skrll 	    uiaa->uiaa_product == USB_PRODUCT_HOSIDEN_PPP) {
    274  1.27  augustss 		static uByte reportbuf[] = { 1 };
    275  1.27  augustss 		/*
    276  1.58     skrll 		 *  This device was sold by Konami with its ParaParaParadise
    277  1.27  augustss 		 *  game for PlayStation2.  It needs to be "turned on"
    278  1.27  augustss 		 *  before it will send any reports.
    279  1.27  augustss 		 */
    280  1.27  augustss 
    281  1.65     skrll 		usbd_set_report(uiaa->uiaa_iface, UHID_FEATURE_REPORT, 0,
    282  1.65     skrll 		    &reportbuf, sizeof(reportbuf));
    283  1.27  augustss 	}
    284  1.27  augustss 
    285  1.65     skrll 	if (uiaa->uiaa_vendor == USB_VENDOR_LOGITECH &&
    286  1.65     skrll 	    uiaa->uiaa_product == USB_PRODUCT_LOGITECH_CBT44 && size == 0xb1) {
    287  1.47  jakllsch 		uint8_t *data = desc;
    288  1.47  jakllsch 		/*
    289  1.47  jakllsch 		 * This device has a odd USAGE_MINIMUM value that would
    290  1.47  jakllsch 		 * cause the multimedia keys to have their usage number
    291  1.47  jakllsch 		 * shifted up one usage.  Adjust so the usages are sane.
    292  1.47  jakllsch 		 */
    293  1.47  jakllsch 
    294  1.47  jakllsch 		if (data[0x56] == 0x19 && data[0x57] == 0x01 &&
    295  1.47  jakllsch 		    data[0x58] == 0x2a && data[0x59] == 0x8c)
    296  1.47  jakllsch 			data[0x57] = 0x00;
    297  1.47  jakllsch 	}
    298  1.47  jakllsch 
    299  1.52   aymeric 	/*
    300  1.52   aymeric 	 * Enable the Six Axis and DualShock 3 controllers.
    301  1.52   aymeric 	 * See http://ps3.jim.sh/sixaxis/usb/
    302  1.52   aymeric 	 */
    303  1.65     skrll 	if (uiaa->uiaa_vendor == USB_VENDOR_SONY &&
    304  1.65     skrll 	    uiaa->uiaa_product == USB_PRODUCT_SONY_PS3CONTROLLER) {
    305  1.52   aymeric 		usb_device_request_t req;
    306  1.52   aymeric 		char data[17];
    307  1.52   aymeric 		int actlen;
    308  1.52   aymeric 
    309  1.52   aymeric 		req.bmRequestType = UT_READ_CLASS_INTERFACE;
    310  1.52   aymeric 		req.bRequest = 1;
    311  1.52   aymeric 		USETW(req.wValue, 0x3f2);
    312  1.52   aymeric 		USETW(req.wIndex, 0);
    313  1.65     skrll 		USETW(req.wLength, sizeof(data));
    314  1.52   aymeric 
    315  1.52   aymeric 		usbd_do_request_flags(sc->sc_udev, &req, data,
    316  1.52   aymeric 			USBD_SHORT_XFER_OK, &actlen, USBD_DEFAULT_TIMEOUT);
    317  1.52   aymeric 	}
    318  1.52   aymeric 
    319   1.1  augustss 	sc->sc_repdesc = desc;
    320   1.1  augustss 	sc->sc_repdesc_size = size;
    321   1.1  augustss 
    322  1.65     skrll 	uha.uiaa = uiaa;
    323   1.1  augustss 	nrepid = uhidev_maxrepid(desc, size);
    324   1.1  augustss 	if (nrepid < 0)
    325  1.48    dyoung 		return;
    326   1.1  augustss 	if (nrepid > 0)
    327  1.41      cube 		aprint_normal_dev(self, "%d report ids\n", nrepid);
    328   1.1  augustss 	nrepid++;
    329  1.65     skrll 	repsizes = kmem_alloc(nrepid * sizeof(*repsizes), KM_SLEEP);
    330  1.65     skrll 	sc->sc_subdevs = kmem_zalloc(nrepid * sizeof(device_t),
    331  1.65     skrll 	    KM_SLEEP);
    332  1.44     rafal 
    333  1.44     rafal 	/* Just request max packet size for the interrupt pipe */
    334  1.44     rafal 	sc->sc_isize = maxinpktsize;
    335   1.1  augustss 	sc->sc_nrepid = nrepid;
    336   1.1  augustss 
    337  1.68   msaitoh 	usbd_add_drv_event(USB_EVENT_DRIVER_ATTACH, sc->sc_udev, sc->sc_dev);
    338   1.1  augustss 
    339   1.1  augustss 	for (repid = 0; repid < nrepid; repid++) {
    340   1.1  augustss 		repsz = hid_report_size(desc, size, hid_input, repid);
    341   1.1  augustss 		DPRINTF(("uhidev_match: repid=%d, repsz=%d\n", repid, repsz));
    342   1.2  augustss 		repsizes[repid] = repsz;
    343   1.1  augustss 	}
    344  1.44     rafal 
    345   1.1  augustss 	DPRINTF(("uhidev_attach: isize=%d\n", sc->sc_isize));
    346   1.1  augustss 
    347   1.1  augustss 	uha.parent = sc;
    348   1.1  augustss 	for (repid = 0; repid < nrepid; repid++) {
    349   1.1  augustss 		DPRINTF(("uhidev_match: try repid=%d\n", repid));
    350   1.1  augustss 		if (hid_report_size(desc, size, hid_input, repid) == 0 &&
    351   1.1  augustss 		    hid_report_size(desc, size, hid_output, repid) == 0 &&
    352   1.1  augustss 		    hid_report_size(desc, size, hid_feature, repid) == 0) {
    353   1.5  augustss 			;	/* already NULL in sc->sc_subdevs[repid] */
    354   1.1  augustss 		} else {
    355   1.1  augustss 			uha.reportid = repid;
    356  1.28  drochner 			locs[UHIDBUSCF_REPORTID] = repid;
    357  1.22  drochner 
    358  1.42  drochner 			dev = config_found_sm_loc(self,
    359  1.28  drochner 				"uhidbus", locs, &uha,
    360  1.42  drochner 				uhidevprint, config_stdsubmatch);
    361   1.1  augustss 			sc->sc_subdevs[repid] = dev;
    362   1.4  augustss 			if (dev != NULL) {
    363  1.42  drochner 				csc = device_private(dev);
    364  1.42  drochner 				csc->sc_in_rep_size = repsizes[repid];
    365   1.1  augustss #ifdef DIAGNOSTIC
    366   1.1  augustss 				DPRINTF(("uhidev_match: repid=%d dev=%p\n",
    367   1.1  augustss 					 repid, dev));
    368  1.42  drochner 				if (csc->sc_intr == NULL) {
    369  1.65     skrll 					kmem_free(repsizes,
    370  1.65     skrll 					    nrepid * sizeof(*repsizes));
    371  1.41      cube 					aprint_error_dev(self,
    372  1.41      cube 					    "sc_intr == NULL\n");
    373  1.48    dyoung 					return;
    374   1.1  augustss 				}
    375   1.4  augustss #endif
    376  1.42  drochner 				rnd_attach_source(&csc->rnd_source,
    377  1.48    dyoung 						  device_xname(dev),
    378  1.61       tls 						  RND_TYPE_TTY,
    379  1.61       tls 						  RND_FLAG_DEFAULT);
    380   1.1  augustss 			}
    381   1.1  augustss 		}
    382   1.1  augustss 	}
    383  1.65     skrll 	kmem_free(repsizes, nrepid * sizeof(*repsizes));
    384   1.1  augustss 
    385  1.48    dyoung 	return;
    386   1.1  augustss }
    387   1.1  augustss 
    388   1.1  augustss int
    389   1.1  augustss uhidev_maxrepid(void *buf, int len)
    390   1.1  augustss {
    391   1.1  augustss 	struct hid_data *d;
    392   1.1  augustss 	struct hid_item h;
    393   1.1  augustss 	int maxid;
    394   1.1  augustss 
    395   1.1  augustss 	maxid = -1;
    396   1.1  augustss 	h.report_ID = 0;
    397   1.1  augustss 	for (d = hid_start_parse(buf, len, hid_none); hid_get_item(d, &h); )
    398   1.1  augustss 		if (h.report_ID > maxid)
    399   1.1  augustss 			maxid = h.report_ID;
    400   1.1  augustss 	hid_end_parse(d);
    401  1.65     skrll 	return maxid;
    402   1.1  augustss }
    403   1.1  augustss 
    404   1.1  augustss int
    405   1.1  augustss uhidevprint(void *aux, const char *pnp)
    406   1.1  augustss {
    407   1.1  augustss 	struct uhidev_attach_arg *uha = aux;
    408   1.1  augustss 
    409   1.1  augustss 	if (pnp)
    410  1.12   thorpej 		aprint_normal("uhid at %s", pnp);
    411   1.1  augustss 	if (uha->reportid != 0)
    412  1.12   thorpej 		aprint_normal(" reportid %d", uha->reportid);
    413  1.65     skrll 	return UNCONF;
    414   1.1  augustss }
    415   1.1  augustss 
    416   1.1  augustss int
    417  1.39    dyoung uhidev_activate(device_t self, enum devact act)
    418   1.1  augustss {
    419  1.39    dyoung 	struct uhidev_softc *sc = device_private(self);
    420   1.1  augustss 
    421   1.1  augustss 	switch (act) {
    422   1.1  augustss 	case DVACT_DEACTIVATE:
    423   1.1  augustss 		sc->sc_dying = 1;
    424  1.45    dyoung 		return 0;
    425  1.16  christos 	default:
    426  1.45    dyoung 		return EOPNOTSUPP;
    427   1.1  augustss 	}
    428   1.1  augustss }
    429   1.1  augustss 
    430  1.39    dyoung void
    431  1.39    dyoung uhidev_childdet(device_t self, device_t child)
    432  1.39    dyoung {
    433  1.39    dyoung 	int i;
    434  1.39    dyoung 	struct uhidev_softc *sc = device_private(self);
    435  1.39    dyoung 
    436  1.39    dyoung 	for (i = 0; i < sc->sc_nrepid; i++) {
    437  1.42  drochner 		if (sc->sc_subdevs[i] == child)
    438  1.39    dyoung 			break;
    439  1.39    dyoung 	}
    440  1.39    dyoung 	KASSERT(i < sc->sc_nrepid);
    441  1.39    dyoung 	sc->sc_subdevs[i] = NULL;
    442  1.39    dyoung }
    443  1.39    dyoung 
    444  1.58     skrll int
    445  1.48    dyoung uhidev_detach(device_t self, int flags)
    446   1.1  augustss {
    447  1.48    dyoung 	struct uhidev_softc *sc = device_private(self);
    448   1.1  augustss 	int i, rv;
    449  1.42  drochner 	struct uhidev *csc;
    450   1.1  augustss 
    451   1.1  augustss 	DPRINTF(("uhidev_detach: sc=%p flags=%d\n", sc, flags));
    452   1.1  augustss 
    453   1.1  augustss 	sc->sc_dying = 1;
    454  1.25     skrll 	if (sc->sc_ipipe != NULL)
    455  1.25     skrll 		usbd_abort_pipe(sc->sc_ipipe);
    456   1.1  augustss 
    457   1.1  augustss 	if (sc->sc_repdesc != NULL)
    458  1.65     skrll 		kmem_free(sc->sc_repdesc, sc->sc_repdesc_size);
    459   1.1  augustss 
    460   1.1  augustss 	rv = 0;
    461   1.1  augustss 	for (i = 0; i < sc->sc_nrepid; i++) {
    462   1.1  augustss 		if (sc->sc_subdevs[i] != NULL) {
    463  1.42  drochner 			csc = device_private(sc->sc_subdevs[i]);
    464  1.42  drochner 			rnd_detach_source(&csc->rnd_source);
    465  1.42  drochner 			rv |= config_detach(sc->sc_subdevs[i], flags);
    466   1.1  augustss 		}
    467   1.1  augustss 	}
    468   1.1  augustss 
    469  1.68   msaitoh 	usbd_add_drv_event(USB_EVENT_DRIVER_DETACH, sc->sc_udev, sc->sc_dev);
    470   1.1  augustss 
    471  1.38  jmcneill 	pmf_device_deregister(self);
    472  1.56       mrg 	mutex_destroy(&sc->sc_lock);
    473  1.38  jmcneill 
    474  1.65     skrll 	return rv;
    475   1.1  augustss }
    476   1.1  augustss 
    477   1.1  augustss void
    478  1.65     skrll uhidev_intr(struct usbd_xfer *xfer, void *addr, usbd_status status)
    479   1.1  augustss {
    480   1.1  augustss 	struct uhidev_softc *sc = addr;
    481  1.42  drochner 	device_t cdev;
    482   1.1  augustss 	struct uhidev *scd;
    483   1.1  augustss 	u_char *p;
    484   1.1  augustss 	u_int rep;
    485  1.65     skrll 	uint32_t cc;
    486   1.1  augustss 
    487   1.1  augustss 	usbd_get_xfer_status(xfer, NULL, NULL, &cc, NULL);
    488   1.1  augustss 
    489   1.1  augustss #ifdef UHIDEV_DEBUG
    490   1.1  augustss 	if (uhidevdebug > 5) {
    491  1.65     skrll 		uint32_t i;
    492   1.6  augustss 
    493   1.1  augustss 		DPRINTF(("uhidev_intr: status=%d cc=%d\n", status, cc));
    494   1.1  augustss 		DPRINTF(("uhidev_intr: data ="));
    495   1.1  augustss 		for (i = 0; i < cc; i++)
    496   1.1  augustss 			DPRINTF((" %02x", sc->sc_ibuf[i]));
    497   1.1  augustss 		DPRINTF(("\n"));
    498   1.1  augustss 	}
    499   1.1  augustss #endif
    500   1.1  augustss 
    501   1.1  augustss 	if (status == USBD_CANCELLED)
    502   1.1  augustss 		return;
    503   1.1  augustss 
    504   1.1  augustss 	if (status != USBD_NORMAL_COMPLETION) {
    505  1.48    dyoung 		DPRINTF(("%s: interrupt status=%d\n", device_xname(sc->sc_dev),
    506   1.3  augustss 			 status));
    507  1.25     skrll 		usbd_clear_endpoint_stall_async(sc->sc_ipipe);
    508   1.1  augustss 		return;
    509   1.1  augustss 	}
    510   1.1  augustss 
    511   1.1  augustss 	p = sc->sc_ibuf;
    512   1.1  augustss 	if (sc->sc_nrepid != 1)
    513   1.1  augustss 		rep = *p++, cc--;
    514   1.1  augustss 	else
    515   1.1  augustss 		rep = 0;
    516   1.1  augustss 	if (rep >= sc->sc_nrepid) {
    517   1.1  augustss 		printf("uhidev_intr: bad repid %d\n", rep);
    518   1.1  augustss 		return;
    519   1.1  augustss 	}
    520  1.42  drochner 	cdev = sc->sc_subdevs[rep];
    521  1.42  drochner 	if (!cdev)
    522  1.42  drochner 		return;
    523  1.42  drochner 	scd = device_private(cdev);
    524   1.1  augustss 	DPRINTFN(5,("uhidev_intr: rep=%d, scd=%p state=0x%x\n",
    525   1.1  augustss 		    rep, scd, scd ? scd->sc_state : 0));
    526  1.42  drochner 	if (!(scd->sc_state & UHIDEV_OPEN))
    527   1.1  augustss 		return;
    528  1.46  jakllsch #ifdef UHIDEV_DEBUG
    529  1.46  jakllsch 	if (scd->sc_in_rep_size != cc) {
    530  1.46  jakllsch 		DPRINTF(("%s: expected %d bytes, got %d\n",
    531  1.48    dyoung 		       device_xname(sc->sc_dev), scd->sc_in_rep_size, cc));
    532  1.46  jakllsch 	}
    533  1.46  jakllsch #endif
    534  1.46  jakllsch 	if (cc == 0) {
    535  1.46  jakllsch 		DPRINTF(("%s: 0-length input ignored\n",
    536  1.48    dyoung 			device_xname(sc->sc_dev)));
    537  1.23  augustss 		return;
    538  1.23  augustss 	}
    539  1.10      fair 	rnd_add_uint32(&scd->rnd_source, (uintptr_t)(sc->sc_ibuf));
    540   1.1  augustss 	scd->sc_intr(scd, p, cc);
    541   1.1  augustss }
    542   1.1  augustss 
    543   1.1  augustss void
    544   1.1  augustss uhidev_get_report_desc(struct uhidev_softc *sc, void **desc, int *size)
    545   1.1  augustss {
    546   1.1  augustss 	*desc = sc->sc_repdesc;
    547   1.1  augustss 	*size = sc->sc_repdesc_size;
    548   1.1  augustss }
    549   1.1  augustss 
    550   1.1  augustss int
    551   1.1  augustss uhidev_open(struct uhidev *scd)
    552   1.1  augustss {
    553   1.1  augustss 	struct uhidev_softc *sc = scd->sc_parent;
    554   1.1  augustss 	usbd_status err;
    555  1.25     skrll 	int error;
    556   1.1  augustss 
    557  1.56       mrg 	DPRINTF(("uhidev_open: open pipe, state=%d\n", scd->sc_state));
    558   1.1  augustss 
    559  1.56       mrg 	mutex_enter(&sc->sc_lock);
    560  1.56       mrg 	if (scd->sc_state & UHIDEV_OPEN) {
    561  1.56       mrg 		mutex_exit(&sc->sc_lock);
    562  1.65     skrll 		return EBUSY;
    563  1.56       mrg 	}
    564   1.1  augustss 	scd->sc_state |= UHIDEV_OPEN;
    565  1.60     skrll 	if (sc->sc_refcnt++) {
    566  1.60     skrll 		mutex_exit(&sc->sc_lock);
    567  1.65     skrll 		return 0;
    568  1.60     skrll 	}
    569  1.56       mrg 	mutex_exit(&sc->sc_lock);
    570   1.1  augustss 
    571   1.1  augustss 	if (sc->sc_isize == 0)
    572  1.65     skrll 		return 0;
    573   1.1  augustss 
    574  1.65     skrll 	sc->sc_ibuf = kmem_alloc(sc->sc_isize, KM_SLEEP);
    575   1.1  augustss 
    576  1.25     skrll 	/* Set up input interrupt pipe. */
    577   1.1  augustss 	DPRINTF(("uhidev_open: isize=%d, ep=0x%02x\n", sc->sc_isize,
    578  1.25     skrll 		 sc->sc_iep_addr));
    579  1.58     skrll 
    580  1.25     skrll 	err = usbd_open_pipe_intr(sc->sc_iface, sc->sc_iep_addr,
    581  1.25     skrll 		  USBD_SHORT_XFER_OK, &sc->sc_ipipe, sc, sc->sc_ibuf,
    582   1.1  augustss 		  sc->sc_isize, uhidev_intr, USBD_DEFAULT_INTERVAL);
    583  1.25     skrll 	if (err != USBD_NORMAL_COMPLETION) {
    584   1.1  augustss 		DPRINTF(("uhidopen: usbd_open_pipe_intr failed, "
    585  1.25     skrll 		    "error=%d\n", err));
    586  1.25     skrll 		error = EIO;
    587  1.25     skrll 		goto out1;
    588  1.25     skrll 	}
    589  1.25     skrll 
    590  1.25     skrll 	/*
    591  1.25     skrll 	 * Set up output interrupt pipe if an output interrupt endpoint
    592  1.25     skrll 	 * exists.
    593  1.25     skrll 	 */
    594  1.25     skrll 	if (sc->sc_oep_addr != -1) {
    595  1.25     skrll 		DPRINTF(("uhidev_open: oep=0x%02x\n", sc->sc_oep_addr));
    596  1.25     skrll 
    597  1.25     skrll 		err = usbd_open_pipe(sc->sc_iface, sc->sc_oep_addr,
    598  1.25     skrll 		    0, &sc->sc_opipe);
    599  1.25     skrll 
    600  1.25     skrll 		if (err != USBD_NORMAL_COMPLETION) {
    601  1.25     skrll 			DPRINTF(("uhidev_open: usbd_open_pipe failed, "
    602  1.25     skrll 			    "error=%d\n", err));
    603  1.25     skrll 			error = EIO;
    604  1.25     skrll 			goto out2;
    605  1.25     skrll 		}
    606  1.25     skrll 		DPRINTF(("uhidev_open: sc->sc_opipe=%p\n", sc->sc_opipe));
    607  1.25     skrll 
    608  1.65     skrll 		error = usbd_create_xfer(sc->sc_opipe, UHIDEV_OSIZE, 0, 0,
    609  1.65     skrll 		    &sc->sc_oxfer);
    610  1.65     skrll 		if (error) {
    611  1.25     skrll 			DPRINTF(("uhidev_open: couldn't allocate an xfer\n"));
    612  1.25     skrll 			goto out3;
    613  1.25     skrll 		}
    614  1.62  jmcneill 
    615  1.62  jmcneill 		if (sc->sc_flags & UHIDEV_F_XB1) {
    616  1.62  jmcneill 			uint8_t init_data[] = { 0x05, 0x20 };
    617  1.62  jmcneill 			int init_data_len = sizeof(init_data);
    618  1.62  jmcneill 			err = usbd_intr_transfer(sc->sc_oxfer, sc->sc_opipe, 0,
    619  1.65     skrll 			    USBD_NO_TIMEOUT, init_data, &init_data_len);
    620  1.62  jmcneill 			if (err != USBD_NORMAL_COMPLETION) {
    621  1.62  jmcneill 				DPRINTF(("uhidev_open: xb1 init failed, "
    622  1.62  jmcneill 				    "error=%d\n", err));
    623  1.62  jmcneill 				error = EIO;
    624  1.62  jmcneill 				goto out4;
    625  1.62  jmcneill 			}
    626  1.62  jmcneill 		}
    627   1.1  augustss 	}
    628  1.58     skrll 
    629  1.65     skrll 	return 0;
    630  1.62  jmcneill out4:
    631  1.62  jmcneill 	/* Free output xfer */
    632  1.62  jmcneill 	if (sc->sc_oxfer != NULL)
    633  1.65     skrll 		usbd_destroy_xfer(sc->sc_oxfer);
    634  1.25     skrll out3:
    635  1.25     skrll 	/* Abort output pipe */
    636  1.25     skrll 	usbd_close_pipe(sc->sc_opipe);
    637  1.25     skrll out2:
    638  1.25     skrll 	/* Abort input pipe */
    639  1.25     skrll 	usbd_close_pipe(sc->sc_ipipe);
    640  1.25     skrll out1:
    641  1.25     skrll 	DPRINTF(("uhidev_open: failed in someway"));
    642  1.65     skrll 	kmem_free(sc->sc_ibuf, sc->sc_isize);
    643  1.56       mrg 	mutex_enter(&sc->sc_lock);
    644  1.25     skrll 	scd->sc_state &= ~UHIDEV_OPEN;
    645  1.60     skrll 	sc->sc_refcnt = 0;
    646  1.59  christos 	sc->sc_ibuf = NULL;
    647  1.25     skrll 	sc->sc_ipipe = NULL;
    648  1.25     skrll 	sc->sc_opipe = NULL;
    649  1.25     skrll 	sc->sc_oxfer = NULL;
    650  1.56       mrg 	mutex_exit(&sc->sc_lock);
    651  1.25     skrll 	return error;
    652   1.1  augustss }
    653   1.1  augustss 
    654   1.1  augustss void
    655  1.63       mrg uhidev_stop(struct uhidev *scd)
    656  1.63       mrg {
    657  1.63       mrg 	struct uhidev_softc *sc = scd->sc_parent;
    658  1.63       mrg 
    659  1.63       mrg 	/* Disable interrupts. */
    660  1.63       mrg 	if (sc->sc_opipe != NULL) {
    661  1.63       mrg 		usbd_abort_pipe(sc->sc_opipe);
    662  1.63       mrg 		usbd_close_pipe(sc->sc_opipe);
    663  1.63       mrg 		sc->sc_opipe = NULL;
    664  1.63       mrg 	}
    665  1.63       mrg 
    666  1.63       mrg 	if (sc->sc_ipipe != NULL) {
    667  1.63       mrg 		usbd_abort_pipe(sc->sc_ipipe);
    668  1.63       mrg 		usbd_close_pipe(sc->sc_ipipe);
    669  1.63       mrg 		sc->sc_ipipe = NULL;
    670  1.63       mrg 	}
    671  1.63       mrg 
    672  1.63       mrg 	if (sc->sc_ibuf != NULL) {
    673  1.65     skrll 		kmem_free(sc->sc_ibuf, sc->sc_isize);
    674  1.63       mrg 		sc->sc_ibuf = NULL;
    675  1.63       mrg 	}
    676  1.63       mrg }
    677  1.63       mrg 
    678  1.63       mrg void
    679   1.1  augustss uhidev_close(struct uhidev *scd)
    680   1.1  augustss {
    681   1.1  augustss 	struct uhidev_softc *sc = scd->sc_parent;
    682   1.1  augustss 
    683  1.56       mrg 	mutex_enter(&sc->sc_lock);
    684  1.56       mrg 	if (!(scd->sc_state & UHIDEV_OPEN)) {
    685  1.56       mrg 		mutex_exit(&sc->sc_lock);
    686   1.1  augustss 		return;
    687  1.56       mrg 	}
    688   1.1  augustss 	scd->sc_state &= ~UHIDEV_OPEN;
    689  1.60     skrll 	if (--sc->sc_refcnt) {
    690  1.60     skrll 		mutex_exit(&sc->sc_lock);
    691  1.60     skrll 		return;
    692  1.60     skrll 	}
    693  1.56       mrg 	mutex_exit(&sc->sc_lock);
    694  1.56       mrg 
    695   1.1  augustss 	DPRINTF(("uhidev_close: close pipe\n"));
    696   1.1  augustss 
    697  1.59  christos 	if (sc->sc_oxfer != NULL) {
    698  1.65     skrll 		usbd_destroy_xfer(sc->sc_oxfer);
    699  1.59  christos 		sc->sc_oxfer = NULL;
    700  1.59  christos 	}
    701  1.58     skrll 
    702  1.65     skrll 
    703  1.63       mrg 	/* Possibly redundant, but properly handled */
    704  1.63       mrg 	uhidev_stop(scd);
    705   1.1  augustss }
    706   1.1  augustss 
    707   1.1  augustss usbd_status
    708   1.1  augustss uhidev_set_report(struct uhidev *scd, int type, void *data, int len)
    709   1.1  augustss {
    710  1.13   dsainty 	char *buf;
    711  1.13   dsainty 	usbd_status retstat;
    712  1.13   dsainty 
    713  1.13   dsainty 	if (scd->sc_report_id == 0)
    714  1.13   dsainty 		return usbd_set_report(scd->sc_parent->sc_iface, type,
    715  1.13   dsainty 				       scd->sc_report_id, data, len);
    716  1.13   dsainty 
    717  1.65     skrll 	buf = kmem_alloc(len + 1, KM_SLEEP);
    718  1.13   dsainty 	buf[0] = scd->sc_report_id;
    719  1.13   dsainty 	memcpy(buf+1, data, len);
    720  1.13   dsainty 
    721  1.13   dsainty 	retstat = usbd_set_report(scd->sc_parent->sc_iface, type,
    722  1.18   dsainty 				  scd->sc_report_id, buf, len + 1);
    723  1.13   dsainty 
    724  1.65     skrll 	kmem_free(buf, len + 1);
    725   1.1  augustss 
    726  1.13   dsainty 	return retstat;
    727   1.1  augustss }
    728   1.1  augustss 
    729   1.1  augustss usbd_status
    730   1.1  augustss uhidev_get_report(struct uhidev *scd, int type, void *data, int len)
    731   1.1  augustss {
    732   1.6  augustss 	return usbd_get_report(scd->sc_parent->sc_iface, type,
    733   1.1  augustss 			       scd->sc_report_id, data, len);
    734   1.1  augustss }
    735  1.25     skrll 
    736  1.25     skrll usbd_status
    737  1.25     skrll uhidev_write(struct uhidev_softc *sc, void *data, int len)
    738  1.25     skrll {
    739  1.25     skrll 
    740  1.25     skrll 	DPRINTF(("uhidev_write: data=%p, len=%d\n", data, len));
    741  1.25     skrll 
    742  1.25     skrll 	if (sc->sc_opipe == NULL)
    743  1.25     skrll 		return USBD_INVAL;
    744  1.25     skrll 
    745  1.25     skrll #ifdef UHIDEV_DEBUG
    746  1.25     skrll 	if (uhidevdebug > 50) {
    747  1.25     skrll 
    748  1.65     skrll 		uint32_t i;
    749  1.65     skrll 		uint8_t *d = data;
    750  1.25     skrll 
    751  1.25     skrll 		DPRINTF(("uhidev_write: data ="));
    752  1.25     skrll 		for (i = 0; i < len; i++)
    753  1.25     skrll 			DPRINTF((" %02x", d[i]));
    754  1.25     skrll 		DPRINTF(("\n"));
    755  1.25     skrll 	}
    756  1.25     skrll #endif
    757  1.65     skrll 	return usbd_intr_transfer(sc->sc_oxfer, sc->sc_opipe, 0, USBD_NO_TIMEOUT,
    758  1.65     skrll 	    data, &len);
    759  1.25     skrll }
    760