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)
615 dev = libusb_get_device(pdev);
617 return (LIBUSB_ERROR_INVALID_PARAM);
619 if (interface_number < 0 || interface_number > 31)
620 return (LIBUSB_ERROR_INVALID_PARAM);
623 dev->claimed_interfaces |= (1 << interface_number);
624 CTX_UNLOCK(dev->ctx);
630 libusb_release_interface(struct libusb20_device *pdev, int interface_number)
635 dev = libusb_get_device(pdev);
637 return (LIBUSB_ERROR_INVALID_PARAM);
639 if (interface_number < 0 || interface_number > 31)
640 return (LIBUSB_ERROR_INVALID_PARAM);
643 if (!(dev->claimed_interfaces & (1 << interface_number)))
644 err = LIBUSB_ERROR_NOT_FOUND;
647 dev->claimed_interfaces &= ~(1 << interface_number);
648 CTX_UNLOCK(dev->ctx);
653 libusb_set_interface_alt_setting(struct libusb20_device *pdev,
654 int interface_number, int alternate_setting)
659 dev = libusb_get_device(pdev);
661 return (LIBUSB_ERROR_INVALID_PARAM);
663 if (interface_number < 0 || interface_number > 31)
664 return (LIBUSB_ERROR_INVALID_PARAM);
667 if (!(dev->claimed_interfaces & (1 << interface_number)))
668 err = LIBUSB_ERROR_NOT_FOUND;
669 CTX_UNLOCK(dev->ctx);
674 libusb10_cancel_all_transfer(dev);
676 libusb10_remove_pollfd(dev->ctx, &dev->dev_poll);
678 err = libusb20_dev_set_alt_index(pdev,
679 interface_number, alternate_setting);
681 libusb10_add_pollfd(dev->ctx, &dev->dev_poll,
682 pdev, libusb20_dev_get_fd(pdev),
683 POLLIN | POLLOUT | POLLRDNORM | POLLWRNORM);
685 return (err ? LIBUSB_ERROR_OTHER : 0);
688 static struct libusb20_transfer *
689 libusb10_get_transfer(struct libusb20_device *pdev,
690 uint8_t endpoint, uint8_t xfer_index)
692 xfer_index &= 1; /* double buffering */
694 xfer_index |= (endpoint & LIBUSB20_ENDPOINT_ADDRESS_MASK) * 4;
696 if (endpoint & LIBUSB20_ENDPOINT_DIR_MASK) {
697 /* this is an IN endpoint */
700 return (libusb20_tr_get_pointer(pdev, xfer_index));
704 libusb_clear_halt(struct libusb20_device *pdev, uint8_t endpoint)
706 struct libusb20_transfer *xfer;
707 struct libusb_device *dev;
710 xfer = libusb10_get_transfer(pdev, endpoint, 0);
712 return (LIBUSB_ERROR_INVALID_PARAM);
714 dev = libusb_get_device(pdev);
716 return (LIBUSB_ERROR_INVALID_PARAM);
719 err = libusb20_tr_open(xfer, 0, 1, endpoint);
720 CTX_UNLOCK(dev->ctx);
722 if (err != 0 && err != LIBUSB20_ERROR_BUSY)
723 return (LIBUSB_ERROR_OTHER);
725 libusb20_tr_clear_stall_sync(xfer);
727 /* check if we opened the transfer */
730 libusb20_tr_close(xfer);
731 CTX_UNLOCK(dev->ctx);
733 return (0); /* success */
737 libusb_reset_device(struct libusb20_device *pdev)
742 dev = libusb_get_device(pdev);
744 return (LIBUSB_ERROR_INVALID_PARAM);
746 libusb10_cancel_all_transfer(dev);
748 libusb10_remove_pollfd(dev->ctx, &dev->dev_poll);
750 err = libusb20_dev_reset(pdev);
752 libusb10_add_pollfd(dev->ctx, &dev->dev_poll,
753 pdev, libusb20_dev_get_fd(pdev),
754 POLLIN | POLLOUT | POLLRDNORM | POLLWRNORM);
756 return (err ? LIBUSB_ERROR_OTHER : 0);
760 libusb_check_connected(struct libusb20_device *pdev)
765 dev = libusb_get_device(pdev);
767 return (LIBUSB_ERROR_INVALID_PARAM);
769 err = libusb20_dev_check_connected(pdev);
771 return (err ? LIBUSB_ERROR_NO_DEVICE : 0);
775 libusb_kernel_driver_active(struct libusb20_device *pdev, int interface)
778 return (LIBUSB_ERROR_INVALID_PARAM);
780 if (libusb20_dev_kernel_driver_active(pdev, interface))
781 return (0); /* no kernel driver is active */
783 return (1); /* kernel driver is active */
787 libusb_get_driver_np(struct libusb20_device *pdev, int interface,
788 char *name, int namelen)
790 return (libusb_get_driver(pdev, interface, name, namelen));
794 libusb_get_driver(struct libusb20_device *pdev, int interface,
795 char *name, int namelen)
801 return (LIBUSB_ERROR_INVALID_PARAM);
803 return (LIBUSB_ERROR_INVALID_PARAM);
807 err = libusb20_dev_get_iface_desc(
808 pdev, interface, name, namelen);
811 return (LIBUSB_ERROR_OTHER);
813 /* we only want the driver name */
814 ptr = strstr(name, ":");
822 libusb_detach_kernel_driver_np(struct libusb20_device *pdev, int interface)
824 return (libusb_detach_kernel_driver(pdev, interface));
828 libusb_detach_kernel_driver(struct libusb20_device *pdev, int interface)
833 return (LIBUSB_ERROR_INVALID_PARAM);
835 err = libusb20_dev_detach_kernel_driver(
838 return (err ? LIBUSB_ERROR_OTHER : 0);
842 libusb_attach_kernel_driver(struct libusb20_device *pdev, int interface)
845 return (LIBUSB_ERROR_INVALID_PARAM);
846 /* stub - currently not supported by libusb20 */
850 /* Asynchronous device I/O */
852 struct libusb_transfer *
853 libusb_alloc_transfer(int iso_packets)
855 struct libusb_transfer *uxfer;
856 struct libusb_super_transfer *sxfer;
859 len = sizeof(struct libusb_transfer) +
860 sizeof(struct libusb_super_transfer) +
861 (iso_packets * sizeof(libusb_iso_packet_descriptor));
867 memset(sxfer, 0, len);
869 uxfer = (struct libusb_transfer *)(
870 ((uint8_t *)sxfer) + sizeof(*sxfer));
872 /* set default value */
873 uxfer->num_iso_packets = iso_packets;
879 libusb_free_transfer(struct libusb_transfer *uxfer)
881 struct libusb_super_transfer *sxfer;
884 return; /* be NULL safe */
886 /* check if we should free the transfer buffer */
887 if (uxfer->flags & LIBUSB_TRANSFER_FREE_BUFFER)
890 sxfer = (struct libusb_super_transfer *)(
891 (uint8_t *)uxfer - sizeof(*sxfer));
897 libusb10_get_maxframe(struct libusb20_device *pdev, libusb_transfer *xfer)
901 switch (xfer->type) {
902 case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
903 ret = 60 | LIBUSB20_MAX_FRAME_PRE_SCALE; /* 60ms */
905 case LIBUSB_TRANSFER_TYPE_CONTROL:
916 libusb10_get_buffsize(struct libusb20_device *pdev, libusb_transfer *xfer)
921 usb_speed = libusb20_dev_get_speed(pdev);
923 switch (xfer->type) {
924 case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
925 ret = 0; /* kernel will auto-select */
927 case LIBUSB_TRANSFER_TYPE_CONTROL:
932 case LIBUSB20_SPEED_LOW:
935 case LIBUSB20_SPEED_FULL:
938 case LIBUSB20_SPEED_SUPER:
951 libusb10_convert_error(uint8_t status)
956 case LIBUSB20_TRANSFER_START:
957 case LIBUSB20_TRANSFER_COMPLETED:
958 return (LIBUSB_TRANSFER_COMPLETED);
959 case LIBUSB20_TRANSFER_OVERFLOW:
960 return (LIBUSB_TRANSFER_OVERFLOW);
961 case LIBUSB20_TRANSFER_NO_DEVICE:
962 return (LIBUSB_TRANSFER_NO_DEVICE);
963 case LIBUSB20_TRANSFER_STALL:
964 return (LIBUSB_TRANSFER_STALL);
965 case LIBUSB20_TRANSFER_CANCELLED:
966 return (LIBUSB_TRANSFER_CANCELLED);
967 case LIBUSB20_TRANSFER_TIMED_OUT:
968 return (LIBUSB_TRANSFER_TIMED_OUT);
970 return (LIBUSB_TRANSFER_ERROR);
974 /* This function must be called locked */
977 libusb10_complete_transfer(struct libusb20_transfer *pxfer,
978 struct libusb_super_transfer *sxfer, int status)
980 struct libusb_transfer *uxfer;
981 struct libusb_device *dev;
983 uxfer = (struct libusb_transfer *)(
984 ((uint8_t *)sxfer) + sizeof(*sxfer));
987 libusb20_tr_set_priv_sc1(pxfer, NULL);
989 /* set transfer status */
990 uxfer->status = status;
992 /* update super transfer state */
993 sxfer->state = LIBUSB_SUPER_XFER_ST_NONE;
995 dev = libusb_get_device(uxfer->dev_handle);
997 TAILQ_INSERT_TAIL(&dev->ctx->tr_done, sxfer, entry);
1000 /* This function must be called locked */
1003 libusb10_isoc_proxy(struct libusb20_transfer *pxfer)
1005 struct libusb_super_transfer *sxfer;
1006 struct libusb_transfer *uxfer;
1008 uint16_t iso_packets;
1012 status = libusb20_tr_get_status(pxfer);
1013 sxfer = libusb20_tr_get_priv_sc1(pxfer);
1014 actlen = libusb20_tr_get_actual_length(pxfer);
1015 iso_packets = libusb20_tr_get_max_frames(pxfer);
1018 return; /* cancelled - nothing to do */
1020 uxfer = (struct libusb_transfer *)(
1021 ((uint8_t *)sxfer) + sizeof(*sxfer));
1023 if (iso_packets > uxfer->num_iso_packets)
1024 iso_packets = uxfer->num_iso_packets;
1026 if (iso_packets == 0)
1027 return; /* nothing to do */
1029 /* make sure that the number of ISOCHRONOUS packets is valid */
1030 uxfer->num_iso_packets = iso_packets;
1033 case LIBUSB20_TRANSFER_COMPLETED:
1034 /* update actual length */
1035 uxfer->actual_length = actlen;
1036 for (i = 0; i != iso_packets; i++) {
1037 uxfer->iso_packet_desc[i].actual_length =
1038 libusb20_tr_get_length(pxfer, i);
1040 libusb10_complete_transfer(pxfer, sxfer, LIBUSB_TRANSFER_COMPLETED);
1042 case LIBUSB20_TRANSFER_START:
1043 /* setup length(s) */
1045 for (i = 0; i != iso_packets; i++) {
1046 libusb20_tr_setup_isoc(pxfer,
1047 &uxfer->buffer[actlen],
1048 uxfer->iso_packet_desc[i].length, i);
1049 actlen += uxfer->iso_packet_desc[i].length;
1055 libusb20_tr_set_total_frames(pxfer, iso_packets);
1056 libusb20_tr_submit(pxfer);
1058 /* fork another USB transfer, if any */
1059 libusb10_submit_transfer_sub(libusb20_tr_get_priv_sc0(pxfer), uxfer->endpoint);
1062 libusb10_complete_transfer(pxfer, sxfer, libusb10_convert_error(status));
1067 /* This function must be called locked */
1070 libusb10_bulk_intr_proxy(struct libusb20_transfer *pxfer)
1072 struct libusb_super_transfer *sxfer;
1073 struct libusb_transfer *uxfer;
1079 status = libusb20_tr_get_status(pxfer);
1080 sxfer = libusb20_tr_get_priv_sc1(pxfer);
1081 max_bulk = libusb20_tr_get_max_total_length(pxfer);
1082 actlen = libusb20_tr_get_actual_length(pxfer);
1085 return; /* cancelled - nothing to do */
1087 uxfer = (struct libusb_transfer *)(
1088 ((uint8_t *)sxfer) + sizeof(*sxfer));
1090 flags = uxfer->flags;
1093 case LIBUSB20_TRANSFER_COMPLETED:
1095 uxfer->actual_length += actlen;
1097 /* check for short packet */
1098 if (sxfer->last_len != actlen) {
1099 if (flags & LIBUSB_TRANSFER_SHORT_NOT_OK) {
1100 libusb10_complete_transfer(pxfer, sxfer, LIBUSB_TRANSFER_ERROR);
1102 libusb10_complete_transfer(pxfer, sxfer, LIBUSB_TRANSFER_COMPLETED);
1106 /* check for end of data */
1107 if (sxfer->rem_len == 0) {
1108 libusb10_complete_transfer(pxfer, sxfer, LIBUSB_TRANSFER_COMPLETED);
1113 case LIBUSB20_TRANSFER_START:
1114 if (max_bulk > sxfer->rem_len) {
1115 max_bulk = sxfer->rem_len;
1117 /* setup new BULK or INTERRUPT transaction */
1118 libusb20_tr_setup_bulk(pxfer,
1119 sxfer->curr_data, max_bulk, uxfer->timeout);
1121 /* update counters */
1122 sxfer->last_len = max_bulk;
1123 sxfer->curr_data += max_bulk;
1124 sxfer->rem_len -= max_bulk;
1126 libusb20_tr_submit(pxfer);
1128 /* check if we can fork another USB transfer */
1129 if (sxfer->rem_len == 0)
1130 libusb10_submit_transfer_sub(libusb20_tr_get_priv_sc0(pxfer), uxfer->endpoint);
1134 libusb10_complete_transfer(pxfer, sxfer, libusb10_convert_error(status));
1139 /* This function must be called locked */
1142 libusb10_ctrl_proxy(struct libusb20_transfer *pxfer)
1144 struct libusb_super_transfer *sxfer;
1145 struct libusb_transfer *uxfer;
1151 status = libusb20_tr_get_status(pxfer);
1152 sxfer = libusb20_tr_get_priv_sc1(pxfer);
1153 max_bulk = libusb20_tr_get_max_total_length(pxfer);
1154 actlen = libusb20_tr_get_actual_length(pxfer);
1157 return; /* cancelled - nothing to do */
1159 uxfer = (struct libusb_transfer *)(
1160 ((uint8_t *)sxfer) + sizeof(*sxfer));
1162 flags = uxfer->flags;
1165 case LIBUSB20_TRANSFER_COMPLETED:
1167 uxfer->actual_length += actlen;
1169 /* subtract length of SETUP packet, if any */
1170 actlen -= libusb20_tr_get_length(pxfer, 0);
1172 /* check for short packet */
1173 if (sxfer->last_len != actlen) {
1174 if (flags & LIBUSB_TRANSFER_SHORT_NOT_OK) {
1175 libusb10_complete_transfer(pxfer, sxfer, LIBUSB_TRANSFER_ERROR);
1177 libusb10_complete_transfer(pxfer, sxfer, LIBUSB_TRANSFER_COMPLETED);
1181 /* check for end of data */
1182 if (sxfer->rem_len == 0) {
1183 libusb10_complete_transfer(pxfer, sxfer, LIBUSB_TRANSFER_COMPLETED);
1188 case LIBUSB20_TRANSFER_START:
1189 if (max_bulk > sxfer->rem_len) {
1190 max_bulk = sxfer->rem_len;
1192 /* setup new CONTROL transaction */
1193 if (status == LIBUSB20_TRANSFER_COMPLETED) {
1194 /* next fragment - don't send SETUP packet */
1195 libusb20_tr_set_length(pxfer, 0, 0);
1197 /* first fragment - send SETUP packet */
1198 libusb20_tr_set_length(pxfer, 8, 0);
1199 libusb20_tr_set_buffer(pxfer, uxfer->buffer, 0);
1202 if (max_bulk != 0) {
1203 libusb20_tr_set_length(pxfer, max_bulk, 1);
1204 libusb20_tr_set_buffer(pxfer, sxfer->curr_data, 1);
1205 libusb20_tr_set_total_frames(pxfer, 2);
1207 libusb20_tr_set_total_frames(pxfer, 1);
1210 /* update counters */
1211 sxfer->last_len = max_bulk;
1212 sxfer->curr_data += max_bulk;
1213 sxfer->rem_len -= max_bulk;
1215 libusb20_tr_submit(pxfer);
1217 /* check if we can fork another USB transfer */
1218 if (sxfer->rem_len == 0)
1219 libusb10_submit_transfer_sub(libusb20_tr_get_priv_sc0(pxfer), uxfer->endpoint);
1223 libusb10_complete_transfer(pxfer, sxfer, libusb10_convert_error(status));
1228 /* The following function must be called locked */
1231 libusb10_submit_transfer_sub(struct libusb20_device *pdev, uint8_t endpoint)
1233 struct libusb20_transfer *pxfer0;
1234 struct libusb20_transfer *pxfer1;
1235 struct libusb_super_transfer *sxfer;
1236 struct libusb_transfer *uxfer;
1237 struct libusb_device *dev;
1244 dev = libusb_get_device(pdev);
1246 pxfer0 = libusb10_get_transfer(pdev, endpoint, 0);
1247 pxfer1 = libusb10_get_transfer(pdev, endpoint, 1);
1249 if (pxfer0 == NULL || pxfer1 == NULL)
1250 return; /* shouldn't happen */
1253 if (libusb20_tr_pending(pxfer0))
1255 if (libusb20_tr_pending(pxfer1))
1260 /* wait till one of the transfers complete */
1263 sxfer = libusb20_tr_get_priv_sc1(pxfer1);
1265 return; /* cancelling */
1267 return; /* cannot queue another one */
1268 /* swap transfers */
1272 sxfer = libusb20_tr_get_priv_sc1(pxfer0);
1274 return; /* cancelling */
1276 return; /* cannot queue another one */
1277 /* swap transfers */
1284 /* find next transfer on same endpoint */
1285 TAILQ_FOREACH(sxfer, &dev->tr_head, entry) {
1287 uxfer = (struct libusb_transfer *)(
1288 ((uint8_t *)sxfer) + sizeof(*sxfer));
1290 if (uxfer->endpoint == endpoint) {
1291 TAILQ_REMOVE(&dev->tr_head, sxfer, entry);
1292 sxfer->entry.tqe_prev = NULL;
1296 return; /* success */
1300 libusb20_tr_set_priv_sc0(pxfer0, pdev);
1301 libusb20_tr_set_priv_sc1(pxfer0, sxfer);
1303 /* reset super transfer state */
1304 sxfer->rem_len = uxfer->length;
1305 sxfer->curr_data = uxfer->buffer;
1306 uxfer->actual_length = 0;
1308 switch (uxfer->type) {
1309 case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
1310 libusb20_tr_set_callback(pxfer0, libusb10_isoc_proxy);
1312 case LIBUSB_TRANSFER_TYPE_BULK:
1313 case LIBUSB_TRANSFER_TYPE_INTERRUPT:
1314 libusb20_tr_set_callback(pxfer0, libusb10_bulk_intr_proxy);
1316 case LIBUSB_TRANSFER_TYPE_CONTROL:
1317 libusb20_tr_set_callback(pxfer0, libusb10_ctrl_proxy);
1318 if (sxfer->rem_len < 8)
1321 /* remove SETUP packet from data */
1322 sxfer->rem_len -= 8;
1323 sxfer->curr_data += 8;
1329 buffsize = libusb10_get_buffsize(pdev, uxfer);
1330 maxframe = libusb10_get_maxframe(pdev, uxfer);
1332 /* make sure the transfer is opened */
1333 err = libusb20_tr_open(pxfer0, buffsize, maxframe, endpoint);
1334 if (err && (err != LIBUSB20_ERROR_BUSY)) {
1337 libusb20_tr_start(pxfer0);
1341 libusb10_complete_transfer(pxfer0, sxfer, LIBUSB_TRANSFER_ERROR);
1343 /* make sure our event loop spins the done handler */
1345 err = write(dev->ctx->ctrl_pipe[1], &dummy, sizeof(dummy));
1348 /* The following function must be called unlocked */
1351 libusb_submit_transfer(struct libusb_transfer *uxfer)
1353 struct libusb20_transfer *pxfer0;
1354 struct libusb20_transfer *pxfer1;
1355 struct libusb_super_transfer *sxfer;
1356 struct libusb_device *dev;
1361 return (LIBUSB_ERROR_INVALID_PARAM);
1363 if (uxfer->dev_handle == NULL)
1364 return (LIBUSB_ERROR_INVALID_PARAM);
1366 endpoint = uxfer->endpoint;
1368 dev = libusb_get_device(uxfer->dev_handle);
1370 DPRINTF(dev->ctx, LIBUSB_DEBUG_FUNCTION, "libusb_submit_transfer enter");
1372 sxfer = (struct libusb_super_transfer *)(
1373 (uint8_t *)uxfer - sizeof(*sxfer));
1377 pxfer0 = libusb10_get_transfer(uxfer->dev_handle, endpoint, 0);
1378 pxfer1 = libusb10_get_transfer(uxfer->dev_handle, endpoint, 1);
1380 if (pxfer0 == NULL || pxfer1 == NULL) {
1381 err = LIBUSB_ERROR_OTHER;
1382 } else if ((sxfer->entry.tqe_prev != NULL) ||
1383 (libusb20_tr_get_priv_sc1(pxfer0) == sxfer) ||
1384 (libusb20_tr_get_priv_sc1(pxfer1) == sxfer)) {
1385 err = LIBUSB_ERROR_BUSY;
1388 /* set pending state */
1389 sxfer->state = LIBUSB_SUPER_XFER_ST_PEND;
1391 /* insert transfer into transfer head list */
1392 TAILQ_INSERT_TAIL(&dev->tr_head, sxfer, entry);
1394 /* start work transfers */
1395 libusb10_submit_transfer_sub(
1396 uxfer->dev_handle, endpoint);
1398 err = 0; /* success */
1401 CTX_UNLOCK(dev->ctx);
1403 DPRINTF(dev->ctx, LIBUSB_DEBUG_FUNCTION, "libusb_submit_transfer leave %d", err);
1408 /* Asynchronous transfer cancel */
1411 libusb_cancel_transfer(struct libusb_transfer *uxfer)
1413 struct libusb20_transfer *pxfer0;
1414 struct libusb20_transfer *pxfer1;
1415 struct libusb_super_transfer *sxfer;
1416 struct libusb_device *dev;
1421 return (LIBUSB_ERROR_INVALID_PARAM);
1423 /* check if not initialised */
1424 if (uxfer->dev_handle == NULL)
1425 return (LIBUSB_ERROR_NOT_FOUND);
1427 endpoint = uxfer->endpoint;
1429 dev = libusb_get_device(uxfer->dev_handle);
1431 DPRINTF(dev->ctx, LIBUSB_DEBUG_FUNCTION, "libusb_cancel_transfer enter");
1433 sxfer = (struct libusb_super_transfer *)(
1434 (uint8_t *)uxfer - sizeof(*sxfer));
1440 pxfer0 = libusb10_get_transfer(uxfer->dev_handle, endpoint, 0);
1441 pxfer1 = libusb10_get_transfer(uxfer->dev_handle, endpoint, 1);
1443 if (sxfer->state != LIBUSB_SUPER_XFER_ST_PEND) {
1444 /* only update the transfer status */
1445 uxfer->status = LIBUSB_TRANSFER_CANCELLED;
1446 retval = LIBUSB_ERROR_NOT_FOUND;
1447 } else if (sxfer->entry.tqe_prev != NULL) {
1448 /* we are lucky - transfer is on a queue */
1449 TAILQ_REMOVE(&dev->tr_head, sxfer, entry);
1450 sxfer->entry.tqe_prev = NULL;
1451 libusb10_complete_transfer(NULL,
1452 sxfer, LIBUSB_TRANSFER_CANCELLED);
1453 } else if (pxfer0 == NULL || pxfer1 == NULL) {
1455 retval = LIBUSB_ERROR_NOT_FOUND;
1456 } else if (libusb20_tr_get_priv_sc1(pxfer0) == sxfer) {
1457 libusb10_complete_transfer(pxfer0,
1458 sxfer, LIBUSB_TRANSFER_CANCELLED);
1459 libusb20_tr_stop(pxfer0);
1460 /* make sure the queue doesn't stall */
1461 libusb10_submit_transfer_sub(
1462 uxfer->dev_handle, endpoint);
1463 } else if (libusb20_tr_get_priv_sc1(pxfer1) == sxfer) {
1464 libusb10_complete_transfer(pxfer1,
1465 sxfer, LIBUSB_TRANSFER_CANCELLED);
1466 libusb20_tr_stop(pxfer1);
1467 /* make sure the queue doesn't stall */
1468 libusb10_submit_transfer_sub(
1469 uxfer->dev_handle, endpoint);
1472 retval = LIBUSB_ERROR_NOT_FOUND;
1475 CTX_UNLOCK(dev->ctx);
1477 DPRINTF(dev->ctx, LIBUSB_DEBUG_FUNCTION, "libusb_cancel_transfer leave");
1483 libusb10_cancel_all_transfer(libusb_device *dev)
1489 libusb_cpu_to_le16(uint16_t x)
1491 return (htole16(x));
1495 libusb_le16_to_cpu(uint16_t x)
1497 return (le16toh(x));
1501 libusb_strerror(int code)
1504 case LIBUSB_SUCCESS:
1506 case LIBUSB_ERROR_IO:
1507 return ("I/O error");
1508 case LIBUSB_ERROR_INVALID_PARAM:
1509 return ("Invalid parameter");
1510 case LIBUSB_ERROR_ACCESS:
1511 return ("Permissions error");
1512 case LIBUSB_ERROR_NO_DEVICE:
1513 return ("No device");
1514 case LIBUSB_ERROR_NOT_FOUND:
1515 return ("Not found");
1516 case LIBUSB_ERROR_BUSY:
1517 return ("Device busy");
1518 case LIBUSB_ERROR_TIMEOUT:
1520 case LIBUSB_ERROR_OVERFLOW:
1521 return ("Overflow");
1522 case LIBUSB_ERROR_PIPE:
1523 return ("Pipe error");
1524 case LIBUSB_ERROR_INTERRUPTED:
1525 return ("Interrupted");
1526 case LIBUSB_ERROR_NO_MEM:
1527 return ("Out of memory");
1528 case LIBUSB_ERROR_NOT_SUPPORTED:
1529 return ("Not supported");
1530 case LIBUSB_ERROR_OTHER:
1531 return ("Other error");
1533 return ("Unknown error");
1538 libusb_error_name(int code)
1541 case LIBUSB_SUCCESS:
1542 return ("LIBUSB_SUCCESS");
1543 case LIBUSB_ERROR_IO:
1544 return ("LIBUSB_ERROR_IO");
1545 case LIBUSB_ERROR_INVALID_PARAM:
1546 return ("LIBUSB_ERROR_INVALID_PARAM");
1547 case LIBUSB_ERROR_ACCESS:
1548 return ("LIBUSB_ERROR_ACCESS");
1549 case LIBUSB_ERROR_NO_DEVICE:
1550 return ("LIBUSB_ERROR_NO_DEVICE");
1551 case LIBUSB_ERROR_NOT_FOUND:
1552 return ("LIBUSB_ERROR_NOT_FOUND");
1553 case LIBUSB_ERROR_BUSY:
1554 return ("LIBUSB_ERROR_BUSY");
1555 case LIBUSB_ERROR_TIMEOUT:
1556 return ("LIBUSB_ERROR_TIMEOUT");
1557 case LIBUSB_ERROR_OVERFLOW:
1558 return ("LIBUSB_ERROR_OVERFLOW");
1559 case LIBUSB_ERROR_PIPE:
1560 return ("LIBUSB_ERROR_PIPE");
1561 case LIBUSB_ERROR_INTERRUPTED:
1562 return ("LIBUSB_ERROR_INTERRUPTED");
1563 case LIBUSB_ERROR_NO_MEM:
1564 return ("LIBUSB_ERROR_NO_MEM");
1565 case LIBUSB_ERROR_NOT_SUPPORTED:
1566 return ("LIBUSB_ERROR_NOT_SUPPORTED");
1567 case LIBUSB_ERROR_OTHER:
1568 return ("LIBUSB_ERROR_OTHER");
1570 return ("LIBUSB_ERROR_UNKNOWN");