1 /* $FreeBSD$ */ 2 /*- 3 * Copyright (c) 2009 Sylvestre Gallon. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 */ 26 27 #ifndef __LIBUSB_H__ 28 #define __LIBUSB_H__ 29 30 #include <sys/time.h> 31 #include <sys/types.h> 32 33 #ifdef __cplusplus 34 extern "C" { 35 #endif 36 #if 0 37 } /* indent fix */ 38 39 #endif 40 41 /* libusb enums */ 42 43 enum libusb_class_code { 44 LIBUSB_CLASS_PER_INTERFACE = 0, 45 LIBUSB_CLASS_AUDIO = 1, 46 LIBUSB_CLASS_COMM = 2, 47 LIBUSB_CLASS_HID = 3, 48 LIBUSB_CLASS_PTP = 6, 49 LIBUSB_CLASS_PRINTER = 7, 50 LIBUSB_CLASS_MASS_STORAGE = 8, 51 LIBUSB_CLASS_HUB = 9, 52 LIBUSB_CLASS_DATA = 10, 53 LIBUSB_CLASS_VENDOR_SPEC = 0xff, 54 }; 55 56 enum libusb_descriptor_type { 57 LIBUSB_DT_DEVICE = 0x01, 58 LIBUSB_DT_CONFIG = 0x02, 59 LIBUSB_DT_STRING = 0x03, 60 LIBUSB_DT_INTERFACE = 0x04, 61 LIBUSB_DT_ENDPOINT = 0x05, 62 LIBUSB_DT_HID = 0x21, 63 LIBUSB_DT_REPORT = 0x22, 64 LIBUSB_DT_PHYSICAL = 0x23, 65 LIBUSB_DT_HUB = 0x29, 66 }; 67 68 #define LIBUSB_DT_DEVICE_SIZE 18 69 #define LIBUSB_DT_CONFIG_SIZE 9 70 #define LIBUSB_DT_INTERFACE_SIZE 9 71 #define LIBUSB_DT_ENDPOINT_SIZE 7 72 #define LIBUSB_DT_ENDPOINT_AUDIO_SIZE 9 73 #define LIBUSB_DT_HUB_NONVAR_SIZE 7 74 75 #define LIBUSB_ENDPOINT_ADDRESS_MASK 0x0f 76 #define LIBUSB_ENDPOINT_DIR_MASK 0x80 77 78 enum libusb_endpoint_direction { 79 LIBUSB_ENDPOINT_IN = 0x80, 80 LIBUSB_ENDPOINT_OUT = 0x00, 81 }; 82 83 #define LIBUSB_TRANSFER_TYPE_MASK 0x03 84 85 enum libusb_transfer_type { 86 LIBUSB_TRANSFER_TYPE_CONTROL = 0, 87 LIBUSB_TRANSFER_TYPE_ISOCHRONOUS = 1, 88 LIBUSB_TRANSFER_TYPE_BULK = 2, 89 LIBUSB_TRANSFER_TYPE_INTERRUPT = 3, 90 }; 91 92 enum libusb_standard_request { 93 LIBUSB_REQUEST_GET_STATUS = 0x00, 94 LIBUSB_REQUEST_CLEAR_FEATURE = 0x01, 95 LIBUSB_REQUEST_SET_FEATURE = 0x03, 96 LIBUSB_REQUEST_SET_ADDRESS = 0x05, 97 LIBUSB_REQUEST_GET_DESCRIPTOR = 0x06, 98 LIBUSB_REQUEST_SET_DESCRIPTOR = 0x07, 99 LIBUSB_REQUEST_GET_CONFIGURATION = 0x08, 100 LIBUSB_REQUEST_SET_CONFIGURATION = 0x09, 101 LIBUSB_REQUEST_GET_INTERFACE = 0x0A, 102 LIBUSB_REQUEST_SET_INTERFACE = 0x0B, 103 LIBUSB_REQUEST_SYNCH_FRAME = 0x0C, 104 }; 105 106 enum libusb_request_type { 107 LIBUSB_REQUEST_TYPE_STANDARD = (0x00 << 5), 108 LIBUSB_REQUEST_TYPE_CLASS = (0x01 << 5), 109 LIBUSB_REQUEST_TYPE_VENDOR = (0x02 << 5), 110 LIBUSB_REQUEST_TYPE_RESERVED = (0x03 << 5), 111 }; 112 113 enum libusb_request_recipient { 114 LIBUSB_RECIPIENT_DEVICE = 0x00, 115 LIBUSB_RECIPIENT_INTERFACE = 0x01, 116 LIBUSB_RECIPIENT_ENDPOINT = 0x02, 117 LIBUSB_RECIPIENT_OTHER = 0x03, 118 }; 119 120 #define LIBUSB_ISO_SYNC_TYPE_MASK 0x0C 121 122 enum libusb_iso_sync_type { 123 LIBUSB_ISO_SYNC_TYPE_NONE = 0, 124 LIBUSB_ISO_SYNC_TYPE_ASYNC = 1, 125 LIBUSB_ISO_SYNC_TYPE_ADAPTIVE = 2, 126 LIBUSB_ISO_SYNC_TYPE_SYNC = 3, 127 }; 128 129 #define LIBUSB_ISO_USAGE_TYPE_MASK 0x30 130 131 enum libusb_iso_usage_type { 132 LIBUSB_ISO_USAGE_TYPE_DATA = 0, 133 LIBUSB_ISO_USAGE_TYPE_FEEDBACK = 1, 134 LIBUSB_ISO_USAGE_TYPE_IMPLICIT = 2, 135 }; 136 137 enum libusb_error { 138 LIBUSB_SUCCESS = 0, 139 LIBUSB_ERROR_IO = -1, 140 LIBUSB_ERROR_INVALID_PARAM = -2, 141 LIBUSB_ERROR_ACCESS = -3, 142 LIBUSB_ERROR_NO_DEVICE = -4, 143 LIBUSB_ERROR_NOT_FOUND = -5, 144 LIBUSB_ERROR_BUSY = -6, 145 LIBUSB_ERROR_TIMEOUT = -7, 146 LIBUSB_ERROR_OVERFLOW = -8, 147 LIBUSB_ERROR_PIPE = -9, 148 LIBUSB_ERROR_INTERRUPTED = -10, 149 LIBUSB_ERROR_NO_MEM = -11, 150 LIBUSB_ERROR_NOT_SUPPORTED = -12, 151 LIBUSB_ERROR_OTHER = -99, 152 }; 153 154 enum libusb_transfer_status { 155 LIBUSB_TRANSFER_COMPLETED, 156 LIBUSB_TRANSFER_ERROR, 157 LIBUSB_TRANSFER_TIMED_OUT, 158 LIBUSB_TRANSFER_CANCELLED, 159 LIBUSB_TRANSFER_STALL, 160 LIBUSB_TRANSFER_NO_DEVICE, 161 LIBUSB_TRANSFER_OVERFLOW, 162 }; 163 164 enum libusb_transfer_flags { 165 LIBUSB_TRANSFER_SHORT_NOT_OK = 1 << 0, 166 LIBUSB_TRANSFER_FREE_BUFFER = 1 << 1, 167 LIBUSB_TRANSFER_FREE_TRANSFER = 1 << 2, 168 }; 169 170 enum libusb_debug_level { 171 LIBUSB_DEBUG_NO=0, 172 LIBUSB_DEBUG_FUNCTION=1, 173 LIBUSB_DEBUG_TRANSFER=2, 174 }; 175 176 /* libusb structures */ 177 178 struct libusb_context; 179 struct libusb_device; 180 struct libusb_transfer; 181 struct libusb_device_handle; 182 183 struct libusb_pollfd { 184 int fd; 185 short events; 186 }; 187 188 typedef struct libusb_context libusb_context; 189 typedef struct libusb_device libusb_device; 190 typedef struct libusb_device_handle libusb_device_handle; 191 typedef struct libusb_pollfd libusb_pollfd; 192 typedef void (*libusb_pollfd_added_cb) (int fd, short events, void *user_data); 193 typedef void (*libusb_pollfd_removed_cb) (int fd, void *user_data); 194 195 typedef struct libusb_device_descriptor { 196 uint8_t bLength; 197 uint8_t bDescriptorType; 198 uint16_t bcdUSB; 199 uint8_t bDeviceClass; 200 uint8_t bDeviceSubClass; 201 uint8_t bDeviceProtocol; 202 uint8_t bMaxPacketSize0; 203 uint16_t idVendor; 204 uint16_t idProduct; 205 uint16_t bcdDevice; 206 uint8_t iManufacturer; 207 uint8_t iProduct; 208 uint8_t iSerialNumber; 209 uint8_t bNumConfigurations; 210 } libusb_device_descriptor; 211 212 typedef struct libusb_endpoint_descriptor { 213 uint8_t bLength; 214 uint8_t bDescriptorType; 215 uint8_t bEndpointAddress; 216 uint8_t bmAttributes; 217 uint16_t wMaxPacketSize; 218 uint8_t bInterval; 219 uint8_t bRefresh; 220 uint8_t bSynchAddress; 221 uint8_t *extra; 222 int extra_length; 223 } libusb_endpoint_descriptor __aligned(sizeof(void *)); 224 225 typedef struct libusb_interface_descriptor { 226 uint8_t bLength; 227 uint8_t bDescriptorType; 228 uint8_t bInterfaceNumber; 229 uint8_t bAlternateSetting; 230 uint8_t bNumEndpoints; 231 uint8_t bInterfaceClass; 232 uint8_t bInterfaceSubClass; 233 uint8_t bInterfaceProtocol; 234 uint8_t iInterface; 235 struct libusb_endpoint_descriptor *endpoint; 236 uint8_t *extra; 237 int extra_length; 238 } libusb_interface_descriptor __aligned(sizeof(void *)); 239 240 typedef struct libusb_interface { 241 struct libusb_interface_descriptor *altsetting; 242 int num_altsetting; 243 } libusb_interface __aligned(sizeof(void *)); 244 245 typedef struct libusb_config_descriptor { 246 uint8_t bLength; 247 uint8_t bDescriptorType; 248 uint16_t wTotalLength; 249 uint8_t bNumInterfaces; 250 uint8_t bConfigurationValue; 251 uint8_t iConfiguration; 252 uint8_t bmAttributes; 253 uint8_t MaxPower; 254 struct libusb_interface *interface; 255 uint8_t *extra; 256 int extra_length; 257 } libusb_config_descriptor __aligned(sizeof(void *)); 258 259 typedef struct libusb_control_setup { 260 uint8_t bmRequestType; 261 uint8_t bRequest; 262 uint16_t wValue; 263 uint16_t wIndex; 264 uint16_t wLength; 265 } libusb_control_setup; 266 267 #define LIBUSB_CONTROL_SETUP_SIZE 8 /* bytes */ 268 269 typedef struct libusb_iso_packet_descriptor { 270 uint32_t length; 271 uint32_t actual_length; 272 enum libusb_transfer_status status; 273 } libusb_iso_packet_descriptor __aligned(sizeof(void *)); 274 275 typedef void (*libusb_transfer_cb_fn) (struct libusb_transfer *transfer); 276 277 typedef struct libusb_transfer { 278 libusb_device_handle *dev_handle; 279 uint8_t flags; 280 uint32_t endpoint; 281 uint8_t type; 282 uint32_t timeout; 283 enum libusb_transfer_status status; 284 int length; 285 int actual_length; 286 libusb_transfer_cb_fn callback; 287 void *user_data; 288 uint8_t *buffer; 289 void *os_priv; 290 int num_iso_packets; 291 struct libusb_iso_packet_descriptor iso_packet_desc[0]; 292 } libusb_transfer __aligned(sizeof(void *)); 293 294 /* Library initialisation */ 295 296 void libusb_set_debug(libusb_context * ctx, int level); 297 const char *libusb_strerror(int code); 298 int libusb_init(libusb_context ** context); 299 void libusb_exit(struct libusb_context *ctx); 300 301 /* Device handling and enumeration */ 302 303 ssize_t libusb_get_device_list(libusb_context * ctx, libusb_device *** list); 304 void libusb_free_device_list(libusb_device ** list, int unref_devices); 305 uint8_t libusb_get_bus_number(libusb_device * dev); 306 uint8_t libusb_get_device_address(libusb_device * dev); 307 int libusb_clear_halt(libusb_device_handle *devh, uint8_t endpoint); 308 int libusb_get_max_packet_size(libusb_device * dev, uint8_t endpoint); 309 libusb_device *libusb_ref_device(libusb_device * dev); 310 void libusb_unref_device(libusb_device * dev); 311 int libusb_open(libusb_device * dev, libusb_device_handle ** devh); 312 libusb_device_handle *libusb_open_device_with_vid_pid(libusb_context * ctx, uint16_t vendor_id, uint16_t product_id); 313 void libusb_close(libusb_device_handle * devh); 314 libusb_device *libusb_get_device(libusb_device_handle * devh); 315 int libusb_get_configuration(libusb_device_handle * devh, int *config); 316 int libusb_set_configuration(libusb_device_handle * devh, int configuration); 317 int libusb_claim_interface(libusb_device_handle * devh, int interface_number); 318 int libusb_release_interface(libusb_device_handle * devh, int interface_number); 319 int libusb_reset_device(libusb_device_handle * devh); 320 int libusb_check_connected(libusb_device_handle * devh); 321 int libusb_kernel_driver_active(libusb_device_handle * devh, int interface); 322 int libusb_get_driver_np(libusb_device_handle * devh, int interface, char *name, int namelen); 323 int libusb_get_driver(libusb_device_handle * devh, int interface, char *name, int namelen); 324 int libusb_detach_kernel_driver_np(libusb_device_handle * devh, int interface); 325 int libusb_detach_kernel_driver(libusb_device_handle * devh, int interface); 326 int libusb_attach_kernel_driver(libusb_device_handle * devh, int interface); 327 int libusb_set_interface_alt_setting(libusb_device_handle * devh, int interface_number, int alternate_setting); 328 329 /* USB Descriptors */ 330 331 int libusb_get_device_descriptor(libusb_device * dev, struct libusb_device_descriptor *desc); 332 int libusb_get_active_config_descriptor(libusb_device * dev, struct libusb_config_descriptor **config); 333 int libusb_get_config_descriptor(libusb_device * dev, uint8_t config_index, struct libusb_config_descriptor **config); 334 int libusb_get_config_descriptor_by_value(libusb_device * dev, uint8_t bConfigurationValue, struct libusb_config_descriptor **config); 335 void libusb_free_config_descriptor(struct libusb_config_descriptor *config); 336 int libusb_get_string_descriptor_ascii(libusb_device_handle * devh, uint8_t desc_index, uint8_t *data, int length); 337 int libusb_get_descriptor(libusb_device_handle * devh, uint8_t desc_type, uint8_t desc_index, uint8_t *data, int length); 338 339 /* Asynchronous device I/O */ 340 341 struct libusb_transfer *libusb_alloc_transfer(int iso_packets); 342 void libusb_free_transfer(struct libusb_transfer *transfer); 343 int libusb_submit_transfer(struct libusb_transfer *transfer); 344 int libusb_cancel_transfer(struct libusb_transfer *transfer); 345 uint8_t *libusb_get_iso_packet_buffer(struct libusb_transfer *transfer, uint32_t index); 346 uint8_t *libusb_get_iso_packet_buffer_simple(struct libusb_transfer *transfer, uint32_t index); 347 void libusb_set_iso_packet_lengths(struct libusb_transfer *transfer, uint32_t length); 348 uint8_t *libusb_control_transfer_get_data(struct libusb_transfer *transfer); 349 struct libusb_control_setup *libusb_control_transfer_get_setup(struct libusb_transfer *transfer); 350 void libusb_fill_control_setup(uint8_t *buf, uint8_t bmRequestType, uint8_t bRequest, uint16_t wValue, uint16_t wIndex, uint16_t wLength); 351 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); 352 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); 353 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); 354 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); 355 356 /* Polling and timing */ 357 358 int libusb_try_lock_events(libusb_context * ctx); 359 void libusb_lock_events(libusb_context * ctx); 360 void libusb_unlock_events(libusb_context * ctx); 361 int libusb_event_handling_ok(libusb_context * ctx); 362 int libusb_event_handler_active(libusb_context * ctx); 363 void libusb_lock_event_waiters(libusb_context * ctx); 364 void libusb_unlock_event_waiters(libusb_context * ctx); 365 int libusb_wait_for_event(libusb_context * ctx, struct timeval *tv); 366 int libusb_handle_events_timeout(libusb_context * ctx, struct timeval *tv); 367 int libusb_handle_events(libusb_context * ctx); 368 int libusb_handle_events_locked(libusb_context * ctx, struct timeval *tv); 369 int libusb_get_next_timeout(libusb_context * ctx, struct timeval *tv); 370 void libusb_set_pollfd_notifiers(libusb_context * ctx, libusb_pollfd_added_cb added_cb, libusb_pollfd_removed_cb removed_cb, void *user_data); 371 struct libusb_pollfd **libusb_get_pollfds(libusb_context * ctx); 372 373 /* Synchronous device I/O */ 374 375 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); 376 int libusb_bulk_transfer(libusb_device_handle * devh, uint8_t endpoint, uint8_t *data, int length, int *transferred, uint32_t timeout); 377 int libusb_interrupt_transfer(libusb_device_handle * devh, uint8_t endpoint, uint8_t *data, int length, int *transferred, uint32_t timeout); 378 379 /* Byte-order */ 380 381 uint16_t libusb_cpu_to_le16(uint16_t x); 382 uint16_t libusb_le16_to_cpu(uint16_t x); 383 384 #if 0 385 { /* indent fix */ 386 #endif 387 #ifdef __cplusplus 388 } 389 390 #endif 391 392 #endif /* __LIBUSB_H__ */ 393