/*

 * Public libusb header file

 * Copyright © 2001 Johannes Erdfelt <johannes@erdfelt.com>

 * Copyright © 2007-2008 Daniel Drake <dsd@gentoo.org>

 * Copyright © 2012 Pete Batard <pete@akeo.ie>

 * Copyright © 2012-2018 Nathan Hjelm <hjelmn@cs.unm.edu>

 * For more information, please visit: http://libusb.info

 *

 * This library is free software; you can redistribute it and/or

 * modify it under the terms of the GNU Lesser General Public

 * License as published by the Free Software Foundation; either

 * version 2.1 of the License, or (at your option) any later version.

 *

 * This library is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU

 * Lesser General Public License for more details.

 *

 * You should have received a copy of the GNU Lesser General Public

 * License along with this library; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

 */

#ifndef LIBUSB_H

#define LIBUSB_H

#ifdef _MSC_VER

/* on MS environments, the inline keyword is available in C++ only */

#if !defined(__cplusplus)

#define inline __inline

#endif

/* ssize_t is also not available (copy/paste from MinGW) */

#ifndef _SSIZE_T_DEFINED

#define _SSIZE_T_DEFINED

#undef ssize_t

#ifdef _WIN64

  typedef __int64 ssize_t;

#else

  typedef int ssize_t;

#endif /* _WIN64 */

#endif /* _SSIZE_T_DEFINED */

#endif /* _MSC_VER */

/* stdint.h is not available on older MSVC */

#if defined(_MSC_VER) && (_MSC_VER < 1600) && (!defined(_STDINT)) && (!defined(_STDINT_H))

typedef unsigned __int8   uint8_t;

typedef unsigned __int16  uint16_t;

typedef unsigned __int32  uint32_t;

#else

#include <stdint.h>

#endif

#if !defined(_WIN32_WCE)

#include <sys/types.h>

#endif

#if defined(__linux__) || defined(__APPLE__) || defined(__CYGWIN__) || defined(__HAIKU__)

#include <sys/time.h>

#endif

#include <time.h>

#include <limits.h>

#if defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 199901L)

#define ZERO_SIZED_ARRAY		/* [] - valid C99 code */

#else

#define ZERO_SIZED_ARRAY	0	/* [0] - non-standard, but usually working code */

#endif

/* 'interface' might be defined as a macro on Windows, so we need to

 * undefine it so as not to break the current libusb API, because

 * libusb_config_descriptor has an 'interface' member

 * As this can be problematic if you include windows.h after libusb.h

 * in your sources, we force windows.h to be included first. */

#if defined(_WIN32) || defined(__CYGWIN__) || defined(_WIN32_WCE)

#include <windows.h>

#if defined(interface)

#undef interface

#endif

#if !defined(__CYGWIN__)

#include <winsock.h>

#endif

#endif

#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5)

