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