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 #include <sys/fcntl.h>
29 #include <sys/ioctl.h>
30 #include <sys/queue.h>
40 #define libusb_device_handle libusb20_device
43 #include "libusb20_desc.h"
44 #include "libusb20_int.h"
48 static pthread_mutex_t default_context_lock = PTHREAD_MUTEX_INITIALIZER;
49 struct libusb_context *usbi_default_context = NULL;
53 static struct libusb20_transfer *libusb10_get_transfer(struct libusb20_device *, uint8_t, uint8_t);
54 static int libusb10_get_buffsize(struct libusb20_device *, libusb_transfer *);
55 static int libusb10_convert_error(uint8_t status);
56 static void libusb10_complete_transfer(struct libusb20_transfer *, struct libusb_super_transfer *, int);
57 static void libusb10_isoc_proxy(struct libusb20_transfer *);
58 static void libusb10_bulk_intr_proxy(struct libusb20_transfer *);
59 static void libusb10_ctrl_proxy(struct libusb20_transfer *);
60 static void libusb10_submit_transfer_sub(struct libusb20_device *, uint8_t);
62 /* Library initialisation / deinitialisation */
65 libusb_set_debug(libusb_context *ctx, int level)
67 ctx = GET_CONTEXT(ctx);
73 libusb_set_nonblocking(int f)
78 * We ignore any failures in this function, hence the
79 * non-blocking flag is not critical to the operation of
80 * libUSB. We use F_GETFL and F_SETFL to be compatible with
84 flags = fcntl(f, F_GETFL, NULL);
88 fcntl(f, F_SETFL, flags);
92 libusb_init(libusb_context **context)
94 struct libusb_context *ctx;
95 pthread_condattr_t attr;
99 ctx = malloc(sizeof(*ctx));
101 return (LIBUSB_ERROR_INVALID_PARAM);
103 memset(ctx, 0, sizeof(*ctx));
105 debug = getenv("LIBUSB_DEBUG");
107 ctx->debug = atoi(debug);
109 ctx->debug_fixed = 1;
111 TAILQ_INIT(&ctx->pollfds);
112 TAILQ_INIT(&ctx->tr_done);
114 if (pthread_mutex_init(&ctx->ctx_lock, NULL) != 0) {
116 return (LIBUSB_ERROR_NO_MEM);
118 if (pthread_condattr_init(&attr) != 0) {
119 pthread_mutex_destroy(&ctx->ctx_lock);
121 return (LIBUSB_ERROR_NO_MEM);
123 if (pthread_condattr_setclock(&attr, CLOCK_MONOTONIC) != 0) {
124 pthread_mutex_destroy(&ctx->ctx_lock);
125 pthread_condattr_destroy(&attr);
127 return (LIBUSB_ERROR_OTHER);
129 if (pthread_cond_init(&ctx->ctx_cond, &attr) != 0) {
130 pthread_mutex_destroy(&ctx->ctx_lock);
131 pthread_condattr_destroy(&attr);
133 return (LIBUSB_ERROR_NO_MEM);
135 pthread_condattr_destroy(&attr);
137 ctx->ctx_handler = NO_THREAD;
139 ret = pipe(ctx->ctrl_pipe);
141 pthread_mutex_destroy(&ctx->ctx_lock);
142 pthread_cond_destroy(&ctx->ctx_cond);
144 return (LIBUSB_ERROR_OTHER);
146 /* set non-blocking mode on the control pipe to avoid deadlock */
147 libusb_set_nonblocking(ctx->ctrl_pipe[0]);
148 libusb_set_nonblocking(ctx->ctrl_pipe[1]);
150 libusb10_add_pollfd(ctx, &ctx->ctx_poll, NULL, ctx->ctrl_pipe[0], POLLIN);
152 pthread_mutex_lock(&default_context_lock);
153 if (usbi_default_context == NULL) {
154 usbi_default_context = ctx;
156 pthread_mutex_unlock(&default_context_lock);
161 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_init complete");
167 libusb_exit(libusb_context *ctx)
169 ctx = GET_CONTEXT(ctx);
174 /* XXX cleanup devices */
176 libusb10_remove_pollfd(ctx, &ctx->ctx_poll);
177 close(ctx->ctrl_pipe[0]);
178 close(ctx->ctrl_pipe[1]);
179 pthread_mutex_destroy(&ctx->ctx_lock);
180 pthread_cond_destroy(&ctx->ctx_cond);
182 pthread_mutex_lock(&default_context_lock);
183 if (ctx == usbi_default_context) {
184 usbi_default_context = NULL;
186 pthread_mutex_unlock(&default_context_lock);
191 /* Device handling and initialisation. */
194 libusb_get_device_list(libusb_context *ctx, libusb_device ***list)
196 struct libusb20_backend *usb_backend;
197 struct libusb20_device *pdev;
198 struct libusb_device *dev;
201 ctx = GET_CONTEXT(ctx);
204 return (LIBUSB_ERROR_INVALID_PARAM);
207 return (LIBUSB_ERROR_INVALID_PARAM);
209 usb_backend = libusb20_be_alloc_default();
210 if (usb_backend == NULL)
211 return (LIBUSB_ERROR_NO_MEM);
213 /* figure out how many USB devices are present */
216 while ((pdev = libusb20_be_device_foreach(usb_backend, pdev)))
219 /* allocate device pointer list */
220 *list = malloc((i + 1) * sizeof(void *));
222 libusb20_be_free(usb_backend);
223 return (LIBUSB_ERROR_NO_MEM);
225 /* create libusb v1.0 compliant devices */
227 while ((pdev = libusb20_be_device_foreach(usb_backend, NULL))) {
229 dev = malloc(sizeof(*dev));
232 libusb_unref_device((*list)[i - 1]);
237 libusb20_be_free(usb_backend);
238 return (LIBUSB_ERROR_NO_MEM);
240 /* get device into libUSB v1.0 list */
241 libusb20_be_dequeue_device(usb_backend, pdev);
243 memset(dev, 0, sizeof(*dev));
245 /* init transfer queues */
246 TAILQ_INIT(&dev->tr_head);
248 /* set context we belong to */
251 /* link together the two structures */
253 pdev->privLuData = dev;
255 (*list)[i] = libusb_ref_device(dev);
260 libusb20_be_free(usb_backend);
265 libusb_free_device_list(libusb_device **list, int unref_devices)
270 return; /* be NULL safe */
273 for (i = 0; list[i] != NULL; i++)
274 libusb_unref_device(list[i]);
280 libusb_get_bus_number(libusb_device *dev)
283 return (0); /* should not happen */
284 return (libusb20_dev_get_bus_number(dev->os_priv));
288 libusb_get_port_numbers(libusb_device *dev, uint8_t *buf, uint8_t bufsize)
290 return (libusb20_dev_get_port_path(dev->os_priv, buf, bufsize));
294 libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *buf,
297 return (libusb20_dev_get_port_path(dev->os_priv, buf, bufsize));
301 libusb_get_device_address(libusb_device *dev)
304 return (0); /* should not happen */
305 return (libusb20_dev_get_address(dev->os_priv));
309 libusb_get_device_speed(libusb_device *dev)
312 return (LIBUSB_SPEED_UNKNOWN); /* should not happen */
314 switch (libusb20_dev_get_speed(dev->os_priv)) {
315 case LIBUSB20_SPEED_LOW:
316 return (LIBUSB_SPEED_LOW);
317 case LIBUSB20_SPEED_FULL:
318 return (LIBUSB_SPEED_FULL);
319 case LIBUSB20_SPEED_HIGH:
320 return (LIBUSB_SPEED_HIGH);
321 case LIBUSB20_SPEED_SUPER:
322 return (LIBUSB_SPEED_SUPER);
326 return (LIBUSB_SPEED_UNKNOWN);
330 libusb_get_max_packet_size(libusb_device *dev, uint8_t endpoint)
332 struct libusb_config_descriptor *pdconf;
333 struct libusb_interface *pinf;
334 struct libusb_interface_descriptor *pdinf;
335 struct libusb_endpoint_descriptor *pdend;
342 return (LIBUSB_ERROR_NO_DEVICE);
344 ret = libusb_get_active_config_descriptor(dev, &pdconf);
348 ret = LIBUSB_ERROR_NOT_FOUND;
349 for (i = 0; i < pdconf->bNumInterfaces; i++) {
350 pinf = &pdconf->interface[i];
351 for (j = 0; j < pinf->num_altsetting; j++) {
352 pdinf = &pinf->altsetting[j];
353 for (k = 0; k < pdinf->bNumEndpoints; k++) {
354 pdend = &pdinf->endpoint[k];
355 if (pdend->bEndpointAddress == endpoint) {
356 ret = pdend->wMaxPacketSize;
364 libusb_free_config_descriptor(pdconf);
369 libusb_get_max_iso_packet_size(libusb_device *dev, uint8_t endpoint)
374 ret = libusb_get_max_packet_size(dev, endpoint);
376 switch (libusb20_dev_get_speed(dev->os_priv)) {
377 case LIBUSB20_SPEED_LOW:
378 case LIBUSB20_SPEED_FULL:
382 multiplier = (1 + ((ret >> 11) & 3));
385 ret = (ret & 0x7FF) * multiplier;
393 libusb_ref_device(libusb_device *dev)
396 return (NULL); /* be NULL safe */
400 CTX_UNLOCK(dev->ctx);
406 libusb_unref_device(libusb_device *dev)
409 return; /* be NULL safe */
413 CTX_UNLOCK(dev->ctx);
415 if (dev->refcnt == 0) {
416 libusb20_dev_free(dev->os_priv);
422 libusb_open(libusb_device *dev, libusb_device_handle **devh)
424 libusb_context *ctx = dev->ctx;
425 struct libusb20_device *pdev = dev->os_priv;
430 return (LIBUSB_ERROR_INVALID_PARAM);
432 /* set default device handle value */
435 dev = libusb_ref_device(dev);
437 return (LIBUSB_ERROR_INVALID_PARAM);
439 err = libusb20_dev_open(pdev, 16 * 4 /* number of endpoints */ );
441 libusb_unref_device(dev);
442 return (LIBUSB_ERROR_NO_MEM);
444 libusb10_add_pollfd(ctx, &dev->dev_poll, pdev, libusb20_dev_get_fd(pdev), POLLIN |
445 POLLOUT | POLLRDNORM | POLLWRNORM);
447 /* make sure our event loop detects the new device */
449 err = write(ctx->ctrl_pipe[1], &dummy, sizeof(dummy));
450 if (err < (int)sizeof(dummy)) {
451 /* ignore error, if any */
452 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_open write failed!");
459 libusb_device_handle *
460 libusb_open_device_with_vid_pid(libusb_context *ctx, uint16_t vendor_id,
463 struct libusb_device **devs;
464 struct libusb20_device *pdev;
465 struct LIBUSB20_DEVICE_DESC_DECODED *pdesc;
469 ctx = GET_CONTEXT(ctx);
471 return (NULL); /* be NULL safe */
473 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_open_device_width_vid_pid enter");
475 if ((i = libusb_get_device_list(ctx, &devs)) < 0)
479 for (j = 0; j < i; j++) {
480 struct libusb20_device *tdev;
482 tdev = devs[j]->os_priv;
483 pdesc = libusb20_dev_get_device_desc(tdev);
485 * NOTE: The USB library will automatically swap the
486 * fields in the device descriptor to be of host
489 if (pdesc->idVendor == vendor_id &&
490 pdesc->idProduct == product_id) {
491 libusb_open(devs[j], &pdev);
496 libusb_free_device_list(devs, 1);
497 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_open_device_width_vid_pid leave");
502 libusb_close(struct libusb20_device *pdev)
505 struct libusb_device *dev;
510 return; /* be NULL safe */
512 dev = libusb_get_device(pdev);
515 libusb10_remove_pollfd(ctx, &dev->dev_poll);
517 libusb20_dev_close(pdev);
519 /* unref will free the "pdev" when the refcount reaches zero */
520 libusb_unref_device(dev);
522 /* make sure our event loop detects the closed device */
524 err = write(ctx->ctrl_pipe[1], &dummy, sizeof(dummy));
525 if (err < (int)sizeof(dummy)) {
526 /* ignore error, if any */
527 DPRINTF(ctx, LIBUSB_DEBUG_FUNCTION, "libusb_close write failed!");
532 libusb_get_device(struct libusb20_device *pdev)
536 return ((libusb_device *)pdev->privLuData);
540 libusb_get_configuration(struct libusb20_device *pdev, int *config)
542 struct libusb20_config *pconf;
544 if (pdev == NULL || config == NULL)
545 return (LIBUSB_ERROR_INVALID_PARAM);
547 pconf = libusb20_dev_alloc_config(pdev, libusb20_dev_get_config_index(pdev));
549 return (LIBUSB_ERROR_NO_MEM);
551 *config = pconf->desc.bConfigurationValue;
559 libusb_set_configuration(struct libusb20_device *pdev, int configuration)
561 struct libusb20_config *pconf;
562 struct libusb_device *dev;
566 dev = libusb_get_device(pdev);
568 return (LIBUSB_ERROR_INVALID_PARAM);
570 if (configuration < 1) {
574 for (i = 0; i != 255; i++) {
577 pconf = libusb20_dev_alloc_config(pdev, i);
579 return (LIBUSB_ERROR_INVALID_PARAM);
580 found = (pconf->desc.bConfigurationValue
587 return (LIBUSB_ERROR_INVALID_PARAM);
592 libusb10_cancel_all_transfer(dev);
594 libusb10_remove_pollfd(dev->ctx, &dev->dev_poll);
596 err = libusb20_dev_set_config_index(pdev, i);
598 libusb10_add_pollfd(dev->ctx, &dev->dev_poll, pdev, libusb20_dev_get_fd(pdev), POLLIN |
599 POLLOUT | POLLRDNORM | POLLWRNORM);
601 return (err ? LIBUSB_ERROR_INVALID_PARAM : 0);
605 libusb_claim_interface(struct libusb20_device *pdev, int interface_number)
610 dev = libusb_get_device(pdev);
612 return (LIBUSB_ERROR_INVALID_PARAM);
614 if (interface_number < 0 || interface_number > 31)
615 return (LIBUSB_ERROR_INVALID_PARAM);
618 if (dev->claimed_interfaces & (1 << interface_number))
619 err = LIBUSB_ERROR_BUSY;
622 dev->claimed_interfaces |= (1 << interface_number);
623 CTX_UNLOCK(dev->ctx);
628 libusb_release_interface(struct libusb20_device *pdev, int interface_number)
633 dev = libusb_get_device(pdev);
635 return (LIBUSB_ERROR_INVALID_PARAM);
637 if (interface_number < 0 || interface_number > 31)
638 return (LIBUSB_ERROR_INVALID_PARAM);
641 if (!(dev->claimed_interfaces & (1 << interface_number)))
642 err = LIBUSB_ERROR_NOT_FOUND;
645 dev->claimed_interfaces &= ~(1 << interface_number);
646 CTX_UNLOCK(dev->ctx);
651 libusb_set_interface_alt_setting(struct libusb20_device *pdev,
652 int interface_number, int alternate_setting)
657 dev = libusb_get_device(pdev);
659 return (LIBUSB_ERROR_INVALID_PARAM);
661 if (interface_number < 0 || interface_number > 31)
662 return (LIBUSB_ERROR_INVALID_PARAM);
665 if (!(dev->claimed_interfaces & (1 << interface_number)))
666 err = LIBUSB_ERROR_NOT_FOUND;
667 CTX_UNLOCK(dev->ctx);
672 libusb10_cancel_all_transfer(dev);
674 libusb10_remove_pollfd(dev->ctx, &dev->dev_poll);
676 err = libusb20_dev_set_alt_index(pdev,
677 interface_number, alternate_setting);
679 libusb10_add_pollfd(dev->ctx, &dev->dev_poll,
680 pdev, libusb20_dev_get_fd(pdev),
681 POLLIN | POLLOUT | POLLRDNORM | POLLWRNORM);
683 return (err ? LIBUSB_ERROR_OTHER : 0);
686 static struct libusb20_transfer *
687 libusb10_get_transfer(struct libusb20_device *pdev,
688 uint8_t endpoint, uint8_t xfer_index)
690 xfer_index &= 1; /* double buffering */
692 xfer_index |= (endpoint & LIBUSB20_ENDPOINT_ADDRESS_MASK) * 4;
694 if (endpoint & LIBUSB20_ENDPOINT_DIR_MASK) {
695 /* this is an IN endpoint */
698 return (libusb20_tr_get_pointer(pdev, xfer_index));
702 libusb_clear_halt(struct libusb20_device *pdev, uint8_t endpoint)
704 struct libusb20_transfer *xfer;
705 struct libusb_device *dev;
708 xfer = libusb10_get_transfer(pdev, endpoint, 0);
710 return (LIBUSB_ERROR_INVALID_PARAM);
712 dev = libusb_get_device(pdev);
714 return (LIBUSB_ERROR_INVALID_PARAM);
717 err = libusb20_tr_open(xfer, 0, 1, endpoint);
718 CTX_UNLOCK(dev->ctx);
720 if (err != 0 && err != LIBUSB20_ERROR_BUSY)
721 return (LIBUSB_ERROR_OTHER);
723 libusb20_tr_clear_stall_sync(xfer);
725 /* check if we opened the transfer */
728 libusb20_tr_close(xfer);
729 CTX_UNLOCK(dev->ctx);
731 return (0); /* success */
735 libusb_reset_device(struct libusb20_device *pdev)
740 dev = libusb_get_device(pdev);
742 return (LIBUSB_ERROR_INVALID_PARAM);
744 libusb10_cancel_all_transfer(dev);
746 libusb10_remove_pollfd(dev->ctx, &dev->dev_poll);
748 err = libusb20_dev_reset(pdev);
750 libusb10_add_pollfd(dev->ctx, &dev->dev_poll,
751 pdev, libusb20_dev_get_fd(pdev),
752 POLLIN | POLLOUT | POLLRDNORM | POLLWRNORM);
754 return (err ? LIBUSB_ERROR_OTHER : 0);
758 libusb_check_connected(struct libusb20_device *pdev)
763 dev = libusb_get_device(pdev);
765 return (LIBUSB_ERROR_INVALID_PARAM);
767 err = libusb20_dev_check_connected(pdev);
769 return (err ? LIBUSB_ERROR_NO_DEVICE : 0);
773 libusb_kernel_driver_active(struct libusb20_device *pdev, int interface)
776 return (LIBUSB_ERROR_INVALID_PARAM);
778 if (libusb20_dev_kernel_driver_active(pdev, interface))
779 return (0); /* no kernel driver is active */
781 return (1); /* kernel driver is active */
785 libusb_get_driver_np(struct libusb20_device *pdev, int interface,
786 char *name, int namelen)
788 return (libusb_get_driver(pdev, interface, name, namelen));
792 libusb_get_driver(struct libusb20_device *pdev, int interface,
793 char *name, int namelen)
799 return (LIBUSB_ERROR_INVALID_PARAM);
801 return (LIBUSB_ERROR_INVALID_PARAM);
805 err = libusb20_dev_get_iface_desc(
806 pdev, interface, name, namelen);
809 return (LIBUSB_ERROR_OTHER);
811 /* we only want the driver name */
812 ptr = strstr(name, ":");
820 libusb_detach_kernel_driver_np(struct libusb20_device *pdev, int interface)
822 return (libusb_detach_kernel_driver(pdev, interface));
826 libusb_detach_kernel_driver(struct libusb20_device *pdev, int interface)
831 return (LIBUSB_ERROR_INVALID_PARAM);
833 err = libusb20_dev_detach_kernel_driver(
836 return (err ? LIBUSB_ERROR_OTHER : 0);
840 libusb_attach_kernel_driver(struct libusb20_device *pdev, int interface)
843 return (LIBUSB_ERROR_INVALID_PARAM);
844 /* stub - currently not supported by libusb20 */
848 /* Asynchronous device I/O */
850 struct libusb_transfer *
851 libusb_alloc_transfer(int iso_packets)
853 struct libusb_transfer *uxfer;
854 struct libusb_super_transfer *sxfer;
857 len = sizeof(struct libusb_transfer) +
858 sizeof(struct libusb_super_transfer) +
859 (iso_packets * sizeof(libusb_iso_packet_descriptor));
865 memset(sxfer, 0, len);
867 uxfer = (struct libusb_transfer *)(
868 ((uint8_t *)sxfer) + sizeof(*sxfer));
870 /* set default value */
871 uxfer->num_iso_packets = iso_packets;
877 libusb_free_transfer(struct libusb_transfer *uxfer)
879 struct libusb_super_transfer *sxfer;
882 return; /* be NULL safe */
884 /* check if we should free the transfer buffer */
885 if (uxfer->flags & LIBUSB_TRANSFER_FREE_BUFFER)
888 sxfer = (struct libusb_super_transfer *)(
889 (uint8_t *)uxfer - sizeof(*sxfer));
895 libusb10_get_maxframe(struct libusb20_device *pdev, libusb_transfer *xfer)
899 switch (xfer->type) {
900 case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
901 ret = 60 | LIBUSB20_MAX_FRAME_PRE_SCALE; /* 60ms */
903 case LIBUSB_TRANSFER_TYPE_CONTROL:
914 libusb10_get_buffsize(struct libusb20_device *pdev, libusb_transfer *xfer)
919 usb_speed = libusb20_dev_get_speed(pdev);
921 switch (xfer->type) {
922 case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
923 ret = 0; /* kernel will auto-select */
925 case LIBUSB_TRANSFER_TYPE_CONTROL:
930 case LIBUSB20_SPEED_LOW:
933 case LIBUSB20_SPEED_FULL:
946 libusb10_convert_error(uint8_t status)
951 case LIBUSB20_TRANSFER_START:
952 case LIBUSB20_TRANSFER_COMPLETED:
953 return (LIBUSB_TRANSFER_COMPLETED);
954 case LIBUSB20_TRANSFER_OVERFLOW:
955 return (LIBUSB_TRANSFER_OVERFLOW);
956 case LIBUSB20_TRANSFER_NO_DEVICE:
957 return (LIBUSB_TRANSFER_NO_DEVICE);
958 case LIBUSB20_TRANSFER_STALL:
959 return (LIBUSB_TRANSFER_STALL);
960 case LIBUSB20_TRANSFER_CANCELLED:
961 return (LIBUSB_TRANSFER_CANCELLED);
962 case LIBUSB20_TRANSFER_TIMED_OUT:
963 return (LIBUSB_TRANSFER_TIMED_OUT);
965 return (LIBUSB_TRANSFER_ERROR);
969 /* This function must be called locked */
972 libusb10_complete_transfer(struct libusb20_transfer *pxfer,
973 struct libusb_super_transfer *sxfer, int status)
975 struct libusb_transfer *uxfer;
976 struct libusb_device *dev;
978 uxfer = (struct libusb_transfer *)(
979 ((uint8_t *)sxfer) + sizeof(*sxfer));
982 libusb20_tr_set_priv_sc1(pxfer, NULL);
984 /* set transfer status */
985 uxfer->status = status;
987 /* update super transfer state */
988 sxfer->state = LIBUSB_SUPER_XFER_ST_NONE;
990 dev = libusb_get_device(uxfer->dev_handle);
992 TAILQ_INSERT_TAIL(&dev->ctx->tr_done, sxfer, entry);
995 /* This function must be called locked */
998 libusb10_isoc_proxy(struct libusb20_transfer *pxfer)
1000 struct libusb_super_transfer *sxfer;
1001 struct libusb_transfer *uxfer;
1003 uint16_t iso_packets;
1008 status = libusb20_tr_get_status(pxfer);
1009 sxfer = libusb20_tr_get_priv_sc1(pxfer);
1010 actlen = libusb20_tr_get_actual_length(pxfer);
1011 iso_packets = libusb20_tr_get_max_frames(pxfer);
1014 return; /* cancelled - nothing to do */
1016 uxfer = (struct libusb_transfer *)(
1017 ((uint8_t *)sxfer) + sizeof(*sxfer));
1019 if (iso_packets > uxfer->num_iso_packets)
1020 iso_packets = uxfer->num_iso_packets;
1022 if (iso_packets == 0)
1023 return; /* nothing to do */
1025 /* make sure that the number of ISOCHRONOUS packets is valid */
1026 uxfer->num_iso_packets = iso_packets;
1028 flags = uxfer->flags;
1031 case LIBUSB20_TRANSFER_COMPLETED:
1033 /* update actual length */
1034 uxfer->actual_length = actlen;
1035 for (i = 0; i != iso_packets; i++) {
1036 uxfer->iso_packet_desc[i].actual_length =
1037 libusb20_tr_get_length(pxfer, i);
1039 libusb10_complete_transfer(pxfer, sxfer, LIBUSB_TRANSFER_COMPLETED);
1042 case LIBUSB20_TRANSFER_START:
1044 /* setup length(s) */
1046 for (i = 0; i != iso_packets; i++) {
1047 libusb20_tr_setup_isoc(pxfer,
1048 &uxfer->buffer[actlen],
1049 uxfer->iso_packet_desc[i].length, i);
1050 actlen += uxfer->iso_packet_desc[i].length;
1056 libusb20_tr_set_total_frames(pxfer, iso_packets);
1057 libusb20_tr_submit(pxfer);
1059 /* fork another USB transfer, if any */
1060 libusb10_submit_transfer_sub(libusb20_tr_get_priv_sc0(pxfer), uxfer->endpoint);
1064 libusb10_complete_transfer(pxfer, sxfer, libusb10_convert_error(status));
1069 /* This function must be called locked */
1072 libusb10_bulk_intr_proxy(struct libusb20_transfer *pxfer)
1074 struct libusb_super_transfer *sxfer;
1075 struct libusb_transfer *uxfer;
1081 status = libusb20_tr_get_status(pxfer);
1082 sxfer = libusb20_tr_get_priv_sc1(pxfer);
1083 max_bulk = libusb20_tr_get_max_total_length(pxfer);
1084 actlen = libusb20_tr_get_actual_length(pxfer);
1087 return; /* cancelled - nothing to do */
1089 uxfer = (struct libusb_transfer *)(
1090 ((uint8_t *)sxfer) + sizeof(*sxfer));
1092 flags = uxfer->flags;
1095 case LIBUSB20_TRANSFER_COMPLETED:
1097 uxfer->actual_length += actlen;
1099 /* check for short packet */
1100 if (sxfer->last_len != actlen) {
1101 if (flags & LIBUSB_TRANSFER_SHORT_NOT_OK) {
1102 libusb10_complete_transfer(pxfer, sxfer, LIBUSB_TRANSFER_ERROR);
1104 libusb10_complete_transfer(pxfer, sxfer, LIBUSB_TRANSFER_COMPLETED);
1108 /* check for end of data */
1109 if (sxfer->rem_len == 0) {
1110 libusb10_complete_transfer(pxfer, sxfer, LIBUSB_TRANSFER_COMPLETED);
1115 case LIBUSB20_TRANSFER_START:
1116 if (max_bulk > sxfer->rem_len) {
1117 max_bulk = sxfer->rem_len;
1119 /* setup new BULK or INTERRUPT transaction */
1120 libusb20_tr_setup_bulk(pxfer,
1121 sxfer->curr_data, max_bulk, uxfer->timeout);
1123 /* update counters */
1124 sxfer->last_len = max_bulk;
1125 sxfer->curr_data += max_bulk;
1126 sxfer->rem_len -= max_bulk;
1128 libusb20_tr_submit(pxfer);
1130 /* check if we can fork another USB transfer */
1131 if (sxfer->rem_len == 0)
1132 libusb10_submit_transfer_sub(libusb20_tr_get_priv_sc0(pxfer), uxfer->endpoint);
1136 libusb10_complete_transfer(pxfer, sxfer, libusb10_convert_error(status));
1141 /* This function must be called locked */
1144 libusb10_ctrl_proxy(struct libusb20_transfer *pxfer)
1146 struct libusb_super_transfer *sxfer;
1147 struct libusb_transfer *uxfer;
1153 status = libusb20_tr_get_status(pxfer);
1154 sxfer = libusb20_tr_get_priv_sc1(pxfer);
1155 max_bulk = libusb20_tr_get_max_total_length(pxfer);
1156 actlen = libusb20_tr_get_actual_length(pxfer);
1159 return; /* cancelled - nothing to do */
1161 uxfer = (struct libusb_transfer *)(
1162 ((uint8_t *)sxfer) + sizeof(*sxfer));
1164 flags = uxfer->flags;
1167 case LIBUSB20_TRANSFER_COMPLETED:
1169 uxfer->actual_length += actlen;
1171 /* subtract length of SETUP packet, if any */
1172 actlen -= libusb20_tr_get_length(pxfer, 0);
1174 /* check for short packet */
1175 if (sxfer->last_len != actlen) {
1176 if (flags & LIBUSB_TRANSFER_SHORT_NOT_OK) {
1177 libusb10_complete_transfer(pxfer, sxfer, LIBUSB_TRANSFER_ERROR);
1179 libusb10_complete_transfer(pxfer, sxfer, LIBUSB_TRANSFER_COMPLETED);
1183 /* check for end of data */
1184 if (sxfer->rem_len == 0) {
1185 libusb10_complete_transfer(pxfer, sxfer, LIBUSB_TRANSFER_COMPLETED);
1190 case LIBUSB20_TRANSFER_START:
1191 if (max_bulk > sxfer->rem_len) {
1192 max_bulk = sxfer->rem_len;
1194 /* setup new CONTROL transaction */
1195 if (status == LIBUSB20_TRANSFER_COMPLETED) {
1196 /* next fragment - don't send SETUP packet */
1197 libusb20_tr_set_length(pxfer, 0, 0);
1199 /* first fragment - send SETUP packet */
1200 libusb20_tr_set_length(pxfer, 8, 0);
1201 libusb20_tr_set_buffer(pxfer, uxfer->buffer, 0);
1204 if (max_bulk != 0) {
1205 libusb20_tr_set_length(pxfer, max_bulk, 1);
1206 libusb20_tr_set_buffer(pxfer, sxfer->curr_data, 1);
1207 libusb20_tr_set_total_frames(pxfer, 2);
1209 libusb20_tr_set_total_frames(pxfer, 1);
1212 /* update counters */
1213 sxfer->last_len = max_bulk;
1214 sxfer->curr_data += max_bulk;
1215 sxfer->rem_len -= max_bulk;
1217 libusb20_tr_submit(pxfer);
1219 /* check if we can fork another USB transfer */
1220 if (sxfer->rem_len == 0)
1221 libusb10_submit_transfer_sub(libusb20_tr_get_priv_sc0(pxfer), uxfer->endpoint);
1225 libusb10_complete_transfer(pxfer, sxfer, libusb10_convert_error(status));
1230 /* The following function must be called locked */
1233 libusb10_submit_transfer_sub(struct libusb20_device *pdev, uint8_t endpoint)
1235 struct libusb20_transfer *pxfer0;
1236 struct libusb20_transfer *pxfer1;
1237 struct libusb_super_transfer *sxfer;
1238 struct libusb_transfer *uxfer;
1239 struct libusb_device *dev;
1246 dev = libusb_get_device(pdev);
1248 pxfer0 = libusb10_get_transfer(pdev, endpoint, 0);
1249 pxfer1 = libusb10_get_transfer(pdev, endpoint, 1);
1251 if (pxfer0 == NULL || pxfer1 == NULL)
1252 return; /* shouldn't happen */
1255 if (libusb20_tr_pending(pxfer0))
1257 if (libusb20_tr_pending(pxfer1))
1262 /* wait till one of the transfers complete */
1265 sxfer = libusb20_tr_get_priv_sc1(pxfer1);
1267 return; /* cancelling */
1269 return; /* cannot queue another one */
1270 /* swap transfers */
1274 sxfer = libusb20_tr_get_priv_sc1(pxfer0);
1276 return; /* cancelling */
1278 return; /* cannot queue another one */
1279 /* swap transfers */
1286 /* find next transfer on same endpoint */
1287 TAILQ_FOREACH(sxfer, &dev->tr_head, entry) {
1289 uxfer = (struct libusb_transfer *)(
1290 ((uint8_t *)sxfer) + sizeof(*sxfer));
1292 if (uxfer->endpoint == endpoint) {
1293 TAILQ_REMOVE(&dev->tr_head, sxfer, entry);
1294 sxfer->entry.tqe_prev = NULL;
1298 return; /* success */
1302 libusb20_tr_set_priv_sc0(pxfer0, pdev);
1303 libusb20_tr_set_priv_sc1(pxfer0, sxfer);
1305 /* reset super transfer state */
1306 sxfer->rem_len = uxfer->length;
1307 sxfer->curr_data = uxfer->buffer;
1308 uxfer->actual_length = 0;
1310 switch (uxfer->type) {
1311 case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
1312 libusb20_tr_set_callback(pxfer0, libusb10_isoc_proxy);
1314 case LIBUSB_TRANSFER_TYPE_BULK:
1315 case LIBUSB_TRANSFER_TYPE_INTERRUPT:
1316 libusb20_tr_set_callback(pxfer0, libusb10_bulk_intr_proxy);
1318 case LIBUSB_TRANSFER_TYPE_CONTROL:
1319 libusb20_tr_set_callback(pxfer0, libusb10_ctrl_proxy);
1320 if (sxfer->rem_len < 8)
1323 /* remove SETUP packet from data */
1324 sxfer->rem_len -= 8;
1325 sxfer->curr_data += 8;
1331 buffsize = libusb10_get_buffsize(pdev, uxfer);
1332 maxframe = libusb10_get_maxframe(pdev, uxfer);
1334 /* make sure the transfer is opened */
1335 err = libusb20_tr_open(pxfer0, buffsize, maxframe, endpoint);
1336 if (err && (err != LIBUSB20_ERROR_BUSY)) {
1339 libusb20_tr_start(pxfer0);
1343 libusb10_complete_transfer(pxfer0, sxfer, LIBUSB_TRANSFER_ERROR);
1345 /* make sure our event loop spins the done handler */
1347 write(dev->ctx->ctrl_pipe[1], &dummy, sizeof(dummy));
1350 /* The following function must be called unlocked */
1353 libusb_submit_transfer(struct libusb_transfer *uxfer)
1355 struct libusb20_transfer *pxfer0;
1356 struct libusb20_transfer *pxfer1;
1357 struct libusb_super_transfer *sxfer;
1358 struct libusb_device *dev;
1363 return (LIBUSB_ERROR_INVALID_PARAM);
1365 if (uxfer->dev_handle == NULL)
1366 return (LIBUSB_ERROR_INVALID_PARAM);
1368 endpoint = uxfer->endpoint;
1371 return (LIBUSB_ERROR_INVALID_PARAM);
1373 dev = libusb_get_device(uxfer->dev_handle);
1375 DPRINTF(dev->ctx, LIBUSB_DEBUG_FUNCTION, "libusb_submit_transfer enter");
1377 sxfer = (struct libusb_super_transfer *)(
1378 (uint8_t *)uxfer - sizeof(*sxfer));
1382 pxfer0 = libusb10_get_transfer(uxfer->dev_handle, endpoint, 0);
1383 pxfer1 = libusb10_get_transfer(uxfer->dev_handle, endpoint, 1);
1385 if (pxfer0 == NULL || pxfer1 == NULL) {
1386 err = LIBUSB_ERROR_OTHER;
1387 } else if ((sxfer->entry.tqe_prev != NULL) ||
1388 (libusb20_tr_get_priv_sc1(pxfer0) == sxfer) ||
1389 (libusb20_tr_get_priv_sc1(pxfer1) == sxfer)) {
1390 err = LIBUSB_ERROR_BUSY;
1393 /* set pending state */
1394 sxfer->state = LIBUSB_SUPER_XFER_ST_PEND;
1396 /* insert transfer into transfer head list */
1397 TAILQ_INSERT_TAIL(&dev->tr_head, sxfer, entry);
1399 /* start work transfers */
1400 libusb10_submit_transfer_sub(
1401 uxfer->dev_handle, endpoint);
1403 err = 0; /* success */
1406 CTX_UNLOCK(dev->ctx);
1408 DPRINTF(dev->ctx, LIBUSB_DEBUG_FUNCTION, "libusb_submit_transfer leave %d", err);
1413 /* Asynchronous transfer cancel */
1416 libusb_cancel_transfer(struct libusb_transfer *uxfer)
1418 struct libusb20_transfer *pxfer0;
1419 struct libusb20_transfer *pxfer1;
1420 struct libusb_super_transfer *sxfer;
1421 struct libusb_device *dev;
1426 return (LIBUSB_ERROR_INVALID_PARAM);
1428 /* check if not initialised */
1429 if (uxfer->dev_handle == NULL)
1430 return (LIBUSB_ERROR_NOT_FOUND);
1432 endpoint = uxfer->endpoint;
1435 return (LIBUSB_ERROR_INVALID_PARAM);
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");