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