1 /* $FreeBSD$ */ 2 /*- 3 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 4 * 5 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 #ifndef _USB_DEV_H_ 30 #define _USB_DEV_H_ 31 32 #ifndef USB_GLOBAL_INCLUDE_FILE 33 #include <sys/file.h> 34 #include <sys/selinfo.h> 35 #include <sys/poll.h> 36 #include <sys/signalvar.h> 37 #include <sys/proc.h> 38 #endif 39 40 struct usb_fifo; 41 struct usb_mbuf; 42 43 struct usb_symlink { 44 TAILQ_ENTRY(usb_symlink) sym_entry; 45 char src_path[32]; /* Source path - including terminating 46 * zero */ 47 char dst_path[32]; /* Destination path - including 48 * terminating zero */ 49 uint8_t src_len; /* String length */ 50 uint8_t dst_len; /* String length */ 51 }; 52 53 /* 54 * Private per-device information. 55 */ 56 struct usb_cdev_privdata { 57 struct usb_bus *bus; 58 struct usb_device *udev; 59 struct usb_interface *iface; 60 int bus_index; /* bus index */ 61 int dev_index; /* device index */ 62 int ep_addr; /* endpoint address */ 63 int fflags; 64 uint8_t fifo_index; /* FIFO index */ 65 }; 66 67 /* 68 * The following structure defines a minimum re-implementation of the 69 * ifqueue structure in the kernel. 70 */ 71 struct usb_ifqueue { 72 struct usb_mbuf *ifq_head; 73 struct usb_mbuf *ifq_tail; 74 75 usb_size_t ifq_len; 76 usb_size_t ifq_maxlen; 77 }; 78 79 /* 80 * Private per-device and per-thread reference information 81 */ 82 struct usb_cdev_refdata { 83 struct usb_fifo *rxfifo; 84 struct usb_fifo *txfifo; 85 uint8_t is_read; /* location has read access */ 86 uint8_t is_write; /* location has write access */ 87 uint8_t is_uref; /* USB refcount decr. needed */ 88 uint8_t is_usbfs; /* USB-FS is active */ 89 uint8_t do_unlock; /* USB enum unlock needed */ 90 }; 91 92 struct usb_fs_privdata { 93 int bus_index; 94 int dev_index; 95 int ep_addr; 96 int mode; 97 int fifo_index; 98 struct cdev *cdev; 99 100 LIST_ENTRY(usb_fs_privdata) pd_next; 101 }; 102 103 /* 104 * Most of the fields in the "usb_fifo" structure are used by the 105 * generic USB access layer. 106 */ 107 struct usb_fifo { 108 struct usb_ifqueue free_q; 109 struct usb_ifqueue used_q; 110 struct selinfo selinfo; 111 struct cv cv_io; 112 struct cv cv_drain; 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 struct usb_xfer *xfer[2]; 119 struct usb_xfer **fs_xfer; 120 struct mtx *priv_mtx; /* client data */ 121 /* set if FIFO is opened by a FILE: */ 122 struct usb_cdev_privdata *curr_cpd; 123 void *priv_sc0; /* client data */ 124 void *priv_sc1; /* client data */ 125 void *queue_data; 126 usb_timeout_t timeout; /* timeout in milliseconds */ 127 usb_frlength_t bufsize; /* BULK and INTERRUPT buffer size */ 128 usb_frcount_t nframes; /* for isochronous mode */ 129 uint16_t dev_ep_index; /* our device endpoint index */ 130 uint8_t flag_sleeping; /* set if FIFO is sleeping */ 131 uint8_t flag_iscomplete; /* set if a USB transfer is complete */ 132 uint8_t flag_iserror; /* set if FIFO error happened */ 133 uint8_t flag_isselect; /* set if FIFO is selected */ 134 uint8_t flag_flushing; /* set if FIFO is flushing data */ 135 uint8_t flag_short; /* set if short_ok or force_short 136 * transfer flags should be set */ 137 uint8_t flag_stall; /* set if clear stall should be run */ 138 uint8_t flag_write_defrag; /* set to defrag written data */ 139 uint8_t flag_have_fragment; /* set if defragging */ 140 uint8_t iface_index; /* set to the interface we belong to */ 141 uint8_t fifo_index; /* set to the FIFO index in "struct 142 * usb_device" */ 143 uint8_t fs_ep_max; 144 uint8_t fifo_zlp; /* zero length packet count */ 145 uint8_t refcount; 146 #define USB_FIFO_REF_MAX 0xFF 147 }; 148 149 extern struct cdevsw usb_devsw; 150 151 int usb_fifo_wait(struct usb_fifo *fifo); 152 void usb_fifo_signal(struct usb_fifo *fifo); 153 uint8_t usb_fifo_opened(struct usb_fifo *fifo); 154 struct usb_symlink *usb_alloc_symlink(const char *target); 155 void usb_free_symlink(struct usb_symlink *ps); 156 int usb_read_symlink(uint8_t *user_ptr, uint32_t startentry, 157 uint32_t user_len); 158 159 #endif /* _USB_DEV_H_ */ 160