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(6, "flag=0x%x\n", fflags);
188 mtx_lock(f->priv_mtx);
189 switch (usbd_get_speed(f->udev)) {
192 f->nframes = UGEN_HW_FRAMES;
193 f->bufsize = UGEN_BULK_FS_BUFFER_SIZE;
196 f->nframes = UGEN_HW_FRAMES * 8;
197 f->bufsize = UGEN_BULK_HS_BUFFER_SIZE;
201 type = ed->bmAttributes & UE_XFERTYPE;
202 if (type == UE_INTERRUPT) {
203 f->bufsize = 0; /* use "wMaxPacketSize" */
205 f->timeout = USB_NO_TIMEOUT;
208 mtx_unlock(f->priv_mtx);
214 ugen_close(struct usb_fifo *f, int fflags)
216 DPRINTFN(6, "flag=0x%x\n", fflags);
220 mtx_lock(f->priv_mtx);
221 usbd_transfer_stop(f->xfer[0]);
222 usbd_transfer_stop(f->xfer[1]);
223 mtx_unlock(f->priv_mtx);
225 usbd_transfer_unsetup(f->xfer, 2);
226 usb_fifo_free_buffer(f);
228 if (ugen_fs_uninit(f)) {
229 /* ignore any errors - we are closing */
230 DPRINTFN(6, "no FIFOs\n");
235 ugen_open_pipe_write(struct usb_fifo *f)
237 struct usb_config usb_config[2];
238 struct usb_endpoint *ep = usb_fifo_softc(f);
239 struct usb_endpoint_descriptor *ed = ep->edesc;
241 USB_MTX_ASSERT(f->priv_mtx, MA_OWNED);
243 if (f->xfer[0] || f->xfer[1]) {
244 /* transfers are already opened */
247 memset(usb_config, 0, sizeof(usb_config));
249 usb_config[1].type = UE_CONTROL;
250 usb_config[1].endpoint = 0;
251 usb_config[1].direction = UE_DIR_ANY;
252 usb_config[1].timeout = 1000; /* 1 second */
253 usb_config[1].interval = 50;/* 50 milliseconds */
254 usb_config[1].bufsize = sizeof(struct usb_device_request);
255 usb_config[1].callback = &ugen_write_clear_stall_callback;
256 usb_config[1].usb_mode = USB_MODE_HOST;
258 usb_config[0].type = ed->bmAttributes & UE_XFERTYPE;
259 usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR;
260 usb_config[0].stream_id = 0; /* XXX support more stream ID's */
261 usb_config[0].direction = UE_DIR_TX;
262 usb_config[0].interval = USB_DEFAULT_INTERVAL;
263 usb_config[0].flags.proxy_buffer = 1;
264 usb_config[0].usb_mode = USB_MODE_DUAL; /* both modes */
266 switch (ed->bmAttributes & UE_XFERTYPE) {
270 usb_config[0].flags.force_short_xfer = 1;
272 usb_config[0].callback = &ugen_ctrl_write_callback;
273 usb_config[0].timeout = f->timeout;
274 usb_config[0].frames = 1;
275 usb_config[0].bufsize = f->bufsize;
276 if (ugen_transfer_setup(f, usb_config, 2)) {
279 /* first transfer does not clear stall */
284 usb_config[0].flags.short_xfer_ok = 1;
285 usb_config[0].bufsize = 0; /* use default */
286 usb_config[0].frames = f->nframes;
287 usb_config[0].callback = &ugen_isoc_write_callback;
288 usb_config[0].timeout = 0;
290 /* clone configuration */
291 usb_config[1] = usb_config[0];
293 if (ugen_transfer_setup(f, usb_config, 2)) {
304 ugen_open_pipe_read(struct usb_fifo *f)
306 struct usb_config usb_config[2];
307 struct usb_endpoint *ep = usb_fifo_softc(f);
308 struct usb_endpoint_descriptor *ed = ep->edesc;
310 USB_MTX_ASSERT(f->priv_mtx, MA_OWNED);
312 if (f->xfer[0] || f->xfer[1]) {
313 /* transfers are already opened */
316 memset(usb_config, 0, sizeof(usb_config));
318 usb_config[1].type = UE_CONTROL;
319 usb_config[1].endpoint = 0;
320 usb_config[1].direction = UE_DIR_ANY;
321 usb_config[1].timeout = 1000; /* 1 second */
322 usb_config[1].interval = 50;/* 50 milliseconds */
323 usb_config[1].bufsize = sizeof(struct usb_device_request);
324 usb_config[1].callback = &ugen_read_clear_stall_callback;
325 usb_config[1].usb_mode = USB_MODE_HOST;
327 usb_config[0].type = ed->bmAttributes & UE_XFERTYPE;
328 usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR;
329 usb_config[0].stream_id = 0; /* XXX support more stream ID's */
330 usb_config[0].direction = UE_DIR_RX;
331 usb_config[0].interval = USB_DEFAULT_INTERVAL;
332 usb_config[0].flags.proxy_buffer = 1;
333 usb_config[0].usb_mode = USB_MODE_DUAL; /* both modes */
335 switch (ed->bmAttributes & UE_XFERTYPE) {
339 usb_config[0].flags.short_xfer_ok = 1;
341 usb_config[0].timeout = f->timeout;
342 usb_config[0].frames = 1;
343 usb_config[0].callback = &ugen_ctrl_read_callback;
344 usb_config[0].bufsize = f->bufsize;
346 if (ugen_transfer_setup(f, usb_config, 2)) {
349 /* first transfer does not clear stall */
354 usb_config[0].flags.short_xfer_ok = 1;
355 usb_config[0].bufsize = 0; /* use default */
356 usb_config[0].frames = f->nframes;
357 usb_config[0].callback = &ugen_isoc_read_callback;
358 usb_config[0].timeout = 0;
360 /* clone configuration */
361 usb_config[1] = usb_config[0];
363 if (ugen_transfer_setup(f, usb_config, 2)) {
375 ugen_start_read(struct usb_fifo *f)
377 /* check that pipes are open */
378 if (ugen_open_pipe_read(f)) {
380 usb_fifo_put_data_error(f);
382 /* start transfers */
383 usbd_transfer_start(f->xfer[0]);
384 usbd_transfer_start(f->xfer[1]);
388 ugen_start_write(struct usb_fifo *f)
390 /* check that pipes are open */
391 if (ugen_open_pipe_write(f)) {
393 usb_fifo_get_data_error(f);
395 /* start transfers */
396 usbd_transfer_start(f->xfer[0]);
397 usbd_transfer_start(f->xfer[1]);
401 ugen_stop_io(struct usb_fifo *f)
404 usbd_transfer_stop(f->xfer[0]);
405 usbd_transfer_stop(f->xfer[1]);
409 ugen_ctrl_read_callback(struct usb_xfer *xfer, usb_error_t error)
411 struct usb_fifo *f = usbd_xfer_softc(xfer);
414 DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
416 switch (USB_GET_STATE(xfer)) {
417 case USB_ST_TRANSFERRED:
418 if (xfer->actlen == 0) {
419 if (f->fifo_zlp != 4) {
423 * Throttle a little bit we have multiple ZLPs
426 xfer->interval = 64; /* ms */
433 usb_fifo_put_data(f, xfer->frbuffers, 0,
438 usbd_transfer_start(f->xfer[1]);
441 USB_IF_POLL(&f->free_q, m);
443 usbd_xfer_set_frame_len(xfer, 0, usbd_xfer_max_len(xfer));
444 usbd_transfer_submit(xfer);
449 if (xfer->error != USB_ERR_CANCELLED) {
450 /* send a zero length packet to userland */
451 usb_fifo_put_data(f, xfer->frbuffers, 0, 0, 1);
454 usbd_transfer_start(f->xfer[1]);
461 ugen_ctrl_write_callback(struct usb_xfer *xfer, usb_error_t error)
463 struct usb_fifo *f = usbd_xfer_softc(xfer);
464 usb_frlength_t actlen;
466 DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
468 switch (USB_GET_STATE(xfer)) {
470 case USB_ST_TRANSFERRED:
472 * If writing is in stall, just jump to clear stall
473 * callback and solve the situation.
476 usbd_transfer_start(f->xfer[1]);
480 * Write data, setup and perform hardware transfer.
482 if (usb_fifo_get_data(f, xfer->frbuffers, 0,
483 xfer->max_data_length, &actlen, 0)) {
484 usbd_xfer_set_frame_len(xfer, 0, actlen);
485 usbd_transfer_submit(xfer);
490 if (xfer->error != USB_ERR_CANCELLED) {
492 usbd_transfer_start(f->xfer[1]);
499 ugen_read_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error)
501 struct usb_fifo *f = usbd_xfer_softc(xfer);
502 struct usb_xfer *xfer_other = f->xfer[0];
504 if (f->flag_stall == 0) {
508 if (usbd_clear_stall_callback(xfer, xfer_other)) {
509 DPRINTFN(5, "f=%p: stall cleared\n", f);
511 usbd_transfer_start(xfer_other);
516 ugen_write_clear_stall_callback(struct usb_xfer *xfer, usb_error_t error)
518 struct usb_fifo *f = usbd_xfer_softc(xfer);
519 struct usb_xfer *xfer_other = f->xfer[0];
521 if (f->flag_stall == 0) {
525 if (usbd_clear_stall_callback(xfer, xfer_other)) {
526 DPRINTFN(5, "f=%p: stall cleared\n", f);
528 usbd_transfer_start(xfer_other);
533 ugen_isoc_read_callback(struct usb_xfer *xfer, usb_error_t error)
535 struct usb_fifo *f = usbd_xfer_softc(xfer);
536 usb_frlength_t offset;
539 DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
541 switch (USB_GET_STATE(xfer)) {
542 case USB_ST_TRANSFERRED:
544 DPRINTFN(6, "actlen=%d\n", xfer->actlen);
548 for (n = 0; n != xfer->aframes; n++) {
549 usb_fifo_put_data(f, xfer->frbuffers, offset,
550 xfer->frlengths[n], 1);
551 offset += xfer->max_frame_size;
556 for (n = 0; n != xfer->nframes; n++) {
557 /* setup size for next transfer */
558 usbd_xfer_set_frame_len(xfer, n, xfer->max_frame_size);
560 usbd_transfer_submit(xfer);
564 if (xfer->error == USB_ERR_CANCELLED) {
572 ugen_isoc_write_callback(struct usb_xfer *xfer, usb_error_t error)
574 struct usb_fifo *f = usbd_xfer_softc(xfer);
575 usb_frlength_t actlen;
576 usb_frlength_t offset;
579 DPRINTFN(4, "actlen=%u, aframes=%u\n", xfer->actlen, xfer->aframes);
581 switch (USB_GET_STATE(xfer)) {
582 case USB_ST_TRANSFERRED:
586 for (n = 0; n != xfer->nframes; n++) {
587 if (usb_fifo_get_data(f, xfer->frbuffers, offset,
588 xfer->max_frame_size, &actlen, 1)) {
589 usbd_xfer_set_frame_len(xfer, n, actlen);
596 for (; n != xfer->nframes; n++) {
597 /* fill in zero frames */
598 usbd_xfer_set_frame_len(xfer, n, 0);
600 usbd_transfer_submit(xfer);
604 if (xfer->error == USB_ERR_CANCELLED) {
612 ugen_set_config(struct usb_fifo *f, uint8_t index)
614 DPRINTFN(2, "index %u\n", index);
616 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
617 /* not possible in device side mode */
621 /* make sure all FIFO's are gone */
622 /* else there can be a deadlock */
623 if (ugen_fs_uninit(f)) {
624 /* ignore any errors */
625 DPRINTFN(6, "no FIFOs\n");
628 if (usbd_start_set_config(f->udev, index) != 0)
635 ugen_set_interface(struct usb_fifo *f,
636 uint8_t iface_index, uint8_t alt_index)
638 DPRINTFN(2, "%u, %u\n", iface_index, alt_index);
640 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
641 /* not possible in device side mode */
644 /* make sure all FIFO's are gone */
645 /* else there can be a deadlock */
646 if (ugen_fs_uninit(f)) {
647 /* ignore any errors */
648 DPRINTFN(6, "no FIFOs\n");
650 /* change setting - will free generic FIFOs, if any */
651 if (usbd_set_alt_interface_index(f->udev, iface_index, alt_index)) {
654 /* probe and attach */
655 if (usb_probe_and_attach(f->udev, iface_index)) {
661 /*------------------------------------------------------------------------*
664 * This function will retrieve the complete configuration descriptor
665 * at the given index.
666 *------------------------------------------------------------------------*/
668 ugen_get_cdesc(struct usb_fifo *f, struct usb_gen_descriptor *ugd)
670 struct usb_config_descriptor *cdesc;
671 struct usb_device *udev = f->udev;
678 if (ugd->ugd_data == NULL) {
679 /* userland pointer should not be zero */
682 if ((ugd->ugd_config_index == USB_UNCONFIG_INDEX) ||
683 (ugd->ugd_config_index == udev->curr_config_index)) {
684 cdesc = usbd_get_config_descriptor(udev);
690 #if (USB_HAVE_FIXED_CONFIG == 0)
691 if (usbd_req_get_config_desc_full(udev,
692 NULL, &cdesc, ugd->ugd_config_index)) {
697 /* configuration descriptor data is shared */
702 len = UGETW(cdesc->wTotalLength);
703 if (len > ugd->ugd_maxlen) {
704 len = ugd->ugd_maxlen;
706 DPRINTFN(6, "len=%u\n", len);
708 ugd->ugd_actlen = len;
711 error = copyout(cdesc, ugd->ugd_data, len);
714 usbd_free_config_desc(udev, cdesc);
720 ugen_get_sdesc(struct usb_fifo *f, struct usb_gen_descriptor *ugd)
727 /* Protect scratch area */
728 do_unlock = usbd_ctrl_lock(f->udev);
730 ptr = f->udev->scratch.data;
731 size = sizeof(f->udev->scratch.data);
733 if (usbd_req_get_string_desc(f->udev, NULL, ptr,
734 size, ugd->ugd_lang_id, ugd->ugd_string_index)) {
738 if (size > ((uint8_t *)ptr)[0]) {
739 size = ((uint8_t *)ptr)[0];
741 if (size > ugd->ugd_maxlen) {
742 size = ugd->ugd_maxlen;
744 ugd->ugd_actlen = size;
747 error = copyout(ptr, ugd->ugd_data, size);
750 usbd_ctrl_unlock(f->udev);
755 /*------------------------------------------------------------------------*
756 * ugen_get_iface_driver
758 * This function generates an USB interface description for userland.
763 *------------------------------------------------------------------------*/
765 ugen_get_iface_driver(struct usb_fifo *f, struct usb_gen_descriptor *ugd)
767 struct usb_device *udev = f->udev;
768 struct usb_interface *iface;
778 if ((ugd->ugd_data == NULL) || (ugd->ugd_maxlen == 0)) {
779 /* userland pointer should not be zero */
783 iface = usbd_get_iface(udev, ugd->ugd_iface_index);
784 if ((iface == NULL) || (iface->idesc == NULL)) {
785 /* invalid interface index */
789 /* read out device nameunit string, if any */
790 if ((iface->subdev != NULL) &&
791 device_is_attached(iface->subdev) &&
792 (ptr = device_get_nameunit(iface->subdev)) &&
793 (desc = device_get_desc(iface->subdev))) {
795 /* print description */
796 snprintf(buf, sizeof(buf), "%s: <%s>", ptr, desc);
799 maxlen = ugd->ugd_maxlen - 1;
804 /* update actual length, including terminating zero */
805 ugd->ugd_actlen = len + 1;
807 /* copy out interface description */
808 error = copyout(buf, ugd->ugd_data, ugd->ugd_actlen);
810 /* zero length string is default */
811 error = copyout("", ugd->ugd_data, 1);
816 /*------------------------------------------------------------------------*
817 * usb_gen_fill_deviceinfo
819 * This function dumps information about an USB device to the
820 * structure pointed to by the "di" argument.
825 *------------------------------------------------------------------------*/
827 usb_gen_fill_deviceinfo(struct usb_fifo *f, struct usb_device_info *di)
829 struct usb_device *udev;
830 struct usb_device *hub;
834 bzero(di, sizeof(di[0]));
836 di->udi_bus = device_get_unit(udev->bus->bdev);
837 di->udi_addr = udev->address;
838 di->udi_index = udev->device_index;
839 strlcpy(di->udi_serial, usb_get_serial(udev), sizeof(di->udi_serial));
840 strlcpy(di->udi_vendor, usb_get_manufacturer(udev), sizeof(di->udi_vendor));
841 strlcpy(di->udi_product, usb_get_product(udev), sizeof(di->udi_product));
842 usb_printbcd(di->udi_release, sizeof(di->udi_release),
843 UGETW(udev->ddesc.bcdDevice));
844 di->udi_vendorNo = UGETW(udev->ddesc.idVendor);
845 di->udi_productNo = UGETW(udev->ddesc.idProduct);
846 di->udi_releaseNo = UGETW(udev->ddesc.bcdDevice);
847 di->udi_class = udev->ddesc.bDeviceClass;
848 di->udi_subclass = udev->ddesc.bDeviceSubClass;
849 di->udi_protocol = udev->ddesc.bDeviceProtocol;
850 di->udi_config_no = udev->curr_config_no;
851 di->udi_config_index = udev->curr_config_index;
852 di->udi_power = udev->flags.self_powered ? 0 : udev->power;
853 di->udi_speed = udev->speed;
854 di->udi_mode = udev->flags.usb_mode;
855 di->udi_power_mode = udev->power_mode;
856 di->udi_suspended = udev->flags.peer_suspended;
858 hub = udev->parent_hub;
860 di->udi_hubaddr = hub->address;
861 di->udi_hubindex = hub->device_index;
862 di->udi_hubport = udev->port_no;
867 /*------------------------------------------------------------------------*
873 *------------------------------------------------------------------------*/
875 ugen_check_request(struct usb_device *udev, struct usb_device_request *req)
877 struct usb_endpoint *ep;
881 * Avoid requests that would damage the bus integrity:
883 if (((req->bmRequestType == UT_WRITE_DEVICE) &&
884 (req->bRequest == UR_SET_ADDRESS)) ||
885 ((req->bmRequestType == UT_WRITE_DEVICE) &&
886 (req->bRequest == UR_SET_CONFIG)) ||
887 ((req->bmRequestType == UT_WRITE_INTERFACE) &&
888 (req->bRequest == UR_SET_INTERFACE))) {
890 * These requests can be useful for testing USB drivers.
892 error = priv_check(curthread, PRIV_DRIVER);
898 * Special case - handle clearing of stall
900 if (req->bmRequestType == UT_WRITE_ENDPOINT) {
902 ep = usbd_get_ep_by_addr(udev, req->wIndex[0]);
906 if ((req->bRequest == UR_CLEAR_FEATURE) &&
907 (UGETW(req->wValue) == UF_ENDPOINT_HALT)) {
908 usbd_clear_data_toggle(udev, ep);
911 /* TODO: add more checks to verify the interface index */
917 ugen_do_request(struct usb_fifo *f, struct usb_ctl_request *ur)
923 if (ugen_check_request(f->udev, &ur->ucr_request)) {
926 len = UGETW(ur->ucr_request.wLength);
928 /* check if "ucr_data" is valid */
930 if (ur->ucr_data == NULL) {
934 /* do the USB request */
935 error = usbd_do_request_flags
936 (f->udev, NULL, &ur->ucr_request, ur->ucr_data,
937 (ur->ucr_flags & USB_SHORT_XFER_OK) |
938 USB_USER_DATA_PTR, &actlen,
939 USB_DEFAULT_TIMEOUT);
941 ur->ucr_actlen = actlen;
949 /*------------------------------------------------------------------------
951 *------------------------------------------------------------------------*/
953 ugen_re_enumerate(struct usb_fifo *f)
955 struct usb_device *udev = f->udev;
959 * This request can be useful for testing USB drivers:
961 error = priv_check(curthread, PRIV_DRIVER);
965 if (udev->flags.usb_mode != USB_MODE_HOST) {
966 /* not possible in device side mode */
967 DPRINTFN(6, "device mode\n");
970 /* make sure all FIFO's are gone */
971 /* else there can be a deadlock */
972 if (ugen_fs_uninit(f)) {
973 /* ignore any errors */
974 DPRINTFN(6, "no FIFOs\n");
976 /* start re-enumeration of device */
977 usbd_start_re_enumerate(udev);
982 ugen_fs_uninit(struct usb_fifo *f)
984 if (f->fs_xfer == NULL) {
987 usbd_transfer_unsetup(f->fs_xfer, f->fs_ep_max);
988 free(f->fs_xfer, M_USB);
992 f->flag_iscomplete = 0;
993 usb_fifo_free_buffer(f);
998 ugen_fs_get_complete(struct usb_fifo *f, uint8_t *pindex)
1002 USB_IF_DEQUEUE(&f->used_q, m);
1005 *pindex = *((uint8_t *)(m->cur_data_ptr));
1007 USB_IF_ENQUEUE(&f->free_q, m);
1009 return (0); /* success */
1012 *pindex = 0; /* fix compiler warning */
1014 f->flag_iscomplete = 0;
1016 return (1); /* failure */
1020 ugen_fs_set_complete(struct usb_fifo *f, uint8_t index)
1024 USB_IF_DEQUEUE(&f->free_q, m);
1027 /* can happen during close */
1028 DPRINTF("out of buffers\n");
1033 *((uint8_t *)(m->cur_data_ptr)) = index;
1035 USB_IF_ENQUEUE(&f->used_q, m);
1037 f->flag_iscomplete = 1;
1043 ugen_fs_copy_in(struct usb_fifo *f, uint8_t ep_index)
1045 struct usb_device_request *req;
1046 struct usb_xfer *xfer;
1047 struct usb_fs_endpoint fs_ep;
1048 void *uaddr; /* userland pointer */
1050 usb_frlength_t offset;
1057 if (ep_index >= f->fs_ep_max) {
1060 xfer = f->fs_xfer[ep_index];
1064 mtx_lock(f->priv_mtx);
1065 if (usbd_transfer_pending(xfer)) {
1066 mtx_unlock(f->priv_mtx);
1067 return (EBUSY); /* should not happen */
1069 mtx_unlock(f->priv_mtx);
1071 error = copyin(f->fs_ep_ptr +
1072 ep_index, &fs_ep, sizeof(fs_ep));
1076 /* security checks */
1078 if (fs_ep.nFrames > xfer->max_frame_count) {
1079 xfer->error = USB_ERR_INVAL;
1082 if (fs_ep.nFrames == 0) {
1083 xfer->error = USB_ERR_INVAL;
1086 error = copyin(fs_ep.ppBuffer,
1087 &uaddr, sizeof(uaddr));
1091 /* reset first frame */
1092 usbd_xfer_set_frame_offset(xfer, 0, 0);
1094 if (xfer->flags_int.control_xfr) {
1096 req = xfer->frbuffers[0].buffer;
1098 error = copyin(fs_ep.pLength,
1099 &length, sizeof(length));
1103 if (length != sizeof(*req)) {
1104 xfer->error = USB_ERR_INVAL;
1108 error = copyin(uaddr, req, length);
1113 if (ugen_check_request(f->udev, req)) {
1114 xfer->error = USB_ERR_INVAL;
1117 usbd_xfer_set_frame_len(xfer, 0, length);
1119 /* Host mode only ! */
1120 if ((req->bmRequestType &
1121 (UT_READ | UT_WRITE)) == UT_READ) {
1127 offset = sizeof(*req);
1130 /* Device and Host mode */
1131 if (USB_GET_DATA_ISREAD(xfer)) {
1140 rem = usbd_xfer_max_len(xfer);
1141 xfer->nframes = fs_ep.nFrames;
1142 xfer->timeout = fs_ep.timeout;
1143 if (xfer->timeout > 65535) {
1144 xfer->timeout = 65535;
1146 if (fs_ep.flags & USB_FS_FLAG_SINGLE_SHORT_OK)
1147 xfer->flags.short_xfer_ok = 1;
1149 xfer->flags.short_xfer_ok = 0;
1151 if (fs_ep.flags & USB_FS_FLAG_MULTI_SHORT_OK)
1152 xfer->flags.short_frames_ok = 1;
1154 xfer->flags.short_frames_ok = 0;
1156 if (fs_ep.flags & USB_FS_FLAG_FORCE_SHORT)
1157 xfer->flags.force_short_xfer = 1;
1159 xfer->flags.force_short_xfer = 0;
1161 if (fs_ep.flags & USB_FS_FLAG_CLEAR_STALL)
1162 usbd_xfer_set_stall(xfer);
1164 xfer->flags.stall_pipe = 0;
1166 for (; n != xfer->nframes; n++) {
1168 error = copyin(fs_ep.pLength + n,
1169 &length, sizeof(length));
1173 usbd_xfer_set_frame_len(xfer, n, length);
1176 xfer->error = USB_ERR_INVAL;
1183 /* we need to know the source buffer */
1184 error = copyin(fs_ep.ppBuffer + n,
1185 &uaddr, sizeof(uaddr));
1189 if (xfer->flags_int.isochronous_xfr) {
1190 /* get kernel buffer address */
1191 kaddr = xfer->frbuffers[0].buffer;
1192 kaddr = USB_ADD_BYTES(kaddr, offset);
1194 /* set current frame offset */
1195 usbd_xfer_set_frame_offset(xfer, offset, n);
1197 /* get kernel buffer address */
1198 kaddr = xfer->frbuffers[n].buffer;
1202 error = copyin(uaddr, kaddr, length);
1212 mtx_lock(f->priv_mtx);
1213 ugen_fs_set_complete(f, ep_index);
1214 mtx_unlock(f->priv_mtx);
1219 ugen_fs_copy_out(struct usb_fifo *f, uint8_t ep_index)
1221 struct usb_device_request *req;
1222 struct usb_xfer *xfer;
1223 struct usb_fs_endpoint fs_ep;
1224 struct usb_fs_endpoint *fs_ep_uptr; /* userland ptr */
1225 void *uaddr; /* userland ptr */
1227 usb_frlength_t offset;
1235 if (ep_index >= f->fs_ep_max)
1238 xfer = f->fs_xfer[ep_index];
1242 mtx_lock(f->priv_mtx);
1243 if (usbd_transfer_pending(xfer)) {
1244 mtx_unlock(f->priv_mtx);
1245 return (EBUSY); /* should not happen */
1247 mtx_unlock(f->priv_mtx);
1249 fs_ep_uptr = f->fs_ep_ptr + ep_index;
1250 error = copyin(fs_ep_uptr, &fs_ep, sizeof(fs_ep));
1254 fs_ep.status = xfer->error;
1255 fs_ep.aFrames = xfer->aframes;
1256 fs_ep.isoc_time_complete = xfer->isoc_time_complete;
1260 if (xfer->flags_int.control_xfr) {
1261 req = xfer->frbuffers[0].buffer;
1263 /* Host mode only ! */
1264 if ((req->bmRequestType & (UT_READ | UT_WRITE)) == UT_READ) {
1269 if (xfer->nframes == 0)
1270 n = 0; /* should never happen */
1274 /* Device and Host mode */
1275 if (USB_GET_DATA_ISREAD(xfer)) {
1283 /* Update lengths and copy out data */
1285 rem = usbd_xfer_max_len(xfer);
1288 for (; n != xfer->nframes; n++) {
1290 /* get initial length into "temp" */
1291 error = copyin(fs_ep.pLength + n,
1292 &temp, sizeof(temp));
1297 /* the userland length has been corrupted */
1298 DPRINTF("corrupt userland length "
1299 "%u > %u\n", temp, rem);
1300 fs_ep.status = USB_ERR_INVAL;
1305 /* get actual transfer length */
1306 length = xfer->frlengths[n];
1307 if (length > temp) {
1309 fs_ep.status = USB_ERR_INVAL;
1310 DPRINTF("data overflow %u > %u\n",
1316 /* we need to know the destination buffer */
1317 error = copyin(fs_ep.ppBuffer + n,
1318 &uaddr, sizeof(uaddr));
1322 if (xfer->flags_int.isochronous_xfr) {
1323 /* only one frame buffer */
1324 kaddr = USB_ADD_BYTES(
1325 xfer->frbuffers[0].buffer, offset);
1327 /* multiple frame buffers */
1328 kaddr = xfer->frbuffers[n].buffer;
1332 error = copyout(kaddr, uaddr, length);
1338 * Update offset according to initial length, which is
1339 * needed by isochronous transfers!
1344 error = copyout(&length,
1345 fs_ep.pLength + n, sizeof(length));
1352 /* update "aFrames" */
1353 error = copyout(&fs_ep.aFrames, &fs_ep_uptr->aFrames,
1354 sizeof(fs_ep.aFrames));
1358 /* update "isoc_time_complete" */
1359 error = copyout(&fs_ep.isoc_time_complete,
1360 &fs_ep_uptr->isoc_time_complete,
1361 sizeof(fs_ep.isoc_time_complete));
1364 /* update "status" */
1365 error = copyout(&fs_ep.status, &fs_ep_uptr->status,
1366 sizeof(fs_ep.status));
1372 ugen_fifo_in_use(struct usb_fifo *f, int fflags)
1374 struct usb_fifo *f_rx;
1375 struct usb_fifo *f_tx;
1377 f_rx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_RX];
1378 f_tx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_TX];
1380 if ((fflags & FREAD) && f_rx &&
1381 (f_rx->xfer[0] || f_rx->xfer[1])) {
1382 return (1); /* RX FIFO in use */
1384 if ((fflags & FWRITE) && f_tx &&
1385 (f_tx->xfer[0] || f_tx->xfer[1])) {
1386 return (1); /* TX FIFO in use */
1388 return (0); /* not in use */
1392 ugen_ioctl(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
1394 struct usb_config usb_config[1];
1395 struct usb_device_request req;
1397 struct usb_fs_complete *pcomp;
1398 struct usb_fs_start *pstart;
1399 struct usb_fs_stop *pstop;
1400 struct usb_fs_open *popen;
1401 struct usb_fs_open_stream *popen_stream;
1402 struct usb_fs_close *pclose;
1403 struct usb_fs_clear_stall_sync *pstall;
1406 struct usb_endpoint *ep;
1407 struct usb_endpoint_descriptor *ed;
1408 struct usb_xfer *xfer;
1410 uint8_t iface_index;
1417 DPRINTFN(6, "cmd=0x%08lx\n", cmd);
1420 case USB_FS_COMPLETE:
1421 mtx_lock(f->priv_mtx);
1422 error = ugen_fs_get_complete(f, &ep_index);
1423 mtx_unlock(f->priv_mtx);
1429 u.pcomp->ep_index = ep_index;
1430 error = ugen_fs_copy_out(f, u.pcomp->ep_index);
1434 error = ugen_fs_copy_in(f, u.pstart->ep_index);
1437 mtx_lock(f->priv_mtx);
1438 xfer = f->fs_xfer[u.pstart->ep_index];
1439 usbd_transfer_start(xfer);
1440 mtx_unlock(f->priv_mtx);
1444 if (u.pstop->ep_index >= f->fs_ep_max) {
1448 mtx_lock(f->priv_mtx);
1449 xfer = f->fs_xfer[u.pstart->ep_index];
1450 if (usbd_transfer_pending(xfer)) {
1451 usbd_transfer_stop(xfer);
1453 * Check if the USB transfer was stopped
1454 * before it was even started. Else a cancel
1455 * callback will be pending.
1457 if (!xfer->flags_int.transferring) {
1458 ugen_fs_set_complete(xfer->priv_sc,
1459 USB_P2U(xfer->priv_fifo));
1462 mtx_unlock(f->priv_mtx);
1466 case USB_FS_OPEN_STREAM:
1467 if (u.popen->ep_index >= f->fs_ep_max) {
1471 if (f->fs_xfer[u.popen->ep_index] != NULL) {
1475 if (u.popen->max_bufsize > USB_FS_MAX_BUFSIZE) {
1476 u.popen->max_bufsize = USB_FS_MAX_BUFSIZE;
1478 if (u.popen->max_frames & USB_FS_MAX_FRAMES_PRE_SCALE) {
1480 u.popen->max_frames &= ~USB_FS_MAX_FRAMES_PRE_SCALE;
1484 if (u.popen->max_frames > USB_FS_MAX_FRAMES) {
1485 u.popen->max_frames = USB_FS_MAX_FRAMES;
1488 if (u.popen->max_frames == 0) {
1492 ep = usbd_get_ep_by_addr(f->udev, u.popen->ep_no);
1502 iface_index = ep->iface_index;
1504 memset(usb_config, 0, sizeof(usb_config));
1506 usb_config[0].type = ed->bmAttributes & UE_XFERTYPE;
1507 usb_config[0].endpoint = ed->bEndpointAddress & UE_ADDR;
1508 usb_config[0].direction = ed->bEndpointAddress & (UE_DIR_OUT | UE_DIR_IN);
1509 usb_config[0].interval = USB_DEFAULT_INTERVAL;
1510 usb_config[0].flags.proxy_buffer = 1;
1512 usb_config[0].flags.pre_scale_frames = 1;
1513 usb_config[0].callback = &ugen_ctrl_fs_callback;
1514 usb_config[0].timeout = 0; /* no timeout */
1515 usb_config[0].frames = u.popen->max_frames;
1516 usb_config[0].bufsize = u.popen->max_bufsize;
1517 usb_config[0].usb_mode = USB_MODE_DUAL; /* both modes */
1518 if (cmd == USB_FS_OPEN_STREAM)
1519 usb_config[0].stream_id = u.popen_stream->stream_id;
1521 if (usb_config[0].type == UE_CONTROL) {
1522 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1528 isread = ((usb_config[0].endpoint &
1529 (UE_DIR_IN | UE_DIR_OUT)) == UE_DIR_IN);
1531 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1534 /* check permissions */
1536 if (!(fflags & FREAD)) {
1541 if (!(fflags & FWRITE)) {
1547 error = usbd_transfer_setup(f->udev, &iface_index,
1548 f->fs_xfer + u.popen->ep_index, usb_config, 1,
1551 /* update maximums */
1552 u.popen->max_packet_length =
1553 f->fs_xfer[u.popen->ep_index]->max_frame_size;
1554 u.popen->max_bufsize =
1555 f->fs_xfer[u.popen->ep_index]->max_data_length;
1556 /* update number of frames */
1557 u.popen->max_frames =
1558 f->fs_xfer[u.popen->ep_index]->nframes;
1559 /* store index of endpoint */
1560 f->fs_xfer[u.popen->ep_index]->priv_fifo =
1561 ((uint8_t *)0) + u.popen->ep_index;
1568 if (u.pclose->ep_index >= f->fs_ep_max) {
1572 if (f->fs_xfer[u.pclose->ep_index] == NULL) {
1576 usbd_transfer_unsetup(f->fs_xfer + u.pclose->ep_index, 1);
1579 case USB_FS_CLEAR_STALL_SYNC:
1580 if (u.pstall->ep_index >= f->fs_ep_max) {
1584 if (f->fs_xfer[u.pstall->ep_index] == NULL) {
1588 if (f->udev->flags.usb_mode != USB_MODE_HOST) {
1592 mtx_lock(f->priv_mtx);
1593 error = usbd_transfer_pending(f->fs_xfer[u.pstall->ep_index]);
1594 mtx_unlock(f->priv_mtx);
1599 ep = f->fs_xfer[u.pstall->ep_index]->endpoint;
1601 /* setup a clear-stall packet */
1602 req.bmRequestType = UT_WRITE_ENDPOINT;
1603 req.bRequest = UR_CLEAR_FEATURE;
1604 USETW(req.wValue, UF_ENDPOINT_HALT);
1605 req.wIndex[0] = ep->edesc->bEndpointAddress;
1607 USETW(req.wLength, 0);
1609 error = usbd_do_request(f->udev, NULL, &req, NULL);
1611 usbd_clear_data_toggle(f->udev, ep);
1622 DPRINTFN(6, "error=%d\n", error);
1628 ugen_set_short_xfer(struct usb_fifo *f, void *addr)
1637 if (f->flag_short == t) {
1638 /* same value like before - accept */
1641 if (f->xfer[0] || f->xfer[1]) {
1642 /* cannot change this during transfer */
1650 ugen_set_timeout(struct usb_fifo *f, void *addr)
1652 f->timeout = *(int *)addr;
1653 if (f->timeout > 65535) {
1654 /* limit user input */
1661 ugen_get_frame_size(struct usb_fifo *f, void *addr)
1664 *(int *)addr = f->xfer[0]->max_frame_size;
1672 ugen_set_buffer_size(struct usb_fifo *f, void *addr)
1676 if (*(int *)addr < 0)
1677 t = 0; /* use "wMaxPacketSize" */
1678 else if (*(int *)addr < (256 * 1024))
1683 if (f->bufsize == t) {
1684 /* same value like before - accept */
1687 if (f->xfer[0] || f->xfer[1]) {
1688 /* cannot change this during transfer */
1696 ugen_get_buffer_size(struct usb_fifo *f, void *addr)
1698 *(int *)addr = f->bufsize;
1703 ugen_get_iface_desc(struct usb_fifo *f,
1704 struct usb_interface_descriptor *idesc)
1706 struct usb_interface *iface;
1708 iface = usbd_get_iface(f->udev, f->iface_index);
1709 if (iface && iface->idesc) {
1710 *idesc = *(iface->idesc);
1718 ugen_get_endpoint_desc(struct usb_fifo *f,
1719 struct usb_endpoint_descriptor *ed)
1721 struct usb_endpoint *ep;
1723 ep = usb_fifo_softc(f);
1725 if (ep && ep->edesc) {
1734 ugen_set_power_mode(struct usb_fifo *f, int mode)
1736 struct usb_device *udev = f->udev;
1740 if ((udev == NULL) ||
1741 (udev->parent_hub == NULL)) {
1744 err = priv_check(curthread, PRIV_DRIVER);
1748 /* get old power mode */
1749 old_mode = udev->power_mode;
1751 /* if no change, then just return */
1752 if (old_mode == mode)
1756 case USB_POWER_MODE_OFF:
1757 if (udev->flags.usb_mode == USB_MODE_HOST &&
1758 udev->re_enumerate_wait == USB_RE_ENUM_DONE) {
1759 udev->re_enumerate_wait = USB_RE_ENUM_PWR_OFF;
1761 /* set power mode will wake up the explore thread */
1764 case USB_POWER_MODE_ON:
1765 case USB_POWER_MODE_SAVE:
1768 case USB_POWER_MODE_RESUME:
1770 /* let USB-powerd handle resume */
1771 USB_BUS_LOCK(udev->bus);
1772 udev->pwr_save.write_refs++;
1773 udev->pwr_save.last_xfer_time = ticks;
1774 USB_BUS_UNLOCK(udev->bus);
1776 /* set new power mode */
1777 usbd_set_power_mode(udev, USB_POWER_MODE_SAVE);
1779 /* wait for resume to complete */
1780 usb_pause_mtx(NULL, hz / 4);
1782 /* clear write reference */
1783 USB_BUS_LOCK(udev->bus);
1784 udev->pwr_save.write_refs--;
1785 USB_BUS_UNLOCK(udev->bus);
1787 mode = USB_POWER_MODE_SAVE;
1790 case USB_POWER_MODE_SUSPEND:
1792 /* let USB-powerd handle suspend */
1793 USB_BUS_LOCK(udev->bus);
1794 udev->pwr_save.last_xfer_time = ticks - (256 * hz);
1795 USB_BUS_UNLOCK(udev->bus);
1797 mode = USB_POWER_MODE_SAVE;
1805 return (ENXIO); /* I/O failure */
1807 /* if we are powered off we need to re-enumerate first */
1808 if (old_mode == USB_POWER_MODE_OFF) {
1809 if (udev->flags.usb_mode == USB_MODE_HOST &&
1810 udev->re_enumerate_wait == USB_RE_ENUM_DONE) {
1811 udev->re_enumerate_wait = USB_RE_ENUM_START;
1813 /* set power mode will wake up the explore thread */
1816 /* set new power mode */
1817 usbd_set_power_mode(udev, mode);
1819 return (0); /* success */
1823 ugen_get_power_mode(struct usb_fifo *f)
1825 struct usb_device *udev = f->udev;
1828 return (USB_POWER_MODE_ON);
1830 return (udev->power_mode);
1834 ugen_get_port_path(struct usb_fifo *f, struct usb_device_port_path *dpp)
1836 struct usb_device *udev = f->udev;
1837 struct usb_device *next;
1838 unsigned int nlevel = 0;
1843 dpp->udp_bus = device_get_unit(udev->bus->bdev);
1844 dpp->udp_index = udev->device_index;
1846 /* count port levels */
1848 while (next->parent_hub != NULL) {
1850 next = next->parent_hub;
1853 /* check if too many levels */
1854 if (nlevel > USB_DEVICE_PORT_PATH_MAX)
1857 /* store total level of ports */
1858 dpp->udp_port_level = nlevel;
1860 /* store port index array */
1862 while (next->parent_hub != NULL) {
1863 dpp->udp_port_no[--nlevel] = next->port_no;
1864 next = next->parent_hub;
1866 return (0); /* success */
1869 return (EINVAL); /* failure */
1873 ugen_get_power_usage(struct usb_fifo *f)
1875 struct usb_device *udev = f->udev;
1880 return (udev->power);
1884 ugen_do_port_feature(struct usb_fifo *f, uint8_t port_no,
1885 uint8_t set, uint16_t feature)
1887 struct usb_device *udev = f->udev;
1888 struct usb_hub *hub;
1891 err = priv_check(curthread, PRIV_DRIVER);
1898 if ((udev == NULL) ||
1899 (udev->hub == NULL)) {
1904 if (port_no > hub->nports) {
1908 err = usbd_req_set_port_feature(udev,
1909 NULL, port_no, feature);
1911 err = usbd_req_clear_port_feature(udev,
1912 NULL, port_no, feature);
1915 return (ENXIO); /* failure */
1917 return (0); /* success */
1921 ugen_iface_ioctl(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
1923 struct usb_fifo *f_rx;
1924 struct usb_fifo *f_tx;
1927 f_rx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_RX];
1928 f_tx = f->udev->fifo[(f->fifo_index & ~1) + USB_FIFO_TX];
1931 case USB_SET_RX_SHORT_XFER:
1932 if (fflags & FREAD) {
1933 error = ugen_set_short_xfer(f_rx, addr);
1939 case USB_SET_TX_FORCE_SHORT:
1940 if (fflags & FWRITE) {
1941 error = ugen_set_short_xfer(f_tx, addr);
1947 case USB_SET_RX_TIMEOUT:
1948 if (fflags & FREAD) {
1949 error = ugen_set_timeout(f_rx, addr);
1955 case USB_SET_TX_TIMEOUT:
1956 if (fflags & FWRITE) {
1957 error = ugen_set_timeout(f_tx, addr);
1963 case USB_GET_RX_FRAME_SIZE:
1964 if (fflags & FREAD) {
1965 error = ugen_get_frame_size(f_rx, addr);
1971 case USB_GET_TX_FRAME_SIZE:
1972 if (fflags & FWRITE) {
1973 error = ugen_get_frame_size(f_tx, addr);
1979 case USB_SET_RX_BUFFER_SIZE:
1980 if (fflags & FREAD) {
1981 error = ugen_set_buffer_size(f_rx, addr);
1987 case USB_SET_TX_BUFFER_SIZE:
1988 if (fflags & FWRITE) {
1989 error = ugen_set_buffer_size(f_tx, addr);
1995 case USB_GET_RX_BUFFER_SIZE:
1996 if (fflags & FREAD) {
1997 error = ugen_get_buffer_size(f_rx, addr);
2003 case USB_GET_TX_BUFFER_SIZE:
2004 if (fflags & FWRITE) {
2005 error = ugen_get_buffer_size(f_tx, addr);
2011 case USB_GET_RX_INTERFACE_DESC:
2012 if (fflags & FREAD) {
2013 error = ugen_get_iface_desc(f_rx, addr);
2019 case USB_GET_TX_INTERFACE_DESC:
2020 if (fflags & FWRITE) {
2021 error = ugen_get_iface_desc(f_tx, addr);
2027 case USB_GET_RX_ENDPOINT_DESC:
2028 if (fflags & FREAD) {
2029 error = ugen_get_endpoint_desc(f_rx, addr);
2035 case USB_GET_TX_ENDPOINT_DESC:
2036 if (fflags & FWRITE) {
2037 error = ugen_get_endpoint_desc(f_tx, addr);
2043 case USB_SET_RX_STALL_FLAG:
2044 if ((fflags & FREAD) && (*(int *)addr)) {
2045 f_rx->flag_stall = 1;
2049 case USB_SET_TX_STALL_FLAG:
2050 if ((fflags & FWRITE) && (*(int *)addr)) {
2051 f_tx->flag_stall = 1;
2063 ugen_ioctl_post(struct usb_fifo *f, u_long cmd, void *addr, int fflags)
2066 struct usb_interface_descriptor *idesc;
2067 struct usb_alt_interface *ai;
2068 struct usb_device_descriptor *ddesc;
2069 struct usb_config_descriptor *cdesc;
2070 struct usb_device_stats *stat;
2071 struct usb_fs_init *pinit;
2072 struct usb_fs_uninit *puninit;
2073 struct usb_device_port_path *dpp;
2078 struct usb_device_descriptor *dtemp;
2079 struct usb_config_descriptor *ctemp;
2080 struct usb_interface *iface;
2086 DPRINTFN(6, "cmd=0x%08lx\n", cmd);
2090 usb_needs_explore_all();
2094 if (!(fflags & FWRITE)) {
2098 usb_debug = *(int *)addr;
2101 case USB_GET_CONFIG:
2102 *(int *)addr = f->udev->curr_config_index;
2105 case USB_SET_CONFIG:
2106 if (!(fflags & FWRITE)) {
2110 error = ugen_set_config(f, *(int *)addr);
2113 case USB_GET_ALTINTERFACE:
2114 iface = usbd_get_iface(f->udev,
2115 u.ai->uai_interface_index);
2116 if (iface && iface->idesc) {
2117 u.ai->uai_alt_index = iface->alt_index;
2123 case USB_SET_ALTINTERFACE:
2124 if (!(fflags & FWRITE)) {
2128 error = ugen_set_interface(f,
2129 u.ai->uai_interface_index, u.ai->uai_alt_index);
2132 case USB_GET_DEVICE_DESC:
2133 dtemp = usbd_get_device_descriptor(f->udev);
2141 case USB_GET_CONFIG_DESC:
2142 ctemp = usbd_get_config_descriptor(f->udev);
2150 case USB_GET_FULL_DESC:
2151 error = ugen_get_cdesc(f, addr);
2154 case USB_GET_STRING_DESC:
2155 error = ugen_get_sdesc(f, addr);
2158 case USB_GET_IFACE_DRIVER:
2159 error = ugen_get_iface_driver(f, addr);
2163 case USB_DO_REQUEST:
2164 if (!(fflags & FWRITE)) {
2168 error = ugen_do_request(f, addr);
2171 case USB_DEVICEINFO:
2172 case USB_GET_DEVICEINFO:
2173 error = usb_gen_fill_deviceinfo(f, addr);
2176 case USB_DEVICESTATS:
2177 for (n = 0; n != 4; n++) {
2179 u.stat->uds_requests_fail[n] =
2180 f->udev->bus->stats_err.uds_requests[n];
2182 u.stat->uds_requests_ok[n] =
2183 f->udev->bus->stats_ok.uds_requests[n];
2187 case USB_DEVICEENUMERATE:
2188 error = ugen_re_enumerate(f);
2191 case USB_GET_PLUGTIME:
2192 *u.ptime = f->udev->plugtime;
2195 case USB_CLAIM_INTERFACE:
2196 case USB_RELEASE_INTERFACE:
2200 case USB_IFACE_DRIVER_ACTIVE:
2204 iface = usbd_get_iface(f->udev, n);
2206 if (iface && iface->subdev)
2212 case USB_IFACE_DRIVER_DETACH:
2214 error = priv_check(curthread, PRIV_DRIVER);
2221 if (n == USB_IFACE_INDEX_ANY) {
2227 * Detach the currently attached driver.
2229 usb_detach_device(f->udev, n, 0);
2232 * Set parent to self, this should keep attach away
2233 * until the next set configuration event.
2235 usbd_set_parent_iface(f->udev, n, n);
2238 case USB_SET_POWER_MODE:
2239 error = ugen_set_power_mode(f, *u.pint);
2242 case USB_GET_POWER_MODE:
2243 *u.pint = ugen_get_power_mode(f);
2246 case USB_GET_DEV_PORT_PATH:
2247 error = ugen_get_port_path(f, u.dpp);
2250 case USB_GET_POWER_USAGE:
2251 *u.pint = ugen_get_power_usage(f);
2254 case USB_SET_PORT_ENABLE:
2255 error = ugen_do_port_feature(f,
2256 *u.pint, 1, UHF_PORT_ENABLE);
2259 case USB_SET_PORT_DISABLE:
2260 error = ugen_do_port_feature(f,
2261 *u.pint, 0, UHF_PORT_ENABLE);
2265 /* verify input parameters */
2266 if (u.pinit->pEndpoints == NULL) {
2270 if (u.pinit->ep_index_max > 127) {
2274 if (u.pinit->ep_index_max == 0) {
2278 if (f->fs_xfer != NULL) {
2282 if (f->dev_ep_index != 0) {
2286 if (ugen_fifo_in_use(f, fflags)) {
2290 error = usb_fifo_alloc_buffer(f, 1, u.pinit->ep_index_max);
2294 f->fs_xfer = malloc(sizeof(f->fs_xfer[0]) *
2295 u.pinit->ep_index_max, M_USB, M_WAITOK | M_ZERO);
2296 if (f->fs_xfer == NULL) {
2297 usb_fifo_free_buffer(f);
2301 f->fs_ep_max = u.pinit->ep_index_max;
2302 f->fs_ep_ptr = u.pinit->pEndpoints;
2306 if (u.puninit->dummy != 0) {
2310 error = ugen_fs_uninit(f);
2314 mtx_lock(f->priv_mtx);
2315 error = ugen_iface_ioctl(f, cmd, addr, fflags);
2316 mtx_unlock(f->priv_mtx);
2319 DPRINTFN(6, "error=%d\n", error);
2324 ugen_ctrl_fs_callback(struct usb_xfer *xfer, usb_error_t error)
2326 ; /* workaround for a bug in "indent" */
2328 DPRINTF("st=%u alen=%u aframes=%u\n",
2329 USB_GET_STATE(xfer), xfer->actlen, xfer->aframes);
2331 switch (USB_GET_STATE(xfer)) {
2333 usbd_transfer_submit(xfer);
2336 ugen_fs_set_complete(xfer->priv_sc, USB_P2U(xfer->priv_fifo));
2340 #endif /* USB_HAVE_UGEN */