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