3 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
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>
35 #include <sys/module.h>
37 #include <sys/mutex.h>
38 #include <sys/condvar.h>
39 #include <sys/sysctl.h>
41 #include <sys/unistd.h>
42 #include <sys/callout.h>
43 #include <sys/malloc.h>
46 #include <sys/fcntl.h>
48 #include <dev/usb/usb.h>
49 #include <dev/usb/usb_ioctl.h>
50 #include <dev/usb/usbdi.h>
51 #include <dev/usb/usbdi_util.h>
53 #define USB_DEBUG_VAR ugen_debug
55 #include <dev/usb/usb_core.h>
56 #include <dev/usb/usb_dev.h>
57 #include <dev/usb/usb_mbuf.h>
58 #include <dev/usb/usb_process.h>
59 #include <dev/usb/usb_device.h>
60 #include <dev/usb/usb_debug.h>
61 #include <dev/usb/usb_request.h>
62 #include <dev/usb/usb_busdma.h>
63 #include <dev/usb/usb_util.h>
64 #include <dev/usb/usb_hub.h>
65 #include <dev/usb/usb_generic.h>
66 #include <dev/usb/usb_transfer.h>
68 #include <dev/usb/usb_controller.h>
69 #include <dev/usb/usb_bus.h>
75 #define UGEN_BULK_FS_BUFFER_SIZE (64*32) /* bytes */
76 #define UGEN_BULK_HS_BUFFER_SIZE (1024*32) /* bytes */
77 #define UGEN_HW_FRAMES 50 /* number of milliseconds per transfer */
79 /* function prototypes */
81 static usb_callback_t ugen_read_clear_stall_callback;
82 static usb_callback_t ugen_write_clear_stall_callback;
83 static usb_callback_t ugen_ctrl_read_callback;
84 static usb_callback_t ugen_ctrl_write_callback;
85 static usb_callback_t ugen_isoc_read_callback;
86 static usb_callback_t ugen_isoc_write_callback;
87 static usb_callback_t ugen_ctrl_fs_callback;
89 static usb_fifo_open_t ugen_open;
90 static usb_fifo_close_t ugen_close;
91 static usb_fifo_ioctl_t ugen_ioctl;
92 static usb_fifo_ioctl_t ugen_ioctl_post;
93 static usb_fifo_cmd_t ugen_start_read;
94 static usb_fifo_cmd_t ugen_start_write;
95 static usb_fifo_cmd_t ugen_stop_io;
97 static int ugen_transfer_setup(struct usb_fifo *,
98 const struct usb_config *, uint8_t);
99 static int ugen_open_pipe_write(struct usb_fifo *);
100 static int ugen_open_pipe_read(struct usb_fifo *);
101 static int ugen_set_config(struct usb_fifo *, uint8_t);
102 static int ugen_set_interface(struct usb_fifo *, uint8_t, uint8_t);
103 static int ugen_get_cdesc(struct usb_fifo *, struct usb_gen_descriptor *);
104 static int ugen_get_sdesc(struct usb_fifo *, struct usb_gen_descriptor *);
105 static int ugen_get_iface_driver(struct usb_fifo *f, struct usb_gen_descriptor *ugd);
106 static int usb_gen_fill_deviceinfo(struct usb_fifo *,
107 struct usb_device_info *);
108 static int ugen_re_enumerate(struct usb_fifo *);
109 static int ugen_iface_ioctl(struct usb_fifo *, u_long, void *, int);
110 static uint8_t ugen_fs_get_complete(struct usb_fifo *, uint8_t *);
111 static int ugen_fs_uninit(struct usb_fifo *f);
115 struct usb_fifo_methods usb_ugen_methods = {
116 .f_open = &ugen_open,
117 .f_close = &ugen_close,
118 .f_ioctl = &ugen_ioctl,
119 .f_ioctl_post = &ugen_ioctl_post,
120 .f_start_read = &ugen_start_read,
121 .f_stop_read = &ugen_stop_io,
122 .f_start_write = &ugen_start_write,
123 .f_stop_write = &ugen_stop_io,
127 static int ugen_debug = 0;
129 SYSCTL_NODE(_hw_usb, OID_AUTO, ugen, CTLFLAG_RW, 0, "USB generic");
130 SYSCTL_INT(_hw_usb_ugen, OID_AUTO, debug, CTLFLAG_RW, &ugen_debug,
133 TUNABLE_INT("hw.usb.ugen.debug", &ugen_debug);
140 ugen_transfer_setup(struct usb_fifo *f,
141 const struct usb_config *setup, uint8_t n_setup)
143 struct usb_endpoint *ep = usb_fifo_softc(f);
144 struct usb_device *udev = f->udev;
145 uint8_t iface_index = ep->iface_index;
148 mtx_unlock(f->priv_mtx);
151 * "usbd_transfer_setup()" can sleep so one needs to make a wrapper,
152 * exiting the mutex and checking things
154 error = usbd_transfer_setup(udev, &iface_index, f->xfer,
155 setup, n_setup, f, f->priv_mtx);
158 if (f->xfer[0]->nframes == 1) {
159 error = usb_fifo_alloc_buffer(f,
160 f->xfer[0]->max_data_length, 2);
162 error = usb_fifo_alloc_buffer(f,
163 f->xfer[0]->max_frame_size,
164 2 * f->xfer[0]->nframes);
167 usbd_transfer_unsetup(f->xfer, n_setup);
170 mtx_lock(f->priv_mtx);
176 ugen_open(struct usb_fifo *f, int fflags)
178 struct usb_endpoint *ep = usb_fifo_softc(f);
179 struct usb_endpoint_descriptor *ed = ep->edesc;
182 DPRINTFN(6, "flag=0x%x\n", fflags);
184 mtx_lock(f->priv_mtx);
185 switch (usbd_get_speed(f->udev)) {
188 f->nframes = UGEN_HW_FRAMES;
189 f->bufsize = UGEN_BULK_FS_BUFFER_SIZE;
192 f->nframes = UGEN_HW_FRAMES * 8;
193 f->bufsize = UGEN_BULK_HS_BUFFER_SIZE;
197 type = ed->bmAttributes & UE_XFERTYPE;
198 if (type == UE_INTERRUPT) {
199 f->bufsize = 0; /* use "wMaxPacketSize" */
201 f->timeout = USB_NO_TIMEOUT;
204 mtx_unlock(f->priv_mtx);
210 ugen_close(struct usb_fifo *f, int fflags)
212 DPRINTFN(6, "flag=0x%x\n", fflags);
216 mtx_lock(f->priv_mtx);
217 usbd_transfer_stop(f->xfer[0]);
218 usbd_transfer_stop(f->xfer[1]);
219 mtx_unlock(f->priv_mtx);
221 usbd_transfer_unsetup(f->xfer, 2);
222 usb_fifo_free_buffer(f);
224 if (ugen_fs_uninit(f)) {
225 /* ignore any errors - we are closing */
226 DPRINTFN(6, "no FIFOs\n");
231 ugen_open_pipe_write(struct usb_fifo *f)
233 struct usb_config usb_config[2];
234 struct usb_endpoint *ep = usb_fifo_softc(f);
235 struct usb_endpoint_descriptor *ed = ep->edesc;
237 mtx_assert(f->priv_mtx, MA_OWNED);
239 if (f->xfer[0] || f->xfer[1]) {
240 /* transfers are already opened */
243 memset(usb_config, 0, sizeof(usb_config));
245 usb_config[1].type = UE_CONTROL;
246 usb_config[1].endpoint = 0;
247 usb_config[1].direction = UE_DIR_ANY;
248 usb_config[1].timeout = 1000; /* 1 second */
249 usb_config[1].interval = 50;/* 50 milliseconds */
250 usb_config[1].bufsize = sizeof(struct usb_device_request);
251 usb_config[1].callback = &ugen_write_clear_stall_callback;
252 usb_config[1].usb_mode = USB_MODE_HOST;
254 usb_config[0].type = ed->bmAttributes & UE_XFERTYPE;
255 usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR;
256 usb_config[0].direction = UE_DIR_TX;
257 usb_config[0].interval = USB_DEFAULT_INTERVAL;
258 usb_config[0].flags.proxy_buffer = 1;
259 usb_config[0].usb_mode = USB_MODE_DUAL; /* both modes */
261 switch (ed->bmAttributes & UE_XFERTYPE) {
265 usb_config[0].flags.force_short_xfer = 1;
267 usb_config[0].callback = &ugen_ctrl_write_callback;
268 usb_config[0].timeout = f->timeout;
269 usb_config[0].frames = 1;
270 usb_config[0].bufsize = f->bufsize;
271 if (ugen_transfer_setup(f, usb_config, 2)) {
274 /* first transfer does not clear stall */
279 usb_config[0].flags.short_xfer_ok = 1;
280 usb_config[0].bufsize = 0; /* use default */
281 usb_config[0].frames = f->nframes;
282 usb_config[0].callback = &ugen_isoc_write_callback;
283 usb_config[0].timeout = 0;
285 /* clone configuration */
286 usb_config[1] = usb_config[0];
288 if (ugen_transfer_setup(f, usb_config, 2)) {
299 ugen_open_pipe_read(struct usb_fifo *f)
301 struct usb_config usb_config[2];
302 struct usb_endpoint *ep = usb_fifo_softc(f);
303 struct usb_endpoint_descriptor *ed = ep->edesc;
305 mtx_assert(f->priv_mtx, MA_OWNED);
307 if (f->xfer[0] || f->xfer[1]) {
308 /* transfers are already opened */
311 memset(usb_config, 0, sizeof(usb_config));
313 usb_config[1].type = UE_CONTROL;
314 usb_config[1].endpoint = 0;
315 usb_config[1].direction = UE_DIR_ANY;
316 usb_config[1].timeout = 1000; /* 1 second */
317 usb_config[1].interval = 50;/* 50 milliseconds */
318 usb_config[1].bufsize = sizeof(struct usb_device_request);
319 usb_config[1].callback = &ugen_read_clear_stall_callback;
320 usb_config[1].usb_mode = USB_MODE_HOST;
322 usb_config[0].type = ed->bmAttributes & UE_XFERTYPE;
323 usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR;
324 usb_config[0].direction = UE_DIR_RX;
325 usb_config[0].interval = USB_DEFAULT_INTERVAL;
326 usb_config[0].flags.proxy_buffer = 1;
327 usb_config[0].usb_mode = USB_MODE_DUAL; /* both modes */
329 switch (ed->bmAttributes & UE_XFERTYPE) {
333 usb_config[0].flags.short_xfer_ok = 1;
335 usb_config[0].timeout = f->timeout;
336 usb_config[0].frames = 1;
337 usb_config[0].callback = &ugen_ctrl_read_callback;
338 usb_config[0].bufsize = f->bufsize;
340 if (ugen_transfer_setup(f, usb_config, 2)) {
343 /* first transfer does not clear stall */
348 usb_config[0].flags.short_xfer_ok = 1;
349 usb_config[0].bufsize = 0; /* use default */
350 usb_config[0].frames = f->nframes;
351 usb_config[0].callback = &ugen_isoc_read_callback;
352 usb_config[0].timeout = 0;
354 /* clone configuration */
355 usb_config[1] = usb_config[0];
357 if (ugen_transfer_setup(f, usb_config, 2)) {
369 ugen_start_read(struct usb_fifo *f)
371 /* check that pipes are open */
372 if (ugen_open_pipe_read(f)) {
374 usb_fifo_put_data_error(f);
376 /* start transfers */
377 usbd_transfer_start(f->xfer[0]);
378 usbd_transfer_start(f->xfer[1]);
382 ugen_start_write(struct usb_fifo *f)
384 /* check that pipes are open */
385 if (ugen_open_pipe_write(f)) {
387 usb_fifo_get_data_error(f);
389 /* start transfers */
390 usbd_transfer_start(f->xfer[0]);
391 usbd_transfer_start(f->xfer[1]);
395 ugen_stop_io(struct usb_fifo *f)
398 usbd_transfer_stop(f->xfer[0]);
399 usbd_transfer_stop(f->xfer[1]);
403 ugen_ctrl_read_callback(struct usb_xfer *xfer, usb_error_t error)
405 struct usb_fifo *f = usbd_xfer_softc(xfer);
408 DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
410 switch (USB_GET_STATE(xfer)) {
411 case USB_ST_TRANSFERRED:
412 if (xfer->actlen == 0) {
413 if (f->fifo_zlp != 4) {
417 * Throttle a little bit we have multiple ZLPs
420 xfer->interval = 64; /* ms */
427 usb_fifo_put_data(f, xfer->frbuffers, 0,
432 usbd_transfer_start(f->xfer[1]);
435 USB_IF_POLL(&f->free_q, m);
437 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
438 usbd_transfer_submit(xfer);
443 if (xfer->error != USB_ERR_CANCELLED) {
444 /* send a zero length packet to userland */
445 usb_fifo_put_data(f, xfer->frbuffers, 0, 0, 1);
448 usbd_transfer_start(f->xfer[1]);
455 ugen_ctrl_write_callback(struct usb_xfer *xfer, usb_error_t error)
457 struct usb_fifo *f = usbd_xfer_softc(xfer);
458 usb_frlength_t actlen;
460 DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
462 switch (USB_GET_STATE(xfer)) {
464 case USB_ST_TRANSFERRED:
466 * If writing is in stall, just jump to clear stall
467 * callback and solve the situation.
470 usbd_transfer_start(f->xfer[1]);
474 * Write data, setup and perform hardware transfer.
476 if (usb_fifo_get_data(f, xfer->frbuffers, 0,
477 xfer->max_data_length, &actlen, 0)) {
478 usbd_xfer_set_frame_len(xfer, 0, actlen);
479 usbd_transfer_submit(xfer);
484 if (xfer->error != USB_ERR_CANCELLED) {
486 usbd_transfer_start(f->xfer[1]);
493 ugen_read_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error)
495 struct usb_fifo *f = usbd_xfer_softc(xfer);
496 struct usb_xfer *xfer_other = f->xfer[0];
498 if (f->flag_stall == 0) {
502 if (usbd_clear_stall_callback(xfer, xfer_other)) {
503 DPRINTFN(5, "f=%p: stall cleared\n", f);
505 usbd_transfer_start(xfer_other);
510 ugen_write_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error)
512 struct usb_fifo *f = usbd_xfer_softc(xfer);
513 struct usb_xfer *xfer_other = f->xfer[0];
515 if (f->flag_stall == 0) {
519 if (usbd_clear_stall_callback(xfer, xfer_other)) {
520 DPRINTFN(5, "f=%p: stall cleared\n", f);
522 usbd_transfer_start(xfer_other);
527 ugen_isoc_read_callback(struct usb_xfer *xfer, usb_error_t error)
529 struct usb_fifo *f = usbd_xfer_softc(xfer);
530 usb_frlength_t offset;
533 DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
535 switch (USB_GET_STATE(xfer)) {
536 case USB_ST_TRANSFERRED:
538 DPRINTFN(6, "actlen=%d\n", xfer->actlen);
542 for (n = 0; n != xfer->aframes; n++) {
543 usb_fifo_put_data(f, xfer->frbuffers, offset,
544 xfer->frlengths[n], 1);
545 offset += xfer->max_frame_size;
550 for (n = 0; n != xfer->nframes; n++) {
551 /* setup size for next transfer */
552 usbd_xfer_set_frame_len(xfer, n, xfer->max_frame_size);
554 usbd_transfer_submit(xfer);
558 if (xfer->error == USB_ERR_CANCELLED) {
566 ugen_isoc_write_callback(struct usb_xfer *xfer, usb_error_t error)
568 struct usb_fifo *f = usbd_xfer_softc(xfer);
569 usb_frlength_t actlen;
570 usb_frlength_t offset;
573 DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
575 switch (USB_GET_STATE(xfer)) {
576 case USB_ST_TRANSFERRED:
580 for (n = 0; n != xfer->nframes; n++) {
581 if (usb_fifo_get_data(f, xfer->frbuffers, offset,
582 xfer->max_frame_size, &actlen, 1)) {
583 usbd_xfer_set_frame_len(xfer, n, actlen);
590 for (; n != xfer->nframes; n++) {
591 /* fill in zero frames */
592 usbd_xfer_set_frame_len(xfer, n, 0);
594 usbd_transfer_submit(xfer);
598 if (xfer->error == USB_ERR_CANCELLED) {
606 ugen_set_config(struct usb_fifo *f, uint8_t index)
608 DPRINTFN(2, "index %u\n", index);
610 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
611 /* not possible in device side mode */
614 if (f->udev->curr_config_index == index) {
615 /* no change needed */
618 /* make sure all FIFO's are gone */
619 /* else there can be a deadlock */
620 if (ugen_fs_uninit(f)) {
621 /* ignore any errors */
622 DPRINTFN(6, "no FIFOs\n");
624 /* change setting - will free generic FIFOs, if any */
625 if (usbd_set_config_index(f->udev, index)) {
628 /* probe and attach */
629 if (usb_probe_and_attach(f->udev, USB_IFACE_INDEX_ANY)) {
636 ugen_set_interface(struct usb_fifo *f,
637 uint8_t iface_index, uint8_t alt_index)
639 DPRINTFN(2, "%u, %u\n", iface_index, alt_index);
641 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
642 /* not possible in device side mode */
645 /* make sure all FIFO's are gone */
646 /* else there can be a deadlock */
647 if (ugen_fs_uninit(f)) {
648 /* ignore any errors */
649 DPRINTFN(6, "no FIFOs\n");
651 /* change setting - will free generic FIFOs, if any */
652 if (usbd_set_alt_interface_index(f->udev, iface_index, alt_index)) {
655 /* probe and attach */
656 if (usb_probe_and_attach(f->udev, iface_index)) {
662 /*------------------------------------------------------------------------*
665 * This function will retrieve the complete configuration descriptor
666 * at the given index.
667 *------------------------------------------------------------------------*/
669 ugen_get_cdesc(struct usb_fifo *f, struct usb_gen_descriptor *ugd)
671 struct usb_config_descriptor *cdesc;
672 struct usb_device *udev = f->udev;
679 if (ugd->ugd_data == NULL) {
680 /* userland pointer should not be zero */
683 if ((ugd->ugd_config_index == USB_UNCONFIG_INDEX) ||
684 (ugd->ugd_config_index == udev->curr_config_index)) {
685 cdesc = usbd_get_config_descriptor(udev);
692 if (usbd_req_get_config_desc_full(udev,
693 NULL, &cdesc, M_USBDEV,
694 ugd->ugd_config_index)) {
700 len = UGETW(cdesc->wTotalLength);
701 if (len > ugd->ugd_maxlen) {
702 len = ugd->ugd_maxlen;
704 DPRINTFN(6, "len=%u\n", len);
706 ugd->ugd_actlen = len;
709 error = copyout(cdesc, ugd->ugd_data, len);
712 free(cdesc, M_USBDEV);
718 ugen_get_sdesc(struct usb_fifo *f, struct usb_gen_descriptor *ugd)
720 void *ptr = f->udev->bus->scratch[0].data;
721 uint16_t size = sizeof(f->udev->bus->scratch[0].data);
724 if (usbd_req_get_string_desc(f->udev, NULL, ptr,
725 size, ugd->ugd_lang_id, ugd->ugd_string_index)) {
729 if (size > ((uint8_t *)ptr)[0]) {
730 size = ((uint8_t *)ptr)[0];
732 if (size > ugd->ugd_maxlen) {
733 size = ugd->ugd_maxlen;
735 ugd->ugd_actlen = size;
738 error = copyout(ptr, ugd->ugd_data, size);
743 /*------------------------------------------------------------------------*
744 * ugen_get_iface_driver
746 * This function generates an USB interface description for userland.
751 *------------------------------------------------------------------------*/
753 ugen_get_iface_driver(struct usb_fifo *f, struct usb_gen_descriptor *ugd)
755 struct usb_device *udev = f->udev;
756 struct usb_interface *iface;
766 if ((ugd->ugd_data == NULL) || (ugd->ugd_maxlen == 0)) {
767 /* userland pointer should not be zero */
771 iface = usbd_get_iface(udev, ugd->ugd_iface_index);
772 if ((iface == NULL) || (iface->idesc == NULL)) {
773 /* invalid interface index */
777 /* read out device nameunit string, if any */
778 if ((iface->subdev != NULL) &&
779 device_is_attached(iface->subdev) &&
780 (ptr = device_get_nameunit(iface->subdev)) &&
781 (desc = device_get_desc(iface->subdev))) {
783 /* print description */
784 snprintf(buf, sizeof(buf), "%s: <%s>", ptr, desc);
787 maxlen = ugd->ugd_maxlen - 1;
792 /* update actual length, including terminating zero */
793 ugd->ugd_actlen = len + 1;
795 /* copy out interface description */
796 error = copyout(buf, ugd->ugd_data, ugd->ugd_actlen);
798 /* zero length string is default */
799 error = copyout("", ugd->ugd_data, 1);
804 /*------------------------------------------------------------------------*
805 * usb_gen_fill_deviceinfo
807 * This function dumps information about an USB device to the
808 * structure pointed to by the "di" argument.
813 *------------------------------------------------------------------------*/
815 usb_gen_fill_deviceinfo(struct usb_fifo *f, struct usb_device_info *di)
817 struct usb_device *udev;
818 struct usb_device *hub;
822 bzero(di, sizeof(di[0]));
824 di->udi_bus = device_get_unit(udev->bus->bdev);
825 di->udi_addr = udev->address;
826 di->udi_index = udev->device_index;
827 strlcpy(di->udi_serial, usb_get_serial(udev), sizeof(di->udi_serial));
828 strlcpy(di->udi_vendor, usb_get_manufacturer(udev), sizeof(di->udi_vendor));
829 strlcpy(di->udi_product, usb_get_product(udev), sizeof(di->udi_product));
830 usb_printbcd(di->udi_release, sizeof(di->udi_release),
831 UGETW(udev->ddesc.bcdDevice));
832 di->udi_vendorNo = UGETW(udev->ddesc.idVendor);
833 di->udi_productNo = UGETW(udev->ddesc.idProduct);
834 di->udi_releaseNo = UGETW(udev->ddesc.bcdDevice);
835 di->udi_class = udev->ddesc.bDeviceClass;
836 di->udi_subclass = udev->ddesc.bDeviceSubClass;
837 di->udi_protocol = udev->ddesc.bDeviceProtocol;
838 di->udi_config_no = udev->curr_config_no;
839 di->udi_config_index = udev->curr_config_index;
840 di->udi_power = udev->flags.self_powered ? 0 : udev->power;
841 di->udi_speed = udev->speed;
842 di->udi_mode = udev->flags.usb_mode;
843 di->udi_power_mode = udev->power_mode;
844 di->udi_suspended = udev->flags.peer_suspended;
846 hub = udev->parent_hub;
848 di->udi_hubaddr = hub->address;
849 di->udi_hubindex = hub->device_index;
850 di->udi_hubport = udev->port_no;
855 /*------------------------------------------------------------------------*
861 *------------------------------------------------------------------------*/
863 ugen_check_request(struct usb_device *udev, struct usb_device_request *req)
865 struct usb_endpoint *ep;
869 * Avoid requests that would damage the bus integrity:
871 if (((req->bmRequestType == UT_WRITE_DEVICE) &&
872 (req->bRequest == UR_SET_ADDRESS)) ||
873 ((req->bmRequestType == UT_WRITE_DEVICE) &&
874 (req->bRequest == UR_SET_CONFIG)) ||
875 ((req->bmRequestType == UT_WRITE_INTERFACE) &&
876 (req->bRequest == UR_SET_INTERFACE))) {
878 * These requests can be useful for testing USB drivers.
880 error = priv_check(curthread, PRIV_DRIVER);
886 * Special case - handle clearing of stall
888 if (req->bmRequestType == UT_WRITE_ENDPOINT) {
890 ep = usbd_get_ep_by_addr(udev, req->wIndex[0]);
894 if ((req->bRequest == UR_CLEAR_FEATURE) &&
895 (UGETW(req->wValue) == UF_ENDPOINT_HALT)) {
896 usbd_clear_data_toggle(udev, ep);
899 /* TODO: add more checks to verify the interface index */
905 ugen_do_request(struct usb_fifo *f, struct usb_ctl_request *ur)
911 if (ugen_check_request(f->udev, &ur->ucr_request)) {
914 len = UGETW(ur->ucr_request.wLength);
916 /* check if "ucr_data" is valid */
918 if (ur->ucr_data == NULL) {
922 /* do the USB request */
923 error = usbd_do_request_flags
924 (f->udev, NULL, &ur->ucr_request, ur->ucr_data,
925 (ur->ucr_flags & USB_SHORT_XFER_OK) |
926 USB_USER_DATA_PTR, &actlen,
927 USB_DEFAULT_TIMEOUT);
929 ur->ucr_actlen = actlen;
937 /*------------------------------------------------------------------------
939 *------------------------------------------------------------------------*/
941 ugen_re_enumerate(struct usb_fifo *f)
943 struct usb_device *udev = f->udev;
947 * This request can be useful for testing USB drivers:
949 error = priv_check(curthread, PRIV_DRIVER);
953 if (udev->flags.usb_mode != USB_MODE_HOST) {
954 /* not possible in device side mode */
955 DPRINTFN(6, "device mode\n");
958 if (udev->parent_hub == NULL) {
959 /* the root HUB cannot be re-enumerated */
960 DPRINTFN(6, "cannot reset root HUB\n");
963 /* make sure all FIFO's are gone */
964 /* else there can be a deadlock */
965 if (ugen_fs_uninit(f)) {
966 /* ignore any errors */
967 DPRINTFN(6, "no FIFOs\n");
969 /* start re-enumeration of device */
970 usbd_start_re_enumerate(udev);
975 ugen_fs_uninit(struct usb_fifo *f)
977 if (f->fs_xfer == NULL) {
980 usbd_transfer_unsetup(f->fs_xfer, f->fs_ep_max);
981 free(f->fs_xfer, M_USB);
985 f->flag_iscomplete = 0;
986 usb_fifo_free_buffer(f);
991 ugen_fs_get_complete(struct usb_fifo *f, uint8_t *pindex)
995 USB_IF_DEQUEUE(&f->used_q, m);
998 *pindex = *((uint8_t *)(m->cur_data_ptr));
1000 USB_IF_ENQUEUE(&f->free_q, m);
1002 return (0); /* success */
1005 *pindex = 0; /* fix compiler warning */
1007 f->flag_iscomplete = 0;
1009 return (1); /* failure */
1013 ugen_fs_set_complete(struct usb_fifo *f, uint8_t index)
1017 USB_IF_DEQUEUE(&f->free_q, m);
1020 /* can happen during close */
1021 DPRINTF("out of buffers\n");
1026 *((uint8_t *)(m->cur_data_ptr)) = index;
1028 USB_IF_ENQUEUE(&f->used_q, m);
1030 f->flag_iscomplete = 1;
1036 ugen_fs_copy_in(struct usb_fifo *f, uint8_t ep_index)
1038 struct usb_device_request *req;
1039 struct usb_xfer *xfer;
1040 struct usb_fs_endpoint fs_ep;
1041 void *uaddr; /* userland pointer */
1043 usb_frlength_t offset;
1050 if (ep_index >= f->fs_ep_max) {
1053 xfer = f->fs_xfer[ep_index];
1057 mtx_lock(f->priv_mtx);
1058 if (usbd_transfer_pending(xfer)) {
1059 mtx_unlock(f->priv_mtx);
1060 return (EBUSY); /* should not happen */
1062 mtx_unlock(f->priv_mtx);
1064 error = copyin(f->fs_ep_ptr +
1065 ep_index, &fs_ep, sizeof(fs_ep));
1069 /* security checks */
1071 if (fs_ep.nFrames > xfer->max_frame_count) {
1072 xfer->error = USB_ERR_INVAL;
1075 if (fs_ep.nFrames == 0) {
1076 xfer->error = USB_ERR_INVAL;
1079 error = copyin(fs_ep.ppBuffer,
1080 &uaddr, sizeof(uaddr));
1084 /* reset first frame */
1085 usbd_xfer_set_frame_offset(xfer, 0, 0);
1087 if (xfer->flags_int.control_xfr) {
1089 req = xfer->frbuffers[0].buffer;
1091 error = copyin(fs_ep.pLength,
1092 &length, sizeof(length));
1096 if (length != sizeof(*req)) {
1097 xfer->error = USB_ERR_INVAL;
1101 error = copyin(uaddr, req, length);
1106 if (ugen_check_request(f->udev, req)) {
1107 xfer->error = USB_ERR_INVAL;
1110 usbd_xfer_set_frame_len(xfer, 0, length);
1112 /* Host mode only ! */
1113 if ((req->bmRequestType &
1114 (UT_READ | UT_WRITE)) == UT_READ) {
1120 offset = sizeof(*req);
1123 /* Device and Host mode */
1124 if (USB_GET_DATA_ISREAD(xfer)) {
1133 rem = usbd_xfer_max_len(xfer);
1134 xfer->nframes = fs_ep.nFrames;
1135 xfer->timeout = fs_ep.timeout;
1136 if (xfer->timeout > 65535) {
1137 xfer->timeout = 65535;
1139 if (fs_ep.flags & USB_FS_FLAG_SINGLE_SHORT_OK)
1140 xfer->flags.short_xfer_ok = 1;
1142 xfer->flags.short_xfer_ok = 0;
1144 if (fs_ep.flags & USB_FS_FLAG_MULTI_SHORT_OK)
1145 xfer->flags.short_frames_ok = 1;
1147 xfer->flags.short_frames_ok = 0;
1149 if (fs_ep.flags & USB_FS_FLAG_FORCE_SHORT)
1150 xfer->flags.force_short_xfer = 1;
1152 xfer->flags.force_short_xfer = 0;
1154 if (fs_ep.flags & USB_FS_FLAG_CLEAR_STALL)
1155 usbd_xfer_set_stall(xfer);
1157 xfer->flags.stall_pipe = 0;
1159 for (; n != xfer->nframes; n++) {
1161 error = copyin(fs_ep.pLength + n,
1162 &length, sizeof(length));
1166 usbd_xfer_set_frame_len(xfer, n, length);
1169 xfer->error = USB_ERR_INVAL;
1176 /* we need to know the source buffer */
1177 error = copyin(fs_ep.ppBuffer + n,
1178 &uaddr, sizeof(uaddr));
1182 if (xfer->flags_int.isochronous_xfr) {
1183 /* get kernel buffer address */
1184 kaddr = xfer->frbuffers[0].buffer;
1185 kaddr = USB_ADD_BYTES(kaddr, offset);
1187 /* set current frame offset */
1188 usbd_xfer_set_frame_offset(xfer, offset, n);
1190 /* get kernel buffer address */
1191 kaddr = xfer->frbuffers[n].buffer;
1195 error = copyin(uaddr, kaddr, length);
1205 mtx_lock(f->priv_mtx);
1206 ugen_fs_set_complete(f, ep_index);
1207 mtx_unlock(f->priv_mtx);
1212 ugen_fs_copy_out(struct usb_fifo *f, uint8_t ep_index)
1214 struct usb_device_request *req;
1215 struct usb_xfer *xfer;
1216 struct usb_fs_endpoint fs_ep;
1217 struct usb_fs_endpoint *fs_ep_uptr; /* userland ptr */
1218 void *uaddr; /* userland ptr */
1220 usb_frlength_t offset;
1228 if (ep_index >= f->fs_ep_max)
1231 xfer = f->fs_xfer[ep_index];
1235 mtx_lock(f->priv_mtx);
1236 if (usbd_transfer_pending(xfer)) {
1237 mtx_unlock(f->priv_mtx);
1238 return (EBUSY); /* should not happen */
1240 mtx_unlock(f->priv_mtx);
1242 fs_ep_uptr = f->fs_ep_ptr + ep_index;
1243 error = copyin(fs_ep_uptr, &fs_ep, sizeof(fs_ep));
1247 fs_ep.status = xfer->error;
1248 fs_ep.aFrames = xfer->aframes;
1249 fs_ep.isoc_time_complete = xfer->isoc_time_complete;
1253 if (xfer->flags_int.control_xfr) {
1254 req = xfer->frbuffers[0].buffer;
1256 /* Host mode only ! */
1257 if ((req->bmRequestType & (UT_READ | UT_WRITE)) == UT_READ) {
1262 if (xfer->nframes == 0)
1263 n = 0; /* should never happen */
1267 /* Device and Host mode */
1268 if (USB_GET_DATA_ISREAD(xfer)) {
1276 /* Update lengths and copy out data */
1278 rem = usbd_xfer_max_len(xfer);
1281 for (; n != xfer->nframes; n++) {
1283 /* get initial length into "temp" */
1284 error = copyin(fs_ep.pLength + n,
1285 &temp, sizeof(temp));
1290 /* the userland length has been corrupted */
1291 DPRINTF("corrupt userland length "
1292 "%u > %u\n", temp, rem);
1293 fs_ep.status = USB_ERR_INVAL;
1298 /* get actual transfer length */
1299 length = xfer->frlengths[n];
1300 if (length > temp) {
1302 fs_ep.status = USB_ERR_INVAL;
1303 DPRINTF("data overflow %u > %u\n",
1309 /* we need to know the destination buffer */
1310 error = copyin(fs_ep.ppBuffer + n,
1311 &uaddr, sizeof(uaddr));
1315 if (xfer->flags_int.isochronous_xfr) {
1316 /* only one frame buffer */
1317 kaddr = USB_ADD_BYTES(
1318 xfer->frbuffers[0].buffer, offset);
1320 /* multiple frame buffers */
1321 kaddr = xfer->frbuffers[n].buffer;
1325 error = copyout(kaddr, uaddr, length);
1331 * Update offset according to initial length, which is
1332 * needed by isochronous transfers!
1337 error = copyout(&length,
1338 fs_ep.pLength + n, sizeof(length));
1345 /* update "aFrames" */
1346 error = copyout(&fs_ep.aFrames, &fs_ep_uptr->aFrames,
1347 sizeof(fs_ep.aFrames));
1351 /* update "isoc_time_complete" */
1352 error = copyout(&fs_ep.isoc_time_complete,
1353 &fs_ep_uptr->isoc_time_complete,
1354 sizeof(fs_ep.isoc_time_complete));
1357 /* update "status" */
1358 error = copyout(&fs_ep.status, &fs_ep_uptr->status,
1359 sizeof(fs_ep.status));
1365 ugen_fifo_in_use(struct usb_fifo *f, int fflags)
1367 struct usb_fifo *f_rx;
1368 struct usb_fifo *f_tx;
1370 f_rx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_RX];
1371 f_tx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_TX];
1373 if ((fflags & FREAD) && f_rx &&
1374 (f_rx->xfer[0] || f_rx->xfer[1])) {
1375 return (1); /* RX FIFO in use */
1377 if ((fflags & FWRITE) && f_tx &&
1378 (f_tx->xfer[0] || f_tx->xfer[1])) {
1379 return (1); /* TX FIFO in use */
1381 return (0); /* not in use */
1385 ugen_ioctl(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
1387 struct usb_config usb_config[1];
1388 struct usb_device_request req;
1390 struct usb_fs_complete *pcomp;
1391 struct usb_fs_start *pstart;
1392 struct usb_fs_stop *pstop;
1393 struct usb_fs_open *popen;
1394 struct usb_fs_close *pclose;
1395 struct usb_fs_clear_stall_sync *pstall;
1398 struct usb_endpoint *ep;
1399 struct usb_endpoint_descriptor *ed;
1400 struct usb_xfer *xfer;
1402 uint8_t iface_index;
1409 DPRINTFN(6, "cmd=0x%08lx\n", cmd);
1412 case USB_FS_COMPLETE:
1413 mtx_lock(f->priv_mtx);
1414 error = ugen_fs_get_complete(f, &ep_index);
1415 mtx_unlock(f->priv_mtx);
1421 u.pcomp->ep_index = ep_index;
1422 error = ugen_fs_copy_out(f, u.pcomp->ep_index);
1426 error = ugen_fs_copy_in(f, u.pstart->ep_index);
1429 mtx_lock(f->priv_mtx);
1430 xfer = f->fs_xfer[u.pstart->ep_index];
1431 usbd_transfer_start(xfer);
1432 mtx_unlock(f->priv_mtx);
1436 if (u.pstop->ep_index >= f->fs_ep_max) {
1440 mtx_lock(f->priv_mtx);
1441 xfer = f->fs_xfer[u.pstart->ep_index];
1442 if (usbd_transfer_pending(xfer)) {
1443 usbd_transfer_stop(xfer);
1445 * Check if the USB transfer was stopped
1446 * before it was even started. Else a cancel
1447 * callback will be pending.
1449 if (!xfer->flags_int.transferring) {
1450 ugen_fs_set_complete(xfer->priv_sc,
1451 USB_P2U(xfer->priv_fifo));
1454 mtx_unlock(f->priv_mtx);
1458 if (u.popen->ep_index >= f->fs_ep_max) {
1462 if (f->fs_xfer[u.popen->ep_index] != NULL) {
1466 if (u.popen->max_bufsize > USB_FS_MAX_BUFSIZE) {
1467 u.popen->max_bufsize = USB_FS_MAX_BUFSIZE;
1469 if (u.popen->max_frames & USB_FS_MAX_FRAMES_PRE_SCALE) {
1471 u.popen->max_frames &= ~USB_FS_MAX_FRAMES_PRE_SCALE;
1475 if (u.popen->max_frames > USB_FS_MAX_FRAMES) {
1476 u.popen->max_frames = USB_FS_MAX_FRAMES;
1479 if (u.popen->max_frames == 0) {
1483 ep = usbd_get_ep_by_addr(f->udev, u.popen->ep_no);
1493 iface_index = ep->iface_index;
1495 memset(usb_config, 0, sizeof(usb_config));
1497 usb_config[0].type = ed->bmAttributes & UE_XFERTYPE;
1498 usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR;
1499 usb_config[0].direction = ed->bEndpointAddress & (UE_DIR_OUT | UE_DIR_IN);
1500 usb_config[0].interval = USB_DEFAULT_INTERVAL;
1501 usb_config[0].flags.proxy_buffer = 1;
1503 usb_config[0].flags.pre_scale_frames = 1;
1504 usb_config[0].callback = &ugen_ctrl_fs_callback;
1505 usb_config[0].timeout = 0; /* no timeout */
1506 usb_config[0].frames = u.popen->max_frames;
1507 usb_config[0].bufsize = u.popen->max_bufsize;
1508 usb_config[0].usb_mode = USB_MODE_DUAL; /* both modes */
1510 if (usb_config[0].type == UE_CONTROL) {
1511 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1517 isread = ((usb_config[0].endpoint &
1518 (UE_DIR_IN | UE_DIR_OUT)) == UE_DIR_IN);
1520 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1523 /* check permissions */
1525 if (!(fflags & FREAD)) {
1530 if (!(fflags & FWRITE)) {
1536 error = usbd_transfer_setup(f->udev, &iface_index,
1537 f->fs_xfer + u.popen->ep_index, usb_config, 1,
1540 /* update maximums */
1541 u.popen->max_packet_length =
1542 f->fs_xfer[u.popen->ep_index]->max_frame_size;
1543 u.popen->max_bufsize =
1544 f->fs_xfer[u.popen->ep_index]->max_data_length;
1545 /* update number of frames */
1546 u.popen->max_frames =
1547 f->fs_xfer[u.popen->ep_index]->nframes;
1548 /* store index of endpoint */
1549 f->fs_xfer[u.popen->ep_index]->priv_fifo =
1550 ((uint8_t *)0) + u.popen->ep_index;
1557 if (u.pclose->ep_index >= f->fs_ep_max) {
1561 if (f->fs_xfer[u.pclose->ep_index] == NULL) {
1565 usbd_transfer_unsetup(f->fs_xfer + u.pclose->ep_index, 1);
1568 case USB_FS_CLEAR_STALL_SYNC:
1569 if (u.pstall->ep_index >= f->fs_ep_max) {
1573 if (f->fs_xfer[u.pstall->ep_index] == NULL) {
1577 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1581 mtx_lock(f->priv_mtx);
1582 error = usbd_transfer_pending(f->fs_xfer[u.pstall->ep_index]);
1583 mtx_unlock(f->priv_mtx);
1588 ep = f->fs_xfer[u.pstall->ep_index]->endpoint;
1590 /* setup a clear-stall packet */
1591 req.bmRequestType = UT_WRITE_ENDPOINT;
1592 req.bRequest = UR_CLEAR_FEATURE;
1593 USETW(req.wValue, UF_ENDPOINT_HALT);
1594 req.wIndex[0] = ep->edesc->bEndpointAddress;
1596 USETW(req.wLength, 0);
1598 error = usbd_do_request(f->udev, NULL, &req, NULL);
1600 usbd_clear_data_toggle(f->udev, ep);
1611 DPRINTFN(6, "error=%d\n", error);
1617 ugen_set_short_xfer(struct usb_fifo *f, void *addr)
1626 if (f->flag_short == t) {
1627 /* same value like before - accept */
1630 if (f->xfer[0] || f->xfer[1]) {
1631 /* cannot change this during transfer */
1639 ugen_set_timeout(struct usb_fifo *f, void *addr)
1641 f->timeout = *(int *)addr;
1642 if (f->timeout > 65535) {
1643 /* limit user input */
1650 ugen_get_frame_size(struct usb_fifo *f, void *addr)
1653 *(int *)addr = f->xfer[0]->max_frame_size;
1661 ugen_set_buffer_size(struct usb_fifo *f, void *addr)
1665 if (*(int *)addr < 0)
1666 t = 0; /* use "wMaxPacketSize" */
1667 else if (*(int *)addr < (256 * 1024))
1672 if (f->bufsize == t) {
1673 /* same value like before - accept */
1676 if (f->xfer[0] || f->xfer[1]) {
1677 /* cannot change this during transfer */
1685 ugen_get_buffer_size(struct usb_fifo *f, void *addr)
1687 *(int *)addr = f->bufsize;
1692 ugen_get_iface_desc(struct usb_fifo *f,
1693 struct usb_interface_descriptor *idesc)
1695 struct usb_interface *iface;
1697 iface = usbd_get_iface(f->udev, f->iface_index);
1698 if (iface && iface->idesc) {
1699 *idesc = *(iface->idesc);
1707 ugen_get_endpoint_desc(struct usb_fifo *f,
1708 struct usb_endpoint_descriptor *ed)
1710 struct usb_endpoint *ep;
1712 ep = usb_fifo_softc(f);
1714 if (ep && ep->edesc) {
1723 ugen_set_power_mode(struct usb_fifo *f, int mode)
1725 struct usb_device *udev = f->udev;
1729 if ((udev == NULL) ||
1730 (udev->parent_hub == NULL)) {
1733 err = priv_check(curthread, PRIV_DRIVER);
1737 /* get old power mode */
1738 old_mode = udev->power_mode;
1740 /* if no change, then just return */
1741 if (old_mode == mode)
1745 case USB_POWER_MODE_OFF:
1746 /* get the device unconfigured */
1747 err = ugen_set_config(f, USB_UNCONFIG_INDEX);
1749 DPRINTFN(0, "Could not unconfigure "
1750 "device (ignored)\n");
1753 /* clear port enable */
1754 err = usbd_req_clear_port_feature(udev->parent_hub,
1755 NULL, udev->port_no, UHF_PORT_ENABLE);
1758 case USB_POWER_MODE_ON:
1759 case USB_POWER_MODE_SAVE:
1762 case USB_POWER_MODE_RESUME:
1764 /* let USB-powerd handle resume */
1765 USB_BUS_LOCK(udev->bus);
1766 udev->pwr_save.write_refs++;
1767 udev->pwr_save.last_xfer_time = ticks;
1768 USB_BUS_UNLOCK(udev->bus);
1770 /* set new power mode */
1771 usbd_set_power_mode(udev, USB_POWER_MODE_SAVE);
1773 /* wait for resume to complete */
1774 usb_pause_mtx(NULL, hz / 4);
1776 /* clear write reference */
1777 USB_BUS_LOCK(udev->bus);
1778 udev->pwr_save.write_refs--;
1779 USB_BUS_UNLOCK(udev->bus);
1781 mode = USB_POWER_MODE_SAVE;
1784 case USB_POWER_MODE_SUSPEND:
1786 /* let USB-powerd handle suspend */
1787 USB_BUS_LOCK(udev->bus);
1788 udev->pwr_save.last_xfer_time = ticks - (256 * hz);
1789 USB_BUS_UNLOCK(udev->bus);
1791 mode = USB_POWER_MODE_SAVE;
1799 return (ENXIO); /* I/O failure */
1801 /* if we are powered off we need to re-enumerate first */
1802 if (old_mode == USB_POWER_MODE_OFF) {
1803 if (udev->flags.usb_mode == USB_MODE_HOST) {
1804 if (udev->re_enumerate_wait == 0)
1805 udev->re_enumerate_wait = 1;
1807 /* set power mode will wake up the explore thread */
1810 /* set new power mode */
1811 usbd_set_power_mode(udev, mode);
1813 return (0); /* success */
1817 ugen_get_power_mode(struct usb_fifo *f)
1819 struct usb_device *udev = f->udev;
1822 return (USB_POWER_MODE_ON);
1824 return (udev->power_mode);
1828 ugen_do_port_feature(struct usb_fifo *f, uint8_t port_no,
1829 uint8_t set, uint16_t feature)
1831 struct usb_device *udev = f->udev;
1832 struct usb_hub *hub;
1835 err = priv_check(curthread, PRIV_DRIVER);
1842 if ((udev == NULL) ||
1843 (udev->hub == NULL)) {
1848 if (port_no > hub->nports) {
1852 err = usbd_req_set_port_feature(udev,
1853 NULL, port_no, feature);
1855 err = usbd_req_clear_port_feature(udev,
1856 NULL, port_no, feature);
1859 return (ENXIO); /* failure */
1861 return (0); /* success */
1865 ugen_iface_ioctl(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
1867 struct usb_fifo *f_rx;
1868 struct usb_fifo *f_tx;
1871 f_rx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_RX];
1872 f_tx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_TX];
1875 case USB_SET_RX_SHORT_XFER:
1876 if (fflags & FREAD) {
1877 error = ugen_set_short_xfer(f_rx, addr);
1883 case USB_SET_TX_FORCE_SHORT:
1884 if (fflags & FWRITE) {
1885 error = ugen_set_short_xfer(f_tx, addr);
1891 case USB_SET_RX_TIMEOUT:
1892 if (fflags & FREAD) {
1893 error = ugen_set_timeout(f_rx, addr);
1899 case USB_SET_TX_TIMEOUT:
1900 if (fflags & FWRITE) {
1901 error = ugen_set_timeout(f_tx, addr);
1907 case USB_GET_RX_FRAME_SIZE:
1908 if (fflags & FREAD) {
1909 error = ugen_get_frame_size(f_rx, addr);
1915 case USB_GET_TX_FRAME_SIZE:
1916 if (fflags & FWRITE) {
1917 error = ugen_get_frame_size(f_tx, addr);
1923 case USB_SET_RX_BUFFER_SIZE:
1924 if (fflags & FREAD) {
1925 error = ugen_set_buffer_size(f_rx, addr);
1931 case USB_SET_TX_BUFFER_SIZE:
1932 if (fflags & FWRITE) {
1933 error = ugen_set_buffer_size(f_tx, addr);
1939 case USB_GET_RX_BUFFER_SIZE:
1940 if (fflags & FREAD) {
1941 error = ugen_get_buffer_size(f_rx, addr);
1947 case USB_GET_TX_BUFFER_SIZE:
1948 if (fflags & FWRITE) {
1949 error = ugen_get_buffer_size(f_tx, addr);
1955 case USB_GET_RX_INTERFACE_DESC:
1956 if (fflags & FREAD) {
1957 error = ugen_get_iface_desc(f_rx, addr);
1963 case USB_GET_TX_INTERFACE_DESC:
1964 if (fflags & FWRITE) {
1965 error = ugen_get_iface_desc(f_tx, addr);
1971 case USB_GET_RX_ENDPOINT_DESC:
1972 if (fflags & FREAD) {
1973 error = ugen_get_endpoint_desc(f_rx, addr);
1979 case USB_GET_TX_ENDPOINT_DESC:
1980 if (fflags & FWRITE) {
1981 error = ugen_get_endpoint_desc(f_tx, addr);
1987 case USB_SET_RX_STALL_FLAG:
1988 if ((fflags & FREAD) && (*(int *)addr)) {
1989 f_rx->flag_stall = 1;
1993 case USB_SET_TX_STALL_FLAG:
1994 if ((fflags & FWRITE) && (*(int *)addr)) {
1995 f_tx->flag_stall = 1;
2007 ugen_ioctl_post(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
2010 struct usb_interface_descriptor *idesc;
2011 struct usb_alt_interface *ai;
2012 struct usb_device_descriptor *ddesc;
2013 struct usb_config_descriptor *cdesc;
2014 struct usb_device_stats *stat;
2015 struct usb_fs_init *pinit;
2016 struct usb_fs_uninit *puninit;
2021 struct usb_device_descriptor *dtemp;
2022 struct usb_config_descriptor *ctemp;
2023 struct usb_interface *iface;
2029 DPRINTFN(6, "cmd=0x%08lx\n", cmd);
2033 usb_needs_explore_all();
2037 if (!(fflags & FWRITE)) {
2041 usb_debug = *(int *)addr;
2044 case USB_GET_CONFIG:
2045 *(int *)addr = f->udev->curr_config_index;
2048 case USB_SET_CONFIG:
2049 if (!(fflags & FWRITE)) {
2053 error = ugen_set_config(f, *(int *)addr);
2056 case USB_GET_ALTINTERFACE:
2057 iface = usbd_get_iface(f->udev,
2058 u.ai->uai_interface_index);
2059 if (iface && iface->idesc) {
2060 u.ai->uai_alt_index = iface->alt_index;
2066 case USB_SET_ALTINTERFACE:
2067 if (!(fflags & FWRITE)) {
2071 error = ugen_set_interface(f,
2072 u.ai->uai_interface_index, u.ai->uai_alt_index);
2075 case USB_GET_DEVICE_DESC:
2076 dtemp = usbd_get_device_descriptor(f->udev);
2084 case USB_GET_CONFIG_DESC:
2085 ctemp = usbd_get_config_descriptor(f->udev);
2093 case USB_GET_FULL_DESC:
2094 error = ugen_get_cdesc(f, addr);
2097 case USB_GET_STRING_DESC:
2098 error = ugen_get_sdesc(f, addr);
2101 case USB_GET_IFACE_DRIVER:
2102 error = ugen_get_iface_driver(f, addr);
2106 case USB_DO_REQUEST:
2107 if (!(fflags & FWRITE)) {
2111 error = ugen_do_request(f, addr);
2114 case USB_DEVICEINFO:
2115 case USB_GET_DEVICEINFO:
2116 error = usb_gen_fill_deviceinfo(f, addr);
2119 case USB_DEVICESTATS:
2120 for (n = 0; n != 4; n++) {
2122 u.stat->uds_requests_fail[n] =
2123 f->udev->bus->stats_err.uds_requests[n];
2125 u.stat->uds_requests_ok[n] =
2126 f->udev->bus->stats_ok.uds_requests[n];
2130 case USB_DEVICEENUMERATE:
2131 error = ugen_re_enumerate(f);
2134 case USB_GET_PLUGTIME:
2135 *u.ptime = f->udev->plugtime;
2138 case USB_CLAIM_INTERFACE:
2139 case USB_RELEASE_INTERFACE:
2143 case USB_IFACE_DRIVER_ACTIVE:
2147 iface = usbd_get_iface(f->udev, n);
2149 if (iface && iface->subdev)
2155 case USB_IFACE_DRIVER_DETACH:
2157 error = priv_check(curthread, PRIV_DRIVER);
2164 if (n == USB_IFACE_INDEX_ANY) {
2170 * Detach the currently attached driver.
2172 usb_detach_device(f->udev, n, 0);
2175 * Set parent to self, this should keep attach away
2176 * until the next set configuration event.
2178 usbd_set_parent_iface(f->udev, n, n);
2181 case USB_SET_POWER_MODE:
2182 error = ugen_set_power_mode(f, *u.pint);
2185 case USB_GET_POWER_MODE:
2186 *u.pint = ugen_get_power_mode(f);
2189 case USB_SET_PORT_ENABLE:
2190 error = ugen_do_port_feature(f,
2191 *u.pint, 1, UHF_PORT_ENABLE);
2194 case USB_SET_PORT_DISABLE:
2195 error = ugen_do_port_feature(f,
2196 *u.pint, 0, UHF_PORT_ENABLE);
2200 /* verify input parameters */
2201 if (u.pinit->pEndpoints == NULL) {
2205 if (u.pinit->ep_index_max > 127) {
2209 if (u.pinit->ep_index_max == 0) {
2213 if (f->fs_xfer != NULL) {
2217 if (f->dev_ep_index != 0) {
2221 if (ugen_fifo_in_use(f, fflags)) {
2225 error = usb_fifo_alloc_buffer(f, 1, u.pinit->ep_index_max);
2229 f->fs_xfer = malloc(sizeof(f->fs_xfer[0]) *
2230 u.pinit->ep_index_max, M_USB, M_WAITOK | M_ZERO);
2231 if (f->fs_xfer == NULL) {
2232 usb_fifo_free_buffer(f);
2236 f->fs_ep_max = u.pinit->ep_index_max;
2237 f->fs_ep_ptr = u.pinit->pEndpoints;
2241 if (u.puninit->dummy != 0) {
2245 error = ugen_fs_uninit(f);
2249 mtx_lock(f->priv_mtx);
2250 error = ugen_iface_ioctl(f, cmd, addr, fflags);
2251 mtx_unlock(f->priv_mtx);
2254 DPRINTFN(6, "error=%d\n", error);
2259 ugen_ctrl_fs_callback(struct usb_xfer *xfer, usb_error_t error)
2261 ; /* workaround for a bug in "indent" */
2263 DPRINTF("st=%u alen=%u aframes=%u\n",
2264 USB_GET_STATE(xfer), xfer->actlen, xfer->aframes);
2266 switch (USB_GET_STATE(xfer)) {
2268 usbd_transfer_submit(xfer);
2271 ugen_fs_set_complete(xfer->priv_sc, USB_P2U(xfer->priv_fifo));
2275 #endif /* USB_HAVE_UGEN */