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