libusb  1.0.29
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>
40 typedef 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 
173 #define LIBUSB_API_VERSION 0x0100010B
174 
181 #define LIBUSBX_API_VERSION LIBUSB_API_VERSION
182 
183 #if defined(__cplusplus)
184 extern "C" {
185 #endif
186 
195 static inline uint16_t libusb_cpu_to_le16(const uint16_t x)
196 {
197  union {
198  uint8_t b8[2];
199  uint16_t b16;
200  } _tmp;
201  _tmp.b8[1] = (uint8_t) (x >> 8);
202  _tmp.b8[0] = (uint8_t) (x & 0xff);
203  return _tmp.b16;
204 }
205 
214 #define libusb_le16_to_cpu libusb_cpu_to_le16
215 
216 /* standard USB stuff */
217 
226 
229 
232 
235 
238 
241  LIBUSB_CLASS_PTP = 0x06, /* legacy name from libusb-0.1 usb.h */
242 
245 
248 
251 
254 
257 
260 
263 
266 
269 
272 
275 
278 
281 };
282 
288 
291 
294 
297 
300 
304 
307 
310 
313 
316 
319 
322 
325 
328 };
329 
330 /* Descriptor sizes per descriptor type */
331 #define LIBUSB_DT_DEVICE_SIZE 18
332 #define LIBUSB_DT_CONFIG_SIZE 9
333 #define LIBUSB_DT_INTERFACE_SIZE 9
334 #define LIBUSB_DT_ENDPOINT_SIZE 7
335 #define LIBUSB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
336 #define LIBUSB_DT_HUB_NONVAR_SIZE 7
337 #define LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE 6
338 #define LIBUSB_DT_BOS_SIZE 5
339 #define LIBUSB_DT_DEVICE_CAPABILITY_SIZE 3
340 #define LIBUSB_DT_INTERFACE_ASSOCIATION_SIZE 8
341 
342 /* BOS descriptor sizes */
343 #define LIBUSB_BT_USB_2_0_EXTENSION_SIZE 7
344 #define LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE 10
345 #define LIBUSB_BT_SSPLUS_USB_DEVICE_CAPABILITY_SIZE 12
346 #define LIBUSB_BT_CONTAINER_ID_SIZE 20
347 #define LIBUSB_BT_PLATFORM_DESCRIPTOR_MIN_SIZE 20
348 
349 /* We unwrap the BOS => define its max size */
350 #define LIBUSB_DT_BOS_MAX_SIZE \
351  (LIBUSB_DT_BOS_SIZE + \
352  LIBUSB_BT_USB_2_0_EXTENSION_SIZE + \
353  LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE + \
354  LIBUSB_BT_CONTAINER_ID_SIZE)
355 
356 #define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f /* in bEndpointAddress */
357 #define LIBUSB_ENDPOINT_DIR_MASK 0x80
358 
366 
369 };
370 
371 #define LIBUSB_TRANSFER_TYPE_MASK 0x03 /* in bmAttributes */
372 
380 
383 
386 
389 };
390 
396 
399 
400  /* 0x02 is reserved */
401 
404 
405  /* 0x04 is reserved */
406 
409 
412 
415 
418 
421 
424 
427 
430 
433 
437 };
438 
446 
449 
452 
455 };
456 
464 
467 
470 
473 };
474 
475 #define LIBUSB_ISO_SYNC_TYPE_MASK 0x0c
476 
485 
488 
491 
494 };
495 
496 #define LIBUSB_ISO_USAGE_TYPE_MASK 0x30
497 
506 
509 
512 };
513 
521 
524 
527 
530 };
531 
540 };
541 
550 };
551 
558 
561 
564 
567 
570 
573 };
574 
582  uint8_t bLength;
583 
588 
591  uint16_t bcdUSB;
592 
594  uint8_t bDeviceClass;
595 
599 
603 
606 
608  uint16_t idVendor;
609 
611  uint16_t idProduct;
612 
614  uint16_t bcdDevice;
615 
617  uint8_t iManufacturer;
618 
620  uint8_t iProduct;
621 
623  uint8_t iSerialNumber;
624 
627 };
628 
636  uint8_t bLength;
637 
642 
647 
654  uint8_t bmAttributes;
655 
657  uint16_t wMaxPacketSize;
658 
660  uint8_t bInterval;
661 
664  uint8_t bRefresh;
665 
667  uint8_t bSynchAddress;
668 
671  const unsigned char *extra;
672 
675 };
676 
684  uint8_t bLength;
685 
690 
694 
698 
704  uint8_t bFunctionClass;
705 
711 
717 
719  uint8_t iFunction;
720 };
721 
731 
733  int length;
734 };
735 
743  uint8_t bLength;
744 
749 
752 
755 
758  uint8_t bNumEndpoints;
759 
762 
766 
770 
772  uint8_t iInterface;
773 
777 
780  const unsigned char *extra;
781 
784 };
785 
793 
797 };
798 
806  uint8_t bLength;
807 
812 
814  uint16_t wTotalLength;
815 
817  uint8_t bNumInterfaces;
818 
821 
823  uint8_t iConfiguration;
824 
826  uint8_t bmAttributes;
827 
832  uint8_t MaxPower;
833 
837 
840  const unsigned char *extra;
841 
844 };
845 
854  uint8_t bLength;
855 
860 
863  uint8_t bMaxBurst;
864 
869  uint8_t bmAttributes;
870 
874 };
875 
883  uint8_t bLength;
884 
889 
892 
894  uint8_t dev_capability_data[LIBUSB_FLEXIBLE_ARRAY];
895 };
896 
904  uint8_t bLength;
905 
910 
912  uint16_t wTotalLength;
913 
916  uint8_t bNumDeviceCaps;
917 
919  struct libusb_bos_dev_capability_descriptor *dev_capability[LIBUSB_FLEXIBLE_ARRAY];
920 };
921 
929  uint8_t bLength;
930 
935 
940 
945  uint32_t bmAttributes;
946 };
947 
955  uint8_t bLength;
956 
961 
966 
971  uint8_t bmAttributes;
972 
975  uint16_t wSpeedSupported;
976 
982 
984  uint8_t bU1DevExitLat;
985 
987  uint16_t bU2DevExitLat;
988 };
989 
994  LIBUSB_SSPLUS_ATTR_TYPE_SYM = 0,
995  LIBUSB_SSPLUS_ATTR_TYPE_ASYM = 1,
996 };
997 
1002  LIBUSB_SSPLUS_ATTR_DIR_RX = 0,
1003  LIBUSB_SSPLUS_ATTR_DIR_TX = 1,
1004 };
1005 
1014  LIBUSB_SSPLUS_ATTR_EXP_BPS = 0,
1015  LIBUSB_SSPLUS_ATTR_EXP_KBS = 1,
1016  LIBUSB_SSPLUS_ATTR_EXP_MBS = 2,
1017  LIBUSB_SSPLUS_ATTR_EXP_GBS = 3,
1018 };
1019 
1024  LIBUSB_SSPLUS_ATTR_PROT_SS = 0,
1025  LIBUSB_SSPLUS_ATTR_PROT_SSPLUS = 1,
1026 };
1027 
1034  uint8_t ssid;
1035 
1040 
1045 
1050 
1054 
1057  uint16_t mantissa;
1058 };
1059 
1067 
1070 
1072  uint8_t ssid;
1073 
1076 
1079 
1082 };
1083 
1091  uint8_t bLength;
1092 
1097 
1102 
1104  uint8_t bReserved;
1105 
1107  uint8_t ContainerID[16];
1108 };
1109 
1116  uint8_t bLength;
1117 
1122 
1127 
1129  uint8_t bReserved;
1130 
1133 
1135  uint8_t CapabilityData[LIBUSB_FLEXIBLE_ARRAY];
1136 };
1137 
1140 #if defined(_MSC_VER) || defined(__WATCOMC__)
1141 #pragma pack(push, 1)
1142 #endif
1149  uint8_t bmRequestType;
1150 
1156  uint8_t bRequest;
1157 
1159  uint16_t wValue;
1160 
1163  uint16_t wIndex;
1164 
1166  uint16_t wLength;
1167 } LIBUSB_PACKED;
1168 #if defined(_MSC_VER) || defined(__WATCOMC__)
1169 #pragma pack(pop)
1170 #endif
1171 
1172 #define LIBUSB_CONTROL_SETUP_SIZE (sizeof(struct libusb_control_setup))
1173 
1174 /* libusb */
1175 
1176 struct libusb_context;
1177 struct libusb_device;
1178 struct libusb_device_handle;
1179 
1185  const uint16_t major;
1186 
1188  const uint16_t minor;
1189 
1191  const uint16_t micro;
1192 
1194  const uint16_t nano;
1195 
1197  const char *rc;
1198 
1200  const char *describe;
1201 };
1202 
1222 
1239 
1240 
1250 
1257 
1260 
1263 
1266 
1269 
1272 
1275 };
1276 
1287 
1290 
1293 
1296 
1299 
1302 
1305 
1308 
1311 
1314 
1317 
1320 
1323 
1324  /* NB: Remember to update LIBUSB_ERROR_COUNT below as well as the
1325  message strings in strerror.c when adding new error codes here. */
1326 
1329 };
1330 
1331 /* Total number of error codes in enum libusb_error */
1332 #define LIBUSB_ERROR_COUNT 14
1333 
1339 
1342 
1345 
1348 
1351 };
1352 
1359 
1362 
1365 
1368 
1372 
1375 
1378 
1379  /* NB! Remember to update libusb_error_name()
1380  when adding new status codes here. */
1381 };
1382 
1388 
1394 
1400 
1426 };
1427 
1432  unsigned int length;
1433 
1435  unsigned int actual_length;
1436 
1439 };
1440 
1441 struct libusb_transfer;
1442 
1452 typedef void (LIBUSB_CALL *libusb_transfer_cb_fn)(struct libusb_transfer *transfer);
1453 
1463 
1465  uint8_t flags;
1466 
1468  unsigned char endpoint;
1469 
1471  unsigned char type;
1472 
1475  unsigned int timeout;
1476 
1485 
1487  int length;
1488 
1493 
1497 
1508  void *user_data;
1509 
1511  unsigned char *buffer;
1512 
1516 
1518  struct libusb_iso_packet_descriptor iso_packet_desc[LIBUSB_FLEXIBLE_ARRAY];
1519 };
1520 
1529 
1532 
1538 
1542 };
1543 
1550 
1553 
1556 
1559 
1562 };
1563 
1574 
1577 };
1578 
1606 
1615 
1635 
1636 #define LIBUSB_OPTION_WEAK_AUTHORITY LIBUSB_OPTION_NO_DEVICE_DISCOVERY
1637 
1648 
1649  LIBUSB_OPTION_MAX = 4
1650 };
1651 
1664  enum libusb_log_level level, const char *str);
1665 
1674  union {
1675  int ival;
1676  libusb_log_cb log_cbval;
1677  } value;
1678 };
1679 
1681 int LIBUSB_CALL libusb_init_context(libusb_context **ctx, const struct libusb_init_option options[], int num_options);
1683 void LIBUSB_CALL libusb_set_debug(libusb_context *ctx, int level);
1684 /* may be deprecated in the future in favor of lubusb_init_context()+libusb_set_option() */
1686 const struct libusb_version * LIBUSB_CALL libusb_get_version(void);
1687 int LIBUSB_CALL libusb_has_capability(uint32_t capability);
1688 const char * LIBUSB_CALL libusb_error_name(int error_code);
1689 int LIBUSB_CALL libusb_setlocale(const char *locale);
1690 const char * LIBUSB_CALL libusb_strerror(int errcode);
1691 
1693  libusb_device ***list);
1695  int unref_devices);
1698 
1700  int *config);
1702  struct libusb_device_descriptor *desc);
1704  struct libusb_config_descriptor **config);
1706  uint8_t config_index, struct libusb_config_descriptor **config);
1708  uint8_t bConfigurationValue, struct libusb_config_descriptor **config);
1710  struct libusb_config_descriptor *config);
1712  libusb_context *ctx,
1713  const struct libusb_endpoint_descriptor *endpoint,
1714  struct libusb_ss_endpoint_companion_descriptor **ep_comp);
1716  struct libusb_ss_endpoint_companion_descriptor *ep_comp);
1718  struct libusb_bos_descriptor **bos);
1721  libusb_context *ctx,
1722  struct libusb_bos_dev_capability_descriptor *dev_cap,
1723  struct libusb_usb_2_0_extension_descriptor **usb_2_0_extension);
1725  struct libusb_usb_2_0_extension_descriptor *usb_2_0_extension);
1727  libusb_context *ctx,
1728  struct libusb_bos_dev_capability_descriptor *dev_cap,
1729  struct libusb_ss_usb_device_capability_descriptor **ss_usb_device_cap);
1731  struct libusb_ss_usb_device_capability_descriptor *ss_usb_device_cap);
1733  libusb_context *ctx,
1734  struct libusb_bos_dev_capability_descriptor *dev_cap,
1735  struct libusb_ssplus_usb_device_capability_descriptor **ssplus_usb_device_cap);
1737  struct libusb_ssplus_usb_device_capability_descriptor *ssplus_usb_device_cap);
1739  struct libusb_bos_dev_capability_descriptor *dev_cap,
1740  struct libusb_container_id_descriptor **container_id);
1742  struct libusb_container_id_descriptor *container_id);
1744  struct libusb_bos_dev_capability_descriptor *dev_cap,
1745  struct libusb_platform_descriptor **platform_descriptor);
1747  struct libusb_platform_descriptor *platform_descriptor);
1750 int LIBUSB_CALL libusb_get_port_numbers(libusb_device *dev, uint8_t *port_numbers, int port_numbers_len);
1751 LIBUSB_DEPRECATED_FOR(libusb_get_port_numbers)
1752 int LIBUSB_CALL libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *path, uint8_t path_length);
1757  unsigned char endpoint);
1759  unsigned char endpoint);
1761  int interface_number, int alternate_setting, unsigned char endpoint);
1762 
1764  uint8_t config_index, struct libusb_interface_association_descriptor_array **iad_array);
1769 
1770 int LIBUSB_CALL libusb_wrap_sys_device(libusb_context *ctx, intptr_t sys_dev, libusb_device_handle **dev_handle);
1774 
1776  int configuration);
1778  int interface_number);
1780  int interface_number);
1781 
1783  libusb_context *ctx, uint16_t vendor_id, uint16_t product_id);
1784 
1786  int interface_number, int alternate_setting);
1788  unsigned char endpoint);
1790 
1792  uint32_t num_streams, unsigned char *endpoints, int num_endpoints);
1794  unsigned char *endpoints, int num_endpoints);
1795 
1796 unsigned char * LIBUSB_CALL libusb_dev_mem_alloc(libusb_device_handle *dev_handle,
1797  size_t length);
1799  unsigned char *buffer, size_t length);
1800 
1802  int interface_number);
1804  int interface_number);
1806  int interface_number);
1808  libusb_device_handle *dev_handle, int enable);
1809 
1810 /* async I/O */
1811 
1824 static inline unsigned char *libusb_control_transfer_get_data(
1825  struct libusb_transfer *transfer)
1826 {
1827  return transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
1828 }
1829 
1843  struct libusb_transfer *transfer)
1844 {
1845  return (struct libusb_control_setup *)(void *)transfer->buffer;
1846 }
1847 
1871 static inline void libusb_fill_control_setup(unsigned char *buffer,
1872  uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
1873  uint16_t wLength)
1874 {
1875  struct libusb_control_setup *setup = (struct libusb_control_setup *)(void *)buffer;
1876  setup->bmRequestType = bmRequestType;
1877  setup->bRequest = bRequest;
1878  setup->wValue = libusb_cpu_to_le16(wValue);
1879  setup->wIndex = libusb_cpu_to_le16(wIndex);
1880  setup->wLength = libusb_cpu_to_le16(wLength);
1881 }
1882 
1883 struct libusb_transfer * LIBUSB_CALL libusb_alloc_transfer(int iso_packets);
1884 int LIBUSB_CALL libusb_submit_transfer(struct libusb_transfer *transfer);
1885 int LIBUSB_CALL libusb_cancel_transfer(struct libusb_transfer *transfer);
1886 void LIBUSB_CALL libusb_free_transfer(struct libusb_transfer *transfer);
1888  struct libusb_transfer *transfer, uint32_t stream_id);
1890  struct libusb_transfer *transfer);
1891 
1920 static inline void libusb_fill_control_transfer(
1921  struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1922  unsigned char *buffer, libusb_transfer_cb_fn callback, void *user_data,
1923  unsigned int timeout)
1924 {
1925  struct libusb_control_setup *setup = (struct libusb_control_setup *)(void *)buffer;
1926  transfer->dev_handle = dev_handle;
1927  transfer->endpoint = 0;
1928  transfer->type = LIBUSB_TRANSFER_TYPE_CONTROL;
1929  transfer->timeout = timeout;
1930  transfer->buffer = buffer;
1931  if (setup)
1932  transfer->length = (int) (LIBUSB_CONTROL_SETUP_SIZE
1933  + libusb_le16_to_cpu(setup->wLength));
1934  transfer->user_data = user_data;
1935  transfer->callback = callback;
1936 }
1937 
1951 static inline void libusb_fill_bulk_transfer(struct libusb_transfer *transfer,
1952  libusb_device_handle *dev_handle, unsigned char endpoint,
1953  unsigned char *buffer, int length, libusb_transfer_cb_fn callback,
1954  void *user_data, unsigned int timeout)
1955 {
1956  transfer->dev_handle = dev_handle;
1957  transfer->endpoint = endpoint;
1958  transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1959  transfer->timeout = timeout;
1960  transfer->buffer = buffer;
1961  transfer->length = length;
1962  transfer->user_data = user_data;
1963  transfer->callback = callback;
1964 }
1965 
1983  struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1984  unsigned char endpoint, uint32_t stream_id,
1985  unsigned char *buffer, int length, libusb_transfer_cb_fn callback,
1986  void *user_data, unsigned int timeout)
1987 {
1988  libusb_fill_bulk_transfer(transfer, dev_handle, endpoint, buffer,
1989  length, callback, user_data, timeout);
1991  libusb_transfer_set_stream_id(transfer, stream_id);
1992 }
1993 
2008  struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
2009  unsigned char endpoint, unsigned char *buffer, int length,
2010  libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
2011 {
2012  transfer->dev_handle = dev_handle;
2013  transfer->endpoint = endpoint;
2015  transfer->timeout = timeout;
2016  transfer->buffer = buffer;
2017  transfer->length = length;
2018  transfer->user_data = user_data;
2019  transfer->callback = callback;
2020 }
2021 
2036 static inline void libusb_fill_iso_transfer(struct libusb_transfer *transfer,
2037  libusb_device_handle *dev_handle, unsigned char endpoint,
2038  unsigned char *buffer, int length, int num_iso_packets,
2039  libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
2040 {
2041  transfer->dev_handle = dev_handle;
2042  transfer->endpoint = endpoint;
2044  transfer->timeout = timeout;
2045  transfer->buffer = buffer;
2046  transfer->length = length;
2047  transfer->num_iso_packets = num_iso_packets;
2048  transfer->user_data = user_data;
2049  transfer->callback = callback;
2050 }
2051 
2061  struct libusb_transfer *transfer, unsigned int length)
2062 {
2063  int i;
2064 
2065  for (i = 0; i < transfer->num_iso_packets; i++)
2066  transfer->iso_packet_desc[i].length = length;
2067 }
2068 
2085 static inline unsigned char *libusb_get_iso_packet_buffer(
2086  struct libusb_transfer *transfer, unsigned int packet)
2087 {
2088  int i;
2089  size_t offset = 0;
2090  int _packet;
2091 
2092  /* oops..slight bug in the API. packet is an unsigned int, but we use
2093  * signed integers almost everywhere else. range-check and convert to
2094  * signed to avoid compiler warnings. FIXME for libusb-2. */
2095  if (packet > INT_MAX)
2096  return NULL;
2097  _packet = (int) packet;
2098 
2099  if (_packet >= transfer->num_iso_packets)
2100  return NULL;
2101 
2102  for (i = 0; i < _packet; i++)
2103  offset += transfer->iso_packet_desc[i].length;
2104 
2105  return transfer->buffer + offset;
2106 }
2107 
2127 static inline unsigned char *libusb_get_iso_packet_buffer_simple(
2128  struct libusb_transfer *transfer, unsigned int packet)
2129 {
2130  int _packet;
2131 
2132  /* oops..slight bug in the API. packet is an unsigned int, but we use
2133  * signed integers almost everywhere else. range-check and convert to
2134  * signed to avoid compiler warnings. FIXME for libusb-2. */
2135  if (packet > INT_MAX)
2136  return NULL;
2137  _packet = (int) packet;
2138 
2139  if (_packet >= transfer->num_iso_packets)
2140  return NULL;
2141 
2142  return transfer->buffer + ((int) transfer->iso_packet_desc[0].length * _packet);
2143 }
2144 
2145 /* sync I/O */
2146 
2148  uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
2149  unsigned char *data, uint16_t wLength, unsigned int timeout);
2150 
2152  unsigned char endpoint, unsigned char *data, int length,
2153  int *transferred, unsigned int timeout);
2154 
2156  unsigned char endpoint, unsigned char *data, int length,
2157  int *transferred, unsigned int timeout);
2158 
2171 static inline int libusb_get_descriptor(libusb_device_handle *dev_handle,
2172  uint8_t desc_type, uint8_t desc_index, unsigned char *data, int length)
2173 {
2174  return libusb_control_transfer(dev_handle, LIBUSB_ENDPOINT_IN,
2175  LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t) ((desc_type << 8) | desc_index),
2176  0, data, (uint16_t) length, 1000);
2177 }
2178 
2194  uint8_t desc_index, uint16_t langid, unsigned char *data, int length)
2195 {
2196  return libusb_control_transfer(dev_handle, LIBUSB_ENDPOINT_IN,
2197  LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t)((LIBUSB_DT_STRING << 8) | desc_index),
2198  langid, data, (uint16_t) length, 1000);
2199 }
2200 
2202  uint8_t desc_index, unsigned char *data, int length);
2203 
2204 /* polling and timeouts */
2205 
2214 int LIBUSB_CALL libusb_wait_for_event(libusb_context *ctx, struct timeval *tv);
2215 
2217  struct timeval *tv);
2219  struct timeval *tv, int *completed);
2223  struct timeval *tv);
2226  struct timeval *tv);
2227 
2233  int fd;
2234 
2239  short events;
2240 };
2241 
2252 typedef void (LIBUSB_CALL *libusb_pollfd_added_cb)(int fd, short events,
2253  void *user_data);
2254 
2264 typedef void (LIBUSB_CALL *libusb_pollfd_removed_cb)(int fd, void *user_data);
2265 
2267  libusb_context *ctx);
2268 void LIBUSB_CALL libusb_free_pollfds(const struct libusb_pollfd **pollfds);
2270  libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb,
2271  void *user_data);
2272 
2286 
2292 typedef enum {
2295 
2301 
2307 typedef enum {
2311 
2314 #define LIBUSB_HOTPLUG_NO_FLAGS 0
2315 
2318 #define LIBUSB_HOTPLUG_MATCH_ANY -1
2319 
2343  libusb_device *device, libusb_hotplug_event event, void *user_data);
2344 
2381  int events, int flags,
2382  int vendor_id, int product_id, int dev_class,
2383  libusb_hotplug_callback_fn cb_fn, void *user_data,
2384  libusb_hotplug_callback_handle *callback_handle);
2385 
2398  libusb_hotplug_callback_handle callback_handle);
2399 
2409  libusb_hotplug_callback_handle callback_handle);
2410 
2411 int LIBUSB_CALLV libusb_set_option(libusb_context *ctx, enum libusb_option option, ...);
2412 
2413 #ifdef _MSC_VER
2414 #pragma warning(pop)
2415 #endif
2416 
2417 #if defined(__cplusplus)
2418 }
2419 #endif
2420 
2421 #endif
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
const char * describe
For ABI compatibility only.
Definition: libusb.h:1200
uint16_t bU2DevExitLat
U2 Device Exit Latency.
Definition: libusb.h:987
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
Device.
Definition: libusb.h:463
uint8_t bFunctionalitySupport
The lowest speed at which all the functionality supported by the device is available to the user...
Definition: libusb.h:981
SuperSpeed Endpoint Companion descriptor.
Definition: libusb.h:327
uint8_t bInterfaceNumber
Number of this interface.
Definition: libusb.h:751
Asynchronous.
Definition: libusb.h:487
uint8_t bSynchAddress
For audio devices only: the address if the synch endpoint.
Definition: libusb.h:667
(0) : No messages ever emitted by the library (default)
Definition: libusb.h:1549
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
The device is operating at low speed (1.5MBit/s).
Definition: libusb.h:1259
Isochronous endpoint.
Definition: libusb.h:382
Success (no error)
Definition: libusb.h:1286
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
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:2085
Device was disconnected.
Definition: libusb.h:1374
Device Capability descriptor.
Definition: libusb.h:309
uint8_t bmAttributes
Attributes which apply to the endpoint when it is configured using the bConfigurationValue.
Definition: libusb.h:654
The OS doesn't report or know the device speed.
Definition: libusb.h:1256
void libusb_free_transfer(struct libusb_transfer *transfer)
Free a transfer structure.
Definition: io.c:1331
A collection of alternate settings for a particular USB interface.
Definition: libusb.h:789
static unsigned char * libusb_control_transfer_get_data(struct libusb_transfer *transfer)
Get the data section of a control transfer.
Definition: libusb.h:1824
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:195
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
HID descriptor.
Definition: libusb.h:312
void(* libusb_log_cb)(libusb_context *ctx, enum libusb_log_level level, const char *str)
Callback function for handling log messages.
Definition: libusb.h:1663
void libusb_free_pollfds(const struct libusb_pollfd **pollfds)
Free a list of libusb_pollfd structures.
Definition: io.c:2801
union libusb_init_option::@0 value
An integer value used by the option (if applicable).
uint8_t bReserved
Reserved field.
Definition: libusb.h:1104
enum libusb_transfer_status status
Status code for this packet.
Definition: libusb.h:1438
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
uint8_t bNumConfigurations
Number of possible configurations.
Definition: libusb.h:626
Audio class.
Definition: libusb.h:228
uint8_t bRequest
Request.
Definition: libusb.h:1156
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:1116
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
Operation not supported or unimplemented on this platform.
Definition: libusb.h:1322
Physical.
Definition: libusb.h:237
void libusb_interrupt_event_handler(libusb_context *ctx)
Interrupt any active thread that is handling events.
Definition: io.c:1948
int libusb_cancel_transfer(struct libusb_transfer *transfer)
Asynchronously cancel a previously submitted transfer.
Definition: io.c:1606
Other.
Definition: libusb.h:472
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
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:1951
const uint16_t nano
Library nano version.
Definition: libusb.h:1194
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:1101
void libusb_exit(libusb_context *ctx)
Deinitialize libusb.
Definition: core.c:2575
Bulk transfer.
Definition: libusb.h:1344
Supports Link Power Management (LPM)
Definition: libusb.h:539
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:883
uint8_t bDeviceSubClass
USB-IF subclass code for the device, qualified by the bDeviceClass value.
Definition: libusb.h:598
Structure used for setting options through libusb_init_context.
Definition: libusb.h:1670
libusb_class_code
Device and/or Interface Class codes.
Definition: libusb.h:220
#define libusb_le16_to_cpu
Convert a 16-bit value from little-endian to host-endian format.
Definition: libusb.h:214
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:888
Hub class.
Definition: libusb.h:250
int libusb_detach_kernel_driver(libusb_device_handle *dev_handle, int interface_number)
Detach a kernel driver from an interface.
Definition: core.c:2122
int libusb_try_lock_events(libusb_context *ctx)
Attempt to acquire the event handling lock.
Definition: io.c:1797
A structure representing the standard USB configuration descriptor.
Definition: libusb.h:804
A generic representation of a BOS Device Capability descriptor.
Definition: libusb.h:881
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
uint8_t bInterval
Interval for polling endpoint for data transfers.
Definition: libusb.h:660
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:582
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
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:2252
enum libusb_transfer_status status
The status of the transfer.
Definition: libusb.h:1484
libusb_endpoint_direction
Endpoint direction.
Definition: libusb.h:363
uint8_t bDeviceClass
USB-IF class code for the device.
Definition: libusb.h:594
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:689
int libusb_claim_interface(libusb_device_handle *dev_handle, int interface_number)
Claim an interface on a given device handle.
Definition: core.c:1773
Interface descriptor.
Definition: libusb.h:296
Overflow.
Definition: libusb.h:1310
int libusb_open(libusb_device *dev, libusb_device_handle **dev_handle)
Open a device and obtain a device handle.
Definition: core.c:1405
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:547
short events
Event flags to poll for from .
Definition: libusb.h:2239
Container ID type.
Definition: libusb.h:566
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:674
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:2264
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
A structure representing the SuperSpeed USB Device Capability descriptor This descriptor is documente...
Definition: libusb.h:953
uint8_t flags
A bitwise OR combination of libusb_transfer_flags.
Definition: libusb.h:1465
uint8_t bFunctionSubClass
USB-IF subclass code for this function.
Definition: libusb.h:710
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
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
Feedback endpoint.
Definition: libusb.h:508
Data endpoint.
Definition: libusb.h:505
Reserved.
Definition: libusb.h:454
Callback function handling context related log messages.
Definition: libusb.h:1576
int libusb_get_ssplus_usb_device_capability_descriptor(libusb_context *ctx, struct libusb_bos_dev_capability_descriptor *dev_cap, struct libusb_ssplus_usb_device_capability_descriptor **ssplus_usb_device_cap)
Get a SuperSpeedPlus USB Device Capability descriptor.
Definition: descriptor.c:1053
Arm the callback and fire it for all matching currently attached devices.
Definition: libusb.h:2309
uint8_t bmAttributes
In bulk EP: bits 4:0 represents the maximum number of streams the EP supports.
Definition: libusb.h:869
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:2127
void libusb_close(libusb_device_handle *dev_handle)
Close a device handle.
Definition: core.c:1562
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
The library can access HID devices without requiring user intervention.
Definition: libusb.h:1537
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:641
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
Class is vendor-specific.
Definition: libusb.h:280
struct libusb_context libusb_context
Structure representing a libusb session.
Definition: libusb.h:1221
Terminate transfers that are a multiple of the endpoint's wMaxPacketSize with an extra zero length pa...
Definition: libusb.h:1425
uint8_t iSerialNumber
Index of string descriptor containing device serial number.
Definition: libusb.h:623
libusb_option
Available option values for libusb_set_option() and libusb_init_context().
Definition: libusb.h:1582
Sets both the U1 and U2 Exit Latency.
Definition: libusb.h:432
Isochronous transfer.
Definition: libusb.h:1341
void libusb_free_ssplus_usb_device_capability_descriptor(struct libusb_ssplus_usb_device_capability_descriptor *ssplus_usb_device_cap)
Free a SuperSpeedPlus USB Device Capability descriptor obtained from libusb_get_ssplus_usb_device_cap...
Definition: descriptor.c:1131
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:743
Invalid parameter.
Definition: libusb.h:1292
File descriptor for polling.
Definition: libusb.h:2231
Supports Latency Tolerance Messages (LTM)
Definition: libusb.h:549
uint8_t bNumInterfaces
Number of interfaces supported by this configuration.
Definition: libusb.h:817
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:1013
libusb_speed
Speed codes.
Definition: libusb.h:1254
struct libusb_iso_packet_descriptor iso_packet_desc[LIBUSB_FLEXIBLE_ARRAY]
Isochronous packet descriptors, for isochronous transfers only.
Definition: libusb.h:1518
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:1148
A device has left and is no longer available.
Definition: libusb.h:2299
int libusb_event_handler_active(libusb_context *ctx)
Determine if an active thread is handling events (i.e.
Definition: io.c:1919
System call interrupted (perhaps due to signal)
Definition: libusb.h:1316
libusb_iso_sync_type
Synchronization type for isochronous endpoints.
Definition: libusb.h:482
uint8_t bmAttributes
Bitmap encoding of supported device level features.
Definition: libusb.h:971
int libusb_get_configuration(libusb_device_handle *dev, int *config)
Determine the bConfigurationValue of the currently active configuration.
Definition: core.c:1649
void libusb_free_bos_descriptor(struct libusb_bos_descriptor *bos)
Free a BOS descriptor obtained from libusb_get_bos_descriptor().
Definition: descriptor.c:890
(1) : Error messages are emitted
Definition: libusb.h:1552
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:1121
uint16_t bcdDevice
Device release number in binary-coded decimal.
Definition: libusb.h:614
unsigned char * buffer
Data buffer.
Definition: libusb.h:1511
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
Low speed operation supported (1.5MBit/s).
Definition: libusb.h:520
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:1464
uint8_t bReserved
Reserved field.
Definition: libusb.h:1129
uint8_t bDeviceProtocol
USB-IF protocol code for the device, qualified by the bDeviceClass and bDeviceSubClass values...
Definition: libusb.h:602
A device has been plugged in and is ready to use.
Definition: libusb.h:2294
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:2007
(4) : All messages are emitted
Definition: libusb.h:1561
Access denied (insufficient permissions)
Definition: libusb.h:1295
Entity not found.
Definition: libusb.h:1301
Input/output error.
Definition: libusb.h:1289
The libusb_has_capability() API is available.
Definition: libusb.h:1528
uint16_t wMaxPacketSize
Maximum packet size this endpoint is capable of sending/receiving.
Definition: libusb.h:657
Diagnostic Device.
Definition: libusb.h:268
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:965
uint8_t minTxLaneCount
This field indicates the minimum transmit lane count.
Definition: libusb.h:1078
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:671
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
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:2171
libusb_standard_request
Standard requests, as defined in table 9-5 of the USB 3.0 specifications.
Definition: libusb.h:393
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:1206
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
The device is operating at full speed (12MBit/s).
Definition: libusb.h:1262
int libusb_get_device_speed(libusb_device *dev)
Get the negotiated connection speed for a device.
Definition: core.c:1015
Set device address for all future accesses.
Definition: libusb.h:408
int fd
Numeric file descriptor.
Definition: libusb.h:2233
A structure representing the Container ID descriptor.
Definition: libusb.h:1089
uint8_t iManufacturer
Index of string descriptor describing manufacturer.
Definition: libusb.h:617
USB 2.0 extensions.
Definition: libusb.h:560
The device is operating at super speed plus (10000MBit/s).
Definition: libusb.h:1271
uint8_t iInterface
Index of string descriptor describing this interface.
Definition: libusb.h:772
int libusb_handle_events(libusb_context *ctx)
Handle any pending events in blocking mode.
Definition: io.c:2441
uint8_t dev_capability_data[LIBUSB_FLEXIBLE_ARRAY]
Device Capability data (bLength - 3 bytes)
Definition: libusb.h:894
The generic USB transfer structure.
Definition: libusb.h:1460
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
Automatically call libusb_free_transfer() after callback returns.
Definition: libusb.h:1399
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:1167
libusb_descriptor_type
Descriptor types as defined by the USB specification.
Definition: libusb.h:285
Endpoint.
Definition: libusb.h:469
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
The device is operating at high speed (480MBit/s).
Definition: libusb.h:1265
unsigned int timeout
Timeout for this transfer in milliseconds.
Definition: libusb.h:1475
void libusb_lock_event_waiters(libusb_context *ctx)
Acquire the event waiters lock.
Definition: io.c:1984
Used to update existing descriptors or add new descriptors.
Definition: libusb.h:414
Wireless USB device capability.
Definition: libusb.h:557
Smart Card.
Definition: libusb.h:256
Control endpoint.
Definition: libusb.h:379
uint8_t bFirstInterface
Interface number of the first interface that is associated with this function.
Definition: libusb.h:693
libusb_bos_type
USB capability types.
Definition: libusb.h:555
void libusb_unref_device(libusb_device *dev)
Decrement the reference count of a device.
Definition: core.c:1288
uint8_t bDevCapabilityType
Device Capability type.
Definition: libusb.h:891
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_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:1227
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:1292
libusb_transfer_cb_fn callback
Callback function.
Definition: libusb.h:1496
A structure representing the standard USB interface descriptor.
Definition: libusb.h:741
const uint16_t minor
Library minor version.
Definition: libusb.h:1188
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_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
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:840
Out: host-to-device.
Definition: libusb.h:365
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:1982
A structure representing the standard USB device descriptor.
Definition: libusb.h:580
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
Insufficient memory.
Definition: libusb.h:1319
uint8_t bmRequestType
Request type.
Definition: libusb.h:1149
int libusb_set_configuration(libusb_device_handle *dev_handle, int configuration)
Set the active configuration for a device.
Definition: core.c:1736
libusb_transfer_type
Transfer type.
Definition: libusb.h:1336
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:636
Human Interface Device class.
Definition: libusb.h:234
uint8_t bInterfaceCount
Number of contiguous interfaces that are associated with this function.
Definition: libusb.h:697
Mass storage class.
Definition: libusb.h:247
struct libusb_device libusb_device
Structure representing a USB device detected on the system.
Definition: libusb.h:1238
uint8_t bEndpointAddress
The address of the endpoint described by this descriptor.
Definition: libusb.h:646
Get the current device configuration value.
Definition: libusb.h:417
Printer class.
Definition: libusb.h:244
Resource busy.
Definition: libusb.h:1304
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
Get the specified descriptor.
Definition: libusb.h:411
Content Security.
Definition: libusb.h:259
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
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:1871
Other error.
Definition: libusb.h:1328
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
const struct libusb_interface * interface
Array of interfaces supported by this configuration.
Definition: libusb.h:836
libusb_request_recipient
Recipient bits of the bmRequestType field in control transfers.
Definition: libusb.h:461
int libusb_reset_device(libusb_device_handle *dev_handle)
Perform a USB port reset to reinitialize a device.
Definition: core.c:1932
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:854
uint8_t ContainerID[16]
128 bit UUID
Definition: libusb.h:1107
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:748
A structure representing the superspeed endpoint companion descriptor.
Definition: libusb.h:852
libusb_error
Error codes.
Definition: libusb.h:1284
SuperSpeed Hub descriptor.
Definition: libusb.h:324
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:783
const struct libusb_interface_descriptor * altsetting
Array of interface descriptors.
Definition: libusb.h:792
libusb_hotplug_event
Since version 1.0.16, LIBUSB_API_VERSION >= 0x01000102.
Definition: libusb.h:2292
void libusb_lock_events(libusb_context *ctx)
Acquire the event handling lock, blocking until successful acquisition if it is contended.
Definition: io.c:1840
A structure representing the standard USB interface association descriptor.
Definition: libusb.h:682
Use the UsbDk backend for a specific context, if available.
Definition: libusb.h:1614
libusb_supported_speed
Supported speeds (wSpeedSupported) bitfield.
Definition: libusb.h:518
libusb_hotplug_flag
Since version 1.0.16, LIBUSB_API_VERSION >= 0x01000102.
Definition: libusb.h:2307
const uint16_t major
Library major version.
Definition: libusb.h:1185
uint8_t bU1DevExitLat
U1 Device Exit Latency.
Definition: libusb.h:984
A structure representing the Binary Device Object Store (BOS) descriptor.
Definition: libusb.h:902
Data class.
Definition: libusb.h:253
libusb_transfer_status
Transfer status codes.
Definition: libusb.h:1355
Interface.
Definition: libusb.h:466
uint8_t iFunction
Index of string descriptor describing this function.
Definition: libusb.h:719
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
Miscellaneous class.
Definition: libusb.h:274
uint8_t CapabilityData[LIBUSB_FLEXIBLE_ARRAY]
Capability data (bLength - 20)
Definition: libusb.h:1135
uint8_t PlatformCapabilityUUID[16]
128 bit UUID
Definition: libusb.h:1132
Control transfer.
Definition: libusb.h:1338
const uint16_t micro
Library micro version.
Definition: libusb.h:1191
unsigned int actual_length
Amount of data that was actually transferred.
Definition: libusb.h:1435
int num_altsetting
The number of alternate settings that belong to this interface.
Definition: libusb.h:796
(3) : Informational, warning and error messages are emitted
Definition: libusb.h:1558
libusb_request_type
Request type bits of the bmRequestType field in control transfers.
Definition: libusb.h:443
uint8_t bFunctionClass
USB-IF class code for this function.
Definition: libusb.h:704
int libusb_hotplug_callback_handle
Callback handle.
Definition: libusb.h:2285
void libusb_unlock_event_waiters(libusb_context *ctx)
Release the event waiters lock.
Definition: io.c:1995
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:929
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:2036
uint8_t bInterfaceClass
USB-IF class code for this interface.
Definition: libusb.h:761
(2) : Warning and error messages are emitted
Definition: libusb.h:1555
uint8_t numSublinkSpeedAttributes
Sublink Speed Attribute Count.
Definition: libusb.h:1066
int libusb_has_capability(uint32_t capability)
Check at runtime if the loaded library has a given capability.
Definition: core.c:2649
libusb_log_cb_mode
Log callback mode.
Definition: libusb.h:1571
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_get_device_descriptor(libusb_device *dev, struct libusb_device_descriptor *desc)
Get the USB device descriptor for a given device.
Definition: descriptor.c:518
Transfer timed out.
Definition: libusb.h:1364
int libusb_handle_events_completed(libusb_context *ctx, int *completed)
Handle any pending events in blocking mode.
Definition: io.c:2463
Operation timed out.
Definition: libusb.h:1307
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
Adaptive.
Definition: libusb.h:490
libusb_iso_usage_type
Usage type for isochronous endpoints.
Definition: libusb.h:503
enum libusb_option option
Which option to set.
Definition: libusb.h:1672
uint16_t wValue
Value.
Definition: libusb.h:1159
void libusb_transfer_set_stream_id(struct libusb_transfer *transfer, uint32_t stream_id)
Set a transfers bulk stream id.
Definition: io.c:1650
Standard.
Definition: libusb.h:445
libusb_superspeedplus_sublink_attribute_sublink_direction
enum used in libusb_ssplus_sublink_attribute
Definition: libusb.h:1001
Platform descriptor.
Definition: libusb.h:569
Physical descriptor.
Definition: libusb.h:318
High speed operation supported (480MBit/s).
Definition: libusb.h:526
Full speed operation supported (12MBit/s).
Definition: libusb.h:523
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
uint8_t bmAttributes
Configuration characteristics.
Definition: libusb.h:826
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:811
int length
Length of the data buffer.
Definition: libusb.h:1487
Report short frames as errors.
Definition: libusb.h:1387
void * user_data
User context data.
Definition: libusb.h:1508
No synchronization.
Definition: libusb.h:484
uint8_t bNumEndpoints
Number of endpoints used by this interface (excluding the control endpoint).
Definition: libusb.h:758
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
uint16_t wIndex
Index.
Definition: libusb.h:1163
int libusb_handle_events_timeout(libusb_context *ctx, struct timeval *tv)
Handle any pending events.
Definition: io.c:2421
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:684
BOS descriptor.
Definition: libusb.h:306
Transfer completed without error.
Definition: libusb.h:1358
int length
Number of interface association descriptors contained.
Definition: libusb.h:733
Hub descriptor.
Definition: libusb.h:321
Wireless class.
Definition: libusb.h:271
A structure representing the USB 2.0 Extension descriptor This descriptor is documented in section 9...
Definition: libusb.h:927
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:939
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:2060
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
String descriptor.
Definition: libusb.h:293
Synchronous.
Definition: libusb.h:493
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:960
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:904
Image class.
Definition: libusb.h:240
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
Setup packet for control transfers.
Definition: libusb.h:1143
const struct libusb_version * libusb_get_version(void)
Returns a pointer to const struct libusb_version with the version (major, minor, micro, nano and rc) of the running library.
Definition: core.c:2922
The device is operating at super speed (5000MBit/s).
Definition: libusb.h:1268
void libusb_set_log_cb(libusb_context *ctx, libusb_log_cb cb, int mode)
Set log handler.
Definition: core.c:2262
libusb_superspeedplus_sublink_attribute_link_protocol
enum used in libusb_ssplus_sublink_attribute
Definition: libusb.h:1023
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
struct libusb_bos_dev_capability_descriptor * dev_capability[LIBUSB_FLEXIBLE_ARRAY]
bNumDeviceCap Device Capability Descriptors
Definition: libusb.h:919
Transfer failed.
Definition: libusb.h:1361
libusb_device * libusb_get_parent(libusb_device *dev)
Get the the parent from the specified device.
Definition: core.c:994
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:1096
libusb_device_handle * dev_handle
Handle of the device that this transfer will be submitted to.
Definition: libusb.h:1462
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:934
uint8_t bNumDeviceCaps
The number of separate device capability descriptors in the BOS.
Definition: libusb.h:916
uint8_t ssid
Unique ID to indicates the minimum lane speed.
Definition: libusb.h:1072
uint16_t wTotalLength
Total length of data returned for this configuration.
Definition: libusb.h:814
uint16_t idProduct
USB-IF product ID.
Definition: libusb.h:611
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
Configuration descriptor.
Definition: libusb.h:290
uint16_t wTotalLength
Length of this descriptor and all of its sub descriptors.
Definition: libusb.h:912
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:1920
Return the selected alternate setting for the specified interface.
Definition: libusb.h:423
uint8_t minRxLaneCount
This field indicates the minimum receive lane count.
Definition: libusb.h:1075
Endpoint descriptor.
Definition: libusb.h:299
Class.
Definition: libusb.h:448
Clear or disable a specific feature.
Definition: libusb.h:398
uint8_t bFunctionProtocol
USB-IF protocol code for this function.
Definition: libusb.h:716
uint16_t wLength
Number of bytes to transfer.
Definition: libusb.h:1166
Bulk endpoint.
Definition: libusb.h:385
Video.
Definition: libusb.h:262
uint16_t idVendor
USB-IF vendor ID.
Definition: libusb.h:608
Set the context log callback function.
Definition: libusb.h:1647
uint8_t bInterfaceSubClass
USB-IF subclass code for this interface, qualified by the bInterfaceClass value.
Definition: libusb.h:765
int LIBUSB_CALLV libusb_set_option(libusb_context *ctx, enum libusb_option option,...)
Set an option in the library.
Definition: core.c:2291
A structure representing the standard USB endpoint descriptor.
Definition: libusb.h:634
The library supports detaching of the default USB driver, using libusb_detach_kernel_driver(), if one is set by the OS kernel.
Definition: libusb.h:1541
void(* libusb_transfer_cb_fn)(struct libusb_transfer *transfer)
Asynchronous transfer callback function type.
Definition: libusb.h:1452
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:955
uint8_t bConfigurationValue
Identifier value for this configuration.
Definition: libusb.h:820
No such device (it may have been disconnected)
Definition: libusb.h:1298
int num_iso_packets
Number of isochronous packets.
Definition: libusb.h:1515
SuperSpeedPlus device capability.
Definition: libusb.h:572
libusb_transfer_flags
libusb_transfer.flags values
Definition: libusb.h:1385
Interrupt transfer.
Definition: libusb.h:1347
libusb_device * libusb_ref_device(libusb_device *dev)
Increment the reference count of a device.
Definition: core.c:1273
int actual_length
Actual length of data that was transferred.
Definition: libusb.h:1492
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:587
In: device-to-host.
Definition: libusb.h:368
Application class.
Definition: libusb.h:277
libusb_superspeedplus_sublink_attribute_sublink_type
enum used in libusb_ssplus_sublink_attribute
Definition: libusb.h:993
Superspeed operation supported (5000MBit/s).
Definition: libusb.h:529
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:806
struct libusb_device_handle libusb_device_handle
Structure representing a handle on a USB device.
Definition: libusb.h:1249
int libusb_handle_events_timeout_completed(libusb_context *ctx, struct timeval *tv, int *completed)
Handle any pending events.
Definition: io.c:2349
libusb_endpoint_transfer_type
Endpoint transfer type.
Definition: libusb.h:377
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 bDevCapabilityType
Capability type.
Definition: libusb.h:1126
void libusb_free_platform_descriptor(struct libusb_platform_descriptor *platform_descriptor)
Free a platform descriptor obtained from libusb_get_platform_descriptor().
Definition: descriptor.c:1274
Transfer was cancelled.
Definition: libusb.h:1367
For bulk/interrupt endpoints: halt condition detected (endpoint stalled).
Definition: libusb.h:1371
uint8_t bMaxPacketSize0
Maximum packet size for endpoint 0.
Definition: libusb.h:605
uint32_t libusb_transfer_get_stream_id(struct libusb_transfer *transfer)
Get a transfers bulk stream id.
Definition: io.c:1667
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
Personal Healthcare.
Definition: libusb.h:265
A structure representing the SuperSpeedPlus descriptor This descriptor is documented in section 9...
Definition: libusb.h:1064
uint8_t iProduct
Index of string descriptor describing product.
Definition: libusb.h:620
Delay from the time a host transmits a packet to the time it is received by the device.
Definition: libusb.h:436
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:2193
Set the log message verbosity.
Definition: libusb.h:1605
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:2342
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:1091
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
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:909
int libusb_init_context(libusb_context **ctx, const struct libusb_init_option options[], int num_options)
Initialize libusb.
Definition: core.c:2422
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
libusb_capability
Capabilities supported by an instance of libusb on the current running platform.
Definition: libusb.h:1526
Bulk stream transfer.
Definition: libusb.h:1350
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:1513
int libusb_submit_transfer(struct libusb_transfer *transfer)
Submit a transfer.
Definition: io.c:1486
Select an alternate interface for the specified interface.
Definition: libusb.h:426
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:843
int libusb_clear_halt(libusb_device_handle *dev_handle, unsigned char endpoint)
Clear the halt/stall condition for an endpoint.
Definition: core.c:1903
uint32_t bmAttributes
Bitmap encoding of supported device level features.
Definition: libusb.h:945
uint16_t wBytesPerInterval
The total number of bytes this EP will transfer every service interval.
Definition: libusb.h:873
uint8_t iConfiguration
Index of string descriptor describing this configuration.
Definition: libusb.h:823
unsigned int length
Length of data to request in this packet.
Definition: libusb.h:1432
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:780
uint8_t bAlternateSetting
Value used to select this alternate setting for this interface.
Definition: libusb.h:754
Implicit feedback Data endpoint.
Definition: libusb.h:511
libusb_log_level
Log message levels.
Definition: libusb.h:1547
Device sent more data than requested.
Definition: libusb.h:1377
Pipe error.
Definition: libusb.h:1313
Request status of the specific recipient.
Definition: libusb.h:395
libusb_device * libusb_get_device(libusb_device_handle *dev_handle)
Get the underlying device for a device handle.
Definition: core.c:1624
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
Vendor.
Definition: libusb.h:451
Communications class.
Definition: libusb.h:231
unsigned char endpoint
Address of the endpoint where this transfer will be sent.
Definition: libusb.h:1468
Do not scan for devices.
Definition: libusb.h:1634
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
uint8_t bInterfaceProtocol
USB-IF protocol code for this interface, qualified by the bInterfaceClass and bInterfaceSubClass valu...
Definition: libusb.h:769
Automatically free() transfer buffer during libusb_free_transfer().
Definition: libusb.h:1393
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
uint16_t bcdUSB
USB specification release number in binary-coded decimal.
Definition: libusb.h:591
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
Interrupt endpoint.
Definition: libusb.h:388
Structure providing the version of the libusb runtime.
Definition: libusb.h:1183
Device descriptor.
Definition: libusb.h:287
int libusb_init(libusb_context **ctx)
Deprecated initialization function.
Definition: core.c:2399
uint8_t bMaxBurst
The maximum number of packets the endpoint can send or receive as part of a burst.
Definition: libusb.h:863
uint16_t wSpeedSupported
Bitmap encoding of the speed supported by this device when operating in SuperSpeed mode...
Definition: libusb.h:975
Set or enable a specific feature.
Definition: libusb.h:403
Set device configuration.
Definition: libusb.h:420
const struct libusb_endpoint_descriptor * endpoint
Array of endpoint descriptors.
Definition: libusb.h:776
int libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *path, uint8_t path_length)
Definition: core.c:974
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
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
#define LIBUSB_CALL
libusb's Windows calling convention.
Definition: libusb.h:125
Isochronous packet descriptor.
Definition: libusb.h:1430
Structure containing an array of 0 or more interface association descriptors.
Definition: libusb.h:726
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:859
const char * rc
Library release candidate suffix string, e.g.
Definition: libusb.h:1197
Interface Association Descriptor.
Definition: libusb.h:303
void libusb_hotplug_deregister_callback(libusb_context *ctx, libusb_hotplug_callback_handle callback_handle)
Deregisters a hotplug callback.
Definition: hotplug.c:427
Set then report an endpoint's synchronization frame.
Definition: libusb.h:429
The device is operating at super speed plus x2 (20000MBit/s).
Definition: libusb.h:1274
Hotplug support is available on this platform.
Definition: libusb.h:1531
const struct libusb_interface_association_descriptor * iad
Array of interface association descriptors.
Definition: libusb.h:730
SuperSpeed USB device capability.
Definition: libusb.h:563
uint8_t MaxPower
Maximum power consumption of the USB device from this bus in this configuration when the device is fu...
Definition: libusb.h:832
void libusb_set_debug(libusb_context *ctx, int level)
Deprecated.
Definition: core.c:2211
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:1549
HID report descriptor.
Definition: libusb.h:315
struct libusb_ssplus_sublink_attribute sublinkSpeedAttributes[]
Array size is libusb_ssplus_usb_device_capability_descriptor::numSublinkSpeedAttributes.
Definition: libusb.h:1081
uint8_t numSublinkSpeedIDs
Sublink Speed ID Count.
Definition: libusb.h:1069
unsigned char type
Type of the transfer from libusb_transfer_type.
Definition: libusb.h:1471
A structure representing a Platform descriptor.
Definition: libusb.h:1114
Callback function handling all log messages.
Definition: libusb.h:1573
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:1842
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
uint8_t bRefresh
For audio devices only: the rate at which synchronization feedback is provided.
Definition: libusb.h:664
libusb_usb_2_0_extension_attributes
Masks for the bits of the bmAttributes field of the USB 2.0 Extension descriptor. ...
Definition: libusb.h:537
In the context of a device descriptor, this bDeviceClass value indicates that each interface specifie...
Definition: libusb.h:225