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