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