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 static SYSCTL_NODE(_hw_usb, OID_AUTO, ugen, CTLFLAG_RW, 0, "USB generic");
130 SYSCTL_INT(_hw_usb_ugen, OID_AUTO, debug, CTLFLAG_RW | CTLFLAG_TUN, &ugen_debug,
132 TUNABLE_INT("hw.usb.ugen.debug", &ugen_debug);
139 ugen_transfer_setup(struct usb_fifo *f,
140 const struct usb_config *setup, uint8_t n_setup)
142 struct usb_endpoint *ep = usb_fifo_softc(f);
143 struct usb_device *udev = f->udev;
144 uint8_t iface_index = ep->iface_index;
147 mtx_unlock(f->priv_mtx);
150 * "usbd_transfer_setup()" can sleep so one needs to make a wrapper,
151 * exiting the mutex and checking things
153 error = usbd_transfer_setup(udev, &iface_index, f->xfer,
154 setup, n_setup, f, f->priv_mtx);
157 if (f->xfer[0]->nframes == 1) {
158 error = usb_fifo_alloc_buffer(f,
159 f->xfer[0]->max_data_length, 2);
161 error = usb_fifo_alloc_buffer(f,
162 f->xfer[0]->max_frame_size,
163 2 * f->xfer[0]->nframes);
166 usbd_transfer_unsetup(f->xfer, n_setup);
169 mtx_lock(f->priv_mtx);
175 ugen_open(struct usb_fifo *f, int fflags)
177 struct usb_endpoint *ep = usb_fifo_softc(f);
178 struct usb_endpoint_descriptor *ed = ep->edesc;
181 DPRINTFN(6, "flag=0x%x\n", fflags);
183 mtx_lock(f->priv_mtx);
184 switch (usbd_get_speed(f->udev)) {
187 f->nframes = UGEN_HW_FRAMES;
188 f->bufsize = UGEN_BULK_FS_BUFFER_SIZE;
191 f->nframes = UGEN_HW_FRAMES * 8;
192 f->bufsize = UGEN_BULK_HS_BUFFER_SIZE;
196 type = ed->bmAttributes & UE_XFERTYPE;
197 if (type == UE_INTERRUPT) {
198 f->bufsize = 0; /* use "wMaxPacketSize" */
200 f->timeout = USB_NO_TIMEOUT;
203 mtx_unlock(f->priv_mtx);
209 ugen_close(struct usb_fifo *f, int fflags)
211 DPRINTFN(6, "flag=0x%x\n", fflags);
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);
220 usbd_transfer_unsetup(f->xfer, 2);
221 usb_fifo_free_buffer(f);
223 if (ugen_fs_uninit(f)) {
224 /* ignore any errors - we are closing */
225 DPRINTFN(6, "no FIFOs\n");
230 ugen_open_pipe_write(struct usb_fifo *f)
232 struct usb_config usb_config[2];
233 struct usb_endpoint *ep = usb_fifo_softc(f);
234 struct usb_endpoint_descriptor *ed = ep->edesc;
236 mtx_assert(f->priv_mtx, MA_OWNED);
238 if (f->xfer[0] || f->xfer[1]) {
239 /* transfers are already opened */
242 memset(usb_config, 0, sizeof(usb_config));
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;
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 */
260 switch (ed->bmAttributes & UE_XFERTYPE) {
264 usb_config[0].flags.force_short_xfer = 1;
266 usb_config[0].callback = &ugen_ctrl_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)) {
273 /* first transfer does not clear stall */
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;
284 /* clone configuration */
285 usb_config[1] = usb_config[0];
287 if (ugen_transfer_setup(f, usb_config, 2)) {
298 ugen_open_pipe_read(struct usb_fifo *f)
300 struct usb_config usb_config[2];
301 struct usb_endpoint *ep = usb_fifo_softc(f);
302 struct usb_endpoint_descriptor *ed = ep->edesc;
304 mtx_assert(f->priv_mtx, MA_OWNED);
306 if (f->xfer[0] || f->xfer[1]) {
307 /* transfers are already opened */
310 memset(usb_config, 0, sizeof(usb_config));
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;
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 */
328 switch (ed->bmAttributes & UE_XFERTYPE) {
332 usb_config[0].flags.short_xfer_ok = 1;
334 usb_config[0].timeout = f->timeout;
335 usb_config[0].frames = 1;
336 usb_config[0].callback = &ugen_ctrl_read_callback;
337 usb_config[0].bufsize = f->bufsize;
339 if (ugen_transfer_setup(f, usb_config, 2)) {
342 /* first transfer does not clear stall */
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;
353 /* clone configuration */
354 usb_config[1] = usb_config[0];
356 if (ugen_transfer_setup(f, usb_config, 2)) {
368 ugen_start_read(struct usb_fifo *f)
370 /* check that pipes are open */
371 if (ugen_open_pipe_read(f)) {
373 usb_fifo_put_data_error(f);
375 /* start transfers */
376 usbd_transfer_start(f->xfer[0]);
377 usbd_transfer_start(f->xfer[1]);
381 ugen_start_write(struct usb_fifo *f)
383 /* check that pipes are open */
384 if (ugen_open_pipe_write(f)) {
386 usb_fifo_get_data_error(f);
388 /* start transfers */
389 usbd_transfer_start(f->xfer[0]);
390 usbd_transfer_start(f->xfer[1]);
394 ugen_stop_io(struct usb_fifo *f)
397 usbd_transfer_stop(f->xfer[0]);
398 usbd_transfer_stop(f->xfer[1]);
402 ugen_ctrl_read_callback(struct usb_xfer *xfer, usb_error_t error)
404 struct usb_fifo *f = usbd_xfer_softc(xfer);
407 DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
409 switch (USB_GET_STATE(xfer)) {
410 case USB_ST_TRANSFERRED:
411 if (xfer->actlen == 0) {
412 if (f->fifo_zlp != 4) {
416 * Throttle a little bit we have multiple ZLPs
419 xfer->interval = 64; /* ms */
426 usb_fifo_put_data(f, xfer->frbuffers, 0,
431 usbd_transfer_start(f->xfer[1]);
434 USB_IF_POLL(&f->free_q, m);
436 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
437 usbd_transfer_submit(xfer);
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);
447 usbd_transfer_start(f->xfer[1]);
454 ugen_ctrl_write_callback(struct usb_xfer *xfer, usb_error_t error)
456 struct usb_fifo *f = usbd_xfer_softc(xfer);
457 usb_frlength_t actlen;
459 DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
461 switch (USB_GET_STATE(xfer)) {
463 case USB_ST_TRANSFERRED:
465 * If writing is in stall, just jump to clear stall
466 * callback and solve the situation.
469 usbd_transfer_start(f->xfer[1]);
473 * Write data, setup and perform hardware transfer.
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);
483 if (xfer->error != USB_ERR_CANCELLED) {
485 usbd_transfer_start(f->xfer[1]);
492 ugen_read_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error)
494 struct usb_fifo *f = usbd_xfer_softc(xfer);
495 struct usb_xfer *xfer_other = f->xfer[0];
497 if (f->flag_stall == 0) {
501 if (usbd_clear_stall_callback(xfer, xfer_other)) {
502 DPRINTFN(5, "f=%p: stall cleared\n", f);
504 usbd_transfer_start(xfer_other);
509 ugen_write_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error)
511 struct usb_fifo *f = usbd_xfer_softc(xfer);
512 struct usb_xfer *xfer_other = f->xfer[0];
514 if (f->flag_stall == 0) {
518 if (usbd_clear_stall_callback(xfer, xfer_other)) {
519 DPRINTFN(5, "f=%p: stall cleared\n", f);
521 usbd_transfer_start(xfer_other);
526 ugen_isoc_read_callback(struct usb_xfer *xfer, usb_error_t error)
528 struct usb_fifo *f = usbd_xfer_softc(xfer);
529 usb_frlength_t offset;
532 DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
534 switch (USB_GET_STATE(xfer)) {
535 case USB_ST_TRANSFERRED:
537 DPRINTFN(6, "actlen=%d\n", xfer->actlen);
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;
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);
553 usbd_transfer_submit(xfer);
557 if (xfer->error == USB_ERR_CANCELLED) {
565 ugen_isoc_write_callback(struct usb_xfer *xfer, usb_error_t error)
567 struct usb_fifo *f = usbd_xfer_softc(xfer);
568 usb_frlength_t actlen;
569 usb_frlength_t offset;
572 DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
574 switch (USB_GET_STATE(xfer)) {
575 case USB_ST_TRANSFERRED:
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);
589 for (; n != xfer->nframes; n++) {
590 /* fill in zero frames */
591 usbd_xfer_set_frame_len(xfer, n, 0);
593 usbd_transfer_submit(xfer);
597 if (xfer->error == USB_ERR_CANCELLED) {
605 ugen_set_config(struct usb_fifo *f, uint8_t index)
607 DPRINTFN(2, "index %u\n", index);
609 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
610 /* not possible in device side mode */
614 /* make sure all FIFO's are gone */
615 /* else there can be a deadlock */
616 if (ugen_fs_uninit(f)) {
617 /* ignore any errors */
618 DPRINTFN(6, "no FIFOs\n");
621 if (usbd_start_set_config(f->udev, index) != 0)
628 ugen_set_interface(struct usb_fifo *f,
629 uint8_t iface_index, uint8_t alt_index)
631 DPRINTFN(2, "%u, %u\n", iface_index, alt_index);
633 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
634 /* not possible in device side mode */
637 /* make sure all FIFO's are gone */
638 /* else there can be a deadlock */
639 if (ugen_fs_uninit(f)) {
640 /* ignore any errors */
641 DPRINTFN(6, "no FIFOs\n");
643 /* change setting - will free generic FIFOs, if any */
644 if (usbd_set_alt_interface_index(f->udev, iface_index, alt_index)) {
647 /* probe and attach */
648 if (usb_probe_and_attach(f->udev, iface_index)) {
654 /*------------------------------------------------------------------------*
657 * This function will retrieve the complete configuration descriptor
658 * at the given index.
659 *------------------------------------------------------------------------*/
661 ugen_get_cdesc(struct usb_fifo *f, struct usb_gen_descriptor *ugd)
663 struct usb_config_descriptor *cdesc;
664 struct usb_device *udev = f->udev;
671 if (ugd->ugd_data == NULL) {
672 /* userland pointer should not be zero */
675 if ((ugd->ugd_config_index == USB_UNCONFIG_INDEX) ||
676 (ugd->ugd_config_index == udev->curr_config_index)) {
677 cdesc = usbd_get_config_descriptor(udev);
684 if (usbd_req_get_config_desc_full(udev,
685 NULL, &cdesc, M_USBDEV,
686 ugd->ugd_config_index)) {
692 len = UGETW(cdesc->wTotalLength);
693 if (len > ugd->ugd_maxlen) {
694 len = ugd->ugd_maxlen;
696 DPRINTFN(6, "len=%u\n", len);
698 ugd->ugd_actlen = len;
701 error = copyout(cdesc, ugd->ugd_data, len);
704 free(cdesc, M_USBDEV);
710 ugen_get_sdesc(struct usb_fifo *f, struct usb_gen_descriptor *ugd)
717 /* Protect scratch area */
718 do_unlock = usbd_ctrl_lock(f->udev);
720 ptr = f->udev->scratch.data;
721 size = sizeof(f->udev->scratch.data);
723 if (usbd_req_get_string_desc(f->udev, NULL, ptr,
724 size, ugd->ugd_lang_id, ugd->ugd_string_index)) {
728 if (size > ((uint8_t *)ptr)[0]) {
729 size = ((uint8_t *)ptr)[0];
731 if (size > ugd->ugd_maxlen) {
732 size = ugd->ugd_maxlen;
734 ugd->ugd_actlen = size;
737 error = copyout(ptr, ugd->ugd_data, size);
740 usbd_ctrl_unlock(f->udev);
745 /*------------------------------------------------------------------------*
746 * ugen_get_iface_driver
748 * This function generates an USB interface description for userland.
753 *------------------------------------------------------------------------*/
755 ugen_get_iface_driver(struct usb_fifo *f, struct usb_gen_descriptor *ugd)
757 struct usb_device *udev = f->udev;
758 struct usb_interface *iface;
768 if ((ugd->ugd_data == NULL) || (ugd->ugd_maxlen == 0)) {
769 /* userland pointer should not be zero */
773 iface = usbd_get_iface(udev, ugd->ugd_iface_index);
774 if ((iface == NULL) || (iface->idesc == NULL)) {
775 /* invalid interface index */
779 /* read out device nameunit string, if any */
780 if ((iface->subdev != NULL) &&
781 device_is_attached(iface->subdev) &&
782 (ptr = device_get_nameunit(iface->subdev)) &&
783 (desc = device_get_desc(iface->subdev))) {
785 /* print description */
786 snprintf(buf, sizeof(buf), "%s: <%s>", ptr, desc);
789 maxlen = ugd->ugd_maxlen - 1;
794 /* update actual length, including terminating zero */
795 ugd->ugd_actlen = len + 1;
797 /* copy out interface description */
798 error = copyout(buf, ugd->ugd_data, ugd->ugd_actlen);
800 /* zero length string is default */
801 error = copyout("", ugd->ugd_data, 1);
806 /*------------------------------------------------------------------------*
807 * usb_gen_fill_deviceinfo
809 * This function dumps information about an USB device to the
810 * structure pointed to by the "di" argument.
815 *------------------------------------------------------------------------*/
817 usb_gen_fill_deviceinfo(struct usb_fifo *f, struct usb_device_info *di)
819 struct usb_device *udev;
820 struct usb_device *hub;
824 bzero(di, sizeof(di[0]));
826 di->udi_bus = device_get_unit(udev->bus->bdev);
827 di->udi_addr = udev->address;
828 di->udi_index = udev->device_index;
829 strlcpy(di->udi_serial, usb_get_serial(udev), sizeof(di->udi_serial));
830 strlcpy(di->udi_vendor, usb_get_manufacturer(udev), sizeof(di->udi_vendor));
831 strlcpy(di->udi_product, usb_get_product(udev), sizeof(di->udi_product));
832 usb_printbcd(di->udi_release, sizeof(di->udi_release),
833 UGETW(udev->ddesc.bcdDevice));
834 di->udi_vendorNo = UGETW(udev->ddesc.idVendor);
835 di->udi_productNo = UGETW(udev->ddesc.idProduct);
836 di->udi_releaseNo = UGETW(udev->ddesc.bcdDevice);
837 di->udi_class = udev->ddesc.bDeviceClass;
838 di->udi_subclass = udev->ddesc.bDeviceSubClass;
839 di->udi_protocol = udev->ddesc.bDeviceProtocol;
840 di->udi_config_no = udev->curr_config_no;
841 di->udi_config_index = udev->curr_config_index;
842 di->udi_power = udev->flags.self_powered ? 0 : udev->power;
843 di->udi_speed = udev->speed;
844 di->udi_mode = udev->flags.usb_mode;
845 di->udi_power_mode = udev->power_mode;
846 di->udi_suspended = udev->flags.peer_suspended;
848 hub = udev->parent_hub;
850 di->udi_hubaddr = hub->address;
851 di->udi_hubindex = hub->device_index;
852 di->udi_hubport = udev->port_no;
857 /*------------------------------------------------------------------------*
863 *------------------------------------------------------------------------*/
865 ugen_check_request(struct usb_device *udev, struct usb_device_request *req)
867 struct usb_endpoint *ep;
871 * Avoid requests that would damage the bus integrity:
873 if (((req->bmRequestType == UT_WRITE_DEVICE) &&
874 (req->bRequest == UR_SET_ADDRESS)) ||
875 ((req->bmRequestType == UT_WRITE_DEVICE) &&
876 (req->bRequest == UR_SET_CONFIG)) ||
877 ((req->bmRequestType == UT_WRITE_INTERFACE) &&
878 (req->bRequest == UR_SET_INTERFACE))) {
880 * These requests can be useful for testing USB drivers.
882 error = priv_check(curthread, PRIV_DRIVER);
888 * Special case - handle clearing of stall
890 if (req->bmRequestType == UT_WRITE_ENDPOINT) {
892 ep = usbd_get_ep_by_addr(udev, req->wIndex[0]);
896 if ((req->bRequest == UR_CLEAR_FEATURE) &&
897 (UGETW(req->wValue) == UF_ENDPOINT_HALT)) {
898 usbd_clear_data_toggle(udev, ep);
901 /* TODO: add more checks to verify the interface index */
907 ugen_do_request(struct usb_fifo *f, struct usb_ctl_request *ur)
913 if (ugen_check_request(f->udev, &ur->ucr_request)) {
916 len = UGETW(ur->ucr_request.wLength);
918 /* check if "ucr_data" is valid */
920 if (ur->ucr_data == NULL) {
924 /* do the USB request */
925 error = usbd_do_request_flags
926 (f->udev, NULL, &ur->ucr_request, ur->ucr_data,
927 (ur->ucr_flags & USB_SHORT_XFER_OK) |
928 USB_USER_DATA_PTR, &actlen,
929 USB_DEFAULT_TIMEOUT);
931 ur->ucr_actlen = actlen;
939 /*------------------------------------------------------------------------
941 *------------------------------------------------------------------------*/
943 ugen_re_enumerate(struct usb_fifo *f)
945 struct usb_device *udev = f->udev;
949 * This request can be useful for testing USB drivers:
951 error = priv_check(curthread, PRIV_DRIVER);
955 if (udev->flags.usb_mode != USB_MODE_HOST) {
956 /* not possible in device side mode */
957 DPRINTFN(6, "device mode\n");
960 /* make sure all FIFO's are gone */
961 /* else there can be a deadlock */
962 if (ugen_fs_uninit(f)) {
963 /* ignore any errors */
964 DPRINTFN(6, "no FIFOs\n");
966 /* start re-enumeration of device */
967 usbd_start_re_enumerate(udev);
972 ugen_fs_uninit(struct usb_fifo *f)
974 if (f->fs_xfer == NULL) {
977 usbd_transfer_unsetup(f->fs_xfer, f->fs_ep_max);
978 free(f->fs_xfer, M_USB);
982 f->flag_iscomplete = 0;
983 usb_fifo_free_buffer(f);
988 ugen_fs_get_complete(struct usb_fifo *f, uint8_t *pindex)
992 USB_IF_DEQUEUE(&f->used_q, m);
995 *pindex = *((uint8_t *)(m->cur_data_ptr));
997 USB_IF_ENQUEUE(&f->free_q, m);
999 return (0); /* success */
1002 *pindex = 0; /* fix compiler warning */
1004 f->flag_iscomplete = 0;
1006 return (1); /* failure */
1010 ugen_fs_set_complete(struct usb_fifo *f, uint8_t index)
1014 USB_IF_DEQUEUE(&f->free_q, m);
1017 /* can happen during close */
1018 DPRINTF("out of buffers\n");
1023 *((uint8_t *)(m->cur_data_ptr)) = index;
1025 USB_IF_ENQUEUE(&f->used_q, m);
1027 f->flag_iscomplete = 1;
1033 ugen_fs_copy_in(struct usb_fifo *f, uint8_t ep_index)
1035 struct usb_device_request *req;
1036 struct usb_xfer *xfer;
1037 struct usb_fs_endpoint fs_ep;
1038 void *uaddr; /* userland pointer */
1040 usb_frlength_t offset;
1047 if (ep_index >= f->fs_ep_max) {
1050 xfer = f->fs_xfer[ep_index];
1054 mtx_lock(f->priv_mtx);
1055 if (usbd_transfer_pending(xfer)) {
1056 mtx_unlock(f->priv_mtx);
1057 return (EBUSY); /* should not happen */
1059 mtx_unlock(f->priv_mtx);
1061 error = copyin(f->fs_ep_ptr +
1062 ep_index, &fs_ep, sizeof(fs_ep));
1066 /* security checks */
1068 if (fs_ep.nFrames > xfer->max_frame_count) {
1069 xfer->error = USB_ERR_INVAL;
1072 if (fs_ep.nFrames == 0) {
1073 xfer->error = USB_ERR_INVAL;
1076 error = copyin(fs_ep.ppBuffer,
1077 &uaddr, sizeof(uaddr));
1081 /* reset first frame */
1082 usbd_xfer_set_frame_offset(xfer, 0, 0);
1084 if (xfer->flags_int.control_xfr) {
1086 req = xfer->frbuffers[0].buffer;
1088 error = copyin(fs_ep.pLength,
1089 &length, sizeof(length));
1093 if (length != sizeof(*req)) {
1094 xfer->error = USB_ERR_INVAL;
1098 error = copyin(uaddr, req, length);
1103 if (ugen_check_request(f->udev, req)) {
1104 xfer->error = USB_ERR_INVAL;
1107 usbd_xfer_set_frame_len(xfer, 0, length);
1109 /* Host mode only ! */
1110 if ((req->bmRequestType &
1111 (UT_READ | UT_WRITE)) == UT_READ) {
1117 offset = sizeof(*req);
1120 /* Device and Host mode */
1121 if (USB_GET_DATA_ISREAD(xfer)) {
1130 rem = usbd_xfer_max_len(xfer);
1131 xfer->nframes = fs_ep.nFrames;
1132 xfer->timeout = fs_ep.timeout;
1133 if (xfer->timeout > 65535) {
1134 xfer->timeout = 65535;
1136 if (fs_ep.flags & USB_FS_FLAG_SINGLE_SHORT_OK)
1137 xfer->flags.short_xfer_ok = 1;
1139 xfer->flags.short_xfer_ok = 0;
1141 if (fs_ep.flags & USB_FS_FLAG_MULTI_SHORT_OK)
1142 xfer->flags.short_frames_ok = 1;
1144 xfer->flags.short_frames_ok = 0;
1146 if (fs_ep.flags & USB_FS_FLAG_FORCE_SHORT)
1147 xfer->flags.force_short_xfer = 1;
1149 xfer->flags.force_short_xfer = 0;
1151 if (fs_ep.flags & USB_FS_FLAG_CLEAR_STALL)
1152 usbd_xfer_set_stall(xfer);
1154 xfer->flags.stall_pipe = 0;
1156 for (; n != xfer->nframes; n++) {
1158 error = copyin(fs_ep.pLength + n,
1159 &length, sizeof(length));
1163 usbd_xfer_set_frame_len(xfer, n, length);
1166 xfer->error = USB_ERR_INVAL;
1173 /* we need to know the source buffer */
1174 error = copyin(fs_ep.ppBuffer + n,
1175 &uaddr, sizeof(uaddr));
1179 if (xfer->flags_int.isochronous_xfr) {
1180 /* get kernel buffer address */
1181 kaddr = xfer->frbuffers[0].buffer;
1182 kaddr = USB_ADD_BYTES(kaddr, offset);
1184 /* set current frame offset */
1185 usbd_xfer_set_frame_offset(xfer, offset, n);
1187 /* get kernel buffer address */
1188 kaddr = xfer->frbuffers[n].buffer;
1192 error = copyin(uaddr, kaddr, length);
1202 mtx_lock(f->priv_mtx);
1203 ugen_fs_set_complete(f, ep_index);
1204 mtx_unlock(f->priv_mtx);
1209 ugen_fs_copy_out_cancelled(struct usb_fs_endpoint *fs_ep_uptr)
1211 struct usb_fs_endpoint fs_ep;
1214 error = copyin(fs_ep_uptr, &fs_ep, sizeof(fs_ep));
1218 fs_ep.status = USB_ERR_CANCELLED;
1220 fs_ep.isoc_time_complete = 0;
1222 /* update "aFrames" */
1223 error = copyout(&fs_ep.aFrames, &fs_ep_uptr->aFrames,
1224 sizeof(fs_ep.aFrames));
1228 /* update "isoc_time_complete" */
1229 error = copyout(&fs_ep.isoc_time_complete,
1230 &fs_ep_uptr->isoc_time_complete,
1231 sizeof(fs_ep.isoc_time_complete));
1235 /* update "status" */
1236 error = copyout(&fs_ep.status, &fs_ep_uptr->status,
1237 sizeof(fs_ep.status));
1243 ugen_fs_copy_out(struct usb_fifo *f, uint8_t ep_index)
1245 struct usb_device_request *req;
1246 struct usb_xfer *xfer;
1247 struct usb_fs_endpoint fs_ep;
1248 struct usb_fs_endpoint *fs_ep_uptr; /* userland ptr */
1249 void *uaddr; /* userland ptr */
1251 usb_frlength_t offset;
1259 if (ep_index >= f->fs_ep_max)
1262 xfer = f->fs_xfer[ep_index];
1266 mtx_lock(f->priv_mtx);
1267 if (!xfer->flags_int.transferring &&
1268 !xfer->flags_int.started) {
1269 mtx_unlock(f->priv_mtx);
1270 DPRINTF("Returning fake cancel event\n");
1271 return (ugen_fs_copy_out_cancelled(f->fs_ep_ptr + ep_index));
1272 } else if (usbd_transfer_pending(xfer)) {
1273 mtx_unlock(f->priv_mtx);
1274 return (EBUSY); /* should not happen */
1276 mtx_unlock(f->priv_mtx);
1278 fs_ep_uptr = f->fs_ep_ptr + ep_index;
1279 error = copyin(fs_ep_uptr, &fs_ep, sizeof(fs_ep));
1283 fs_ep.status = xfer->error;
1284 fs_ep.aFrames = xfer->aframes;
1285 fs_ep.isoc_time_complete = xfer->isoc_time_complete;
1289 if (xfer->flags_int.control_xfr) {
1290 req = xfer->frbuffers[0].buffer;
1292 /* Host mode only ! */
1293 if ((req->bmRequestType & (UT_READ | UT_WRITE)) == UT_READ) {
1298 if (xfer->nframes == 0)
1299 n = 0; /* should never happen */
1303 /* Device and Host mode */
1304 if (USB_GET_DATA_ISREAD(xfer)) {
1312 /* Update lengths and copy out data */
1314 rem = usbd_xfer_max_len(xfer);
1317 for (; n != xfer->nframes; n++) {
1319 /* get initial length into "temp" */
1320 error = copyin(fs_ep.pLength + n,
1321 &temp, sizeof(temp));
1326 /* the userland length has been corrupted */
1327 DPRINTF("corrupt userland length "
1328 "%u > %u\n", temp, rem);
1329 fs_ep.status = USB_ERR_INVAL;
1334 /* get actual transfer length */
1335 length = xfer->frlengths[n];
1336 if (length > temp) {
1338 fs_ep.status = USB_ERR_INVAL;
1339 DPRINTF("data overflow %u > %u\n",
1345 /* we need to know the destination buffer */
1346 error = copyin(fs_ep.ppBuffer + n,
1347 &uaddr, sizeof(uaddr));
1351 if (xfer->flags_int.isochronous_xfr) {
1352 /* only one frame buffer */
1353 kaddr = USB_ADD_BYTES(
1354 xfer->frbuffers[0].buffer, offset);
1356 /* multiple frame buffers */
1357 kaddr = xfer->frbuffers[n].buffer;
1361 error = copyout(kaddr, uaddr, length);
1367 * Update offset according to initial length, which is
1368 * needed by isochronous transfers!
1373 error = copyout(&length,
1374 fs_ep.pLength + n, sizeof(length));
1381 /* update "aFrames" */
1382 error = copyout(&fs_ep.aFrames, &fs_ep_uptr->aFrames,
1383 sizeof(fs_ep.aFrames));
1387 /* update "isoc_time_complete" */
1388 error = copyout(&fs_ep.isoc_time_complete,
1389 &fs_ep_uptr->isoc_time_complete,
1390 sizeof(fs_ep.isoc_time_complete));
1394 /* update "status" */
1395 error = copyout(&fs_ep.status, &fs_ep_uptr->status,
1396 sizeof(fs_ep.status));
1402 ugen_fifo_in_use(struct usb_fifo *f, int fflags)
1404 struct usb_fifo *f_rx;
1405 struct usb_fifo *f_tx;
1407 f_rx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_RX];
1408 f_tx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_TX];
1410 if ((fflags & FREAD) && f_rx &&
1411 (f_rx->xfer[0] || f_rx->xfer[1])) {
1412 return (1); /* RX FIFO in use */
1414 if ((fflags & FWRITE) && f_tx &&
1415 (f_tx->xfer[0] || f_tx->xfer[1])) {
1416 return (1); /* TX FIFO in use */
1418 return (0); /* not in use */
1422 ugen_ioctl(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
1424 struct usb_config usb_config[1];
1425 struct usb_device_request req;
1427 struct usb_fs_complete *pcomp;
1428 struct usb_fs_start *pstart;
1429 struct usb_fs_stop *pstop;
1430 struct usb_fs_open *popen;
1431 struct usb_fs_close *pclose;
1432 struct usb_fs_clear_stall_sync *pstall;
1435 struct usb_endpoint *ep;
1436 struct usb_endpoint_descriptor *ed;
1437 struct usb_xfer *xfer;
1439 uint8_t iface_index;
1446 DPRINTFN(6, "cmd=0x%08lx\n", cmd);
1449 case USB_FS_COMPLETE:
1450 mtx_lock(f->priv_mtx);
1451 error = ugen_fs_get_complete(f, &ep_index);
1452 mtx_unlock(f->priv_mtx);
1458 u.pcomp->ep_index = ep_index;
1459 error = ugen_fs_copy_out(f, u.pcomp->ep_index);
1463 error = ugen_fs_copy_in(f, u.pstart->ep_index);
1466 mtx_lock(f->priv_mtx);
1467 xfer = f->fs_xfer[u.pstart->ep_index];
1468 usbd_transfer_start(xfer);
1469 mtx_unlock(f->priv_mtx);
1473 if (u.pstop->ep_index >= f->fs_ep_max) {
1477 mtx_lock(f->priv_mtx);
1478 xfer = f->fs_xfer[u.pstart->ep_index];
1479 if (usbd_transfer_pending(xfer)) {
1480 usbd_transfer_stop(xfer);
1483 * Check if the USB transfer was stopped
1484 * before it was even started and fake a
1487 if (!xfer->flags_int.transferring &&
1488 !xfer->flags_int.started) {
1489 DPRINTF("Issuing fake completion event\n");
1490 ugen_fs_set_complete(xfer->priv_sc,
1491 USB_P2U(xfer->priv_fifo));
1494 mtx_unlock(f->priv_mtx);
1498 if (u.popen->ep_index >= f->fs_ep_max) {
1502 if (f->fs_xfer[u.popen->ep_index] != NULL) {
1506 if (u.popen->max_bufsize > USB_FS_MAX_BUFSIZE) {
1507 u.popen->max_bufsize = USB_FS_MAX_BUFSIZE;
1509 if (u.popen->max_frames & USB_FS_MAX_FRAMES_PRE_SCALE) {
1511 u.popen->max_frames &= ~USB_FS_MAX_FRAMES_PRE_SCALE;
1515 if (u.popen->max_frames > USB_FS_MAX_FRAMES) {
1516 u.popen->max_frames = USB_FS_MAX_FRAMES;
1519 if (u.popen->max_frames == 0) {
1523 ep = usbd_get_ep_by_addr(f->udev, u.popen->ep_no);
1533 iface_index = ep->iface_index;
1535 memset(usb_config, 0, sizeof(usb_config));
1537 usb_config[0].type = ed->bmAttributes & UE_XFERTYPE;
1538 usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR;
1539 usb_config[0].direction = ed->bEndpointAddress & (UE_DIR_OUT | UE_DIR_IN);
1540 usb_config[0].interval = USB_DEFAULT_INTERVAL;
1541 usb_config[0].flags.proxy_buffer = 1;
1543 usb_config[0].flags.pre_scale_frames = 1;
1544 usb_config[0].callback = &ugen_ctrl_fs_callback;
1545 usb_config[0].timeout = 0; /* no timeout */
1546 usb_config[0].frames = u.popen->max_frames;
1547 usb_config[0].bufsize = u.popen->max_bufsize;
1548 usb_config[0].usb_mode = USB_MODE_DUAL; /* both modes */
1550 if (usb_config[0].type == UE_CONTROL) {
1551 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1557 isread = ((usb_config[0].endpoint &
1558 (UE_DIR_IN | UE_DIR_OUT)) == UE_DIR_IN);
1560 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1563 /* check permissions */
1565 if (!(fflags & FREAD)) {
1570 if (!(fflags & FWRITE)) {
1576 error = usbd_transfer_setup(f->udev, &iface_index,
1577 f->fs_xfer + u.popen->ep_index, usb_config, 1,
1580 /* update maximums */
1581 u.popen->max_packet_length =
1582 f->fs_xfer[u.popen->ep_index]->max_frame_size;
1583 u.popen->max_bufsize =
1584 f->fs_xfer[u.popen->ep_index]->max_data_length;
1585 /* update number of frames */
1586 u.popen->max_frames =
1587 f->fs_xfer[u.popen->ep_index]->nframes;
1588 /* store index of endpoint */
1589 f->fs_xfer[u.popen->ep_index]->priv_fifo =
1590 ((uint8_t *)0) + u.popen->ep_index;
1597 if (u.pclose->ep_index >= f->fs_ep_max) {
1601 if (f->fs_xfer[u.pclose->ep_index] == NULL) {
1605 usbd_transfer_unsetup(f->fs_xfer + u.pclose->ep_index, 1);
1608 case USB_FS_CLEAR_STALL_SYNC:
1609 if (u.pstall->ep_index >= f->fs_ep_max) {
1613 if (f->fs_xfer[u.pstall->ep_index] == NULL) {
1617 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1621 mtx_lock(f->priv_mtx);
1622 error = usbd_transfer_pending(f->fs_xfer[u.pstall->ep_index]);
1623 mtx_unlock(f->priv_mtx);
1628 ep = f->fs_xfer[u.pstall->ep_index]->endpoint;
1630 /* setup a clear-stall packet */
1631 req.bmRequestType = UT_WRITE_ENDPOINT;
1632 req.bRequest = UR_CLEAR_FEATURE;
1633 USETW(req.wValue, UF_ENDPOINT_HALT);
1634 req.wIndex[0] = ep->edesc->bEndpointAddress;
1636 USETW(req.wLength, 0);
1638 error = usbd_do_request(f->udev, NULL, &req, NULL);
1640 usbd_clear_data_toggle(f->udev, ep);
1651 DPRINTFN(6, "error=%d\n", error);
1657 ugen_set_short_xfer(struct usb_fifo *f, void *addr)
1666 if (f->flag_short == t) {
1667 /* same value like before - accept */
1670 if (f->xfer[0] || f->xfer[1]) {
1671 /* cannot change this during transfer */
1679 ugen_set_timeout(struct usb_fifo *f, void *addr)
1681 f->timeout = *(int *)addr;
1682 if (f->timeout > 65535) {
1683 /* limit user input */
1690 ugen_get_frame_size(struct usb_fifo *f, void *addr)
1693 *(int *)addr = f->xfer[0]->max_frame_size;
1701 ugen_set_buffer_size(struct usb_fifo *f, void *addr)
1705 if (*(int *)addr < 0)
1706 t = 0; /* use "wMaxPacketSize" */
1707 else if (*(int *)addr < (256 * 1024))
1712 if (f->bufsize == t) {
1713 /* same value like before - accept */
1716 if (f->xfer[0] || f->xfer[1]) {
1717 /* cannot change this during transfer */
1725 ugen_get_buffer_size(struct usb_fifo *f, void *addr)
1727 *(int *)addr = f->bufsize;
1732 ugen_get_iface_desc(struct usb_fifo *f,
1733 struct usb_interface_descriptor *idesc)
1735 struct usb_interface *iface;
1737 iface = usbd_get_iface(f->udev, f->iface_index);
1738 if (iface && iface->idesc) {
1739 *idesc = *(iface->idesc);
1747 ugen_get_endpoint_desc(struct usb_fifo *f,
1748 struct usb_endpoint_descriptor *ed)
1750 struct usb_endpoint *ep;
1752 ep = usb_fifo_softc(f);
1754 if (ep && ep->edesc) {
1763 ugen_set_power_mode(struct usb_fifo *f, int mode)
1765 struct usb_device *udev = f->udev;
1769 if ((udev == NULL) ||
1770 (udev->parent_hub == NULL)) {
1773 err = priv_check(curthread, PRIV_DRIVER);
1777 /* get old power mode */
1778 old_mode = udev->power_mode;
1780 /* if no change, then just return */
1781 if (old_mode == mode)
1785 case USB_POWER_MODE_OFF:
1786 if (udev->flags.usb_mode == USB_MODE_HOST &&
1787 udev->re_enumerate_wait == USB_RE_ENUM_DONE) {
1788 udev->re_enumerate_wait = USB_RE_ENUM_PWR_OFF;
1790 /* set power mode will wake up the explore thread */
1793 case USB_POWER_MODE_ON:
1794 case USB_POWER_MODE_SAVE:
1797 case USB_POWER_MODE_RESUME:
1799 /* let USB-powerd handle resume */
1800 USB_BUS_LOCK(udev->bus);
1801 udev->pwr_save.write_refs++;
1802 udev->pwr_save.last_xfer_time = ticks;
1803 USB_BUS_UNLOCK(udev->bus);
1805 /* set new power mode */
1806 usbd_set_power_mode(udev, USB_POWER_MODE_SAVE);
1808 /* wait for resume to complete */
1809 usb_pause_mtx(NULL, hz / 4);
1811 /* clear write reference */
1812 USB_BUS_LOCK(udev->bus);
1813 udev->pwr_save.write_refs--;
1814 USB_BUS_UNLOCK(udev->bus);
1816 mode = USB_POWER_MODE_SAVE;
1819 case USB_POWER_MODE_SUSPEND:
1821 /* let USB-powerd handle suspend */
1822 USB_BUS_LOCK(udev->bus);
1823 udev->pwr_save.last_xfer_time = ticks - (256 * hz);
1824 USB_BUS_UNLOCK(udev->bus);
1826 mode = USB_POWER_MODE_SAVE;
1834 return (ENXIO); /* I/O failure */
1836 /* if we are powered off we need to re-enumerate first */
1837 if (old_mode == USB_POWER_MODE_OFF) {
1838 if (udev->flags.usb_mode == USB_MODE_HOST &&
1839 udev->re_enumerate_wait == USB_RE_ENUM_DONE) {
1840 udev->re_enumerate_wait = USB_RE_ENUM_START;
1842 /* set power mode will wake up the explore thread */
1845 /* set new power mode */
1846 usbd_set_power_mode(udev, mode);
1848 return (0); /* success */
1852 ugen_get_power_mode(struct usb_fifo *f)
1854 struct usb_device *udev = f->udev;
1857 return (USB_POWER_MODE_ON);
1859 return (udev->power_mode);
1863 ugen_get_port_path(struct usb_fifo *f, struct usb_device_port_path *dpp)
1865 struct usb_device *udev = f->udev;
1866 struct usb_device *next;
1867 unsigned int nlevel = 0;
1872 dpp->udp_bus = device_get_unit(udev->bus->bdev);
1873 dpp->udp_index = udev->device_index;
1875 /* count port levels */
1877 while (next->parent_hub != NULL) {
1879 next = next->parent_hub;
1882 /* check if too many levels */
1883 if (nlevel > USB_DEVICE_PORT_PATH_MAX)
1886 /* store total level of ports */
1887 dpp->udp_port_level = nlevel;
1889 /* store port index array */
1891 while (next->parent_hub != NULL) {
1892 dpp->udp_port_no[--nlevel] = next->port_no;
1893 next = next->parent_hub;
1895 return (0); /* success */
1898 return (EINVAL); /* failure */
1902 ugen_get_power_usage(struct usb_fifo *f)
1904 struct usb_device *udev = f->udev;
1909 return (udev->power);
1913 ugen_do_port_feature(struct usb_fifo *f, uint8_t port_no,
1914 uint8_t set, uint16_t feature)
1916 struct usb_device *udev = f->udev;
1917 struct usb_hub *hub;
1920 err = priv_check(curthread, PRIV_DRIVER);
1927 if ((udev == NULL) ||
1928 (udev->hub == NULL)) {
1933 if (port_no > hub->nports) {
1937 err = usbd_req_set_port_feature(udev,
1938 NULL, port_no, feature);
1940 err = usbd_req_clear_port_feature(udev,
1941 NULL, port_no, feature);
1944 return (ENXIO); /* failure */
1946 return (0); /* success */
1950 ugen_iface_ioctl(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
1952 struct usb_fifo *f_rx;
1953 struct usb_fifo *f_tx;
1956 f_rx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_RX];
1957 f_tx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_TX];
1960 case USB_SET_RX_SHORT_XFER:
1961 if (fflags & FREAD) {
1962 error = ugen_set_short_xfer(f_rx, addr);
1968 case USB_SET_TX_FORCE_SHORT:
1969 if (fflags & FWRITE) {
1970 error = ugen_set_short_xfer(f_tx, addr);
1976 case USB_SET_RX_TIMEOUT:
1977 if (fflags & FREAD) {
1978 error = ugen_set_timeout(f_rx, addr);
1984 case USB_SET_TX_TIMEOUT:
1985 if (fflags & FWRITE) {
1986 error = ugen_set_timeout(f_tx, addr);
1992 case USB_GET_RX_FRAME_SIZE:
1993 if (fflags & FREAD) {
1994 error = ugen_get_frame_size(f_rx, addr);
2000 case USB_GET_TX_FRAME_SIZE:
2001 if (fflags & FWRITE) {
2002 error = ugen_get_frame_size(f_tx, addr);
2008 case USB_SET_RX_BUFFER_SIZE:
2009 if (fflags & FREAD) {
2010 error = ugen_set_buffer_size(f_rx, addr);
2016 case USB_SET_TX_BUFFER_SIZE:
2017 if (fflags & FWRITE) {
2018 error = ugen_set_buffer_size(f_tx, addr);
2024 case USB_GET_RX_BUFFER_SIZE:
2025 if (fflags & FREAD) {
2026 error = ugen_get_buffer_size(f_rx, addr);
2032 case USB_GET_TX_BUFFER_SIZE:
2033 if (fflags & FWRITE) {
2034 error = ugen_get_buffer_size(f_tx, addr);
2040 case USB_GET_RX_INTERFACE_DESC:
2041 if (fflags & FREAD) {
2042 error = ugen_get_iface_desc(f_rx, addr);
2048 case USB_GET_TX_INTERFACE_DESC:
2049 if (fflags & FWRITE) {
2050 error = ugen_get_iface_desc(f_tx, addr);
2056 case USB_GET_RX_ENDPOINT_DESC:
2057 if (fflags & FREAD) {
2058 error = ugen_get_endpoint_desc(f_rx, addr);
2064 case USB_GET_TX_ENDPOINT_DESC:
2065 if (fflags & FWRITE) {
2066 error = ugen_get_endpoint_desc(f_tx, addr);
2072 case USB_SET_RX_STALL_FLAG:
2073 if ((fflags & FREAD) && (*(int *)addr)) {
2074 f_rx->flag_stall = 1;
2078 case USB_SET_TX_STALL_FLAG:
2079 if ((fflags & FWRITE) && (*(int *)addr)) {
2080 f_tx->flag_stall = 1;
2092 ugen_ioctl_post(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
2095 struct usb_interface_descriptor *idesc;
2096 struct usb_alt_interface *ai;
2097 struct usb_device_descriptor *ddesc;
2098 struct usb_config_descriptor *cdesc;
2099 struct usb_device_stats *stat;
2100 struct usb_fs_init *pinit;
2101 struct usb_fs_uninit *puninit;
2102 struct usb_device_port_path *dpp;
2107 struct usb_device_descriptor *dtemp;
2108 struct usb_config_descriptor *ctemp;
2109 struct usb_interface *iface;
2115 DPRINTFN(6, "cmd=0x%08lx\n", cmd);
2119 usb_needs_explore_all();
2123 if (!(fflags & FWRITE)) {
2127 usb_debug = *(int *)addr;
2130 case USB_GET_CONFIG:
2131 *(int *)addr = f->udev->curr_config_index;
2134 case USB_SET_CONFIG:
2135 if (!(fflags & FWRITE)) {
2139 error = ugen_set_config(f, *(int *)addr);
2142 case USB_GET_ALTINTERFACE:
2143 iface = usbd_get_iface(f->udev,
2144 u.ai->uai_interface_index);
2145 if (iface && iface->idesc) {
2146 u.ai->uai_alt_index = iface->alt_index;
2152 case USB_SET_ALTINTERFACE:
2153 if (!(fflags & FWRITE)) {
2157 error = ugen_set_interface(f,
2158 u.ai->uai_interface_index, u.ai->uai_alt_index);
2161 case USB_GET_DEVICE_DESC:
2162 dtemp = usbd_get_device_descriptor(f->udev);
2170 case USB_GET_CONFIG_DESC:
2171 ctemp = usbd_get_config_descriptor(f->udev);
2179 case USB_GET_FULL_DESC:
2180 error = ugen_get_cdesc(f, addr);
2183 case USB_GET_STRING_DESC:
2184 error = ugen_get_sdesc(f, addr);
2187 case USB_GET_IFACE_DRIVER:
2188 error = ugen_get_iface_driver(f, addr);
2192 case USB_DO_REQUEST:
2193 if (!(fflags & FWRITE)) {
2197 error = ugen_do_request(f, addr);
2200 case USB_DEVICEINFO:
2201 case USB_GET_DEVICEINFO:
2202 error = usb_gen_fill_deviceinfo(f, addr);
2205 case USB_DEVICESTATS:
2206 for (n = 0; n != 4; n++) {
2208 u.stat->uds_requests_fail[n] =
2209 f->udev->bus->stats_err.uds_requests[n];
2211 u.stat->uds_requests_ok[n] =
2212 f->udev->bus->stats_ok.uds_requests[n];
2216 case USB_DEVICEENUMERATE:
2217 error = ugen_re_enumerate(f);
2220 case USB_GET_PLUGTIME:
2221 *u.ptime = f->udev->plugtime;
2224 case USB_CLAIM_INTERFACE:
2225 case USB_RELEASE_INTERFACE:
2229 case USB_IFACE_DRIVER_ACTIVE:
2233 iface = usbd_get_iface(f->udev, n);
2235 if (iface && iface->subdev)
2241 case USB_IFACE_DRIVER_DETACH:
2243 error = priv_check(curthread, PRIV_DRIVER);
2250 if (n == USB_IFACE_INDEX_ANY) {
2256 * Detach the currently attached driver.
2258 usb_detach_device(f->udev, n, 0);
2261 * Set parent to self, this should keep attach away
2262 * until the next set configuration event.
2264 usbd_set_parent_iface(f->udev, n, n);
2267 case USB_SET_POWER_MODE:
2268 error = ugen_set_power_mode(f, *u.pint);
2271 case USB_GET_POWER_MODE:
2272 *u.pint = ugen_get_power_mode(f);
2275 case USB_GET_DEV_PORT_PATH:
2276 error = ugen_get_port_path(f, u.dpp);
2279 case USB_GET_POWER_USAGE:
2280 *u.pint = ugen_get_power_usage(f);
2283 case USB_SET_PORT_ENABLE:
2284 error = ugen_do_port_feature(f,
2285 *u.pint, 1, UHF_PORT_ENABLE);
2288 case USB_SET_PORT_DISABLE:
2289 error = ugen_do_port_feature(f,
2290 *u.pint, 0, UHF_PORT_ENABLE);
2294 /* verify input parameters */
2295 if (u.pinit->pEndpoints == NULL) {
2299 if (u.pinit->ep_index_max > 127) {
2303 if (u.pinit->ep_index_max == 0) {
2307 if (f->fs_xfer != NULL) {
2311 if (f->dev_ep_index != 0) {
2315 if (ugen_fifo_in_use(f, fflags)) {
2319 error = usb_fifo_alloc_buffer(f, 1, u.pinit->ep_index_max);
2323 f->fs_xfer = malloc(sizeof(f->fs_xfer[0]) *
2324 u.pinit->ep_index_max, M_USB, M_WAITOK | M_ZERO);
2325 if (f->fs_xfer == NULL) {
2326 usb_fifo_free_buffer(f);
2330 f->fs_ep_max = u.pinit->ep_index_max;
2331 f->fs_ep_ptr = u.pinit->pEndpoints;
2335 if (u.puninit->dummy != 0) {
2339 error = ugen_fs_uninit(f);
2343 mtx_lock(f->priv_mtx);
2344 error = ugen_iface_ioctl(f, cmd, addr, fflags);
2345 mtx_unlock(f->priv_mtx);
2348 DPRINTFN(6, "error=%d\n", error);
2353 ugen_ctrl_fs_callback(struct usb_xfer *xfer, usb_error_t error)
2355 ; /* workaround for a bug in "indent" */
2357 DPRINTF("st=%u alen=%u aframes=%u\n",
2358 USB_GET_STATE(xfer), xfer->actlen, xfer->aframes);
2360 switch (USB_GET_STATE(xfer)) {
2362 usbd_transfer_submit(xfer);
2365 ugen_fs_set_complete(xfer->priv_sc, USB_P2U(xfer->priv_fifo));
2369 #endif /* USB_HAVE_UGEN */