1194676Sthompsa/* $FreeBSD: stable/10/lib/libusb/libusb.h 362224 2020-06-16 12:21:55Z kevans $ */ 2194676Sthompsa/*- 3194676Sthompsa * Copyright (c) 2009 Sylvestre Gallon. All rights reserved. 4194676Sthompsa * 5194676Sthompsa * Redistribution and use in source and binary forms, with or without 6194676Sthompsa * modification, are permitted provided that the following conditions 7194676Sthompsa * are met: 8194676Sthompsa * 1. Redistributions of source code must retain the above copyright 9194676Sthompsa * notice, this list of conditions and the following disclaimer. 10194676Sthompsa * 2. Redistributions in binary form must reproduce the above copyright 11194676Sthompsa * notice, this list of conditions and the following disclaimer in the 12194676Sthompsa * documentation and/or other materials provided with the distribution. 13194676Sthompsa * 14194676Sthompsa * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15194676Sthompsa * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16194676Sthompsa * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17194676Sthompsa * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18194676Sthompsa * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19194676Sthompsa * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20194676Sthompsa * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21194676Sthompsa * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22194676Sthompsa * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23194676Sthompsa * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24194676Sthompsa * SUCH DAMAGE. 25194676Sthompsa */ 26194676Sthompsa 27194676Sthompsa#ifndef __LIBUSB_H__ 28194676Sthompsa#define __LIBUSB_H__ 29194676Sthompsa 30248236Shselasky#ifndef LIBUSB_GLOBAL_INCLUDE_FILE 31248236Shselasky#include <stdint.h> 32195560Sthompsa#include <sys/time.h> 33195560Sthompsa#include <sys/types.h> 34248236Shselasky#endif 35195560Sthompsa 36302275Shselasky#define LIBUSB_API_VERSION 0x01000102 37302275Shselasky 38267047Shselasky#define LIBUSB_CALL 39267047Shselasky 40194676Sthompsa#ifdef __cplusplus 41194676Sthompsaextern "C" { 42194676Sthompsa#endif 43194676Sthompsa#if 0 44194676Sthompsa} /* indent fix */ 45194676Sthompsa 46194676Sthompsa#endif 47194676Sthompsa 48194676Sthompsa/* libusb enums */ 49194676Sthompsa 50194676Sthompsaenum libusb_class_code { 51194676Sthompsa LIBUSB_CLASS_PER_INTERFACE = 0, 52194676Sthompsa LIBUSB_CLASS_AUDIO = 1, 53194676Sthompsa LIBUSB_CLASS_COMM = 2, 54194676Sthompsa LIBUSB_CLASS_HID = 3, 55362224Skevans LIBUSB_CLASS_PHYSICAL = 5, 56194676Sthompsa LIBUSB_CLASS_PTP = 6, 57270714Shselasky LIBUSB_CLASS_IMAGE = 6, 58194676Sthompsa LIBUSB_CLASS_PRINTER = 7, 59194676Sthompsa LIBUSB_CLASS_MASS_STORAGE = 8, 60194676Sthompsa LIBUSB_CLASS_HUB = 9, 61194676Sthompsa LIBUSB_CLASS_DATA = 10, 62270714Shselasky LIBUSB_CLASS_SMART_CARD = 11, 63270714Shselasky LIBUSB_CLASS_CONTENT_SECURITY = 13, 64270714Shselasky LIBUSB_CLASS_VIDEO = 14, 65270714Shselasky LIBUSB_CLASS_PERSONAL_HEALTHCARE = 15, 66270714Shselasky LIBUSB_CLASS_DIAGNOSTIC_DEVICE = 0xdc, 67270714Shselasky LIBUSB_CLASS_WIRELESS = 0xe0, 68270714Shselasky LIBUSB_CLASS_APPLICATION = 0xfe, 69194676Sthompsa LIBUSB_CLASS_VENDOR_SPEC = 0xff, 70194676Sthompsa}; 71194676Sthompsa 72194676Sthompsaenum libusb_descriptor_type { 73194676Sthompsa LIBUSB_DT_DEVICE = 0x01, 74194676Sthompsa LIBUSB_DT_CONFIG = 0x02, 75194676Sthompsa LIBUSB_DT_STRING = 0x03, 76194676Sthompsa LIBUSB_DT_INTERFACE = 0x04, 77194676Sthompsa LIBUSB_DT_ENDPOINT = 0x05, 78194676Sthompsa LIBUSB_DT_HID = 0x21, 79194676Sthompsa LIBUSB_DT_REPORT = 0x22, 80194676Sthompsa LIBUSB_DT_PHYSICAL = 0x23, 81194676Sthompsa LIBUSB_DT_HUB = 0x29, 82227404Shselasky LIBUSB_DT_BOS = 0x0f, 83227404Shselasky LIBUSB_DT_DEVICE_CAPABILITY = 0x10, 84227404Shselasky LIBUSB_DT_SS_ENDPOINT_COMPANION = 0x30, 85194676Sthompsa}; 86194676Sthompsa 87227404Shselaskyenum libusb_device_capability_type { 88227404Shselasky LIBUSB_WIRELESS_USB_DEVICE_CAPABILITY = 0x1, 89227404Shselasky LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY = 0x2, 90227404Shselasky LIBUSB_SS_USB_DEVICE_CAPABILITY = 0x3, 91227404Shselasky LIBUSB_CONTAINER_ID_DEVICE_CAPABILITY = 0x4, 92227404Shselasky}; 93227404Shselasky 94194676Sthompsa#define LIBUSB_DT_DEVICE_SIZE 18 95194676Sthompsa#define LIBUSB_DT_CONFIG_SIZE 9 96194676Sthompsa#define LIBUSB_DT_INTERFACE_SIZE 9 97194676Sthompsa#define LIBUSB_DT_ENDPOINT_SIZE 7 98194676Sthompsa#define LIBUSB_DT_ENDPOINT_AUDIO_SIZE 9 99194676Sthompsa#define LIBUSB_DT_HUB_NONVAR_SIZE 7 100227404Shselasky#define LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE 6 101227404Shselasky#define LIBUSB_DT_BOS_SIZE 5 102227404Shselasky#define LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY_SIZE 7 103227404Shselasky#define LIBUSB_SS_USB_DEVICE_CAPABILITY_SIZE 10 104194676Sthompsa 105302275Shselasky#define LIBUSB_BT_USB_2_0_EXTENSION_SIZE 7 106302275Shselasky#define LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE 10 107302275Shselasky#define LIBUSB_BT_CONTAINER_ID_SIZE 20 108302275Shselasky 109194676Sthompsa#define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f 110194676Sthompsa#define LIBUSB_ENDPOINT_DIR_MASK 0x80 111194676Sthompsa 112194676Sthompsaenum libusb_endpoint_direction { 113194676Sthompsa LIBUSB_ENDPOINT_IN = 0x80, 114194676Sthompsa LIBUSB_ENDPOINT_OUT = 0x00, 115194676Sthompsa}; 116194676Sthompsa 117194676Sthompsa#define LIBUSB_TRANSFER_TYPE_MASK 0x03 118194676Sthompsa 119194676Sthompsaenum libusb_transfer_type { 120194676Sthompsa LIBUSB_TRANSFER_TYPE_CONTROL = 0, 121194676Sthompsa LIBUSB_TRANSFER_TYPE_ISOCHRONOUS = 1, 122194676Sthompsa LIBUSB_TRANSFER_TYPE_BULK = 2, 123194676Sthompsa LIBUSB_TRANSFER_TYPE_INTERRUPT = 3, 124194676Sthompsa}; 125194676Sthompsa 126194676Sthompsaenum libusb_standard_request { 127194676Sthompsa LIBUSB_REQUEST_GET_STATUS = 0x00, 128194676Sthompsa LIBUSB_REQUEST_CLEAR_FEATURE = 0x01, 129194676Sthompsa LIBUSB_REQUEST_SET_FEATURE = 0x03, 130194676Sthompsa LIBUSB_REQUEST_SET_ADDRESS = 0x05, 131194676Sthompsa LIBUSB_REQUEST_GET_DESCRIPTOR = 0x06, 132194676Sthompsa LIBUSB_REQUEST_SET_DESCRIPTOR = 0x07, 133194676Sthompsa LIBUSB_REQUEST_GET_CONFIGURATION = 0x08, 134194676Sthompsa LIBUSB_REQUEST_SET_CONFIGURATION = 0x09, 135194676Sthompsa LIBUSB_REQUEST_GET_INTERFACE = 0x0A, 136194676Sthompsa LIBUSB_REQUEST_SET_INTERFACE = 0x0B, 137194676Sthompsa LIBUSB_REQUEST_SYNCH_FRAME = 0x0C, 138277847Shselasky LIBUSB_REQUEST_SET_SEL = 0x30, 139277847Shselasky LIBUSB_REQUEST_SET_ISOCH_DELAY = 0x31, 140194676Sthompsa}; 141194676Sthompsa 142194676Sthompsaenum libusb_request_type { 143194676Sthompsa LIBUSB_REQUEST_TYPE_STANDARD = (0x00 << 5), 144194676Sthompsa LIBUSB_REQUEST_TYPE_CLASS = (0x01 << 5), 145194676Sthompsa LIBUSB_REQUEST_TYPE_VENDOR = (0x02 << 5), 146194676Sthompsa LIBUSB_REQUEST_TYPE_RESERVED = (0x03 << 5), 147194676Sthompsa}; 148194676Sthompsa 149194676Sthompsaenum libusb_request_recipient { 150194676Sthompsa LIBUSB_RECIPIENT_DEVICE = 0x00, 151194676Sthompsa LIBUSB_RECIPIENT_INTERFACE = 0x01, 152194676Sthompsa LIBUSB_RECIPIENT_ENDPOINT = 0x02, 153194676Sthompsa LIBUSB_RECIPIENT_OTHER = 0x03, 154194676Sthompsa}; 155194676Sthompsa 156194676Sthompsa#define LIBUSB_ISO_SYNC_TYPE_MASK 0x0C 157194676Sthompsa 158194676Sthompsaenum libusb_iso_sync_type { 159194676Sthompsa LIBUSB_ISO_SYNC_TYPE_NONE = 0, 160194676Sthompsa LIBUSB_ISO_SYNC_TYPE_ASYNC = 1, 161194676Sthompsa LIBUSB_ISO_SYNC_TYPE_ADAPTIVE = 2, 162194676Sthompsa LIBUSB_ISO_SYNC_TYPE_SYNC = 3, 163194676Sthompsa}; 164194676Sthompsa 165194676Sthompsa#define LIBUSB_ISO_USAGE_TYPE_MASK 0x30 166194676Sthompsa 167194676Sthompsaenum libusb_iso_usage_type { 168194676Sthompsa LIBUSB_ISO_USAGE_TYPE_DATA = 0, 169194676Sthompsa LIBUSB_ISO_USAGE_TYPE_FEEDBACK = 1, 170194676Sthompsa LIBUSB_ISO_USAGE_TYPE_IMPLICIT = 2, 171194676Sthompsa}; 172194676Sthompsa 173302275Shselaskyenum libusb_bos_type { 174302275Shselasky LIBUSB_BT_WIRELESS_USB_DEVICE_CAPABILITY = 1, 175302275Shselasky LIBUSB_BT_USB_2_0_EXTENSION = 2, 176302275Shselasky LIBUSB_BT_SS_USB_DEVICE_CAPABILITY = 3, 177302275Shselasky LIBUSB_BT_CONTAINER_ID = 4, 178302275Shselasky}; 179302275Shselasky 180362224Skevansenum libusb_capability { 181362224Skevans /* libusb supports libusb_has_capability(). */ 182362224Skevans LIBUSB_CAP_HAS_CAPABILITY = 0, 183362224Skevans /* Hotplug support is available. */ 184362224Skevans LIBUSB_CAP_HAS_HOTPLUG, 185362224Skevans /* Can access HID devices without requiring user intervention. */ 186362224Skevans LIBUSB_CAP_HAS_HID_ACCESS, 187362224Skevans 188362224Skevans /* 189362224Skevans * Supports detaching of the default USB driver with 190362224Skevans * libusb_detach_kernel_driver(). 191362224Skevans */ 192362224Skevans LIBUSB_CAP_SUPPORTS_DETACH_KERNEL_DRIVER, 193362224Skevans}; 194362224Skevans 195194676Sthompsaenum libusb_error { 196194676Sthompsa LIBUSB_SUCCESS = 0, 197194676Sthompsa LIBUSB_ERROR_IO = -1, 198194676Sthompsa LIBUSB_ERROR_INVALID_PARAM = -2, 199194676Sthompsa LIBUSB_ERROR_ACCESS = -3, 200194676Sthompsa LIBUSB_ERROR_NO_DEVICE = -4, 201194676Sthompsa LIBUSB_ERROR_NOT_FOUND = -5, 202194676Sthompsa LIBUSB_ERROR_BUSY = -6, 203194676Sthompsa LIBUSB_ERROR_TIMEOUT = -7, 204194676Sthompsa LIBUSB_ERROR_OVERFLOW = -8, 205194676Sthompsa LIBUSB_ERROR_PIPE = -9, 206194676Sthompsa LIBUSB_ERROR_INTERRUPTED = -10, 207194676Sthompsa LIBUSB_ERROR_NO_MEM = -11, 208194676Sthompsa LIBUSB_ERROR_NOT_SUPPORTED = -12, 209194676Sthompsa LIBUSB_ERROR_OTHER = -99, 210194676Sthompsa}; 211194676Sthompsa 212224903Shselaskyenum libusb_speed { 213224903Shselasky LIBUSB_SPEED_UNKNOWN = 0, 214224903Shselasky LIBUSB_SPEED_LOW = 1, 215224903Shselasky LIBUSB_SPEED_FULL = 2, 216224903Shselasky LIBUSB_SPEED_HIGH = 3, 217224903Shselasky LIBUSB_SPEED_SUPER = 4, 218224903Shselasky}; 219224903Shselasky 220194676Sthompsaenum libusb_transfer_status { 221194676Sthompsa LIBUSB_TRANSFER_COMPLETED, 222194676Sthompsa LIBUSB_TRANSFER_ERROR, 223194676Sthompsa LIBUSB_TRANSFER_TIMED_OUT, 224194676Sthompsa LIBUSB_TRANSFER_CANCELLED, 225194676Sthompsa LIBUSB_TRANSFER_STALL, 226194676Sthompsa LIBUSB_TRANSFER_NO_DEVICE, 227194676Sthompsa LIBUSB_TRANSFER_OVERFLOW, 228194676Sthompsa}; 229194676Sthompsa 230194676Sthompsaenum libusb_transfer_flags { 231194676Sthompsa LIBUSB_TRANSFER_SHORT_NOT_OK = 1 << 0, 232194676Sthompsa LIBUSB_TRANSFER_FREE_BUFFER = 1 << 1, 233194676Sthompsa LIBUSB_TRANSFER_FREE_TRANSFER = 1 << 2, 234194676Sthompsa}; 235194676Sthompsa 236267435Shselaskyenum libusb_log_level { 237267435Shselasky LIBUSB_LOG_LEVEL_NONE = 0, 238267435Shselasky LIBUSB_LOG_LEVEL_ERROR, 239267435Shselasky LIBUSB_LOG_LEVEL_WARNING, 240267435Shselasky LIBUSB_LOG_LEVEL_INFO, 241267435Shselasky LIBUSB_LOG_LEVEL_DEBUG 242267435Shselasky}; 243267435Shselasky 244267435Shselasky/* XXX */ 245267435Shselasky/* libusb_set_debug should take parameters from libusb_log_level 246267435Shselasky * above according to 247267435Shselasky * http://libusb.sourceforge.net/api-1.0/group__lib.html 248267435Shselasky */ 249194676Sthompsaenum libusb_debug_level { 250194676Sthompsa LIBUSB_DEBUG_NO=0, 251194676Sthompsa LIBUSB_DEBUG_FUNCTION=1, 252194676Sthompsa LIBUSB_DEBUG_TRANSFER=2, 253194676Sthompsa}; 254194676Sthompsa 255302275Shselasky#define LIBUSB_HOTPLUG_MATCH_ANY -1 256302275Shselasky 257302275Shselaskytypedef enum { 258302275Shselasky LIBUSB_HOTPLUG_NO_FLAGS = 0, 259302275Shselasky LIBUSB_HOTPLUG_ENUMERATE = 1 << 0, 260302275Shselasky} libusb_hotplug_flag; 261302275Shselasky 262302275Shselaskytypedef enum { 263302275Shselasky LIBUSB_HOTPLUG_EVENT_DEVICE_ARRIVED = 1, 264302275Shselasky LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT = 2, 265302275Shselasky} libusb_hotplug_event; 266302275Shselasky 267195957Salfred/* libusb structures */ 268195560Sthompsa 269195957Salfredstruct libusb_context; 270195957Salfredstruct libusb_device; 271195957Salfredstruct libusb_transfer; 272208020Sthompsastruct libusb_device_handle; 273302275Shselaskystruct libusb_hotplug_callback_handle_struct; 274195957Salfred 275195957Salfredstruct libusb_pollfd { 276195560Sthompsa int fd; 277195560Sthompsa short events; 278195560Sthompsa}; 279195560Sthompsa 280302275Shselaskystruct libusb_version { 281302275Shselasky const uint16_t major; 282302275Shselasky const uint16_t minor; 283302275Shselasky const uint16_t micro; 284302275Shselasky const uint16_t nano; 285302275Shselasky const char *rc; 286302275Shselasky const char *describe; 287302275Shselasky}; 288302275Shselasky 289195957Salfredtypedef struct libusb_context libusb_context; 290195957Salfredtypedef struct libusb_device libusb_device; 291208020Sthompsatypedef struct libusb_device_handle libusb_device_handle; 292195957Salfredtypedef struct libusb_pollfd libusb_pollfd; 293194676Sthompsatypedef void (*libusb_pollfd_added_cb) (int fd, short events, void *user_data); 294194676Sthompsatypedef void (*libusb_pollfd_removed_cb) (int fd, void *user_data); 295302275Shselaskytypedef struct libusb_hotplug_callback_handle_struct *libusb_hotplug_callback_handle; 296194676Sthompsa 297194676Sthompsatypedef struct libusb_device_descriptor { 298194676Sthompsa uint8_t bLength; 299194676Sthompsa uint8_t bDescriptorType; 300194676Sthompsa uint16_t bcdUSB; 301194676Sthompsa uint8_t bDeviceClass; 302194676Sthompsa uint8_t bDeviceSubClass; 303194676Sthompsa uint8_t bDeviceProtocol; 304194676Sthompsa uint8_t bMaxPacketSize0; 305194676Sthompsa uint16_t idVendor; 306194676Sthompsa uint16_t idProduct; 307194676Sthompsa uint16_t bcdDevice; 308194676Sthompsa uint8_t iManufacturer; 309194676Sthompsa uint8_t iProduct; 310194676Sthompsa uint8_t iSerialNumber; 311194676Sthompsa uint8_t bNumConfigurations; 312194676Sthompsa} libusb_device_descriptor; 313194676Sthompsa 314194676Sthompsatypedef struct libusb_endpoint_descriptor { 315194676Sthompsa uint8_t bLength; 316194676Sthompsa uint8_t bDescriptorType; 317194676Sthompsa uint8_t bEndpointAddress; 318194676Sthompsa uint8_t bmAttributes; 319194676Sthompsa uint16_t wMaxPacketSize; 320194676Sthompsa uint8_t bInterval; 321194676Sthompsa uint8_t bRefresh; 322194676Sthompsa uint8_t bSynchAddress; 323195957Salfred uint8_t *extra; 324194676Sthompsa int extra_length; 325194676Sthompsa} libusb_endpoint_descriptor __aligned(sizeof(void *)); 326194676Sthompsa 327227404Shselaskytypedef struct libusb_ss_endpoint_companion_descriptor { 328227404Shselasky uint8_t bLength; 329227404Shselasky uint8_t bDescriptorType; 330227404Shselasky uint8_t bMaxBurst; 331227404Shselasky uint8_t bmAttributes; 332227404Shselasky uint16_t wBytesPerInterval; 333227404Shselasky} libusb_ss_endpoint_companion_descriptor __aligned(sizeof(void *)); 334227404Shselasky 335194676Sthompsatypedef struct libusb_interface_descriptor { 336194676Sthompsa uint8_t bLength; 337194676Sthompsa uint8_t bDescriptorType; 338194676Sthompsa uint8_t bInterfaceNumber; 339194676Sthompsa uint8_t bAlternateSetting; 340194676Sthompsa uint8_t bNumEndpoints; 341194676Sthompsa uint8_t bInterfaceClass; 342194676Sthompsa uint8_t bInterfaceSubClass; 343194676Sthompsa uint8_t bInterfaceProtocol; 344194676Sthompsa uint8_t iInterface; 345194676Sthompsa struct libusb_endpoint_descriptor *endpoint; 346195957Salfred uint8_t *extra; 347194676Sthompsa int extra_length; 348194676Sthompsa} libusb_interface_descriptor __aligned(sizeof(void *)); 349194676Sthompsa 350194676Sthompsatypedef struct libusb_interface { 351194676Sthompsa struct libusb_interface_descriptor *altsetting; 352194676Sthompsa int num_altsetting; 353194676Sthompsa} libusb_interface __aligned(sizeof(void *)); 354194676Sthompsa 355194676Sthompsatypedef struct libusb_config_descriptor { 356194676Sthompsa uint8_t bLength; 357194676Sthompsa uint8_t bDescriptorType; 358194676Sthompsa uint16_t wTotalLength; 359194676Sthompsa uint8_t bNumInterfaces; 360194676Sthompsa uint8_t bConfigurationValue; 361194676Sthompsa uint8_t iConfiguration; 362194676Sthompsa uint8_t bmAttributes; 363194676Sthompsa uint8_t MaxPower; 364194676Sthompsa struct libusb_interface *interface; 365195957Salfred uint8_t *extra; 366194676Sthompsa int extra_length; 367194676Sthompsa} libusb_config_descriptor __aligned(sizeof(void *)); 368194676Sthompsa 369227404Shselaskytypedef struct libusb_usb_2_0_device_capability_descriptor { 370227404Shselasky uint8_t bLength; 371227404Shselasky uint8_t bDescriptorType; 372227404Shselasky uint8_t bDevCapabilityType; 373227404Shselasky uint32_t bmAttributes; 374227404Shselasky#define LIBUSB_USB_2_0_CAPABILITY_LPM_SUPPORT (1 << 1) 375227404Shselasky} libusb_usb_2_0_device_capability_descriptor __aligned(sizeof(void *)); 376227404Shselasky 377227404Shselaskytypedef struct libusb_ss_usb_device_capability_descriptor { 378227404Shselasky uint8_t bLength; 379227404Shselasky uint8_t bDescriptorType; 380227404Shselasky uint8_t bDevCapabilityType; 381227404Shselasky uint8_t bmAttributes; 382227404Shselasky#define LIBUSB_SS_USB_CAPABILITY_LPM_SUPPORT (1 << 1) 383227404Shselasky uint16_t wSpeedSupported; 384227404Shselasky#define LIBUSB_CAPABILITY_LOW_SPEED_OPERATION (1) 385227404Shselasky#define LIBUSB_CAPABILITY_FULL_SPEED_OPERATION (1 << 1) 386227404Shselasky#define LIBUSB_CAPABILITY_HIGH_SPEED_OPERATION (1 << 2) 387227404Shselasky#define LIBUSB_CAPABILITY_5GBPS_OPERATION (1 << 3) 388227404Shselasky uint8_t bFunctionalitySupport; 389227404Shselasky uint8_t bU1DevExitLat; 390227404Shselasky uint16_t wU2DevExitLat; 391227404Shselasky} libusb_ss_usb_device_capability_descriptor __aligned(sizeof(void *)); 392227404Shselasky 393302275Shselaskytypedef struct libusb_bos_dev_capability_descriptor { 394302275Shselasky uint8_t bLength; 395302275Shselasky uint8_t bDescriptorType; 396302275Shselasky uint8_t bDevCapabilityType; 397302275Shselasky uint8_t dev_capability_data[0]; 398302275Shselasky} libusb_bos_dev_capability_descriptor __aligned(sizeof(void *)); 399302275Shselasky 400227404Shselaskytypedef struct libusb_bos_descriptor { 401227404Shselasky uint8_t bLength; 402227404Shselasky uint8_t bDescriptorType; 403227404Shselasky uint16_t wTotalLength; 404227404Shselasky uint8_t bNumDeviceCapabilities; 405227404Shselasky struct libusb_usb_2_0_device_capability_descriptor *usb_2_0_ext_cap; 406227404Shselasky struct libusb_ss_usb_device_capability_descriptor *ss_usb_cap; 407227404Shselasky} libusb_bos_descriptor __aligned(sizeof(void *)); 408227404Shselasky 409302275Shselaskytypedef struct libusb_usb_2_0_extension_descriptor { 410302275Shselasky uint8_t bLength; 411302275Shselasky uint8_t bDescriptorType; 412302275Shselasky uint8_t bDevCapabilityType; 413302275Shselasky uint32_t bmAttributes; 414302275Shselasky} libusb_usb_2_0_extension_descriptor __aligned(sizeof(void *)); 415302275Shselasky 416302275Shselaskytypedef struct libusb_container_id_descriptor { 417302275Shselasky uint8_t bLength; 418302275Shselasky uint8_t bDescriptorType; 419302275Shselasky uint8_t bDevCapabilityType; 420302275Shselasky uint8_t bReserved; 421302275Shselasky uint8_t ContainerID[16]; 422302275Shselasky} libusb_container_id_descriptor __aligned(sizeof(void *)); 423302275Shselasky 424194676Sthompsatypedef struct libusb_control_setup { 425194676Sthompsa uint8_t bmRequestType; 426194676Sthompsa uint8_t bRequest; 427194676Sthompsa uint16_t wValue; 428194676Sthompsa uint16_t wIndex; 429194676Sthompsa uint16_t wLength; 430194676Sthompsa} libusb_control_setup; 431194676Sthompsa 432199055Sthompsa#define LIBUSB_CONTROL_SETUP_SIZE 8 /* bytes */ 433199055Sthompsa 434194676Sthompsatypedef struct libusb_iso_packet_descriptor { 435199055Sthompsa uint32_t length; 436199055Sthompsa uint32_t actual_length; 437194676Sthompsa enum libusb_transfer_status status; 438194676Sthompsa} libusb_iso_packet_descriptor __aligned(sizeof(void *)); 439194676Sthompsa 440194676Sthompsatypedef void (*libusb_transfer_cb_fn) (struct libusb_transfer *transfer); 441194676Sthompsa 442194676Sthompsatypedef struct libusb_transfer { 443194676Sthompsa libusb_device_handle *dev_handle; 444194676Sthompsa uint8_t flags; 445234684Shselasky uint8_t endpoint; 446195957Salfred uint8_t type; 447199055Sthompsa uint32_t timeout; 448194676Sthompsa enum libusb_transfer_status status; 449194676Sthompsa int length; 450194676Sthompsa int actual_length; 451194676Sthompsa libusb_transfer_cb_fn callback; 452194676Sthompsa void *user_data; 453195957Salfred uint8_t *buffer; 454194676Sthompsa int num_iso_packets; 455194676Sthompsa struct libusb_iso_packet_descriptor iso_packet_desc[0]; 456194676Sthompsa} libusb_transfer __aligned(sizeof(void *)); 457194676Sthompsa 458194676Sthompsa/* Library initialisation */ 459194676Sthompsa 460194676Sthompsavoid libusb_set_debug(libusb_context * ctx, int level); 461302275Shselaskyconst struct libusb_version *libusb_get_version(void); 462213853Shselaskyconst char *libusb_strerror(int code); 463225659Shselaskyconst char *libusb_error_name(int code); 464194676Sthompsaint libusb_init(libusb_context ** context); 465194676Sthompsavoid libusb_exit(struct libusb_context *ctx); 466362224Skevansint libusb_has_capability(uint32_t capability); 467194676Sthompsa 468194676Sthompsa/* Device handling and enumeration */ 469194676Sthompsa 470194676Sthompsassize_t libusb_get_device_list(libusb_context * ctx, libusb_device *** list); 471194676Sthompsavoid libusb_free_device_list(libusb_device ** list, int unref_devices); 472194676Sthompsauint8_t libusb_get_bus_number(libusb_device * dev); 473302275Shselaskyuint8_t libusb_get_port_number(libusb_device * dev); 474251495Semasteint libusb_get_port_numbers(libusb_device *dev, uint8_t *buf, uint8_t bufsize); 475250342Semasteint libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *buf, uint8_t bufsize); 476194676Sthompsauint8_t libusb_get_device_address(libusb_device * dev); 477224903Shselaskyenum libusb_speed libusb_get_device_speed(libusb_device * dev); 478195957Salfredint libusb_clear_halt(libusb_device_handle *devh, uint8_t endpoint); 479195957Salfredint libusb_get_max_packet_size(libusb_device * dev, uint8_t endpoint); 480234193Shselaskyint libusb_get_max_iso_packet_size(libusb_device * dev, uint8_t endpoint); 481194676Sthompsalibusb_device *libusb_ref_device(libusb_device * dev); 482194676Sthompsavoid libusb_unref_device(libusb_device * dev); 483194676Sthompsaint libusb_open(libusb_device * dev, libusb_device_handle ** devh); 484194676Sthompsalibusb_device_handle *libusb_open_device_with_vid_pid(libusb_context * ctx, uint16_t vendor_id, uint16_t product_id); 485194676Sthompsavoid libusb_close(libusb_device_handle * devh); 486194676Sthompsalibusb_device *libusb_get_device(libusb_device_handle * devh); 487194676Sthompsaint libusb_get_configuration(libusb_device_handle * devh, int *config); 488194676Sthompsaint libusb_set_configuration(libusb_device_handle * devh, int configuration); 489194676Sthompsaint libusb_claim_interface(libusb_device_handle * devh, int interface_number); 490194676Sthompsaint libusb_release_interface(libusb_device_handle * devh, int interface_number); 491199055Sthompsaint libusb_reset_device(libusb_device_handle * devh); 492213848Shselaskyint libusb_check_connected(libusb_device_handle * devh); 493194676Sthompsaint libusb_kernel_driver_active(libusb_device_handle * devh, int interface); 494213853Shselaskyint libusb_get_driver_np(libusb_device_handle * devh, int interface, char *name, int namelen); 495213853Shselaskyint libusb_get_driver(libusb_device_handle * devh, int interface, char *name, int namelen); 496213853Shselaskyint libusb_detach_kernel_driver_np(libusb_device_handle * devh, int interface); 497194676Sthompsaint libusb_detach_kernel_driver(libusb_device_handle * devh, int interface); 498194676Sthompsaint libusb_attach_kernel_driver(libusb_device_handle * devh, int interface); 499302275Shselaskyint libusb_set_auto_detach_kernel_driver(libusb_device_handle *dev, int enable); 500194676Sthompsaint libusb_set_interface_alt_setting(libusb_device_handle * devh, int interface_number, int alternate_setting); 501194676Sthompsa 502194676Sthompsa/* USB Descriptors */ 503194676Sthompsa 504194676Sthompsaint libusb_get_device_descriptor(libusb_device * dev, struct libusb_device_descriptor *desc); 505194676Sthompsaint libusb_get_active_config_descriptor(libusb_device * dev, struct libusb_config_descriptor **config); 506194676Sthompsaint libusb_get_config_descriptor(libusb_device * dev, uint8_t config_index, struct libusb_config_descriptor **config); 507194676Sthompsaint libusb_get_config_descriptor_by_value(libusb_device * dev, uint8_t bConfigurationValue, struct libusb_config_descriptor **config); 508194676Sthompsavoid libusb_free_config_descriptor(struct libusb_config_descriptor *config); 509302275Shselaskyint libusb_get_ss_endpoint_companion_descriptor(struct libusb_context *ctx, const struct libusb_endpoint_descriptor *endpoint, struct libusb_ss_endpoint_companion_descriptor **ep_comp); 510302275Shselaskyvoid libusb_free_ss_endpoint_companion_descriptor(struct libusb_ss_endpoint_companion_descriptor *ep_comp); 511235128Shselaskyint libusb_get_string_descriptor(libusb_device_handle * devh, uint8_t desc_index, uint16_t langid, unsigned char *data, int length); 512199055Sthompsaint libusb_get_string_descriptor_ascii(libusb_device_handle * devh, uint8_t desc_index, uint8_t *data, int length); 513199055Sthompsaint libusb_get_descriptor(libusb_device_handle * devh, uint8_t desc_type, uint8_t desc_index, uint8_t *data, int length); 514227404Shselaskyint libusb_parse_ss_endpoint_comp(const void *buf, int len, struct libusb_ss_endpoint_companion_descriptor **ep_comp); 515227404Shselaskyvoid libusb_free_ss_endpoint_comp(struct libusb_ss_endpoint_companion_descriptor *ep_comp); 516227404Shselaskyint libusb_parse_bos_descriptor(const void *buf, int len, struct libusb_bos_descriptor **bos); 517227404Shselaskyvoid libusb_free_bos_descriptor(struct libusb_bos_descriptor *bos); 518302275Shselaskyint libusb_get_bos_descriptor(libusb_device_handle *handle, struct libusb_bos_descriptor **bos); 519302275Shselaskyint libusb_get_usb_2_0_extension_descriptor(struct libusb_context *ctx, struct libusb_bos_dev_capability_descriptor *dev_cap, struct libusb_usb_2_0_extension_descriptor **usb_2_0_extension); 520302275Shselaskyvoid libusb_free_usb_2_0_extension_descriptor(struct libusb_usb_2_0_extension_descriptor *usb_2_0_extension); 521302275Shselaskyint libusb_get_ss_usb_device_capability_descriptor(struct libusb_context *ctx, struct libusb_bos_dev_capability_descriptor *dev_cap, struct libusb_ss_usb_device_capability_descriptor **ss_usb_device_capability); 522302275Shselaskyvoid libusb_free_ss_usb_device_capability_descriptor(struct libusb_ss_usb_device_capability_descriptor *ss_usb_device_capability); 523302275Shselaskyint libusb_get_container_id_descriptor(struct libusb_context *ctx, struct libusb_bos_dev_capability_descriptor *dev_cap, struct libusb_container_id_descriptor **container_id); 524302275Shselaskyvoid libusb_free_container_id_descriptor(struct libusb_container_id_descriptor *container_id); 525194676Sthompsa 526195957Salfred/* Asynchronous device I/O */ 527194676Sthompsa 528194676Sthompsastruct libusb_transfer *libusb_alloc_transfer(int iso_packets); 529194676Sthompsavoid libusb_free_transfer(struct libusb_transfer *transfer); 530194676Sthompsaint libusb_submit_transfer(struct libusb_transfer *transfer); 531194676Sthompsaint libusb_cancel_transfer(struct libusb_transfer *transfer); 532199055Sthompsauint8_t *libusb_get_iso_packet_buffer(struct libusb_transfer *transfer, uint32_t index); 533199055Sthompsauint8_t *libusb_get_iso_packet_buffer_simple(struct libusb_transfer *transfer, uint32_t index); 534199055Sthompsavoid libusb_set_iso_packet_lengths(struct libusb_transfer *transfer, uint32_t length); 535199055Sthompsauint8_t *libusb_control_transfer_get_data(struct libusb_transfer *transfer); 536199055Sthompsastruct libusb_control_setup *libusb_control_transfer_get_setup(struct libusb_transfer *transfer); 537199055Sthompsavoid libusb_fill_control_setup(uint8_t *buf, uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex, uint16_t wLength); 538199055Sthompsavoid libusb_fill_control_transfer(struct libusb_transfer *transfer, libusb_device_handle *devh, uint8_t *buf, libusb_transfer_cb_fn callback, void *user_data, uint32_t timeout); 539199055Sthompsavoid libusb_fill_bulk_transfer(struct libusb_transfer *transfer, libusb_device_handle *devh, uint8_t endpoint, uint8_t *buf, int length, libusb_transfer_cb_fn callback, void *user_data, uint32_t timeout); 540199055Sthompsavoid libusb_fill_interrupt_transfer(struct libusb_transfer *transfer, libusb_device_handle *devh, uint8_t endpoint, uint8_t *buf, int length, libusb_transfer_cb_fn callback, void *user_data, uint32_t timeout); 541199055Sthompsavoid libusb_fill_iso_transfer(struct libusb_transfer *transfer, libusb_device_handle *devh, uint8_t endpoint, uint8_t *buf, int length, int npacket, libusb_transfer_cb_fn callback, void *user_data, uint32_t timeout); 542194676Sthompsa 543194676Sthompsa/* Polling and timing */ 544194676Sthompsa 545194676Sthompsaint libusb_try_lock_events(libusb_context * ctx); 546194676Sthompsavoid libusb_lock_events(libusb_context * ctx); 547194676Sthompsavoid libusb_unlock_events(libusb_context * ctx); 548194676Sthompsaint libusb_event_handling_ok(libusb_context * ctx); 549194676Sthompsaint libusb_event_handler_active(libusb_context * ctx); 550194676Sthompsavoid libusb_lock_event_waiters(libusb_context * ctx); 551194676Sthompsavoid libusb_unlock_event_waiters(libusb_context * ctx); 552194676Sthompsaint libusb_wait_for_event(libusb_context * ctx, struct timeval *tv); 553261482Shselaskyint libusb_handle_events_timeout_completed(libusb_context * ctx, struct timeval *tv, int *completed); 554261482Shselaskyint libusb_handle_events_completed(libusb_context * ctx, int *completed); 555194676Sthompsaint libusb_handle_events_timeout(libusb_context * ctx, struct timeval *tv); 556194676Sthompsaint libusb_handle_events(libusb_context * ctx); 557194676Sthompsaint libusb_handle_events_locked(libusb_context * ctx, struct timeval *tv); 558194676Sthompsaint libusb_get_next_timeout(libusb_context * ctx, struct timeval *tv); 559194676Sthompsavoid libusb_set_pollfd_notifiers(libusb_context * ctx, libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb, void *user_data); 560250335Semasteconst struct libusb_pollfd **libusb_get_pollfds(libusb_context * ctx); 561194676Sthompsa 562194676Sthompsa/* Synchronous device I/O */ 563194676Sthompsa 564199055Sthompsaint libusb_control_transfer(libusb_device_handle * devh, uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex, uint8_t *data, uint16_t wLength, uint32_t timeout); 565199055Sthompsaint libusb_bulk_transfer(libusb_device_handle * devh, uint8_t endpoint, uint8_t *data, int length, int *transferred, uint32_t timeout); 566199055Sthompsaint libusb_interrupt_transfer(libusb_device_handle * devh, uint8_t endpoint, uint8_t *data, int length, int *transferred, uint32_t timeout); 567194676Sthompsa 568199055Sthompsa/* Byte-order */ 569199055Sthompsa 570199055Sthompsauint16_t libusb_cpu_to_le16(uint16_t x); 571199055Sthompsauint16_t libusb_le16_to_cpu(uint16_t x); 572199055Sthompsa 573302275Shselasky/* Hotplug support */ 574302275Shselasky 575302275Shselaskytypedef int (*libusb_hotplug_callback_fn)(libusb_context *ctx, 576302275Shselasky libusb_device *device, libusb_hotplug_event event, void *user_data); 577302275Shselasky 578302275Shselaskyint libusb_hotplug_register_callback(libusb_context *ctx, libusb_hotplug_event events, libusb_hotplug_flag flags, int vendor_id, int product_id, int dev_class, libusb_hotplug_callback_fn cb_fn, void *user_data, libusb_hotplug_callback_handle *handle); 579302275Shselaskyvoid libusb_hotplug_deregister_callback(libusb_context *ctx, libusb_hotplug_callback_handle handle); 580302275Shselasky 581302275Shselasky/* Streams support */ 582302275Shselasky 583302275Shselaskyint libusb_alloc_streams(libusb_device_handle *dev, uint32_t num_streams, unsigned char *endpoints, int num_endpoints); 584302275Shselaskyint libusb_free_streams(libusb_device_handle *dev, unsigned char *endpoints, int num_endpoints); 585302275Shselaskyvoid libusb_transfer_set_stream_id(struct libusb_transfer *transfer, uint32_t stream_id); 586302275Shselaskyuint32_t libusb_transfer_get_stream_id(struct libusb_transfer *transfer); 587302275Shselasky 588194676Sthompsa#if 0 589194676Sthompsa{ /* indent fix */ 590194676Sthompsa#endif 591194676Sthompsa#ifdef __cplusplus 592194676Sthompsa} 593194676Sthompsa 594194676Sthompsa#endif 595194676Sthompsa 596194676Sthompsa#endif /* __LIBUSB_H__ */ 597