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