xref: /openbsd-src/sys/dev/usb/uhidev.c (revision d0fc3bb68efd6c434b4053cd7adb29023cbec341)
1 /*	$OpenBSD: uhidev.c,v 1.92 2021/03/18 09:21:53 anton Exp $	*/
2 /*	$NetBSD: uhidev.c,v 1.14 2003/03/11 16:44:00 augustss Exp $	*/
3 
4 /*
5  * Copyright (c) 2001 The NetBSD Foundation, Inc.
6  * All rights reserved.
7  *
8  * This code is derived from software contributed to The NetBSD Foundation
9  * by Lennart Augustsson (lennart@augustsson.net) at
10  * Carlstedt Research & Technology.
11  *
12  * Redistribution and use in source and binary forms, with or without
13  * modification, are permitted provided that the following conditions
14  * are met:
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  *
21  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
22  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
23  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
24  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
25  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31  * POSSIBILITY OF SUCH DAMAGE.
32  */
33 
34 /*
35  * HID spec: https://www.usb.org/sites/default/files/hid1_11.pdf
36  */
37 
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/kernel.h>
41 #include <sys/malloc.h>
42 #include <sys/signalvar.h>
43 #include <sys/device.h>
44 #include <sys/ioctl.h>
45 #include <sys/conf.h>
46 
47 #include <machine/bus.h>
48 
49 #include <dev/usb/usb.h>
50 #include <dev/usb/usbhid.h>
51 
52 #include <dev/usb/usbdevs.h>
53 #include <dev/usb/usbdi.h>
54 #include <dev/usb/usbdi_util.h>
55 #include <dev/usb/usbdivar.h>
56 #include <dev/usb/usb_mem.h>
57 #include <dev/usb/usb_quirks.h>
58 
59 #include <dev/usb/uhidev.h>
60 
61 #ifndef SMALL_KERNEL
62 /* Replacement report descriptors for devices shipped with broken ones */
63 #include <dev/usb/uhid_rdesc.h>
64 int uhidev_use_rdesc(struct uhidev_softc *, usb_interface_descriptor_t *,
65 		int, int, void **, int *);
66 #define UISUBCLASS_XBOX360_CONTROLLER 0x5d
67 #define UIPROTO_XBOX360_GAMEPAD 0x01
68 #endif /* !SMALL_KERNEL */
69 
70 #define DEVNAME(sc)		((sc)->sc_dev.dv_xname)
71 
72 #ifdef UHIDEV_DEBUG
73 #define DPRINTF(x)	do { if (uhidevdebug) printf x; } while (0)
74 #define DPRINTFN(n,x)	do { if (uhidevdebug>(n)) printf x; } while (0)
75 int	uhidevdebug = 0;
76 #else
77 #define DPRINTF(x)
78 #define DPRINTFN(n,x)
79 #endif
80 
81 struct uhidev_async_info {
82 	void (*callback)(void *priv, int id, void *data, int len);
83 	void *priv;
84 	void *data;
85 	int id;
86 };
87 
88 void uhidev_intr(struct usbd_xfer *, void *, usbd_status);
89 
90 int uhidev_maxrepid(void *buf, int len);
91 int uhidevprint(void *aux, const char *pnp);
92 int uhidevsubmatch(struct device *parent, void *cf, void *aux);
93 
94 int uhidev_match(struct device *, void *, void *);
95 void uhidev_attach(struct device *, struct device *, void *);
96 int uhidev_detach(struct device *, int);
97 int uhidev_activate(struct device *, int);
98 
99 void uhidev_get_report_async_cb(struct usbd_xfer *, void *, usbd_status);
100 void uhidev_set_report_async_cb(struct usbd_xfer *, void *, usbd_status);
101 
102 struct cfdriver uhidev_cd = {
103 	NULL, "uhidev", DV_DULL
104 };
105 
106 const struct cfattach uhidev_ca = {
107 	sizeof(struct uhidev_softc), uhidev_match, uhidev_attach,
108 	uhidev_detach, uhidev_activate,
109 };
110 
111 int
112 uhidev_match(struct device *parent, void *match, void *aux)
113 {
114 	struct usb_attach_arg *uaa = aux;
115 	usb_interface_descriptor_t *id;
116 
117 	if (uaa->iface == NULL)
118 		return (UMATCH_NONE);
119 	id = usbd_get_interface_descriptor(uaa->iface);
120 	if (id == NULL)
121 		return (UMATCH_NONE);
122 #ifndef SMALL_KERNEL
123 	if (id->bInterfaceClass == UICLASS_VENDOR &&
124 	    id->bInterfaceSubClass == UISUBCLASS_XBOX360_CONTROLLER &&
125 	    id->bInterfaceProtocol == UIPROTO_XBOX360_GAMEPAD)
126 		return (UMATCH_IFACECLASS_IFACESUBCLASS_IFACEPROTO);
127 #endif /* !SMALL_KERNEL */
128 	if (id->bInterfaceClass != UICLASS_HID)
129 		return (UMATCH_NONE);
130 	if (usbd_get_quirks(uaa->device)->uq_flags & UQ_BAD_HID)
131 		return (UMATCH_NONE);
132 
133 	return (UMATCH_IFACECLASS_GENERIC);
134 }
135 
136 void
137 uhidev_attach(struct device *parent, struct device *self, void *aux)
138 {
139 	struct uhidev_softc *sc = (struct uhidev_softc *)self;
140 	struct usb_attach_arg *uaa = aux;
141 	usb_interface_descriptor_t *id;
142 	usb_endpoint_descriptor_t *ed;
143 	struct uhidev_attach_arg uha;
144 	int size, nrepid, repid, repsz;
145 	int i, repsizes[256];
146 	void *desc = NULL;
147 	struct device *dev;
148 
149 	sc->sc_udev = uaa->device;
150 	sc->sc_iface = uaa->iface;
151 	sc->sc_ifaceno = uaa->ifaceno;
152 	id = usbd_get_interface_descriptor(sc->sc_iface);
153 
154 	sc->sc_iep_addr = sc->sc_oep_addr = -1;
155 	for (i = 0; i < id->bNumEndpoints; i++) {
156 		ed = usbd_interface2endpoint_descriptor(sc->sc_iface, i);
157 		if (ed == NULL) {
158 			printf("%s: could not read endpoint descriptor\n",
159 			    DEVNAME(sc));
160 			return;
161 		}
162 
163 		DPRINTFN(10,("uhidev_attach: bLength=%d bDescriptorType=%d "
164 		    "bEndpointAddress=%d-%s bmAttributes=%d wMaxPacketSize=%d"
165 		    " bInterval=%d\n",
166 		    ed->bLength, ed->bDescriptorType,
167 		    ed->bEndpointAddress & UE_ADDR,
168 		    UE_GET_DIR(ed->bEndpointAddress)==UE_DIR_IN? "in" : "out",
169 		    UE_GET_XFERTYPE(ed->bmAttributes),
170 		    UGETW(ed->wMaxPacketSize), ed->bInterval));
171 
172 		if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_IN &&
173 		    UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
174 			sc->sc_iep_addr = ed->bEndpointAddress;
175 		} else if (UE_GET_DIR(ed->bEndpointAddress) == UE_DIR_OUT &&
176 		    UE_GET_XFERTYPE(ed->bmAttributes) == UE_INTERRUPT) {
177 			sc->sc_oep_addr = ed->bEndpointAddress;
178 		} else {
179 			printf("%s: unexpected endpoint\n", DEVNAME(sc));
180 			return;
181 		}
182 	}
183 
184 	/*
185 	 * Check that we found an input interrupt endpoint.
186 	 * The output interrupt endpoint is optional
187 	 */
188 	if (sc->sc_iep_addr == -1) {
189 		printf("%s: no input interrupt endpoint\n", DEVNAME(sc));
190 		return;
191 	}
192 
193 #ifndef SMALL_KERNEL
194 	if (uhidev_use_rdesc(sc, id, uaa->vendor, uaa->product, &desc, &size))
195 		return;
196 #endif /* !SMALL_KERNEL */
197 
198 	if (desc == NULL) {
199 		struct usb_hid_descriptor *hid;
200 
201 		hid = usbd_get_hid_descriptor(sc->sc_udev, id);
202 		if (hid == NULL) {
203 			printf("%s: no HID descriptor\n", DEVNAME(sc));
204 			return;
205 		}
206 		size = UGETW(hid->descrs[0].wDescriptorLength);
207 		desc = malloc(size, M_USBDEV, M_NOWAIT);
208 		if (desc == NULL) {
209 			printf("%s: no memory\n", DEVNAME(sc));
210 			return;
211 		}
212 		if (usbd_get_report_descriptor(sc->sc_udev, sc->sc_ifaceno,
213 		    desc, size)) {
214 			printf("%s: no report descriptor\n", DEVNAME(sc));
215 			free(desc, M_USBDEV, size);
216 			return;
217 		}
218 	}
219 
220 	sc->sc_repdesc = desc;
221 	sc->sc_repdesc_size = size;
222 
223 	nrepid = uhidev_maxrepid(desc, size);
224 	if (nrepid < 0)
225 		return;
226 	printf("%s: iclass %d/%d", DEVNAME(sc), id->bInterfaceClass,
227 	    id->bInterfaceSubClass);
228 	if (nrepid > 0)
229 		printf(", %d report id%s", nrepid, nrepid > 1 ? "s" : "");
230 	printf("\n");
231 	nrepid++;
232 	sc->sc_subdevs = mallocarray(nrepid, sizeof(struct uhidev *),
233 	    M_USBDEV, M_NOWAIT | M_ZERO);
234 	if (sc->sc_subdevs == NULL) {
235 		printf("%s: no memory\n", DEVNAME(sc));
236 		return;
237 	}
238 	sc->sc_nrepid = nrepid;
239 	sc->sc_isize = 0;
240 
241 	for (repid = 0; repid < nrepid; repid++) {
242 		repsz = hid_report_size(desc, size, hid_input, repid);
243 		DPRINTF(("uhidev_match: repid=%d, repsz=%d\n", repid, repsz));
244 		repsizes[repid] = repsz;
245 		if (repsz > sc->sc_isize)
246 			sc->sc_isize = repsz;
247 	}
248 	sc->sc_isize += (nrepid != 1);	/* one byte for the report ID */
249 	DPRINTF(("uhidev_attach: isize=%d\n", sc->sc_isize));
250 
251 	uha.uaa = uaa;
252 	uha.parent = sc;
253 	uha.reportid = UHIDEV_CLAIM_MULTIPLE_REPORTID;
254 	uha.nreports = nrepid;
255 	uha.claimed = malloc(nrepid, M_TEMP, M_WAITOK|M_ZERO);
256 
257 	/* Look for a driver claiming multiple report IDs first. */
258 	dev = config_found_sm(self, &uha, NULL, uhidevsubmatch);
259 	if (dev != NULL) {
260 		for (repid = 0; repid < nrepid; repid++) {
261 			/*
262 			 * Could already be assigned by uhidev_set_report_dev().
263 			 */
264 			if (sc->sc_subdevs[repid] != NULL)
265 				continue;
266 
267 			if (uha.claimed[repid])
268 				sc->sc_subdevs[repid] = (struct uhidev *)dev;
269 		}
270 	}
271 
272 	free(uha.claimed, M_TEMP, nrepid);
273 	uha.claimed = NULL;
274 
275 	for (repid = 0; repid < nrepid; repid++) {
276 		DPRINTF(("%s: try repid=%d\n", __func__, repid));
277 		if (hid_report_size(desc, size, hid_input, repid) == 0 &&
278 		    hid_report_size(desc, size, hid_output, repid) == 0 &&
279 		    hid_report_size(desc, size, hid_feature, repid) == 0)
280 			continue;
281 
282 		/* Could already be assigned by uhidev_set_report_dev(). */
283 		if (sc->sc_subdevs[repid] != NULL)
284 			continue;
285 
286 		uha.reportid = repid;
287 		dev = config_found_sm(self, &uha, uhidevprint, uhidevsubmatch);
288 		sc->sc_subdevs[repid] = (struct uhidev *)dev;
289 	}
290 }
291 
292 #ifndef SMALL_KERNEL
293 int
294 uhidev_use_rdesc(struct uhidev_softc *sc, usb_interface_descriptor_t *id,
295 		int vendor, int product, void **descp, int *sizep)
296 {
297 	static uByte reportbuf[] = {2, 2};
298 	const void *descptr = NULL;
299 	void *desc;
300 	int size;
301 
302 	if (vendor == USB_VENDOR_WACOM) {
303 		/* The report descriptor for the Wacom Graphire is broken. */
304 		switch (product) {
305 		case USB_PRODUCT_WACOM_GRAPHIRE:
306 			size = sizeof(uhid_graphire_report_descr);
307 			descptr = uhid_graphire_report_descr;
308 			break;
309 		case USB_PRODUCT_WACOM_GRAPHIRE3_4X5:
310 		case USB_PRODUCT_WACOM_GRAPHIRE4_4X5:
311 			uhidev_set_report(sc, UHID_FEATURE_REPORT,
312 			    2, &reportbuf, sizeof(reportbuf));
313 			size = sizeof(uhid_graphire3_4x5_report_descr);
314 			descptr = uhid_graphire3_4x5_report_descr;
315 			break;
316 		default:
317 			break;
318 		}
319 	} else if ((id->bInterfaceClass == UICLASS_VENDOR &&
320 		   id->bInterfaceSubClass == UISUBCLASS_XBOX360_CONTROLLER &&
321 		   id->bInterfaceProtocol == UIPROTO_XBOX360_GAMEPAD)) {
322 		/* The Xbox 360 gamepad has no report descriptor. */
323 		size = sizeof(uhid_xb360gp_report_descr);
324 		descptr = uhid_xb360gp_report_descr;
325 	}
326 
327 	if (descptr) {
328 		desc = malloc(size, M_USBDEV, M_NOWAIT);
329 		if (desc == NULL)
330 			return (ENOMEM);
331 
332 		memcpy(desc, descptr, size);
333 
334 		*descp = desc;
335 		*sizep = size;
336 	}
337 
338 	return (0);
339 }
340 #endif /* !SMALL_KERNEL */
341 
342 int
343 uhidev_maxrepid(void *buf, int len)
344 {
345 	struct hid_data *d;
346 	struct hid_item h;
347 	int maxid;
348 
349 	maxid = -1;
350 	h.report_ID = 0;
351 	for (d = hid_start_parse(buf, len, hid_none); hid_get_item(d, &h); )
352 		if (h.report_ID > maxid)
353 			maxid = h.report_ID;
354 	hid_end_parse(d);
355 	return (maxid);
356 }
357 
358 int
359 uhidevprint(void *aux, const char *pnp)
360 {
361 	struct uhidev_attach_arg *uha = aux;
362 
363 	if (pnp)
364 		printf("uhid at %s", pnp);
365 	if (uha->reportid != 0 && uha->reportid != UHIDEV_CLAIM_MULTIPLE_REPORTID)
366 		printf(" reportid %d", uha->reportid);
367 	return (UNCONF);
368 }
369 
370 int uhidevsubmatch(struct device *parent, void *match, void *aux)
371 {
372 	struct uhidev_attach_arg *uha = aux;
373         struct cfdata *cf = match;
374 
375 	if (cf->uhidevcf_reportid != UHIDEV_UNK_REPORTID &&
376 	    cf->uhidevcf_reportid != uha->reportid)
377 		return (0);
378 	return ((*cf->cf_attach->ca_match)(parent, cf, aux));
379 }
380 
381 int
382 uhidev_activate(struct device *self, int act)
383 {
384 	struct uhidev_softc *sc = (struct uhidev_softc *)self;
385 	int i, j, already, rv = 0, r;
386 
387 	switch (act) {
388 	case DVACT_DEACTIVATE:
389 		for (i = 0; i < sc->sc_nrepid; i++) {
390 			if (sc->sc_subdevs[i] == NULL)
391 				continue;
392 
393 			/*
394 			 * Only notify devices attached to multiple report ids
395 			 * once.
396 			 */
397 			for (already = 0, j = 0; j < i; j++) {
398 				if (sc->sc_subdevs[i] == sc->sc_subdevs[j]) {
399 					already = 1;
400 					break;
401 				}
402 			}
403 
404 			if (!already) {
405 				r = config_deactivate(
406 				    &sc->sc_subdevs[i]->sc_dev);
407 				if (r && r != EOPNOTSUPP)
408 					rv = r;
409 			}
410 		}
411 		usbd_deactivate(sc->sc_udev);
412 		break;
413 	}
414 	return (rv);
415 }
416 
417 int
418 uhidev_detach(struct device *self, int flags)
419 {
420 	struct uhidev_softc *sc = (struct uhidev_softc *)self;
421 	int i, j, rv = 0;
422 
423 	DPRINTF(("uhidev_detach: sc=%p flags=%d\n", sc, flags));
424 
425 	if (sc->sc_opipe != NULL) {
426 		usbd_close_pipe(sc->sc_opipe);
427 		sc->sc_opipe = NULL;
428 	}
429 
430 	if (sc->sc_ipipe != NULL) {
431 		usbd_close_pipe(sc->sc_ipipe);
432 		sc->sc_ipipe = NULL;
433 	}
434 
435 	if (sc->sc_repdesc != NULL)
436 		free(sc->sc_repdesc, M_USBDEV, sc->sc_repdesc_size);
437 
438 	for (i = 0; i < sc->sc_nrepid; i++) {
439 		if (sc->sc_subdevs[i] == NULL)
440 			continue;
441 
442 		rv |= config_detach(&sc->sc_subdevs[i]->sc_dev, flags);
443 
444 		/*
445 		 * Nullify without detaching any other instances of this device
446 		 * found on other report ids.
447 		 */
448 		for (j = i + 1; j < sc->sc_nrepid; j++) {
449 			if (sc->sc_subdevs[i] == sc->sc_subdevs[j])
450 				sc->sc_subdevs[j] = NULL;
451 		}
452 
453 		sc->sc_subdevs[i] = NULL;
454 	}
455 
456 	return (rv);
457 }
458 
459 void
460 uhidev_intr(struct usbd_xfer *xfer, void *addr, usbd_status status)
461 {
462 	struct uhidev_softc *sc = addr;
463 	struct uhidev *scd;
464 	u_char *p;
465 	u_int rep;
466 	u_int32_t cc;
467 
468 	if (usbd_is_dying(sc->sc_udev))
469 		return;
470 
471 	usbd_get_xfer_status(xfer, NULL, NULL, &cc, NULL);
472 
473 #ifdef UHIDEV_DEBUG
474 	if (uhidevdebug > 5) {
475 		u_int32_t i;
476 
477 		DPRINTF(("uhidev_intr: status=%d cc=%d\n", status, cc));
478 		DPRINTF(("uhidev_intr: data ="));
479 		for (i = 0; i < cc; i++)
480 			DPRINTF((" %02x", sc->sc_ibuf[i]));
481 		DPRINTF(("\n"));
482 	}
483 #endif
484 
485 	if (status == USBD_CANCELLED || status == USBD_IOERROR)
486 		return;
487 
488 	if (status != USBD_NORMAL_COMPLETION) {
489 		DPRINTF(("%s: interrupt status=%d\n", DEVNAME(sc), status));
490 		usbd_clear_endpoint_stall_async(sc->sc_ipipe);
491 		return;
492 	}
493 
494 	p = sc->sc_ibuf;
495 	if (sc->sc_nrepid != 1)
496 		rep = *p++, cc--;
497 	else
498 		rep = 0;
499 	if (rep >= sc->sc_nrepid) {
500 		printf("uhidev_intr: bad repid %d\n", rep);
501 		return;
502 	}
503 	scd = sc->sc_subdevs[rep];
504 	DPRINTFN(5,("uhidev_intr: rep=%d, scd=%p state=0x%x\n",
505 		    rep, scd, scd ? scd->sc_state : 0));
506 	if (scd == NULL || !(scd->sc_state & UHIDEV_OPEN))
507 		return;
508 
509 	scd->sc_intr(scd, p, cc);
510 }
511 
512 void
513 uhidev_get_report_desc(struct uhidev_softc *sc, void **desc, int *size)
514 {
515 	*desc = sc->sc_repdesc;
516 	*size = sc->sc_repdesc_size;
517 }
518 
519 int
520 uhidev_open(struct uhidev *scd)
521 {
522 	struct uhidev_softc *sc = scd->sc_parent;
523 	usbd_status err;
524 	int error;
525 
526 	DPRINTF(("uhidev_open: open pipe, state=%d refcnt=%d\n",
527 		 scd->sc_state, sc->sc_refcnt));
528 
529 	if (scd->sc_state & UHIDEV_OPEN)
530 		return (EBUSY);
531 	scd->sc_state |= UHIDEV_OPEN;
532 	if (sc->sc_refcnt++)
533 		return (0);
534 
535 	if (sc->sc_isize == 0)
536 		return (0);
537 
538 	sc->sc_ibuf = malloc(sc->sc_isize, M_USBDEV, M_WAITOK);
539 
540 	/* Set up input interrupt pipe. */
541 	DPRINTF(("uhidev_open: isize=%d, ep=0x%02x\n", sc->sc_isize,
542 	    sc->sc_iep_addr));
543 
544 	err = usbd_open_pipe_intr(sc->sc_iface, sc->sc_iep_addr,
545 		  USBD_SHORT_XFER_OK, &sc->sc_ipipe, sc, sc->sc_ibuf,
546 		  sc->sc_isize, uhidev_intr, USBD_DEFAULT_INTERVAL);
547 	if (err != USBD_NORMAL_COMPLETION) {
548 		DPRINTF(("uhidopen: usbd_open_pipe_intr failed, "
549 		    "error=%d\n", err));
550 		error = EIO;
551 		goto out1;
552 	}
553 
554 	DPRINTF(("uhidev_open: sc->sc_ipipe=%p\n", sc->sc_ipipe));
555 
556 	sc->sc_ixfer = usbd_alloc_xfer(sc->sc_udev);
557 	if (sc->sc_ixfer == NULL) {
558 		DPRINTF(("uhidev_open: couldn't allocate an xfer\n"));
559 		error = ENOMEM;
560 		goto out1; // xxxx
561 	}
562 
563 	/*
564 	 * Set up output interrupt pipe if an output interrupt endpoint
565 	 * exists.
566 	 */
567 	if (sc->sc_oep_addr != -1) {
568 		DPRINTF(("uhidev_open: oep=0x%02x\n", sc->sc_oep_addr));
569 
570 		err = usbd_open_pipe(sc->sc_iface, sc->sc_oep_addr,
571 		    0, &sc->sc_opipe);
572 		if (err != USBD_NORMAL_COMPLETION) {
573 			DPRINTF(("uhidev_open: usbd_open_pipe failed, "
574 			    "error=%d\n", err));
575 			error = EIO;
576 			goto out2;
577 		}
578 
579 		DPRINTF(("uhidev_open: sc->sc_opipe=%p\n", sc->sc_opipe));
580 
581 		sc->sc_oxfer = usbd_alloc_xfer(sc->sc_udev);
582 		if (sc->sc_oxfer == NULL) {
583 			DPRINTF(("uhidev_open: couldn't allocate an xfer\n"));
584 			error = ENOMEM;
585 			goto out3;
586 		}
587 
588 		sc->sc_owxfer = usbd_alloc_xfer(sc->sc_udev);
589 		if (sc->sc_owxfer == NULL) {
590 			DPRINTF(("uhidev_open: couldn't allocate owxfer\n"));
591 			error = ENOMEM;
592 			goto out3;
593 		}
594 	}
595 
596 	return (0);
597 
598 out3:
599 	/* Abort output pipe */
600 	usbd_close_pipe(sc->sc_opipe);
601 out2:
602 	/* Abort input pipe */
603 	usbd_close_pipe(sc->sc_ipipe);
604 out1:
605 	DPRINTF(("uhidev_open: failed in someway"));
606 	free(sc->sc_ibuf, M_USBDEV, sc->sc_isize);
607 	scd->sc_state &= ~UHIDEV_OPEN;
608 	sc->sc_refcnt = 0;
609 	sc->sc_ipipe = NULL;
610 	sc->sc_opipe = NULL;
611 	if (sc->sc_oxfer != NULL) {
612 		usbd_free_xfer(sc->sc_oxfer);
613 		sc->sc_oxfer = NULL;
614 	}
615 	if (sc->sc_owxfer != NULL) {
616 		usbd_free_xfer(sc->sc_owxfer);
617 		sc->sc_owxfer = NULL;
618 	}
619 	if (sc->sc_ixfer != NULL) {
620 		usbd_free_xfer(sc->sc_ixfer);
621 		sc->sc_ixfer = NULL;
622 	}
623 	return (error);
624 }
625 
626 void
627 uhidev_close(struct uhidev *scd)
628 {
629 	struct uhidev_softc *sc = scd->sc_parent;
630 
631 	if (!(scd->sc_state & UHIDEV_OPEN))
632 		return;
633 	scd->sc_state &= ~UHIDEV_OPEN;
634 	if (--sc->sc_refcnt)
635 		return;
636 	DPRINTF(("uhidev_close: close pipe\n"));
637 
638 	/* Disable interrupts. */
639 	if (sc->sc_opipe != NULL) {
640 		usbd_close_pipe(sc->sc_opipe);
641 		sc->sc_opipe = NULL;
642 	}
643 
644 	if (sc->sc_ipipe != NULL) {
645 		usbd_close_pipe(sc->sc_ipipe);
646 		sc->sc_ipipe = NULL;
647 	}
648 
649 	if (sc->sc_oxfer != NULL) {
650 		usbd_free_xfer(sc->sc_oxfer);
651 		sc->sc_oxfer = NULL;
652 	}
653 
654 	if (sc->sc_owxfer != NULL) {
655 		usbd_free_xfer(sc->sc_owxfer);
656 		sc->sc_owxfer = NULL;
657 	}
658 
659 	if (sc->sc_ixfer != NULL) {
660 		usbd_free_xfer(sc->sc_ixfer);
661 		sc->sc_ixfer = NULL;
662 	}
663 
664 	if (sc->sc_ibuf != NULL) {
665 		free(sc->sc_ibuf, M_USBDEV, sc->sc_isize);
666 		sc->sc_ibuf = NULL;
667 	}
668 }
669 
670 int
671 uhidev_report_type_conv(int hid_type_id)
672 {
673 	switch (hid_type_id) {
674 	case hid_input:
675 		return UHID_INPUT_REPORT;
676 	case hid_output:
677 		return UHID_OUTPUT_REPORT;
678 	case hid_feature:
679 		return UHID_FEATURE_REPORT;
680 	default:
681 		return -1;
682 	}
683 }
684 
685 int
686 uhidev_set_report(struct uhidev_softc *sc, int type, int id, void *data,
687     int len)
688 {
689 	usb_device_request_t req;
690 	char *buf = data;
691 	int actlen = len;
692 
693 	/* Prepend the reportID. */
694 	if (id > 0) {
695 		len++;
696 		buf = malloc(len, M_TEMP, M_WAITOK);
697 		buf[0] = id;
698 		memcpy(buf + 1, data, len - 1);
699 	}
700 
701 	if (sc->sc_opipe != NULL) {
702 		usbd_setup_xfer(sc->sc_owxfer, sc->sc_opipe, 0, buf, len,
703 		    USBD_SYNCHRONOUS | USBD_CATCH, 0, NULL);
704 		if (usbd_transfer(sc->sc_owxfer)) {
705 			usbd_clear_endpoint_stall(sc->sc_opipe);
706 			actlen = -1;
707 		}
708 	} else {
709 		req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
710 		req.bRequest = UR_SET_REPORT;
711 		USETW2(req.wValue, type, id);
712 		USETW(req.wIndex, sc->sc_ifaceno);
713 		USETW(req.wLength, len);
714 
715 		if (usbd_do_request(sc->sc_udev, &req, buf))
716 			actlen = -1;
717 	}
718 
719 	if (id > 0)
720 		free(buf, M_TEMP, len);
721 
722 	return (actlen);
723 }
724 
725 void
726 uhidev_set_report_async_cb(struct usbd_xfer *xfer, void *priv, usbd_status err)
727 {
728 	struct uhidev_softc *sc = priv;
729 
730 	if (err == USBD_STALLED)
731 		usbd_clear_endpoint_stall_async(sc->sc_opipe);
732 	usbd_free_xfer(xfer);
733 }
734 
735 int
736 uhidev_set_report_async(struct uhidev_softc *sc, int type, int id, void *data,
737     int len)
738 {
739 	struct usbd_xfer *xfer;
740 	usb_device_request_t req;
741 	int actlen = len;
742 	char *buf;
743 
744 	xfer = usbd_alloc_xfer(sc->sc_udev);
745 	if (xfer == NULL)
746 		return (-1);
747 
748 	if (id > 0)
749 		len++;
750 
751 	buf = usbd_alloc_buffer(xfer, len);
752 	if (buf == NULL) {
753 		usbd_free_xfer(xfer);
754 		return (-1);
755 	}
756 
757 	/* Prepend the reportID. */
758 	if (id > 0) {
759 		buf[0] = id;
760 		memcpy(buf + 1, data, len - 1);
761 	} else {
762 		memcpy(buf, data, len);
763 	}
764 
765 	if (sc->sc_opipe != NULL) {
766 		usbd_setup_xfer(xfer, sc->sc_opipe, sc, buf, len,
767 		    USBD_NO_COPY, USBD_DEFAULT_TIMEOUT,
768 		    uhidev_set_report_async_cb);
769 		if (usbd_transfer(xfer)) {
770 			usbd_clear_endpoint_stall_async(sc->sc_opipe);
771 			actlen = -1;
772 		}
773 	} else {
774 		req.bmRequestType = UT_WRITE_CLASS_INTERFACE;
775 		req.bRequest = UR_SET_REPORT;
776 		USETW2(req.wValue, type, id);
777 		USETW(req.wIndex, sc->sc_ifaceno);
778 		USETW(req.wLength, len);
779 		if (usbd_request_async(xfer, &req, NULL, NULL))
780 			actlen = -1;
781 	}
782 
783 	return (actlen);
784 }
785 
786 int
787 uhidev_get_report(struct uhidev_softc *sc, int type, int id, void *data,
788     int len)
789 {
790 	usb_device_request_t req;
791 	char *buf = data;
792 	usbd_status err;
793 	int actlen;
794 
795 	if (id > 0) {
796 		len++;
797 		buf = malloc(len, M_TEMP, M_WAITOK|M_ZERO);
798 	}
799 
800 	req.bmRequestType = UT_READ_CLASS_INTERFACE;
801 	req.bRequest = UR_GET_REPORT;
802 	USETW2(req.wValue, type, id);
803 	USETW(req.wIndex, sc->sc_ifaceno);
804 	USETW(req.wLength, len);
805 
806 	err = usbd_do_request_flags(sc->sc_udev, &req, buf, 0, &actlen,
807 	    USBD_DEFAULT_TIMEOUT);
808 	if (err != USBD_NORMAL_COMPLETION && err != USBD_SHORT_XFER)
809 		actlen = -1;
810 
811 	/* Skip the reportID. */
812 	if (id > 0) {
813 		memcpy(data, buf + 1, len - 1);
814 		free(buf, M_TEMP, len);
815 	}
816 
817 	return (actlen);
818 }
819 
820 void
821 uhidev_get_report_async_cb(struct usbd_xfer *xfer, void *priv, usbd_status err)
822 {
823 	struct uhidev_async_info *info = priv;
824 	char *buf;
825 	int len = -1;
826 
827 	if (!usbd_is_dying(xfer->pipe->device)) {
828 		if (err == USBD_NORMAL_COMPLETION || err == USBD_SHORT_XFER) {
829 			len = xfer->actlen;
830 			buf = KERNADDR(&xfer->dmabuf, 0);
831 			if (info->id > 0) {
832 				len--;
833 				memcpy(info->data, buf + 1, len);
834 			} else {
835 				memcpy(info->data, buf, len);
836 			}
837 		}
838 		info->callback(info->priv, info->id, info->data, len);
839 	}
840 	free(info, M_TEMP, sizeof(*info));
841 	usbd_free_xfer(xfer);
842 }
843 
844 int
845 uhidev_get_report_async(struct uhidev_softc *sc, int type, int id, void *data,
846     int len, void *priv, void (*callback)(void *, int, void *, int))
847 {
848 	struct usbd_xfer *xfer;
849 	usb_device_request_t req;
850 	struct uhidev_async_info *info;
851 	int actlen = len;
852 	char *buf;
853 
854 	xfer = usbd_alloc_xfer(sc->sc_udev);
855 	if (xfer == NULL)
856 		return (-1);
857 
858 	if (id > 0)
859 		len++;
860 
861 	buf = usbd_alloc_buffer(xfer, len);
862 	if (buf == NULL) {
863 		usbd_free_xfer(xfer);
864 		return (-1);
865 	}
866 
867 	info = malloc(sizeof(*info), M_TEMP, M_NOWAIT);
868 	if (info == NULL) {
869 		usbd_free_xfer(xfer);
870 		return (-1);
871 	}
872 
873 	info->callback = callback;
874 	info->priv = priv;
875 	info->data = data;
876 	info->id = id;
877 
878 	req.bmRequestType = UT_READ_CLASS_INTERFACE;
879 	req.bRequest = UR_GET_REPORT;
880 	USETW2(req.wValue, type, id);
881 	USETW(req.wIndex, sc->sc_ifaceno);
882 	USETW(req.wLength, len);
883 
884 	if (usbd_request_async(xfer, &req, info, uhidev_get_report_async_cb)) {
885 		free(info, M_TEMP, sizeof(*info));
886 		actlen = -1;
887 	}
888 
889 	return (actlen);
890 }
891 
892 usbd_status
893 uhidev_write(struct uhidev_softc *sc, void *data, int len)
894 {
895 	usbd_status error;
896 
897 	DPRINTF(("uhidev_write: data=%p, len=%d\n", data, len));
898 
899 	if (sc->sc_opipe == NULL)
900 		return USBD_INVAL;
901 
902 #ifdef UHIDEV_DEBUG
903 	if (uhidevdebug > 50) {
904 
905 		u_int32_t i;
906 		u_int8_t *d = data;
907 
908 		DPRINTF(("uhidev_write: data ="));
909 		for (i = 0; i < len; i++)
910 			DPRINTF((" %02x", d[i]));
911 		DPRINTF(("\n"));
912 	}
913 #endif
914 	usbd_setup_xfer(sc->sc_owxfer, sc->sc_opipe, 0, data, len,
915 	    USBD_SYNCHRONOUS | USBD_CATCH, 0, NULL);
916 	error = usbd_transfer(sc->sc_owxfer);
917 	if (error)
918 		usbd_clear_endpoint_stall(sc->sc_opipe);
919 
920 	return (error);
921 }
922 
923 int
924 uhidev_ioctl(struct uhidev *sc, u_long cmd, caddr_t addr, int flag,
925     struct proc *p)
926 {
927 	struct usb_ctl_report_desc *rd;
928 	struct usb_ctl_report *re;
929 	int size;
930 	void *desc;
931 
932 	switch (cmd) {
933 	case USB_GET_REPORT_DESC:
934 		uhidev_get_report_desc(sc->sc_parent, &desc, &size);
935 		rd = (struct usb_ctl_report_desc *)addr;
936 		size = min(size, sizeof rd->ucrd_data);
937 		rd->ucrd_size = size;
938 		memcpy(rd->ucrd_data, desc, size);
939 		break;
940 	case USB_GET_REPORT:
941 		re = (struct usb_ctl_report *)addr;
942 		switch (re->ucr_report) {
943 		case UHID_INPUT_REPORT:
944 			size = sc->sc_isize;
945 			break;
946 		case UHID_OUTPUT_REPORT:
947 			size = sc->sc_osize;
948 			break;
949 		case UHID_FEATURE_REPORT:
950 			size = sc->sc_fsize;
951 			break;
952 		default:
953 			return EINVAL;
954 		}
955 		if (uhidev_get_report(sc->sc_parent, re->ucr_report,
956 		    sc->sc_report_id, re->ucr_data, size) != size)
957 			return EIO;
958 		break;
959 	case USB_SET_REPORT:
960 		re = (struct usb_ctl_report *)addr;
961 		switch (re->ucr_report) {
962 		case UHID_INPUT_REPORT:
963 			size = sc->sc_isize;
964 			break;
965 		case UHID_OUTPUT_REPORT:
966 			size = sc->sc_osize;
967 			break;
968 		case UHID_FEATURE_REPORT:
969 			size = sc->sc_fsize;
970 			break;
971 		default:
972 			return EINVAL;
973 		}
974 		if (uhidev_set_report(sc->sc_parent, re->ucr_report,
975 		    sc->sc_report_id, re->ucr_data, size) != size)
976 			return EIO;
977 		break;
978 	case USB_GET_REPORT_ID:
979 		*(int *)addr = sc->sc_report_id;
980 		break;
981 	default:
982 		return -1;
983 	}
984 	return 0;
985 }
986 
987 int
988 uhidev_set_report_dev(struct uhidev_softc *sc, struct uhidev *dev, int repid)
989 {
990 	if ((dev->sc_state & UHIDEV_OPEN) == 0)
991 		return ENODEV;
992 	if (repid >= sc->sc_nrepid)
993 		return EINVAL;
994 
995 	sc->sc_subdevs[repid] = dev;
996 	return 0;
997 }
998