15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* 2ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Public libusbx header file 3ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Copyright © 2001 Johannes Erdfelt <johannes@erdfelt.com> 4ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Copyright © 2007-2008 Daniel Drake <dsd@gentoo.org> 5ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Copyright © 2012 Pete Batard <pete@akeo.ie> 6ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Copyright © 2012 Nathan Hjelm <hjelmn@cs.unm.edu> 7ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * For more information, please visit: http://libusbx.org 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This library is free software; you can redistribute it and/or 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * modify it under the terms of the GNU Lesser General Public 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * License as published by the Free Software Foundation; either 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * version 2.1 of the License, or (at your option) any later version. 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This library is distributed in the hope that it will be useful, 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * but WITHOUT ANY WARRANTY; without even the implied warranty of 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Lesser General Public License for more details. 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * You should have received a copy of the GNU Lesser General Public 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * License along with this library; if not, write to the Free Software 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef LIBUSB_H 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define LIBUSB_H 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifdef _MSC_VER 28ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch// Disable warning 4200 for [0]. 29ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#pragma warning(push) 30ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#pragma warning(disable: 4200) 31ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#endif 32ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 33ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#ifdef _MSC_VER 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* on MS environments, the inline keyword is available in C++ only */ 35ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#if !defined(__cplusplus) 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define inline __inline 37ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#endif 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* ssize_t is also not available (copy/paste from MinGW) */ 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef _SSIZE_T_DEFINED 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define _SSIZE_T_DEFINED 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#undef ssize_t 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifdef _WIN64 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef __int64 ssize_t; 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#else 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) typedef int ssize_t; 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif /* _WIN64 */ 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif /* _SSIZE_T_DEFINED */ 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif /* _MSC_VER */ 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 50ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/* stdint.h is not available on older MSVC */ 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(_MSC_VER) && (_MSC_VER < 1600) && (!defined(_STDINT)) && (!defined(_STDINT_H)) 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef unsigned __int8 uint8_t; 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef unsigned __int16 uint16_t; 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef unsigned __int32 uint32_t; 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#else 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <stdint.h> 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 59ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#if !defined(_WIN32_WCE) 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <sys/types.h> 61ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#endif 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(__linux) || defined(__APPLE__) || defined(__CYGWIN__) 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <sys/time.h> 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 67ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#include <time.h> 68ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#include <limits.h> 69ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* 'interface' might be defined as a macro on Windows, so we need to 71ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * undefine it so as not to break the current libusbx API, because 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * libusb_config_descriptor has an 'interface' member 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * As this can be problematic if you include windows.h after libusb.h 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * in your sources, we force windows.h to be included first. */ 75ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#if defined(_WIN32) || defined(__CYGWIN__) || defined(_WIN32_WCE) 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <windows.h> 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(interface) 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#undef interface 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 80ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#if !defined(__CYGWIN__) 81ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#include <winsock.h> 82ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#endif 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5) 86ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#define LIBUSB_DEPRECATED_FOR(f) \ 87ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch __attribute__((deprecated("Use " #f " instead"))) 88ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#else 89ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#define LIBUSB_DEPRECATED_FOR(f) 90ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#endif /* __GNUC__ */ 91ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \def LIBUSB_CALL 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ingroup misc 94ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * libusbx's Windows calling convention. 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Under Windows, the selection of available compilers and configurations 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * means that, unlike other platforms, there is not <em>one true calling 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * convention</em> (calling convention: the manner in which parameters are 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * passed to funcions in the generated assembly code). 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 101ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Matching the Windows API itself, libusbx uses the WINAPI convention (which 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * translates to the <tt>stdcall</tt> convention) and guarantees that the 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * library is compiled in this way. The public header file also includes 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * appropriate annotations so that your own software will use the right 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * convention, even if another convention is being used by default within 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * your codebase. 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The one consideration that you must apply in your software is to mark 109ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * all functions which you use as libusbx callbacks with this LIBUSB_CALL 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * annotation, so that they too get compiled for the correct calling 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * convention. 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * On non-Windows operating systems, this macro is defined as nothing. This 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * means that you can apply it to your code without worrying about 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * cross-platform compatibility. 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 117ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/* LIBUSB_CALL must be defined on both definition and declaration of libusbx 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * functions. You'd think that declaration would be enough, but cygwin will 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * complain about conflicting types unless both are marked this way. 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The placement of this macro is important too; it must appear after the 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * return type, before the function name. See internal documentation for 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * API_EXPORTED. 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 124ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#if defined(_WIN32) || defined(__CYGWIN__) || defined(_WIN32_WCE) 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define LIBUSB_CALL WINAPI 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#else 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define LIBUSB_CALL 1285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 1295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 130ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \def LIBUSBX_API_VERSION 131ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \ingroup misc 132ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * libusbx's API version. 133ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 134ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Since version 1.0.13, to help with feature detection, libusbx defines 135ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * a LIBUSBX_API_VERSION macro that gets increased every time there is a 136ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * significant change to the API, such as the introduction of a new call, 137ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * the definition of a new macro/enum member, or any other element that 138ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * libusbx applications may want to detect at compilation time. 139ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 140ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * The macro is typically used in an application as follows: 141ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \code 142ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * #if defined(LIBUSBX_API_VERSION) && (LIBUSBX_API_VERSION >= 0x01001234) 143ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * // Use one of the newer features from the libusbx API 144ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * #endif 145ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \endcode 146ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 147ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Another feature of LIBUSBX_API_VERSION is that it can be used to detect 148ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * whether you are compiling against the libusb or the libusbx library. 149ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 150ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Internally, LIBUSBX_API_VERSION is defined as follows: 151ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * (libusbx major << 24) | (libusbx minor << 16) | (16 bit incremental) 152ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch */ 153ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#define LIBUSBX_API_VERSION 0x01000102 154ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifdef __cplusplus 1565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)extern "C" { 1575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 1585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 15968043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles)/** \fn libusb_cpu_to_le16 1605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ingroup misc 1615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Convert a 16-bit value from host-endian to little-endian format. On 1625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * little endian systems, this function does nothing. On big endian systems, 1635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * the bytes are swapped. 1645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param x the host-endian value to convert 1655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns the value in little-endian byte order 1665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 1675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static inline uint16_t libusb_cpu_to_le16(const uint16_t x) 1685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 1695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) union { 1705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t b8[2]; 1715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint16_t b16; 1725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } _tmp; 173ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch _tmp.b8[1] = (uint8_t) (x >> 8); 174ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch _tmp.b8[0] = (uint8_t) (x & 0xff); 1755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return _tmp.b16; 1765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \def libusb_le16_to_cpu 1795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ingroup misc 1805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Convert a 16-bit value from little-endian to host-endian format. On 1815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * little endian systems, this function does nothing. On big endian systems, 1825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * the bytes are swapped. 1835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param x the little-endian value to convert 1845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns the value in host-endian byte order 1855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 1865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define libusb_le16_to_cpu libusb_cpu_to_le16 1875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* standard USB stuff */ 1895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup desc 1915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Device and/or Interface Class codes */ 1925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)enum libusb_class_code { 1935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** In the context of a \ref libusb_device_descriptor "device descriptor", 1945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * this bDeviceClass value indicates that each interface specifies its 1955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * own class information and all interfaces operate independently. 1965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 1975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_CLASS_PER_INTERFACE = 0, 1985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Audio class */ 2005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_CLASS_AUDIO = 1, 2015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Communications class */ 2035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_CLASS_COMM = 2, 2045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Human Interface Device class */ 2065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_CLASS_HID = 3, 2075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Physical */ 2095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_CLASS_PHYSICAL = 5, 2105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Printer class */ 2125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_CLASS_PRINTER = 7, 2135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Image class */ 2155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_CLASS_PTP = 6, /* legacy name from libusb-0.1 usb.h */ 2165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_CLASS_IMAGE = 6, 2175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Mass storage class */ 2195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_CLASS_MASS_STORAGE = 8, 2205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Hub class */ 2225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_CLASS_HUB = 9, 2235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Data class */ 2255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_CLASS_DATA = 10, 2265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Smart Card */ 2285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_CLASS_SMART_CARD = 0x0b, 2295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Content Security */ 2315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_CLASS_CONTENT_SECURITY = 0x0d, 2325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Video */ 2345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_CLASS_VIDEO = 0x0e, 2355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Personal Healthcare */ 2375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_CLASS_PERSONAL_HEALTHCARE = 0x0f, 2385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Diagnostic Device */ 2405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_CLASS_DIAGNOSTIC_DEVICE = 0xdc, 2415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Wireless class */ 2435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_CLASS_WIRELESS = 0xe0, 2445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Application class */ 2465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_CLASS_APPLICATION = 0xfe, 2475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Class is vendor-specific */ 2495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_CLASS_VENDOR_SPEC = 0xff 2505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 2515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup desc 2535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Descriptor types as defined by the USB specification. */ 2545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)enum libusb_descriptor_type { 2555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Device descriptor. See libusb_device_descriptor. */ 2565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_DT_DEVICE = 0x01, 2575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Configuration descriptor. See libusb_config_descriptor. */ 2595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_DT_CONFIG = 0x02, 2605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** String descriptor */ 2625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_DT_STRING = 0x03, 2635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Interface descriptor. See libusb_interface_descriptor. */ 2655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_DT_INTERFACE = 0x04, 2665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Endpoint descriptor. See libusb_endpoint_descriptor. */ 2685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_DT_ENDPOINT = 0x05, 2695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 270ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** BOS descriptor */ 271ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_DT_BOS = 0x0f, 272ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 273ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Device Capability descriptor */ 274ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_DT_DEVICE_CAPABILITY = 0x10, 275ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 2765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** HID descriptor */ 2775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_DT_HID = 0x21, 2785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** HID report descriptor */ 2805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_DT_REPORT = 0x22, 2815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Physical descriptor */ 2835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_DT_PHYSICAL = 0x23, 2845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Hub descriptor */ 286eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch LIBUSB_DT_HUB = 0x29, 287ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 288ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** SuperSpeed Hub descriptor */ 289ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_DT_SUPERSPEED_HUB = 0x2a, 290ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 291ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** SuperSpeed Endpoint Companion descriptor */ 292ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_DT_SS_ENDPOINT_COMPANION = 0x30 2935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 2945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 2955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* Descriptor sizes per descriptor type */ 2965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define LIBUSB_DT_DEVICE_SIZE 18 2975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define LIBUSB_DT_CONFIG_SIZE 9 2985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define LIBUSB_DT_INTERFACE_SIZE 9 299ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#define LIBUSB_DT_ENDPOINT_SIZE 7 300ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#define LIBUSB_DT_ENDPOINT_AUDIO_SIZE 9 /* Audio extension */ 3015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define LIBUSB_DT_HUB_NONVAR_SIZE 7 302ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#define LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE 6 303ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#define LIBUSB_DT_BOS_SIZE 5 304ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#define LIBUSB_DT_DEVICE_CAPABILITY_SIZE 3 305ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 306ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/* BOS descriptor sizes */ 307ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#define LIBUSB_BT_USB_2_0_EXTENSION_SIZE 7 308ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#define LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE 10 309ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#define LIBUSB_BT_CONTAINER_ID_SIZE 20 310ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 311ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/* We unwrap the BOS => define its max size */ 312ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#define LIBUSB_DT_BOS_MAX_SIZE ((LIBUSB_DT_BOS_SIZE) +\ 313ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch (LIBUSB_BT_USB_2_0_EXTENSION_SIZE) +\ 314ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch (LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE) +\ 315ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch (LIBUSB_BT_CONTAINER_ID_SIZE)) 3165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f /* in bEndpointAddress */ 3185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define LIBUSB_ENDPOINT_DIR_MASK 0x80 3195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup desc 3215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Endpoint direction. Values for bit 7 of the 3225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_endpoint_descriptor::bEndpointAddress "endpoint address" scheme. 3235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 3245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)enum libusb_endpoint_direction { 3255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** In: device-to-host */ 3265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_ENDPOINT_IN = 0x80, 3275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Out: host-to-device */ 3295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_ENDPOINT_OUT = 0x00 3305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 3315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define LIBUSB_TRANSFER_TYPE_MASK 0x03 /* in bmAttributes */ 3335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup desc 3355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Endpoint transfer type. Values for bits 0:1 of the 3365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_endpoint_descriptor::bmAttributes "endpoint attributes" field. 3375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 3385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)enum libusb_transfer_type { 3395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Control endpoint */ 3405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_TRANSFER_TYPE_CONTROL = 0, 3415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Isochronous endpoint */ 3435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_TRANSFER_TYPE_ISOCHRONOUS = 1, 3445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Bulk endpoint */ 3465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_TRANSFER_TYPE_BULK = 2, 3475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Interrupt endpoint */ 3495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_TRANSFER_TYPE_INTERRUPT = 3 3505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 3515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup misc 353ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Standard requests, as defined in table 9-5 of the USB 3.0 specifications */ 3545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)enum libusb_standard_request { 3555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Request status of the specific recipient */ 3565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_REQUEST_GET_STATUS = 0x00, 3575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Clear or disable a specific feature */ 3595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_REQUEST_CLEAR_FEATURE = 0x01, 3605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* 0x02 is reserved */ 3625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Set or enable a specific feature */ 3645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_REQUEST_SET_FEATURE = 0x03, 3655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* 0x04 is reserved */ 3675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Set device address for all future accesses */ 3695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_REQUEST_SET_ADDRESS = 0x05, 3705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Get the specified descriptor */ 3725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_REQUEST_GET_DESCRIPTOR = 0x06, 3735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Used to update existing descriptors or add new descriptors */ 3755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_REQUEST_SET_DESCRIPTOR = 0x07, 3765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Get the current device configuration value */ 3785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_REQUEST_GET_CONFIGURATION = 0x08, 3795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Set device configuration */ 3815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_REQUEST_SET_CONFIGURATION = 0x09, 3825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Return the selected alternate setting for the specified interface */ 3845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_REQUEST_GET_INTERFACE = 0x0A, 3855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Select an alternate interface for the specified interface */ 3875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_REQUEST_SET_INTERFACE = 0x0B, 3885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 3895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Set then report an endpoint's synchronization frame */ 390eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch LIBUSB_REQUEST_SYNCH_FRAME = 0x0C, 391ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 392ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Sets both the U1 and U2 Exit Latency */ 393ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_REQUEST_SET_SEL = 0x30, 394ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 395ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Delay from the time a host transmits a packet to the time it is 396ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * received by the device. */ 397ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_SET_ISOCH_DELAY = 0x31, 3985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 3995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup misc 4015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Request type bits of the 4025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_control_setup::bmRequestType "bmRequestType" field in control 4035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * transfers. */ 4045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)enum libusb_request_type { 4055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Standard */ 4065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_REQUEST_TYPE_STANDARD = (0x00 << 5), 4075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Class */ 4095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_REQUEST_TYPE_CLASS = (0x01 << 5), 4105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Vendor */ 4125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_REQUEST_TYPE_VENDOR = (0x02 << 5), 4135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Reserved */ 4155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_REQUEST_TYPE_RESERVED = (0x03 << 5) 4165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 4175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup misc 4195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Recipient bits of the 4205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_control_setup::bmRequestType "bmRequestType" field in control 4215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * transfers. Values 4 through 31 are reserved. */ 4225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)enum libusb_request_recipient { 4235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Device */ 4245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_RECIPIENT_DEVICE = 0x00, 4255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Interface */ 4275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_RECIPIENT_INTERFACE = 0x01, 4285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Endpoint */ 4305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_RECIPIENT_ENDPOINT = 0x02, 4315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Other */ 433eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch LIBUSB_RECIPIENT_OTHER = 0x03, 4345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 4355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define LIBUSB_ISO_SYNC_TYPE_MASK 0x0C 4375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup desc 4395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Synchronization type for isochronous endpoints. Values for bits 2:3 of the 4405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_endpoint_descriptor::bmAttributes "bmAttributes" field in 4415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * libusb_endpoint_descriptor. 4425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 4435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)enum libusb_iso_sync_type { 4445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** No synchronization */ 4455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_ISO_SYNC_TYPE_NONE = 0, 4465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Asynchronous */ 4485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_ISO_SYNC_TYPE_ASYNC = 1, 4495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Adaptive */ 4515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_ISO_SYNC_TYPE_ADAPTIVE = 2, 4525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Synchronous */ 4545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_ISO_SYNC_TYPE_SYNC = 3 4555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 4565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define LIBUSB_ISO_USAGE_TYPE_MASK 0x30 4585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup desc 4605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Usage type for isochronous endpoints. Values for bits 4:5 of the 4615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_endpoint_descriptor::bmAttributes "bmAttributes" field in 4625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * libusb_endpoint_descriptor. 4635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 4645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)enum libusb_iso_usage_type { 4655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Data endpoint */ 4665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_ISO_USAGE_TYPE_DATA = 0, 4675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Feedback endpoint */ 4695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_ISO_USAGE_TYPE_FEEDBACK = 1, 4705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Implicit feedback Data endpoint */ 472eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch LIBUSB_ISO_USAGE_TYPE_IMPLICIT = 2, 4735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 4745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup desc 4765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * A structure representing the standard USB device descriptor. This 477ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * descriptor is documented in section 9.6.1 of the USB 3.0 specification. 4785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * All multiple-byte fields are represented in host-endian format. 4795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 4805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct libusb_device_descriptor { 4815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Size of this descriptor (in bytes) */ 4825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bLength; 4835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Descriptor type. Will have value 4855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE LIBUSB_DT_DEVICE in this 4865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * context. */ 4875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bDescriptorType; 4885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** USB specification release number in binary-coded decimal. A value of 4905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 0x0200 indicates USB 2.0, 0x0110 indicates USB 1.1, etc. */ 4915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint16_t bcdUSB; 4925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** USB-IF class code for the device. See \ref libusb_class_code. */ 4945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bDeviceClass; 4955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 4965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** USB-IF subclass code for the device, qualified by the bDeviceClass 4975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * value */ 4985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bDeviceSubClass; 4995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** USB-IF protocol code for the device, qualified by the bDeviceClass and 5015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * bDeviceSubClass values */ 5025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bDeviceProtocol; 5035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Maximum packet size for endpoint 0 */ 5055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bMaxPacketSize0; 5065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** USB-IF vendor ID */ 5085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint16_t idVendor; 5095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** USB-IF product ID */ 5115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint16_t idProduct; 5125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Device release number in binary-coded decimal */ 5145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint16_t bcdDevice; 5155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Index of string descriptor describing manufacturer */ 5175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t iManufacturer; 5185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Index of string descriptor describing product */ 5205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t iProduct; 5215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Index of string descriptor containing device serial number */ 5235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t iSerialNumber; 5245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Number of possible configurations */ 5265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bNumConfigurations; 5275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 5285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup desc 5305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * A structure representing the standard USB endpoint descriptor. This 531ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * descriptor is documented in section 9.6.6 of the USB 3.0 specification. 5325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * All multiple-byte fields are represented in host-endian format. 5335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 5345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct libusb_endpoint_descriptor { 5355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Size of this descriptor (in bytes) */ 5365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bLength; 5375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Descriptor type. Will have value 5395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_descriptor_type::LIBUSB_DT_ENDPOINT LIBUSB_DT_ENDPOINT in 5405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * this context. */ 5415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bDescriptorType; 5425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** The address of the endpoint described by this descriptor. Bits 0:3 are 5445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * the endpoint number. Bits 4:6 are reserved. Bit 7 indicates direction, 5455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * see \ref libusb_endpoint_direction. 5465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 5475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bEndpointAddress; 5485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Attributes which apply to the endpoint when it is configured using 5505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * the bConfigurationValue. Bits 0:1 determine the transfer type and 5515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * correspond to \ref libusb_transfer_type. Bits 2:3 are only used for 5525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * isochronous endpoints and correspond to \ref libusb_iso_sync_type. 5535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Bits 4:5 are also only used for isochronous endpoints and correspond to 5545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_iso_usage_type. Bits 6:7 are reserved. 5555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 5565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bmAttributes; 5575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Maximum packet size this endpoint is capable of sending/receiving. */ 5595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint16_t wMaxPacketSize; 5605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Interval for polling endpoint for data transfers. */ 5625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bInterval; 5635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** For audio devices only: the rate at which synchronization feedback 5655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * is provided. */ 5665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bRefresh; 5675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** For audio devices only: the address if the synch endpoint */ 5695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bSynchAddress; 5705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 571ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Extra descriptors. If libusbx encounters unknown endpoint descriptors, 5725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * it will store them here, should you wish to parse them. */ 5735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const unsigned char *extra; 5745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Length of the extra descriptors, in bytes. */ 5765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int extra_length; 5775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 5785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup desc 5805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * A structure representing the standard USB interface descriptor. This 581ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * descriptor is documented in section 9.6.5 of the USB 3.0 specification. 5825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * All multiple-byte fields are represented in host-endian format. 5835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 5845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct libusb_interface_descriptor { 5855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Size of this descriptor (in bytes) */ 5865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bLength; 5875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Descriptor type. Will have value 5895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_descriptor_type::LIBUSB_DT_INTERFACE LIBUSB_DT_INTERFACE 5905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * in this context. */ 5915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bDescriptorType; 5925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Number of this interface */ 5945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bInterfaceNumber; 5955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Value used to select this alternate setting for this interface */ 5975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bAlternateSetting; 5985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 5995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Number of endpoints used by this interface (excluding the control 6005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * endpoint). */ 6015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bNumEndpoints; 6025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** USB-IF class code for this interface. See \ref libusb_class_code. */ 6045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bInterfaceClass; 6055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** USB-IF subclass code for this interface, qualified by the 6075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * bInterfaceClass value */ 6085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bInterfaceSubClass; 6095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** USB-IF protocol code for this interface, qualified by the 6115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * bInterfaceClass and bInterfaceSubClass values */ 6125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bInterfaceProtocol; 6135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Index of string descriptor describing this interface */ 6155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t iInterface; 6165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Array of endpoint descriptors. This length of this array is determined 6185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * by the bNumEndpoints field. */ 6195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const struct libusb_endpoint_descriptor *endpoint; 6205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 621ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Extra descriptors. If libusbx encounters unknown interface descriptors, 6225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * it will store them here, should you wish to parse them. */ 6235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const unsigned char *extra; 6245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Length of the extra descriptors, in bytes. */ 6265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int extra_length; 6275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 6285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup desc 6305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * A collection of alternate settings for a particular USB interface. 6315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 6325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct libusb_interface { 6335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Array of interface descriptors. The length of this array is determined 6345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * by the num_altsetting field. */ 6355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const struct libusb_interface_descriptor *altsetting; 6365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** The number of alternate settings that belong to this interface */ 6385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int num_altsetting; 6395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 6405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup desc 6425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * A structure representing the standard USB configuration descriptor. This 643ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * descriptor is documented in section 9.6.3 of the USB 3.0 specification. 6445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * All multiple-byte fields are represented in host-endian format. 6455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 6465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct libusb_config_descriptor { 6475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Size of this descriptor (in bytes) */ 6485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bLength; 6495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Descriptor type. Will have value 6515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_descriptor_type::LIBUSB_DT_CONFIG LIBUSB_DT_CONFIG 6525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * in this context. */ 6535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bDescriptorType; 6545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Total length of data returned for this configuration */ 6565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint16_t wTotalLength; 6575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Number of interfaces supported by this configuration */ 6595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bNumInterfaces; 6605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Identifier value for this configuration */ 6625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bConfigurationValue; 6635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Index of string descriptor describing this configuration */ 6655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t iConfiguration; 6665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Configuration characteristics */ 6685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bmAttributes; 6695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Maximum power consumption of the USB device from this bus in this 6715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * configuration when the device is fully opreation. Expressed in units 6725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * of 2 mA. */ 6735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t MaxPower; 6745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Array of interfaces supported by this configuration. The length of 6765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * this array is determined by the bNumInterfaces field. */ 6775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const struct libusb_interface *interface; 6785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 679ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Extra descriptors. If libusbx encounters unknown configuration 6805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * descriptors, it will store them here, should you wish to parse them. */ 6815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const unsigned char *extra; 6825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 6835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Length of the extra descriptors, in bytes. */ 6845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int extra_length; 6855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 6865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 687ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \ingroup desc 688ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * A structure representing the superspeed endpoint companion 689ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * descriptor. This descriptor is documented in section 9.6.7 of 690ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * the USB 3.0 specification. All multiple-byte fields are represented in 691ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * host-endian format. 692ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch */ 693ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochstruct libusb_ss_endpoint_companion_descriptor { 694ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 695ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Size of this descriptor (in bytes) */ 696ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t bLength; 697ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 698ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Descriptor type. Will have value 699ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \ref libusb_descriptor_type::LIBUSB_DT_SS_ENDPOINT_COMPANION in 700ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * this context. */ 701ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t bDescriptorType; 702ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 703ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 704ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** The maximum number of packets the endpoint can send or 705ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * recieve as part of a burst. */ 706ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t bMaxBurst; 707ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 708ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** In bulk EP: bits 4:0 represents the maximum number of 709ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * streams the EP supports. In isochronous EP: bits 1:0 710ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * represents the Mult - a zero based value that determines 711ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * the maximum number of packets within a service interval */ 712ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t bmAttributes; 713ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 714ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** The total number of bytes this EP will transfer every 715ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * service interval. valid only for periodic EPs. */ 716ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint16_t wBytesPerInterval; 717ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch}; 718ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 719ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \ingroup desc 720ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * A generic representation of a BOS Device Capability descriptor. It is 721ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * advised to check bDevCapabilityType and call the matching 722ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * libusb_get_*_descriptor function to get a structure fully matching the type. 723ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch */ 724ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochstruct libusb_bos_dev_capability_descriptor { 725ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Size of this descriptor (in bytes) */ 726ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t bLength; 727ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Descriptor type. Will have value 728ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE_CAPABILITY 729ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * LIBUSB_DT_DEVICE_CAPABILITY in this context. */ 730ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t bDescriptorType; 731ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Device Capability type */ 732ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t bDevCapabilityType; 733ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Device Capability data (bLength - 3 bytes) */ 734ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t dev_capability_data 735ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) 736ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch [] /* valid C99 code */ 737ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#else 738ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch [0] /* non-standard, but usually working code */ 739ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#endif 740ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch ; 741ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch}; 742ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 743ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \ingroup desc 744ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * A structure representing the Binary Device Object Store (BOS) descriptor. 745ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * This descriptor is documented in section 9.6.2 of the USB 3.0 specification. 746ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * All multiple-byte fields are represented in host-endian format. 747ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch */ 748ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochstruct libusb_bos_descriptor { 749ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Size of this descriptor (in bytes) */ 750ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t bLength; 751ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 752ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Descriptor type. Will have value 753ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \ref libusb_descriptor_type::LIBUSB_DT_BOS LIBUSB_DT_BOS 754ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * in this context. */ 755ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t bDescriptorType; 756ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 757ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Length of this descriptor and all of its sub descriptors */ 758ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint16_t wTotalLength; 759ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 760ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** The number of separate device capability descriptors in 761ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * the BOS */ 762ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t bNumDeviceCaps; 763ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 764ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** bNumDeviceCap Device Capability Descriptors */ 765ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch struct libusb_bos_dev_capability_descriptor *dev_capability 766ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) 767ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch [] /* valid C99 code */ 768ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#else 769ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch [0] /* non-standard, but usually working code */ 770ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#endif 771ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch ; 772ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch}; 773ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 774ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \ingroup desc 775ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * A structure representing the USB 2.0 Extension descriptor 776ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * This descriptor is documented in section 9.6.2.1 of the USB 3.0 specification. 777ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * All multiple-byte fields are represented in host-endian format. 778ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch */ 779ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochstruct libusb_usb_2_0_extension_descriptor { 780ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Size of this descriptor (in bytes) */ 781ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t bLength; 782ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 783ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Descriptor type. Will have value 784ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE_CAPABILITY 785ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * LIBUSB_DT_DEVICE_CAPABILITY in this context. */ 786ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t bDescriptorType; 787ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 788ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Capability type. Will have value 789ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \ref libusb_capability_type::LIBUSB_BT_USB_2_0_EXTENSION 790ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * LIBUSB_BT_USB_2_0_EXTENSION in this context. */ 791ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t bDevCapabilityType; 792ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 793ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Bitmap encoding of supported device level features. 794ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * A value of one in a bit location indicates a feature is 795ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * supported; a value of zero indicates it is not supported. 796ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * See \ref libusb_usb_2_0_extension_attributes. */ 797ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint32_t bmAttributes; 798ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch}; 799ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 800ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \ingroup desc 801ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * A structure representing the SuperSpeed USB Device Capability descriptor 802ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * This descriptor is documented in section 9.6.2.2 of the USB 3.0 specification. 803ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * All multiple-byte fields are represented in host-endian format. 804ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch */ 805ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochstruct libusb_ss_usb_device_capability_descriptor { 806ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Size of this descriptor (in bytes) */ 807ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t bLength; 808ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 809ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Descriptor type. Will have value 810ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE_CAPABILITY 811ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * LIBUSB_DT_DEVICE_CAPABILITY in this context. */ 812ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t bDescriptorType; 813ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 814ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Capability type. Will have value 815ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \ref libusb_capability_type::LIBUSB_BT_SS_USB_DEVICE_CAPABILITY 816ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * LIBUSB_BT_SS_USB_DEVICE_CAPABILITY in this context. */ 817ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t bDevCapabilityType; 818ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 819ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Bitmap encoding of supported device level features. 820ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * A value of one in a bit location indicates a feature is 821ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * supported; a value of zero indicates it is not supported. 822ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * See \ref libusb_ss_usb_device_capability_attributes. */ 823ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t bmAttributes; 824ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 825ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Bitmap encoding of the speed supported by this device when 826ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * operating in SuperSpeed mode. See \ref libusb_supported_speed. */ 827ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint16_t wSpeedSupported; 828ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 829ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** The lowest speed at which all the functionality supported 830ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * by the device is available to the user. For example if the 831ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * device supports all its functionality when connected at 832ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * full speed and above then it sets this value to 1. */ 833ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t bFunctionalitySupport; 834ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 835ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** U1 Device Exit Latency. */ 836ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t bU1DevExitLat; 837ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 838ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** U2 Device Exit Latency. */ 839ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint16_t bU2DevExitLat; 840ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch}; 841ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 842ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \ingroup desc 843ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * A structure representing the Container ID descriptor. 844ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * This descriptor is documented in section 9.6.2.3 of the USB 3.0 specification. 845ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * All multiple-byte fields, except UUIDs, are represented in host-endian format. 846ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch */ 847ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochstruct libusb_container_id_descriptor { 848ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Size of this descriptor (in bytes) */ 849ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t bLength; 850ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 851ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Descriptor type. Will have value 852ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE_CAPABILITY 853ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * LIBUSB_DT_DEVICE_CAPABILITY in this context. */ 854ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t bDescriptorType; 855ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 856ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Capability type. Will have value 857ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \ref libusb_capability_type::LIBUSB_BT_CONTAINER_ID 858ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * LIBUSB_BT_CONTAINER_ID in this context. */ 859ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t bDevCapabilityType; 860ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 861ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Reserved field */ 862ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t bReserved; 863ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 864ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** 128 bit UUID */ 865ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch uint8_t ContainerID[16]; 866ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch}; 867ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 8685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup asyncio 8695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Setup packet for control transfers. */ 8705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct libusb_control_setup { 8715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Request type. Bits 0:4 determine recipient, see 8725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_request_recipient. Bits 5:6 determine type, see 8735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_request_type. Bit 7 determines data transfer direction, see 8745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_endpoint_direction. 8755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 8765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bmRequestType; 8775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Request. If the type bits of bmRequestType are equal to 8795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_request_type::LIBUSB_REQUEST_TYPE_STANDARD 8805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * "LIBUSB_REQUEST_TYPE_STANDARD" then this field refers to 8815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_standard_request. For other cases, use of this field is 8825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * application-specific. */ 8835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bRequest; 8845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Value. Varies according to request */ 8865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint16_t wValue; 8875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Index. Varies according to request, typically used to pass an index 8895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * or offset */ 8905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint16_t wIndex; 8915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Number of bytes to transfer */ 8935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint16_t wLength; 8945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 8955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 8965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define LIBUSB_CONTROL_SETUP_SIZE (sizeof(struct libusb_control_setup)) 8975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 898ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/* libusbx */ 8995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct libusb_context; 9015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct libusb_device; 9025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct libusb_device_handle; 903ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochstruct libusb_hotplug_callback; 9045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup lib 906ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Structure providing the version of the libusbx runtime 907eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch */ 908eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdochstruct libusb_version { 909eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch /** Library major version. */ 910eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch const uint16_t major; 911eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 912eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch /** Library minor version. */ 913eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch const uint16_t minor; 914eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 915eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch /** Library micro version. */ 916eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch const uint16_t micro; 917eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 918ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Library nano version. */ 919eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch const uint16_t nano; 920eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 921eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch /** Library release candidate suffix string, e.g. "-rc4". */ 922eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch const char *rc; 923eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 924ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** For ABI compatibility only. */ 925ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch const char* describe; 926eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch}; 927eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 928eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch/** \ingroup lib 929ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Structure representing a libusbx session. The concept of individual libusbx 9305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * sessions allows for your program to use two libraries (or dynamically 9315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * load two modules) which both independently use libusb. This will prevent 932ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * interference between the individual libusbx users - for example 9335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * libusb_set_debug() will not affect the other user of the library, and 9345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * libusb_exit() will not destroy resources that the other user is still 9355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * using. 9365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 9375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Sessions are created by libusb_init() and destroyed through libusb_exit(). 938ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * If your application is guaranteed to only ever include a single libusbx 9395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * user (i.e. you), you do not have to worry about contexts: pass NULL in 9405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * every function call where a context is required. The default context 9415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * will be used. 9425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 9435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * For more information, see \ref contexts. 9445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 9455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef struct libusb_context libusb_context; 9465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 9485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Structure representing a USB device detected on the system. This is an 9495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * opaque type for which you are only ever provided with a pointer, usually 9505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * originating from libusb_get_device_list(). 9515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 9525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Certain operations can be performed on a device, but in order to do any 9535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * I/O you will have to first obtain a device handle using libusb_open(). 9545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 955ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Devices are reference counted with libusb_ref_device() and 956ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * libusb_unref_device(), and are freed when the reference count reaches 0. 9575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * New devices presented by libusb_get_device_list() have a reference count of 9585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 1, and libusb_free_device_list() can optionally decrease the reference count 9595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * on all devices in the list. libusb_open() adds another reference which is 9605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * later destroyed by libusb_close(). 9615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 9625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef struct libusb_device libusb_device; 9635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 9665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Structure representing a handle on a USB device. This is an opaque type for 9675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * which you are only ever provided with a pointer, usually originating from 9685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * libusb_open(). 9695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 9705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * A device handle is used to perform I/O and other operations. When finished 9715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * with a device handle, you should call libusb_close(). 9725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 9735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef struct libusb_device_handle libusb_device_handle; 9745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 9755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup dev 9765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Speed codes. Indicates the speed at which the device is operating. 9775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 9785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)enum libusb_speed { 979ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** The OS doesn't report or know the device speed. */ 980ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_SPEED_UNKNOWN = 0, 981ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 982ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** The device is operating at low speed (1.5MBit/s). */ 983ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_SPEED_LOW = 1, 984ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 985ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** The device is operating at full speed (12MBit/s). */ 986ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_SPEED_FULL = 2, 987ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 988ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** The device is operating at high speed (480MBit/s). */ 989ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_SPEED_HIGH = 3, 990ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 991ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** The device is operating at super speed (5000MBit/s). */ 992ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_SPEED_SUPER = 4, 993ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch}; 994ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 995ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \ingroup dev 996ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Supported speeds (wSpeedSupported) bitfield. Indicates what 997ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * speeds the device supports. 998ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch */ 999ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochenum libusb_supported_speed { 1000ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Low speed operation supported (1.5MBit/s). */ 1001ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_LOW_SPEED_OPERATION = 1, 1002ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1003ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Full speed operation supported (12MBit/s). */ 1004ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_FULL_SPEED_OPERATION = 2, 1005ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1006ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** High speed operation supported (480MBit/s). */ 1007ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_HIGH_SPEED_OPERATION = 4, 1008ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1009ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Superspeed operation supported (5000MBit/s). */ 1010ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_SUPER_SPEED_OPERATION = 8, 1011ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch}; 1012ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1013ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \ingroup dev 1014ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Masks for the bits of the 1015ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \ref libusb_usb_2_0_extension_descriptor::bmAttributes "bmAttributes" field 1016ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * of the USB 2.0 Extension descriptor. 1017ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch */ 1018ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochenum libusb_usb_2_0_extension_attributes { 1019ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Supports Link Power Management (LPM) */ 1020ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_BM_LPM_SUPPORT = 2, 1021ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch}; 1022ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1023ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \ingroup dev 1024ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Masks for the bits of the 1025ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \ref libusb_ss_usb_device_capability_descriptor::bmAttributes "bmAttributes" field 1026ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * field of the SuperSpeed USB Device Capability descriptor. 1027ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch */ 1028ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochenum libusb_ss_usb_device_capability_attributes { 1029ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Supports Latency Tolerance Messages (LTM) */ 1030ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_BM_LTM_SUPPORT = 2, 1031ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch}; 10325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1033ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \ingroup dev 1034ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * USB capability types 1035ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch */ 1036ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochenum libusb_bos_type { 1037ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Wireless USB device capability */ 1038ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_BT_WIRELESS_USB_DEVICE_CAPABILITY = 1, 10395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1040ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** USB 2.0 extensions */ 1041ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_BT_USB_2_0_EXTENSION = 2, 10425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1043ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** SuperSpeed USB device capability */ 1044ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_BT_SS_USB_DEVICE_CAPABILITY = 3, 10455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1046ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Container ID type */ 1047ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_BT_CONTAINER_ID = 4, 10485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 10495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup misc 1051ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Error codes. Most libusbx functions return 0 on success or one of these 10525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * codes on failure. 1053ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * You can call libusb_error_name() to retrieve a string representation of an 1054ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * error code or libusb_strerror() to get an end-user suitable description of 1055ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * an error code. 10565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 10575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)enum libusb_error { 10585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Success (no error) */ 10595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_SUCCESS = 0, 10605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Input/output error */ 10625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_ERROR_IO = -1, 10635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Invalid parameter */ 10655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_ERROR_INVALID_PARAM = -2, 10665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Access denied (insufficient permissions) */ 10685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_ERROR_ACCESS = -3, 10695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** No such device (it may have been disconnected) */ 10715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_ERROR_NO_DEVICE = -4, 10725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Entity not found */ 10745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_ERROR_NOT_FOUND = -5, 10755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Resource busy */ 10775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_ERROR_BUSY = -6, 10785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Operation timed out */ 10805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_ERROR_TIMEOUT = -7, 10815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Overflow */ 10835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_ERROR_OVERFLOW = -8, 10845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Pipe error */ 10865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_ERROR_PIPE = -9, 10875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** System call interrupted (perhaps due to signal) */ 10895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_ERROR_INTERRUPTED = -10, 10905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Insufficient memory */ 10925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_ERROR_NO_MEM = -11, 10935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 10945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Operation not supported or unimplemented on this platform */ 10955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_ERROR_NOT_SUPPORTED = -12, 10965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1097ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /* NB: Remember to update LIBUSB_ERROR_COUNT below as well as the 1098ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch message strings in strerror.c when adding new error codes here. */ 10995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Other error */ 1101eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch LIBUSB_ERROR_OTHER = -99, 11025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 11035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1104ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/* Total number of error codes in enum libusb_error */ 1105ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#define LIBUSB_ERROR_COUNT 14 1106ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 11075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup asyncio 11085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Transfer status codes */ 11095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)enum libusb_transfer_status { 11105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Transfer completed without error. Note that this does not indicate 11115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * that the entire amount of requested data was transferred. */ 11125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_TRANSFER_COMPLETED, 11135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Transfer failed */ 11155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_TRANSFER_ERROR, 11165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Transfer timed out */ 11185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_TRANSFER_TIMED_OUT, 11195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Transfer was cancelled */ 11215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_TRANSFER_CANCELLED, 11225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** For bulk/interrupt endpoints: halt condition detected (endpoint 11245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * stalled). For control endpoints: control request not supported. */ 11255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_TRANSFER_STALL, 11265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Device was disconnected */ 11285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_TRANSFER_NO_DEVICE, 11295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Device sent more data than requested */ 1131eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch LIBUSB_TRANSFER_OVERFLOW, 1132ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1133ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /* NB! Remember to update libusb_error_name() 1134ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch when adding new status codes here. */ 11355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 11365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup asyncio 11385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * libusb_transfer.flags values */ 11395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)enum libusb_transfer_flags { 11405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Report short frames as errors */ 11415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_TRANSFER_SHORT_NOT_OK = 1<<0, 11425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Automatically free() transfer buffer during libusb_free_transfer() */ 11445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) LIBUSB_TRANSFER_FREE_BUFFER = 1<<1, 11455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Automatically call libusb_free_transfer() after callback returns. 11475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * If this flag is set, it is illegal to call libusb_free_transfer() 11485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * from your transfer callback, as this will result in a double-free 11495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * when this flag is acted upon. */ 1150eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch LIBUSB_TRANSFER_FREE_TRANSFER = 1<<2, 1151eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 1152eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch /** Terminate transfers that are a multiple of the endpoint's 1153eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * wMaxPacketSize with an extra zero length packet. This is useful 1154eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * when a device protocol mandates that each logical request is 1155eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * terminated by an incomplete packet (i.e. the logical requests are 1156eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * not separated by other means). 1157eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * 1158eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * This flag only affects host-to-device transfers to bulk and interrupt 1159eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * endpoints. In other situations, it is ignored. 1160eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * 1161eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * This flag only affects transfers with a length that is a multiple of 1162eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * the endpoint's wMaxPacketSize. On transfers of other lengths, this 1163eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * flag has no effect. Therefore, if you are working with a device that 1164eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * needs a ZLP whenever the end of the logical request falls on a packet 1165eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * boundary, then it is sensible to set this flag on <em>every</em> 1166eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * transfer (you do not have to worry about only setting it on transfers 1167eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * that end on the boundary). 1168eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * 1169eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * This flag is currently only supported on Linux. 1170eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * On other systems, libusb_submit_transfer() will return 1171eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * LIBUSB_ERROR_NOT_SUPPORTED for every transfer where this flag is set. 1172eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * 1173eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch * Available since libusb-1.0.9. 1174eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch */ 1175eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch LIBUSB_TRANSFER_ADD_ZERO_PACKET = 1 << 3, 11765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 11775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup asyncio 11795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Isochronous packet descriptor. */ 11805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct libusb_iso_packet_descriptor { 11815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Length of data to request in this packet */ 11825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned int length; 11835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Amount of data that was actually transferred */ 11855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned int actual_length; 11865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Status code for this packet */ 11885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum libusb_transfer_status status; 11895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 11905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct libusb_transfer; 11925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 11935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup asyncio 11945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Asynchronous transfer callback function type. When submitting asynchronous 11955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * transfers, you pass a pointer to a callback function of this type via the 11965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_transfer::callback "callback" member of the libusb_transfer 1197ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * structure. libusbx will call this function later, when the transfer has 11985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * completed or failed. See \ref asyncio for more information. 11995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param transfer The libusb_transfer struct the callback function is being 12005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * notified about. 12015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 12025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef void (LIBUSB_CALL *libusb_transfer_cb_fn)(struct libusb_transfer *transfer); 12035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup asyncio 12055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * The generic USB transfer structure. The user populates this structure and 12065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * then submits it in order to request a transfer. After the transfer has 12075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * completed, the library populates the transfer with the results and passes 12085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * it back to the user. 12095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 12105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct libusb_transfer { 12115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Handle of the device that this transfer will be submitted to */ 12125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_device_handle *dev_handle; 12135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** A bitwise OR combination of \ref libusb_transfer_flags. */ 12155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t flags; 12165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Address of the endpoint where this transfer will be sent. */ 12185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned char endpoint; 12195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Type of the endpoint from \ref libusb_transfer_type */ 12215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned char type; 12225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Timeout for this transfer in millseconds. A value of 0 indicates no 12245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * timeout. */ 12255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned int timeout; 12265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** The status of the transfer. Read-only, and only for use within 12285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * transfer callback function. 12295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 12305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * If this is an isochronous transfer, this field may read COMPLETED even 12315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * if there were errors in the frames. Use the 12325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_iso_packet_descriptor::status "status" field in each packet 12335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * to determine if errors occurred. */ 12345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum libusb_transfer_status status; 12355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Length of the data buffer */ 12375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int length; 12385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Actual length of data that was transferred. Read-only, and only for 12405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * use within transfer callback function. Not valid for isochronous 12415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * endpoint transfers. */ 12425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int actual_length; 12435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Callback function. This will be invoked when the transfer completes, 12455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * fails, or is cancelled. */ 12465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_transfer_cb_fn callback; 12475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** User context data to pass to the callback function. */ 12495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void *user_data; 12505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Data buffer */ 12525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned char *buffer; 12535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Number of isochronous packets. Only used for I/O with isochronous 12555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * endpoints. */ 12565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int num_iso_packets; 12575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 12585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Isochronous packet descriptors, for isochronous transfers only. */ 12595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_iso_packet_descriptor iso_packet_desc 12605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L) 1261eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch [] /* valid C99 code */ 12625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#else 1263eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch [0] /* non-standard, but usually working code */ 12645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 1265eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch ; 12665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1267eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch 12685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup misc 1269ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Capabilities supported by an instance of libusb on the current running 1270ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * platform. Test if the loaded library supports a given capability by calling 12715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_has_capability(). 12725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 12735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)enum libusb_capability { 1274eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch /** The libusb_has_capability() API is available. */ 1275ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_CAP_HAS_CAPABILITY = 0x0000, 1276ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Hotplug support is available on this platform. */ 1277ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_CAP_HAS_HOTPLUG = 0x0001, 1278ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** The library can access HID devices without requiring user intervention. 1279ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Note that before being able to actually access an HID device, you may 1280ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * still have to call additional libusbx functions such as 1281ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \ref libusb_detach_kernel_driver(). */ 1282ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_CAP_HAS_HID_ACCESS = 0x0100, 1283ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** The library supports detaching of the default USB driver, using 1284ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \ref libusb_detach_kernel_driver(), if one is set by the OS kernel */ 1285ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER = 0x0101 1286ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch}; 1287ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1288ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \ingroup lib 1289ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Log message levels. 1290ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * - LIBUSB_LOG_LEVEL_NONE (0) : no messages ever printed by the library (default) 1291ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * - LIBUSB_LOG_LEVEL_ERROR (1) : error messages are printed to stderr 1292ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * - LIBUSB_LOG_LEVEL_WARNING (2) : warning and error messages are printed to stderr 1293ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * - LIBUSB_LOG_LEVEL_INFO (3) : informational messages are printed to stdout, warning 1294ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * and error messages are printed to stderr 1295ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * - LIBUSB_LOG_LEVEL_DEBUG (4) : debug and informational messages are printed to stdout, 1296ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * warnings and errors to stderr 1297ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch */ 1298ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochenum libusb_log_level { 1299ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_LOG_LEVEL_NONE = 0, 1300ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_LOG_LEVEL_ERROR, 1301ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_LOG_LEVEL_WARNING, 1302ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_LOG_LEVEL_INFO, 1303ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_LOG_LEVEL_DEBUG, 13045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 13055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_init(libusb_context **ctx); 13075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void LIBUSB_CALL libusb_exit(libusb_context *ctx); 13085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void LIBUSB_CALL libusb_set_debug(libusb_context *ctx, int level); 1309eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdochconst struct libusb_version * LIBUSB_CALL libusb_get_version(void); 13105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_has_capability(uint32_t capability); 13115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)const char * LIBUSB_CALL libusb_error_name(int errcode); 1312ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochint LIBUSB_CALL libusb_setlocale(const char *locale); 1313ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochconst char * LIBUSB_CALL libusb_strerror(enum libusb_error errcode); 13145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)ssize_t LIBUSB_CALL libusb_get_device_list(libusb_context *ctx, 13165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_device ***list); 13175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void LIBUSB_CALL libusb_free_device_list(libusb_device **list, 13185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int unref_devices); 13195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)libusb_device * LIBUSB_CALL libusb_ref_device(libusb_device *dev); 13205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void LIBUSB_CALL libusb_unref_device(libusb_device *dev); 13215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_get_configuration(libusb_device_handle *dev, 13235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int *config); 13245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_get_device_descriptor(libusb_device *dev, 13255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_device_descriptor *desc); 13265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_get_active_config_descriptor(libusb_device *dev, 13275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_config_descriptor **config); 13285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_get_config_descriptor(libusb_device *dev, 13295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t config_index, struct libusb_config_descriptor **config); 13305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_get_config_descriptor_by_value(libusb_device *dev, 13315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bConfigurationValue, struct libusb_config_descriptor **config); 13325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void LIBUSB_CALL libusb_free_config_descriptor( 13335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_config_descriptor *config); 1334ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochint LIBUSB_CALL libusb_get_ss_endpoint_companion_descriptor( 1335ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch struct libusb_context *ctx, 1336ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch const struct libusb_endpoint_descriptor *endpoint, 1337ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch struct libusb_ss_endpoint_companion_descriptor **ep_comp); 1338ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochvoid LIBUSB_CALL libusb_free_ss_endpoint_companion_descriptor( 1339ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch struct libusb_ss_endpoint_companion_descriptor *ep_comp); 1340ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochint LIBUSB_CALL libusb_get_bos_descriptor(libusb_device_handle *handle, 1341ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch struct libusb_bos_descriptor **bos); 1342ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochvoid LIBUSB_CALL libusb_free_bos_descriptor(struct libusb_bos_descriptor *bos); 1343ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochint LIBUSB_CALL libusb_get_usb_2_0_extension_descriptor( 1344ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch struct libusb_context *ctx, 1345ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch struct libusb_bos_dev_capability_descriptor *dev_cap, 1346ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch struct libusb_usb_2_0_extension_descriptor **usb_2_0_extension); 1347ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochvoid LIBUSB_CALL libusb_free_usb_2_0_extension_descriptor( 1348ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch struct libusb_usb_2_0_extension_descriptor *usb_2_0_extension); 1349ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochint LIBUSB_CALL libusb_get_ss_usb_device_capability_descriptor( 1350ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch struct libusb_context *ctx, 1351ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch struct libusb_bos_dev_capability_descriptor *dev_cap, 1352ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch struct libusb_ss_usb_device_capability_descriptor **ss_usb_device_cap); 1353ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochvoid LIBUSB_CALL libusb_free_ss_usb_device_capability_descriptor( 1354ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch struct libusb_ss_usb_device_capability_descriptor *ss_usb_device_cap); 1355ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochint LIBUSB_CALL libusb_get_container_id_descriptor(struct libusb_context *ctx, 1356ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch struct libusb_bos_dev_capability_descriptor *dev_cap, 1357ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch struct libusb_container_id_descriptor **container_id); 1358ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochvoid LIBUSB_CALL libusb_free_container_id_descriptor( 1359ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch struct libusb_container_id_descriptor *container_id); 13605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)uint8_t LIBUSB_CALL libusb_get_bus_number(libusb_device *dev); 1361ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochuint8_t LIBUSB_CALL libusb_get_port_number(libusb_device *dev); 1362ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochint LIBUSB_CALL libusb_get_port_numbers(libusb_device *dev, uint8_t* port_numbers, int port_numbers_len); 1363ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben MurdochLIBUSB_DEPRECATED_FOR(libusb_get_port_numbers) 1364ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochint LIBUSB_CALL libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t* path, uint8_t path_length); 1365ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochlibusb_device * LIBUSB_CALL libusb_get_parent(libusb_device *dev); 13665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)uint8_t LIBUSB_CALL libusb_get_device_address(libusb_device *dev); 13675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_get_device_speed(libusb_device *dev); 13685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_get_max_packet_size(libusb_device *dev, 13695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned char endpoint); 13705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_get_max_iso_packet_size(libusb_device *dev, 13715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned char endpoint); 13725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_open(libusb_device *dev, libusb_device_handle **handle); 13745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void LIBUSB_CALL libusb_close(libusb_device_handle *dev_handle); 13755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)libusb_device * LIBUSB_CALL libusb_get_device(libusb_device_handle *dev_handle); 13765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_set_configuration(libusb_device_handle *dev, 13785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int configuration); 13795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_claim_interface(libusb_device_handle *dev, 13805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int interface_number); 13815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_release_interface(libusb_device_handle *dev, 13825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int interface_number); 13835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)libusb_device_handle * LIBUSB_CALL libusb_open_device_with_vid_pid( 13855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_context *ctx, uint16_t vendor_id, uint16_t product_id); 13865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_set_interface_alt_setting(libusb_device_handle *dev, 13885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int interface_number, int alternate_setting); 13895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_clear_halt(libusb_device_handle *dev, 13905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned char endpoint); 13915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_reset_device(libusb_device_handle *dev); 13925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 13935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_kernel_driver_active(libusb_device_handle *dev, 13945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int interface_number); 13955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_detach_kernel_driver(libusb_device_handle *dev, 13965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int interface_number); 13975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_attach_kernel_driver(libusb_device_handle *dev, 13985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int interface_number); 1399ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochint LIBUSB_CALL libusb_set_auto_detach_kernel_driver( 1400ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch libusb_device_handle *dev, int enable); 14015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* async I/O */ 14035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup asyncio 14055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Get the data section of a control transfer. This convenience function is here 14065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * to remind you that the data does not start until 8 bytes into the actual 14075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * buffer, as the setup packet comes first. 14085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 14095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Calling this function only makes sense from a transfer callback function, 14105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * or situations where you have already allocated a suitably sized buffer at 14115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * transfer->buffer. 14125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 14135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param transfer a transfer 14145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns pointer to the first byte of the data section 14155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 14165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static inline unsigned char *libusb_control_transfer_get_data( 14175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_transfer *transfer) 14185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 14195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE; 14205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 14215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup asyncio 14235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Get the control setup packet of a control transfer. This convenience 14245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * function is here to remind you that the control setup occupies the first 14255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 8 bytes of the transfer data buffer. 14265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 14275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Calling this function only makes sense from a transfer callback function, 14285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * or situations where you have already allocated a suitably sized buffer at 14295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * transfer->buffer. 14305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 14315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param transfer a transfer 14325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns a casted pointer to the start of the transfer data buffer 14335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 14345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static inline struct libusb_control_setup *libusb_control_transfer_get_setup( 14355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_transfer *transfer) 14365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 143768043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) return (struct libusb_control_setup *)(void *) transfer->buffer; 14385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 14395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup asyncio 14415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Helper function to populate the setup packet (first 8 bytes of the data 14425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * buffer) for a control transfer. The wIndex, wValue and wLength values should 14435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * be given in host-endian byte order. 14445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 14455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param buffer buffer to output the setup packet into 144668043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) * This pointer must be aligned to at least 2 bytes boundary. 14475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param bmRequestType see the 14485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_control_setup::bmRequestType "bmRequestType" field of 14495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_control_setup 14505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param bRequest see the 14515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_control_setup::bRequest "bRequest" field of 14525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_control_setup 14535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param wValue see the 14545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_control_setup::wValue "wValue" field of 14555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_control_setup 14565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param wIndex see the 14575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_control_setup::wIndex "wIndex" field of 14585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_control_setup 14595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param wLength see the 14605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_control_setup::wLength "wLength" field of 14615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \ref libusb_control_setup 14625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 14635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static inline void libusb_fill_control_setup(unsigned char *buffer, 14645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex, 14655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint16_t wLength) 14665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 146768043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) struct libusb_control_setup *setup = (struct libusb_control_setup *)(void *) buffer; 14685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) setup->bmRequestType = bmRequestType; 14695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) setup->bRequest = bRequest; 14705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) setup->wValue = libusb_cpu_to_le16(wValue); 14715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) setup->wIndex = libusb_cpu_to_le16(wIndex); 14725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) setup->wLength = libusb_cpu_to_le16(wLength); 14735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 14745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct libusb_transfer * LIBUSB_CALL libusb_alloc_transfer(int iso_packets); 14765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_submit_transfer(struct libusb_transfer *transfer); 14775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_cancel_transfer(struct libusb_transfer *transfer); 14785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void LIBUSB_CALL libusb_free_transfer(struct libusb_transfer *transfer); 14795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 14805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup asyncio 14815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Helper function to populate the required \ref libusb_transfer fields 14825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * for a control transfer. 14835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 14845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * If you pass a transfer buffer to this function, the first 8 bytes will 14855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * be interpreted as a control setup packet, and the wLength field will be 14865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * used to automatically populate the \ref libusb_transfer::length "length" 14875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * field of the transfer. Therefore the recommended approach is: 14885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * -# Allocate a suitably sized data buffer (including space for control setup) 14895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * -# Call libusb_fill_control_setup() 14905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * -# If this is a host-to-device transfer with a data stage, put the data 14915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * in place after the setup packet 14925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * -# Call this function 14935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * -# Call libusb_submit_transfer() 14945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 14955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * It is also legal to pass a NULL buffer to this function, in which case this 14965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * function will not attempt to populate the length field. Remember that you 14975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * must then populate the buffer and length fields later. 14985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 14995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param transfer the transfer to populate 15005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev_handle handle of the device that will handle the transfer 15015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param buffer data buffer. If provided, this function will interpret the 15025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * first 8 bytes as a setup packet and infer the transfer length from that. 150368043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) * This pointer must be aligned to at least 2 bytes boundary. 15045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param callback callback function to be invoked on transfer completion 15055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param user_data user data to pass to callback function 15065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param timeout timeout for the transfer in milliseconds 15075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 15085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static inline void libusb_fill_control_transfer( 15095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_transfer *transfer, libusb_device_handle *dev_handle, 15105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned char *buffer, libusb_transfer_cb_fn callback, void *user_data, 15115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned int timeout) 15125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 151368043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) struct libusb_control_setup *setup = (struct libusb_control_setup *)(void *) buffer; 15145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->dev_handle = dev_handle; 15155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->endpoint = 0; 15165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->type = LIBUSB_TRANSFER_TYPE_CONTROL; 15175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->timeout = timeout; 15185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->buffer = buffer; 15195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (setup) 1520ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch transfer->length = (int) (LIBUSB_CONTROL_SETUP_SIZE 1521ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch + libusb_le16_to_cpu(setup->wLength)); 15225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->user_data = user_data; 15235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->callback = callback; 15245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 15255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 15265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup asyncio 15275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Helper function to populate the required \ref libusb_transfer fields 15285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * for a bulk transfer. 15295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 15305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param transfer the transfer to populate 15315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev_handle handle of the device that will handle the transfer 15325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param endpoint address of the endpoint where this transfer will be sent 15335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param buffer data buffer 15345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param length length of data buffer 15355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param callback callback function to be invoked on transfer completion 15365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param user_data user data to pass to callback function 15375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param timeout timeout for the transfer in milliseconds 15385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 15395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static inline void libusb_fill_bulk_transfer(struct libusb_transfer *transfer, 15405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_device_handle *dev_handle, unsigned char endpoint, 15415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned char *buffer, int length, libusb_transfer_cb_fn callback, 15425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void *user_data, unsigned int timeout) 15435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 15445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->dev_handle = dev_handle; 15455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->endpoint = endpoint; 15465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->type = LIBUSB_TRANSFER_TYPE_BULK; 15475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->timeout = timeout; 15485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->buffer = buffer; 15495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->length = length; 15505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->user_data = user_data; 15515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->callback = callback; 15525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 15535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 15545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup asyncio 15555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Helper function to populate the required \ref libusb_transfer fields 15565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * for an interrupt transfer. 15575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 15585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param transfer the transfer to populate 15595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev_handle handle of the device that will handle the transfer 15605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param endpoint address of the endpoint where this transfer will be sent 15615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param buffer data buffer 15625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param length length of data buffer 15635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param callback callback function to be invoked on transfer completion 15645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param user_data user data to pass to callback function 15655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param timeout timeout for the transfer in milliseconds 15665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 15675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static inline void libusb_fill_interrupt_transfer( 15685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_transfer *transfer, libusb_device_handle *dev_handle, 15695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned char endpoint, unsigned char *buffer, int length, 15705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout) 15715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 15725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->dev_handle = dev_handle; 15735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->endpoint = endpoint; 15745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->type = LIBUSB_TRANSFER_TYPE_INTERRUPT; 15755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->timeout = timeout; 15765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->buffer = buffer; 15775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->length = length; 15785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->user_data = user_data; 15795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->callback = callback; 15805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 15815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 15825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup asyncio 15835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Helper function to populate the required \ref libusb_transfer fields 15845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * for an isochronous transfer. 15855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 15865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param transfer the transfer to populate 15875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev_handle handle of the device that will handle the transfer 15885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param endpoint address of the endpoint where this transfer will be sent 15895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param buffer data buffer 15905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param length length of data buffer 15915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param num_iso_packets the number of isochronous packets 15925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param callback callback function to be invoked on transfer completion 15935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param user_data user data to pass to callback function 15945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param timeout timeout for the transfer in milliseconds 15955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 15965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static inline void libusb_fill_iso_transfer(struct libusb_transfer *transfer, 15975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_device_handle *dev_handle, unsigned char endpoint, 15985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned char *buffer, int length, int num_iso_packets, 15995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout) 16005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 16015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->dev_handle = dev_handle; 16025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->endpoint = endpoint; 16035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->type = LIBUSB_TRANSFER_TYPE_ISOCHRONOUS; 16045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->timeout = timeout; 16055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->buffer = buffer; 16065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->length = length; 16075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->num_iso_packets = num_iso_packets; 16085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->user_data = user_data; 16095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->callback = callback; 16105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 16115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 16125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup asyncio 16135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Convenience function to set the length of all packets in an isochronous 16145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * transfer, based on the num_iso_packets field in the transfer structure. 16155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 16165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param transfer a transfer 16175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param length the length to set in each isochronous packet descriptor 16185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \see libusb_get_max_packet_size() 16195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 16205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static inline void libusb_set_iso_packet_lengths( 16215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_transfer *transfer, unsigned int length) 16225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 16235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int i; 16245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for (i = 0; i < transfer->num_iso_packets; i++) 16255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) transfer->iso_packet_desc[i].length = length; 16265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 16275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 16285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup asyncio 16295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Convenience function to locate the position of an isochronous packet 16305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * within the buffer of an isochronous transfer. 16315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 16325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This is a thorough function which loops through all preceding packets, 16335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * accumulating their lengths to find the position of the specified packet. 16345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Typically you will assign equal lengths to each packet in the transfer, 16355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * and hence the above method is sub-optimal. You may wish to use 16365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * libusb_get_iso_packet_buffer_simple() instead. 16375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 16385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param transfer a transfer 16395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param packet the packet to return the address of 16405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns the base address of the packet buffer inside the transfer buffer, 16415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * or NULL if the packet does not exist. 16425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \see libusb_get_iso_packet_buffer_simple() 16435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 16445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static inline unsigned char *libusb_get_iso_packet_buffer( 16455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_transfer *transfer, unsigned int packet) 16465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 16475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int i; 16485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t offset = 0; 16495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int _packet; 16505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 16515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* oops..slight bug in the API. packet is an unsigned int, but we use 16525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * signed integers almost everywhere else. range-check and convert to 16535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * signed to avoid compiler warnings. FIXME for libusb-2. */ 16545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (packet > INT_MAX) 16555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return NULL; 1656ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch _packet = (int) packet; 16575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 16585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (_packet >= transfer->num_iso_packets) 16595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return NULL; 16605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 16615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) for (i = 0; i < _packet; i++) 16625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) offset += transfer->iso_packet_desc[i].length; 16635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 16645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return transfer->buffer + offset; 16655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 16665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 16675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup asyncio 16685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Convenience function to locate the position of an isochronous packet 16695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * within the buffer of an isochronous transfer, for transfers where each 16705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * packet is of identical size. 16715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 16725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This function relies on the assumption that every packet within the transfer 16735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * is of identical size to the first packet. Calculating the location of 16745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * the packet buffer is then just a simple calculation: 16755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * <tt>buffer + (packet_size * packet)</tt> 16765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 16775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Do not use this function on transfers other than those that have identical 16785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * packet lengths for each packet. 16795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 16805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param transfer a transfer 16815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param packet the packet to return the address of 16825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns the base address of the packet buffer inside the transfer buffer, 16835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * or NULL if the packet does not exist. 16845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \see libusb_get_iso_packet_buffer() 16855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 16865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static inline unsigned char *libusb_get_iso_packet_buffer_simple( 16875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct libusb_transfer *transfer, unsigned int packet) 16885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 16895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int _packet; 16905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 16915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /* oops..slight bug in the API. packet is an unsigned int, but we use 16925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * signed integers almost everywhere else. range-check and convert to 16935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * signed to avoid compiler warnings. FIXME for libusb-2. */ 16945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (packet > INT_MAX) 16955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return NULL; 1696ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch _packet = (int) packet; 16975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 16985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) if (_packet >= transfer->num_iso_packets) 16995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return NULL; 17005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1701ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch return transfer->buffer + ((int) transfer->iso_packet_desc[0].length * _packet); 17025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 17035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 17045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* sync I/O */ 17055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 17065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_control_transfer(libusb_device_handle *dev_handle, 17075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t request_type, uint8_t bRequest, uint16_t wValue, uint16_t wIndex, 17085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned char *data, uint16_t wLength, unsigned int timeout); 17095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 17105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_bulk_transfer(libusb_device_handle *dev_handle, 17115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned char endpoint, unsigned char *data, int length, 17125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int *actual_length, unsigned int timeout); 17135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 17145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_interrupt_transfer(libusb_device_handle *dev_handle, 17155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned char endpoint, unsigned char *data, int length, 17165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int *actual_length, unsigned int timeout); 17175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 17185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup desc 17195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Retrieve a descriptor from the default control pipe. 17205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This is a convenience function which formulates the appropriate control 17215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * message to retrieve the descriptor. 17225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 17235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev a device handle 17245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param desc_type the descriptor type, see \ref libusb_descriptor_type 17255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param desc_index the index of the descriptor to retrieve 17265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param data output buffer for descriptor 17275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param length size of data buffer 17285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns number of bytes returned in data, or LIBUSB_ERROR code on failure 17295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 17305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static inline int libusb_get_descriptor(libusb_device_handle *dev, 17315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t desc_type, uint8_t desc_index, unsigned char *data, int length) 17325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 17335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return libusb_control_transfer(dev, LIBUSB_ENDPOINT_IN, 1734ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t) ((desc_type << 8) | desc_index), 1735ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 0, data, (uint16_t) length, 1000); 17365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 17375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 17385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup desc 17395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Retrieve a descriptor from a device. 17405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This is a convenience function which formulates the appropriate control 17415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * message to retrieve the descriptor. The string returned is Unicode, as 17425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * detailed in the USB specifications. 17435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 17445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param dev a device handle 17455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param desc_index the index of the descriptor to retrieve 17465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param langid the language ID for the string descriptor 17475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param data output buffer for descriptor 17485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param length size of data buffer 17495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \returns number of bytes returned in data, or LIBUSB_ERROR code on failure 17505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \see libusb_get_string_descriptor_ascii() 17515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 17525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)static inline int libusb_get_string_descriptor(libusb_device_handle *dev, 17535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t desc_index, uint16_t langid, unsigned char *data, int length) 17545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles){ 17555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return libusb_control_transfer(dev, LIBUSB_ENDPOINT_IN, 1756eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t)((LIBUSB_DT_STRING << 8) | desc_index), 17575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) langid, data, (uint16_t) length, 1000); 17585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 17595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 17605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_get_string_descriptor_ascii(libusb_device_handle *dev, 17615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) uint8_t desc_index, unsigned char *data, int length); 17625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 17635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* polling and timeouts */ 17645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 17655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_try_lock_events(libusb_context *ctx); 17665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void LIBUSB_CALL libusb_lock_events(libusb_context *ctx); 17675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void LIBUSB_CALL libusb_unlock_events(libusb_context *ctx); 17685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_event_handling_ok(libusb_context *ctx); 17695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_event_handler_active(libusb_context *ctx); 17705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void LIBUSB_CALL libusb_lock_event_waiters(libusb_context *ctx); 17715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void LIBUSB_CALL libusb_unlock_event_waiters(libusb_context *ctx); 17725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_wait_for_event(libusb_context *ctx, struct timeval *tv); 17735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 17745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_handle_events_timeout(libusb_context *ctx, 17755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct timeval *tv); 17765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_handle_events_timeout_completed(libusb_context *ctx, 17775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct timeval *tv, int *completed); 17785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_handle_events(libusb_context *ctx); 17795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_handle_events_completed(libusb_context *ctx, int *completed); 17805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_handle_events_locked(libusb_context *ctx, 17815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct timeval *tv); 17825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_pollfds_handle_timeouts(libusb_context *ctx); 17835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)int LIBUSB_CALL libusb_get_next_timeout(libusb_context *ctx, 17845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) struct timeval *tv); 17855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 17865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup poll 17875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * File descriptor for polling 17885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 17895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)struct libusb_pollfd { 17905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Numeric file descriptor */ 17915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int fd; 17925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 17935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) /** Event flags to poll for from <poll.h>. POLLIN indicates that you 17945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * should monitor this file descriptor for becoming ready to read from, 17955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * and POLLOUT indicates that you should monitor this file descriptor for 17965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * nonblocking write readiness. */ 17975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) short events; 17985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 17995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 18005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup poll 18015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Callback function, invoked when a new file descriptor should be added 18025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * to the set of file descriptors monitored for events. 18035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param fd the new file descriptor 18045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param events events to monitor for, see \ref libusb_pollfd for a 18055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * description 18065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param user_data User data pointer specified in 18075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * libusb_set_pollfd_notifiers() call 18085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \see libusb_set_pollfd_notifiers() 18095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 18105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef void (LIBUSB_CALL *libusb_pollfd_added_cb)(int fd, short events, 18115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void *user_data); 18125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 18135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/** \ingroup poll 18145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Callback function, invoked when a file descriptor should be removed from 18155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * the set of file descriptors being monitored for events. After returning 18165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * from this callback, do not use that file descriptor again. 18175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param fd the file descriptor to stop monitoring 18185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \param user_data User data pointer specified in 18195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * libusb_set_pollfd_notifiers() call 18205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * \see libusb_set_pollfd_notifiers() 18215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 18225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef void (LIBUSB_CALL *libusb_pollfd_removed_cb)(int fd, void *user_data); 18235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 18245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)const struct libusb_pollfd ** LIBUSB_CALL libusb_get_pollfds( 18255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_context *ctx); 18265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void LIBUSB_CALL libusb_set_pollfd_notifiers(libusb_context *ctx, 18275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb, 18285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void *user_data); 18295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1830ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \ingroup hotplug 1831ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Callback handle. 1832ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1833ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Callbacks handles are generated by libusb_hotplug_register_callback() 1834ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * and can be used to deregister callbacks. Callback handles are unique 1835ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * per libusb_context and it is safe to call libusb_hotplug_deregister_callback() 1836ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * on an already deregisted callback. 1837ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1838ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Since version 1.0.16, \ref LIBUSBX_API_VERSION >= 0x01000102 1839ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1840ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * For more information, see \ref hotplug. 1841ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch */ 1842ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochtypedef int libusb_hotplug_callback_handle; 1843ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1844ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \ingroup hotplug 1845ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1846ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Since version 1.0.16, \ref LIBUSBX_API_VERSION >= 0x01000102 1847ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1848ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Flags for hotplug events */ 1849ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochtypedef enum { 1850ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** Arm the callback and fire it for all matching currently attached devices. */ 1851ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_HOTPLUG_ENUMERATE = 1, 1852ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch} libusb_hotplug_flag; 1853ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1854ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \ingroup hotplug 1855ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1856ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Since version 1.0.16, \ref LIBUSBX_API_VERSION >= 0x01000102 1857ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1858ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Hotplug events */ 1859ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochtypedef enum { 1860ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** A device has been plugged in and is ready to use */ 1861ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_HOTPLUG_EVENT_DEVICE_ARRIVED = 0x01, 1862ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1863ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch /** A device has left and is no longer available. 1864ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * It is the user's responsibility to call libusb_close on any handle associated with a disconnected device. 1865ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * It is safe to call libusb_get_device_descriptor on a device that has left */ 1866ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT = 0x02, 1867ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch} libusb_hotplug_event; 1868ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1869ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \ingroup hotplug 1870ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Wildcard matching for hotplug events */ 1871ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#define LIBUSB_HOTPLUG_MATCH_ANY -1 1872ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1873ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \ingroup hotplug 1874ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Hotplug callback function type. When requesting hotplug event notifications, 1875ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * you pass a pointer to a callback function of this type. 1876ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1877ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * This callback may be called by an internal event thread and as such it is 1878ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * recommended the callback do minimal processing before returning. 1879ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1880ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * libusbx will call this function later, when a matching event had happened on 1881ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * a matching device. See \ref hotplug for more information. 1882ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1883ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * It is safe to call either libusb_hotplug_register_callback() or 1884ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * libusb_hotplug_deregister_callback() from within a callback function. 1885ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1886ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Since version 1.0.16, \ref LIBUSBX_API_VERSION >= 0x01000102 1887ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 188868043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) * \param ctx context of this notification 1889ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \param device libusb_device this event occurred on 1890ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \param event event that occurred 1891ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \param user_data user data provided when this callback was registered 1892ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \returns bool whether this callback is finished processing events. 1893ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * returning 1 will cause this callback to be deregistered 1894ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch */ 1895ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochtypedef int (LIBUSB_CALL *libusb_hotplug_callback_fn)(libusb_context *ctx, 1896ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch libusb_device *device, 1897ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch libusb_hotplug_event event, 1898ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch void *user_data); 1899ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1900ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \ingroup hotplug 1901ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Register a hotplug callback function 1902ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1903ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Register a callback with the libusb_context. The callback will fire 1904ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * when a matching event occurs on a matching device. The callback is 1905ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * armed until either it is deregistered with libusb_hotplug_deregister_callback() 1906ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * or the supplied callback returns 1 to indicate it is finished processing events. 1907ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 190868043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) * If the \ref LIBUSB_HOTPLUG_ENUMERATE is passed the callback will be 190968043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) * called with a \ref LIBUSB_HOTPLUG_EVENT_DEVICE_ARRIVED for all devices 191068043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) * already plugged into the machine. Note that libusbx modifies its internal 191168043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) * device list from a separate thread, while calling hotplug callbacks from 191268043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) * libusb_handle_events(), so it is possible for a device to already be present 191368043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) * on, or removed from, its internal device list, while the hotplug callbacks 191468043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) * still need to be dispatched. This means that when using \ref 191568043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) * LIBUSB_HOTPLUG_ENUMERATE, your callback may be called twice for the arrival 191668043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) * of the same device, once from libusb_hotplug_register_callback() and once 191768043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) * from libusb_handle_events(); and/or your callback may be called for the 191868043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) * removal of a device for which an arrived call was never made. 191968043e1e95eeb07d5cae7aca370b26518b0867d6Torne (Richard Coles) * 1920ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Since version 1.0.16, \ref LIBUSBX_API_VERSION >= 0x01000102 1921ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1922ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \param[in] ctx context to register this callback with 1923ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \param[in] events bitwise or of events that will trigger this callback. See \ref 1924ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * libusb_hotplug_event 1925ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \param[in] flags hotplug callback flags. See \ref libusb_hotplug_flag 1926ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \param[in] vendor_id the vendor id to match or \ref LIBUSB_HOTPLUG_MATCH_ANY 1927ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \param[in] product_id the product id to match or \ref LIBUSB_HOTPLUG_MATCH_ANY 1928ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \param[in] dev_class the device class to match or \ref LIBUSB_HOTPLUG_MATCH_ANY 1929ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \param[in] cb_fn the function to be invoked on a matching event/device 1930ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \param[in] user_data user data to pass to the callback function 1931ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \param[out] handle pointer to store the handle of the allocated callback (can be NULL) 1932ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \returns LIBUSB_SUCCESS on success LIBUSB_ERROR code on failure 1933ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch */ 1934ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochint LIBUSB_CALL libusb_hotplug_register_callback(libusb_context *ctx, 1935ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch libusb_hotplug_event events, 1936ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch libusb_hotplug_flag flags, 1937ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch int vendor_id, int product_id, 1938ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch int dev_class, 1939ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch libusb_hotplug_callback_fn cb_fn, 1940ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch void *user_data, 1941ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch libusb_hotplug_callback_handle *handle); 1942ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 1943ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch/** \ingroup hotplug 1944ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Deregisters a hotplug callback. 1945ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1946ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Deregister a callback from a libusb_context. This function is safe to call from within 1947ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * a hotplug callback. 1948ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1949ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * Since version 1.0.16, \ref LIBUSBX_API_VERSION >= 0x01000102 1950ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * 1951ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \param[in] ctx context this callback is registered with 1952ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch * \param[in] handle the handle of the callback to deregister 1953ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch */ 1954ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdochvoid LIBUSB_CALL libusb_hotplug_deregister_callback(libusb_context *ctx, 1955ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch libusb_hotplug_callback_handle handle); 1956ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 19575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifdef __cplusplus 19585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 19595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 19605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1961ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#ifdef _MSC_VER 1962ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#pragma warning(pop) 1963ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch#endif 1964ca12bfac764ba476d6cd062bf1dde12cc64c3f40Ben Murdoch 19655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 1966