libusb20_int.h revision 331722
1/* $FreeBSD: stable/11/lib/libusb/libusb20_int.h 331722 2018-03-29 02:50:57Z eadler $ */ 2/*- 3 * Copyright (c) 2008 Hans Petter Selasky. 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/* 28 * This file describes internal structures. 29 */ 30 31#ifndef _LIBUSB20_INT_H_ 32#define _LIBUSB20_INT_H_ 33 34#ifdef COMPAT_32BIT 35#define libusb20_pass_ptr(ptr) ((uint64_t)(uintptr_t)(ptr)) 36#else 37#define libusb20_pass_ptr(ptr) (ptr) 38#endif 39 40struct libusb20_device; 41struct libusb20_backend; 42struct libusb20_transfer; 43struct libusb20_quirk; 44 45union libusb20_session_data { 46 unsigned long session_data; 47 struct timespec tv; 48 uint32_t plugtime; 49}; 50 51/* USB backend specific */ 52typedef const char *(libusb20_get_backend_name_t)(void); 53typedef int (libusb20_root_get_dev_quirk_t)(struct libusb20_backend *pbe, uint16_t index, struct libusb20_quirk *pq); 54typedef int (libusb20_root_get_quirk_name_t)(struct libusb20_backend *pbe, uint16_t index, struct libusb20_quirk *pq); 55typedef int (libusb20_root_add_dev_quirk_t)(struct libusb20_backend *pbe, struct libusb20_quirk *pq); 56typedef int (libusb20_root_remove_dev_quirk_t)(struct libusb20_backend *pbe, struct libusb20_quirk *pq); 57typedef int (libusb20_close_device_t)(struct libusb20_device *pdev); 58typedef int (libusb20_dev_get_info_t)(struct libusb20_device *pdev, struct usb_device_info *pinfo); 59typedef int (libusb20_dev_get_iface_desc_t)(struct libusb20_device *pdev, uint8_t iface_index, char *buf, uint8_t len); 60typedef int (libusb20_init_backend_t)(struct libusb20_backend *pbe); 61typedef int (libusb20_open_device_t)(struct libusb20_device *pdev, uint16_t transfer_count_max); 62typedef void (libusb20_exit_backend_t)(struct libusb20_backend *pbe); 63typedef int (libusb20_root_set_template_t)(struct libusb20_backend *pbe, int temp); 64typedef int (libusb20_root_get_template_t)(struct libusb20_backend *pbe, int *ptemp); 65 66#define LIBUSB20_DEFINE(n,field) \ 67 libusb20_##field##_t *field; 68 69#define LIBUSB20_DECLARE(n,field) \ 70 /* .field = */ n##_##field, 71 72#define LIBUSB20_BACKEND(m,n) \ 73 /* description of this backend */ \ 74 m(n, get_backend_name) \ 75 /* optional backend methods */ \ 76 m(n, init_backend) \ 77 m(n, exit_backend) \ 78 m(n, dev_get_info) \ 79 m(n, dev_get_iface_desc) \ 80 m(n, root_get_dev_quirk) \ 81 m(n, root_get_quirk_name) \ 82 m(n, root_add_dev_quirk) \ 83 m(n, root_remove_dev_quirk) \ 84 m(n, root_set_template) \ 85 m(n, root_get_template) \ 86 /* mandatory device methods */ \ 87 m(n, open_device) \ 88 m(n, close_device) \ 89 90struct libusb20_backend_methods { 91 LIBUSB20_BACKEND(LIBUSB20_DEFINE,) 92}; 93 94/* USB dummy methods */ 95typedef int (libusb20_dummy_int_t)(void); 96typedef void (libusb20_dummy_void_t)(void); 97 98/* USB device specific */ 99typedef int (libusb20_detach_kernel_driver_t)(struct libusb20_device *pdev, uint8_t iface_index); 100typedef 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); 101typedef int (libusb20_get_config_desc_full_t)(struct libusb20_device *pdev, uint8_t **ppbuf, uint16_t *plen, uint8_t index); 102typedef int (libusb20_get_config_index_t)(struct libusb20_device *pdev, uint8_t *pindex); 103typedef int (libusb20_kernel_driver_active_t)(struct libusb20_device *pdev, uint8_t iface_index); 104typedef int (libusb20_process_t)(struct libusb20_device *pdev); 105typedef int (libusb20_reset_device_t)(struct libusb20_device *pdev); 106typedef int (libusb20_set_power_mode_t)(struct libusb20_device *pdev, uint8_t power_mode); 107typedef int (libusb20_get_power_mode_t)(struct libusb20_device *pdev, uint8_t *power_mode); 108typedef int (libusb20_get_port_path_t)(struct libusb20_device *pdev, uint8_t *buf, uint8_t bufsize); 109typedef int (libusb20_get_power_usage_t)(struct libusb20_device *pdev, uint16_t *power_usage); 110typedef int (libusb20_set_alt_index_t)(struct libusb20_device *pdev, uint8_t iface_index, uint8_t alt_index); 111typedef int (libusb20_set_config_index_t)(struct libusb20_device *pdev, uint8_t index); 112typedef int (libusb20_check_connected_t)(struct libusb20_device *pdev); 113 114/* USB transfer specific */ 115typedef 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); 116typedef int (libusb20_tr_close_t)(struct libusb20_transfer *xfer); 117typedef int (libusb20_tr_clear_stall_sync_t)(struct libusb20_transfer *xfer); 118typedef void (libusb20_tr_submit_t)(struct libusb20_transfer *xfer); 119typedef void (libusb20_tr_cancel_async_t)(struct libusb20_transfer *xfer); 120 121#define LIBUSB20_DEVICE(m,n) \ 122 m(n, detach_kernel_driver) \ 123 m(n, do_request_sync) \ 124 m(n, get_config_desc_full) \ 125 m(n, get_config_index) \ 126 m(n, kernel_driver_active) \ 127 m(n, process) \ 128 m(n, reset_device) \ 129 m(n, check_connected) \ 130 m(n, set_power_mode) \ 131 m(n, get_power_mode) \ 132 m(n, get_port_path) \ 133 m(n, get_power_usage) \ 134 m(n, set_alt_index) \ 135 m(n, set_config_index) \ 136 m(n, tr_cancel_async) \ 137 m(n, tr_clear_stall_sync) \ 138 m(n, tr_close) \ 139 m(n, tr_open) \ 140 m(n, tr_submit) \ 141 142struct libusb20_device_methods { 143 LIBUSB20_DEVICE(LIBUSB20_DEFINE,) 144}; 145 146struct libusb20_backend { 147 TAILQ_HEAD(, libusb20_device) usb_devs; 148 const struct libusb20_backend_methods *methods; 149}; 150 151struct libusb20_transfer { 152 struct libusb20_device *pdev; /* the USB device we belong to */ 153 libusb20_tr_callback_t *callback; 154 void *priv_sc0; /* private client data */ 155 void *priv_sc1; /* private client data */ 156 /* 157 * Pointer to a list of buffer pointers: 158 */ 159#ifdef COMPAT_32BIT 160 uint64_t *ppBuffer; 161#else 162 void **ppBuffer; 163#endif 164 /* 165 * Pointer to frame lengths, which are updated to actual length 166 * after the USB transfer completes: 167 */ 168 uint32_t *pLength; 169 uint32_t maxTotalLength; 170 uint32_t maxFrames; /* total number of frames */ 171 uint32_t nFrames; /* total number of frames */ 172 uint32_t aFrames; /* actual number of frames */ 173 uint32_t timeout; 174 /* isochronous completion time in milliseconds */ 175 uint16_t timeComplete; 176 uint16_t trIndex; 177 uint16_t maxPacketLen; 178 uint8_t flags; /* see LIBUSB20_TRANSFER_XXX */ 179 uint8_t status; /* see LIBUSB20_TRANSFER_XXX */ 180 uint8_t is_opened; 181 uint8_t is_pending; 182 uint8_t is_cancel; 183 uint8_t is_draining; 184 uint8_t is_restart; 185}; 186 187struct libusb20_device { 188 189 /* device descriptor */ 190 struct LIBUSB20_DEVICE_DESC_DECODED ddesc; 191 192 /* device timestamp */ 193 union libusb20_session_data session_data; 194 195 /* our device entry */ 196 TAILQ_ENTRY(libusb20_device) dev_entry; 197 198 /* device methods */ 199 const struct libusb20_device_methods *methods; 200 201 /* backend methods */ 202 const struct libusb20_backend_methods *beMethods; 203 204 /* list of USB transfers */ 205 struct libusb20_transfer *pTransfer; 206 207 /* private backend data */ 208 void *privBeData; 209 210 /* libUSB v0.1 and v1.0 compat data */ 211 void *privLuData; 212 213 /* claimed interface */ 214 uint8_t claimed_interface; 215 216 /* auto detach kernel driver */ 217 uint8_t auto_detach; 218 219 /* device file handle */ 220 int file; 221 222 /* device file handle (control transfers only) */ 223 int file_ctrl; 224 225 /* debugging level */ 226 int debug; 227 228 /* number of USB transfers */ 229 uint16_t nTransfer; 230 231 uint8_t bus_number; 232 uint8_t device_address; 233 uint8_t usb_mode; 234 uint8_t usb_speed; 235 uint8_t is_opened; 236 uint8_t parent_address; 237 uint8_t parent_port; 238 239 char usb_desc[96]; 240}; 241 242extern const struct libusb20_backend_methods libusb20_ugen20_backend; 243extern const struct libusb20_backend_methods libusb20_linux_backend; 244 245#endif /* _LIBUSB20_INT_H_ */ 246