1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2008-2023 Hans Petter Selasky 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 #ifndef _USB_DEV_H_ 29 #define _USB_DEV_H_ 30 31 #ifndef USB_GLOBAL_INCLUDE_FILE 32 #include <sys/file.h> 33 #include <sys/selinfo.h> 34 #include <sys/poll.h> 35 #include <sys/signalvar.h> 36 #include <sys/proc.h> 37 #endif 38 39 struct usb_fifo; 40 struct usb_mbuf; 41 42 struct usb_symlink { 43 TAILQ_ENTRY(usb_symlink) sym_entry; 44 char src_path[32]; /* Source path - including terminating 45 * zero */ 46 char dst_path[32]; /* Destination path - including 47 * terminating zero */ 48 uint8_t src_len; /* String length */ 49 uint8_t dst_len; /* String length */ 50 }; 51 52 /* 53 * Private per-device information. 54 */ 55 struct usb_cdev_privdata { 56 struct usb_bus *bus; 57 struct usb_device *udev; 58 struct usb_interface *iface; 59 int bus_index; /* bus index */ 60 int dev_index; /* device index */ 61 int ep_addr; /* endpoint address */ 62 int fflags; 63 uint8_t fifo_index; /* FIFO index */ 64 }; 65 66 /* 67 * The following structure defines a minimum re-implementation of the 68 * ifqueue structure in the kernel. 69 */ 70 struct usb_ifqueue { 71 struct usb_mbuf *ifq_head; 72 struct usb_mbuf *ifq_tail; 73 74 usb_size_t ifq_len; 75 usb_size_t ifq_maxlen; 76 }; 77 78 /* 79 * Private per-device and per-thread reference information 80 */ 81 struct usb_cdev_refdata { 82 struct usb_fifo *rxfifo; 83 struct usb_fifo *txfifo; 84 uint8_t is_read; /* location has read access */ 85 uint8_t is_write; /* location has write access */ 86 uint8_t is_uref; /* USB refcount decr. needed */ 87 uint8_t is_usbfs; /* USB-FS is active */ 88 uint8_t do_unlock; /* USB enum unlock needed */ 89 }; 90 91 struct usb_fs_privdata { 92 int bus_index; 93 int dev_index; 94 int ep_addr; 95 int mode; 96 int fifo_index; 97 struct cdev *cdev; 98 99 SLIST_ENTRY(usb_fs_privdata) pd_next; 100 }; 101 102 /* 103 * Most of the fields in the "usb_fifo" structure are used by the 104 * generic USB access layer. 105 */ 106 struct usb_fifo { 107 struct usb_ifqueue free_q; 108 struct usb_ifqueue used_q; 109 struct selinfo selinfo; 110 struct cv cv_io; 111 struct cv cv_drain; 112 struct sx fs_fastpath_lock; 113 struct usb_fifo_methods *methods; 114 struct usb_symlink *symlink[2];/* our symlinks */ 115 struct proc *async_p; /* process that wants SIGIO */ 116 struct usb_fs_endpoint *fs_ep_ptr; 117 struct usb_device *udev; 118 #define USB_FS_XFER_MAX 126 119 struct usb_xfer *xfer[2]; 120 struct usb_xfer *fs_xfer[USB_FS_XFER_MAX]; 121 struct mtx *priv_mtx; /* client data */ 122 /* set if FIFO is opened by a FILE: */ 123 struct usb_cdev_privdata *curr_cpd; 124 void *priv_sc0; /* client data */ 125 void *priv_sc1; /* client data */ 126 void *queue_data; 127 usb_size_t fs_ep_sz; 128 usb_timeout_t timeout; /* timeout in milliseconds */ 129 usb_frlength_t bufsize; /* BULK and INTERRUPT buffer size */ 130 usb_frcount_t nframes; /* for isochronous mode */ 131 uint16_t dev_ep_index; /* our device endpoint index */ 132 uint8_t flag_sleeping; /* set if FIFO is sleeping */ 133 uint8_t flag_iscomplete; /* set if a USB transfer is complete */ 134 uint8_t flag_iserror; /* set if FIFO error happened */ 135 uint8_t flag_isselect; /* set if FIFO is selected */ 136 uint8_t flag_flushing; /* set if FIFO is flushing data */ 137 uint8_t flag_short; /* set if short_ok or force_short 138 * transfer flags should be set */ 139 uint8_t flag_stall; /* set if clear stall should be run */ 140 uint8_t flag_write_defrag; /* set to defrag written data */ 141 uint8_t flag_have_fragment; /* set if defragging */ 142 uint8_t iface_index; /* set to the interface we belong to */ 143 uint8_t fifo_index; /* set to the FIFO index in "struct 144 * usb_device" */ 145 uint8_t fs_ep_max; 146 uint8_t fifo_zlp; /* zero length packet count */ 147 uint8_t refcount; 148 #define USB_FIFO_REF_MAX 0xFF 149 }; 150 151 extern struct cdevsw usb_devsw; 152 153 int usb_fifo_wait(struct usb_fifo *fifo); 154 void usb_fifo_signal(struct usb_fifo *fifo); 155 uint8_t usb_fifo_opened(struct usb_fifo *fifo); 156 struct usb_symlink *usb_alloc_symlink(const char *target); 157 void usb_free_symlink(struct usb_symlink *ps); 158 int usb_read_symlink(uint8_t *user_ptr, uint32_t startentry, 159 uint32_t user_len); 160 161 #endif /* _USB_DEV_H_ */ 162