xref: /freebsd/sys/dev/usb/usb_generic.c (revision c6ec7d31830ab1c80edae95ad5e4b9dba10c47ac)
1 /* $FreeBSD$ */
2 /*-
3  * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  */
26 
27 #include <sys/stdint.h>
28 #include <sys/stddef.h>
29 #include <sys/param.h>
30 #include <sys/queue.h>
31 #include <sys/types.h>
32 #include <sys/systm.h>
33 #include <sys/kernel.h>
34 #include <sys/bus.h>
35 #include <sys/module.h>
36 #include <sys/lock.h>
37 #include <sys/mutex.h>
38 #include <sys/condvar.h>
39 #include <sys/sysctl.h>
40 #include <sys/sx.h>
41 #include <sys/unistd.h>
42 #include <sys/callout.h>
43 #include <sys/malloc.h>
44 #include <sys/priv.h>
45 #include <sys/conf.h>
46 #include <sys/fcntl.h>
47 
48 #include <dev/usb/usb.h>
49 #include <dev/usb/usb_ioctl.h>
50 #include <dev/usb/usbdi.h>
51 #include <dev/usb/usbdi_util.h>
52 
53 #define	USB_DEBUG_VAR ugen_debug
54 
55 #include <dev/usb/usb_core.h>
56 #include <dev/usb/usb_dev.h>
57 #include <dev/usb/usb_mbuf.h>
58 #include <dev/usb/usb_process.h>
59 #include <dev/usb/usb_device.h>
60 #include <dev/usb/usb_debug.h>
61 #include <dev/usb/usb_request.h>
62 #include <dev/usb/usb_busdma.h>
63 #include <dev/usb/usb_util.h>
64 #include <dev/usb/usb_hub.h>
65 #include <dev/usb/usb_generic.h>
66 #include <dev/usb/usb_transfer.h>
67 
68 #include <dev/usb/usb_controller.h>
69 #include <dev/usb/usb_bus.h>
70 
71 #if USB_HAVE_UGEN
72 
73 /* defines */
74 
75 #define	UGEN_BULK_FS_BUFFER_SIZE	(64*32)	/* bytes */
76 #define	UGEN_BULK_HS_BUFFER_SIZE	(1024*32)	/* bytes */
77 #define	UGEN_HW_FRAMES	50		/* number of milliseconds per transfer */
78 
79 /* function prototypes */
80 
81 static usb_callback_t ugen_read_clear_stall_callback;
82 static usb_callback_t ugen_write_clear_stall_callback;
83 static usb_callback_t ugen_ctrl_read_callback;
84 static usb_callback_t ugen_ctrl_write_callback;
85 static usb_callback_t ugen_isoc_read_callback;
86 static usb_callback_t ugen_isoc_write_callback;
87 static usb_callback_t ugen_ctrl_fs_callback;
88 
89 static usb_fifo_open_t ugen_open;
90 static usb_fifo_close_t ugen_close;
91 static usb_fifo_ioctl_t ugen_ioctl;
92 static usb_fifo_ioctl_t ugen_ioctl_post;
93 static usb_fifo_cmd_t ugen_start_read;
94 static usb_fifo_cmd_t ugen_start_write;
95 static usb_fifo_cmd_t ugen_stop_io;
96 
97 static int	ugen_transfer_setup(struct usb_fifo *,
98 		     const struct usb_config *, uint8_t);
99 static int	ugen_open_pipe_write(struct usb_fifo *);
100 static int	ugen_open_pipe_read(struct usb_fifo *);
101 static int	ugen_set_config(struct usb_fifo *, uint8_t);
102 static int	ugen_set_interface(struct usb_fifo *, uint8_t, uint8_t);
103 static int	ugen_get_cdesc(struct usb_fifo *, struct usb_gen_descriptor *);
104 static int	ugen_get_sdesc(struct usb_fifo *, struct usb_gen_descriptor *);
105 static int	ugen_get_iface_driver(struct usb_fifo *f, struct usb_gen_descriptor *ugd);
106 static int	usb_gen_fill_deviceinfo(struct usb_fifo *,
107 		    struct usb_device_info *);
108 static int	ugen_re_enumerate(struct usb_fifo *);
109 static int	ugen_iface_ioctl(struct usb_fifo *, u_long, void *, int);
110 static uint8_t	ugen_fs_get_complete(struct usb_fifo *, uint8_t *);
111 static int	ugen_fs_uninit(struct usb_fifo *f);
112 
113 /* structures */
114 
115 struct usb_fifo_methods usb_ugen_methods = {
116 	.f_open = &ugen_open,
117 	.f_close = &ugen_close,
118 	.f_ioctl = &ugen_ioctl,
119 	.f_ioctl_post = &ugen_ioctl_post,
120 	.f_start_read = &ugen_start_read,
121 	.f_stop_read = &ugen_stop_io,
122 	.f_start_write = &ugen_start_write,
123 	.f_stop_write = &ugen_stop_io,
124 };
125 
126 #ifdef USB_DEBUG
127 static int ugen_debug = 0;
128 
129 static SYSCTL_NODE(_hw_usb, OID_AUTO, ugen, CTLFLAG_RW, 0, "USB generic");
130 SYSCTL_INT(_hw_usb_ugen, OID_AUTO, debug, CTLFLAG_RW | CTLFLAG_TUN, &ugen_debug,
131     0, "Debug level");
132 TUNABLE_INT("hw.usb.ugen.debug", &ugen_debug);
133 #endif
134 
135 
136 /* prototypes */
137 
138 static int
139 ugen_transfer_setup(struct usb_fifo *f,
140     const struct usb_config *setup, uint8_t n_setup)
141 {
142 	struct usb_endpoint *ep = usb_fifo_softc(f);
143 	struct usb_device *udev = f->udev;
144 	uint8_t iface_index = ep->iface_index;
145 	int error;
146 
147 	mtx_unlock(f->priv_mtx);
148 
149 	/*
150 	 * "usbd_transfer_setup()" can sleep so one needs to make a wrapper,
151 	 * exiting the mutex and checking things
152 	 */
153 	error = usbd_transfer_setup(udev, &iface_index, f->xfer,
154 	    setup, n_setup, f, f->priv_mtx);
155 	if (error == 0) {
156 
157 		if (f->xfer[0]->nframes == 1) {
158 			error = usb_fifo_alloc_buffer(f,
159 			    f->xfer[0]->max_data_length, 2);
160 		} else {
161 			error = usb_fifo_alloc_buffer(f,
162 			    f->xfer[0]->max_frame_size,
163 			    2 * f->xfer[0]->nframes);
164 		}
165 		if (error) {
166 			usbd_transfer_unsetup(f->xfer, n_setup);
167 		}
168 	}
169 	mtx_lock(f->priv_mtx);
170 
171 	return (error);
172 }
173 
174 static int
175 ugen_open(struct usb_fifo *f, int fflags)
176 {
177 	struct usb_endpoint *ep = usb_fifo_softc(f);
178 	struct usb_endpoint_descriptor *ed = ep->edesc;
179 	uint8_t type;
180 
181 	DPRINTFN(6, "flag=0x%x\n", fflags);
182 
183 	mtx_lock(f->priv_mtx);
184 	switch (usbd_get_speed(f->udev)) {
185 	case USB_SPEED_LOW:
186 	case USB_SPEED_FULL:
187 		f->nframes = UGEN_HW_FRAMES;
188 		f->bufsize = UGEN_BULK_FS_BUFFER_SIZE;
189 		break;
190 	default:
191 		f->nframes = UGEN_HW_FRAMES * 8;
192 		f->bufsize = UGEN_BULK_HS_BUFFER_SIZE;
193 		break;
194 	}
195 
196 	type = ed->bmAttributes & UE_XFERTYPE;
197 	if (type == UE_INTERRUPT) {
198 		f->bufsize = 0;		/* use "wMaxPacketSize" */
199 	}
200 	f->timeout = USB_NO_TIMEOUT;
201 	f->flag_short = 0;
202 	f->fifo_zlp = 0;
203 	mtx_unlock(f->priv_mtx);
204 
205 	return (0);
206 }
207 
208 static void
209 ugen_close(struct usb_fifo *f, int fflags)
210 {
211 	DPRINTFN(6, "flag=0x%x\n", fflags);
212 
213 	/* cleanup */
214 
215 	mtx_lock(f->priv_mtx);
216 	usbd_transfer_stop(f->xfer[0]);
217 	usbd_transfer_stop(f->xfer[1]);
218 	mtx_unlock(f->priv_mtx);
219 
220 	usbd_transfer_unsetup(f->xfer, 2);
221 	usb_fifo_free_buffer(f);
222 
223 	if (ugen_fs_uninit(f)) {
224 		/* ignore any errors - we are closing */
225 		DPRINTFN(6, "no FIFOs\n");
226 	}
227 }
228 
229 static int
230 ugen_open_pipe_write(struct usb_fifo *f)
231 {
232 	struct usb_config usb_config[2];
233 	struct usb_endpoint *ep = usb_fifo_softc(f);
234 	struct usb_endpoint_descriptor *ed = ep->edesc;
235 
236 	mtx_assert(f->priv_mtx, MA_OWNED);
237 
238 	if (f->xfer[0] || f->xfer[1]) {
239 		/* transfers are already opened */
240 		return (0);
241 	}
242 	memset(usb_config, 0, sizeof(usb_config));
243 
244 	usb_config[1].type = UE_CONTROL;
245 	usb_config[1].endpoint = 0;
246 	usb_config[1].direction = UE_DIR_ANY;
247 	usb_config[1].timeout = 1000;	/* 1 second */
248 	usb_config[1].interval = 50;/* 50 milliseconds */
249 	usb_config[1].bufsize = sizeof(struct usb_device_request);
250 	usb_config[1].callback = &ugen_write_clear_stall_callback;
251 	usb_config[1].usb_mode = USB_MODE_HOST;
252 
253 	usb_config[0].type = ed->bmAttributes & UE_XFERTYPE;
254 	usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR;
255 	usb_config[0].stream_id = 0;	/* XXX support more stream ID's */
256 	usb_config[0].direction = UE_DIR_TX;
257 	usb_config[0].interval = USB_DEFAULT_INTERVAL;
258 	usb_config[0].flags.proxy_buffer = 1;
259 	usb_config[0].usb_mode = USB_MODE_DUAL;	/* both modes */
260 
261 	switch (ed->bmAttributes & UE_XFERTYPE) {
262 	case UE_INTERRUPT:
263 	case UE_BULK:
264 		if (f->flag_short) {
265 			usb_config[0].flags.force_short_xfer = 1;
266 		}
267 		usb_config[0].callback = &ugen_ctrl_write_callback;
268 		usb_config[0].timeout = f->timeout;
269 		usb_config[0].frames = 1;
270 		usb_config[0].bufsize = f->bufsize;
271 		if (ugen_transfer_setup(f, usb_config, 2)) {
272 			return (EIO);
273 		}
274 		/* first transfer does not clear stall */
275 		f->flag_stall = 0;
276 		break;
277 
278 	case UE_ISOCHRONOUS:
279 		usb_config[0].flags.short_xfer_ok = 1;
280 		usb_config[0].bufsize = 0;	/* use default */
281 		usb_config[0].frames = f->nframes;
282 		usb_config[0].callback = &ugen_isoc_write_callback;
283 		usb_config[0].timeout = 0;
284 
285 		/* clone configuration */
286 		usb_config[1] = usb_config[0];
287 
288 		if (ugen_transfer_setup(f, usb_config, 2)) {
289 			return (EIO);
290 		}
291 		break;
292 	default:
293 		return (EINVAL);
294 	}
295 	return (0);
296 }
297 
298 static int
299 ugen_open_pipe_read(struct usb_fifo *f)
300 {
301 	struct usb_config usb_config[2];
302 	struct usb_endpoint *ep = usb_fifo_softc(f);
303 	struct usb_endpoint_descriptor *ed = ep->edesc;
304 
305 	mtx_assert(f->priv_mtx, MA_OWNED);
306 
307 	if (f->xfer[0] || f->xfer[1]) {
308 		/* transfers are already opened */
309 		return (0);
310 	}
311 	memset(usb_config, 0, sizeof(usb_config));
312 
313 	usb_config[1].type = UE_CONTROL;
314 	usb_config[1].endpoint = 0;
315 	usb_config[1].direction = UE_DIR_ANY;
316 	usb_config[1].timeout = 1000;	/* 1 second */
317 	usb_config[1].interval = 50;/* 50 milliseconds */
318 	usb_config[1].bufsize = sizeof(struct usb_device_request);
319 	usb_config[1].callback = &ugen_read_clear_stall_callback;
320 	usb_config[1].usb_mode = USB_MODE_HOST;
321 
322 	usb_config[0].type = ed->bmAttributes & UE_XFERTYPE;
323 	usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR;
324 	usb_config[0].stream_id = 0;	/* XXX support more stream ID's */
325 	usb_config[0].direction = UE_DIR_RX;
326 	usb_config[0].interval = USB_DEFAULT_INTERVAL;
327 	usb_config[0].flags.proxy_buffer = 1;
328 	usb_config[0].usb_mode = USB_MODE_DUAL;	/* both modes */
329 
330 	switch (ed->bmAttributes & UE_XFERTYPE) {
331 	case UE_INTERRUPT:
332 	case UE_BULK:
333 		if (f->flag_short) {
334 			usb_config[0].flags.short_xfer_ok = 1;
335 		}
336 		usb_config[0].timeout = f->timeout;
337 		usb_config[0].frames = 1;
338 		usb_config[0].callback = &ugen_ctrl_read_callback;
339 		usb_config[0].bufsize = f->bufsize;
340 
341 		if (ugen_transfer_setup(f, usb_config, 2)) {
342 			return (EIO);
343 		}
344 		/* first transfer does not clear stall */
345 		f->flag_stall = 0;
346 		break;
347 
348 	case UE_ISOCHRONOUS:
349 		usb_config[0].flags.short_xfer_ok = 1;
350 		usb_config[0].bufsize = 0;	/* use default */
351 		usb_config[0].frames = f->nframes;
352 		usb_config[0].callback = &ugen_isoc_read_callback;
353 		usb_config[0].timeout = 0;
354 
355 		/* clone configuration */
356 		usb_config[1] = usb_config[0];
357 
358 		if (ugen_transfer_setup(f, usb_config, 2)) {
359 			return (EIO);
360 		}
361 		break;
362 
363 	default:
364 		return (EINVAL);
365 	}
366 	return (0);
367 }
368 
369 static void
370 ugen_start_read(struct usb_fifo *f)
371 {
372 	/* check that pipes are open */
373 	if (ugen_open_pipe_read(f)) {
374 		/* signal error */
375 		usb_fifo_put_data_error(f);
376 	}
377 	/* start transfers */
378 	usbd_transfer_start(f->xfer[0]);
379 	usbd_transfer_start(f->xfer[1]);
380 }
381 
382 static void
383 ugen_start_write(struct usb_fifo *f)
384 {
385 	/* check that pipes are open */
386 	if (ugen_open_pipe_write(f)) {
387 		/* signal error */
388 		usb_fifo_get_data_error(f);
389 	}
390 	/* start transfers */
391 	usbd_transfer_start(f->xfer[0]);
392 	usbd_transfer_start(f->xfer[1]);
393 }
394 
395 static void
396 ugen_stop_io(struct usb_fifo *f)
397 {
398 	/* stop transfers */
399 	usbd_transfer_stop(f->xfer[0]);
400 	usbd_transfer_stop(f->xfer[1]);
401 }
402 
403 static void
404 ugen_ctrl_read_callback(struct usb_xfer *xfer, usb_error_t error)
405 {
406 	struct usb_fifo *f = usbd_xfer_softc(xfer);
407 	struct usb_mbuf *m;
408 
409 	DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
410 
411 	switch (USB_GET_STATE(xfer)) {
412 	case USB_ST_TRANSFERRED:
413 		if (xfer->actlen == 0) {
414 			if (f->fifo_zlp != 4) {
415 				f->fifo_zlp++;
416 			} else {
417 				/*
418 				 * Throttle a little bit we have multiple ZLPs
419 				 * in a row!
420 				 */
421 				xfer->interval = 64;	/* ms */
422 			}
423 		} else {
424 			/* clear throttle */
425 			xfer->interval = 0;
426 			f->fifo_zlp = 0;
427 		}
428 		usb_fifo_put_data(f, xfer->frbuffers, 0,
429 		    xfer->actlen, 1);
430 
431 	case USB_ST_SETUP:
432 		if (f->flag_stall) {
433 			usbd_transfer_start(f->xfer[1]);
434 			break;
435 		}
436 		USB_IF_POLL(&f->free_q, m);
437 		if (m) {
438 			usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
439 			usbd_transfer_submit(xfer);
440 		}
441 		break;
442 
443 	default:			/* Error */
444 		if (xfer->error != USB_ERR_CANCELLED) {
445 			/* send a zero length packet to userland */
446 			usb_fifo_put_data(f, xfer->frbuffers, 0, 0, 1);
447 			f->flag_stall = 1;
448 			f->fifo_zlp = 0;
449 			usbd_transfer_start(f->xfer[1]);
450 		}
451 		break;
452 	}
453 }
454 
455 static void
456 ugen_ctrl_write_callback(struct usb_xfer *xfer, usb_error_t error)
457 {
458 	struct usb_fifo *f = usbd_xfer_softc(xfer);
459 	usb_frlength_t actlen;
460 
461 	DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
462 
463 	switch (USB_GET_STATE(xfer)) {
464 	case USB_ST_SETUP:
465 	case USB_ST_TRANSFERRED:
466 		/*
467 		 * If writing is in stall, just jump to clear stall
468 		 * callback and solve the situation.
469 		 */
470 		if (f->flag_stall) {
471 			usbd_transfer_start(f->xfer[1]);
472 			break;
473 		}
474 		/*
475 		 * Write data, setup and perform hardware transfer.
476 		 */
477 		if (usb_fifo_get_data(f, xfer->frbuffers, 0,
478 		    xfer->max_data_length, &actlen, 0)) {
479 			usbd_xfer_set_frame_len(xfer, 0, actlen);
480 			usbd_transfer_submit(xfer);
481 		}
482 		break;
483 
484 	default:			/* Error */
485 		if (xfer->error != USB_ERR_CANCELLED) {
486 			f->flag_stall = 1;
487 			usbd_transfer_start(f->xfer[1]);
488 		}
489 		break;
490 	}
491 }
492 
493 static void
494 ugen_read_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error)
495 {
496 	struct usb_fifo *f = usbd_xfer_softc(xfer);
497 	struct usb_xfer *xfer_other = f->xfer[0];
498 
499 	if (f->flag_stall == 0) {
500 		/* nothing to do */
501 		return;
502 	}
503 	if (usbd_clear_stall_callback(xfer, xfer_other)) {
504 		DPRINTFN(5, "f=%p: stall cleared\n", f);
505 		f->flag_stall = 0;
506 		usbd_transfer_start(xfer_other);
507 	}
508 }
509 
510 static void
511 ugen_write_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error)
512 {
513 	struct usb_fifo *f = usbd_xfer_softc(xfer);
514 	struct usb_xfer *xfer_other = f->xfer[0];
515 
516 	if (f->flag_stall == 0) {
517 		/* nothing to do */
518 		return;
519 	}
520 	if (usbd_clear_stall_callback(xfer, xfer_other)) {
521 		DPRINTFN(5, "f=%p: stall cleared\n", f);
522 		f->flag_stall = 0;
523 		usbd_transfer_start(xfer_other);
524 	}
525 }
526 
527 static void
528 ugen_isoc_read_callback(struct usb_xfer *xfer, usb_error_t error)
529 {
530 	struct usb_fifo *f = usbd_xfer_softc(xfer);
531 	usb_frlength_t offset;
532 	usb_frcount_t n;
533 
534 	DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
535 
536 	switch (USB_GET_STATE(xfer)) {
537 	case USB_ST_TRANSFERRED:
538 
539 		DPRINTFN(6, "actlen=%d\n", xfer->actlen);
540 
541 		offset = 0;
542 
543 		for (n = 0; n != xfer->aframes; n++) {
544 			usb_fifo_put_data(f, xfer->frbuffers, offset,
545 			    xfer->frlengths[n], 1);
546 			offset += xfer->max_frame_size;
547 		}
548 
549 	case USB_ST_SETUP:
550 tr_setup:
551 		for (n = 0; n != xfer->nframes; n++) {
552 			/* setup size for next transfer */
553 			usbd_xfer_set_frame_len(xfer, n, xfer->max_frame_size);
554 		}
555 		usbd_transfer_submit(xfer);
556 		break;
557 
558 	default:			/* Error */
559 		if (xfer->error == USB_ERR_CANCELLED) {
560 			break;
561 		}
562 		goto tr_setup;
563 	}
564 }
565 
566 static void
567 ugen_isoc_write_callback(struct usb_xfer *xfer, usb_error_t error)
568 {
569 	struct usb_fifo *f = usbd_xfer_softc(xfer);
570 	usb_frlength_t actlen;
571 	usb_frlength_t offset;
572 	usb_frcount_t n;
573 
574 	DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
575 
576 	switch (USB_GET_STATE(xfer)) {
577 	case USB_ST_TRANSFERRED:
578 	case USB_ST_SETUP:
579 tr_setup:
580 		offset = 0;
581 		for (n = 0; n != xfer->nframes; n++) {
582 			if (usb_fifo_get_data(f, xfer->frbuffers, offset,
583 			    xfer->max_frame_size, &actlen, 1)) {
584 				usbd_xfer_set_frame_len(xfer, n, actlen);
585 				offset += actlen;
586 			} else {
587 				break;
588 			}
589 		}
590 
591 		for (; n != xfer->nframes; n++) {
592 			/* fill in zero frames */
593 			usbd_xfer_set_frame_len(xfer, n, 0);
594 		}
595 		usbd_transfer_submit(xfer);
596 		break;
597 
598 	default:			/* Error */
599 		if (xfer->error == USB_ERR_CANCELLED) {
600 			break;
601 		}
602 		goto tr_setup;
603 	}
604 }
605 
606 static int
607 ugen_set_config(struct usb_fifo *f, uint8_t index)
608 {
609 	DPRINTFN(2, "index %u\n", index);
610 
611 	if (f->udev->flags.usb_mode != USB_MODE_HOST) {
612 		/* not possible in device side mode */
613 		return (ENOTTY);
614 	}
615 	if (f->udev->curr_config_index == index) {
616 		/* no change needed */
617 		return (0);
618 	}
619 	/* make sure all FIFO's are gone */
620 	/* else there can be a deadlock */
621 	if (ugen_fs_uninit(f)) {
622 		/* ignore any errors */
623 		DPRINTFN(6, "no FIFOs\n");
624 	}
625 	/* change setting - will free generic FIFOs, if any */
626 	if (usbd_set_config_index(f->udev, index)) {
627 		return (EIO);
628 	}
629 	/* probe and attach */
630 	if (usb_probe_and_attach(f->udev, USB_IFACE_INDEX_ANY)) {
631 		return (EIO);
632 	}
633 	return (0);
634 }
635 
636 static int
637 ugen_set_interface(struct usb_fifo *f,
638     uint8_t iface_index, uint8_t alt_index)
639 {
640 	DPRINTFN(2, "%u, %u\n", iface_index, alt_index);
641 
642 	if (f->udev->flags.usb_mode != USB_MODE_HOST) {
643 		/* not possible in device side mode */
644 		return (ENOTTY);
645 	}
646 	/* make sure all FIFO's are gone */
647 	/* else there can be a deadlock */
648 	if (ugen_fs_uninit(f)) {
649 		/* ignore any errors */
650 		DPRINTFN(6, "no FIFOs\n");
651 	}
652 	/* change setting - will free generic FIFOs, if any */
653 	if (usbd_set_alt_interface_index(f->udev, iface_index, alt_index)) {
654 		return (EIO);
655 	}
656 	/* probe and attach */
657 	if (usb_probe_and_attach(f->udev, iface_index)) {
658 		return (EIO);
659 	}
660 	return (0);
661 }
662 
663 /*------------------------------------------------------------------------*
664  *	ugen_get_cdesc
665  *
666  * This function will retrieve the complete configuration descriptor
667  * at the given index.
668  *------------------------------------------------------------------------*/
669 static int
670 ugen_get_cdesc(struct usb_fifo *f, struct usb_gen_descriptor *ugd)
671 {
672 	struct usb_config_descriptor *cdesc;
673 	struct usb_device *udev = f->udev;
674 	int error;
675 	uint16_t len;
676 	uint8_t free_data;
677 
678 	DPRINTFN(6, "\n");
679 
680 	if (ugd->ugd_data == NULL) {
681 		/* userland pointer should not be zero */
682 		return (EINVAL);
683 	}
684 	if ((ugd->ugd_config_index == USB_UNCONFIG_INDEX) ||
685 	    (ugd->ugd_config_index == udev->curr_config_index)) {
686 		cdesc = usbd_get_config_descriptor(udev);
687 		if (cdesc == NULL) {
688 			return (ENXIO);
689 		}
690 		free_data = 0;
691 
692 	} else {
693 		if (usbd_req_get_config_desc_full(udev,
694 		    NULL, &cdesc, M_USBDEV,
695 		    ugd->ugd_config_index)) {
696 			return (ENXIO);
697 		}
698 		free_data = 1;
699 	}
700 
701 	len = UGETW(cdesc->wTotalLength);
702 	if (len > ugd->ugd_maxlen) {
703 		len = ugd->ugd_maxlen;
704 	}
705 	DPRINTFN(6, "len=%u\n", len);
706 
707 	ugd->ugd_actlen = len;
708 	ugd->ugd_offset = 0;
709 
710 	error = copyout(cdesc, ugd->ugd_data, len);
711 
712 	if (free_data) {
713 		free(cdesc, M_USBDEV);
714 	}
715 	return (error);
716 }
717 
718 static int
719 ugen_get_sdesc(struct usb_fifo *f, struct usb_gen_descriptor *ugd)
720 {
721 	void *ptr = f->udev->bus->scratch[0].data;
722 	uint16_t size = sizeof(f->udev->bus->scratch[0].data);
723 	int error;
724 
725 	if (usbd_req_get_string_desc(f->udev, NULL, ptr,
726 	    size, ugd->ugd_lang_id, ugd->ugd_string_index)) {
727 		error = EINVAL;
728 	} else {
729 
730 		if (size > ((uint8_t *)ptr)[0]) {
731 			size = ((uint8_t *)ptr)[0];
732 		}
733 		if (size > ugd->ugd_maxlen) {
734 			size = ugd->ugd_maxlen;
735 		}
736 		ugd->ugd_actlen = size;
737 		ugd->ugd_offset = 0;
738 
739 		error = copyout(ptr, ugd->ugd_data, size);
740 	}
741 	return (error);
742 }
743 
744 /*------------------------------------------------------------------------*
745  *	ugen_get_iface_driver
746  *
747  * This function generates an USB interface description for userland.
748  *
749  * Returns:
750  *    0: Success
751  * Else: Failure
752  *------------------------------------------------------------------------*/
753 static int
754 ugen_get_iface_driver(struct usb_fifo *f, struct usb_gen_descriptor *ugd)
755 {
756 	struct usb_device *udev = f->udev;
757 	struct usb_interface *iface;
758 	const char *ptr;
759 	const char *desc;
760 	unsigned int len;
761 	unsigned int maxlen;
762 	char buf[128];
763 	int error;
764 
765 	DPRINTFN(6, "\n");
766 
767 	if ((ugd->ugd_data == NULL) || (ugd->ugd_maxlen == 0)) {
768 		/* userland pointer should not be zero */
769 		return (EINVAL);
770 	}
771 
772 	iface = usbd_get_iface(udev, ugd->ugd_iface_index);
773 	if ((iface == NULL) || (iface->idesc == NULL)) {
774 		/* invalid interface index */
775 		return (EINVAL);
776 	}
777 
778 	/* read out device nameunit string, if any */
779 	if ((iface->subdev != NULL) &&
780 	    device_is_attached(iface->subdev) &&
781 	    (ptr = device_get_nameunit(iface->subdev)) &&
782 	    (desc = device_get_desc(iface->subdev))) {
783 
784 		/* print description */
785 		snprintf(buf, sizeof(buf), "%s: <%s>", ptr, desc);
786 
787 		/* range checks */
788 		maxlen = ugd->ugd_maxlen - 1;
789 		len = strlen(buf);
790 		if (len > maxlen)
791 			len = maxlen;
792 
793 		/* update actual length, including terminating zero */
794 		ugd->ugd_actlen = len + 1;
795 
796 		/* copy out interface description */
797 		error = copyout(buf, ugd->ugd_data, ugd->ugd_actlen);
798 	} else {
799 		/* zero length string is default */
800 		error = copyout("", ugd->ugd_data, 1);
801 	}
802 	return (error);
803 }
804 
805 /*------------------------------------------------------------------------*
806  *	usb_gen_fill_deviceinfo
807  *
808  * This function dumps information about an USB device to the
809  * structure pointed to by the "di" argument.
810  *
811  * Returns:
812  *    0: Success
813  * Else: Failure
814  *------------------------------------------------------------------------*/
815 static int
816 usb_gen_fill_deviceinfo(struct usb_fifo *f, struct usb_device_info *di)
817 {
818 	struct usb_device *udev;
819 	struct usb_device *hub;
820 
821 	udev = f->udev;
822 
823 	bzero(di, sizeof(di[0]));
824 
825 	di->udi_bus = device_get_unit(udev->bus->bdev);
826 	di->udi_addr = udev->address;
827 	di->udi_index = udev->device_index;
828 	strlcpy(di->udi_serial, usb_get_serial(udev), sizeof(di->udi_serial));
829 	strlcpy(di->udi_vendor, usb_get_manufacturer(udev), sizeof(di->udi_vendor));
830 	strlcpy(di->udi_product, usb_get_product(udev), sizeof(di->udi_product));
831 	usb_printbcd(di->udi_release, sizeof(di->udi_release),
832 	    UGETW(udev->ddesc.bcdDevice));
833 	di->udi_vendorNo = UGETW(udev->ddesc.idVendor);
834 	di->udi_productNo = UGETW(udev->ddesc.idProduct);
835 	di->udi_releaseNo = UGETW(udev->ddesc.bcdDevice);
836 	di->udi_class = udev->ddesc.bDeviceClass;
837 	di->udi_subclass = udev->ddesc.bDeviceSubClass;
838 	di->udi_protocol = udev->ddesc.bDeviceProtocol;
839 	di->udi_config_no = udev->curr_config_no;
840 	di->udi_config_index = udev->curr_config_index;
841 	di->udi_power = udev->flags.self_powered ? 0 : udev->power;
842 	di->udi_speed = udev->speed;
843 	di->udi_mode = udev->flags.usb_mode;
844 	di->udi_power_mode = udev->power_mode;
845 	di->udi_suspended = udev->flags.peer_suspended;
846 
847 	hub = udev->parent_hub;
848 	if (hub) {
849 		di->udi_hubaddr = hub->address;
850 		di->udi_hubindex = hub->device_index;
851 		di->udi_hubport = udev->port_no;
852 	}
853 	return (0);
854 }
855 
856 /*------------------------------------------------------------------------*
857  *	ugen_check_request
858  *
859  * Return values:
860  * 0: Access allowed
861  * Else: No access
862  *------------------------------------------------------------------------*/
863 static int
864 ugen_check_request(struct usb_device *udev, struct usb_device_request *req)
865 {
866 	struct usb_endpoint *ep;
867 	int error;
868 
869 	/*
870 	 * Avoid requests that would damage the bus integrity:
871 	 */
872 	if (((req->bmRequestType == UT_WRITE_DEVICE) &&
873 	    (req->bRequest == UR_SET_ADDRESS)) ||
874 	    ((req->bmRequestType == UT_WRITE_DEVICE) &&
875 	    (req->bRequest == UR_SET_CONFIG)) ||
876 	    ((req->bmRequestType == UT_WRITE_INTERFACE) &&
877 	    (req->bRequest == UR_SET_INTERFACE))) {
878 		/*
879 		 * These requests can be useful for testing USB drivers.
880 		 */
881 		error = priv_check(curthread, PRIV_DRIVER);
882 		if (error) {
883 			return (error);
884 		}
885 	}
886 	/*
887 	 * Special case - handle clearing of stall
888 	 */
889 	if (req->bmRequestType == UT_WRITE_ENDPOINT) {
890 
891 		ep = usbd_get_ep_by_addr(udev, req->wIndex[0]);
892 		if (ep == NULL) {
893 			return (EINVAL);
894 		}
895 		if ((req->bRequest == UR_CLEAR_FEATURE) &&
896 		    (UGETW(req->wValue) == UF_ENDPOINT_HALT)) {
897 			usbd_clear_data_toggle(udev, ep);
898 		}
899 	}
900 	/* TODO: add more checks to verify the interface index */
901 
902 	return (0);
903 }
904 
905 int
906 ugen_do_request(struct usb_fifo *f, struct usb_ctl_request *ur)
907 {
908 	int error;
909 	uint16_t len;
910 	uint16_t actlen;
911 
912 	if (ugen_check_request(f->udev, &ur->ucr_request)) {
913 		return (EPERM);
914 	}
915 	len = UGETW(ur->ucr_request.wLength);
916 
917 	/* check if "ucr_data" is valid */
918 	if (len != 0) {
919 		if (ur->ucr_data == NULL) {
920 			return (EFAULT);
921 		}
922 	}
923 	/* do the USB request */
924 	error = usbd_do_request_flags
925 	    (f->udev, NULL, &ur->ucr_request, ur->ucr_data,
926 	    (ur->ucr_flags & USB_SHORT_XFER_OK) |
927 	    USB_USER_DATA_PTR, &actlen,
928 	    USB_DEFAULT_TIMEOUT);
929 
930 	ur->ucr_actlen = actlen;
931 
932 	if (error) {
933 		error = EIO;
934 	}
935 	return (error);
936 }
937 
938 /*------------------------------------------------------------------------
939  *	ugen_re_enumerate
940  *------------------------------------------------------------------------*/
941 static int
942 ugen_re_enumerate(struct usb_fifo *f)
943 {
944 	struct usb_device *udev = f->udev;
945 	int error;
946 
947 	/*
948 	 * This request can be useful for testing USB drivers:
949 	 */
950 	error = priv_check(curthread, PRIV_DRIVER);
951 	if (error) {
952 		return (error);
953 	}
954 	if (udev->flags.usb_mode != USB_MODE_HOST) {
955 		/* not possible in device side mode */
956 		DPRINTFN(6, "device mode\n");
957 		return (ENOTTY);
958 	}
959 	if (udev->parent_hub == NULL) {
960 		/* the root HUB cannot be re-enumerated */
961 		DPRINTFN(6, "cannot reset root HUB\n");
962 		return (EINVAL);
963 	}
964 	/* make sure all FIFO's are gone */
965 	/* else there can be a deadlock */
966 	if (ugen_fs_uninit(f)) {
967 		/* ignore any errors */
968 		DPRINTFN(6, "no FIFOs\n");
969 	}
970 	/* start re-enumeration of device */
971 	usbd_start_re_enumerate(udev);
972 	return (0);
973 }
974 
975 int
976 ugen_fs_uninit(struct usb_fifo *f)
977 {
978 	if (f->fs_xfer == NULL) {
979 		return (EINVAL);
980 	}
981 	usbd_transfer_unsetup(f->fs_xfer, f->fs_ep_max);
982 	free(f->fs_xfer, M_USB);
983 	f->fs_xfer = NULL;
984 	f->fs_ep_max = 0;
985 	f->fs_ep_ptr = NULL;
986 	f->flag_iscomplete = 0;
987 	usb_fifo_free_buffer(f);
988 	return (0);
989 }
990 
991 static uint8_t
992 ugen_fs_get_complete(struct usb_fifo *f, uint8_t *pindex)
993 {
994 	struct usb_mbuf *m;
995 
996 	USB_IF_DEQUEUE(&f->used_q, m);
997 
998 	if (m) {
999 		*pindex = *((uint8_t *)(m->cur_data_ptr));
1000 
1001 		USB_IF_ENQUEUE(&f->free_q, m);
1002 
1003 		return (0);		/* success */
1004 	} else {
1005 
1006 		*pindex = 0;		/* fix compiler warning */
1007 
1008 		f->flag_iscomplete = 0;
1009 	}
1010 	return (1);			/* failure */
1011 }
1012 
1013 static void
1014 ugen_fs_set_complete(struct usb_fifo *f, uint8_t index)
1015 {
1016 	struct usb_mbuf *m;
1017 
1018 	USB_IF_DEQUEUE(&f->free_q, m);
1019 
1020 	if (m == NULL) {
1021 		/* can happen during close */
1022 		DPRINTF("out of buffers\n");
1023 		return;
1024 	}
1025 	USB_MBUF_RESET(m);
1026 
1027 	*((uint8_t *)(m->cur_data_ptr)) = index;
1028 
1029 	USB_IF_ENQUEUE(&f->used_q, m);
1030 
1031 	f->flag_iscomplete = 1;
1032 
1033 	usb_fifo_wakeup(f);
1034 }
1035 
1036 static int
1037 ugen_fs_copy_in(struct usb_fifo *f, uint8_t ep_index)
1038 {
1039 	struct usb_device_request *req;
1040 	struct usb_xfer *xfer;
1041 	struct usb_fs_endpoint fs_ep;
1042 	void *uaddr;			/* userland pointer */
1043 	void *kaddr;
1044 	usb_frlength_t offset;
1045 	usb_frlength_t rem;
1046 	usb_frcount_t n;
1047 	uint32_t length;
1048 	int error;
1049 	uint8_t isread;
1050 
1051 	if (ep_index >= f->fs_ep_max) {
1052 		return (EINVAL);
1053 	}
1054 	xfer = f->fs_xfer[ep_index];
1055 	if (xfer == NULL) {
1056 		return (EINVAL);
1057 	}
1058 	mtx_lock(f->priv_mtx);
1059 	if (usbd_transfer_pending(xfer)) {
1060 		mtx_unlock(f->priv_mtx);
1061 		return (EBUSY);		/* should not happen */
1062 	}
1063 	mtx_unlock(f->priv_mtx);
1064 
1065 	error = copyin(f->fs_ep_ptr +
1066 	    ep_index, &fs_ep, sizeof(fs_ep));
1067 	if (error) {
1068 		return (error);
1069 	}
1070 	/* security checks */
1071 
1072 	if (fs_ep.nFrames > xfer->max_frame_count) {
1073 		xfer->error = USB_ERR_INVAL;
1074 		goto complete;
1075 	}
1076 	if (fs_ep.nFrames == 0) {
1077 		xfer->error = USB_ERR_INVAL;
1078 		goto complete;
1079 	}
1080 	error = copyin(fs_ep.ppBuffer,
1081 	    &uaddr, sizeof(uaddr));
1082 	if (error) {
1083 		return (error);
1084 	}
1085 	/* reset first frame */
1086 	usbd_xfer_set_frame_offset(xfer, 0, 0);
1087 
1088 	if (xfer->flags_int.control_xfr) {
1089 
1090 		req = xfer->frbuffers[0].buffer;
1091 
1092 		error = copyin(fs_ep.pLength,
1093 		    &length, sizeof(length));
1094 		if (error) {
1095 			return (error);
1096 		}
1097 		if (length != sizeof(*req)) {
1098 			xfer->error = USB_ERR_INVAL;
1099 			goto complete;
1100 		}
1101 		if (length != 0) {
1102 			error = copyin(uaddr, req, length);
1103 			if (error) {
1104 				return (error);
1105 			}
1106 		}
1107 		if (ugen_check_request(f->udev, req)) {
1108 			xfer->error = USB_ERR_INVAL;
1109 			goto complete;
1110 		}
1111 		usbd_xfer_set_frame_len(xfer, 0, length);
1112 
1113 		/* Host mode only ! */
1114 		if ((req->bmRequestType &
1115 		    (UT_READ | UT_WRITE)) == UT_READ) {
1116 			isread = 1;
1117 		} else {
1118 			isread = 0;
1119 		}
1120 		n = 1;
1121 		offset = sizeof(*req);
1122 
1123 	} else {
1124 		/* Device and Host mode */
1125 		if (USB_GET_DATA_ISREAD(xfer)) {
1126 			isread = 1;
1127 		} else {
1128 			isread = 0;
1129 		}
1130 		n = 0;
1131 		offset = 0;
1132 	}
1133 
1134 	rem = usbd_xfer_max_len(xfer);
1135 	xfer->nframes = fs_ep.nFrames;
1136 	xfer->timeout = fs_ep.timeout;
1137 	if (xfer->timeout > 65535) {
1138 		xfer->timeout = 65535;
1139 	}
1140 	if (fs_ep.flags & USB_FS_FLAG_SINGLE_SHORT_OK)
1141 		xfer->flags.short_xfer_ok = 1;
1142 	else
1143 		xfer->flags.short_xfer_ok = 0;
1144 
1145 	if (fs_ep.flags & USB_FS_FLAG_MULTI_SHORT_OK)
1146 		xfer->flags.short_frames_ok = 1;
1147 	else
1148 		xfer->flags.short_frames_ok = 0;
1149 
1150 	if (fs_ep.flags & USB_FS_FLAG_FORCE_SHORT)
1151 		xfer->flags.force_short_xfer = 1;
1152 	else
1153 		xfer->flags.force_short_xfer = 0;
1154 
1155 	if (fs_ep.flags & USB_FS_FLAG_CLEAR_STALL)
1156 		usbd_xfer_set_stall(xfer);
1157 	else
1158 		xfer->flags.stall_pipe = 0;
1159 
1160 	for (; n != xfer->nframes; n++) {
1161 
1162 		error = copyin(fs_ep.pLength + n,
1163 		    &length, sizeof(length));
1164 		if (error) {
1165 			break;
1166 		}
1167 		usbd_xfer_set_frame_len(xfer, n, length);
1168 
1169 		if (length > rem) {
1170 			xfer->error = USB_ERR_INVAL;
1171 			goto complete;
1172 		}
1173 		rem -= length;
1174 
1175 		if (!isread) {
1176 
1177 			/* we need to know the source buffer */
1178 			error = copyin(fs_ep.ppBuffer + n,
1179 			    &uaddr, sizeof(uaddr));
1180 			if (error) {
1181 				break;
1182 			}
1183 			if (xfer->flags_int.isochronous_xfr) {
1184 				/* get kernel buffer address */
1185 				kaddr = xfer->frbuffers[0].buffer;
1186 				kaddr = USB_ADD_BYTES(kaddr, offset);
1187 			} else {
1188 				/* set current frame offset */
1189 				usbd_xfer_set_frame_offset(xfer, offset, n);
1190 
1191 				/* get kernel buffer address */
1192 				kaddr = xfer->frbuffers[n].buffer;
1193 			}
1194 
1195 			/* move data */
1196 			error = copyin(uaddr, kaddr, length);
1197 			if (error) {
1198 				break;
1199 			}
1200 		}
1201 		offset += length;
1202 	}
1203 	return (error);
1204 
1205 complete:
1206 	mtx_lock(f->priv_mtx);
1207 	ugen_fs_set_complete(f, ep_index);
1208 	mtx_unlock(f->priv_mtx);
1209 	return (0);
1210 }
1211 
1212 static int
1213 ugen_fs_copy_out(struct usb_fifo *f, uint8_t ep_index)
1214 {
1215 	struct usb_device_request *req;
1216 	struct usb_xfer *xfer;
1217 	struct usb_fs_endpoint fs_ep;
1218 	struct usb_fs_endpoint *fs_ep_uptr;	/* userland ptr */
1219 	void *uaddr;			/* userland ptr */
1220 	void *kaddr;
1221 	usb_frlength_t offset;
1222 	usb_frlength_t rem;
1223 	usb_frcount_t n;
1224 	uint32_t length;
1225 	uint32_t temp;
1226 	int error;
1227 	uint8_t isread;
1228 
1229 	if (ep_index >= f->fs_ep_max)
1230 		return (EINVAL);
1231 
1232 	xfer = f->fs_xfer[ep_index];
1233 	if (xfer == NULL)
1234 		return (EINVAL);
1235 
1236 	mtx_lock(f->priv_mtx);
1237 	if (usbd_transfer_pending(xfer)) {
1238 		mtx_unlock(f->priv_mtx);
1239 		return (EBUSY);		/* should not happen */
1240 	}
1241 	mtx_unlock(f->priv_mtx);
1242 
1243 	fs_ep_uptr = f->fs_ep_ptr + ep_index;
1244 	error = copyin(fs_ep_uptr, &fs_ep, sizeof(fs_ep));
1245 	if (error) {
1246 		return (error);
1247 	}
1248 	fs_ep.status = xfer->error;
1249 	fs_ep.aFrames = xfer->aframes;
1250 	fs_ep.isoc_time_complete = xfer->isoc_time_complete;
1251 	if (xfer->error) {
1252 		goto complete;
1253 	}
1254 	if (xfer->flags_int.control_xfr) {
1255 		req = xfer->frbuffers[0].buffer;
1256 
1257 		/* Host mode only ! */
1258 		if ((req->bmRequestType & (UT_READ | UT_WRITE)) == UT_READ) {
1259 			isread = 1;
1260 		} else {
1261 			isread = 0;
1262 		}
1263 		if (xfer->nframes == 0)
1264 			n = 0;		/* should never happen */
1265 		else
1266 			n = 1;
1267 	} else {
1268 		/* Device and Host mode */
1269 		if (USB_GET_DATA_ISREAD(xfer)) {
1270 			isread = 1;
1271 		} else {
1272 			isread = 0;
1273 		}
1274 		n = 0;
1275 	}
1276 
1277 	/* Update lengths and copy out data */
1278 
1279 	rem = usbd_xfer_max_len(xfer);
1280 	offset = 0;
1281 
1282 	for (; n != xfer->nframes; n++) {
1283 
1284 		/* get initial length into "temp" */
1285 		error = copyin(fs_ep.pLength + n,
1286 		    &temp, sizeof(temp));
1287 		if (error) {
1288 			return (error);
1289 		}
1290 		if (temp > rem) {
1291 			/* the userland length has been corrupted */
1292 			DPRINTF("corrupt userland length "
1293 			    "%u > %u\n", temp, rem);
1294 			fs_ep.status = USB_ERR_INVAL;
1295 			goto complete;
1296 		}
1297 		rem -= temp;
1298 
1299 		/* get actual transfer length */
1300 		length = xfer->frlengths[n];
1301 		if (length > temp) {
1302 			/* data overflow */
1303 			fs_ep.status = USB_ERR_INVAL;
1304 			DPRINTF("data overflow %u > %u\n",
1305 			    length, temp);
1306 			goto complete;
1307 		}
1308 		if (isread) {
1309 
1310 			/* we need to know the destination buffer */
1311 			error = copyin(fs_ep.ppBuffer + n,
1312 			    &uaddr, sizeof(uaddr));
1313 			if (error) {
1314 				return (error);
1315 			}
1316 			if (xfer->flags_int.isochronous_xfr) {
1317 				/* only one frame buffer */
1318 				kaddr = USB_ADD_BYTES(
1319 				    xfer->frbuffers[0].buffer, offset);
1320 			} else {
1321 				/* multiple frame buffers */
1322 				kaddr = xfer->frbuffers[n].buffer;
1323 			}
1324 
1325 			/* move data */
1326 			error = copyout(kaddr, uaddr, length);
1327 			if (error) {
1328 				return (error);
1329 			}
1330 		}
1331 		/*
1332 		 * Update offset according to initial length, which is
1333 		 * needed by isochronous transfers!
1334 		 */
1335 		offset += temp;
1336 
1337 		/* update length */
1338 		error = copyout(&length,
1339 		    fs_ep.pLength + n, sizeof(length));
1340 		if (error) {
1341 			return (error);
1342 		}
1343 	}
1344 
1345 complete:
1346 	/* update "aFrames" */
1347 	error = copyout(&fs_ep.aFrames, &fs_ep_uptr->aFrames,
1348 	    sizeof(fs_ep.aFrames));
1349 	if (error)
1350 		goto done;
1351 
1352 	/* update "isoc_time_complete" */
1353 	error = copyout(&fs_ep.isoc_time_complete,
1354 	    &fs_ep_uptr->isoc_time_complete,
1355 	    sizeof(fs_ep.isoc_time_complete));
1356 	if (error)
1357 		goto done;
1358 	/* update "status" */
1359 	error = copyout(&fs_ep.status, &fs_ep_uptr->status,
1360 	    sizeof(fs_ep.status));
1361 done:
1362 	return (error);
1363 }
1364 
1365 static uint8_t
1366 ugen_fifo_in_use(struct usb_fifo *f, int fflags)
1367 {
1368 	struct usb_fifo *f_rx;
1369 	struct usb_fifo *f_tx;
1370 
1371 	f_rx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_RX];
1372 	f_tx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_TX];
1373 
1374 	if ((fflags & FREAD) && f_rx &&
1375 	    (f_rx->xfer[0] || f_rx->xfer[1])) {
1376 		return (1);		/* RX FIFO in use */
1377 	}
1378 	if ((fflags & FWRITE) && f_tx &&
1379 	    (f_tx->xfer[0] || f_tx->xfer[1])) {
1380 		return (1);		/* TX FIFO in use */
1381 	}
1382 	return (0);			/* not in use */
1383 }
1384 
1385 static int
1386 ugen_ioctl(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
1387 {
1388 	struct usb_config usb_config[1];
1389 	struct usb_device_request req;
1390 	union {
1391 		struct usb_fs_complete *pcomp;
1392 		struct usb_fs_start *pstart;
1393 		struct usb_fs_stop *pstop;
1394 		struct usb_fs_open *popen;
1395 		struct usb_fs_open_stream *popen_stream;
1396 		struct usb_fs_close *pclose;
1397 		struct usb_fs_clear_stall_sync *pstall;
1398 		void   *addr;
1399 	}     u;
1400 	struct usb_endpoint *ep;
1401 	struct usb_endpoint_descriptor *ed;
1402 	struct usb_xfer *xfer;
1403 	int error = 0;
1404 	uint8_t iface_index;
1405 	uint8_t isread;
1406 	uint8_t ep_index;
1407 	uint8_t pre_scale;
1408 
1409 	u.addr = addr;
1410 
1411 	DPRINTFN(6, "cmd=0x%08lx\n", cmd);
1412 
1413 	switch (cmd) {
1414 	case USB_FS_COMPLETE:
1415 		mtx_lock(f->priv_mtx);
1416 		error = ugen_fs_get_complete(f, &ep_index);
1417 		mtx_unlock(f->priv_mtx);
1418 
1419 		if (error) {
1420 			error = EBUSY;
1421 			break;
1422 		}
1423 		u.pcomp->ep_index = ep_index;
1424 		error = ugen_fs_copy_out(f, u.pcomp->ep_index);
1425 		break;
1426 
1427 	case USB_FS_START:
1428 		error = ugen_fs_copy_in(f, u.pstart->ep_index);
1429 		if (error)
1430 			break;
1431 		mtx_lock(f->priv_mtx);
1432 		xfer = f->fs_xfer[u.pstart->ep_index];
1433 		usbd_transfer_start(xfer);
1434 		mtx_unlock(f->priv_mtx);
1435 		break;
1436 
1437 	case USB_FS_STOP:
1438 		if (u.pstop->ep_index >= f->fs_ep_max) {
1439 			error = EINVAL;
1440 			break;
1441 		}
1442 		mtx_lock(f->priv_mtx);
1443 		xfer = f->fs_xfer[u.pstart->ep_index];
1444 		if (usbd_transfer_pending(xfer)) {
1445 			usbd_transfer_stop(xfer);
1446 			/*
1447 			 * Check if the USB transfer was stopped
1448 			 * before it was even started. Else a cancel
1449 			 * callback will be pending.
1450 			 */
1451 			if (!xfer->flags_int.transferring) {
1452 				ugen_fs_set_complete(xfer->priv_sc,
1453 				    USB_P2U(xfer->priv_fifo));
1454 			}
1455 		}
1456 		mtx_unlock(f->priv_mtx);
1457 		break;
1458 
1459 	case USB_FS_OPEN:
1460 	case USB_FS_OPEN_STREAM:
1461 		if (u.popen->ep_index >= f->fs_ep_max) {
1462 			error = EINVAL;
1463 			break;
1464 		}
1465 		if (f->fs_xfer[u.popen->ep_index] != NULL) {
1466 			error = EBUSY;
1467 			break;
1468 		}
1469 		if (u.popen->max_bufsize > USB_FS_MAX_BUFSIZE) {
1470 			u.popen->max_bufsize = USB_FS_MAX_BUFSIZE;
1471 		}
1472 		if (u.popen->max_frames & USB_FS_MAX_FRAMES_PRE_SCALE) {
1473 			pre_scale = 1;
1474 			u.popen->max_frames &= ~USB_FS_MAX_FRAMES_PRE_SCALE;
1475 		} else {
1476 			pre_scale = 0;
1477 		}
1478 		if (u.popen->max_frames > USB_FS_MAX_FRAMES) {
1479 			u.popen->max_frames = USB_FS_MAX_FRAMES;
1480 			break;
1481 		}
1482 		if (u.popen->max_frames == 0) {
1483 			error = EINVAL;
1484 			break;
1485 		}
1486 		ep = usbd_get_ep_by_addr(f->udev, u.popen->ep_no);
1487 		if (ep == NULL) {
1488 			error = EINVAL;
1489 			break;
1490 		}
1491 		ed = ep->edesc;
1492 		if (ed == NULL) {
1493 			error = ENXIO;
1494 			break;
1495 		}
1496 		iface_index = ep->iface_index;
1497 
1498 		memset(usb_config, 0, sizeof(usb_config));
1499 
1500 		usb_config[0].type = ed->bmAttributes & UE_XFERTYPE;
1501 		usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR;
1502 		usb_config[0].direction = ed->bEndpointAddress & (UE_DIR_OUT | UE_DIR_IN);
1503 		usb_config[0].interval = USB_DEFAULT_INTERVAL;
1504 		usb_config[0].flags.proxy_buffer = 1;
1505 		if (pre_scale != 0)
1506 			usb_config[0].flags.pre_scale_frames = 1;
1507 		usb_config[0].callback = &ugen_ctrl_fs_callback;
1508 		usb_config[0].timeout = 0;	/* no timeout */
1509 		usb_config[0].frames = u.popen->max_frames;
1510 		usb_config[0].bufsize = u.popen->max_bufsize;
1511 		usb_config[0].usb_mode = USB_MODE_DUAL;	/* both modes */
1512 		if (cmd == USB_FS_OPEN_STREAM)
1513 			usb_config[0].stream_id = u.popen_stream->stream_id;
1514 
1515 		if (usb_config[0].type == UE_CONTROL) {
1516 			if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1517 				error = EINVAL;
1518 				break;
1519 			}
1520 		} else {
1521 
1522 			isread = ((usb_config[0].endpoint &
1523 			    (UE_DIR_IN | UE_DIR_OUT)) == UE_DIR_IN);
1524 
1525 			if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1526 				isread = !isread;
1527 			}
1528 			/* check permissions */
1529 			if (isread) {
1530 				if (!(fflags & FREAD)) {
1531 					error = EPERM;
1532 					break;
1533 				}
1534 			} else {
1535 				if (!(fflags & FWRITE)) {
1536 					error = EPERM;
1537 					break;
1538 				}
1539 			}
1540 		}
1541 		error = usbd_transfer_setup(f->udev, &iface_index,
1542 		    f->fs_xfer + u.popen->ep_index, usb_config, 1,
1543 		    f, f->priv_mtx);
1544 		if (error == 0) {
1545 			/* update maximums */
1546 			u.popen->max_packet_length =
1547 			    f->fs_xfer[u.popen->ep_index]->max_frame_size;
1548 			u.popen->max_bufsize =
1549 			    f->fs_xfer[u.popen->ep_index]->max_data_length;
1550 			/* update number of frames */
1551 			u.popen->max_frames =
1552 			    f->fs_xfer[u.popen->ep_index]->nframes;
1553 			/* store index of endpoint */
1554 			f->fs_xfer[u.popen->ep_index]->priv_fifo =
1555 			    ((uint8_t *)0) + u.popen->ep_index;
1556 		} else {
1557 			error = ENOMEM;
1558 		}
1559 		break;
1560 
1561 	case USB_FS_CLOSE:
1562 		if (u.pclose->ep_index >= f->fs_ep_max) {
1563 			error = EINVAL;
1564 			break;
1565 		}
1566 		if (f->fs_xfer[u.pclose->ep_index] == NULL) {
1567 			error = EINVAL;
1568 			break;
1569 		}
1570 		usbd_transfer_unsetup(f->fs_xfer + u.pclose->ep_index, 1);
1571 		break;
1572 
1573 	case USB_FS_CLEAR_STALL_SYNC:
1574 		if (u.pstall->ep_index >= f->fs_ep_max) {
1575 			error = EINVAL;
1576 			break;
1577 		}
1578 		if (f->fs_xfer[u.pstall->ep_index] == NULL) {
1579 			error = EINVAL;
1580 			break;
1581 		}
1582 		if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1583 			error = EINVAL;
1584 			break;
1585 		}
1586 		mtx_lock(f->priv_mtx);
1587 		error = usbd_transfer_pending(f->fs_xfer[u.pstall->ep_index]);
1588 		mtx_unlock(f->priv_mtx);
1589 
1590 		if (error) {
1591 			return (EBUSY);
1592 		}
1593 		ep = f->fs_xfer[u.pstall->ep_index]->endpoint;
1594 
1595 		/* setup a clear-stall packet */
1596 		req.bmRequestType = UT_WRITE_ENDPOINT;
1597 		req.bRequest = UR_CLEAR_FEATURE;
1598 		USETW(req.wValue, UF_ENDPOINT_HALT);
1599 		req.wIndex[0] = ep->edesc->bEndpointAddress;
1600 		req.wIndex[1] = 0;
1601 		USETW(req.wLength, 0);
1602 
1603 		error = usbd_do_request(f->udev, NULL, &req, NULL);
1604 		if (error == 0) {
1605 			usbd_clear_data_toggle(f->udev, ep);
1606 		} else {
1607 			error = ENXIO;
1608 		}
1609 		break;
1610 
1611 	default:
1612 		error = ENOIOCTL;
1613 		break;
1614 	}
1615 
1616 	DPRINTFN(6, "error=%d\n", error);
1617 
1618 	return (error);
1619 }
1620 
1621 static int
1622 ugen_set_short_xfer(struct usb_fifo *f, void *addr)
1623 {
1624 	uint8_t t;
1625 
1626 	if (*(int *)addr)
1627 		t = 1;
1628 	else
1629 		t = 0;
1630 
1631 	if (f->flag_short == t) {
1632 		/* same value like before - accept */
1633 		return (0);
1634 	}
1635 	if (f->xfer[0] || f->xfer[1]) {
1636 		/* cannot change this during transfer */
1637 		return (EBUSY);
1638 	}
1639 	f->flag_short = t;
1640 	return (0);
1641 }
1642 
1643 static int
1644 ugen_set_timeout(struct usb_fifo *f, void *addr)
1645 {
1646 	f->timeout = *(int *)addr;
1647 	if (f->timeout > 65535) {
1648 		/* limit user input */
1649 		f->timeout = 65535;
1650 	}
1651 	return (0);
1652 }
1653 
1654 static int
1655 ugen_get_frame_size(struct usb_fifo *f, void *addr)
1656 {
1657 	if (f->xfer[0]) {
1658 		*(int *)addr = f->xfer[0]->max_frame_size;
1659 	} else {
1660 		return (EINVAL);
1661 	}
1662 	return (0);
1663 }
1664 
1665 static int
1666 ugen_set_buffer_size(struct usb_fifo *f, void *addr)
1667 {
1668 	usb_frlength_t t;
1669 
1670 	if (*(int *)addr < 0)
1671 		t = 0;		/* use "wMaxPacketSize" */
1672 	else if (*(int *)addr < (256 * 1024))
1673 		t = *(int *)addr;
1674 	else
1675 		t = 256 * 1024;
1676 
1677 	if (f->bufsize == t) {
1678 		/* same value like before - accept */
1679 		return (0);
1680 	}
1681 	if (f->xfer[0] || f->xfer[1]) {
1682 		/* cannot change this during transfer */
1683 		return (EBUSY);
1684 	}
1685 	f->bufsize = t;
1686 	return (0);
1687 }
1688 
1689 static int
1690 ugen_get_buffer_size(struct usb_fifo *f, void *addr)
1691 {
1692 	*(int *)addr = f->bufsize;
1693 	return (0);
1694 }
1695 
1696 static int
1697 ugen_get_iface_desc(struct usb_fifo *f,
1698     struct usb_interface_descriptor *idesc)
1699 {
1700 	struct usb_interface *iface;
1701 
1702 	iface = usbd_get_iface(f->udev, f->iface_index);
1703 	if (iface && iface->idesc) {
1704 		*idesc = *(iface->idesc);
1705 	} else {
1706 		return (EIO);
1707 	}
1708 	return (0);
1709 }
1710 
1711 static int
1712 ugen_get_endpoint_desc(struct usb_fifo *f,
1713     struct usb_endpoint_descriptor *ed)
1714 {
1715 	struct usb_endpoint *ep;
1716 
1717 	ep = usb_fifo_softc(f);
1718 
1719 	if (ep && ep->edesc) {
1720 		*ed = *ep->edesc;
1721 	} else {
1722 		return (EINVAL);
1723 	}
1724 	return (0);
1725 }
1726 
1727 static int
1728 ugen_set_power_mode(struct usb_fifo *f, int mode)
1729 {
1730 	struct usb_device *udev = f->udev;
1731 	int err;
1732 	uint8_t old_mode;
1733 
1734 	if ((udev == NULL) ||
1735 	    (udev->parent_hub == NULL)) {
1736 		return (EINVAL);
1737 	}
1738 	err = priv_check(curthread, PRIV_DRIVER);
1739 	if (err)
1740 		return (err);
1741 
1742 	/* get old power mode */
1743 	old_mode = udev->power_mode;
1744 
1745 	/* if no change, then just return */
1746 	if (old_mode == mode)
1747 		return (0);
1748 
1749 	switch (mode) {
1750 	case USB_POWER_MODE_OFF:
1751 		/* get the device unconfigured */
1752 		err = ugen_set_config(f, USB_UNCONFIG_INDEX);
1753 		if (err) {
1754 			DPRINTFN(0, "Could not unconfigure "
1755 			    "device (ignored)\n");
1756 		}
1757 
1758 		/* clear port enable */
1759 		err = usbd_req_clear_port_feature(udev->parent_hub,
1760 		    NULL, udev->port_no, UHF_PORT_ENABLE);
1761 		break;
1762 
1763 	case USB_POWER_MODE_ON:
1764 	case USB_POWER_MODE_SAVE:
1765 		break;
1766 
1767 	case USB_POWER_MODE_RESUME:
1768 #if USB_HAVE_POWERD
1769 		/* let USB-powerd handle resume */
1770 		USB_BUS_LOCK(udev->bus);
1771 		udev->pwr_save.write_refs++;
1772 		udev->pwr_save.last_xfer_time = ticks;
1773 		USB_BUS_UNLOCK(udev->bus);
1774 
1775 		/* set new power mode */
1776 		usbd_set_power_mode(udev, USB_POWER_MODE_SAVE);
1777 
1778 		/* wait for resume to complete */
1779 		usb_pause_mtx(NULL, hz / 4);
1780 
1781 		/* clear write reference */
1782 		USB_BUS_LOCK(udev->bus);
1783 		udev->pwr_save.write_refs--;
1784 		USB_BUS_UNLOCK(udev->bus);
1785 #endif
1786 		mode = USB_POWER_MODE_SAVE;
1787 		break;
1788 
1789 	case USB_POWER_MODE_SUSPEND:
1790 #if USB_HAVE_POWERD
1791 		/* let USB-powerd handle suspend */
1792 		USB_BUS_LOCK(udev->bus);
1793 		udev->pwr_save.last_xfer_time = ticks - (256 * hz);
1794 		USB_BUS_UNLOCK(udev->bus);
1795 #endif
1796 		mode = USB_POWER_MODE_SAVE;
1797 		break;
1798 
1799 	default:
1800 		return (EINVAL);
1801 	}
1802 
1803 	if (err)
1804 		return (ENXIO);		/* I/O failure */
1805 
1806 	/* if we are powered off we need to re-enumerate first */
1807 	if (old_mode == USB_POWER_MODE_OFF) {
1808 		if (udev->flags.usb_mode == USB_MODE_HOST) {
1809 			if (udev->re_enumerate_wait == 0)
1810 				udev->re_enumerate_wait = 1;
1811 		}
1812 		/* set power mode will wake up the explore thread */
1813 	}
1814 
1815 	/* set new power mode */
1816 	usbd_set_power_mode(udev, mode);
1817 
1818 	return (0);			/* success */
1819 }
1820 
1821 static int
1822 ugen_get_power_mode(struct usb_fifo *f)
1823 {
1824 	struct usb_device *udev = f->udev;
1825 
1826 	if (udev == NULL)
1827 		return (USB_POWER_MODE_ON);
1828 
1829 	return (udev->power_mode);
1830 }
1831 
1832 static int
1833 ugen_do_port_feature(struct usb_fifo *f, uint8_t port_no,
1834     uint8_t set, uint16_t feature)
1835 {
1836 	struct usb_device *udev = f->udev;
1837 	struct usb_hub *hub;
1838 	int err;
1839 
1840 	err = priv_check(curthread, PRIV_DRIVER);
1841 	if (err) {
1842 		return (err);
1843 	}
1844 	if (port_no == 0) {
1845 		return (EINVAL);
1846 	}
1847 	if ((udev == NULL) ||
1848 	    (udev->hub == NULL)) {
1849 		return (EINVAL);
1850 	}
1851 	hub = udev->hub;
1852 
1853 	if (port_no > hub->nports) {
1854 		return (EINVAL);
1855 	}
1856 	if (set)
1857 		err = usbd_req_set_port_feature(udev,
1858 		    NULL, port_no, feature);
1859 	else
1860 		err = usbd_req_clear_port_feature(udev,
1861 		    NULL, port_no, feature);
1862 
1863 	if (err)
1864 		return (ENXIO);		/* failure */
1865 
1866 	return (0);			/* success */
1867 }
1868 
1869 static int
1870 ugen_iface_ioctl(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
1871 {
1872 	struct usb_fifo *f_rx;
1873 	struct usb_fifo *f_tx;
1874 	int error = 0;
1875 
1876 	f_rx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_RX];
1877 	f_tx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_TX];
1878 
1879 	switch (cmd) {
1880 	case USB_SET_RX_SHORT_XFER:
1881 		if (fflags & FREAD) {
1882 			error = ugen_set_short_xfer(f_rx, addr);
1883 		} else {
1884 			error = EINVAL;
1885 		}
1886 		break;
1887 
1888 	case USB_SET_TX_FORCE_SHORT:
1889 		if (fflags & FWRITE) {
1890 			error = ugen_set_short_xfer(f_tx, addr);
1891 		} else {
1892 			error = EINVAL;
1893 		}
1894 		break;
1895 
1896 	case USB_SET_RX_TIMEOUT:
1897 		if (fflags & FREAD) {
1898 			error = ugen_set_timeout(f_rx, addr);
1899 		} else {
1900 			error = EINVAL;
1901 		}
1902 		break;
1903 
1904 	case USB_SET_TX_TIMEOUT:
1905 		if (fflags & FWRITE) {
1906 			error = ugen_set_timeout(f_tx, addr);
1907 		} else {
1908 			error = EINVAL;
1909 		}
1910 		break;
1911 
1912 	case USB_GET_RX_FRAME_SIZE:
1913 		if (fflags & FREAD) {
1914 			error = ugen_get_frame_size(f_rx, addr);
1915 		} else {
1916 			error = EINVAL;
1917 		}
1918 		break;
1919 
1920 	case USB_GET_TX_FRAME_SIZE:
1921 		if (fflags & FWRITE) {
1922 			error = ugen_get_frame_size(f_tx, addr);
1923 		} else {
1924 			error = EINVAL;
1925 		}
1926 		break;
1927 
1928 	case USB_SET_RX_BUFFER_SIZE:
1929 		if (fflags & FREAD) {
1930 			error = ugen_set_buffer_size(f_rx, addr);
1931 		} else {
1932 			error = EINVAL;
1933 		}
1934 		break;
1935 
1936 	case USB_SET_TX_BUFFER_SIZE:
1937 		if (fflags & FWRITE) {
1938 			error = ugen_set_buffer_size(f_tx, addr);
1939 		} else {
1940 			error = EINVAL;
1941 		}
1942 		break;
1943 
1944 	case USB_GET_RX_BUFFER_SIZE:
1945 		if (fflags & FREAD) {
1946 			error = ugen_get_buffer_size(f_rx, addr);
1947 		} else {
1948 			error = EINVAL;
1949 		}
1950 		break;
1951 
1952 	case USB_GET_TX_BUFFER_SIZE:
1953 		if (fflags & FWRITE) {
1954 			error = ugen_get_buffer_size(f_tx, addr);
1955 		} else {
1956 			error = EINVAL;
1957 		}
1958 		break;
1959 
1960 	case USB_GET_RX_INTERFACE_DESC:
1961 		if (fflags & FREAD) {
1962 			error = ugen_get_iface_desc(f_rx, addr);
1963 		} else {
1964 			error = EINVAL;
1965 		}
1966 		break;
1967 
1968 	case USB_GET_TX_INTERFACE_DESC:
1969 		if (fflags & FWRITE) {
1970 			error = ugen_get_iface_desc(f_tx, addr);
1971 		} else {
1972 			error = EINVAL;
1973 		}
1974 		break;
1975 
1976 	case USB_GET_RX_ENDPOINT_DESC:
1977 		if (fflags & FREAD) {
1978 			error = ugen_get_endpoint_desc(f_rx, addr);
1979 		} else {
1980 			error = EINVAL;
1981 		}
1982 		break;
1983 
1984 	case USB_GET_TX_ENDPOINT_DESC:
1985 		if (fflags & FWRITE) {
1986 			error = ugen_get_endpoint_desc(f_tx, addr);
1987 		} else {
1988 			error = EINVAL;
1989 		}
1990 		break;
1991 
1992 	case USB_SET_RX_STALL_FLAG:
1993 		if ((fflags & FREAD) && (*(int *)addr)) {
1994 			f_rx->flag_stall = 1;
1995 		}
1996 		break;
1997 
1998 	case USB_SET_TX_STALL_FLAG:
1999 		if ((fflags & FWRITE) && (*(int *)addr)) {
2000 			f_tx->flag_stall = 1;
2001 		}
2002 		break;
2003 
2004 	default:
2005 		error = ENOIOCTL;
2006 		break;
2007 	}
2008 	return (error);
2009 }
2010 
2011 static int
2012 ugen_ioctl_post(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
2013 {
2014 	union {
2015 		struct usb_interface_descriptor *idesc;
2016 		struct usb_alt_interface *ai;
2017 		struct usb_device_descriptor *ddesc;
2018 		struct usb_config_descriptor *cdesc;
2019 		struct usb_device_stats *stat;
2020 		struct usb_fs_init *pinit;
2021 		struct usb_fs_uninit *puninit;
2022 		uint32_t *ptime;
2023 		void   *addr;
2024 		int    *pint;
2025 	}     u;
2026 	struct usb_device_descriptor *dtemp;
2027 	struct usb_config_descriptor *ctemp;
2028 	struct usb_interface *iface;
2029 	int error = 0;
2030 	uint8_t n;
2031 
2032 	u.addr = addr;
2033 
2034 	DPRINTFN(6, "cmd=0x%08lx\n", cmd);
2035 
2036 	switch (cmd) {
2037 	case USB_DISCOVER:
2038 		usb_needs_explore_all();
2039 		break;
2040 
2041 	case USB_SETDEBUG:
2042 		if (!(fflags & FWRITE)) {
2043 			error = EPERM;
2044 			break;
2045 		}
2046 		usb_debug = *(int *)addr;
2047 		break;
2048 
2049 	case USB_GET_CONFIG:
2050 		*(int *)addr = f->udev->curr_config_index;
2051 		break;
2052 
2053 	case USB_SET_CONFIG:
2054 		if (!(fflags & FWRITE)) {
2055 			error = EPERM;
2056 			break;
2057 		}
2058 		error = ugen_set_config(f, *(int *)addr);
2059 		break;
2060 
2061 	case USB_GET_ALTINTERFACE:
2062 		iface = usbd_get_iface(f->udev,
2063 		    u.ai->uai_interface_index);
2064 		if (iface && iface->idesc) {
2065 			u.ai->uai_alt_index = iface->alt_index;
2066 		} else {
2067 			error = EINVAL;
2068 		}
2069 		break;
2070 
2071 	case USB_SET_ALTINTERFACE:
2072 		if (!(fflags & FWRITE)) {
2073 			error = EPERM;
2074 			break;
2075 		}
2076 		error = ugen_set_interface(f,
2077 		    u.ai->uai_interface_index, u.ai->uai_alt_index);
2078 		break;
2079 
2080 	case USB_GET_DEVICE_DESC:
2081 		dtemp = usbd_get_device_descriptor(f->udev);
2082 		if (!dtemp) {
2083 			error = EIO;
2084 			break;
2085 		}
2086 		*u.ddesc = *dtemp;
2087 		break;
2088 
2089 	case USB_GET_CONFIG_DESC:
2090 		ctemp = usbd_get_config_descriptor(f->udev);
2091 		if (!ctemp) {
2092 			error = EIO;
2093 			break;
2094 		}
2095 		*u.cdesc = *ctemp;
2096 		break;
2097 
2098 	case USB_GET_FULL_DESC:
2099 		error = ugen_get_cdesc(f, addr);
2100 		break;
2101 
2102 	case USB_GET_STRING_DESC:
2103 		error = ugen_get_sdesc(f, addr);
2104 		break;
2105 
2106 	case USB_GET_IFACE_DRIVER:
2107 		error = ugen_get_iface_driver(f, addr);
2108 		break;
2109 
2110 	case USB_REQUEST:
2111 	case USB_DO_REQUEST:
2112 		if (!(fflags & FWRITE)) {
2113 			error = EPERM;
2114 			break;
2115 		}
2116 		error = ugen_do_request(f, addr);
2117 		break;
2118 
2119 	case USB_DEVICEINFO:
2120 	case USB_GET_DEVICEINFO:
2121 		error = usb_gen_fill_deviceinfo(f, addr);
2122 		break;
2123 
2124 	case USB_DEVICESTATS:
2125 		for (n = 0; n != 4; n++) {
2126 
2127 			u.stat->uds_requests_fail[n] =
2128 			    f->udev->bus->stats_err.uds_requests[n];
2129 
2130 			u.stat->uds_requests_ok[n] =
2131 			    f->udev->bus->stats_ok.uds_requests[n];
2132 		}
2133 		break;
2134 
2135 	case USB_DEVICEENUMERATE:
2136 		error = ugen_re_enumerate(f);
2137 		break;
2138 
2139 	case USB_GET_PLUGTIME:
2140 		*u.ptime = f->udev->plugtime;
2141 		break;
2142 
2143 	case USB_CLAIM_INTERFACE:
2144 	case USB_RELEASE_INTERFACE:
2145 		/* TODO */
2146 		break;
2147 
2148 	case USB_IFACE_DRIVER_ACTIVE:
2149 
2150 		n = *u.pint & 0xFF;
2151 
2152 		iface = usbd_get_iface(f->udev, n);
2153 
2154 		if (iface && iface->subdev)
2155 			error = 0;
2156 		else
2157 			error = ENXIO;
2158 		break;
2159 
2160 	case USB_IFACE_DRIVER_DETACH:
2161 
2162 		error = priv_check(curthread, PRIV_DRIVER);
2163 
2164 		if (error)
2165 			break;
2166 
2167 		n = *u.pint & 0xFF;
2168 
2169 		if (n == USB_IFACE_INDEX_ANY) {
2170 			error = EINVAL;
2171 			break;
2172 		}
2173 
2174 		/*
2175 		 * Detach the currently attached driver.
2176 		 */
2177 		usb_detach_device(f->udev, n, 0);
2178 
2179 		/*
2180 		 * Set parent to self, this should keep attach away
2181 		 * until the next set configuration event.
2182 		 */
2183 		usbd_set_parent_iface(f->udev, n, n);
2184 		break;
2185 
2186 	case USB_SET_POWER_MODE:
2187 		error = ugen_set_power_mode(f, *u.pint);
2188 		break;
2189 
2190 	case USB_GET_POWER_MODE:
2191 		*u.pint = ugen_get_power_mode(f);
2192 		break;
2193 
2194 	case USB_SET_PORT_ENABLE:
2195 		error = ugen_do_port_feature(f,
2196 		    *u.pint, 1, UHF_PORT_ENABLE);
2197 		break;
2198 
2199 	case USB_SET_PORT_DISABLE:
2200 		error = ugen_do_port_feature(f,
2201 		    *u.pint, 0, UHF_PORT_ENABLE);
2202 		break;
2203 
2204 	case USB_FS_INIT:
2205 		/* verify input parameters */
2206 		if (u.pinit->pEndpoints == NULL) {
2207 			error = EINVAL;
2208 			break;
2209 		}
2210 		if (u.pinit->ep_index_max > 127) {
2211 			error = EINVAL;
2212 			break;
2213 		}
2214 		if (u.pinit->ep_index_max == 0) {
2215 			error = EINVAL;
2216 			break;
2217 		}
2218 		if (f->fs_xfer != NULL) {
2219 			error = EBUSY;
2220 			break;
2221 		}
2222 		if (f->dev_ep_index != 0) {
2223 			error = EINVAL;
2224 			break;
2225 		}
2226 		if (ugen_fifo_in_use(f, fflags)) {
2227 			error = EBUSY;
2228 			break;
2229 		}
2230 		error = usb_fifo_alloc_buffer(f, 1, u.pinit->ep_index_max);
2231 		if (error) {
2232 			break;
2233 		}
2234 		f->fs_xfer = malloc(sizeof(f->fs_xfer[0]) *
2235 		    u.pinit->ep_index_max, M_USB, M_WAITOK | M_ZERO);
2236 		if (f->fs_xfer == NULL) {
2237 			usb_fifo_free_buffer(f);
2238 			error = ENOMEM;
2239 			break;
2240 		}
2241 		f->fs_ep_max = u.pinit->ep_index_max;
2242 		f->fs_ep_ptr = u.pinit->pEndpoints;
2243 		break;
2244 
2245 	case USB_FS_UNINIT:
2246 		if (u.puninit->dummy != 0) {
2247 			error = EINVAL;
2248 			break;
2249 		}
2250 		error = ugen_fs_uninit(f);
2251 		break;
2252 
2253 	default:
2254 		mtx_lock(f->priv_mtx);
2255 		error = ugen_iface_ioctl(f, cmd, addr, fflags);
2256 		mtx_unlock(f->priv_mtx);
2257 		break;
2258 	}
2259 	DPRINTFN(6, "error=%d\n", error);
2260 	return (error);
2261 }
2262 
2263 static void
2264 ugen_ctrl_fs_callback(struct usb_xfer *xfer, usb_error_t error)
2265 {
2266 	;				/* workaround for a bug in "indent" */
2267 
2268 	DPRINTF("st=%u alen=%u aframes=%u\n",
2269 	    USB_GET_STATE(xfer), xfer->actlen, xfer->aframes);
2270 
2271 	switch (USB_GET_STATE(xfer)) {
2272 	case USB_ST_SETUP:
2273 		usbd_transfer_submit(xfer);
2274 		break;
2275 	default:
2276 		ugen_fs_set_complete(xfer->priv_sc, USB_P2U(xfer->priv_fifo));
2277 		break;
2278 	}
2279 }
2280 #endif	/* USB_HAVE_UGEN */
2281