libusb.h revision 302171
1194676Sthompsa/* $FreeBSD: head/lib/libusb/libusb.h 302171 2016-06-24 10:55:14Z hselasky $ */ 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 36301957Shselasky#define LIBUSB_API_VERSION 0x01000102 37301957Shselasky 38266664Shselasky#define LIBUSB_CALL 39266664Shselasky 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, 55194676Sthompsa LIBUSB_CLASS_PTP = 6, 56270133Shselasky LIBUSB_CLASS_IMAGE = 6, 57194676Sthompsa LIBUSB_CLASS_PRINTER = 7, 58194676Sthompsa LIBUSB_CLASS_MASS_STORAGE = 8, 59194676Sthompsa LIBUSB_CLASS_HUB = 9, 60194676Sthompsa LIBUSB_CLASS_DATA = 10, 61270133Shselasky LIBUSB_CLASS_SMART_CARD = 11, 62270133Shselasky LIBUSB_CLASS_CONTENT_SECURITY = 13, 63270133Shselasky LIBUSB_CLASS_VIDEO = 14, 64270133Shselasky LIBUSB_CLASS_PERSONAL_HEALTHCARE = 15, 65270133Shselasky LIBUSB_CLASS_DIAGNOSTIC_DEVICE = 0xdc, 66270133Shselasky LIBUSB_CLASS_WIRELESS = 0xe0, 67270133Shselasky LIBUSB_CLASS_APPLICATION = 0xfe, 68194676Sthompsa LIBUSB_CLASS_VENDOR_SPEC = 0xff, 69194676Sthompsa}; 70194676Sthompsa 71194676Sthompsaenum libusb_descriptor_type { 72194676Sthompsa LIBUSB_DT_DEVICE = 0x01, 73194676Sthompsa LIBUSB_DT_CONFIG = 0x02, 74194676Sthompsa LIBUSB_DT_STRING = 0x03, 75194676Sthompsa LIBUSB_DT_INTERFACE = 0x04, 76194676Sthompsa LIBUSB_DT_ENDPOINT = 0x05, 77194676Sthompsa LIBUSB_DT_HID = 0x21, 78194676Sthompsa LIBUSB_DT_REPORT = 0x22, 79194676Sthompsa LIBUSB_DT_PHYSICAL = 0x23, 80194676Sthompsa LIBUSB_DT_HUB = 0x29, 81227404Shselasky LIBUSB_DT_BOS = 0x0f, 82227404Shselasky LIBUSB_DT_DEVICE_CAPABILITY = 0x10, 83227404Shselasky LIBUSB_DT_SS_ENDPOINT_COMPANION = 0x30, 84194676Sthompsa}; 85194676Sthompsa 86227404Shselaskyenum libusb_device_capability_type { 87227404Shselasky LIBUSB_WIRELESS_USB_DEVICE_CAPABILITY = 0x1, 88227404Shselasky LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY = 0x2, 89227404Shselasky LIBUSB_SS_USB_DEVICE_CAPABILITY = 0x3, 90227404Shselasky LIBUSB_CONTAINER_ID_DEVICE_CAPABILITY = 0x4, 91227404Shselasky}; 92227404Shselasky 93194676Sthompsa#define LIBUSB_DT_DEVICE_SIZE 18 94194676Sthompsa#define LIBUSB_DT_CONFIG_SIZE 9 95194676Sthompsa#define LIBUSB_DT_INTERFACE_SIZE 9 96194676Sthompsa#define LIBUSB_DT_ENDPOINT_SIZE 7 97194676Sthompsa#define LIBUSB_DT_ENDPOINT_AUDIO_SIZE 9 98194676Sthompsa#define LIBUSB_DT_HUB_NONVAR_SIZE 7 99227404Shselasky#define LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE 6 100227404Shselasky#define LIBUSB_DT_BOS_SIZE 5 101227404Shselasky#define LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY_SIZE 7 102227404Shselasky#define LIBUSB_SS_USB_DEVICE_CAPABILITY_SIZE 10 103194676Sthompsa 104301968Shselasky#define LIBUSB_BT_USB_2_0_EXTENSION_SIZE 7 105301968Shselasky#define LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE 10 106301968Shselasky#define LIBUSB_BT_CONTAINER_ID_SIZE 20 107301968Shselasky 108194676Sthompsa#define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f 109194676Sthompsa#define LIBUSB_ENDPOINT_DIR_MASK 0x80 110194676Sthompsa 111194676Sthompsaenum libusb_endpoint_direction { 112194676Sthompsa LIBUSB_ENDPOINT_IN = 0x80, 113194676Sthompsa LIBUSB_ENDPOINT_OUT = 0x00, 114194676Sthompsa}; 115194676Sthompsa 116194676Sthompsa#define LIBUSB_TRANSFER_TYPE_MASK 0x03 117194676Sthompsa 118194676Sthompsaenum libusb_transfer_type { 119194676Sthompsa LIBUSB_TRANSFER_TYPE_CONTROL = 0, 120194676Sthompsa LIBUSB_TRANSFER_TYPE_ISOCHRONOUS = 1, 121194676Sthompsa LIBUSB_TRANSFER_TYPE_BULK = 2, 122194676Sthompsa LIBUSB_TRANSFER_TYPE_INTERRUPT = 3, 123194676Sthompsa}; 124194676Sthompsa 125194676Sthompsaenum libusb_standard_request { 126194676Sthompsa LIBUSB_REQUEST_GET_STATUS = 0x00, 127194676Sthompsa LIBUSB_REQUEST_CLEAR_FEATURE = 0x01, 128194676Sthompsa LIBUSB_REQUEST_SET_FEATURE = 0x03, 129194676Sthompsa LIBUSB_REQUEST_SET_ADDRESS = 0x05, 130194676Sthompsa LIBUSB_REQUEST_GET_DESCRIPTOR = 0x06, 131194676Sthompsa LIBUSB_REQUEST_SET_DESCRIPTOR = 0x07, 132194676Sthompsa LIBUSB_REQUEST_GET_CONFIGURATION = 0x08, 133194676Sthompsa LIBUSB_REQUEST_SET_CONFIGURATION = 0x09, 134194676Sthompsa LIBUSB_REQUEST_GET_INTERFACE = 0x0A, 135194676Sthompsa LIBUSB_REQUEST_SET_INTERFACE = 0x0B, 136194676Sthompsa LIBUSB_REQUEST_SYNCH_FRAME = 0x0C, 137277245Shselasky LIBUSB_REQUEST_SET_SEL = 0x30, 138277245Shselasky LIBUSB_REQUEST_SET_ISOCH_DELAY = 0x31, 139194676Sthompsa}; 140194676Sthompsa 141194676Sthompsaenum libusb_request_type { 142194676Sthompsa LIBUSB_REQUEST_TYPE_STANDARD = (0x00 << 5), 143194676Sthompsa LIBUSB_REQUEST_TYPE_CLASS = (0x01 << 5), 144194676Sthompsa LIBUSB_REQUEST_TYPE_VENDOR = (0x02 << 5), 145194676Sthompsa LIBUSB_REQUEST_TYPE_RESERVED = (0x03 << 5), 146194676Sthompsa}; 147194676Sthompsa 148194676Sthompsaenum libusb_request_recipient { 149194676Sthompsa LIBUSB_RECIPIENT_DEVICE = 0x00, 150194676Sthompsa LIBUSB_RECIPIENT_INTERFACE = 0x01, 151194676Sthompsa LIBUSB_RECIPIENT_ENDPOINT = 0x02, 152194676Sthompsa LIBUSB_RECIPIENT_OTHER = 0x03, 153194676Sthompsa}; 154194676Sthompsa 155194676Sthompsa#define LIBUSB_ISO_SYNC_TYPE_MASK 0x0C 156194676Sthompsa 157194676Sthompsaenum libusb_iso_sync_type { 158194676Sthompsa LIBUSB_ISO_SYNC_TYPE_NONE = 0, 159194676Sthompsa LIBUSB_ISO_SYNC_TYPE_ASYNC = 1, 160194676Sthompsa LIBUSB_ISO_SYNC_TYPE_ADAPTIVE = 2, 161194676Sthompsa LIBUSB_ISO_SYNC_TYPE_SYNC = 3, 162194676Sthompsa}; 163194676Sthompsa 164194676Sthompsa#define LIBUSB_ISO_USAGE_TYPE_MASK 0x30 165194676Sthompsa 166194676Sthompsaenum libusb_iso_usage_type { 167194676Sthompsa LIBUSB_ISO_USAGE_TYPE_DATA = 0, 168194676Sthompsa LIBUSB_ISO_USAGE_TYPE_FEEDBACK = 1, 169194676Sthompsa LIBUSB_ISO_USAGE_TYPE_IMPLICIT = 2, 170194676Sthompsa}; 171194676Sthompsa 172301968Shselaskyenum libusb_bos_type { 173301968Shselasky LIBUSB_BT_WIRELESS_USB_DEVICE_CAPABILITY = 1, 174301968Shselasky LIBUSB_BT_USB_2_0_EXTENSION = 2, 175301968Shselasky LIBUSB_BT_SS_USB_DEVICE_CAPABILITY = 3, 176301968Shselasky LIBUSB_BT_CONTAINER_ID = 4, 177301968Shselasky}; 178301968Shselasky 179194676Sthompsaenum libusb_error { 180194676Sthompsa LIBUSB_SUCCESS = 0, 181194676Sthompsa LIBUSB_ERROR_IO = -1, 182194676Sthompsa LIBUSB_ERROR_INVALID_PARAM = -2, 183194676Sthompsa LIBUSB_ERROR_ACCESS = -3, 184194676Sthompsa LIBUSB_ERROR_NO_DEVICE = -4, 185194676Sthompsa LIBUSB_ERROR_NOT_FOUND = -5, 186194676Sthompsa LIBUSB_ERROR_BUSY = -6, 187194676Sthompsa LIBUSB_ERROR_TIMEOUT = -7, 188194676Sthompsa LIBUSB_ERROR_OVERFLOW = -8, 189194676Sthompsa LIBUSB_ERROR_PIPE = -9, 190194676Sthompsa LIBUSB_ERROR_INTERRUPTED = -10, 191194676Sthompsa LIBUSB_ERROR_NO_MEM = -11, 192194676Sthompsa LIBUSB_ERROR_NOT_SUPPORTED = -12, 193194676Sthompsa LIBUSB_ERROR_OTHER = -99, 194194676Sthompsa}; 195194676Sthompsa 196224903Shselaskyenum libusb_speed { 197224903Shselasky LIBUSB_SPEED_UNKNOWN = 0, 198224903Shselasky LIBUSB_SPEED_LOW = 1, 199224903Shselasky LIBUSB_SPEED_FULL = 2, 200224903Shselasky LIBUSB_SPEED_HIGH = 3, 201224903Shselasky LIBUSB_SPEED_SUPER = 4, 202224903Shselasky}; 203224903Shselasky 204194676Sthompsaenum libusb_transfer_status { 205194676Sthompsa LIBUSB_TRANSFER_COMPLETED, 206194676Sthompsa LIBUSB_TRANSFER_ERROR, 207194676Sthompsa LIBUSB_TRANSFER_TIMED_OUT, 208194676Sthompsa LIBUSB_TRANSFER_CANCELLED, 209194676Sthompsa LIBUSB_TRANSFER_STALL, 210194676Sthompsa LIBUSB_TRANSFER_NO_DEVICE, 211194676Sthompsa LIBUSB_TRANSFER_OVERFLOW, 212194676Sthompsa}; 213194676Sthompsa 214194676Sthompsaenum libusb_transfer_flags { 215194676Sthompsa LIBUSB_TRANSFER_SHORT_NOT_OK = 1 << 0, 216194676Sthompsa LIBUSB_TRANSFER_FREE_BUFFER = 1 << 1, 217194676Sthompsa LIBUSB_TRANSFER_FREE_TRANSFER = 1 << 2, 218194676Sthompsa}; 219194676Sthompsa 220263191Seadlerenum libusb_log_level { 221263191Seadler LIBUSB_LOG_LEVEL_NONE = 0, 222263191Seadler LIBUSB_LOG_LEVEL_ERROR, 223263191Seadler LIBUSB_LOG_LEVEL_WARNING, 224263191Seadler LIBUSB_LOG_LEVEL_INFO, 225263191Seadler LIBUSB_LOG_LEVEL_DEBUG 226263191Seadler}; 227263191Seadler 228263191Seadler/* XXX */ 229263191Seadler/* libusb_set_debug should take parameters from libusb_log_level 230263191Seadler * above according to 231263191Seadler * http://libusb.sourceforge.net/api-1.0/group__lib.html 232263191Seadler */ 233194676Sthompsaenum libusb_debug_level { 234194676Sthompsa LIBUSB_DEBUG_NO=0, 235194676Sthompsa LIBUSB_DEBUG_FUNCTION=1, 236194676Sthompsa LIBUSB_DEBUG_TRANSFER=2, 237194676Sthompsa}; 238194676Sthompsa 239302080Shselasky#define LIBUSB_HOTPLUG_MATCH_ANY -1 240302080Shselasky 241302080Shselaskytypedef enum { 242302080Shselasky LIBUSB_HOTPLUG_NO_FLAGS = 0, 243302080Shselasky LIBUSB_HOTPLUG_ENUMERATE = 1 << 0, 244302080Shselasky} libusb_hotplug_flag; 245302080Shselasky 246302080Shselaskytypedef enum { 247302080Shselasky LIBUSB_HOTPLUG_EVENT_DEVICE_ARRIVED = 1, 248302080Shselasky LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT = 2, 249302080Shselasky} libusb_hotplug_event; 250302080Shselasky 251195957Salfred/* libusb structures */ 252195560Sthompsa 253195957Salfredstruct libusb_context; 254195957Salfredstruct libusb_device; 255195957Salfredstruct libusb_transfer; 256208020Sthompsastruct libusb_device_handle; 257302171Shselaskystruct libusb_hotplug_callback_handle_struct; 258195957Salfred 259195957Salfredstruct libusb_pollfd { 260195560Sthompsa int fd; 261195560Sthompsa short events; 262195560Sthompsa}; 263195560Sthompsa 264301956Shselaskystruct libusb_version { 265301956Shselasky const uint16_t major; 266301956Shselasky const uint16_t minor; 267301956Shselasky const uint16_t micro; 268301956Shselasky const uint16_t nano; 269301956Shselasky const char *rc; 270301956Shselasky const char *describe; 271301956Shselasky}; 272301956Shselasky 273195957Salfredtypedef struct libusb_context libusb_context; 274195957Salfredtypedef struct libusb_device libusb_device; 275208020Sthompsatypedef struct libusb_device_handle libusb_device_handle; 276195957Salfredtypedef struct libusb_pollfd libusb_pollfd; 277194676Sthompsatypedef void (*libusb_pollfd_added_cb) (int fd, short events, void *user_data); 278194676Sthompsatypedef void (*libusb_pollfd_removed_cb) (int fd, void *user_data); 279302171Shselaskytypedef struct libusb_hotplug_callback_handle_struct *libusb_hotplug_callback_handle; 280194676Sthompsa 281194676Sthompsatypedef struct libusb_device_descriptor { 282194676Sthompsa uint8_t bLength; 283194676Sthompsa uint8_t bDescriptorType; 284194676Sthompsa uint16_t bcdUSB; 285194676Sthompsa uint8_t bDeviceClass; 286194676Sthompsa uint8_t bDeviceSubClass; 287194676Sthompsa uint8_t bDeviceProtocol; 288194676Sthompsa uint8_t bMaxPacketSize0; 289194676Sthompsa uint16_t idVendor; 290194676Sthompsa uint16_t idProduct; 291194676Sthompsa uint16_t bcdDevice; 292194676Sthompsa uint8_t iManufacturer; 293194676Sthompsa uint8_t iProduct; 294194676Sthompsa uint8_t iSerialNumber; 295194676Sthompsa uint8_t bNumConfigurations; 296194676Sthompsa} libusb_device_descriptor; 297194676Sthompsa 298194676Sthompsatypedef struct libusb_endpoint_descriptor { 299194676Sthompsa uint8_t bLength; 300194676Sthompsa uint8_t bDescriptorType; 301194676Sthompsa uint8_t bEndpointAddress; 302194676Sthompsa uint8_t bmAttributes; 303194676Sthompsa uint16_t wMaxPacketSize; 304194676Sthompsa uint8_t bInterval; 305194676Sthompsa uint8_t bRefresh; 306194676Sthompsa uint8_t bSynchAddress; 307195957Salfred uint8_t *extra; 308194676Sthompsa int extra_length; 309194676Sthompsa} libusb_endpoint_descriptor __aligned(sizeof(void *)); 310194676Sthompsa 311227404Shselaskytypedef struct libusb_ss_endpoint_companion_descriptor { 312227404Shselasky uint8_t bLength; 313227404Shselasky uint8_t bDescriptorType; 314227404Shselasky uint8_t bMaxBurst; 315227404Shselasky uint8_t bmAttributes; 316227404Shselasky uint16_t wBytesPerInterval; 317227404Shselasky} libusb_ss_endpoint_companion_descriptor __aligned(sizeof(void *)); 318227404Shselasky 319194676Sthompsatypedef struct libusb_interface_descriptor { 320194676Sthompsa uint8_t bLength; 321194676Sthompsa uint8_t bDescriptorType; 322194676Sthompsa uint8_t bInterfaceNumber; 323194676Sthompsa uint8_t bAlternateSetting; 324194676Sthompsa uint8_t bNumEndpoints; 325194676Sthompsa uint8_t bInterfaceClass; 326194676Sthompsa uint8_t bInterfaceSubClass; 327194676Sthompsa uint8_t bInterfaceProtocol; 328194676Sthompsa uint8_t iInterface; 329194676Sthompsa struct libusb_endpoint_descriptor *endpoint; 330195957Salfred uint8_t *extra; 331194676Sthompsa int extra_length; 332194676Sthompsa} libusb_interface_descriptor __aligned(sizeof(void *)); 333194676Sthompsa 334194676Sthompsatypedef struct libusb_interface { 335194676Sthompsa struct libusb_interface_descriptor *altsetting; 336194676Sthompsa int num_altsetting; 337194676Sthompsa} libusb_interface __aligned(sizeof(void *)); 338194676Sthompsa 339194676Sthompsatypedef struct libusb_config_descriptor { 340194676Sthompsa uint8_t bLength; 341194676Sthompsa uint8_t bDescriptorType; 342194676Sthompsa uint16_t wTotalLength; 343194676Sthompsa uint8_t bNumInterfaces; 344194676Sthompsa uint8_t bConfigurationValue; 345194676Sthompsa uint8_t iConfiguration; 346194676Sthompsa uint8_t bmAttributes; 347194676Sthompsa uint8_t MaxPower; 348194676Sthompsa struct libusb_interface *interface; 349195957Salfred uint8_t *extra; 350194676Sthompsa int extra_length; 351194676Sthompsa} libusb_config_descriptor __aligned(sizeof(void *)); 352194676Sthompsa 353227404Shselaskytypedef struct libusb_usb_2_0_device_capability_descriptor { 354227404Shselasky uint8_t bLength; 355227404Shselasky uint8_t bDescriptorType; 356227404Shselasky uint8_t bDevCapabilityType; 357227404Shselasky uint32_t bmAttributes; 358227404Shselasky#define LIBUSB_USB_2_0_CAPABILITY_LPM_SUPPORT (1 << 1) 359227404Shselasky} libusb_usb_2_0_device_capability_descriptor __aligned(sizeof(void *)); 360227404Shselasky 361227404Shselaskytypedef struct libusb_ss_usb_device_capability_descriptor { 362227404Shselasky uint8_t bLength; 363227404Shselasky uint8_t bDescriptorType; 364227404Shselasky uint8_t bDevCapabilityType; 365227404Shselasky uint8_t bmAttributes; 366227404Shselasky#define LIBUSB_SS_USB_CAPABILITY_LPM_SUPPORT (1 << 1) 367227404Shselasky uint16_t wSpeedSupported; 368227404Shselasky#define LIBUSB_CAPABILITY_LOW_SPEED_OPERATION (1) 369227404Shselasky#define LIBUSB_CAPABILITY_FULL_SPEED_OPERATION (1 << 1) 370227404Shselasky#define LIBUSB_CAPABILITY_HIGH_SPEED_OPERATION (1 << 2) 371227404Shselasky#define LIBUSB_CAPABILITY_5GBPS_OPERATION (1 << 3) 372227404Shselasky uint8_t bFunctionalitySupport; 373227404Shselasky uint8_t bU1DevExitLat; 374227404Shselasky uint16_t wU2DevExitLat; 375227404Shselasky} libusb_ss_usb_device_capability_descriptor __aligned(sizeof(void *)); 376227404Shselasky 377301968Shselaskytypedef struct libusb_bos_dev_capability_descriptor { 378301968Shselasky uint8_t bLength; 379301968Shselasky uint8_t bDescriptorType; 380301968Shselasky uint8_t bDevCapabilityType; 381301968Shselasky uint8_t dev_capability_data[0]; 382301968Shselasky} libusb_bos_dev_capability_descriptor __aligned(sizeof(void *)); 383301968Shselasky 384227404Shselaskytypedef struct libusb_bos_descriptor { 385227404Shselasky uint8_t bLength; 386227404Shselasky uint8_t bDescriptorType; 387227404Shselasky uint16_t wTotalLength; 388227404Shselasky uint8_t bNumDeviceCapabilities; 389227404Shselasky struct libusb_usb_2_0_device_capability_descriptor *usb_2_0_ext_cap; 390227404Shselasky struct libusb_ss_usb_device_capability_descriptor *ss_usb_cap; 391227404Shselasky} libusb_bos_descriptor __aligned(sizeof(void *)); 392227404Shselasky 393301968Shselaskytypedef struct libusb_usb_2_0_extension_descriptor { 394301968Shselasky uint8_t bLength; 395301968Shselasky uint8_t bDescriptorType; 396301968Shselasky uint8_t bDevCapabilityType; 397301968Shselasky uint32_t bmAttributes; 398301968Shselasky} libusb_usb_2_0_extension_descriptor __aligned(sizeof(void *)); 399301968Shselasky 400301968Shselaskytypedef struct libusb_container_id_descriptor { 401301968Shselasky uint8_t bLength; 402301968Shselasky uint8_t bDescriptorType; 403301968Shselasky uint8_t bDevCapabilityType; 404301968Shselasky uint8_t bReserved; 405301968Shselasky uint8_t ContainerID[16]; 406301968Shselasky} libusb_container_id_descriptor __aligned(sizeof(void *)); 407301968Shselasky 408194676Sthompsatypedef struct libusb_control_setup { 409194676Sthompsa uint8_t bmRequestType; 410194676Sthompsa uint8_t bRequest; 411194676Sthompsa uint16_t wValue; 412194676Sthompsa uint16_t wIndex; 413194676Sthompsa uint16_t wLength; 414194676Sthompsa} libusb_control_setup; 415194676Sthompsa 416199055Sthompsa#define LIBUSB_CONTROL_SETUP_SIZE 8 /* bytes */ 417199055Sthompsa 418194676Sthompsatypedef struct libusb_iso_packet_descriptor { 419199055Sthompsa uint32_t length; 420199055Sthompsa uint32_t actual_length; 421194676Sthompsa enum libusb_transfer_status status; 422194676Sthompsa} libusb_iso_packet_descriptor __aligned(sizeof(void *)); 423194676Sthompsa 424194676Sthompsatypedef void (*libusb_transfer_cb_fn) (struct libusb_transfer *transfer); 425194676Sthompsa 426194676Sthompsatypedef struct libusb_transfer { 427194676Sthompsa libusb_device_handle *dev_handle; 428194676Sthompsa uint8_t flags; 429234684Shselasky uint8_t endpoint; 430195957Salfred uint8_t type; 431199055Sthompsa uint32_t timeout; 432194676Sthompsa enum libusb_transfer_status status; 433194676Sthompsa int length; 434194676Sthompsa int actual_length; 435194676Sthompsa libusb_transfer_cb_fn callback; 436194676Sthompsa void *user_data; 437195957Salfred uint8_t *buffer; 438194676Sthompsa int num_iso_packets; 439194676Sthompsa struct libusb_iso_packet_descriptor iso_packet_desc[0]; 440194676Sthompsa} libusb_transfer __aligned(sizeof(void *)); 441194676Sthompsa 442194676Sthompsa/* Library initialisation */ 443194676Sthompsa 444194676Sthompsavoid libusb_set_debug(libusb_context * ctx, int level); 445301956Shselaskyconst struct libusb_version *libusb_get_version(void); 446213853Shselaskyconst char *libusb_strerror(int code); 447225659Shselaskyconst char *libusb_error_name(int code); 448194676Sthompsaint libusb_init(libusb_context ** context); 449194676Sthompsavoid libusb_exit(struct libusb_context *ctx); 450194676Sthompsa 451194676Sthompsa/* Device handling and enumeration */ 452194676Sthompsa 453194676Sthompsassize_t libusb_get_device_list(libusb_context * ctx, libusb_device *** list); 454194676Sthompsavoid libusb_free_device_list(libusb_device ** list, int unref_devices); 455194676Sthompsauint8_t libusb_get_bus_number(libusb_device * dev); 456301964Shselaskyuint8_t libusb_get_port_number(libusb_device * dev); 457251495Semasteint libusb_get_port_numbers(libusb_device *dev, uint8_t *buf, uint8_t bufsize); 458250342Semasteint libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *buf, uint8_t bufsize); 459194676Sthompsauint8_t libusb_get_device_address(libusb_device * dev); 460224903Shselaskyenum libusb_speed libusb_get_device_speed(libusb_device * dev); 461195957Salfredint libusb_clear_halt(libusb_device_handle *devh, uint8_t endpoint); 462195957Salfredint libusb_get_max_packet_size(libusb_device * dev, uint8_t endpoint); 463234193Shselaskyint libusb_get_max_iso_packet_size(libusb_device * dev, uint8_t endpoint); 464194676Sthompsalibusb_device *libusb_ref_device(libusb_device * dev); 465194676Sthompsavoid libusb_unref_device(libusb_device * dev); 466194676Sthompsaint libusb_open(libusb_device * dev, libusb_device_handle ** devh); 467194676Sthompsalibusb_device_handle *libusb_open_device_with_vid_pid(libusb_context * ctx, uint16_t vendor_id, uint16_t product_id); 468194676Sthompsavoid libusb_close(libusb_device_handle * devh); 469194676Sthompsalibusb_device *libusb_get_device(libusb_device_handle * devh); 470194676Sthompsaint libusb_get_configuration(libusb_device_handle * devh, int *config); 471194676Sthompsaint libusb_set_configuration(libusb_device_handle * devh, int configuration); 472194676Sthompsaint libusb_claim_interface(libusb_device_handle * devh, int interface_number); 473194676Sthompsaint libusb_release_interface(libusb_device_handle * devh, int interface_number); 474199055Sthompsaint libusb_reset_device(libusb_device_handle * devh); 475213848Shselaskyint libusb_check_connected(libusb_device_handle * devh); 476194676Sthompsaint libusb_kernel_driver_active(libusb_device_handle * devh, int interface); 477213853Shselaskyint libusb_get_driver_np(libusb_device_handle * devh, int interface, char *name, int namelen); 478213853Shselaskyint libusb_get_driver(libusb_device_handle * devh, int interface, char *name, int namelen); 479213853Shselaskyint libusb_detach_kernel_driver_np(libusb_device_handle * devh, int interface); 480194676Sthompsaint libusb_detach_kernel_driver(libusb_device_handle * devh, int interface); 481194676Sthompsaint libusb_attach_kernel_driver(libusb_device_handle * devh, int interface); 482301966Shselaskyint libusb_set_auto_detach_kernel_driver(libusb_device_handle *dev, int enable); 483194676Sthompsaint libusb_set_interface_alt_setting(libusb_device_handle * devh, int interface_number, int alternate_setting); 484194676Sthompsa 485194676Sthompsa/* USB Descriptors */ 486194676Sthompsa 487194676Sthompsaint libusb_get_device_descriptor(libusb_device * dev, struct libusb_device_descriptor *desc); 488194676Sthompsaint libusb_get_active_config_descriptor(libusb_device * dev, struct libusb_config_descriptor **config); 489194676Sthompsaint libusb_get_config_descriptor(libusb_device * dev, uint8_t config_index, struct libusb_config_descriptor **config); 490194676Sthompsaint libusb_get_config_descriptor_by_value(libusb_device * dev, uint8_t bConfigurationValue, struct libusb_config_descriptor **config); 491194676Sthompsavoid libusb_free_config_descriptor(struct libusb_config_descriptor *config); 492301968Shselaskyint libusb_get_ss_endpoint_companion_descriptor(struct libusb_context *ctx, const struct libusb_endpoint_descriptor *endpoint, struct libusb_ss_endpoint_companion_descriptor **ep_comp); 493301968Shselaskyvoid libusb_free_ss_endpoint_companion_descriptor(struct libusb_ss_endpoint_companion_descriptor *ep_comp); 494235128Shselaskyint libusb_get_string_descriptor(libusb_device_handle * devh, uint8_t desc_index, uint16_t langid, unsigned char *data, int length); 495199055Sthompsaint libusb_get_string_descriptor_ascii(libusb_device_handle * devh, uint8_t desc_index, uint8_t *data, int length); 496199055Sthompsaint libusb_get_descriptor(libusb_device_handle * devh, uint8_t desc_type, uint8_t desc_index, uint8_t *data, int length); 497227404Shselaskyint libusb_parse_ss_endpoint_comp(const void *buf, int len, struct libusb_ss_endpoint_companion_descriptor **ep_comp); 498227404Shselaskyvoid libusb_free_ss_endpoint_comp(struct libusb_ss_endpoint_companion_descriptor *ep_comp); 499227404Shselaskyint libusb_parse_bos_descriptor(const void *buf, int len, struct libusb_bos_descriptor **bos); 500227404Shselaskyvoid libusb_free_bos_descriptor(struct libusb_bos_descriptor *bos); 501301968Shselaskyint libusb_get_bos_descriptor(libusb_device_handle *handle, struct libusb_bos_descriptor **bos); 502301968Shselaskyint 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); 503301968Shselaskyvoid libusb_free_usb_2_0_extension_descriptor(struct libusb_usb_2_0_extension_descriptor *usb_2_0_extension); 504301968Shselaskyint 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); 505301968Shselaskyvoid libusb_free_ss_usb_device_capability_descriptor(struct libusb_ss_usb_device_capability_descriptor *ss_usb_device_capability); 506301968Shselaskyint libusb_get_container_id_descriptor(struct libusb_context *ctx, struct libusb_bos_dev_capability_descriptor *dev_cap, struct libusb_container_id_descriptor **container_id); 507301968Shselaskyvoid libusb_free_container_id_descriptor(struct libusb_container_id_descriptor *container_id); 508194676Sthompsa 509195957Salfred/* Asynchronous device I/O */ 510194676Sthompsa 511194676Sthompsastruct libusb_transfer *libusb_alloc_transfer(int iso_packets); 512194676Sthompsavoid libusb_free_transfer(struct libusb_transfer *transfer); 513194676Sthompsaint libusb_submit_transfer(struct libusb_transfer *transfer); 514194676Sthompsaint libusb_cancel_transfer(struct libusb_transfer *transfer); 515199055Sthompsauint8_t *libusb_get_iso_packet_buffer(struct libusb_transfer *transfer, uint32_t index); 516199055Sthompsauint8_t *libusb_get_iso_packet_buffer_simple(struct libusb_transfer *transfer, uint32_t index); 517199055Sthompsavoid libusb_set_iso_packet_lengths(struct libusb_transfer *transfer, uint32_t length); 518199055Sthompsauint8_t *libusb_control_transfer_get_data(struct libusb_transfer *transfer); 519199055Sthompsastruct libusb_control_setup *libusb_control_transfer_get_setup(struct libusb_transfer *transfer); 520199055Sthompsavoid libusb_fill_control_setup(uint8_t *buf, uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex, uint16_t wLength); 521199055Sthompsavoid 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); 522199055Sthompsavoid 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); 523199055Sthompsavoid 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); 524199055Sthompsavoid 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); 525194676Sthompsa 526194676Sthompsa/* Polling and timing */ 527194676Sthompsa 528194676Sthompsaint libusb_try_lock_events(libusb_context * ctx); 529194676Sthompsavoid libusb_lock_events(libusb_context * ctx); 530194676Sthompsavoid libusb_unlock_events(libusb_context * ctx); 531194676Sthompsaint libusb_event_handling_ok(libusb_context * ctx); 532194676Sthompsaint libusb_event_handler_active(libusb_context * ctx); 533194676Sthompsavoid libusb_lock_event_waiters(libusb_context * ctx); 534194676Sthompsavoid libusb_unlock_event_waiters(libusb_context * ctx); 535194676Sthompsaint libusb_wait_for_event(libusb_context * ctx, struct timeval *tv); 536260315Shselaskyint libusb_handle_events_timeout_completed(libusb_context * ctx, struct timeval *tv, int *completed); 537260315Shselaskyint libusb_handle_events_completed(libusb_context * ctx, int *completed); 538194676Sthompsaint libusb_handle_events_timeout(libusb_context * ctx, struct timeval *tv); 539194676Sthompsaint libusb_handle_events(libusb_context * ctx); 540194676Sthompsaint libusb_handle_events_locked(libusb_context * ctx, struct timeval *tv); 541194676Sthompsaint libusb_get_next_timeout(libusb_context * ctx, struct timeval *tv); 542194676Sthompsavoid libusb_set_pollfd_notifiers(libusb_context * ctx, libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb, void *user_data); 543250335Semasteconst struct libusb_pollfd **libusb_get_pollfds(libusb_context * ctx); 544194676Sthompsa 545194676Sthompsa/* Synchronous device I/O */ 546194676Sthompsa 547199055Sthompsaint 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); 548199055Sthompsaint libusb_bulk_transfer(libusb_device_handle * devh, uint8_t endpoint, uint8_t *data, int length, int *transferred, uint32_t timeout); 549199055Sthompsaint libusb_interrupt_transfer(libusb_device_handle * devh, uint8_t endpoint, uint8_t *data, int length, int *transferred, uint32_t timeout); 550194676Sthompsa 551199055Sthompsa/* Byte-order */ 552199055Sthompsa 553199055Sthompsauint16_t libusb_cpu_to_le16(uint16_t x); 554199055Sthompsauint16_t libusb_le16_to_cpu(uint16_t x); 555199055Sthompsa 556302080Shselasky/* Hotplug support */ 557302080Shselasky 558302080Shselaskytypedef int (*libusb_hotplug_callback_fn)(libusb_context *ctx, 559302080Shselasky libusb_device *device, libusb_hotplug_event event, void *user_data); 560302080Shselasky 561302080Shselaskyint 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); 562302080Shselaskyvoid libusb_hotplug_deregister_callback(libusb_context *ctx, libusb_hotplug_callback_handle handle); 563302080Shselasky 564302125Shselasky/* Streams support */ 565302125Shselasky 566302125Shselaskyint libusb_alloc_streams(libusb_device_handle *dev, uint32_t num_streams, unsigned char *endpoints, int num_endpoints); 567302125Shselaskyint libusb_free_streams(libusb_device_handle *dev, unsigned char *endpoints, int num_endpoints); 568302125Shselaskyvoid libusb_transfer_set_stream_id(struct libusb_transfer *transfer, uint32_t stream_id); 569302125Shselaskyuint32_t libusb_transfer_get_stream_id(struct libusb_transfer *transfer); 570302125Shselasky 571194676Sthompsa#if 0 572194676Sthompsa{ /* indent fix */ 573194676Sthompsa#endif 574194676Sthompsa#ifdef __cplusplus 575194676Sthompsa} 576194676Sthompsa 577194676Sthompsa#endif 578194676Sthompsa 579194676Sthompsa#endif /* __LIBUSB_H__ */ 580