3 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
5 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #ifdef USB_GLOBAL_INCLUDE_FILE
30 #include USB_GLOBAL_INCLUDE_FILE
32 #include <sys/stdint.h>
33 #include <sys/stddef.h>
34 #include <sys/param.h>
35 #include <sys/queue.h>
36 #include <sys/types.h>
37 #include <sys/systm.h>
38 #include <sys/kernel.h>
40 #include <sys/module.h>
42 #include <sys/mutex.h>
43 #include <sys/condvar.h>
44 #include <sys/sysctl.h>
46 #include <sys/unistd.h>
47 #include <sys/callout.h>
48 #include <sys/malloc.h>
51 #include <sys/fcntl.h>
53 #include <dev/usb/usb.h>
54 #include <dev/usb/usb_ioctl.h>
55 #include <dev/usb/usbdi.h>
56 #include <dev/usb/usbdi_util.h>
58 #define USB_DEBUG_VAR ugen_debug
60 #include <dev/usb/usb_core.h>
61 #include <dev/usb/usb_dev.h>
62 #include <dev/usb/usb_mbuf.h>
63 #include <dev/usb/usb_process.h>
64 #include <dev/usb/usb_device.h>
65 #include <dev/usb/usb_debug.h>
66 #include <dev/usb/usb_request.h>
67 #include <dev/usb/usb_busdma.h>
68 #include <dev/usb/usb_util.h>
69 #include <dev/usb/usb_hub.h>
70 #include <dev/usb/usb_generic.h>
71 #include <dev/usb/usb_transfer.h>
73 #include <dev/usb/usb_controller.h>
74 #include <dev/usb/usb_bus.h>
75 #endif /* USB_GLOBAL_INCLUDE_FILE */
81 #define UGEN_BULK_FS_BUFFER_SIZE (64*32) /* bytes */
82 #define UGEN_BULK_HS_BUFFER_SIZE (1024*32) /* bytes */
83 #define UGEN_HW_FRAMES 50 /* number of milliseconds per transfer */
85 /* function prototypes */
87 static usb_callback_t ugen_read_clear_stall_callback;
88 static usb_callback_t ugen_write_clear_stall_callback;
89 static usb_callback_t ugen_ctrl_read_callback;
90 static usb_callback_t ugen_ctrl_write_callback;
91 static usb_callback_t ugen_isoc_read_callback;
92 static usb_callback_t ugen_isoc_write_callback;
93 static usb_callback_t ugen_ctrl_fs_callback;
95 static usb_fifo_open_t ugen_open;
96 static usb_fifo_close_t ugen_close;
97 static usb_fifo_ioctl_t ugen_ioctl;
98 static usb_fifo_ioctl_t ugen_ioctl_post;
99 static usb_fifo_cmd_t ugen_start_read;
100 static usb_fifo_cmd_t ugen_start_write;
101 static usb_fifo_cmd_t ugen_stop_io;
103 static int ugen_transfer_setup(struct usb_fifo *,
104 const struct usb_config *, uint8_t);
105 static int ugen_open_pipe_write(struct usb_fifo *);
106 static int ugen_open_pipe_read(struct usb_fifo *);
107 static int ugen_set_config(struct usb_fifo *, uint8_t);
108 static int ugen_set_interface(struct usb_fifo *, uint8_t, uint8_t);
109 static int ugen_get_cdesc(struct usb_fifo *, struct usb_gen_descriptor *);
110 static int ugen_get_sdesc(struct usb_fifo *, struct usb_gen_descriptor *);
111 static int ugen_get_iface_driver(struct usb_fifo *f, struct usb_gen_descriptor *ugd);
112 static int usb_gen_fill_deviceinfo(struct usb_fifo *,
113 struct usb_device_info *);
114 static int ugen_re_enumerate(struct usb_fifo *);
115 static int ugen_iface_ioctl(struct usb_fifo *, u_long, void *, int);
116 static uint8_t ugen_fs_get_complete(struct usb_fifo *, uint8_t *);
117 static int ugen_fs_uninit(struct usb_fifo *f);
121 struct usb_fifo_methods usb_ugen_methods = {
122 .f_open = &ugen_open,
123 .f_close = &ugen_close,
124 .f_ioctl = &ugen_ioctl,
125 .f_ioctl_post = &ugen_ioctl_post,
126 .f_start_read = &ugen_start_read,
127 .f_stop_read = &ugen_stop_io,
128 .f_start_write = &ugen_start_write,
129 .f_stop_write = &ugen_stop_io,
133 static int ugen_debug = 0;
135 static SYSCTL_NODE(_hw_usb, OID_AUTO, ugen, CTLFLAG_RW, 0, "USB generic");
136 SYSCTL_INT(_hw_usb_ugen, OID_AUTO, debug, CTLFLAG_RWTUN, &ugen_debug,
144 ugen_transfer_setup(struct usb_fifo *f,
145 const struct usb_config *setup, uint8_t n_setup)
147 struct usb_endpoint *ep = usb_fifo_softc(f);
148 struct usb_device *udev = f->udev;
149 uint8_t iface_index = ep->iface_index;
152 mtx_unlock(f->priv_mtx);
155 * "usbd_transfer_setup()" can sleep so one needs to make a wrapper,
156 * exiting the mutex and checking things
158 error = usbd_transfer_setup(udev, &iface_index, f->xfer,
159 setup, n_setup, f, f->priv_mtx);
162 if (f->xfer[0]->nframes == 1) {
163 error = usb_fifo_alloc_buffer(f,
164 f->xfer[0]->max_data_length, 2);
166 error = usb_fifo_alloc_buffer(f,
167 f->xfer[0]->max_frame_size,
168 2 * f->xfer[0]->nframes);
171 usbd_transfer_unsetup(f->xfer, n_setup);
174 mtx_lock(f->priv_mtx);
180 ugen_open(struct usb_fifo *f, int fflags)
182 struct usb_endpoint *ep = usb_fifo_softc(f);
183 struct usb_endpoint_descriptor *ed = ep->edesc;
186 DPRINTFN(1, "flag=0x%x pid=%d name=%s\n", fflags,
187 curthread->td_proc->p_pid, curthread->td_proc->p_comm);
189 mtx_lock(f->priv_mtx);
190 switch (usbd_get_speed(f->udev)) {
193 f->nframes = UGEN_HW_FRAMES;
194 f->bufsize = UGEN_BULK_FS_BUFFER_SIZE;
197 f->nframes = UGEN_HW_FRAMES * 8;
198 f->bufsize = UGEN_BULK_HS_BUFFER_SIZE;
202 type = ed->bmAttributes & UE_XFERTYPE;
203 if (type == UE_INTERRUPT) {
204 f->bufsize = 0; /* use "wMaxPacketSize" */
206 f->timeout = USB_NO_TIMEOUT;
209 mtx_unlock(f->priv_mtx);
215 ugen_close(struct usb_fifo *f, int fflags)
218 DPRINTFN(1, "flag=0x%x pid=%d name=%s\n", fflags,
219 curthread->td_proc->p_pid, curthread->td_proc->p_comm);
223 mtx_lock(f->priv_mtx);
224 usbd_transfer_stop(f->xfer[0]);
225 usbd_transfer_stop(f->xfer[1]);
226 mtx_unlock(f->priv_mtx);
228 usbd_transfer_unsetup(f->xfer, 2);
229 usb_fifo_free_buffer(f);
231 if (ugen_fs_uninit(f)) {
232 /* ignore any errors - we are closing */
233 DPRINTFN(6, "no FIFOs\n");
238 ugen_open_pipe_write(struct usb_fifo *f)
240 struct usb_config usb_config[2];
241 struct usb_endpoint *ep = usb_fifo_softc(f);
242 struct usb_endpoint_descriptor *ed = ep->edesc;
244 USB_MTX_ASSERT(f->priv_mtx, MA_OWNED);
246 if (f->xfer[0] || f->xfer[1]) {
247 /* transfers are already opened */
250 memset(usb_config, 0, sizeof(usb_config));
252 usb_config[1].type = UE_CONTROL;
253 usb_config[1].endpoint = 0;
254 usb_config[1].direction = UE_DIR_ANY;
255 usb_config[1].timeout = 1000; /* 1 second */
256 usb_config[1].interval = 50;/* 50 milliseconds */
257 usb_config[1].bufsize = sizeof(struct usb_device_request);
258 usb_config[1].callback = &ugen_write_clear_stall_callback;
259 usb_config[1].usb_mode = USB_MODE_HOST;
261 usb_config[0].type = ed->bmAttributes & UE_XFERTYPE;
262 usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR;
263 usb_config[0].stream_id = 0; /* XXX support more stream ID's */
264 usb_config[0].direction = UE_DIR_TX;
265 usb_config[0].interval = USB_DEFAULT_INTERVAL;
266 usb_config[0].flags.proxy_buffer = 1;
267 usb_config[0].usb_mode = USB_MODE_DUAL; /* both modes */
269 switch (ed->bmAttributes & UE_XFERTYPE) {
273 usb_config[0].flags.force_short_xfer = 1;
275 usb_config[0].callback = &ugen_ctrl_write_callback;
276 usb_config[0].timeout = f->timeout;
277 usb_config[0].frames = 1;
278 usb_config[0].bufsize = f->bufsize;
279 if (ugen_transfer_setup(f, usb_config, 2)) {
282 /* first transfer does not clear stall */
287 usb_config[0].flags.short_xfer_ok = 1;
288 usb_config[0].bufsize = 0; /* use default */
289 usb_config[0].frames = f->nframes;
290 usb_config[0].callback = &ugen_isoc_write_callback;
291 usb_config[0].timeout = 0;
293 /* clone configuration */
294 usb_config[1] = usb_config[0];
296 if (ugen_transfer_setup(f, usb_config, 2)) {
307 ugen_open_pipe_read(struct usb_fifo *f)
309 struct usb_config usb_config[2];
310 struct usb_endpoint *ep = usb_fifo_softc(f);
311 struct usb_endpoint_descriptor *ed = ep->edesc;
313 USB_MTX_ASSERT(f->priv_mtx, MA_OWNED);
315 if (f->xfer[0] || f->xfer[1]) {
316 /* transfers are already opened */
319 memset(usb_config, 0, sizeof(usb_config));
321 usb_config[1].type = UE_CONTROL;
322 usb_config[1].endpoint = 0;
323 usb_config[1].direction = UE_DIR_ANY;
324 usb_config[1].timeout = 1000; /* 1 second */
325 usb_config[1].interval = 50;/* 50 milliseconds */
326 usb_config[1].bufsize = sizeof(struct usb_device_request);
327 usb_config[1].callback = &ugen_read_clear_stall_callback;
328 usb_config[1].usb_mode = USB_MODE_HOST;
330 usb_config[0].type = ed->bmAttributes & UE_XFERTYPE;
331 usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR;
332 usb_config[0].stream_id = 0; /* XXX support more stream ID's */
333 usb_config[0].direction = UE_DIR_RX;
334 usb_config[0].interval = USB_DEFAULT_INTERVAL;
335 usb_config[0].flags.proxy_buffer = 1;
336 usb_config[0].usb_mode = USB_MODE_DUAL; /* both modes */
338 switch (ed->bmAttributes & UE_XFERTYPE) {
342 usb_config[0].flags.short_xfer_ok = 1;
344 usb_config[0].timeout = f->timeout;
345 usb_config[0].frames = 1;
346 usb_config[0].callback = &ugen_ctrl_read_callback;
347 usb_config[0].bufsize = f->bufsize;
349 if (ugen_transfer_setup(f, usb_config, 2)) {
352 /* first transfer does not clear stall */
357 usb_config[0].flags.short_xfer_ok = 1;
358 usb_config[0].bufsize = 0; /* use default */
359 usb_config[0].frames = f->nframes;
360 usb_config[0].callback = &ugen_isoc_read_callback;
361 usb_config[0].timeout = 0;
363 /* clone configuration */
364 usb_config[1] = usb_config[0];
366 if (ugen_transfer_setup(f, usb_config, 2)) {
378 ugen_start_read(struct usb_fifo *f)
380 /* check that pipes are open */
381 if (ugen_open_pipe_read(f)) {
383 usb_fifo_put_data_error(f);
385 /* start transfers */
386 usbd_transfer_start(f->xfer[0]);
387 usbd_transfer_start(f->xfer[1]);
391 ugen_start_write(struct usb_fifo *f)
393 /* check that pipes are open */
394 if (ugen_open_pipe_write(f)) {
396 usb_fifo_get_data_error(f);
398 /* start transfers */
399 usbd_transfer_start(f->xfer[0]);
400 usbd_transfer_start(f->xfer[1]);
404 ugen_stop_io(struct usb_fifo *f)
407 usbd_transfer_stop(f->xfer[0]);
408 usbd_transfer_stop(f->xfer[1]);
412 ugen_ctrl_read_callback(struct usb_xfer *xfer, usb_error_t error)
414 struct usb_fifo *f = usbd_xfer_softc(xfer);
417 DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
419 switch (USB_GET_STATE(xfer)) {
420 case USB_ST_TRANSFERRED:
421 if (xfer->actlen == 0) {
422 if (f->fifo_zlp != 4) {
426 * Throttle a little bit we have multiple ZLPs
429 xfer->interval = 64; /* ms */
436 usb_fifo_put_data(f, xfer->frbuffers, 0,
441 usbd_transfer_start(f->xfer[1]);
444 USB_IF_POLL(&f->free_q, m);
446 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
447 usbd_transfer_submit(xfer);
452 if (xfer->error != USB_ERR_CANCELLED) {
453 /* send a zero length packet to userland */
454 usb_fifo_put_data(f, xfer->frbuffers, 0, 0, 1);
457 usbd_transfer_start(f->xfer[1]);
464 ugen_ctrl_write_callback(struct usb_xfer *xfer, usb_error_t error)
466 struct usb_fifo *f = usbd_xfer_softc(xfer);
467 usb_frlength_t actlen;
469 DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
471 switch (USB_GET_STATE(xfer)) {
473 case USB_ST_TRANSFERRED:
475 * If writing is in stall, just jump to clear stall
476 * callback and solve the situation.
479 usbd_transfer_start(f->xfer[1]);
483 * Write data, setup and perform hardware transfer.
485 if (usb_fifo_get_data(f, xfer->frbuffers, 0,
486 xfer->max_data_length, &actlen, 0)) {
487 usbd_xfer_set_frame_len(xfer, 0, actlen);
488 usbd_transfer_submit(xfer);
493 if (xfer->error != USB_ERR_CANCELLED) {
495 usbd_transfer_start(f->xfer[1]);
502 ugen_read_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error)
504 struct usb_fifo *f = usbd_xfer_softc(xfer);
505 struct usb_xfer *xfer_other = f->xfer[0];
507 if (f->flag_stall == 0) {
511 if (usbd_clear_stall_callback(xfer, xfer_other)) {
512 DPRINTFN(5, "f=%p: stall cleared\n", f);
514 usbd_transfer_start(xfer_other);
519 ugen_write_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error)
521 struct usb_fifo *f = usbd_xfer_softc(xfer);
522 struct usb_xfer *xfer_other = f->xfer[0];
524 if (f->flag_stall == 0) {
528 if (usbd_clear_stall_callback(xfer, xfer_other)) {
529 DPRINTFN(5, "f=%p: stall cleared\n", f);
531 usbd_transfer_start(xfer_other);
536 ugen_isoc_read_callback(struct usb_xfer *xfer, usb_error_t error)
538 struct usb_fifo *f = usbd_xfer_softc(xfer);
539 usb_frlength_t offset;
542 DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
544 switch (USB_GET_STATE(xfer)) {
545 case USB_ST_TRANSFERRED:
547 DPRINTFN(6, "actlen=%d\n", xfer->actlen);
551 for (n = 0; n != xfer->aframes; n++) {
552 usb_fifo_put_data(f, xfer->frbuffers, offset,
553 xfer->frlengths[n], 1);
554 offset += xfer->max_frame_size;
559 for (n = 0; n != xfer->nframes; n++) {
560 /* setup size for next transfer */
561 usbd_xfer_set_frame_len(xfer, n, xfer->max_frame_size);
563 usbd_transfer_submit(xfer);
567 if (xfer->error == USB_ERR_CANCELLED) {
575 ugen_isoc_write_callback(struct usb_xfer *xfer, usb_error_t error)
577 struct usb_fifo *f = usbd_xfer_softc(xfer);
578 usb_frlength_t actlen;
579 usb_frlength_t offset;
582 DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
584 switch (USB_GET_STATE(xfer)) {
585 case USB_ST_TRANSFERRED:
589 for (n = 0; n != xfer->nframes; n++) {
590 if (usb_fifo_get_data(f, xfer->frbuffers, offset,
591 xfer->max_frame_size, &actlen, 1)) {
592 usbd_xfer_set_frame_len(xfer, n, actlen);
599 for (; n != xfer->nframes; n++) {
600 /* fill in zero frames */
601 usbd_xfer_set_frame_len(xfer, n, 0);
603 usbd_transfer_submit(xfer);
607 if (xfer->error == USB_ERR_CANCELLED) {
615 ugen_set_config(struct usb_fifo *f, uint8_t index)
617 DPRINTFN(2, "index %u\n", index);
619 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
620 /* not possible in device side mode */
624 /* make sure all FIFO's are gone */
625 /* else there can be a deadlock */
626 if (ugen_fs_uninit(f)) {
627 /* ignore any errors */
628 DPRINTFN(6, "no FIFOs\n");
631 if (usbd_start_set_config(f->udev, index) != 0)
638 ugen_set_interface(struct usb_fifo *f,
639 uint8_t iface_index, uint8_t alt_index)
641 DPRINTFN(2, "%u, %u\n", iface_index, alt_index);
643 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
644 /* not possible in device side mode */
647 /* make sure all FIFO's are gone */
648 /* else there can be a deadlock */
649 if (ugen_fs_uninit(f)) {
650 /* ignore any errors */
651 DPRINTFN(6, "no FIFOs\n");
653 /* change setting - will free generic FIFOs, if any */
654 if (usbd_set_alt_interface_index(f->udev, iface_index, alt_index)) {
657 /* probe and attach */
658 if (usb_probe_and_attach(f->udev, iface_index)) {
664 /*------------------------------------------------------------------------*
667 * This function will retrieve the complete configuration descriptor
668 * at the given index.
669 *------------------------------------------------------------------------*/
671 ugen_get_cdesc(struct usb_fifo *f, struct usb_gen_descriptor *ugd)
673 struct usb_config_descriptor *cdesc;
674 struct usb_device *udev = f->udev;
681 if (ugd->ugd_data == NULL) {
682 /* userland pointer should not be zero */
685 if ((ugd->ugd_config_index == USB_UNCONFIG_INDEX) ||
686 (ugd->ugd_config_index == udev->curr_config_index)) {
687 cdesc = usbd_get_config_descriptor(udev);
693 #if (USB_HAVE_FIXED_CONFIG == 0)
694 if (usbd_req_get_config_desc_full(udev,
695 NULL, &cdesc, ugd->ugd_config_index)) {
700 /* configuration descriptor data is shared */
705 len = UGETW(cdesc->wTotalLength);
706 if (len > ugd->ugd_maxlen) {
707 len = ugd->ugd_maxlen;
709 DPRINTFN(6, "len=%u\n", len);
711 ugd->ugd_actlen = len;
714 error = copyout(cdesc, ugd->ugd_data, len);
717 usbd_free_config_desc(udev, cdesc);
723 ugen_get_sdesc(struct usb_fifo *f, struct usb_gen_descriptor *ugd)
730 /* Protect scratch area */
731 do_unlock = usbd_ctrl_lock(f->udev);
733 ptr = f->udev->scratch.data;
734 size = sizeof(f->udev->scratch.data);
736 if (usbd_req_get_string_desc(f->udev, NULL, ptr,
737 size, ugd->ugd_lang_id, ugd->ugd_string_index)) {
741 if (size > ((uint8_t *)ptr)[0]) {
742 size = ((uint8_t *)ptr)[0];
744 if (size > ugd->ugd_maxlen) {
745 size = ugd->ugd_maxlen;
747 ugd->ugd_actlen = size;
750 error = copyout(ptr, ugd->ugd_data, size);
753 usbd_ctrl_unlock(f->udev);
758 /*------------------------------------------------------------------------*
759 * ugen_get_iface_driver
761 * This function generates an USB interface description for userland.
766 *------------------------------------------------------------------------*/
768 ugen_get_iface_driver(struct usb_fifo *f, struct usb_gen_descriptor *ugd)
770 struct usb_device *udev = f->udev;
771 struct usb_interface *iface;
781 if ((ugd->ugd_data == NULL) || (ugd->ugd_maxlen == 0)) {
782 /* userland pointer should not be zero */
786 iface = usbd_get_iface(udev, ugd->ugd_iface_index);
787 if ((iface == NULL) || (iface->idesc == NULL)) {
788 /* invalid interface index */
792 /* read out device nameunit string, if any */
793 if ((iface->subdev != NULL) &&
794 device_is_attached(iface->subdev) &&
795 (ptr = device_get_nameunit(iface->subdev)) &&
796 (desc = device_get_desc(iface->subdev))) {
798 /* print description */
799 snprintf(buf, sizeof(buf), "%s: <%s>", ptr, desc);
802 maxlen = ugd->ugd_maxlen - 1;
807 /* update actual length, including terminating zero */
808 ugd->ugd_actlen = len + 1;
810 /* copy out interface description */
811 error = copyout(buf, ugd->ugd_data, ugd->ugd_actlen);
813 /* zero length string is default */
814 error = copyout("", ugd->ugd_data, 1);
819 /*------------------------------------------------------------------------*
820 * usb_gen_fill_deviceinfo
822 * This function dumps information about an USB device to the
823 * structure pointed to by the "di" argument.
828 *------------------------------------------------------------------------*/
830 usb_gen_fill_deviceinfo(struct usb_fifo *f, struct usb_device_info *di)
832 struct usb_device *udev;
833 struct usb_device *hub;
837 bzero(di, sizeof(di[0]));
839 di->udi_bus = device_get_unit(udev->bus->bdev);
840 di->udi_addr = udev->address;
841 di->udi_index = udev->device_index;
842 strlcpy(di->udi_serial, usb_get_serial(udev), sizeof(di->udi_serial));
843 strlcpy(di->udi_vendor, usb_get_manufacturer(udev), sizeof(di->udi_vendor));
844 strlcpy(di->udi_product, usb_get_product(udev), sizeof(di->udi_product));
845 usb_printbcd(di->udi_release, sizeof(di->udi_release),
846 UGETW(udev->ddesc.bcdDevice));
847 di->udi_vendorNo = UGETW(udev->ddesc.idVendor);
848 di->udi_productNo = UGETW(udev->ddesc.idProduct);
849 di->udi_releaseNo = UGETW(udev->ddesc.bcdDevice);
850 di->udi_class = udev->ddesc.bDeviceClass;
851 di->udi_subclass = udev->ddesc.bDeviceSubClass;
852 di->udi_protocol = udev->ddesc.bDeviceProtocol;
853 di->udi_config_no = udev->curr_config_no;
854 di->udi_config_index = udev->curr_config_index;
855 di->udi_power = udev->flags.self_powered ? 0 : udev->power;
856 di->udi_speed = udev->speed;
857 di->udi_mode = udev->flags.usb_mode;
858 di->udi_power_mode = udev->power_mode;
859 di->udi_suspended = udev->flags.peer_suspended;
861 hub = udev->parent_hub;
863 di->udi_hubaddr = hub->address;
864 di->udi_hubindex = hub->device_index;
865 di->udi_hubport = udev->port_no;
870 /*------------------------------------------------------------------------*
876 *------------------------------------------------------------------------*/
878 ugen_check_request(struct usb_device *udev, struct usb_device_request *req)
880 struct usb_endpoint *ep;
884 * Avoid requests that would damage the bus integrity:
886 if (((req->bmRequestType == UT_WRITE_DEVICE) &&
887 (req->bRequest == UR_SET_ADDRESS)) ||
888 ((req->bmRequestType == UT_WRITE_DEVICE) &&
889 (req->bRequest == UR_SET_CONFIG)) ||
890 ((req->bmRequestType == UT_WRITE_INTERFACE) &&
891 (req->bRequest == UR_SET_INTERFACE))) {
893 * These requests can be useful for testing USB drivers.
895 error = priv_check(curthread, PRIV_DRIVER);
901 * Special case - handle clearing of stall
903 if (req->bmRequestType == UT_WRITE_ENDPOINT) {
905 ep = usbd_get_ep_by_addr(udev, req->wIndex[0]);
909 if ((req->bRequest == UR_CLEAR_FEATURE) &&
910 (UGETW(req->wValue) == UF_ENDPOINT_HALT)) {
911 usbd_clear_data_toggle(udev, ep);
914 /* TODO: add more checks to verify the interface index */
920 ugen_do_request(struct usb_fifo *f, struct usb_ctl_request *ur)
926 if (ugen_check_request(f->udev, &ur->ucr_request)) {
929 len = UGETW(ur->ucr_request.wLength);
931 /* check if "ucr_data" is valid */
933 if (ur->ucr_data == NULL) {
937 /* do the USB request */
938 error = usbd_do_request_flags
939 (f->udev, NULL, &ur->ucr_request, ur->ucr_data,
940 (ur->ucr_flags & USB_SHORT_XFER_OK) |
941 USB_USER_DATA_PTR, &actlen,
942 USB_DEFAULT_TIMEOUT);
944 ur->ucr_actlen = actlen;
952 /*------------------------------------------------------------------------
954 *------------------------------------------------------------------------*/
956 ugen_re_enumerate(struct usb_fifo *f)
958 struct usb_device *udev = f->udev;
962 * This request can be useful for testing USB drivers:
964 error = priv_check(curthread, PRIV_DRIVER);
968 if (udev->flags.usb_mode != USB_MODE_HOST) {
969 /* not possible in device side mode */
970 DPRINTFN(6, "device mode\n");
973 /* make sure all FIFO's are gone */
974 /* else there can be a deadlock */
975 if (ugen_fs_uninit(f)) {
976 /* ignore any errors */
977 DPRINTFN(6, "no FIFOs\n");
979 /* start re-enumeration of device */
980 usbd_start_re_enumerate(udev);
985 ugen_fs_uninit(struct usb_fifo *f)
987 if (f->fs_xfer == NULL) {
990 usbd_transfer_unsetup(f->fs_xfer, f->fs_ep_max);
991 free(f->fs_xfer, M_USB);
995 f->flag_iscomplete = 0;
996 usb_fifo_free_buffer(f);
1001 ugen_fs_get_complete(struct usb_fifo *f, uint8_t *pindex)
1005 USB_IF_DEQUEUE(&f->used_q, m);
1008 *pindex = *((uint8_t *)(m->cur_data_ptr));
1010 USB_IF_ENQUEUE(&f->free_q, m);
1012 return (0); /* success */
1015 *pindex = 0; /* fix compiler warning */
1017 f->flag_iscomplete = 0;
1019 return (1); /* failure */
1023 ugen_fs_set_complete(struct usb_fifo *f, uint8_t index)
1027 USB_IF_DEQUEUE(&f->free_q, m);
1030 /* can happen during close */
1031 DPRINTF("out of buffers\n");
1036 *((uint8_t *)(m->cur_data_ptr)) = index;
1038 USB_IF_ENQUEUE(&f->used_q, m);
1040 f->flag_iscomplete = 1;
1046 ugen_fs_copy_in(struct usb_fifo *f, uint8_t ep_index)
1048 struct usb_device_request *req;
1049 struct usb_xfer *xfer;
1050 struct usb_fs_endpoint fs_ep;
1051 void *uaddr; /* userland pointer */
1053 usb_frlength_t offset;
1060 if (ep_index >= f->fs_ep_max) {
1063 xfer = f->fs_xfer[ep_index];
1067 mtx_lock(f->priv_mtx);
1068 if (usbd_transfer_pending(xfer)) {
1069 mtx_unlock(f->priv_mtx);
1070 return (EBUSY); /* should not happen */
1072 mtx_unlock(f->priv_mtx);
1074 error = copyin(f->fs_ep_ptr +
1075 ep_index, &fs_ep, sizeof(fs_ep));
1079 /* security checks */
1081 if (fs_ep.nFrames > xfer->max_frame_count) {
1082 xfer->error = USB_ERR_INVAL;
1085 if (fs_ep.nFrames == 0) {
1086 xfer->error = USB_ERR_INVAL;
1089 error = copyin(fs_ep.ppBuffer,
1090 &uaddr, sizeof(uaddr));
1094 /* reset first frame */
1095 usbd_xfer_set_frame_offset(xfer, 0, 0);
1097 if (xfer->flags_int.control_xfr) {
1099 req = xfer->frbuffers[0].buffer;
1101 error = copyin(fs_ep.pLength,
1102 &length, sizeof(length));
1106 if (length != sizeof(*req)) {
1107 xfer->error = USB_ERR_INVAL;
1111 error = copyin(uaddr, req, length);
1116 if (ugen_check_request(f->udev, req)) {
1117 xfer->error = USB_ERR_INVAL;
1120 usbd_xfer_set_frame_len(xfer, 0, length);
1122 /* Host mode only ! */
1123 if ((req->bmRequestType &
1124 (UT_READ | UT_WRITE)) == UT_READ) {
1130 offset = sizeof(*req);
1133 /* Device and Host mode */
1134 if (USB_GET_DATA_ISREAD(xfer)) {
1143 rem = usbd_xfer_max_len(xfer);
1144 xfer->nframes = fs_ep.nFrames;
1145 xfer->timeout = fs_ep.timeout;
1146 if (xfer->timeout > 65535) {
1147 xfer->timeout = 65535;
1149 if (fs_ep.flags & USB_FS_FLAG_SINGLE_SHORT_OK)
1150 xfer->flags.short_xfer_ok = 1;
1152 xfer->flags.short_xfer_ok = 0;
1154 if (fs_ep.flags & USB_FS_FLAG_MULTI_SHORT_OK)
1155 xfer->flags.short_frames_ok = 1;
1157 xfer->flags.short_frames_ok = 0;
1159 if (fs_ep.flags & USB_FS_FLAG_FORCE_SHORT)
1160 xfer->flags.force_short_xfer = 1;
1162 xfer->flags.force_short_xfer = 0;
1164 if (fs_ep.flags & USB_FS_FLAG_CLEAR_STALL)
1165 usbd_xfer_set_stall(xfer);
1167 xfer->flags.stall_pipe = 0;
1169 for (; n != xfer->nframes; n++) {
1171 error = copyin(fs_ep.pLength + n,
1172 &length, sizeof(length));
1176 usbd_xfer_set_frame_len(xfer, n, length);
1179 xfer->error = USB_ERR_INVAL;
1186 /* we need to know the source buffer */
1187 error = copyin(fs_ep.ppBuffer + n,
1188 &uaddr, sizeof(uaddr));
1192 if (xfer->flags_int.isochronous_xfr) {
1193 /* get kernel buffer address */
1194 kaddr = xfer->frbuffers[0].buffer;
1195 kaddr = USB_ADD_BYTES(kaddr, offset);
1197 /* set current frame offset */
1198 usbd_xfer_set_frame_offset(xfer, offset, n);
1200 /* get kernel buffer address */
1201 kaddr = xfer->frbuffers[n].buffer;
1205 error = copyin(uaddr, kaddr, length);
1215 mtx_lock(f->priv_mtx);
1216 ugen_fs_set_complete(f, ep_index);
1217 mtx_unlock(f->priv_mtx);
1222 ugen_fs_copy_out_cancelled(struct usb_fs_endpoint *fs_ep_uptr)
1224 struct usb_fs_endpoint fs_ep;
1227 error = copyin(fs_ep_uptr, &fs_ep, sizeof(fs_ep));
1231 fs_ep.status = USB_ERR_CANCELLED;
1233 fs_ep.isoc_time_complete = 0;
1235 /* update "aFrames" */
1236 error = copyout(&fs_ep.aFrames, &fs_ep_uptr->aFrames,
1237 sizeof(fs_ep.aFrames));
1241 /* update "isoc_time_complete" */
1242 error = copyout(&fs_ep.isoc_time_complete,
1243 &fs_ep_uptr->isoc_time_complete,
1244 sizeof(fs_ep.isoc_time_complete));
1248 /* update "status" */
1249 error = copyout(&fs_ep.status, &fs_ep_uptr->status,
1250 sizeof(fs_ep.status));
1256 ugen_fs_copy_out(struct usb_fifo *f, uint8_t ep_index)
1258 struct usb_device_request *req;
1259 struct usb_xfer *xfer;
1260 struct usb_fs_endpoint fs_ep;
1261 struct usb_fs_endpoint *fs_ep_uptr; /* userland ptr */
1262 void *uaddr; /* userland ptr */
1264 usb_frlength_t offset;
1272 if (ep_index >= f->fs_ep_max)
1275 xfer = f->fs_xfer[ep_index];
1279 mtx_lock(f->priv_mtx);
1280 if (!xfer->flags_int.transferring &&
1281 !xfer->flags_int.started) {
1282 mtx_unlock(f->priv_mtx);
1283 DPRINTF("Returning fake cancel event\n");
1284 return (ugen_fs_copy_out_cancelled(f->fs_ep_ptr + ep_index));
1285 } else if (usbd_transfer_pending(xfer)) {
1286 mtx_unlock(f->priv_mtx);
1287 return (EBUSY); /* should not happen */
1289 mtx_unlock(f->priv_mtx);
1291 fs_ep_uptr = f->fs_ep_ptr + ep_index;
1292 error = copyin(fs_ep_uptr, &fs_ep, sizeof(fs_ep));
1296 fs_ep.status = xfer->error;
1297 fs_ep.aFrames = xfer->aframes;
1298 fs_ep.isoc_time_complete = xfer->isoc_time_complete;
1302 if (xfer->flags_int.control_xfr) {
1303 req = xfer->frbuffers[0].buffer;
1305 /* Host mode only ! */
1306 if ((req->bmRequestType & (UT_READ | UT_WRITE)) == UT_READ) {
1311 if (xfer->nframes == 0)
1312 n = 0; /* should never happen */
1316 /* Device and Host mode */
1317 if (USB_GET_DATA_ISREAD(xfer)) {
1325 /* Update lengths and copy out data */
1327 rem = usbd_xfer_max_len(xfer);
1330 for (; n != xfer->nframes; n++) {
1332 /* get initial length into "temp" */
1333 error = copyin(fs_ep.pLength + n,
1334 &temp, sizeof(temp));
1339 /* the userland length has been corrupted */
1340 DPRINTF("corrupt userland length "
1341 "%u > %u\n", temp, rem);
1342 fs_ep.status = USB_ERR_INVAL;
1347 /* get actual transfer length */
1348 length = xfer->frlengths[n];
1349 if (length > temp) {
1351 fs_ep.status = USB_ERR_INVAL;
1352 DPRINTF("data overflow %u > %u\n",
1358 /* we need to know the destination buffer */
1359 error = copyin(fs_ep.ppBuffer + n,
1360 &uaddr, sizeof(uaddr));
1364 if (xfer->flags_int.isochronous_xfr) {
1365 /* only one frame buffer */
1366 kaddr = USB_ADD_BYTES(
1367 xfer->frbuffers[0].buffer, offset);
1369 /* multiple frame buffers */
1370 kaddr = xfer->frbuffers[n].buffer;
1374 error = copyout(kaddr, uaddr, length);
1380 * Update offset according to initial length, which is
1381 * needed by isochronous transfers!
1386 error = copyout(&length,
1387 fs_ep.pLength + n, sizeof(length));
1394 /* update "aFrames" */
1395 error = copyout(&fs_ep.aFrames, &fs_ep_uptr->aFrames,
1396 sizeof(fs_ep.aFrames));
1400 /* update "isoc_time_complete" */
1401 error = copyout(&fs_ep.isoc_time_complete,
1402 &fs_ep_uptr->isoc_time_complete,
1403 sizeof(fs_ep.isoc_time_complete));
1407 /* update "status" */
1408 error = copyout(&fs_ep.status, &fs_ep_uptr->status,
1409 sizeof(fs_ep.status));
1415 ugen_fifo_in_use(struct usb_fifo *f, int fflags)
1417 struct usb_fifo *f_rx;
1418 struct usb_fifo *f_tx;
1420 f_rx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_RX];
1421 f_tx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_TX];
1423 if ((fflags & FREAD) && f_rx &&
1424 (f_rx->xfer[0] || f_rx->xfer[1])) {
1425 return (1); /* RX FIFO in use */
1427 if ((fflags & FWRITE) && f_tx &&
1428 (f_tx->xfer[0] || f_tx->xfer[1])) {
1429 return (1); /* TX FIFO in use */
1431 return (0); /* not in use */
1435 ugen_ioctl(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
1437 struct usb_config usb_config[1];
1438 struct usb_device_request req;
1440 struct usb_fs_complete *pcomp;
1441 struct usb_fs_start *pstart;
1442 struct usb_fs_stop *pstop;
1443 struct usb_fs_open *popen;
1444 struct usb_fs_open_stream *popen_stream;
1445 struct usb_fs_close *pclose;
1446 struct usb_fs_clear_stall_sync *pstall;
1449 struct usb_endpoint *ep;
1450 struct usb_endpoint_descriptor *ed;
1451 struct usb_xfer *xfer;
1453 uint8_t iface_index;
1460 DPRINTFN(6, "cmd=0x%08lx\n", cmd);
1463 case USB_FS_COMPLETE:
1464 mtx_lock(f->priv_mtx);
1465 error = ugen_fs_get_complete(f, &ep_index);
1466 mtx_unlock(f->priv_mtx);
1472 u.pcomp->ep_index = ep_index;
1473 error = ugen_fs_copy_out(f, u.pcomp->ep_index);
1477 error = ugen_fs_copy_in(f, u.pstart->ep_index);
1480 mtx_lock(f->priv_mtx);
1481 xfer = f->fs_xfer[u.pstart->ep_index];
1482 usbd_transfer_start(xfer);
1483 mtx_unlock(f->priv_mtx);
1487 if (u.pstop->ep_index >= f->fs_ep_max) {
1491 mtx_lock(f->priv_mtx);
1492 xfer = f->fs_xfer[u.pstart->ep_index];
1493 if (usbd_transfer_pending(xfer)) {
1494 usbd_transfer_stop(xfer);
1497 * Check if the USB transfer was stopped
1498 * before it was even started and fake a
1501 if (!xfer->flags_int.transferring &&
1502 !xfer->flags_int.started) {
1503 DPRINTF("Issuing fake completion event\n");
1504 ugen_fs_set_complete(xfer->priv_sc,
1505 USB_P2U(xfer->priv_fifo));
1508 mtx_unlock(f->priv_mtx);
1512 case USB_FS_OPEN_STREAM:
1513 if (u.popen->ep_index >= f->fs_ep_max) {
1517 if (f->fs_xfer[u.popen->ep_index] != NULL) {
1521 if (u.popen->max_bufsize > USB_FS_MAX_BUFSIZE) {
1522 u.popen->max_bufsize = USB_FS_MAX_BUFSIZE;
1524 if (u.popen->max_frames & USB_FS_MAX_FRAMES_PRE_SCALE) {
1526 u.popen->max_frames &= ~USB_FS_MAX_FRAMES_PRE_SCALE;
1530 if (u.popen->max_frames > USB_FS_MAX_FRAMES) {
1531 u.popen->max_frames = USB_FS_MAX_FRAMES;
1534 if (u.popen->max_frames == 0) {
1538 ep = usbd_get_ep_by_addr(f->udev, u.popen->ep_no);
1548 iface_index = ep->iface_index;
1550 memset(usb_config, 0, sizeof(usb_config));
1552 usb_config[0].type = ed->bmAttributes & UE_XFERTYPE;
1553 usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR;
1554 usb_config[0].direction = ed->bEndpointAddress & (UE_DIR_OUT | UE_DIR_IN);
1555 usb_config[0].interval = USB_DEFAULT_INTERVAL;
1556 usb_config[0].flags.proxy_buffer = 1;
1558 usb_config[0].flags.pre_scale_frames = 1;
1559 usb_config[0].callback = &ugen_ctrl_fs_callback;
1560 usb_config[0].timeout = 0; /* no timeout */
1561 usb_config[0].frames = u.popen->max_frames;
1562 usb_config[0].bufsize = u.popen->max_bufsize;
1563 usb_config[0].usb_mode = USB_MODE_DUAL; /* both modes */
1564 if (cmd == USB_FS_OPEN_STREAM)
1565 usb_config[0].stream_id = u.popen_stream->stream_id;
1567 if (usb_config[0].type == UE_CONTROL) {
1568 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1574 isread = ((usb_config[0].endpoint &
1575 (UE_DIR_IN | UE_DIR_OUT)) == UE_DIR_IN);
1577 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1580 /* check permissions */
1582 if (!(fflags & FREAD)) {
1587 if (!(fflags & FWRITE)) {
1593 error = usbd_transfer_setup(f->udev, &iface_index,
1594 f->fs_xfer + u.popen->ep_index, usb_config, 1,
1597 /* update maximums */
1598 u.popen->max_packet_length =
1599 f->fs_xfer[u.popen->ep_index]->max_frame_size;
1600 u.popen->max_bufsize =
1601 f->fs_xfer[u.popen->ep_index]->max_data_length;
1602 /* update number of frames */
1603 u.popen->max_frames =
1604 f->fs_xfer[u.popen->ep_index]->nframes;
1605 /* store index of endpoint */
1606 f->fs_xfer[u.popen->ep_index]->priv_fifo =
1607 ((uint8_t *)0) + u.popen->ep_index;
1614 if (u.pclose->ep_index >= f->fs_ep_max) {
1618 if (f->fs_xfer[u.pclose->ep_index] == NULL) {
1622 usbd_transfer_unsetup(f->fs_xfer + u.pclose->ep_index, 1);
1625 case USB_FS_CLEAR_STALL_SYNC:
1626 if (u.pstall->ep_index >= f->fs_ep_max) {
1630 if (f->fs_xfer[u.pstall->ep_index] == NULL) {
1634 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1638 mtx_lock(f->priv_mtx);
1639 error = usbd_transfer_pending(f->fs_xfer[u.pstall->ep_index]);
1640 mtx_unlock(f->priv_mtx);
1645 ep = f->fs_xfer[u.pstall->ep_index]->endpoint;
1647 /* setup a clear-stall packet */
1648 req.bmRequestType = UT_WRITE_ENDPOINT;
1649 req.bRequest = UR_CLEAR_FEATURE;
1650 USETW(req.wValue, UF_ENDPOINT_HALT);
1651 req.wIndex[0] = ep->edesc->bEndpointAddress;
1653 USETW(req.wLength, 0);
1655 error = usbd_do_request(f->udev, NULL, &req, NULL);
1657 usbd_clear_data_toggle(f->udev, ep);
1668 DPRINTFN(6, "error=%d\n", error);
1674 ugen_set_short_xfer(struct usb_fifo *f, void *addr)
1683 if (f->flag_short == t) {
1684 /* same value like before - accept */
1687 if (f->xfer[0] || f->xfer[1]) {
1688 /* cannot change this during transfer */
1696 ugen_set_timeout(struct usb_fifo *f, void *addr)
1698 f->timeout = *(int *)addr;
1699 if (f->timeout > 65535) {
1700 /* limit user input */
1707 ugen_get_frame_size(struct usb_fifo *f, void *addr)
1710 *(int *)addr = f->xfer[0]->max_frame_size;
1718 ugen_set_buffer_size(struct usb_fifo *f, void *addr)
1722 if (*(int *)addr < 0)
1723 t = 0; /* use "wMaxPacketSize" */
1724 else if (*(int *)addr < (256 * 1024))
1729 if (f->bufsize == t) {
1730 /* same value like before - accept */
1733 if (f->xfer[0] || f->xfer[1]) {
1734 /* cannot change this during transfer */
1742 ugen_get_buffer_size(struct usb_fifo *f, void *addr)
1744 *(int *)addr = f->bufsize;
1749 ugen_get_iface_desc(struct usb_fifo *f,
1750 struct usb_interface_descriptor *idesc)
1752 struct usb_interface *iface;
1754 iface = usbd_get_iface(f->udev, f->iface_index);
1755 if (iface && iface->idesc) {
1756 *idesc = *(iface->idesc);
1764 ugen_get_endpoint_desc(struct usb_fifo *f,
1765 struct usb_endpoint_descriptor *ed)
1767 struct usb_endpoint *ep;
1769 ep = usb_fifo_softc(f);
1771 if (ep && ep->edesc) {
1780 ugen_set_power_mode(struct usb_fifo *f, int mode)
1782 struct usb_device *udev = f->udev;
1786 if ((udev == NULL) ||
1787 (udev->parent_hub == NULL)) {
1790 err = priv_check(curthread, PRIV_DRIVER);
1794 /* get old power mode */
1795 old_mode = udev->power_mode;
1797 /* if no change, then just return */
1798 if (old_mode == mode)
1802 case USB_POWER_MODE_OFF:
1803 if (udev->flags.usb_mode == USB_MODE_HOST &&
1804 udev->re_enumerate_wait == USB_RE_ENUM_DONE) {
1805 udev->re_enumerate_wait = USB_RE_ENUM_PWR_OFF;
1807 /* set power mode will wake up the explore thread */
1810 case USB_POWER_MODE_ON:
1811 case USB_POWER_MODE_SAVE:
1814 case USB_POWER_MODE_RESUME:
1816 /* let USB-powerd handle resume */
1817 USB_BUS_LOCK(udev->bus);
1818 udev->pwr_save.write_refs++;
1819 udev->pwr_save.last_xfer_time = ticks;
1820 USB_BUS_UNLOCK(udev->bus);
1822 /* set new power mode */
1823 usbd_set_power_mode(udev, USB_POWER_MODE_SAVE);
1825 /* wait for resume to complete */
1826 usb_pause_mtx(NULL, hz / 4);
1828 /* clear write reference */
1829 USB_BUS_LOCK(udev->bus);
1830 udev->pwr_save.write_refs--;
1831 USB_BUS_UNLOCK(udev->bus);
1833 mode = USB_POWER_MODE_SAVE;
1836 case USB_POWER_MODE_SUSPEND:
1838 /* let USB-powerd handle suspend */
1839 USB_BUS_LOCK(udev->bus);
1840 udev->pwr_save.last_xfer_time = ticks - (256 * hz);
1841 USB_BUS_UNLOCK(udev->bus);
1843 mode = USB_POWER_MODE_SAVE;
1851 return (ENXIO); /* I/O failure */
1853 /* if we are powered off we need to re-enumerate first */
1854 if (old_mode == USB_POWER_MODE_OFF) {
1855 if (udev->flags.usb_mode == USB_MODE_HOST &&
1856 udev->re_enumerate_wait == USB_RE_ENUM_DONE) {
1857 udev->re_enumerate_wait = USB_RE_ENUM_START;
1859 /* set power mode will wake up the explore thread */
1862 /* set new power mode */
1863 usbd_set_power_mode(udev, mode);
1865 return (0); /* success */
1869 ugen_get_power_mode(struct usb_fifo *f)
1871 struct usb_device *udev = f->udev;
1874 return (USB_POWER_MODE_ON);
1876 return (udev->power_mode);
1880 ugen_get_port_path(struct usb_fifo *f, struct usb_device_port_path *dpp)
1882 struct usb_device *udev = f->udev;
1883 struct usb_device *next;
1884 unsigned int nlevel = 0;
1889 dpp->udp_bus = device_get_unit(udev->bus->bdev);
1890 dpp->udp_index = udev->device_index;
1892 /* count port levels */
1894 while (next->parent_hub != NULL) {
1896 next = next->parent_hub;
1899 /* check if too many levels */
1900 if (nlevel > USB_DEVICE_PORT_PATH_MAX)
1903 /* store total level of ports */
1904 dpp->udp_port_level = nlevel;
1906 /* store port index array */
1908 while (next->parent_hub != NULL) {
1909 dpp->udp_port_no[--nlevel] = next->port_no;
1910 next = next->parent_hub;
1912 return (0); /* success */
1915 return (EINVAL); /* failure */
1919 ugen_get_power_usage(struct usb_fifo *f)
1921 struct usb_device *udev = f->udev;
1926 return (udev->power);
1930 ugen_do_port_feature(struct usb_fifo *f, uint8_t port_no,
1931 uint8_t set, uint16_t feature)
1933 struct usb_device *udev = f->udev;
1934 struct usb_hub *hub;
1937 err = priv_check(curthread, PRIV_DRIVER);
1944 if ((udev == NULL) ||
1945 (udev->hub == NULL)) {
1950 if (port_no > hub->nports) {
1954 err = usbd_req_set_port_feature(udev,
1955 NULL, port_no, feature);
1957 err = usbd_req_clear_port_feature(udev,
1958 NULL, port_no, feature);
1961 return (ENXIO); /* failure */
1963 return (0); /* success */
1967 ugen_iface_ioctl(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
1969 struct usb_fifo *f_rx;
1970 struct usb_fifo *f_tx;
1973 f_rx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_RX];
1974 f_tx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_TX];
1977 case USB_SET_RX_SHORT_XFER:
1978 if (fflags & FREAD) {
1979 error = ugen_set_short_xfer(f_rx, addr);
1985 case USB_SET_TX_FORCE_SHORT:
1986 if (fflags & FWRITE) {
1987 error = ugen_set_short_xfer(f_tx, addr);
1993 case USB_SET_RX_TIMEOUT:
1994 if (fflags & FREAD) {
1995 error = ugen_set_timeout(f_rx, addr);
2001 case USB_SET_TX_TIMEOUT:
2002 if (fflags & FWRITE) {
2003 error = ugen_set_timeout(f_tx, addr);
2009 case USB_GET_RX_FRAME_SIZE:
2010 if (fflags & FREAD) {
2011 error = ugen_get_frame_size(f_rx, addr);
2017 case USB_GET_TX_FRAME_SIZE:
2018 if (fflags & FWRITE) {
2019 error = ugen_get_frame_size(f_tx, addr);
2025 case USB_SET_RX_BUFFER_SIZE:
2026 if (fflags & FREAD) {
2027 error = ugen_set_buffer_size(f_rx, addr);
2033 case USB_SET_TX_BUFFER_SIZE:
2034 if (fflags & FWRITE) {
2035 error = ugen_set_buffer_size(f_tx, addr);
2041 case USB_GET_RX_BUFFER_SIZE:
2042 if (fflags & FREAD) {
2043 error = ugen_get_buffer_size(f_rx, addr);
2049 case USB_GET_TX_BUFFER_SIZE:
2050 if (fflags & FWRITE) {
2051 error = ugen_get_buffer_size(f_tx, addr);
2057 case USB_GET_RX_INTERFACE_DESC:
2058 if (fflags & FREAD) {
2059 error = ugen_get_iface_desc(f_rx, addr);
2065 case USB_GET_TX_INTERFACE_DESC:
2066 if (fflags & FWRITE) {
2067 error = ugen_get_iface_desc(f_tx, addr);
2073 case USB_GET_RX_ENDPOINT_DESC:
2074 if (fflags & FREAD) {
2075 error = ugen_get_endpoint_desc(f_rx, addr);
2081 case USB_GET_TX_ENDPOINT_DESC:
2082 if (fflags & FWRITE) {
2083 error = ugen_get_endpoint_desc(f_tx, addr);
2089 case USB_SET_RX_STALL_FLAG:
2090 if ((fflags & FREAD) && (*(int *)addr)) {
2091 f_rx->flag_stall = 1;
2095 case USB_SET_TX_STALL_FLAG:
2096 if ((fflags & FWRITE) && (*(int *)addr)) {
2097 f_tx->flag_stall = 1;
2109 ugen_ioctl_post(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
2112 struct usb_interface_descriptor *idesc;
2113 struct usb_alt_interface *ai;
2114 struct usb_device_descriptor *ddesc;
2115 struct usb_config_descriptor *cdesc;
2116 struct usb_device_stats *stat;
2117 struct usb_fs_init *pinit;
2118 struct usb_fs_uninit *puninit;
2119 struct usb_device_port_path *dpp;
2124 struct usb_device_descriptor *dtemp;
2125 struct usb_config_descriptor *ctemp;
2126 struct usb_interface *iface;
2132 DPRINTFN(6, "cmd=0x%08lx\n", cmd);
2136 usb_needs_explore_all();
2140 if (!(fflags & FWRITE)) {
2144 usb_debug = *(int *)addr;
2147 case USB_GET_CONFIG:
2148 *(int *)addr = f->udev->curr_config_index;
2151 case USB_SET_CONFIG:
2152 if (!(fflags & FWRITE)) {
2156 error = ugen_set_config(f, *(int *)addr);
2159 case USB_GET_ALTINTERFACE:
2160 iface = usbd_get_iface(f->udev,
2161 u.ai->uai_interface_index);
2162 if (iface && iface->idesc) {
2163 u.ai->uai_alt_index = iface->alt_index;
2169 case USB_SET_ALTINTERFACE:
2170 if (!(fflags & FWRITE)) {
2174 error = ugen_set_interface(f,
2175 u.ai->uai_interface_index, u.ai->uai_alt_index);
2178 case USB_GET_DEVICE_DESC:
2179 dtemp = usbd_get_device_descriptor(f->udev);
2187 case USB_GET_CONFIG_DESC:
2188 ctemp = usbd_get_config_descriptor(f->udev);
2196 case USB_GET_FULL_DESC:
2197 error = ugen_get_cdesc(f, addr);
2200 case USB_GET_STRING_DESC:
2201 error = ugen_get_sdesc(f, addr);
2204 case USB_GET_IFACE_DRIVER:
2205 error = ugen_get_iface_driver(f, addr);
2209 case USB_DO_REQUEST:
2210 if (!(fflags & FWRITE)) {
2214 error = ugen_do_request(f, addr);
2217 case USB_DEVICEINFO:
2218 case USB_GET_DEVICEINFO:
2219 error = usb_gen_fill_deviceinfo(f, addr);
2222 case USB_DEVICESTATS:
2223 for (n = 0; n != 4; n++) {
2225 u.stat->uds_requests_fail[n] =
2226 f->udev->stats_err.uds_requests[n];
2227 u.stat->uds_requests_ok[n] =
2228 f->udev->stats_ok.uds_requests[n];
2232 case USB_DEVICEENUMERATE:
2233 error = ugen_re_enumerate(f);
2236 case USB_GET_PLUGTIME:
2237 *u.ptime = f->udev->plugtime;
2240 case USB_CLAIM_INTERFACE:
2241 case USB_RELEASE_INTERFACE:
2245 case USB_IFACE_DRIVER_ACTIVE:
2249 iface = usbd_get_iface(f->udev, n);
2251 if (iface && iface->subdev)
2257 case USB_IFACE_DRIVER_DETACH:
2259 error = priv_check(curthread, PRIV_DRIVER);
2266 if (n == USB_IFACE_INDEX_ANY) {
2272 * Detach the currently attached driver.
2274 usb_detach_device(f->udev, n, 0);
2277 * Set parent to self, this should keep attach away
2278 * until the next set configuration event.
2280 usbd_set_parent_iface(f->udev, n, n);
2283 case USB_SET_POWER_MODE:
2284 error = ugen_set_power_mode(f, *u.pint);
2287 case USB_GET_POWER_MODE:
2288 *u.pint = ugen_get_power_mode(f);
2291 case USB_GET_DEV_PORT_PATH:
2292 error = ugen_get_port_path(f, u.dpp);
2295 case USB_GET_POWER_USAGE:
2296 *u.pint = ugen_get_power_usage(f);
2299 case USB_SET_PORT_ENABLE:
2300 error = ugen_do_port_feature(f,
2301 *u.pint, 1, UHF_PORT_ENABLE);
2304 case USB_SET_PORT_DISABLE:
2305 error = ugen_do_port_feature(f,
2306 *u.pint, 0, UHF_PORT_ENABLE);
2310 /* verify input parameters */
2311 if (u.pinit->pEndpoints == NULL) {
2315 if (u.pinit->ep_index_max > 127) {
2319 if (u.pinit->ep_index_max == 0) {
2323 if (f->fs_xfer != NULL) {
2327 if (f->dev_ep_index != 0) {
2331 if (ugen_fifo_in_use(f, fflags)) {
2335 error = usb_fifo_alloc_buffer(f, 1, u.pinit->ep_index_max);
2339 f->fs_xfer = malloc(sizeof(f->fs_xfer[0]) *
2340 u.pinit->ep_index_max, M_USB, M_WAITOK | M_ZERO);
2341 if (f->fs_xfer == NULL) {
2342 usb_fifo_free_buffer(f);
2346 f->fs_ep_max = u.pinit->ep_index_max;
2347 f->fs_ep_ptr = u.pinit->pEndpoints;
2351 if (u.puninit->dummy != 0) {
2355 error = ugen_fs_uninit(f);
2359 mtx_lock(f->priv_mtx);
2360 error = ugen_iface_ioctl(f, cmd, addr, fflags);
2361 mtx_unlock(f->priv_mtx);
2364 DPRINTFN(6, "error=%d\n", error);
2369 ugen_ctrl_fs_callback(struct usb_xfer *xfer, usb_error_t error)
2371 ; /* workaround for a bug in "indent" */
2373 DPRINTF("st=%u alen=%u aframes=%u\n",
2374 USB_GET_STATE(xfer), xfer->actlen, xfer->aframes);
2376 switch (USB_GET_STATE(xfer)) {
2378 usbd_transfer_submit(xfer);
2381 ugen_fs_set_complete(xfer->priv_sc, USB_P2U(xfer->priv_fifo));
2385 #endif /* USB_HAVE_UGEN */