1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 */ 27 28 /* 29 * Including this file is mandatory for all USB related c-files in the kernel. 30 */ 31 32 #ifndef _USB_CORE_H_ 33 #define _USB_CORE_H_ 34 35 /* 36 * The following macro will tell if an USB transfer is currently 37 * receiving or transferring data. 38 */ 39 #define USB_GET_DATA_ISREAD(xfer) ((xfer)->flags_int.usb_mode == \ 40 USB_MODE_DEVICE ? (((xfer)->endpointno & UE_DIR_IN) ? 0 : 1) : \ 41 (((xfer)->endpointno & UE_DIR_IN) ? 1 : 0)) 42 43 /* locking wrappers for BUS lock */ 44 #define USB_BUS_LOCK(_b) USB_MTX_LOCK(&(_b)->bus_mtx) 45 #define USB_BUS_UNLOCK(_b) USB_MTX_UNLOCK(&(_b)->bus_mtx) 46 #define USB_BUS_LOCK_ASSERT(_b, _t) USB_MTX_ASSERT(&(_b)->bus_mtx, _t) 47 48 /* locking wrappers for BUS spin lock */ 49 #define USB_BUS_SPIN_LOCK(_b) USB_MTX_LOCK_SPIN(&(_b)->bus_spin_lock) 50 #define USB_BUS_SPIN_UNLOCK(_b) USB_MTX_UNLOCK_SPIN(&(_b)->bus_spin_lock) 51 #define USB_BUS_SPIN_LOCK_ASSERT(_b, _t) USB_MTX_ASSERT(&(_b)->bus_spin_lock, _t) 52 53 /* locking wrappers for XFER lock */ 54 #define USB_XFER_LOCK(_x) USB_MTX_LOCK((_x)->xroot->xfer_mtx) 55 #define USB_XFER_UNLOCK(_x) USB_MTX_UNLOCK((_x)->xroot->xfer_mtx) 56 #define USB_XFER_LOCK_ASSERT(_x, _t) USB_MTX_ASSERT((_x)->xroot->xfer_mtx, _t) 57 58 /* helper for converting pointers to integers */ 59 #define USB_P2U(ptr) \ 60 ((uintptr_t)(ptr)) 61 62 /* helper for computing offsets */ 63 #define USB_ADD_BYTES(ptr,size) \ 64 ((void *)(__DECONST(char *, (ptr)) + (size))) 65 66 /* debug macro */ 67 #define USB_ASSERT KASSERT 68 69 /* structure prototypes */ 70 71 struct file; 72 struct usb_bus; 73 struct usb_device; 74 struct usb_device_request; 75 struct usb_page; 76 struct usb_page_cache; 77 struct usb_xfer; 78 struct usb_xfer_root; 79 struct usb_string_lang; 80 81 /* typedefs */ 82 83 /* structures */ 84 85 /* 86 * The following structure defines a set of internal USB transfer 87 * flags. 88 */ 89 struct usb_xfer_flags_int { 90 enum usb_hc_mode usb_mode; /* shadow copy of "udev->usb_mode" */ 91 uint16_t control_rem; /* remainder in bytes */ 92 93 uint8_t open:1; /* set if USB pipe has been opened */ 94 uint8_t transferring:1; /* set if an USB transfer is in 95 * progress */ 96 uint8_t did_dma_delay:1; /* set if we waited for HW DMA */ 97 uint8_t did_close:1; /* set if we closed the USB transfer */ 98 uint8_t draining:1; /* set if we are draining an USB 99 * transfer */ 100 uint8_t started:1; /* keeps track of started or stopped */ 101 uint8_t bandwidth_reclaimed:1; 102 uint8_t control_xfr:1; /* set if control transfer */ 103 uint8_t control_hdr:1; /* set if control header should be 104 * sent */ 105 uint8_t control_act:1; /* set if control transfer is active */ 106 uint8_t control_stall:1; /* set if control transfer should be stalled */ 107 uint8_t control_did_data:1; /* set if control DATA has been transferred */ 108 109 uint8_t short_frames_ok:1; /* filtered version */ 110 uint8_t short_xfer_ok:1; /* filtered version */ 111 #if USB_HAVE_BUSDMA 112 uint8_t bdma_enable:1; /* filtered version (only set if 113 * hardware supports DMA) */ 114 uint8_t bdma_no_post_sync:1; /* set if the USB callback wrapper 115 * should not do the BUS-DMA post sync 116 * operation */ 117 uint8_t bdma_setup:1; /* set if BUS-DMA has been setup */ 118 #endif 119 uint8_t isochronous_xfr:1; /* set if isochronous transfer */ 120 uint8_t curr_dma_set:1; /* used by USB HC/DC driver */ 121 uint8_t can_cancel_immed:1; /* set if USB transfer can be 122 * cancelled immediately */ 123 uint8_t doing_callback:1; /* set if executing the callback */ 124 uint8_t maxp_was_clamped:1; /* set if the max packet size 125 * was outside its allowed range */ 126 }; 127 128 /* 129 * The following structure defines an USB transfer. 130 */ 131 struct usb_xfer { 132 struct usb_callout timeout_handle; 133 TAILQ_ENTRY(usb_xfer) wait_entry; /* used at various places */ 134 135 struct usb_page_cache *buf_fixup; /* fixup buffer(s) */ 136 struct usb_xfer_queue *wait_queue; /* pointer to queue that we 137 * are waiting on */ 138 struct usb_page *dma_page_ptr; 139 struct usb_endpoint *endpoint; /* our USB endpoint */ 140 struct usb_xfer_root *xroot; /* used by HC driver */ 141 void *qh_start[2]; /* used by HC driver */ 142 void *td_start[2]; /* used by HC driver */ 143 void *td_transfer_first; /* used by HC driver */ 144 void *td_transfer_last; /* used by HC driver */ 145 void *td_transfer_cache; /* used by HC driver */ 146 void *priv_sc; /* device driver data pointer 1 */ 147 void *priv_fifo; /* device driver data pointer 2 */ 148 void *local_buffer; 149 usb_frlength_t *frlengths; 150 struct usb_page_cache *frbuffers; 151 usb_callback_t *callback; 152 153 usb_frlength_t max_hc_frame_size; 154 usb_frlength_t max_data_length; 155 usb_frlength_t sumlen; /* sum of all lengths in bytes */ 156 usb_frlength_t actlen; /* actual length in bytes */ 157 usb_timeout_t timeout; /* milliseconds */ 158 159 usb_frcount_t max_frame_count; /* initial value of "nframes" after 160 * setup */ 161 usb_frcount_t nframes; /* number of USB frames to transfer */ 162 usb_frcount_t aframes; /* actual number of USB frames 163 * transferred */ 164 usb_stream_t stream_id; /* USB3.0 specific field */ 165 166 uint16_t max_packet_size; 167 uint16_t max_frame_size; 168 uint16_t qh_pos; 169 uint16_t isoc_time_complete; /* in ms */ 170 usb_timeout_t interval; /* milliseconds */ 171 172 uint8_t address; /* physical USB address */ 173 uint8_t endpointno; /* physical USB endpoint */ 174 uint8_t max_packet_count; 175 uint8_t usb_state; 176 uint8_t fps_shift; /* down shift of FPS, 0..3 */ 177 178 usb_error_t error; 179 180 struct usb_xfer_flags flags; 181 struct usb_xfer_flags_int flags_int; 182 }; 183 184 /* external variables */ 185 186 extern struct mtx usb_ref_lock; 187 extern const struct usb_string_lang usb_string_lang_en; 188 189 /* typedefs */ 190 191 typedef struct malloc_type *usb_malloc_type; 192 193 /* prototypes */ 194 195 #endif /* _USB_CORE_H_ */ 196