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 | CTLFLAG_MPSAFE, 0,
137 SYSCTL_INT(_hw_usb_ugen, OID_AUTO, debug, CTLFLAG_RWTUN, &ugen_debug,
145 ugen_transfer_setup(struct usb_fifo *f,
146 const struct usb_config *setup, uint8_t n_setup)
148 struct usb_endpoint *ep = usb_fifo_softc(f);
149 struct usb_device *udev = f->udev;
150 uint8_t iface_index = ep->iface_index;
153 mtx_unlock(f->priv_mtx);
156 * "usbd_transfer_setup()" can sleep so one needs to make a wrapper,
157 * exiting the mutex and checking things
159 error = usbd_transfer_setup(udev, &iface_index, f->xfer,
160 setup, n_setup, f, f->priv_mtx);
163 if (f->xfer[0]->nframes == 1) {
164 error = usb_fifo_alloc_buffer(f,
165 f->xfer[0]->max_data_length, 2);
167 error = usb_fifo_alloc_buffer(f,
168 f->xfer[0]->max_frame_size,
169 2 * f->xfer[0]->nframes);
172 usbd_transfer_unsetup(f->xfer, n_setup);
175 mtx_lock(f->priv_mtx);
181 ugen_open(struct usb_fifo *f, int fflags)
183 struct usb_endpoint *ep = usb_fifo_softc(f);
184 struct usb_endpoint_descriptor *ed = ep->edesc;
187 DPRINTFN(1, "flag=0x%x pid=%d name=%s\n", fflags,
188 curthread->td_proc->p_pid, curthread->td_proc->p_comm);
190 mtx_lock(f->priv_mtx);
191 switch (usbd_get_speed(f->udev)) {
194 f->nframes = UGEN_HW_FRAMES;
195 f->bufsize = UGEN_BULK_FS_BUFFER_SIZE;
198 f->nframes = UGEN_HW_FRAMES * 8;
199 f->bufsize = UGEN_BULK_HS_BUFFER_SIZE;
203 type = ed->bmAttributes & UE_XFERTYPE;
204 if (type == UE_INTERRUPT) {
205 f->bufsize = 0; /* use "wMaxPacketSize" */
207 f->timeout = USB_NO_TIMEOUT;
210 mtx_unlock(f->priv_mtx);
216 ugen_close(struct usb_fifo *f, int fflags)
219 DPRINTFN(1, "flag=0x%x pid=%d name=%s\n", fflags,
220 curthread->td_proc->p_pid, curthread->td_proc->p_comm);
224 mtx_lock(f->priv_mtx);
225 usbd_transfer_stop(f->xfer[0]);
226 usbd_transfer_stop(f->xfer[1]);
227 mtx_unlock(f->priv_mtx);
229 usbd_transfer_unsetup(f->xfer, 2);
230 usb_fifo_free_buffer(f);
232 if (ugen_fs_uninit(f)) {
233 /* ignore any errors - we are closing */
234 DPRINTFN(6, "no FIFOs\n");
239 ugen_open_pipe_write(struct usb_fifo *f)
241 struct usb_config usb_config[2];
242 struct usb_endpoint *ep = usb_fifo_softc(f);
243 struct usb_endpoint_descriptor *ed = ep->edesc;
245 USB_MTX_ASSERT(f->priv_mtx, MA_OWNED);
247 if (f->xfer[0] || f->xfer[1]) {
248 /* transfers are already opened */
251 memset(usb_config, 0, sizeof(usb_config));
253 usb_config[1].type = UE_CONTROL;
254 usb_config[1].endpoint = 0;
255 usb_config[1].direction = UE_DIR_ANY;
256 usb_config[1].timeout = 1000; /* 1 second */
257 usb_config[1].interval = 50;/* 50 milliseconds */
258 usb_config[1].bufsize = sizeof(struct usb_device_request);
259 usb_config[1].callback = &ugen_write_clear_stall_callback;
260 usb_config[1].usb_mode = USB_MODE_HOST;
262 usb_config[0].type = ed->bmAttributes & UE_XFERTYPE;
263 usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR;
264 usb_config[0].stream_id = 0; /* XXX support more stream ID's */
265 usb_config[0].direction = UE_DIR_TX;
266 usb_config[0].interval = USB_DEFAULT_INTERVAL;
267 usb_config[0].flags.proxy_buffer = 1;
268 usb_config[0].usb_mode = USB_MODE_DUAL; /* both modes */
270 switch (ed->bmAttributes & UE_XFERTYPE) {
274 usb_config[0].flags.force_short_xfer = 1;
276 usb_config[0].callback = &ugen_ctrl_write_callback;
277 usb_config[0].timeout = f->timeout;
278 usb_config[0].frames = 1;
279 usb_config[0].bufsize = f->bufsize;
280 if (ugen_transfer_setup(f, usb_config, 2)) {
283 /* first transfer does not clear stall */
288 usb_config[0].flags.short_xfer_ok = 1;
289 usb_config[0].bufsize = 0; /* use default */
290 usb_config[0].frames = f->nframes;
291 usb_config[0].callback = &ugen_isoc_write_callback;
292 usb_config[0].timeout = 0;
294 /* clone configuration */
295 usb_config[1] = usb_config[0];
297 if (ugen_transfer_setup(f, usb_config, 2)) {
308 ugen_open_pipe_read(struct usb_fifo *f)
310 struct usb_config usb_config[2];
311 struct usb_endpoint *ep = usb_fifo_softc(f);
312 struct usb_endpoint_descriptor *ed = ep->edesc;
314 USB_MTX_ASSERT(f->priv_mtx, MA_OWNED);
316 if (f->xfer[0] || f->xfer[1]) {
317 /* transfers are already opened */
320 memset(usb_config, 0, sizeof(usb_config));
322 usb_config[1].type = UE_CONTROL;
323 usb_config[1].endpoint = 0;
324 usb_config[1].direction = UE_DIR_ANY;
325 usb_config[1].timeout = 1000; /* 1 second */
326 usb_config[1].interval = 50;/* 50 milliseconds */
327 usb_config[1].bufsize = sizeof(struct usb_device_request);
328 usb_config[1].callback = &ugen_read_clear_stall_callback;
329 usb_config[1].usb_mode = USB_MODE_HOST;
331 usb_config[0].type = ed->bmAttributes & UE_XFERTYPE;
332 usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR;
333 usb_config[0].stream_id = 0; /* XXX support more stream ID's */
334 usb_config[0].direction = UE_DIR_RX;
335 usb_config[0].interval = USB_DEFAULT_INTERVAL;
336 usb_config[0].flags.proxy_buffer = 1;
337 usb_config[0].usb_mode = USB_MODE_DUAL; /* both modes */
339 switch (ed->bmAttributes & UE_XFERTYPE) {
343 usb_config[0].flags.short_xfer_ok = 1;
345 usb_config[0].timeout = f->timeout;
346 usb_config[0].frames = 1;
347 usb_config[0].callback = &ugen_ctrl_read_callback;
348 usb_config[0].bufsize = f->bufsize;
350 if (ugen_transfer_setup(f, usb_config, 2)) {
353 /* first transfer does not clear stall */
358 usb_config[0].flags.short_xfer_ok = 1;
359 usb_config[0].bufsize = 0; /* use default */
360 usb_config[0].frames = f->nframes;
361 usb_config[0].callback = &ugen_isoc_read_callback;
362 usb_config[0].timeout = 0;
364 /* clone configuration */
365 usb_config[1] = usb_config[0];
367 if (ugen_transfer_setup(f, usb_config, 2)) {
379 ugen_start_read(struct usb_fifo *f)
381 /* check that pipes are open */
382 if (ugen_open_pipe_read(f)) {
384 usb_fifo_put_data_error(f);
386 /* start transfers */
387 usbd_transfer_start(f->xfer[0]);
388 usbd_transfer_start(f->xfer[1]);
392 ugen_start_write(struct usb_fifo *f)
394 /* check that pipes are open */
395 if (ugen_open_pipe_write(f)) {
397 usb_fifo_get_data_error(f);
399 /* start transfers */
400 usbd_transfer_start(f->xfer[0]);
401 usbd_transfer_start(f->xfer[1]);
405 ugen_stop_io(struct usb_fifo *f)
408 usbd_transfer_stop(f->xfer[0]);
409 usbd_transfer_stop(f->xfer[1]);
413 ugen_ctrl_read_callback(struct usb_xfer *xfer, usb_error_t error)
415 struct usb_fifo *f = usbd_xfer_softc(xfer);
418 DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
420 switch (USB_GET_STATE(xfer)) {
421 case USB_ST_TRANSFERRED:
422 if (xfer->actlen == 0) {
423 if (f->fifo_zlp != 4) {
427 * Throttle a little bit we have multiple ZLPs
430 xfer->interval = 64; /* ms */
437 usb_fifo_put_data(f, xfer->frbuffers, 0,
442 usbd_transfer_start(f->xfer[1]);
445 USB_IF_POLL(&f->free_q, m);
447 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
448 usbd_transfer_submit(xfer);
453 if (xfer->error != USB_ERR_CANCELLED) {
454 /* send a zero length packet to userland */
455 usb_fifo_put_data(f, xfer->frbuffers, 0, 0, 1);
458 usbd_transfer_start(f->xfer[1]);
465 ugen_ctrl_write_callback(struct usb_xfer *xfer, usb_error_t error)
467 struct usb_fifo *f = usbd_xfer_softc(xfer);
468 usb_frlength_t actlen;
470 DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
472 switch (USB_GET_STATE(xfer)) {
474 case USB_ST_TRANSFERRED:
476 * If writing is in stall, just jump to clear stall
477 * callback and solve the situation.
480 usbd_transfer_start(f->xfer[1]);
484 * Write data, setup and perform hardware transfer.
486 if (usb_fifo_get_data(f, xfer->frbuffers, 0,
487 xfer->max_data_length, &actlen, 0)) {
488 usbd_xfer_set_frame_len(xfer, 0, actlen);
489 usbd_transfer_submit(xfer);
494 if (xfer->error != USB_ERR_CANCELLED) {
496 usbd_transfer_start(f->xfer[1]);
503 ugen_read_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error)
505 struct usb_fifo *f = usbd_xfer_softc(xfer);
506 struct usb_xfer *xfer_other = f->xfer[0];
508 if (f->flag_stall == 0) {
512 if (usbd_clear_stall_callback(xfer, xfer_other)) {
513 DPRINTFN(5, "f=%p: stall cleared\n", f);
515 usbd_transfer_start(xfer_other);
520 ugen_write_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error)
522 struct usb_fifo *f = usbd_xfer_softc(xfer);
523 struct usb_xfer *xfer_other = f->xfer[0];
525 if (f->flag_stall == 0) {
529 if (usbd_clear_stall_callback(xfer, xfer_other)) {
530 DPRINTFN(5, "f=%p: stall cleared\n", f);
532 usbd_transfer_start(xfer_other);
537 ugen_isoc_read_callback(struct usb_xfer *xfer, usb_error_t error)
539 struct usb_fifo *f = usbd_xfer_softc(xfer);
540 usb_frlength_t offset;
543 DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
545 switch (USB_GET_STATE(xfer)) {
546 case USB_ST_TRANSFERRED:
548 DPRINTFN(6, "actlen=%d\n", xfer->actlen);
552 for (n = 0; n != xfer->aframes; n++) {
553 usb_fifo_put_data(f, xfer->frbuffers, offset,
554 xfer->frlengths[n], 1);
555 offset += xfer->max_frame_size;
560 for (n = 0; n != xfer->nframes; n++) {
561 /* setup size for next transfer */
562 usbd_xfer_set_frame_len(xfer, n, xfer->max_frame_size);
564 usbd_transfer_submit(xfer);
568 if (xfer->error == USB_ERR_CANCELLED) {
576 ugen_isoc_write_callback(struct usb_xfer *xfer, usb_error_t error)
578 struct usb_fifo *f = usbd_xfer_softc(xfer);
579 usb_frlength_t actlen;
580 usb_frlength_t offset;
583 DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
585 switch (USB_GET_STATE(xfer)) {
586 case USB_ST_TRANSFERRED:
590 for (n = 0; n != xfer->nframes; n++) {
591 if (usb_fifo_get_data(f, xfer->frbuffers, offset,
592 xfer->max_frame_size, &actlen, 1)) {
593 usbd_xfer_set_frame_len(xfer, n, actlen);
600 for (; n != xfer->nframes; n++) {
601 /* fill in zero frames */
602 usbd_xfer_set_frame_len(xfer, n, 0);
604 usbd_transfer_submit(xfer);
608 if (xfer->error == USB_ERR_CANCELLED) {
616 ugen_set_config(struct usb_fifo *f, uint8_t index)
618 DPRINTFN(2, "index %u\n", index);
620 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
621 /* not possible in device side mode */
625 /* make sure all FIFO's are gone */
626 /* else there can be a deadlock */
627 if (ugen_fs_uninit(f)) {
628 /* ignore any errors */
629 DPRINTFN(6, "no FIFOs\n");
632 if (usbd_start_set_config(f->udev, index) != 0)
639 ugen_set_interface(struct usb_fifo *f,
640 uint8_t iface_index, uint8_t alt_index)
642 DPRINTFN(2, "%u, %u\n", iface_index, alt_index);
644 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
645 /* not possible in device side mode */
648 /* make sure all FIFO's are gone */
649 /* else there can be a deadlock */
650 if (ugen_fs_uninit(f)) {
651 /* ignore any errors */
652 DPRINTFN(6, "no FIFOs\n");
654 /* change setting - will free generic FIFOs, if any */
655 if (usbd_set_alt_interface_index(f->udev, iface_index, alt_index)) {
658 /* probe and attach */
659 if (usb_probe_and_attach(f->udev, iface_index)) {
665 /*------------------------------------------------------------------------*
668 * This function will retrieve the complete configuration descriptor
669 * at the given index.
670 *------------------------------------------------------------------------*/
672 ugen_get_cdesc(struct usb_fifo *f, struct usb_gen_descriptor *ugd)
674 struct usb_config_descriptor *cdesc;
675 struct usb_device *udev = f->udev;
682 if (ugd->ugd_data == NULL) {
683 /* userland pointer should not be zero */
686 if ((ugd->ugd_config_index == USB_UNCONFIG_INDEX) ||
687 (ugd->ugd_config_index == udev->curr_config_index)) {
688 cdesc = usbd_get_config_descriptor(udev);
694 #if (USB_HAVE_FIXED_CONFIG == 0)
695 if (usbd_req_get_config_desc_full(udev,
696 NULL, &cdesc, ugd->ugd_config_index)) {
701 /* configuration descriptor data is shared */
706 len = UGETW(cdesc->wTotalLength);
707 if (len > ugd->ugd_maxlen) {
708 len = ugd->ugd_maxlen;
710 DPRINTFN(6, "len=%u\n", len);
712 ugd->ugd_actlen = len;
715 error = copyout(cdesc, ugd->ugd_data, len);
718 usbd_free_config_desc(udev, cdesc);
724 ugen_get_sdesc(struct usb_fifo *f, struct usb_gen_descriptor *ugd)
731 /* Protect scratch area */
732 do_unlock = usbd_ctrl_lock(f->udev);
734 ptr = f->udev->scratch.data;
735 size = sizeof(f->udev->scratch.data);
737 if (usbd_req_get_string_desc(f->udev, NULL, ptr,
738 size, ugd->ugd_lang_id, ugd->ugd_string_index)) {
742 if (size > ((uint8_t *)ptr)[0]) {
743 size = ((uint8_t *)ptr)[0];
745 if (size > ugd->ugd_maxlen) {
746 size = ugd->ugd_maxlen;
748 ugd->ugd_actlen = size;
751 error = copyout(ptr, ugd->ugd_data, size);
754 usbd_ctrl_unlock(f->udev);
759 /*------------------------------------------------------------------------*
760 * ugen_get_iface_driver
762 * This function generates an USB interface description for userland.
767 *------------------------------------------------------------------------*/
769 ugen_get_iface_driver(struct usb_fifo *f, struct usb_gen_descriptor *ugd)
771 struct usb_device *udev = f->udev;
772 struct usb_interface *iface;
782 if ((ugd->ugd_data == NULL) || (ugd->ugd_maxlen == 0)) {
783 /* userland pointer should not be zero */
787 iface = usbd_get_iface(udev, ugd->ugd_iface_index);
788 if ((iface == NULL) || (iface->idesc == NULL)) {
789 /* invalid interface index */
793 /* read out device nameunit string, if any */
794 if ((iface->subdev != NULL) &&
795 device_is_attached(iface->subdev) &&
796 (ptr = device_get_nameunit(iface->subdev)) &&
797 (desc = device_get_desc(iface->subdev))) {
799 /* print description */
800 snprintf(buf, sizeof(buf), "%s: <%s>", ptr, desc);
803 maxlen = ugd->ugd_maxlen - 1;
808 /* update actual length, including terminating zero */
809 ugd->ugd_actlen = len + 1;
811 /* copy out interface description */
812 error = copyout(buf, ugd->ugd_data, ugd->ugd_actlen);
814 /* zero length string is default */
815 error = copyout("", ugd->ugd_data, 1);
820 /*------------------------------------------------------------------------*
821 * usb_gen_fill_deviceinfo
823 * This function dumps information about an USB device to the
824 * structure pointed to by the "di" argument.
829 *------------------------------------------------------------------------*/
831 usb_gen_fill_deviceinfo(struct usb_fifo *f, struct usb_device_info *di)
833 struct usb_device *udev;
834 struct usb_device *hub;
838 bzero(di, sizeof(di[0]));
840 di->udi_bus = device_get_unit(udev->bus->bdev);
841 di->udi_addr = udev->address;
842 di->udi_index = udev->device_index;
843 strlcpy(di->udi_serial, usb_get_serial(udev), sizeof(di->udi_serial));
844 strlcpy(di->udi_vendor, usb_get_manufacturer(udev), sizeof(di->udi_vendor));
845 strlcpy(di->udi_product, usb_get_product(udev), sizeof(di->udi_product));
846 usb_printbcd(di->udi_release, sizeof(di->udi_release),
847 UGETW(udev->ddesc.bcdDevice));
848 di->udi_vendorNo = UGETW(udev->ddesc.idVendor);
849 di->udi_productNo = UGETW(udev->ddesc.idProduct);
850 di->udi_releaseNo = UGETW(udev->ddesc.bcdDevice);
851 di->udi_class = udev->ddesc.bDeviceClass;
852 di->udi_subclass = udev->ddesc.bDeviceSubClass;
853 di->udi_protocol = udev->ddesc.bDeviceProtocol;
854 di->udi_config_no = udev->curr_config_no;
855 di->udi_config_index = udev->curr_config_index;
856 di->udi_power = udev->flags.self_powered ? 0 : udev->power;
857 di->udi_speed = udev->speed;
858 di->udi_mode = udev->flags.usb_mode;
859 di->udi_power_mode = udev->power_mode;
860 di->udi_suspended = udev->flags.peer_suspended;
862 hub = udev->parent_hub;
864 di->udi_hubaddr = hub->address;
865 di->udi_hubindex = hub->device_index;
866 di->udi_hubport = udev->port_no;
871 /*------------------------------------------------------------------------*
877 *------------------------------------------------------------------------*/
879 ugen_check_request(struct usb_device *udev, struct usb_device_request *req)
881 struct usb_endpoint *ep;
885 * Avoid requests that would damage the bus integrity:
887 if (((req->bmRequestType == UT_WRITE_DEVICE) &&
888 (req->bRequest == UR_SET_ADDRESS)) ||
889 ((req->bmRequestType == UT_WRITE_DEVICE) &&
890 (req->bRequest == UR_SET_CONFIG)) ||
891 ((req->bmRequestType == UT_WRITE_INTERFACE) &&
892 (req->bRequest == UR_SET_INTERFACE))) {
894 * These requests can be useful for testing USB drivers.
896 error = priv_check(curthread, PRIV_DRIVER);
902 * Special case - handle clearing of stall
904 if (req->bmRequestType == UT_WRITE_ENDPOINT) {
906 ep = usbd_get_ep_by_addr(udev, req->wIndex[0]);
910 if ((req->bRequest == UR_CLEAR_FEATURE) &&
911 (UGETW(req->wValue) == UF_ENDPOINT_HALT)) {
912 usbd_clear_data_toggle(udev, ep);
915 /* TODO: add more checks to verify the interface index */
921 ugen_do_request(struct usb_fifo *f, struct usb_ctl_request *ur)
927 if (ugen_check_request(f->udev, &ur->ucr_request)) {
930 len = UGETW(ur->ucr_request.wLength);
932 /* check if "ucr_data" is valid */
934 if (ur->ucr_data == NULL) {
938 /* do the USB request */
939 error = usbd_do_request_flags
940 (f->udev, NULL, &ur->ucr_request, ur->ucr_data,
941 (ur->ucr_flags & USB_SHORT_XFER_OK) |
942 USB_USER_DATA_PTR, &actlen,
943 USB_DEFAULT_TIMEOUT);
945 ur->ucr_actlen = actlen;
953 /*------------------------------------------------------------------------
955 *------------------------------------------------------------------------*/
957 ugen_re_enumerate(struct usb_fifo *f)
959 struct usb_device *udev = f->udev;
963 * This request can be useful for testing USB drivers:
965 error = priv_check(curthread, PRIV_DRIVER);
969 if (udev->flags.usb_mode != USB_MODE_HOST) {
970 /* not possible in device side mode */
971 DPRINTFN(6, "device mode\n");
974 /* make sure all FIFO's are gone */
975 /* else there can be a deadlock */
976 if (ugen_fs_uninit(f)) {
977 /* ignore any errors */
978 DPRINTFN(6, "no FIFOs\n");
980 /* start re-enumeration of device */
981 usbd_start_re_enumerate(udev);
986 ugen_fs_uninit(struct usb_fifo *f)
988 if (f->fs_xfer == NULL) {
991 usbd_transfer_unsetup(f->fs_xfer, f->fs_ep_max);
992 free(f->fs_xfer, M_USB);
996 f->flag_iscomplete = 0;
997 usb_fifo_free_buffer(f);
1002 ugen_fs_get_complete(struct usb_fifo *f, uint8_t *pindex)
1006 USB_IF_DEQUEUE(&f->used_q, m);
1009 *pindex = *((uint8_t *)(m->cur_data_ptr));
1011 USB_IF_ENQUEUE(&f->free_q, m);
1013 return (0); /* success */
1016 *pindex = 0; /* fix compiler warning */
1018 f->flag_iscomplete = 0;
1020 return (1); /* failure */
1024 ugen_fs_set_complete(struct usb_fifo *f, uint8_t index)
1028 USB_IF_DEQUEUE(&f->free_q, m);
1031 /* can happen during close */
1032 DPRINTF("out of buffers\n");
1037 *((uint8_t *)(m->cur_data_ptr)) = index;
1039 USB_IF_ENQUEUE(&f->used_q, m);
1041 f->flag_iscomplete = 1;
1047 ugen_fs_copy_in(struct usb_fifo *f, uint8_t ep_index)
1049 struct usb_device_request *req;
1050 struct usb_xfer *xfer;
1051 struct usb_fs_endpoint fs_ep;
1052 void *uaddr; /* userland pointer */
1054 usb_frlength_t offset;
1061 if (ep_index >= f->fs_ep_max) {
1064 xfer = f->fs_xfer[ep_index];
1068 mtx_lock(f->priv_mtx);
1069 if (usbd_transfer_pending(xfer)) {
1070 mtx_unlock(f->priv_mtx);
1071 return (EBUSY); /* should not happen */
1073 mtx_unlock(f->priv_mtx);
1075 error = copyin(f->fs_ep_ptr +
1076 ep_index, &fs_ep, sizeof(fs_ep));
1080 /* security checks */
1082 if (fs_ep.nFrames > xfer->max_frame_count) {
1083 xfer->error = USB_ERR_INVAL;
1086 if (fs_ep.nFrames == 0) {
1087 xfer->error = USB_ERR_INVAL;
1090 error = copyin(fs_ep.ppBuffer,
1091 &uaddr, sizeof(uaddr));
1095 /* reset first frame */
1096 usbd_xfer_set_frame_offset(xfer, 0, 0);
1098 if (xfer->flags_int.control_xfr) {
1100 req = xfer->frbuffers[0].buffer;
1102 error = copyin(fs_ep.pLength,
1103 &length, sizeof(length));
1107 if (length != sizeof(*req)) {
1108 xfer->error = USB_ERR_INVAL;
1112 error = copyin(uaddr, req, length);
1117 if (ugen_check_request(f->udev, req)) {
1118 xfer->error = USB_ERR_INVAL;
1121 usbd_xfer_set_frame_len(xfer, 0, length);
1123 /* Host mode only ! */
1124 if ((req->bmRequestType &
1125 (UT_READ | UT_WRITE)) == UT_READ) {
1131 offset = sizeof(*req);
1134 /* Device and Host mode */
1135 if (USB_GET_DATA_ISREAD(xfer)) {
1144 rem = usbd_xfer_max_len(xfer);
1145 xfer->nframes = fs_ep.nFrames;
1146 xfer->timeout = fs_ep.timeout;
1147 if (xfer->timeout > 65535) {
1148 xfer->timeout = 65535;
1150 if (fs_ep.flags & USB_FS_FLAG_SINGLE_SHORT_OK)
1151 xfer->flags.short_xfer_ok = 1;
1153 xfer->flags.short_xfer_ok = 0;
1155 if (fs_ep.flags & USB_FS_FLAG_MULTI_SHORT_OK)
1156 xfer->flags.short_frames_ok = 1;
1158 xfer->flags.short_frames_ok = 0;
1160 if (fs_ep.flags & USB_FS_FLAG_FORCE_SHORT)
1161 xfer->flags.force_short_xfer = 1;
1163 xfer->flags.force_short_xfer = 0;
1165 if (fs_ep.flags & USB_FS_FLAG_CLEAR_STALL)
1166 usbd_xfer_set_stall(xfer);
1168 xfer->flags.stall_pipe = 0;
1170 for (; n != xfer->nframes; n++) {
1172 error = copyin(fs_ep.pLength + n,
1173 &length, sizeof(length));
1177 usbd_xfer_set_frame_len(xfer, n, length);
1180 xfer->error = USB_ERR_INVAL;
1187 /* we need to know the source buffer */
1188 error = copyin(fs_ep.ppBuffer + n,
1189 &uaddr, sizeof(uaddr));
1193 if (xfer->flags_int.isochronous_xfr) {
1194 /* get kernel buffer address */
1195 kaddr = xfer->frbuffers[0].buffer;
1196 kaddr = USB_ADD_BYTES(kaddr, offset);
1198 /* set current frame offset */
1199 usbd_xfer_set_frame_offset(xfer, offset, n);
1201 /* get kernel buffer address */
1202 kaddr = xfer->frbuffers[n].buffer;
1206 error = copyin(uaddr, kaddr, length);
1216 mtx_lock(f->priv_mtx);
1217 ugen_fs_set_complete(f, ep_index);
1218 mtx_unlock(f->priv_mtx);
1223 ugen_fs_copy_out_cancelled(struct usb_fs_endpoint *fs_ep_uptr)
1225 struct usb_fs_endpoint fs_ep;
1228 error = copyin(fs_ep_uptr, &fs_ep, sizeof(fs_ep));
1232 fs_ep.status = USB_ERR_CANCELLED;
1234 fs_ep.isoc_time_complete = 0;
1236 /* update "aFrames" */
1237 error = copyout(&fs_ep.aFrames, &fs_ep_uptr->aFrames,
1238 sizeof(fs_ep.aFrames));
1242 /* update "isoc_time_complete" */
1243 error = copyout(&fs_ep.isoc_time_complete,
1244 &fs_ep_uptr->isoc_time_complete,
1245 sizeof(fs_ep.isoc_time_complete));
1249 /* update "status" */
1250 error = copyout(&fs_ep.status, &fs_ep_uptr->status,
1251 sizeof(fs_ep.status));
1257 ugen_fs_copy_out(struct usb_fifo *f, uint8_t ep_index)
1259 struct usb_device_request *req;
1260 struct usb_xfer *xfer;
1261 struct usb_fs_endpoint fs_ep;
1262 struct usb_fs_endpoint *fs_ep_uptr; /* userland ptr */
1263 void *uaddr; /* userland ptr */
1265 usb_frlength_t offset;
1273 if (ep_index >= f->fs_ep_max)
1276 xfer = f->fs_xfer[ep_index];
1280 mtx_lock(f->priv_mtx);
1281 if (!xfer->flags_int.transferring &&
1282 !xfer->flags_int.started) {
1283 mtx_unlock(f->priv_mtx);
1284 DPRINTF("Returning fake cancel event\n");
1285 return (ugen_fs_copy_out_cancelled(f->fs_ep_ptr + ep_index));
1286 } else if (usbd_transfer_pending(xfer)) {
1287 mtx_unlock(f->priv_mtx);
1288 return (EBUSY); /* should not happen */
1290 mtx_unlock(f->priv_mtx);
1292 fs_ep_uptr = f->fs_ep_ptr + ep_index;
1293 error = copyin(fs_ep_uptr, &fs_ep, sizeof(fs_ep));
1297 fs_ep.status = xfer->error;
1298 fs_ep.aFrames = xfer->aframes;
1299 fs_ep.isoc_time_complete = xfer->isoc_time_complete;
1303 if (xfer->flags_int.control_xfr) {
1304 req = xfer->frbuffers[0].buffer;
1306 /* Host mode only ! */
1307 if ((req->bmRequestType & (UT_READ | UT_WRITE)) == UT_READ) {
1312 if (xfer->nframes == 0)
1313 n = 0; /* should never happen */
1317 /* Device and Host mode */
1318 if (USB_GET_DATA_ISREAD(xfer)) {
1326 /* Update lengths and copy out data */
1328 rem = usbd_xfer_max_len(xfer);
1331 for (; n != xfer->nframes; n++) {
1333 /* get initial length into "temp" */
1334 error = copyin(fs_ep.pLength + n,
1335 &temp, sizeof(temp));
1340 /* the userland length has been corrupted */
1341 DPRINTF("corrupt userland length "
1342 "%u > %u\n", temp, rem);
1343 fs_ep.status = USB_ERR_INVAL;
1348 /* get actual transfer length */
1349 length = xfer->frlengths[n];
1350 if (length > temp) {
1352 fs_ep.status = USB_ERR_INVAL;
1353 DPRINTF("data overflow %u > %u\n",
1359 /* we need to know the destination buffer */
1360 error = copyin(fs_ep.ppBuffer + n,
1361 &uaddr, sizeof(uaddr));
1365 if (xfer->flags_int.isochronous_xfr) {
1366 /* only one frame buffer */
1367 kaddr = USB_ADD_BYTES(
1368 xfer->frbuffers[0].buffer, offset);
1370 /* multiple frame buffers */
1371 kaddr = xfer->frbuffers[n].buffer;
1375 error = copyout(kaddr, uaddr, length);
1381 * Update offset according to initial length, which is
1382 * needed by isochronous transfers!
1387 error = copyout(&length,
1388 fs_ep.pLength + n, sizeof(length));
1395 /* update "aFrames" */
1396 error = copyout(&fs_ep.aFrames, &fs_ep_uptr->aFrames,
1397 sizeof(fs_ep.aFrames));
1401 /* update "isoc_time_complete" */
1402 error = copyout(&fs_ep.isoc_time_complete,
1403 &fs_ep_uptr->isoc_time_complete,
1404 sizeof(fs_ep.isoc_time_complete));
1408 /* update "status" */
1409 error = copyout(&fs_ep.status, &fs_ep_uptr->status,
1410 sizeof(fs_ep.status));
1416 ugen_fifo_in_use(struct usb_fifo *f, int fflags)
1418 struct usb_fifo *f_rx;
1419 struct usb_fifo *f_tx;
1421 f_rx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_RX];
1422 f_tx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_TX];
1424 if ((fflags & FREAD) && f_rx &&
1425 (f_rx->xfer[0] || f_rx->xfer[1])) {
1426 return (1); /* RX FIFO in use */
1428 if ((fflags & FWRITE) && f_tx &&
1429 (f_tx->xfer[0] || f_tx->xfer[1])) {
1430 return (1); /* TX FIFO in use */
1432 return (0); /* not in use */
1436 ugen_ioctl(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
1438 struct usb_config usb_config[1];
1439 struct usb_device_request req;
1441 struct usb_fs_complete *pcomp;
1442 struct usb_fs_start *pstart;
1443 struct usb_fs_stop *pstop;
1444 struct usb_fs_open *popen;
1445 struct usb_fs_open_stream *popen_stream;
1446 struct usb_fs_close *pclose;
1447 struct usb_fs_clear_stall_sync *pstall;
1450 struct usb_endpoint *ep;
1451 struct usb_endpoint_descriptor *ed;
1452 struct usb_xfer *xfer;
1454 uint8_t iface_index;
1461 DPRINTFN(6, "cmd=0x%08lx\n", cmd);
1464 case USB_FS_COMPLETE:
1465 mtx_lock(f->priv_mtx);
1466 error = ugen_fs_get_complete(f, &ep_index);
1467 mtx_unlock(f->priv_mtx);
1473 u.pcomp->ep_index = ep_index;
1474 error = ugen_fs_copy_out(f, u.pcomp->ep_index);
1478 error = ugen_fs_copy_in(f, u.pstart->ep_index);
1481 mtx_lock(f->priv_mtx);
1482 xfer = f->fs_xfer[u.pstart->ep_index];
1483 usbd_transfer_start(xfer);
1484 mtx_unlock(f->priv_mtx);
1488 if (u.pstop->ep_index >= f->fs_ep_max) {
1492 mtx_lock(f->priv_mtx);
1493 xfer = f->fs_xfer[u.pstart->ep_index];
1494 if (usbd_transfer_pending(xfer)) {
1495 usbd_transfer_stop(xfer);
1498 * Check if the USB transfer was stopped
1499 * before it was even started and fake a
1502 if (!xfer->flags_int.transferring &&
1503 !xfer->flags_int.started) {
1504 DPRINTF("Issuing fake completion event\n");
1505 ugen_fs_set_complete(xfer->priv_sc,
1506 USB_P2U(xfer->priv_fifo));
1509 mtx_unlock(f->priv_mtx);
1513 case USB_FS_OPEN_STREAM:
1514 if (u.popen->ep_index >= f->fs_ep_max) {
1518 if (f->fs_xfer[u.popen->ep_index] != NULL) {
1522 if (u.popen->max_bufsize > USB_FS_MAX_BUFSIZE) {
1523 u.popen->max_bufsize = USB_FS_MAX_BUFSIZE;
1525 if (u.popen->max_frames & USB_FS_MAX_FRAMES_PRE_SCALE) {
1527 u.popen->max_frames &= ~USB_FS_MAX_FRAMES_PRE_SCALE;
1531 if (u.popen->max_frames > USB_FS_MAX_FRAMES) {
1532 u.popen->max_frames = USB_FS_MAX_FRAMES;
1535 if (u.popen->max_frames == 0) {
1539 ep = usbd_get_ep_by_addr(f->udev, u.popen->ep_no);
1549 iface_index = ep->iface_index;
1551 memset(usb_config, 0, sizeof(usb_config));
1553 usb_config[0].type = ed->bmAttributes & UE_XFERTYPE;
1554 usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR;
1555 usb_config[0].direction = ed->bEndpointAddress & (UE_DIR_OUT | UE_DIR_IN);
1556 usb_config[0].interval = USB_DEFAULT_INTERVAL;
1557 usb_config[0].flags.proxy_buffer = 1;
1559 usb_config[0].flags.pre_scale_frames = 1;
1560 usb_config[0].callback = &ugen_ctrl_fs_callback;
1561 usb_config[0].timeout = 0; /* no timeout */
1562 usb_config[0].frames = u.popen->max_frames;
1563 usb_config[0].bufsize = u.popen->max_bufsize;
1564 usb_config[0].usb_mode = USB_MODE_DUAL; /* both modes */
1565 if (cmd == USB_FS_OPEN_STREAM)
1566 usb_config[0].stream_id = u.popen_stream->stream_id;
1568 if (usb_config[0].type == UE_CONTROL) {
1569 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1575 isread = ((usb_config[0].endpoint &
1576 (UE_DIR_IN | UE_DIR_OUT)) == UE_DIR_IN);
1578 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1581 /* check permissions */
1583 if (!(fflags & FREAD)) {
1588 if (!(fflags & FWRITE)) {
1594 error = usbd_transfer_setup(f->udev, &iface_index,
1595 f->fs_xfer + u.popen->ep_index, usb_config, 1,
1598 /* update maximums */
1599 u.popen->max_packet_length =
1600 f->fs_xfer[u.popen->ep_index]->max_frame_size;
1601 u.popen->max_bufsize =
1602 f->fs_xfer[u.popen->ep_index]->max_data_length;
1603 /* update number of frames */
1604 u.popen->max_frames =
1605 f->fs_xfer[u.popen->ep_index]->nframes;
1606 /* store index of endpoint */
1607 f->fs_xfer[u.popen->ep_index]->priv_fifo =
1608 ((uint8_t *)0) + u.popen->ep_index;
1615 if (u.pclose->ep_index >= f->fs_ep_max) {
1619 if (f->fs_xfer[u.pclose->ep_index] == NULL) {
1623 usbd_transfer_unsetup(f->fs_xfer + u.pclose->ep_index, 1);
1626 case USB_FS_CLEAR_STALL_SYNC:
1627 if (u.pstall->ep_index >= f->fs_ep_max) {
1631 if (f->fs_xfer[u.pstall->ep_index] == NULL) {
1635 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1639 mtx_lock(f->priv_mtx);
1640 error = usbd_transfer_pending(f->fs_xfer[u.pstall->ep_index]);
1641 mtx_unlock(f->priv_mtx);
1646 ep = f->fs_xfer[u.pstall->ep_index]->endpoint;
1648 /* setup a clear-stall packet */
1649 req.bmRequestType = UT_WRITE_ENDPOINT;
1650 req.bRequest = UR_CLEAR_FEATURE;
1651 USETW(req.wValue, UF_ENDPOINT_HALT);
1652 req.wIndex[0] = ep->edesc->bEndpointAddress;
1654 USETW(req.wLength, 0);
1656 error = usbd_do_request(f->udev, NULL, &req, NULL);
1658 usbd_clear_data_toggle(f->udev, ep);
1669 DPRINTFN(6, "error=%d\n", error);
1675 ugen_set_short_xfer(struct usb_fifo *f, void *addr)
1684 if (f->flag_short == t) {
1685 /* same value like before - accept */
1688 if (f->xfer[0] || f->xfer[1]) {
1689 /* cannot change this during transfer */
1697 ugen_set_timeout(struct usb_fifo *f, void *addr)
1699 f->timeout = *(int *)addr;
1700 if (f->timeout > 65535) {
1701 /* limit user input */
1708 ugen_get_frame_size(struct usb_fifo *f, void *addr)
1711 *(int *)addr = f->xfer[0]->max_frame_size;
1719 ugen_set_buffer_size(struct usb_fifo *f, void *addr)
1723 if (*(int *)addr < 0)
1724 t = 0; /* use "wMaxPacketSize" */
1725 else if (*(int *)addr < (256 * 1024))
1730 if (f->bufsize == t) {
1731 /* same value like before - accept */
1734 if (f->xfer[0] || f->xfer[1]) {
1735 /* cannot change this during transfer */
1743 ugen_get_buffer_size(struct usb_fifo *f, void *addr)
1745 *(int *)addr = f->bufsize;
1750 ugen_get_iface_desc(struct usb_fifo *f,
1751 struct usb_interface_descriptor *idesc)
1753 struct usb_interface *iface;
1755 iface = usbd_get_iface(f->udev, f->iface_index);
1756 if (iface && iface->idesc) {
1757 *idesc = *(iface->idesc);
1765 ugen_get_endpoint_desc(struct usb_fifo *f,
1766 struct usb_endpoint_descriptor *ed)
1768 struct usb_endpoint *ep;
1770 ep = usb_fifo_softc(f);
1772 if (ep && ep->edesc) {
1781 ugen_set_power_mode(struct usb_fifo *f, int mode)
1783 struct usb_device *udev = f->udev;
1787 if ((udev == NULL) ||
1788 (udev->parent_hub == NULL)) {
1791 err = priv_check(curthread, PRIV_DRIVER);
1795 /* get old power mode */
1796 old_mode = udev->power_mode;
1798 /* if no change, then just return */
1799 if (old_mode == mode)
1803 case USB_POWER_MODE_OFF:
1804 if (udev->flags.usb_mode == USB_MODE_HOST &&
1805 udev->re_enumerate_wait == USB_RE_ENUM_DONE) {
1806 udev->re_enumerate_wait = USB_RE_ENUM_PWR_OFF;
1808 /* set power mode will wake up the explore thread */
1811 case USB_POWER_MODE_ON:
1812 case USB_POWER_MODE_SAVE:
1815 case USB_POWER_MODE_RESUME:
1817 /* let USB-powerd handle resume */
1818 USB_BUS_LOCK(udev->bus);
1819 udev->pwr_save.write_refs++;
1820 udev->pwr_save.last_xfer_time = ticks;
1821 USB_BUS_UNLOCK(udev->bus);
1823 /* set new power mode */
1824 usbd_set_power_mode(udev, USB_POWER_MODE_SAVE);
1826 /* wait for resume to complete */
1827 usb_pause_mtx(NULL, hz / 4);
1829 /* clear write reference */
1830 USB_BUS_LOCK(udev->bus);
1831 udev->pwr_save.write_refs--;
1832 USB_BUS_UNLOCK(udev->bus);
1834 mode = USB_POWER_MODE_SAVE;
1837 case USB_POWER_MODE_SUSPEND:
1839 /* let USB-powerd handle suspend */
1840 USB_BUS_LOCK(udev->bus);
1841 udev->pwr_save.last_xfer_time = ticks - (256 * hz);
1842 USB_BUS_UNLOCK(udev->bus);
1844 mode = USB_POWER_MODE_SAVE;
1852 return (ENXIO); /* I/O failure */
1854 /* if we are powered off we need to re-enumerate first */
1855 if (old_mode == USB_POWER_MODE_OFF) {
1856 if (udev->flags.usb_mode == USB_MODE_HOST &&
1857 udev->re_enumerate_wait == USB_RE_ENUM_DONE) {
1858 udev->re_enumerate_wait = USB_RE_ENUM_START;
1860 /* set power mode will wake up the explore thread */
1863 /* set new power mode */
1864 usbd_set_power_mode(udev, mode);
1866 return (0); /* success */
1870 ugen_get_power_mode(struct usb_fifo *f)
1872 struct usb_device *udev = f->udev;
1875 return (USB_POWER_MODE_ON);
1877 return (udev->power_mode);
1881 ugen_get_port_path(struct usb_fifo *f, struct usb_device_port_path *dpp)
1883 struct usb_device *udev = f->udev;
1884 struct usb_device *next;
1885 unsigned int nlevel = 0;
1890 dpp->udp_bus = device_get_unit(udev->bus->bdev);
1891 dpp->udp_index = udev->device_index;
1893 /* count port levels */
1895 while (next->parent_hub != NULL) {
1897 next = next->parent_hub;
1900 /* check if too many levels */
1901 if (nlevel > USB_DEVICE_PORT_PATH_MAX)
1904 /* store total level of ports */
1905 dpp->udp_port_level = nlevel;
1907 /* store port index array */
1909 while (next->parent_hub != NULL) {
1910 dpp->udp_port_no[--nlevel] = next->port_no;
1911 next = next->parent_hub;
1913 return (0); /* success */
1916 return (EINVAL); /* failure */
1920 ugen_get_power_usage(struct usb_fifo *f)
1922 struct usb_device *udev = f->udev;
1927 return (udev->power);
1931 ugen_do_port_feature(struct usb_fifo *f, uint8_t port_no,
1932 uint8_t set, uint16_t feature)
1934 struct usb_device *udev = f->udev;
1935 struct usb_hub *hub;
1938 err = priv_check(curthread, PRIV_DRIVER);
1945 if ((udev == NULL) ||
1946 (udev->hub == NULL)) {
1951 if (port_no > hub->nports) {
1955 err = usbd_req_set_port_feature(udev,
1956 NULL, port_no, feature);
1958 err = usbd_req_clear_port_feature(udev,
1959 NULL, port_no, feature);
1962 return (ENXIO); /* failure */
1964 return (0); /* success */
1968 ugen_iface_ioctl(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
1970 struct usb_fifo *f_rx;
1971 struct usb_fifo *f_tx;
1974 f_rx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_RX];
1975 f_tx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_TX];
1978 case USB_SET_RX_SHORT_XFER:
1979 if (fflags & FREAD) {
1980 error = ugen_set_short_xfer(f_rx, addr);
1986 case USB_SET_TX_FORCE_SHORT:
1987 if (fflags & FWRITE) {
1988 error = ugen_set_short_xfer(f_tx, addr);
1994 case USB_SET_RX_TIMEOUT:
1995 if (fflags & FREAD) {
1996 error = ugen_set_timeout(f_rx, addr);
2002 case USB_SET_TX_TIMEOUT:
2003 if (fflags & FWRITE) {
2004 error = ugen_set_timeout(f_tx, addr);
2010 case USB_GET_RX_FRAME_SIZE:
2011 if (fflags & FREAD) {
2012 error = ugen_get_frame_size(f_rx, addr);
2018 case USB_GET_TX_FRAME_SIZE:
2019 if (fflags & FWRITE) {
2020 error = ugen_get_frame_size(f_tx, addr);
2026 case USB_SET_RX_BUFFER_SIZE:
2027 if (fflags & FREAD) {
2028 error = ugen_set_buffer_size(f_rx, addr);
2034 case USB_SET_TX_BUFFER_SIZE:
2035 if (fflags & FWRITE) {
2036 error = ugen_set_buffer_size(f_tx, addr);
2042 case USB_GET_RX_BUFFER_SIZE:
2043 if (fflags & FREAD) {
2044 error = ugen_get_buffer_size(f_rx, addr);
2050 case USB_GET_TX_BUFFER_SIZE:
2051 if (fflags & FWRITE) {
2052 error = ugen_get_buffer_size(f_tx, addr);
2058 case USB_GET_RX_INTERFACE_DESC:
2059 if (fflags & FREAD) {
2060 error = ugen_get_iface_desc(f_rx, addr);
2066 case USB_GET_TX_INTERFACE_DESC:
2067 if (fflags & FWRITE) {
2068 error = ugen_get_iface_desc(f_tx, addr);
2074 case USB_GET_RX_ENDPOINT_DESC:
2075 if (fflags & FREAD) {
2076 error = ugen_get_endpoint_desc(f_rx, addr);
2082 case USB_GET_TX_ENDPOINT_DESC:
2083 if (fflags & FWRITE) {
2084 error = ugen_get_endpoint_desc(f_tx, addr);
2090 case USB_SET_RX_STALL_FLAG:
2091 if ((fflags & FREAD) && (*(int *)addr)) {
2092 f_rx->flag_stall = 1;
2096 case USB_SET_TX_STALL_FLAG:
2097 if ((fflags & FWRITE) && (*(int *)addr)) {
2098 f_tx->flag_stall = 1;
2110 ugen_ioctl_post(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
2113 struct usb_interface_descriptor *idesc;
2114 struct usb_alt_interface *ai;
2115 struct usb_device_descriptor *ddesc;
2116 struct usb_config_descriptor *cdesc;
2117 struct usb_device_stats *stat;
2118 struct usb_fs_init *pinit;
2119 struct usb_fs_uninit *puninit;
2120 struct usb_device_port_path *dpp;
2125 struct usb_device_descriptor *dtemp;
2126 struct usb_config_descriptor *ctemp;
2127 struct usb_interface *iface;
2133 DPRINTFN(6, "cmd=0x%08lx\n", cmd);
2137 usb_needs_explore_all();
2141 if (!(fflags & FWRITE)) {
2145 usb_debug = *(int *)addr;
2148 case USB_GET_CONFIG:
2149 *(int *)addr = f->udev->curr_config_index;
2152 case USB_SET_CONFIG:
2153 if (!(fflags & FWRITE)) {
2157 error = ugen_set_config(f, *(int *)addr);
2160 case USB_GET_ALTINTERFACE:
2161 iface = usbd_get_iface(f->udev,
2162 u.ai->uai_interface_index);
2163 if (iface && iface->idesc) {
2164 u.ai->uai_alt_index = iface->alt_index;
2170 case USB_SET_ALTINTERFACE:
2171 if (!(fflags & FWRITE)) {
2175 error = ugen_set_interface(f,
2176 u.ai->uai_interface_index, u.ai->uai_alt_index);
2179 case USB_GET_DEVICE_DESC:
2180 dtemp = usbd_get_device_descriptor(f->udev);
2188 case USB_GET_CONFIG_DESC:
2189 ctemp = usbd_get_config_descriptor(f->udev);
2197 case USB_GET_FULL_DESC:
2198 error = ugen_get_cdesc(f, addr);
2201 case USB_GET_STRING_DESC:
2202 error = ugen_get_sdesc(f, addr);
2205 case USB_GET_IFACE_DRIVER:
2206 error = ugen_get_iface_driver(f, addr);
2210 case USB_DO_REQUEST:
2211 if (!(fflags & FWRITE)) {
2215 error = ugen_do_request(f, addr);
2218 case USB_DEVICEINFO:
2219 case USB_GET_DEVICEINFO:
2220 error = usb_gen_fill_deviceinfo(f, addr);
2223 case USB_DEVICESTATS:
2224 for (n = 0; n != 4; n++) {
2226 u.stat->uds_requests_fail[n] =
2227 f->udev->stats_err.uds_requests[n];
2228 u.stat->uds_requests_ok[n] =
2229 f->udev->stats_ok.uds_requests[n];
2233 case USB_DEVICEENUMERATE:
2234 error = ugen_re_enumerate(f);
2237 case USB_GET_PLUGTIME:
2238 *u.ptime = f->udev->plugtime;
2241 case USB_CLAIM_INTERFACE:
2242 case USB_RELEASE_INTERFACE:
2246 case USB_IFACE_DRIVER_ACTIVE:
2250 iface = usbd_get_iface(f->udev, n);
2252 if (iface && iface->subdev)
2258 case USB_IFACE_DRIVER_DETACH:
2260 error = priv_check(curthread, PRIV_DRIVER);
2267 if (n == USB_IFACE_INDEX_ANY) {
2273 * Detach the currently attached driver.
2275 usb_detach_device(f->udev, n, 0);
2278 * Set parent to self, this should keep attach away
2279 * until the next set configuration event.
2281 usbd_set_parent_iface(f->udev, n, n);
2284 case USB_SET_POWER_MODE:
2285 error = ugen_set_power_mode(f, *u.pint);
2288 case USB_GET_POWER_MODE:
2289 *u.pint = ugen_get_power_mode(f);
2292 case USB_GET_DEV_PORT_PATH:
2293 error = ugen_get_port_path(f, u.dpp);
2296 case USB_GET_POWER_USAGE:
2297 *u.pint = ugen_get_power_usage(f);
2300 case USB_SET_PORT_ENABLE:
2301 error = ugen_do_port_feature(f,
2302 *u.pint, 1, UHF_PORT_ENABLE);
2305 case USB_SET_PORT_DISABLE:
2306 error = ugen_do_port_feature(f,
2307 *u.pint, 0, UHF_PORT_ENABLE);
2311 /* verify input parameters */
2312 if (u.pinit->pEndpoints == NULL) {
2316 if (u.pinit->ep_index_max > 127) {
2320 if (u.pinit->ep_index_max == 0) {
2324 if (f->fs_xfer != NULL) {
2328 if (f->dev_ep_index != 0) {
2332 if (ugen_fifo_in_use(f, fflags)) {
2336 error = usb_fifo_alloc_buffer(f, 1, u.pinit->ep_index_max);
2340 f->fs_xfer = malloc(sizeof(f->fs_xfer[0]) *
2341 u.pinit->ep_index_max, M_USB, M_WAITOK | M_ZERO);
2342 if (f->fs_xfer == NULL) {
2343 usb_fifo_free_buffer(f);
2347 f->fs_ep_max = u.pinit->ep_index_max;
2348 f->fs_ep_ptr = u.pinit->pEndpoints;
2352 if (u.puninit->dummy != 0) {
2356 error = ugen_fs_uninit(f);
2360 mtx_lock(f->priv_mtx);
2361 error = ugen_iface_ioctl(f, cmd, addr, fflags);
2362 mtx_unlock(f->priv_mtx);
2365 DPRINTFN(6, "error=%d\n", error);
2370 ugen_ctrl_fs_callback(struct usb_xfer *xfer, usb_error_t error)
2372 ; /* workaround for a bug in "indent" */
2374 DPRINTF("st=%u alen=%u aframes=%u\n",
2375 USB_GET_STATE(xfer), xfer->actlen, xfer->aframes);
2377 switch (USB_GET_STATE(xfer)) {
2379 usbd_transfer_submit(xfer);
2382 ugen_fs_set_complete(xfer->priv_sc, USB_P2U(xfer->priv_fifo));
2386 #endif /* USB_HAVE_UGEN */