1184610Salfred/* $FreeBSD: stable/10/lib/libusb/libusb20_int.h 356399 2020-01-06 09:22:33Z 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); 108250201Shselaskytypedef int (libusb20_get_port_path_t)(struct libusb20_device *pdev, uint8_t *buf, uint8_t bufsize); 109246789Shselaskytypedef int (libusb20_get_power_usage_t)(struct libusb20_device *pdev, uint16_t *power_usage); 110356399Shselaskytypedef int (libusb20_get_stats_t)(struct libusb20_device *pdev, struct libusb20_device_stats *pstats); 111184610Salfredtypedef int (libusb20_set_alt_index_t)(struct libusb20_device *pdev, uint8_t iface_index, uint8_t alt_index); 112184610Salfredtypedef int (libusb20_set_config_index_t)(struct libusb20_device *pdev, uint8_t index); 113203147Sthompsatypedef int (libusb20_check_connected_t)(struct libusb20_device *pdev); 114184610Salfred 115356399Shselasky 116184610Salfred/* USB transfer specific */ 117239239Shselaskytypedef int (libusb20_tr_open_t)(struct libusb20_transfer *xfer, uint32_t MaxBufSize, uint32_t MaxFrameCount, uint8_t ep_no, uint16_t stream_id, uint8_t pre_scale); 118184610Salfredtypedef int (libusb20_tr_close_t)(struct libusb20_transfer *xfer); 119184610Salfredtypedef int (libusb20_tr_clear_stall_sync_t)(struct libusb20_transfer *xfer); 120184610Salfredtypedef void (libusb20_tr_submit_t)(struct libusb20_transfer *xfer); 121184610Salfredtypedef void (libusb20_tr_cancel_async_t)(struct libusb20_transfer *xfer); 122184610Salfred 123184610Salfred#define LIBUSB20_DEVICE(m,n) \ 124184610Salfred m(n, detach_kernel_driver) \ 125184610Salfred m(n, do_request_sync) \ 126184610Salfred m(n, get_config_desc_full) \ 127184610Salfred m(n, get_config_index) \ 128184610Salfred m(n, kernel_driver_active) \ 129184610Salfred m(n, process) \ 130184610Salfred m(n, reset_device) \ 131203147Sthompsa m(n, check_connected) \ 132184610Salfred m(n, set_power_mode) \ 133184610Salfred m(n, get_power_mode) \ 134250201Shselasky m(n, get_port_path) \ 135246789Shselasky m(n, get_power_usage) \ 136356399Shselasky m(n, get_stats) \ 137184610Salfred m(n, set_alt_index) \ 138184610Salfred m(n, set_config_index) \ 139184610Salfred m(n, tr_cancel_async) \ 140184610Salfred m(n, tr_clear_stall_sync) \ 141184610Salfred m(n, tr_close) \ 142184610Salfred m(n, tr_open) \ 143184610Salfred m(n, tr_submit) \ 144184610Salfred 145184610Salfredstruct libusb20_device_methods { 146184610Salfred LIBUSB20_DEVICE(LIBUSB20_DEFINE,) 147184610Salfred}; 148184610Salfred 149184610Salfredstruct libusb20_backend { 150184610Salfred TAILQ_HEAD(, libusb20_device) usb_devs; 151184610Salfred const struct libusb20_backend_methods *methods; 152184610Salfred}; 153184610Salfred 154184610Salfredstruct libusb20_transfer { 155184610Salfred struct libusb20_device *pdev; /* the USB device we belong to */ 156184610Salfred libusb20_tr_callback_t *callback; 157184610Salfred void *priv_sc0; /* private client data */ 158184610Salfred void *priv_sc1; /* private client data */ 159184610Salfred /* 160184610Salfred * Pointer to a list of buffer pointers: 161184610Salfred */ 162213852Shselasky#ifdef COMPAT_32BIT 163213852Shselasky uint64_t *ppBuffer; 164213852Shselasky#else 165184610Salfred void **ppBuffer; 166213852Shselasky#endif 167184610Salfred /* 168184610Salfred * Pointer to frame lengths, which are updated to actual length 169184610Salfred * after the USB transfer completes: 170184610Salfred */ 171184610Salfred uint32_t *pLength; 172184610Salfred uint32_t maxTotalLength; 173184610Salfred uint32_t maxFrames; /* total number of frames */ 174184610Salfred uint32_t nFrames; /* total number of frames */ 175184610Salfred uint32_t aFrames; /* actual number of frames */ 176184610Salfred uint32_t timeout; 177184610Salfred /* isochronous completion time in milliseconds */ 178184610Salfred uint16_t timeComplete; 179184610Salfred uint16_t trIndex; 180184610Salfred uint16_t maxPacketLen; 181184610Salfred uint8_t flags; /* see LIBUSB20_TRANSFER_XXX */ 182184610Salfred uint8_t status; /* see LIBUSB20_TRANSFER_XXX */ 183184610Salfred uint8_t is_opened; 184184610Salfred uint8_t is_pending; 185184610Salfred uint8_t is_cancel; 186184610Salfred uint8_t is_draining; 187184610Salfred uint8_t is_restart; 188184610Salfred}; 189184610Salfred 190184610Salfredstruct libusb20_device { 191184610Salfred 192184610Salfred /* device descriptor */ 193184610Salfred struct LIBUSB20_DEVICE_DESC_DECODED ddesc; 194184610Salfred 195184610Salfred /* device timestamp */ 196184610Salfred union libusb20_session_data session_data; 197184610Salfred 198184610Salfred /* our device entry */ 199184610Salfred TAILQ_ENTRY(libusb20_device) dev_entry; 200184610Salfred 201184610Salfred /* device methods */ 202184610Salfred const struct libusb20_device_methods *methods; 203184610Salfred 204184610Salfred /* backend methods */ 205184610Salfred const struct libusb20_backend_methods *beMethods; 206184610Salfred 207184610Salfred /* list of USB transfers */ 208184610Salfred struct libusb20_transfer *pTransfer; 209184610Salfred 210184610Salfred /* private backend data */ 211184610Salfred void *privBeData; 212184610Salfred 213195957Salfred /* libUSB v0.1 and v1.0 compat data */ 214195957Salfred void *privLuData; 215184610Salfred 216194069Sthompsa /* claimed interface */ 217194069Sthompsa uint8_t claimed_interface; 218184610Salfred 219302275Shselasky /* auto detach kernel driver */ 220302275Shselasky uint8_t auto_detach; 221302275Shselasky 222184610Salfred /* device file handle */ 223184610Salfred int file; 224184610Salfred 225184610Salfred /* device file handle (control transfers only) */ 226184610Salfred int file_ctrl; 227184610Salfred 228184610Salfred /* debugging level */ 229184610Salfred int debug; 230184610Salfred 231184610Salfred /* number of USB transfers */ 232184610Salfred uint16_t nTransfer; 233184610Salfred 234184610Salfred uint8_t bus_number; 235184610Salfred uint8_t device_address; 236184610Salfred uint8_t usb_mode; 237184610Salfred uint8_t usb_speed; 238184610Salfred uint8_t is_opened; 239223495Shselasky uint8_t parent_address; 240223495Shselasky uint8_t parent_port; 241184610Salfred 242184610Salfred char usb_desc[96]; 243184610Salfred}; 244184610Salfred 245184610Salfredextern const struct libusb20_backend_methods libusb20_ugen20_backend; 246184610Salfredextern const struct libusb20_backend_methods libusb20_linux_backend; 247184610Salfred 248184610Salfred#endif /* _LIBUSB20_INT_H_ */ 249