libusb 1.0.28
A cross-platform user library to access USB devices
libusb.h
1/*
2 * Public libusb header file
3 * Copyright © 2001 Johannes Erdfelt <johannes@erdfelt.com>
4 * Copyright © 2007-2008 Daniel Drake <dsd@gentoo.org>
5 * Copyright © 2012 Pete Batard <pete@akeo.ie>
6 * Copyright © 2012-2023 Nathan Hjelm <hjelmn@cs.unm.edu>
7 * Copyright © 2014-2020 Chris Dickens <christopher.a.dickens@gmail.com>
8 * For more information, please visit: https://libusb.info
9 *
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.
14 *
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.
19 *
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
23 */
24
25#ifndef LIBUSB_H
26#define LIBUSB_H
27
28#if defined(_MSC_VER)
29#pragma warning(push)
30/* Disable: warning C4200: nonstandard extension used : zero-sized array in struct/union */
31#pragma warning(disable:4200)
32/* on MS environments, the inline keyword is available in C++ only */
33#if !defined(__cplusplus)
34#define inline __inline
35#endif
36/* ssize_t is also not available */
37#ifndef _SSIZE_T_DEFINED
38#define _SSIZE_T_DEFINED
39#include <basetsd.h>
40typedef SSIZE_T ssize_t;
41#endif /* _SSIZE_T_DEFINED */
42#endif /* _MSC_VER */
43
44#include <limits.h>
45#include <stdint.h>
46#include <sys/types.h>
47#if !defined(_MSC_VER)
48#include <sys/time.h>
49#endif
50#include <time.h>
51
52#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
53#define LIBUSB_FLEXIBLE_ARRAY /* [] - valid C99 code */
54#else
55#define LIBUSB_FLEXIBLE_ARRAY 0 /* [0] - non-standard, but usually working code */
56#endif /* __STDC_VERSION__ */
57
58/* 'interface' might be defined as a macro on Windows, so we need to
59 * undefine it so as not to break the current libusb API, because
60 * libusb_config_descriptor has an 'interface' member
61 * As this can be problematic if you include windows.h after libusb.h
62 * in your sources, we force windows.h to be included first. */
63#if defined(_WIN32) || defined(__CYGWIN__)
64#include <windows.h>
65#if defined(interface)
66#undef interface
67#endif
68#if !defined(__CYGWIN__)
69#include <winsock.h>
70#endif
71#endif /* _WIN32 || __CYGWIN__ */
72
73#if defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5))
74#define LIBUSB_DEPRECATED_FOR(f) __attribute__ ((deprecated ("Use " #f " instead")))
75#elif defined(__GNUC__) && (__GNUC__ >= 3)
76#define LIBUSB_DEPRECATED_FOR(f) __attribute__ ((deprecated))
77#elif defined(_MSC_VER)
78#define LIBUSB_DEPRECATED_FOR(f) __declspec(deprecated("Use " #f " instead"))
79#else
80#define LIBUSB_DEPRECATED_FOR(f)
81#endif /* __GNUC__ */
82
83#if defined(__GNUC__)
84#define LIBUSB_PACKED __attribute__ ((packed))
85#else
86#define LIBUSB_PACKED
87#endif /* __GNUC__ */
88
114/* LIBUSB_CALL must be defined on both definition and declaration of libusb
115 * functions. You'd think that declaration would be enough, but cygwin will
116 * complain about conflicting types unless both are marked this way.
117 * The placement of this macro is important too; it must appear after the
118 * return type, before the function name. See internal documentation for
119 * API_EXPORTED.
120 */
121#if defined(_WIN32) || defined(__CYGWIN__)
122#define LIBUSB_CALL WINAPI
123#define LIBUSB_CALLV WINAPIV
124#else
125#define LIBUSB_CALL
126#define LIBUSB_CALLV
127#endif /* _WIN32 || __CYGWIN__ */
128
171#define LIBUSB_API_VERSION 0x0100010A
172
179#define LIBUSBX_API_VERSION LIBUSB_API_VERSION
180
181#if defined(__cplusplus)
182extern "C" {
183#endif
184
193static inline uint16_t libusb_cpu_to_le16(const uint16_t x)
194{
195 union {
196 uint8_t b8[2];
197 uint16_t b16;
198 } _tmp;
199 _tmp.b8[1] = (uint8_t) (x >> 8);
200 _tmp.b8[0] = (uint8_t) (x & 0xff);
201 return _tmp.b16;
202}
203
212#define libusb_le16_to_cpu libusb_cpu_to_le16
213
214/* standard USB stuff */
215
280
327
328/* Descriptor sizes per descriptor type */
329#define LIBUSB_DT_DEVICE_SIZE 18
330#define LIBUSB_DT_CONFIG_SIZE 9
331#define LIBUSB_DT_INTERFACE_SIZE 9
332#define LIBUSB_DT_ENDPOINT_SIZE 7
333#define LIBUSB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
334#define LIBUSB_DT_HUB_NONVAR_SIZE 7
335#define LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE 6
336#define LIBUSB_DT_BOS_SIZE 5
337#define LIBUSB_DT_DEVICE_CAPABILITY_SIZE 3
338#define LIBUSB_DT_INTERFACE_ASSOCIATION_SIZE 8
339
340/* BOS descriptor sizes */
341#define LIBUSB_BT_USB_2_0_EXTENSION_SIZE 7
342#define LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE 10
343#define LIBUSB_BT_SSPLUS_USB_DEVICE_CAPABILITY_SIZE 12
344#define LIBUSB_BT_CONTAINER_ID_SIZE 20
345#define LIBUSB_BT_PLATFORM_DESCRIPTOR_MIN_SIZE 20
346
347/* We unwrap the BOS => define its max size */
348#define LIBUSB_DT_BOS_MAX_SIZE \
349 (LIBUSB_DT_BOS_SIZE + \
350 LIBUSB_BT_USB_2_0_EXTENSION_SIZE + \
351 LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE + \
352 LIBUSB_BT_CONTAINER_ID_SIZE)
353
354#define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f /* in bEndpointAddress */
355#define LIBUSB_ENDPOINT_DIR_MASK 0x80
356
368
369#define LIBUSB_TRANSFER_TYPE_MASK 0x03 /* in bmAttributes */
370
388
436
454
472
473#define LIBUSB_ISO_SYNC_TYPE_MASK 0x0c
474
493
494#define LIBUSB_ISO_USAGE_TYPE_MASK 0x30
495
511
529
539
549
572
580 uint8_t bLength;
581
586
589 uint16_t bcdUSB;
590
593
597
601
604
606 uint16_t idVendor;
607
609 uint16_t idProduct;
610
612 uint16_t bcdDevice;
613
616
618 uint8_t iProduct;
619
622
625};
626
634 uint8_t bLength;
635
640
645
653
656
658 uint8_t bInterval;
659
662 uint8_t bRefresh;
663
666
669 const unsigned char *extra;
670
673};
674
682 uint8_t bLength;
683
688
692
696
703
709
715
717 uint8_t iFunction;
718};
719
733
741 uint8_t bLength;
742
747
750
753
757
760
764
768
770 uint8_t iInterface;
771
775
778 const unsigned char *extra;
779
782};
783
796
804 uint8_t bLength;
805
810
812 uint16_t wTotalLength;
813
816
819
822
825
830 uint8_t MaxPower;
831
835
838 const unsigned char *extra;
839
842};
843
852 uint8_t bLength;
853
858
861 uint8_t bMaxBurst;
862
868
872};
873
881 uint8_t bLength;
882
887
890
892 uint8_t dev_capability_data[LIBUSB_FLEXIBLE_ARRAY];
893};
894
902 uint8_t bLength;
903
908
910 uint16_t wTotalLength;
911
915
918};
919
945
987
992 LIBUSB_SSPLUS_ATTR_TYPE_SYM = 0,
993 LIBUSB_SSPLUS_ATTR_TYPE_ASYM = 1,
994};
995
1000 LIBUSB_SSPLUS_ATTR_DIR_RX = 0,
1001 LIBUSB_SSPLUS_ATTR_DIR_TX = 1,
1002};
1003
1012 LIBUSB_SSPLUS_ATTR_EXP_BPS = 0,
1013 LIBUSB_SSPLUS_ATTR_EXP_KBS = 1,
1014 LIBUSB_SSPLUS_ATTR_EXP_MBS = 2,
1015 LIBUSB_SSPLUS_ATTR_EXP_GBS = 3,
1016};
1017
1022 LIBUSB_SSPLUS_ATTR_PROT_SS = 0,
1023 LIBUSB_SSPLUS_ATTR_PROT_SSPLUS = 1,
1024};
1025
1057
1081
1089 uint8_t bLength;
1090
1095
1100
1102 uint8_t bReserved;
1103
1105 uint8_t ContainerID[16];
1106};
1107
1114 uint8_t bLength;
1115
1120
1125
1127 uint8_t bReserved;
1128
1131
1133 uint8_t CapabilityData[LIBUSB_FLEXIBLE_ARRAY];
1134};
1135
1138#if defined(_MSC_VER) || defined(__WATCOMC__)
1139#pragma pack(push, 1)
1140#endif
1148
1154 uint8_t bRequest;
1155
1157 uint16_t wValue;
1158
1161 uint16_t wIndex;
1162
1164 uint16_t wLength;
1165} LIBUSB_PACKED;
1166#if defined(_MSC_VER) || defined(__WATCOMC__)
1167#pragma pack(pop)
1168#endif
1169
1170#define LIBUSB_CONTROL_SETUP_SIZE (sizeof(struct libusb_control_setup))
1171
1172/* libusb */
1173
1174struct libusb_context;
1175struct libusb_device;
1177
1183 const uint16_t major;
1184
1186 const uint16_t minor;
1187
1189 const uint16_t micro;
1190
1192 const uint16_t nano;
1193
1195 const char *rc;
1196
1198 const char *describe;
1199};
1200
1220
1237
1238
1248
1274
1285
1288
1291
1294
1297
1300
1303
1306
1309
1312
1315
1318
1321
1322 /* NB: Remember to update LIBUSB_ERROR_COUNT below as well as the
1323 message strings in strerror.c when adding new error codes here. */
1324
1326 LIBUSB_ERROR_OTHER = -99
1328
1329/* Total number of error codes in enum libusb_error */
1330#define LIBUSB_ERROR_COUNT 14
1331
1350
1357
1360
1363
1366
1370
1373
1376
1377 /* NB! Remember to update libusb_error_name()
1378 when adding new status codes here. */
1380
1425
1430 unsigned int length;
1431
1433 unsigned int actual_length;
1434
1437};
1438
1439struct libusb_transfer;
1440
1450typedef void (LIBUSB_CALL *libusb_transfer_cb_fn)(struct libusb_transfer *transfer);
1451
1461
1463 uint8_t flags;
1464
1466 unsigned char endpoint;
1467
1469 unsigned char type;
1470
1473 unsigned int timeout;
1474
1483
1486
1491
1495
1507
1509 unsigned char *buffer;
1510
1514
1516 struct libusb_iso_packet_descriptor iso_packet_desc[LIBUSB_FLEXIBLE_ARRAY];
1517};
1518
1541
1561
1576
1604
1613
1633
1634#define LIBUSB_OPTION_WEAK_AUTHORITY LIBUSB_OPTION_NO_DEVICE_DISCOVERY
1635
1646
1647 LIBUSB_OPTION_MAX = 4
1648};
1649
1662 enum libusb_log_level level, const char *str);
1663
1672 union {
1673 int ival;
1674 libusb_log_cb log_cbval;
1676};
1677
1679int LIBUSB_CALL libusb_init_context(libusb_context **ctx, const struct libusb_init_option options[], int num_options);
1681void LIBUSB_CALL libusb_set_debug(libusb_context *ctx, int level);
1682/* may be deprecated in the future in favor of lubusb_init_context()+libusb_set_option() */
1684const struct libusb_version * LIBUSB_CALL libusb_get_version(void);
1685int LIBUSB_CALL libusb_has_capability(uint32_t capability);
1686const char * LIBUSB_CALL libusb_error_name(int error_code);
1687int LIBUSB_CALL libusb_setlocale(const char *locale);
1688const char * LIBUSB_CALL libusb_strerror(int errcode);
1689
1691 libusb_device ***list);
1693 int unref_devices);
1696
1698 int *config);
1700 struct libusb_device_descriptor *desc);
1702 struct libusb_config_descriptor **config);
1704 uint8_t config_index, struct libusb_config_descriptor **config);
1706 uint8_t bConfigurationValue, struct libusb_config_descriptor **config);
1708 struct libusb_config_descriptor *config);
1710 libusb_context *ctx,
1711 const struct libusb_endpoint_descriptor *endpoint,
1716 struct libusb_bos_descriptor **bos);
1719 libusb_context *ctx,
1721 struct libusb_usb_2_0_extension_descriptor **usb_2_0_extension);
1723 struct libusb_usb_2_0_extension_descriptor *usb_2_0_extension);
1725 libusb_context *ctx,
1727 struct libusb_ss_usb_device_capability_descriptor **ss_usb_device_cap);
1729 struct libusb_ss_usb_device_capability_descriptor *ss_usb_device_cap);
1730int LIBUSB_CALL libusb_get_ssplus_usb_device_capability_descriptor(
1731 libusb_context *ctx,
1733 struct libusb_ssplus_usb_device_capability_descriptor **ssplus_usb_device_cap);
1734void LIBUSB_CALL libusb_free_ssplus_usb_device_capability_descriptor(
1735 struct libusb_ssplus_usb_device_capability_descriptor *ssplus_usb_device_cap);
1738 struct libusb_container_id_descriptor **container_id);
1740 struct libusb_container_id_descriptor *container_id);
1743 struct libusb_platform_descriptor **platform_descriptor);
1745 struct libusb_platform_descriptor *platform_descriptor);
1748int LIBUSB_CALL libusb_get_port_numbers(libusb_device *dev, uint8_t *port_numbers, int port_numbers_len);
1749LIBUSB_DEPRECATED_FOR(libusb_get_port_numbers)
1750int LIBUSB_CALL libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *path, uint8_t path_length);
1755 unsigned char endpoint);
1757 unsigned char endpoint);
1759 int interface_number, int alternate_setting, unsigned char endpoint);
1760
1762 uint8_t config_index, struct libusb_interface_association_descriptor_array **iad_array);
1767
1768int LIBUSB_CALL libusb_wrap_sys_device(libusb_context *ctx, intptr_t sys_dev, libusb_device_handle **dev_handle);
1772
1774 int configuration);
1776 int interface_number);
1778 int interface_number);
1779
1781 libusb_context *ctx, uint16_t vendor_id, uint16_t product_id);
1782
1784 int interface_number, int alternate_setting);
1786 unsigned char endpoint);
1788
1790 uint32_t num_streams, unsigned char *endpoints, int num_endpoints);
1792 unsigned char *endpoints, int num_endpoints);
1793
1794unsigned char * LIBUSB_CALL libusb_dev_mem_alloc(libusb_device_handle *dev_handle,
1795 size_t length);
1797 unsigned char *buffer, size_t length);
1798
1800 int interface_number);
1802 int interface_number);
1804 int interface_number);
1806 libusb_device_handle *dev_handle, int enable);
1807
1808/* async I/O */
1809
1822static inline unsigned char *libusb_control_transfer_get_data(
1823 struct libusb_transfer *transfer)
1824{
1825 return transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
1826}
1827
1841 struct libusb_transfer *transfer)
1842{
1843 return (struct libusb_control_setup *)(void *)transfer->buffer;
1844}
1845
1869static inline void libusb_fill_control_setup(unsigned char *buffer,
1870 uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
1871 uint16_t wLength)
1872{
1873 struct libusb_control_setup *setup = (struct libusb_control_setup *)(void *)buffer;
1875 setup->bRequest = bRequest;
1879}
1880
1881struct libusb_transfer * LIBUSB_CALL libusb_alloc_transfer(int iso_packets);
1884void LIBUSB_CALL libusb_free_transfer(struct libusb_transfer *transfer);
1886 struct libusb_transfer *transfer, uint32_t stream_id);
1888 struct libusb_transfer *transfer);
1889
1920 unsigned char *buffer, libusb_transfer_cb_fn callback, void *user_data,
1921 unsigned int timeout)
1922{
1923 struct libusb_control_setup *setup = (struct libusb_control_setup *)(void *)buffer;
1924 transfer->dev_handle = dev_handle;
1925 transfer->endpoint = 0;
1927 transfer->timeout = timeout;
1928 transfer->buffer = buffer;
1929 if (setup)
1930 transfer->length = (int) (LIBUSB_CONTROL_SETUP_SIZE
1931 + libusb_le16_to_cpu(setup->wLength));
1932 transfer->user_data = user_data;
1933 transfer->callback = callback;
1934}
1935
1949static inline void libusb_fill_bulk_transfer(struct libusb_transfer *transfer,
1950 libusb_device_handle *dev_handle, unsigned char endpoint,
1951 unsigned char *buffer, int length, libusb_transfer_cb_fn callback,
1952 void *user_data, unsigned int timeout)
1953{
1954 transfer->dev_handle = dev_handle;
1955 transfer->endpoint = endpoint;
1956 transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1957 transfer->timeout = timeout;
1958 transfer->buffer = buffer;
1959 transfer->length = length;
1960 transfer->user_data = user_data;
1961 transfer->callback = callback;
1962}
1963
1981 struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1982 unsigned char endpoint, uint32_t stream_id,
1983 unsigned char *buffer, int length, libusb_transfer_cb_fn callback,
1984 void *user_data, unsigned int timeout)
1985{
1986 libusb_fill_bulk_transfer(transfer, dev_handle, endpoint, buffer,
1987 length, callback, user_data, timeout);
1989 libusb_transfer_set_stream_id(transfer, stream_id);
1990}
1991
2006 struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
2007 unsigned char endpoint, unsigned char *buffer, int length,
2008 libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
2009{
2010 transfer->dev_handle = dev_handle;
2011 transfer->endpoint = endpoint;
2013 transfer->timeout = timeout;
2014 transfer->buffer = buffer;
2015 transfer->length = length;
2016 transfer->user_data = user_data;
2017 transfer->callback = callback;
2018}
2019
2034static inline void libusb_fill_iso_transfer(struct libusb_transfer *transfer,
2035 libusb_device_handle *dev_handle, unsigned char endpoint,
2036 unsigned char *buffer, int length, int num_iso_packets,
2037 libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
2038{
2039 transfer->dev_handle = dev_handle;
2040 transfer->endpoint = endpoint;
2042 transfer->timeout = timeout;
2043 transfer->buffer = buffer;
2044 transfer->length = length;
2045 transfer->num_iso_packets = num_iso_packets;
2046 transfer->user_data = user_data;
2047 transfer->callback = callback;
2048}
2049
2059 struct libusb_transfer *transfer, unsigned int length)
2060{
2061 int i;
2062
2063 for (i = 0; i < transfer->num_iso_packets; i++)
2064 transfer->iso_packet_desc[i].length = length;
2065}
2066
2083static inline unsigned char *libusb_get_iso_packet_buffer(
2084 struct libusb_transfer *transfer, unsigned int packet)
2085{
2086 int i;
2087 size_t offset = 0;
2088 int _packet;
2089
2090 /* oops..slight bug in the API. packet is an unsigned int, but we use
2091 * signed integers almost everywhere else. range-check and convert to
2092 * signed to avoid compiler warnings. FIXME for libusb-2. */
2093 if (packet > INT_MAX)
2094 return NULL;
2095 _packet = (int) packet;
2096
2097 if (_packet >= transfer->num_iso_packets)
2098 return NULL;
2099
2100 for (i = 0; i < _packet; i++)
2101 offset += transfer->iso_packet_desc[i].length;
2102
2103 return transfer->buffer + offset;
2104}
2105
2125static inline unsigned char *libusb_get_iso_packet_buffer_simple(
2126 struct libusb_transfer *transfer, unsigned int packet)
2127{
2128 int _packet;
2129
2130 /* oops..slight bug in the API. packet is an unsigned int, but we use
2131 * signed integers almost everywhere else. range-check and convert to
2132 * signed to avoid compiler warnings. FIXME for libusb-2. */
2133 if (packet > INT_MAX)
2134 return NULL;
2135 _packet = (int) packet;
2136
2137 if (_packet >= transfer->num_iso_packets)
2138 return NULL;
2139
2140 return transfer->buffer + ((int) transfer->iso_packet_desc[0].length * _packet);
2141}
2142
2143/* sync I/O */
2144
2146 uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
2147 unsigned char *data, uint16_t wLength, unsigned int timeout);
2148
2150 unsigned char endpoint, unsigned char *data, int length,
2151 int *transferred, unsigned int timeout);
2152
2154 unsigned char endpoint, unsigned char *data, int length,
2155 int *transferred, unsigned int timeout);
2156
2169static inline int libusb_get_descriptor(libusb_device_handle *dev_handle,
2170 uint8_t desc_type, uint8_t desc_index, unsigned char *data, int length)
2171{
2173 LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t) ((desc_type << 8) | desc_index),
2174 0, data, (uint16_t) length, 1000);
2175}
2176
2192 uint8_t desc_index, uint16_t langid, unsigned char *data, int length)
2193{
2195 LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t)((LIBUSB_DT_STRING << 8) | desc_index),
2196 langid, data, (uint16_t) length, 1000);
2197}
2198
2200 uint8_t desc_index, unsigned char *data, int length);
2201
2202/* polling and timeouts */
2203
2212int LIBUSB_CALL libusb_wait_for_event(libusb_context *ctx, struct timeval *tv);
2213
2215 struct timeval *tv);
2217 struct timeval *tv, int *completed);
2221 struct timeval *tv);
2224 struct timeval *tv);
2225
2231 int fd;
2232
2237 short events;
2238};
2239
2250typedef void (LIBUSB_CALL *libusb_pollfd_added_cb)(int fd, short events,
2251 void *user_data);
2252
2262typedef void (LIBUSB_CALL *libusb_pollfd_removed_cb)(int fd, void *user_data);
2263
2265 libusb_context *ctx);
2266void LIBUSB_CALL libusb_free_pollfds(const struct libusb_pollfd **pollfds);
2269 void *user_data);
2270
2284
2299
2309
2312#define LIBUSB_HOTPLUG_NO_FLAGS 0
2313
2316#define LIBUSB_HOTPLUG_MATCH_ANY -1
2317
2341 libusb_device *device, libusb_hotplug_event event, void *user_data);
2342
2379 int events, int flags,
2380 int vendor_id, int product_id, int dev_class,
2381 libusb_hotplug_callback_fn cb_fn, void *user_data,
2382 libusb_hotplug_callback_handle *callback_handle);
2383
2396 libusb_hotplug_callback_handle callback_handle);
2397
2407 libusb_hotplug_callback_handle callback_handle);
2408
2409int LIBUSB_CALLV libusb_set_option(libusb_context *ctx, enum libusb_option option, ...);
2410
2411#ifdef _MSC_VER
2412#pragma warning(pop)
2413#endif
2414
2415#if defined(__cplusplus)
2416}
2417#endif
2418
2419#endif
void(* libusb_transfer_cb_fn)(struct libusb_transfer *transfer)
Asynchronous transfer callback function type.
Definition libusb.h:1450
libusb_transfer_flags
libusb_transfer.flags values
Definition libusb.h:1383
unsigned char * libusb_dev_mem_alloc(libusb_device_handle *dev_handle, size_t length)
Attempts to allocate a block of persistent DMA memory suitable for transfers against the given device...
Definition core.c:2038
static void libusb_fill_iso_transfer(struct libusb_transfer *transfer, libusb_device_handle *dev_handle, unsigned char endpoint, unsigned char *buffer, int length, int num_iso_packets, libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
Helper function to populate the required libusb_transfer fields for an isochronous transfer.
Definition libusb.h:2034
static void libusb_fill_control_transfer(struct libusb_transfer *transfer, libusb_device_handle *dev_handle, unsigned char *buffer, libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
Helper function to populate the required libusb_transfer fields for a control transfer.
Definition libusb.h:1918
static unsigned char * libusb_control_transfer_get_data(struct libusb_transfer *transfer)
Get the data section of a control transfer.
Definition libusb.h:1822
static unsigned char * libusb_get_iso_packet_buffer_simple(struct libusb_transfer *transfer, unsigned int packet)
Convenience function to locate the position of an isochronous packet within the buffer of an isochron...
Definition libusb.h:2125
static void libusb_fill_control_setup(unsigned char *buffer, uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex, uint16_t wLength)
Helper function to populate the setup packet (first 8 bytes of the data buffer) for a control transfe...
Definition libusb.h:1869
uint32_t libusb_transfer_get_stream_id(struct libusb_transfer *transfer)
Get a transfers bulk stream id.
Definition io.c:1667
int libusb_cancel_transfer(struct libusb_transfer *transfer)
Asynchronously cancel a previously submitted transfer.
Definition io.c:1606
void libusb_free_transfer(struct libusb_transfer *transfer)
Free a transfer structure.
Definition io.c:1331
static void libusb_fill_interrupt_transfer(struct libusb_transfer *transfer, libusb_device_handle *dev_handle, unsigned char endpoint, unsigned char *buffer, int length, libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
Helper function to populate the required libusb_transfer fields for an interrupt transfer.
Definition libusb.h:2005
libusb_transfer_status
Transfer status codes.
Definition libusb.h:1353
struct libusb_transfer * libusb_alloc_transfer(int iso_packets)
Allocate a libusb transfer with a specified number of isochronous packet descriptors.
Definition io.c:1289
static struct libusb_control_setup * libusb_control_transfer_get_setup(struct libusb_transfer *transfer)
Get the control setup packet of a control transfer.
Definition libusb.h:1840
int libusb_free_streams(libusb_device_handle *dev_handle, unsigned char *endpoints, int num_endpoints)
Free usb bulk streams allocated with libusb_alloc_streams().
Definition core.c:1995
int libusb_submit_transfer(struct libusb_transfer *transfer)
Submit a transfer.
Definition io.c:1486
static void libusb_fill_bulk_stream_transfer(struct libusb_transfer *transfer, libusb_device_handle *dev_handle, unsigned char endpoint, uint32_t stream_id, unsigned char *buffer, int length, libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
Helper function to populate the required libusb_transfer fields for a bulk transfer using bulk stream...
Definition libusb.h:1980
libusb_transfer_type
Transfer type.
Definition libusb.h:1334
static void libusb_set_iso_packet_lengths(struct libusb_transfer *transfer, unsigned int length)
Convenience function to set the length of all packets in an isochronous transfer, based on the num_is...
Definition libusb.h:2058
static void libusb_fill_bulk_transfer(struct libusb_transfer *transfer, libusb_device_handle *dev_handle, unsigned char endpoint, unsigned char *buffer, int length, libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
Helper function to populate the required libusb_transfer fields for a bulk transfer.
Definition libusb.h:1949
int libusb_dev_mem_free(libusb_device_handle *dev_handle, unsigned char *buffer, size_t length)
Free device memory allocated with libusb_dev_mem_alloc().
Definition core.c:2058
int libusb_alloc_streams(libusb_device_handle *dev_handle, uint32_t num_streams, unsigned char *endpoints, int num_endpoints)
Allocate up to num_streams usb bulk streams on the specified endpoints.
Definition core.c:1965
static unsigned char * libusb_get_iso_packet_buffer(struct libusb_transfer *transfer, unsigned int packet)
Convenience function to locate the position of an isochronous packet within the buffer of an isochron...
Definition libusb.h:2083
void libusb_transfer_set_stream_id(struct libusb_transfer *transfer, uint32_t stream_id)
Set a transfers bulk stream id.
Definition io.c:1650
@ LIBUSB_TRANSFER_ADD_ZERO_PACKET
Terminate transfers that are a multiple of the endpoint's wMaxPacketSize with an extra zero length pa...
Definition libusb.h:1423
@ LIBUSB_TRANSFER_FREE_TRANSFER
Automatically call libusb_free_transfer() after callback returns.
Definition libusb.h:1397
@ LIBUSB_TRANSFER_SHORT_NOT_OK
Report short frames as errors.
Definition libusb.h:1385
@ LIBUSB_TRANSFER_FREE_BUFFER
Automatically free() transfer buffer during libusb_free_transfer().
Definition libusb.h:1391
@ LIBUSB_TRANSFER_STALL
For bulk/interrupt endpoints: halt condition detected (endpoint stalled).
Definition libusb.h:1369
@ LIBUSB_TRANSFER_COMPLETED
Transfer completed without error.
Definition libusb.h:1356
@ LIBUSB_TRANSFER_CANCELLED
Transfer was cancelled.
Definition libusb.h:1365
@ LIBUSB_TRANSFER_ERROR
Transfer failed.
Definition libusb.h:1359
@ LIBUSB_TRANSFER_OVERFLOW
Device sent more data than requested.
Definition libusb.h:1375
@ LIBUSB_TRANSFER_NO_DEVICE
Device was disconnected.
Definition libusb.h:1372
@ LIBUSB_TRANSFER_TIMED_OUT
Transfer timed out.
Definition libusb.h:1362
@ LIBUSB_TRANSFER_TYPE_BULK_STREAM
Bulk stream transfer.
Definition libusb.h:1348
@ LIBUSB_TRANSFER_TYPE_ISOCHRONOUS
Isochronous transfer.
Definition libusb.h:1339
@ LIBUSB_TRANSFER_TYPE_CONTROL
Control transfer.
Definition libusb.h:1336
@ LIBUSB_TRANSFER_TYPE_BULK
Bulk transfer.
Definition libusb.h:1342
@ LIBUSB_TRANSFER_TYPE_INTERRUPT
Interrupt transfer.
Definition libusb.h:1345
static int libusb_get_string_descriptor(libusb_device_handle *dev_handle, uint8_t desc_index, uint16_t langid, unsigned char *data, int length)
Retrieve a descriptor from a device.
Definition libusb.h:2191
libusb_descriptor_type
Descriptor types as defined by the USB specification.
Definition libusb.h:283
libusb_supported_speed
Supported speeds (wSpeedSupported) bitfield.
Definition libusb.h:516
void libusb_free_config_descriptor(struct libusb_config_descriptor *config)
Free a configuration descriptor obtained from libusb_get_active_config_descriptor() or libusb_get_con...
Definition descriptor.c:669
int libusb_get_string_descriptor_ascii(libusb_device_handle *dev_handle, uint8_t desc_index, unsigned char *data, int length)
Retrieve a string descriptor in C style ASCII.
Definition descriptor.c:1266
void libusb_free_platform_descriptor(struct libusb_platform_descriptor *platform_descriptor)
Free a platform descriptor obtained from libusb_get_platform_descriptor().
Definition descriptor.c:1248
int libusb_get_config_descriptor_by_value(libusb_device *dev, uint8_t bConfigurationValue, struct libusb_config_descriptor **config)
Get a USB configuration descriptor with a specific bConfigurationValue.
Definition descriptor.c:629
int libusb_get_interface_association_descriptors(libusb_device *dev, uint8_t config_index, struct libusb_interface_association_descriptor_array **iad_array)
Get an array of interface association descriptors (IAD) for a given configuration.
Definition descriptor.c:1438
int libusb_get_active_config_descriptor(libusb_device *dev, struct libusb_config_descriptor **config)
Get the USB configuration descriptor for the currently active configuration.
Definition descriptor.c:542
void libusb_free_ss_endpoint_companion_descriptor(struct libusb_ss_endpoint_companion_descriptor *ep_comp)
Free a superspeed endpoint companion descriptor obtained from libusb_get_ss_endpoint_companion_descri...
Definition descriptor.c:745
int libusb_get_device_descriptor(libusb_device *dev, struct libusb_device_descriptor *desc)
Get the USB device descriptor for a given device.
Definition descriptor.c:518
void libusb_free_usb_2_0_extension_descriptor(struct libusb_usb_2_0_extension_descriptor *usb_2_0_extension)
Free a USB 2.0 Extension descriptor obtained from libusb_get_usb_2_0_extension_descriptor().
Definition descriptor.c:954
int libusb_get_active_interface_association_descriptors(libusb_device *dev, struct libusb_interface_association_descriptor_array **iad_array)
Get an array of interface association descriptors (IAD) for the currently active configuration.
Definition descriptor.c:1487
int libusb_get_bos_descriptor(libusb_device_handle *dev_handle, struct libusb_bos_descriptor **bos)
Get a Binary Object Store (BOS) descriptor This is a BLOCKING function, which will send requests to t...
Definition descriptor.c:840
libusb_bos_type
USB capability types.
Definition libusb.h:553
int libusb_get_container_id_descriptor(libusb_context *ctx, struct libusb_bos_dev_capability_descriptor *dev_cap, struct libusb_container_id_descriptor **container_id)
Get a Container ID descriptor.
Definition descriptor.c:1141
libusb_endpoint_direction
Endpoint direction.
Definition libusb.h:361
libusb_endpoint_transfer_type
Endpoint transfer type.
Definition libusb.h:375
void libusb_free_ss_usb_device_capability_descriptor(struct libusb_ss_usb_device_capability_descriptor *ss_usb_device_cap)
Free a SuperSpeed USB Device Capability descriptor obtained from libusb_get_ss_usb_device_capability_...
Definition descriptor.c:1122
libusb_superspeedplus_sublink_attribute_exponent
enum used in libusb_ssplus_sublink_attribute Bit = Bits per second Kb = Kbps Mb = Mbps Gb = Gbps
Definition libusb.h:1011
libusb_superspeedplus_sublink_attribute_sublink_direction
enum used in libusb_ssplus_sublink_attribute
Definition libusb.h:999
static int libusb_get_descriptor(libusb_device_handle *dev_handle, uint8_t desc_type, uint8_t desc_index, unsigned char *data, int length)
Retrieve a descriptor from the default control pipe.
Definition libusb.h:2169
libusb_superspeedplus_sublink_attribute_sublink_type
enum used in libusb_ssplus_sublink_attribute
Definition libusb.h:991
libusb_iso_sync_type
Synchronization type for isochronous endpoints.
Definition libusb.h:480
void libusb_free_interface_association_descriptors(struct libusb_interface_association_descriptor_array *iad_array)
Free an array of interface association descriptors (IADs) obtained from libusb_get_interface_associat...
Definition descriptor.c:1523
int libusb_get_config_descriptor(libusb_device *dev, uint8_t config_index, struct libusb_config_descriptor **config)
Get a USB configuration descriptor based on its index.
Definition descriptor.c:583
libusb_ss_usb_device_capability_attributes
Masks for the bits of the bmAttributes field field of the SuperSpeed USB Device Capability descriptor...
Definition libusb.h:545
int libusb_get_ss_endpoint_companion_descriptor(libusb_context *ctx, const struct libusb_endpoint_descriptor *endpoint, struct libusb_ss_endpoint_companion_descriptor **ep_comp)
Get an endpoints superspeed endpoint companion descriptor (if any)
Definition descriptor.c:692
libusb_iso_usage_type
Usage type for isochronous endpoints.
Definition libusb.h:501
libusb_class_code
Device and/or Interface Class codes.
Definition libusb.h:218
int libusb_get_ss_usb_device_capability_descriptor(libusb_context *ctx, struct libusb_bos_dev_capability_descriptor *dev_cap, struct libusb_ss_usb_device_capability_descriptor **ss_usb_device_cap)
Get a SuperSpeed USB Device Capability descriptor.
Definition descriptor.c:973
int libusb_get_platform_descriptor(libusb_context *ctx, struct libusb_bos_dev_capability_descriptor *dev_cap, struct libusb_platform_descriptor **platform_descriptor)
Get a platform descriptor.
Definition descriptor.c:1201
void libusb_free_bos_descriptor(struct libusb_bos_descriptor *bos)
Free a BOS descriptor obtained from libusb_get_bos_descriptor().
Definition descriptor.c:890
libusb_superspeedplus_sublink_attribute_link_protocol
enum used in libusb_ssplus_sublink_attribute
Definition libusb.h:1021
libusb_usb_2_0_extension_attributes
Masks for the bits of the bmAttributes field of the USB 2.0 Extension descriptor.
Definition libusb.h:535
int libusb_get_usb_2_0_extension_descriptor(libusb_context *ctx, struct libusb_bos_dev_capability_descriptor *dev_cap, struct libusb_usb_2_0_extension_descriptor **usb_2_0_extension)
Get an USB 2.0 Extension descriptor.
Definition descriptor.c:915
void libusb_free_container_id_descriptor(struct libusb_container_id_descriptor *container_id)
Free a Container ID descriptor obtained from libusb_get_container_id_descriptor().
Definition descriptor.c:1180
@ LIBUSB_DT_HUB
Hub descriptor.
Definition libusb.h:319
@ LIBUSB_DT_CONFIG
Configuration descriptor.
Definition libusb.h:288
@ LIBUSB_DT_STRING
String descriptor.
Definition libusb.h:291
@ LIBUSB_DT_HID
HID descriptor.
Definition libusb.h:310
@ LIBUSB_DT_REPORT
HID report descriptor.
Definition libusb.h:313
@ LIBUSB_DT_DEVICE
Device descriptor.
Definition libusb.h:285
@ LIBUSB_DT_DEVICE_CAPABILITY
Device Capability descriptor.
Definition libusb.h:307
@ LIBUSB_DT_SUPERSPEED_HUB
SuperSpeed Hub descriptor.
Definition libusb.h:322
@ LIBUSB_DT_PHYSICAL
Physical descriptor.
Definition libusb.h:316
@ LIBUSB_DT_INTERFACE
Interface descriptor.
Definition libusb.h:294
@ LIBUSB_DT_ENDPOINT
Endpoint descriptor.
Definition libusb.h:297
@ LIBUSB_DT_SS_ENDPOINT_COMPANION
SuperSpeed Endpoint Companion descriptor.
Definition libusb.h:325
@ LIBUSB_DT_BOS
BOS descriptor.
Definition libusb.h:304
@ LIBUSB_DT_INTERFACE_ASSOCIATION
Interface Association Descriptor.
Definition libusb.h:301
@ LIBUSB_HIGH_SPEED_OPERATION
High speed operation supported (480MBit/s).
Definition libusb.h:524
@ LIBUSB_LOW_SPEED_OPERATION
Low speed operation supported (1.5MBit/s).
Definition libusb.h:518
@ LIBUSB_SUPER_SPEED_OPERATION
Superspeed operation supported (5000MBit/s).
Definition libusb.h:527
@ LIBUSB_FULL_SPEED_OPERATION
Full speed operation supported (12MBit/s).
Definition libusb.h:521
@ LIBUSB_BT_USB_2_0_EXTENSION
USB 2.0 extensions.
Definition libusb.h:558
@ LIBUSB_BT_SS_USB_DEVICE_CAPABILITY
SuperSpeed USB device capability.
Definition libusb.h:561
@ LIBUSB_BT_SUPERSPEED_PLUS_CAPABILITY
SuperSpeedPlus device capability.
Definition libusb.h:570
@ LIBUSB_BT_PLATFORM_DESCRIPTOR
Platform descriptor.
Definition libusb.h:567
@ LIBUSB_BT_WIRELESS_USB_DEVICE_CAPABILITY
Wireless USB device capability.
Definition libusb.h:555
@ LIBUSB_BT_CONTAINER_ID
Container ID type.
Definition libusb.h:564
@ LIBUSB_ENDPOINT_IN
In: device-to-host.
Definition libusb.h:366
@ LIBUSB_ENDPOINT_OUT
Out: host-to-device.
Definition libusb.h:363
@ LIBUSB_ENDPOINT_TRANSFER_TYPE_INTERRUPT
Interrupt endpoint.
Definition libusb.h:386
@ LIBUSB_ENDPOINT_TRANSFER_TYPE_ISOCHRONOUS
Isochronous endpoint.
Definition libusb.h:380
@ LIBUSB_ENDPOINT_TRANSFER_TYPE_BULK
Bulk endpoint.
Definition libusb.h:383
@ LIBUSB_ENDPOINT_TRANSFER_TYPE_CONTROL
Control endpoint.
Definition libusb.h:377
@ LIBUSB_ISO_SYNC_TYPE_SYNC
Synchronous.
Definition libusb.h:491
@ LIBUSB_ISO_SYNC_TYPE_NONE
No synchronization.
Definition libusb.h:482
@ LIBUSB_ISO_SYNC_TYPE_ADAPTIVE
Adaptive.
Definition libusb.h:488
@ LIBUSB_ISO_SYNC_TYPE_ASYNC
Asynchronous.
Definition libusb.h:485
@ LIBUSB_BM_LTM_SUPPORT
Supports Latency Tolerance Messages (LTM)
Definition libusb.h:547
@ LIBUSB_ISO_USAGE_TYPE_DATA
Data endpoint.
Definition libusb.h:503
@ LIBUSB_ISO_USAGE_TYPE_FEEDBACK
Feedback endpoint.
Definition libusb.h:506
@ LIBUSB_ISO_USAGE_TYPE_IMPLICIT
Implicit feedback Data endpoint.
Definition libusb.h:509
@ LIBUSB_CLASS_AUDIO
Audio class.
Definition libusb.h:226
@ LIBUSB_CLASS_HUB
Hub class.
Definition libusb.h:248
@ LIBUSB_CLASS_MISCELLANEOUS
Miscellaneous class.
Definition libusb.h:272
@ LIBUSB_CLASS_APPLICATION
Application class.
Definition libusb.h:275
@ LIBUSB_CLASS_CONTENT_SECURITY
Content Security.
Definition libusb.h:257
@ LIBUSB_CLASS_DIAGNOSTIC_DEVICE
Diagnostic Device.
Definition libusb.h:266
@ LIBUSB_CLASS_PHYSICAL
Physical.
Definition libusb.h:235
@ LIBUSB_CLASS_COMM
Communications class.
Definition libusb.h:229
@ LIBUSB_CLASS_VIDEO
Video.
Definition libusb.h:260
@ LIBUSB_CLASS_DATA
Data class.
Definition libusb.h:251
@ LIBUSB_CLASS_WIRELESS
Wireless class.
Definition libusb.h:269
@ LIBUSB_CLASS_PRINTER
Printer class.
Definition libusb.h:242
@ LIBUSB_CLASS_PERSONAL_HEALTHCARE
Personal Healthcare.
Definition libusb.h:263
@ LIBUSB_CLASS_PER_INTERFACE
In the context of a device descriptor, this bDeviceClass value indicates that each interface specifie...
Definition libusb.h:223
@ LIBUSB_CLASS_MASS_STORAGE
Mass storage class.
Definition libusb.h:245
@ LIBUSB_CLASS_HID
Human Interface Device class.
Definition libusb.h:232
@ LIBUSB_CLASS_VENDOR_SPEC
Class is vendor-specific.
Definition libusb.h:278
@ LIBUSB_CLASS_IMAGE
Image class.
Definition libusb.h:238
@ LIBUSB_CLASS_SMART_CARD
Smart Card.
Definition libusb.h:254
@ LIBUSB_BM_LPM_SUPPORT
Supports Link Power Management (LPM)
Definition libusb.h:537
int libusb_get_max_alt_packet_size(libusb_device *dev, int interface_number, int alternate_setting, unsigned char endpoint)
Calculate the maximum packet size which a specific endpoint is capable of sending or receiving in the...
Definition core.c:1239
libusb_device_handle * libusb_open_device_with_vid_pid(libusb_context *ctx, uint16_t vendor_id, uint16_t product_id)
Convenience function for finding a device with a particular idVendor/idProduct combination.
Definition core.c:1460
uint8_t libusb_get_port_number(libusb_device *dev)
Get the number of the port that a device is connected to.
Definition core.c:932
libusb_device * libusb_get_parent(libusb_device *dev)
Get the the parent from the specified device.
Definition core.c:994
int libusb_kernel_driver_active(libusb_device_handle *dev_handle, int interface_number)
Determine if a kernel driver is active on an interface.
Definition core.c:2084
libusb_device * libusb_ref_device(libusb_device *dev)
Increment the reference count of a device.
Definition core.c:1273
libusb_speed
Speed codes.
Definition libusb.h:1252
libusb_device * libusb_get_device(libusb_device_handle *dev_handle)
Get the underlying device for a device handle.
Definition core.c:1624
void libusb_unref_device(libusb_device *dev)
Decrement the reference count of a device.
Definition core.c:1288
int libusb_open(libusb_device *dev, libusb_device_handle **dev_handle)
Open a device and obtain a device handle.
Definition core.c:1405
int libusb_set_interface_alt_setting(libusb_device_handle *dev_handle, int interface_number, int alternate_setting)
Activate an alternate setting for an interface.
Definition core.c:1862
int libusb_release_interface(libusb_device_handle *dev_handle, int interface_number)
Release an interface previously claimed with libusb_claim_interface().
Definition core.c:1817
int libusb_get_device_speed(libusb_device *dev)
Get the negotiated connection speed for a device.
Definition core.c:1015
int libusb_detach_kernel_driver(libusb_device_handle *dev_handle, int interface_number)
Detach a kernel driver from an interface.
Definition core.c:2122
void libusb_close(libusb_device_handle *dev_handle)
Close a device handle.
Definition core.c:1562
struct libusb_device libusb_device
Structure representing a USB device detected on the system.
Definition libusb.h:1236
int libusb_set_configuration(libusb_device_handle *dev_handle, int configuration)
Set the active configuration for a device.
Definition core.c:1736
struct libusb_device_handle libusb_device_handle
Structure representing a handle on a USB device.
Definition libusb.h:1247
int libusb_wrap_sys_device(libusb_context *ctx, intptr_t sys_dev, libusb_device_handle **dev_handle)
Wrap a platform-specific system device handle and obtain a libusb device handle for the underlying de...
Definition core.c:1350
int libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *path, uint8_t path_length)
Definition core.c:974
int libusb_get_port_numbers(libusb_device *dev, uint8_t *port_numbers, int port_numbers_len)
Get the list of all port numbers from root for the specified device.
Definition core.c:948
uint8_t libusb_get_device_address(libusb_device *dev)
Get the address of the device on the bus it is connected to.
Definition core.c:1004
int libusb_clear_halt(libusb_device_handle *dev_handle, unsigned char endpoint)
Clear the halt/stall condition for an endpoint.
Definition core.c:1903
ssize_t libusb_get_device_list(libusb_context *ctx, libusb_device ***list)
Returns a list of USB devices currently attached to the system.
Definition core.c:822
int libusb_set_auto_detach_kernel_driver(libusb_device_handle *dev_handle, int enable)
Enable/disable libusb's automatic kernel driver detachment.
Definition core.c:2197
int libusb_get_max_packet_size(libusb_device *dev, unsigned char endpoint)
Convenience function to retrieve the wMaxPacketSize value for a particular endpoint in the active dev...
Definition core.c:1061
void libusb_free_device_list(libusb_device **list, int unref_devices)
Frees a list of devices previously discovered using libusb_get_device_list().
Definition core.c:892
int libusb_attach_kernel_driver(libusb_device_handle *dev_handle, int interface_number)
Re-attach an interface's kernel driver, which was previously detached using libusb_detach_kernel_driv...
Definition core.c:2158
int libusb_get_configuration(libusb_device_handle *dev, int *config)
Determine the bConfigurationValue of the currently active configuration.
Definition core.c:1649
int libusb_get_max_iso_packet_size(libusb_device *dev, unsigned char endpoint)
Calculate the maximum packet size which a specific endpoint is capable is sending or receiving in the...
Definition core.c:1180
int libusb_claim_interface(libusb_device_handle *dev_handle, int interface_number)
Claim an interface on a given device handle.
Definition core.c:1773
uint8_t libusb_get_bus_number(libusb_device *dev)
Get the number of the bus that a device is connected to.
Definition core.c:913
int libusb_reset_device(libusb_device_handle *dev_handle)
Perform a USB port reset to reinitialize a device.
Definition core.c:1932
@ LIBUSB_SPEED_FULL
The device is operating at full speed (12MBit/s).
Definition libusb.h:1260
@ LIBUSB_SPEED_SUPER_PLUS_X2
The device is operating at super speed plus x2 (20000MBit/s).
Definition libusb.h:1272
@ LIBUSB_SPEED_HIGH
The device is operating at high speed (480MBit/s).
Definition libusb.h:1263
@ LIBUSB_SPEED_LOW
The device is operating at low speed (1.5MBit/s).
Definition libusb.h:1257
@ LIBUSB_SPEED_SUPER_PLUS
The device is operating at super speed plus (10000MBit/s).
Definition libusb.h:1269
@ LIBUSB_SPEED_SUPER
The device is operating at super speed (5000MBit/s).
Definition libusb.h:1266
@ LIBUSB_SPEED_UNKNOWN
The OS doesn't report or know the device speed.
Definition libusb.h:1254
int libusb_hotplug_callback_handle
Callback handle.
Definition libusb.h:2283
libusb_hotplug_event
Since version 1.0.16, LIBUSB_API_VERSION >= 0x01000102.
Definition libusb.h:2290
int libusb_hotplug_register_callback(libusb_context *ctx, int events, int flags, int vendor_id, int product_id, int dev_class, libusb_hotplug_callback_fn cb_fn, void *user_data, libusb_hotplug_callback_handle *callback_handle)
Register a hotplug callback function.
Definition hotplug.c:342
int(* libusb_hotplug_callback_fn)(libusb_context *ctx, libusb_device *device, libusb_hotplug_event event, void *user_data)
Hotplug callback function type.
Definition libusb.h:2340
void libusb_hotplug_deregister_callback(libusb_context *ctx, libusb_hotplug_callback_handle callback_handle)
Deregisters a hotplug callback.
Definition hotplug.c:427
libusb_hotplug_flag
Since version 1.0.16, LIBUSB_API_VERSION >= 0x01000102.
Definition libusb.h:2305
void * libusb_hotplug_get_user_data(libusb_context *ctx, libusb_hotplug_callback_handle callback_handle)
Gets the user_data associated with a hotplug callback.
Definition hotplug.c:465
@ LIBUSB_HOTPLUG_EVENT_DEVICE_ARRIVED
A device has been plugged in and is ready to use.
Definition libusb.h:2292
@ LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT
A device has left and is no longer available.
Definition libusb.h:2297
@ LIBUSB_HOTPLUG_ENUMERATE
Arm the callback and fire it for all matching currently attached devices.
Definition libusb.h:2307
libusb_option
Available option values for libusb_set_option() and libusb_init_context().
Definition libusb.h:1580
int LIBUSB_CALLV libusb_set_option(libusb_context *ctx, enum libusb_option option,...)
Set an option in the library.
Definition core.c:2291
libusb_log_cb_mode
Log callback mode.
Definition libusb.h:1569
libusb_log_level
Log message levels.
Definition libusb.h:1545
void libusb_set_log_cb(libusb_context *ctx, libusb_log_cb cb, int mode)
Set log handler.
Definition core.c:2262
struct libusb_context libusb_context
Structure representing a libusb session.
Definition libusb.h:1219
void libusb_set_debug(libusb_context *ctx, int level)
Deprecated.
Definition core.c:2211
void(* libusb_log_cb)(libusb_context *ctx, enum libusb_log_level level, const char *str)
Callback function for handling log messages.
Definition libusb.h:1661
int libusb_init(libusb_context **ctx)
Deprecated initialization function.
Definition core.c:2399
int libusb_init_context(libusb_context **ctx, const struct libusb_init_option options[], int num_options)
Initialize libusb.
Definition core.c:2422
void libusb_exit(libusb_context *ctx)
Deinitialize libusb.
Definition core.c:2575
@ LIBUSB_OPTION_NO_DEVICE_DISCOVERY
Do not scan for devices.
Definition libusb.h:1632
@ LIBUSB_OPTION_LOG_CB
Set the context log callback function.
Definition libusb.h:1645
@ LIBUSB_OPTION_LOG_LEVEL
Set the log message verbosity.
Definition libusb.h:1603
@ LIBUSB_OPTION_USE_USBDK
Use the UsbDk backend for a specific context, if available.
Definition libusb.h:1612
@ LIBUSB_LOG_CB_GLOBAL
Callback function handling all log messages.
Definition libusb.h:1571
@ LIBUSB_LOG_CB_CONTEXT
Callback function handling context related log messages.
Definition libusb.h:1574
@ LIBUSB_LOG_LEVEL_WARNING
(2) : Warning and error messages are emitted
Definition libusb.h:1553
@ LIBUSB_LOG_LEVEL_INFO
(3) : Informational, warning and error messages are emitted
Definition libusb.h:1556
@ LIBUSB_LOG_LEVEL_ERROR
(1) : Error messages are emitted
Definition libusb.h:1550
@ LIBUSB_LOG_LEVEL_NONE
(0) : No messages ever emitted by the library (default)
Definition libusb.h:1547
@ LIBUSB_LOG_LEVEL_DEBUG
(4) : All messages are emitted
Definition libusb.h:1559
libusb_request_type
Request type bits of the bmRequestType field in control transfers.
Definition libusb.h:441
int libusb_setlocale(const char *locale)
Set the language, and only the language, not the encoding! used for translatable libusb messages.
Definition strerror.c:178
const struct libusb_version * libusb_get_version(void)
Returns a pointer to const struct libusb_version with the version (major, minor, micro,...
Definition core.c:2922
libusb_request_recipient
Recipient bits of the bmRequestType field in control transfers.
Definition libusb.h:459
#define libusb_le16_to_cpu
Convert a 16-bit value from little-endian to host-endian format.
Definition libusb.h:212
const char * libusb_strerror(int errcode)
Returns a constant string with a short description of the given error code, this description is inten...
Definition strerror.c:213
libusb_standard_request
Standard requests, as defined in table 9-5 of the USB 3.0 specifications.
Definition libusb.h:391
int libusb_has_capability(uint32_t capability)
Check at runtime if the loaded library has a given capability.
Definition core.c:2649
#define LIBUSB_CALL
libusb's Windows calling convention.
Definition libusb.h:125
libusb_capability
Capabilities supported by an instance of libusb on the current running platform.
Definition libusb.h:1524
libusb_error
Error codes.
Definition libusb.h:1282
static uint16_t libusb_cpu_to_le16(const uint16_t x)
Convert a 16-bit value from host-endian to little-endian format.
Definition libusb.h:193
const char * libusb_error_name(int error_code)
Returns a constant NULL-terminated string with the ASCII name of a libusb error or transfer status co...
Definition core.c:2867
@ LIBUSB_REQUEST_TYPE_VENDOR
Vendor.
Definition libusb.h:449
@ LIBUSB_REQUEST_TYPE_STANDARD
Standard.
Definition libusb.h:443
@ LIBUSB_REQUEST_TYPE_CLASS
Class.
Definition libusb.h:446
@ LIBUSB_REQUEST_TYPE_RESERVED
Reserved.
Definition libusb.h:452
@ LIBUSB_RECIPIENT_ENDPOINT
Endpoint.
Definition libusb.h:467
@ LIBUSB_RECIPIENT_INTERFACE
Interface.
Definition libusb.h:464
@ LIBUSB_RECIPIENT_OTHER
Other.
Definition libusb.h:470
@ LIBUSB_RECIPIENT_DEVICE
Device.
Definition libusb.h:461
@ LIBUSB_REQUEST_CLEAR_FEATURE
Clear or disable a specific feature.
Definition libusb.h:396
@ LIBUSB_REQUEST_GET_INTERFACE
Return the selected alternate setting for the specified interface.
Definition libusb.h:421
@ LIBUSB_REQUEST_GET_DESCRIPTOR
Get the specified descriptor.
Definition libusb.h:409
@ LIBUSB_REQUEST_SET_DESCRIPTOR
Used to update existing descriptors or add new descriptors.
Definition libusb.h:412
@ LIBUSB_REQUEST_GET_STATUS
Request status of the specific recipient.
Definition libusb.h:393
@ LIBUSB_REQUEST_SET_FEATURE
Set or enable a specific feature.
Definition libusb.h:401
@ LIBUSB_REQUEST_SET_INTERFACE
Select an alternate interface for the specified interface.
Definition libusb.h:424
@ LIBUSB_REQUEST_SET_ADDRESS
Set device address for all future accesses.
Definition libusb.h:406
@ LIBUSB_REQUEST_GET_CONFIGURATION
Get the current device configuration value.
Definition libusb.h:415
@ LIBUSB_REQUEST_SET_SEL
Sets both the U1 and U2 Exit Latency.
Definition libusb.h:430
@ LIBUSB_SET_ISOCH_DELAY
Delay from the time a host transmits a packet to the time it is received by the device.
Definition libusb.h:434
@ LIBUSB_REQUEST_SYNCH_FRAME
Set then report an endpoint's synchronization frame.
Definition libusb.h:427
@ LIBUSB_REQUEST_SET_CONFIGURATION
Set device configuration.
Definition libusb.h:418
@ LIBUSB_CAP_HAS_CAPABILITY
The libusb_has_capability() API is available.
Definition libusb.h:1526
@ LIBUSB_CAP_HAS_HOTPLUG
Hotplug support is available on this platform.
Definition libusb.h:1529
@ LIBUSB_CAP_HAS_HID_ACCESS
The library can access HID devices without requiring user intervention.
Definition libusb.h:1535
@ LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER
The library supports detaching of the default USB driver, using libusb_detach_kernel_driver(),...
Definition libusb.h:1539
@ LIBUSB_ERROR_NOT_SUPPORTED
Operation not supported or unimplemented on this platform.
Definition libusb.h:1320
@ LIBUSB_ERROR_ACCESS
Access denied (insufficient permissions)
Definition libusb.h:1293
@ LIBUSB_ERROR_PIPE
Pipe error.
Definition libusb.h:1311
@ LIBUSB_ERROR_NOT_FOUND
Entity not found.
Definition libusb.h:1299
@ LIBUSB_ERROR_BUSY
Resource busy.
Definition libusb.h:1302
@ LIBUSB_ERROR_INTERRUPTED
System call interrupted (perhaps due to signal)
Definition libusb.h:1314
@ LIBUSB_SUCCESS
Success (no error)
Definition libusb.h:1284
@ LIBUSB_ERROR_INVALID_PARAM
Invalid parameter.
Definition libusb.h:1290
@ LIBUSB_ERROR_IO
Input/output error.
Definition libusb.h:1287
@ LIBUSB_ERROR_OTHER
Other error.
Definition libusb.h:1326
@ LIBUSB_ERROR_TIMEOUT
Operation timed out.
Definition libusb.h:1305
@ LIBUSB_ERROR_OVERFLOW
Overflow.
Definition libusb.h:1308
@ LIBUSB_ERROR_NO_DEVICE
No such device (it may have been disconnected)
Definition libusb.h:1296
@ LIBUSB_ERROR_NO_MEM
Insufficient memory.
Definition libusb.h:1317
int libusb_handle_events_completed(libusb_context *ctx, int *completed)
Handle any pending events in blocking mode.
Definition io.c:2463
void libusb_lock_event_waiters(libusb_context *ctx)
Acquire the event waiters lock.
Definition io.c:1984
void libusb_interrupt_event_handler(libusb_context *ctx)
Interrupt any active thread that is handling events.
Definition io.c:1948
void libusb_set_pollfd_notifiers(libusb_context *ctx, libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb, void *user_data)
Register notification functions for file descriptor additions/removals.
Definition io.c:2645
int libusb_event_handler_active(libusb_context *ctx)
Determine if an active thread is handling events (i.e.
Definition io.c:1919
void libusb_unlock_event_waiters(libusb_context *ctx)
Release the event waiters lock.
Definition io.c:1995
int libusb_handle_events_timeout_completed(libusb_context *ctx, struct timeval *tv, int *completed)
Handle any pending events.
Definition io.c:2349
int libusb_handle_events(libusb_context *ctx)
Handle any pending events in blocking mode.
Definition io.c:2441
int libusb_get_next_timeout(libusb_context *ctx, struct timeval *tv)
Determine the next internal timeout that libusb needs to handle.
Definition io.c:2573
int libusb_event_handling_ok(libusb_context *ctx)
Determine if it is still OK for this thread to be doing event handling.
Definition io.c:1890
int libusb_handle_events_timeout(libusb_context *ctx, struct timeval *tv)
Handle any pending events.
Definition io.c:2421
int libusb_try_lock_events(libusb_context *ctx)
Attempt to acquire the event handling lock.
Definition io.c:1797
int libusb_handle_events_locked(libusb_context *ctx, struct timeval *tv)
Handle any pending events by polling file descriptors, without checking if any other threads are alre...
Definition io.c:2491
void(* libusb_pollfd_removed_cb)(int fd, void *user_data)
Callback function, invoked when a file descriptor should be removed from the set of file descriptors ...
Definition libusb.h:2262
void(* libusb_pollfd_added_cb)(int fd, short events, void *user_data)
Callback function, invoked when a new file descriptor should be added to the set of file descriptors ...
Definition libusb.h:2250
void libusb_lock_events(libusb_context *ctx)
Acquire the event handling lock, blocking until successful acquisition if it is contended.
Definition io.c:1840
const struct libusb_pollfd ** libusb_get_pollfds(libusb_context *ctx)
Retrieve a list of file descriptors that should be polled by your main loop as libusb event sources.
Definition io.c:2753
void libusb_unlock_events(libusb_context *ctx)
Release the lock previously acquired with libusb_try_lock_events() or libusb_lock_events().
Definition io.c:1855
void libusb_free_pollfds(const struct libusb_pollfd **pollfds)
Free a list of libusb_pollfd structures.
Definition io.c:2801
int libusb_wait_for_event(libusb_context *ctx, struct timeval *tv)
Wait for another thread to signal completion of an event.
Definition io.c:2027
int libusb_pollfds_handle_timeouts(libusb_context *ctx)
Determines whether your application must apply special timing considerations when monitoring libusb's...
Definition io.c:2539
int libusb_interrupt_transfer(libusb_device_handle *dev_handle, unsigned char endpoint, unsigned char *data, int length, int *transferred, unsigned int timeout)
Perform a USB interrupt transfer.
Definition sync.c:336
int libusb_bulk_transfer(libusb_device_handle *dev_handle, unsigned char endpoint, unsigned char *data, int length, int *transferred, unsigned int timeout)
Perform a USB bulk transfer.
Definition sync.c:282
int libusb_control_transfer(libusb_device_handle *dev_handle, uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex, unsigned char *data, uint16_t wLength, unsigned int timeout)
Perform a USB control transfer.
Definition sync.c:103
A structure representing the Binary Device Object Store (BOS) descriptor.
Definition libusb.h:900
uint16_t wTotalLength
Length of this descriptor and all of its sub descriptors.
Definition libusb.h:910
struct libusb_bos_dev_capability_descriptor * dev_capability[LIBUSB_FLEXIBLE_ARRAY]
bNumDeviceCap Device Capability Descriptors
Definition libusb.h:917
uint8_t bNumDeviceCaps
The number of separate device capability descriptors in the BOS.
Definition libusb.h:914
uint8_t bLength
Size of this descriptor (in bytes)
Definition libusb.h:902
uint8_t bDescriptorType
Descriptor type.
Definition libusb.h:907
A generic representation of a BOS Device Capability descriptor.
Definition libusb.h:879
uint8_t bLength
Size of this descriptor (in bytes)
Definition libusb.h:881
uint8_t bDescriptorType
Descriptor type.
Definition libusb.h:886
uint8_t bDevCapabilityType
Device Capability type.
Definition libusb.h:889
uint8_t dev_capability_data[LIBUSB_FLEXIBLE_ARRAY]
Device Capability data (bLength - 3 bytes)
Definition libusb.h:892
A structure representing the standard USB configuration descriptor.
Definition libusb.h:802
uint8_t bConfigurationValue
Identifier value for this configuration.
Definition libusb.h:818
uint8_t iConfiguration
Index of string descriptor describing this configuration.
Definition libusb.h:821
int extra_length
Length of the extra descriptors, in bytes.
Definition libusb.h:841
uint8_t bLength
Size of this descriptor (in bytes)
Definition libusb.h:804
uint8_t bNumInterfaces
Number of interfaces supported by this configuration.
Definition libusb.h:815
uint8_t MaxPower
Maximum power consumption of the USB device from this bus in this configuration when the device is fu...
Definition libusb.h:830
uint16_t wTotalLength
Total length of data returned for this configuration.
Definition libusb.h:812
uint8_t bDescriptorType
Descriptor type.
Definition libusb.h:809
const unsigned char * extra
Extra descriptors.
Definition libusb.h:838
uint8_t bmAttributes
Configuration characteristics.
Definition libusb.h:824
const struct libusb_interface * interface
Array of interfaces supported by this configuration.
Definition libusb.h:834
A structure representing the Container ID descriptor.
Definition libusb.h:1087
uint8_t ContainerID[16]
128 bit UUID
Definition libusb.h:1105
uint8_t bDescriptorType
Descriptor type.
Definition libusb.h:1094
uint8_t bDevCapabilityType
Capability type.
Definition libusb.h:1099
uint8_t bLength
Size of this descriptor (in bytes)
Definition libusb.h:1089
uint8_t bReserved
Reserved field.
Definition libusb.h:1102
Setup packet for control transfers.
Definition libusb.h:1141
uint8_t bRequest
Request.
Definition libusb.h:1154
uint8_t bmRequestType
Request type.
Definition libusb.h:1147
uint16_t wLength
Number of bytes to transfer.
Definition libusb.h:1164
uint16_t wIndex
Index.
Definition libusb.h:1161
uint16_t wValue
Value.
Definition libusb.h:1157
A structure representing the standard USB device descriptor.
Definition libusb.h:578
uint8_t bNumConfigurations
Number of possible configurations.
Definition libusb.h:624
uint8_t iProduct
Index of string descriptor describing product.
Definition libusb.h:618
uint8_t iSerialNumber
Index of string descriptor containing device serial number.
Definition libusb.h:621
uint8_t bMaxPacketSize0
Maximum packet size for endpoint 0.
Definition libusb.h:603
uint8_t bDeviceProtocol
USB-IF protocol code for the device, qualified by the bDeviceClass and bDeviceSubClass values.
Definition libusb.h:600
uint16_t idProduct
USB-IF product ID.
Definition libusb.h:609
uint8_t bDescriptorType
Descriptor type.
Definition libusb.h:585
uint8_t bDeviceSubClass
USB-IF subclass code for the device, qualified by the bDeviceClass value.
Definition libusb.h:596
uint8_t bDeviceClass
USB-IF class code for the device.
Definition libusb.h:592
uint8_t iManufacturer
Index of string descriptor describing manufacturer.
Definition libusb.h:615
uint16_t idVendor
USB-IF vendor ID.
Definition libusb.h:606
uint16_t bcdUSB
USB specification release number in binary-coded decimal.
Definition libusb.h:589
uint16_t bcdDevice
Device release number in binary-coded decimal.
Definition libusb.h:612
uint8_t bLength
Size of this descriptor (in bytes)
Definition libusb.h:580
A structure representing the standard USB endpoint descriptor.
Definition libusb.h:632
int extra_length
Length of the extra descriptors, in bytes.
Definition libusb.h:672
uint8_t bEndpointAddress
The address of the endpoint described by this descriptor.
Definition libusb.h:644
const unsigned char * extra
Extra descriptors.
Definition libusb.h:669
uint8_t bInterval
Interval for polling endpoint for data transfers.
Definition libusb.h:658
uint8_t bDescriptorType
Descriptor type.
Definition libusb.h:639
uint8_t bRefresh
For audio devices only: the rate at which synchronization feedback is provided.
Definition libusb.h:662
uint8_t bmAttributes
Attributes which apply to the endpoint when it is configured using the bConfigurationValue.
Definition libusb.h:652
uint8_t bLength
Size of this descriptor (in bytes)
Definition libusb.h:634
uint8_t bSynchAddress
For audio devices only: the address if the synch endpoint.
Definition libusb.h:665
uint16_t wMaxPacketSize
Maximum packet size this endpoint is capable of sending/receiving.
Definition libusb.h:655
Structure used for setting options through libusb_init_context.
Definition libusb.h:1668
enum libusb_option option
Which option to set.
Definition libusb.h:1670
union libusb_init_option::@0 value
An integer value used by the option (if applicable).
Structure containing an array of 0 or more interface association descriptors.
Definition libusb.h:724
const struct libusb_interface_association_descriptor * iad
Array of interface association descriptors.
Definition libusb.h:728
int length
Number of interface association descriptors contained.
Definition libusb.h:731
A structure representing the standard USB interface association descriptor.
Definition libusb.h:680
uint8_t bFunctionClass
USB-IF class code for this function.
Definition libusb.h:702
uint8_t bDescriptorType
Descriptor type.
Definition libusb.h:687
uint8_t bFunctionSubClass
USB-IF subclass code for this function.
Definition libusb.h:708
uint8_t bFunctionProtocol
USB-IF protocol code for this function.
Definition libusb.h:714
uint8_t bInterfaceCount
Number of contiguous interfaces that are associated with this function.
Definition libusb.h:695
uint8_t iFunction
Index of string descriptor describing this function.
Definition libusb.h:717
uint8_t bFirstInterface
Interface number of the first interface that is associated with this function.
Definition libusb.h:691
uint8_t bLength
Size of this descriptor (in bytes)
Definition libusb.h:682
A structure representing the standard USB interface descriptor.
Definition libusb.h:739
uint8_t bInterfaceSubClass
USB-IF subclass code for this interface, qualified by the bInterfaceClass value.
Definition libusb.h:763
uint8_t iInterface
Index of string descriptor describing this interface.
Definition libusb.h:770
uint8_t bInterfaceClass
USB-IF class code for this interface.
Definition libusb.h:759
uint8_t bAlternateSetting
Value used to select this alternate setting for this interface.
Definition libusb.h:752
const struct libusb_endpoint_descriptor * endpoint
Array of endpoint descriptors.
Definition libusb.h:774
uint8_t bNumEndpoints
Number of endpoints used by this interface (excluding the control endpoint).
Definition libusb.h:756
uint8_t bInterfaceProtocol
USB-IF protocol code for this interface, qualified by the bInterfaceClass and bInterfaceSubClass valu...
Definition libusb.h:767
uint8_t bLength
Size of this descriptor (in bytes)
Definition libusb.h:741
uint8_t bInterfaceNumber
Number of this interface.
Definition libusb.h:749
const unsigned char * extra
Extra descriptors.
Definition libusb.h:778
int extra_length
Length of the extra descriptors, in bytes.
Definition libusb.h:781
uint8_t bDescriptorType
Descriptor type.
Definition libusb.h:746
A collection of alternate settings for a particular USB interface.
Definition libusb.h:787
const struct libusb_interface_descriptor * altsetting
Array of interface descriptors.
Definition libusb.h:790
int num_altsetting
The number of alternate settings that belong to this interface.
Definition libusb.h:794
Isochronous packet descriptor.
Definition libusb.h:1428
unsigned int actual_length
Amount of data that was actually transferred.
Definition libusb.h:1433
unsigned int length
Length of data to request in this packet.
Definition libusb.h:1430
enum libusb_transfer_status status
Status code for this packet.
Definition libusb.h:1436
A structure representing a Platform descriptor.
Definition libusb.h:1112
uint8_t bDevCapabilityType
Capability type.
Definition libusb.h:1124
uint8_t PlatformCapabilityUUID[16]
128 bit UUID
Definition libusb.h:1130
uint8_t bReserved
Reserved field.
Definition libusb.h:1127
uint8_t bLength
Size of this descriptor (in bytes)
Definition libusb.h:1114
uint8_t bDescriptorType
Descriptor type.
Definition libusb.h:1119
uint8_t CapabilityData[LIBUSB_FLEXIBLE_ARRAY]
Capability data (bLength - 20)
Definition libusb.h:1133
File descriptor for polling.
Definition libusb.h:2229
short events
Event flags to poll for from <poll.h>.
Definition libusb.h:2237
int fd
Numeric file descriptor.
Definition libusb.h:2231
A structure representing the superspeed endpoint companion descriptor.
Definition libusb.h:850
uint16_t wBytesPerInterval
The total number of bytes this EP will transfer every service interval.
Definition libusb.h:871
uint8_t bLength
Size of this descriptor (in bytes)
Definition libusb.h:852
uint8_t bDescriptorType
Descriptor type.
Definition libusb.h:857
uint8_t bMaxBurst
The maximum number of packets the endpoint can send or receive as part of a burst.
Definition libusb.h:861
uint8_t bmAttributes
In bulk EP: bits 4:0 represents the maximum number of streams the EP supports.
Definition libusb.h:867
A structure representing the SuperSpeed USB Device Capability descriptor This descriptor is documente...
Definition libusb.h:951
uint8_t bDevCapabilityType
Capability type.
Definition libusb.h:963
uint16_t wSpeedSupported
Bitmap encoding of the speed supported by this device when operating in SuperSpeed mode.
Definition libusb.h:973
uint8_t bFunctionalitySupport
The lowest speed at which all the functionality supported by the device is available to the user.
Definition libusb.h:979
uint16_t bU2DevExitLat
U2 Device Exit Latency.
Definition libusb.h:985
uint8_t bLength
Size of this descriptor (in bytes)
Definition libusb.h:953
uint8_t bmAttributes
Bitmap encoding of supported device level features.
Definition libusb.h:969
uint8_t bU1DevExitLat
U1 Device Exit Latency.
Definition libusb.h:982
uint8_t bDescriptorType
Descriptor type.
Definition libusb.h:958
A structure representing the SuperSpeedPlus descriptor This descriptor is documented in section 9....
Definition libusb.h:1062
uint8_t minTxLaneCount
This field indicates the minimum transmit lane count.
Definition libusb.h:1076
uint8_t numSublinkSpeedAttributes
Sublink Speed Attribute Count.
Definition libusb.h:1064
struct libusb_ssplus_sublink_attribute sublinkSpeedAttributes[]
Array size is libusb_ssplus_usb_device_capability_descriptor::numSublinkSpeedAttributes.
Definition libusb.h:1079
uint8_t ssid
Unique ID to indicates the minimum lane speed.
Definition libusb.h:1070
uint8_t numSublinkSpeedIDs
Sublink Speed ID Count.
Definition libusb.h:1067
uint8_t minRxLaneCount
This field indicates the minimum receive lane count.
Definition libusb.h:1073
The generic USB transfer structure.
Definition libusb.h:1458
unsigned char endpoint
Address of the endpoint where this transfer will be sent.
Definition libusb.h:1466
enum libusb_transfer_status status
The status of the transfer.
Definition libusb.h:1482
int length
Length of the data buffer.
Definition libusb.h:1485
libusb_transfer_cb_fn callback
Callback function.
Definition libusb.h:1494
struct libusb_iso_packet_descriptor iso_packet_desc[LIBUSB_FLEXIBLE_ARRAY]
Isochronous packet descriptors, for isochronous transfers only.
Definition libusb.h:1516
unsigned char type
Type of the transfer from libusb_transfer_type.
Definition libusb.h:1469
int actual_length
Actual length of data that was transferred.
Definition libusb.h:1490
unsigned char * buffer
Data buffer.
Definition libusb.h:1509
int num_iso_packets
Number of isochronous packets.
Definition libusb.h:1513
unsigned int timeout
Timeout for this transfer in milliseconds.
Definition libusb.h:1473
void * user_data
User context data.
Definition libusb.h:1506
libusb_device_handle * dev_handle
Handle of the device that this transfer will be submitted to.
Definition libusb.h:1460
uint8_t flags
A bitwise OR combination of libusb_transfer_flags.
Definition libusb.h:1463
A structure representing the USB 2.0 Extension descriptor This descriptor is documented in section 9....
Definition libusb.h:925
uint8_t bLength
Size of this descriptor (in bytes)
Definition libusb.h:927
uint8_t bDevCapabilityType
Capability type.
Definition libusb.h:937
uint32_t bmAttributes
Bitmap encoding of supported device level features.
Definition libusb.h:943
uint8_t bDescriptorType
Descriptor type.
Definition libusb.h:932
Structure providing the version of the libusb runtime.
Definition libusb.h:1181
const uint16_t micro
Library micro version.
Definition libusb.h:1189
const uint16_t major
Library major version.
Definition libusb.h:1183
const char * rc
Library release candidate suffix string, e.g.
Definition libusb.h:1195
const uint16_t minor
Library minor version.
Definition libusb.h:1186
const char * describe
For ABI compatibility only.
Definition libusb.h:1198
const uint16_t nano
Library nano version.
Definition libusb.h:1192