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