libusb20.h revision 185087
1/* $FreeBSD: head/lib/libusb20/libusb20.h 185087 2008-11-19 08:56:35Z alfred $ */ 2/*- 3 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 4 * Copyright (c) 2007-2008 Daniel Drake. All rights reserved. 5 * Copyright (c) 2001 Johannes Erdfelt. 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 _LIBUSB20_H_ 30#define _LIBUSB20_H_ 31 32#include <stdint.h> 33#include <time.h> 34#include <string.h> 35 36#include <sys/time.h> 37#include <sys/types.h> 38#include <sys/endian.h> 39 40#ifdef __cplusplus 41extern "C" { 42#endif 43#if 0 44}; /* style */ 45 46#endif 47 48/** \ingroup misc 49 * Error codes. Most libusb20 functions return 0 on success or one of 50 * these codes on failure. 51 */ 52enum libusb20_error { 53 /** Success (no error) */ 54 LIBUSB20_SUCCESS = 0, 55 56 /** Input/output error */ 57 LIBUSB20_ERROR_IO = -1, 58 59 /** Invalid parameter */ 60 LIBUSB20_ERROR_INVALID_PARAM = -2, 61 62 /** Access denied (insufficient permissions) */ 63 LIBUSB20_ERROR_ACCESS = -3, 64 65 /** No such device (it may have been disconnected) */ 66 LIBUSB20_ERROR_NO_DEVICE = -4, 67 68 /** Entity not found */ 69 LIBUSB20_ERROR_NOT_FOUND = -5, 70 71 /** Resource busy */ 72 LIBUSB20_ERROR_BUSY = -6, 73 74 /** Operation timed out */ 75 LIBUSB20_ERROR_TIMEOUT = -7, 76 77 /** Overflow */ 78 LIBUSB20_ERROR_OVERFLOW = -8, 79 80 /** Pipe error */ 81 LIBUSB20_ERROR_PIPE = -9, 82 83 /** System call interrupted (perhaps due to signal) */ 84 LIBUSB20_ERROR_INTERRUPTED = -10, 85 86 /** Insufficient memory */ 87 LIBUSB20_ERROR_NO_MEM = -11, 88 89 /** Operation not supported or unimplemented on this platform */ 90 LIBUSB20_ERROR_NOT_SUPPORTED = -12, 91 92 /** Other error */ 93 LIBUSB20_ERROR_OTHER = -99, 94}; 95 96/** \ingroup asyncio 97 * libusb20_tr_get_status() values */ 98enum libusb20_transfer_status { 99 /** Transfer completed without error. Note that this does not 100 * indicate that the entire amount of requested data was 101 * transferred. */ 102 LIBUSB20_TRANSFER_COMPLETED, 103 104 /** Callback code to start transfer */ 105 LIBUSB20_TRANSFER_START, 106 107 /** Drain complete callback code */ 108 LIBUSB20_TRANSFER_DRAINED, 109 110 /** Transfer failed */ 111 LIBUSB20_TRANSFER_ERROR, 112 113 /** Transfer timed out */ 114 LIBUSB20_TRANSFER_TIMED_OUT, 115 116 /** Transfer was cancelled */ 117 LIBUSB20_TRANSFER_CANCELLED, 118 119 /** For bulk/interrupt endpoints: halt condition detected 120 * (endpoint stalled). For control endpoints: control request 121 * not supported. */ 122 LIBUSB20_TRANSFER_STALL, 123 124 /** Device was disconnected */ 125 LIBUSB20_TRANSFER_NO_DEVICE, 126 127 /** Device sent more data than requested */ 128 LIBUSB20_TRANSFER_OVERFLOW, 129}; 130 131/** \ingroup asyncio 132 * libusb20_tr_set_flags() values */ 133enum libusb20_transfer_flags { 134 /** Report a short frame as error */ 135 LIBUSB20_TRANSFER_SINGLE_SHORT_NOT_OK = 0x0001, 136 137 /** Multiple short frames are not allowed */ 138 LIBUSB20_TRANSFER_MULTI_SHORT_NOT_OK = 0x0002, 139 140 /** All transmitted frames are short terminated */ 141 LIBUSB20_TRANSFER_FORCE_SHORT = 0x0004, 142 143 /** Will do a clear-stall before xfer */ 144 LIBUSB20_TRANSFER_DO_CLEAR_STALL = 0x0008, 145}; 146 147/** \ingroup misc 148 * libusb20_dev_get_mode() values 149 */ 150enum libusb20_device_mode { 151 LIBUSB20_MODE_HOST, /* default */ 152 LIBUSB20_MODE_DEVICE, 153}; 154 155/** \ingroup misc 156 * libusb20_dev_get_speed() values 157 */ 158enum { 159 LIBUSB20_SPEED_UNKNOWN, /* default */ 160 LIBUSB20_SPEED_LOW, 161 LIBUSB20_SPEED_FULL, 162 LIBUSB20_SPEED_HIGH, 163 LIBUSB20_SPEED_VARIABLE, 164 LIBUSB20_SPEED_SUPER, 165}; 166 167/** \ingroup misc 168 * libusb20_dev_set_power() values 169 */ 170enum { 171 LIBUSB20_POWER_OFF, 172 LIBUSB20_POWER_ON, 173 LIBUSB20_POWER_SAVE, 174 LIBUSB20_POWER_SUSPEND, 175 LIBUSB20_POWER_RESUME, 176}; 177 178struct libusb20_transfer; 179struct libusb20_backend; 180struct libusb20_backend_methods; 181struct libusb20_device; 182struct libusb20_device_methods; 183struct libusb20_config; 184struct LIBUSB20_CONTROL_SETUP_DECODED; 185struct LIBUSB20_DEVICE_DESC_DECODED; 186 187typedef void (libusb20_tr_callback_t)(struct libusb20_transfer *xfer); 188 189struct libusb20_quirk { 190 uint16_t vid; /* vendor ID */ 191 uint16_t pid; /* product ID */ 192 uint16_t bcdDeviceLow; /* low revision value, inclusive */ 193 uint16_t bcdDeviceHigh; /* high revision value, inclusive */ 194 uint16_t reserved[2]; /* for the future */ 195 /* quirk name, UQ_XXX, including terminating zero */ 196 char quirkname[64 - 12]; 197}; 198 199/* USB transfer operations */ 200 201int libusb20_tr_close(struct libusb20_transfer *xfer); 202int libusb20_tr_open(struct libusb20_transfer *xfer, uint32_t max_buf_size, uint32_t max_frame_count, uint8_t ep_no); 203struct libusb20_transfer *libusb20_tr_get_pointer(struct libusb20_device *pdev, uint16_t tr_index); 204uint16_t libusb20_tr_get_time_complete(struct libusb20_transfer *xfer); 205uint32_t libusb20_tr_get_actual_frames(struct libusb20_transfer *xfer); 206uint32_t libusb20_tr_get_actual_length(struct libusb20_transfer *xfer); 207uint32_t libusb20_tr_get_max_frames(struct libusb20_transfer *xfer); 208uint32_t libusb20_tr_get_max_packet_length(struct libusb20_transfer *xfer); 209uint32_t libusb20_tr_get_max_total_length(struct libusb20_transfer *xfer); 210uint8_t libusb20_tr_get_status(struct libusb20_transfer *xfer); 211uint8_t libusb20_tr_pending(struct libusb20_transfer *xfer); 212void libusb20_tr_callback_wrapper(struct libusb20_transfer *xfer); 213void libusb20_tr_clear_stall_sync(struct libusb20_transfer *xfer); 214void libusb20_tr_drain(struct libusb20_transfer *xfer); 215void libusb20_tr_set_buffer(struct libusb20_transfer *xfer, void *buffer, uint16_t fr_index); 216void libusb20_tr_set_callback(struct libusb20_transfer *xfer, libusb20_tr_callback_t *cb); 217void libusb20_tr_set_flags(struct libusb20_transfer *xfer, uint8_t flags); 218void libusb20_tr_set_length(struct libusb20_transfer *xfer, uint32_t length, uint16_t fr_index); 219void libusb20_tr_set_priv_sc0(struct libusb20_transfer *xfer, void *sc0); 220void libusb20_tr_set_priv_sc1(struct libusb20_transfer *xfer, void *sc1); 221void libusb20_tr_set_timeout(struct libusb20_transfer *xfer, uint32_t timeout); 222void libusb20_tr_set_total_frames(struct libusb20_transfer *xfer, uint32_t nFrames); 223void libusb20_tr_setup_bulk(struct libusb20_transfer *xfer, void *pbuf, uint32_t length, uint32_t timeout); 224void libusb20_tr_setup_control(struct libusb20_transfer *xfer, void *psetup, void *pbuf, uint32_t timeout); 225void libusb20_tr_setup_intr(struct libusb20_transfer *xfer, void *pbuf, uint32_t length, uint32_t timeout); 226void libusb20_tr_setup_isoc(struct libusb20_transfer *xfer, void *pbuf, uint32_t length, uint16_t fr_index); 227void libusb20_tr_start(struct libusb20_transfer *xfer); 228void libusb20_tr_stop(struct libusb20_transfer *xfer); 229void libusb20_tr_submit(struct libusb20_transfer *xfer); 230void *libusb20_tr_get_priv_sc0(struct libusb20_transfer *xfer); 231void *libusb20_tr_get_priv_sc1(struct libusb20_transfer *xfer); 232 233 234/* USB device operations */ 235 236const char *libusb20_dev_get_backend_name(struct libusb20_device *pdev); 237const char *libusb20_dev_get_desc(struct libusb20_device *pdev); 238int libusb20_dev_claim_interface(struct libusb20_device *pdev, uint8_t iface_index); 239int libusb20_dev_close(struct libusb20_device *pdev); 240int libusb20_dev_detach_kernel_driver(struct libusb20_device *pdev, uint8_t iface_index); 241int libusb20_dev_set_config_index(struct libusb20_device *pdev, uint8_t configIndex); 242int libusb20_dev_get_debug(struct libusb20_device *pdev); 243int libusb20_dev_get_fd(struct libusb20_device *pdev); 244int libusb20_dev_kernel_driver_active(struct libusb20_device *pdev, uint8_t iface_index); 245int libusb20_dev_open(struct libusb20_device *pdev, uint16_t transfer_max); 246int libusb20_dev_process(struct libusb20_device *pdev); 247int libusb20_dev_release_interface(struct libusb20_device *pdev, uint8_t iface_index); 248int 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); 249int libusb20_dev_req_string_sync(struct libusb20_device *pdev, uint8_t index, uint16_t langid, void *ptr, uint16_t len); 250int libusb20_dev_req_string_simple_sync(struct libusb20_device *pdev, uint8_t index, void *ptr, uint16_t len); 251int libusb20_dev_reset(struct libusb20_device *pdev); 252int libusb20_dev_set_power_mode(struct libusb20_device *pdev, uint8_t power_mode); 253uint8_t libusb20_dev_get_power_mode(struct libusb20_device *pdev); 254int libusb20_dev_set_alt_index(struct libusb20_device *pdev, uint8_t iface_index, uint8_t alt_index); 255int libusb20_dev_set_owner(struct libusb20_device *pdev, uid_t user, gid_t group); 256int libusb20_dev_set_perm(struct libusb20_device *pdev, mode_t mode); 257int libusb20_dev_set_iface_owner(struct libusb20_device *pdev, uint8_t iface_index, uid_t user, gid_t group); 258int libusb20_dev_set_iface_perm(struct libusb20_device *pdev, uint8_t iface_index, mode_t mode); 259int libusb20_dev_get_owner(struct libusb20_device *pdev, uid_t *user, gid_t *group); 260int libusb20_dev_get_perm(struct libusb20_device *pdev, mode_t *mode); 261int libusb20_dev_get_iface_owner(struct libusb20_device *pdev, uint8_t iface_index, uid_t *user, gid_t *group); 262int libusb20_dev_get_iface_perm(struct libusb20_device *pdev, uint8_t iface_index, mode_t *mode); 263 264struct LIBUSB20_DEVICE_DESC_DECODED *libusb20_dev_get_device_desc(struct libusb20_device *pdev); 265struct libusb20_config *libusb20_dev_alloc_config(struct libusb20_device *pdev, uint8_t config_index); 266struct libusb20_device *libusb20_dev_alloc(void); 267uint8_t libusb20_dev_get_address(struct libusb20_device *pdev); 268uint8_t libusb20_dev_get_bus_number(struct libusb20_device *pdev); 269uint8_t libusb20_dev_get_mode(struct libusb20_device *pdev); 270uint8_t libusb20_dev_get_speed(struct libusb20_device *pdev); 271uint8_t libusb20_dev_get_config_index(struct libusb20_device *pdev); 272void libusb20_dev_free(struct libusb20_device *pdev); 273void libusb20_dev_set_debug(struct libusb20_device *pdev, int debug); 274void libusb20_dev_wait_process(struct libusb20_device *pdev, int timeout); 275 276/* USB bus operations */ 277 278int libusb20_bus_set_owner(struct libusb20_backend *pbe, uint8_t bus, uid_t user, gid_t group); 279int libusb20_bus_set_perm(struct libusb20_backend *pbe, uint8_t bus, mode_t mode); 280int libusb20_bus_get_owner(struct libusb20_backend *pbe, uint8_t bus, uid_t *user, gid_t *group); 281int libusb20_bus_get_perm(struct libusb20_backend *pbe, uint8_t bus, mode_t *mode); 282 283/* USB global operations */ 284 285int libusb20_be_get_dev_quirk(struct libusb20_backend *pbe, uint16_t index, struct libusb20_quirk *pq); 286int libusb20_be_get_quirk_name(struct libusb20_backend *pbe, uint16_t index, struct libusb20_quirk *pq); 287int libusb20_be_add_dev_quirk(struct libusb20_backend *pbe, struct libusb20_quirk *pq); 288int libusb20_be_remove_dev_quirk(struct libusb20_backend *pbe, struct libusb20_quirk *pq); 289int libusb20_be_set_owner(struct libusb20_backend *be, uid_t user, gid_t group); 290int libusb20_be_set_perm(struct libusb20_backend *be, mode_t mode); 291int libusb20_be_get_owner(struct libusb20_backend *be, uid_t *user, gid_t *group); 292int libusb20_be_get_perm(struct libusb20_backend *be, mode_t *mode); 293 294/* USB backend operations */ 295 296struct libusb20_backend *libusb20_be_alloc(const struct libusb20_backend_methods *methods); 297struct libusb20_backend *libusb20_be_alloc_default(void); 298struct libusb20_backend *libusb20_be_alloc_freebsd(void); 299struct libusb20_backend *libusb20_be_alloc_linux(void); 300struct libusb20_backend *libusb20_be_alloc_ugen20(void); 301struct libusb20_device *libusb20_be_device_foreach(struct libusb20_backend *pbe, struct libusb20_device *pdev); 302void libusb20_be_dequeue_device(struct libusb20_backend *pbe, struct libusb20_device *pdev); 303void libusb20_be_enqueue_device(struct libusb20_backend *pbe, struct libusb20_device *pdev); 304void libusb20_be_free(struct libusb20_backend *pbe); 305 306#if 0 307{ /* style */ 308#endif 309#ifdef __cplusplus 310} 311 312#endif 313 314#endif /* _LIBUSB20_H_ */ 315