libusb  1.0.26
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 #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 ZERO_SIZED_ARRAY /* [] - valid C99 code */
54 #else
55 #define ZERO_SIZED_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 #else
78 #define LIBUSB_DEPRECATED_FOR(f)
79 #endif /* __GNUC__ */
80 
81 #if defined(__GNUC__)
82 #define LIBUSB_PACKED __attribute__ ((packed))
83 #define LIBUSB_NONNULL(...) __attribute__((nonnull(__VA_ARGS__)))
84 #else
85 #define LIBUSB_PACKED
86 #define LIBUSB_NONNULL(...)
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 #else
124 #define LIBUSB_CALL
125 #endif /* _WIN32 || __CYGWIN__ */
126 
147 #define LIBUSB_API_VERSION 0x01000109
148 
149 /* The following is kept for compatibility, but will be deprecated in the future */
150 #define LIBUSBX_API_VERSION LIBUSB_API_VERSION
151 
152 #if defined(__cplusplus)
153 extern "C" {
154 #endif
155 
164 static inline uint16_t libusb_cpu_to_le16(const uint16_t x)
165 {
166  union {
167  uint8_t b8[2];
168  uint16_t b16;
169  } _tmp;
170  _tmp.b8[1] = (uint8_t) (x >> 8);
171  _tmp.b8[0] = (uint8_t) (x & 0xff);
172  return _tmp.b16;
173 }
174 
183 #define libusb_le16_to_cpu libusb_cpu_to_le16
184 
185 /* standard USB stuff */
186 
195 
198 
201 
204 
207 
210  LIBUSB_CLASS_PTP = 0x06, /* legacy name from libusb-0.1 usb.h */
211 
214 
217 
220 
223 
226 
229 
232 
235 
238 
241 
244 
247 
250 };
251 
257 
260 
263 
266 
269 
272 
275 
278 
281 
284 
287 
290 
293 };
294 
295 /* Descriptor sizes per descriptor type */
296 #define LIBUSB_DT_DEVICE_SIZE 18
297 #define LIBUSB_DT_CONFIG_SIZE 9
298 #define LIBUSB_DT_INTERFACE_SIZE 9
299 #define LIBUSB_DT_ENDPOINT_SIZE 7
300 #define LIBUSB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
301 #define LIBUSB_DT_HUB_NONVAR_SIZE 7
302 #define LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE 6
303 #define LIBUSB_DT_BOS_SIZE 5
304 #define LIBUSB_DT_DEVICE_CAPABILITY_SIZE 3
305 
306 /* BOS descriptor sizes */
307 #define LIBUSB_BT_USB_2_0_EXTENSION_SIZE 7
308 #define LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE 10
309 #define LIBUSB_BT_CONTAINER_ID_SIZE 20
310 
311 /* We unwrap the BOS => define its max size */
312 #define LIBUSB_DT_BOS_MAX_SIZE \
313  (LIBUSB_DT_BOS_SIZE + \
314  LIBUSB_BT_USB_2_0_EXTENSION_SIZE + \
315  LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE + \
316  LIBUSB_BT_CONTAINER_ID_SIZE)
317 
318 #define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f /* in bEndpointAddress */
319 #define LIBUSB_ENDPOINT_DIR_MASK 0x80
320 
328 
330  LIBUSB_ENDPOINT_IN = 0x80
331 };
332 
333 #define LIBUSB_TRANSFER_TYPE_MASK 0x03 /* in bmAttributes */
334 
342 
345 
348 
351 };
352 
358 
361 
362  /* 0x02 is reserved */
363 
366 
367  /* 0x04 is reserved */
368 
371 
374 
377 
380 
383 
386 
389 
392 
395 
399 };
400 
408 
411 
414 
416  LIBUSB_REQUEST_TYPE_RESERVED = (0x03 << 5)
417 };
418 
426 
429 
432 
435 };
436 
437 #define LIBUSB_ISO_SYNC_TYPE_MASK 0x0c
438 
447 
450 
453 
456 };
457 
458 #define LIBUSB_ISO_USAGE_TYPE_MASK 0x30
459 
468 
471 
474 };
475 
483 
486 
489 
492 };
493 
501  LIBUSB_BM_LPM_SUPPORT = (1 << 1)
502 };
503 
511  LIBUSB_BM_LTM_SUPPORT = (1 << 1)
512 };
513 
520 
523 
526 
529 };
530 
538  uint8_t bLength;
539 
544 
547  uint16_t bcdUSB;
548 
550  uint8_t bDeviceClass;
551 
555 
559 
562 
564  uint16_t idVendor;
565 
567  uint16_t idProduct;
568 
570  uint16_t bcdDevice;
571 
573  uint8_t iManufacturer;
574 
576  uint8_t iProduct;
577 
579  uint8_t iSerialNumber;
580 
583 };
584 
592  uint8_t bLength;
593 
598 
603 
610  uint8_t bmAttributes;
611 
613  uint16_t wMaxPacketSize;
614 
616  uint8_t bInterval;
617 
620  uint8_t bRefresh;
621 
623  uint8_t bSynchAddress;
624 
627  const unsigned char *extra;
628 
631 };
632 
640  uint8_t bLength;
641 
646 
649 
652 
655  uint8_t bNumEndpoints;
656 
659 
663 
667 
669  uint8_t iInterface;
670 
674 
677  const unsigned char *extra;
678 
681 };
682 
690 
694 };
695 
703  uint8_t bLength;
704 
709 
711  uint16_t wTotalLength;
712 
714  uint8_t bNumInterfaces;
715 
718 
720  uint8_t iConfiguration;
721 
723  uint8_t bmAttributes;
724 
729  uint8_t MaxPower;
730 
734 
737  const unsigned char *extra;
738 
741 };
742 
751  uint8_t bLength;
752 
757 
760  uint8_t bMaxBurst;
761 
766  uint8_t bmAttributes;
767 
771 };
772 
780  uint8_t bLength;
781 
786 
789 
791  uint8_t dev_capability_data[ZERO_SIZED_ARRAY];
792 };
793 
801  uint8_t bLength;
802 
807 
809  uint16_t wTotalLength;
810 
813  uint8_t bNumDeviceCaps;
814 
817 };
818 
826  uint8_t bLength;
827 
832 
837 
842  uint32_t bmAttributes;
843 };
844 
852  uint8_t bLength;
853 
858 
863 
868  uint8_t bmAttributes;
869 
872  uint16_t wSpeedSupported;
873 
879 
881  uint8_t bU1DevExitLat;
882 
884  uint16_t bU2DevExitLat;
885 };
886 
894  uint8_t bLength;
895 
900 
905 
907  uint8_t bReserved;
908 
910  uint8_t ContainerID[16];
911 };
912 
915 #if defined(_MSC_VER) || defined(__WATCOMC__)
916 #pragma pack(push, 1)
917 #endif
924  uint8_t bmRequestType;
925 
931  uint8_t bRequest;
932 
934  uint16_t wValue;
935 
938  uint16_t wIndex;
939 
941  uint16_t wLength;
942 } LIBUSB_PACKED;
943 #if defined(_MSC_VER) || defined(__WATCOMC__)
944 #pragma pack(pop)
945 #endif
946 
947 #define LIBUSB_CONTROL_SETUP_SIZE (sizeof(struct libusb_control_setup))
948 
949 /* libusb */
950 
951 struct libusb_context;
952 struct libusb_device;
953 struct libusb_device_handle;
954 
960  const uint16_t major;
961 
963  const uint16_t minor;
964 
966  const uint16_t micro;
967 
969  const uint16_t nano;
970 
972  const char *rc;
973 
975  const char *describe;
976 };
977 
996 typedef struct libusb_context libusb_context;
997 
1013 typedef struct libusb_device libusb_device;
1014 
1015 
1025 
1032 
1035 
1038 
1041 
1044 
1047 };
1048 
1059 
1062 
1065 
1068 
1071 
1074 
1077 
1080 
1083 
1086 
1089 
1092 
1095 
1096  /* NB: Remember to update LIBUSB_ERROR_COUNT below as well as the
1097  message strings in strerror.c when adding new error codes here. */
1098 
1100  LIBUSB_ERROR_OTHER = -99
1101 };
1102 
1103 /* Total number of error codes in enum libusb_error */
1104 #define LIBUSB_ERROR_COUNT 14
1105 
1111 
1114 
1117 
1120 
1123 };
1124 
1131 
1134 
1137 
1140 
1144 
1147 
1150 
1151  /* NB! Remember to update libusb_error_name()
1152  when adding new status codes here. */
1153 };
1154 
1160 
1166 
1172 
1197 };
1198 
1203  unsigned int length;
1204 
1206  unsigned int actual_length;
1207 
1210 };
1211 
1212 struct libusb_transfer;
1213 
1223 typedef void (LIBUSB_CALL *libusb_transfer_cb_fn)(struct libusb_transfer *transfer);
1224 
1234 
1236  uint8_t flags;
1237 
1239  unsigned char endpoint;
1240 
1242  unsigned char type;
1243 
1246  unsigned int timeout;
1247 
1256 
1258  int length;
1259 
1264 
1268 
1279  void *user_data;
1280 
1282  unsigned char *buffer;
1283 
1287 
1289  struct libusb_iso_packet_descriptor iso_packet_desc[ZERO_SIZED_ARRAY];
1290 };
1291 
1300 
1303 
1309 
1313 };
1314 
1321 
1324 
1327 
1330 
1333 };
1334 
1345 
1347  LIBUSB_LOG_CB_CONTEXT = (1 << 1)
1348 };
1349 
1362  enum libusb_log_level level, const char *str);
1363 
1366 LIBUSB_DEPRECATED_FOR(libusb_set_option)
1367 void LIBUSB_CALL libusb_set_debug(libusb_context *ctx, int level);
1369 const struct libusb_version * LIBUSB_CALL libusb_get_version(void);
1370 int LIBUSB_CALL libusb_has_capability(uint32_t capability);
1371 const char * LIBUSB_CALL libusb_error_name(int errcode);
1372 int LIBUSB_CALL libusb_setlocale(const char *locale);
1373 const char * LIBUSB_CALL libusb_strerror(int errcode);
1374 
1376  libusb_device ***list);
1378  int unref_devices);
1381 
1383  int *config);
1385  struct libusb_device_descriptor *desc);
1387  struct libusb_config_descriptor **config);
1389  uint8_t config_index, struct libusb_config_descriptor **config);
1391  uint8_t bConfigurationValue, struct libusb_config_descriptor **config);
1393  struct libusb_config_descriptor *config);
1395  libusb_context *ctx,
1396  const struct libusb_endpoint_descriptor *endpoint,
1397  struct libusb_ss_endpoint_companion_descriptor **ep_comp);
1399  struct libusb_ss_endpoint_companion_descriptor *ep_comp);
1401  struct libusb_bos_descriptor **bos);
1404  libusb_context *ctx,
1405  struct libusb_bos_dev_capability_descriptor *dev_cap,
1406  struct libusb_usb_2_0_extension_descriptor **usb_2_0_extension);
1408  struct libusb_usb_2_0_extension_descriptor *usb_2_0_extension);
1410  libusb_context *ctx,
1411  struct libusb_bos_dev_capability_descriptor *dev_cap,
1412  struct libusb_ss_usb_device_capability_descriptor **ss_usb_device_cap);
1414  struct libusb_ss_usb_device_capability_descriptor *ss_usb_device_cap);
1416  struct libusb_bos_dev_capability_descriptor *dev_cap,
1417  struct libusb_container_id_descriptor **container_id);
1419  struct libusb_container_id_descriptor *container_id);
1422 int LIBUSB_CALL libusb_get_port_numbers(libusb_device *dev, uint8_t *port_numbers, int port_numbers_len);
1423 LIBUSB_DEPRECATED_FOR(libusb_get_port_numbers)
1424 int LIBUSB_CALL libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *path, uint8_t path_length);
1429  unsigned char endpoint);
1431  unsigned char endpoint);
1432 
1433 int LIBUSB_CALL libusb_wrap_sys_device(libusb_context *ctx, intptr_t sys_dev, libusb_device_handle **dev_handle);
1437 
1439  int configuration);
1441  int interface_number);
1443  int interface_number);
1444 
1446  libusb_context *ctx, uint16_t vendor_id, uint16_t product_id);
1447 
1449  int interface_number, int alternate_setting);
1451  unsigned char endpoint);
1453 
1455  uint32_t num_streams, unsigned char *endpoints, int num_endpoints);
1457  unsigned char *endpoints, int num_endpoints);
1458 
1459 unsigned char * LIBUSB_CALL libusb_dev_mem_alloc(libusb_device_handle *dev_handle,
1460  size_t length);
1462  unsigned char *buffer, size_t length);
1463 
1465  int interface_number);
1467  int interface_number);
1469  int interface_number);
1471  libusb_device_handle *dev_handle, int enable);
1472 
1473 /* async I/O */
1474 
1487 LIBUSB_NONNULL(1)
1488 static inline unsigned char *libusb_control_transfer_get_data(
1489  struct libusb_transfer *transfer)
1490 {
1491  return transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
1492 }
1493 
1506 LIBUSB_NONNULL(1)
1508  struct libusb_transfer *transfer)
1509 {
1510  return (struct libusb_control_setup *)(void *)transfer->buffer;
1511 }
1512 
1536 LIBUSB_NONNULL(1)
1537 static inline void libusb_fill_control_setup(unsigned char *buffer,
1538  uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
1539  uint16_t wLength)
1540 {
1541  struct libusb_control_setup *setup = (struct libusb_control_setup *)(void *)buffer;
1542  setup->bmRequestType = bmRequestType;
1543  setup->bRequest = bRequest;
1544  setup->wValue = libusb_cpu_to_le16(wValue);
1545  setup->wIndex = libusb_cpu_to_le16(wIndex);
1547 }
1548 
1549 struct libusb_transfer * LIBUSB_CALL libusb_alloc_transfer(int iso_packets);
1550 int LIBUSB_CALL libusb_submit_transfer(struct libusb_transfer *transfer);
1551 int LIBUSB_CALL libusb_cancel_transfer(struct libusb_transfer *transfer);
1552 void LIBUSB_CALL libusb_free_transfer(struct libusb_transfer *transfer);
1554  struct libusb_transfer *transfer, uint32_t stream_id);
1556  struct libusb_transfer *transfer);
1557 
1586 LIBUSB_NONNULL(1)
1587 static inline void libusb_fill_control_transfer(
1588  struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1589  unsigned char *buffer, libusb_transfer_cb_fn callback, void *user_data,
1590  unsigned int timeout)
1591 {
1592  struct libusb_control_setup *setup = (struct libusb_control_setup *)(void *)buffer;
1593  transfer->dev_handle = dev_handle;
1594  transfer->endpoint = 0;
1595  transfer->type = LIBUSB_TRANSFER_TYPE_CONTROL;
1596  transfer->timeout = timeout;
1597  transfer->buffer = buffer;
1598  if (setup)
1599  transfer->length = (int) (LIBUSB_CONTROL_SETUP_SIZE
1600  + libusb_le16_to_cpu(setup->wLength));
1601  transfer->user_data = user_data;
1602  transfer->callback = callback;
1603 }
1604 
1618 LIBUSB_NONNULL(1)
1619 static inline void libusb_fill_bulk_transfer(struct libusb_transfer *transfer,
1620  libusb_device_handle *dev_handle, unsigned char endpoint,
1621  unsigned char *buffer, int length, libusb_transfer_cb_fn callback,
1622  void *user_data, unsigned int timeout)
1623 {
1624  transfer->dev_handle = dev_handle;
1625  transfer->endpoint = endpoint;
1626  transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1627  transfer->timeout = timeout;
1628  transfer->buffer = buffer;
1629  transfer->length = length;
1630  transfer->user_data = user_data;
1631  transfer->callback = callback;
1632 }
1633 
1650 LIBUSB_NONNULL(1)
1652  struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1653  unsigned char endpoint, uint32_t stream_id,
1654  unsigned char *buffer, int length, libusb_transfer_cb_fn callback,
1655  void *user_data, unsigned int timeout)
1656 {
1657  libusb_fill_bulk_transfer(transfer, dev_handle, endpoint, buffer,
1658  length, callback, user_data, timeout);
1659  transfer->type = LIBUSB_TRANSFER_TYPE_BULK_STREAM;
1660  libusb_transfer_set_stream_id(transfer, stream_id);
1661 }
1662 
1676 LIBUSB_NONNULL(1)
1678  struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1679  unsigned char endpoint, unsigned char *buffer, int length,
1680  libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
1681 {
1682  transfer->dev_handle = dev_handle;
1683  transfer->endpoint = endpoint;
1684  transfer->type = LIBUSB_TRANSFER_TYPE_INTERRUPT;
1685  transfer->timeout = timeout;
1686  transfer->buffer = buffer;
1687  transfer->length = length;
1688  transfer->user_data = user_data;
1689  transfer->callback = callback;
1690 }
1691 
1706 LIBUSB_NONNULL(1)
1707 static inline void libusb_fill_iso_transfer(struct libusb_transfer *transfer,
1708  libusb_device_handle *dev_handle, unsigned char endpoint,
1709  unsigned char *buffer, int length, int num_iso_packets,
1710  libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
1711 {
1712  transfer->dev_handle = dev_handle;
1713  transfer->endpoint = endpoint;
1714  transfer->type = LIBUSB_TRANSFER_TYPE_ISOCHRONOUS;
1715  transfer->timeout = timeout;
1716  transfer->buffer = buffer;
1717  transfer->length = length;
1718  transfer->num_iso_packets = num_iso_packets;
1719  transfer->user_data = user_data;
1720  transfer->callback = callback;
1721 }
1722 
1731 LIBUSB_NONNULL(1)
1733  struct libusb_transfer *transfer, unsigned int length)
1734 {
1735  int i;
1736 
1737  for (i = 0; i < transfer->num_iso_packets; i++)
1738  transfer->iso_packet_desc[i].length = length;
1739 }
1740 
1757 LIBUSB_NONNULL(1)
1758 static inline unsigned char *libusb_get_iso_packet_buffer(
1759  struct libusb_transfer *transfer, unsigned int packet)
1760 {
1761  int i;
1762  size_t offset = 0;
1763  int _packet;
1764 
1765  /* oops..slight bug in the API. packet is an unsigned int, but we use
1766  * signed integers almost everywhere else. range-check and convert to
1767  * signed to avoid compiler warnings. FIXME for libusb-2. */
1768  if (packet > INT_MAX)
1769  return NULL;
1770  _packet = (int) packet;
1771 
1772  if (_packet >= transfer->num_iso_packets)
1773  return NULL;
1774 
1775  for (i = 0; i < _packet; i++)
1776  offset += transfer->iso_packet_desc[i].length;
1777 
1778  return transfer->buffer + offset;
1779 }
1780 
1800 LIBUSB_NONNULL(1)
1801 static inline unsigned char *libusb_get_iso_packet_buffer_simple(
1802  struct libusb_transfer *transfer, unsigned int packet)
1803 {
1804  int _packet;
1805 
1806  /* oops..slight bug in the API. packet is an unsigned int, but we use
1807  * signed integers almost everywhere else. range-check and convert to
1808  * signed to avoid compiler warnings. FIXME for libusb-2. */
1809  if (packet > INT_MAX)
1810  return NULL;
1811  _packet = (int) packet;
1812 
1813  if (_packet >= transfer->num_iso_packets)
1814  return NULL;
1815 
1816  return transfer->buffer + ((int) transfer->iso_packet_desc[0].length * _packet);
1817 }
1818 
1819 /* sync I/O */
1820 
1822  uint8_t request_type, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
1823  unsigned char *data, uint16_t wLength, unsigned int timeout);
1824 
1826  unsigned char endpoint, unsigned char *data, int length,
1827  int *actual_length, unsigned int timeout);
1828 
1830  unsigned char endpoint, unsigned char *data, int length,
1831  int *actual_length, unsigned int timeout);
1832 
1845 static inline int libusb_get_descriptor(libusb_device_handle *dev_handle,
1846  uint8_t desc_type, uint8_t desc_index, unsigned char *data, int length)
1847 {
1848  return libusb_control_transfer(dev_handle, LIBUSB_ENDPOINT_IN,
1849  LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t) ((desc_type << 8) | desc_index),
1850  0, data, (uint16_t) length, 1000);
1851 }
1852 
1868  uint8_t desc_index, uint16_t langid, unsigned char *data, int length)
1869 {
1870  return libusb_control_transfer(dev_handle, LIBUSB_ENDPOINT_IN,
1871  LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t)((LIBUSB_DT_STRING << 8) | desc_index),
1872  langid, data, (uint16_t) length, 1000);
1873 }
1874 
1876  uint8_t desc_index, unsigned char *data, int length);
1877 
1878 /* polling and timeouts */
1879 
1888 int LIBUSB_CALL libusb_wait_for_event(libusb_context *ctx, struct timeval *tv);
1889 
1891  struct timeval *tv);
1893  struct timeval *tv, int *completed);
1897  struct timeval *tv);
1900  struct timeval *tv);
1901 
1907  int fd;
1908 
1913  short events;
1914 };
1915 
1926 typedef void (LIBUSB_CALL *libusb_pollfd_added_cb)(int fd, short events,
1927  void *user_data);
1928 
1938 typedef void (LIBUSB_CALL *libusb_pollfd_removed_cb)(int fd, void *user_data);
1939 
1941  libusb_context *ctx);
1942 void LIBUSB_CALL libusb_free_pollfds(const struct libusb_pollfd **pollfds);
1944  libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb,
1945  void *user_data);
1946 
1960 
1966 typedef enum {
1969 
1975 
1981 typedef enum {
1983  LIBUSB_HOTPLUG_ENUMERATE = (1 << 0)
1985 
1988 #define LIBUSB_HOTPLUG_NO_FLAGS 0
1989 
1992 #define LIBUSB_HOTPLUG_MATCH_ANY -1
1993 
2017  libusb_device *device, libusb_hotplug_event event, void *user_data);
2018 
2055  int events, int flags,
2056  int vendor_id, int product_id, int dev_class,
2057  libusb_hotplug_callback_fn cb_fn, void *user_data,
2058  libusb_hotplug_callback_handle *callback_handle);
2059 
2072  libusb_hotplug_callback_handle callback_handle);
2073 
2083  libusb_hotplug_callback_handle callback_handle);
2084 
2111 
2120 
2139 
2140 #define LIBUSB_OPTION_WEAK_AUTHORITY LIBUSB_OPTION_NO_DEVICE_DISCOVERY
2141 
2142  LIBUSB_OPTION_MAX = 3
2143 };
2144 
2145 int LIBUSB_CALL libusb_set_option(libusb_context *ctx, enum libusb_option option, ...);
2146 
2147 #ifdef _MSC_VER
2148 #pragma warning(pop)
2149 #endif
2150 
2151 #if defined(__cplusplus)
2152 }
2153 #endif
2154 
2155 #endif
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
libusb_transfer_flags
libusb_transfer.flags values
Definition: libusb.h:1157
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:1707
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:1587
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:1801
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:1930
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:1537
uint32_t libusb_transfer_get_stream_id(struct libusb_transfer *transfer)
Get a transfers bulk stream id.
Definition: io.c:1666
int libusb_cancel_transfer(struct libusb_transfer *transfer)
Asynchronously cancel a previously submitted transfer.
Definition: io.c:1605
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:1507
void libusb_free_transfer(struct libusb_transfer *transfer)
Free a transfer structure.
Definition: io.c:1332
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:1758
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:1677
libusb_transfer_status
Transfer status codes.
Definition: libusb.h:1127
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:1887
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:1651
void(* libusb_transfer_cb_fn)(struct libusb_transfer *transfer)
Asynchronous transfer callback function type.
Definition: libusb.h:1223
libusb_transfer_type
Transfer type.
Definition: libusb.h:1108
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:1732
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:1619
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:1950
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:1857
static unsigned char * libusb_control_transfer_get_data(struct libusb_transfer *transfer)
Get the data section of a control transfer.
Definition: libusb.h:1488
void libusb_transfer_set_stream_id(struct libusb_transfer *transfer, uint32_t stream_id)
Set a transfers bulk stream id.
Definition: io.c:1649
@ 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:1196
@ LIBUSB_TRANSFER_FREE_TRANSFER
Automatically call libusb_free_transfer() after callback returns.
Definition: libusb.h:1171
@ LIBUSB_TRANSFER_SHORT_NOT_OK
Report short frames as errors.
Definition: libusb.h:1159
@ LIBUSB_TRANSFER_FREE_BUFFER
Automatically free() transfer buffer during libusb_free_transfer().
Definition: libusb.h:1165
@ LIBUSB_TRANSFER_STALL
For bulk/interrupt endpoints: halt condition detected (endpoint stalled).
Definition: libusb.h:1143
@ LIBUSB_TRANSFER_COMPLETED
Transfer completed without error.
Definition: libusb.h:1130
@ LIBUSB_TRANSFER_CANCELLED
Transfer was cancelled.
Definition: libusb.h:1139
@ LIBUSB_TRANSFER_ERROR
Transfer failed.
Definition: libusb.h:1133
@ LIBUSB_TRANSFER_OVERFLOW
Device sent more data than requested.
Definition: libusb.h:1149
@ LIBUSB_TRANSFER_NO_DEVICE
Device was disconnected.
Definition: libusb.h:1146
@ LIBUSB_TRANSFER_TIMED_OUT
Transfer timed out.
Definition: libusb.h:1136
@ LIBUSB_TRANSFER_TYPE_BULK_STREAM
Bulk stream transfer.
Definition: libusb.h:1122
@ LIBUSB_TRANSFER_TYPE_ISOCHRONOUS
Isochronous transfer.
Definition: libusb.h:1113
@ LIBUSB_TRANSFER_TYPE_CONTROL
Control transfer.
Definition: libusb.h:1110
@ LIBUSB_TRANSFER_TYPE_BULK
Bulk transfer.
Definition: libusb.h:1116
@ LIBUSB_TRANSFER_TYPE_INTERRUPT
Interrupt transfer.
Definition: libusb.h:1119
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:1867
libusb_descriptor_type
Descriptor types as defined by the USB specification.
Definition: libusb.h:254
libusb_supported_speed
Supported speeds (wSpeedSupported) bitfield.
Definition: libusb.h:480
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:517
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:325
libusb_endpoint_transfer_type
Endpoint transfer type.
Definition: libusb.h:339
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:1845
libusb_iso_sync_type
Synchronization type for isochronous endpoints.
Definition: libusb.h:444
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:509
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:465
libusb_class_code
Device and/or Interface Class codes.
Definition: libusb.h:189
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:499
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:286
@ LIBUSB_DT_CONFIG
Configuration descriptor.
Definition: libusb.h:259
@ LIBUSB_DT_STRING
String descriptor.
Definition: libusb.h:262
@ LIBUSB_DT_HID
HID descriptor.
Definition: libusb.h:277
@ LIBUSB_DT_REPORT
HID report descriptor.
Definition: libusb.h:280
@ LIBUSB_DT_DEVICE
Device descriptor.
Definition: libusb.h:256
@ LIBUSB_DT_DEVICE_CAPABILITY
Device Capability descriptor.
Definition: libusb.h:274
@ LIBUSB_DT_SUPERSPEED_HUB
SuperSpeed Hub descriptor.
Definition: libusb.h:289
@ LIBUSB_DT_PHYSICAL
Physical descriptor.
Definition: libusb.h:283
@ LIBUSB_DT_INTERFACE
Interface descriptor.
Definition: libusb.h:265
@ LIBUSB_DT_ENDPOINT
Endpoint descriptor.
Definition: libusb.h:268
@ LIBUSB_DT_SS_ENDPOINT_COMPANION
SuperSpeed Endpoint Companion descriptor.
Definition: libusb.h:292
@ LIBUSB_DT_BOS
BOS descriptor.
Definition: libusb.h:271
@ LIBUSB_HIGH_SPEED_OPERATION
High speed operation supported (480MBit/s).
Definition: libusb.h:488
@ LIBUSB_LOW_SPEED_OPERATION
Low speed operation supported (1.5MBit/s).
Definition: libusb.h:482
@ LIBUSB_SUPER_SPEED_OPERATION
Superspeed operation supported (5000MBit/s).
Definition: libusb.h:491
@ LIBUSB_FULL_SPEED_OPERATION
Full speed operation supported (12MBit/s).
Definition: libusb.h:485
@ LIBUSB_BT_USB_2_0_EXTENSION
USB 2.0 extensions.
Definition: libusb.h:522
@ LIBUSB_BT_SS_USB_DEVICE_CAPABILITY
SuperSpeed USB device capability.
Definition: libusb.h:525
@ LIBUSB_BT_WIRELESS_USB_DEVICE_CAPABILITY
Wireless USB device capability.
Definition: libusb.h:519
@ LIBUSB_BT_CONTAINER_ID
Container ID type.
Definition: libusb.h:528
@ LIBUSB_ENDPOINT_IN
In: device-to-host.
Definition: libusb.h:330
@ LIBUSB_ENDPOINT_OUT
Out: host-to-device.
Definition: libusb.h:327
@ LIBUSB_ENDPOINT_TRANSFER_TYPE_INTERRUPT
Interrupt endpoint.
Definition: libusb.h:350
@ LIBUSB_ENDPOINT_TRANSFER_TYPE_ISOCHRONOUS
Isochronous endpoint.
Definition: libusb.h:344
@ LIBUSB_ENDPOINT_TRANSFER_TYPE_BULK
Bulk endpoint.
Definition: libusb.h:347
@ LIBUSB_ENDPOINT_TRANSFER_TYPE_CONTROL
Control endpoint.
Definition: libusb.h:341
@ LIBUSB_ISO_SYNC_TYPE_SYNC
Synchronous.
Definition: libusb.h:455
@ LIBUSB_ISO_SYNC_TYPE_NONE
No synchronization.
Definition: libusb.h:446
@ LIBUSB_ISO_SYNC_TYPE_ADAPTIVE
Adaptive.
Definition: libusb.h:452
@ LIBUSB_ISO_SYNC_TYPE_ASYNC
Asynchronous.
Definition: libusb.h:449
@ LIBUSB_BM_LTM_SUPPORT
Supports Latency Tolerance Messages (LTM)
Definition: libusb.h:511
@ LIBUSB_ISO_USAGE_TYPE_DATA
Data endpoint.
Definition: libusb.h:467
@ LIBUSB_ISO_USAGE_TYPE_FEEDBACK
Feedback endpoint.
Definition: libusb.h:470
@ LIBUSB_ISO_USAGE_TYPE_IMPLICIT
Implicit feedback Data endpoint.
Definition: libusb.h:473
@ LIBUSB_CLASS_AUDIO
Audio class.
Definition: libusb.h:197
@ LIBUSB_CLASS_HUB
Hub class.
Definition: libusb.h:219
@ LIBUSB_CLASS_MISCELLANEOUS
Miscellaneous class.
Definition: libusb.h:243
@ LIBUSB_CLASS_APPLICATION
Application class.
Definition: libusb.h:246
@ LIBUSB_CLASS_CONTENT_SECURITY
Content Security.
Definition: libusb.h:228
@ LIBUSB_CLASS_DIAGNOSTIC_DEVICE
Diagnostic Device.
Definition: libusb.h:237
@ LIBUSB_CLASS_PHYSICAL
Physical.
Definition: libusb.h:206
@ LIBUSB_CLASS_COMM
Communications class.
Definition: libusb.h:200
@ LIBUSB_CLASS_VIDEO
Video.
Definition: libusb.h:231
@ LIBUSB_CLASS_DATA
Data class.
Definition: libusb.h:222
@ LIBUSB_CLASS_WIRELESS
Wireless class.
Definition: libusb.h:240
@ LIBUSB_CLASS_PRINTER
Printer class.
Definition: libusb.h:213
@ LIBUSB_CLASS_PERSONAL_HEALTHCARE
Personal Healthcare.
Definition: libusb.h:234
@ LIBUSB_CLASS_PER_INTERFACE
In the context of a device descriptor, this bDeviceClass value indicates that each interface specifie...
Definition: libusb.h:194
@ LIBUSB_CLASS_MASS_STORAGE
Mass storage class.
Definition: libusb.h:216
@ LIBUSB_CLASS_HID
Human Interface Device class.
Definition: libusb.h:203
@ LIBUSB_CLASS_VENDOR_SPEC
Class is vendor-specific.
Definition: libusb.h:249
@ LIBUSB_CLASS_IMAGE
Image class.
Definition: libusb.h:209
@ LIBUSB_CLASS_SMART_CARD
Smart Card.
Definition: libusb.h:225
@ LIBUSB_BM_LPM_SUPPORT
Supports Link Power Management (LPM)
Definition: libusb.h:501
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:1353
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
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:1976
libusb_speed
Speed codes.
Definition: libusb.h:1029
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:1298
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:1753
int libusb_release_interface(libusb_device_handle *dev_handle, int interface_number)
Release an interface previously claimed with libusb_claim_interface().
Definition: core.c:1708
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:2014
void libusb_close(libusb_device_handle *dev_handle)
Close a device handle.
Definition: core.c:1453
struct libusb_device libusb_device
Structure representing a USB device detected on the system.
Definition: libusb.h:1013
int libusb_set_configuration(libusb_device_handle *dev_handle, int configuration)
Set the active configuration for a device.
Definition: core.c:1627
struct libusb_device_handle libusb_device_handle
Structure representing a handle on a USB device.
Definition: libusb.h:1024
libusb_device * libusb_get_parent(libusb_device *dev)
Get the the parent from the specified device.
Definition: core.c:988
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
libusb_device * libusb_ref_device(libusb_device *dev)
Increment the reference count of a device.
Definition: core.c:1165
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:1795
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:2089
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:2050
int libusb_get_configuration(libusb_device_handle *dev, int *config)
Determine the bConfigurationValue of the currently active configuration.
Definition: core.c:1540
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:1664
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
libusb_device * libusb_get_device(libusb_device_handle *dev_handle)
Get the underlying device for a device handle.
Definition: core.c:1515
int libusb_reset_device(libusb_device_handle *dev_handle)
Perform a USB port reset to reinitialize a device.
Definition: core.c:1824
@ LIBUSB_SPEED_FULL
The device is operating at full speed (12MBit/s).
Definition: libusb.h:1037
@ LIBUSB_SPEED_HIGH
The device is operating at high speed (480MBit/s).
Definition: libusb.h:1040
@ LIBUSB_SPEED_LOW
The device is operating at low speed (1.5MBit/s).
Definition: libusb.h:1034
@ LIBUSB_SPEED_SUPER_PLUS
The device is operating at super speed plus (10000MBit/s).
Definition: libusb.h:1046
@ LIBUSB_SPEED_SUPER
The device is operating at super speed (5000MBit/s).
Definition: libusb.h:1043
@ LIBUSB_SPEED_UNKNOWN
The OS doesn't report or know the device speed.
Definition: libusb.h:1031
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:2016
int libusb_hotplug_callback_handle
Callback handle.
Definition: libusb.h:1959
libusb_hotplug_event
Since version 1.0.16, LIBUSB_API_VERSION >= 0x01000102.
Definition: libusb.h:1966
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:323
void libusb_hotplug_deregister_callback(libusb_context *ctx, libusb_hotplug_callback_handle callback_handle)
Deregisters a hotplug callback.
Definition: hotplug.c:407
libusb_hotplug_flag
Since version 1.0.16, LIBUSB_API_VERSION >= 0x01000102.
Definition: libusb.h:1981
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:445
@ LIBUSB_HOTPLUG_EVENT_DEVICE_ARRIVED
A device has been plugged in and is ready to use.
Definition: libusb.h:1968
@ LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT
A device has left and is no longer available.
Definition: libusb.h:1973
@ LIBUSB_HOTPLUG_ENUMERATE
Arm the callback and fire it for all matching currently attached devices.
Definition: libusb.h:1983
libusb_option
Available option values for libusb_set_option().
Definition: libusb.h:2088
libusb_log_cb_mode
Log callback mode.
Definition: libusb.h:1342
libusb_log_level
Log message levels.
Definition: libusb.h:1318
void libusb_set_log_cb(libusb_context *ctx, libusb_log_cb cb, int mode)
Set log handler.
Definition: core.c:2140
struct libusb_context libusb_context
Structure representing a libusb session.
Definition: libusb.h:996
void libusb_set_debug(libusb_context *ctx, int level)
Definition: core.c:2103
int libusb_init(libusb_context **ctx)
Initialize libusb.
Definition: core.c:2277
void(* libusb_log_cb)(libusb_context *ctx, enum libusb_log_level level, const char *str)
Callback function for handling log messages.
Definition: libusb.h:1361
void libusb_exit(libusb_context *ctx)
Deinitialize libusb.
Definition: core.c:2399
int libusb_set_option(libusb_context *ctx, enum libusb_option option,...)
Set an option in the library.
Definition: core.c:2186
@ LIBUSB_OPTION_NO_DEVICE_DISCOVERY
Do not scan for devices.
Definition: libusb.h:2138
@ LIBUSB_OPTION_LOG_LEVEL
Set the log message verbosity.
Definition: libusb.h:2110
@ LIBUSB_OPTION_USE_USBDK
Use the UsbDk backend for a specific context, if available.
Definition: libusb.h:2119
@ LIBUSB_LOG_CB_GLOBAL
Callback function handling all log messages.
Definition: libusb.h:1344
@ LIBUSB_LOG_CB_CONTEXT
Callback function handling context related log messages.
Definition: libusb.h:1347
@ LIBUSB_LOG_LEVEL_WARNING
(2) : Warning and error messages are emitted
Definition: libusb.h:1326
@ LIBUSB_LOG_LEVEL_INFO
(3) : Informational, warning and error messages are emitted
Definition: libusb.h:1329
@ LIBUSB_LOG_LEVEL_ERROR
(1) : Error messages are emitted
Definition: libusb.h:1323
@ LIBUSB_LOG_LEVEL_NONE
(0) : No messages ever emitted by the library (default)
Definition: libusb.h:1320
@ LIBUSB_LOG_LEVEL_DEBUG
(4) : All messages are emitted
Definition: libusb.h:1332
libusb_request_type
Request type bits of the bmRequestType field in control transfers.
Definition: libusb.h:405
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
libusb_request_recipient
Recipient bits of the bmRequestType field in control transfers.
Definition: libusb.h:423
#define libusb_le16_to_cpu
Convert a 16-bit value from little-endian to host-endian format.
Definition: libusb.h:183
libusb_standard_request
Standard requests, as defined in table 9-5 of the USB 3.0 specifications.
Definition: libusb.h:355
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:2740
int libusb_has_capability(uint32_t capability)
Check at runtime if the loaded library has a given capability.
Definition: core.c:2471
#define LIBUSB_CALL
libusb's Windows calling convention.
Definition: libusb.h:124
libusb_capability
Capabilities supported by an instance of libusb on the current running platform.
Definition: libusb.h:1297
libusb_error
Error codes.
Definition: libusb.h:1056
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:2685
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
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:164
@ LIBUSB_REQUEST_TYPE_VENDOR
Vendor.
Definition: libusb.h:413
@ LIBUSB_REQUEST_TYPE_STANDARD
Standard.
Definition: libusb.h:407
@ LIBUSB_REQUEST_TYPE_CLASS
Class.
Definition: libusb.h:410
@ LIBUSB_REQUEST_TYPE_RESERVED
Reserved.
Definition: libusb.h:416
@ LIBUSB_RECIPIENT_ENDPOINT
Endpoint.
Definition: libusb.h:431
@ LIBUSB_RECIPIENT_INTERFACE
Interface.
Definition: libusb.h:428
@ LIBUSB_RECIPIENT_OTHER
Other.
Definition: libusb.h:434
@ LIBUSB_RECIPIENT_DEVICE
Device.
Definition: libusb.h:425
@ LIBUSB_REQUEST_CLEAR_FEATURE
Clear or disable a specific feature.
Definition: libusb.h:360
@ LIBUSB_REQUEST_GET_INTERFACE
Return the selected alternate setting for the specified interface.
Definition: libusb.h:385
@ LIBUSB_REQUEST_GET_DESCRIPTOR
Get the specified descriptor.
Definition: libusb.h:373
@ LIBUSB_REQUEST_SET_DESCRIPTOR
Used to update existing descriptors or add new descriptors.
Definition: libusb.h:376
@ LIBUSB_REQUEST_GET_STATUS
Request status of the specific recipient.
Definition: libusb.h:357
@ LIBUSB_REQUEST_SET_FEATURE
Set or enable a specific feature.
Definition: libusb.h:365
@ LIBUSB_REQUEST_SET_INTERFACE
Select an alternate interface for the specified interface.
Definition: libusb.h:388
@ LIBUSB_REQUEST_SET_ADDRESS
Set device address for all future accesses.
Definition: libusb.h:370
@ LIBUSB_REQUEST_GET_CONFIGURATION
Get the current device configuration value.
Definition: libusb.h:379
@ LIBUSB_REQUEST_SET_SEL
Sets both the U1 and U2 Exit Latency.
Definition: libusb.h:394
@ 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:398
@ LIBUSB_REQUEST_SYNCH_FRAME
Set then report an endpoint's synchronization frame.
Definition: libusb.h:391
@ LIBUSB_REQUEST_SET_CONFIGURATION
Set device configuration.
Definition: libusb.h:382
@ LIBUSB_CAP_HAS_CAPABILITY
The libusb_has_capability() API is available.
Definition: libusb.h:1299
@ LIBUSB_CAP_HAS_HOTPLUG
Hotplug support is available on this platform.
Definition: libusb.h:1302
@ LIBUSB_CAP_HAS_HID_ACCESS
The library can access HID devices without requiring user intervention.
Definition: libusb.h:1308
@ LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER
The library supports detaching of the default USB driver, using libusb_detach_kernel_driver(),...
Definition: libusb.h:1312
@ LIBUSB_ERROR_NOT_SUPPORTED
Operation not supported or unimplemented on this platform.
Definition: libusb.h:1094
@ LIBUSB_ERROR_ACCESS
Access denied (insufficient permissions)
Definition: libusb.h:1067
@ LIBUSB_ERROR_PIPE
Pipe error.
Definition: libusb.h:1085
@ LIBUSB_ERROR_NOT_FOUND
Entity not found.
Definition: libusb.h:1073
@ LIBUSB_ERROR_BUSY
Resource busy.
Definition: libusb.h:1076
@ LIBUSB_ERROR_INTERRUPTED
System call interrupted (perhaps due to signal)
Definition: libusb.h:1088
@ LIBUSB_SUCCESS
Success (no error)
Definition: libusb.h:1058
@ LIBUSB_ERROR_INVALID_PARAM
Invalid parameter.
Definition: libusb.h:1064
@ LIBUSB_ERROR_IO
Input/output error.
Definition: libusb.h:1061
@ LIBUSB_ERROR_OTHER
Other error.
Definition: libusb.h:1100
@ LIBUSB_ERROR_TIMEOUT
Operation timed out.
Definition: libusb.h:1079
@ LIBUSB_ERROR_OVERFLOW
Overflow.
Definition: libusb.h:1082
@ LIBUSB_ERROR_NO_DEVICE
No such device (it may have been disconnected)
Definition: libusb.h:1070
@ LIBUSB_ERROR_NO_MEM
Insufficient memory.
Definition: libusb.h:1091
int libusb_handle_events_completed(libusb_context *ctx, int *completed)
Handle any pending events in blocking mode.
Definition: io.c:2456
void libusb_lock_event_waiters(libusb_context *ctx)
Acquire the event waiters lock.
Definition: io.c:1979
void libusb_interrupt_event_handler(libusb_context *ctx)
Interrupt any active thread that is handling events.
Definition: io.c:1943
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:2638
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:1926
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:1938
int libusb_event_handler_active(libusb_context *ctx)
Determine if an active thread is handling events (i.e.
Definition: io.c:1914
void libusb_unlock_event_waiters(libusb_context *ctx)
Release the event waiters lock.
Definition: io.c:1990
int libusb_handle_events_timeout_completed(libusb_context *ctx, struct timeval *tv, int *completed)
Handle any pending events.
Definition: io.c:2342
int libusb_handle_events(libusb_context *ctx)
Handle any pending events in blocking mode.
Definition: io.c:2434
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:2746
int libusb_get_next_timeout(libusb_context *ctx, struct timeval *tv)
Determine the next internal timeout that libusb needs to handle.
Definition: io.c:2566
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:1885
int libusb_handle_events_timeout(libusb_context *ctx, struct timeval *tv)
Handle any pending events.
Definition: io.c:2414
int libusb_try_lock_events(libusb_context *ctx)
Attempt to acquire the event handling lock.
Definition: io.c:1791
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:2484
void libusb_lock_events(libusb_context *ctx)
Acquire the event handling lock, blocking until successful acquisition if it is contended.
Definition: io.c:1835
void libusb_unlock_events(libusb_context *ctx)
Release the lock previously acquired with libusb_try_lock_events() or libusb_lock_events().
Definition: io.c:1850
void libusb_free_pollfds(const struct libusb_pollfd **pollfds)
Free a list of libusb_pollfd structures.
Definition: io.c:2794
int libusb_wait_for_event(libusb_context *ctx, struct timeval *tv)
Wait for another thread to signal completion of an event.
Definition: io.c:2022
int libusb_pollfds_handle_timeouts(libusb_context *ctx)
Determines whether your application must apply special timing considerations when monitoring libusb's...
Definition: io.c:2532
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:799
uint16_t wTotalLength
Length of this descriptor and all of its sub descriptors.
Definition: libusb.h:809
struct libusb_bos_dev_capability_descriptor * dev_capability[ZERO_SIZED_ARRAY]
bNumDeviceCap Device Capability Descriptors
Definition: libusb.h:816
uint8_t bNumDeviceCaps
The number of separate device capability descriptors in the BOS.
Definition: libusb.h:813
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:801
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:806
A generic representation of a BOS Device Capability descriptor.
Definition: libusb.h:778
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:780
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:785
uint8_t dev_capability_data[ZERO_SIZED_ARRAY]
Device Capability data (bLength - 3 bytes)
Definition: libusb.h:791
uint8_t bDevCapabilityType
Device Capability type.
Definition: libusb.h:788
A structure representing the standard USB configuration descriptor.
Definition: libusb.h:701
uint8_t bConfigurationValue
Identifier value for this configuration.
Definition: libusb.h:717
uint8_t iConfiguration
Index of string descriptor describing this configuration.
Definition: libusb.h:720
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:740
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:703
uint8_t bNumInterfaces
Number of interfaces supported by this configuration.
Definition: libusb.h:714
uint8_t MaxPower
Maximum power consumption of the USB device from this bus in this configuration when the device is fu...
Definition: libusb.h:729
uint16_t wTotalLength
Total length of data returned for this configuration.
Definition: libusb.h:711
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:708
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:737
uint8_t bmAttributes
Configuration characteristics.
Definition: libusb.h:723
const struct libusb_interface * interface
Array of interfaces supported by this configuration.
Definition: libusb.h:733
A structure representing the Container ID descriptor.
Definition: libusb.h:892
uint8_t ContainerID[16]
128 bit UUID
Definition: libusb.h:910
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:899
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:904
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:894
uint8_t bReserved
Reserved field.
Definition: libusb.h:907
Setup packet for control transfers.
Definition: libusb.h:918
uint8_t bRequest
Request.
Definition: libusb.h:931
uint8_t bmRequestType
Request type.
Definition: libusb.h:924
uint16_t wLength
Number of bytes to transfer.
Definition: libusb.h:941
uint16_t wIndex
Index.
Definition: libusb.h:938
uint16_t wValue
Value.
Definition: libusb.h:934
A structure representing the standard USB device descriptor.
Definition: libusb.h:536
uint8_t bNumConfigurations
Number of possible configurations.
Definition: libusb.h:582
uint8_t iProduct
Index of string descriptor describing product.
Definition: libusb.h:576
uint8_t iSerialNumber
Index of string descriptor containing device serial number.
Definition: libusb.h:579
uint8_t bMaxPacketSize0
Maximum packet size for endpoint 0.
Definition: libusb.h:561
uint8_t bDeviceProtocol
USB-IF protocol code for the device, qualified by the bDeviceClass and bDeviceSubClass values.
Definition: libusb.h:558
uint16_t idProduct
USB-IF product ID.
Definition: libusb.h:567
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:543
uint8_t bDeviceSubClass
USB-IF subclass code for the device, qualified by the bDeviceClass value.
Definition: libusb.h:554
uint8_t bDeviceClass
USB-IF class code for the device.
Definition: libusb.h:550
uint8_t iManufacturer
Index of string descriptor describing manufacturer.
Definition: libusb.h:573
uint16_t idVendor
USB-IF vendor ID.
Definition: libusb.h:564
uint16_t bcdUSB
USB specification release number in binary-coded decimal.
Definition: libusb.h:547
uint16_t bcdDevice
Device release number in binary-coded decimal.
Definition: libusb.h:570
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:538
A structure representing the standard USB endpoint descriptor.
Definition: libusb.h:590
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:630
uint8_t bEndpointAddress
The address of the endpoint described by this descriptor.
Definition: libusb.h:602
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:627
uint8_t bInterval
Interval for polling endpoint for data transfers.
Definition: libusb.h:616
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:597
uint8_t bRefresh
For audio devices only: the rate at which synchronization feedback is provided.
Definition: libusb.h:620
uint8_t bmAttributes
Attributes which apply to the endpoint when it is configured using the bConfigurationValue.
Definition: libusb.h:610
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:592
uint8_t bSynchAddress
For audio devices only: the address if the synch endpoint.
Definition: libusb.h:623
uint16_t wMaxPacketSize
Maximum packet size this endpoint is capable of sending/receiving.
Definition: libusb.h:613
A structure representing the standard USB interface descriptor.
Definition: libusb.h:638
uint8_t bInterfaceSubClass
USB-IF subclass code for this interface, qualified by the bInterfaceClass value.
Definition: libusb.h:662
uint8_t iInterface
Index of string descriptor describing this interface.
Definition: libusb.h:669
uint8_t bInterfaceClass
USB-IF class code for this interface.
Definition: libusb.h:658
uint8_t bAlternateSetting
Value used to select this alternate setting for this interface.
Definition: libusb.h:651
const struct libusb_endpoint_descriptor * endpoint
Array of endpoint descriptors.
Definition: libusb.h:673
uint8_t bNumEndpoints
Number of endpoints used by this interface (excluding the control endpoint).
Definition: libusb.h:655
uint8_t bInterfaceProtocol
USB-IF protocol code for this interface, qualified by the bInterfaceClass and bInterfaceSubClass valu...
Definition: libusb.h:666
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:640
uint8_t bInterfaceNumber
Number of this interface.
Definition: libusb.h:648
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:677
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:680
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:645
A collection of alternate settings for a particular USB interface.
Definition: libusb.h:686
const struct libusb_interface_descriptor * altsetting
Array of interface descriptors.
Definition: libusb.h:689
int num_altsetting
The number of alternate settings that belong to this interface.
Definition: libusb.h:693
Isochronous packet descriptor.
Definition: libusb.h:1201
unsigned int actual_length
Amount of data that was actually transferred.
Definition: libusb.h:1206
unsigned int length
Length of data to request in this packet.
Definition: libusb.h:1203
enum libusb_transfer_status status
Status code for this packet.
Definition: libusb.h:1209
File descriptor for polling.
Definition: libusb.h:1905
short events
Event flags to poll for from <poll.h>.
Definition: libusb.h:1913
int fd
Numeric file descriptor.
Definition: libusb.h:1907
A structure representing the superspeed endpoint companion descriptor.
Definition: libusb.h:749
uint16_t wBytesPerInterval
The total number of bytes this EP will transfer every service interval.
Definition: libusb.h:770
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:751
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:756
uint8_t bMaxBurst
The maximum number of packets the endpoint can send or receive as part of a burst.
Definition: libusb.h:760
uint8_t bmAttributes
In bulk EP: bits 4:0 represents the maximum number of streams the EP supports.
Definition: libusb.h:766
A structure representing the SuperSpeed USB Device Capability descriptor This descriptor is documente...
Definition: libusb.h:850
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:862
uint16_t wSpeedSupported
Bitmap encoding of the speed supported by this device when operating in SuperSpeed mode.
Definition: libusb.h:872
uint8_t bFunctionalitySupport
The lowest speed at which all the functionality supported by the device is available to the user.
Definition: libusb.h:878
uint16_t bU2DevExitLat
U2 Device Exit Latency.
Definition: libusb.h:884
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:852
uint8_t bmAttributes
Bitmap encoding of supported device level features.
Definition: libusb.h:868
uint8_t bU1DevExitLat
U1 Device Exit Latency.
Definition: libusb.h:881
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:857
The generic USB transfer structure.
Definition: libusb.h:1231
unsigned char endpoint
Address of the endpoint where this transfer will be sent.
Definition: libusb.h:1239
struct libusb_iso_packet_descriptor iso_packet_desc[ZERO_SIZED_ARRAY]
Isochronous packet descriptors, for isochronous transfers only.
Definition: libusb.h:1289
enum libusb_transfer_status status
The status of the transfer.
Definition: libusb.h:1255
int length
Length of the data buffer.
Definition: libusb.h:1258
libusb_transfer_cb_fn callback
Callback function.
Definition: libusb.h:1267
unsigned char type
Type of the transfer from libusb_transfer_type.
Definition: libusb.h:1242
int actual_length
Actual length of data that was transferred.
Definition: libusb.h:1263
unsigned char * buffer
Data buffer.
Definition: libusb.h:1282
int num_iso_packets
Number of isochronous packets.
Definition: libusb.h:1286
unsigned int timeout
Timeout for this transfer in milliseconds.
Definition: libusb.h:1246
void * user_data
User context data.
Definition: libusb.h:1279
libusb_device_handle * dev_handle
Handle of the device that this transfer will be submitted to.
Definition: libusb.h:1233
uint8_t flags
A bitwise OR combination of libusb_transfer_flags.
Definition: libusb.h:1236
A structure representing the USB 2.0 Extension descriptor This descriptor is documented in section 9....
Definition: libusb.h:824
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:826
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:836
uint32_t bmAttributes
Bitmap encoding of supported device level features.
Definition: libusb.h:842
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:831
Structure providing the version of the libusb runtime.
Definition: libusb.h:958
const uint16_t micro
Library micro version.
Definition: libusb.h:966
const uint16_t major
Library major version.
Definition: libusb.h:960
const char * rc
Library release candidate suffix string, e.g.
Definition: libusb.h:972
const uint16_t minor
Library minor version.
Definition: libusb.h:963
const char * describe
For ABI compatibility only.
Definition: libusb.h:975
const uint16_t nano
Library nano version.
Definition: libusb.h:969