libusb.h revision 225659
111126Sjulian/* $FreeBSD: head/lib/libusb/libusb.h 225659 2011-09-19 08:52:06Z hselasky $ */ 211126Sjulian/*- 311126Sjulian * Copyright (c) 2009 Sylvestre Gallon. All rights reserved. 411126Sjulian * 511126Sjulian * Redistribution and use in source and binary forms, with or without 611126Sjulian * modification, are permitted provided that the following conditions 711126Sjulian * are met: 811126Sjulian * 1. Redistributions of source code must retain the above copyright 911126Sjulian * notice, this list of conditions and the following disclaimer. 1011126Sjulian * 2. Redistributions in binary form must reproduce the above copyright 1111126Sjulian * notice, this list of conditions and the following disclaimer in the 1211126Sjulian * documentation and/or other materials provided with the distribution. 1311126Sjulian * 1411126Sjulian * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1511126Sjulian * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1611126Sjulian * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1711126Sjulian * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 1811126Sjulian * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 1911126Sjulian * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2011126Sjulian * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2111126Sjulian * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2211126Sjulian * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2311126Sjulian * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2411126Sjulian * SUCH DAMAGE. 2511126Sjulian */ 2611126Sjulian 2711126Sjulian#ifndef __LIBUSB_H__ 2811126Sjulian#define __LIBUSB_H__ 2911126Sjulian 3011126Sjulian#include <sys/time.h> 3111126Sjulian#include <sys/types.h> 3211126Sjulian 3348936Sphk#ifdef __cplusplus 3411126Sjulianextern "C" { 3511126Sjulian#endif 3611126Sjulian#if 0 3748936Sphk} /* indent fix */ 3811127Sjulian 3936735Sdfr#endif 4048936Sphk 4111126Sjulian/* libusb enums */ 4212954Sjulian 4348936Sphkenum libusb_class_code { 4411126Sjulian LIBUSB_CLASS_PER_INTERFACE = 0, 4548936Sphk LIBUSB_CLASS_AUDIO = 1, 4648936Sphk LIBUSB_CLASS_COMM = 2, 4747640Sphk LIBUSB_CLASS_HID = 3, 4812954Sjulian LIBUSB_CLASS_PTP = 6, 4947640Sphk LIBUSB_CLASS_PRINTER = 7, 5012954Sjulian LIBUSB_CLASS_MASS_STORAGE = 8, 5148936Sphk LIBUSB_CLASS_HUB = 9, 5246635Sphk LIBUSB_CLASS_DATA = 10, 5348936Sphk LIBUSB_CLASS_VENDOR_SPEC = 0xff, 5448936Sphk}; 5548936Sphk 5648936Sphkenum libusb_descriptor_type { 5748936Sphk LIBUSB_DT_DEVICE = 0x01, 5848936Sphk LIBUSB_DT_CONFIG = 0x02, 5948936Sphk LIBUSB_DT_STRING = 0x03, 6048936Sphk LIBUSB_DT_INTERFACE = 0x04, 6148936Sphk LIBUSB_DT_ENDPOINT = 0x05, 6211126Sjulian LIBUSB_DT_HID = 0x21, 6312954Sjulian LIBUSB_DT_REPORT = 0x22, 6412954Sjulian LIBUSB_DT_PHYSICAL = 0x23, 6512954Sjulian LIBUSB_DT_HUB = 0x29, 6612954Sjulian}; 6712954Sjulian 6812954Sjulian#define LIBUSB_DT_DEVICE_SIZE 18 6912954Sjulian#define LIBUSB_DT_CONFIG_SIZE 9 7012954Sjulian#define LIBUSB_DT_INTERFACE_SIZE 9 7112954Sjulian#define LIBUSB_DT_ENDPOINT_SIZE 7 7246676Sphk#define LIBUSB_DT_ENDPOINT_AUDIO_SIZE 9 7337389Sjulian#define LIBUSB_DT_HUB_NONVAR_SIZE 7 7448864Sphk 7512954Sjulian#define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f 7612954Sjulian#define LIBUSB_ENDPOINT_DIR_MASK 0x80 7712954Sjulian 7812954Sjulianenum libusb_endpoint_direction { 7947640Sphk LIBUSB_ENDPOINT_IN = 0x80, 8047640Sphk LIBUSB_ENDPOINT_OUT = 0x00, 8147640Sphk}; 8247640Sphk 8347640Sphk#define LIBUSB_TRANSFER_TYPE_MASK 0x03 8447640Sphk 8547640Sphkenum libusb_transfer_type { 8647640Sphk LIBUSB_TRANSFER_TYPE_CONTROL = 0, 8747640Sphk LIBUSB_TRANSFER_TYPE_ISOCHRONOUS = 1, 8848892Sphk LIBUSB_TRANSFER_TYPE_BULK = 2, 8947640Sphk LIBUSB_TRANSFER_TYPE_INTERRUPT = 3, 9047640Sphk}; 9147640Sphk 9247640Sphkenum libusb_standard_request { 9347640Sphk LIBUSB_REQUEST_GET_STATUS = 0x00, 9447640Sphk LIBUSB_REQUEST_CLEAR_FEATURE = 0x01, 9537389Sjulian LIBUSB_REQUEST_SET_FEATURE = 0x03, 9647640Sphk LIBUSB_REQUEST_SET_ADDRESS = 0x05, 9717264Sphk LIBUSB_REQUEST_GET_DESCRIPTOR = 0x06, 9847028Sphk LIBUSB_REQUEST_SET_DESCRIPTOR = 0x07, 9947028Sphk LIBUSB_REQUEST_GET_CONFIGURATION = 0x08, 10017264Sphk LIBUSB_REQUEST_SET_CONFIGURATION = 0x09, 10147028Sphk LIBUSB_REQUEST_GET_INTERFACE = 0x0A, 10247640Sphk LIBUSB_REQUEST_SET_INTERFACE = 0x0B, 10347028Sphk LIBUSB_REQUEST_SYNCH_FRAME = 0x0C, 10448936Sphk}; 10547028Sphk 10647028Sphkenum libusb_request_type { 10747028Sphk LIBUSB_REQUEST_TYPE_STANDARD = (0x00 << 5), 10847640Sphk LIBUSB_REQUEST_TYPE_CLASS = (0x01 << 5), 10947640Sphk LIBUSB_REQUEST_TYPE_VENDOR = (0x02 << 5), 11047640Sphk LIBUSB_REQUEST_TYPE_RESERVED = (0x03 << 5), 11147640Sphk}; 11237389Sjulian 11317264Sphkenum libusb_request_recipient { 11448510Sphk LIBUSB_RECIPIENT_DEVICE = 0x00, 11548510Sphk LIBUSB_RECIPIENT_INTERFACE = 0x01, 11648510Sphk LIBUSB_RECIPIENT_ENDPOINT = 0x02, 11748510Sphk LIBUSB_RECIPIENT_OTHER = 0x03, 11847640Sphk}; 11937389Sjulian 12048510Sphk#define LIBUSB_ISO_SYNC_TYPE_MASK 0x0C 12148936Sphk 12248510Sphkenum libusb_iso_sync_type { 12348510Sphk LIBUSB_ISO_SYNC_TYPE_NONE = 0, 12448510Sphk LIBUSB_ISO_SYNC_TYPE_ASYNC = 1, 12548510Sphk LIBUSB_ISO_SYNC_TYPE_ADAPTIVE = 2, 12647640Sphk LIBUSB_ISO_SYNC_TYPE_SYNC = 3, 12748510Sphk}; 12847640Sphk 12937389Sjulian#define LIBUSB_ISO_USAGE_TYPE_MASK 0x30 13037389Sjulian 13137389Sjulianenum libusb_iso_usage_type { 13248211Sgrog LIBUSB_ISO_USAGE_TYPE_DATA = 0, 13348211Sgrog LIBUSB_ISO_USAGE_TYPE_FEEDBACK = 1, 13448211Sgrog LIBUSB_ISO_USAGE_TYPE_IMPLICIT = 2, 13548211Sgrog}; 13636735Sdfr 13748211Sgrogenum libusb_error { 13848211Sgrog LIBUSB_SUCCESS = 0, 13948211Sgrog LIBUSB_ERROR_IO = -1, 14048211Sgrog LIBUSB_ERROR_INVALID_PARAM = -2, 14148211Sgrog LIBUSB_ERROR_ACCESS = -3, 14248211Sgrog LIBUSB_ERROR_NO_DEVICE = -4, 14348211Sgrog LIBUSB_ERROR_NOT_FOUND = -5, 14448211Sgrog LIBUSB_ERROR_BUSY = -6, 14548211Sgrog LIBUSB_ERROR_TIMEOUT = -7, 14648211Sgrog LIBUSB_ERROR_OVERFLOW = -8, 14748211Sgrog LIBUSB_ERROR_PIPE = -9, 14848211Sgrog LIBUSB_ERROR_INTERRUPTED = -10, 14948211Sgrog LIBUSB_ERROR_NO_MEM = -11, 15048211Sgrog LIBUSB_ERROR_NOT_SUPPORTED = -12, 15148211Sgrog LIBUSB_ERROR_OTHER = -99, 15248211Sgrog}; 15348211Sgrog 15446635Sphkenum libusb_speed { 15536735Sdfr LIBUSB_SPEED_UNKNOWN = 0, 15646635Sphk LIBUSB_SPEED_LOW = 1, 15748240Sdfr LIBUSB_SPEED_FULL = 2, 15836735Sdfr LIBUSB_SPEED_HIGH = 3, 15936735Sdfr LIBUSB_SPEED_SUPER = 4, 16036735Sdfr}; 16147640Sphk 16244975Sdfrenum libusb_transfer_status { 16344975Sdfr LIBUSB_TRANSFER_COMPLETED, 16444975Sdfr LIBUSB_TRANSFER_ERROR, 16536735Sdfr LIBUSB_TRANSFER_TIMED_OUT, 16636735Sdfr LIBUSB_TRANSFER_CANCELLED, 16744975Sdfr LIBUSB_TRANSFER_STALL, 16844975Sdfr LIBUSB_TRANSFER_NO_DEVICE, 16944975Sdfr LIBUSB_TRANSFER_OVERFLOW, 17044975Sdfr}; 17144975Sdfr 17248240Sdfrenum libusb_transfer_flags { 17344975Sdfr LIBUSB_TRANSFER_SHORT_NOT_OK = 1 << 0, 17436735Sdfr LIBUSB_TRANSFER_FREE_BUFFER = 1 << 1, 17536735Sdfr LIBUSB_TRANSFER_FREE_TRANSFER = 1 << 2, 17636735Sdfr}; 17736735Sdfr 17836735Sdfrenum libusb_debug_level { 17936735Sdfr LIBUSB_DEBUG_NO=0, 18036735Sdfr LIBUSB_DEBUG_FUNCTION=1, 18147028Sphk LIBUSB_DEBUG_TRANSFER=2, 18247028Sphk}; 18347028Sphk 18447028Sphk/* libusb structures */ 18547028Sphk 18647028Sphkstruct libusb_context; 18747028Sphkstruct libusb_device; 18847028Sphkstruct libusb_transfer; 18948936Sphkstruct libusb_device_handle; 19048936Sphk 19148936Sphkstruct libusb_pollfd { 19247028Sphk int fd; 19347028Sphk short events; 19447028Sphk}; 19547028Sphk 19647028Sphktypedef struct libusb_context libusb_context; 19748936Sphktypedef struct libusb_device libusb_device; 19848936Sphktypedef struct libusb_device_handle libusb_device_handle; 19948936Sphktypedef struct libusb_pollfd libusb_pollfd; 20047028Sphktypedef void (*libusb_pollfd_added_cb) (int fd, short events, void *user_data); 20147028Sphktypedef void (*libusb_pollfd_removed_cb) (int fd, void *user_data); 20247028Sphk 20347680Sphktypedef struct libusb_device_descriptor { 20447680Sphk uint8_t bLength; 20548892Sphk uint8_t bDescriptorType; 20647680Sphk uint16_t bcdUSB; 20747680Sphk uint8_t bDeviceClass; 20847680Sphk uint8_t bDeviceSubClass; 20947028Sphk uint8_t bDeviceProtocol; 21047028Sphk uint8_t bMaxPacketSize0; 21148936Sphk uint16_t idVendor; 21248936Sphk uint16_t idProduct; 21348936Sphk uint16_t bcdDevice; 21448936Sphk uint8_t iManufacturer; 21548936Sphk uint8_t iProduct; 21648936Sphk uint8_t iSerialNumber; 21748936Sphk uint8_t bNumConfigurations; 21848936Sphk} libusb_device_descriptor; 21948936Sphk 22048936Sphktypedef struct libusb_endpoint_descriptor { 22148936Sphk uint8_t bLength; 22248936Sphk uint8_t bDescriptorType; 22348936Sphk uint8_t bEndpointAddress; 22448936Sphk uint8_t bmAttributes; 22548936Sphk uint16_t wMaxPacketSize; 22648936Sphk uint8_t bInterval; 22748936Sphk uint8_t bRefresh; 22848936Sphk uint8_t bSynchAddress; 22948936Sphk uint8_t *extra; 23048936Sphk int extra_length; 23148936Sphk} libusb_endpoint_descriptor __aligned(sizeof(void *)); 23248936Sphk 23348936Sphktypedef struct libusb_interface_descriptor { 23448936Sphk uint8_t bLength; 23547028Sphk uint8_t bDescriptorType; 23647028Sphk uint8_t bInterfaceNumber; 23747028Sphk uint8_t bAlternateSetting; 23847028Sphk uint8_t bNumEndpoints; 23947028Sphk uint8_t bInterfaceClass; 24048936Sphk uint8_t bInterfaceSubClass; 24148936Sphk uint8_t bInterfaceProtocol; 24248936Sphk uint8_t iInterface; 24347028Sphk struct libusb_endpoint_descriptor *endpoint; 24447028Sphk uint8_t *extra; 24547028Sphk int extra_length; 24647028Sphk} libusb_interface_descriptor __aligned(sizeof(void *)); 24747028Sphk 24848864Sphktypedef struct libusb_interface { 24948864Sphk struct libusb_interface_descriptor *altsetting; 25048864Sphk int num_altsetting; 25148864Sphk} libusb_interface __aligned(sizeof(void *)); 25248864Sphk 25348864Sphktypedef struct libusb_config_descriptor { 25448864Sphk uint8_t bLength; 25548864Sphk uint8_t bDescriptorType; 25648864Sphk uint16_t wTotalLength; 25747028Sphk uint8_t bNumInterfaces; 25847028Sphk uint8_t bConfigurationValue; 25947028Sphk uint8_t iConfiguration; 26047028Sphk uint8_t bmAttributes; 26147028Sphk uint8_t MaxPower; 26247028Sphk struct libusb_interface *interface; 26347028Sphk uint8_t *extra; 26447028Sphk int extra_length; 26547028Sphk} libusb_config_descriptor __aligned(sizeof(void *)); 26647028Sphk 26747028Sphktypedef struct libusb_control_setup { 26847028Sphk uint8_t bmRequestType; 26947028Sphk uint8_t bRequest; 27047028Sphk uint16_t wValue; 27147028Sphk uint16_t wIndex; 27248859Sphk uint16_t wLength; 27347028Sphk} libusb_control_setup; 27447028Sphk 27547028Sphk#define LIBUSB_CONTROL_SETUP_SIZE 8 /* bytes */ 27647028Sphk 277typedef struct libusb_iso_packet_descriptor { 278 uint32_t length; 279 uint32_t actual_length; 280 enum libusb_transfer_status status; 281} libusb_iso_packet_descriptor __aligned(sizeof(void *)); 282 283typedef void (*libusb_transfer_cb_fn) (struct libusb_transfer *transfer); 284 285typedef struct libusb_transfer { 286 libusb_device_handle *dev_handle; 287 uint8_t flags; 288 uint32_t endpoint; 289 uint8_t type; 290 uint32_t timeout; 291 enum libusb_transfer_status status; 292 int length; 293 int actual_length; 294 libusb_transfer_cb_fn callback; 295 void *user_data; 296 uint8_t *buffer; 297 void *os_priv; 298 int num_iso_packets; 299 struct libusb_iso_packet_descriptor iso_packet_desc[0]; 300} libusb_transfer __aligned(sizeof(void *)); 301 302/* Library initialisation */ 303 304void libusb_set_debug(libusb_context * ctx, int level); 305const char *libusb_strerror(int code); 306const char *libusb_error_name(int code); 307int libusb_init(libusb_context ** context); 308void libusb_exit(struct libusb_context *ctx); 309 310/* Device handling and enumeration */ 311 312ssize_t libusb_get_device_list(libusb_context * ctx, libusb_device *** list); 313void libusb_free_device_list(libusb_device ** list, int unref_devices); 314uint8_t libusb_get_bus_number(libusb_device * dev); 315uint8_t libusb_get_device_address(libusb_device * dev); 316enum libusb_speed libusb_get_device_speed(libusb_device * dev); 317int libusb_clear_halt(libusb_device_handle *devh, uint8_t endpoint); 318int libusb_get_max_packet_size(libusb_device * dev, uint8_t endpoint); 319libusb_device *libusb_ref_device(libusb_device * dev); 320void libusb_unref_device(libusb_device * dev); 321int libusb_open(libusb_device * dev, libusb_device_handle ** devh); 322libusb_device_handle *libusb_open_device_with_vid_pid(libusb_context * ctx, uint16_t vendor_id, uint16_t product_id); 323void libusb_close(libusb_device_handle * devh); 324libusb_device *libusb_get_device(libusb_device_handle * devh); 325int libusb_get_configuration(libusb_device_handle * devh, int *config); 326int libusb_set_configuration(libusb_device_handle * devh, int configuration); 327int libusb_claim_interface(libusb_device_handle * devh, int interface_number); 328int libusb_release_interface(libusb_device_handle * devh, int interface_number); 329int libusb_reset_device(libusb_device_handle * devh); 330int libusb_check_connected(libusb_device_handle * devh); 331int libusb_kernel_driver_active(libusb_device_handle * devh, int interface); 332int libusb_get_driver_np(libusb_device_handle * devh, int interface, char *name, int namelen); 333int libusb_get_driver(libusb_device_handle * devh, int interface, char *name, int namelen); 334int libusb_detach_kernel_driver_np(libusb_device_handle * devh, int interface); 335int libusb_detach_kernel_driver(libusb_device_handle * devh, int interface); 336int libusb_attach_kernel_driver(libusb_device_handle * devh, int interface); 337int libusb_set_interface_alt_setting(libusb_device_handle * devh, int interface_number, int alternate_setting); 338 339/* USB Descriptors */ 340 341int libusb_get_device_descriptor(libusb_device * dev, struct libusb_device_descriptor *desc); 342int libusb_get_active_config_descriptor(libusb_device * dev, struct libusb_config_descriptor **config); 343int libusb_get_config_descriptor(libusb_device * dev, uint8_t config_index, struct libusb_config_descriptor **config); 344int libusb_get_config_descriptor_by_value(libusb_device * dev, uint8_t bConfigurationValue, struct libusb_config_descriptor **config); 345void libusb_free_config_descriptor(struct libusb_config_descriptor *config); 346int libusb_get_string_descriptor_ascii(libusb_device_handle * devh, uint8_t desc_index, uint8_t *data, int length); 347int libusb_get_descriptor(libusb_device_handle * devh, uint8_t desc_type, uint8_t desc_index, uint8_t *data, int length); 348 349/* Asynchronous device I/O */ 350 351struct libusb_transfer *libusb_alloc_transfer(int iso_packets); 352void libusb_free_transfer(struct libusb_transfer *transfer); 353int libusb_submit_transfer(struct libusb_transfer *transfer); 354int libusb_cancel_transfer(struct libusb_transfer *transfer); 355uint8_t *libusb_get_iso_packet_buffer(struct libusb_transfer *transfer, uint32_t index); 356uint8_t *libusb_get_iso_packet_buffer_simple(struct libusb_transfer *transfer, uint32_t index); 357void libusb_set_iso_packet_lengths(struct libusb_transfer *transfer, uint32_t length); 358uint8_t *libusb_control_transfer_get_data(struct libusb_transfer *transfer); 359struct libusb_control_setup *libusb_control_transfer_get_setup(struct libusb_transfer *transfer); 360void libusb_fill_control_setup(uint8_t *buf, uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex, uint16_t wLength); 361void 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); 362void 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); 363void 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); 364void 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); 365 366/* Polling and timing */ 367 368int libusb_try_lock_events(libusb_context * ctx); 369void libusb_lock_events(libusb_context * ctx); 370void libusb_unlock_events(libusb_context * ctx); 371int libusb_event_handling_ok(libusb_context * ctx); 372int libusb_event_handler_active(libusb_context * ctx); 373void libusb_lock_event_waiters(libusb_context * ctx); 374void libusb_unlock_event_waiters(libusb_context * ctx); 375int libusb_wait_for_event(libusb_context * ctx, struct timeval *tv); 376int libusb_handle_events_timeout(libusb_context * ctx, struct timeval *tv); 377int libusb_handle_events(libusb_context * ctx); 378int libusb_handle_events_locked(libusb_context * ctx, struct timeval *tv); 379int libusb_get_next_timeout(libusb_context * ctx, struct timeval *tv); 380void libusb_set_pollfd_notifiers(libusb_context * ctx, libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb, void *user_data); 381struct libusb_pollfd **libusb_get_pollfds(libusb_context * ctx); 382 383/* Synchronous device I/O */ 384 385int 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); 386int libusb_bulk_transfer(libusb_device_handle * devh, uint8_t endpoint, uint8_t *data, int length, int *transferred, uint32_t timeout); 387int libusb_interrupt_transfer(libusb_device_handle * devh, uint8_t endpoint, uint8_t *data, int length, int *transferred, uint32_t timeout); 388 389/* Byte-order */ 390 391uint16_t libusb_cpu_to_le16(uint16_t x); 392uint16_t libusb_le16_to_cpu(uint16_t x); 393 394#if 0 395{ /* indent fix */ 396#endif 397#ifdef __cplusplus 398} 399 400#endif 401 402#endif /* __LIBUSB_H__ */ 403