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 Nathan Hjelm <hjelmn@cs.unm.edu>
7  * For more information, please visit: http://libusb.info
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2.1 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with this library; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22  */
23 
24 #ifndef LIBUSB_H
25 #define LIBUSB_H
26 
27 #ifdef _MSC_VER
28 /* on MS environments, the inline keyword is available in C++ only */
29 #if !defined(__cplusplus)
30 #define inline __inline
31 #endif
32 /* ssize_t is also not available (copy/paste from MinGW) */
33 #ifndef _SSIZE_T_DEFINED
34 #define _SSIZE_T_DEFINED
35 #undef ssize_t
36 #ifdef _WIN64
37  typedef __int64 ssize_t;
38 #else
39  typedef int ssize_t;
40 #endif /* _WIN64 */
41 #endif /* _SSIZE_T_DEFINED */
42 #endif /* _MSC_VER */
43 
44 /* stdint.h is not available on older MSVC */
45 #if defined(_MSC_VER) && (_MSC_VER < 1600) && (!defined(_STDINT)) && (!defined(_STDINT_H))
46 typedef unsigned __int8 uint8_t;
47 typedef unsigned __int16 uint16_t;
48 typedef unsigned __int32 uint32_t;
49 #else
50 #include <stdint.h>
51 #endif
52 
53 #if !defined(_WIN32_WCE)
54 #include <sys/types.h>
55 #endif
56 
57 #if defined(__linux) || defined(__APPLE__) || defined(__CYGWIN__)
58 #include <sys/time.h>
59 #endif
60 
61 #include <time.h>
62 #include <limits.h>
63 
64 /* 'interface' might be defined as a macro on Windows, so we need to
65  * undefine it so as not to break the current libusb API, because
66  * libusb_config_descriptor has an 'interface' member
67  * As this can be problematic if you include windows.h after libusb.h
68  * in your sources, we force windows.h to be included first. */
69 #if defined(_WIN32) || defined(__CYGWIN__) || defined(_WIN32_WCE)
70 #include <windows.h>
71 #if defined(interface)
72 #undef interface
73 #endif
74 #if !defined(__CYGWIN__)
75 #include <winsock.h>
76 #endif
77 #endif
78 
79 #if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5)
80 #define LIBUSB_DEPRECATED_FOR(f) \
81  __attribute__((deprecated("Use " #f " instead")))
82 #else
83 #define LIBUSB_DEPRECATED_FOR(f)
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__) || defined(_WIN32_WCE)
119 #define LIBUSB_CALL WINAPI
120 #else
121 #define LIBUSB_CALL
122 #endif
123 
147 #define LIBUSB_API_VERSION 0x01000103
148 
149 /* The following is kept for compatibility, but will be deprecated in the future */
150 #define LIBUSBX_API_VERSION LIBUSB_API_VERSION
151 
152 #ifdef __cplusplus
153 extern "C" {
154 #endif
155 
164 static inline uint16_t libusb_cpu_to_le16(const uint16_t x)
165 {
166  union {
167  uint8_t b8[2];
168  uint16_t b16;
169  } _tmp;
170  _tmp.b8[1] = (uint8_t) (x >> 8);
171  _tmp.b8[0] = (uint8_t) (x & 0xff);
172  return _tmp.b16;
173 }
174 
183 #define libusb_le16_to_cpu libusb_cpu_to_le16
184 
185 /* standard USB stuff */
186 
195 
198 
201 
204 
207 
210 
212  LIBUSB_CLASS_PTP = 6, /* legacy name from libusb-0.1 usb.h */
213  LIBUSB_CLASS_IMAGE = 6,
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 ((LIBUSB_DT_BOS_SIZE) +\
310  (LIBUSB_BT_USB_2_0_EXTENSION_SIZE) +\
311  (LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE) +\
312  (LIBUSB_BT_CONTAINER_ID_SIZE))
313 
314 #define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f /* in bEndpointAddress */
315 #define LIBUSB_ENDPOINT_DIR_MASK 0x80
316 
324 
327 };
328 
329 #define LIBUSB_TRANSFER_TYPE_MASK 0x03 /* in bmAttributes */
330 
338 
341 
344 
347 
350 };
351 
357 
360 
361  /* 0x02 is reserved */
362 
365 
366  /* 0x04 is reserved */
367 
370 
373 
376 
379 
382 
385 
388 
391 
394 
398 };
399 
407 
410 
413 
416 };
417 
425 
428 
431 
434 };
435 
436 #define LIBUSB_ISO_SYNC_TYPE_MASK 0x0C
437 
446 
449 
452 
455 };
456 
457 #define LIBUSB_ISO_USAGE_TYPE_MASK 0x30
458 
467 
470 
473 };
474 
482  uint8_t bLength;
483 
488 
491  uint16_t bcdUSB;
492 
494  uint8_t bDeviceClass;
495 
499 
503 
506 
508  uint16_t idVendor;
509 
511  uint16_t idProduct;
512 
514  uint16_t bcdDevice;
515 
517  uint8_t iManufacturer;
518 
520  uint8_t iProduct;
521 
523  uint8_t iSerialNumber;
524 
527 };
528 
536  uint8_t bLength;
537 
542 
548 
556  uint8_t bmAttributes;
557 
559  uint16_t wMaxPacketSize;
560 
562  uint8_t bInterval;
563 
566  uint8_t bRefresh;
567 
569  uint8_t bSynchAddress;
570 
573  const unsigned char *extra;
574 
577 };
578 
586  uint8_t bLength;
587 
592 
595 
598 
601  uint8_t bNumEndpoints;
602 
605 
609 
613 
615  uint8_t iInterface;
616 
620 
623  const unsigned char *extra;
624 
627 };
628 
636 
639 };
640 
648  uint8_t bLength;
649 
654 
656  uint16_t wTotalLength;
657 
659  uint8_t bNumInterfaces;
660 
663 
665  uint8_t iConfiguration;
666 
668  uint8_t bmAttributes;
669 
673  uint8_t MaxPower;
674 
678 
681  const unsigned char *extra;
682 
685 };
686 
694 
696  uint8_t bLength;
697 
702 
703 
706  uint8_t bMaxBurst;
707 
712  uint8_t bmAttributes;
713 
717 };
718 
726  uint8_t bLength;
734  uint8_t dev_capability_data
735 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
736  [] /* valid C99 code */
737 #else
738  [0] /* non-standard, but usually working code */
739 #endif
740  ;
741 };
742 
750  uint8_t bLength;
751 
756 
758  uint16_t wTotalLength;
759 
762  uint8_t bNumDeviceCaps;
763 
766 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
767  [] /* valid C99 code */
768 #else
769  [0] /* non-standard, but usually working code */
770 #endif
771  ;
772 };
773 
781  uint8_t bLength;
782 
787 
792 
797  uint32_t bmAttributes;
798 };
799 
807  uint8_t bLength;
808 
813 
818 
823  uint8_t bmAttributes;
824 
827  uint16_t wSpeedSupported;
828 
834 
836  uint8_t bU1DevExitLat;
837 
839  uint16_t bU2DevExitLat;
840 };
841 
849  uint8_t bLength;
850 
855 
860 
862  uint8_t bReserved;
863 
865  uint8_t ContainerID[16];
866 };
867 
876  uint8_t bmRequestType;
877 
883  uint8_t bRequest;
884 
886  uint16_t wValue;
887 
890  uint16_t wIndex;
891 
893  uint16_t wLength;
894 };
895 
896 #define LIBUSB_CONTROL_SETUP_SIZE (sizeof(struct libusb_control_setup))
897 
898 /* libusb */
899 
900 struct libusb_context;
901 struct libusb_device;
902 struct libusb_device_handle;
903 struct libusb_hotplug_callback;
904 
910  const uint16_t major;
911 
913  const uint16_t minor;
914 
916  const uint16_t micro;
917 
919  const uint16_t nano;
920 
922  const char *rc;
923 
925  const char* describe;
926 };
927 
946 
963 
964 
974 
981 
984 
987 
990 
993 };
994 
1002 
1005 
1008 
1011 };
1012 
1021 };
1022 
1031 };
1032 
1039 
1042 
1045 
1048 };
1049 
1060 
1063 
1066 
1069 
1072 
1075 
1078 
1081 
1084 
1087 
1090 
1093 
1096 
1097  /* NB: Remember to update LIBUSB_ERROR_COUNT below as well as the
1098  message strings in strerror.c when adding new error codes here. */
1099 
1102 };
1103 
1104 /* Total number of error codes in enum libusb_error */
1105 #define LIBUSB_ERROR_COUNT 14
1106 
1113 
1116 
1119 
1122 
1126 
1129 
1132 
1133  /* NB! Remember to update libusb_error_name()
1134  when adding new status codes here. */
1135 };
1136 
1142 
1145 
1151 
1176 };
1177 
1182  unsigned int length;
1183 
1185  unsigned int actual_length;
1186 
1189 };
1190 
1191 struct libusb_transfer;
1192 
1202 typedef void (LIBUSB_CALL *libusb_transfer_cb_fn)(struct libusb_transfer *transfer);
1203 
1213 
1215  uint8_t flags;
1216 
1218  unsigned char endpoint;
1219 
1221  unsigned char type;
1222 
1225  unsigned int timeout;
1226 
1235 
1237  int length;
1238 
1243 
1247 
1249  void *user_data;
1250 
1252  unsigned char *buffer;
1253 
1257 
1260 #if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
1261  [] /* valid C99 code */
1262 #else
1263  [0] /* non-standard, but usually working code */
1264 #endif
1265  ;
1266 };
1267 
1286 };
1287 
1299  LIBUSB_LOG_LEVEL_NONE = 0,
1300  LIBUSB_LOG_LEVEL_ERROR,
1301  LIBUSB_LOG_LEVEL_WARNING,
1302  LIBUSB_LOG_LEVEL_INFO,
1303  LIBUSB_LOG_LEVEL_DEBUG,
1304 };
1305 
1308 void LIBUSB_CALL libusb_set_debug(libusb_context *ctx, int level);
1309 const struct libusb_version * LIBUSB_CALL libusb_get_version(void);
1310 int LIBUSB_CALL libusb_has_capability(uint32_t capability);
1311 const char * LIBUSB_CALL libusb_error_name(int errcode);
1312 int LIBUSB_CALL libusb_setlocale(const char *locale);
1313 const char * LIBUSB_CALL libusb_strerror(enum libusb_error errcode);
1314 
1316  libusb_device ***list);
1318  int unref_devices);
1321 
1323  int *config);
1325  struct libusb_device_descriptor *desc);
1327  struct libusb_config_descriptor **config);
1329  uint8_t config_index, struct libusb_config_descriptor **config);
1331  uint8_t bConfigurationValue, struct libusb_config_descriptor **config);
1333  struct libusb_config_descriptor *config);
1335  struct libusb_context *ctx,
1336  const struct libusb_endpoint_descriptor *endpoint,
1337  struct libusb_ss_endpoint_companion_descriptor **ep_comp);
1339  struct libusb_ss_endpoint_companion_descriptor *ep_comp);
1341  struct libusb_bos_descriptor **bos);
1344  struct libusb_context *ctx,
1345  struct libusb_bos_dev_capability_descriptor *dev_cap,
1346  struct libusb_usb_2_0_extension_descriptor **usb_2_0_extension);
1348  struct libusb_usb_2_0_extension_descriptor *usb_2_0_extension);
1350  struct libusb_context *ctx,
1351  struct libusb_bos_dev_capability_descriptor *dev_cap,
1352  struct libusb_ss_usb_device_capability_descriptor **ss_usb_device_cap);
1354  struct libusb_ss_usb_device_capability_descriptor *ss_usb_device_cap);
1356  struct libusb_bos_dev_capability_descriptor *dev_cap,
1357  struct libusb_container_id_descriptor **container_id);
1359  struct libusb_container_id_descriptor *container_id);
1362 int LIBUSB_CALL libusb_get_port_numbers(libusb_device *dev, uint8_t* port_numbers, int port_numbers_len);
1363 LIBUSB_DEPRECATED_FOR(libusb_get_port_numbers)
1364 int LIBUSB_CALL libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t* path, uint8_t path_length);
1369  unsigned char endpoint);
1371  unsigned char endpoint);
1372 
1376 
1378  int configuration);
1380  int interface_number);
1382  int interface_number);
1383 
1385  libusb_context *ctx, uint16_t vendor_id, uint16_t product_id);
1386 
1388  int interface_number, int alternate_setting);
1390  unsigned char endpoint);
1392 
1394  uint32_t num_streams, unsigned char *endpoints, int num_endpoints);
1396  unsigned char *endpoints, int num_endpoints);
1397 
1399  int interface_number);
1401  int interface_number);
1403  int interface_number);
1405  libusb_device_handle *dev, int enable);
1406 
1407 /* async I/O */
1408 
1421 static inline unsigned char *libusb_control_transfer_get_data(
1422  struct libusb_transfer *transfer)
1423 {
1424  return transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
1425 }
1426 
1440  struct libusb_transfer *transfer)
1441 {
1442  return (struct libusb_control_setup *)(void *) transfer->buffer;
1443 }
1444 
1468 static inline void libusb_fill_control_setup(unsigned char *buffer,
1469  uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
1470  uint16_t wLength)
1471 {
1472  struct libusb_control_setup *setup = (struct libusb_control_setup *)(void *) buffer;
1473  setup->bmRequestType = bmRequestType;
1474  setup->bRequest = bRequest;
1475  setup->wValue = libusb_cpu_to_le16(wValue);
1476  setup->wIndex = libusb_cpu_to_le16(wIndex);
1477  setup->wLength = libusb_cpu_to_le16(wLength);
1478 }
1479 
1480 struct libusb_transfer * LIBUSB_CALL libusb_alloc_transfer(int iso_packets);
1481 int LIBUSB_CALL libusb_submit_transfer(struct libusb_transfer *transfer);
1482 int LIBUSB_CALL libusb_cancel_transfer(struct libusb_transfer *transfer);
1483 void LIBUSB_CALL libusb_free_transfer(struct libusb_transfer *transfer);
1485  struct libusb_transfer *transfer, uint32_t stream_id);
1487  struct libusb_transfer *transfer);
1488 
1517 static inline void libusb_fill_control_transfer(
1518  struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1519  unsigned char *buffer, libusb_transfer_cb_fn callback, void *user_data,
1520  unsigned int timeout)
1521 {
1522  struct libusb_control_setup *setup = (struct libusb_control_setup *)(void *) buffer;
1523  transfer->dev_handle = dev_handle;
1524  transfer->endpoint = 0;
1525  transfer->type = LIBUSB_TRANSFER_TYPE_CONTROL;
1526  transfer->timeout = timeout;
1527  transfer->buffer = buffer;
1528  if (setup)
1529  transfer->length = (int) (LIBUSB_CONTROL_SETUP_SIZE
1530  + libusb_le16_to_cpu(setup->wLength));
1531  transfer->user_data = user_data;
1532  transfer->callback = callback;
1533 }
1534 
1548 static inline void libusb_fill_bulk_transfer(struct libusb_transfer *transfer,
1549  libusb_device_handle *dev_handle, unsigned char endpoint,
1550  unsigned char *buffer, int length, libusb_transfer_cb_fn callback,
1551  void *user_data, unsigned int timeout)
1552 {
1553  transfer->dev_handle = dev_handle;
1554  transfer->endpoint = endpoint;
1555  transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1556  transfer->timeout = timeout;
1557  transfer->buffer = buffer;
1558  transfer->length = length;
1559  transfer->user_data = user_data;
1560  transfer->callback = callback;
1561 }
1562 
1580  struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1581  unsigned char endpoint, uint32_t stream_id,
1582  unsigned char *buffer, int length, libusb_transfer_cb_fn callback,
1583  void *user_data, unsigned int timeout)
1584 {
1585  libusb_fill_bulk_transfer(transfer, dev_handle, endpoint, buffer,
1586  length, callback, user_data, timeout);
1588  libusb_transfer_set_stream_id(transfer, stream_id);
1589 }
1590 
1605  struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1606  unsigned char endpoint, unsigned char *buffer, int length,
1607  libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
1608 {
1609  transfer->dev_handle = dev_handle;
1610  transfer->endpoint = endpoint;
1612  transfer->timeout = timeout;
1613  transfer->buffer = buffer;
1614  transfer->length = length;
1615  transfer->user_data = user_data;
1616  transfer->callback = callback;
1617 }
1618 
1633 static inline void libusb_fill_iso_transfer(struct libusb_transfer *transfer,
1634  libusb_device_handle *dev_handle, unsigned char endpoint,
1635  unsigned char *buffer, int length, int num_iso_packets,
1636  libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
1637 {
1638  transfer->dev_handle = dev_handle;
1639  transfer->endpoint = endpoint;
1641  transfer->timeout = timeout;
1642  transfer->buffer = buffer;
1643  transfer->length = length;
1644  transfer->num_iso_packets = num_iso_packets;
1645  transfer->user_data = user_data;
1646  transfer->callback = callback;
1647 }
1648 
1658  struct libusb_transfer *transfer, unsigned int length)
1659 {
1660  int i;
1661  for (i = 0; i < transfer->num_iso_packets; i++)
1662  transfer->iso_packet_desc[i].length = length;
1663 }
1664 
1681 static inline unsigned char *libusb_get_iso_packet_buffer(
1682  struct libusb_transfer *transfer, unsigned int packet)
1683 {
1684  int i;
1685  size_t offset = 0;
1686  int _packet;
1687 
1688  /* oops..slight bug in the API. packet is an unsigned int, but we use
1689  * signed integers almost everywhere else. range-check and convert to
1690  * signed to avoid compiler warnings. FIXME for libusb-2. */
1691  if (packet > INT_MAX)
1692  return NULL;
1693  _packet = (int) packet;
1694 
1695  if (_packet >= transfer->num_iso_packets)
1696  return NULL;
1697 
1698  for (i = 0; i < _packet; i++)
1699  offset += transfer->iso_packet_desc[i].length;
1700 
1701  return transfer->buffer + offset;
1702 }
1703 
1723 static inline unsigned char *libusb_get_iso_packet_buffer_simple(
1724  struct libusb_transfer *transfer, unsigned int packet)
1725 {
1726  int _packet;
1727 
1728  /* oops..slight bug in the API. packet is an unsigned int, but we use
1729  * signed integers almost everywhere else. range-check and convert to
1730  * signed to avoid compiler warnings. FIXME for libusb-2. */
1731  if (packet > INT_MAX)
1732  return NULL;
1733  _packet = (int) packet;
1734 
1735  if (_packet >= transfer->num_iso_packets)
1736  return NULL;
1737 
1738  return transfer->buffer + ((int) transfer->iso_packet_desc[0].length * _packet);
1739 }
1740 
1741 /* sync I/O */
1742 
1744  uint8_t request_type, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
1745  unsigned char *data, uint16_t wLength, unsigned int timeout);
1746 
1748  unsigned char endpoint, unsigned char *data, int length,
1749  int *actual_length, unsigned int timeout);
1750 
1752  unsigned char endpoint, unsigned char *data, int length,
1753  int *actual_length, unsigned int timeout);
1754 
1768  uint8_t desc_type, uint8_t desc_index, unsigned char *data, int length)
1769 {
1771  LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t) ((desc_type << 8) | desc_index),
1772  0, data, (uint16_t) length, 1000);
1773 }
1774 
1790  uint8_t desc_index, uint16_t langid, unsigned char *data, int length)
1791 {
1793  LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t)((LIBUSB_DT_STRING << 8) | desc_index),
1794  langid, data, (uint16_t) length, 1000);
1795 }
1796 
1798  uint8_t desc_index, unsigned char *data, int length);
1799 
1800 /* polling and timeouts */
1801 
1809 int LIBUSB_CALL libusb_wait_for_event(libusb_context *ctx, struct timeval *tv);
1810 
1812  struct timeval *tv);
1814  struct timeval *tv, int *completed);
1818  struct timeval *tv);
1821  struct timeval *tv);
1822 
1828  int fd;
1829 
1834  short events;
1835 };
1836 
1847 typedef void (LIBUSB_CALL *libusb_pollfd_added_cb)(int fd, short events,
1848  void *user_data);
1849 
1859 typedef void (LIBUSB_CALL *libusb_pollfd_removed_cb)(int fd, void *user_data);
1860 
1862  libusb_context *ctx);
1864  libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb,
1865  void *user_data);
1866 
1880 
1886 typedef enum {
1890 
1896 typedef enum {
1899 
1905 
1908 #define LIBUSB_HOTPLUG_MATCH_ANY -1
1909 
1933  libusb_device *device,
1934  libusb_hotplug_event event,
1935  void *user_data);
1936 
1972  libusb_hotplug_event events,
1973  libusb_hotplug_flag flags,
1974  int vendor_id, int product_id,
1975  int dev_class,
1977  void *user_data,
1978  libusb_hotplug_callback_handle *handle);
1979 
1992  libusb_hotplug_callback_handle handle);
1993 
1994 #ifdef __cplusplus
1995 }
1996 #endif
1997 
1998 #endif
uint8_t dev_capability_data[0]
Device Capability data (bLength - 3 bytes)
Definition: libusb.h:740
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:623
const char * describe
For ABI compatibility only.
Definition: libusb.h:925
The device is operating at full speed (12MBit/s).
Definition: libusb.h:986
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:1073
int libusb_has_capability(uint32_t capability)
Check at runtime if the loaded library has a given capability.
Definition: core.c:2052
uint16_t bU2DevExitLat
U2 Device Exit Latency.
Definition: libusb.h:839
uint8_t bFunctionalitySupport
The lowest speed at which all the functionality supported by the device is available to the user...
Definition: libusb.h:833
int libusb_get_configuration(libusb_device_handle *dev, int *config)
Determine the bConfigurationValue of the currently active configuration.
Definition: core.c:1347
uint8_t bInterfaceNumber
Number of this interface.
Definition: libusb.h:594
uint8_t bSynchAddress
For audio devices only: the address if the synch endpoint.
Definition: libusb.h:569
libusb_request_type
Request type bits of the bmRequestType field in control transfers.
Definition: libusb.h:404
Return the selected alternate setting for the specified interface.
Definition: libusb.h:384
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:1932
Smart Card.
Definition: libusb.h:225
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:738
int libusb_open(libusb_device *dev, libusb_device_handle **handle)
Open a device and obtain a device handle.
Definition: core.c:1086
uint8_t bmAttributes
Attributes which apply to the endpoint when it is configured using the bConfigurationValue.
Definition: libusb.h:556
libusb_iso_sync_type
Synchronization type for isochronous endpoints.
Definition: libusb.h:443
A collection of alternate settings for a particular USB interface.
Definition: libusb.h:632
int libusb_set_interface_alt_setting(libusb_device_handle *dev, int interface_number, int alternate_setting)
Activate an alternate setting for an interface.
Definition: core.c:1548
void libusb_free_transfer(struct libusb_transfer *transfer)
Free a transfer structure.
Definition: io.c:1352
Automatically call libusb_free_transfer() after callback returns.
Definition: libusb.h:1150
void libusb_transfer_set_stream_id(struct libusb_transfer *transfer, uint32_t stream_id)
Set a transfers bulk stream id.
Definition: io.c:1524
uint8_t bReserved
Reserved field.
Definition: libusb.h:862
enum libusb_transfer_status status
Status code for this packet.
Definition: libusb.h:1188
uint8_t bNumConfigurations
Number of possible configurations.
Definition: libusb.h:526
Data endpoint.
Definition: libusb.h:466
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:1738
uint8_t bRequest
Request.
Definition: libusb.h:883
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:940
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:1517
int libusb_wait_for_event(libusb_context *ctx, struct timeval *tv)
Wait for another thread to signal completion of an event.
Definition: io.c:1845
void libusb_hotplug_deregister_callback(libusb_context *ctx, libusb_hotplug_callback_handle handle)
Deregisters a hotplug callback.
Definition: hotplug.c:284
void libusb_exit(libusb_context *ctx)
Deinitialize libusb.
Definition: core.c:1978
Endpoint.
Definition: libusb.h:430
const uint16_t nano
Library nano version.
Definition: libusb.h:919
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:859
libusb_request_recipient
Recipient bits of the bmRequestType field in control transfers.
Definition: libusb.h:422
Data class.
Definition: libusb.h:222
SuperSpeed USB device capability.
Definition: libusb.h:1044
struct libusb_context libusb_context
Structure representing a libusb session.
Definition: libusb.h:945
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:726
uint8_t bDeviceSubClass
USB-IF subclass code for the device, qualified by the bDeviceClass value.
Definition: libusb.h:498
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:730
struct libusb_bos_dev_capability_descriptor * dev_capability[0]
bNumDeviceCap Device Capability Descriptors
Definition: libusb.h:765
A structure representing the standard USB configuration descriptor.
Definition: libusb.h:646
A generic representation of a BOS Device Capability descriptor.
Definition: libusb.h:724
uint8_t bInterval
Interval for polling endpoint for data transfers.
Definition: libusb.h:562
Arm the callback and fire it for all matching currently attached devices.
Definition: libusb.h:1888
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:482
#define LIBUSB_CALL
libusb's Windows calling convention.
Definition: libusb.h:121
Device Capability descriptor.
Definition: libusb.h:271
Set device configuration.
Definition: libusb.h:381
String descriptor.
Definition: libusb.h:259
enum libusb_transfer_status status
The status of the transfer.
Definition: libusb.h:1234
Endpoint descriptor.
Definition: libusb.h:265
const char * libusb_strerror(enum libusb_error errcode)
Returns a constant string with a short description of the given error code, this description is inten...
Definition: strerror.c:189
uint8_t bDeviceClass
USB-IF class code for the device.
Definition: libusb.h:494
short events
Event flags to poll for from <poll.h>.
Definition: libusb.h:1834
int libusb_free_streams(libusb_device_handle *dev, unsigned char *endpoints, int num_endpoints)
Free usb bulk streams allocated with libusb_alloc_streams().
Definition: core.c:1674
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:574
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:576
libusb_speed
Speed codes.
Definition: libusb.h:978
A structure representing the SuperSpeed USB Device Capability descriptor This descriptor is documente...
Definition: libusb.h:805
uint8_t flags
A bitwise OR combination of libusb_transfer_flags.
Definition: libusb.h:1215
int libusb_hotplug_register_callback(libusb_context *ctx, libusb_hotplug_event events, libusb_hotplug_flag flags, int vendor_id, int product_id, int dev_class, libusb_hotplug_callback_fn cb_fn, void *user_data, libusb_hotplug_callback_handle *handle)
Register a hotplug callback function.
Definition: hotplug.c:206
Operation not supported or unimplemented on this platform.
Definition: libusb.h:1095
High speed operation supported (480MBit/s).
Definition: libusb.h:1007
Success (no error)
Definition: libusb.h:1059
int libusb_init(libusb_context **ctx)
Initialize libusb.
Definition: core.c:1866
Class is vendor-specific.
Definition: libusb.h:246
uint8_t bmAttributes
In bulk EP: bits 4:0 represents the maximum number of streams the EP supports.
Definition: libusb.h:712
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:806
void libusb_set_debug(libusb_context *ctx, int level)
Set log message verbosity.
Definition: core.c:1846
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:541
libusb_hotplug_event
Since version 1.0.16, LIBUSB_API_VERSION >= 0x01000102.
Definition: libusb.h:1896
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:830
uint8_t iSerialNumber
Index of string descriptor containing device serial number.
Definition: libusb.h:523
int libusb_handle_events_completed(libusb_context *ctx, int *completed)
Handle any pending events in blocking mode.
Definition: io.c:2267
static int libusb_get_string_descriptor(libusb_device_handle *dev, uint8_t desc_index, uint16_t langid, unsigned char *data, int length)
Retrieve a descriptor from a device.
Definition: libusb.h:1789
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:718
Interrupt endpoint.
Definition: libusb.h:346
Insufficient memory.
Definition: libusb.h:1092
Stream endpoint.
Definition: libusb.h:349
void libusb_unref_device(libusb_device *dev)
Decrement the reference count of a device.
Definition: core.c:994
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:2331
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:586
struct libusb_device_handle libusb_device_handle
Structure representing a handle on a USB device.
Definition: libusb.h:973
Vendor.
Definition: libusb.h:412
File descriptor for polling.
Definition: libusb.h:1826
#define libusb_le16_to_cpu
Convert a 16-bit value from little-endian to host-endian format.
Definition: libusb.h:183
uint8_t bNumInterfaces
Number of interfaces supported by this configuration.
Definition: libusb.h:659
Low speed operation supported (1.5MBit/s).
Definition: libusb.h:1001
void libusb_lock_event_waiters(libusb_context *ctx)
Acquire the event waiters lock.
Definition: io.c:1803
uint8_t bmAttributes
Bitmap encoding of supported device level features.
Definition: libusb.h:823
Superspeed operation supported (5000MBit/s).
Definition: libusb.h:1010
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:301
uint16_t bcdDevice
Device release number in binary-coded decimal.
Definition: libusb.h:514
libusb_descriptor_type
Descriptor types as defined by the USB specification.
Definition: libusb.h:251
unsigned char * buffer
Data buffer.
Definition: libusb.h:1252
int libusb_get_ss_endpoint_companion_descriptor(struct 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:761
Hub descriptor.
Definition: libusb.h:283
No such device (it may have been disconnected)
Definition: libusb.h:1071
uint8_t bDeviceProtocol
USB-IF protocol code for the device, qualified by the bDeviceClass and bDeviceSubClass values...
Definition: libusb.h:502
Entity not found.
Definition: libusb.h:1074
static unsigned char * libusb_control_transfer_get_data(struct libusb_transfer *transfer)
Get the data section of a control transfer.
Definition: libusb.h:1421
int libusb_setlocale(const char *locale)
Set the language, and only the language, not the encoding! used for translatable libusb messages...
Definition: strerror.c:155
uint16_t wMaxPacketSize
Maximum packet size this endpoint is capable of sending/receiving.
Definition: libusb.h:559
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:817
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:573
int libusb_get_next_timeout(libusb_context *ctx, struct timeval *tv)
Determine the next internal timeout that libusb needs to handle.
Definition: io.c:2376
Transfer was cancelled.
Definition: libusb.h:1121
Report short frames as errors.
Definition: libusb.h:1141
int fd
Numeric file descriptor.
Definition: libusb.h:1828
A structure representing the Container ID descriptor.
Definition: libusb.h:847
uint8_t iManufacturer
Index of string descriptor describing manufacturer.
Definition: libusb.h:517
uint8_t iInterface
Index of string descriptor describing this interface.
Definition: libusb.h:615
Set or enable a specific feature.
Definition: libusb.h:364
The generic USB transfer structure.
Definition: libusb.h:1210
Class.
Definition: libusb.h:409
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:1723
int libusb_event_handler_active(libusb_context *ctx)
Determine if an active thread is handling events (i.e.
Definition: io.c:1766
Control endpoint.
Definition: libusb.h:337
Human Interface Device class.
Definition: libusb.h:203
int libusb_detach_kernel_driver(libusb_device_handle *dev, int interface_number)
Detach a kernel driver from an interface.
Definition: core.c:1741
SuperSpeed Endpoint Companion descriptor.
Definition: libusb.h:289
int libusb_handle_events(libusb_context *ctx)
Handle any pending events in blocking mode.
Definition: io.c:2245
BOS descriptor.
Definition: libusb.h:268
Input/output error.
Definition: libusb.h:1062
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:651
int libusb_handle_events_timeout(libusb_context *ctx, struct timeval *tv)
Handle any pending events.
Definition: io.c:2225
unsigned int timeout
Timeout for this transfer in millseconds.
Definition: libusb.h:1225
int libusb_submit_transfer(struct libusb_transfer *transfer)
Submit a transfer.
Definition: io.c:1434
uint32_t libusb_transfer_get_stream_id(struct libusb_transfer *transfer)
Get a transfers bulk stream id.
Definition: io.c:1541
Bulk endpoint.
Definition: libusb.h:343
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:1015
Implicit feedback Data endpoint.
Definition: libusb.h:472
Configuration descriptor.
Definition: libusb.h:256
int libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *path, uint8_t path_length)
Deprecated please use libusb_get_port_numbers instead.
Definition: core.c:800
uint8_t bDevCapabilityType
Device Capability type.
Definition: libusb.h:732
libusb_capability
Capabilities supported by an instance of libusb on the current running platform.
Definition: libusb.h:1273
Synchronous.
Definition: libusb.h:454
libusb_transfer_cb_fn callback
Callback function.
Definition: libusb.h:1246
Device.
Definition: libusb.h:424
int libusb_attach_kernel_driver(libusb_device_handle *dev, int interface_number)
Re-attach an interface's kernel driver, which was previously detached using libusb_detach_kernel_driv...
Definition: core.c:1775
A structure representing the standard USB interface descriptor.
Definition: libusb.h:584
const uint16_t minor
Library minor version.
Definition: libusb.h:913
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:681
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:90
A structure representing the standard USB device descriptor.
Definition: libusb.h:480
static int libusb_get_descriptor(libusb_device_handle *dev, uint8_t desc_type, uint8_t desc_index, unsigned char *data, int length)
Retrieve a descriptor from the default control pipe.
Definition: libusb.h:1767
In the context of a device descriptor, this bDeviceClass value indicates that each interface specifie...
Definition: libusb.h:194
uint8_t bmRequestType
Request type.
Definition: libusb.h:876
Audio class.
Definition: libusb.h:197
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:536
uint8_t bEndpointAddress
The address of the endpoint described by this descriptor.
Definition: libusb.h:547
Standard.
Definition: libusb.h:406
const struct libusb_interface * interface
Array of interfaces supported by this configuration.
Definition: libusb.h:677
Resource busy.
Definition: libusb.h:1077
libusb_endpoint_direction
Endpoint direction.
Definition: libusb.h:321
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:696
uint8_t ContainerID[16]
128 bit UUID
Definition: libusb.h:865
Sets both the U1 and U2 Exit Latency.
Definition: libusb.h:393
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:591
A structure representing the superspeed endpoint companion descriptor.
Definition: libusb.h:693
void libusb_free_bos_descriptor(struct libusb_bos_descriptor *bos)
Free a BOS descriptor obtained from libusb_get_bos_descriptor().
Definition: descriptor.c:951
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:626
const struct libusb_interface_descriptor * altsetting
Array of interface descriptors.
Definition: libusb.h:635
The device is operating at super speed (5000MBit/s).
Definition: libusb.h:992
int libusb_set_auto_detach_kernel_driver(libusb_device_handle *dev, int enable)
Enable/disable libusb's automatic kernel driver detachment.
Definition: core.c:1811
Personal Healthcare.
Definition: libusb.h:234
HID report descriptor.
Definition: libusb.h:277
int libusb_get_usb_2_0_extension_descriptor(struct 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:976
const uint16_t major
Library major version.
Definition: libusb.h:910
uint8_t bU1DevExitLat
U1 Device Exit Latency.
Definition: libusb.h:836
uint8_t libusb_get_port_number(libusb_device *dev)
Get the number of the port that a device is connected to.
Definition: core.c:758
A structure representing the Binary Device Object Store (BOS) descriptor.
Definition: libusb.h:748
Application class.
Definition: libusb.h:243
int libusb_set_configuration(libusb_device_handle *dev, int configuration)
Set the active configuration for a device.
Definition: core.c:1424
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:1604
Supports Latency Tolerance Messages (LTM)
Definition: libusb.h:1030
Interface.
Definition: libusb.h:427
Transfer timed out.
Definition: libusb.h:1118
Video.
Definition: libusb.h:231
A device has been plugged in and is ready to use.
Definition: libusb.h:1898
Printer class.
Definition: libusb.h:209
libusb_usb_2_0_extension_attributes
Masks for the bits of the bmAttributes field of the USB 2.0 Extension descriptor. ...
Definition: libusb.h:1018
const uint16_t micro
Library micro version.
Definition: libusb.h:916
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:2276
Wireless class.
Definition: libusb.h:240
unsigned int actual_length
Amount of data that was actually transferred.
Definition: libusb.h:1185
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:1028
Request status of the specific recipient.
Definition: libusb.h:356
int num_altsetting
The number of alternate settings that belong to this interface.
Definition: libusb.h:638
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:781
libusb_hotplug_flag
Since version 1.0.16, LIBUSB_API_VERSION >= 0x01000102.
Definition: libusb.h:1886
Get the current device configuration value.
Definition: libusb.h:378
uint8_t bInterfaceClass
USB-IF class code for this interface.
Definition: libusb.h:604
void libusb_close(libusb_device_handle *dev_handle)
Close a device handle.
Definition: core.c:1260
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:1633
libusb_transfer_type
Endpoint transfer type.
Definition: libusb.h:335
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:2457
Container ID type.
Definition: libusb.h:1047
int libusb_clear_halt(libusb_device_handle *dev, unsigned char endpoint)
Clear the halt/stall condition for an endpoint.
Definition: core.c:1588
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:1439
void libusb_unlock_events(libusb_context *ctx)
Release the lock previously acquired with libusb_try_lock_events() or libusb_lock_events().
Definition: io.c:1703
uint16_t wValue
Value.
Definition: libusb.h:886
Asynchronous.
Definition: libusb.h:448
void(* libusb_transfer_cb_fn)(struct libusb_transfer *transfer)
Asynchronous transfer callback function type.
Definition: libusb.h:1202
SuperSpeed Hub descriptor.
Definition: libusb.h:286
The library can access HID devices without requiring user intervention.
Definition: libusb.h:1282
Overflow.
Definition: libusb.h:1083
Clear or disable a specific feature.
Definition: libusb.h:359
uint8_t bmAttributes
Configuration characteristics.
Definition: libusb.h:668
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:653
int length
Length of the data buffer.
Definition: libusb.h:1237
USB 2.0 extensions.
Definition: libusb.h:1041
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:707
void * user_data
User context data to pass to the callback function.
Definition: libusb.h:1249
Other.
Definition: libusb.h:433
uint8_t bNumEndpoints
Number of endpoints used by this interface (excluding the control endpoint).
Definition: libusb.h:601
Out: host-to-device.
Definition: libusb.h:326
uint16_t wIndex
Index.
Definition: libusb.h:890
Set then report an endpoint's synchronization frame.
Definition: libusb.h:390
Set device address for all future accesses.
Definition: libusb.h:369
A structure representing the USB 2.0 Extension descriptor This descriptor is documented in section 9...
Definition: libusb.h:779
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:1468
uint8_t bDevCapabilityType
Capability type.
Definition: libusb.h:791
Physical descriptor.
Definition: libusb.h:280
void libusb_unlock_event_waiters(libusb_context *ctx)
Release the event waiters lock.
Definition: io.c:1814
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:812
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:750
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:252
Access denied (insufficient permissions)
Definition: libusb.h:1068
libusb_transfer_status
Transfer status codes.
Definition: libusb.h:1109
Setup packet for control transfers.
Definition: libusb.h:870
Get the specified descriptor.
Definition: libusb.h:372
int libusb_claim_interface(libusb_device_handle *dev, int interface_number)
Claim an interface on a given device handle.
Definition: core.c:1459
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:854
libusb_device_handle * dev_handle
Handle of the device that this transfer will be submitted to.
Definition: libusb.h:1212
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:786
uint8_t bNumDeviceCaps
The number of separate device capability descriptors in the BOS.
Definition: libusb.h:762
libusb_transfer_flags
libusb_transfer.flags values
Definition: libusb.h:1139
uint16_t wTotalLength
Total length of data returned for this configuration.
Definition: libusb.h:656
uint16_t idProduct
USB-IF product ID.
Definition: libusb.h:511
uint16_t wTotalLength
Length of this descriptor and all of its sub descriptors.
Definition: libusb.h:758
Device descriptor.
Definition: libusb.h:253
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:1681
int libusb_hotplug_callback_handle
Callback handle.
Definition: libusb.h:1879
Device sent more data than requested.
Definition: libusb.h:1131
int libusb_try_lock_events(libusb_context *ctx)
Attempt to acquire the event handling lock.
Definition: io.c:1646
void libusb_lock_events(libusb_context *ctx)
Acquire the event handling lock, blocking until successful acquisition if it is contended.
Definition: io.c:1688
Communications class.
Definition: libusb.h:200
uint16_t wLength
Number of bytes to transfer.
Definition: libusb.h:893
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:551
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:2293
uint16_t idVendor
USB-IF vendor ID.
Definition: libusb.h:508
int libusb_kernel_driver_active(libusb_device_handle *dev, int interface_number)
Determine if a kernel driver is active on an interface.
Definition: core.c:1706
uint8_t bInterfaceSubClass
USB-IF subclass code for this interface, qualified by the bInterfaceClass value.
Definition: libusb.h:608
A structure representing the standard USB endpoint descriptor.
Definition: libusb.h:534
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:807
uint8_t bConfigurationValue
Identifier value for this configuration.
Definition: libusb.h:662
libusb_supported_speed
Supported speeds (wSpeedSupported) bitfield.
Definition: libusb.h:999
libusb_bos_type
USB capability types.
Definition: libusb.h:1036
int num_iso_packets
Number of isochronous packets.
Definition: libusb.h:1256
int libusb_handle_events_timeout_completed(libusb_context *ctx, struct timeval *tv, int *completed)
Handle any pending events.
Definition: io.c:2156
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:1156
int actual_length
Actual length of data that was transferred.
Definition: libusb.h:1242
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:487
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:774
Hotplug support is available on this platform.
Definition: libusb.h:1277
The device is operating at low speed (1.5MBit/s).
Definition: libusb.h:983
int libusb_reset_device(libusb_device_handle *dev)
Perform a USB port reset to reinitialize a device.
Definition: core.c:1617
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:648
Transfer completed without error.
Definition: libusb.h:1112
int libusb_get_ss_usb_device_capability_descriptor(struct 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:1034
uint8_t bMaxPacketSize0
Maximum packet size for endpoint 0.
Definition: libusb.h:505
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:1847
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:1859
uint8_t iProduct
Index of string descriptor describing product.
Definition: libusb.h:520
static uint16_t libusb_cpu_to_le16(const uint16_t x)
Convert a 16-bit value from host-endian to little-endian format.
Definition: libusb.h:164
Isochronous endpoint.
Definition: libusb.h:340
int libusb_cancel_transfer(struct libusb_transfer *transfer)
Asynchronously cancel a previously submitted transfer.
Definition: io.c:1486
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:1130
libusb_device * libusb_ref_device(libusb_device *dev)
Increment the reference count of a device.
Definition: core.c:981
uint8_t bLength
Size of this descriptor (in bytes)
Definition: libusb.h:849
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:755
libusb_device * libusb_get_device(libusb_device_handle *dev_handle)
Get the underlying device for a handle.
Definition: core.c:1322
Device was disconnected.
Definition: libusb.h:1128
int extra_length
Length of the extra descriptors, in bytes.
Definition: libusb.h:684
uint32_t bmAttributes
Bitmap encoding of supported device level features.
Definition: libusb.h:797
Transfer failed.
Definition: libusb.h:1115
uint16_t wBytesPerInterval
The total number of bytes this EP will transfer every service interval.
Definition: libusb.h:716
int libusb_get_device_speed(libusb_device *dev)
Get the negotiated connection speed for a device.
Definition: core.c:841
uint8_t iConfiguration
Index of string descriptor describing this configuration.
Definition: libusb.h:665
int libusb_get_string_descriptor_ascii(libusb_device_handle *dev, uint8_t desc_index, unsigned char *data, int length)
Retrieve a string descriptor in C style ASCII.
Definition: descriptor.c:1148
Invalid parameter.
Definition: libusb.h:1065
unsigned int length
Length of data to request in this packet.
Definition: libusb.h:1182
struct libusb_device libusb_device
Structure representing a USB device detected on the system.
Definition: libusb.h:962
const unsigned char * extra
Extra descriptors.
Definition: libusb.h:623
uint8_t bAlternateSetting
Value used to select this alternate setting for this interface.
Definition: libusb.h:597
uint8_t libusb_get_bus_number(libusb_device *dev)
Get the number of the bus that a device is connected to.
Definition: core.c:739
Image class.
Definition: libusb.h:212
The libusb_has_capability() API is available.
Definition: libusb.h:1275
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:1285
int libusb_alloc_streams(libusb_device_handle *dev, 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:1647
int libusb_get_container_id_descriptor(struct 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:1092
Physical.
Definition: libusb.h:206
In: device-to-host.
Definition: libusb.h:323
Reserved.
Definition: libusb.h:415
Delay from the time a host transmits a packet to the time it is received by the device.
Definition: libusb.h:397
Other error.
Definition: libusb.h:1101
unsigned char endpoint
Address of the endpoint where this transfer will be sent.
Definition: libusb.h:1218
Diagnostic Device.
Definition: libusb.h:237
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:2531
Mass storage class.
Definition: libusb.h:216
HID descriptor.
Definition: libusb.h:274
libusb_iso_usage_type
Usage type for isochronous endpoints.
Definition: libusb.h:464
uint8_t bInterfaceProtocol
USB-IF protocol code for this interface, qualified by the bInterfaceClass and bInterfaceSubClass valu...
Definition: libusb.h:612
Terminate transfers that are a multiple of the endpoint's wMaxPacketSize with an extra zero length pa...
Definition: libusb.h:1175
uint16_t bcdUSB
USB specification release number in binary-coded decimal.
Definition: libusb.h:491
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:1548
Content Security.
Definition: libusb.h:228
The OS doesn't report or know the device speed.
Definition: libusb.h:980
The device is operating at high speed (480MBit/s).
Definition: libusb.h:989
Operation timed out.
Definition: libusb.h:1080
Feedback endpoint.
Definition: libusb.h:469
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:1579
int libusb_release_interface(libusb_device_handle *dev, int interface_number)
Release an interface previously claimed with libusb_claim_interface().
Definition: core.c:1503
Structure providing the version of the libusb runtime.
Definition: libusb.h:908
Wireless USB device capability.
Definition: libusb.h:1038
uint8_t bMaxBurst
The maximum number of packets the endpoint can send or recieve as part of a burst.
Definition: libusb.h:706
uint16_t wSpeedSupported
Bitmap encoding of the speed supported by this device when operating in SuperSpeed mode...
Definition: libusb.h:827
Pipe error.
Definition: libusb.h:1086
int libusb_pollfds_handle_timeouts(libusb_context *ctx)
Determines whether your application must apply special timing considerations when monitoring libusb's...
Definition: io.c:2337
Full speed operation supported (12MBit/s).
Definition: libusb.h:1004
libusb_standard_request
Standard requests, as defined in table 9-5 of the USB 3.0 specifications.
Definition: libusb.h:354
Adaptive.
Definition: libusb.h:451
const struct libusb_endpoint_descriptor * endpoint
Array of endpoint descriptors.
Definition: libusb.h:619
libusb_class_code
Device and/or Interface Class codes.
Definition: libusb.h:189
A device has left and is no longer available.
Definition: libusb.h:1903
No synchronization.
Definition: libusb.h:445
Isochronous packet descriptor.
Definition: libusb.h:1180
Automatically free() transfer buffer during libusb_free_transfer()
Definition: libusb.h:1144
Interface descriptor.
Definition: libusb.h:262
System call interrupted (perhaps due to signal)
Definition: libusb.h:1089
libusb_device * libusb_get_parent(libusb_device *dev)
Get the the parent from the specified device.
Definition: core.c:820
uint8_t bDescriptorType
Descriptor type.
Definition: libusb.h:701
const char * rc
Library release candidate suffix string, e.g.
Definition: libusb.h:922
For bulk/interrupt endpoints: halt condition detected (endpoint stalled).
Definition: libusb.h:1125
Supports Link Power Management (LPM)
Definition: libusb.h:1020
int libusb_get_bos_descriptor(libusb_device_handle *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:902
Used to update existing descriptors or add new descriptors.
Definition: libusb.h:375
uint8_t MaxPower
Maximum power consumption of the USB device from this bus in this configuration when the device is fu...
Definition: libusb.h:673
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:887
unsigned char type
Type of the endpoint from libusb_transfer_type.
Definition: libusb.h:1221
libusb_error
Error codes.
Definition: libusb.h:1057
libusb_log_level
Log message levels.
Definition: libusb.h:1298
struct libusb_transfer * libusb_alloc_transfer(int iso_packets)
Allocate a libusb transfer with a specified number of isochronous packet descriptors.
Definition: io.c:1317
Select an alternate interface for the specified interface.
Definition: libusb.h:387
struct libusb_iso_packet_descriptor iso_packet_desc[0]
Isochronous packet descriptors, for isochronous transfers only.
Definition: libusb.h:1259
uint8_t bRefresh
For audio devices only: the rate at which synchronization feedback is provided.
Definition: libusb.h:566
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:1657
Hub class.
Definition: libusb.h:219