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