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 #else
84 #define LIBUSB_PACKED
85 #endif /* __GNUC__ */
86 
112 /* LIBUSB_CALL must be defined on both definition and declaration of libusb
113  * functions. You'd think that declaration would be enough, but cygwin will
114  * complain about conflicting types unless both are marked this way.
115  * The placement of this macro is important too; it must appear after the
116  * return type, before the function name. See internal documentation for
117  * API_EXPORTED.
118  */
119 #if defined(_WIN32) || defined(__CYGWIN__)
120 #define LIBUSB_CALL WINAPI
121 #else
122 #define LIBUSB_CALL
123 #endif /* _WIN32 || __CYGWIN__ */
124 
145 #define LIBUSB_API_VERSION 0x01000109
146 
147 /* The following is kept for compatibility, but will be deprecated in the future */
148 #define LIBUSBX_API_VERSION LIBUSB_API_VERSION
149 
150 #if defined(__cplusplus)
151 extern "C" {
152 #endif
153 
162 static inline uint16_t libusb_cpu_to_le16(const uint16_t x)
163 {
164  union {
165  uint8_t b8[2];
166  uint16_t b16;
167  } _tmp;
168  _tmp.b8[1] = (uint8_t) (x >> 8);
169  _tmp.b8[0] = (uint8_t) (x & 0xff);
170  return _tmp.b16;
171 }
172 
181 #define libusb_le16_to_cpu libusb_cpu_to_le16
182 
183 /* standard USB stuff */
184 
193 
196 
199 
202 
205 
208  LIBUSB_CLASS_PTP = 0x06, /* legacy name from libusb-0.1 usb.h */
209 
212 
215 
218 
221 
224 
227 
230 
233 
236 
239 
242 
245 
248 };
249 
255 
258 
261 
264 
267 
270 
273 
276 
279 
282 
285 
288 
291 };
292 
293 /* Descriptor sizes per descriptor type */
294 #define LIBUSB_DT_DEVICE_SIZE 18
295 #define LIBUSB_DT_CONFIG_SIZE 9
296 #define LIBUSB_DT_INTERFACE_SIZE 9
297 #define LIBUSB_DT_ENDPOINT_SIZE 7
298 #define LIBUSB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */
299 #define LIBUSB_DT_HUB_NONVAR_SIZE 7
300 #define LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE 6
301 #define LIBUSB_DT_BOS_SIZE 5
302 #define LIBUSB_DT_DEVICE_CAPABILITY_SIZE 3
303 
304 /* BOS descriptor sizes */
305 #define LIBUSB_BT_USB_2_0_EXTENSION_SIZE 7
306 #define LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE 10
307 #define LIBUSB_BT_CONTAINER_ID_SIZE 20
308 
309 /* We unwrap the BOS => define its max size */
310 #define LIBUSB_DT_BOS_MAX_SIZE \
311  (LIBUSB_DT_BOS_SIZE + \
312  LIBUSB_BT_USB_2_0_EXTENSION_SIZE + \
313  LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE + \
314  LIBUSB_BT_CONTAINER_ID_SIZE)
315 
316 #define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f /* in bEndpointAddress */
317 #define LIBUSB_ENDPOINT_DIR_MASK 0x80
318 
326 
329 };
330 
331 #define LIBUSB_TRANSFER_TYPE_MASK 0x03 /* in bmAttributes */
332 
340 
343 
346 
349 };
350 
356 
359 
360  /* 0x02 is reserved */
361 
364 
365  /* 0x04 is reserved */
366 
369 
372 
375 
378 
381 
384 
387 
390 
393 
397 };
398 
406 
409 
412 
415 };
416 
424 
427 
430 
433 };
434 
435 #define LIBUSB_ISO_SYNC_TYPE_MASK 0x0c
436 
445 
448 
451 
454 };
455 
456 #define LIBUSB_ISO_USAGE_TYPE_MASK 0x30
457 
466 
469 
472 };
473 
481 
484 
487 
490 };
491 
500 };
501 
510 };
511 
518 
521 
524 
527 };
528 
536  uint8_t bLength;
537 
542 
545  uint16_t bcdUSB;
546 
548  uint8_t bDeviceClass;
549 
553 
557 
560 
562  uint16_t idVendor;
563 
565  uint16_t idProduct;
566 
568  uint16_t bcdDevice;
569 
571  uint8_t iManufacturer;
572 
574  uint8_t iProduct;
575 
577  uint8_t iSerialNumber;
578 
581 };
582 
590  uint8_t bLength;
591 
596 
601 
608  uint8_t bmAttributes;
609 
611  uint16_t wMaxPacketSize;
612 
614  uint8_t bInterval;
615 
618  uint8_t bRefresh;
619 
621  uint8_t bSynchAddress;
622 
625  const unsigned char *extra;
626 
629 };
630 
638  uint8_t bLength;
639 
644 
647 
650 
653  uint8_t bNumEndpoints;
654 
657 
661 
665 
667  uint8_t iInterface;
668 
672 
675  const unsigned char *extra;
676 
679 };
680 
688 
692 };
693 
701  uint8_t bLength;
702 
707 
709  uint16_t wTotalLength;
710 
712  uint8_t bNumInterfaces;
713 
716 
718  uint8_t iConfiguration;
719 
721  uint8_t bmAttributes;
722 
727  uint8_t MaxPower;
728 
732 
735  const unsigned char *extra;
736 
739 };
740 
749  uint8_t bLength;
750 
755 
758  uint8_t bMaxBurst;
759 
764  uint8_t bmAttributes;
765 
769 };
770 
778  uint8_t bLength;
779 
784 
787 
789  uint8_t dev_capability_data[ZERO_SIZED_ARRAY];
790 };
791 
799  uint8_t bLength;
800 
805 
807  uint16_t wTotalLength;
808 
811  uint8_t bNumDeviceCaps;
812 
814  struct libusb_bos_dev_capability_descriptor *dev_capability[ZERO_SIZED_ARRAY];
815 };
816 
824  uint8_t bLength;
825 
830 
835 
840  uint32_t bmAttributes;
841 };
842 
850  uint8_t bLength;
851 
856 
861 
866  uint8_t bmAttributes;
867 
870  uint16_t wSpeedSupported;
871 
877 
879  uint8_t bU1DevExitLat;
880 
882  uint16_t bU2DevExitLat;
883 };
884 
892  uint8_t bLength;
893 
898 
903 
905  uint8_t bReserved;
906 
908  uint8_t ContainerID[16];
909 };
910 
913 #if defined(_MSC_VER) || defined(__WATCOMC__)
914 #pragma pack(push, 1)
915 #endif
922  uint8_t bmRequestType;
923 
929  uint8_t bRequest;
930 
932  uint16_t wValue;
933 
936  uint16_t wIndex;
937 
939  uint16_t wLength;
940 } LIBUSB_PACKED;
941 #if defined(_MSC_VER) || defined(__WATCOMC__)
942 #pragma pack(pop)
943 #endif
944 
945 #define LIBUSB_CONTROL_SETUP_SIZE (sizeof(struct libusb_control_setup))
946 
947 /* libusb */
948 
949 struct libusb_context;
950 struct libusb_device;
951 struct libusb_device_handle;
952 
958  const uint16_t major;
959 
961  const uint16_t minor;
962 
964  const uint16_t micro;
965 
967  const uint16_t nano;
968 
970  const char *rc;
971 
973  const char *describe;
974 };
975 
995 
1012 
1013 
1023 
1030 
1033 
1036 
1039 
1042 
1045 };
1046 
1057 
1060 
1063 
1066 
1069 
1072 
1075 
1078 
1081 
1084 
1087 
1090 
1093 
1094  /* NB: Remember to update LIBUSB_ERROR_COUNT below as well as the
1095  message strings in strerror.c when adding new error codes here. */
1096 
1099 };
1100 
1101 /* Total number of error codes in enum libusb_error */
1102 #define LIBUSB_ERROR_COUNT 14
1103 
1109 
1112 
1115 
1118 
1121 };
1122 
1129 
1132 
1135 
1138 
1142 
1145 
1148 
1149  /* NB! Remember to update libusb_error_name()
1150  when adding new status codes here. */
1151 };
1152 
1158 
1164 
1170 
1195 };
1196 
1201  unsigned int length;
1202 
1204  unsigned int actual_length;
1205 
1208 };
1209 
1210 struct libusb_transfer;
1211 
1221 typedef void (LIBUSB_CALL *libusb_transfer_cb_fn)(struct libusb_transfer *transfer);
1222 
1232 
1234  uint8_t flags;
1235 
1237  unsigned char endpoint;
1238 
1240  unsigned char type;
1241 
1244  unsigned int timeout;
1245 
1254 
1256  int length;
1257 
1262 
1266 
1277  void *user_data;
1278 
1280  unsigned char *buffer;
1281 
1285 
1287  struct libusb_iso_packet_descriptor iso_packet_desc[ZERO_SIZED_ARRAY];
1288 };
1289 
1298 
1301 
1307 
1311 };
1312 
1319 
1322 
1325 
1328 
1331 };
1332 
1343 
1346 };
1347 
1360  enum libusb_log_level level, const char *str);
1361 
1364 LIBUSB_DEPRECATED_FOR(libusb_set_option)
1365 void LIBUSB_CALL libusb_set_debug(libusb_context *ctx, int level);
1367 const struct libusb_version * LIBUSB_CALL libusb_get_version(void);
1368 int LIBUSB_CALL libusb_has_capability(uint32_t capability);
1369 const char * LIBUSB_CALL libusb_error_name(int errcode);
1370 int LIBUSB_CALL libusb_setlocale(const char *locale);
1371 const char * LIBUSB_CALL libusb_strerror(int errcode);
1372 
1374  libusb_device ***list);
1376  int unref_devices);
1379 
1381  int *config);
1383  struct libusb_device_descriptor *desc);
1385  struct libusb_config_descriptor **config);
1387  uint8_t config_index, struct libusb_config_descriptor **config);
1389  uint8_t bConfigurationValue, struct libusb_config_descriptor **config);
1391  struct libusb_config_descriptor *config);
1393  libusb_context *ctx,
1394  const struct libusb_endpoint_descriptor *endpoint,
1395  struct libusb_ss_endpoint_companion_descriptor **ep_comp);
1397  struct libusb_ss_endpoint_companion_descriptor *ep_comp);
1399  struct libusb_bos_descriptor **bos);
1402  libusb_context *ctx,
1403  struct libusb_bos_dev_capability_descriptor *dev_cap,
1404  struct libusb_usb_2_0_extension_descriptor **usb_2_0_extension);
1406  struct libusb_usb_2_0_extension_descriptor *usb_2_0_extension);
1408  libusb_context *ctx,
1409  struct libusb_bos_dev_capability_descriptor *dev_cap,
1410  struct libusb_ss_usb_device_capability_descriptor **ss_usb_device_cap);
1412  struct libusb_ss_usb_device_capability_descriptor *ss_usb_device_cap);
1414  struct libusb_bos_dev_capability_descriptor *dev_cap,
1415  struct libusb_container_id_descriptor **container_id);
1417  struct libusb_container_id_descriptor *container_id);
1420 int LIBUSB_CALL libusb_get_port_numbers(libusb_device *dev, uint8_t *port_numbers, int port_numbers_len);
1421 LIBUSB_DEPRECATED_FOR(libusb_get_port_numbers)
1422 int LIBUSB_CALL libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *path, uint8_t path_length);
1427  unsigned char endpoint);
1429  unsigned char endpoint);
1430 
1431 int LIBUSB_CALL libusb_wrap_sys_device(libusb_context *ctx, intptr_t sys_dev, libusb_device_handle **dev_handle);
1435 
1437  int configuration);
1439  int interface_number);
1441  int interface_number);
1442 
1444  libusb_context *ctx, uint16_t vendor_id, uint16_t product_id);
1445 
1447  int interface_number, int alternate_setting);
1449  unsigned char endpoint);
1451 
1453  uint32_t num_streams, unsigned char *endpoints, int num_endpoints);
1455  unsigned char *endpoints, int num_endpoints);
1456 
1457 unsigned char * LIBUSB_CALL libusb_dev_mem_alloc(libusb_device_handle *dev_handle,
1458  size_t length);
1460  unsigned char *buffer, size_t length);
1461 
1463  int interface_number);
1465  int interface_number);
1467  int interface_number);
1469  libusb_device_handle *dev_handle, int enable);
1470 
1471 /* async I/O */
1472 
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 
1504  struct libusb_transfer *transfer)
1505 {
1506  return (struct libusb_control_setup *)(void *)transfer->buffer;
1507 }
1508 
1532 static inline void libusb_fill_control_setup(unsigned char *buffer,
1533  uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
1534  uint16_t wLength)
1535 {
1536  struct libusb_control_setup *setup = (struct libusb_control_setup *)(void *)buffer;
1537  setup->bmRequestType = bmRequestType;
1538  setup->bRequest = bRequest;
1539  setup->wValue = libusb_cpu_to_le16(wValue);
1540  setup->wIndex = libusb_cpu_to_le16(wIndex);
1541  setup->wLength = libusb_cpu_to_le16(wLength);
1542 }
1543 
1544 struct libusb_transfer * LIBUSB_CALL libusb_alloc_transfer(int iso_packets);
1545 int LIBUSB_CALL libusb_submit_transfer(struct libusb_transfer *transfer);
1546 int LIBUSB_CALL libusb_cancel_transfer(struct libusb_transfer *transfer);
1547 void LIBUSB_CALL libusb_free_transfer(struct libusb_transfer *transfer);
1549  struct libusb_transfer *transfer, uint32_t stream_id);
1551  struct libusb_transfer *transfer);
1552 
1581 static inline void libusb_fill_control_transfer(
1582  struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1583  unsigned char *buffer, libusb_transfer_cb_fn callback, void *user_data,
1584  unsigned int timeout)
1585 {
1586  struct libusb_control_setup *setup = (struct libusb_control_setup *)(void *)buffer;
1587  transfer->dev_handle = dev_handle;
1588  transfer->endpoint = 0;
1589  transfer->type = LIBUSB_TRANSFER_TYPE_CONTROL;
1590  transfer->timeout = timeout;
1591  transfer->buffer = buffer;
1592  if (setup)
1593  transfer->length = (int) (LIBUSB_CONTROL_SETUP_SIZE
1594  + libusb_le16_to_cpu(setup->wLength));
1595  transfer->user_data = user_data;
1596  transfer->callback = callback;
1597 }
1598 
1612 static inline void libusb_fill_bulk_transfer(struct libusb_transfer *transfer,
1613  libusb_device_handle *dev_handle, unsigned char endpoint,
1614  unsigned char *buffer, int length, libusb_transfer_cb_fn callback,
1615  void *user_data, unsigned int timeout)
1616 {
1617  transfer->dev_handle = dev_handle;
1618  transfer->endpoint = endpoint;
1619  transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1620  transfer->timeout = timeout;
1621  transfer->buffer = buffer;
1622  transfer->length = length;
1623  transfer->user_data = user_data;
1624  transfer->callback = callback;
1625 }
1626 
1644  struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1645  unsigned char endpoint, uint32_t stream_id,
1646  unsigned char *buffer, int length, libusb_transfer_cb_fn callback,
1647  void *user_data, unsigned int timeout)
1648 {
1649  libusb_fill_bulk_transfer(transfer, dev_handle, endpoint, buffer,
1650  length, callback, user_data, timeout);
1652  libusb_transfer_set_stream_id(transfer, stream_id);
1653 }
1654 
1669  struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1670  unsigned char endpoint, unsigned char *buffer, int length,
1671  libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
1672 {
1673  transfer->dev_handle = dev_handle;
1674  transfer->endpoint = endpoint;
1676  transfer->timeout = timeout;
1677  transfer->buffer = buffer;
1678  transfer->length = length;
1679  transfer->user_data = user_data;
1680  transfer->callback = callback;
1681 }
1682 
1697 static inline void libusb_fill_iso_transfer(struct libusb_transfer *transfer,
1698  libusb_device_handle *dev_handle, unsigned char endpoint,
1699  unsigned char *buffer, int length, int num_iso_packets,
1700  libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
1701 {
1702  transfer->dev_handle = dev_handle;
1703  transfer->endpoint = endpoint;
1705  transfer->timeout = timeout;
1706  transfer->buffer = buffer;
1707  transfer->length = length;
1708  transfer->num_iso_packets = num_iso_packets;
1709  transfer->user_data = user_data;
1710  transfer->callback = callback;
1711 }
1712 
1722  struct libusb_transfer *transfer, unsigned int length)
1723 {
1724  int i;
1725 
1726  for (i = 0; i < transfer->num_iso_packets; i++)
1727  transfer->iso_packet_desc[i].length = length;
1728 }
1729 
1746 static inline unsigned char *libusb_get_iso_packet_buffer(
1747  struct libusb_transfer *transfer, unsigned int packet)
1748 {
1749  int i;
1750  size_t offset = 0;
1751  int _packet;
1752 
1753  /* oops..slight bug in the API. packet is an unsigned int, but we use
1754  * signed integers almost everywhere else. range-check and convert to
1755  * signed to avoid compiler warnings. FIXME for libusb-2. */
1756  if (packet > INT_MAX)
1757  return NULL;
1758  _packet = (int) packet;
1759 
1760  if (_packet >= transfer->num_iso_packets)
1761  return NULL;
1762 
1763  for (i = 0; i < _packet; i++)
1764  offset += transfer->iso_packet_desc[i].length;
1765 
1766  return transfer->buffer + offset;
1767 }
1768 
1788 static inline unsigned char *libusb_get_iso_packet_buffer_simple(
1789  struct libusb_transfer *transfer, unsigned int packet)
1790 {
1791  int _packet;
1792 
1793  /* oops..slight bug in the API. packet is an unsigned int, but we use
1794  * signed integers almost everywhere else. range-check and convert to
1795  * signed to avoid compiler warnings. FIXME for libusb-2. */
1796  if (packet > INT_MAX)
1797  return NULL;
1798  _packet = (int) packet;
1799 
1800  if (_packet >= transfer->num_iso_packets)
1801  return NULL;
1802 
1803  return transfer->buffer + ((int) transfer->iso_packet_desc[0].length * _packet);
1804 }
1805 
1806 /* sync I/O */
1807 
1809  uint8_t request_type, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
1810  unsigned char *data, uint16_t wLength, unsigned int timeout);
1811 
1813  unsigned char endpoint, unsigned char *data, int length,
1814  int *actual_length, unsigned int timeout);
1815 
1817  unsigned char endpoint, unsigned char *data, int length,
1818  int *actual_length, unsigned int timeout);
1819 
1832 static inline int libusb_get_descriptor(libusb_device_handle *dev_handle,
1833  uint8_t desc_type, uint8_t desc_index, unsigned char *data, int length)
1834 {
1835  return libusb_control_transfer(dev_handle, LIBUSB_ENDPOINT_IN,
1836  LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t) ((desc_type << 8) | desc_index),
1837  0, data, (uint16_t) length, 1000);
1838 }
1839 
1855  uint8_t desc_index, uint16_t langid, unsigned char *data, int length)
1856 {
1857  return libusb_control_transfer(dev_handle, LIBUSB_ENDPOINT_IN,
1858  LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t)((LIBUSB_DT_STRING << 8) | desc_index),
1859  langid, data, (uint16_t) length, 1000);
1860 }
1861 
1863  uint8_t desc_index, unsigned char *data, int length);
1864 
1865 /* polling and timeouts */
1866 
1875 int LIBUSB_CALL libusb_wait_for_event(libusb_context *ctx, struct timeval *tv);
1876 
1878  struct timeval *tv);
1880  struct timeval *tv, int *completed);
1884  struct timeval *tv);
1887  struct timeval *tv);
1888 
1894  int fd;
1895 
1900  short events;
1901 };
1902 
1913 typedef void (LIBUSB_CALL *libusb_pollfd_added_cb)(int fd, short events,
1914  void *user_data);
1915 
1925 typedef void (LIBUSB_CALL *libusb_pollfd_removed_cb)(int fd, void *user_data);
1926 
1928  libusb_context *ctx);
1929 void LIBUSB_CALL libusb_free_pollfds(const struct libusb_pollfd **pollfds);
1931  libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb,
1932  void *user_data);
1933 
1947 
1953 typedef enum {
1956 
1962 
1968 typedef enum {
1972 
1975 #define LIBUSB_HOTPLUG_NO_FLAGS 0
1976 
1979 #define LIBUSB_HOTPLUG_MATCH_ANY -1
1980 
2004  libusb_device *device, libusb_hotplug_event event, void *user_data);
2005 
2042  int events, int flags,
2043  int vendor_id, int product_id, int dev_class,
2044  libusb_hotplug_callback_fn cb_fn, void *user_data,
2045  libusb_hotplug_callback_handle *callback_handle);
2046 
2059  libusb_hotplug_callback_handle callback_handle);
2060 
2070  libusb_hotplug_callback_handle callback_handle);
2071 
2098 
2107 
2126 
2127 #define LIBUSB_OPTION_WEAK_AUTHORITY LIBUSB_OPTION_NO_DEVICE_DISCOVERY
2128 
2129  LIBUSB_OPTION_MAX = 3
2130 };
2131 
2132 int LIBUSB_CALL libusb_set_option(libusb_context *ctx, enum libusb_option option, ...);
2133 
2134 #ifdef _MSC_VER
2135 #pragma warning(pop)
2136 #endif
2137 
2138 #if defined(__cplusplus)
2139 }
2140 #endif
2141 
2142 #endif
void libusb_free_usb_2_0_extension_descriptor(struct libusb_usb_2_0_extension_descriptor *usb_2_0_extension)
Free a USB 2.0 Extension descriptor obtained from libusb_get_usb_2_0_extension_descriptor().
Definition: descriptor.c:957
const char * describe
For ABI compatibility only.
Definition: libusb.h:973
uint16_t bU2DevExitLat
U2 Device Exit Latency.
Definition: libusb.h:882
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
Device.
Definition: libusb.h:423
uint8_t bFunctionalitySupport
The lowest speed at which all the functionality supported by the device is available to the user...
Definition: libusb.h:876
SuperSpeed Endpoint Companion descriptor.
Definition: libusb.h:290
uint8_t bInterfaceNumber
Number of this interface.
Definition: libusb.h:646
Asynchronous.
Definition: libusb.h:447
uint8_t bSynchAddress
For audio devices only: the address if the synch endpoint.
Definition: libusb.h:621
(0) : No messages ever emitted by the library (default)
Definition: libusb.h:1318
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
The device is operating at low speed (1.5MBit/s).
Definition: libusb.h:1032
Isochronous endpoint.
Definition: libusb.h:342
Success (no error)
Definition: libusb.h:1056
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
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:1746
Device was disconnected.
Definition: libusb.h:1144
Device Capability descriptor.
Definition: libusb.h:272
uint8_t bmAttributes
Attributes which apply to the endpoint when it is configured using the bConfigurationValue.
Definition: libusb.h:608
The OS doesn&#39;t report or know the device speed.
Definition: libusb.h:1029
void libusb_free_transfer(struct libusb_transfer *transfer)
Free a transfer structure.
Definition: io.c:1332
A collection of alternate settings for a particular USB interface.
Definition: libusb.h:684
static unsigned char * libusb_control_transfer_get_data(struct libusb_transfer *transfer)
Get the data section of a control transfer.
Definition: libusb.h:1485
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:162
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
HID descriptor.
Definition: libusb.h:275
void(* libusb_log_cb)(libusb_context *ctx, enum libusb_log_level level, const char *str)
Callback function for handling log messages.
Definition: libusb.h:1359
void libusb_free_pollfds(const struct libusb_pollfd **pollfds)
Free a list of libusb_pollfd structures.
Definition: io.c:2791
uint8_t bReserved
Reserved field.
Definition: libusb.h:905
int libusb_set_auto_detach_kernel_driver(libusb_device_handle *dev_handle, int enable)
Enable/disable libusb&#39;s automatic kernel driver detachment.
Definition: core.c:2088
uint8_t bNumConfigurations
Number of possible configurations.
Definition: libusb.h:580
Audio class.
Definition: libusb.h:195
uint8_t bRequest
Request.
Definition: libusb.h:929
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
Operation not supported or unimplemented on this platform.
Definition: libusb.h:1092
Physical.
Definition: libusb.h:204
void libusb_interrupt_event_handler(libusb_context *ctx)
Interrupt any active thread that is handling events.
Definition: io.c:1940
int libusb_cancel_transfer(struct libusb_transfer *transfer)
Asynchronously cancel a previously submitted transfer.
Definition: io.c:1605
Other.
Definition: libusb.h:432
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:1882
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:1612
const uint16_t nano
Library nano version.
Definition: libusb.h:967
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:902
void libusb_exit(libusb_context *ctx)
Deinitialize libusb.
Definition: core.c:2402
Bulk transfer.
Definition: libusb.h:1114
Supports Link Power Management (LPM)
Definition: libusb.h:499
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:778
uint8_t bDeviceSubClass
USB-IF subclass code for the device, qualified by the bDeviceClass value.
Definition: libusb.h:552
libusb_class_code
Device and/or Interface Class codes.
Definition: libusb.h:187
#define libusb_le16_to_cpu
Convert a 16-bit value from little-endian to host-endian format.
Definition: libusb.h:181
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:783
Hub class.
Definition: libusb.h:217
int libusb_detach_kernel_driver(libusb_device_handle *dev_handle, int interface_number)
Detach a kernel driver from an interface.
Definition: core.c:2013
int libusb_try_lock_events(libusb_context *ctx)
Attempt to acquire the event handling lock.
Definition: io.c:1789
A structure representing the standard USB configuration descriptor.
Definition: libusb.h:699
A generic representation of a BOS Device Capability descriptor.
Definition: libusb.h:776
int libusb_wait_for_event(libusb_context *ctx, struct timeval *tv)
Wait for another thread to signal completion of an event.
Definition: io.c:2019
uint8_t bInterval
Interval for polling endpoint for data transfers.
Definition: libusb.h:614
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:536
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
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:1913
libusb_endpoint_direction
Endpoint direction.
Definition: libusb.h:323
uint8_t bDeviceClass
USB-IF class code for the device.
Definition: libusb.h:548
int libusb_claim_interface(libusb_device_handle *dev_handle, int interface_number)
Claim an interface on a given device handle.
Definition: core.c:1663
Interface descriptor.
Definition: libusb.h:263
Overflow.
Definition: libusb.h:1080
int libusb_open(libusb_device *dev, libusb_device_handle **dev_handle)
Open a device and obtain a device handle.
Definition: core.c:1297
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:507
short events
Event flags to poll for from <poll.h>.
Definition: libusb.h:1900
Container ID type.
Definition: libusb.h:526
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:628
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:1925
int libusb_attach_kernel_driver(libusb_device_handle *dev_handle, int interface_number)
Re-attach an interface&#39;s kernel driver, which was previously detached using libusb_detach_kernel_driv...
Definition: core.c:2049
A structure representing the SuperSpeed USB Device Capability descriptor This descriptor is documente...
Definition: libusb.h:848
uint8_t flags
A bitwise OR combination of libusb_transfer_flags.
Definition: libusb.h:1234
int libusb_setlocale(const char *locale)
Set the language, and only the language, not the encoding! used for translatable libusb messages...
Definition: strerror.c:178
int libusb_get_config_descriptor(libusb_device *dev, uint8_t config_index, struct libusb_config_descriptor **config)
Get a USB configuration descriptor based on its index.
Definition: descriptor.c:596
Feedback endpoint.
Definition: libusb.h:468
Data endpoint.
Definition: libusb.h:465
Reserved.
Definition: libusb.h:414
Callback function handling context related log messages.
Definition: libusb.h:1345
Arm the callback and fire it for all matching currently attached devices.
Definition: libusb.h:1970
uint8_t bmAttributes
In bulk EP: bits 4:0 represents the maximum number of streams the EP supports.
Definition: libusb.h:764
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:1788
void libusb_close(libusb_device_handle *dev_handle)
Close a device handle.
Definition: core.c:1452
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
The library can access HID devices without requiring user intervention.
Definition: libusb.h:1306
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:595
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
Class is vendor-specific.
Definition: libusb.h:247
struct libusb_context libusb_context
Structure representing a libusb session.
Definition: libusb.h:994
Terminate transfers that are a multiple of the endpoint&#39;s wMaxPacketSize with an extra zero length pa...
Definition: libusb.h:1194
uint8_t iSerialNumber
Index of string descriptor containing device serial number.
Definition: libusb.h:577
libusb_option
Available option values for libusb_set_option().
Definition: libusb.h:2075
Sets both the U1 and U2 Exit Latency.
Definition: libusb.h:392
Isochronous transfer.
Definition: libusb.h:1111
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:638
Invalid parameter.
Definition: libusb.h:1062
File descriptor for polling.
Definition: libusb.h:1892
Supports Latency Tolerance Messages (LTM)
Definition: libusb.h:509
uint8_t bNumInterfaces
Number of interfaces supported by this configuration.
Definition: libusb.h:712
libusb_speed
Speed codes.
Definition: libusb.h:1027
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
A device has left and is no longer available.
Definition: libusb.h:1960
int libusb_event_handler_active(libusb_context *ctx)
Determine if an active thread is handling events (i.e.
Definition: io.c:1911
System call interrupted (perhaps due to signal)
Definition: libusb.h:1086
libusb_iso_sync_type
Synchronization type for isochronous endpoints.
Definition: libusb.h:442
uint8_t bmAttributes
Bitmap encoding of supported device level features.
Definition: libusb.h:866
int libusb_get_configuration(libusb_device_handle *dev, int *config)
Determine the bConfigurationValue of the currently active configuration.
Definition: core.c:1539
void libusb_free_bos_descriptor(struct libusb_bos_descriptor *bos)
Free a BOS descriptor obtained from libusb_get_bos_descriptor().
Definition: descriptor.c:896
(1) : Error messages are emitted
Definition: libusb.h:1321
uint16_t bcdDevice
Device release number in binary-coded decimal.
Definition: libusb.h:568
unsigned char * buffer
Data buffer.
Definition: libusb.h:1280
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
Low speed operation supported (1.5MBit/s).
Definition: libusb.h:480
uint8_t bDeviceProtocol
USB-IF protocol code for the device, qualified by the bDeviceClass and bDeviceSubClass values...
Definition: libusb.h:556
A device has been plugged in and is ready to use.
Definition: libusb.h:1955
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:1668
(4) : All messages are emitted
Definition: libusb.h:1330
Access denied (insufficient permissions)
Definition: libusb.h:1065
Entity not found.
Definition: libusb.h:1071
Input/output error.
Definition: libusb.h:1059
The libusb_has_capability() API is available.
Definition: libusb.h:1297
uint16_t wMaxPacketSize
Maximum packet size this endpoint is capable of sending/receiving.
Definition: libusb.h:611
Diagnostic Device.
Definition: libusb.h:235
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:860
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:625
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
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:1832
libusb_standard_request
Standard requests, as defined in table 9-5 of the USB 3.0 specifications.
Definition: libusb.h:353
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
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
The device is operating at full speed (12MBit/s).
Definition: libusb.h:1035
int libusb_get_device_speed(libusb_device *dev)
Get the negotiated connection speed for a device.
Definition: core.c:1009
Set device address for all future accesses.
Definition: libusb.h:368
int fd
Numeric file descriptor.
Definition: libusb.h:1894
A structure representing the Container ID descriptor.
Definition: libusb.h:890
uint8_t iManufacturer
Index of string descriptor describing manufacturer.
Definition: libusb.h:571
USB 2.0 extensions.
Definition: libusb.h:520
The device is operating at super speed plus (10000MBit/s).
Definition: libusb.h:1044
uint8_t iInterface
Index of string descriptor describing this interface.
Definition: libusb.h:667
int libusb_handle_events(libusb_context *ctx)
Handle any pending events in blocking mode.
Definition: io.c:2431
The generic USB transfer structure.
Definition: libusb.h:1229
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
Automatically call libusb_free_transfer() after callback returns.
Definition: libusb.h:1169
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_descriptor_type
Descriptor types as defined by the USB specification.
Definition: libusb.h:252
Endpoint.
Definition: libusb.h:429
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
The device is operating at high speed (480MBit/s).
Definition: libusb.h:1038
unsigned int timeout
Timeout for this transfer in milliseconds.
Definition: libusb.h:1244
void libusb_lock_event_waiters(libusb_context *ctx)
Acquire the event waiters lock.
Definition: io.c:1976
Used to update existing descriptors or add new descriptors.
Definition: libusb.h:374
Wireless USB device capability.
Definition: libusb.h:517
Smart Card.
Definition: libusb.h:223
Control endpoint.
Definition: libusb.h:339
libusb_bos_type
USB capability types.
Definition: libusb.h:515
void libusb_unref_device(libusb_device *dev)
Decrement the reference count of a device.
Definition: core.c:1180
uint8_t bDevCapabilityType
Device Capability type.
Definition: libusb.h:786
int libusb_pollfds_handle_timeouts(libusb_context *ctx)
Determines whether your application must apply special timing considerations when monitoring libusb&#39;s...
Definition: io.c:2529
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
libusb_transfer_cb_fn callback
Callback function.
Definition: libusb.h:1265
A structure representing the standard USB interface descriptor.
Definition: libusb.h:636
const uint16_t minor
Library minor version.
Definition: libusb.h:961
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:2635
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
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:735
Out: host-to-device.
Definition: libusb.h:325
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:1643
A structure representing the standard USB device descriptor.
Definition: libusb.h:534
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
Insufficient memory.
Definition: libusb.h:1089
uint8_t bmRequestType
Request type.
Definition: libusb.h:922
int libusb_set_configuration(libusb_device_handle *dev_handle, int configuration)
Set the active configuration for a device.
Definition: core.c:1626
libusb_transfer_type
Transfer type.
Definition: libusb.h:1106
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:590
Human Interface Device class.
Definition: libusb.h:201
Mass storage class.
Definition: libusb.h:214
struct libusb_device libusb_device
Structure representing a USB device detected on the system.
Definition: libusb.h:1011
uint8_t bEndpointAddress
The address of the endpoint described by this descriptor.
Definition: libusb.h:600
Get the current device configuration value.
Definition: libusb.h:377
Printer class.
Definition: libusb.h:211
Resource busy.
Definition: libusb.h:1074
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
Get the specified descriptor.
Definition: libusb.h:371
Content Security.
Definition: libusb.h:226
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
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:1532
Other error.
Definition: libusb.h:1098
const char * libusb_strerror(int errcode)
Returns a constant string with a short description of the given error code, this description is inten...
Definition: strerror.c:213
const struct libusb_interface * interface
Array of interfaces supported by this configuration.
Definition: libusb.h:731
libusb_request_recipient
Recipient bits of the bmRequestType field in control transfers.
Definition: libusb.h:421
int libusb_reset_device(libusb_device_handle *dev_handle)
Perform a USB port reset to reinitialize a device.
Definition: core.c:1823
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:749
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:643
A structure representing the superspeed endpoint companion descriptor.
Definition: libusb.h:747
libusb_error
Error codes.
Definition: libusb.h:1054
SuperSpeed Hub descriptor.
Definition: libusb.h:287
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:678
const struct libusb_interface_descriptor * altsetting
Array of interface descriptors.
Definition: libusb.h:687
struct libusb_iso_packet_descriptor iso_packet_desc[ZERO_SIZED_ARRAY]
Isochronous packet descriptors, for isochronous transfers only.
Definition: libusb.h:1287
libusb_hotplug_event
Since version 1.0.16, LIBUSB_API_VERSION >= 0x01000102.
Definition: libusb.h:1953
void libusb_lock_events(libusb_context *ctx)
Acquire the event handling lock, blocking until successful acquisition if it is contended.
Definition: io.c:1832
Use the UsbDk backend for a specific context, if available.
Definition: libusb.h:2106
libusb_supported_speed
Supported speeds (wSpeedSupported) bitfield.
Definition: libusb.h:478
libusb_hotplug_flag
Since version 1.0.16, LIBUSB_API_VERSION >= 0x01000102.
Definition: libusb.h:1968
const uint16_t major
Library major version.
Definition: libusb.h:958
uint8_t bU1DevExitLat
U1 Device Exit Latency.
Definition: libusb.h:879
A structure representing the Binary Device Object Store (BOS) descriptor.
Definition: libusb.h:797
Data class.
Definition: libusb.h:220
libusb_transfer_status
Transfer status codes.
Definition: libusb.h:1125
Interface.
Definition: libusb.h:426
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
Miscellaneous class.
Definition: libusb.h:241
Control transfer.
Definition: libusb.h:1108
const uint16_t micro
Library micro version.
Definition: libusb.h:964
unsigned int actual_length
Amount of data that was actually transferred.
Definition: libusb.h:1204
int num_altsetting
The number of alternate settings that belong to this interface.
Definition: libusb.h:691
(3) : Informational, warning and error messages are emitted
Definition: libusb.h:1327
libusb_request_type
Request type bits of the bmRequestType field in control transfers.
Definition: libusb.h:403
int libusb_hotplug_callback_handle
Callback handle.
Definition: libusb.h:1946
void libusb_unlock_event_waiters(libusb_context *ctx)
Release the event waiters lock.
Definition: io.c:1987
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:824
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:1697
uint8_t bInterfaceClass
USB-IF class code for this interface.
Definition: libusb.h:656
(2) : Warning and error messages are emitted
Definition: libusb.h:1324
int libusb_has_capability(uint32_t capability)
Check at runtime if the loaded library has a given capability.
Definition: core.c:2474
libusb_log_cb_mode
Log callback mode.
Definition: libusb.h:1340
int libusb_get_next_timeout(libusb_context *ctx, struct timeval *tv)
Determine the next internal timeout that libusb needs to handle.
Definition: io.c:2563
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
Transfer timed out.
Definition: libusb.h:1134
int libusb_handle_events_completed(libusb_context *ctx, int *completed)
Handle any pending events in blocking mode.
Definition: io.c:2453
Operation timed out.
Definition: libusb.h:1077
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
Adaptive.
Definition: libusb.h:450
libusb_iso_usage_type
Usage type for isochronous endpoints.
Definition: libusb.h:463
uint16_t wValue
Value.
Definition: libusb.h:932
void libusb_transfer_set_stream_id(struct libusb_transfer *transfer, uint32_t stream_id)
Set a transfers bulk stream id.
Definition: io.c:1649
Standard.
Definition: libusb.h:405
Physical descriptor.
Definition: libusb.h:281
High speed operation supported (480MBit/s).
Definition: libusb.h:486
Full speed operation supported (12MBit/s).
Definition: libusb.h:483
void libusb_unlock_events(libusb_context *ctx)
Release the lock previously acquired with libusb_try_lock_events() or libusb_lock_events().
Definition: io.c:1847
uint8_t bmAttributes
Configuration characteristics.
Definition: libusb.h:721
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:706
int length
Length of the data buffer.
Definition: libusb.h:1256
Report short frames as errors.
Definition: libusb.h:1157
void * user_data
User context data.
Definition: libusb.h:1277
No synchronization.
Definition: libusb.h:444
uint8_t bNumEndpoints
Number of endpoints used by this interface (excluding the control endpoint).
Definition: libusb.h:653
uint16_t wIndex
Index.
Definition: libusb.h:936
int libusb_handle_events_timeout(libusb_context *ctx, struct timeval *tv)
Handle any pending events.
Definition: io.c:2411
BOS descriptor.
Definition: libusb.h:269
Transfer completed without error.
Definition: libusb.h:1128
Hub descriptor.
Definition: libusb.h:284
Wireless class.
Definition: libusb.h:238
A structure representing the USB 2.0 Extension descriptor This descriptor is documented in section 9...
Definition: libusb.h:822
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:834
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:1721
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:2691
String descriptor.
Definition: libusb.h:260
Synchronous.
Definition: libusb.h:453
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:855
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:799
Image class.
Definition: libusb.h:207
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
Setup packet for control transfers.
Definition: libusb.h:916
const struct libusb_version * libusb_get_version(void)
Returns a pointer to const struct libusb_version with the version (major, minor, micro, nano and rc) of the running library.
Definition: core.c:2746
The device is operating at super speed (5000MBit/s).
Definition: libusb.h:1041
void libusb_set_log_cb(libusb_context *ctx, libusb_log_cb cb, int mode)
Set log handler.
Definition: core.c:2139
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
Transfer failed.
Definition: libusb.h:1131
libusb_device * libusb_get_parent(libusb_device *dev)
Get the the parent from the specified device.
Definition: core.c:988
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:897
libusb_device_handle * dev_handle
Handle of the device that this transfer will be submitted to.
Definition: libusb.h:1231
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:829
uint8_t bNumDeviceCaps
The number of separate device capability descriptors in the BOS.
Definition: libusb.h:811
uint16_t wTotalLength
Total length of data returned for this configuration.
Definition: libusb.h:709
uint16_t idProduct
USB-IF product ID.
Definition: libusb.h:565
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:2481
Configuration descriptor.
Definition: libusb.h:257
uint16_t wTotalLength
Length of this descriptor and all of its sub descriptors.
Definition: libusb.h:807
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:1581
Return the selected alternate setting for the specified interface.
Definition: libusb.h:383
Endpoint descriptor.
Definition: libusb.h:266
Class.
Definition: libusb.h:408
Clear or disable a specific feature.
Definition: libusb.h:358
uint16_t wLength
Number of bytes to transfer.
Definition: libusb.h:939
Bulk endpoint.
Definition: libusb.h:345
Video.
Definition: libusb.h:229
uint16_t idVendor
USB-IF vendor ID.
Definition: libusb.h:562
int libusb_set_option(libusb_context *ctx, enum libusb_option option,...)
Set an option in the library.
Definition: core.c:2185
uint8_t bInterfaceSubClass
USB-IF subclass code for this interface, qualified by the bInterfaceClass value.
Definition: libusb.h:660
A structure representing the standard USB endpoint descriptor.
Definition: libusb.h:588
The library supports detaching of the default USB driver, using libusb_detach_kernel_driver(), if one is set by the OS kernel.
Definition: libusb.h:1310
void(* libusb_transfer_cb_fn)(struct libusb_transfer *transfer)
Asynchronous transfer callback function type.
Definition: libusb.h:1221
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:850
uint8_t bConfigurationValue
Identifier value for this configuration.
Definition: libusb.h:715
No such device (it may have been disconnected)
Definition: libusb.h:1068
int num_iso_packets
Number of isochronous packets.
Definition: libusb.h:1284
libusb_transfer_flags
libusb_transfer.flags values
Definition: libusb.h:1155
Interrupt transfer.
Definition: libusb.h:1117
libusb_device * libusb_ref_device(libusb_device *dev)
Increment the reference count of a device.
Definition: core.c:1165
int actual_length
Actual length of data that was transferred.
Definition: libusb.h:1261
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:541
In: device-to-host.
Definition: libusb.h:328
Application class.
Definition: libusb.h:244
Superspeed operation supported (5000MBit/s).
Definition: libusb.h:489
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:701
struct libusb_device_handle libusb_device_handle
Structure representing a handle on a USB device.
Definition: libusb.h:1022
int libusb_handle_events_timeout_completed(libusb_context *ctx, struct timeval *tv, int *completed)
Handle any pending events.
Definition: io.c:2339
libusb_endpoint_transfer_type
Endpoint transfer type.
Definition: libusb.h:337
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
Transfer was cancelled.
Definition: libusb.h:1137
For bulk/interrupt endpoints: halt condition detected (endpoint stalled).
Definition: libusb.h:1141
uint8_t bMaxPacketSize0
Maximum packet size for endpoint 0.
Definition: libusb.h:559
uint32_t libusb_transfer_get_stream_id(struct libusb_transfer *transfer)
Get a transfers bulk stream id.
Definition: io.c:1666
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
Personal Healthcare.
Definition: libusb.h:232
uint8_t iProduct
Index of string descriptor describing product.
Definition: libusb.h:574
Delay from the time a host transmits a packet to the time it is received by the device.
Definition: libusb.h:396
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:1854
Set the log message verbosity.
Definition: libusb.h:2097
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:2003
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:892
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
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:804
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:2743
libusb_capability
Capabilities supported by an instance of libusb on the current running platform.
Definition: libusb.h:1295
Bulk stream transfer.
Definition: libusb.h:1120
int libusb_submit_transfer(struct libusb_transfer *transfer)
Submit a transfer.
Definition: io.c:1490
Select an alternate interface for the specified interface.
Definition: libusb.h:386
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:738
int libusb_clear_halt(libusb_device_handle *dev_handle, unsigned char endpoint)
Clear the halt/stall condition for an endpoint.
Definition: core.c:1794
uint32_t bmAttributes
Bitmap encoding of supported device level features.
Definition: libusb.h:840
uint16_t wBytesPerInterval
The total number of bytes this EP will transfer every service interval.
Definition: libusb.h:768
uint8_t iConfiguration
Index of string descriptor describing this configuration.
Definition: libusb.h:718
unsigned int length
Length of data to request in this packet.
Definition: libusb.h:1201
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:675
uint8_t bAlternateSetting
Value used to select this alternate setting for this interface.
Definition: libusb.h:649
Implicit feedback Data endpoint.
Definition: libusb.h:471
libusb_log_level
Log message levels.
Definition: libusb.h:1316
Device sent more data than requested.
Definition: libusb.h:1147
Pipe error.
Definition: libusb.h:1083
Request status of the specific recipient.
Definition: libusb.h:355
libusb_device * libusb_get_device(libusb_device_handle *dev_handle)
Get the underlying device for a device handle.
Definition: core.c:1514
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
Vendor.
Definition: libusb.h:411
Communications class.
Definition: libusb.h:198
unsigned char endpoint
Address of the endpoint where this transfer will be sent.
Definition: libusb.h:1237
Do not scan for devices.
Definition: libusb.h:2125
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
uint8_t bInterfaceProtocol
USB-IF protocol code for this interface, qualified by the bInterfaceClass and bInterfaceSubClass valu...
Definition: libusb.h:664
Automatically free() transfer buffer during libusb_free_transfer().
Definition: libusb.h:1163
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
uint16_t bcdUSB
USB specification release number in binary-coded decimal.
Definition: libusb.h:545
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
Interrupt endpoint.
Definition: libusb.h:348
Structure providing the version of the libusb runtime.
Definition: libusb.h:956
Device descriptor.
Definition: libusb.h:254
int libusb_init(libusb_context **ctx)
Initialize libusb.
Definition: core.c:2280
uint8_t bMaxBurst
The maximum number of packets the endpoint can send or receive as part of a burst.
Definition: libusb.h:758
uint16_t wSpeedSupported
Bitmap encoding of the speed supported by this device when operating in SuperSpeed mode...
Definition: libusb.h:870
Set or enable a specific feature.
Definition: libusb.h:363
Set device configuration.
Definition: libusb.h:380
const struct libusb_endpoint_descriptor * endpoint
Array of endpoint descriptors.
Definition: libusb.h:671
int libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *path, uint8_t path_length)
Definition: core.c:968
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
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
#define LIBUSB_CALL
libusb&#39;s Windows calling convention.
Definition: libusb.h:122
Isochronous packet descriptor.
Definition: libusb.h:1199
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:754
const char * rc
Library release candidate suffix string, e.g.
Definition: libusb.h:970
void libusb_hotplug_deregister_callback(libusb_context *ctx, libusb_hotplug_callback_handle callback_handle)
Deregisters a hotplug callback.
Definition: hotplug.c:407
Set then report an endpoint&#39;s synchronization frame.
Definition: libusb.h:389
Hotplug support is available on this platform.
Definition: libusb.h:1300
SuperSpeed USB device capability.
Definition: libusb.h:523
uint8_t MaxPower
Maximum power consumption of the USB device from this bus in this configuration when the device is fu...
Definition: libusb.h:727
void libusb_set_debug(libusb_context *ctx, int level)
Definition: core.c:2102
HID report descriptor.
Definition: libusb.h:278
unsigned char type
Type of the transfer from libusb_transfer_type.
Definition: libusb.h:1240
Callback function handling all log messages.
Definition: libusb.h:1342
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:1503
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
uint8_t bRefresh
For audio devices only: the rate at which synchronization feedback is provided.
Definition: libusb.h:618
libusb_usb_2_0_extension_attributes
Masks for the bits of the bmAttributes field of the USB 2.0 Extension descriptor. ...
Definition: libusb.h:497
In the context of a device descriptor, this bDeviceClass value indicates that each interface specifie...
Definition: libusb.h:192