3 * Copyright (c) 2009 Sylvestre Gallon. All rights reserved.
4 * Copyright (c) 2009 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 LIBUSB_GLOBAL_INCLUDE_FILE
29 #include LIBUSB_GLOBAL_INCLUDE_FILE
40 #include <sys/fcntl.h>
41 #include <sys/ioctl.h>
42 #include <sys/queue.h>
43 #include <sys/endian.h>
46 #define libusb_device_handle libusb20_device
49 #include "libusb20_desc.h"
50 #include "libusb20_int.h"
54 static pthread_mutex_t default_context_lock = PTHREAD_MUTEX_INITIALIZER;
55 struct libusb_context *usbi_default_context = NULL;
59 static struct libusb20_transfer *libusb10_get_transfer(struct libusb20_device *, uint8_t, uint8_t);
60 static int libusb10_get_buffsize(struct libusb20_device *, libusb_transfer *);
61 static int libusb10_convert_error(uint8_t status);
62 static void libusb10_complete_transfer(struct libusb20_transfer *, struct libusb_super_transfer *, int);
63 static void libusb10_isoc_proxy(struct libusb20_transfer *);
64 static void libusb10_bulk_intr_proxy(struct libusb20_transfer *);
65 static void libusb10_ctrl_proxy(struct libusb20_transfer *);
66 static void libusb10_submit_transfer_sub(struct libusb20_device *, uint8_t);
68 /* Library initialisation / deinitialisation */
71 libusb_set_debug(libusb_context *ctx, int level)
73 ctx = GET_CONTEXT(ctx);
79 libusb_set_nonblocking(int f)
84 * We ignore any failures in this function, hence the
85 * non-blocking flag is not critical to the operation of
86 * libUSB. We use F_GETFL and F_SETFL to be compatible with
90 flags = fcntl(f, F_GETFL, NULL);
94 fcntl(f, F_SETFL, flags);
98 libusb_init(libusb_context **context)
100 struct libusb_context *ctx;
101 pthread_condattr_t attr;
105 ctx = malloc(sizeof(*ctx));
107 return (LIBUSB_ERROR_INVALID_PARAM);
109 memset(ctx, 0, sizeof(*ctx));
111 debug = getenv("LIBUSB_DEBUG");
113 ctx->debug = atoi(debug);
115 ctx->debug_fixed = 1;
117 TAILQ_INIT(&ctx->pollfds);
118 TAILQ_INIT(&ctx->tr_done);
120 if (pthread_mutex_init(&ctx->ctx_lock, NULL) != 0) {
122 return (LIBUSB_ERROR_NO_MEM);
124 if (pthread_condattr_init(&attr) != 0) {
125 pthread_mutex_destroy(&ctx->ctx_lock);
127 return (LIBUSB_ERROR_NO_MEM);
129 if (pthread_condattr_setclock(&attr, CLOCK_MONOTONIC) != 0) {
130 pthread_mutex_destroy(&ctx->ctx_lock);
131 pthread_condattr_destroy(&attr);
133 return (LIBUSB_ERROR_OTHER);
135 if (pthread_cond_init(&ctx->ctx_cond, &attr) != 0) {
136 pthread_mutex_destroy(&ctx->ctx_lock);
137 pthread_condattr_destroy(&attr);
139 return (LIBUSB_ERROR_NO_MEM);
141 pthread_condattr_destroy(&attr);
143 ctx->ctx_handler = NO_THREAD;
145 ret = pipe(ctx->ctrl_pipe);
147 pthread_mutex_destroy(&ctx->ctx_lock);
148 pthread_cond_destroy(&ctx->ctx_cond);
150 return (LIBUSB_ERROR_OTHER);
152 /* set non-blocking mode on the control pipe to avoid deadlock */
153 libusb_set_nonblocking(ctx->ctrl_pipe[0]);
154 libusb_set_nonblocking(ctx->ctrl_pipe[1]);
156 libusb10_add_pollfd(ctx, &ctx->ctx_poll, NULL, ctx->ctrl_pipe[0], POLLIN);
158 pthread_mutex_lock(&default_context_lock);
159 if (usbi_default_context == NULL) {
160 usbi_default_context = ctx;
162 pthread_mutex_unlock(&default_context_lock);
167 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_init complete");
173 libusb_exit(libusb_context *ctx)
175 ctx = GET_CONTEXT(ctx);
180 /* XXX cleanup devices */
182 libusb10_remove_pollfd(ctx, &ctx->ctx_poll);
183 close(ctx->ctrl_pipe[0]);
184 close(ctx->ctrl_pipe[1]);
185 pthread_mutex_destroy(&ctx->ctx_lock);
186 pthread_cond_destroy(&ctx->ctx_cond);
188 pthread_mutex_lock(&default_context_lock);
189 if (ctx == usbi_default_context) {
190 usbi_default_context = NULL;
192 pthread_mutex_unlock(&default_context_lock);
197 /* Device handling and initialisation. */
200 libusb_get_device_list(libusb_context *ctx, libusb_device ***list)
202 struct libusb20_backend *usb_backend;
203 struct libusb20_device *pdev;
204 struct libusb_device *dev;
207 ctx = GET_CONTEXT(ctx);
210 return (LIBUSB_ERROR_INVALID_PARAM);
213 return (LIBUSB_ERROR_INVALID_PARAM);
215 usb_backend = libusb20_be_alloc_default();
216 if (usb_backend == NULL)
217 return (LIBUSB_ERROR_NO_MEM);
219 /* figure out how many USB devices are present */
222 while ((pdev = libusb20_be_device_foreach(usb_backend, pdev)))
225 /* allocate device pointer list */
226 *list = malloc((i + 1) * sizeof(void *));
228 libusb20_be_free(usb_backend);
229 return (LIBUSB_ERROR_NO_MEM);
231 /* create libusb v1.0 compliant devices */
233 while ((pdev = libusb20_be_device_foreach(usb_backend, NULL))) {
235 dev = malloc(sizeof(*dev));
238 libusb_unref_device((*list)[i - 1]);
243 libusb20_be_free(usb_backend);
244 return (LIBUSB_ERROR_NO_MEM);
246 /* get device into libUSB v1.0 list */
247 libusb20_be_dequeue_device(usb_backend, pdev);
249 memset(dev, 0, sizeof(*dev));
251 /* init transfer queues */
252 TAILQ_INIT(&dev->tr_head);
254 /* set context we belong to */
257 /* link together the two structures */
259 pdev->privLuData = dev;
261 (*list)[i] = libusb_ref_device(dev);
266 libusb20_be_free(usb_backend);
271 libusb_free_device_list(libusb_device **list, int unref_devices)
276 return; /* be NULL safe */
279 for (i = 0; list[i] != NULL; i++)
280 libusb_unref_device(list[i]);
286 libusb_get_bus_number(libusb_device *dev)
289 return (0); /* should not happen */
290 return (libusb20_dev_get_bus_number(dev->os_priv));
294 libusb_get_port_numbers(libusb_device *dev, uint8_t *buf, uint8_t bufsize)
296 return (libusb20_dev_get_port_path(dev->os_priv, buf, bufsize));
300 libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *buf,
303 return (libusb20_dev_get_port_path(dev->os_priv, buf, bufsize));
307 libusb_get_device_address(libusb_device *dev)
310 return (0); /* should not happen */
311 return (libusb20_dev_get_address(dev->os_priv));
315 libusb_get_device_speed(libusb_device *dev)
318 return (LIBUSB_SPEED_UNKNOWN); /* should not happen */
320 switch (libusb20_dev_get_speed(dev->os_priv)) {
321 case LIBUSB20_SPEED_LOW:
322 return (LIBUSB_SPEED_LOW);
323 case LIBUSB20_SPEED_FULL:
324 return (LIBUSB_SPEED_FULL);
325 case LIBUSB20_SPEED_HIGH:
326 return (LIBUSB_SPEED_HIGH);
327 case LIBUSB20_SPEED_SUPER:
328 return (LIBUSB_SPEED_SUPER);
332 return (LIBUSB_SPEED_UNKNOWN);
336 libusb_get_max_packet_size(libusb_device *dev, uint8_t endpoint)
338 struct libusb_config_descriptor *pdconf;
339 struct libusb_interface *pinf;
340 struct libusb_interface_descriptor *pdinf;
341 struct libusb_endpoint_descriptor *pdend;
348 return (LIBUSB_ERROR_NO_DEVICE);
350 ret = libusb_get_active_config_descriptor(dev, &pdconf);
354 ret = LIBUSB_ERROR_NOT_FOUND;
355 for (i = 0; i < pdconf->bNumInterfaces; i++) {
356 pinf = &pdconf->interface[i];
357 for (j = 0; j < pinf->num_altsetting; j++) {
358 pdinf = &pinf->altsetting[j];
359 for (k = 0; k < pdinf->bNumEndpoints; k++) {
360 pdend = &pdinf->endpoint[k];
361 if (pdend->bEndpointAddress == endpoint) {
362 ret = pdend->wMaxPacketSize;
370 libusb_free_config_descriptor(pdconf);
375 libusb_get_max_iso_packet_size(libusb_device *dev, uint8_t endpoint)
380 ret = libusb_get_max_packet_size(dev, endpoint);
382 switch (libusb20_dev_get_speed(dev->os_priv)) {
383 case LIBUSB20_SPEED_LOW:
384 case LIBUSB20_SPEED_FULL:
388 multiplier = (1 + ((ret >> 11) & 3));
391 ret = (ret & 0x7FF) * multiplier;
399 libusb_ref_device(libusb_device *dev)
402 return (NULL); /* be NULL safe */
406 CTX_UNLOCK(dev->ctx);
412 libusb_unref_device(libusb_device *dev)
415 return; /* be NULL safe */
419 CTX_UNLOCK(dev->ctx);
421 if (dev->refcnt == 0) {
422 libusb20_dev_free(dev->os_priv);
428 libusb_open(libusb_device *dev, libusb_device_handle **devh)
430 libusb_context *ctx = dev->ctx;
431 struct libusb20_device *pdev = dev->os_priv;
436 return (LIBUSB_ERROR_INVALID_PARAM);
438 /* set default device handle value */
441 dev = libusb_ref_device(dev);
443 return (LIBUSB_ERROR_INVALID_PARAM);
445 err = libusb20_dev_open(pdev, 16 * 4 /* number of endpoints */ );
447 libusb_unref_device(dev);
448 return (LIBUSB_ERROR_NO_MEM);
450 libusb10_add_pollfd(ctx, &dev->dev_poll, pdev, libusb20_dev_get_fd(pdev), POLLIN |
451 POLLOUT | POLLRDNORM | POLLWRNORM);
453 /* make sure our event loop detects the new device */
455 err = write(ctx->ctrl_pipe[1], &dummy, sizeof(dummy));
456 if (err < (int)sizeof(dummy)) {
457 /* ignore error, if any */
458 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_open write failed!");
465 libusb_device_handle *
466 libusb_open_device_with_vid_pid(libusb_context *ctx, uint16_t vendor_id,
469 struct libusb_device **devs;
470 struct libusb20_device *pdev;
471 struct LIBUSB20_DEVICE_DESC_DECODED *pdesc;
475 ctx = GET_CONTEXT(ctx);
477 return (NULL); /* be NULL safe */
479 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_open_device_width_vid_pid enter");
481 if ((i = libusb_get_device_list(ctx, &devs)) < 0)
485 for (j = 0; j < i; j++) {
486 struct libusb20_device *tdev;
488 tdev = devs[j]->os_priv;
489 pdesc = libusb20_dev_get_device_desc(tdev);
491 * NOTE: The USB library will automatically swap the
492 * fields in the device descriptor to be of host
495 if (pdesc->idVendor == vendor_id &&
496 pdesc->idProduct == product_id) {
497 libusb_open(devs[j], &pdev);
502 libusb_free_device_list(devs, 1);
503 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_open_device_width_vid_pid leave");
508 libusb_close(struct libusb20_device *pdev)
511 struct libusb_device *dev;
516 return; /* be NULL safe */
518 dev = libusb_get_device(pdev);
521 libusb10_remove_pollfd(ctx, &dev->dev_poll);
523 libusb20_dev_close(pdev);
525 /* unref will free the "pdev" when the refcount reaches zero */
526 libusb_unref_device(dev);
528 /* make sure our event loop detects the closed device */
530 err = write(ctx->ctrl_pipe[1], &dummy, sizeof(dummy));
531 if (err < (int)sizeof(dummy)) {
532 /* ignore error, if any */
533 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_close write failed!");
538 libusb_get_device(struct libusb20_device *pdev)
542 return ((libusb_device *)pdev->privLuData);
546 libusb_get_configuration(struct libusb20_device *pdev, int *config)
548 struct libusb20_config *pconf;
550 if (pdev == NULL || config == NULL)
551 return (LIBUSB_ERROR_INVALID_PARAM);
553 pconf = libusb20_dev_alloc_config(pdev, libusb20_dev_get_config_index(pdev));
555 return (LIBUSB_ERROR_NO_MEM);
557 *config = pconf->desc.bConfigurationValue;
565 libusb_set_configuration(struct libusb20_device *pdev, int configuration)
567 struct libusb20_config *pconf;
568 struct libusb_device *dev;
572 dev = libusb_get_device(pdev);
574 return (LIBUSB_ERROR_INVALID_PARAM);
576 if (configuration < 1) {
580 for (i = 0; i != 255; i++) {
583 pconf = libusb20_dev_alloc_config(pdev, i);
585 return (LIBUSB_ERROR_INVALID_PARAM);
586 found = (pconf->desc.bConfigurationValue
593 return (LIBUSB_ERROR_INVALID_PARAM);
598 libusb10_cancel_all_transfer(dev);
600 libusb10_remove_pollfd(dev->ctx, &dev->dev_poll);
602 err = libusb20_dev_set_config_index(pdev, i);
604 libusb10_add_pollfd(dev->ctx, &dev->dev_poll, pdev, libusb20_dev_get_fd(pdev), POLLIN |
605 POLLOUT | POLLRDNORM | POLLWRNORM);
607 return (err ? LIBUSB_ERROR_INVALID_PARAM : 0);
611 libusb_claim_interface(struct libusb20_device *pdev, int interface_number)
616 dev = libusb_get_device(pdev);
618 return (LIBUSB_ERROR_INVALID_PARAM);
620 if (interface_number < 0 || interface_number > 31)
621 return (LIBUSB_ERROR_INVALID_PARAM);
624 if (dev->claimed_interfaces & (1 << interface_number))
625 err = LIBUSB_ERROR_BUSY;
628 dev->claimed_interfaces |= (1 << interface_number);
629 CTX_UNLOCK(dev->ctx);
634 libusb_release_interface(struct libusb20_device *pdev, int interface_number)
639 dev = libusb_get_device(pdev);
641 return (LIBUSB_ERROR_INVALID_PARAM);
643 if (interface_number < 0 || interface_number > 31)
644 return (LIBUSB_ERROR_INVALID_PARAM);
647 if (!(dev->claimed_interfaces & (1 << interface_number)))
648 err = LIBUSB_ERROR_NOT_FOUND;
651 dev->claimed_interfaces &= ~(1 << interface_number);
652 CTX_UNLOCK(dev->ctx);
657 libusb_set_interface_alt_setting(struct libusb20_device *pdev,
658 int interface_number, int alternate_setting)
663 dev = libusb_get_device(pdev);
665 return (LIBUSB_ERROR_INVALID_PARAM);
667 if (interface_number < 0 || interface_number > 31)
668 return (LIBUSB_ERROR_INVALID_PARAM);
671 if (!(dev->claimed_interfaces & (1 << interface_number)))
672 err = LIBUSB_ERROR_NOT_FOUND;
673 CTX_UNLOCK(dev->ctx);
678 libusb10_cancel_all_transfer(dev);
680 libusb10_remove_pollfd(dev->ctx, &dev->dev_poll);
682 err = libusb20_dev_set_alt_index(pdev,
683 interface_number, alternate_setting);
685 libusb10_add_pollfd(dev->ctx, &dev->dev_poll,
686 pdev, libusb20_dev_get_fd(pdev),
687 POLLIN | POLLOUT | POLLRDNORM | POLLWRNORM);
689 return (err ? LIBUSB_ERROR_OTHER : 0);
692 static struct libusb20_transfer *
693 libusb10_get_transfer(struct libusb20_device *pdev,
694 uint8_t endpoint, uint8_t xfer_index)
696 xfer_index &= 1; /* double buffering */
698 xfer_index |= (endpoint & LIBUSB20_ENDPOINT_ADDRESS_MASK) * 4;
700 if (endpoint & LIBUSB20_ENDPOINT_DIR_MASK) {
701 /* this is an IN endpoint */
704 return (libusb20_tr_get_pointer(pdev, xfer_index));
708 libusb_clear_halt(struct libusb20_device *pdev, uint8_t endpoint)
710 struct libusb20_transfer *xfer;
711 struct libusb_device *dev;
714 xfer = libusb10_get_transfer(pdev, endpoint, 0);
716 return (LIBUSB_ERROR_INVALID_PARAM);
718 dev = libusb_get_device(pdev);
720 return (LIBUSB_ERROR_INVALID_PARAM);
723 err = libusb20_tr_open(xfer, 0, 1, endpoint);
724 CTX_UNLOCK(dev->ctx);
726 if (err != 0 && err != LIBUSB20_ERROR_BUSY)
727 return (LIBUSB_ERROR_OTHER);
729 libusb20_tr_clear_stall_sync(xfer);
731 /* check if we opened the transfer */
734 libusb20_tr_close(xfer);
735 CTX_UNLOCK(dev->ctx);
737 return (0); /* success */
741 libusb_reset_device(struct libusb20_device *pdev)
746 dev = libusb_get_device(pdev);
748 return (LIBUSB_ERROR_INVALID_PARAM);
750 libusb10_cancel_all_transfer(dev);
752 libusb10_remove_pollfd(dev->ctx, &dev->dev_poll);
754 err = libusb20_dev_reset(pdev);
756 libusb10_add_pollfd(dev->ctx, &dev->dev_poll,
757 pdev, libusb20_dev_get_fd(pdev),
758 POLLIN | POLLOUT | POLLRDNORM | POLLWRNORM);
760 return (err ? LIBUSB_ERROR_OTHER : 0);
764 libusb_check_connected(struct libusb20_device *pdev)
769 dev = libusb_get_device(pdev);
771 return (LIBUSB_ERROR_INVALID_PARAM);
773 err = libusb20_dev_check_connected(pdev);
775 return (err ? LIBUSB_ERROR_NO_DEVICE : 0);
779 libusb_kernel_driver_active(struct libusb20_device *pdev, int interface)
782 return (LIBUSB_ERROR_INVALID_PARAM);
784 if (libusb20_dev_kernel_driver_active(pdev, interface))
785 return (0); /* no kernel driver is active */
787 return (1); /* kernel driver is active */
791 libusb_get_driver_np(struct libusb20_device *pdev, int interface,
792 char *name, int namelen)
794 return (libusb_get_driver(pdev, interface, name, namelen));
798 libusb_get_driver(struct libusb20_device *pdev, int interface,
799 char *name, int namelen)
805 return (LIBUSB_ERROR_INVALID_PARAM);
807 return (LIBUSB_ERROR_INVALID_PARAM);
811 err = libusb20_dev_get_iface_desc(
812 pdev, interface, name, namelen);
815 return (LIBUSB_ERROR_OTHER);
817 /* we only want the driver name */
818 ptr = strstr(name, ":");
826 libusb_detach_kernel_driver_np(struct libusb20_device *pdev, int interface)
828 return (libusb_detach_kernel_driver(pdev, interface));
832 libusb_detach_kernel_driver(struct libusb20_device *pdev, int interface)
837 return (LIBUSB_ERROR_INVALID_PARAM);
839 err = libusb20_dev_detach_kernel_driver(
842 return (err ? LIBUSB_ERROR_OTHER : 0);
846 libusb_attach_kernel_driver(struct libusb20_device *pdev, int interface)
849 return (LIBUSB_ERROR_INVALID_PARAM);
850 /* stub - currently not supported by libusb20 */
854 /* Asynchronous device I/O */
856 struct libusb_transfer *
857 libusb_alloc_transfer(int iso_packets)
859 struct libusb_transfer *uxfer;
860 struct libusb_super_transfer *sxfer;
863 len = sizeof(struct libusb_transfer) +
864 sizeof(struct libusb_super_transfer) +
865 (iso_packets * sizeof(libusb_iso_packet_descriptor));
871 memset(sxfer, 0, len);
873 uxfer = (struct libusb_transfer *)(
874 ((uint8_t *)sxfer) + sizeof(*sxfer));
876 /* set default value */
877 uxfer->num_iso_packets = iso_packets;
883 libusb_free_transfer(struct libusb_transfer *uxfer)
885 struct libusb_super_transfer *sxfer;
888 return; /* be NULL safe */
890 /* check if we should free the transfer buffer */
891 if (uxfer->flags & LIBUSB_TRANSFER_FREE_BUFFER)
894 sxfer = (struct libusb_super_transfer *)(
895 (uint8_t *)uxfer - sizeof(*sxfer));
901 libusb10_get_maxframe(struct libusb20_device *pdev, libusb_transfer *xfer)
905 switch (xfer->type) {
906 case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
907 ret = 60 | LIBUSB20_MAX_FRAME_PRE_SCALE; /* 60ms */
909 case LIBUSB_TRANSFER_TYPE_CONTROL:
920 libusb10_get_buffsize(struct libusb20_device *pdev, libusb_transfer *xfer)
925 usb_speed = libusb20_dev_get_speed(pdev);
927 switch (xfer->type) {
928 case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
929 ret = 0; /* kernel will auto-select */
931 case LIBUSB_TRANSFER_TYPE_CONTROL:
936 case LIBUSB20_SPEED_LOW:
939 case LIBUSB20_SPEED_FULL:
952 libusb10_convert_error(uint8_t status)
957 case LIBUSB20_TRANSFER_START:
958 case LIBUSB20_TRANSFER_COMPLETED:
959 return (LIBUSB_TRANSFER_COMPLETED);
960 case LIBUSB20_TRANSFER_OVERFLOW:
961 return (LIBUSB_TRANSFER_OVERFLOW);
962 case LIBUSB20_TRANSFER_NO_DEVICE:
963 return (LIBUSB_TRANSFER_NO_DEVICE);
964 case LIBUSB20_TRANSFER_STALL:
965 return (LIBUSB_TRANSFER_STALL);
966 case LIBUSB20_TRANSFER_CANCELLED:
967 return (LIBUSB_TRANSFER_CANCELLED);
968 case LIBUSB20_TRANSFER_TIMED_OUT:
969 return (LIBUSB_TRANSFER_TIMED_OUT);
971 return (LIBUSB_TRANSFER_ERROR);
975 /* This function must be called locked */
978 libusb10_complete_transfer(struct libusb20_transfer *pxfer,
979 struct libusb_super_transfer *sxfer, int status)
981 struct libusb_transfer *uxfer;
982 struct libusb_device *dev;
984 uxfer = (struct libusb_transfer *)(
985 ((uint8_t *)sxfer) + sizeof(*sxfer));
988 libusb20_tr_set_priv_sc1(pxfer, NULL);
990 /* set transfer status */
991 uxfer->status = status;
993 /* update super transfer state */
994 sxfer->state = LIBUSB_SUPER_XFER_ST_NONE;
996 dev = libusb_get_device(uxfer->dev_handle);
998 TAILQ_INSERT_TAIL(&dev->ctx->tr_done, sxfer, entry);
1001 /* This function must be called locked */
1004 libusb10_isoc_proxy(struct libusb20_transfer *pxfer)
1006 struct libusb_super_transfer *sxfer;
1007 struct libusb_transfer *uxfer;
1009 uint16_t iso_packets;
1014 status = libusb20_tr_get_status(pxfer);
1015 sxfer = libusb20_tr_get_priv_sc1(pxfer);
1016 actlen = libusb20_tr_get_actual_length(pxfer);
1017 iso_packets = libusb20_tr_get_max_frames(pxfer);
1020 return; /* cancelled - nothing to do */
1022 uxfer = (struct libusb_transfer *)(
1023 ((uint8_t *)sxfer) + sizeof(*sxfer));
1025 if (iso_packets > uxfer->num_iso_packets)
1026 iso_packets = uxfer->num_iso_packets;
1028 if (iso_packets == 0)
1029 return; /* nothing to do */
1031 /* make sure that the number of ISOCHRONOUS packets is valid */
1032 uxfer->num_iso_packets = iso_packets;
1034 flags = uxfer->flags;
1037 case LIBUSB20_TRANSFER_COMPLETED:
1039 /* update actual length */
1040 uxfer->actual_length = actlen;
1041 for (i = 0; i != iso_packets; i++) {
1042 uxfer->iso_packet_desc[i].actual_length =
1043 libusb20_tr_get_length(pxfer, i);
1045 libusb10_complete_transfer(pxfer, sxfer, LIBUSB_TRANSFER_COMPLETED);
1048 case LIBUSB20_TRANSFER_START:
1050 /* setup length(s) */
1052 for (i = 0; i != iso_packets; i++) {
1053 libusb20_tr_setup_isoc(pxfer,
1054 &uxfer->buffer[actlen],
1055 uxfer->iso_packet_desc[i].length, i);
1056 actlen += uxfer->iso_packet_desc[i].length;
1062 libusb20_tr_set_total_frames(pxfer, iso_packets);
1063 libusb20_tr_submit(pxfer);
1065 /* fork another USB transfer, if any */
1066 libusb10_submit_transfer_sub(libusb20_tr_get_priv_sc0(pxfer), uxfer->endpoint);
1070 libusb10_complete_transfer(pxfer, sxfer, libusb10_convert_error(status));
1075 /* This function must be called locked */
1078 libusb10_bulk_intr_proxy(struct libusb20_transfer *pxfer)
1080 struct libusb_super_transfer *sxfer;
1081 struct libusb_transfer *uxfer;
1087 status = libusb20_tr_get_status(pxfer);
1088 sxfer = libusb20_tr_get_priv_sc1(pxfer);
1089 max_bulk = libusb20_tr_get_max_total_length(pxfer);
1090 actlen = libusb20_tr_get_actual_length(pxfer);
1093 return; /* cancelled - nothing to do */
1095 uxfer = (struct libusb_transfer *)(
1096 ((uint8_t *)sxfer) + sizeof(*sxfer));
1098 flags = uxfer->flags;
1101 case LIBUSB20_TRANSFER_COMPLETED:
1103 uxfer->actual_length += actlen;
1105 /* check for short packet */
1106 if (sxfer->last_len != actlen) {
1107 if (flags & LIBUSB_TRANSFER_SHORT_NOT_OK) {
1108 libusb10_complete_transfer(pxfer, sxfer, LIBUSB_TRANSFER_ERROR);
1110 libusb10_complete_transfer(pxfer, sxfer, LIBUSB_TRANSFER_COMPLETED);
1114 /* check for end of data */
1115 if (sxfer->rem_len == 0) {
1116 libusb10_complete_transfer(pxfer, sxfer, LIBUSB_TRANSFER_COMPLETED);
1121 case LIBUSB20_TRANSFER_START:
1122 if (max_bulk > sxfer->rem_len) {
1123 max_bulk = sxfer->rem_len;
1125 /* setup new BULK or INTERRUPT transaction */
1126 libusb20_tr_setup_bulk(pxfer,
1127 sxfer->curr_data, max_bulk, uxfer->timeout);
1129 /* update counters */
1130 sxfer->last_len = max_bulk;
1131 sxfer->curr_data += max_bulk;
1132 sxfer->rem_len -= max_bulk;
1134 libusb20_tr_submit(pxfer);
1136 /* check if we can fork another USB transfer */
1137 if (sxfer->rem_len == 0)
1138 libusb10_submit_transfer_sub(libusb20_tr_get_priv_sc0(pxfer), uxfer->endpoint);
1142 libusb10_complete_transfer(pxfer, sxfer, libusb10_convert_error(status));
1147 /* This function must be called locked */
1150 libusb10_ctrl_proxy(struct libusb20_transfer *pxfer)
1152 struct libusb_super_transfer *sxfer;
1153 struct libusb_transfer *uxfer;
1159 status = libusb20_tr_get_status(pxfer);
1160 sxfer = libusb20_tr_get_priv_sc1(pxfer);
1161 max_bulk = libusb20_tr_get_max_total_length(pxfer);
1162 actlen = libusb20_tr_get_actual_length(pxfer);
1165 return; /* cancelled - nothing to do */
1167 uxfer = (struct libusb_transfer *)(
1168 ((uint8_t *)sxfer) + sizeof(*sxfer));
1170 flags = uxfer->flags;
1173 case LIBUSB20_TRANSFER_COMPLETED:
1175 uxfer->actual_length += actlen;
1177 /* subtract length of SETUP packet, if any */
1178 actlen -= libusb20_tr_get_length(pxfer, 0);
1180 /* check for short packet */
1181 if (sxfer->last_len != actlen) {
1182 if (flags & LIBUSB_TRANSFER_SHORT_NOT_OK) {
1183 libusb10_complete_transfer(pxfer, sxfer, LIBUSB_TRANSFER_ERROR);
1185 libusb10_complete_transfer(pxfer, sxfer, LIBUSB_TRANSFER_COMPLETED);
1189 /* check for end of data */
1190 if (sxfer->rem_len == 0) {
1191 libusb10_complete_transfer(pxfer, sxfer, LIBUSB_TRANSFER_COMPLETED);
1196 case LIBUSB20_TRANSFER_START:
1197 if (max_bulk > sxfer->rem_len) {
1198 max_bulk = sxfer->rem_len;
1200 /* setup new CONTROL transaction */
1201 if (status == LIBUSB20_TRANSFER_COMPLETED) {
1202 /* next fragment - don't send SETUP packet */
1203 libusb20_tr_set_length(pxfer, 0, 0);
1205 /* first fragment - send SETUP packet */
1206 libusb20_tr_set_length(pxfer, 8, 0);
1207 libusb20_tr_set_buffer(pxfer, uxfer->buffer, 0);
1210 if (max_bulk != 0) {
1211 libusb20_tr_set_length(pxfer, max_bulk, 1);
1212 libusb20_tr_set_buffer(pxfer, sxfer->curr_data, 1);
1213 libusb20_tr_set_total_frames(pxfer, 2);
1215 libusb20_tr_set_total_frames(pxfer, 1);
1218 /* update counters */
1219 sxfer->last_len = max_bulk;
1220 sxfer->curr_data += max_bulk;
1221 sxfer->rem_len -= max_bulk;
1223 libusb20_tr_submit(pxfer);
1225 /* check if we can fork another USB transfer */
1226 if (sxfer->rem_len == 0)
1227 libusb10_submit_transfer_sub(libusb20_tr_get_priv_sc0(pxfer), uxfer->endpoint);
1231 libusb10_complete_transfer(pxfer, sxfer, libusb10_convert_error(status));
1236 /* The following function must be called locked */
1239 libusb10_submit_transfer_sub(struct libusb20_device *pdev, uint8_t endpoint)
1241 struct libusb20_transfer *pxfer0;
1242 struct libusb20_transfer *pxfer1;
1243 struct libusb_super_transfer *sxfer;
1244 struct libusb_transfer *uxfer;
1245 struct libusb_device *dev;
1252 dev = libusb_get_device(pdev);
1254 pxfer0 = libusb10_get_transfer(pdev, endpoint, 0);
1255 pxfer1 = libusb10_get_transfer(pdev, endpoint, 1);
1257 if (pxfer0 == NULL || pxfer1 == NULL)
1258 return; /* shouldn't happen */
1261 if (libusb20_tr_pending(pxfer0))
1263 if (libusb20_tr_pending(pxfer1))
1268 /* wait till one of the transfers complete */
1271 sxfer = libusb20_tr_get_priv_sc1(pxfer1);
1273 return; /* cancelling */
1275 return; /* cannot queue another one */
1276 /* swap transfers */
1280 sxfer = libusb20_tr_get_priv_sc1(pxfer0);
1282 return; /* cancelling */
1284 return; /* cannot queue another one */
1285 /* swap transfers */
1292 /* find next transfer on same endpoint */
1293 TAILQ_FOREACH(sxfer, &dev->tr_head, entry) {
1295 uxfer = (struct libusb_transfer *)(
1296 ((uint8_t *)sxfer) + sizeof(*sxfer));
1298 if (uxfer->endpoint == endpoint) {
1299 TAILQ_REMOVE(&dev->tr_head, sxfer, entry);
1300 sxfer->entry.tqe_prev = NULL;
1304 return; /* success */
1308 libusb20_tr_set_priv_sc0(pxfer0, pdev);
1309 libusb20_tr_set_priv_sc1(pxfer0, sxfer);
1311 /* reset super transfer state */
1312 sxfer->rem_len = uxfer->length;
1313 sxfer->curr_data = uxfer->buffer;
1314 uxfer->actual_length = 0;
1316 switch (uxfer->type) {
1317 case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
1318 libusb20_tr_set_callback(pxfer0, libusb10_isoc_proxy);
1320 case LIBUSB_TRANSFER_TYPE_BULK:
1321 case LIBUSB_TRANSFER_TYPE_INTERRUPT:
1322 libusb20_tr_set_callback(pxfer0, libusb10_bulk_intr_proxy);
1324 case LIBUSB_TRANSFER_TYPE_CONTROL:
1325 libusb20_tr_set_callback(pxfer0, libusb10_ctrl_proxy);
1326 if (sxfer->rem_len < 8)
1329 /* remove SETUP packet from data */
1330 sxfer->rem_len -= 8;
1331 sxfer->curr_data += 8;
1337 buffsize = libusb10_get_buffsize(pdev, uxfer);
1338 maxframe = libusb10_get_maxframe(pdev, uxfer);
1340 /* make sure the transfer is opened */
1341 err = libusb20_tr_open(pxfer0, buffsize, maxframe, endpoint);
1342 if (err && (err != LIBUSB20_ERROR_BUSY)) {
1345 libusb20_tr_start(pxfer0);
1349 libusb10_complete_transfer(pxfer0, sxfer, LIBUSB_TRANSFER_ERROR);
1351 /* make sure our event loop spins the done handler */
1353 err = write(dev->ctx->ctrl_pipe[1], &dummy, sizeof(dummy));
1356 /* The following function must be called unlocked */
1359 libusb_submit_transfer(struct libusb_transfer *uxfer)
1361 struct libusb20_transfer *pxfer0;
1362 struct libusb20_transfer *pxfer1;
1363 struct libusb_super_transfer *sxfer;
1364 struct libusb_device *dev;
1369 return (LIBUSB_ERROR_INVALID_PARAM);
1371 if (uxfer->dev_handle == NULL)
1372 return (LIBUSB_ERROR_INVALID_PARAM);
1374 endpoint = uxfer->endpoint;
1376 dev = libusb_get_device(uxfer->dev_handle);
1378 DPRINTF(dev->ctx, LIBUSB_DEBUG_FUNCTION, "libusb_submit_transfer enter");
1380 sxfer = (struct libusb_super_transfer *)(
1381 (uint8_t *)uxfer - sizeof(*sxfer));
1385 pxfer0 = libusb10_get_transfer(uxfer->dev_handle, endpoint, 0);
1386 pxfer1 = libusb10_get_transfer(uxfer->dev_handle, endpoint, 1);
1388 if (pxfer0 == NULL || pxfer1 == NULL) {
1389 err = LIBUSB_ERROR_OTHER;
1390 } else if ((sxfer->entry.tqe_prev != NULL) ||
1391 (libusb20_tr_get_priv_sc1(pxfer0) == sxfer) ||
1392 (libusb20_tr_get_priv_sc1(pxfer1) == sxfer)) {
1393 err = LIBUSB_ERROR_BUSY;
1396 /* set pending state */
1397 sxfer->state = LIBUSB_SUPER_XFER_ST_PEND;
1399 /* insert transfer into transfer head list */
1400 TAILQ_INSERT_TAIL(&dev->tr_head, sxfer, entry);
1402 /* start work transfers */
1403 libusb10_submit_transfer_sub(
1404 uxfer->dev_handle, endpoint);
1406 err = 0; /* success */
1409 CTX_UNLOCK(dev->ctx);
1411 DPRINTF(dev->ctx, LIBUSB_DEBUG_FUNCTION, "libusb_submit_transfer leave %d", err);
1416 /* Asynchronous transfer cancel */
1419 libusb_cancel_transfer(struct libusb_transfer *uxfer)
1421 struct libusb20_transfer *pxfer0;
1422 struct libusb20_transfer *pxfer1;
1423 struct libusb_super_transfer *sxfer;
1424 struct libusb_device *dev;
1429 return (LIBUSB_ERROR_INVALID_PARAM);
1431 /* check if not initialised */
1432 if (uxfer->dev_handle == NULL)
1433 return (LIBUSB_ERROR_NOT_FOUND);
1435 endpoint = uxfer->endpoint;
1437 dev = libusb_get_device(uxfer->dev_handle);
1439 DPRINTF(dev->ctx, LIBUSB_DEBUG_FUNCTION, "libusb_cancel_transfer enter");
1441 sxfer = (struct libusb_super_transfer *)(
1442 (uint8_t *)uxfer - sizeof(*sxfer));
1448 pxfer0 = libusb10_get_transfer(uxfer->dev_handle, endpoint, 0);
1449 pxfer1 = libusb10_get_transfer(uxfer->dev_handle, endpoint, 1);
1451 if (sxfer->state != LIBUSB_SUPER_XFER_ST_PEND) {
1452 /* only update the transfer status */
1453 uxfer->status = LIBUSB_TRANSFER_CANCELLED;
1454 retval = LIBUSB_ERROR_NOT_FOUND;
1455 } else if (sxfer->entry.tqe_prev != NULL) {
1456 /* we are lucky - transfer is on a queue */
1457 TAILQ_REMOVE(&dev->tr_head, sxfer, entry);
1458 sxfer->entry.tqe_prev = NULL;
1459 libusb10_complete_transfer(NULL,
1460 sxfer, LIBUSB_TRANSFER_CANCELLED);
1461 } else if (pxfer0 == NULL || pxfer1 == NULL) {
1463 retval = LIBUSB_ERROR_NOT_FOUND;
1464 } else if (libusb20_tr_get_priv_sc1(pxfer0) == sxfer) {
1465 libusb10_complete_transfer(pxfer0,
1466 sxfer, LIBUSB_TRANSFER_CANCELLED);
1467 libusb20_tr_stop(pxfer0);
1468 /* make sure the queue doesn't stall */
1469 libusb10_submit_transfer_sub(
1470 uxfer->dev_handle, endpoint);
1471 } else if (libusb20_tr_get_priv_sc1(pxfer1) == sxfer) {
1472 libusb10_complete_transfer(pxfer1,
1473 sxfer, LIBUSB_TRANSFER_CANCELLED);
1474 libusb20_tr_stop(pxfer1);
1475 /* make sure the queue doesn't stall */
1476 libusb10_submit_transfer_sub(
1477 uxfer->dev_handle, endpoint);
1480 retval = LIBUSB_ERROR_NOT_FOUND;
1483 CTX_UNLOCK(dev->ctx);
1485 DPRINTF(dev->ctx, LIBUSB_DEBUG_FUNCTION, "libusb_cancel_transfer leave");
1491 libusb10_cancel_all_transfer(libusb_device *dev)
1497 libusb_cpu_to_le16(uint16_t x)
1499 return (htole16(x));
1503 libusb_le16_to_cpu(uint16_t x)
1505 return (le16toh(x));
1509 libusb_strerror(int code)
1512 case LIBUSB_SUCCESS:
1514 case LIBUSB_ERROR_IO:
1515 return ("I/O error");
1516 case LIBUSB_ERROR_INVALID_PARAM:
1517 return ("Invalid parameter");
1518 case LIBUSB_ERROR_ACCESS:
1519 return ("Permissions error");
1520 case LIBUSB_ERROR_NO_DEVICE:
1521 return ("No device");
1522 case LIBUSB_ERROR_NOT_FOUND:
1523 return ("Not found");
1524 case LIBUSB_ERROR_BUSY:
1525 return ("Device busy");
1526 case LIBUSB_ERROR_TIMEOUT:
1528 case LIBUSB_ERROR_OVERFLOW:
1529 return ("Overflow");
1530 case LIBUSB_ERROR_PIPE:
1531 return ("Pipe error");
1532 case LIBUSB_ERROR_INTERRUPTED:
1533 return ("Interrupted");
1534 case LIBUSB_ERROR_NO_MEM:
1535 return ("Out of memory");
1536 case LIBUSB_ERROR_NOT_SUPPORTED:
1537 return ("Not supported");
1538 case LIBUSB_ERROR_OTHER:
1539 return ("Other error");
1541 return ("Unknown error");
1546 libusb_error_name(int code)
1549 case LIBUSB_SUCCESS:
1550 return ("LIBUSB_SUCCESS");
1551 case LIBUSB_ERROR_IO:
1552 return ("LIBUSB_ERROR_IO");
1553 case LIBUSB_ERROR_INVALID_PARAM:
1554 return ("LIBUSB_ERROR_INVALID_PARAM");
1555 case LIBUSB_ERROR_ACCESS:
1556 return ("LIBUSB_ERROR_ACCESS");
1557 case LIBUSB_ERROR_NO_DEVICE:
1558 return ("LIBUSB_ERROR_NO_DEVICE");
1559 case LIBUSB_ERROR_NOT_FOUND:
1560 return ("LIBUSB_ERROR_NOT_FOUND");
1561 case LIBUSB_ERROR_BUSY:
1562 return ("LIBUSB_ERROR_BUSY");
1563 case LIBUSB_ERROR_TIMEOUT:
1564 return ("LIBUSB_ERROR_TIMEOUT");
1565 case LIBUSB_ERROR_OVERFLOW:
1566 return ("LIBUSB_ERROR_OVERFLOW");
1567 case LIBUSB_ERROR_PIPE:
1568 return ("LIBUSB_ERROR_PIPE");
1569 case LIBUSB_ERROR_INTERRUPTED:
1570 return ("LIBUSB_ERROR_INTERRUPTED");
1571 case LIBUSB_ERROR_NO_MEM:
1572 return ("LIBUSB_ERROR_NO_MEM");
1573 case LIBUSB_ERROR_NOT_SUPPORTED:
1574 return ("LIBUSB_ERROR_NOT_SUPPORTED");
1575 case LIBUSB_ERROR_OTHER:
1576 return ("LIBUSB_ERROR_OTHER");
1578 return ("LIBUSB_ERROR_UNKNOWN");