libusb  1.0.25
A cross-platform user library to access USB devices
libusb.h
1 /*
2  * Public libusb header file
3  * Copyright © 2001 Johannes Erdfelt <johannes@erdfelt.com>
4  * Copyright © 2007-2008 Daniel Drake <dsd@gentoo.org>
5  * Copyright © 2012 Pete Batard <pete@akeo.ie>
6  * Copyright © 2012-2018 Nathan Hjelm <hjelmn@cs.unm.edu>
7  * Copyright © 2014-2020 Chris Dickens <christopher.a.dickens@gmail.com>
8  * For more information, please visit: http://libusb.info
9  *
10  * This library is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Lesser General Public
12  * License as published by the Free Software Foundation; either
13  * version 2.1 of the License, or (at your option) any later version.
14  *
15  * This library is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18  * Lesser General Public License for more details.
19  *
20  * You should have received a copy of the GNU Lesser General Public
21  * License along with this library; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
23  */
24 
25 #ifndef LIBUSB_H
26 #define LIBUSB_H
27 
28 #if defined(_MSC_VER)
29 /* on MS environments, the inline keyword is available in C++ only */
30 #if !defined(__cplusplus)
31 #define inline __inline
32 #endif
33 /* ssize_t is also not available */
34 #ifndef _SSIZE_T_DEFINED
35 #define _SSIZE_T_DEFINED
36 #include <basetsd.h>
37 typedef SSIZE_T ssize_t;
38 #endif /* _SSIZE_T_DEFINED */
39 #endif /* _MSC_VER */
40 
41 #include <limits.h>
42 #include <stdint.h>
43 #include <sys/types.h>
44 #if !defined(_MSC_VER)
45 #include <sys/time.h>
46 #endif
47 #include <time.h>
48 
49 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
50 #define ZERO_SIZED_ARRAY /* [] - valid C99 code */
51 #else
52 #define ZERO_SIZED_ARRAY 0 /* [0] - non-standard, but usually working code */
53 #endif /* __STDC_VERSION__ */
54 
55 /* 'interface' might be defined as a macro on Windows, so we need to
56  * undefine it so as not to break the current libusb API, because
57  * libusb_config_descriptor has an 'interface' member
58  * As this can be problematic if you include windows.h after libusb.h
59  * in your sources, we force windows.h to be included first. */
60 #if defined(_WIN32) || defined(__CYGWIN__)
61 #include <windows.h>
62 #if defined(interface)
63 #undef interface
64 #endif
65 #if !defined(__CYGWIN__)
66 #include <winsock.h>
67 #endif
68 #endif /* _WIN32 || __CYGWIN__ */
69 
70 #if defined(__GNUC__) && (__GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5))
71 #define LIBUSB_DEPRECATED_FOR(f) __attribute__ ((deprecated ("Use " #f " instead")))
72 #elif defined(__GNUC__) && (__GNUC__ >= 3)
73 #define LIBUSB_DEPRECATED_FOR(f) __attribute__ ((deprecated))
74 #else
75 #define LIBUSB_DEPRECATED_FOR(f)
76 #endif /* __GNUC__ */
77 
78 #if defined(__GNUC__)
79 #define LIBUSB_PACKED __attribute__ ((packed))
80 #define LIBUSB_NONNULL(...) __attribute__((nonnull(__VA_ARGS__)))
81 #else
82 #define LIBUSB_PACKED
83 #define LIBUSB_NONNULL(...)
84 #endif /* __GNUC__ */
85 
111 /* LIBUSB_CALL must be defined on both definition and declaration of libusb
112  * functions. You'd think that declaration would be enough, but cygwin will
113  * complain about conflicting types unless both are marked this way.
114  * The placement of this macro is important too; it must appear after the
115  * return type, before the function name. See internal documentation for
116  * API_EXPORTED.
117  */
118 #if defined(_WIN32) || defined(__CYGWIN__)
119 #define LIBUSB_CALL WINAPI
120 #else
121 #define LIBUSB_CALL
122 #endif /* _WIN32 || __CYGWIN__ */
123 
144 #define LIBUSB_API_VERSION 0x01000109
145 
146 /* The following is kept for compatibility, but will be deprecated in the future */
147 #define LIBUSBX_API_VERSION LIBUSB_API_VERSION
148 
149 #if defined(__cplusplus)
150 extern "C" {
151 #endif
152 
161 static inline uint16_t libusb_cpu_to_le16(const uint16_t x)
162 {
163  union {
164  uint8_t b8[2];
165  uint16_t b16;
166  } _tmp;
167  _tmp.b8[1] = (uint8_t) (x >> 8);
168  _tmp.b8[0] = (uint8_t) (x & 0xff);
169  return _tmp.b16;
170 }
171 
180 #define libusb_le16_to_cpu libusb_cpu_to_le16
181 
182 /* standard USB stuff */
183 
192 
195 
198 
201 
204 
207  LIBUSB_CLASS_PTP = 0x06, /* legacy name from libusb-0.1 usb.h */
208 
211 
214 
217 
220 
223 
226 
229 
232 
235 
238 
241 
244 
247 };
248 
254 
257 
260 
263 
266 
269 
272 
275 
278 
281 
284 
287 
290 };
291 
292 /* Descriptor sizes per descriptor type */
293 #define LIBUSB_DT_DEVICE_SIZE 18
294 #define LIBUSB_DT_CONFIG_SIZE 9
295 #define LIBUSB_DT_INTERFACE_SIZE 9
296 #define LIBUSB_DT_ENDPOINT_SIZE 7
297 #define LIBUSB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
298 #define LIBUSB_DT_HUB_NONVAR_SIZE 7
299 #define LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE 6
300 #define LIBUSB_DT_BOS_SIZE 5
301 #define LIBUSB_DT_DEVICE_CAPABILITY_SIZE 3
302 
303 /* BOS descriptor sizes */
304 #define LIBUSB_BT_USB_2_0_EXTENSION_SIZE 7
305 #define LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE 10
306 #define LIBUSB_BT_CONTAINER_ID_SIZE 20
307 
308 /* We unwrap the BOS => define its max size */
309 #define LIBUSB_DT_BOS_MAX_SIZE \
310  (LIBUSB_DT_BOS_SIZE + \
311  LIBUSB_BT_USB_2_0_EXTENSION_SIZE + \
312  LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE + \
313  LIBUSB_BT_CONTAINER_ID_SIZE)
314 
315 #define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f /* in bEndpointAddress */
316 #define LIBUSB_ENDPOINT_DIR_MASK 0x80
317 
325 
327  LIBUSB_ENDPOINT_IN = 0x80
328 };
329 
330 #define LIBUSB_TRANSFER_TYPE_MASK 0x03 /* in bmAttributes */
331 
339 
342 
345 
348 };
349 
355 
358 
359  /* 0x02 is reserved */
360 
363 
364  /* 0x04 is reserved */
365 
368 
371 
374 
377 
380 
383 
386 
389 
392 
396 };
397 
405 
408 
411 
413  LIBUSB_REQUEST_TYPE_RESERVED = (0x03 << 5)
414 };
415 
423 
426 
429 
432 };
433 
434 #define LIBUSB_ISO_SYNC_TYPE_MASK 0x0c
435 
444 
447 
450 
453 };
454 
455 #define LIBUSB_ISO_USAGE_TYPE_MASK 0x30
456 
465 
468 
471 };
472 
480 
483 
486 
489 };
490 
498  LIBUSB_BM_LPM_SUPPORT = (1 << 1)
499 };
500 
508  LIBUSB_BM_LTM_SUPPORT = (1 << 1)
509 };
510 
517 
520 
523 
526 };
527 
535  uint8_t bLength;
536 
541 
544  uint16_t bcdUSB;
545 
547  uint8_t bDeviceClass;
548 
552 
556 
559 
561  uint16_t idVendor;
562 
564  uint16_t idProduct;
565 
567  uint16_t bcdDevice;
568 
570  uint8_t iManufacturer;
571 
573  uint8_t iProduct;
574 
576  uint8_t iSerialNumber;
577 
580 };
581 
589  uint8_t bLength;
590 
595 
600 
607  uint8_t bmAttributes;
608 
610  uint16_t wMaxPacketSize;
611 
613  uint8_t bInterval;
614 
617  uint8_t bRefresh;
618 
620  uint8_t bSynchAddress;
621 
624  const unsigned char *extra;
625 
628 };
629 
637  uint8_t bLength;
638 
643 
646 
649 
652  uint8_t bNumEndpoints;
653 
656 
660 
664 
666  uint8_t iInterface;
667 
671 
674  const unsigned char *extra;
675 
678 };
679 
687 
691 };
692 
700  uint8_t bLength;
701 
706 
708  uint16_t wTotalLength;
709 
711  uint8_t bNumInterfaces;
712 
715 
717  uint8_t iConfiguration;
718 
720  uint8_t bmAttributes;
721 
726  uint8_t MaxPower;
727 
731 
734  const unsigned char *extra;
735 
738 };
739 
748  uint8_t bLength;
749 
754 
757  uint8_t bMaxBurst;
758 
763  uint8_t bmAttributes;
764 
768 };
769 
777  uint8_t bLength;
778 
783 
786 
788  uint8_t dev_capability_data[ZERO_SIZED_ARRAY];
789 };
790 
798  uint8_t bLength;
799 
804 
806  uint16_t wTotalLength;
807 
810  uint8_t bNumDeviceCaps;
811 
814 };
815 
823  uint8_t bLength;
824 
829 
834 
839  uint32_t bmAttributes;
840 };
841 
849  uint8_t bLength;
850 
855 
860 
865  uint8_t bmAttributes;
866 
869  uint16_t wSpeedSupported;
870 
876 
878  uint8_t bU1DevExitLat;
879 
881  uint16_t bU2DevExitLat;
882 };
883 
891  uint8_t bLength;
892 
897 
902 
904  uint8_t bReserved;
905 
907  uint8_t ContainerID[16];
908 };
909 
912 #if defined(_MSC_VER) || defined(__WATCOMC__)
913 #pragma pack(push, 1)
914 #endif
921  uint8_t bmRequestType;
922 
928  uint8_t bRequest;
929 
931  uint16_t wValue;
932 
935  uint16_t wIndex;
936 
938  uint16_t wLength;
939 } LIBUSB_PACKED;
940 #if defined(_MSC_VER) || defined(__WATCOMC__)
941 #pragma pack(pop)
942 #endif
943 
944 #define LIBUSB_CONTROL_SETUP_SIZE (sizeof(struct libusb_control_setup))
945 
946 /* libusb */
947 
948 struct libusb_context;
949 struct libusb_device;
950 struct libusb_device_handle;
951 
957  const uint16_t major;
958 
960  const uint16_t minor;
961 
963  const uint16_t micro;
964 
966  const uint16_t nano;
967 
969  const char *rc;
970 
972  const char *describe;
973 };
974 
993 typedef struct libusb_context libusb_context;
994 
1010 typedef struct libusb_device libusb_device;
1011 
1012 
1022 
1029 
1032 
1035 
1038 
1041 
1044 };
1045 
1056 
1059 
1062 
1065 
1068 
1071 
1074 
1077 
1080 
1083 
1086 
1089 
1092 
1093  /* NB: Remember to update LIBUSB_ERROR_COUNT below as well as the
1094  message strings in strerror.c when adding new error codes here. */
1095 
1097  LIBUSB_ERROR_OTHER = -99
1098 };
1099 
1100 /* Total number of error codes in enum libusb_error */
1101 #define LIBUSB_ERROR_COUNT 14
1102 
1108 
1111 
1114 
1117 
1120 };
1121 
1128 
1131 
1134 
1137 
1141 
1144 
1147 
1148  /* NB! Remember to update libusb_error_name()
1149  when adding new status codes here. */
1150 };
1151 
1157 
1163 
1169 
1194 };
1195 
1200  unsigned int length;
1201 
1203  unsigned int actual_length;
1204 
1207 };
1208 
1209 struct libusb_transfer;
1210 
1220 typedef void (LIBUSB_CALL *libusb_transfer_cb_fn)(struct libusb_transfer *transfer);
1221 
1231 
1233  uint8_t flags;
1234 
1236  unsigned char endpoint;
1237 
1239  unsigned char type;
1240 
1243  unsigned int timeout;
1244 
1253 
1255  int length;
1256 
1261 
1265 
1276  void *user_data;
1277 
1279  unsigned char *buffer;
1280 
1284 
1286  struct libusb_iso_packet_descriptor iso_packet_desc[ZERO_SIZED_ARRAY];
1287 };
1288 
1297 
1300 
1306 
1310 };
1311 
1318 
1321 
1324 
1327 
1330 };
1331 
1342 
1344  LIBUSB_LOG_CB_CONTEXT = (1 << 1)
1345 };
1346 
1359  enum libusb_log_level level, const char *str);
1360 
1363 LIBUSB_DEPRECATED_FOR(libusb_set_option)
1364 void LIBUSB_CALL libusb_set_debug(libusb_context *ctx, int level);
1366 const struct libusb_version * LIBUSB_CALL libusb_get_version(void);
1367 int LIBUSB_CALL libusb_has_capability(uint32_t capability);
1368 const char * LIBUSB_CALL libusb_error_name(int errcode);
1369 int LIBUSB_CALL libusb_setlocale(const char *locale);
1370 const char * LIBUSB_CALL libusb_strerror(int errcode);
1371 
1373  libusb_device ***list);
1375  int unref_devices);
1378 
1380  int *config);
1382  struct libusb_device_descriptor *desc);
1384  struct libusb_config_descriptor **config);
1386  uint8_t config_index, struct libusb_config_descriptor **config);
1388  uint8_t bConfigurationValue, struct libusb_config_descriptor **config);
1390  struct libusb_config_descriptor *config);
1392  libusb_context *ctx,
1393  const struct libusb_endpoint_descriptor *endpoint,
1394  struct libusb_ss_endpoint_companion_descriptor **ep_comp);
1396  struct libusb_ss_endpoint_companion_descriptor *ep_comp);
1398  struct libusb_bos_descriptor **bos);
1401  libusb_context *ctx,
1402  struct libusb_bos_dev_capability_descriptor *dev_cap,
1403  struct libusb_usb_2_0_extension_descriptor **usb_2_0_extension);
1405  struct libusb_usb_2_0_extension_descriptor *usb_2_0_extension);
1407  libusb_context *ctx,
1408  struct libusb_bos_dev_capability_descriptor *dev_cap,
1409  struct libusb_ss_usb_device_capability_descriptor **ss_usb_device_cap);
1411  struct libusb_ss_usb_device_capability_descriptor *ss_usb_device_cap);
1413  struct libusb_bos_dev_capability_descriptor *dev_cap,
1414  struct libusb_container_id_descriptor **container_id);
1416  struct libusb_container_id_descriptor *container_id);
1419 int LIBUSB_CALL libusb_get_port_numbers(libusb_device *dev, uint8_t *port_numbers, int port_numbers_len);
1420 LIBUSB_DEPRECATED_FOR(libusb_get_port_numbers)
1421 int LIBUSB_CALL libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *path, uint8_t path_length);
1426  unsigned char endpoint);
1428  unsigned char endpoint);
1429 
1430 int LIBUSB_CALL libusb_wrap_sys_device(libusb_context *ctx, intptr_t sys_dev, libusb_device_handle **dev_handle);
1434 
1436  int configuration);
1438  int interface_number);
1440  int interface_number);
1441 
1443  libusb_context *ctx, uint16_t vendor_id, uint16_t product_id);
1444 
1446  int interface_number, int alternate_setting);
1448  unsigned char endpoint);
1450 
1452  uint32_t num_streams, unsigned char *endpoints, int num_endpoints);
1454  unsigned char *endpoints, int num_endpoints);
1455 
1456 unsigned char * LIBUSB_CALL libusb_dev_mem_alloc(libusb_device_handle *dev_handle,
1457  size_t length);
1459  unsigned char *buffer, size_t length);
1460 
1462  int interface_number);
1464  int interface_number);
1466  int interface_number);
1468  libusb_device_handle *dev_handle, int enable);
1469 
1470 /* async I/O */
1471 
1484 LIBUSB_NONNULL(1)
1485 static inline unsigned char *libusb_control_transfer_get_data(
1486  struct libusb_transfer *transfer)
1487 {
1488  return transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
1489 }
1490 
1503 LIBUSB_NONNULL(1)
1505  struct libusb_transfer *transfer)
1506 {
1507  return (struct libusb_control_setup *)(void *)transfer->buffer;
1508 }
1509 
1533 LIBUSB_NONNULL(1)
1534 static inline void libusb_fill_control_setup(unsigned char *buffer,
1535  uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
1536  uint16_t wLength)
1537 {
1538  struct libusb_control_setup *setup = (struct libusb_control_setup *)(void *)buffer;
1539  setup->bmRequestType = bmRequestType;
1540  setup->bRequest = bRequest;
1541  setup->wValue = libusb_cpu_to_le16(wValue);
1542  setup->wIndex = libusb_cpu_to_le16(wIndex);
1544 }
1545 
1546 struct libusb_transfer * LIBUSB_CALL libusb_alloc_transfer(int iso_packets);
1547 int LIBUSB_CALL libusb_submit_transfer(struct libusb_transfer *transfer);
1548 int LIBUSB_CALL libusb_cancel_transfer(struct libusb_transfer *transfer);
1549 void LIBUSB_CALL libusb_free_transfer(struct libusb_transfer *transfer);
1551  struct libusb_transfer *transfer, uint32_t stream_id);
1553  struct libusb_transfer *transfer);
1554 
1583 LIBUSB_NONNULL(1)
1584 static inline void libusb_fill_control_transfer(
1585  struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1586  unsigned char *buffer, libusb_transfer_cb_fn callback, void *user_data,
1587  unsigned int timeout)
1588 {
1589  struct libusb_control_setup *setup = (struct libusb_control_setup *)(void *)buffer;
1590  transfer->dev_handle = dev_handle;
1591  transfer->endpoint = 0;
1592  transfer->type = LIBUSB_TRANSFER_TYPE_CONTROL;
1593  transfer->timeout = timeout;
1594  transfer->buffer = buffer;
1595  if (setup)
1596  transfer->length = (int) (LIBUSB_CONTROL_SETUP_SIZE
1597  + libusb_le16_to_cpu(setup->wLength));
1598  transfer->user_data = user_data;
1599  transfer->callback = callback;
1600 }
1601 
1615 LIBUSB_NONNULL(1)
1616 static inline void libusb_fill_bulk_transfer(struct libusb_transfer *transfer,
1617  libusb_device_handle *dev_handle, unsigned char endpoint,
1618  unsigned char *buffer, int length, libusb_transfer_cb_fn callback,
1619  void *user_data, unsigned int timeout)
1620 {
1621  transfer->dev_handle = dev_handle;
1622  transfer->endpoint = endpoint;
1623  transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1624  transfer->timeout = timeout;
1625  transfer->buffer = buffer;
1626  transfer->length = length;
1627  transfer->user_data = user_data;
1628  transfer->callback = callback;
1629 }
1630 
1647 LIBUSB_NONNULL(1)
1649  struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1650  unsigned char endpoint, uint32_t stream_id,
1651  unsigned char *buffer, int length, libusb_transfer_cb_fn callback,
1652  void *user_data, unsigned int timeout)
1653 {
1654  libusb_fill_bulk_transfer(transfer, dev_handle, endpoint, buffer,
1655  length, callback, user_data, timeout);
1656  transfer->type = LIBUSB_TRANSFER_TYPE_BULK_STREAM;
1657  libusb_transfer_set_stream_id(transfer, stream_id);
1658 }
1659 
1673 LIBUSB_NONNULL(1)
1675  struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1676  unsigned char endpoint, unsigned char *buffer, int length,
1677  libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
1678 {
1679  transfer->dev_handle = dev_handle;
1680  transfer->endpoint = endpoint;
1681  transfer->type = LIBUSB_TRANSFER_TYPE_INTERRUPT;
1682  transfer->timeout = timeout;
1683  transfer->buffer = buffer;
1684  transfer->length = length;
1685  transfer->user_data = user_data;
1686  transfer->callback = callback;
1687 }
1688 
1703 LIBUSB_NONNULL(1)
1704 static inline void libusb_fill_iso_transfer(struct libusb_transfer *transfer,
1705  libusb_device_handle *dev_handle, unsigned char endpoint,
1706  unsigned char *buffer, int length, int num_iso_packets,
1707  libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
1708 {
1709  transfer->dev_handle = dev_handle;
1710  transfer->endpoint = endpoint;
1711  transfer->type = LIBUSB_TRANSFER_TYPE_ISOCHRONOUS;
1712  transfer->timeout = timeout;
1713  transfer->buffer = buffer;
1714  transfer->length = length;
1715  transfer->num_iso_packets = num_iso_packets;
1716  transfer->user_data = user_data;
1717  transfer->callback = callback;
1718 }
1719 
1728 LIBUSB_NONNULL(1)
1730  struct libusb_transfer *transfer, unsigned int length)
1731 {
1732  int i;
1733 
1734  for (i = 0; i < transfer->num_iso_packets; i++)
1735  transfer->iso_packet_desc[i].length = length;
1736 }
1737 
1754 LIBUSB_NONNULL(1)
1755 static inline unsigned char *libusb_get_iso_packet_buffer(
1756  struct libusb_transfer *transfer, unsigned int packet)
1757 {
1758  int i;
1759  size_t offset = 0;
1760  int _packet;
1761 
1762  /* oops..slight bug in the API. packet is an unsigned int, but we use
1763  * signed integers almost everywhere else. range-check and convert to
1764  * signed to avoid compiler warnings. FIXME for libusb-2. */
1765  if (packet > INT_MAX)
1766  return NULL;
1767  _packet = (int) packet;
1768 
1769  if (_packet >= transfer->num_iso_packets)
1770  return NULL;
1771 
1772  for (i = 0; i < _packet; i++)
1773  offset += transfer->iso_packet_desc[i].length;
1774 
1775  return transfer->buffer + offset;
1776 }
1777 
1797 LIBUSB_NONNULL(1)
1798 static inline unsigned char *libusb_get_iso_packet_buffer_simple(
1799  struct libusb_transfer *transfer, unsigned int packet)
1800 {
1801  int _packet;
1802 
1803  /* oops..slight bug in the API. packet is an unsigned int, but we use
1804  * signed integers almost everywhere else. range-check and convert to
1805  * signed to avoid compiler warnings. FIXME for libusb-2. */
1806  if (packet > INT_MAX)
1807  return NULL;
1808  _packet = (int) packet;
1809 
1810  if (_packet >= transfer->num_iso_packets)
1811  return NULL;
1812 
1813  return transfer->buffer + ((int) transfer->iso_packet_desc[0].length * _packet);
1814 }
1815 
1816 /* sync I/O */
1817 
1819  uint8_t request_type, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
1820  unsigned char *data, uint16_t wLength, unsigned int timeout);
1821 
1823  unsigned char endpoint, unsigned char *data, int length,
1824  int *actual_length, unsigned int timeout);
1825 
1827  unsigned char endpoint, unsigned char *data, int length,
1828  int *actual_length, unsigned int timeout);
1829 
1842 static inline int libusb_get_descriptor(libusb_device_handle *dev_handle,
1843  uint8_t desc_type, uint8_t desc_index, unsigned char *data, int length)
1844 {
1845  return libusb_control_transfer(dev_handle, LIBUSB_ENDPOINT_IN,
1846  LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t) ((desc_type << 8) | desc_index),
1847  0, data, (uint16_t) length, 1000);
1848 }
1849 
1865  uint8_t desc_index, uint16_t langid, unsigned char *data, int length)
1866 {
1867  return libusb_control_transfer(dev_handle, LIBUSB_ENDPOINT_IN,
1868  LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t)((LIBUSB_DT_STRING << 8) | desc_index),
1869  langid, data, (uint16_t) length, 1000);
1870 }
1871 
1873  uint8_t desc_index, unsigned char *data, int length);
1874 
1875 /* polling and timeouts */
1876 
1885 int LIBUSB_CALL libusb_wait_for_event(libusb_context *ctx, struct timeval *tv);
1886 
1888  struct timeval *tv);
1890  struct timeval *tv, int *completed);
1894  struct timeval *tv);
1897  struct timeval *tv);
1898 
1904  int fd;
1905 
1910  short events;
1911 };
1912 
1923 typedef void (LIBUSB_CALL *libusb_pollfd_added_cb)(int fd, short events,
1924  void *user_data);
1925 
1935 typedef void (LIBUSB_CALL *libusb_pollfd_removed_cb)(int fd, void *user_data);
1936 
1938  libusb_context *ctx);
1939 void LIBUSB_CALL libusb_free_pollfds(const struct libusb_pollfd **pollfds);
1941  libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb,
1942  void *user_data);
1943 
1957 
1963 typedef enum {
1966 
1972 
1978 typedef enum {
1980  LIBUSB_HOTPLUG_ENUMERATE = (1 << 0)
1982 
1985 #define LIBUSB_HOTPLUG_NO_FLAGS 0
1986 
1989 #define LIBUSB_HOTPLUG_MATCH_ANY -1
1990 
2014  libusb_device *device, libusb_hotplug_event event, void *user_data);
2015 
2052  int events, int flags,
2053  int vendor_id, int product_id, int dev_class,
2054  libusb_hotplug_callback_fn cb_fn, void *user_data,
2055  libusb_hotplug_callback_handle *callback_handle);
2056 
2069  libusb_hotplug_callback_handle callback_handle);
2070 
2080  libusb_hotplug_callback_handle callback_handle);
2081 
2108 
2117 
2136 
2137 #define LIBUSB_OPTION_WEAK_AUTHORITY LIBUSB_OPTION_NO_DEVICE_DISCOVERY
2138 
2139  LIBUSB_OPTION_MAX = 3
2140 };
2141 
2142 int LIBUSB_CALL libusb_set_option(libusb_context *ctx, enum libusb_option option, ...);
2143 
2144 #if defined(__cplusplus)
2145 }
2146 #endif
2147 
2148 #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:1154
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:1704
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:1584
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:1798
unsigned char * libusb_dev_mem_alloc(libusb_device_handle *dev_handle, size_t length)
Attempts to allocate a block of persistent DMA memory suitable for transfers against the given device...
Definition: core.c:1929
static void libusb_fill_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:1534
uint32_t libusb_transfer_get_stream_id(struct libusb_transfer *transfer)
Get a transfers bulk stream id.
Definition: io.c:1642
int libusb_cancel_transfer(struct libusb_transfer *transfer)
Asynchronously cancel a previously submitted transfer.
Definition: io.c:1581
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:1504
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:1755
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:1674
libusb_transfer_status
Transfer status codes.
Definition: libusb.h:1124
int libusb_free_streams(libusb_device_handle *dev_handle, unsigned char *endpoints, int num_endpoints)
Free usb bulk streams allocated with libusb_alloc_streams().
Definition: core.c:1886
int libusb_submit_transfer(struct libusb_transfer *transfer)
Submit a transfer.
Definition: io.c:1490
static void libusb_fill_bulk_stream_transfer(struct libusb_transfer *transfer, libusb_device_handle *dev_handle, unsigned char endpoint, uint32_t stream_id, unsigned char *buffer, int length, libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
Helper function to populate the required libusb_transfer fields for a bulk transfer using bulk stream...
Definition: libusb.h:1648
void(* libusb_transfer_cb_fn)(struct libusb_transfer *transfer)
Asynchronous transfer callback function type.
Definition: libusb.h:1220
libusb_transfer_type
Transfer type.
Definition: libusb.h:1105
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:1729
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:1616
int libusb_dev_mem_free(libusb_device_handle *dev_handle, unsigned char *buffer, size_t length)
Free device memory allocated with libusb_dev_mem_alloc().
Definition: core.c:1949
int libusb_alloc_streams(libusb_device_handle *dev_handle, uint32_t num_streams, unsigned char *endpoints, int num_endpoints)
Allocate up to num_streams usb bulk streams on the specified endpoints.
Definition: core.c:1856
static unsigned char * libusb_control_transfer_get_data(struct libusb_transfer *transfer)
Get the data section of a control transfer.
Definition: libusb.h:1485
void libusb_transfer_set_stream_id(struct libusb_transfer *transfer, uint32_t stream_id)
Set a transfers bulk stream id.
Definition: io.c:1625
@ 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:1193
@ LIBUSB_TRANSFER_FREE_TRANSFER
Automatically call libusb_free_transfer() after callback returns.
Definition: libusb.h:1168
@ LIBUSB_TRANSFER_SHORT_NOT_OK
Report short frames as errors.
Definition: libusb.h:1156
@ LIBUSB_TRANSFER_FREE_BUFFER
Automatically free() transfer buffer during libusb_free_transfer().
Definition: libusb.h:1162
@ LIBUSB_TRANSFER_STALL
For bulk/interrupt endpoints: halt condition detected (endpoint stalled).
Definition: libusb.h:1140
@ LIBUSB_TRANSFER_COMPLETED
Transfer completed without error.
Definition: libusb.h:1127
@ LIBUSB_TRANSFER_CANCELLED
Transfer was cancelled.
Definition: libusb.h:1136
@ LIBUSB_TRANSFER_ERROR
Transfer failed.
Definition: libusb.h:1130
@ LIBUSB_TRANSFER_OVERFLOW
Device sent more data than requested.
Definition: libusb.h:1146
@ LIBUSB_TRANSFER_NO_DEVICE
Device was disconnected.
Definition: libusb.h:1143
@ LIBUSB_TRANSFER_TIMED_OUT
Transfer timed out.
Definition: libusb.h:1133
@ LIBUSB_TRANSFER_TYPE_BULK_STREAM
Bulk stream transfer.
Definition: libusb.h:1119
@ LIBUSB_TRANSFER_TYPE_ISOCHRONOUS
Isochronous transfer.
Definition: libusb.h:1110
@ LIBUSB_TRANSFER_TYPE_CONTROL
Control transfer.
Definition: libusb.h:1107
@ LIBUSB_TRANSFER_TYPE_BULK
Bulk transfer.
Definition: libusb.h:1113
@ LIBUSB_TRANSFER_TYPE_INTERRUPT
Interrupt transfer.
Definition: libusb.h:1116
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:1864
libusb_descriptor_type
Descriptor types as defined by the USB specification.
Definition: libusb.h:251
libusb_supported_speed
Supported speeds (wSpeedSupported) bitfield.
Definition: libusb.h:477
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:514
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:322
libusb_endpoint_transfer_type
Endpoint transfer type.
Definition: libusb.h:336
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:1842
libusb_iso_sync_type
Synchronization type for isochronous endpoints.
Definition: libusb.h:441
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:506
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:462
libusb_class_code
Device and/or Interface Class codes.
Definition: libusb.h:186
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:496
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:283
@ LIBUSB_DT_CONFIG
Configuration descriptor.
Definition: libusb.h:256
@ LIBUSB_DT_STRING
String descriptor.
Definition: libusb.h:259
@ LIBUSB_DT_HID
HID descriptor.
Definition: libusb.h:274
@ LIBUSB_DT_REPORT
HID report descriptor.
Definition: libusb.h:277
@ LIBUSB_DT_DEVICE
Device descriptor.
Definition: libusb.h:253
@ LIBUSB_DT_DEVICE_CAPABILITY
Device Capability descriptor.
Definition: libusb.h:271
@ LIBUSB_DT_SUPERSPEED_HUB
SuperSpeed Hub descriptor.
Definition: libusb.h:286
@ LIBUSB_DT_PHYSICAL
Physical descriptor.
Definition: libusb.h:280
@ LIBUSB_DT_INTERFACE
Interface descriptor.
Definition: libusb.h:262
@ LIBUSB_DT_ENDPOINT
Endpoint descriptor.
Definition: libusb.h:265
@ LIBUSB_DT_SS_ENDPOINT_COMPANION
SuperSpeed Endpoint Companion descriptor.
Definition: libusb.h:289
@ LIBUSB_DT_BOS
BOS descriptor.
Definition: libusb.h:268
@ LIBUSB_HIGH_SPEED_OPERATION
High speed operation supported (480MBit/s).
Definition: libusb.h:485
@ LIBUSB_LOW_SPEED_OPERATION
Low speed operation supported (1.5MBit/s).
Definition: libusb.h:479
@ LIBUSB_SUPER_SPEED_OPERATION
Superspeed operation supported (5000MBit/s).
Definition: libusb.h:488
@ LIBUSB_FULL_SPEED_OPERATION
Full speed operation supported (12MBit/s).
Definition: libusb.h:482
@ LIBUSB_BT_USB_2_0_EXTENSION
USB 2.0 extensions.
Definition: libusb.h:519
@ LIBUSB_BT_SS_USB_DEVICE_CAPABILITY
SuperSpeed USB device capability.
Definition: libusb.h:522
@ LIBUSB_BT_WIRELESS_USB_DEVICE_CAPABILITY
Wireless USB device capability.
Definition: libusb.h:516
@ LIBUSB_BT_CONTAINER_ID
Container ID type.
Definition: libusb.h:525
@ LIBUSB_ENDPOINT_IN
In: device-to-host.
Definition: libusb.h:327
@ LIBUSB_ENDPOINT_OUT
Out: host-to-device.
Definition: libusb.h:324
@ LIBUSB_ENDPOINT_TRANSFER_TYPE_INTERRUPT
Interrupt endpoint.
Definition: libusb.h:347
@ LIBUSB_ENDPOINT_TRANSFER_TYPE_ISOCHRONOUS
Isochronous endpoint.
Definition: libusb.h:341
@ LIBUSB_ENDPOINT_TRANSFER_TYPE_BULK
Bulk endpoint.
Definition: libusb.h:344
@ LIBUSB_ENDPOINT_TRANSFER_TYPE_CONTROL
Control endpoint.
Definition: libusb.h:338
@ LIBUSB_ISO_SYNC_TYPE_SYNC
Synchronous.
Definition: libusb.h:452
@ LIBUSB_ISO_SYNC_TYPE_NONE
No synchronization.
Definition: libusb.h:443
@ LIBUSB_ISO_SYNC_TYPE_ADAPTIVE
Adaptive.
Definition: libusb.h:449
@ LIBUSB_ISO_SYNC_TYPE_ASYNC
Asynchronous.
Definition: libusb.h:446
@ LIBUSB_BM_LTM_SUPPORT
Supports Latency Tolerance Messages (LTM)
Definition: libusb.h:508
@ LIBUSB_ISO_USAGE_TYPE_DATA
Data endpoint.
Definition: libusb.h:464
@ LIBUSB_ISO_USAGE_TYPE_FEEDBACK
Feedback endpoint.
Definition: libusb.h:467
@ LIBUSB_ISO_USAGE_TYPE_IMPLICIT
Implicit feedback Data endpoint.
Definition: libusb.h:470
@ LIBUSB_CLASS_AUDIO
Audio class.
Definition: libusb.h:194
@ LIBUSB_CLASS_HUB
Hub class.
Definition: libusb.h:216
@ LIBUSB_CLASS_MISCELLANEOUS
Miscellaneous class.
Definition: libusb.h:240
@ LIBUSB_CLASS_APPLICATION
Application class.
Definition: libusb.h:243
@ LIBUSB_CLASS_CONTENT_SECURITY
Content Security.
Definition: libusb.h:225
@ LIBUSB_CLASS_DIAGNOSTIC_DEVICE
Diagnostic Device.
Definition: libusb.h:234
@ LIBUSB_CLASS_PHYSICAL
Physical.
Definition: libusb.h:203
@ LIBUSB_CLASS_COMM
Communications class.
Definition: libusb.h:197
@ LIBUSB_CLASS_VIDEO
Video.
Definition: libusb.h:228
@ LIBUSB_CLASS_DATA
Data class.
Definition: libusb.h:219
@ LIBUSB_CLASS_WIRELESS
Wireless class.
Definition: libusb.h:237
@ LIBUSB_CLASS_PRINTER
Printer class.
Definition: libusb.h:210
@ LIBUSB_CLASS_PERSONAL_HEALTHCARE
Personal Healthcare.
Definition: libusb.h:231
@ LIBUSB_CLASS_PER_INTERFACE
In the context of a device descriptor, this bDeviceClass value indicates that each interface specifie...
Definition: libusb.h:191
@ LIBUSB_CLASS_MASS_STORAGE
Mass storage class.
Definition: libusb.h:213
@ LIBUSB_CLASS_HID
Human Interface Device class.
Definition: libusb.h:200
@ LIBUSB_CLASS_VENDOR_SPEC
Class is vendor-specific.
Definition: libusb.h:246
@ LIBUSB_CLASS_IMAGE
Image class.
Definition: libusb.h:206
@ LIBUSB_CLASS_SMART_CARD
Smart Card.
Definition: libusb.h:222
@ LIBUSB_BM_LPM_SUPPORT
Supports Link Power Management (LPM)
Definition: libusb.h:498
libusb_device_handle * libusb_open_device_with_vid_pid(libusb_context *ctx, uint16_t vendor_id, uint16_t product_id)
Convenience function for finding a device with a particular idVendor/idProduct combination.
Definition: core.c:1352
uint8_t libusb_get_port_number(libusb_device *dev)
Get the number of the port that a device is connected to.
Definition: core.c:925
int libusb_kernel_driver_active(libusb_device_handle *dev_handle, int interface_number)
Determine if a kernel driver is active on an interface.
Definition: core.c:1975
libusb_speed
Speed codes.
Definition: libusb.h:1026
void libusb_unref_device(libusb_device *dev)
Decrement the reference count of a device.
Definition: core.c:1179
int libusb_open(libusb_device *dev, libusb_device_handle **dev_handle)
Open a device and obtain a device handle.
Definition: core.c:1297
int libusb_set_interface_alt_setting(libusb_device_handle *dev_handle, int interface_number, int alternate_setting)
Activate an alternate setting for an interface.
Definition: core.c:1752
int libusb_release_interface(libusb_device_handle *dev_handle, int interface_number)
Release an interface previously claimed with libusb_claim_interface().
Definition: core.c:1707
int libusb_get_device_speed(libusb_device *dev)
Get the negotiated connection speed for a device.
Definition: core.c:1008
int libusb_detach_kernel_driver(libusb_device_handle *dev_handle, int interface_number)
Detach a kernel driver from an interface.
Definition: core.c:2013
void libusb_close(libusb_device_handle *dev_handle)
Close a device handle.
Definition: core.c:1452
struct libusb_device libusb_device
Structure representing a USB device detected on the system.
Definition: libusb.h:1010
int libusb_set_configuration(libusb_device_handle *dev_handle, int configuration)
Set the active configuration for a device.
Definition: core.c:1626
struct libusb_device_handle libusb_device_handle
Structure representing a handle on a USB device.
Definition: libusb.h:1021
libusb_device * libusb_get_parent(libusb_device *dev)
Get the the parent from the specified device.
Definition: core.c:987
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:1241
int libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *path, uint8_t path_length)
Definition: core.c:967
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:941
libusb_device * libusb_ref_device(libusb_device *dev)
Increment the reference count of a device.
Definition: core.c:1164
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:997
int libusb_clear_halt(libusb_device_handle *dev_handle, unsigned char endpoint)
Clear the halt/stall condition for an endpoint.
Definition: core.c:1794
ssize_t libusb_get_device_list(libusb_context *ctx, libusb_device ***list)
Returns a list of USB devices currently attached to the system.
Definition: core.c:815
int libusb_set_auto_detach_kernel_driver(libusb_device_handle *dev_handle, int enable)
Enable/disable libusb's automatic kernel driver detachment.
Definition: core.c:2088
int libusb_get_max_packet_size(libusb_device *dev, unsigned char endpoint)
Convenience function to retrieve the wMaxPacketSize value for a particular endpoint in the active dev...
Definition: core.c:1054
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:885
int libusb_attach_kernel_driver(libusb_device_handle *dev_handle, int interface_number)
Re-attach an interface's kernel driver, which was previously detached using libusb_detach_kernel_driv...
Definition: core.c:2049
int libusb_get_configuration(libusb_device_handle *dev, int *config)
Determine the bConfigurationValue of the currently active configuration.
Definition: core.c:1539
int libusb_get_max_iso_packet_size(libusb_device *dev, unsigned char endpoint)
Calculate the maximum packet size which a specific endpoint is capable is sending or receiving in the...
Definition: core.c:1109
int libusb_claim_interface(libusb_device_handle *dev_handle, int interface_number)
Claim an interface on a given device handle.
Definition: core.c:1663
uint8_t libusb_get_bus_number(libusb_device *dev)
Get the number of the bus that a device is connected to.
Definition: core.c:906
libusb_device * libusb_get_device(libusb_device_handle *dev_handle)
Get the underlying device for a device handle.
Definition: core.c:1514
int libusb_reset_device(libusb_device_handle *dev_handle)
Perform a USB port reset to reinitialize a device.
Definition: core.c:1823
@ LIBUSB_SPEED_FULL
The device is operating at full speed (12MBit/s).
Definition: libusb.h:1034
@ LIBUSB_SPEED_HIGH
The device is operating at high speed (480MBit/s).
Definition: libusb.h:1037
@ LIBUSB_SPEED_LOW
The device is operating at low speed (1.5MBit/s).
Definition: libusb.h:1031
@ LIBUSB_SPEED_SUPER_PLUS
The device is operating at super speed plus (10000MBit/s).
Definition: libusb.h:1043
@ LIBUSB_SPEED_SUPER
The device is operating at super speed (5000MBit/s).
Definition: libusb.h:1040
@ LIBUSB_SPEED_UNKNOWN
The OS doesn't report or know the device speed.
Definition: libusb.h:1028
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:2013
int libusb_hotplug_callback_handle
Callback handle.
Definition: libusb.h:1956
libusb_hotplug_event
Since version 1.0.16, LIBUSB_API_VERSION >= 0x01000102.
Definition: libusb.h:1963
int libusb_hotplug_register_callback(libusb_context *ctx, int events, int flags, int vendor_id, int product_id, int dev_class, libusb_hotplug_callback_fn cb_fn, void *user_data, libusb_hotplug_callback_handle *callback_handle)
Register a hotplug callback function.
Definition: hotplug.c:320
void libusb_hotplug_deregister_callback(libusb_context *ctx, libusb_hotplug_callback_handle callback_handle)
Deregisters a hotplug callback.
Definition: hotplug.c:404
libusb_hotplug_flag
Since version 1.0.16, LIBUSB_API_VERSION >= 0x01000102.
Definition: libusb.h:1978
void * libusb_hotplug_get_user_data(libusb_context *ctx, libusb_hotplug_callback_handle callback_handle)
Gets the user_data associated with a hotplug callback.
Definition: hotplug.c:442
@ LIBUSB_HOTPLUG_EVENT_DEVICE_ARRIVED
A device has been plugged in and is ready to use.
Definition: libusb.h:1965
@ LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT
A device has left and is no longer available.
Definition: libusb.h:1970
@ LIBUSB_HOTPLUG_ENUMERATE
Arm the callback and fire it for all matching currently attached devices.
Definition: libusb.h:1980
libusb_option
Available option values for libusb_set_option().
Definition: libusb.h:2085
libusb_log_cb_mode
Log callback mode.
Definition: libusb.h:1339
libusb_log_level
Log message levels.
Definition: libusb.h:1315
void libusb_set_log_cb(libusb_context *ctx, libusb_log_cb cb, int mode)
Set log handler.
Definition: core.c:2139
struct libusb_context libusb_context
Structure representing a libusb session.
Definition: libusb.h:993
void libusb_set_debug(libusb_context *ctx, int level)
Definition: core.c:2102
int libusb_init(libusb_context **ctx)
Initialize libusb.
Definition: core.c:2276
void(* libusb_log_cb)(libusb_context *ctx, enum libusb_log_level level, const char *str)
Callback function for handling log messages.
Definition: libusb.h:1358
void libusb_exit(libusb_context *ctx)
Deinitialize libusb.
Definition: core.c:2391
int libusb_set_option(libusb_context *ctx, enum libusb_option option,...)
Set an option in the library.
Definition: core.c:2185
@ LIBUSB_OPTION_NO_DEVICE_DISCOVERY
Do not scan for devices.
Definition: libusb.h:2135
@ LIBUSB_OPTION_LOG_LEVEL
Set the log message verbosity.
Definition: libusb.h:2107
@ LIBUSB_OPTION_USE_USBDK
Use the UsbDk backend for a specific context, if available.
Definition: libusb.h:2116
@ LIBUSB_LOG_CB_GLOBAL
Callback function handling all log messages.
Definition: libusb.h:1341
@ LIBUSB_LOG_CB_CONTEXT
Callback function handling context related log messages.
Definition: libusb.h:1344
@ LIBUSB_LOG_LEVEL_WARNING
(2) : Warning and error messages are emitted
Definition: libusb.h:1323
@ LIBUSB_LOG_LEVEL_INFO
(3) : Informational, warning and error messages are emitted
Definition: libusb.h:1326
@ LIBUSB_LOG_LEVEL_ERROR
(1) : Error messages are emitted
Definition: libusb.h:1320
@ LIBUSB_LOG_LEVEL_NONE
(0) : No messages ever emitted by the library (default)
Definition: libusb.h:1317
@ LIBUSB_LOG_LEVEL_DEBUG
(4) : All messages are emitted
Definition: libusb.h:1329
libusb_request_type
Request type bits of the bmRequestType field in control transfers.
Definition: libusb.h:402
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:420
#define libusb_le16_to_cpu
Convert a 16-bit value from little-endian to host-endian format.
Definition: libusb.h:180
libusb_standard_request
Standard requests, as defined in table 9-5 of the USB 3.0 specifications.
Definition: libusb.h:352
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:2729
int libusb_has_capability(uint32_t capability)
Check at runtime if the loaded library has a given capability.
Definition: core.c:2461
#define LIBUSB_CALL
libusb's Windows calling convention.
Definition: libusb.h:121
libusb_capability
Capabilities supported by an instance of libusb on the current running platform.
Definition: libusb.h:1294
libusb_error
Error codes.
Definition: libusb.h:1053
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:2674
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:161
@ LIBUSB_REQUEST_TYPE_VENDOR
Vendor.
Definition: libusb.h:410
@ LIBUSB_REQUEST_TYPE_STANDARD
Standard.
Definition: libusb.h:404
@ LIBUSB_REQUEST_TYPE_CLASS
Class.
Definition: libusb.h:407
@ LIBUSB_REQUEST_TYPE_RESERVED
Reserved.
Definition: libusb.h:413
@ LIBUSB_RECIPIENT_ENDPOINT
Endpoint.
Definition: libusb.h:428
@ LIBUSB_RECIPIENT_INTERFACE
Interface.
Definition: libusb.h:425
@ LIBUSB_RECIPIENT_OTHER
Other.
Definition: libusb.h:431
@ LIBUSB_RECIPIENT_DEVICE
Device.
Definition: libusb.h:422
@ LIBUSB_REQUEST_CLEAR_FEATURE
Clear or disable a specific feature.
Definition: libusb.h:357
@ LIBUSB_REQUEST_GET_INTERFACE
Return the selected alternate setting for the specified interface.
Definition: libusb.h:382
@ LIBUSB_REQUEST_GET_DESCRIPTOR
Get the specified descriptor.
Definition: libusb.h:370
@ LIBUSB_REQUEST_SET_DESCRIPTOR
Used to update existing descriptors or add new descriptors.
Definition: libusb.h:373
@ LIBUSB_REQUEST_GET_STATUS
Request status of the specific recipient.
Definition: libusb.h:354
@ LIBUSB_REQUEST_SET_FEATURE
Set or enable a specific feature.
Definition: libusb.h:362
@ LIBUSB_REQUEST_SET_INTERFACE
Select an alternate interface for the specified interface.
Definition: libusb.h:385
@ LIBUSB_REQUEST_SET_ADDRESS
Set device address for all future accesses.
Definition: libusb.h:367
@ LIBUSB_REQUEST_GET_CONFIGURATION
Get the current device configuration value.
Definition: libusb.h:376
@ LIBUSB_REQUEST_SET_SEL
Sets both the U1 and U2 Exit Latency.
Definition: libusb.h:391
@ 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:395
@ LIBUSB_REQUEST_SYNCH_FRAME
Set then report an endpoint's synchronization frame.
Definition: libusb.h:388
@ LIBUSB_REQUEST_SET_CONFIGURATION
Set device configuration.
Definition: libusb.h:379
@ LIBUSB_CAP_HAS_CAPABILITY
The libusb_has_capability() API is available.
Definition: libusb.h:1296
@ LIBUSB_CAP_HAS_HOTPLUG
Hotplug support is available on this platform.
Definition: libusb.h:1299
@ LIBUSB_CAP_HAS_HID_ACCESS
The library can access HID devices without requiring user intervention.
Definition: libusb.h:1305
@ LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER
The library supports detaching of the default USB driver, using libusb_detach_kernel_driver(),...
Definition: libusb.h:1309
@ LIBUSB_ERROR_NOT_SUPPORTED
Operation not supported or unimplemented on this platform.
Definition: libusb.h:1091
@ LIBUSB_ERROR_ACCESS
Access denied (insufficient permissions)
Definition: libusb.h:1064
@ LIBUSB_ERROR_PIPE
Pipe error.
Definition: libusb.h:1082
@ LIBUSB_ERROR_NOT_FOUND
Entity not found.
Definition: libusb.h:1070
@ LIBUSB_ERROR_BUSY
Resource busy.
Definition: libusb.h:1073
@ LIBUSB_ERROR_INTERRUPTED
System call interrupted (perhaps due to signal)
Definition: libusb.h:1085
@ LIBUSB_SUCCESS
Success (no error)
Definition: libusb.h:1055
@ LIBUSB_ERROR_INVALID_PARAM
Invalid parameter.
Definition: libusb.h:1061
@ LIBUSB_ERROR_IO
Input/output error.
Definition: libusb.h:1058
@ LIBUSB_ERROR_OTHER
Other error.
Definition: libusb.h:1097
@ LIBUSB_ERROR_TIMEOUT
Operation timed out.
Definition: libusb.h:1076
@ LIBUSB_ERROR_OVERFLOW
Overflow.
Definition: libusb.h:1079
@ LIBUSB_ERROR_NO_DEVICE
No such device (it may have been disconnected)
Definition: libusb.h:1067
@ LIBUSB_ERROR_NO_MEM
Insufficient memory.
Definition: libusb.h:1088
int libusb_handle_events_completed(libusb_context *ctx, int *completed)
Handle any pending events in blocking mode.
Definition: io.c:2434
void libusb_lock_event_waiters(libusb_context *ctx)
Acquire the event waiters lock.
Definition: io.c:1957
void libusb_interrupt_event_handler(libusb_context *ctx)
Interrupt any active thread that is handling events.
Definition: io.c:1921
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:2616
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:1923
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:1935
int libusb_event_handler_active(libusb_context *ctx)
Determine if an active thread is handling events (i.e.
Definition: io.c:1892
void libusb_unlock_event_waiters(libusb_context *ctx)
Release the event waiters lock.
Definition: io.c:1968
int libusb_handle_events_timeout_completed(libusb_context *ctx, struct timeval *tv, int *completed)
Handle any pending events.
Definition: io.c:2320
int libusb_handle_events(libusb_context *ctx)
Handle any pending events in blocking mode.
Definition: io.c:2412
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:2724
int libusb_get_next_timeout(libusb_context *ctx, struct timeval *tv)
Determine the next internal timeout that libusb needs to handle.
Definition: io.c:2544
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:1863
int libusb_handle_events_timeout(libusb_context *ctx, struct timeval *tv)
Handle any pending events.
Definition: io.c:2392
int libusb_try_lock_events(libusb_context *ctx)
Attempt to acquire the event handling lock.
Definition: io.c:1769
int libusb_handle_events_locked(libusb_context *ctx, struct timeval *tv)
Handle any pending events by polling file descriptors, without checking if any other threads are alre...
Definition: io.c:2462
void libusb_lock_events(libusb_context *ctx)
Acquire the event handling lock, blocking until successful acquisition if it is contended.
Definition: io.c:1813
void libusb_unlock_events(libusb_context *ctx)
Release the lock previously acquired with libusb_try_lock_events() or libusb_lock_events().
Definition: io.c:1828
void libusb_free_pollfds(const struct libusb_pollfd **pollfds)
Free a list of libusb_pollfd structures.
Definition: io.c:2772
int libusb_wait_for_event(libusb_context *ctx, struct timeval *tv)
Wait for another thread to signal completion of an event.
Definition: io.c:2000
int libusb_pollfds_handle_timeouts(libusb_context *ctx)
Determines whether your application must apply special timing considerations when monitoring libusb's...
Definition: io.c:2510
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:796
uint16_t wTotalLength
Length of this descriptor and all of its sub descriptors.
Definition: libusb.h:806
struct libusb_bos_dev_capability_descriptor * dev_capability[ZERO_SIZED_ARRAY]
bNumDeviceCap Device Capability Descriptors
Definition: libusb.h:813
uint8_t bNumDeviceCaps
The number of separate device capability descriptors in the BOS.
Definition: libusb.h:810
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:798
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:803
A generic representation of a BOS Device Capability descriptor.
Definition: libusb.h:775
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:777
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:782
uint8_t dev_capability_data[ZERO_SIZED_ARRAY]
Device Capability data (bLength - 3 bytes)
Definition: libusb.h:788
uint8_t bDevCapabilityType
Device Capability type.
Definition: libusb.h:785
A structure representing the standard USB configuration descriptor.
Definition: libusb.h:698
uint8_t bConfigurationValue
Identifier value for this configuration.
Definition: libusb.h:714
uint8_t iConfiguration
Index of string descriptor describing this configuration.
Definition: libusb.h:717
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:737
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:700
uint8_t bNumInterfaces
Number of interfaces supported by this configuration.
Definition: libusb.h:711
uint8_t MaxPower
Maximum power consumption of the USB device from this bus in this configuration when the device is fu...
Definition: libusb.h:726
uint16_t wTotalLength
Total length of data returned for this configuration.
Definition: libusb.h:708
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:705
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:734
uint8_t bmAttributes
Configuration characteristics.
Definition: libusb.h:720
const struct libusb_interface * interface
Array of interfaces supported by this configuration.
Definition: libusb.h:730
A structure representing the Container ID descriptor.
Definition: libusb.h:889
uint8_t ContainerID[16]
128 bit UUID
Definition: libusb.h:907
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:896
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:901
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:891
uint8_t bReserved
Reserved field.
Definition: libusb.h:904
Setup packet for control transfers.
Definition: libusb.h:915
uint8_t bRequest
Request.
Definition: libusb.h:928
uint8_t bmRequestType
Request type.
Definition: libusb.h:921
uint16_t wLength
Number of bytes to transfer.
Definition: libusb.h:938
uint16_t wIndex
Index.
Definition: libusb.h:935
uint16_t wValue
Value.
Definition: libusb.h:931
A structure representing the standard USB device descriptor.
Definition: libusb.h:533
uint8_t bNumConfigurations
Number of possible configurations.
Definition: libusb.h:579
uint8_t iProduct
Index of string descriptor describing product.
Definition: libusb.h:573
uint8_t iSerialNumber
Index of string descriptor containing device serial number.
Definition: libusb.h:576
uint8_t bMaxPacketSize0
Maximum packet size for endpoint 0.
Definition: libusb.h:558
uint8_t bDeviceProtocol
USB-IF protocol code for the device, qualified by the bDeviceClass and bDeviceSubClass values.
Definition: libusb.h:555
uint16_t idProduct
USB-IF product ID.
Definition: libusb.h:564
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:540
uint8_t bDeviceSubClass
USB-IF subclass code for the device, qualified by the bDeviceClass value.
Definition: libusb.h:551
uint8_t bDeviceClass
USB-IF class code for the device.
Definition: libusb.h:547
uint8_t iManufacturer
Index of string descriptor describing manufacturer.
Definition: libusb.h:570
uint16_t idVendor
USB-IF vendor ID.
Definition: libusb.h:561
uint16_t bcdUSB
USB specification release number in binary-coded decimal.
Definition: libusb.h:544
uint16_t bcdDevice
Device release number in binary-coded decimal.
Definition: libusb.h:567
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:535
A structure representing the standard USB endpoint descriptor.
Definition: libusb.h:587
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:627
uint8_t bEndpointAddress
The address of the endpoint described by this descriptor.
Definition: libusb.h:599
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:624
uint8_t bInterval
Interval for polling endpoint for data transfers.
Definition: libusb.h:613
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:594
uint8_t bRefresh
For audio devices only: the rate at which synchronization feedback is provided.
Definition: libusb.h:617
uint8_t bmAttributes
Attributes which apply to the endpoint when it is configured using the bConfigurationValue.
Definition: libusb.h:607
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:589
uint8_t bSynchAddress
For audio devices only: the address if the synch endpoint.
Definition: libusb.h:620
uint16_t wMaxPacketSize
Maximum packet size this endpoint is capable of sending/receiving.
Definition: libusb.h:610
A structure representing the standard USB interface descriptor.
Definition: libusb.h:635
uint8_t bInterfaceSubClass
USB-IF subclass code for this interface, qualified by the bInterfaceClass value.
Definition: libusb.h:659
uint8_t iInterface
Index of string descriptor describing this interface.
Definition: libusb.h:666
uint8_t bInterfaceClass
USB-IF class code for this interface.
Definition: libusb.h:655
uint8_t bAlternateSetting
Value used to select this alternate setting for this interface.
Definition: libusb.h:648
const struct libusb_endpoint_descriptor * endpoint
Array of endpoint descriptors.
Definition: libusb.h:670
uint8_t bNumEndpoints
Number of endpoints used by this interface (excluding the control endpoint).
Definition: libusb.h:652
uint8_t bInterfaceProtocol
USB-IF protocol code for this interface, qualified by the bInterfaceClass and bInterfaceSubClass valu...
Definition: libusb.h:663
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:637
uint8_t bInterfaceNumber
Number of this interface.
Definition: libusb.h:645
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:674
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:677
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:642
A collection of alternate settings for a particular USB interface.
Definition: libusb.h:683
const struct libusb_interface_descriptor * altsetting
Array of interface descriptors.
Definition: libusb.h:686
int num_altsetting
The number of alternate settings that belong to this interface.
Definition: libusb.h:690
Isochronous packet descriptor.
Definition: libusb.h:1198
unsigned int actual_length
Amount of data that was actually transferred.
Definition: libusb.h:1203
unsigned int length
Length of data to request in this packet.
Definition: libusb.h:1200
enum libusb_transfer_status status
Status code for this packet.
Definition: libusb.h:1206
File descriptor for polling.
Definition: libusb.h:1902
short events
Event flags to poll for from <poll.h>.
Definition: libusb.h:1910
int fd
Numeric file descriptor.
Definition: libusb.h:1904
A structure representing the superspeed endpoint companion descriptor.
Definition: libusb.h:746
uint16_t wBytesPerInterval
The total number of bytes this EP will transfer every service interval.
Definition: libusb.h:767
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:748
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:753
uint8_t bMaxBurst
The maximum number of packets the endpoint can send or receive as part of a burst.
Definition: libusb.h:757
uint8_t bmAttributes
In bulk EP: bits 4:0 represents the maximum number of streams the EP supports.
Definition: libusb.h:763
A structure representing the SuperSpeed USB Device Capability descriptor This descriptor is documente...
Definition: libusb.h:847
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:859
uint16_t wSpeedSupported
Bitmap encoding of the speed supported by this device when operating in SuperSpeed mode.
Definition: libusb.h:869
uint8_t bFunctionalitySupport
The lowest speed at which all the functionality supported by the device is available to the user.
Definition: libusb.h:875
uint16_t bU2DevExitLat
U2 Device Exit Latency.
Definition: libusb.h:881
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:849
uint8_t bmAttributes
Bitmap encoding of supported device level features.
Definition: libusb.h:865
uint8_t bU1DevExitLat
U1 Device Exit Latency.
Definition: libusb.h:878
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:854
The generic USB transfer structure.
Definition: libusb.h:1228
unsigned char endpoint
Address of the endpoint where this transfer will be sent.
Definition: libusb.h:1236
struct libusb_iso_packet_descriptor iso_packet_desc[ZERO_SIZED_ARRAY]
Isochronous packet descriptors, for isochronous transfers only.
Definition: libusb.h:1286
enum libusb_transfer_status status
The status of the transfer.
Definition: libusb.h:1252
int length
Length of the data buffer.
Definition: libusb.h:1255
libusb_transfer_cb_fn callback
Callback function.
Definition: libusb.h:1264
unsigned char type
Type of the transfer from libusb_transfer_type.
Definition: libusb.h:1239
int actual_length
Actual length of data that was transferred.
Definition: libusb.h:1260
unsigned char * buffer
Data buffer.
Definition: libusb.h:1279
int num_iso_packets
Number of isochronous packets.
Definition: libusb.h:1283
unsigned int timeout
Timeout for this transfer in milliseconds.
Definition: libusb.h:1243
void * user_data
User context data.
Definition: libusb.h:1276
libusb_device_handle * dev_handle
Handle of the device that this transfer will be submitted to.
Definition: libusb.h:1230
uint8_t flags
A bitwise OR combination of libusb_transfer_flags.
Definition: libusb.h:1233
A structure representing the USB 2.0 Extension descriptor This descriptor is documented in section 9....
Definition: libusb.h:821
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:823
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:833
uint32_t bmAttributes
Bitmap encoding of supported device level features.
Definition: libusb.h:839
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:828
Structure providing the version of the libusb runtime.
Definition: libusb.h:955
const uint16_t micro
Library micro version.
Definition: libusb.h:963
const uint16_t major
Library major version.
Definition: libusb.h:957
const char * rc
Library release candidate suffix string, e.g.
Definition: libusb.h:969
const uint16_t minor
Library minor version.
Definition: libusb.h:960
const char * describe
For ABI compatibility only.
Definition: libusb.h:972
const uint16_t nano
Library nano version.
Definition: libusb.h:966