libusb20_int.h revision 223495
1184610Salfred/* $FreeBSD: head/lib/libusb/libusb20_int.h 223495 2011-06-24 11:14:09Z hselasky $ */ 2184610Salfred/*- 3184610Salfred * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 4184610Salfred * 5184610Salfred * Redistribution and use in source and binary forms, with or without 6184610Salfred * modification, are permitted provided that the following conditions 7184610Salfred * are met: 8184610Salfred * 1. Redistributions of source code must retain the above copyright 9184610Salfred * notice, this list of conditions and the following disclaimer. 10184610Salfred * 2. Redistributions in binary form must reproduce the above copyright 11184610Salfred * notice, this list of conditions and the following disclaimer in the 12184610Salfred * documentation and/or other materials provided with the distribution. 13184610Salfred * 14184610Salfred * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15184610Salfred * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16184610Salfred * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17184610Salfred * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18184610Salfred * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19184610Salfred * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20184610Salfred * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21184610Salfred * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22184610Salfred * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23184610Salfred * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24184610Salfred * SUCH DAMAGE. 25184610Salfred */ 26184610Salfred 27184610Salfred/* 28184610Salfred * This file describes internal structures. 29184610Salfred */ 30184610Salfred 31184610Salfred#ifndef _LIBUSB20_INT_H_ 32184610Salfred#define _LIBUSB20_INT_H_ 33184610Salfred 34213852Shselasky#ifdef COMPAT_32BIT 35213852Shselasky#define libusb20_pass_ptr(ptr) ((uint64_t)(uintptr_t)(ptr)) 36213852Shselasky#else 37213852Shselasky#define libusb20_pass_ptr(ptr) (ptr) 38213852Shselasky#endif 39213852Shselasky 40184610Salfredstruct libusb20_device; 41184610Salfredstruct libusb20_backend; 42184610Salfredstruct libusb20_transfer; 43184610Salfredstruct libusb20_quirk; 44184610Salfred 45184610Salfredunion libusb20_session_data { 46184610Salfred unsigned long session_data; 47184610Salfred struct timespec tv; 48184610Salfred uint32_t plugtime; 49184610Salfred}; 50184610Salfred 51184610Salfred/* USB backend specific */ 52184610Salfredtypedef const char *(libusb20_get_backend_name_t)(void); 53184610Salfredtypedef int (libusb20_root_get_dev_quirk_t)(struct libusb20_backend *pbe, uint16_t index, struct libusb20_quirk *pq); 54184610Salfredtypedef int (libusb20_root_get_quirk_name_t)(struct libusb20_backend *pbe, uint16_t index, struct libusb20_quirk *pq); 55184610Salfredtypedef int (libusb20_root_add_dev_quirk_t)(struct libusb20_backend *pbe, struct libusb20_quirk *pq); 56184610Salfredtypedef int (libusb20_root_remove_dev_quirk_t)(struct libusb20_backend *pbe, struct libusb20_quirk *pq); 57184610Salfredtypedef int (libusb20_close_device_t)(struct libusb20_device *pdev); 58192984Sthompsatypedef int (libusb20_dev_get_info_t)(struct libusb20_device *pdev, struct usb_device_info *pinfo); 59188622Sthompsatypedef int (libusb20_dev_get_iface_desc_t)(struct libusb20_device *pdev, uint8_t iface_index, char *buf, uint8_t len); 60184610Salfredtypedef int (libusb20_init_backend_t)(struct libusb20_backend *pbe); 61184610Salfredtypedef int (libusb20_open_device_t)(struct libusb20_device *pdev, uint16_t transfer_count_max); 62184610Salfredtypedef void (libusb20_exit_backend_t)(struct libusb20_backend *pbe); 63188987Sthompsatypedef int (libusb20_root_set_template_t)(struct libusb20_backend *pbe, int temp); 64188987Sthompsatypedef int (libusb20_root_get_template_t)(struct libusb20_backend *pbe, int *ptemp); 65184610Salfred 66184610Salfred#define LIBUSB20_DEFINE(n,field) \ 67184610Salfred libusb20_##field##_t *field; 68184610Salfred 69184610Salfred#define LIBUSB20_DECLARE(n,field) \ 70184610Salfred /* .field = */ n##_##field, 71184610Salfred 72184610Salfred#define LIBUSB20_BACKEND(m,n) \ 73184610Salfred /* description of this backend */ \ 74184610Salfred m(n, get_backend_name) \ 75184610Salfred /* optional backend methods */ \ 76184610Salfred m(n, init_backend) \ 77184610Salfred m(n, exit_backend) \ 78188622Sthompsa m(n, dev_get_info) \ 79188622Sthompsa m(n, dev_get_iface_desc) \ 80184610Salfred m(n, root_get_dev_quirk) \ 81184610Salfred m(n, root_get_quirk_name) \ 82184610Salfred m(n, root_add_dev_quirk) \ 83184610Salfred m(n, root_remove_dev_quirk) \ 84188987Sthompsa m(n, root_set_template) \ 85188987Sthompsa m(n, root_get_template) \ 86184610Salfred /* mandatory device methods */ \ 87184610Salfred m(n, open_device) \ 88184610Salfred m(n, close_device) \ 89184610Salfred 90184610Salfredstruct libusb20_backend_methods { 91184610Salfred LIBUSB20_BACKEND(LIBUSB20_DEFINE,) 92184610Salfred}; 93184610Salfred 94184610Salfred/* USB dummy methods */ 95184610Salfredtypedef int (libusb20_dummy_int_t)(void); 96184610Salfredtypedef void (libusb20_dummy_void_t)(void); 97184610Salfred 98184610Salfred/* USB device specific */ 99184610Salfredtypedef int (libusb20_detach_kernel_driver_t)(struct libusb20_device *pdev, uint8_t iface_index); 100184610Salfredtypedef int (libusb20_do_request_sync_t)(struct libusb20_device *pdev, struct LIBUSB20_CONTROL_SETUP_DECODED *setup, void *data, uint16_t *pactlen, uint32_t timeout, uint8_t flags); 101184610Salfredtypedef int (libusb20_get_config_desc_full_t)(struct libusb20_device *pdev, uint8_t **ppbuf, uint16_t *plen, uint8_t index); 102184610Salfredtypedef int (libusb20_get_config_index_t)(struct libusb20_device *pdev, uint8_t *pindex); 103184610Salfredtypedef int (libusb20_kernel_driver_active_t)(struct libusb20_device *pdev, uint8_t iface_index); 104184610Salfredtypedef int (libusb20_process_t)(struct libusb20_device *pdev); 105184610Salfredtypedef int (libusb20_reset_device_t)(struct libusb20_device *pdev); 106184610Salfredtypedef int (libusb20_set_power_mode_t)(struct libusb20_device *pdev, uint8_t power_mode); 107184610Salfredtypedef int (libusb20_get_power_mode_t)(struct libusb20_device *pdev, uint8_t *power_mode); 108184610Salfredtypedef int (libusb20_set_alt_index_t)(struct libusb20_device *pdev, uint8_t iface_index, uint8_t alt_index); 109184610Salfredtypedef int (libusb20_set_config_index_t)(struct libusb20_device *pdev, uint8_t index); 110203147Sthompsatypedef int (libusb20_check_connected_t)(struct libusb20_device *pdev); 111184610Salfred 112184610Salfred/* USB transfer specific */ 113219100Shselaskytypedef int (libusb20_tr_open_t)(struct libusb20_transfer *xfer, uint32_t MaxBufSize, uint32_t MaxFrameCount, uint8_t ep_no, uint8_t pre_scale); 114184610Salfredtypedef int (libusb20_tr_close_t)(struct libusb20_transfer *xfer); 115184610Salfredtypedef int (libusb20_tr_clear_stall_sync_t)(struct libusb20_transfer *xfer); 116184610Salfredtypedef void (libusb20_tr_submit_t)(struct libusb20_transfer *xfer); 117184610Salfredtypedef void (libusb20_tr_cancel_async_t)(struct libusb20_transfer *xfer); 118184610Salfred 119184610Salfred#define LIBUSB20_DEVICE(m,n) \ 120184610Salfred m(n, detach_kernel_driver) \ 121184610Salfred m(n, do_request_sync) \ 122184610Salfred m(n, get_config_desc_full) \ 123184610Salfred m(n, get_config_index) \ 124184610Salfred m(n, kernel_driver_active) \ 125184610Salfred m(n, process) \ 126184610Salfred m(n, reset_device) \ 127203147Sthompsa m(n, check_connected) \ 128184610Salfred m(n, set_power_mode) \ 129184610Salfred m(n, get_power_mode) \ 130184610Salfred m(n, set_alt_index) \ 131184610Salfred m(n, set_config_index) \ 132184610Salfred m(n, tr_cancel_async) \ 133184610Salfred m(n, tr_clear_stall_sync) \ 134184610Salfred m(n, tr_close) \ 135184610Salfred m(n, tr_open) \ 136184610Salfred m(n, tr_submit) \ 137184610Salfred 138184610Salfredstruct libusb20_device_methods { 139184610Salfred LIBUSB20_DEVICE(LIBUSB20_DEFINE,) 140184610Salfred}; 141184610Salfred 142184610Salfredstruct libusb20_backend { 143184610Salfred TAILQ_HEAD(, libusb20_device) usb_devs; 144184610Salfred const struct libusb20_backend_methods *methods; 145184610Salfred}; 146184610Salfred 147184610Salfredstruct libusb20_transfer { 148184610Salfred struct libusb20_device *pdev; /* the USB device we belong to */ 149184610Salfred libusb20_tr_callback_t *callback; 150184610Salfred void *priv_sc0; /* private client data */ 151184610Salfred void *priv_sc1; /* private client data */ 152184610Salfred /* 153184610Salfred * Pointer to a list of buffer pointers: 154184610Salfred */ 155213852Shselasky#ifdef COMPAT_32BIT 156213852Shselasky uint64_t *ppBuffer; 157213852Shselasky#else 158184610Salfred void **ppBuffer; 159213852Shselasky#endif 160184610Salfred /* 161184610Salfred * Pointer to frame lengths, which are updated to actual length 162184610Salfred * after the USB transfer completes: 163184610Salfred */ 164184610Salfred uint32_t *pLength; 165184610Salfred uint32_t maxTotalLength; 166184610Salfred uint32_t maxFrames; /* total number of frames */ 167184610Salfred uint32_t nFrames; /* total number of frames */ 168184610Salfred uint32_t aFrames; /* actual number of frames */ 169184610Salfred uint32_t timeout; 170184610Salfred /* isochronous completion time in milliseconds */ 171184610Salfred uint16_t timeComplete; 172184610Salfred uint16_t trIndex; 173184610Salfred uint16_t maxPacketLen; 174184610Salfred uint8_t flags; /* see LIBUSB20_TRANSFER_XXX */ 175184610Salfred uint8_t status; /* see LIBUSB20_TRANSFER_XXX */ 176184610Salfred uint8_t is_opened; 177184610Salfred uint8_t is_pending; 178184610Salfred uint8_t is_cancel; 179184610Salfred uint8_t is_draining; 180184610Salfred uint8_t is_restart; 181184610Salfred}; 182184610Salfred 183184610Salfredstruct libusb20_device { 184184610Salfred 185184610Salfred /* device descriptor */ 186184610Salfred struct LIBUSB20_DEVICE_DESC_DECODED ddesc; 187184610Salfred 188184610Salfred /* device timestamp */ 189184610Salfred union libusb20_session_data session_data; 190184610Salfred 191184610Salfred /* our device entry */ 192184610Salfred TAILQ_ENTRY(libusb20_device) dev_entry; 193184610Salfred 194184610Salfred /* device methods */ 195184610Salfred const struct libusb20_device_methods *methods; 196184610Salfred 197184610Salfred /* backend methods */ 198184610Salfred const struct libusb20_backend_methods *beMethods; 199184610Salfred 200184610Salfred /* list of USB transfers */ 201184610Salfred struct libusb20_transfer *pTransfer; 202184610Salfred 203184610Salfred /* private backend data */ 204184610Salfred void *privBeData; 205184610Salfred 206195957Salfred /* libUSB v0.1 and v1.0 compat data */ 207195957Salfred void *privLuData; 208184610Salfred 209194069Sthompsa /* claimed interface */ 210194069Sthompsa uint8_t claimed_interface; 211184610Salfred 212184610Salfred /* device file handle */ 213184610Salfred int file; 214184610Salfred 215184610Salfred /* device file handle (control transfers only) */ 216184610Salfred int file_ctrl; 217184610Salfred 218184610Salfred /* debugging level */ 219184610Salfred int debug; 220184610Salfred 221184610Salfred /* number of USB transfers */ 222184610Salfred uint16_t nTransfer; 223184610Salfred 224184610Salfred uint8_t bus_number; 225184610Salfred uint8_t device_address; 226184610Salfred uint8_t usb_mode; 227184610Salfred uint8_t usb_speed; 228184610Salfred uint8_t is_opened; 229223495Shselasky uint8_t parent_address; 230223495Shselasky uint8_t parent_port; 231184610Salfred 232184610Salfred char usb_desc[96]; 233184610Salfred}; 234184610Salfred 235184610Salfredextern const struct libusb20_backend_methods libusb20_ugen20_backend; 236184610Salfredextern const struct libusb20_backend_methods libusb20_linux_backend; 237184610Salfred 238184610Salfred#endif /* _LIBUSB20_INT_H_ */ 239