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