#define LIBUSB_DEPRECATED_FOR(f) \

  __attribute__((deprecated("Use " #f " instead")))

#elif __GNUC__ >= 3

#define LIBUSB_DEPRECATED_FOR(f) __attribute__((deprecated))

#else

#define LIBUSB_DEPRECATED_FOR(f)

#endif /* __GNUC__ */

/** \def LIBUSB_CALL

 * \ingroup libusb_misc

 * libusb's Windows calling convention.

 *

 * Under Windows, the selection of available compilers and configurations

 * means that, unlike other platforms, there is not one true calling

 * convention (calling convention: the manner in which parameters are

 * passed to functions in the generated assembly code).

 *

 * Matching the Windows API itself, libusb uses the WINAPI convention (which

 * translates to the <tt>stdcall</tt> convention) and guarantees that the

 * library is compiled in this way. The public header file also includes

 * appropriate annotations so that your own software will use the right

 * convention, even if another convention is being used by default within

 * your codebase.

 *

 * The one consideration that you must apply in your software is to mark

 * all functions which you use as libusb callbacks with this LIBUSB_CALL

 * annotation, so that they too get compiled for the correct calling

 * convention.

 *

 * On non-Windows operating systems, this macro is defined as nothing. This

 * means that you can apply it to your code without worrying about

 * cross-platform compatibility.

 */

/* LIBUSB_CALL must be defined on both definition and declaration of libusb

 * functions. You'd think that declaration would be enough, but cygwin will

 * complain about conflicting types unless both are marked this way.

 * The placement of this macro is important too; it must appear after the

 * return type, before the function name. See internal documentation for

 * API_EXPORTED.

 */

#if defined(_WIN32) || defined(__CYGWIN__) || defined(_WIN32_WCE)

#define LIBUSB_CALL WINAPI

#else

#define LIBUSB_CALL

#endif

/** \def LIBUSB_API_VERSION

 * \ingroup libusb_misc

 * libusb's API version.

 *

 * Since version 1.0.13, to help with feature detection, libusb defines

 * a LIBUSB_API_VERSION macro that gets increased every time there is a

 * significant change to the API, such as the introduction of a new call,

 * the definition of a new macro/enum member, or any other element that

 * libusb applications may want to detect at compilation time.

 *

 * The macro is typically used in an application as follows:

 * \code

 * #if defined(LIBUSB_API_VERSION) && (LIBUSB_API_VERSION >= 0x01001234)

 * // Use one of the newer features from the libusb API

 * #endif

 * \endcode

 *

 * Internally, LIBUSB_API_VERSION is defined as follows:

 * (libusb major << 24) | (libusb minor << 16) | (16 bit incremental)

 */

#define LIBUSB_API_VERSION 0x01000107

/* The following is kept for compatibility, but will be deprecated in the future */

#define LIBUSBX_API_VERSION LIBUSB_API_VERSION

#ifdef __cplusplus

extern "C" {

#endif

/**

 * \ingroup libusb_misc

 * Convert a 16-bit value from host-endian to little-endian format. On

 * little endian systems, this function does nothing. On big endian systems,

 * the bytes are swapped.

 * \param x the host-endian value to convert

 * \returns the value in little-endian byte order

 */

static inline uint16_t libusb_cpu_to_le16(const uint16_t x)

{

	union {

		uint8_t  b8[2];

		uint16_t b16;

	} _tmp;

	_tmp.b8[1] = (uint8_t) (x >> 8);

	_tmp.b8[0] = (uint8_t) (x & 0xff);

	return _tmp.b16;

}

/** \def libusb_le16_to_cpu

 * \ingroup libusb_misc

 * Convert a 16-bit value from little-endian to host-endian format. On

 * little endian systems, this function does nothing. On big endian systems,

 * the bytes are swapped.

 * \param x the little-endian value to convert

 * \returns the value in host-endian byte order

 */

#define libusb_le16_to_cpu libusb_cpu_to_le16

/* standard USB stuff */

/** \ingroup libusb_desc

 * Device and/or Interface Class codes */

enum libusb_class_code {

	/** In the context of a \ref libusb_device_descriptor "device descriptor",

	 * this bDeviceClass value indicates that each interface specifies its

	 * own class information and all interfaces operate independently.

	 */

	LIBUSB_CLASS_PER_INTERFACE = 0,

	/** Audio class */

	LIBUSB_CLASS_AUDIO = 1,

	/** Communications class */

	LIBUSB_CLASS_COMM = 2,

	/** Human Interface Device class */

	LIBUSB_CLASS_HID = 3,

	/** Physical */

	LIBUSB_CLASS_PHYSICAL = 5,

	/** Printer class */

	LIBUSB_CLASS_PRINTER = 7,

	/** Image class */

	LIBUSB_CLASS_PTP = 6, /* legacy name from libusb-0.1 usb.h */

	LIBUSB_CLASS_IMAGE = 6,

	/** Mass storage class */

	LIBUSB_CLASS_MASS_STORAGE = 8,

	/** Hub class */

	LIBUSB_CLASS_HUB = 9,

	/** Data class */

	LIBUSB_CLASS_DATA = 10,

	/** Smart Card */

	LIBUSB_CLASS_SMART_CARD = 0x0b,

	/** Content Security */

	LIBUSB_CLASS_CONTENT_SECURITY = 0x0d,

	/** Video */

	LIBUSB_CLASS_VIDEO = 0x0e,

	/** Personal Healthcare */

	LIBUSB_CLASS_PERSONAL_HEALTHCARE = 0x0f,

	/** Diagnostic Device */

	LIBUSB_CLASS_DIAGNOSTIC_DEVICE = 0xdc,

	/** Wireless class */

	LIBUSB_CLASS_WIRELESS = 0xe0,

	/** Application class */

	LIBUSB_CLASS_APPLICATION = 0xfe,

	/** Class is vendor-specific */

	LIBUSB_CLASS_VENDOR_SPEC = 0xff

};

/** \ingroup libusb_desc

 * Descriptor types as defined by the USB specification. */

enum libusb_descriptor_type {

	/** Device descriptor. See libusb_device_descriptor. */

	LIBUSB_DT_DEVICE = 0x01,

	/** Configuration descriptor. See libusb_config_descriptor. */

	LIBUSB_DT_CONFIG = 0x02,

	/** String descriptor */

	LIBUSB_DT_STRING = 0x03,

	/** Interface descriptor. See libusb_interface_descriptor. */

	LIBUSB_DT_INTERFACE = 0x04,

	/** Endpoint descriptor. See libusb_endpoint_descriptor. */

	LIBUSB_DT_ENDPOINT = 0x05,

	/** BOS descriptor */

	LIBUSB_DT_BOS = 0x0f,

	/** Device Capability descriptor */

	LIBUSB_DT_DEVICE_CAPABILITY = 0x10,

	/** HID descriptor */

	LIBUSB_DT_HID = 0x21,

	/** HID report descriptor */

	LIBUSB_DT_REPORT = 0x22,

	/** Physical descriptor */

	LIBUSB_DT_PHYSICAL = 0x23,

	/** Hub descriptor */

	LIBUSB_DT_HUB = 0x29,

	/** SuperSpeed Hub descriptor */

	LIBUSB_DT_SUPERSPEED_HUB = 0x2a,

	/** SuperSpeed Endpoint Companion descriptor */

	LIBUSB_DT_SS_ENDPOINT_COMPANION = 0x30

};

/* Descriptor sizes per descriptor type */

#define LIBUSB_DT_DEVICE_SIZE			18

#define LIBUSB_DT_CONFIG_SIZE			9

#define LIBUSB_DT_INTERFACE_SIZE		9

#define LIBUSB_DT_ENDPOINT_SIZE			7

#define LIBUSB_DT_ENDPOINT_AUDIO_SIZE		9	/* Audio extension */

#define LIBUSB_DT_HUB_NONVAR_SIZE		7

#define LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE	6

#define LIBUSB_DT_BOS_SIZE			5

#define LIBUSB_DT_DEVICE_CAPABILITY_SIZE	3

/* BOS descriptor sizes */

#define LIBUSB_BT_USB_2_0_EXTENSION_SIZE	7

#define LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE	10

#define LIBUSB_BT_CONTAINER_ID_SIZE		20

/* We unwrap the BOS => define its max size */

#define LIBUSB_DT_BOS_MAX_SIZE		((LIBUSB_DT_BOS_SIZE)     +\

					(LIBUSB_BT_USB_2_0_EXTENSION_SIZE)       +\

					(LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE) +\

					(LIBUSB_BT_CONTAINER_ID_SIZE))

#define LIBUSB_ENDPOINT_ADDRESS_MASK	0x0f    /* in bEndpointAddress */

#define LIBUSB_ENDPOINT_DIR_MASK		0x80

/** \ingroup libusb_desc

 * Endpoint direction. Values for bit 7 of the

 * \ref libusb_endpoint_descriptor::bEndpointAddress "endpoint address" scheme.

 */

enum libusb_endpoint_direction {

	/** In: device-to-host */

	LIBUSB_ENDPOINT_IN = 0x80,

	/** Out: host-to-device */

	LIBUSB_ENDPOINT_OUT = 0x00

};

#define LIBUSB_TRANSFER_TYPE_MASK			0x03    /* in bmAttributes */

/** \ingroup libusb_desc

 * Endpoint transfer type. Values for bits 0:1 of the

 * \ref libusb_endpoint_descriptor::bmAttributes "endpoint attributes" field.

 */

enum libusb_transfer_type {

	/** Control endpoint */

	LIBUSB_TRANSFER_TYPE_CONTROL = 0,

	/** Isochronous endpoint */

	LIBUSB_TRANSFER_TYPE_ISOCHRONOUS = 1,

	/** Bulk endpoint */

	LIBUSB_TRANSFER_TYPE_BULK = 2,

	/** Interrupt endpoint */

	LIBUSB_TRANSFER_TYPE_INTERRUPT = 3,

	/** Stream endpoint */

	LIBUSB_TRANSFER_TYPE_BULK_STREAM = 4,

};

/** \ingroup libusb_misc

 * Standard requests, as defined in table 9-5 of the USB 3.0 specifications */

enum libusb_standard_request {

	/** Request status of the specific recipient */

	LIBUSB_REQUEST_GET_STATUS = 0x00,

	/** Clear or disable a specific feature */

	LIBUSB_REQUEST_CLEAR_FEATURE = 0x01,

	/* 0x02 is reserved */

	/** Set or enable a specific feature */

	LIBUSB_REQUEST_SET_FEATURE = 0x03,

	/* 0x04 is reserved */

	/** Set device address for all future accesses */

	LIBUSB_REQUEST_SET_ADDRESS = 0x05,

	/** Get the specified descriptor */

	LIBUSB_REQUEST_GET_DESCRIPTOR = 0x06,

	/** Used to update existing descriptors or add new descriptors */

	LIBUSB_REQUEST_SET_DESCRIPTOR = 0x07,

	/** Get the current device configuration value */

	LIBUSB_REQUEST_GET_CONFIGURATION = 0x08,

	/** Set device configuration */

	LIBUSB_REQUEST_SET_CONFIGURATION = 0x09,

	/** Return the selected alternate setting for the specified interface */

	LIBUSB_REQUEST_GET_INTERFACE = 0x0A,

	/** Select an alternate interface for the specified interface */

	LIBUSB_REQUEST_SET_INTERFACE = 0x0B,

	/** Set then report an endpoint's synchronization frame */

	LIBUSB_REQUEST_SYNCH_FRAME = 0x0C,

	/** Sets both the U1 and U2 Exit Latency */

	LIBUSB_REQUEST_SET_SEL = 0x30,

	/** Delay from the time a host transmits a packet to the time it is

	  * received by the device. */

	LIBUSB_SET_ISOCH_DELAY = 0x31,

};

/** \ingroup libusb_misc

 * Request type bits of the

 * \ref libusb_control_setup::bmRequestType "bmRequestType" field in control

 * transfers. */

enum libusb_request_type {

	/** Standard */

	LIBUSB_REQUEST_TYPE_STANDARD = (0x00 << 5),

	/** Class */

	LIBUSB_REQUEST_TYPE_CLASS = (0x01 << 5),

	/** Vendor */

	LIBUSB_REQUEST_TYPE_VENDOR = (0x02 << 5),

	/** Reserved */

	LIBUSB_REQUEST_TYPE_RESERVED = (0x03 << 5)

};

/** \ingroup libusb_misc

 * Recipient bits of the

 * \ref libusb_control_setup::bmRequestType "bmRequestType" field in control

 * transfers. Values 4 through 31 are reserved. */

enum libusb_request_recipient {

	/** Device */

	LIBUSB_RECIPIENT_DEVICE = 0x00,

	/** Interface */

	LIBUSB_RECIPIENT_INTERFACE = 0x01,

	/** Endpoint */

	LIBUSB_RECIPIENT_ENDPOINT = 0x02,

	/** Other */

	LIBUSB_RECIPIENT_OTHER = 0x03,

};

#define LIBUSB_ISO_SYNC_TYPE_MASK		0x0C

/** \ingroup libusb_desc

 * Synchronization type for isochronous endpoints. Values for bits 2:3 of the

 * \ref libusb_endpoint_descriptor::bmAttributes "bmAttributes" field in

 * libusb_endpoint_descriptor.

 */

enum libusb_iso_sync_type {

	/** No synchronization */

	LIBUSB_ISO_SYNC_TYPE_NONE = 0,

	/** Asynchronous */

	LIBUSB_ISO_SYNC_TYPE_ASYNC = 1,

	/** Adaptive */

	LIBUSB_ISO_SYNC_TYPE_ADAPTIVE = 2,

	/** Synchronous */

	LIBUSB_ISO_SYNC_TYPE_SYNC = 3

};

#define LIBUSB_ISO_USAGE_TYPE_MASK 0x30

/** \ingroup libusb_desc

 * Usage type for isochronous endpoints. Values for bits 4:5 of the

 * \ref libusb_endpoint_descriptor::bmAttributes "bmAttributes" field in

 * libusb_endpoint_descriptor.

 */

enum libusb_iso_usage_type {

	/** Data endpoint */

	LIBUSB_ISO_USAGE_TYPE_DATA = 0,

	/** Feedback endpoint */

	LIBUSB_ISO_USAGE_TYPE_FEEDBACK = 1,

	/** Implicit feedback Data endpoint */

	LIBUSB_ISO_USAGE_TYPE_IMPLICIT = 2,

};

/** \ingroup libusb_desc

 * A structure representing the standard USB device descriptor. This

 * descriptor is documented in section 9.6.1 of the USB 3.0 specification.

 * All multiple-byte fields are represented in host-endian format.

 */

struct libusb_device_descriptor {

	/** Size of this descriptor (in bytes) */

	uint8_t  bLength;

	/** Descriptor type. Will have value

	 * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE LIBUSB_DT_DEVICE in this

	 * context. */

	uint8_t  bDescriptorType;

	/** USB specification release number in binary-coded decimal. A value of

	 * 0x0200 indicates USB 2.0, 0x0110 indicates USB 1.1, etc. */

	uint16_t bcdUSB;

	/** USB-IF class code for the device. See \ref libusb_class_code. */

	uint8_t  bDeviceClass;

	/** USB-IF subclass code for the device, qualified by the bDeviceClass

	 * value */

	uint8_t  bDeviceSubClass;

	/** USB-IF protocol code for the device, qualified by the bDeviceClass and

	 * bDeviceSubClass values */

	uint8_t  bDeviceProtocol;

	/** Maximum packet size for endpoint 0 */

	uint8_t  bMaxPacketSize0;

	/** USB-IF vendor ID */

	uint16_t idVendor;

	/** USB-IF product ID */

	uint16_t idProduct;

	/** Device release number in binary-coded decimal */

	uint16_t bcdDevice;

	/** Index of string descriptor describing manufacturer */

	uint8_t  iManufacturer;

	/** Index of string descriptor describing product */

	uint8_t  iProduct;

	/** Index of string descriptor containing device serial number */

	uint8_t  iSerialNumber;

	/** Number of possible configurations */

	uint8_t  bNumConfigurations;

};

/** \ingroup libusb_desc

 * A structure representing the standard USB endpoint descriptor. This

 * descriptor is documented in section 9.6.6 of the USB 3.0 specification.

 * All multiple-byte fields are represented in host-endian format.

 */

struct libusb_endpoint_descriptor {

	/** Size of this descriptor (in bytes) */

	uint8_t  bLength;

	/** Descriptor type. Will have value

	 * \ref libusb_descriptor_type::LIBUSB_DT_ENDPOINT LIBUSB_DT_ENDPOINT in

	 * this context. */

	uint8_t  bDescriptorType;

	/** The address of the endpoint described by this descriptor. Bits 0:3 are

	 * the endpoint number. Bits 4:6 are reserved. Bit 7 indicates direction,

	 * see \ref libusb_endpoint_direction.

	 */

	uint8_t  bEndpointAddress;

	/** Attributes which apply to the endpoint when it is configured using

	 * the bConfigurationValue. Bits 0:1 determine the transfer type and

	 * correspond to \ref libusb_transfer_type. Bits 2:3 are only used for

	 * isochronous endpoints and correspond to \ref libusb_iso_sync_type.

	 * Bits 4:5 are also only used for isochronous endpoints and correspond to

	 * \ref libusb_iso_usage_type. Bits 6:7 are reserved.

	 */

	uint8_t  bmAttributes;

	/** Maximum packet size this endpoint is capable of sending/receiving. */

	uint16_t wMaxPacketSize;

	/** Interval for polling endpoint for data transfers. */

	uint8_t  bInterval;

	/** For audio devices only: the rate at which synchronization feedback

	 * is provided. */

	uint8_t  bRefresh;

	/** For audio devices only: the address if the synch endpoint */

	uint8_t  bSynchAddress;

	/** Extra descriptors. If libusb encounters unknown endpoint descriptors,

	 * it will store them here, should you wish to parse them. */

	const unsigned char *extra;

	/** Length of the extra descriptors, in bytes. Must be non-negative. */

	int extra_length;

};

/** \ingroup libusb_desc

 * A structure representing the standard USB interface descriptor. This

 * descriptor is documented in section 9.6.5 of the USB 3.0 specification.

 * All multiple-byte fields are represented in host-endian format.

 */

struct libusb_interface_descriptor {

	/** Size of this descriptor (in bytes) */

	uint8_t  bLength;

	/** Descriptor type. Will have value

	 * \ref libusb_descriptor_type::LIBUSB_DT_INTERFACE LIBUSB_DT_INTERFACE

	 * in this context. */

	uint8_t  bDescriptorType;

	/** Number of this interface */

	uint8_t  bInterfaceNumber;

	/** Value used to select this alternate setting for this interface */

	uint8_t  bAlternateSetting;

	/** Number of endpoints used by this interface (excluding the control

	 * endpoint). */

	uint8_t  bNumEndpoints;

	/** USB-IF class code for this interface. See \ref libusb_class_code. */

	uint8_t  bInterfaceClass;

	/** USB-IF subclass code for this interface, qualified by the

	 * bInterfaceClass value */

	uint8_t  bInterfaceSubClass;

	/** USB-IF protocol code for this interface, qualified by the

	 * bInterfaceClass and bInterfaceSubClass values */

	uint8_t  bInterfaceProtocol;

	/** Index of string descriptor describing this interface */

	uint8_t  iInterface;

	/** Array of endpoint descriptors. This length of this array is determined

	 * by the bNumEndpoints field. */

	const struct libusb_endpoint_descriptor *endpoint;

	/** Extra descriptors. If libusb encounters unknown interface descriptors,

	 * it will store them here, should you wish to parse them. */

	const unsigned char *extra;

	/** Length of the extra descriptors, in bytes. Must be non-negative. */

	int extra_length;

};

/** \ingroup libusb_desc

 * A collection of alternate settings for a particular USB interface.

 */

struct libusb_interface {

	/** Array of interface descriptors. The length of this array is determined

	 * by the num_altsetting field. */

	const struct libusb_interface_descriptor *altsetting;

	/** The number of alternate settings that belong to this interface.

	 * Must be non-negative. */

	int num_altsetting;

};

/** \ingroup libusb_desc

 * A structure representing the standard USB configuration descriptor. This

 * descriptor is documented in section 9.6.3 of the USB 3.0 specification.

 * All multiple-byte fields are represented in host-endian format.

 */

struct libusb_config_descriptor {

	/** Size of this descriptor (in bytes) */

	uint8_t  bLength;

	/** Descriptor type. Will have value

	 * \ref libusb_descriptor_type::LIBUSB_DT_CONFIG LIBUSB_DT_CONFIG

	 * in this context. */

	uint8_t  bDescriptorType;

	/** Total length of data returned for this configuration */

	uint16_t wTotalLength;

	/** Number of interfaces supported by this configuration */

	uint8_t  bNumInterfaces;

	/** Identifier value for this configuration */

	uint8_t  bConfigurationValue;

	/** Index of string descriptor describing this configuration */

	uint8_t  iConfiguration;

	/** Configuration characteristics */

	uint8_t  bmAttributes;

	/** Maximum power consumption of the USB device from this bus in this

	 * configuration when the device is fully operation. Expressed in units

	 * of 2 mA when the device is operating in high-speed mode and in units

	 * of 8 mA when the device is operating in super-speed mode. */

	uint8_t  MaxPower;

	/** Array of interfaces supported by this configuration. The length of

	 * this array is determined by the bNumInterfaces field. */

	const struct libusb_interface *interface;

	/** Extra descriptors. If libusb encounters unknown configuration

	 * descriptors, it will store them here, should you wish to parse them. */

	const unsigned char *extra;

	/** Length of the extra descriptors, in bytes. Must be non-negative. */

	int extra_length;

};

/** \ingroup libusb_desc

 * A structure representing the superspeed endpoint companion

 * descriptor. This descriptor is documented in section 9.6.7 of

 * the USB 3.0 specification. All multiple-byte fields are represented in

 * host-endian format.

 */

struct libusb_ss_endpoint_companion_descriptor {

	/** Size of this descriptor (in bytes) */

	uint8_t  bLength;

	/** Descriptor type. Will have value

	 * \ref libusb_descriptor_type::LIBUSB_DT_SS_ENDPOINT_COMPANION in

	 * this context. */

	uint8_t  bDescriptorType;

	/** The maximum number of packets the endpoint can send or

	 *  receive as part of a burst. */

	uint8_t  bMaxBurst;

	/** In bulk EP:	bits 4:0 represents the	maximum	number of

	 *  streams the	EP supports. In	isochronous EP:	bits 1:0

	 *  represents the Mult	- a zero based value that determines

	 *  the	maximum	number of packets within a service interval  */

	uint8_t  bmAttributes;

	/** The	total number of bytes this EP will transfer every

	 *  service interval. valid only for periodic EPs. */

	uint16_t wBytesPerInterval;

};

/** \ingroup libusb_desc

 * A generic representation of a BOS Device Capability descriptor. It is

 * advised to check bDevCapabilityType and call the matching

 * libusb_get_*_descriptor function to get a structure fully matching the type.

 */

struct libusb_bos_dev_capability_descriptor {

	/** Size of this descriptor (in bytes) */

	uint8_t bLength;

	/** Descriptor type. Will have value

	 * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE_CAPABILITY

	 * LIBUSB_DT_DEVICE_CAPABILITY in this context. */

	uint8_t bDescriptorType;

	/** Device Capability type */

	uint8_t bDevCapabilityType;

	/** Device Capability data (bLength - 3 bytes) */

	uint8_t dev_capability_data[ZERO_SIZED_ARRAY];

};

/** \ingroup libusb_desc

 * A structure representing the Binary Device Object Store (BOS) descriptor.

 * This descriptor is documented in section 9.6.2 of the USB 3.0 specification.

 * All multiple-byte fields are represented in host-endian format.

 */

struct libusb_bos_descriptor {

	/** Size of this descriptor (in bytes) */

	uint8_t  bLength;

	/** Descriptor type. Will have value

	 * \ref libusb_descriptor_type::LIBUSB_DT_BOS LIBUSB_DT_BOS

	 * in this context. */

	uint8_t  bDescriptorType;

	/** Length of this descriptor and all of its sub descriptors */

	uint16_t wTotalLength;

	/** The number of separate device capability descriptors in

	 * the BOS */

	uint8_t  bNumDeviceCaps;

	/** bNumDeviceCap Device Capability Descriptors */

	struct libusb_bos_dev_capability_descriptor *dev_capability[ZERO_SIZED_ARRAY];

};

/** \ingroup libusb_desc

 * A structure representing the USB 2.0 Extension descriptor

 * This descriptor is documented in section 9.6.2.1 of the USB 3.0 specification.

 * All multiple-byte fields are represented in host-endian format.

 */

struct libusb_usb_2_0_extension_descriptor {

	/** Size of this descriptor (in bytes) */

	uint8_t  bLength;

	/** Descriptor type. Will have value

	 * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE_CAPABILITY

	 * LIBUSB_DT_DEVICE_CAPABILITY in this context. */

	uint8_t  bDescriptorType;

	/** Capability type. Will have value

	 * \ref libusb_capability_type::LIBUSB_BT_USB_2_0_EXTENSION

	 * LIBUSB_BT_USB_2_0_EXTENSION in this context. */

	uint8_t  bDevCapabilityType;

	/** Bitmap encoding of supported device level features.

	 * A value of one in a bit location indicates a feature is

	 * supported; a value of zero indicates it is not supported.

	 * See \ref libusb_usb_2_0_extension_attributes. */

	uint32_t  bmAttributes;

};

/** \ingroup libusb_desc

 * A structure representing the SuperSpeed USB Device Capability descriptor

 * This descriptor is documented in section 9.6.2.2 of the USB 3.0 specification.

 * All multiple-byte fields are represented in host-endian format.

 */

struct libusb_ss_usb_device_capability_descriptor {

	/** Size of this descriptor (in bytes) */

	uint8_t  bLength;

	/** Descriptor type. Will have value

	 * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE_CAPABILITY

	 * LIBUSB_DT_DEVICE_CAPABILITY in this context. */

	uint8_t  bDescriptorType;

	/** Capability type. Will have value

	 * \ref libusb_capability_type::LIBUSB_BT_SS_USB_DEVICE_CAPABILITY

	 * LIBUSB_BT_SS_USB_DEVICE_CAPABILITY in this context. */

	uint8_t  bDevCapabilityType;

	/** Bitmap encoding of supported device level features.

	 * A value of one in a bit location indicates a feature is

	 * supported; a value of zero indicates it is not supported.

	 * See \ref libusb_ss_usb_device_capability_attributes. */

	uint8_t  bmAttributes;

	/** Bitmap encoding of the speed supported by this device when

	 * operating in SuperSpeed mode. See \ref libusb_supported_speed. */

	uint16_t wSpeedSupported;

	/** The lowest speed at which all the functionality supported

	 * by the device is available to the user. For example if the

	 * device supports all its functionality when connected at

	 * full speed and above then it sets this value to 1. */

	uint8_t  bFunctionalitySupport;

	/** U1 Device Exit Latency. */

	uint8_t  bU1DevExitLat;

	/** U2 Device Exit Latency. */

	uint16_t bU2DevExitLat;

};

/** \ingroup libusb_desc

 * A structure representing the Container ID descriptor.

 * This descriptor is documented in section 9.6.2.3 of the USB 3.0 specification.

 * All multiple-byte fields, except UUIDs, are represented in host-endian format.

 */

struct libusb_container_id_descriptor {

	/** Size of this descriptor (in bytes) */

	uint8_t  bLength;

	/** Descriptor type. Will have value

	 * \ref libusb_descriptor_type::LIBUSB_DT_DEVICE_CAPABILITY

	 * LIBUSB_DT_DEVICE_CAPABILITY in this context. */

	uint8_t  bDescriptorType;

	/** Capability type. Will have value

	 * \ref libusb_capability_type::LIBUSB_BT_CONTAINER_ID

	 * LIBUSB_BT_CONTAINER_ID in this context. */

	uint8_t  bDevCapabilityType;

	/** Reserved field */

	uint8_t bReserved;

	/** 128 bit UUID */

	uint8_t  ContainerID[16];

};

/** \ingroup libusb_asyncio

 * Setup packet for control transfers. */

struct libusb_control_setup {

	/** Request type. Bits 0:4 determine recipient, see

	 * \ref libusb_request_recipient. Bits 5:6 determine type, see

	 * \ref libusb_request_type. Bit 7 determines data transfer direction, see

	 * \ref libusb_endpoint_direction.

	 */

	uint8_t  bmRequestType;

	/** Request. If the type bits of bmRequestType are equal to

	 * \ref libusb_request_type::LIBUSB_REQUEST_TYPE_STANDARD

	 * "LIBUSB_REQUEST_TYPE_STANDARD" then this field refers to

	 * \ref libusb_standard_request. For other cases, use of this field is

	 * application-specific. */

	uint8_t  bRequest;

	/** Value. Varies according to request */