source: arduino-1-6-7/trunk/fuentes/arduino-ide-amd64/hardware/tools/avr/include/libusb-1.0/libusb.h @ 46

Last change on this file since 46 was 46, checked in by jrpelegrina, 4 years ago

First release to Xenial

File size: 66.8 KB
Line 
1/*
2 * Public libusb header file
3 * Copyright © 2001 Johannes Erdfelt <johannes@erdfelt.com>
4 * Copyright © 2007-2008 Daniel Drake <dsd@gentoo.org>
5 * Copyright © 2012 Pete Batard <pete@akeo.ie>
6 * Copyright © 2012 Nathan Hjelm <hjelmn@cs.unm.edu>
7 * For more information, please visit: http://libusb.info
8 *
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Lesser General Public
11 * License as published by the Free Software Foundation; either
12 * version 2.1 of the License, or (at your option) any later version.
13 *
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17 * Lesser General Public License for more details.
18 *
19 * You should have received a copy of the GNU Lesser General Public
20 * License along with this library; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 */
23
24#ifndef LIBUSB_H
25#define LIBUSB_H
26
27#ifdef _MSC_VER
28/* on MS environments, the inline keyword is available in C++ only */
29#if !defined(__cplusplus)
30#define inline __inline
31#endif
32/* ssize_t is also not available (copy/paste from MinGW) */
33#ifndef _SSIZE_T_DEFINED
34#define _SSIZE_T_DEFINED
35#undef ssize_t
36#ifdef _WIN64
37  typedef __int64 ssize_t;
38#else
39  typedef int ssize_t;
40#endif /* _WIN64 */
41#endif /* _SSIZE_T_DEFINED */
42#endif /* _MSC_VER */
43
44/* stdint.h is not available on older MSVC */
45#if defined(_MSC_VER) && (_MSC_VER < 1600) && (!defined(_STDINT)) && (!defined(_STDINT_H))
46typedef unsigned __int8   uint8_t;
47typedef unsigned __int16  uint16_t;
48typedef unsigned __int32  uint32_t;
49#else
50#include <stdint.h>
51#endif
52
53#if !defined(_WIN32_WCE)
54#include <sys/types.h>
55#endif
56
57#if defined(__linux) || defined(__APPLE__) || defined(__CYGWIN__)
58#include <sys/time.h>
59#endif
60
61#include <time.h>
62#include <limits.h>
63
64/* 'interface' might be defined as a macro on Windows, so we need to
65 * undefine it so as not to break the current libusb API, because
66 * libusb_config_descriptor has an 'interface' member
67 * As this can be problematic if you include windows.h after libusb.h
68 * in your sources, we force windows.h to be included first. */
69#if defined(_WIN32) || defined(__CYGWIN__) || defined(_WIN32_WCE)
70#include <windows.h>
71#if defined(interface)
72#undef interface
73#endif
74#if !defined(__CYGWIN__)
75#include <winsock.h>
76#endif
77#endif
78
79#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5)
80#define LIBUSB_DEPRECATED_FOR(f) \
81  __attribute__((deprecated("Use " #f " instead")))
82#else
83#define LIBUSB_DEPRECATED_FOR(f)
84#endif /* __GNUC__ */
85
86/** \def LIBUSB_CALL
87 * \ingroup misc
88 * libusb's Windows calling convention.
89 *
90 * Under Windows, the selection of available compilers and configurations
91 * means that, unlike other platforms, there is not <em>one true calling
92 * convention</em> (calling convention: the manner in which parameters are
93 * passed to funcions in the generated assembly code).
94 *
95 * Matching the Windows API itself, libusb uses the WINAPI convention (which
96 * translates to the <tt>stdcall</tt> convention) and guarantees that the
97 * library is compiled in this way. The public header file also includes
98 * appropriate annotations so that your own software will use the right
99 * convention, even if another convention is being used by default within
100 * your codebase.
101 *
102 * The one consideration that you must apply in your software is to mark
103 * all functions which you use as libusb callbacks with this LIBUSB_CALL
104 * annotation, so that they too get compiled for the correct calling
105 * convention.
106 *
107 * On non-Windows operating systems, this macro is defined as nothing. This
108 * means that you can apply it to your code without worrying about
109 * cross-platform compatibility.
110 */
111/* LIBUSB_CALL must be defined on both definition and declaration of libusb
112 * functions. You'd think that declaration would be enough, but cygwin will
113 * complain about conflicting types unless both are marked this way.
114 * The placement of this macro is important too; it must appear after the
115 * return type, before the function name. See internal documentation for
116 * API_EXPORTED.
117 */
118#if defined(_WIN32) || defined(__CYGWIN__) || defined(_WIN32_WCE)
119#define LIBUSB_CALL WINAPI
120#else
121#define LIBUSB_CALL
122#endif
123
124/** \def LIBUSB_API_VERSION
125 * \ingroup misc
126 * libusb's API version.
127 *
128 * Since version 1.0.13, to help with feature detection, libusb defines
129 * a LIBUSB_API_VERSION macro that gets increased every time there is a
130 * significant change to the API, such as the introduction of a new call,
131 * the definition of a new macro/enum member, or any other element that
132 * libusb applications may want to detect at compilation time.
133 *
134 * The macro is typically used in an application as follows:
135 * \code
136 * #if defined(LIBUSB_API_VERSION) && (LIBUSB_API_VERSION >= 0x01001234)
137 * // Use one of the newer features from the libusb API
138 * #endif
139 * \endcode
140 *
141 * Another feature of LIBUSB_API_VERSION is that it can be used to detect
142 * whether you are compiling against the libusb or the libusb library.
143 *
144 * Internally, LIBUSB_API_VERSION is defined as follows:
145 * (libusb major << 24) | (libusb minor << 16) | (16 bit incremental)
146 */
147#define LIBUSB_API_VERSION 0x01000102
148
149/* The following is kept for compatibility, but will be deprecated in the future */
150#define LIBUSBX_API_VERSION LIBUSB_API_VERSION
151
152#ifdef __cplusplus
153extern "C" {
154#endif
155
156/**
157 * \ingroup misc
158 * Convert a 16-bit value from host-endian to little-endian format. On
159 * little endian systems, this function does nothing. On big endian systems,
160 * the bytes are swapped.
161 * \param x the host-endian value to convert
162 * \returns the value in little-endian byte order
163 */
164static inline uint16_t libusb_cpu_to_le16(const uint16_t x)
165{
166        union {
167                uint8_t  b8[2];
168                uint16_t b16;
169        } _tmp;
170        _tmp.b8[1] = (uint8_t) (x >> 8);
171        _tmp.b8[0] = (uint8_t) (x & 0xff);
172        return _tmp.b16;
173}
174
175/** \def libusb_le16_to_cpu
176 * \ingroup misc
177 * Convert a 16-bit value from little-endian to host-endian format. On
178 * little endian systems, this function does nothing. On big endian systems,
179 * the bytes are swapped.
180 * \param x the little-endian value to convert
181 * \returns the value in host-endian byte order
182 */
183#define libusb_le16_to_cpu libusb_cpu_to_le16
184
185/* standard USB stuff */
186
187/** \ingroup desc
188 * Device and/or Interface Class codes */
189enum libusb_class_code {
190        /** In the context of a \ref libusb_device_descriptor "device descriptor",
191         * this bDeviceClass value indicates that each interface specifies its
192         * own class information and all interfaces operate independently.
193         */
194        LIBUSB_CLASS_PER_INTERFACE = 0,
195
196        /** Audio class */
197        LIBUSB_CLASS_AUDIO = 1,
198
199        /** Communications class */
200        LIBUSB_CLASS_COMM = 2,
201
202        /** Human Interface Device class */
203        LIBUSB_CLASS_HID = 3,
204
205        /** Physical */
206        LIBUSB_CLASS_PHYSICAL = 5,
207
208        /** Printer class */
209        LIBUSB_CLASS_PRINTER = 7,
210
211        /** Image class */
212        LIBUSB_CLASS_PTP = 6, /* legacy name from libusb-0.1 usb.h */
213        LIBUSB_CLASS_IMAGE = 6,
214
215        /** Mass storage class */
216        LIBUSB_CLASS_MASS_STORAGE = 8,
217
218        /** Hub class */
219        LIBUSB_CLASS_HUB = 9,
220
221        /** Data class */
222        LIBUSB_CLASS_DATA = 10,
223
224        /** Smart Card */
225        LIBUSB_CLASS_SMART_CARD = 0x0b,
226
227        /** Content Security */
228        LIBUSB_CLASS_CONTENT_SECURITY = 0x0d,
229
230        /** Video */
231        LIBUSB_CLASS_VIDEO = 0x0e,
232
233        /** Personal Healthcare */
234        LIBUSB_CLASS_PERSONAL_HEALTHCARE = 0x0f,
235
236        /** Diagnostic Device */
237        LIBUSB_CLASS_DIAGNOSTIC_DEVICE = 0xdc,
238
239        /** Wireless class */
240        LIBUSB_CLASS_WIRELESS = 0xe0,
241
242        /** Application class */
243        LIBUSB_CLASS_APPLICATION = 0xfe,
244
245        /** Class is vendor-specific */
246        LIBUSB_CLASS_VENDOR_SPEC = 0xff
247};
248
249/** \ingroup desc
250 * Descriptor types as defined by the USB specification. */
251enum libusb_descriptor_type {
252        /** Device descriptor. See libusb_device_descriptor. */
253        LIBUSB_DT_DEVICE = 0x01,
254
255        /** Configuration descriptor. See libusb_config_descriptor. */
256        LIBUSB_DT_CONFIG = 0x02,
257
258        /** String descriptor */
259        LIBUSB_DT_STRING = 0x03,
260
261        /** Interface descriptor. See libusb_interface_descriptor. */
262        LIBUSB_DT_INTERFACE = 0x04,
263
264        /** Endpoint descriptor. See libusb_endpoint_descriptor. */
265        LIBUSB_DT_ENDPOINT = 0x05,
266
267        /** BOS descriptor */
268        LIBUSB_DT_BOS = 0x0f,
269
270        /** Device Capability descriptor */
271        LIBUSB_DT_DEVICE_CAPABILITY = 0x10,
272
273        /** HID descriptor */
274        LIBUSB_DT_HID = 0x21,
275
276        /** HID report descriptor */
277        LIBUSB_DT_REPORT = 0x22,
278
279        /** Physical descriptor */
280        LIBUSB_DT_PHYSICAL = 0x23,
281
282        /** Hub descriptor */
283        LIBUSB_DT_HUB = 0x29,
284
285        /** SuperSpeed Hub descriptor */
286        LIBUSB_DT_SUPERSPEED_HUB = 0x2a,
287
288        /** SuperSpeed Endpoint Companion descriptor */
289        LIBUSB_DT_SS_ENDPOINT_COMPANION = 0x30
290};
291
292/* Descriptor sizes per descriptor type */
293#define LIBUSB_DT_DEVICE_SIZE                   18
294#define LIBUSB_DT_CONFIG_SIZE                   9
295#define LIBUSB_DT_INTERFACE_SIZE                9
296#define LIBUSB_DT_ENDPOINT_SIZE                 7
297#define LIBUSB_DT_ENDPOINT_AUDIO_SIZE           9       /* Audio extension */
298#define LIBUSB_DT_HUB_NONVAR_SIZE               7
299#define LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE    6
300#define LIBUSB_DT_BOS_SIZE                      5
301#define LIBUSB_DT_DEVICE_CAPABILITY_SIZE        3
302
303/* BOS descriptor sizes */
304#define LIBUSB_BT_USB_2_0_EXTENSION_SIZE        7
305#define LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE 10
306#define LIBUSB_BT_CONTAINER_ID_SIZE             20
307
308/* We unwrap the BOS => define its max size */
309#define LIBUSB_DT_BOS_MAX_SIZE          ((LIBUSB_DT_BOS_SIZE)     +\
310                                        (LIBUSB_BT_USB_2_0_EXTENSION_SIZE)       +\
311                                        (LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE) +\
312                                        (LIBUSB_BT_CONTAINER_ID_SIZE))
313
314#define LIBUSB_ENDPOINT_ADDRESS_MASK    0x0f    /* in bEndpointAddress */
315#define LIBUSB_ENDPOINT_DIR_MASK                0x80
316
317/** \ingroup desc
318 * Endpoint direction. Values for bit 7 of the
319 * \ref libusb_endpoint_descriptor::bEndpointAddress "endpoint address" scheme.
320 */
321enum libusb_endpoint_direction {
322        /** In: device-to-host */
323        LIBUSB_ENDPOINT_IN = 0x80,
324
325        /** Out: host-to-device */
326        LIBUSB_ENDPOINT_OUT = 0x00
327};
328
329#define LIBUSB_TRANSFER_TYPE_MASK                       0x03    /* in bmAttributes */
330
331/** \ingroup desc
332 * Endpoint transfer type. Values for bits 0:1 of the
333 * \ref libusb_endpoint_descriptor::bmAttributes "endpoint attributes" field.
334 */
335enum libusb_transfer_type {
336        /** Control endpoint */
337        LIBUSB_TRANSFER_TYPE_CONTROL = 0,
338
339        /** Isochronous endpoint */
340        LIBUSB_TRANSFER_TYPE_ISOCHRONOUS = 1,
341
342        /** Bulk endpoint */
343        LIBUSB_TRANSFER_TYPE_BULK = 2,
344
345        /** Interrupt endpoint */
346        LIBUSB_TRANSFER_TYPE_INTERRUPT = 3
347};
348
349/** \ingroup misc
350 * Standard requests, as defined in table 9-5 of the USB 3.0 specifications */
351enum libusb_standard_request {
352        /** Request status of the specific recipient */
353        LIBUSB_REQUEST_GET_STATUS = 0x00,
354
355        /** Clear or disable a specific feature */
356        LIBUSB_REQUEST_CLEAR_FEATURE = 0x01,
357
358        /* 0x02 is reserved */
359
360        /** Set or enable a specific feature */
361        LIBUSB_REQUEST_SET_FEATURE = 0x03,
362
363        /* 0x04 is reserved */
364
365        /** Set device address for all future accesses */
366        LIBUSB_REQUEST_SET_ADDRESS = 0x05,
367
368        /** Get the specified descriptor */
369        LIBUSB_REQUEST_GET_DESCRIPTOR = 0x06,
370
371        /** Used to update existing descriptors or add new descriptors */
372        LIBUSB_REQUEST_SET_DESCRIPTOR = 0x07,
373
374        /** Get the current device configuration value */
375        LIBUSB_REQUEST_GET_CONFIGURATION = 0x08,
376
377        /** Set device configuration */
378        LIBUSB_REQUEST_SET_CONFIGURATION = 0x09,
379
380        /** Return the selected alternate setting for the specified interface */
381        LIBUSB_REQUEST_GET_INTERFACE = 0x0A,
382
383        /** Select an alternate interface for the specified interface */
384        LIBUSB_REQUEST_SET_INTERFACE = 0x0B,
385
386        /** Set then report an endpoint's synchronization frame */
387        LIBUSB_REQUEST_SYNCH_FRAME = 0x0C,
388
389        /** Sets both the U1 and U2 Exit Latency */
390        LIBUSB_REQUEST_SET_SEL = 0x30,
391
392        /** Delay from the time a host transmits a packet to the time it is
393          * received by the device. */
394        LIBUSB_SET_ISOCH_DELAY = 0x31,
395};
396
397/** \ingroup misc
398 * Request type bits of the
399 * \ref libusb_control_setup::bmRequestType "bmRequestType" field in control
400 * transfers. */
401enum libusb_request_type {
402        /** Standard */
403        LIBUSB_REQUEST_TYPE_STANDARD = (0x00 << 5),
404
405        /** Class */
406        LIBUSB_REQUEST_TYPE_CLASS = (0x01 << 5),
407
408        /** Vendor */
409        LIBUSB_REQUEST_TYPE_VENDOR = (0x02 << 5),
410
411        /** Reserved */
412        LIBUSB_REQUEST_TYPE_RESERVED = (0x03 << 5)
413};
414
415/** \ingroup misc
416 * Recipient bits of the
417 * \ref libusb_control_setup::bmRequestType "bmRequestType" field in control
418 * transfers. Values 4 through 31 are reserved. */
419enum libusb_request_recipient {
420        /** Device */
421        LIBUSB_RECIPIENT_DEVICE = 0x00,
422
423        /** Interface */
424        LIBUSB_RECIPIENT_INTERFACE = 0x01,
425
426        /** Endpoint */
427        LIBUSB_RECIPIENT_ENDPOINT = 0x02,
428
429        /** Other */
430        LIBUSB_RECIPIENT_OTHER = 0x03,
431};
432
433#define LIBUSB_ISO_SYNC_TYPE_MASK               0x0C
434
435/** \ingroup desc
436 * Synchronization type for isochronous endpoints. Values for bits 2:3 of the
437 * \ref libusb_endpoint_descriptor::bmAttributes "bmAttributes" field in
438 * libusb_endpoint_descriptor.
439 */
440enum libusb_iso_sync_type {
441        /** No synchronization */
442        LIBUSB_ISO_SYNC_TYPE_NONE = 0,
443
444        /** Asynchronous */
445        LIBUSB_ISO_SYNC_TYPE_ASYNC = 1,
446
447        /** Adaptive */
448        LIBUSB_ISO_SYNC_TYPE_ADAPTIVE = 2,
449
450        /** Synchronous */
451        LIBUSB_ISO_SYNC_TYPE_SYNC = 3
452};
453
454#define LIBUSB_ISO_USAGE_TYPE_MASK 0x30
455
456/** \ingroup desc
457 * Usage type for isochronous endpoints. Values for bits 4:5 of the
458 * \ref libusb_endpoint_descriptor::bmAttributes "bmAttributes" field in
459 * libusb_endpoint_descriptor.
460 */
461enum libusb_iso_usage_type {
462        /** Data endpoint */
463        LIBUSB_ISO_USAGE_TYPE_DATA = 0,
464
465        /** Feedback endpoint */
466        LIBUSB_ISO_USAGE_TYPE_FEEDBACK = 1,
467
468        /** Implicit feedback Data endpoint */
469        LIBUSB_ISO_USAGE_TYPE_IMPLICIT = 2,
470};
471
472/** \ingroup desc
473 * A structure representing the standard USB device descriptor. This
474 * descriptor is documented in section 9.6.1 of the USB 3.0 specification.
475 * All multiple-byte fields are represented in host-endian format.
476 */
477struct libusb_device_descriptor {
478        /** Size of this descriptor (in bytes) */
479        uint8_t  bLength;
480
481        /** Descriptor type. Will have value
482         * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE LIBUSB_DT_DEVICE in this
483         * context. */
484        uint8_t  bDescriptorType;
485
486        /** USB specification release number in binary-coded decimal. A value of
487         * 0x0200 indicates USB 2.0, 0x0110 indicates USB 1.1, etc. */
488        uint16_t bcdUSB;
489
490        /** USB-IF class code for the device. See \ref libusb_class_code. */
491        uint8_t  bDeviceClass;
492
493        /** USB-IF subclass code for the device, qualified by the bDeviceClass
494         * value */
495        uint8_t  bDeviceSubClass;
496
497        /** USB-IF protocol code for the device, qualified by the bDeviceClass and
498         * bDeviceSubClass values */
499        uint8_t  bDeviceProtocol;
500
501        /** Maximum packet size for endpoint 0 */
502        uint8_t  bMaxPacketSize0;
503
504        /** USB-IF vendor ID */
505        uint16_t idVendor;
506
507        /** USB-IF product ID */
508        uint16_t idProduct;
509
510        /** Device release number in binary-coded decimal */
511        uint16_t bcdDevice;
512
513        /** Index of string descriptor describing manufacturer */
514        uint8_t  iManufacturer;
515
516        /** Index of string descriptor describing product */
517        uint8_t  iProduct;
518
519        /** Index of string descriptor containing device serial number */
520        uint8_t  iSerialNumber;
521
522        /** Number of possible configurations */
523        uint8_t  bNumConfigurations;
524};
525
526/** \ingroup desc
527 * A structure representing the standard USB endpoint descriptor. This
528 * descriptor is documented in section 9.6.6 of the USB 3.0 specification.
529 * All multiple-byte fields are represented in host-endian format.
530 */
531struct libusb_endpoint_descriptor {
532        /** Size of this descriptor (in bytes) */
533        uint8_t  bLength;
534
535        /** Descriptor type. Will have value
536         * \ref libusb_descriptor_type::LIBUSB_DT_ENDPOINT LIBUSB_DT_ENDPOINT in
537         * this context. */
538        uint8_t  bDescriptorType;
539
540        /** The address of the endpoint described by this descriptor. Bits 0:3 are
541         * the endpoint number. Bits 4:6 are reserved. Bit 7 indicates direction,
542         * see \ref libusb_endpoint_direction.
543         */
544        uint8_t  bEndpointAddress;
545
546        /** Attributes which apply to the endpoint when it is configured using
547         * the bConfigurationValue. Bits 0:1 determine the transfer type and
548         * correspond to \ref libusb_transfer_type. Bits 2:3 are only used for
549         * isochronous endpoints and correspond to \ref libusb_iso_sync_type.
550         * Bits 4:5 are also only used for isochronous endpoints and correspond to
551         * \ref libusb_iso_usage_type. Bits 6:7 are reserved.
552         */
553        uint8_t  bmAttributes;
554
555        /** Maximum packet size this endpoint is capable of sending/receiving. */
556        uint16_t wMaxPacketSize;
557
558        /** Interval for polling endpoint for data transfers. */
559        uint8_t  bInterval;
560
561        /** For audio devices only: the rate at which synchronization feedback
562         * is provided. */
563        uint8_t  bRefresh;
564
565        /** For audio devices only: the address if the synch endpoint */
566        uint8_t  bSynchAddress;
567
568        /** Extra descriptors. If libusb encounters unknown endpoint descriptors,
569         * it will store them here, should you wish to parse them. */
570        const unsigned char *extra;
571
572        /** Length of the extra descriptors, in bytes. */
573        int extra_length;
574};
575
576/** \ingroup desc
577 * A structure representing the standard USB interface descriptor. This
578 * descriptor is documented in section 9.6.5 of the USB 3.0 specification.
579 * All multiple-byte fields are represented in host-endian format.
580 */
581struct libusb_interface_descriptor {
582        /** Size of this descriptor (in bytes) */
583        uint8_t  bLength;
584
585        /** Descriptor type. Will have value
586         * \ref libusb_descriptor_type::LIBUSB_DT_INTERFACE LIBUSB_DT_INTERFACE
587         * in this context. */
588        uint8_t  bDescriptorType;
589
590        /** Number of this interface */
591        uint8_t  bInterfaceNumber;
592
593        /** Value used to select this alternate setting for this interface */
594        uint8_t  bAlternateSetting;
595
596        /** Number of endpoints used by this interface (excluding the control
597         * endpoint). */
598        uint8_t  bNumEndpoints;
599
600        /** USB-IF class code for this interface. See \ref libusb_class_code. */
601        uint8_t  bInterfaceClass;
602
603        /** USB-IF subclass code for this interface, qualified by the
604         * bInterfaceClass value */
605        uint8_t  bInterfaceSubClass;
606
607        /** USB-IF protocol code for this interface, qualified by the
608         * bInterfaceClass and bInterfaceSubClass values */
609        uint8_t  bInterfaceProtocol;
610
611        /** Index of string descriptor describing this interface */
612        uint8_t  iInterface;
613
614        /** Array of endpoint descriptors. This length of this array is determined
615         * by the bNumEndpoints field. */
616        const struct libusb_endpoint_descriptor *endpoint;
617
618        /** Extra descriptors. If libusb encounters unknown interface descriptors,
619         * it will store them here, should you wish to parse them. */
620        const unsigned char *extra;
621
622        /** Length of the extra descriptors, in bytes. */
623        int extra_length;
624};
625
626/** \ingroup desc
627 * A collection of alternate settings for a particular USB interface.
628 */
629struct libusb_interface {
630        /** Array of interface descriptors. The length of this array is determined
631         * by the num_altsetting field. */
632        const struct libusb_interface_descriptor *altsetting;
633
634        /** The number of alternate settings that belong to this interface */
635        int num_altsetting;
636};
637
638/** \ingroup desc
639 * A structure representing the standard USB configuration descriptor. This
640 * descriptor is documented in section 9.6.3 of the USB 3.0 specification.
641 * All multiple-byte fields are represented in host-endian format.
642 */
643struct libusb_config_descriptor {
644        /** Size of this descriptor (in bytes) */
645        uint8_t  bLength;
646
647        /** Descriptor type. Will have value
648         * \ref libusb_descriptor_type::LIBUSB_DT_CONFIG LIBUSB_DT_CONFIG
649         * in this context. */
650        uint8_t  bDescriptorType;
651
652        /** Total length of data returned for this configuration */
653        uint16_t wTotalLength;
654
655        /** Number of interfaces supported by this configuration */
656        uint8_t  bNumInterfaces;
657
658        /** Identifier value for this configuration */
659        uint8_t  bConfigurationValue;
660
661        /** Index of string descriptor describing this configuration */
662        uint8_t  iConfiguration;
663
664        /** Configuration characteristics */
665        uint8_t  bmAttributes;
666
667        /** Maximum power consumption of the USB device from this bus in this
668         * configuration when the device is fully opreation. Expressed in units
669         * of 2 mA. */
670        uint8_t  MaxPower;
671
672        /** Array of interfaces supported by this configuration. The length of
673         * this array is determined by the bNumInterfaces field. */
674        const struct libusb_interface *interface;
675
676        /** Extra descriptors. If libusb encounters unknown configuration
677         * descriptors, it will store them here, should you wish to parse them. */
678        const unsigned char *extra;
679
680        /** Length of the extra descriptors, in bytes. */
681        int extra_length;
682};
683
684/** \ingroup desc
685 * A structure representing the superspeed endpoint companion
686 * descriptor. This descriptor is documented in section 9.6.7 of
687 * the USB 3.0 specification. All multiple-byte fields are represented in
688 * host-endian format.
689 */
690struct libusb_ss_endpoint_companion_descriptor {
691
692        /** Size of this descriptor (in bytes) */
693        uint8_t  bLength;
694
695        /** Descriptor type. Will have value
696         * \ref libusb_descriptor_type::LIBUSB_DT_SS_ENDPOINT_COMPANION in
697         * this context. */
698        uint8_t  bDescriptorType;
699
700
701        /** The maximum number of packets the endpoint can send or
702         *  recieve as part of a burst. */
703        uint8_t  bMaxBurst;
704
705        /** In bulk EP: bits 4:0 represents the maximum number of
706         *  streams the EP supports. In isochronous EP: bits 1:0
707         *  represents the Mult - a zero based value that determines
708         *  the maximum number of packets within a service interval  */
709        uint8_t  bmAttributes;
710
711        /** The total number of bytes this EP will transfer every
712         *  service interval. valid only for periodic EPs. */
713        uint16_t wBytesPerInterval;
714};
715
716/** \ingroup desc
717 * A generic representation of a BOS Device Capability descriptor. It is
718 * advised to check bDevCapabilityType and call the matching
719 * libusb_get_*_descriptor function to get a structure fully matching the type.
720 */
721struct libusb_bos_dev_capability_descriptor {
722        /** Size of this descriptor (in bytes) */
723        uint8_t bLength;
724        /** Descriptor type. Will have value
725         * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE_CAPABILITY
726         * LIBUSB_DT_DEVICE_CAPABILITY in this context. */
727        uint8_t bDescriptorType;
728        /** Device Capability type */
729        uint8_t bDevCapabilityType;
730        /** Device Capability data (bLength - 3 bytes) */
731        uint8_t dev_capability_data
732#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
733        [] /* valid C99 code */
734#else
735        [0] /* non-standard, but usually working code */
736#endif
737        ;
738};
739
740/** \ingroup desc
741 * A structure representing the Binary Device Object Store (BOS) descriptor.
742 * This descriptor is documented in section 9.6.2 of the USB 3.0 specification.
743 * All multiple-byte fields are represented in host-endian format.
744 */
745struct libusb_bos_descriptor {
746        /** Size of this descriptor (in bytes) */
747        uint8_t  bLength;
748
749        /** Descriptor type. Will have value
750         * \ref libusb_descriptor_type::LIBUSB_DT_BOS LIBUSB_DT_BOS
751         * in this context. */
752        uint8_t  bDescriptorType;
753
754        /** Length of this descriptor and all of its sub descriptors */
755        uint16_t wTotalLength;
756
757        /** The number of separate device capability descriptors in
758         * the BOS */
759        uint8_t  bNumDeviceCaps;
760
761        /** bNumDeviceCap Device Capability Descriptors */
762        struct libusb_bos_dev_capability_descriptor *dev_capability
763#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
764        [] /* valid C99 code */
765#else
766        [0] /* non-standard, but usually working code */
767#endif
768        ;
769};
770
771/** \ingroup desc
772 * A structure representing the USB 2.0 Extension descriptor
773 * This descriptor is documented in section 9.6.2.1 of the USB 3.0 specification.
774 * All multiple-byte fields are represented in host-endian format.
775 */
776struct libusb_usb_2_0_extension_descriptor {
777        /** Size of this descriptor (in bytes) */
778        uint8_t  bLength;
779
780        /** Descriptor type. Will have value
781         * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE_CAPABILITY
782         * LIBUSB_DT_DEVICE_CAPABILITY in this context. */
783        uint8_t  bDescriptorType;
784
785        /** Capability type. Will have value
786         * \ref libusb_capability_type::LIBUSB_BT_USB_2_0_EXTENSION
787         * LIBUSB_BT_USB_2_0_EXTENSION in this context. */
788        uint8_t  bDevCapabilityType;
789
790        /** Bitmap encoding of supported device level features.
791         * A value of one in a bit location indicates a feature is
792         * supported; a value of zero indicates it is not supported.
793         * See \ref libusb_usb_2_0_extension_attributes. */
794        uint32_t  bmAttributes;
795};
796
797/** \ingroup desc
798 * A structure representing the SuperSpeed USB Device Capability descriptor
799 * This descriptor is documented in section 9.6.2.2 of the USB 3.0 specification.
800 * All multiple-byte fields are represented in host-endian format.
801 */
802struct libusb_ss_usb_device_capability_descriptor {
803        /** Size of this descriptor (in bytes) */
804        uint8_t  bLength;
805
806        /** Descriptor type. Will have value
807         * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE_CAPABILITY
808         * LIBUSB_DT_DEVICE_CAPABILITY in this context. */
809        uint8_t  bDescriptorType;
810
811        /** Capability type. Will have value
812         * \ref libusb_capability_type::LIBUSB_BT_SS_USB_DEVICE_CAPABILITY
813         * LIBUSB_BT_SS_USB_DEVICE_CAPABILITY in this context. */
814        uint8_t  bDevCapabilityType;
815
816        /** Bitmap encoding of supported device level features.
817         * A value of one in a bit location indicates a feature is
818         * supported; a value of zero indicates it is not supported.
819         * See \ref libusb_ss_usb_device_capability_attributes. */
820        uint8_t  bmAttributes;
821
822        /** Bitmap encoding of the speed supported by this device when
823         * operating in SuperSpeed mode. See \ref libusb_supported_speed. */
824        uint16_t wSpeedSupported;
825
826        /** The lowest speed at which all the functionality supported
827         * by the device is available to the user. For example if the
828         * device supports all its functionality when connected at
829         * full speed and above then it sets this value to 1. */
830        uint8_t  bFunctionalitySupport;
831
832        /** U1 Device Exit Latency. */
833        uint8_t  bU1DevExitLat;
834
835        /** U2 Device Exit Latency. */
836        uint16_t bU2DevExitLat;
837};
838
839/** \ingroup desc
840 * A structure representing the Container ID descriptor.
841 * This descriptor is documented in section 9.6.2.3 of the USB 3.0 specification.
842 * All multiple-byte fields, except UUIDs, are represented in host-endian format.
843 */
844struct libusb_container_id_descriptor {
845        /** Size of this descriptor (in bytes) */
846        uint8_t  bLength;
847
848        /** Descriptor type. Will have value
849         * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE_CAPABILITY
850         * LIBUSB_DT_DEVICE_CAPABILITY in this context. */
851        uint8_t  bDescriptorType;
852
853        /** Capability type. Will have value
854         * \ref libusb_capability_type::LIBUSB_BT_CONTAINER_ID
855         * LIBUSB_BT_CONTAINER_ID in this context. */
856        uint8_t  bDevCapabilityType;
857
858        /** Reserved field */
859        uint8_t bReserved;
860
861        /** 128 bit UUID */
862        uint8_t  ContainerID[16];
863};
864
865/** \ingroup asyncio
866 * Setup packet for control transfers. */
867struct libusb_control_setup {
868        /** Request type. Bits 0:4 determine recipient, see
869         * \ref libusb_request_recipient. Bits 5:6 determine type, see
870         * \ref libusb_request_type. Bit 7 determines data transfer direction, see
871         * \ref libusb_endpoint_direction.
872         */
873        uint8_t  bmRequestType;
874
875        /** Request. If the type bits of bmRequestType are equal to
876         * \ref libusb_request_type::LIBUSB_REQUEST_TYPE_STANDARD
877         * "LIBUSB_REQUEST_TYPE_STANDARD" then this field refers to
878         * \ref libusb_standard_request. For other cases, use of this field is
879         * application-specific. */
880        uint8_t  bRequest;
881
882        /** Value. Varies according to request */
883        uint16_t wValue;
884
885        /** Index. Varies according to request, typically used to pass an index
886         * or offset */
887        uint16_t wIndex;
888
889        /** Number of bytes to transfer */
890        uint16_t wLength;
891};
892
893#define LIBUSB_CONTROL_SETUP_SIZE (sizeof(struct libusb_control_setup))
894
895/* libusb */
896
897struct libusb_context;
898struct libusb_device;
899struct libusb_device_handle;
900struct libusb_hotplug_callback;
901
902/** \ingroup lib
903 * Structure providing the version of the libusb runtime
904 */
905struct libusb_version {
906        /** Library major version. */
907        const uint16_t major;
908
909        /** Library minor version. */
910        const uint16_t minor;
911
912        /** Library micro version. */
913        const uint16_t micro;
914
915        /** Library nano version. */
916        const uint16_t nano;
917
918        /** Library release candidate suffix string, e.g. "-rc4". */
919        const char *rc;
920
921        /** For ABI compatibility only. */
922        const char* describe;
923};
924
925/** \ingroup lib
926 * Structure representing a libusb session. The concept of individual libusb
927 * sessions allows for your program to use two libraries (or dynamically
928 * load two modules) which both independently use libusb. This will prevent
929 * interference between the individual libusb users - for example
930 * libusb_set_debug() will not affect the other user of the library, and
931 * libusb_exit() will not destroy resources that the other user is still
932 * using.
933 *
934 * Sessions are created by libusb_init() and destroyed through libusb_exit().
935 * If your application is guaranteed to only ever include a single libusb
936 * user (i.e. you), you do not have to worry about contexts: pass NULL in
937 * every function call where a context is required. The default context
938 * will be used.
939 *
940 * For more information, see \ref contexts.
941 */
942typedef struct libusb_context libusb_context;
943
944/** \ingroup dev
945 * Structure representing a USB device detected on the system. This is an
946 * opaque type for which you are only ever provided with a pointer, usually
947 * originating from libusb_get_device_list().
948 *
949 * Certain operations can be performed on a device, but in order to do any
950 * I/O you will have to first obtain a device handle using libusb_open().
951 *
952 * Devices are reference counted with libusb_ref_device() and
953 * libusb_unref_device(), and are freed when the reference count reaches 0.
954 * New devices presented by libusb_get_device_list() have a reference count of
955 * 1, and libusb_free_device_list() can optionally decrease the reference count
956 * on all devices in the list. libusb_open() adds another reference which is
957 * later destroyed by libusb_close().
958 */
959typedef struct libusb_device libusb_device;
960
961
962/** \ingroup dev
963 * Structure representing a handle on a USB device. This is an opaque type for
964 * which you are only ever provided with a pointer, usually originating from
965 * libusb_open().
966 *
967 * A device handle is used to perform I/O and other operations. When finished
968 * with a device handle, you should call libusb_close().
969 */
970typedef struct libusb_device_handle libusb_device_handle;
971
972/** \ingroup dev
973 * Speed codes. Indicates the speed at which the device is operating.
974 */
975enum libusb_speed {
976        /** The OS doesn't report or know the device speed. */
977        LIBUSB_SPEED_UNKNOWN = 0,
978
979        /** The device is operating at low speed (1.5MBit/s). */
980        LIBUSB_SPEED_LOW = 1,
981
982        /** The device is operating at full speed (12MBit/s). */
983        LIBUSB_SPEED_FULL = 2,
984
985        /** The device is operating at high speed (480MBit/s). */
986        LIBUSB_SPEED_HIGH = 3,
987
988        /** The device is operating at super speed (5000MBit/s). */
989        LIBUSB_SPEED_SUPER = 4,
990};
991
992/** \ingroup dev
993 * Supported speeds (wSpeedSupported) bitfield. Indicates what
994 * speeds the device supports.
995 */
996enum libusb_supported_speed {
997        /** Low speed operation supported (1.5MBit/s). */
998        LIBUSB_LOW_SPEED_OPERATION   = 1,
999
1000        /** Full speed operation supported (12MBit/s). */
1001        LIBUSB_FULL_SPEED_OPERATION  = 2,
1002
1003        /** High speed operation supported (480MBit/s). */
1004        LIBUSB_HIGH_SPEED_OPERATION  = 4,
1005
1006        /** Superspeed operation supported (5000MBit/s). */
1007        LIBUSB_SUPER_SPEED_OPERATION = 8,
1008};
1009
1010/** \ingroup dev
1011 * Masks for the bits of the
1012 * \ref libusb_usb_2_0_extension_descriptor::bmAttributes "bmAttributes" field
1013 * of the USB 2.0 Extension descriptor.
1014 */
1015enum libusb_usb_2_0_extension_attributes {
1016        /** Supports Link Power Management (LPM) */
1017        LIBUSB_BM_LPM_SUPPORT = 2,
1018};
1019
1020/** \ingroup dev
1021 * Masks for the bits of the
1022 * \ref libusb_ss_usb_device_capability_descriptor::bmAttributes "bmAttributes" field
1023 * field of the SuperSpeed USB Device Capability descriptor.
1024 */
1025enum libusb_ss_usb_device_capability_attributes {
1026        /** Supports Latency Tolerance Messages (LTM) */
1027        LIBUSB_BM_LTM_SUPPORT = 2,
1028};
1029
1030/** \ingroup dev
1031 * USB capability types
1032 */
1033enum libusb_bos_type {
1034        /** Wireless USB device capability */
1035        LIBUSB_BT_WIRELESS_USB_DEVICE_CAPABILITY        = 1,
1036
1037        /** USB 2.0 extensions */
1038        LIBUSB_BT_USB_2_0_EXTENSION                     = 2,
1039
1040        /** SuperSpeed USB device capability */
1041        LIBUSB_BT_SS_USB_DEVICE_CAPABILITY              = 3,
1042
1043        /** Container ID type */
1044        LIBUSB_BT_CONTAINER_ID                          = 4,
1045};
1046
1047/** \ingroup misc
1048 * Error codes. Most libusb functions return 0 on success or one of these
1049 * codes on failure.
1050 * You can call libusb_error_name() to retrieve a string representation of an
1051 * error code or libusb_strerror() to get an end-user suitable description of
1052 * an error code.
1053 */
1054enum libusb_error {
1055        /** Success (no error) */
1056        LIBUSB_SUCCESS = 0,
1057
1058        /** Input/output error */
1059        LIBUSB_ERROR_IO = -1,
1060
1061        /** Invalid parameter */
1062        LIBUSB_ERROR_INVALID_PARAM = -2,
1063
1064        /** Access denied (insufficient permissions) */
1065        LIBUSB_ERROR_ACCESS = -3,
1066
1067        /** No such device (it may have been disconnected) */
1068        LIBUSB_ERROR_NO_DEVICE = -4,
1069
1070        /** Entity not found */
1071        LIBUSB_ERROR_NOT_FOUND = -5,
1072
1073        /** Resource busy */
1074        LIBUSB_ERROR_BUSY = -6,
1075
1076        /** Operation timed out */
1077        LIBUSB_ERROR_TIMEOUT = -7,
1078
1079        /** Overflow */
1080        LIBUSB_ERROR_OVERFLOW = -8,
1081
1082        /** Pipe error */
1083        LIBUSB_ERROR_PIPE = -9,
1084
1085        /** System call interrupted (perhaps due to signal) */
1086        LIBUSB_ERROR_INTERRUPTED = -10,
1087
1088        /** Insufficient memory */
1089        LIBUSB_ERROR_NO_MEM = -11,
1090
1091        /** Operation not supported or unimplemented on this platform */
1092        LIBUSB_ERROR_NOT_SUPPORTED = -12,
1093
1094        /* NB: Remember to update LIBUSB_ERROR_COUNT below as well as the
1095           message strings in strerror.c when adding new error codes here. */
1096
1097        /** Other error */
1098        LIBUSB_ERROR_OTHER = -99,
1099};
1100
1101/* Total number of error codes in enum libusb_error */
1102#define LIBUSB_ERROR_COUNT 14
1103
1104/** \ingroup asyncio
1105 * Transfer status codes */
1106enum libusb_transfer_status {
1107        /** Transfer completed without error. Note that this does not indicate
1108         * that the entire amount of requested data was transferred. */
1109        LIBUSB_TRANSFER_COMPLETED,
1110
1111        /** Transfer failed */
1112        LIBUSB_TRANSFER_ERROR,
1113
1114        /** Transfer timed out */
1115        LIBUSB_TRANSFER_TIMED_OUT,
1116
1117        /** Transfer was cancelled */
1118        LIBUSB_TRANSFER_CANCELLED,
1119
1120        /** For bulk/interrupt endpoints: halt condition detected (endpoint
1121         * stalled). For control endpoints: control request not supported. */
1122        LIBUSB_TRANSFER_STALL,
1123
1124        /** Device was disconnected */
1125        LIBUSB_TRANSFER_NO_DEVICE,
1126
1127        /** Device sent more data than requested */
1128        LIBUSB_TRANSFER_OVERFLOW,
1129
1130        /* NB! Remember to update libusb_error_name()
1131           when adding new status codes here. */
1132};
1133
1134/** \ingroup asyncio
1135 * libusb_transfer.flags values */
1136enum libusb_transfer_flags {
1137        /** Report short frames as errors */
1138        LIBUSB_TRANSFER_SHORT_NOT_OK = 1<<0,
1139
1140        /** Automatically free() transfer buffer during libusb_free_transfer() */
1141        LIBUSB_TRANSFER_FREE_BUFFER = 1<<1,
1142
1143        /** Automatically call libusb_free_transfer() after callback returns.
1144         * If this flag is set, it is illegal to call libusb_free_transfer()
1145         * from your transfer callback, as this will result in a double-free
1146         * when this flag is acted upon. */
1147        LIBUSB_TRANSFER_FREE_TRANSFER = 1<<2,
1148
1149        /** Terminate transfers that are a multiple of the endpoint's
1150         * wMaxPacketSize with an extra zero length packet. This is useful
1151         * when a device protocol mandates that each logical request is
1152         * terminated by an incomplete packet (i.e. the logical requests are
1153         * not separated by other means).
1154         *
1155         * This flag only affects host-to-device transfers to bulk and interrupt
1156         * endpoints. In other situations, it is ignored.
1157         *
1158         * This flag only affects transfers with a length that is a multiple of
1159         * the endpoint's wMaxPacketSize. On transfers of other lengths, this
1160         * flag has no effect. Therefore, if you are working with a device that
1161         * needs a ZLP whenever the end of the logical request falls on a packet
1162         * boundary, then it is sensible to set this flag on <em>every</em>
1163         * transfer (you do not have to worry about only setting it on transfers
1164         * that end on the boundary).
1165         *
1166         * This flag is currently only supported on Linux.
1167         * On other systems, libusb_submit_transfer() will return
1168         * LIBUSB_ERROR_NOT_SUPPORTED for every transfer where this flag is set.
1169         *
1170         * Available since libusb-1.0.9.
1171         */
1172        LIBUSB_TRANSFER_ADD_ZERO_PACKET = 1 << 3,
1173};
1174
1175/** \ingroup asyncio
1176 * Isochronous packet descriptor. */
1177struct libusb_iso_packet_descriptor {
1178        /** Length of data to request in this packet */
1179        unsigned int length;
1180
1181        /** Amount of data that was actually transferred */
1182        unsigned int actual_length;
1183
1184        /** Status code for this packet */
1185        enum libusb_transfer_status status;
1186};
1187
1188struct libusb_transfer;
1189
1190/** \ingroup asyncio
1191 * Asynchronous transfer callback function type. When submitting asynchronous
1192 * transfers, you pass a pointer to a callback function of this type via the
1193 * \ref libusb_transfer::callback "callback" member of the libusb_transfer
1194 * structure. libusb will call this function later, when the transfer has
1195 * completed or failed. See \ref asyncio for more information.
1196 * \param transfer The libusb_transfer struct the callback function is being
1197 * notified about.
1198 */
1199typedef void (LIBUSB_CALL *libusb_transfer_cb_fn)(struct libusb_transfer *transfer);
1200
1201/** \ingroup asyncio
1202 * The generic USB transfer structure. The user populates this structure and
1203 * then submits it in order to request a transfer. After the transfer has
1204 * completed, the library populates the transfer with the results and passes
1205 * it back to the user.
1206 */
1207struct libusb_transfer {
1208        /** Handle of the device that this transfer will be submitted to */
1209        libusb_device_handle *dev_handle;
1210
1211        /** A bitwise OR combination of \ref libusb_transfer_flags. */
1212        uint8_t flags;
1213
1214        /** Address of the endpoint where this transfer will be sent. */
1215        unsigned char endpoint;
1216
1217        /** Type of the endpoint from \ref libusb_transfer_type */
1218        unsigned char type;
1219
1220        /** Timeout for this transfer in millseconds. A value of 0 indicates no
1221         * timeout. */
1222        unsigned int timeout;
1223
1224        /** The status of the transfer. Read-only, and only for use within
1225         * transfer callback function.
1226         *
1227         * If this is an isochronous transfer, this field may read COMPLETED even
1228         * if there were errors in the frames. Use the
1229         * \ref libusb_iso_packet_descriptor::status "status" field in each packet
1230         * to determine if errors occurred. */
1231        enum libusb_transfer_status status;
1232
1233        /** Length of the data buffer */
1234        int length;
1235
1236        /** Actual length of data that was transferred. Read-only, and only for
1237         * use within transfer callback function. Not valid for isochronous
1238         * endpoint transfers. */
1239        int actual_length;
1240
1241        /** Callback function. This will be invoked when the transfer completes,
1242         * fails, or is cancelled. */
1243        libusb_transfer_cb_fn callback;
1244
1245        /** User context data to pass to the callback function. */
1246        void *user_data;
1247
1248        /** Data buffer */
1249        unsigned char *buffer;
1250
1251        /** Number of isochronous packets. Only used for I/O with isochronous
1252         * endpoints. */
1253        int num_iso_packets;
1254
1255        /** Isochronous packet descriptors, for isochronous transfers only. */
1256        struct libusb_iso_packet_descriptor iso_packet_desc
1257#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)
1258        [] /* valid C99 code */
1259#else
1260        [0] /* non-standard, but usually working code */
1261#endif
1262        ;
1263};
1264
1265/** \ingroup misc
1266 * Capabilities supported by an instance of libusb on the current running
1267 * platform. Test if the loaded library supports a given capability by calling
1268 * \ref libusb_has_capability().
1269 */
1270enum libusb_capability {
1271        /** The libusb_has_capability() API is available. */
1272        LIBUSB_CAP_HAS_CAPABILITY = 0x0000,
1273        /** Hotplug support is available on this platform. */
1274        LIBUSB_CAP_HAS_HOTPLUG = 0x0001,
1275        /** The library can access HID devices without requiring user intervention.
1276         * Note that before being able to actually access an HID device, you may
1277         * still have to call additional libusb functions such as
1278         * \ref libusb_detach_kernel_driver(). */
1279        LIBUSB_CAP_HAS_HID_ACCESS = 0x0100,
1280        /** The library supports detaching of the default USB driver, using
1281         * \ref libusb_detach_kernel_driver(), if one is set by the OS kernel */
1282        LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER = 0x0101
1283};
1284
1285/** \ingroup lib
1286 *  Log message levels.
1287 *  - LIBUSB_LOG_LEVEL_NONE (0)    : no messages ever printed by the library (default)
1288 *  - LIBUSB_LOG_LEVEL_ERROR (1)   : error messages are printed to stderr
1289 *  - LIBUSB_LOG_LEVEL_WARNING (2) : warning and error messages are printed to stderr
1290 *  - LIBUSB_LOG_LEVEL_INFO (3)    : informational messages are printed to stdout, warning
1291 *    and error messages are printed to stderr
1292 *  - LIBUSB_LOG_LEVEL_DEBUG (4)   : debug and informational messages are printed to stdout,
1293 *    warnings and errors to stderr
1294 */
1295enum libusb_log_level {
1296        LIBUSB_LOG_LEVEL_NONE = 0,
1297        LIBUSB_LOG_LEVEL_ERROR,
1298        LIBUSB_LOG_LEVEL_WARNING,
1299        LIBUSB_LOG_LEVEL_INFO,
1300        LIBUSB_LOG_LEVEL_DEBUG,
1301};
1302
1303int LIBUSB_CALL libusb_init(libusb_context **ctx);
1304void LIBUSB_CALL libusb_exit(libusb_context *ctx);
1305void LIBUSB_CALL libusb_set_debug(libusb_context *ctx, int level);
1306const struct libusb_version * LIBUSB_CALL libusb_get_version(void);
1307int LIBUSB_CALL libusb_has_capability(uint32_t capability);
1308const char * LIBUSB_CALL libusb_error_name(int errcode);
1309int LIBUSB_CALL libusb_setlocale(const char *locale);
1310const char * LIBUSB_CALL libusb_strerror(enum libusb_error errcode);
1311
1312ssize_t LIBUSB_CALL libusb_get_device_list(libusb_context *ctx,
1313        libusb_device ***list);
1314void LIBUSB_CALL libusb_free_device_list(libusb_device **list,
1315        int unref_devices);
1316libusb_device * LIBUSB_CALL libusb_ref_device(libusb_device *dev);
1317void LIBUSB_CALL libusb_unref_device(libusb_device *dev);
1318
1319int LIBUSB_CALL libusb_get_configuration(libusb_device_handle *dev,
1320        int *config);
1321int LIBUSB_CALL libusb_get_device_descriptor(libusb_device *dev,
1322        struct libusb_device_descriptor *desc);
1323int LIBUSB_CALL libusb_get_active_config_descriptor(libusb_device *dev,
1324        struct libusb_config_descriptor **config);
1325int LIBUSB_CALL libusb_get_config_descriptor(libusb_device *dev,
1326        uint8_t config_index, struct libusb_config_descriptor **config);
1327int LIBUSB_CALL libusb_get_config_descriptor_by_value(libusb_device *dev,
1328        uint8_t bConfigurationValue, struct libusb_config_descriptor **config);
1329void LIBUSB_CALL libusb_free_config_descriptor(
1330        struct libusb_config_descriptor *config);
1331int LIBUSB_CALL libusb_get_ss_endpoint_companion_descriptor(
1332        struct libusb_context *ctx,
1333        const struct libusb_endpoint_descriptor *endpoint,
1334        struct libusb_ss_endpoint_companion_descriptor **ep_comp);
1335void LIBUSB_CALL libusb_free_ss_endpoint_companion_descriptor(
1336        struct libusb_ss_endpoint_companion_descriptor *ep_comp);
1337int LIBUSB_CALL libusb_get_bos_descriptor(libusb_device_handle *handle,
1338        struct libusb_bos_descriptor **bos);
1339void LIBUSB_CALL libusb_free_bos_descriptor(struct libusb_bos_descriptor *bos);
1340int LIBUSB_CALL libusb_get_usb_2_0_extension_descriptor(
1341        struct libusb_context *ctx,
1342        struct libusb_bos_dev_capability_descriptor *dev_cap,
1343        struct libusb_usb_2_0_extension_descriptor **usb_2_0_extension);
1344void LIBUSB_CALL libusb_free_usb_2_0_extension_descriptor(
1345        struct libusb_usb_2_0_extension_descriptor *usb_2_0_extension);
1346int LIBUSB_CALL libusb_get_ss_usb_device_capability_descriptor(
1347        struct libusb_context *ctx,
1348        struct libusb_bos_dev_capability_descriptor *dev_cap,
1349        struct libusb_ss_usb_device_capability_descriptor **ss_usb_device_cap);
1350void LIBUSB_CALL libusb_free_ss_usb_device_capability_descriptor(
1351        struct libusb_ss_usb_device_capability_descriptor *ss_usb_device_cap);
1352int LIBUSB_CALL libusb_get_container_id_descriptor(struct libusb_context *ctx,
1353        struct libusb_bos_dev_capability_descriptor *dev_cap,
1354        struct libusb_container_id_descriptor **container_id);
1355void LIBUSB_CALL libusb_free_container_id_descriptor(
1356        struct libusb_container_id_descriptor *container_id);
1357uint8_t LIBUSB_CALL libusb_get_bus_number(libusb_device *dev);
1358uint8_t LIBUSB_CALL libusb_get_port_number(libusb_device *dev);
1359int LIBUSB_CALL libusb_get_port_numbers(libusb_device *dev, uint8_t* port_numbers, int port_numbers_len);
1360LIBUSB_DEPRECATED_FOR(libusb_get_port_numbers)
1361int LIBUSB_CALL libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t* path, uint8_t path_length);
1362libusb_device * LIBUSB_CALL libusb_get_parent(libusb_device *dev);
1363uint8_t LIBUSB_CALL libusb_get_device_address(libusb_device *dev);
1364int LIBUSB_CALL libusb_get_device_speed(libusb_device *dev);
1365int LIBUSB_CALL libusb_get_max_packet_size(libusb_device *dev,
1366        unsigned char endpoint);
1367int LIBUSB_CALL libusb_get_max_iso_packet_size(libusb_device *dev,
1368        unsigned char endpoint);
1369
1370int LIBUSB_CALL libusb_open(libusb_device *dev, libusb_device_handle **handle);
1371void LIBUSB_CALL libusb_close(libusb_device_handle *dev_handle);
1372libusb_device * LIBUSB_CALL libusb_get_device(libusb_device_handle *dev_handle);
1373
1374int LIBUSB_CALL libusb_set_configuration(libusb_device_handle *dev,
1375        int configuration);
1376int LIBUSB_CALL libusb_claim_interface(libusb_device_handle *dev,
1377        int interface_number);
1378int LIBUSB_CALL libusb_release_interface(libusb_device_handle *dev,
1379        int interface_number);
1380
1381libusb_device_handle * LIBUSB_CALL libusb_open_device_with_vid_pid(
1382        libusb_context *ctx, uint16_t vendor_id, uint16_t product_id);
1383
1384int LIBUSB_CALL libusb_set_interface_alt_setting(libusb_device_handle *dev,
1385        int interface_number, int alternate_setting);
1386int LIBUSB_CALL libusb_clear_halt(libusb_device_handle *dev,
1387        unsigned char endpoint);
1388int LIBUSB_CALL libusb_reset_device(libusb_device_handle *dev);
1389
1390int LIBUSB_CALL libusb_kernel_driver_active(libusb_device_handle *dev,
1391        int interface_number);
1392int LIBUSB_CALL libusb_detach_kernel_driver(libusb_device_handle *dev,
1393        int interface_number);
1394int LIBUSB_CALL libusb_attach_kernel_driver(libusb_device_handle *dev,
1395        int interface_number);
1396int LIBUSB_CALL libusb_set_auto_detach_kernel_driver(
1397        libusb_device_handle *dev, int enable);
1398
1399/* async I/O */
1400
1401/** \ingroup asyncio
1402 * Get the data section of a control transfer. This convenience function is here
1403 * to remind you that the data does not start until 8 bytes into the actual
1404 * buffer, as the setup packet comes first.
1405 *
1406 * Calling this function only makes sense from a transfer callback function,
1407 * or situations where you have already allocated a suitably sized buffer at
1408 * transfer->buffer.
1409 *
1410 * \param transfer a transfer
1411 * \returns pointer to the first byte of the data section
1412 */
1413static inline unsigned char *libusb_control_transfer_get_data(
1414        struct libusb_transfer *transfer)
1415{
1416        return transfer->buffer + LIBUSB_CONTROL_SETUP_SIZE;
1417}
1418
1419/** \ingroup asyncio
1420 * Get the control setup packet of a control transfer. This convenience
1421 * function is here to remind you that the control setup occupies the first
1422 * 8 bytes of the transfer data buffer.
1423 *
1424 * Calling this function only makes sense from a transfer callback function,
1425 * or situations where you have already allocated a suitably sized buffer at
1426 * transfer->buffer.
1427 *
1428 * \param transfer a transfer
1429 * \returns a casted pointer to the start of the transfer data buffer
1430 */
1431static inline struct libusb_control_setup *libusb_control_transfer_get_setup(
1432        struct libusb_transfer *transfer)
1433{
1434        return (struct libusb_control_setup *)(void *) transfer->buffer;
1435}
1436
1437/** \ingroup asyncio
1438 * Helper function to populate the setup packet (first 8 bytes of the data
1439 * buffer) for a control transfer. The wIndex, wValue and wLength values should
1440 * be given in host-endian byte order.
1441 *
1442 * \param buffer buffer to output the setup packet into
1443 * This pointer must be aligned to at least 2 bytes boundary.
1444 * \param bmRequestType see the
1445 * \ref libusb_control_setup::bmRequestType "bmRequestType" field of
1446 * \ref libusb_control_setup
1447 * \param bRequest see the
1448 * \ref libusb_control_setup::bRequest "bRequest" field of
1449 * \ref libusb_control_setup
1450 * \param wValue see the
1451 * \ref libusb_control_setup::wValue "wValue" field of
1452 * \ref libusb_control_setup
1453 * \param wIndex see the
1454 * \ref libusb_control_setup::wIndex "wIndex" field of
1455 * \ref libusb_control_setup
1456 * \param wLength see the
1457 * \ref libusb_control_setup::wLength "wLength" field of
1458 * \ref libusb_control_setup
1459 */
1460static inline void libusb_fill_control_setup(unsigned char *buffer,
1461        uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
1462        uint16_t wLength)
1463{
1464        struct libusb_control_setup *setup = (struct libusb_control_setup *)(void *) buffer;
1465        setup->bmRequestType = bmRequestType;
1466        setup->bRequest = bRequest;
1467        setup->wValue = libusb_cpu_to_le16(wValue);
1468        setup->wIndex = libusb_cpu_to_le16(wIndex);
1469        setup->wLength = libusb_cpu_to_le16(wLength);
1470}
1471
1472struct libusb_transfer * LIBUSB_CALL libusb_alloc_transfer(int iso_packets);
1473int LIBUSB_CALL libusb_submit_transfer(struct libusb_transfer *transfer);
1474int LIBUSB_CALL libusb_cancel_transfer(struct libusb_transfer *transfer);
1475void LIBUSB_CALL libusb_free_transfer(struct libusb_transfer *transfer);
1476
1477/** \ingroup asyncio
1478 * Helper function to populate the required \ref libusb_transfer fields
1479 * for a control transfer.
1480 *
1481 * If you pass a transfer buffer to this function, the first 8 bytes will
1482 * be interpreted as a control setup packet, and the wLength field will be
1483 * used to automatically populate the \ref libusb_transfer::length "length"
1484 * field of the transfer. Therefore the recommended approach is:
1485 * -# Allocate a suitably sized data buffer (including space for control setup)
1486 * -# Call libusb_fill_control_setup()
1487 * -# If this is a host-to-device transfer with a data stage, put the data
1488 *    in place after the setup packet
1489 * -# Call this function
1490 * -# Call libusb_submit_transfer()
1491 *
1492 * It is also legal to pass a NULL buffer to this function, in which case this
1493 * function will not attempt to populate the length field. Remember that you
1494 * must then populate the buffer and length fields later.
1495 *
1496 * \param transfer the transfer to populate
1497 * \param dev_handle handle of the device that will handle the transfer
1498 * \param buffer data buffer. If provided, this function will interpret the
1499 * first 8 bytes as a setup packet and infer the transfer length from that.
1500 * This pointer must be aligned to at least 2 bytes boundary.
1501 * \param callback callback function to be invoked on transfer completion
1502 * \param user_data user data to pass to callback function
1503 * \param timeout timeout for the transfer in milliseconds
1504 */
1505static inline void libusb_fill_control_transfer(
1506        struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1507        unsigned char *buffer, libusb_transfer_cb_fn callback, void *user_data,
1508        unsigned int timeout)
1509{
1510        struct libusb_control_setup *setup = (struct libusb_control_setup *)(void *) buffer;
1511        transfer->dev_handle = dev_handle;
1512        transfer->endpoint = 0;
1513        transfer->type = LIBUSB_TRANSFER_TYPE_CONTROL;
1514        transfer->timeout = timeout;
1515        transfer->buffer = buffer;
1516        if (setup)
1517                transfer->length = (int) (LIBUSB_CONTROL_SETUP_SIZE
1518                        + libusb_le16_to_cpu(setup->wLength));
1519        transfer->user_data = user_data;
1520        transfer->callback = callback;
1521}
1522
1523/** \ingroup asyncio
1524 * Helper function to populate the required \ref libusb_transfer fields
1525 * for a bulk transfer.
1526 *
1527 * \param transfer the transfer to populate
1528 * \param dev_handle handle of the device that will handle the transfer
1529 * \param endpoint address of the endpoint where this transfer will be sent
1530 * \param buffer data buffer
1531 * \param length length of data buffer
1532 * \param callback callback function to be invoked on transfer completion
1533 * \param user_data user data to pass to callback function
1534 * \param timeout timeout for the transfer in milliseconds
1535 */
1536static inline void libusb_fill_bulk_transfer(struct libusb_transfer *transfer,
1537        libusb_device_handle *dev_handle, unsigned char endpoint,
1538        unsigned char *buffer, int length, libusb_transfer_cb_fn callback,
1539        void *user_data, unsigned int timeout)
1540{
1541        transfer->dev_handle = dev_handle;
1542        transfer->endpoint = endpoint;
1543        transfer->type = LIBUSB_TRANSFER_TYPE_BULK;
1544        transfer->timeout = timeout;
1545        transfer->buffer = buffer;
1546        transfer->length = length;
1547        transfer->user_data = user_data;
1548        transfer->callback = callback;
1549}
1550
1551/** \ingroup asyncio
1552 * Helper function to populate the required \ref libusb_transfer fields
1553 * for an interrupt transfer.
1554 *
1555 * \param transfer the transfer to populate
1556 * \param dev_handle handle of the device that will handle the transfer
1557 * \param endpoint address of the endpoint where this transfer will be sent
1558 * \param buffer data buffer
1559 * \param length length of data buffer
1560 * \param callback callback function to be invoked on transfer completion
1561 * \param user_data user data to pass to callback function
1562 * \param timeout timeout for the transfer in milliseconds
1563 */
1564static inline void libusb_fill_interrupt_transfer(
1565        struct libusb_transfer *transfer, libusb_device_handle *dev_handle,
1566        unsigned char endpoint, unsigned char *buffer, int length,
1567        libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
1568{
1569        transfer->dev_handle = dev_handle;
1570        transfer->endpoint = endpoint;
1571        transfer->type = LIBUSB_TRANSFER_TYPE_INTERRUPT;
1572        transfer->timeout = timeout;
1573        transfer->buffer = buffer;
1574        transfer->length = length;
1575        transfer->user_data = user_data;
1576        transfer->callback = callback;
1577}
1578
1579/** \ingroup asyncio
1580 * Helper function to populate the required \ref libusb_transfer fields
1581 * for an isochronous transfer.
1582 *
1583 * \param transfer the transfer to populate
1584 * \param dev_handle handle of the device that will handle the transfer
1585 * \param endpoint address of the endpoint where this transfer will be sent
1586 * \param buffer data buffer
1587 * \param length length of data buffer
1588 * \param num_iso_packets the number of isochronous packets
1589 * \param callback callback function to be invoked on transfer completion
1590 * \param user_data user data to pass to callback function
1591 * \param timeout timeout for the transfer in milliseconds
1592 */
1593static inline void libusb_fill_iso_transfer(struct libusb_transfer *transfer,
1594        libusb_device_handle *dev_handle, unsigned char endpoint,
1595        unsigned char *buffer, int length, int num_iso_packets,
1596        libusb_transfer_cb_fn callback, void *user_data, unsigned int timeout)
1597{
1598        transfer->dev_handle = dev_handle;
1599        transfer->endpoint = endpoint;
1600        transfer->type = LIBUSB_TRANSFER_TYPE_ISOCHRONOUS;
1601        transfer->timeout = timeout;
1602        transfer->buffer = buffer;
1603        transfer->length = length;
1604        transfer->num_iso_packets = num_iso_packets;
1605        transfer->user_data = user_data;
1606        transfer->callback = callback;
1607}
1608
1609/** \ingroup asyncio
1610 * Convenience function to set the length of all packets in an isochronous
1611 * transfer, based on the num_iso_packets field in the transfer structure.
1612 *
1613 * \param transfer a transfer
1614 * \param length the length to set in each isochronous packet descriptor
1615 * \see libusb_get_max_packet_size()
1616 */
1617static inline void libusb_set_iso_packet_lengths(
1618        struct libusb_transfer *transfer, unsigned int length)
1619{
1620        int i;
1621        for (i = 0; i < transfer->num_iso_packets; i++)
1622                transfer->iso_packet_desc[i].length = length;
1623}
1624
1625/** \ingroup asyncio
1626 * Convenience function to locate the position of an isochronous packet
1627 * within the buffer of an isochronous transfer.
1628 *
1629 * This is a thorough function which loops through all preceding packets,
1630 * accumulating their lengths to find the position of the specified packet.
1631 * Typically you will assign equal lengths to each packet in the transfer,
1632 * and hence the above method is sub-optimal. You may wish to use
1633 * libusb_get_iso_packet_buffer_simple() instead.
1634 *
1635 * \param transfer a transfer
1636 * \param packet the packet to return the address of
1637 * \returns the base address of the packet buffer inside the transfer buffer,
1638 * or NULL if the packet does not exist.
1639 * \see libusb_get_iso_packet_buffer_simple()
1640 */
1641static inline unsigned char *libusb_get_iso_packet_buffer(
1642        struct libusb_transfer *transfer, unsigned int packet)
1643{
1644        int i;
1645        size_t offset = 0;
1646        int _packet;
1647
1648        /* oops..slight bug in the API. packet is an unsigned int, but we use
1649         * signed integers almost everywhere else. range-check and convert to
1650         * signed to avoid compiler warnings. FIXME for libusb-2. */
1651        if (packet > INT_MAX)
1652                return NULL;
1653        _packet = (int) packet;
1654
1655        if (_packet >= transfer->num_iso_packets)
1656                return NULL;
1657
1658        for (i = 0; i < _packet; i++)
1659                offset += transfer->iso_packet_desc[i].length;
1660
1661        return transfer->buffer + offset;
1662}
1663
1664/** \ingroup asyncio
1665 * Convenience function to locate the position of an isochronous packet
1666 * within the buffer of an isochronous transfer, for transfers where each
1667 * packet is of identical size.
1668 *
1669 * This function relies on the assumption that every packet within the transfer
1670 * is of identical size to the first packet. Calculating the location of
1671 * the packet buffer is then just a simple calculation:
1672 * <tt>buffer + (packet_size * packet)</tt>
1673 *
1674 * Do not use this function on transfers other than those that have identical
1675 * packet lengths for each packet.
1676 *
1677 * \param transfer a transfer
1678 * \param packet the packet to return the address of
1679 * \returns the base address of the packet buffer inside the transfer buffer,
1680 * or NULL if the packet does not exist.
1681 * \see libusb_get_iso_packet_buffer()
1682 */
1683static inline unsigned char *libusb_get_iso_packet_buffer_simple(
1684        struct libusb_transfer *transfer, unsigned int packet)
1685{
1686        int _packet;
1687
1688        /* oops..slight bug in the API. packet is an unsigned int, but we use
1689         * signed integers almost everywhere else. range-check and convert to
1690         * signed to avoid compiler warnings. FIXME for libusb-2. */
1691        if (packet > INT_MAX)
1692                return NULL;
1693        _packet = (int) packet;
1694
1695        if (_packet >= transfer->num_iso_packets)
1696                return NULL;
1697
1698        return transfer->buffer + ((int) transfer->iso_packet_desc[0].length * _packet);
1699}
1700
1701/* sync I/O */
1702
1703int LIBUSB_CALL libusb_control_transfer(libusb_device_handle *dev_handle,
1704        uint8_t request_type, uint8_t bRequest, uint16_t wValue, uint16_t wIndex,
1705        unsigned char *data, uint16_t wLength, unsigned int timeout);
1706
1707int LIBUSB_CALL libusb_bulk_transfer(libusb_device_handle *dev_handle,
1708        unsigned char endpoint, unsigned char *data, int length,
1709        int *actual_length, unsigned int timeout);
1710
1711int LIBUSB_CALL libusb_interrupt_transfer(libusb_device_handle *dev_handle,
1712        unsigned char endpoint, unsigned char *data, int length,
1713        int *actual_length, unsigned int timeout);
1714
1715/** \ingroup desc
1716 * Retrieve a descriptor from the default control pipe.
1717 * This is a convenience function which formulates the appropriate control
1718 * message to retrieve the descriptor.
1719 *
1720 * \param dev a device handle
1721 * \param desc_type the descriptor type, see \ref libusb_descriptor_type
1722 * \param desc_index the index of the descriptor to retrieve
1723 * \param data output buffer for descriptor
1724 * \param length size of data buffer
1725 * \returns number of bytes returned in data, or LIBUSB_ERROR code on failure
1726 */
1727static inline int libusb_get_descriptor(libusb_device_handle *dev,
1728        uint8_t desc_type, uint8_t desc_index, unsigned char *data, int length)
1729{
1730        return libusb_control_transfer(dev, LIBUSB_ENDPOINT_IN,
1731                LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t) ((desc_type << 8) | desc_index),
1732                0, data, (uint16_t) length, 1000);
1733}
1734
1735/** \ingroup desc
1736 * Retrieve a descriptor from a device.
1737 * This is a convenience function which formulates the appropriate control
1738 * message to retrieve the descriptor. The string returned is Unicode, as
1739 * detailed in the USB specifications.
1740 *
1741 * \param dev a device handle
1742 * \param desc_index the index of the descriptor to retrieve
1743 * \param langid the language ID for the string descriptor
1744 * \param data output buffer for descriptor
1745 * \param length size of data buffer
1746 * \returns number of bytes returned in data, or LIBUSB_ERROR code on failure
1747 * \see libusb_get_string_descriptor_ascii()
1748 */
1749static inline int libusb_get_string_descriptor(libusb_device_handle *dev,
1750        uint8_t desc_index, uint16_t langid, unsigned char *data, int length)
1751{
1752        return libusb_control_transfer(dev, LIBUSB_ENDPOINT_IN,
1753                LIBUSB_REQUEST_GET_DESCRIPTOR, (uint16_t)((LIBUSB_DT_STRING << 8) | desc_index),
1754                langid, data, (uint16_t) length, 1000);
1755}
1756
1757int LIBUSB_CALL libusb_get_string_descriptor_ascii(libusb_device_handle *dev,
1758        uint8_t desc_index, unsigned char *data, int length);
1759
1760/* polling and timeouts */
1761
1762int LIBUSB_CALL libusb_try_lock_events(libusb_context *ctx);
1763void LIBUSB_CALL libusb_lock_events(libusb_context *ctx);
1764void LIBUSB_CALL libusb_unlock_events(libusb_context *ctx);
1765int LIBUSB_CALL libusb_event_handling_ok(libusb_context *ctx);
1766int LIBUSB_CALL libusb_event_handler_active(libusb_context *ctx);
1767void LIBUSB_CALL libusb_lock_event_waiters(libusb_context *ctx);
1768void LIBUSB_CALL libusb_unlock_event_waiters(libusb_context *ctx);
1769int LIBUSB_CALL libusb_wait_for_event(libusb_context *ctx, struct timeval *tv);
1770
1771int LIBUSB_CALL libusb_handle_events_timeout(libusb_context *ctx,
1772        struct timeval *tv);
1773int LIBUSB_CALL libusb_handle_events_timeout_completed(libusb_context *ctx,
1774        struct timeval *tv, int *completed);
1775int LIBUSB_CALL libusb_handle_events(libusb_context *ctx);
1776int LIBUSB_CALL libusb_handle_events_completed(libusb_context *ctx, int *completed);
1777int LIBUSB_CALL libusb_handle_events_locked(libusb_context *ctx,
1778        struct timeval *tv);
1779int LIBUSB_CALL libusb_pollfds_handle_timeouts(libusb_context *ctx);
1780int LIBUSB_CALL libusb_get_next_timeout(libusb_context *ctx,
1781        struct timeval *tv);
1782
1783/** \ingroup poll
1784 * File descriptor for polling
1785 */
1786struct libusb_pollfd {
1787        /** Numeric file descriptor */
1788        int fd;
1789
1790        /** Event flags to poll for from <poll.h>. POLLIN indicates that you
1791         * should monitor this file descriptor for becoming ready to read from,
1792         * and POLLOUT indicates that you should monitor this file descriptor for
1793         * nonblocking write readiness. */
1794        short events;
1795};
1796
1797/** \ingroup poll
1798 * Callback function, invoked when a new file descriptor should be added
1799 * to the set of file descriptors monitored for events.
1800 * \param fd the new file descriptor
1801 * \param events events to monitor for, see \ref libusb_pollfd for a
1802 * description
1803 * \param user_data User data pointer specified in
1804 * libusb_set_pollfd_notifiers() call
1805 * \see libusb_set_pollfd_notifiers()
1806 */
1807typedef void (LIBUSB_CALL *libusb_pollfd_added_cb)(int fd, short events,
1808        void *user_data);
1809
1810/** \ingroup poll
1811 * Callback function, invoked when a file descriptor should be removed from
1812 * the set of file descriptors being monitored for events. After returning
1813 * from this callback, do not use that file descriptor again.
1814 * \param fd the file descriptor to stop monitoring
1815 * \param user_data User data pointer specified in
1816 * libusb_set_pollfd_notifiers() call
1817 * \see libusb_set_pollfd_notifiers()
1818 */
1819typedef void (LIBUSB_CALL *libusb_pollfd_removed_cb)(int fd, void *user_data);
1820
1821const struct libusb_pollfd ** LIBUSB_CALL libusb_get_pollfds(
1822        libusb_context *ctx);
1823void LIBUSB_CALL libusb_set_pollfd_notifiers(libusb_context *ctx,
1824        libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb,
1825        void *user_data);
1826
1827/** \ingroup hotplug
1828 * Callback handle.
1829 *
1830 * Callbacks handles are generated by libusb_hotplug_register_callback()
1831 * and can be used to deregister callbacks. Callback handles are unique
1832 * per libusb_context and it is safe to call libusb_hotplug_deregister_callback()
1833 * on an already deregisted callback.
1834 *
1835 * Since version 1.0.16, \ref LIBUSB_API_VERSION >= 0x01000102
1836 *
1837 * For more information, see \ref hotplug.
1838 */
1839typedef int libusb_hotplug_callback_handle;
1840
1841/** \ingroup hotplug
1842 *
1843 * Since version 1.0.16, \ref LIBUSB_API_VERSION >= 0x01000102
1844 *
1845 * Flags for hotplug events */
1846typedef enum {
1847        /** Arm the callback and fire it for all matching currently attached devices. */
1848        LIBUSB_HOTPLUG_ENUMERATE = 1,
1849} libusb_hotplug_flag;
1850
1851/** \ingroup hotplug
1852 *
1853 * Since version 1.0.16, \ref LIBUSB_API_VERSION >= 0x01000102
1854 *
1855 * Hotplug events */
1856typedef enum {
1857        /** A device has been plugged in and is ready to use */
1858        LIBUSB_HOTPLUG_EVENT_DEVICE_ARRIVED = 0x01,
1859
1860        /** A device has left and is no longer available.
1861         * It is the user's responsibility to call libusb_close on any handle associated with a disconnected device.
1862         * It is safe to call libusb_get_device_descriptor on a device that has left */
1863        LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT    = 0x02,
1864} libusb_hotplug_event;
1865
1866/** \ingroup hotplug
1867 * Wildcard matching for hotplug events */
1868#define LIBUSB_HOTPLUG_MATCH_ANY -1
1869
1870/** \ingroup hotplug
1871 * Hotplug callback function type. When requesting hotplug event notifications,
1872 * you pass a pointer to a callback function of this type.
1873 *
1874 * This callback may be called by an internal event thread and as such it is
1875 * recommended the callback do minimal processing before returning.
1876 *
1877 * libusb will call this function later, when a matching event had happened on
1878 * a matching device. See \ref hotplug for more information.
1879 *
1880 * It is safe to call either libusb_hotplug_register_callback() or
1881 * libusb_hotplug_deregister_callback() from within a callback function.
1882 *
1883 * Since version 1.0.16, \ref LIBUSB_API_VERSION >= 0x01000102
1884 *
1885 * \param ctx            context of this notification
1886 * \param device         libusb_device this event occurred on
1887 * \param event          event that occurred
1888 * \param user_data      user data provided when this callback was registered
1889 * \returns bool whether this callback is finished processing events.
1890 *                       returning 1 will cause this callback to be deregistered
1891 */
1892typedef int (LIBUSB_CALL *libusb_hotplug_callback_fn)(libusb_context *ctx,
1893                                                libusb_device *device,
1894                                                libusb_hotplug_event event,
1895                                                void *user_data);
1896
1897/** \ingroup hotplug
1898 * Register a hotplug callback function
1899 *
1900 * Register a callback with the libusb_context. The callback will fire
1901 * when a matching event occurs on a matching device. The callback is
1902 * armed until either it is deregistered with libusb_hotplug_deregister_callback()
1903 * or the supplied callback returns 1 to indicate it is finished processing events.
1904 *
1905 * If the \ref LIBUSB_HOTPLUG_ENUMERATE is passed the callback will be
1906 * called with a \ref LIBUSB_HOTPLUG_EVENT_DEVICE_ARRIVED for all devices
1907 * already plugged into the machine. Note that libusb modifies its internal
1908 * device list from a separate thread, while calling hotplug callbacks from
1909 * libusb_handle_events(), so it is possible for a device to already be present
1910 * on, or removed from, its internal device list, while the hotplug callbacks
1911 * still need to be dispatched. This means that when using \ref
1912 * LIBUSB_HOTPLUG_ENUMERATE, your callback may be called twice for the arrival
1913 * of the same device, once from libusb_hotplug_register_callback() and once
1914 * from libusb_handle_events(); and/or your callback may be called for the
1915 * removal of a device for which an arrived call was never made.
1916 *
1917 * Since version 1.0.16, \ref LIBUSB_API_VERSION >= 0x01000102
1918 *
1919 * \param[in] ctx context to register this callback with
1920 * \param[in] events bitwise or of events that will trigger this callback. See \ref
1921 *            libusb_hotplug_event
1922 * \param[in] flags hotplug callback flags. See \ref libusb_hotplug_flag
1923 * \param[in] vendor_id the vendor id to match or \ref LIBUSB_HOTPLUG_MATCH_ANY
1924 * \param[in] product_id the product id to match or \ref LIBUSB_HOTPLUG_MATCH_ANY
1925 * \param[in] dev_class the device class to match or \ref LIBUSB_HOTPLUG_MATCH_ANY
1926 * \param[in] cb_fn the function to be invoked on a matching event/device
1927 * \param[in] user_data user data to pass to the callback function
1928 * \param[out] handle pointer to store the handle of the allocated callback (can be NULL)
1929 * \returns LIBUSB_SUCCESS on success LIBUSB_ERROR code on failure
1930 */
1931int LIBUSB_CALL libusb_hotplug_register_callback(libusb_context *ctx,
1932                                                libusb_hotplug_event events,
1933                                                libusb_hotplug_flag flags,
1934                                                int vendor_id, int product_id,
1935                                                int dev_class,
1936                                                libusb_hotplug_callback_fn cb_fn,
1937                                                void *user_data,
1938                                                libusb_hotplug_callback_handle *handle);
1939
1940/** \ingroup hotplug
1941 * Deregisters a hotplug callback.
1942 *
1943 * Deregister a callback from a libusb_context. This function is safe to call from within
1944 * a hotplug callback.
1945 *
1946 * Since version 1.0.16, \ref LIBUSB_API_VERSION >= 0x01000102
1947 *
1948 * \param[in] ctx context this callback is registered with
1949 * \param[in] handle the handle of the callback to deregister
1950 */
1951void LIBUSB_CALL libusb_hotplug_deregister_callback(libusb_context *ctx,
1952                                                libusb_hotplug_callback_handle handle);
1953
1954#ifdef __cplusplus
1955}
1956#endif
1957
1958#endif
Note: See TracBrowser for help on using the repository browser.