1 /* -*- Mode: C; c-basic-offset:8 ; indent-tabs-mode:t -*- */
3 * Linux usbfs backend for libusb
4 * Copyright © 2007-2009 Daniel Drake <dsd@gentoo.org>
5 * Copyright © 2001 Johannes Erdfelt <johannes@erdfelt.com>
6 * Copyright © 2013 Nathan Hjelm <hjelmn@mac.com>
7 * Copyright © 2012-2013 Hans de Goede <hdegoede@redhat.com>
8 * Copyright © 2020 Chris Dickens <christopher.a.dickens@gmail.com>
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Lesser General Public
12 * License as published by the Free Software Foundation; either
13 * version 2.1 of the License, or (at your option) any later version.
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with this library; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
26 #include "linux_usbfs.h"
35 #include <sys/ioctl.h>
37 #include <sys/utsname.h>
42 * opening a usbfs node causes the device to be resumed, so we attempt to
43 * avoid this during enumeration.
45 * sysfs allows us to read the kernel's in-memory copies of device descriptors
46 * and so forth, avoiding the need to open the device:
47 * - The binary "descriptors" file contains all config descriptors since
48 * 2.6.26, commit 217a9081d8e69026186067711131b77f0ce219ed
49 * - The binary "descriptors" file was added in 2.6.23, commit
50 * 69d42a78f935d19384d1f6e4f94b65bb162b36df, but it only contains the
51 * active config descriptors
52 * - The "busnum" file was added in 2.6.22, commit
53 * 83f7d958eab2fbc6b159ee92bf1493924e1d0f72
54 * - The "devnum" file has been present since pre-2.6.18
55 * - the "bConfigurationValue" file has been present since pre-2.6.18
57 * If we have bConfigurationValue, busnum, and devnum, then we can determine
58 * the active configuration without having to open the usbfs node in RDWR mode.
59 * The busnum file is important as that is the only way we can relate sysfs
60 * devices to usbfs nodes.
62 * If we also have all descriptors, we can obtain the device descriptor and
63 * configuration without touching usbfs at all.
66 /* endianness for multi-byte fields:
68 * Descriptors exposed by usbfs have the multi-byte fields in the device
69 * descriptor as host endian. Multi-byte fields in the other descriptors are
70 * bus-endian. The kernel documentation says otherwise, but it is wrong.
72 * In sysfs all descriptors are bus-endian.
75 #define USBDEV_PATH "/dev"
76 #define USB_DEVTMPFS_PATH "/dev/bus/usb"
78 /* use usbdev*.* device names in /dev instead of the usbfs bus directories */
79 static int usbdev_names = 0;
81 /* Linux has changed the maximum length of an individual isochronous packet
82 * over time. Initially this limit was 1,023 bytes, but Linux 2.6.18
83 * (commit 3612242e527eb47ee4756b5350f8bdf791aa5ede) increased this value to
84 * 8,192 bytes to support higher bandwidth devices. Linux 3.10
85 * (commit e2e2f0ea1c935edcf53feb4c4c8fdb4f86d57dd9) further increased this
86 * value to 49,152 bytes to support super speed devices. Linux 5.2
87 * (commit 8a1dbc8d91d3d1602282c7e6b4222c7759c916fa) even further increased
88 * this value to 98,304 bytes to support super speed plus devices.
90 static unsigned int max_iso_packet_len = 0;
92 /* is sysfs available (mounted) ? */
93 static int sysfs_available = -1;
95 /* how many times have we initted (and not exited) ? */
96 static int init_count = 0;
99 /* have no authority to operate usb device directly */
100 static int weak_authority = 0;
103 /* Serialize hotplug start/stop */
104 static usbi_mutex_static_t linux_hotplug_startstop_lock = USBI_MUTEX_INITIALIZER;
105 /* Serialize scan-devices, event-thread, and poll */
106 usbi_mutex_static_t linux_hotplug_lock = USBI_MUTEX_INITIALIZER;
108 static int linux_scan_devices(struct libusb_context *ctx);
109 static int detach_kernel_driver_and_claim(struct libusb_device_handle *, uint8_t);
111 #if !defined(HAVE_LIBUDEV)
112 static int linux_default_scan_devices(struct libusb_context *ctx);
115 struct kernel_version {
121 struct config_descriptor {
122 struct usbi_configuration_descriptor *desc;
126 struct linux_device_priv {
129 size_t descriptors_len;
130 struct config_descriptor *config_descriptors;
131 uint8_t active_config; /* cache val for !sysfs_available */
134 struct linux_device_handle_priv {
143 /* submission failed after the first URB, so await cancellation/completion
144 * of all the others */
147 /* cancelled by user or timeout */
150 /* completed multi-URB transfer in non-final URB */
153 /* one or more urbs encountered a low-level error */
157 struct linux_transfer_priv {
159 struct usbfs_urb *urbs;
160 struct usbfs_urb **iso_urbs;
163 enum reap_action reap_action;
166 enum libusb_transfer_status reap_status;
168 /* next iso packet in user-supplied transfer to be populated */
169 int iso_packet_offset;
172 static int get_usbfs_fd(struct libusb_device *dev, mode_t mode, int silent)
174 struct libusb_context *ctx = DEVICE_CTX(dev);
179 sprintf(path, USBDEV_PATH "/usbdev%u.%u",
180 dev->bus_number, dev->device_address);
182 sprintf(path, USB_DEVTMPFS_PATH "/%03u/%03u",
183 dev->bus_number, dev->device_address);
185 fd = open(path, mode | O_CLOEXEC);
187 return fd; /* Success */
189 if (errno == ENOENT) {
190 const long delay_ms = 10L;
191 const struct timespec delay_ts = { 0L, delay_ms * 1000L * 1000L };
194 usbi_err(ctx, "File doesn't exist, wait %ld ms and try again", delay_ms);
196 /* Wait 10ms for USB device path creation.*/
197 nanosleep(&delay_ts, NULL);
199 fd = open(path, mode | O_CLOEXEC);
201 return fd; /* Success */
205 usbi_err(ctx, "libusb couldn't open USB device %s, errno=%d", path, errno);
206 if (errno == EACCES && mode == O_RDWR)
207 usbi_err(ctx, "libusb requires write access to USB device nodes");
211 return LIBUSB_ERROR_ACCESS;
213 return LIBUSB_ERROR_NO_DEVICE;
214 return LIBUSB_ERROR_IO;
217 /* check dirent for a /dev/usbdev%d.%d name
218 * optionally return bus/device on success */
219 static int is_usbdev_entry(const char *name, uint8_t *bus_p, uint8_t *dev_p)
223 if (sscanf(name, "usbdev%d.%d", &busnum, &devnum) != 2)
225 if (busnum < 0 || busnum > UINT8_MAX || devnum < 0 || devnum > UINT8_MAX) {
226 usbi_dbg("invalid usbdev format '%s'", name);
230 usbi_dbg("found: %s", name);
232 *bus_p = (uint8_t)busnum;
234 *dev_p = (uint8_t)devnum;
238 static const char *find_usbfs_path(void)
242 struct dirent *entry;
244 path = USB_DEVTMPFS_PATH;
247 while ((entry = readdir(dir))) {
248 if (entry->d_name[0] == '.')
251 /* We assume if we find any files that it must be the right place */
261 /* look for /dev/usbdev*.* if the normal place fails */
265 while ((entry = readdir(dir))) {
266 if (entry->d_name[0] == '.')
269 if (is_usbdev_entry(entry->d_name, NULL, NULL)) {
270 /* found one; that's enough */
283 /* On udev based systems without any usb-devices /dev/bus/usb will not
284 * exist. So if we've not found anything and we're using udev for hotplug
285 * simply assume /dev/bus/usb rather then making libusb_init fail.
286 * Make the same assumption for Android where SELinux policies might block us
287 * from reading /dev on newer devices. */
288 #if defined(HAVE_LIBUDEV) || defined(__ANDROID__)
289 return USB_DEVTMPFS_PATH;
295 static int get_kernel_version(struct libusb_context *ctx,
296 struct kernel_version *ver)
301 if (uname(&uts) < 0) {
302 usbi_err(ctx, "uname failed, errno=%d", errno);
306 atoms = sscanf(uts.release, "%d.%d.%d", &ver->major, &ver->minor, &ver->sublevel);
308 usbi_err(ctx, "failed to parse uname release '%s'", uts.release);
315 usbi_dbg("reported kernel version is %s", uts.release);
320 static int kernel_version_ge(const struct kernel_version *ver,
321 int major, int minor, int sublevel)
323 if (ver->major > major)
325 else if (ver->major < major)
328 /* kmajor == major */
329 if (ver->minor > minor)
331 else if (ver->minor < minor)
334 /* kminor == minor */
335 if (ver->sublevel == -1)
336 return sublevel == 0;
338 return ver->sublevel >= sublevel;
341 static int op_init(struct libusb_context *ctx)
343 struct kernel_version kversion;
344 const char *usbfs_path;
347 if (get_kernel_version(ctx, &kversion) < 0)
348 return LIBUSB_ERROR_OTHER;
350 if (!kernel_version_ge(&kversion, 2, 6, 32)) {
351 usbi_err(ctx, "kernel version is too old (reported as %d.%d.%d)",
352 kversion.major, kversion.minor,
353 kversion.sublevel != -1 ? kversion.sublevel : 0);
354 return LIBUSB_ERROR_NOT_SUPPORTED;
357 usbfs_path = find_usbfs_path();
359 usbi_err(ctx, "could not find usbfs");
360 return LIBUSB_ERROR_OTHER;
363 usbi_dbg("found usbfs at %s", usbfs_path);
365 if (!max_iso_packet_len) {
366 if (kernel_version_ge(&kversion, 5, 2, 0))
367 max_iso_packet_len = 98304;
368 else if (kernel_version_ge(&kversion, 3, 10, 0))
369 max_iso_packet_len = 49152;
371 max_iso_packet_len = 8192;
374 usbi_dbg("max iso packet length is (likely) %u bytes", max_iso_packet_len);
376 if (sysfs_available == -1) {
377 struct statfs statfsbuf;
379 r = statfs(SYSFS_MOUNT_PATH, &statfsbuf);
380 if (r == 0 && statfsbuf.f_type == SYSFS_MAGIC) {
381 usbi_dbg("sysfs is available");
384 usbi_warn(ctx, "sysfs not mounted");
390 if (weak_authority) {
391 return LIBUSB_SUCCESS;
395 usbi_mutex_static_lock(&linux_hotplug_startstop_lock);
397 if (init_count == 0) {
398 /* start up hotplug event handler */
399 r = linux_start_event_monitor();
401 if (r == LIBUSB_SUCCESS) {
402 r = linux_scan_devices(ctx);
403 if (r == LIBUSB_SUCCESS)
405 else if (init_count == 0)
406 linux_stop_event_monitor();
408 usbi_err(ctx, "error starting hotplug event monitor");
410 usbi_mutex_static_unlock(&linux_hotplug_startstop_lock);
415 static void op_exit(struct libusb_context *ctx)
418 usbi_mutex_static_lock(&linux_hotplug_startstop_lock);
419 assert(init_count != 0);
421 /* tear down event handler */
422 linux_stop_event_monitor();
424 usbi_mutex_static_unlock(&linux_hotplug_startstop_lock);
427 static int op_set_option(struct libusb_context *ctx, enum libusb_option option, va_list ap)
433 if (option == LIBUSB_OPTION_WEAK_AUTHORITY) {
434 usbi_dbg("set libusb has weak authority");
436 return LIBUSB_SUCCESS;
442 return LIBUSB_ERROR_NOT_SUPPORTED;
445 static int linux_scan_devices(struct libusb_context *ctx)
449 usbi_mutex_static_lock(&linux_hotplug_lock);
451 #if defined(HAVE_LIBUDEV)
452 ret = linux_udev_scan_devices(ctx);
454 ret = linux_default_scan_devices(ctx);
457 usbi_mutex_static_unlock(&linux_hotplug_lock);
462 static void op_hotplug_poll(void)
464 linux_hotplug_poll();
467 static int open_sysfs_attr(struct libusb_context *ctx,
468 const char *sysfs_dir, const char *attr)
473 snprintf(filename, sizeof(filename), SYSFS_DEVICE_PATH "/%s/%s", sysfs_dir, attr);
474 fd = open(filename, O_RDONLY | O_CLOEXEC);
476 if (errno == ENOENT) {
477 /* File doesn't exist. Assume the device has been
478 disconnected (see trac ticket #70). */
479 return LIBUSB_ERROR_NO_DEVICE;
481 usbi_err(ctx, "open %s failed, errno=%d", filename, errno);
482 return LIBUSB_ERROR_IO;
488 /* Note only suitable for attributes which always read >= 0, < 0 is error */
489 static int read_sysfs_attr(struct libusb_context *ctx,
490 const char *sysfs_dir, const char *attr, int max_value, int *value_p)
492 char buf[20], *endptr;
497 fd = open_sysfs_attr(ctx, sysfs_dir, attr);
501 r = read(fd, buf, sizeof(buf));
506 return LIBUSB_ERROR_NO_DEVICE;
507 usbi_err(ctx, "attribute %s read failed, errno=%zd", attr, r);
508 return LIBUSB_ERROR_IO;
513 /* Certain attributes (e.g. bConfigurationValue) are not
514 * populated if the device is not configured. */
519 /* The kernel does *not* NULL-terminate the string, but every attribute
520 * should be terminated with a newline character. */
521 if (!isdigit(buf[0])) {
522 usbi_err(ctx, "attribute %s doesn't have numeric value?", attr);
523 return LIBUSB_ERROR_IO;
524 } else if (buf[r - 1] != '\n') {
525 usbi_err(ctx, "attribute %s doesn't end with newline?", attr);
526 return LIBUSB_ERROR_IO;
531 value = strtol(buf, &endptr, 10);
532 if (value < 0 || value > (long)max_value || errno) {
533 usbi_err(ctx, "attribute %s contains an invalid value: '%s'", attr, buf);
534 return LIBUSB_ERROR_INVALID_PARAM;
535 } else if (*endptr != '\0') {
536 /* Consider the value to be valid if the remainder is a '.'
537 * character followed by numbers. This occurs, for example,
538 * when reading the "speed" attribute for a low-speed device
540 if (*endptr == '.' && isdigit(*(endptr + 1))) {
542 while (isdigit(*endptr))
545 if (*endptr != '\0') {
546 usbi_err(ctx, "attribute %s contains an invalid value: '%s'", attr, buf);
547 return LIBUSB_ERROR_INVALID_PARAM;
551 *value_p = (int)value;
555 static int sysfs_scan_device(struct libusb_context *ctx, const char *devname)
557 uint8_t busnum, devaddr;
560 ret = linux_get_device_address(ctx, 0, &busnum, &devaddr, NULL, devname, -1);
561 if (ret != LIBUSB_SUCCESS)
564 return linux_enumerate_device(ctx, busnum, devaddr, devname);
567 /* read the bConfigurationValue for a device */
568 static int sysfs_get_active_config(struct libusb_device *dev, uint8_t *config)
570 struct linux_device_priv *priv = usbi_get_device_priv(dev);
573 ret = read_sysfs_attr(DEVICE_CTX(dev), priv->sysfs_dir, "bConfigurationValue",
579 tmp = 0; /* unconfigured */
581 *config = (uint8_t)tmp;
586 int linux_get_device_address(struct libusb_context *ctx, int detached,
587 uint8_t *busnum, uint8_t *devaddr, const char *dev_node,
588 const char *sys_name, int fd)
593 usbi_dbg("getting address for device: %s detached: %d", sys_name, detached);
594 /* can't use sysfs to read the bus and device number if the
595 * device has been detached */
596 if (!sysfs_available || detached || !sys_name) {
597 if (!dev_node && fd >= 0) {
598 char *fd_path = alloca(PATH_MAX);
601 /* try to retrieve the device node from fd */
602 sprintf(proc_path, "/proc/self/fd/%d", fd);
603 r = readlink(proc_path, fd_path, PATH_MAX - 1);
611 return LIBUSB_ERROR_OTHER;
613 /* will this work with all supported kernel versions? */
614 if (!strncmp(dev_node, "/dev/bus/usb", 12))
615 sscanf(dev_node, "/dev/bus/usb/%hhu/%hhu", busnum, devaddr);
617 return LIBUSB_ERROR_OTHER;
619 return LIBUSB_SUCCESS;
622 usbi_dbg("scan %s", sys_name);
624 r = read_sysfs_attr(ctx, sys_name, "busnum", UINT8_MAX, &sysfs_val);
627 *busnum = (uint8_t)sysfs_val;
629 r = read_sysfs_attr(ctx, sys_name, "devnum", UINT8_MAX, &sysfs_val);
632 *devaddr = (uint8_t)sysfs_val;
634 usbi_dbg("bus=%u dev=%u", *busnum, *devaddr);
636 return LIBUSB_SUCCESS;
639 /* Return offset of the next config descriptor */
640 static int seek_to_next_config(struct libusb_context *ctx,
641 uint8_t *buffer, size_t len)
643 struct usbi_descriptor_header *header;
646 /* Start seeking past the config descriptor */
647 offset = LIBUSB_DT_CONFIG_SIZE;
648 buffer += LIBUSB_DT_CONFIG_SIZE;
649 len -= LIBUSB_DT_CONFIG_SIZE;
653 usbi_err(ctx, "short descriptor read %zu/2", len);
654 return LIBUSB_ERROR_IO;
657 header = (struct usbi_descriptor_header *)buffer;
658 if (header->bDescriptorType == LIBUSB_DT_CONFIG)
661 if (len < header->bLength) {
662 usbi_err(ctx, "bLength overflow by %zu bytes",
663 (size_t)header->bLength - len);
664 return LIBUSB_ERROR_IO;
667 offset += header->bLength;
668 buffer += header->bLength;
669 len -= header->bLength;
672 usbi_err(ctx, "config descriptor not found");
673 return LIBUSB_ERROR_IO;
676 static int parse_config_descriptors(struct libusb_device *dev)
678 struct libusb_context *ctx = DEVICE_CTX(dev);
679 struct linux_device_priv *priv = usbi_get_device_priv(dev);
680 struct usbi_device_descriptor *device_desc;
681 uint8_t idx, num_configs;
685 device_desc = priv->descriptors;
686 num_configs = device_desc->bNumConfigurations;
688 if (num_configs == 0)
689 return 0; /* no configurations? */
691 priv->config_descriptors = malloc(num_configs * sizeof(priv->config_descriptors[0]));
692 if (!priv->config_descriptors)
693 return LIBUSB_ERROR_NO_MEM;
695 buffer = (uint8_t *)priv->descriptors + LIBUSB_DT_DEVICE_SIZE;
696 remaining = priv->descriptors_len - LIBUSB_DT_DEVICE_SIZE;
698 for (idx = 0; idx < num_configs; idx++) {
699 struct usbi_configuration_descriptor *config_desc;
702 if (remaining < LIBUSB_DT_CONFIG_SIZE) {
703 usbi_err(ctx, "short descriptor read %zu/%d",
704 remaining, LIBUSB_DT_CONFIG_SIZE);
705 return LIBUSB_ERROR_IO;
708 config_desc = (struct usbi_configuration_descriptor *)buffer;
709 if (config_desc->bDescriptorType != LIBUSB_DT_CONFIG) {
710 usbi_err(ctx, "descriptor is not a config desc (type 0x%02x)",
711 config_desc->bDescriptorType);
712 return LIBUSB_ERROR_IO;
713 } else if (config_desc->bLength < LIBUSB_DT_CONFIG_SIZE) {
714 usbi_err(ctx, "invalid descriptor bLength %u",
715 config_desc->bLength);
716 return LIBUSB_ERROR_IO;
719 config_len = libusb_le16_to_cpu(config_desc->wTotalLength);
720 if (config_len < LIBUSB_DT_CONFIG_SIZE) {
721 usbi_err(ctx, "invalid wTotalLength %u", config_len);
722 return LIBUSB_ERROR_IO;
725 if (priv->sysfs_dir) {
727 * In sysfs wTotalLength is ignored, instead the kernel returns a
728 * config descriptor with verified bLength fields, with descriptors
729 * with an invalid bLength removed.
731 uint16_t sysfs_config_len;
734 if (num_configs > 1 && idx < num_configs - 1) {
735 offset = seek_to_next_config(ctx, buffer, remaining);
738 sysfs_config_len = (uint16_t)offset;
740 sysfs_config_len = (uint16_t)remaining;
743 if (config_len != sysfs_config_len) {
744 usbi_warn(ctx, "config length mismatch wTotalLength %u real %u",
745 config_len, sysfs_config_len);
746 config_len = sysfs_config_len;
750 * In usbfs the config descriptors are wTotalLength bytes apart,
751 * with any short reads from the device appearing as holes in the file.
753 if (config_len > remaining) {
754 usbi_warn(ctx, "short descriptor read %zu/%u", remaining, config_len);
755 config_len = (uint16_t)remaining;
759 priv->config_descriptors[idx].desc = config_desc;
760 priv->config_descriptors[idx].actual_len = config_len;
762 buffer += config_len;
763 remaining -= config_len;
766 return LIBUSB_SUCCESS;
769 static int op_get_config_descriptor_by_value(struct libusb_device *dev,
770 uint8_t value, void **buffer)
772 struct linux_device_priv *priv = usbi_get_device_priv(dev);
773 struct config_descriptor *config;
776 for (idx = 0; idx < dev->device_descriptor.bNumConfigurations; idx++) {
777 config = &priv->config_descriptors[idx];
778 if (config->desc->bConfigurationValue == value) {
779 *buffer = config->desc;
780 return (int)config->actual_len;
784 return LIBUSB_ERROR_NOT_FOUND;
787 static int op_get_active_config_descriptor(struct libusb_device *dev,
788 void *buffer, size_t len)
790 struct linux_device_priv *priv = usbi_get_device_priv(dev);
792 uint8_t active_config;
795 if (priv->sysfs_dir) {
796 r = sysfs_get_active_config(dev, &active_config);
800 /* Use cached bConfigurationValue */
801 active_config = priv->active_config;
804 if (active_config == 0) {
805 usbi_err(DEVICE_CTX(dev), "device unconfigured");
806 return LIBUSB_ERROR_NOT_FOUND;
809 r = op_get_config_descriptor_by_value(dev, active_config, &config_desc);
813 len = MIN(len, (size_t)r);
814 memcpy(buffer, config_desc, len);
818 static int op_get_config_descriptor(struct libusb_device *dev,
819 uint8_t config_index, void *buffer, size_t len)
821 struct linux_device_priv *priv = usbi_get_device_priv(dev);
822 struct config_descriptor *config;
824 if (config_index >= dev->device_descriptor.bNumConfigurations)
825 return LIBUSB_ERROR_NOT_FOUND;
827 config = &priv->config_descriptors[config_index];
828 len = MIN(len, config->actual_len);
829 memcpy(buffer, config->desc, len);
833 /* send a control message to retrieve active configuration */
834 static int usbfs_get_active_config(struct libusb_device *dev, int fd)
836 struct linux_device_priv *priv = usbi_get_device_priv(dev);
837 uint8_t active_config = 0;
840 struct usbfs_ctrltransfer ctrl = {
841 .bmRequestType = LIBUSB_ENDPOINT_IN,
842 .bRequest = LIBUSB_REQUEST_GET_CONFIGURATION,
847 .data = &active_config
850 r = ioctl(fd, IOCTL_USBFS_CONTROL, &ctrl);
853 return LIBUSB_ERROR_NO_DEVICE;
855 /* we hit this error path frequently with buggy devices :( */
856 usbi_warn(DEVICE_CTX(dev), "get configuration failed, errno=%d", errno);
857 } else if (active_config == 0) {
858 /* some buggy devices have a configuration 0, but we're
859 * reaching into the corner of a corner case here, so let's
860 * not support buggy devices in these circumstances.
861 * stick to the specs: a configuration value of 0 means
863 usbi_warn(DEVICE_CTX(dev), "active cfg 0? assuming unconfigured device");
866 priv->active_config = active_config;
868 return LIBUSB_SUCCESS;
871 static enum libusb_speed usbfs_get_speed(struct libusb_context *ctx, int fd)
875 r = ioctl(fd, IOCTL_USBFS_GET_SPEED, NULL);
877 case USBFS_SPEED_UNKNOWN: return LIBUSB_SPEED_UNKNOWN;
878 case USBFS_SPEED_LOW: return LIBUSB_SPEED_LOW;
879 case USBFS_SPEED_FULL: return LIBUSB_SPEED_FULL;
880 case USBFS_SPEED_HIGH: return LIBUSB_SPEED_HIGH;
881 case USBFS_SPEED_WIRELESS: return LIBUSB_SPEED_HIGH;
882 case USBFS_SPEED_SUPER: return LIBUSB_SPEED_SUPER;
883 case USBFS_SPEED_SUPER_PLUS: return LIBUSB_SPEED_SUPER_PLUS;
885 usbi_warn(ctx, "Error getting device speed: %d", r);
888 return LIBUSB_SPEED_UNKNOWN;
891 static int initialize_device(struct libusb_device *dev, uint8_t busnum,
892 uint8_t devaddr, const char *sysfs_dir, int wrapped_fd)
894 struct linux_device_priv *priv = usbi_get_device_priv(dev);
895 struct libusb_context *ctx = DEVICE_CTX(dev);
900 dev->bus_number = busnum;
901 dev->device_address = devaddr;
904 priv->sysfs_dir = strdup(sysfs_dir);
905 if (!priv->sysfs_dir)
906 return LIBUSB_ERROR_NO_MEM;
908 /* Note speed can contain 1.5, in this case read_sysfs_attr()
909 will stop parsing at the '.' and return 1 */
910 if (read_sysfs_attr(ctx, sysfs_dir, "speed", INT_MAX, &speed) == 0) {
912 case 1: dev->speed = LIBUSB_SPEED_LOW; break;
913 case 12: dev->speed = LIBUSB_SPEED_FULL; break;
914 case 480: dev->speed = LIBUSB_SPEED_HIGH; break;
915 case 5000: dev->speed = LIBUSB_SPEED_SUPER; break;
916 case 10000: dev->speed = LIBUSB_SPEED_SUPER_PLUS; break;
918 usbi_warn(ctx, "unknown device speed: %d Mbps", speed);
921 } else if (wrapped_fd >= 0) {
922 dev->speed = usbfs_get_speed(ctx, wrapped_fd);
925 /* cache descriptors in memory */
927 fd = open_sysfs_attr(ctx, sysfs_dir, "descriptors");
928 } else if (wrapped_fd < 0) {
929 fd = get_usbfs_fd(dev, O_RDONLY, 0);
932 r = lseek(fd, 0, SEEK_SET);
934 usbi_err(ctx, "lseek failed, errno=%d", errno);
935 return LIBUSB_ERROR_IO;
943 const size_t desc_read_length = 256;
946 alloc_len += desc_read_length;
947 priv->descriptors = usbi_reallocf(priv->descriptors, alloc_len);
948 if (!priv->descriptors) {
949 if (fd != wrapped_fd)
951 return LIBUSB_ERROR_NO_MEM;
953 read_ptr = (uint8_t *)priv->descriptors + priv->descriptors_len;
954 /* usbfs has holes in the file */
956 memset(read_ptr, 0, desc_read_length);
957 nb = read(fd, read_ptr, desc_read_length);
959 usbi_err(ctx, "read descriptor failed, errno=%d", errno);
960 if (fd != wrapped_fd)
962 return LIBUSB_ERROR_IO;
964 priv->descriptors_len += (size_t)nb;
965 } while (priv->descriptors_len == alloc_len);
967 if (fd != wrapped_fd)
970 if (priv->descriptors_len < LIBUSB_DT_DEVICE_SIZE) {
971 usbi_err(ctx, "short descriptor read (%zu)", priv->descriptors_len);
972 return LIBUSB_ERROR_IO;
975 r = parse_config_descriptors(dev);
979 memcpy(&dev->device_descriptor, priv->descriptors, LIBUSB_DT_DEVICE_SIZE);
982 /* sysfs descriptors are in bus-endian format */
983 usbi_localize_device_descriptor(&dev->device_descriptor);
984 return LIBUSB_SUCCESS;
987 /* cache active config */
989 fd = get_usbfs_fd(dev, O_RDWR, 1);
993 /* cannot send a control message to determine the active
994 * config. just assume the first one is active. */
995 usbi_warn(ctx, "Missing rw usbfs access; cannot determine "
996 "active configuration descriptor");
997 if (priv->config_descriptors)
998 priv->active_config = priv->config_descriptors[0].desc->bConfigurationValue;
1000 priv->active_config = 0; /* No config dt */
1002 return LIBUSB_SUCCESS;
1005 r = usbfs_get_active_config(dev, fd);
1006 if (fd != wrapped_fd)
1012 static int linux_get_parent_info(struct libusb_device *dev, const char *sysfs_dir)
1014 struct libusb_context *ctx = DEVICE_CTX(dev);
1015 struct libusb_device *it;
1016 char *parent_sysfs_dir, *tmp;
1017 int ret, add_parent = 1;
1019 /* XXX -- can we figure out the topology when using usbfs? */
1020 if (!sysfs_dir || !strncmp(sysfs_dir, "usb", 3)) {
1021 /* either using usbfs or finding the parent of a root hub */
1022 return LIBUSB_SUCCESS;
1025 parent_sysfs_dir = strdup(sysfs_dir);
1026 if (!parent_sysfs_dir)
1027 return LIBUSB_ERROR_NO_MEM;
1029 if ((tmp = strrchr(parent_sysfs_dir, '.')) ||
1030 (tmp = strrchr(parent_sysfs_dir, '-'))) {
1031 dev->port_number = atoi(tmp + 1);
1034 usbi_warn(ctx, "Can not parse sysfs_dir: %s, no parent info",
1036 free(parent_sysfs_dir);
1037 return LIBUSB_SUCCESS;
1040 /* is the parent a root hub? */
1041 if (!strchr(parent_sysfs_dir, '-')) {
1042 tmp = parent_sysfs_dir;
1043 ret = asprintf(&parent_sysfs_dir, "usb%s", tmp);
1046 return LIBUSB_ERROR_NO_MEM;
1050 /* find the parent in the context */
1051 usbi_mutex_lock(&ctx->usb_devs_lock);
1052 for_each_device(ctx, it) {
1053 struct linux_device_priv *priv = usbi_get_device_priv(it);
1055 if (priv->sysfs_dir) {
1056 if (!strcmp(priv->sysfs_dir, parent_sysfs_dir)) {
1057 dev->parent_dev = libusb_ref_device(it);
1062 usbi_mutex_unlock(&ctx->usb_devs_lock);
1064 if (!dev->parent_dev && add_parent) {
1065 usbi_dbg("parent_dev %s not enumerated yet, enumerating now",
1067 sysfs_scan_device(ctx, parent_sysfs_dir);
1072 usbi_dbg("dev %p (%s) has parent %p (%s) port %u", dev, sysfs_dir,
1073 dev->parent_dev, parent_sysfs_dir, dev->port_number);
1075 free(parent_sysfs_dir);
1077 return LIBUSB_SUCCESS;
1080 int linux_enumerate_device(struct libusb_context *ctx,
1081 uint8_t busnum, uint8_t devaddr, const char *sysfs_dir)
1083 unsigned long session_id;
1084 struct libusb_device *dev;
1087 /* FIXME: session ID is not guaranteed unique as addresses can wrap and
1088 * will be reused. instead we should add a simple sysfs attribute with
1090 session_id = busnum << 8 | devaddr;
1091 usbi_dbg("busnum %u devaddr %u session_id %lu", busnum, devaddr, session_id);
1093 dev = usbi_get_device_by_session_id(ctx, session_id);
1095 /* device already exists in the context */
1096 usbi_dbg("session_id %lu already exists", session_id);
1097 libusb_unref_device(dev);
1098 return LIBUSB_SUCCESS;
1101 usbi_dbg("allocating new device for %u/%u (session %lu)",
1102 busnum, devaddr, session_id);
1103 dev = usbi_alloc_device(ctx, session_id);
1105 return LIBUSB_ERROR_NO_MEM;
1107 r = initialize_device(dev, busnum, devaddr, sysfs_dir, -1);
1110 r = usbi_sanitize_device(dev);
1114 r = linux_get_parent_info(dev, sysfs_dir);
1119 libusb_unref_device(dev);
1121 usbi_connect_device(dev);
1126 void linux_hotplug_enumerate(uint8_t busnum, uint8_t devaddr, const char *sys_name)
1128 struct libusb_context *ctx;
1130 usbi_mutex_static_lock(&active_contexts_lock);
1131 for_each_context(ctx) {
1132 linux_enumerate_device(ctx, busnum, devaddr, sys_name);
1134 usbi_mutex_static_unlock(&active_contexts_lock);
1137 void linux_device_disconnected(uint8_t busnum, uint8_t devaddr)
1139 struct libusb_context *ctx;
1140 struct libusb_device *dev;
1141 unsigned long session_id = busnum << 8 | devaddr;
1143 usbi_mutex_static_lock(&active_contexts_lock);
1144 for_each_context(ctx) {
1145 dev = usbi_get_device_by_session_id(ctx, session_id);
1147 usbi_disconnect_device(dev);
1148 libusb_unref_device(dev);
1150 usbi_dbg("device not found for session %lx", session_id);
1153 usbi_mutex_static_unlock(&active_contexts_lock);
1156 #if !defined(HAVE_LIBUDEV)
1157 static int parse_u8(const char *str, uint8_t *val_p)
1163 num = strtol(str, &endptr, 10);
1164 if (num < 0 || num > UINT8_MAX || errno)
1166 if (endptr == str || *endptr != '\0')
1169 *val_p = (uint8_t)num;
1173 /* open a bus directory and adds all discovered devices to the context */
1174 static int usbfs_scan_busdir(struct libusb_context *ctx, uint8_t busnum)
1178 struct dirent *entry;
1179 int r = LIBUSB_ERROR_IO;
1181 sprintf(dirpath, USB_DEVTMPFS_PATH "/%03u", busnum);
1182 usbi_dbg("%s", dirpath);
1183 dir = opendir(dirpath);
1185 usbi_err(ctx, "opendir '%s' failed, errno=%d", dirpath, errno);
1186 /* FIXME: should handle valid race conditions like hub unplugged
1187 * during directory iteration - this is not an error */
1191 while ((entry = readdir(dir))) {
1194 if (entry->d_name[0] == '.')
1197 if (!parse_u8(entry->d_name, &devaddr)) {
1198 usbi_dbg("unknown dir entry %s", entry->d_name);
1202 if (linux_enumerate_device(ctx, busnum, devaddr, NULL)) {
1203 usbi_dbg("failed to enumerate dir entry %s", entry->d_name);
1214 static int usbfs_get_device_list(struct libusb_context *ctx)
1216 struct dirent *entry;
1218 uint8_t busnum, devaddr;
1222 buses = opendir(USBDEV_PATH);
1224 buses = opendir(USB_DEVTMPFS_PATH);
1227 usbi_err(ctx, "opendir buses failed, errno=%d", errno);
1228 return LIBUSB_ERROR_IO;
1231 while ((entry = readdir(buses))) {
1232 if (entry->d_name[0] == '.')
1236 if (!is_usbdev_entry(entry->d_name, &busnum, &devaddr))
1239 r = linux_enumerate_device(ctx, busnum, devaddr, NULL);
1241 usbi_dbg("failed to enumerate dir entry %s", entry->d_name);
1245 if (!parse_u8(entry->d_name, &busnum)) {
1246 usbi_dbg("unknown dir entry %s", entry->d_name);
1250 r = usbfs_scan_busdir(ctx, busnum);
1261 static int sysfs_get_device_list(struct libusb_context *ctx)
1263 DIR *devices = opendir(SYSFS_DEVICE_PATH);
1264 struct dirent *entry;
1265 int num_devices = 0;
1266 int num_enumerated = 0;
1269 usbi_err(ctx, "opendir devices failed, errno=%d", errno);
1270 return LIBUSB_ERROR_IO;
1273 while ((entry = readdir(devices))) {
1274 if ((!isdigit(entry->d_name[0]) && strncmp(entry->d_name, "usb", 3))
1275 || strchr(entry->d_name, ':'))
1280 if (sysfs_scan_device(ctx, entry->d_name)) {
1281 usbi_dbg("failed to enumerate dir entry %s", entry->d_name);
1290 /* successful if at least one device was enumerated or no devices were found */
1291 if (num_enumerated || !num_devices)
1292 return LIBUSB_SUCCESS;
1294 return LIBUSB_ERROR_IO;
1297 static int linux_default_scan_devices(struct libusb_context *ctx)
1299 /* we can retrieve device list and descriptors from sysfs or usbfs.
1300 * sysfs is preferable, because if we use usbfs we end up resuming
1301 * any autosuspended USB devices. however, sysfs is not available
1302 * everywhere, so we need a usbfs fallback too.
1304 if (sysfs_available)
1305 return sysfs_get_device_list(ctx);
1307 return usbfs_get_device_list(ctx);
1311 static int initialize_handle(struct libusb_device_handle *handle, int fd)
1313 struct linux_device_handle_priv *hpriv = usbi_get_device_handle_priv(handle);
1318 r = ioctl(fd, IOCTL_USBFS_GET_CAPABILITIES, &hpriv->caps);
1320 if (errno == ENOTTY)
1321 usbi_dbg("getcap not available");
1323 usbi_err(HANDLE_CTX(handle), "getcap failed, errno=%d", errno);
1324 hpriv->caps = USBFS_CAP_BULK_CONTINUATION;
1327 return usbi_add_event_source(HANDLE_CTX(handle), hpriv->fd, POLLOUT);
1330 static int op_wrap_sys_device(struct libusb_context *ctx,
1331 struct libusb_device_handle *handle, intptr_t sys_dev)
1333 struct linux_device_handle_priv *hpriv = usbi_get_device_handle_priv(handle);
1334 int fd = (int)sys_dev;
1335 uint8_t busnum, devaddr;
1336 struct usbfs_connectinfo ci;
1337 struct libusb_device *dev;
1340 r = linux_get_device_address(ctx, 1, &busnum, &devaddr, NULL, NULL, fd);
1342 r = ioctl(fd, IOCTL_USBFS_CONNECTINFO, &ci);
1344 usbi_err(ctx, "connectinfo failed, errno=%d", errno);
1345 return LIBUSB_ERROR_IO;
1347 /* There is no ioctl to get the bus number. We choose 0 here
1348 * as linux starts numbering buses from 1. */
1350 devaddr = ci.devnum;
1353 /* Session id is unused as we do not add the device to the list of
1354 * connected devices. */
1355 usbi_dbg("allocating new device for fd %d", fd);
1356 dev = usbi_alloc_device(ctx, 0);
1358 return LIBUSB_ERROR_NO_MEM;
1360 r = initialize_device(dev, busnum, devaddr, NULL, fd);
1363 r = usbi_sanitize_device(dev);
1366 /* Consider the device as connected, but do not add it to the managed
1371 r = initialize_handle(handle, fd);
1376 libusb_unref_device(dev);
1380 static int op_open(struct libusb_device_handle *handle)
1384 fd = get_usbfs_fd(handle->dev, O_RDWR, 0);
1386 if (fd == LIBUSB_ERROR_NO_DEVICE) {
1387 /* device will still be marked as attached if hotplug monitor thread
1388 * hasn't processed remove event yet */
1389 usbi_mutex_static_lock(&linux_hotplug_lock);
1390 if (handle->dev->attached) {
1391 usbi_dbg("open failed with no device, but device still attached");
1392 linux_device_disconnected(handle->dev->bus_number,
1393 handle->dev->device_address);
1395 usbi_mutex_static_unlock(&linux_hotplug_lock);
1400 r = initialize_handle(handle, fd);
1407 static void op_close(struct libusb_device_handle *dev_handle)
1409 struct linux_device_handle_priv *hpriv = usbi_get_device_handle_priv(dev_handle);
1411 /* fd may have already been removed by POLLERR condition in op_handle_events() */
1412 if (!hpriv->fd_removed)
1413 usbi_remove_event_source(HANDLE_CTX(dev_handle), hpriv->fd);
1414 if (!hpriv->fd_keep)
1418 static int op_get_configuration(struct libusb_device_handle *handle,
1421 struct linux_device_priv *priv = usbi_get_device_priv(handle->dev);
1424 if (priv->sysfs_dir) {
1425 r = sysfs_get_active_config(handle->dev, config);
1427 struct linux_device_handle_priv *hpriv = usbi_get_device_handle_priv(handle);
1429 r = usbfs_get_active_config(handle->dev, hpriv->fd);
1430 if (r == LIBUSB_SUCCESS)
1431 *config = priv->active_config;
1437 usbi_err(HANDLE_CTX(handle), "device unconfigured");
1442 static int op_set_configuration(struct libusb_device_handle *handle, int config)
1444 struct linux_device_priv *priv = usbi_get_device_priv(handle->dev);
1445 struct linux_device_handle_priv *hpriv = usbi_get_device_handle_priv(handle);
1447 int r = ioctl(fd, IOCTL_USBFS_SETCONFIGURATION, &config);
1450 if (errno == EINVAL)
1451 return LIBUSB_ERROR_NOT_FOUND;
1452 else if (errno == EBUSY)
1453 return LIBUSB_ERROR_BUSY;
1454 else if (errno == ENODEV)
1455 return LIBUSB_ERROR_NO_DEVICE;
1457 usbi_err(HANDLE_CTX(handle), "set configuration failed, errno=%d", errno);
1458 return LIBUSB_ERROR_OTHER;
1464 /* update our cached active config descriptor */
1465 priv->active_config = (uint8_t)config;
1467 return LIBUSB_SUCCESS;
1470 static int claim_interface(struct libusb_device_handle *handle, unsigned int iface)
1472 struct linux_device_handle_priv *hpriv = usbi_get_device_handle_priv(handle);
1474 int r = ioctl(fd, IOCTL_USBFS_CLAIMINTERFACE, &iface);
1477 if (errno == ENOENT)
1478 return LIBUSB_ERROR_NOT_FOUND;
1479 else if (errno == EBUSY)
1480 return LIBUSB_ERROR_BUSY;
1481 else if (errno == ENODEV)
1482 return LIBUSB_ERROR_NO_DEVICE;
1484 usbi_err(HANDLE_CTX(handle), "claim interface failed, errno=%d", errno);
1485 return LIBUSB_ERROR_OTHER;
1490 static int release_interface(struct libusb_device_handle *handle, unsigned int iface)
1492 struct linux_device_handle_priv *hpriv = usbi_get_device_handle_priv(handle);
1494 int r = ioctl(fd, IOCTL_USBFS_RELEASEINTERFACE, &iface);
1497 if (errno == ENODEV)
1498 return LIBUSB_ERROR_NO_DEVICE;
1500 usbi_err(HANDLE_CTX(handle), "release interface failed, errno=%d", errno);
1501 return LIBUSB_ERROR_OTHER;
1506 static int op_set_interface(struct libusb_device_handle *handle, uint8_t interface,
1509 struct linux_device_handle_priv *hpriv = usbi_get_device_handle_priv(handle);
1511 struct usbfs_setinterface setintf;
1514 setintf.interface = interface;
1515 setintf.altsetting = altsetting;
1516 r = ioctl(fd, IOCTL_USBFS_SETINTERFACE, &setintf);
1518 if (errno == EINVAL)
1519 return LIBUSB_ERROR_NOT_FOUND;
1520 else if (errno == ENODEV)
1521 return LIBUSB_ERROR_NO_DEVICE;
1523 usbi_err(HANDLE_CTX(handle), "set interface failed, errno=%d", errno);
1524 return LIBUSB_ERROR_OTHER;
1530 static int op_clear_halt(struct libusb_device_handle *handle,
1531 unsigned char endpoint)
1533 struct linux_device_handle_priv *hpriv = usbi_get_device_handle_priv(handle);
1535 unsigned int _endpoint = endpoint;
1536 int r = ioctl(fd, IOCTL_USBFS_CLEAR_HALT, &_endpoint);
1539 if (errno == ENOENT)
1540 return LIBUSB_ERROR_NOT_FOUND;
1541 else if (errno == ENODEV)
1542 return LIBUSB_ERROR_NO_DEVICE;
1544 usbi_err(HANDLE_CTX(handle), "clear halt failed, errno=%d", errno);
1545 return LIBUSB_ERROR_OTHER;
1551 static int op_reset_device(struct libusb_device_handle *handle)
1553 struct linux_device_handle_priv *hpriv = usbi_get_device_handle_priv(handle);
1558 /* Doing a device reset will cause the usbfs driver to get unbound
1559 * from any interfaces it is bound to. By voluntarily unbinding
1560 * the usbfs driver ourself, we stop the kernel from rebinding
1561 * the interface after reset (which would end up with the interface
1562 * getting bound to the in kernel driver if any). */
1563 for (i = 0; i < USB_MAXINTERFACES; i++) {
1564 if (handle->claimed_interfaces & (1UL << i))
1565 release_interface(handle, i);
1568 usbi_mutex_lock(&handle->lock);
1569 r = ioctl(fd, IOCTL_USBFS_RESET, NULL);
1571 if (errno == ENODEV) {
1572 ret = LIBUSB_ERROR_NOT_FOUND;
1576 usbi_err(HANDLE_CTX(handle), "reset failed, errno=%d", errno);
1577 ret = LIBUSB_ERROR_OTHER;
1581 /* And re-claim any interfaces which were claimed before the reset */
1582 for (i = 0; i < USB_MAXINTERFACES; i++) {
1583 if (!(handle->claimed_interfaces & (1UL << i)))
1586 * A driver may have completed modprobing during
1587 * IOCTL_USBFS_RESET, and bound itself as soon as
1588 * IOCTL_USBFS_RESET released the device lock
1590 r = detach_kernel_driver_and_claim(handle, i);
1592 usbi_warn(HANDLE_CTX(handle), "failed to re-claim interface %u after reset: %s",
1593 i, libusb_error_name(r));
1594 handle->claimed_interfaces &= ~(1UL << i);
1595 ret = LIBUSB_ERROR_NOT_FOUND;
1599 usbi_mutex_unlock(&handle->lock);
1603 static int do_streams_ioctl(struct libusb_device_handle *handle, long req,
1604 uint32_t num_streams, unsigned char *endpoints, int num_endpoints)
1606 struct linux_device_handle_priv *hpriv = usbi_get_device_handle_priv(handle);
1607 int r, fd = hpriv->fd;
1608 struct usbfs_streams *streams;
1610 if (num_endpoints > 30) /* Max 15 in + 15 out eps */
1611 return LIBUSB_ERROR_INVALID_PARAM;
1613 streams = malloc(sizeof(*streams) + num_endpoints);
1615 return LIBUSB_ERROR_NO_MEM;
1617 streams->num_streams = num_streams;
1618 streams->num_eps = num_endpoints;
1619 memcpy(streams->eps, endpoints, num_endpoints);
1621 r = ioctl(fd, req, streams);
1626 if (errno == ENOTTY)
1627 return LIBUSB_ERROR_NOT_SUPPORTED;
1628 else if (errno == EINVAL)
1629 return LIBUSB_ERROR_INVALID_PARAM;
1630 else if (errno == ENODEV)
1631 return LIBUSB_ERROR_NO_DEVICE;
1633 usbi_err(HANDLE_CTX(handle), "streams-ioctl failed, errno=%d", errno);
1634 return LIBUSB_ERROR_OTHER;
1639 static int op_alloc_streams(struct libusb_device_handle *handle,
1640 uint32_t num_streams, unsigned char *endpoints, int num_endpoints)
1642 return do_streams_ioctl(handle, IOCTL_USBFS_ALLOC_STREAMS,
1643 num_streams, endpoints, num_endpoints);
1646 static int op_free_streams(struct libusb_device_handle *handle,
1647 unsigned char *endpoints, int num_endpoints)
1649 return do_streams_ioctl(handle, IOCTL_USBFS_FREE_STREAMS, 0,
1650 endpoints, num_endpoints);
1653 static void *op_dev_mem_alloc(struct libusb_device_handle *handle, size_t len)
1655 struct linux_device_handle_priv *hpriv = usbi_get_device_handle_priv(handle);
1658 buffer = mmap(NULL, len, PROT_READ | PROT_WRITE, MAP_SHARED, hpriv->fd, 0);
1659 if (buffer == MAP_FAILED) {
1660 usbi_err(HANDLE_CTX(handle), "alloc dev mem failed, errno=%d", errno);
1666 static int op_dev_mem_free(struct libusb_device_handle *handle, void *buffer,
1669 if (munmap(buffer, len) != 0) {
1670 usbi_err(HANDLE_CTX(handle), "free dev mem failed, errno=%d", errno);
1671 return LIBUSB_ERROR_OTHER;
1673 return LIBUSB_SUCCESS;
1677 static int op_kernel_driver_active(struct libusb_device_handle *handle,
1680 struct linux_device_handle_priv *hpriv = usbi_get_device_handle_priv(handle);
1682 struct usbfs_getdriver getdrv;
1685 getdrv.interface = interface;
1686 r = ioctl(fd, IOCTL_USBFS_GETDRIVER, &getdrv);
1688 if (errno == ENODATA)
1690 else if (errno == ENODEV)
1691 return LIBUSB_ERROR_NO_DEVICE;
1693 usbi_err(HANDLE_CTX(handle), "get driver failed, errno=%d", errno);
1694 return LIBUSB_ERROR_OTHER;
1697 return strcmp(getdrv.driver, "usbfs") != 0;
1700 static int op_detach_kernel_driver(struct libusb_device_handle *handle,
1703 struct linux_device_handle_priv *hpriv = usbi_get_device_handle_priv(handle);
1705 struct usbfs_ioctl command;
1706 struct usbfs_getdriver getdrv;
1709 command.ifno = interface;
1710 command.ioctl_code = IOCTL_USBFS_DISCONNECT;
1711 command.data = NULL;
1713 getdrv.interface = interface;
1714 r = ioctl(fd, IOCTL_USBFS_GETDRIVER, &getdrv);
1715 if (r == 0 && !strcmp(getdrv.driver, "usbfs"))
1716 return LIBUSB_ERROR_NOT_FOUND;
1718 r = ioctl(fd, IOCTL_USBFS_IOCTL, &command);
1720 if (errno == ENODATA)
1721 return LIBUSB_ERROR_NOT_FOUND;
1722 else if (errno == EINVAL)
1723 return LIBUSB_ERROR_INVALID_PARAM;
1724 else if (errno == ENODEV)
1725 return LIBUSB_ERROR_NO_DEVICE;
1727 usbi_err(HANDLE_CTX(handle), "detach failed, errno=%d", errno);
1728 return LIBUSB_ERROR_OTHER;
1734 static int op_attach_kernel_driver(struct libusb_device_handle *handle,
1737 struct linux_device_handle_priv *hpriv = usbi_get_device_handle_priv(handle);
1739 struct usbfs_ioctl command;
1742 command.ifno = interface;
1743 command.ioctl_code = IOCTL_USBFS_CONNECT;
1744 command.data = NULL;
1746 r = ioctl(fd, IOCTL_USBFS_IOCTL, &command);
1748 if (errno == ENODATA)
1749 return LIBUSB_ERROR_NOT_FOUND;
1750 else if (errno == EINVAL)
1751 return LIBUSB_ERROR_INVALID_PARAM;
1752 else if (errno == ENODEV)
1753 return LIBUSB_ERROR_NO_DEVICE;
1754 else if (errno == EBUSY)
1755 return LIBUSB_ERROR_BUSY;
1757 usbi_err(HANDLE_CTX(handle), "attach failed, errno=%d", errno);
1758 return LIBUSB_ERROR_OTHER;
1759 } else if (r == 0) {
1760 return LIBUSB_ERROR_NOT_FOUND;
1766 static int detach_kernel_driver_and_claim(struct libusb_device_handle *handle,
1769 struct linux_device_handle_priv *hpriv = usbi_get_device_handle_priv(handle);
1770 struct usbfs_disconnect_claim dc;
1771 int r, fd = hpriv->fd;
1773 dc.interface = interface;
1774 strcpy(dc.driver, "usbfs");
1775 dc.flags = USBFS_DISCONNECT_CLAIM_EXCEPT_DRIVER;
1776 r = ioctl(fd, IOCTL_USBFS_DISCONNECT_CLAIM, &dc);
1783 return LIBUSB_ERROR_BUSY;
1785 return LIBUSB_ERROR_INVALID_PARAM;
1787 return LIBUSB_ERROR_NO_DEVICE;
1789 usbi_err(HANDLE_CTX(handle), "disconnect-and-claim failed, errno=%d", errno);
1790 return LIBUSB_ERROR_OTHER;
1793 /* Fallback code for kernels which don't support the
1794 disconnect-and-claim ioctl */
1795 r = op_detach_kernel_driver(handle, interface);
1796 if (r != 0 && r != LIBUSB_ERROR_NOT_FOUND)
1799 return claim_interface(handle, interface);
1802 static int op_claim_interface(struct libusb_device_handle *handle, uint8_t interface)
1804 if (handle->auto_detach_kernel_driver)
1805 return detach_kernel_driver_and_claim(handle, interface);
1807 return claim_interface(handle, interface);
1810 static int op_release_interface(struct libusb_device_handle *handle, uint8_t interface)
1814 r = release_interface(handle, interface);
1818 if (handle->auto_detach_kernel_driver)
1819 op_attach_kernel_driver(handle, interface);
1824 static void op_destroy_device(struct libusb_device *dev)
1826 struct linux_device_priv *priv = usbi_get_device_priv(dev);
1828 free(priv->config_descriptors);
1829 free(priv->descriptors);
1830 free(priv->sysfs_dir);
1833 /* URBs are discarded in reverse order of submission to avoid races. */
1834 static int discard_urbs(struct usbi_transfer *itransfer, int first, int last_plus_one)
1836 struct libusb_transfer *transfer =
1837 USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1838 struct linux_transfer_priv *tpriv = usbi_get_transfer_priv(itransfer);
1839 struct linux_device_handle_priv *hpriv =
1840 usbi_get_device_handle_priv(transfer->dev_handle);
1842 struct usbfs_urb *urb;
1844 for (i = last_plus_one - 1; i >= first; i--) {
1845 if (transfer->type == LIBUSB_TRANSFER_TYPE_ISOCHRONOUS)
1846 urb = tpriv->iso_urbs[i];
1848 urb = &tpriv->urbs[i];
1850 if (ioctl(hpriv->fd, IOCTL_USBFS_DISCARDURB, urb) == 0)
1853 if (errno == EINVAL) {
1854 usbi_dbg("URB not found --> assuming ready to be reaped");
1855 if (i == (last_plus_one - 1))
1856 ret = LIBUSB_ERROR_NOT_FOUND;
1857 } else if (errno == ENODEV) {
1858 usbi_dbg("Device not found for URB --> assuming ready to be reaped");
1859 ret = LIBUSB_ERROR_NO_DEVICE;
1861 usbi_warn(TRANSFER_CTX(transfer), "unrecognised discard errno %d", errno);
1862 ret = LIBUSB_ERROR_OTHER;
1868 static void free_iso_urbs(struct linux_transfer_priv *tpriv)
1872 for (i = 0; i < tpriv->num_urbs; i++) {
1873 struct usbfs_urb *urb = tpriv->iso_urbs[i];
1880 free(tpriv->iso_urbs);
1881 tpriv->iso_urbs = NULL;
1884 static int submit_bulk_transfer(struct usbi_transfer *itransfer)
1886 struct libusb_transfer *transfer =
1887 USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
1888 struct linux_transfer_priv *tpriv = usbi_get_transfer_priv(itransfer);
1889 struct linux_device_handle_priv *hpriv =
1890 usbi_get_device_handle_priv(transfer->dev_handle);
1891 struct usbfs_urb *urbs;
1892 int is_out = IS_XFEROUT(transfer);
1893 int bulk_buffer_len, use_bulk_continuation;
1895 int last_urb_partial = 0;
1900 * Older versions of usbfs place a 16kb limit on bulk URBs. We work
1901 * around this by splitting large transfers into 16k blocks, and then
1902 * submit all urbs at once. it would be simpler to submit one urb at
1903 * a time, but there is a big performance gain doing it this way.
1905 * Newer versions lift the 16k limit (USBFS_CAP_NO_PACKET_SIZE_LIM),
1906 * using arbitrary large transfers can still be a bad idea though, as
1907 * the kernel needs to allocate physical contiguous memory for this,
1908 * which may fail for large buffers.
1910 * The kernel solves this problem by splitting the transfer into
1911 * blocks itself when the host-controller is scatter-gather capable
1912 * (USBFS_CAP_BULK_SCATTER_GATHER), which most controllers are.
1914 * Last, there is the issue of short-transfers when splitting, for
1915 * short split-transfers to work reliable USBFS_CAP_BULK_CONTINUATION
1916 * is needed, but this is not always available.
1918 if (hpriv->caps & USBFS_CAP_BULK_SCATTER_GATHER) {
1919 /* Good! Just submit everything in one go */
1920 bulk_buffer_len = transfer->length ? transfer->length : 1;
1921 use_bulk_continuation = 0;
1922 } else if (hpriv->caps & USBFS_CAP_BULK_CONTINUATION) {
1923 /* Split the transfers and use bulk-continuation to
1924 avoid issues with short-transfers */
1925 bulk_buffer_len = MAX_BULK_BUFFER_LENGTH;
1926 use_bulk_continuation = 1;
1927 } else if (hpriv->caps & USBFS_CAP_NO_PACKET_SIZE_LIM) {
1928 /* Don't split, assume the kernel can alloc the buffer
1929 (otherwise the submit will fail with -ENOMEM) */
1930 bulk_buffer_len = transfer->length ? transfer->length : 1;
1931 use_bulk_continuation = 0;
1933 /* Bad, splitting without bulk-continuation, short transfers
1934 which end before the last urb will not work reliable! */
1935 /* Note we don't warn here as this is "normal" on kernels <
1936 2.6.32 and not a problem for most applications */
1937 bulk_buffer_len = MAX_BULK_BUFFER_LENGTH;
1938 use_bulk_continuation = 0;
1941 num_urbs = transfer->length / bulk_buffer_len;
1943 if (transfer->length == 0) {
1945 } else if ((transfer->length % bulk_buffer_len) > 0) {
1946 last_urb_partial = 1;
1949 usbi_dbg("need %d urbs for new transfer with length %d", num_urbs, transfer->length);
1950 urbs = calloc(num_urbs, sizeof(*urbs));
1952 return LIBUSB_ERROR_NO_MEM;
1954 tpriv->num_urbs = num_urbs;
1955 tpriv->num_retired = 0;
1956 tpriv->reap_action = NORMAL;
1957 tpriv->reap_status = LIBUSB_TRANSFER_COMPLETED;
1959 for (i = 0; i < num_urbs; i++) {
1960 struct usbfs_urb *urb = &urbs[i];
1962 urb->usercontext = itransfer;
1963 switch (transfer->type) {
1964 case LIBUSB_TRANSFER_TYPE_BULK:
1965 urb->type = USBFS_URB_TYPE_BULK;
1968 case LIBUSB_TRANSFER_TYPE_BULK_STREAM:
1969 urb->type = USBFS_URB_TYPE_BULK;
1970 urb->stream_id = itransfer->stream_id;
1972 case LIBUSB_TRANSFER_TYPE_INTERRUPT:
1973 urb->type = USBFS_URB_TYPE_INTERRUPT;
1976 urb->endpoint = transfer->endpoint;
1977 urb->buffer = transfer->buffer + (i * bulk_buffer_len);
1979 /* don't set the short not ok flag for the last URB */
1980 if (use_bulk_continuation && !is_out && (i < num_urbs - 1))
1981 urb->flags = USBFS_URB_SHORT_NOT_OK;
1983 if (i == num_urbs - 1 && last_urb_partial)
1984 urb->buffer_length = transfer->length % bulk_buffer_len;
1985 else if (transfer->length == 0)
1986 urb->buffer_length = 0;
1988 urb->buffer_length = bulk_buffer_len;
1990 if (i > 0 && use_bulk_continuation)
1991 urb->flags |= USBFS_URB_BULK_CONTINUATION;
1993 /* we have already checked that the flag is supported */
1994 if (is_out && i == num_urbs - 1 &&
1995 (transfer->flags & LIBUSB_TRANSFER_ADD_ZERO_PACKET))
1996 urb->flags |= USBFS_URB_ZERO_PACKET;
1998 r = ioctl(hpriv->fd, IOCTL_USBFS_SUBMITURB, urb);
2002 if (errno == ENODEV) {
2003 r = LIBUSB_ERROR_NO_DEVICE;
2004 } else if (errno == ENOMEM) {
2005 r = LIBUSB_ERROR_NO_MEM;
2007 usbi_err(TRANSFER_CTX(transfer), "submiturb failed, errno=%d", errno);
2008 r = LIBUSB_ERROR_IO;
2011 /* if the first URB submission fails, we can simply free up and
2012 * return failure immediately. */
2014 usbi_dbg("first URB failed, easy peasy");
2020 /* if it's not the first URB that failed, the situation is a bit
2021 * tricky. we may need to discard all previous URBs. there are
2023 * - discarding is asynchronous - discarded urbs will be reaped
2024 * later. the user must not have freed the transfer when the
2025 * discarded URBs are reaped, otherwise libusb will be using
2027 * - the earlier URBs may have completed successfully and we do
2028 * not want to throw away any data.
2029 * - this URB failing may be no error; EREMOTEIO means that
2030 * this transfer simply didn't need all the URBs we submitted
2031 * so, we report that the transfer was submitted successfully and
2032 * in case of error we discard all previous URBs. later when
2033 * the final reap completes we can report error to the user,
2034 * or success if an earlier URB was completed successfully.
2036 tpriv->reap_action = errno == EREMOTEIO ? COMPLETED_EARLY : SUBMIT_FAILED;
2038 /* The URBs we haven't submitted yet we count as already
2040 tpriv->num_retired += num_urbs - i;
2042 /* If we completed short then don't try to discard. */
2043 if (tpriv->reap_action == COMPLETED_EARLY)
2046 discard_urbs(itransfer, 0, i);
2048 usbi_dbg("reporting successful submission but waiting for %d "
2049 "discards before reporting error", i);
2056 static int submit_iso_transfer(struct usbi_transfer *itransfer)
2058 struct libusb_transfer *transfer =
2059 USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
2060 struct linux_transfer_priv *tpriv = usbi_get_transfer_priv(itransfer);
2061 struct linux_device_handle_priv *hpriv =
2062 usbi_get_device_handle_priv(transfer->dev_handle);
2063 struct usbfs_urb **urbs;
2064 int num_packets = transfer->num_iso_packets;
2065 int num_packets_remaining;
2068 unsigned int packet_len;
2069 unsigned int total_len = 0;
2070 unsigned char *urb_buffer = transfer->buffer;
2072 if (num_packets < 1)
2073 return LIBUSB_ERROR_INVALID_PARAM;
2075 /* usbfs places arbitrary limits on iso URBs. this limit has changed
2076 * at least three times, but we attempt to detect this limit during
2077 * init and check it here. if the kernel rejects the request due to
2078 * its size, we return an error indicating such to the user.
2080 for (i = 0; i < num_packets; i++) {
2081 packet_len = transfer->iso_packet_desc[i].length;
2083 if (packet_len > max_iso_packet_len) {
2084 usbi_warn(TRANSFER_CTX(transfer),
2085 "iso packet length of %u bytes exceeds maximum of %u bytes",
2086 packet_len, max_iso_packet_len);
2087 return LIBUSB_ERROR_INVALID_PARAM;
2090 total_len += packet_len;
2093 if (transfer->length < (int)total_len)
2094 return LIBUSB_ERROR_INVALID_PARAM;
2096 /* usbfs limits the number of iso packets per URB */
2097 num_urbs = (num_packets + (MAX_ISO_PACKETS_PER_URB - 1)) / MAX_ISO_PACKETS_PER_URB;
2099 usbi_dbg("need %d urbs for new transfer with length %d", num_urbs, transfer->length);
2101 urbs = calloc(num_urbs, sizeof(*urbs));
2103 return LIBUSB_ERROR_NO_MEM;
2105 tpriv->iso_urbs = urbs;
2106 tpriv->num_urbs = num_urbs;
2107 tpriv->num_retired = 0;
2108 tpriv->reap_action = NORMAL;
2109 tpriv->iso_packet_offset = 0;
2111 /* allocate + initialize each URB with the correct number of packets */
2112 num_packets_remaining = num_packets;
2113 for (i = 0, j = 0; i < num_urbs; i++) {
2114 int num_packets_in_urb = MIN(num_packets_remaining, MAX_ISO_PACKETS_PER_URB);
2115 struct usbfs_urb *urb;
2119 alloc_size = sizeof(*urb)
2120 + (num_packets_in_urb * sizeof(struct usbfs_iso_packet_desc));
2121 urb = calloc(1, alloc_size);
2123 free_iso_urbs(tpriv);
2124 return LIBUSB_ERROR_NO_MEM;
2128 /* populate packet lengths */
2129 for (k = 0; k < num_packets_in_urb; j++, k++) {
2130 packet_len = transfer->iso_packet_desc[j].length;
2131 urb->buffer_length += packet_len;
2132 urb->iso_frame_desc[k].length = packet_len;
2135 urb->usercontext = itransfer;
2136 urb->type = USBFS_URB_TYPE_ISO;
2137 /* FIXME: interface for non-ASAP data? */
2138 urb->flags = USBFS_URB_ISO_ASAP;
2139 urb->endpoint = transfer->endpoint;
2140 urb->number_of_packets = num_packets_in_urb;
2141 urb->buffer = urb_buffer;
2143 urb_buffer += urb->buffer_length;
2144 num_packets_remaining -= num_packets_in_urb;
2148 for (i = 0; i < num_urbs; i++) {
2149 int r = ioctl(hpriv->fd, IOCTL_USBFS_SUBMITURB, urbs[i]);
2154 if (errno == ENODEV) {
2155 r = LIBUSB_ERROR_NO_DEVICE;
2156 } else if (errno == EINVAL) {
2157 usbi_warn(TRANSFER_CTX(transfer), "submiturb failed, transfer too large");
2158 r = LIBUSB_ERROR_INVALID_PARAM;
2159 } else if (errno == EMSGSIZE) {
2160 usbi_warn(TRANSFER_CTX(transfer), "submiturb failed, iso packet length too large");
2161 r = LIBUSB_ERROR_INVALID_PARAM;
2163 usbi_err(TRANSFER_CTX(transfer), "submiturb failed, errno=%d", errno);
2164 r = LIBUSB_ERROR_IO;
2167 /* if the first URB submission fails, we can simply free up and
2168 * return failure immediately. */
2170 usbi_dbg("first URB failed, easy peasy");
2171 free_iso_urbs(tpriv);
2175 /* if it's not the first URB that failed, the situation is a bit
2176 * tricky. we must discard all previous URBs. there are
2178 * - discarding is asynchronous - discarded urbs will be reaped
2179 * later. the user must not have freed the transfer when the
2180 * discarded URBs are reaped, otherwise libusb will be using
2182 * - the earlier URBs may have completed successfully and we do
2183 * not want to throw away any data.
2184 * so, in this case we discard all the previous URBs BUT we report
2185 * that the transfer was submitted successfully. then later when
2186 * the final discard completes we can report error to the user.
2188 tpriv->reap_action = SUBMIT_FAILED;
2190 /* The URBs we haven't submitted yet we count as already
2192 tpriv->num_retired = num_urbs - i;
2193 discard_urbs(itransfer, 0, i);
2195 usbi_dbg("reporting successful submission but waiting for %d "
2196 "discards before reporting error", i);
2203 static int submit_control_transfer(struct usbi_transfer *itransfer)
2205 struct linux_transfer_priv *tpriv = usbi_get_transfer_priv(itransfer);
2206 struct libusb_transfer *transfer =
2207 USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
2208 struct linux_device_handle_priv *hpriv =
2209 usbi_get_device_handle_priv(transfer->dev_handle);
2210 struct usbfs_urb *urb;
2213 if (transfer->length - LIBUSB_CONTROL_SETUP_SIZE > MAX_CTRL_BUFFER_LENGTH)
2214 return LIBUSB_ERROR_INVALID_PARAM;
2216 urb = calloc(1, sizeof(*urb));
2218 return LIBUSB_ERROR_NO_MEM;
2220 tpriv->num_urbs = 1;
2221 tpriv->reap_action = NORMAL;
2223 urb->usercontext = itransfer;
2224 urb->type = USBFS_URB_TYPE_CONTROL;
2225 urb->endpoint = transfer->endpoint;
2226 urb->buffer = transfer->buffer;
2227 urb->buffer_length = transfer->length;
2229 r = ioctl(hpriv->fd, IOCTL_USBFS_SUBMITURB, urb);
2233 if (errno == ENODEV)
2234 return LIBUSB_ERROR_NO_DEVICE;
2236 usbi_err(TRANSFER_CTX(transfer), "submiturb failed, errno=%d", errno);
2237 return LIBUSB_ERROR_IO;
2242 static int op_submit_transfer(struct usbi_transfer *itransfer)
2244 struct libusb_transfer *transfer =
2245 USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
2247 switch (transfer->type) {
2248 case LIBUSB_TRANSFER_TYPE_CONTROL:
2249 return submit_control_transfer(itransfer);
2250 case LIBUSB_TRANSFER_TYPE_BULK:
2251 case LIBUSB_TRANSFER_TYPE_BULK_STREAM:
2252 return submit_bulk_transfer(itransfer);
2253 case LIBUSB_TRANSFER_TYPE_INTERRUPT:
2254 return submit_bulk_transfer(itransfer);
2255 case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
2256 return submit_iso_transfer(itransfer);
2258 usbi_err(TRANSFER_CTX(transfer), "unknown transfer type %u", transfer->type);
2259 return LIBUSB_ERROR_INVALID_PARAM;
2263 static int op_cancel_transfer(struct usbi_transfer *itransfer)
2265 struct linux_transfer_priv *tpriv = usbi_get_transfer_priv(itransfer);
2266 struct libusb_transfer *transfer =
2267 USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
2271 return LIBUSB_ERROR_NOT_FOUND;
2273 r = discard_urbs(itransfer, 0, tpriv->num_urbs);
2277 switch (transfer->type) {
2278 case LIBUSB_TRANSFER_TYPE_BULK:
2279 case LIBUSB_TRANSFER_TYPE_BULK_STREAM:
2280 if (tpriv->reap_action == ERROR)
2282 /* else, fall through */
2284 tpriv->reap_action = CANCELLED;
2290 static void op_clear_transfer_priv(struct usbi_transfer *itransfer)
2292 struct libusb_transfer *transfer =
2293 USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
2294 struct linux_transfer_priv *tpriv = usbi_get_transfer_priv(itransfer);
2296 switch (transfer->type) {
2297 case LIBUSB_TRANSFER_TYPE_CONTROL:
2298 case LIBUSB_TRANSFER_TYPE_BULK:
2299 case LIBUSB_TRANSFER_TYPE_BULK_STREAM:
2300 case LIBUSB_TRANSFER_TYPE_INTERRUPT:
2306 case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
2307 if (tpriv->iso_urbs) {
2308 free_iso_urbs(tpriv);
2309 tpriv->iso_urbs = NULL;
2313 usbi_err(TRANSFER_CTX(transfer), "unknown transfer type %u", transfer->type);
2317 static int handle_bulk_completion(struct usbi_transfer *itransfer,
2318 struct usbfs_urb *urb)
2320 struct linux_transfer_priv *tpriv = usbi_get_transfer_priv(itransfer);
2321 struct libusb_transfer *transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
2322 int urb_idx = urb - tpriv->urbs;
2324 usbi_mutex_lock(&itransfer->lock);
2325 usbi_dbg("handling completion status %d of bulk urb %d/%d", urb->status,
2326 urb_idx + 1, tpriv->num_urbs);
2328 tpriv->num_retired++;
2330 if (tpriv->reap_action != NORMAL) {
2331 /* cancelled, submit_fail, or completed early */
2332 usbi_dbg("abnormal reap: urb status %d", urb->status);
2334 /* even though we're in the process of cancelling, it's possible that
2335 * we may receive some data in these URBs that we don't want to lose.
2337 * 1. while the kernel is cancelling all the packets that make up an
2338 * URB, a few of them might complete. so we get back a successful
2339 * cancellation *and* some data.
2340 * 2. we receive a short URB which marks the early completion condition,
2341 * so we start cancelling the remaining URBs. however, we're too
2342 * slow and another URB completes (or at least completes partially).
2343 * (this can't happen since we always use BULK_CONTINUATION.)
2345 * When this happens, our objectives are not to lose any "surplus" data,
2346 * and also to stick it at the end of the previously-received data
2347 * (closing any holes), so that libusb reports the total amount of
2348 * transferred data and presents it in a contiguous chunk.
2350 if (urb->actual_length > 0) {
2351 unsigned char *target = transfer->buffer + itransfer->transferred;
2353 usbi_dbg("received %d bytes of surplus data", urb->actual_length);
2354 if (urb->buffer != target) {
2355 usbi_dbg("moving surplus data from offset %zu to offset %zu",
2356 (unsigned char *)urb->buffer - transfer->buffer,
2357 target - transfer->buffer);
2358 memmove(target, urb->buffer, urb->actual_length);
2360 itransfer->transferred += urb->actual_length;
2363 if (tpriv->num_retired == tpriv->num_urbs) {
2364 usbi_dbg("abnormal reap: last URB handled, reporting");
2365 if (tpriv->reap_action != COMPLETED_EARLY &&
2366 tpriv->reap_status == LIBUSB_TRANSFER_COMPLETED)
2367 tpriv->reap_status = LIBUSB_TRANSFER_ERROR;
2373 itransfer->transferred += urb->actual_length;
2375 /* Many of these errors can occur on *any* urb of a multi-urb
2376 * transfer. When they do, we tear down the rest of the transfer.
2378 switch (urb->status) {
2381 case -EREMOTEIO: /* short transfer */
2383 case -ENOENT: /* cancelled */
2388 usbi_dbg("device removed");
2389 tpriv->reap_status = LIBUSB_TRANSFER_NO_DEVICE;
2390 goto cancel_remaining;
2392 usbi_dbg("detected endpoint stall");
2393 if (tpriv->reap_status == LIBUSB_TRANSFER_COMPLETED)
2394 tpriv->reap_status = LIBUSB_TRANSFER_STALL;
2395 goto cancel_remaining;
2397 /* overflow can only ever occur in the last urb */
2398 usbi_dbg("overflow, actual_length=%d", urb->actual_length);
2399 if (tpriv->reap_status == LIBUSB_TRANSFER_COMPLETED)
2400 tpriv->reap_status = LIBUSB_TRANSFER_OVERFLOW;
2407 usbi_dbg("low-level bus error %d", urb->status);
2408 tpriv->reap_action = ERROR;
2409 goto cancel_remaining;
2411 usbi_warn(ITRANSFER_CTX(itransfer), "unrecognised urb status %d", urb->status);
2412 tpriv->reap_action = ERROR;
2413 goto cancel_remaining;
2416 /* if we've reaped all urbs or we got less data than requested then we're
2418 if (tpriv->num_retired == tpriv->num_urbs) {
2419 usbi_dbg("all URBs in transfer reaped --> complete!");
2421 } else if (urb->actual_length < urb->buffer_length) {
2422 usbi_dbg("short transfer %d/%d --> complete!",
2423 urb->actual_length, urb->buffer_length);
2424 if (tpriv->reap_action == NORMAL)
2425 tpriv->reap_action = COMPLETED_EARLY;
2431 if (tpriv->reap_action == ERROR && tpriv->reap_status == LIBUSB_TRANSFER_COMPLETED)
2432 tpriv->reap_status = LIBUSB_TRANSFER_ERROR;
2434 if (tpriv->num_retired == tpriv->num_urbs) /* nothing to cancel */
2437 /* cancel remaining urbs and wait for their completion before
2438 * reporting results */
2439 discard_urbs(itransfer, urb_idx + 1, tpriv->num_urbs);
2442 usbi_mutex_unlock(&itransfer->lock);
2448 usbi_mutex_unlock(&itransfer->lock);
2449 return tpriv->reap_action == CANCELLED ?
2450 usbi_handle_transfer_cancellation(itransfer) :
2451 usbi_handle_transfer_completion(itransfer, tpriv->reap_status);
2454 static int handle_iso_completion(struct usbi_transfer *itransfer,
2455 struct usbfs_urb *urb)
2457 struct libusb_transfer *transfer =
2458 USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
2459 struct linux_transfer_priv *tpriv = usbi_get_transfer_priv(itransfer);
2460 int num_urbs = tpriv->num_urbs;
2463 enum libusb_transfer_status status = LIBUSB_TRANSFER_COMPLETED;
2465 usbi_mutex_lock(&itransfer->lock);
2466 for (i = 0; i < num_urbs; i++) {
2467 if (urb == tpriv->iso_urbs[i]) {
2473 usbi_err(TRANSFER_CTX(transfer), "could not locate urb!");
2474 usbi_mutex_unlock(&itransfer->lock);
2475 return LIBUSB_ERROR_NOT_FOUND;
2478 usbi_dbg("handling completion status %d of iso urb %d/%d", urb->status,
2481 /* copy isochronous results back in */
2483 for (i = 0; i < urb->number_of_packets; i++) {
2484 struct usbfs_iso_packet_desc *urb_desc = &urb->iso_frame_desc[i];
2485 struct libusb_iso_packet_descriptor *lib_desc =
2486 &transfer->iso_packet_desc[tpriv->iso_packet_offset++];
2488 lib_desc->status = LIBUSB_TRANSFER_COMPLETED;
2489 switch (urb_desc->status) {
2492 case -ENOENT: /* cancelled */
2497 usbi_dbg("packet %d - device removed", i);
2498 lib_desc->status = LIBUSB_TRANSFER_NO_DEVICE;
2501 usbi_dbg("packet %d - detected endpoint stall", i);
2502 lib_desc->status = LIBUSB_TRANSFER_STALL;
2505 usbi_dbg("packet %d - overflow error", i);
2506 lib_desc->status = LIBUSB_TRANSFER_OVERFLOW;
2514 usbi_dbg("packet %d - low-level USB error %d", i, urb_desc->status);
2515 lib_desc->status = LIBUSB_TRANSFER_ERROR;
2518 usbi_warn(TRANSFER_CTX(transfer), "packet %d - unrecognised urb status %d",
2519 i, urb_desc->status);
2520 lib_desc->status = LIBUSB_TRANSFER_ERROR;
2523 lib_desc->actual_length = urb_desc->actual_length;
2526 tpriv->num_retired++;
2528 if (tpriv->reap_action != NORMAL) { /* cancelled or submit_fail */
2529 usbi_dbg("CANCEL: urb status %d", urb->status);
2531 if (tpriv->num_retired == num_urbs) {
2532 usbi_dbg("CANCEL: last URB handled, reporting");
2533 free_iso_urbs(tpriv);
2534 if (tpriv->reap_action == CANCELLED) {
2535 usbi_mutex_unlock(&itransfer->lock);
2536 return usbi_handle_transfer_cancellation(itransfer);
2538 usbi_mutex_unlock(&itransfer->lock);
2539 return usbi_handle_transfer_completion(itransfer, LIBUSB_TRANSFER_ERROR);
2545 switch (urb->status) {
2548 case -ENOENT: /* cancelled */
2552 usbi_dbg("device removed");
2553 status = LIBUSB_TRANSFER_NO_DEVICE;
2556 usbi_warn(TRANSFER_CTX(transfer), "unrecognised urb status %d", urb->status);
2557 status = LIBUSB_TRANSFER_ERROR;
2561 /* if we've reaped all urbs then we're done */
2562 if (tpriv->num_retired == num_urbs) {
2563 usbi_dbg("all URBs in transfer reaped --> complete!");
2564 free_iso_urbs(tpriv);
2565 usbi_mutex_unlock(&itransfer->lock);
2566 return usbi_handle_transfer_completion(itransfer, status);
2570 usbi_mutex_unlock(&itransfer->lock);
2574 static int handle_control_completion(struct usbi_transfer *itransfer,
2575 struct usbfs_urb *urb)
2577 struct linux_transfer_priv *tpriv = usbi_get_transfer_priv(itransfer);
2580 usbi_mutex_lock(&itransfer->lock);
2581 usbi_dbg("handling completion status %d", urb->status);
2583 itransfer->transferred += urb->actual_length;
2585 if (tpriv->reap_action == CANCELLED) {
2586 if (urb->status && urb->status != -ENOENT)
2587 usbi_warn(ITRANSFER_CTX(itransfer), "cancel: unrecognised urb status %d",
2591 usbi_mutex_unlock(&itransfer->lock);
2592 return usbi_handle_transfer_cancellation(itransfer);
2595 switch (urb->status) {
2597 status = LIBUSB_TRANSFER_COMPLETED;
2599 case -ENOENT: /* cancelled */
2600 status = LIBUSB_TRANSFER_CANCELLED;
2604 usbi_dbg("device removed");
2605 status = LIBUSB_TRANSFER_NO_DEVICE;
2608 usbi_dbg("unsupported control request");
2609 status = LIBUSB_TRANSFER_STALL;
2612 usbi_dbg("overflow, actual_length=%d", urb->actual_length);
2613 status = LIBUSB_TRANSFER_OVERFLOW;
2620 usbi_dbg("low-level bus error %d", urb->status);
2621 status = LIBUSB_TRANSFER_ERROR;
2624 usbi_warn(ITRANSFER_CTX(itransfer), "unrecognised urb status %d", urb->status);
2625 status = LIBUSB_TRANSFER_ERROR;
2631 usbi_mutex_unlock(&itransfer->lock);
2632 return usbi_handle_transfer_completion(itransfer, status);
2635 static int reap_for_handle(struct libusb_device_handle *handle)
2637 struct linux_device_handle_priv *hpriv = usbi_get_device_handle_priv(handle);
2639 struct usbfs_urb *urb = NULL;
2640 struct usbi_transfer *itransfer;
2641 struct libusb_transfer *transfer;
2643 r = ioctl(hpriv->fd, IOCTL_USBFS_REAPURBNDELAY, &urb);
2645 if (errno == EAGAIN)
2647 if (errno == ENODEV)
2648 return LIBUSB_ERROR_NO_DEVICE;
2650 usbi_err(HANDLE_CTX(handle), "reap failed, errno=%d", errno);
2651 return LIBUSB_ERROR_IO;
2654 itransfer = urb->usercontext;
2655 transfer = USBI_TRANSFER_TO_LIBUSB_TRANSFER(itransfer);
2657 usbi_dbg("urb type=%u status=%d transferred=%d", urb->type, urb->status, urb->actual_length);
2659 switch (transfer->type) {
2660 case LIBUSB_TRANSFER_TYPE_ISOCHRONOUS:
2661 return handle_iso_completion(itransfer, urb);
2662 case LIBUSB_TRANSFER_TYPE_BULK:
2663 case LIBUSB_TRANSFER_TYPE_BULK_STREAM:
2664 case LIBUSB_TRANSFER_TYPE_INTERRUPT:
2665 return handle_bulk_completion(itransfer, urb);
2666 case LIBUSB_TRANSFER_TYPE_CONTROL:
2667 return handle_control_completion(itransfer, urb);
2669 usbi_err(HANDLE_CTX(handle), "unrecognised transfer type %u", transfer->type);
2670 return LIBUSB_ERROR_OTHER;
2674 static int op_handle_events(struct libusb_context *ctx,
2675 void *event_data, unsigned int count, unsigned int num_ready)
2677 struct pollfd *fds = event_data;
2681 usbi_mutex_lock(&ctx->open_devs_lock);
2682 for (n = 0; n < count && num_ready > 0; n++) {
2683 struct pollfd *pollfd = &fds[n];
2684 struct libusb_device_handle *handle;
2685 struct linux_device_handle_priv *hpriv = NULL;
2688 if (!pollfd->revents)
2692 for_each_open_device(ctx, handle) {
2693 hpriv = usbi_get_device_handle_priv(handle);
2694 if (hpriv->fd == pollfd->fd)
2698 if (!hpriv || hpriv->fd != pollfd->fd) {
2699 usbi_err(ctx, "cannot find handle for fd %d",
2704 if (pollfd->revents & POLLERR) {
2705 /* remove the fd from the pollfd set so that it doesn't continuously
2706 * trigger an event, and flag that it has been removed so op_close()
2707 * doesn't try to remove it a second time */
2708 usbi_remove_event_source(HANDLE_CTX(handle), hpriv->fd);
2709 hpriv->fd_removed = 1;
2711 /* device will still be marked as attached if hotplug monitor thread
2712 * hasn't processed remove event yet */
2713 usbi_mutex_static_lock(&linux_hotplug_lock);
2714 if (handle->dev->attached)
2715 linux_device_disconnected(handle->dev->bus_number,
2716 handle->dev->device_address);
2717 usbi_mutex_static_unlock(&linux_hotplug_lock);
2719 if (hpriv->caps & USBFS_CAP_REAP_AFTER_DISCONNECT) {
2721 r = reap_for_handle(handle);
2725 usbi_handle_disconnect(handle);
2731 r = reap_for_handle(handle);
2732 } while (r == 0 && ++reap_count <= 25);
2734 if (r == 1 || r == LIBUSB_ERROR_NO_DEVICE)
2742 usbi_mutex_unlock(&ctx->open_devs_lock);
2746 const struct usbi_os_backend usbi_backend = {
2747 .name = "Linux usbfs",
2748 .caps = USBI_CAP_HAS_HID_ACCESS|USBI_CAP_SUPPORTS_DETACH_KERNEL_DRIVER,
2751 .set_option = op_set_option,
2752 .hotplug_poll = op_hotplug_poll,
2753 .get_active_config_descriptor = op_get_active_config_descriptor,
2754 .get_config_descriptor = op_get_config_descriptor,
2755 .get_config_descriptor_by_value = op_get_config_descriptor_by_value,
2757 .wrap_sys_device = op_wrap_sys_device,
2760 .get_configuration = op_get_configuration,
2761 .set_configuration = op_set_configuration,
2762 .claim_interface = op_claim_interface,
2763 .release_interface = op_release_interface,
2765 .set_interface_altsetting = op_set_interface,
2766 .clear_halt = op_clear_halt,
2767 .reset_device = op_reset_device,
2769 .alloc_streams = op_alloc_streams,
2770 .free_streams = op_free_streams,
2772 .dev_mem_alloc = op_dev_mem_alloc,
2773 .dev_mem_free = op_dev_mem_free,
2775 .kernel_driver_active = op_kernel_driver_active,
2776 .detach_kernel_driver = op_detach_kernel_driver,
2777 .attach_kernel_driver = op_attach_kernel_driver,
2779 .destroy_device = op_destroy_device,
2781 .submit_transfer = op_submit_transfer,
2782 .cancel_transfer = op_cancel_transfer,
2783 .clear_transfer_priv = op_clear_transfer_priv,
2785 .handle_events = op_handle_events,
2787 .device_priv_size = sizeof(struct linux_device_priv),
2788 .device_handle_priv_size = sizeof(struct linux_device_handle_priv),
2789 .transfer_priv_size = sizeof(struct linux_transfer_priv),