libusb20.h revision 193313
1151497Sru/* $FreeBSD: head/lib/libusb/libusb20.h 193313 2009-06-02 17:27:51Z thompsa $ */ 275584Sru/*- 375584Sru * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 475584Sru * Copyright (c) 2007-2008 Daniel Drake. All rights reserved. 575584Sru * Copyright (c) 2001 Johannes Erdfelt. All rights reserved. 675584Sru * 775584Sru * Redistribution and use in source and binary forms, with or without 875584Sru * modification, are permitted provided that the following conditions 975584Sru * are met: 10151497Sru * 1. Redistributions of source code must retain the above copyright 11151497Sru * notice, this list of conditions and the following disclaimer. 12151497Sru * 2. Redistributions in binary form must reproduce the above copyright 13151497Sru * notice, this list of conditions and the following disclaimer in the 14151497Sru * documentation and/or other materials provided with the distribution. 15151497Sru * 16151497Sru * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17151497Sru * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18151497Sru * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19151497Sru * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20151497Sru * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21151497Sru * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22151497Sru * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23151497Sru * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24151497Sru * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25151497Sru * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26151497Sru * SUCH DAMAGE. 27151497Sru */ 28151497Sru 29151497Sru#ifndef _LIBUSB20_H_ 30151497Sru#define _LIBUSB20_H_ 31151497Sru 32151497Sru#include <stdint.h> 33151497Sru#include <time.h> 34151497Sru#include <string.h> 35151497Sru 36151497Sru#include <sys/time.h> 37151497Sru#include <sys/types.h> 38151497Sru#include <sys/endian.h> 39151497Sru 40151497Sru#ifdef __cplusplus 41151497Sruextern "C" { 42151497Sru#endif 43151497Sru#if 0 44151497Sru}; /* style */ 45151497Sru 46151497Sru#endif 47151497Sru 48151497Sru/** \ingroup misc 49151497Sru * Error codes. Most libusb20 functions return 0 on success or one of 50151497Sru * these codes on failure. 51151497Sru */ 52151497Sruenum libusb20_error { 53151497Sru /** Success (no error) */ 54151497Sru LIBUSB20_SUCCESS = 0, 55151497Sru 56151497Sru /** Input/output error */ 57151497Sru LIBUSB20_ERROR_IO = -1, 58151497Sru 59151497Sru /** Invalid parameter */ 60151497Sru LIBUSB20_ERROR_INVALID_PARAM = -2, 61151497Sru 62151497Sru /** Access denied (insufficient permissions) */ 63151497Sru LIBUSB20_ERROR_ACCESS = -3, 64151497Sru 65151497Sru /** No such device (it may have been disconnected) */ 66151497Sru LIBUSB20_ERROR_NO_DEVICE = -4, 67151497Sru 68151497Sru /** Entity not found */ 69151497Sru LIBUSB20_ERROR_NOT_FOUND = -5, 70151497Sru 71151497Sru /** Resource busy */ 72151497Sru LIBUSB20_ERROR_BUSY = -6, 73151497Sru 74151497Sru /** Operation timed out */ 75151497Sru LIBUSB20_ERROR_TIMEOUT = -7, 76151497Sru 77151497Sru /** Overflow */ 78151497Sru LIBUSB20_ERROR_OVERFLOW = -8, 79151497Sru 80151497Sru /** Pipe error */ 81151497Sru LIBUSB20_ERROR_PIPE = -9, 82151497Sru 83151497Sru /** System call interrupted (perhaps due to signal) */ 84151497Sru LIBUSB20_ERROR_INTERRUPTED = -10, 85151497Sru 86151497Sru /** Insufficient memory */ 87151497Sru LIBUSB20_ERROR_NO_MEM = -11, 88151497Sru 89151497Sru /** Operation not supported or unimplemented on this platform */ 90151497Sru LIBUSB20_ERROR_NOT_SUPPORTED = -12, 91151497Sru 92151497Sru /** Other error */ 93151497Sru LIBUSB20_ERROR_OTHER = -99, 94151497Sru}; 95151497Sru 96151497Sru/** \ingroup asyncio 97151497Sru * libusb20_tr_get_status() values */ 98151497Sruenum libusb20_transfer_status { 99151497Sru /** Transfer completed without error. Note that this does not 100151497Sru * indicate that the entire amount of requested data was 101151497Sru * transferred. */ 102151497Sru LIBUSB20_TRANSFER_COMPLETED, 103151497Sru 104151497Sru /** Callback code to start transfer */ 105151497Sru LIBUSB20_TRANSFER_START, 106151497Sru 107151497Sru /** Drain complete callback code */ 108151497Sru LIBUSB20_TRANSFER_DRAINED, 109151497Sru 110151497Sru /** Transfer failed */ 111151497Sru LIBUSB20_TRANSFER_ERROR, 112151497Sru 113151497Sru /** Transfer timed out */ 114151497Sru LIBUSB20_TRANSFER_TIMED_OUT, 115151497Sru 116151497Sru /** Transfer was cancelled */ 117151497Sru LIBUSB20_TRANSFER_CANCELLED, 118151497Sru 119151497Sru /** For bulk/interrupt endpoints: halt condition detected 120151497Sru * (endpoint stalled). For control endpoints: control request 121151497Sru * not supported. */ 122151497Sru LIBUSB20_TRANSFER_STALL, 123151497Sru 124151497Sru /** Device was disconnected */ 125151497Sru LIBUSB20_TRANSFER_NO_DEVICE, 126151497Sru 127151497Sru /** Device sent more data than requested */ 128151497Sru LIBUSB20_TRANSFER_OVERFLOW, 129151497Sru}; 130151497Sru 131151497Sru/** \ingroup asyncio 132151497Sru * libusb20_tr_set_flags() values */ 133151497Sruenum libusb20_transfer_flags { 134151497Sru /** Report a short frame as error */ 135151497Sru LIBUSB20_TRANSFER_SINGLE_SHORT_NOT_OK = 0x0001, 136151497Sru 137151497Sru /** Multiple short frames are not allowed */ 138151497Sru LIBUSB20_TRANSFER_MULTI_SHORT_NOT_OK = 0x0002, 139151497Sru 140151497Sru /** All transmitted frames are short terminated */ 141151497Sru LIBUSB20_TRANSFER_FORCE_SHORT = 0x0004, 142151497Sru 143151497Sru /** Will do a clear-stall before xfer */ 144151497Sru LIBUSB20_TRANSFER_DO_CLEAR_STALL = 0x0008, 145151497Sru}; 146151497Sru 147151497Sru/** \ingroup misc 148151497Sru * libusb20_dev_get_mode() values 149151497Sru */ 150151497Sruenum libusb20_device_mode { 151151497Sru LIBUSB20_MODE_HOST, /* default */ 152151497Sru LIBUSB20_MODE_DEVICE, 153151497Sru}; 154151497Sru 155151497Sru/** \ingroup misc 156151497Sru * libusb20_dev_get_speed() values 157151497Sru */ 158151497Sruenum { 159151497Sru LIBUSB20_SPEED_UNKNOWN, /* default */ 160151497Sru LIBUSB20_SPEED_LOW, 161151497Sru LIBUSB20_SPEED_FULL, 162151497Sru LIBUSB20_SPEED_HIGH, 163151497Sru LIBUSB20_SPEED_VARIABLE, 164151497Sru LIBUSB20_SPEED_SUPER, 165151497Sru}; 166151497Sru 167151497Sru/** \ingroup misc 168151497Sru * libusb20_dev_set_power() values 169151497Sru */ 170151497Sruenum { 171151497Sru LIBUSB20_POWER_OFF, 172151497Sru LIBUSB20_POWER_ON, 173151497Sru LIBUSB20_POWER_SAVE, 174151497Sru LIBUSB20_POWER_SUSPEND, 175151497Sru LIBUSB20_POWER_RESUME, 176151497Sru}; 177151497Sru 178151497Srustruct usb_device_info; 179151497Srustruct libusb20_transfer; 180151497Srustruct libusb20_backend; 181151497Srustruct libusb20_backend_methods; 182151497Srustruct libusb20_device; 183151497Srustruct libusb20_device_methods; 184151497Srustruct libusb20_config; 185151497Srustruct LIBUSB20_CONTROL_SETUP_DECODED; 186151497Srustruct LIBUSB20_DEVICE_DESC_DECODED; 187151497Sru 188151497Srutypedef void (libusb20_tr_callback_t)(struct libusb20_transfer *xfer); 189151497Sru 190151497Srustruct libusb20_quirk { 191151497Sru uint16_t vid; /* vendor ID */ 192151497Sru uint16_t pid; /* product ID */ 193151497Sru uint16_t bcdDeviceLow; /* low revision value, inclusive */ 194151497Sru uint16_t bcdDeviceHigh; /* high revision value, inclusive */ 195151497Sru uint16_t reserved[2]; /* for the future */ 196151497Sru /* quirk name, UQ_XXX, including terminating zero */ 197151497Sru char quirkname[64 - 12]; 198151497Sru}; 199151497Sru 200151497Sru/* USB transfer operations */ 201151497Sru 202151497Sruint libusb20_tr_close(struct libusb20_transfer *xfer); 203151497Sruint libusb20_tr_open(struct libusb20_transfer *xfer, uint32_t max_buf_size, uint32_t max_frame_count, uint8_t ep_no); 204151497Srustruct libusb20_transfer *libusb20_tr_get_pointer(struct libusb20_device *pdev, uint16_t tr_index); 205151497Sruuint16_t libusb20_tr_get_time_complete(struct libusb20_transfer *xfer); 206151497Sruuint32_t libusb20_tr_get_actual_frames(struct libusb20_transfer *xfer); 207151497Sruuint32_t libusb20_tr_get_actual_length(struct libusb20_transfer *xfer); 208151497Sruuint32_t libusb20_tr_get_max_frames(struct libusb20_transfer *xfer); 209151497Sruuint32_t libusb20_tr_get_max_packet_length(struct libusb20_transfer *xfer); 210151497Sruuint32_t libusb20_tr_get_max_total_length(struct libusb20_transfer *xfer); 211151497Sruuint8_t libusb20_tr_get_status(struct libusb20_transfer *xfer); 212151497Sruuint8_t libusb20_tr_pending(struct libusb20_transfer *xfer); 213151497Sruvoid libusb20_tr_callback_wrapper(struct libusb20_transfer *xfer); 214151497Sruvoid libusb20_tr_clear_stall_sync(struct libusb20_transfer *xfer); 215151497Sruvoid libusb20_tr_drain(struct libusb20_transfer *xfer); 216151497Sruvoid libusb20_tr_set_buffer(struct libusb20_transfer *xfer, void *buffer, uint16_t fr_index); 217151497Sruvoid libusb20_tr_set_callback(struct libusb20_transfer *xfer, libusb20_tr_callback_t *cb); 218151497Sruvoid libusb20_tr_set_flags(struct libusb20_transfer *xfer, uint8_t flags); 219151497Sruuint32_t libusb20_tr_get_length(struct libusb20_transfer *xfer, uint16_t fr_index); 220151497Sruvoid libusb20_tr_set_length(struct libusb20_transfer *xfer, uint32_t length, uint16_t fr_index); 221151497Sruvoid libusb20_tr_set_priv_sc0(struct libusb20_transfer *xfer, void *sc0); 222151497Sruvoid libusb20_tr_set_priv_sc1(struct libusb20_transfer *xfer, void *sc1); 223151497Sruvoid libusb20_tr_set_timeout(struct libusb20_transfer *xfer, uint32_t timeout); 224151497Sruvoid libusb20_tr_set_total_frames(struct libusb20_transfer *xfer, uint32_t nFrames); 225151497Sruvoid libusb20_tr_setup_bulk(struct libusb20_transfer *xfer, void *pbuf, uint32_t length, uint32_t timeout); 226151497Sruvoid libusb20_tr_setup_control(struct libusb20_transfer *xfer, void *psetup, void *pbuf, uint32_t timeout); 227151497Sruvoid libusb20_tr_setup_intr(struct libusb20_transfer *xfer, void *pbuf, uint32_t length, uint32_t timeout); 228151497Sruvoid libusb20_tr_setup_isoc(struct libusb20_transfer *xfer, void *pbuf, uint32_t length, uint16_t fr_index); 229151497Sruvoid libusb20_tr_start(struct libusb20_transfer *xfer); 230151497Sruvoid libusb20_tr_stop(struct libusb20_transfer *xfer); 231151497Sruvoid libusb20_tr_submit(struct libusb20_transfer *xfer); 232151497Sruvoid *libusb20_tr_get_priv_sc0(struct libusb20_transfer *xfer); 233151497Sruvoid *libusb20_tr_get_priv_sc1(struct libusb20_transfer *xfer); 234151497Sru 235151497Sru 236151497Sru/* USB device operations */ 237151497Sru 238151497Sruconst char *libusb20_dev_get_backend_name(struct libusb20_device *pdev); 239151497Sruconst char *libusb20_dev_get_desc(struct libusb20_device *pdev); 240151497Sruint libusb20_dev_claim_interface(struct libusb20_device *pdev, uint8_t iface_index); 241151497Sruint libusb20_dev_close(struct libusb20_device *pdev); 242151497Sruint libusb20_dev_detach_kernel_driver(struct libusb20_device *pdev, uint8_t iface_index); 243151497Sruint libusb20_dev_set_config_index(struct libusb20_device *pdev, uint8_t configIndex); 244151497Sruint libusb20_dev_get_debug(struct libusb20_device *pdev); 245151497Sruint libusb20_dev_get_fd(struct libusb20_device *pdev); 246151497Sruint libusb20_dev_kernel_driver_active(struct libusb20_device *pdev, uint8_t iface_index); 247151497Sruint libusb20_dev_open(struct libusb20_device *pdev, uint16_t transfer_max); 248151497Sruint libusb20_dev_process(struct libusb20_device *pdev); 249151497Sruint libusb20_dev_release_interface(struct libusb20_device *pdev, uint8_t iface_index); 250151497Sruint libusb20_dev_request_sync(struct libusb20_device *pdev, struct LIBUSB20_CONTROL_SETUP_DECODED *setup, void *data, uint16_t *pactlen, uint32_t timeout, uint8_t flags); 251151497Sruint libusb20_dev_req_string_sync(struct libusb20_device *pdev, uint8_t index, uint16_t langid, void *ptr, uint16_t len); 252151497Sruint libusb20_dev_req_string_simple_sync(struct libusb20_device *pdev, uint8_t index, void *ptr, uint16_t len); 253151497Sruint libusb20_dev_reset(struct libusb20_device *pdev); 254151497Sruint libusb20_dev_set_power_mode(struct libusb20_device *pdev, uint8_t power_mode); 255151497Sruuint8_t libusb20_dev_get_power_mode(struct libusb20_device *pdev); 256151497Sruint libusb20_dev_set_alt_index(struct libusb20_device *pdev, uint8_t iface_index, uint8_t alt_index); 257151497Sruint libusb20_dev_get_info(struct libusb20_device *pdev, struct usb_device_info *pinfo); 258151497Sruint libusb20_dev_get_iface_desc(struct libusb20_device *pdev, uint8_t iface_index, char *buf, uint8_t len); 259151497Sru 260151497Srustruct LIBUSB20_DEVICE_DESC_DECODED *libusb20_dev_get_device_desc(struct libusb20_device *pdev); 261151497Srustruct libusb20_config *libusb20_dev_alloc_config(struct libusb20_device *pdev, uint8_t config_index); 262151497Srustruct libusb20_device *libusb20_dev_alloc(void); 263151497Sruuint8_t libusb20_dev_get_address(struct libusb20_device *pdev); 264151497Sruuint8_t libusb20_dev_get_bus_number(struct libusb20_device *pdev); 265151497Sruuint8_t libusb20_dev_get_mode(struct libusb20_device *pdev); 266151497Sruuint8_t libusb20_dev_get_speed(struct libusb20_device *pdev); 267151497Sruuint8_t libusb20_dev_get_config_index(struct libusb20_device *pdev); 268151497Sruvoid libusb20_dev_free(struct libusb20_device *pdev); 269151497Sruvoid libusb20_dev_set_debug(struct libusb20_device *pdev, int debug); 270151497Sruvoid libusb20_dev_wait_process(struct libusb20_device *pdev, int timeout); 271151497Sru 272151497Sru/* USB global operations */ 273151497Sru 274151497Sruint libusb20_be_get_dev_quirk(struct libusb20_backend *pbe, uint16_t index, struct libusb20_quirk *pq); 275151497Sruint libusb20_be_get_quirk_name(struct libusb20_backend *pbe, uint16_t index, struct libusb20_quirk *pq); 276151497Sruint libusb20_be_add_dev_quirk(struct libusb20_backend *pbe, struct libusb20_quirk *pq); 277151497Sruint libusb20_be_remove_dev_quirk(struct libusb20_backend *pbe, struct libusb20_quirk *pq); 278151497Sruint libusb20_be_get_template(struct libusb20_backend *pbe, int *ptemp); 279151497Sruint libusb20_be_set_template(struct libusb20_backend *pbe, int temp); 280151497Sru 281151497Sru/* USB backend operations */ 282151497Sru 283151497Srustruct libusb20_backend *libusb20_be_alloc(const struct libusb20_backend_methods *methods); 284151497Srustruct libusb20_backend *libusb20_be_alloc_default(void); 285151497Srustruct libusb20_backend *libusb20_be_alloc_freebsd(void); 286151497Srustruct libusb20_backend *libusb20_be_alloc_linux(void); 287151497Srustruct libusb20_backend *libusb20_be_alloc_ugen20(void); 288151497Srustruct libusb20_device *libusb20_be_device_foreach(struct libusb20_backend *pbe, struct libusb20_device *pdev); 289151497Sruvoid libusb20_be_dequeue_device(struct libusb20_backend *pbe, struct libusb20_device *pdev); 290151497Sruvoid libusb20_be_enqueue_device(struct libusb20_backend *pbe, struct libusb20_device *pdev); 291151497Sruvoid libusb20_be_free(struct libusb20_backend *pbe); 292151497Sru 293151497Sru#if 0 294151497Sru{ /* style */ 295151497Sru#endif 296151497Sru#ifdef __cplusplus 297151497Sru} 298151497Sru 299151497Sru#endif 300151497Sru 301151497Sru#endif /* _LIBUSB20_H_ */ 302151497Sru