libusb 1.0.25
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-2018 Nathan Hjelm <hjelmn@cs.unm.edu>
7 * Copyright © 2014-2020 Chris Dickens <christopher.a.dickens@gmail.com>
8 * For more information, please visit: http://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/* on MS environments, the inline keyword is available in C++ only */
30#if !defined(__cplusplus)
31#define inline __inline
32#endif
33/* ssize_t is also not available */
34#ifndef _SSIZE_T_DEFINED
35#define _SSIZE_T_DEFINED
36#include <basetsd.h>
37typedef SSIZE_T ssize_t;
38#endif /* _SSIZE_T_DEFINED */
39#endif /* _MSC_VER */
40
41#include <limits.h>
42#include <stdint.h>
43#include <sys/types.h>
44#if !defined(_MSC_VER)
45#include <sys/time.h>
46#endif
47#include <time.h>
48
49#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
50#define ZERO_SIZED_ARRAY /* [] - valid C99 code */
51#else
52#define ZERO_SIZED_ARRAY 0 /* [0] - non-standard, but usually working code */
53#endif /* __STDC_VERSION__ */
54
55/* 'interface' might be defined as a macro on Windows, so we need to
56 * undefine it so as not to break the current libusb API, because
57 * libusb_config_descriptor has an 'interface' member
58 * As this can be problematic if you include windows.h after libusb.h
59 * in your sources, we force windows.h to be included first. */
60#if defined(_WIN32) || defined(__CYGWIN__)
61#include <windows.h>
62#if defined(interface)
63#undef interface
64#endif
65#if !defined(__CYGWIN__)
66#include <winsock.h>
67#endif
68#endif /* _WIN32 || __CYGWIN__ */
69
70#if defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5))
71#define LIBUSB_DEPRECATED_FOR(f) __attribute__ ((deprecated ("Use " #f " instead")))
72#elif defined(__GNUC__) && (__GNUC__ >= 3)
73#define LIBUSB_DEPRECATED_FOR(f) __attribute__ ((deprecated))
74#else
75#define LIBUSB_DEPRECATED_FOR(f)
76#endif /* __GNUC__ */
77
78#if defined(__GNUC__)
79#define LIBUSB_PACKED __attribute__ ((packed))
80#else
81#define LIBUSB_PACKED
82#endif /* __GNUC__ */
83
109/* LIBUSB_CALL must be defined on both definition and declaration of libusb
110 * functions. You'd think that declaration would be enough, but cygwin will
111 * complain about conflicting types unless both are marked this way.
112 * The placement of this macro is important too; it must appear after the
113 * return type, before the function name. See internal documentation for
114 * API_EXPORTED.
115 */
116#if defined(_WIN32) || defined(__CYGWIN__)
117#define LIBUSB_CALL WINAPI
118#else
119#define LIBUSB_CALL
120#endif /* _WIN32 || __CYGWIN__ */
121
142#define LIBUSB_API_VERSION 0x01000109
143
144/* The following is kept for compatibility, but will be deprecated in the future */
145#define LIBUSBX_API_VERSION LIBUSB_API_VERSION
146
147#if defined(__cplusplus)
148extern "C" {
149#endif
150
159static inline uint16_t libusb_cpu_to_le16(const uint16_t x)
160{
161 union {
162 uint8_t b8[2];
163 uint16_t b16;
164 } _tmp;
165 _tmp.b8[1] = (uint8_t) (x >> 8);
166 _tmp.b8[0] = (uint8_t) (x & 0xff);
167 return _tmp.b16;
168}
169
178#define libusb_le16_to_cpu libusb_cpu_to_le16
179
180/* standard USB stuff */
181
190
193
196
199
202
205 LIBUSB_CLASS_PTP = 0x06, /* legacy name from libusb-0.1 usb.h */
206
209
212
215
218
221
224
227
230
233
236
239
242
246
252
255
258
261
264
267
270
273
276
279
282
285
289
290/* Descriptor sizes per descriptor type */
291#define LIBUSB_DT_DEVICE_SIZE 18
292#define LIBUSB_DT_CONFIG_SIZE 9
293#define LIBUSB_DT_INTERFACE_SIZE 9
294#define LIBUSB_DT_ENDPOINT_SIZE 7
295#define LIBUSB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
296#define LIBUSB_DT_HUB_NONVAR_SIZE 7
297#define LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE 6
298#define LIBUSB_DT_BOS_SIZE 5
299#define LIBUSB_DT_DEVICE_CAPABILITY_SIZE 3
300
301/* BOS descriptor sizes */
302#define LIBUSB_BT_USB_2_0_EXTENSION_SIZE 7
303#define LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE 10
304#define LIBUSB_BT_CONTAINER_ID_SIZE 20
305
306/* We unwrap the BOS => define its max size */
307#define LIBUSB_DT_BOS_MAX_SIZE \
308 (LIBUSB_DT_BOS_SIZE + \
309 LIBUSB_BT_USB_2_0_EXTENSION_SIZE + \
310 LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE + \
311 LIBUSB_BT_CONTAINER_ID_SIZE)
312
313#define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f /* in bEndpointAddress */
314#define LIBUSB_ENDPOINT_DIR_MASK 0x80
315
323
325 LIBUSB_ENDPOINT_IN = 0x80
327
328#define LIBUSB_TRANSFER_TYPE_MASK 0x03 /* in bmAttributes */
329
337
340
343
347
353
356
357 /* 0x02 is reserved */
358
361
362 /* 0x04 is reserved */
363
366
369
372
375
378
381
384
387
390
395
403
406
409
411 LIBUSB_REQUEST_TYPE_RESERVED = (0x03 << 5)
413
421
424
427
431
432#define LIBUSB_ISO_SYNC_TYPE_MASK 0x0c
433
442
445
448
452
453#define LIBUSB_ISO_USAGE_TYPE_MASK 0x30
454
463
466
470
478
481
484
488
496 LIBUSB_BM_LPM_SUPPORT = (1 << 1)
498
506 LIBUSB_BM_LTM_SUPPORT = (1 << 1)
508
515
518
521
525
533 uint8_t bLength;
534
539
542 uint16_t bcdUSB;
543
546
550
554
557
559 uint16_t idVendor;
560
562 uint16_t idProduct;
563
565 uint16_t bcdDevice;
566
569
571 uint8_t iProduct;
572
575
578};
579
587 uint8_t bLength;
588
593
598
606
609
611 uint8_t bInterval;
612
615 uint8_t bRefresh;
616
619
622 const unsigned char *extra;
623
626};
627
635 uint8_t bLength;
636
641
644
647
651
654
658
662
664 uint8_t iInterface;
665
669
672 const unsigned char *extra;
673
676};
677
685
689};
690
698 uint8_t bLength;
699
704
706 uint16_t wTotalLength;
707
710
713
716
719
724 uint8_t MaxPower;
725
729
732 const unsigned char *extra;
733
736};
737
746 uint8_t bLength;
747
752
755 uint8_t bMaxBurst;
756
762
766};
767
775 uint8_t bLength;
776
781
784
786 uint8_t dev_capability_data[ZERO_SIZED_ARRAY];
787};
788
796 uint8_t bLength;
797
802
804 uint16_t wTotalLength;
805
809
812};
813
821 uint8_t bLength;
822
827
832
837 uint32_t bmAttributes;
838};
839
847 uint8_t bLength;
848
853
858
864
868
874
877
880};
881
889 uint8_t bLength;
890
895
900
902 uint8_t bReserved;
903
905 uint8_t ContainerID[16];
906};
907
910#if defined(_MSC_VER) || defined(__WATCOMC__)
911#pragma pack(push, 1)
912#endif
920
926 uint8_t bRequest;
927
929 uint16_t wValue;
930
933 uint16_t wIndex;
934
936 uint16_t wLength;
937} LIBUSB_PACKED;
938#if defined(_MSC_VER) || defined(__WATCOMC__)
939#pragma pack(pop)
940#endif
941
942#define LIBUSB_CONTROL_SETUP_SIZE (sizeof(struct libusb_control_setup))
943
944/* libusb */
945
946struct libusb_context;
947struct libusb_device;
949
955 const uint16_t major;
956
958 const uint16_t minor;
959
961 const uint16_t micro;
962
964 const uint16_t nano;
965
967 const char *rc;
968
970 const char *describe;
971};
972
992
1009
1010
1020
1027
1030
1033
1036
1039
1043
1054
1057
1060
1063
1066
1069
1072
1075
1078
1081
1084
1087
1090
1091 /* NB: Remember to update LIBUSB_ERROR_COUNT below as well as the
1092 message strings in strerror.c when adding new error codes here. */
1093
1095 LIBUSB_ERROR_OTHER = -99
1097
1098/* Total number of error codes in enum libusb_error */
1099#define LIBUSB_ERROR_COUNT 14
1100
1106
1109
1112
1115
1119
1126
1129
1132
1135
1139
1142
1145
1146 /* NB! Remember to update libusb_error_name()
1147 when adding new status codes here. */
1149
1155
1161
1167
1193
1198 unsigned int length;
1199
1201 unsigned int actual_length;
1202
1205};
1206
1207struct libusb_transfer;
1208
1218typedef void (LIBUSB_CALL *libusb_transfer_cb_fn)(struct libusb_transfer *transfer);
1219
1229
1231 uint8_t flags;
1232
1234 unsigned char endpoint;
1235
1237 unsigned char type;
1238
1241 unsigned int timeout;
1242
1251
1254
1259
1263
1275
1277 unsigned char *buffer;
1278
1282
1285};
1286
1295
1298
1304
1309
1316
1319
1322
1325
1329
1340
1342 LIBUSB_LOG_CB_CONTEXT = (1 << 1)
1344
1357 enum libusb_log_level level, const char *str);
1358
1361LIBUSB_DEPRECATED_FOR(libusb_set_option)
1362void LIBUSB_CALL libusb_set_debug(libusb_context *ctx, int level);
1364const struct libusb_version * LIBUSB_CALL libusb_get_version(void);
1365int LIBUSB_CALL libusb_has_capability(uint32_t capability);
1366const char * LIBUSB_CALL libusb_error_name(int errcode);
1367int LIBUSB_CALL libusb_setlocale(const char *locale);
1368const char * LIBUSB_CALL libusb_strerror(int errcode);
1369
1371 libusb_device ***list);
1373 int unref_devices);
1376
1378 int *config);
1380 struct libusb_device_descriptor *desc);
1382 struct libusb_config_descriptor **config);
1384 uint8_t config_index, struct libusb_config_descriptor **config);
1386 uint8_t bConfigurationValue, struct libusb_config_descriptor **config);
1388 struct libusb_config_descriptor *config);
1390 libusb_context *ctx,
1391 const struct libusb_endpoint_descriptor *endpoint,
1396 struct libusb_bos_descriptor **bos);
1399 libusb_context *ctx,
1401 struct libusb_usb_2_0_extension_descriptor **usb_2_0_extension);
1403 struct libusb_usb_2_0_extension_descriptor *usb_2_0_extension);
1405 libusb_context *ctx,
1407 struct libusb_ss_usb_device_capability_descriptor **ss_usb_device_cap);
1409 struct libusb_ss_usb_device_capability_descriptor *ss_usb_device_cap);
1412 struct libusb_container_id_descriptor **container_id);
1414 struct libusb_container_id_descriptor *container_id);
1417int LIBUSB_CALL libusb_get_port_numbers(libusb_device *dev, uint8_t *port_numbers, int port_numbers_len);
1418LIBUSB_DEPRECATED_FOR(libusb_get_port_numbers)
1419int LIBUSB_CALL libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *path, uint8_t path_length);
1424 unsigned char endpoint);
1426 unsigned char endpoint);
1427
1428int LIBUSB_CALL libusb_wrap_sys_device(libusb_context *ctx, intptr_t sys_dev, libusb_device_handle **dev_handle);
1432
1434 int configuration);
1436 int interface_number);
1438 int interface_number);
1439
1441 libusb_context *ctx, uint16_t vendor_id, uint16_t product_id);
1442
1444 int interface_number, int alternate_setting);
1446 unsigned char endpoint);
1448
1450 uint32_t num_streams, unsigned char *endpoints, int num_endpoints);
1452 unsigned char *endpoints, int num_endpoints);
1453
1454unsigned char * LIBUSB_CALL libusb_dev_mem_alloc(libusb_device_handle *dev_handle,
1455 size_t length);
1457 unsigned char *buffer, size_t length);
1458
1460 int interface_number);
1462 int interface_number);
1464 int interface_number);
1466 libusb_device_handle *dev_handle, int enable);
1467
1468/* async I/O */
1469
1482static inline unsigned char *libusb_control_transfer_get_data(
1483 struct libusb_transfer *transfer)
1484{
1485 return transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
1486}
1487
1501 struct libusb_transfer *transfer)
1502{
1503 return (struct libusb_control_setup *)(void *)transfer->buffer;
1504}
1505
1529static inline void libusb_fill_control_setup(unsigned char *buffer,
1530 uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
1531 uint16_t wLength)
1532{
1533 struct libusb_control_setup *setup = (struct libusb_control_setup *)(void *)buffer;
1535 setup->bRequest = bRequest;
1539}
1540
1541struct libusb_transfer * LIBUSB_CALL libusb_alloc_transfer(int iso_packets);
1544void LIBUSB_CALL libusb_free_transfer(struct libusb_transfer *transfer);
1546 struct libusb_transfer *transfer, uint32_t stream_id);
1548 struct libusb_transfer *transfer);
1549
1580 unsigned char *buffer, libusb_transfer_cb_fn callback, void *user_data,
1581 unsigned int timeout)
1582{
1583 struct libusb_control_setup *setup = (struct libusb_control_setup *)(void *)buffer;
1584 transfer->dev_handle = dev_handle;
1585 transfer->endpoint = 0;
1587 transfer->timeout = timeout;
1588 transfer->buffer = buffer;
1589 if (setup)
1590 transfer->length = (int) (LIBUSB_CONTROL_SETUP_SIZE
1591 + libusb_le16_to_cpu(setup->wLength));
1592 transfer->user_data = user_data;
1593 transfer->callback = callback;
1594}
1595
1609static inline void libusb_fill_bulk_transfer(struct libusb_transfer *transfer,
1610 libusb_device_handle *dev_handle, unsigned char endpoint,
1611 unsigned char *buffer, int length, libusb_transfer_cb_fn callback,
1612 void *user_data, unsigned int timeout)
1613{
1614 transfer->dev_handle = dev_handle;
1615 transfer->endpoint = endpoint;
1616 transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1617 transfer->timeout = timeout;
1618 transfer->buffer = buffer;
1619 transfer->length = length;
1620 transfer->user_data = user_data;
1621 transfer->callback = callback;
1622}
1623
1641 struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1642 unsigned char endpoint, uint32_t stream_id,
1643 unsigned char *buffer, int length, libusb_transfer_cb_fn callback,
1644 void *user_data, unsigned int timeout)
1645{
1646 libusb_fill_bulk_transfer(transfer, dev_handle, endpoint, buffer,
1647 length, callback, user_data, timeout);
1649 libusb_transfer_set_stream_id(transfer, stream_id);
1650}
1651
1666 struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1667 unsigned char endpoint, unsigned char *buffer, int length,
1668 libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
1669{
1670 transfer->dev_handle = dev_handle;
1671 transfer->endpoint = endpoint;
1673 transfer->timeout = timeout;
1674 transfer->buffer = buffer;
1675 transfer->length = length;
1676 transfer->user_data = user_data;
1677 transfer->callback = callback;
1678}
1679
1694static inline void libusb_fill_iso_transfer(struct libusb_transfer *transfer,
1695 libusb_device_handle *dev_handle, unsigned char endpoint,
1696 unsigned char *buffer, int length, int num_iso_packets,
1697 libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
1698{
1699 transfer->dev_handle = dev_handle;
1700 transfer->endpoint = endpoint;
1702 transfer->timeout = timeout;
1703 transfer->buffer = buffer;
1704 transfer->length = length;
1705 transfer->num_iso_packets = num_iso_packets;
1706 transfer->user_data = user_data;
1707 transfer->callback = callback;
1708}
1709
1719 struct libusb_transfer *transfer, unsigned int length)
1720{
1721 int i;
1722
1723 for (i = 0; i < transfer->num_iso_packets; i++)
1724 transfer->iso_packet_desc[i].length = length;
1725}
1726
1743static inline unsigned char *libusb_get_iso_packet_buffer(
1744 struct libusb_transfer *transfer, unsigned int packet)
1745{
1746 int i;
1747 size_t offset = 0;
1748 int _packet;
1749
1750 /* oops..slight bug in the API. packet is an unsigned int, but we use
1751 * signed integers almost everywhere else. range-check and convert to
1752 * signed to avoid compiler warnings. FIXME for libusb-2. */
1753 if (packet > INT_MAX)
1754 return NULL;
1755 _packet = (int) packet;
1756
1757 if (_packet >= transfer->num_iso_packets)
1758 return NULL;
1759
1760 for (i = 0; i < _packet; i++)
1761 offset += transfer->iso_packet_desc[i].length;
1762
1763 return transfer->buffer + offset;
1764}
1765
1785static inline unsigned char *libusb_get_iso_packet_buffer_simple(
1786 struct libusb_transfer *transfer, unsigned int packet)
1787{
1788 int _packet;
1789
1790 /* oops..slight bug in the API. packet is an unsigned int, but we use
1791 * signed integers almost everywhere else. range-check and convert to
1792 * signed to avoid compiler warnings. FIXME for libusb-2. */
1793 if (packet > INT_MAX)
1794 return NULL;
1795 _packet = (int) packet;
1796
1797 if (_packet >= transfer->num_iso_packets)
1798 return NULL;
1799
1800 return transfer->buffer + ((int) transfer->iso_packet_desc[0].length * _packet);
1801}
1802
1803/* sync I/O */
1804
1806 uint8_t request_type, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
1807 unsigned char *data, uint16_t wLength, unsigned int timeout);
1808
1810 unsigned char endpoint, unsigned char *data, int length,
1811 int *actual_length, unsigned int timeout);
1812
1814 unsigned char endpoint, unsigned char *data, int length,
1815 int *actual_length, unsigned int timeout);
1816
1829static inline int libusb_get_descriptor(libusb_device_handle *dev_handle,
1830 uint8_t desc_type, uint8_t desc_index, unsigned char *data, int length)
1831{
1833 LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t) ((desc_type << 8) | desc_index),
1834 0, data, (uint16_t) length, 1000);
1835}
1836
1852 uint8_t desc_index, uint16_t langid, unsigned char *data, int length)
1853{
1855 LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t)((LIBUSB_DT_STRING << 8) | desc_index),
1856 langid, data, (uint16_t) length, 1000);
1857}
1858
1860 uint8_t desc_index, unsigned char *data, int length);
1861
1862/* polling and timeouts */
1863
1872int LIBUSB_CALL libusb_wait_for_event(libusb_context *ctx, struct timeval *tv);
1873
1875 struct timeval *tv);
1877 struct timeval *tv, int *completed);
1881 struct timeval *tv);
1884 struct timeval *tv);
1885
1891 int fd;
1892
1897 short events;
1898};
1899
1910typedef void (LIBUSB_CALL *libusb_pollfd_added_cb)(int fd, short events,
1911 void *user_data);
1912
1922typedef void (LIBUSB_CALL *libusb_pollfd_removed_cb)(int fd, void *user_data);
1923
1925 libusb_context *ctx);
1926void LIBUSB_CALL libusb_free_pollfds(const struct libusb_pollfd **pollfds);
1929 void *user_data);
1930
1944
1950typedef enum {
1953
1959
1965typedef enum {
1967 LIBUSB_HOTPLUG_ENUMERATE = (1 << 0)
1969
1972#define LIBUSB_HOTPLUG_NO_FLAGS 0
1973
1976#define LIBUSB_HOTPLUG_MATCH_ANY -1
1977
2001 libusb_device *device, libusb_hotplug_event event, void *user_data);
2002
2039 int events, int flags,
2040 int vendor_id, int product_id, int dev_class,
2041 libusb_hotplug_callback_fn cb_fn, void *user_data,
2042 libusb_hotplug_callback_handle *callback_handle);
2043
2056 libusb_hotplug_callback_handle callback_handle);
2057
2067 libusb_hotplug_callback_handle callback_handle);
2068
2095
2104
2123
2124#define LIBUSB_OPTION_WEAK_AUTHORITY LIBUSB_OPTION_NO_DEVICE_DISCOVERY
2125
2126 LIBUSB_OPTION_MAX = 3
2127};
2128
2129int LIBUSB_CALL libusb_set_option(libusb_context *ctx, enum libusb_option option, ...);
2130
2131#if defined(__cplusplus)
2132}
2133#endif
2134
2135#endif
void(* libusb_transfer_cb_fn)(struct libusb_transfer *transfer)
Asynchronous transfer callback function type.
Definition: libusb.h:1218
libusb_transfer_flags
libusb_transfer.flags values
Definition: libusb.h:1152
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:1929
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:1694
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:1578
static unsigned char * libusb_control_transfer_get_data(struct libusb_transfer *transfer)
Get the data section of a control transfer.
Definition: libusb.h:1482
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:1785
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:1529
uint32_t libusb_transfer_get_stream_id(struct libusb_transfer *transfer)
Get a transfers bulk stream id.
Definition: io.c:1646
int libusb_cancel_transfer(struct libusb_transfer *transfer)
Asynchronously cancel a previously submitted transfer.
Definition: io.c:1585
void libusb_free_transfer(struct libusb_transfer *transfer)
Free a transfer structure.
Definition: io.c:1332
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:1665
libusb_transfer_status
Transfer status codes.
Definition: libusb.h:1122
struct libusb_transfer * libusb_alloc_transfer(int iso_packets)
Allocate a libusb transfer with a specified number of isochronous packet descriptors.
Definition: io.c:1285
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:1500
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:1886
int libusb_submit_transfer(struct libusb_transfer *transfer)
Submit a transfer.
Definition: io.c:1490
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:1640
libusb_transfer_type
Transfer type.
Definition: libusb.h:1103
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:1718
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:1609
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:1949
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:1856
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:1743
void libusb_transfer_set_stream_id(struct libusb_transfer *transfer, uint32_t stream_id)
Set a transfers bulk stream id.
Definition: io.c:1629
@ 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:1191
@ LIBUSB_TRANSFER_FREE_TRANSFER
Automatically call libusb_free_transfer() after callback returns.
Definition: libusb.h:1166
@ LIBUSB_TRANSFER_SHORT_NOT_OK
Report short frames as errors.
Definition: libusb.h:1154
@ LIBUSB_TRANSFER_FREE_BUFFER
Automatically free() transfer buffer during libusb_free_transfer().
Definition: libusb.h:1160
@ LIBUSB_TRANSFER_STALL
For bulk/interrupt endpoints: halt condition detected (endpoint stalled).
Definition: libusb.h:1138
@ LIBUSB_TRANSFER_COMPLETED
Transfer completed without error.
Definition: libusb.h:1125
@ LIBUSB_TRANSFER_CANCELLED
Transfer was cancelled.
Definition: libusb.h:1134
@ LIBUSB_TRANSFER_ERROR
Transfer failed.
Definition: libusb.h:1128
@ LIBUSB_TRANSFER_OVERFLOW
Device sent more data than requested.
Definition: libusb.h:1144
@ LIBUSB_TRANSFER_NO_DEVICE
Device was disconnected.
Definition: libusb.h:1141
@ LIBUSB_TRANSFER_TIMED_OUT
Transfer timed out.
Definition: libusb.h:1131
@ LIBUSB_TRANSFER_TYPE_BULK_STREAM
Bulk stream transfer.
Definition: libusb.h:1117
@ LIBUSB_TRANSFER_TYPE_ISOCHRONOUS
Isochronous transfer.
Definition: libusb.h:1108
@ LIBUSB_TRANSFER_TYPE_CONTROL
Control transfer.
Definition: libusb.h:1105
@ LIBUSB_TRANSFER_TYPE_BULK
Bulk transfer.
Definition: libusb.h:1111
@ LIBUSB_TRANSFER_TYPE_INTERRUPT
Interrupt transfer.
Definition: libusb.h:1114
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:1851
libusb_descriptor_type
Descriptor types as defined by the USB specification.
Definition: libusb.h:249
libusb_supported_speed
Supported speeds (wSpeedSupported) bitfield.
Definition: libusb.h:475
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:682
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:1085
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:642
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:555
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:754
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:531
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:957
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:846
libusb_bos_type
USB capability types.
Definition: libusb.h:512
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:1032
libusb_endpoint_direction
Endpoint direction.
Definition: libusb.h:320
libusb_endpoint_transfer_type
Endpoint transfer type.
Definition: libusb.h:334
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:1013
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:1829
libusb_iso_sync_type
Synchronization type for isochronous endpoints.
Definition: libusb.h:439
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:596
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:504
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:705
libusb_iso_usage_type
Usage type for isochronous endpoints.
Definition: libusb.h:460
libusb_class_code
Device and/or Interface Class codes.
Definition: libusb.h:184
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:976
void libusb_free_bos_descriptor(struct libusb_bos_descriptor *bos)
Free a BOS descriptor obtained from libusb_get_bos_descriptor().
Definition: descriptor.c:896
libusb_usb_2_0_extension_attributes
Masks for the bits of the bmAttributes field of the USB 2.0 Extension descriptor.
Definition: libusb.h:494
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:921
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:1067
@ LIBUSB_DT_HUB
Hub descriptor.
Definition: libusb.h:281
@ LIBUSB_DT_CONFIG
Configuration descriptor.
Definition: libusb.h:254
@ LIBUSB_DT_STRING
String descriptor.
Definition: libusb.h:257
@ LIBUSB_DT_HID
HID descriptor.
Definition: libusb.h:272
@ LIBUSB_DT_REPORT
HID report descriptor.
Definition: libusb.h:275
@ LIBUSB_DT_DEVICE
Device descriptor.
Definition: libusb.h:251
@ LIBUSB_DT_DEVICE_CAPABILITY
Device Capability descriptor.
Definition: libusb.h:269
@ LIBUSB_DT_SUPERSPEED_HUB
SuperSpeed Hub descriptor.
Definition: libusb.h:284
@ LIBUSB_DT_PHYSICAL
Physical descriptor.
Definition: libusb.h:278
@ LIBUSB_DT_INTERFACE
Interface descriptor.
Definition: libusb.h:260
@ LIBUSB_DT_ENDPOINT
Endpoint descriptor.
Definition: libusb.h:263
@ LIBUSB_DT_SS_ENDPOINT_COMPANION
SuperSpeed Endpoint Companion descriptor.
Definition: libusb.h:287
@ LIBUSB_DT_BOS
BOS descriptor.
Definition: libusb.h:266
@ LIBUSB_HIGH_SPEED_OPERATION
High speed operation supported (480MBit/s).
Definition: libusb.h:483
@ LIBUSB_LOW_SPEED_OPERATION
Low speed operation supported (1.5MBit/s).
Definition: libusb.h:477
@ LIBUSB_SUPER_SPEED_OPERATION
Superspeed operation supported (5000MBit/s).
Definition: libusb.h:486
@ LIBUSB_FULL_SPEED_OPERATION
Full speed operation supported (12MBit/s).
Definition: libusb.h:480
@ LIBUSB_BT_USB_2_0_EXTENSION
USB 2.0 extensions.
Definition: libusb.h:517
@ LIBUSB_BT_SS_USB_DEVICE_CAPABILITY
SuperSpeed USB device capability.
Definition: libusb.h:520
@ LIBUSB_BT_WIRELESS_USB_DEVICE_CAPABILITY
Wireless USB device capability.
Definition: libusb.h:514
@ LIBUSB_BT_CONTAINER_ID
Container ID type.
Definition: libusb.h:523
@ LIBUSB_ENDPOINT_IN
In: device-to-host.
Definition: libusb.h:325
@ LIBUSB_ENDPOINT_OUT
Out: host-to-device.
Definition: libusb.h:322
@ LIBUSB_ENDPOINT_TRANSFER_TYPE_INTERRUPT
Interrupt endpoint.
Definition: libusb.h:345
@ LIBUSB_ENDPOINT_TRANSFER_TYPE_ISOCHRONOUS
Isochronous endpoint.
Definition: libusb.h:339
@ LIBUSB_ENDPOINT_TRANSFER_TYPE_BULK
Bulk endpoint.
Definition: libusb.h:342
@ LIBUSB_ENDPOINT_TRANSFER_TYPE_CONTROL
Control endpoint.
Definition: libusb.h:336
@ LIBUSB_ISO_SYNC_TYPE_SYNC
Synchronous.
Definition: libusb.h:450
@ LIBUSB_ISO_SYNC_TYPE_NONE
No synchronization.
Definition: libusb.h:441
@ LIBUSB_ISO_SYNC_TYPE_ADAPTIVE
Adaptive.
Definition: libusb.h:447
@ LIBUSB_ISO_SYNC_TYPE_ASYNC
Asynchronous.
Definition: libusb.h:444
@ LIBUSB_BM_LTM_SUPPORT
Supports Latency Tolerance Messages (LTM)
Definition: libusb.h:506
@ LIBUSB_ISO_USAGE_TYPE_DATA
Data endpoint.
Definition: libusb.h:462
@ LIBUSB_ISO_USAGE_TYPE_FEEDBACK
Feedback endpoint.
Definition: libusb.h:465
@ LIBUSB_ISO_USAGE_TYPE_IMPLICIT
Implicit feedback Data endpoint.
Definition: libusb.h:468
@ LIBUSB_CLASS_AUDIO
Audio class.
Definition: libusb.h:192
@ LIBUSB_CLASS_HUB
Hub class.
Definition: libusb.h:214
@ LIBUSB_CLASS_MISCELLANEOUS
Miscellaneous class.
Definition: libusb.h:238
@ LIBUSB_CLASS_APPLICATION
Application class.
Definition: libusb.h:241
@ LIBUSB_CLASS_CONTENT_SECURITY
Content Security.
Definition: libusb.h:223
@ LIBUSB_CLASS_DIAGNOSTIC_DEVICE
Diagnostic Device.
Definition: libusb.h:232
@ LIBUSB_CLASS_PHYSICAL
Physical.
Definition: libusb.h:201
@ LIBUSB_CLASS_COMM
Communications class.
Definition: libusb.h:195
@ LIBUSB_CLASS_VIDEO
Video.
Definition: libusb.h:226
@ LIBUSB_CLASS_DATA
Data class.
Definition: libusb.h:217
@ LIBUSB_CLASS_WIRELESS
Wireless class.
Definition: libusb.h:235
@ LIBUSB_CLASS_PRINTER
Printer class.
Definition: libusb.h:208
@ LIBUSB_CLASS_PERSONAL_HEALTHCARE
Personal Healthcare.
Definition: libusb.h:229
@ LIBUSB_CLASS_PER_INTERFACE
In the context of a device descriptor, this bDeviceClass value indicates that each interface specifie...
Definition: libusb.h:189
@ LIBUSB_CLASS_MASS_STORAGE
Mass storage class.
Definition: libusb.h:211
@ LIBUSB_CLASS_HID
Human Interface Device class.
Definition: libusb.h:198
@ LIBUSB_CLASS_VENDOR_SPEC
Class is vendor-specific.
Definition: libusb.h:244
@ LIBUSB_CLASS_IMAGE
Image class.
Definition: libusb.h:204
@ LIBUSB_CLASS_SMART_CARD
Smart Card.
Definition: libusb.h:220
@ LIBUSB_BM_LPM_SUPPORT
Supports Link Power Management (LPM)
Definition: libusb.h:496
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:1352
uint8_t libusb_get_port_number(libusb_device *dev)
Get the number of the port that a device is connected to.
Definition: core.c:926
libusb_device * libusb_get_parent(libusb_device *dev)
Get the the parent from the specified device.
Definition: core.c:988
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:1975
libusb_device * libusb_ref_device(libusb_device *dev)
Increment the reference count of a device.
Definition: core.c:1165
libusb_speed
Speed codes.
Definition: libusb.h:1024
libusb_device * libusb_get_device(libusb_device_handle *dev_handle)
Get the underlying device for a device handle.
Definition: core.c:1514
void libusb_unref_device(libusb_device *dev)
Decrement the reference count of a device.
Definition: core.c:1180
int libusb_open(libusb_device *dev, libusb_device_handle **dev_handle)
Open a device and obtain a device handle.
Definition: core.c:1297
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:1752
int libusb_release_interface(libusb_device_handle *dev_handle, int interface_number)
Release an interface previously claimed with libusb_claim_interface().
Definition: core.c:1707
int libusb_get_device_speed(libusb_device *dev)
Get the negotiated connection speed for a device.
Definition: core.c:1009
int libusb_detach_kernel_driver(libusb_device_handle *dev_handle, int interface_number)
Detach a kernel driver from an interface.
Definition: core.c:2013
void libusb_close(libusb_device_handle *dev_handle)
Close a device handle.
Definition: core.c:1452
struct libusb_device libusb_device
Structure representing a USB device detected on the system.
Definition: libusb.h:1008
int libusb_set_configuration(libusb_device_handle *dev_handle, int configuration)
Set the active configuration for a device.
Definition: core.c:1626
struct libusb_device_handle libusb_device_handle
Structure representing a handle on a USB device.
Definition: libusb.h:1019
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:1242
int libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *path, uint8_t path_length)
Definition: core.c:968
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:942
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:998
int libusb_clear_halt(libusb_device_handle *dev_handle, unsigned char endpoint)
Clear the halt/stall condition for an endpoint.
Definition: core.c:1794
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:816
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:2088
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:1055
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:886
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:2049
int libusb_get_configuration(libusb_device_handle *dev, int *config)
Determine the bConfigurationValue of the currently active configuration.
Definition: core.c:1539
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:1110
int libusb_claim_interface(libusb_device_handle *dev_handle, int interface_number)
Claim an interface on a given device handle.
Definition: core.c:1663
uint8_t libusb_get_bus_number(libusb_device *dev)
Get the number of the bus that a device is connected to.
Definition: core.c:907
int libusb_reset_device(libusb_device_handle *dev_handle)
Perform a USB port reset to reinitialize a device.
Definition: core.c:1823
@ LIBUSB_SPEED_FULL
The device is operating at full speed (12MBit/s).
Definition: libusb.h:1032
@ LIBUSB_SPEED_HIGH
The device is operating at high speed (480MBit/s).
Definition: libusb.h:1035
@ LIBUSB_SPEED_LOW
The device is operating at low speed (1.5MBit/s).
Definition: libusb.h:1029
@ LIBUSB_SPEED_SUPER_PLUS
The device is operating at super speed plus (10000MBit/s).
Definition: libusb.h:1041
@ LIBUSB_SPEED_SUPER
The device is operating at super speed (5000MBit/s).
Definition: libusb.h:1038
@ LIBUSB_SPEED_UNKNOWN
The OS doesn't report or know the device speed.
Definition: libusb.h:1026
int libusb_hotplug_callback_handle
Callback handle.
Definition: libusb.h:1943
libusb_hotplug_event
Since version 1.0.16, LIBUSB_API_VERSION >= 0x01000102.
Definition: libusb.h:1950
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:320
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:2000
void libusb_hotplug_deregister_callback(libusb_context *ctx, libusb_hotplug_callback_handle callback_handle)
Deregisters a hotplug callback.
Definition: hotplug.c:404
libusb_hotplug_flag
Since version 1.0.16, LIBUSB_API_VERSION >= 0x01000102.
Definition: libusb.h:1965
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:442
@ LIBUSB_HOTPLUG_EVENT_DEVICE_ARRIVED
A device has been plugged in and is ready to use.
Definition: libusb.h:1952
@ LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT
A device has left and is no longer available.
Definition: libusb.h:1957
@ LIBUSB_HOTPLUG_ENUMERATE
Arm the callback and fire it for all matching currently attached devices.
Definition: libusb.h:1967
libusb_option
Available option values for libusb_set_option().
Definition: libusb.h:2072
libusb_log_cb_mode
Log callback mode.
Definition: libusb.h:1337
libusb_log_level
Log message levels.
Definition: libusb.h:1313
void libusb_set_log_cb(libusb_context *ctx, libusb_log_cb cb, int mode)
Set log handler.
Definition: core.c:2139
struct libusb_context libusb_context
Structure representing a libusb session.
Definition: libusb.h:991
void libusb_set_debug(libusb_context *ctx, int level)
Definition: core.c:2102
void(* libusb_log_cb)(libusb_context *ctx, enum libusb_log_level level, const char *str)
Callback function for handling log messages.
Definition: libusb.h:1356
int libusb_init(libusb_context **ctx)
Initialize libusb.
Definition: core.c:2280
void libusb_exit(libusb_context *ctx)
Deinitialize libusb.
Definition: core.c:2401
int libusb_set_option(libusb_context *ctx, enum libusb_option option,...)
Set an option in the library.
Definition: core.c:2185
@ LIBUSB_OPTION_NO_DEVICE_DISCOVERY
Do not scan for devices.
Definition: libusb.h:2122
@ LIBUSB_OPTION_LOG_LEVEL
Set the log message verbosity.
Definition: libusb.h:2094
@ LIBUSB_OPTION_USE_USBDK
Use the UsbDk backend for a specific context, if available.
Definition: libusb.h:2103
@ LIBUSB_LOG_CB_GLOBAL
Callback function handling all log messages.
Definition: libusb.h:1339
@ LIBUSB_LOG_CB_CONTEXT
Callback function handling context related log messages.
Definition: libusb.h:1342
@ LIBUSB_LOG_LEVEL_WARNING
(2) : Warning and error messages are emitted
Definition: libusb.h:1321
@ LIBUSB_LOG_LEVEL_INFO
(3) : Informational, warning and error messages are emitted
Definition: libusb.h:1324
@ LIBUSB_LOG_LEVEL_ERROR
(1) : Error messages are emitted
Definition: libusb.h:1318
@ LIBUSB_LOG_LEVEL_NONE
(0) : No messages ever emitted by the library (default)
Definition: libusb.h:1315
@ LIBUSB_LOG_LEVEL_DEBUG
(4) : All messages are emitted
Definition: libusb.h:1327
libusb_request_type
Request type bits of the bmRequestType field in control transfers.
Definition: libusb.h:400
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:2745
libusb_request_recipient
Recipient bits of the bmRequestType field in control transfers.
Definition: libusb.h:418
#define libusb_le16_to_cpu
Convert a 16-bit value from little-endian to host-endian format.
Definition: libusb.h:178
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:350
int libusb_has_capability(uint32_t capability)
Check at runtime if the loaded library has a given capability.
Definition: core.c:2473
#define LIBUSB_CALL
libusb's Windows calling convention.
Definition: libusb.h:119
libusb_capability
Capabilities supported by an instance of libusb on the current running platform.
Definition: libusb.h:1292
libusb_error
Error codes.
Definition: libusb.h:1051
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:159
const char * libusb_error_name(int errcode)
Returns a constant NULL-terminated string with the ASCII name of a libusb error or transfer status co...
Definition: core.c:2690
@ LIBUSB_REQUEST_TYPE_VENDOR
Vendor.
Definition: libusb.h:408
@ LIBUSB_REQUEST_TYPE_STANDARD
Standard.
Definition: libusb.h:402
@ LIBUSB_REQUEST_TYPE_CLASS
Class.
Definition: libusb.h:405
@ LIBUSB_REQUEST_TYPE_RESERVED
Reserved.
Definition: libusb.h:411
@ LIBUSB_RECIPIENT_ENDPOINT
Endpoint.
Definition: libusb.h:426
@ LIBUSB_RECIPIENT_INTERFACE
Interface.
Definition: libusb.h:423
@ LIBUSB_RECIPIENT_OTHER
Other.
Definition: libusb.h:429
@ LIBUSB_RECIPIENT_DEVICE
Device.
Definition: libusb.h:420
@ LIBUSB_REQUEST_CLEAR_FEATURE
Clear or disable a specific feature.
Definition: libusb.h:355
@ LIBUSB_REQUEST_GET_INTERFACE
Return the selected alternate setting for the specified interface.
Definition: libusb.h:380
@ LIBUSB_REQUEST_GET_DESCRIPTOR
Get the specified descriptor.
Definition: libusb.h:368
@ LIBUSB_REQUEST_SET_DESCRIPTOR
Used to update existing descriptors or add new descriptors.
Definition: libusb.h:371
@ LIBUSB_REQUEST_GET_STATUS
Request status of the specific recipient.
Definition: libusb.h:352
@ LIBUSB_REQUEST_SET_FEATURE
Set or enable a specific feature.
Definition: libusb.h:360
@ LIBUSB_REQUEST_SET_INTERFACE
Select an alternate interface for the specified interface.
Definition: libusb.h:383
@ LIBUSB_REQUEST_SET_ADDRESS
Set device address for all future accesses.
Definition: libusb.h:365
@ LIBUSB_REQUEST_GET_CONFIGURATION
Get the current device configuration value.
Definition: libusb.h:374
@ LIBUSB_REQUEST_SET_SEL
Sets both the U1 and U2 Exit Latency.
Definition: libusb.h:389
@ 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:393
@ LIBUSB_REQUEST_SYNCH_FRAME
Set then report an endpoint's synchronization frame.
Definition: libusb.h:386
@ LIBUSB_REQUEST_SET_CONFIGURATION
Set device configuration.
Definition: libusb.h:377
@ LIBUSB_CAP_HAS_CAPABILITY
The libusb_has_capability() API is available.
Definition: libusb.h:1294
@ LIBUSB_CAP_HAS_HOTPLUG
Hotplug support is available on this platform.
Definition: libusb.h:1297
@ LIBUSB_CAP_HAS_HID_ACCESS
The library can access HID devices without requiring user intervention.
Definition: libusb.h:1303
@ LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER
The library supports detaching of the default USB driver, using libusb_detach_kernel_driver(),...
Definition: libusb.h:1307
@ LIBUSB_ERROR_NOT_SUPPORTED
Operation not supported or unimplemented on this platform.
Definition: libusb.h:1089
@ LIBUSB_ERROR_ACCESS
Access denied (insufficient permissions)
Definition: libusb.h:1062
@ LIBUSB_ERROR_PIPE
Pipe error.
Definition: libusb.h:1080
@ LIBUSB_ERROR_NOT_FOUND
Entity not found.
Definition: libusb.h:1068
@ LIBUSB_ERROR_BUSY
Resource busy.
Definition: libusb.h:1071
@ LIBUSB_ERROR_INTERRUPTED
System call interrupted (perhaps due to signal)
Definition: libusb.h:1083
@ LIBUSB_SUCCESS
Success (no error)
Definition: libusb.h:1053
@ LIBUSB_ERROR_INVALID_PARAM
Invalid parameter.
Definition: libusb.h:1059
@ LIBUSB_ERROR_IO
Input/output error.
Definition: libusb.h:1056
@ LIBUSB_ERROR_OTHER
Other error.
Definition: libusb.h:1095
@ LIBUSB_ERROR_TIMEOUT
Operation timed out.
Definition: libusb.h:1074
@ LIBUSB_ERROR_OVERFLOW
Overflow.
Definition: libusb.h:1077
@ LIBUSB_ERROR_NO_DEVICE
No such device (it may have been disconnected)
Definition: libusb.h:1065
@ LIBUSB_ERROR_NO_MEM
Insufficient memory.
Definition: libusb.h:1086
int libusb_handle_events_completed(libusb_context *ctx, int *completed)
Handle any pending events in blocking mode.
Definition: io.c:2433
void libusb_lock_event_waiters(libusb_context *ctx)
Acquire the event waiters lock.
Definition: io.c:1956
void libusb_interrupt_event_handler(libusb_context *ctx)
Interrupt any active thread that is handling events.
Definition: io.c:1920
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:2615
int libusb_event_handler_active(libusb_context *ctx)
Determine if an active thread is handling events (i.e.
Definition: io.c:1891
void libusb_unlock_event_waiters(libusb_context *ctx)
Release the event waiters lock.
Definition: io.c:1967
int libusb_handle_events_timeout_completed(libusb_context *ctx, struct timeval *tv, int *completed)
Handle any pending events.
Definition: io.c:2319
int libusb_handle_events(libusb_context *ctx)
Handle any pending events in blocking mode.
Definition: io.c:2411
int libusb_get_next_timeout(libusb_context *ctx, struct timeval *tv)
Determine the next internal timeout that libusb needs to handle.
Definition: io.c:2543
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:1862
int libusb_handle_events_timeout(libusb_context *ctx, struct timeval *tv)
Handle any pending events.
Definition: io.c:2391
int libusb_try_lock_events(libusb_context *ctx)
Attempt to acquire the event handling lock.
Definition: io.c:1769
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:2461
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:1922
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:1910
void libusb_lock_events(libusb_context *ctx)
Acquire the event handling lock, blocking until successful acquisition if it is contended.
Definition: io.c:1812
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:2723
void libusb_unlock_events(libusb_context *ctx)
Release the lock previously acquired with libusb_try_lock_events() or libusb_lock_events().
Definition: io.c:1827
void libusb_free_pollfds(const struct libusb_pollfd **pollfds)
Free a list of libusb_pollfd structures.
Definition: io.c:2771
int libusb_wait_for_event(libusb_context *ctx, struct timeval *tv)
Wait for another thread to signal completion of an event.
Definition: io.c:1999
int libusb_pollfds_handle_timeouts(libusb_context *ctx)
Determines whether your application must apply special timing considerations when monitoring libusb's...
Definition: io.c:2509
int libusb_interrupt_transfer(libusb_device_handle *dev_handle, unsigned char endpoint, unsigned char *data, int length, int *actual_length, unsigned int timeout)
Perform a USB interrupt transfer.
Definition: sync.c:328
int libusb_bulk_transfer(libusb_device_handle *dev_handle, unsigned char endpoint, unsigned char *data, int length, int *actual_length, unsigned int timeout)
Perform a USB bulk transfer.
Definition: sync.c:274
int libusb_control_transfer(libusb_device_handle *dev_handle, uint8_t request_type, 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:97
A structure representing the Binary Device Object Store (BOS) descriptor.
Definition: libusb.h:794
uint16_t wTotalLength
Length of this descriptor and all of its sub descriptors.
Definition: libusb.h:804
struct libusb_bos_dev_capability_descriptor * dev_capability[ZERO_SIZED_ARRAY]
bNumDeviceCap Device Capability Descriptors
Definition: libusb.h:811
uint8_t bNumDeviceCaps
The number of separate device capability descriptors in the BOS.
Definition: libusb.h:808
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:796
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:801
A generic representation of a BOS Device Capability descriptor.
Definition: libusb.h:773
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:775
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:780
uint8_t dev_capability_data[ZERO_SIZED_ARRAY]
Device Capability data (bLength - 3 bytes)
Definition: libusb.h:786
uint8_t bDevCapabilityType
Device Capability type.
Definition: libusb.h:783
A structure representing the standard USB configuration descriptor.
Definition: libusb.h:696
uint8_t bConfigurationValue
Identifier value for this configuration.
Definition: libusb.h:712
uint8_t iConfiguration
Index of string descriptor describing this configuration.
Definition: libusb.h:715
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:735
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:698
uint8_t bNumInterfaces
Number of interfaces supported by this configuration.
Definition: libusb.h:709
uint8_t MaxPower
Maximum power consumption of the USB device from this bus in this configuration when the device is fu...
Definition: libusb.h:724
uint16_t wTotalLength
Total length of data returned for this configuration.
Definition: libusb.h:706
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:703
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:732
uint8_t bmAttributes
Configuration characteristics.
Definition: libusb.h:718
const struct libusb_interface * interface
Array of interfaces supported by this configuration.
Definition: libusb.h:728
A structure representing the Container ID descriptor.
Definition: libusb.h:887
uint8_t ContainerID[16]
128 bit UUID
Definition: libusb.h:905
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:894
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:899
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:889
uint8_t bReserved
Reserved field.
Definition: libusb.h:902
Setup packet for control transfers.
Definition: libusb.h:913
uint8_t bRequest
Request.
Definition: libusb.h:926
uint8_t bmRequestType
Request type.
Definition: libusb.h:919
uint16_t wLength
Number of bytes to transfer.
Definition: libusb.h:936
uint16_t wIndex
Index.
Definition: libusb.h:933
uint16_t wValue
Value.
Definition: libusb.h:929
A structure representing the standard USB device descriptor.
Definition: libusb.h:531
uint8_t bNumConfigurations
Number of possible configurations.
Definition: libusb.h:577
uint8_t iProduct
Index of string descriptor describing product.
Definition: libusb.h:571
uint8_t iSerialNumber
Index of string descriptor containing device serial number.
Definition: libusb.h:574
uint8_t bMaxPacketSize0
Maximum packet size for endpoint 0.
Definition: libusb.h:556
uint8_t bDeviceProtocol
USB-IF protocol code for the device, qualified by the bDeviceClass and bDeviceSubClass values.
Definition: libusb.h:553
uint16_t idProduct
USB-IF product ID.
Definition: libusb.h:562
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:538
uint8_t bDeviceSubClass
USB-IF subclass code for the device, qualified by the bDeviceClass value.
Definition: libusb.h:549
uint8_t bDeviceClass
USB-IF class code for the device.
Definition: libusb.h:545
uint8_t iManufacturer
Index of string descriptor describing manufacturer.
Definition: libusb.h:568
uint16_t idVendor
USB-IF vendor ID.
Definition: libusb.h:559
uint16_t bcdUSB
USB specification release number in binary-coded decimal.
Definition: libusb.h:542
uint16_t bcdDevice
Device release number in binary-coded decimal.
Definition: libusb.h:565
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:533
A structure representing the standard USB endpoint descriptor.
Definition: libusb.h:585
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:625
uint8_t bEndpointAddress
The address of the endpoint described by this descriptor.
Definition: libusb.h:597
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:622
uint8_t bInterval
Interval for polling endpoint for data transfers.
Definition: libusb.h:611
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:592
uint8_t bRefresh
For audio devices only: the rate at which synchronization feedback is provided.
Definition: libusb.h:615
uint8_t bmAttributes
Attributes which apply to the endpoint when it is configured using the bConfigurationValue.
Definition: libusb.h:605
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:587
uint8_t bSynchAddress
For audio devices only: the address if the synch endpoint.
Definition: libusb.h:618
uint16_t wMaxPacketSize
Maximum packet size this endpoint is capable of sending/receiving.
Definition: libusb.h:608
A structure representing the standard USB interface descriptor.
Definition: libusb.h:633
uint8_t bInterfaceSubClass
USB-IF subclass code for this interface, qualified by the bInterfaceClass value.
Definition: libusb.h:657
uint8_t iInterface
Index of string descriptor describing this interface.
Definition: libusb.h:664
uint8_t bInterfaceClass
USB-IF class code for this interface.
Definition: libusb.h:653
uint8_t bAlternateSetting
Value used to select this alternate setting for this interface.
Definition: libusb.h:646
const struct libusb_endpoint_descriptor * endpoint
Array of endpoint descriptors.
Definition: libusb.h:668
uint8_t bNumEndpoints
Number of endpoints used by this interface (excluding the control endpoint).
Definition: libusb.h:650
uint8_t bInterfaceProtocol
USB-IF protocol code for this interface, qualified by the bInterfaceClass and bInterfaceSubClass valu...
Definition: libusb.h:661
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:635
uint8_t bInterfaceNumber
Number of this interface.
Definition: libusb.h:643
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:672
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:675
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:640
A collection of alternate settings for a particular USB interface.
Definition: libusb.h:681
const struct libusb_interface_descriptor * altsetting
Array of interface descriptors.
Definition: libusb.h:684
int num_altsetting
The number of alternate settings that belong to this interface.
Definition: libusb.h:688
Isochronous packet descriptor.
Definition: libusb.h:1196
unsigned int actual_length
Amount of data that was actually transferred.
Definition: libusb.h:1201
unsigned int length
Length of data to request in this packet.
Definition: libusb.h:1198
enum libusb_transfer_status status
Status code for this packet.
Definition: libusb.h:1204
File descriptor for polling.
Definition: libusb.h:1889
short events
Event flags to poll for from <poll.h>.
Definition: libusb.h:1897
int fd
Numeric file descriptor.
Definition: libusb.h:1891
A structure representing the superspeed endpoint companion descriptor.
Definition: libusb.h:744
uint16_t wBytesPerInterval
The total number of bytes this EP will transfer every service interval.
Definition: libusb.h:765
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:746
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:751
uint8_t bMaxBurst
The maximum number of packets the endpoint can send or receive as part of a burst.
Definition: libusb.h:755
uint8_t bmAttributes
In bulk EP: bits 4:0 represents the maximum number of streams the EP supports.
Definition: libusb.h:761
A structure representing the SuperSpeed USB Device Capability descriptor This descriptor is documente...
Definition: libusb.h:845
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:857
uint16_t wSpeedSupported
Bitmap encoding of the speed supported by this device when operating in SuperSpeed mode.
Definition: libusb.h:867
uint8_t bFunctionalitySupport
The lowest speed at which all the functionality supported by the device is available to the user.
Definition: libusb.h:873
uint16_t bU2DevExitLat
U2 Device Exit Latency.
Definition: libusb.h:879
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:847
uint8_t bmAttributes
Bitmap encoding of supported device level features.
Definition: libusb.h:863
uint8_t bU1DevExitLat
U1 Device Exit Latency.
Definition: libusb.h:876
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:852
The generic USB transfer structure.
Definition: libusb.h:1226
unsigned char endpoint
Address of the endpoint where this transfer will be sent.
Definition: libusb.h:1234
struct libusb_iso_packet_descriptor iso_packet_desc[ZERO_SIZED_ARRAY]
Isochronous packet descriptors, for isochronous transfers only.
Definition: libusb.h:1284
enum libusb_transfer_status status
The status of the transfer.
Definition: libusb.h:1250
int length
Length of the data buffer.
Definition: libusb.h:1253
libusb_transfer_cb_fn callback
Callback function.
Definition: libusb.h:1262
unsigned char type
Type of the transfer from libusb_transfer_type.
Definition: libusb.h:1237
int actual_length
Actual length of data that was transferred.
Definition: libusb.h:1258
unsigned char * buffer
Data buffer.
Definition: libusb.h:1277
int num_iso_packets
Number of isochronous packets.
Definition: libusb.h:1281
unsigned int timeout
Timeout for this transfer in milliseconds.
Definition: libusb.h:1241
void * user_data
User context data.
Definition: libusb.h:1274
libusb_device_handle * dev_handle
Handle of the device that this transfer will be submitted to.
Definition: libusb.h:1228
uint8_t flags
A bitwise OR combination of libusb_transfer_flags.
Definition: libusb.h:1231
A structure representing the USB 2.0 Extension descriptor This descriptor is documented in section 9....
Definition: libusb.h:819
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:821
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:831
uint32_t bmAttributes
Bitmap encoding of supported device level features.
Definition: libusb.h:837
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:826
Structure providing the version of the libusb runtime.
Definition: libusb.h:953
const uint16_t micro
Library micro version.
Definition: libusb.h:961
const uint16_t major
Library major version.
Definition: libusb.h:955
const char * rc
Library release candidate suffix string, e.g.
Definition: libusb.h:967
const uint16_t minor
Library minor version.
Definition: libusb.h:958
const char * describe
For ABI compatibility only.
Definition: libusb.h:970
const uint16_t nano
Library nano version.
Definition: libusb.h:964