3 * Copyright (c) 2007 Luigi Rizzo - Universita` di Pisa. All rights reserved.
4 * Copyright (c) 2007 Hans Petter Selasky. All rights reserved.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 #ifdef USB_GLOBAL_INCLUDE_FILE
29 #include USB_GLOBAL_INCLUDE_FILE
31 #include <sys/stdint.h>
32 #include <sys/stddef.h>
33 #include <sys/param.h>
34 #include <sys/queue.h>
35 #include <sys/types.h>
36 #include <sys/systm.h>
37 #include <sys/kernel.h>
39 #include <sys/module.h>
41 #include <sys/mutex.h>
42 #include <sys/condvar.h>
43 #include <sys/sysctl.h>
45 #include <sys/unistd.h>
46 #include <sys/callout.h>
47 #include <sys/malloc.h>
50 #include <dev/usb/usb.h>
51 #include <dev/usb/usbdi.h>
52 #include <dev/usb/usbdi_util.h>
54 #define USB_DEBUG_VAR usb_debug
56 #include <dev/usb/usb_core.h>
57 #include <dev/usb/usb_compat_linux.h>
58 #include <dev/usb/usb_process.h>
59 #include <dev/usb/usb_device.h>
60 #include <dev/usb/usb_util.h>
61 #include <dev/usb/usb_busdma.h>
62 #include <dev/usb/usb_transfer.h>
63 #include <dev/usb/usb_hub.h>
64 #include <dev/usb/usb_request.h>
65 #include <dev/usb/usb_debug.h>
66 #endif /* USB_GLOBAL_INCLUDE_FILE */
68 struct usb_linux_softc {
69 LIST_ENTRY(usb_linux_softc) sc_attached_list;
72 struct usb_device *sc_fbsd_udev;
73 struct usb_interface *sc_ui;
74 struct usb_driver *sc_udrv;
78 static device_probe_t usb_linux_probe;
79 static device_attach_t usb_linux_attach;
80 static device_detach_t usb_linux_detach;
81 static device_suspend_t usb_linux_suspend;
82 static device_resume_t usb_linux_resume;
84 static usb_callback_t usb_linux_isoc_callback;
85 static usb_callback_t usb_linux_non_isoc_callback;
87 static usb_complete_t usb_linux_wait_complete;
89 static uint16_t usb_max_isoc_frames(struct usb_device *);
90 static int usb_start_wait_urb(struct urb *, usb_timeout_t, uint16_t *);
91 static const struct usb_device_id *usb_linux_lookup_id(
92 const struct usb_device_id *, struct usb_attach_arg *);
93 static struct usb_driver *usb_linux_get_usb_driver(struct usb_linux_softc *);
94 static int usb_linux_create_usb_device(struct usb_device *, device_t);
95 static void usb_linux_cleanup_interface(struct usb_device *,
96 struct usb_interface *);
97 static void usb_linux_complete(struct usb_xfer *);
98 static int usb_unlink_urb_sub(struct urb *, uint8_t);
100 /*------------------------------------------------------------------------*
101 * FreeBSD USB interface
102 *------------------------------------------------------------------------*/
104 static LIST_HEAD(, usb_linux_softc) usb_linux_attached_list;
105 static LIST_HEAD(, usb_driver) usb_linux_driver_list;
107 static device_method_t usb_linux_methods[] = {
108 /* Device interface */
109 DEVMETHOD(device_probe, usb_linux_probe),
110 DEVMETHOD(device_attach, usb_linux_attach),
111 DEVMETHOD(device_detach, usb_linux_detach),
112 DEVMETHOD(device_suspend, usb_linux_suspend),
113 DEVMETHOD(device_resume, usb_linux_resume),
118 static driver_t usb_linux_driver = {
120 .methods = usb_linux_methods,
121 .size = sizeof(struct usb_linux_softc),
124 static devclass_t usb_linux_devclass;
126 DRIVER_MODULE(usb_linux, uhub, usb_linux_driver, usb_linux_devclass, NULL, 0);
127 MODULE_VERSION(usb_linux, 1);
129 /*------------------------------------------------------------------------*
130 * usb_linux_lookup_id
132 * This functions takes an array of "struct usb_device_id" and tries
133 * to match the entries with the information in "struct usb_attach_arg".
134 * If it finds a match the matching entry will be returned.
135 * Else "NULL" will be returned.
136 *------------------------------------------------------------------------*/
137 static const struct usb_device_id *
138 usb_linux_lookup_id(const struct usb_device_id *id, struct usb_attach_arg *uaa)
144 * Keep on matching array entries until we find one with
145 * "match_flags" equal to zero, which indicates the end of the
148 for (; id->match_flags; id++) {
150 if ((id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
151 (id->idVendor != uaa->info.idVendor)) {
154 if ((id->match_flags & USB_DEVICE_ID_MATCH_PRODUCT) &&
155 (id->idProduct != uaa->info.idProduct)) {
158 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_LO) &&
159 (id->bcdDevice_lo > uaa->info.bcdDevice)) {
162 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_HI) &&
163 (id->bcdDevice_hi < uaa->info.bcdDevice)) {
166 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_CLASS) &&
167 (id->bDeviceClass != uaa->info.bDeviceClass)) {
170 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_SUBCLASS) &&
171 (id->bDeviceSubClass != uaa->info.bDeviceSubClass)) {
174 if ((id->match_flags & USB_DEVICE_ID_MATCH_DEV_PROTOCOL) &&
175 (id->bDeviceProtocol != uaa->info.bDeviceProtocol)) {
178 if ((uaa->info.bDeviceClass == 0xFF) &&
179 !(id->match_flags & USB_DEVICE_ID_MATCH_VENDOR) &&
180 (id->match_flags & (USB_DEVICE_ID_MATCH_INT_CLASS |
181 USB_DEVICE_ID_MATCH_INT_SUBCLASS |
182 USB_DEVICE_ID_MATCH_INT_PROTOCOL))) {
185 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_CLASS) &&
186 (id->bInterfaceClass != uaa->info.bInterfaceClass)) {
189 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_SUBCLASS) &&
190 (id->bInterfaceSubClass != uaa->info.bInterfaceSubClass)) {
193 if ((id->match_flags & USB_DEVICE_ID_MATCH_INT_PROTOCOL) &&
194 (id->bInterfaceProtocol != uaa->info.bInterfaceProtocol)) {
197 /* we found a match! */
205 /*------------------------------------------------------------------------*
208 * This function is the FreeBSD probe callback. It is called from the
209 * FreeBSD USB stack through the "device_probe_and_attach()" function.
210 *------------------------------------------------------------------------*/
212 usb_linux_probe(device_t dev)
214 struct usb_attach_arg *uaa = device_get_ivars(dev);
215 struct usb_driver *udrv;
218 if (uaa->usb_mode != USB_MODE_HOST) {
222 LIST_FOREACH(udrv, &usb_linux_driver_list, linux_driver_list) {
223 if (usb_linux_lookup_id(udrv->id_table, uaa)) {
233 /*------------------------------------------------------------------------*
234 * usb_linux_get_usb_driver
236 * This function returns the pointer to the "struct usb_driver" where
237 * the Linux USB device driver "struct usb_device_id" match was found.
238 * We apply a lock before reading out the pointer to avoid races.
239 *------------------------------------------------------------------------*/
240 static struct usb_driver *
241 usb_linux_get_usb_driver(struct usb_linux_softc *sc)
243 struct usb_driver *udrv;
251 /*------------------------------------------------------------------------*
254 * This function is the FreeBSD attach callback. It is called from the
255 * FreeBSD USB stack through the "device_probe_and_attach()" function.
256 * This function is called when "usb_linux_probe()" returns zero.
257 *------------------------------------------------------------------------*/
259 usb_linux_attach(device_t dev)
261 struct usb_attach_arg *uaa = device_get_ivars(dev);
262 struct usb_linux_softc *sc = device_get_softc(dev);
263 struct usb_driver *udrv;
264 const struct usb_device_id *id = NULL;
267 LIST_FOREACH(udrv, &usb_linux_driver_list, linux_driver_list) {
268 id = usb_linux_lookup_id(udrv->id_table, uaa);
277 if (usb_linux_create_usb_device(uaa->device, dev) != 0)
279 device_set_usb_desc(dev);
281 sc->sc_fbsd_udev = uaa->device;
282 sc->sc_fbsd_dev = dev;
284 sc->sc_ui = usb_ifnum_to_if(uaa->device, uaa->info.bIfaceNum);
285 if (sc->sc_ui == NULL) {
289 if ((udrv->probe) (sc->sc_ui, id)) {
294 LIST_INSERT_HEAD(&usb_linux_attached_list, sc, sc_attached_list);
301 /*------------------------------------------------------------------------*
304 * This function is the FreeBSD detach callback. It is called from the
305 * FreeBSD USB stack through the "device_detach()" function.
306 *------------------------------------------------------------------------*/
308 usb_linux_detach(device_t dev)
310 struct usb_linux_softc *sc = device_get_softc(dev);
311 struct usb_driver *udrv = NULL;
314 if (sc->sc_attached_list.le_prev) {
315 LIST_REMOVE(sc, sc_attached_list);
316 sc->sc_attached_list.le_prev = NULL;
322 if (udrv && udrv->disconnect) {
323 (udrv->disconnect) (sc->sc_ui);
326 * Make sure that we free all FreeBSD USB transfers belonging to
327 * this Linux "usb_interface", hence they will most likely not be
330 usb_linux_cleanup_interface(sc->sc_fbsd_udev, sc->sc_ui);
334 /*------------------------------------------------------------------------*
337 * This function is the FreeBSD suspend callback. Usually it does nothing.
338 *------------------------------------------------------------------------*/
340 usb_linux_suspend(device_t dev)
342 struct usb_linux_softc *sc = device_get_softc(dev);
343 struct usb_driver *udrv = usb_linux_get_usb_driver(sc);
346 if (udrv && udrv->suspend) {
347 err = (udrv->suspend) (sc->sc_ui, 0);
352 /*------------------------------------------------------------------------*
355 * This function is the FreeBSD resume callback. Usually it does nothing.
356 *------------------------------------------------------------------------*/
358 usb_linux_resume(device_t dev)
360 struct usb_linux_softc *sc = device_get_softc(dev);
361 struct usb_driver *udrv = usb_linux_get_usb_driver(sc);
364 if (udrv && udrv->resume) {
365 err = (udrv->resume) (sc->sc_ui);
370 /*------------------------------------------------------------------------*
371 * Linux emulation layer
372 *------------------------------------------------------------------------*/
374 /*------------------------------------------------------------------------*
375 * usb_max_isoc_frames
377 * The following function returns the maximum number of isochronous
378 * frames that we support per URB. It is not part of the Linux USB API.
379 *------------------------------------------------------------------------*/
381 usb_max_isoc_frames(struct usb_device *dev)
384 switch (usbd_get_speed(dev)) {
387 return (USB_MAX_FULL_SPEED_ISOC_FRAMES);
389 return (USB_MAX_HIGH_SPEED_ISOC_FRAMES);
393 /*------------------------------------------------------------------------*
396 * This function is used to queue an URB after that it has been
397 * initialized. If it returns non-zero, it means that the URB was not
399 *------------------------------------------------------------------------*/
401 usb_submit_urb(struct urb *urb, uint16_t mem_flags)
403 struct usb_host_endpoint *uhe;
410 do_unlock = mtx_owned(&Giant) ? 0 : 1;
414 if (urb->endpoint == NULL) {
420 * Check to see if the urb is in the process of being killed
421 * and stop a urb that is in the process of being killed from
422 * being re-submitted (e.g. from its completion callback
425 if (urb->kill_count != 0) {
433 * Check that we have got a FreeBSD USB transfer that will dequeue
434 * the URB structure and do the real transfer. If there are no USB
435 * transfers, then we return an error.
437 if (uhe->bsd_xfer[0] ||
441 TAILQ_INSERT_TAIL(&uhe->bsd_urb_list, urb, bsd_urb_list);
443 urb->status = -EINPROGRESS;
445 usbd_transfer_start(uhe->bsd_xfer[0]);
446 usbd_transfer_start(uhe->bsd_xfer[1]);
449 /* no pipes have been setup yet! */
450 urb->status = -EINVAL;
459 /*------------------------------------------------------------------------*
462 * This function is used to stop an URB after that it is been
463 * submitted, but before the "complete" callback has been called. On
464 *------------------------------------------------------------------------*/
466 usb_unlink_urb(struct urb *urb)
468 return (usb_unlink_urb_sub(urb, 0));
472 usb_unlink_bsd(struct usb_xfer *xfer,
473 struct urb *urb, uint8_t drain)
477 if (!usbd_transfer_pending(xfer))
479 if (xfer->priv_fifo == (void *)urb) {
482 usbd_transfer_drain(xfer);
485 usbd_transfer_stop(xfer);
487 usbd_transfer_start(xfer);
492 usb_unlink_urb_sub(struct urb *urb, uint8_t drain)
494 struct usb_host_endpoint *uhe;
502 do_unlock = mtx_owned(&Giant) ? 0 : 1;
508 if (urb->endpoint == NULL) {
514 if (urb->bsd_urb_list.tqe_prev) {
516 /* not started yet, just remove it from the queue */
517 TAILQ_REMOVE(&uhe->bsd_urb_list, urb, bsd_urb_list);
518 urb->bsd_urb_list.tqe_prev = NULL;
519 urb->status = -ECONNRESET;
520 urb->actual_length = 0;
522 for (x = 0; x < urb->number_of_packets; x++) {
523 urb->iso_frame_desc[x].actual_length = 0;
527 (urb->complete) (urb);
532 * If the URB is not on the URB list, then check if one of
533 * the FreeBSD USB transfer are processing the current URB.
534 * If so, re-start that transfer, which will lead to the
535 * termination of that URB:
537 usb_unlink_bsd(uhe->bsd_xfer[0], urb, drain);
538 usb_unlink_bsd(uhe->bsd_xfer[1], urb, drain);
549 /*------------------------------------------------------------------------*
552 * This function must always be used to clear the stall. Stall is when
553 * an USB endpoint returns a stall message to the USB host controller.
554 * Until the stall is cleared, no data can be transferred.
555 *------------------------------------------------------------------------*/
557 usb_clear_halt(struct usb_device *dev, struct usb_host_endpoint *uhe)
559 struct usb_config cfg[1];
560 struct usb_endpoint *ep;
567 type = uhe->desc.bmAttributes & UE_XFERTYPE;
568 addr = uhe->desc.bEndpointAddress;
570 memset(cfg, 0, sizeof(cfg));
573 cfg[0].endpoint = addr & UE_ADDR;
574 cfg[0].direction = addr & (UE_DIR_OUT | UE_DIR_IN);
576 ep = usbd_get_endpoint(dev, uhe->bsd_iface_index, cfg);
580 usbd_clear_data_toggle(dev, ep);
582 return (usb_control_msg(dev, &dev->ep0,
583 UR_CLEAR_FEATURE, UT_WRITE_ENDPOINT,
584 UF_ENDPOINT_HALT, addr, NULL, 0, 1000));
587 /*------------------------------------------------------------------------*
590 * This is an internal function that is used to perform synchronous
591 * Linux USB transfers.
592 *------------------------------------------------------------------------*/
594 usb_start_wait_urb(struct urb *urb, usb_timeout_t timeout, uint16_t *p_actlen)
599 /* you must have a timeout! */
603 urb->complete = &usb_linux_wait_complete;
604 urb->timeout = timeout;
605 urb->transfer_flags |= URB_WAIT_WAKEUP;
606 urb->transfer_flags &= ~URB_IS_SLEEPING;
608 do_unlock = mtx_owned(&Giant) ? 0 : 1;
611 err = usb_submit_urb(urb, 0);
616 * the URB might have completed before we get here, so check that by
619 while (urb->transfer_flags & URB_WAIT_WAKEUP) {
620 urb->transfer_flags |= URB_IS_SLEEPING;
621 cv_wait(&urb->cv_wait, &Giant);
622 urb->transfer_flags &= ~URB_IS_SLEEPING;
630 if (p_actlen != NULL) {
634 *p_actlen = urb->actual_length;
639 /*------------------------------------------------------------------------*
642 * The following function performs a control transfer sequence one any
643 * control, bulk or interrupt endpoint, specified by "uhe". A control
644 * transfer means that you transfer an 8-byte header first followed by
645 * a data-phase as indicated by the 8-byte header. The "timeout" is
646 * given in milliseconds.
652 *------------------------------------------------------------------------*/
654 usb_control_msg(struct usb_device *dev, struct usb_host_endpoint *uhe,
655 uint8_t request, uint8_t requesttype,
656 uint16_t value, uint16_t index, void *data,
657 uint16_t size, usb_timeout_t timeout)
659 struct usb_device_request req;
666 req.bmRequestType = requesttype;
667 req.bRequest = request;
668 USETW(req.wValue, value);
669 USETW(req.wIndex, index);
670 USETW(req.wLength, size);
675 type = (uhe->desc.bmAttributes & UE_XFERTYPE);
676 addr = (uhe->desc.bEndpointAddress & UE_ADDR);
678 if (type != UE_CONTROL) {
683 * The FreeBSD USB stack supports standard control
684 * transfers on control endpoint zero:
686 err = usbd_do_request_flags(dev,
687 NULL, &req, data, USB_SHORT_XFER_OK,
696 if (dev->flags.usb_mode != USB_MODE_HOST) {
700 err = usb_setup_endpoint(dev, uhe, 1 /* dummy */ );
703 * NOTE: we need to allocate real memory here so that we don't
704 * transfer data to/from the stack!
706 * 0xFFFF is a FreeBSD specific magic value.
708 urb = usb_alloc_urb(0xFFFF, size);
715 memcpy(urb->setup_packet, &req, sizeof(req));
717 if (size && (!(req.bmRequestType & UT_READ))) {
718 /* move the data to a real buffer */
719 memcpy(USB_ADD_BYTES(urb->setup_packet, sizeof(req)),
722 err = usb_start_wait_urb(urb, timeout, &actlen);
724 if (req.bmRequestType & UT_READ) {
726 bcopy(USB_ADD_BYTES(urb->setup_packet,
727 sizeof(req)), data, actlen);
738 /*------------------------------------------------------------------------*
741 * The following function will select which alternate setting of an
742 * USB interface you plan to use. By default alternate setting with
743 * index zero is selected. Note that "iface_no" is not the interface
744 * index, but rather the value of "bInterfaceNumber".
745 *------------------------------------------------------------------------*/
747 usb_set_interface(struct usb_device *dev, uint8_t iface_no, uint8_t alt_index)
749 struct usb_interface *p_ui = usb_ifnum_to_if(dev, iface_no);
754 if (alt_index >= p_ui->num_altsetting)
756 usb_linux_cleanup_interface(dev, p_ui);
757 err = -usbd_set_alt_interface_index(dev,
758 p_ui->bsd_iface_index, alt_index);
760 p_ui->cur_altsetting = p_ui->altsetting + alt_index;
765 /*------------------------------------------------------------------------*
768 * The following function is an extension to the Linux USB API that
769 * allows you to set a maximum buffer size for a given USB endpoint.
770 * The maximum buffer size is per URB. If you don't call this function
771 * to set a maximum buffer size, the endpoint will not be functional.
772 * Note that for isochronous endpoints the maximum buffer size must be
773 * a non-zero dummy, hence this function will base the maximum buffer
774 * size on "wMaxPacketSize".
775 *------------------------------------------------------------------------*/
777 usb_setup_endpoint(struct usb_device *dev,
778 struct usb_host_endpoint *uhe, usb_size_t bufsize)
780 struct usb_config cfg[2];
781 uint8_t type = uhe->desc.bmAttributes & UE_XFERTYPE;
782 uint8_t addr = uhe->desc.bEndpointAddress;
784 if (uhe->fbsd_buf_size == bufsize) {
788 usbd_transfer_unsetup(uhe->bsd_xfer, 2);
790 uhe->fbsd_buf_size = bufsize;
795 memset(cfg, 0, sizeof(cfg));
797 if (type == UE_ISOCHRONOUS) {
800 * Isochronous transfers are special in that they don't fit
801 * into the BULK/INTR/CONTROL transfer model.
805 cfg[0].endpoint = addr & UE_ADDR;
806 cfg[0].direction = addr & (UE_DIR_OUT | UE_DIR_IN);
807 cfg[0].callback = &usb_linux_isoc_callback;
808 cfg[0].bufsize = 0; /* use wMaxPacketSize */
809 cfg[0].frames = usb_max_isoc_frames(dev);
810 cfg[0].flags.proxy_buffer = 1;
813 * The Linux USB API allows non back-to-back
814 * isochronous frames which we do not support. If the
815 * isochronous frames are not back-to-back we need to
816 * do a copy, and then we need a buffer for
817 * that. Enable this at your own risk.
819 cfg[0].flags.ext_buffer = 1;
821 cfg[0].flags.short_xfer_ok = 1;
823 bcopy(cfg, cfg + 1, sizeof(*cfg));
825 /* Allocate and setup two generic FreeBSD USB transfers */
827 if (usbd_transfer_setup(dev, &uhe->bsd_iface_index,
828 uhe->bsd_xfer, cfg, 2, uhe, &Giant)) {
832 if (bufsize > (1 << 22)) {
833 /* limit buffer size */
836 /* Allocate and setup one generic FreeBSD USB transfer */
839 cfg[0].endpoint = addr & UE_ADDR;
840 cfg[0].direction = addr & (UE_DIR_OUT | UE_DIR_IN);
841 cfg[0].callback = &usb_linux_non_isoc_callback;
842 cfg[0].bufsize = bufsize;
843 cfg[0].flags.ext_buffer = 1; /* enable zero-copy */
844 cfg[0].flags.proxy_buffer = 1;
845 cfg[0].flags.short_xfer_ok = 1;
847 if (usbd_transfer_setup(dev, &uhe->bsd_iface_index,
848 uhe->bsd_xfer, cfg, 1, uhe, &Giant)) {
855 /*------------------------------------------------------------------------*
856 * usb_linux_create_usb_device
858 * The following function is used to build up a per USB device
859 * structure tree, that mimics the Linux one. The root structure
860 * is returned by this function.
861 *------------------------------------------------------------------------*/
863 usb_linux_create_usb_device(struct usb_device *udev, device_t dev)
865 struct usb_config_descriptor *cd = usbd_get_config_descriptor(udev);
866 struct usb_descriptor *desc;
867 struct usb_interface_descriptor *id;
868 struct usb_endpoint_descriptor *ed;
869 struct usb_interface *p_ui = NULL;
870 struct usb_host_interface *p_uhi = NULL;
871 struct usb_host_endpoint *p_uhe = NULL;
873 uint16_t niface_total;
875 uint16_t iface_no_curr;
876 uint16_t iface_index;
881 * We do two passes. One pass for computing necessary memory size
882 * and one pass to initialize all the allocated memory structures.
884 for (pass = 0; pass < 2; pass++) {
886 iface_no_curr = 0xFFFF;
893 * Iterate over all the USB descriptors. Use the USB config
894 * descriptor pointer provided by the FreeBSD USB stack.
896 while ((desc = usb_desc_foreach(cd, desc))) {
899 * Build up a tree according to the descriptors we
902 switch (desc->bDescriptorType) {
908 if ((ed->bLength < sizeof(*ed)) ||
912 bcopy(ed, &p_uhe->desc, sizeof(p_uhe->desc));
913 p_uhe->bsd_iface_index = iface_index - 1;
914 TAILQ_INIT(&p_uhe->bsd_urb_list);
918 (p_uhi - 1)->desc.bNumEndpoints++;
923 case UDESC_INTERFACE:
925 if (id->bLength < sizeof(*id))
928 bcopy(id, &p_uhi->desc, sizeof(p_uhi->desc));
929 p_uhi->desc.bNumEndpoints = 0;
930 p_uhi->endpoint = p_uhe;
932 p_uhi->bsd_iface_index = iface_index;
935 iface_no = id->bInterfaceNumber;
937 if (iface_no_curr != iface_no) {
939 p_ui->altsetting = p_uhi - 1;
940 p_ui->cur_altsetting = p_uhi - 1;
941 p_ui->num_altsetting = 1;
942 p_ui->bsd_iface_index = iface_index;
943 p_ui->linux_udev = udev;
946 iface_no_curr = iface_no;
950 (p_ui - 1)->num_altsetting++;
962 size = (sizeof(*p_uhe) * nedesc) +
963 (sizeof(*p_ui) * iface_index) +
964 (sizeof(*p_uhi) * niface_total);
966 p_uhe = malloc(size, M_USBDEV, M_WAITOK | M_ZERO);
967 p_ui = (void *)(p_uhe + nedesc);
968 p_uhi = (void *)(p_ui + iface_index);
970 udev->linux_iface_start = p_ui;
971 udev->linux_iface_end = p_ui + iface_index;
972 udev->linux_endpoint_start = p_uhe;
973 udev->linux_endpoint_end = p_uhe + nedesc;
974 udev->devnum = device_get_unit(dev);
975 bcopy(&udev->ddesc, &udev->descriptor,
976 sizeof(udev->descriptor));
977 bcopy(udev->ctrl_ep.edesc, &udev->ep0.desc,
978 sizeof(udev->ep0.desc));
984 /*------------------------------------------------------------------------*
987 * This function should always be used when you allocate an URB for
988 * use with the USB Linux stack. In case of an isochronous transfer
989 * you must specifiy the maximum number of "iso_packets" which you
990 * plan to transfer per URB. This function is always blocking, and
991 * "mem_flags" are not regarded like on Linux.
992 *------------------------------------------------------------------------*/
994 usb_alloc_urb(uint16_t iso_packets, uint16_t mem_flags)
999 if (iso_packets == 0xFFFF) {
1001 * FreeBSD specific magic value to ask for control transfer
1002 * memory allocation:
1004 size = sizeof(*urb) + sizeof(struct usb_device_request) + mem_flags;
1006 size = sizeof(*urb) + (iso_packets * sizeof(urb->iso_frame_desc[0]));
1009 urb = malloc(size, M_USBDEV, M_WAITOK | M_ZERO);
1012 cv_init(&urb->cv_wait, "URBWAIT");
1013 if (iso_packets == 0xFFFF) {
1014 urb->setup_packet = (void *)(urb + 1);
1015 urb->transfer_buffer = (void *)(urb->setup_packet +
1016 sizeof(struct usb_device_request));
1018 urb->number_of_packets = iso_packets;
1024 /*------------------------------------------------------------------------*
1025 * usb_find_host_endpoint
1027 * The following function will return the Linux USB host endpoint
1028 * structure that matches the given endpoint type and endpoint
1029 * value. If no match is found, NULL is returned. This function is not
1030 * part of the Linux USB API and is only used internally.
1031 *------------------------------------------------------------------------*/
1032 struct usb_host_endpoint *
1033 usb_find_host_endpoint(struct usb_device *dev, uint8_t type, uint8_t ep)
1035 struct usb_host_endpoint *uhe;
1036 struct usb_host_endpoint *uhe_end;
1037 struct usb_host_interface *uhi;
1038 struct usb_interface *ui;
1046 if (type == UE_CONTROL) {
1049 mask = (UE_DIR_IN | UE_DIR_OUT | UE_ADDR);
1055 * Iterate over all the interfaces searching the selected alternate
1056 * setting only, and all belonging endpoints.
1058 for (ui = dev->linux_iface_start;
1059 ui != dev->linux_iface_end;
1061 uhi = ui->cur_altsetting;
1063 uhe_end = uhi->endpoint + uhi->desc.bNumEndpoints;
1064 for (uhe = uhi->endpoint;
1067 ea = uhe->desc.bEndpointAddress;
1068 at = uhe->desc.bmAttributes;
1070 if (((ea & mask) == ep) &&
1071 ((at & UE_XFERTYPE) == type)) {
1078 if ((type == UE_CONTROL) && ((ep & UE_ADDR) == 0)) {
1084 /*------------------------------------------------------------------------*
1085 * usb_altnum_to_altsetting
1087 * The following function returns a pointer to an alternate setting by
1088 * index given a "usb_interface" pointer. If the alternate setting by
1089 * index does not exist, NULL is returned. And alternate setting is a
1090 * variant of an interface, but usually with slightly different
1092 *------------------------------------------------------------------------*/
1093 struct usb_host_interface *
1094 usb_altnum_to_altsetting(const struct usb_interface *intf, uint8_t alt_index)
1096 if (alt_index >= intf->num_altsetting) {
1099 return (intf->altsetting + alt_index);
1102 /*------------------------------------------------------------------------*
1105 * The following function searches up an USB interface by
1106 * "bInterfaceNumber". If no match is found, NULL is returned.
1107 *------------------------------------------------------------------------*/
1108 struct usb_interface *
1109 usb_ifnum_to_if(struct usb_device *dev, uint8_t iface_no)
1111 struct usb_interface *p_ui;
1113 for (p_ui = dev->linux_iface_start;
1114 p_ui != dev->linux_iface_end;
1116 if ((p_ui->num_altsetting > 0) &&
1117 (p_ui->altsetting->desc.bInterfaceNumber == iface_no)) {
1124 /*------------------------------------------------------------------------*
1126 *------------------------------------------------------------------------*/
1128 usb_buffer_alloc(struct usb_device *dev, usb_size_t size, uint16_t mem_flags, uint8_t *dma_addr)
1130 return (malloc(size, M_USBDEV, M_WAITOK | M_ZERO));
1133 /*------------------------------------------------------------------------*
1135 *------------------------------------------------------------------------*/
1137 usbd_get_intfdata(struct usb_interface *intf)
1139 return (intf->bsd_priv_sc);
1142 /*------------------------------------------------------------------------*
1143 * usb_linux_register
1145 * The following function is used by the "USB_DRIVER_EXPORT()" macro,
1146 * and is used to register a Linux USB driver, so that its
1147 * "usb_device_id" structures gets searched a probe time. This
1148 * function is not part of the Linux USB API, and is for internal use
1150 *------------------------------------------------------------------------*/
1152 usb_linux_register(void *arg)
1154 struct usb_driver *drv = arg;
1157 LIST_INSERT_HEAD(&usb_linux_driver_list, drv, linux_driver_list);
1160 usb_needs_explore_all();
1163 /*------------------------------------------------------------------------*
1164 * usb_linux_deregister
1166 * The following function is used by the "USB_DRIVER_EXPORT()" macro,
1167 * and is used to deregister a Linux USB driver. This function will
1168 * ensure that all driver instances belonging to the Linux USB device
1169 * driver in question, gets detached before the driver is
1170 * unloaded. This function is not part of the Linux USB API, and is
1171 * for internal use only.
1172 *------------------------------------------------------------------------*/
1174 usb_linux_deregister(void *arg)
1176 struct usb_driver *drv = arg;
1177 struct usb_linux_softc *sc;
1181 LIST_FOREACH(sc, &usb_linux_attached_list, sc_attached_list) {
1182 if (sc->sc_udrv == drv) {
1184 device_detach(sc->sc_fbsd_dev);
1188 LIST_REMOVE(drv, linux_driver_list);
1192 /*------------------------------------------------------------------------*
1193 * usb_linux_free_device
1195 * The following function is only used by the FreeBSD USB stack, to
1196 * cleanup and free memory after that a Linux USB device was attached.
1197 *------------------------------------------------------------------------*/
1199 usb_linux_free_device(struct usb_device *dev)
1201 struct usb_host_endpoint *uhe;
1202 struct usb_host_endpoint *uhe_end;
1205 uhe = dev->linux_endpoint_start;
1206 uhe_end = dev->linux_endpoint_end;
1207 while (uhe != uhe_end) {
1208 err = usb_setup_endpoint(dev, uhe, 0);
1211 err = usb_setup_endpoint(dev, &dev->ep0, 0);
1212 free(dev->linux_endpoint_start, M_USBDEV);
1215 /*------------------------------------------------------------------------*
1217 *------------------------------------------------------------------------*/
1219 usb_buffer_free(struct usb_device *dev, usb_size_t size,
1220 void *addr, uint8_t dma_addr)
1222 free(addr, M_USBDEV);
1225 /*------------------------------------------------------------------------*
1227 *------------------------------------------------------------------------*/
1229 usb_free_urb(struct urb *urb)
1234 /* make sure that the current URB is not active */
1237 /* destroy condition variable */
1238 cv_destroy(&urb->cv_wait);
1241 free(urb, M_USBDEV);
1244 /*------------------------------------------------------------------------*
1247 * The following function can be used to initialize a custom URB. It
1248 * is not recommended to use this function. Use "usb_alloc_urb()"
1250 *------------------------------------------------------------------------*/
1252 usb_init_urb(struct urb *urb)
1257 memset(urb, 0, sizeof(*urb));
1260 /*------------------------------------------------------------------------*
1262 *------------------------------------------------------------------------*/
1264 usb_kill_urb(struct urb *urb)
1266 usb_unlink_urb_sub(urb, 1);
1269 /*------------------------------------------------------------------------*
1272 * The following function sets the per Linux USB interface private
1273 * data pointer. It is used by most Linux USB device drivers.
1274 *------------------------------------------------------------------------*/
1276 usb_set_intfdata(struct usb_interface *intf, void *data)
1278 intf->bsd_priv_sc = data;
1281 /*------------------------------------------------------------------------*
1282 * usb_linux_cleanup_interface
1284 * The following function will release all FreeBSD USB transfers
1285 * associated with a Linux USB interface. It is for internal use only.
1286 *------------------------------------------------------------------------*/
1288 usb_linux_cleanup_interface(struct usb_device *dev, struct usb_interface *iface)
1290 struct usb_host_interface *uhi;
1291 struct usb_host_interface *uhi_end;
1292 struct usb_host_endpoint *uhe;
1293 struct usb_host_endpoint *uhe_end;
1296 uhi = iface->altsetting;
1297 uhi_end = iface->altsetting + iface->num_altsetting;
1298 while (uhi != uhi_end) {
1299 uhe = uhi->endpoint;
1300 uhe_end = uhi->endpoint + uhi->desc.bNumEndpoints;
1301 while (uhe != uhe_end) {
1302 err = usb_setup_endpoint(dev, uhe, 0);
1309 /*------------------------------------------------------------------------*
1310 * usb_linux_wait_complete
1312 * The following function is used by "usb_start_wait_urb()" to wake it
1313 * up, when an USB transfer has finished.
1314 *------------------------------------------------------------------------*/
1316 usb_linux_wait_complete(struct urb *urb)
1318 if (urb->transfer_flags & URB_IS_SLEEPING) {
1319 cv_signal(&urb->cv_wait);
1321 urb->transfer_flags &= ~URB_WAIT_WAKEUP;
1324 /*------------------------------------------------------------------------*
1325 * usb_linux_complete
1326 *------------------------------------------------------------------------*/
1328 usb_linux_complete(struct usb_xfer *xfer)
1332 urb = usbd_xfer_get_priv(xfer);
1333 usbd_xfer_set_priv(xfer, NULL);
1334 if (urb->complete) {
1335 (urb->complete) (urb);
1339 /*------------------------------------------------------------------------*
1340 * usb_linux_isoc_callback
1342 * The following is the FreeBSD isochronous USB callback. Isochronous
1343 * frames are USB packets transferred 1000 or 8000 times per second,
1344 * depending on whether a full- or high- speed USB transfer is
1346 *------------------------------------------------------------------------*/
1348 usb_linux_isoc_callback(struct usb_xfer *xfer, usb_error_t error)
1350 usb_frlength_t max_frame = xfer->max_frame_size;
1351 usb_frlength_t offset;
1353 struct urb *urb = usbd_xfer_get_priv(xfer);
1354 struct usb_host_endpoint *uhe = usbd_xfer_softc(xfer);
1355 struct usb_iso_packet_descriptor *uipd;
1359 switch (USB_GET_STATE(xfer)) {
1360 case USB_ST_TRANSFERRED:
1362 if (urb->bsd_isread) {
1364 /* copy in data with regard to the URB */
1368 for (x = 0; x < urb->number_of_packets; x++) {
1369 uipd = urb->iso_frame_desc + x;
1370 if (uipd->length > xfer->frlengths[x]) {
1371 if (urb->transfer_flags & URB_SHORT_NOT_OK) {
1372 /* XXX should be EREMOTEIO */
1373 uipd->status = -EPIPE;
1380 uipd->actual_length = xfer->frlengths[x];
1381 if (!xfer->flags.ext_buffer) {
1382 usbd_copy_out(xfer->frbuffers, offset,
1383 USB_ADD_BYTES(urb->transfer_buffer,
1384 uipd->offset), uipd->actual_length);
1386 offset += max_frame;
1389 for (x = 0; x < urb->number_of_packets; x++) {
1390 uipd = urb->iso_frame_desc + x;
1391 uipd->actual_length = xfer->frlengths[x];
1396 urb->actual_length = xfer->actlen;
1398 /* check for short transfer */
1399 if (xfer->actlen < xfer->sumlen) {
1400 /* short transfer */
1401 if (urb->transfer_flags & URB_SHORT_NOT_OK) {
1402 /* XXX should be EREMOTEIO */
1403 urb->status = -EPIPE;
1413 usb_linux_complete(xfer);
1418 if (xfer->priv_fifo == NULL) {
1420 /* get next transfer */
1421 urb = TAILQ_FIRST(&uhe->bsd_urb_list);
1426 TAILQ_REMOVE(&uhe->bsd_urb_list, urb, bsd_urb_list);
1427 urb->bsd_urb_list.tqe_prev = NULL;
1429 x = xfer->max_frame_count;
1430 if (urb->number_of_packets > x) {
1431 /* XXX simply truncate the transfer */
1432 urb->number_of_packets = x;
1435 DPRINTF("Already got a transfer\n");
1437 /* already got a transfer (should not happen) */
1438 urb = usbd_xfer_get_priv(xfer);
1441 urb->bsd_isread = (uhe->desc.bEndpointAddress & UE_DIR_IN) ? 1 : 0;
1443 if (xfer->flags.ext_buffer) {
1444 /* set virtual address to load */
1445 usbd_xfer_set_frame_data(xfer, 0, urb->transfer_buffer, 0);
1447 if (!(urb->bsd_isread)) {
1449 /* copy out data with regard to the URB */
1453 for (x = 0; x < urb->number_of_packets; x++) {
1454 uipd = urb->iso_frame_desc + x;
1455 usbd_xfer_set_frame_len(xfer, x, uipd->length);
1456 if (!xfer->flags.ext_buffer) {
1457 usbd_copy_in(xfer->frbuffers, offset,
1458 USB_ADD_BYTES(urb->transfer_buffer,
1459 uipd->offset), uipd->length);
1461 offset += uipd->length;
1466 * compute the transfer length into the "offset"
1470 offset = urb->number_of_packets * max_frame;
1472 /* setup "frlengths" array */
1474 for (x = 0; x < urb->number_of_packets; x++) {
1475 uipd = urb->iso_frame_desc + x;
1476 usbd_xfer_set_frame_len(xfer, x, max_frame);
1479 usbd_xfer_set_priv(xfer, urb);
1480 xfer->flags.force_short_xfer = 0;
1481 xfer->timeout = urb->timeout;
1482 xfer->nframes = urb->number_of_packets;
1483 usbd_transfer_submit(xfer);
1486 default: /* Error */
1487 if (xfer->error == USB_ERR_CANCELLED) {
1488 urb->status = -ECONNRESET;
1490 urb->status = -EPIPE; /* stalled */
1493 /* Set zero for "actual_length" */
1494 urb->actual_length = 0;
1496 /* Set zero for "actual_length" */
1497 for (x = 0; x < urb->number_of_packets; x++) {
1498 urb->iso_frame_desc[x].actual_length = 0;
1499 urb->iso_frame_desc[x].status = urb->status;
1503 usb_linux_complete(xfer);
1505 if (xfer->error == USB_ERR_CANCELLED) {
1506 /* we need to return in this case */
1514 /*------------------------------------------------------------------------*
1515 * usb_linux_non_isoc_callback
1517 * The following is the FreeBSD BULK/INTERRUPT and CONTROL USB
1518 * callback. It dequeues Linux USB stack compatible URB's, transforms
1519 * the URB fields into a FreeBSD USB transfer, and defragments the USB
1520 * transfer as required. When the transfer is complete the "complete"
1521 * callback is called.
1522 *------------------------------------------------------------------------*/
1524 usb_linux_non_isoc_callback(struct usb_xfer *xfer, usb_error_t error)
1527 REQ_SIZE = sizeof(struct usb_device_request)
1529 struct urb *urb = usbd_xfer_get_priv(xfer);
1530 struct usb_host_endpoint *uhe = usbd_xfer_softc(xfer);
1532 usb_frlength_t max_bulk = usbd_xfer_max_len(xfer);
1533 uint8_t data_frame = xfer->flags_int.control_xfr ? 1 : 0;
1537 switch (USB_GET_STATE(xfer)) {
1538 case USB_ST_TRANSFERRED:
1540 if (xfer->flags_int.control_xfr) {
1542 /* don't transfer the setup packet again: */
1544 usbd_xfer_set_frame_len(xfer, 0, 0);
1546 if (urb->bsd_isread && (!xfer->flags.ext_buffer)) {
1547 /* copy in data with regard to the URB */
1548 usbd_copy_out(xfer->frbuffers + data_frame, 0,
1549 urb->bsd_data_ptr, xfer->frlengths[data_frame]);
1551 urb->bsd_length_rem -= xfer->frlengths[data_frame];
1552 urb->bsd_data_ptr += xfer->frlengths[data_frame];
1553 urb->actual_length += xfer->frlengths[data_frame];
1555 /* check for short transfer */
1556 if (xfer->actlen < xfer->sumlen) {
1557 urb->bsd_length_rem = 0;
1559 /* short transfer */
1560 if (urb->transfer_flags & URB_SHORT_NOT_OK) {
1561 urb->status = -EPIPE;
1566 /* check remainder */
1567 if (urb->bsd_length_rem > 0) {
1575 usb_linux_complete(xfer);
1579 /* get next transfer */
1580 urb = TAILQ_FIRST(&uhe->bsd_urb_list);
1585 TAILQ_REMOVE(&uhe->bsd_urb_list, urb, bsd_urb_list);
1586 urb->bsd_urb_list.tqe_prev = NULL;
1588 usbd_xfer_set_priv(xfer, urb);
1589 xfer->flags.force_short_xfer = 0;
1590 xfer->timeout = urb->timeout;
1592 if (xfer->flags_int.control_xfr) {
1595 * USB control transfers need special handling.
1596 * First copy in the header, then copy in data!
1598 if (!xfer->flags.ext_buffer) {
1599 usbd_copy_in(xfer->frbuffers, 0,
1600 urb->setup_packet, REQ_SIZE);
1601 usbd_xfer_set_frame_len(xfer, 0, REQ_SIZE);
1603 /* set virtual address to load */
1604 usbd_xfer_set_frame_data(xfer, 0,
1605 urb->setup_packet, REQ_SIZE);
1608 ptr = urb->setup_packet;
1610 /* setup data transfer direction and length */
1611 urb->bsd_isread = (ptr[0] & UT_READ) ? 1 : 0;
1612 urb->bsd_length_rem = ptr[6] | (ptr[7] << 8);
1616 /* setup data transfer direction */
1618 urb->bsd_length_rem = urb->transfer_buffer_length;
1619 urb->bsd_isread = (uhe->desc.bEndpointAddress &
1623 urb->bsd_data_ptr = urb->transfer_buffer;
1624 urb->actual_length = 0;
1627 if (max_bulk > urb->bsd_length_rem) {
1628 max_bulk = urb->bsd_length_rem;
1630 /* check if we need to force a short transfer */
1632 if ((max_bulk == urb->bsd_length_rem) &&
1633 (urb->transfer_flags & URB_ZERO_PACKET) &&
1634 (!xfer->flags_int.control_xfr)) {
1635 xfer->flags.force_short_xfer = 1;
1637 /* check if we need to copy in data */
1639 if (xfer->flags.ext_buffer) {
1640 /* set virtual address to load */
1641 usbd_xfer_set_frame_data(xfer, data_frame,
1642 urb->bsd_data_ptr, max_bulk);
1643 } else if (!urb->bsd_isread) {
1644 /* copy out data with regard to the URB */
1645 usbd_copy_in(xfer->frbuffers + data_frame, 0,
1646 urb->bsd_data_ptr, max_bulk);
1647 usbd_xfer_set_frame_len(xfer, data_frame, max_bulk);
1649 if (xfer->flags_int.control_xfr) {
1658 usbd_transfer_submit(xfer);
1662 if (xfer->error == USB_ERR_CANCELLED) {
1663 urb->status = -ECONNRESET;
1665 urb->status = -EPIPE;
1668 /* Set zero for "actual_length" */
1669 urb->actual_length = 0;
1672 usb_linux_complete(xfer);
1674 if (xfer->error == USB_ERR_CANCELLED) {
1675 /* we need to return in this case */
1682 /*------------------------------------------------------------------------*
1684 *------------------------------------------------------------------------*/
1686 usb_fill_bulk_urb(struct urb *urb, struct usb_device *udev,
1687 struct usb_host_endpoint *uhe, void *buf,
1688 int length, usb_complete_t callback, void *arg)
1691 urb->endpoint = uhe;
1692 urb->transfer_buffer = buf;
1693 urb->transfer_buffer_length = length;
1694 urb->complete = callback;
1698 /*------------------------------------------------------------------------*
1701 * NOTE: This function can also be used for interrupt endpoints!
1706 *------------------------------------------------------------------------*/
1708 usb_bulk_msg(struct usb_device *udev, struct usb_host_endpoint *uhe,
1709 void *data, int len, uint16_t *pactlen, usb_timeout_t timeout)
1719 err = usb_setup_endpoint(udev, uhe, 4096 /* bytes */);
1723 urb = usb_alloc_urb(0, 0);
1727 usb_fill_bulk_urb(urb, udev, uhe, data, len,
1728 usb_linux_wait_complete, NULL);
1730 err = usb_start_wait_urb(urb, timeout, pactlen);