lib/libusb/libusb.h

   1 /* $FreeBSD$ */
   2 /*-
   3  * Copyright (c) 2009 Sylvestre Gallon. All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26
  27 #ifndef __LIBUSB_H__
  28 #define __LIBUSB_H__
  29
  30 #include <sys/time.h>
  31 #include <sys/types.h>
  32
  33 #define LIBUSB_API_VERSION 0x01000102
  34
  35 #define LIBUSB_CALL
  36
  37 #ifdef __cplusplus
  38 extern  "C" {
  39 #endif
  40 #if 0
  41 }                                       /* indent fix */
  42
  43 #endif
  44
  45 /* libusb enums */
  46
  47 enum libusb_class_code {
  48         LIBUSB_CLASS_PER_INTERFACE = 0,
  49         LIBUSB_CLASS_AUDIO = 1,
  50         LIBUSB_CLASS_COMM = 2,
  51         LIBUSB_CLASS_HID = 3,
  52         LIBUSB_CLASS_PTP = 6,
  53         LIBUSB_CLASS_IMAGE = 6,
  54         LIBUSB_CLASS_PRINTER = 7,
  55         LIBUSB_CLASS_MASS_STORAGE = 8,
  56         LIBUSB_CLASS_HUB = 9,
  57         LIBUSB_CLASS_DATA = 10,
  58         LIBUSB_CLASS_SMART_CARD = 11,
  59         LIBUSB_CLASS_CONTENT_SECURITY = 13,
  60         LIBUSB_CLASS_VIDEO = 14,
  61         LIBUSB_CLASS_PERSONAL_HEALTHCARE = 15,
  62         LIBUSB_CLASS_DIAGNOSTIC_DEVICE = 0xdc,
  63         LIBUSB_CLASS_WIRELESS = 0xe0,
  64         LIBUSB_CLASS_APPLICATION = 0xfe,
  65         LIBUSB_CLASS_VENDOR_SPEC = 0xff,
  66 };
  67
  68 enum libusb_descriptor_type {
  69         LIBUSB_DT_DEVICE = 0x01,
  70         LIBUSB_DT_CONFIG = 0x02,
  71         LIBUSB_DT_STRING = 0x03,
  72         LIBUSB_DT_INTERFACE = 0x04,
  73         LIBUSB_DT_ENDPOINT = 0x05,
  74         LIBUSB_DT_HID = 0x21,
  75         LIBUSB_DT_REPORT = 0x22,
  76         LIBUSB_DT_PHYSICAL = 0x23,
  77         LIBUSB_DT_HUB = 0x29,
  78         LIBUSB_DT_BOS = 0x0f,
  79         LIBUSB_DT_DEVICE_CAPABILITY = 0x10,
  80         LIBUSB_DT_SS_ENDPOINT_COMPANION = 0x30,
  81 };
  82
  83 enum libusb_device_capability_type {
  84         LIBUSB_WIRELESS_USB_DEVICE_CAPABILITY = 0x1,
  85         LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY = 0x2,
  86         LIBUSB_SS_USB_DEVICE_CAPABILITY = 0x3,
  87         LIBUSB_CONTAINER_ID_DEVICE_CAPABILITY = 0x4,
  88 };
  89
  90 #define LIBUSB_DT_DEVICE_SIZE           18
  91 #define LIBUSB_DT_CONFIG_SIZE           9
  92 #define LIBUSB_DT_INTERFACE_SIZE        9
  93 #define LIBUSB_DT_ENDPOINT_SIZE         7
  94 #define LIBUSB_DT_ENDPOINT_AUDIO_SIZE   9
  95 #define LIBUSB_DT_HUB_NONVAR_SIZE       7
  96 #define LIBUSB_DT_SS_ENDPOINT_COMPANION_SIZE    6
  97 #define LIBUSB_DT_BOS_SIZE              5
  98 #define LIBUSB_USB_2_0_EXTENSION_DEVICE_CAPABILITY_SIZE 7
  99 #define LIBUSB_SS_USB_DEVICE_CAPABILITY_SIZE    10
 100
 101 #define LIBUSB_BT_USB_2_0_EXTENSION_SIZE        7
 102 #define LIBUSB_BT_SS_USB_DEVICE_CAPABILITY_SIZE 10
 103 #define LIBUSB_BT_CONTAINER_ID_SIZE             20
 104
 105 #define LIBUSB_ENDPOINT_ADDRESS_MASK    0x0f
 106 #define LIBUSB_ENDPOINT_DIR_MASK        0x80
 107
 108 enum libusb_endpoint_direction {
 109         LIBUSB_ENDPOINT_IN = 0x80,
 110         LIBUSB_ENDPOINT_OUT = 0x00,
 111 };
 112
 113 #define LIBUSB_TRANSFER_TYPE_MASK       0x03
 114
 115 enum libusb_transfer_type {
 116         LIBUSB_TRANSFER_TYPE_CONTROL = 0,
 117         LIBUSB_TRANSFER_TYPE_ISOCHRONOUS = 1,
 118         LIBUSB_TRANSFER_TYPE_BULK = 2,
 119         LIBUSB_TRANSFER_TYPE_INTERRUPT = 3,
 120 };
 121
 122 enum libusb_standard_request {
 123         LIBUSB_REQUEST_GET_STATUS = 0x00,
 124         LIBUSB_REQUEST_CLEAR_FEATURE = 0x01,
 125         LIBUSB_REQUEST_SET_FEATURE = 0x03,
 126         LIBUSB_REQUEST_SET_ADDRESS = 0x05,
 127         LIBUSB_REQUEST_GET_DESCRIPTOR = 0x06,
 128         LIBUSB_REQUEST_SET_DESCRIPTOR = 0x07,
 129         LIBUSB_REQUEST_GET_CONFIGURATION = 0x08,
 130         LIBUSB_REQUEST_SET_CONFIGURATION = 0x09,
 131         LIBUSB_REQUEST_GET_INTERFACE = 0x0A,
 132         LIBUSB_REQUEST_SET_INTERFACE = 0x0B,
 133         LIBUSB_REQUEST_SYNCH_FRAME = 0x0C,
 134         LIBUSB_REQUEST_SET_SEL = 0x30,
 135         LIBUSB_REQUEST_SET_ISOCH_DELAY = 0x31,
 136 };
 137
 138 enum libusb_request_type {
 139         LIBUSB_REQUEST_TYPE_STANDARD = (0x00 << 5),
 140         LIBUSB_REQUEST_TYPE_CLASS = (0x01 << 5),
 141         LIBUSB_REQUEST_TYPE_VENDOR = (0x02 << 5),
 142         LIBUSB_REQUEST_TYPE_RESERVED = (0x03 << 5),
 143 };
 144
 145 enum libusb_request_recipient {
 146         LIBUSB_RECIPIENT_DEVICE = 0x00,
 147         LIBUSB_RECIPIENT_INTERFACE = 0x01,
 148         LIBUSB_RECIPIENT_ENDPOINT = 0x02,
 149         LIBUSB_RECIPIENT_OTHER = 0x03,
 150 };
 151
 152 #define LIBUSB_ISO_SYNC_TYPE_MASK       0x0C
 153
 154 enum libusb_iso_sync_type {
 155         LIBUSB_ISO_SYNC_TYPE_NONE = 0,
 156         LIBUSB_ISO_SYNC_TYPE_ASYNC = 1,
 157         LIBUSB_ISO_SYNC_TYPE_ADAPTIVE = 2,
 158         LIBUSB_ISO_SYNC_TYPE_SYNC = 3,
 159 };
 160
 161 #define LIBUSB_ISO_USAGE_TYPE_MASK 0x30
 162
 163 enum libusb_iso_usage_type {
 164         LIBUSB_ISO_USAGE_TYPE_DATA = 0,
 165         LIBUSB_ISO_USAGE_TYPE_FEEDBACK = 1,
 166         LIBUSB_ISO_USAGE_TYPE_IMPLICIT = 2,
 167 };
 168
 169 enum libusb_bos_type {
 170         LIBUSB_BT_WIRELESS_USB_DEVICE_CAPABILITY = 1,
 171         LIBUSB_BT_USB_2_0_EXTENSION = 2,
 172         LIBUSB_BT_SS_USB_DEVICE_CAPABILITY = 3,
 173         LIBUSB_BT_CONTAINER_ID = 4,
 174 };
 175
 176 enum libusb_error {
 177         LIBUSB_SUCCESS = 0,
 178         LIBUSB_ERROR_IO = -1,
 179         LIBUSB_ERROR_INVALID_PARAM = -2,
 180         LIBUSB_ERROR_ACCESS = -3,
 181         LIBUSB_ERROR_NO_DEVICE = -4,
 182         LIBUSB_ERROR_NOT_FOUND = -5,
 183         LIBUSB_ERROR_BUSY = -6,
 184         LIBUSB_ERROR_TIMEOUT = -7,
 185         LIBUSB_ERROR_OVERFLOW = -8,
 186         LIBUSB_ERROR_PIPE = -9,
 187         LIBUSB_ERROR_INTERRUPTED = -10,
 188         LIBUSB_ERROR_NO_MEM = -11,
 189         LIBUSB_ERROR_NOT_SUPPORTED = -12,
 190         LIBUSB_ERROR_OTHER = -99,
 191 };
 192
 193 enum libusb_speed {
 194         LIBUSB_SPEED_UNKNOWN = 0,
 195         LIBUSB_SPEED_LOW = 1,
 196         LIBUSB_SPEED_FULL = 2,
 197         LIBUSB_SPEED_HIGH = 3,
 198         LIBUSB_SPEED_SUPER = 4,
 199 };
 200
 201 enum libusb_transfer_status {
 202         LIBUSB_TRANSFER_COMPLETED,
 203         LIBUSB_TRANSFER_ERROR,
 204         LIBUSB_TRANSFER_TIMED_OUT,
 205         LIBUSB_TRANSFER_CANCELLED,
 206         LIBUSB_TRANSFER_STALL,
 207         LIBUSB_TRANSFER_NO_DEVICE,
 208         LIBUSB_TRANSFER_OVERFLOW,
 209 };
 210
 211 enum libusb_transfer_flags {
 212         LIBUSB_TRANSFER_SHORT_NOT_OK = 1 << 0,
 213         LIBUSB_TRANSFER_FREE_BUFFER = 1 << 1,
 214         LIBUSB_TRANSFER_FREE_TRANSFER = 1 << 2,
 215 };
 216
 217 enum libusb_debug_level {
 218         LIBUSB_DEBUG_NO=0,
 219         LIBUSB_DEBUG_FUNCTION=1,
 220         LIBUSB_DEBUG_TRANSFER=2,
 221 };
 222
 223 #define LIBUSB_HOTPLUG_MATCH_ANY -1
 224
 225 typedef enum {
 226         LIBUSB_HOTPLUG_NO_FLAGS = 0,
 227         LIBUSB_HOTPLUG_ENUMERATE = 1 << 0,
 228 } libusb_hotplug_flag;
 229
 230 typedef enum {
 231         LIBUSB_HOTPLUG_EVENT_DEVICE_ARRIVED = 1,
 232         LIBUSB_HOTPLUG_EVENT_DEVICE_LEFT = 2,
 233 } libusb_hotplug_event;
 234
 235 /* libusb structures */
 236
 237 struct libusb_context;
 238 struct libusb_device;
 239 struct libusb_transfer;
 240 struct libusb_device_handle;
 241 struct libusb_hotplug_callback_handle_struct;
 242
 243 struct libusb_pollfd {
 244         int     fd;
 245         short   events;
 246 };
 247
 248 struct libusb_version {
 249         const uint16_t major;
 250         const uint16_t minor;
 251         const uint16_t micro;
 252         const uint16_t nano;
 253         const char *rc;
 254         const char *describe;
 255 };
 256
 257 typedef struct libusb_context libusb_context;
 258 typedef struct libusb_device libusb_device;
 259 typedef struct libusb_device_handle libusb_device_handle;
 260 typedef struct libusb_pollfd libusb_pollfd;
 261 typedef void (*libusb_pollfd_added_cb) (int fd, short events, void *user_data);
 262 typedef void (*libusb_pollfd_removed_cb) (int fd, void *user_data);
 263 typedef struct libusb_hotplug_callback_handle_struct *libusb_hotplug_callback_handle;
 264
 265 typedef struct libusb_device_descriptor {
 266         uint8_t bLength;
 267         uint8_t bDescriptorType;
 268         uint16_t bcdUSB;
 269         uint8_t bDeviceClass;
 270         uint8_t bDeviceSubClass;
 271         uint8_t bDeviceProtocol;
 272         uint8_t bMaxPacketSize0;
 273         uint16_t idVendor;
 274         uint16_t idProduct;
 275         uint16_t bcdDevice;
 276         uint8_t iManufacturer;
 277         uint8_t iProduct;
 278         uint8_t iSerialNumber;
 279         uint8_t bNumConfigurations;
 280 }       libusb_device_descriptor;
 281
 282 typedef struct libusb_endpoint_descriptor {
 283         uint8_t bLength;
 284         uint8_t bDescriptorType;
 285         uint8_t bEndpointAddress;
 286         uint8_t bmAttributes;
 287         uint16_t wMaxPacketSize;
 288         uint8_t bInterval;
 289         uint8_t bRefresh;
 290         uint8_t bSynchAddress;
 291         uint8_t *extra;
 292         int     extra_length;
 293 }       libusb_endpoint_descriptor __aligned(sizeof(void *));
 294
 295 typedef struct libusb_ss_endpoint_companion_descriptor {
 296         uint8_t bLength;
 297         uint8_t bDescriptorType;
 298         uint8_t bMaxBurst;
 299         uint8_t bmAttributes;
 300         uint16_t wBytesPerInterval;
 301 }       libusb_ss_endpoint_companion_descriptor __aligned(sizeof(void *));
 302
 303 typedef struct libusb_interface_descriptor {
 304         uint8_t bLength;
 305         uint8_t bDescriptorType;
 306         uint8_t bInterfaceNumber;
 307         uint8_t bAlternateSetting;
 308         uint8_t bNumEndpoints;
 309         uint8_t bInterfaceClass;
 310         uint8_t bInterfaceSubClass;
 311         uint8_t bInterfaceProtocol;
 312         uint8_t iInterface;
 313         struct libusb_endpoint_descriptor *endpoint;
 314         uint8_t *extra;
 315         int     extra_length;
 316 }       libusb_interface_descriptor __aligned(sizeof(void *));
 317
 318 typedef struct libusb_interface {
 319         struct libusb_interface_descriptor *altsetting;
 320         int     num_altsetting;
 321 }       libusb_interface __aligned(sizeof(void *));
 322
 323 typedef struct libusb_config_descriptor {
 324         uint8_t bLength;
 325         uint8_t bDescriptorType;
 326         uint16_t wTotalLength;
 327         uint8_t bNumInterfaces;
 328         uint8_t bConfigurationValue;
 329         uint8_t iConfiguration;
 330         uint8_t bmAttributes;
 331         uint8_t MaxPower;
 332         struct libusb_interface *interface;
 333         uint8_t *extra;
 334         int     extra_length;
 335 }       libusb_config_descriptor __aligned(sizeof(void *));
 336
 337 typedef struct libusb_usb_2_0_device_capability_descriptor {
 338         uint8_t bLength;
 339         uint8_t bDescriptorType;
 340         uint8_t bDevCapabilityType;
 341         uint32_t bmAttributes;
 342 #define LIBUSB_USB_2_0_CAPABILITY_LPM_SUPPORT  (1 << 1)
 343 }       libusb_usb_2_0_device_capability_descriptor __aligned(sizeof(void *));
 344
 345 typedef struct libusb_ss_usb_device_capability_descriptor {
 346         uint8_t bLength;
 347         uint8_t bDescriptorType;
 348         uint8_t bDevCapabilityType;
 349         uint8_t bmAttributes;
 350 #define LIBUSB_SS_USB_CAPABILITY_LPM_SUPPORT   (1 << 1)
 351         uint16_t wSpeedSupported;
 352 #define LIBUSB_CAPABILITY_LOW_SPEED_OPERATION  (1)
 353 #define LIBUSB_CAPABILITY_FULL_SPEED_OPERATION (1 << 1)
 354 #define LIBUSB_CAPABILITY_HIGH_SPEED_OPERATION (1 << 2)
 355 #define LIBUSB_CAPABILITY_5GBPS_OPERATION      (1 << 3)
 356         uint8_t bFunctionalitySupport;
 357         uint8_t bU1DevExitLat;
 358         uint16_t wU2DevExitLat;
 359 }       libusb_ss_usb_device_capability_descriptor __aligned(sizeof(void *));
 360
 361 typedef struct libusb_bos_dev_capability_descriptor {
 362         uint8_t bLength;
 363         uint8_t bDescriptorType;
 364         uint8_t bDevCapabilityType;
 365         uint8_t dev_capability_data[0];
 366 }       libusb_bos_dev_capability_descriptor __aligned(sizeof(void *));
 367
 368 typedef struct libusb_bos_descriptor {
 369         uint8_t bLength;
 370         uint8_t bDescriptorType;
 371         uint16_t wTotalLength;
 372         uint8_t bNumDeviceCapabilities;
 373         struct libusb_usb_2_0_device_capability_descriptor *usb_2_0_ext_cap;
 374         struct libusb_ss_usb_device_capability_descriptor *ss_usb_cap;
 375 }       libusb_bos_descriptor __aligned(sizeof(void *));
 376
 377 typedef struct libusb_usb_2_0_extension_descriptor {
 378         uint8_t bLength;
 379         uint8_t bDescriptorType;
 380         uint8_t bDevCapabilityType;
 381         uint32_t bmAttributes;
 382 }       libusb_usb_2_0_extension_descriptor __aligned(sizeof(void *));
 383
 384 typedef struct libusb_container_id_descriptor {
 385         uint8_t bLength;
 386         uint8_t bDescriptorType;
 387         uint8_t bDevCapabilityType;
 388         uint8_t bReserved;
 389         uint8_t ContainerID[16];
 390 }       libusb_container_id_descriptor __aligned(sizeof(void *));
 391
 392 typedef struct libusb_control_setup {
 393         uint8_t bmRequestType;
 394         uint8_t bRequest;
 395         uint16_t wValue;
 396         uint16_t wIndex;
 397         uint16_t wLength;
 398 }       libusb_control_setup;
 399
 400 #define LIBUSB_CONTROL_SETUP_SIZE       8       /* bytes */
 401
 402 typedef struct libusb_iso_packet_descriptor {
 403         uint32_t length;
 404         uint32_t actual_length;
 405         enum libusb_transfer_status status;
 406 }       libusb_iso_packet_descriptor __aligned(sizeof(void *));
 407
 408 typedef void (*libusb_transfer_cb_fn) (struct libusb_transfer *transfer);
 409
 410 typedef struct libusb_transfer {
 411         libusb_device_handle *dev_handle;
 412         uint8_t flags;
 413         uint32_t endpoint;
 414         uint8_t type;
 415         uint32_t timeout;
 416         enum libusb_transfer_status status;
 417         int     length;
 418         int     actual_length;
 419         libusb_transfer_cb_fn callback;
 420         void   *user_data;
 421         uint8_t *buffer;
 422         void *os_priv;
 423         int     num_iso_packets;
 424         struct libusb_iso_packet_descriptor iso_packet_desc[0];
 425 }       libusb_transfer __aligned(sizeof(void *));
 426
 427 /* Library initialisation */
 428
 429 void    libusb_set_debug(libusb_context * ctx, int level);
 430 const struct libusb_version *libusb_get_version(void);
 431 const char *libusb_strerror(int code);
 432 const char *libusb_error_name(int code);
 433 int     libusb_init(libusb_context ** context);
 434 void    libusb_exit(struct libusb_context *ctx);
 435
 436 /* Device handling and enumeration */
 437
 438 ssize_t libusb_get_device_list(libusb_context * ctx, libusb_device *** list);
 439 void    libusb_free_device_list(libusb_device ** list, int unref_devices);
 440 uint8_t libusb_get_bus_number(libusb_device * dev);
 441 uint8_t libusb_get_port_number(libusb_device * dev);
 442 int     libusb_get_port_numbers(libusb_device *dev, uint8_t *buf, uint8_t bufsize);
 443 int     libusb_get_port_path(libusb_context *ctx, libusb_device *dev, uint8_t *buf, uint8_t bufsize);
 444 uint8_t libusb_get_device_address(libusb_device * dev);
 445 enum libusb_speed libusb_get_device_speed(libusb_device * dev);
 446 int     libusb_clear_halt(libusb_device_handle *devh, uint8_t endpoint);
 447 int     libusb_get_max_packet_size(libusb_device * dev, uint8_t endpoint);
 448 int     libusb_get_max_iso_packet_size(libusb_device * dev, uint8_t endpoint);
 449 libusb_device *libusb_ref_device(libusb_device * dev);
 450 void    libusb_unref_device(libusb_device * dev);
 451 int     libusb_open(libusb_device * dev, libusb_device_handle ** devh);
 452 libusb_device_handle *libusb_open_device_with_vid_pid(libusb_context * ctx, uint16_t vendor_id, uint16_t product_id);
 453 void    libusb_close(libusb_device_handle * devh);
 454 libusb_device *libusb_get_device(libusb_device_handle * devh);
 455 int     libusb_get_configuration(libusb_device_handle * devh, int *config);
 456 int     libusb_set_configuration(libusb_device_handle * devh, int configuration);
 457 int     libusb_claim_interface(libusb_device_handle * devh, int interface_number);
 458 int     libusb_release_interface(libusb_device_handle * devh, int interface_number);
 459 int     libusb_reset_device(libusb_device_handle * devh);
 460 int     libusb_check_connected(libusb_device_handle * devh);
 461 int     libusb_kernel_driver_active(libusb_device_handle * devh, int interface);
 462 int     libusb_get_driver_np(libusb_device_handle * devh, int interface, char *name, int namelen);
 463 int     libusb_get_driver(libusb_device_handle * devh, int interface, char *name, int namelen);
 464 int     libusb_detach_kernel_driver_np(libusb_device_handle * devh, int interface);
 465 int     libusb_detach_kernel_driver(libusb_device_handle * devh, int interface);
 466 int     libusb_attach_kernel_driver(libusb_device_handle * devh, int interface);
 467 int     libusb_set_auto_detach_kernel_driver(libusb_device_handle *dev, int enable);
 468 int     libusb_set_interface_alt_setting(libusb_device_handle * devh, int interface_number, int alternate_setting);
 469
 470 /* USB Descriptors */
 471
 472 int     libusb_get_device_descriptor(libusb_device * dev, struct libusb_device_descriptor *desc);
 473 int     libusb_get_active_config_descriptor(libusb_device * dev, struct libusb_config_descriptor **config);
 474 int     libusb_get_config_descriptor(libusb_device * dev, uint8_t config_index, struct libusb_config_descriptor **config);
 475 int     libusb_get_config_descriptor_by_value(libusb_device * dev, uint8_t bConfigurationValue, struct libusb_config_descriptor **config);
 476 void    libusb_free_config_descriptor(struct libusb_config_descriptor *config);
 477 int     libusb_get_ss_endpoint_companion_descriptor(struct libusb_context *ctx, const struct libusb_endpoint_descriptor *endpoint, struct libusb_ss_endpoint_companion_descriptor **ep_comp);
 478 void    libusb_free_ss_endpoint_companion_descriptor(struct libusb_ss_endpoint_companion_descriptor *ep_comp);
 479 int     libusb_get_string_descriptor(libusb_device_handle * devh, uint8_t desc_index, uint16_t langid, unsigned char *data, int length);
 480 int     libusb_get_string_descriptor_ascii(libusb_device_handle * devh, uint8_t desc_index, uint8_t *data, int length);
 481 int     libusb_get_descriptor(libusb_device_handle * devh, uint8_t desc_type, uint8_t desc_index, uint8_t *data, int length);
 482 int     libusb_parse_ss_endpoint_comp(const void *buf, int len, struct libusb_ss_endpoint_companion_descriptor **ep_comp);
 483 void    libusb_free_ss_endpoint_comp(struct libusb_ss_endpoint_companion_descriptor *ep_comp);
 484 int     libusb_parse_bos_descriptor(const void *buf, int len, struct libusb_bos_descriptor **bos);
 485 void    libusb_free_bos_descriptor(struct libusb_bos_descriptor *bos);
 486 int     libusb_get_bos_descriptor(libusb_device_handle *handle, struct libusb_bos_descriptor **bos);
 487 int     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);
 488 void    libusb_free_usb_2_0_extension_descriptor(struct libusb_usb_2_0_extension_descriptor *usb_2_0_extension);
 489 int     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);
 490 void    libusb_free_ss_usb_device_capability_descriptor(struct libusb_ss_usb_device_capability_descriptor *ss_usb_device_capability);
 491 int     libusb_get_container_id_descriptor(struct libusb_context *ctx, struct libusb_bos_dev_capability_descriptor *dev_cap, struct libusb_container_id_descriptor **container_id);
 492 void    libusb_free_container_id_descriptor(struct libusb_container_id_descriptor *container_id);
 493
 494 /* Asynchronous device I/O */
 495
 496 struct libusb_transfer *libusb_alloc_transfer(int iso_packets);
 497 void    libusb_free_transfer(struct libusb_transfer *transfer);
 498 int     libusb_submit_transfer(struct libusb_transfer *transfer);
 499 int     libusb_cancel_transfer(struct libusb_transfer *transfer);
 500 uint8_t *libusb_get_iso_packet_buffer(struct libusb_transfer *transfer, uint32_t index);
 501 uint8_t *libusb_get_iso_packet_buffer_simple(struct libusb_transfer *transfer, uint32_t index);
 502 void    libusb_set_iso_packet_lengths(struct libusb_transfer *transfer, uint32_t length);
 503 uint8_t *libusb_control_transfer_get_data(struct libusb_transfer *transfer);
 504 struct libusb_control_setup *libusb_control_transfer_get_setup(struct libusb_transfer *transfer);
 505 void    libusb_fill_control_setup(uint8_t *buf, uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex, uint16_t wLength);
 506 void    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);
 507 void    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);
 508 void    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);
 509 void    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);
 510
 511 /* Polling and timing */
 512
 513 int     libusb_try_lock_events(libusb_context * ctx);
 514 void    libusb_lock_events(libusb_context * ctx);
 515 void    libusb_unlock_events(libusb_context * ctx);
 516 int     libusb_event_handling_ok(libusb_context * ctx);
 517 int     libusb_event_handler_active(libusb_context * ctx);
 518 void    libusb_lock_event_waiters(libusb_context * ctx);
 519 void    libusb_unlock_event_waiters(libusb_context * ctx);
 520 int     libusb_wait_for_event(libusb_context * ctx, struct timeval *tv);
 521 int     libusb_handle_events_timeout_completed(libusb_context * ctx, struct timeval *tv, int *completed);
 522 int     libusb_handle_events_completed(libusb_context * ctx, int *completed);
 523 int     libusb_handle_events_timeout(libusb_context * ctx, struct timeval *tv);
 524 int     libusb_handle_events(libusb_context * ctx);
 525 int     libusb_handle_events_locked(libusb_context * ctx, struct timeval *tv);
 526 int     libusb_get_next_timeout(libusb_context * ctx, struct timeval *tv);
 527 void    libusb_set_pollfd_notifiers(libusb_context * ctx, libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb, void *user_data);
 528 const struct libusb_pollfd **libusb_get_pollfds(libusb_context * ctx);
 529
 530 /* Synchronous device I/O */
 531
 532 int     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);
 533 int     libusb_bulk_transfer(libusb_device_handle * devh, uint8_t endpoint, uint8_t *data, int length, int *transferred, uint32_t timeout);
 534 int     libusb_interrupt_transfer(libusb_device_handle * devh, uint8_t endpoint, uint8_t *data, int length, int *transferred, uint32_t timeout);
 535
 536 /* Byte-order */
 537
 538 uint16_t libusb_cpu_to_le16(uint16_t x);
 539 uint16_t libusb_le16_to_cpu(uint16_t x);
 540
 541 /* Hotplug support */
 542
 543 typedef int (*libusb_hotplug_callback_fn)(libusb_context *ctx,
 544     libusb_device *device, libusb_hotplug_event event, void *user_data);
 545
 546 int     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);
 547 void    libusb_hotplug_deregister_callback(libusb_context *ctx, libusb_hotplug_callback_handle handle);
 548
 549 /* Streams support */
 550
 551 int     libusb_alloc_streams(libusb_device_handle *dev, uint32_t num_streams, unsigned char *endpoints, int num_endpoints);
 552 int     libusb_free_streams(libusb_device_handle *dev, unsigned char *endpoints, int num_endpoints);
 553 void    libusb_transfer_set_stream_id(struct libusb_transfer *transfer, uint32_t stream_id);
 554 uint32_t libusb_transfer_get_stream_id(struct libusb_transfer *transfer);
 555
 556 #if 0
 557 {                                       /* indent fix */
 558 #endif
 559 #ifdef __cplusplus
 560 }
 561
 562 #endif
 563
 564 #endif                                  /* __LIBUSB_H__ */