1 /* $FreeBSD: releng/12.2/sys/compat/linuxkpi/common/include/linux/usb.h 331433 2018-03-23 15:50:01Z emaste $ */ 2 /*- 3 * Copyright (c) 2007 Luigi Rizzo - Universita` di Pisa. All rights reserved. 4 * Copyright (c) 2007 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 #ifndef _USB_COMPAT_LINUX_H 29 #define _USB_COMPAT_LINUX_H 30 31 #ifdef LOSCFG_NET_LWIP_SACK 32 #include <lwip/pbuf.h> 33 #endif 34 #include "implementation/freebsd_sys.h" 35 #include "usb_endian.h" 36 #include "usb_freebsd_loader.h" 37 #include "usb.h" 38 #include "usbdi.h" 39 40 struct usb_device; 41 struct usb_interface; 42 struct usb_driver; 43 struct urb; 44 45 typedef void *pm_message_t; 46 typedef void (usb_complete_t)(struct urb *); 47 48 #define USB_MAX_FULL_SPEED_ISOC_FRAMES (60 * 1) 49 #define USB_MAX_HIGH_SPEED_ISOC_FRAMES (60 * 8) 50 51 #define USB_DEVICE_ID_MATCH_DEVICE \ 52 (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT) 53 54 #define USB_DEVICE(vend,prod) \ 55 .match_flags = USB_DEVICE_ID_MATCH_DEVICE, .idVendor = (vend), \ 56 .idProduct = (prod) 57 58 /* The "usb_driver" structure holds the Linux USB device driver 59 * callbacks, and a pointer to device ID's which this entry should 60 * match against. Usually this entry is exposed to the USB emulation 61 * layer using the "USB_DRIVER_EXPORT()" macro, which is defined 62 * below. 63 */ 64 struct usb_driver { 65 const char *name; 66 67 int (*probe)(struct usb_interface *intf, const struct usb_device_id *id); 68 69 void (*disconnect)(struct usb_interface *intf); 70 71 int (*ioctl)(struct usb_interface *intf, unsigned int code, void *buf); 72 73 int (*suspend)(struct usb_interface *intf, pm_message_t message); 74 int (*resume)(struct usb_interface *intf); 75 76 const struct usb_device_id *id_table; 77 78 void (*shutdown)(struct usb_interface *intf); 79 80 LIST_ENTRY(usb_driver) linux_driver_list; 81 }; 82 83 #define USB_DT_ENDPOINT_SIZE 7 84 #define USB_DT_ENDPOINT_AUDIO_SIZE 9 85 86 /* 87 * Endpoints 88 */ 89 #define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */ 90 #define USB_ENDPOINT_DIR_MASK 0x80 91 92 #define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */ 93 #define USB_ENDPOINT_XFER_CONTROL 0 94 #define USB_ENDPOINT_XFER_ISOC 1 95 #define USB_ENDPOINT_XFER_BULK 2 96 #define USB_ENDPOINT_XFER_INT 3 97 #define USB_ENDPOINT_MAX_ADJUSTABLE 0x80 98 99 /* CONTROL REQUEST SUPPORT */ 100 101 /* 102 * Definition of direction mask for 103 * "bEndpointAddress" and "bmRequestType": 104 */ 105 #define USB_DIR_MASK 0x80 106 #define USB_DIR_OUT 0x00 /* write to USB device */ 107 #define USB_DIR_IN 0x80 /* read from USB device */ 108 109 /* :set number 110 111 * Definition of type mask for 112 * "bmRequestType": 113 */ 114 #define USB_TYPE_MASK (0x03 << 5) 115 #define USB_TYPE_STANDARD (0x00 << 5) 116 #define USB_TYPE_CLASS (0x01 << 5) 117 #define USB_TYPE_VENDOR (0x02 << 5) 118 #define USB_TYPE_RESERVED (0x03 << 5) 119 120 /* 121 * Definition of receiver mask for 122 * "bmRequestType": 123 */ 124 #define USB_RECIP_MASK 0x1f 125 #define USB_RECIP_DEVICE 0x00 126 #define USB_RECIP_INTERFACE 0x01 127 #define USB_RECIP_ENDPOINT 0x02 128 #define USB_RECIP_OTHER 0x03 129 130 /* 131 * Definition of standard request values for 132 * "bRequest": 133 */ 134 #define USB_REQ_GET_STATUS 0x00 135 #define USB_REQ_CLEAR_FEATURE 0x01 136 #define USB_REQ_SET_FEATURE 0x03 137 #define USB_REQ_SET_ADDRESS 0x05 138 #define USB_REQ_GET_DESCRIPTOR 0x06 139 #define USB_REQ_SET_DESCRIPTOR 0x07 140 #define USB_REQ_GET_CONFIGURATION 0x08 141 #define USB_REQ_SET_CONFIGURATION 0x09 142 #define USB_REQ_GET_INTERFACE 0x0A 143 #define USB_REQ_SET_INTERFACE 0x0B 144 #define USB_REQ_SYNCH_FRAME 0x0C 145 146 #define USB_REQ_SET_ENCRYPTION 0x0D /* Wireless USB */ 147 #define USB_REQ_GET_ENCRYPTION 0x0E 148 #define USB_REQ_SET_HANDSHAKE 0x0F 149 #define USB_REQ_GET_HANDSHAKE 0x10 150 #define USB_REQ_SET_CONNECTION 0x11 151 #define USB_REQ_SET_SECURITY_DATA 0x12 152 #define USB_REQ_GET_SECURITY_DATA 0x13 153 #define USB_REQ_SET_WUSB_DATA 0x14 154 #define USB_REQ_LOOPBACK_DATA_WRITE 0x15 155 #define USB_REQ_LOOPBACK_DATA_READ 0x16 156 #define USB_REQ_SET_INTERFACE_DS 0x17 157 158 /* 159 * USB feature flags are written using USB_REQ_{CLEAR,SET}_FEATURE, and 160 * are read as a bit array returned by USB_REQ_GET_STATUS. (So there 161 * are at most sixteen features of each type.) 162 */ 163 #define USB_DEVICE_SELF_POWERED 0 /* (read only) */ 164 #define USB_DEVICE_REMOTE_WAKEUP 1 /* dev may initiate wakeup */ 165 #define USB_DEVICE_TEST_MODE 2 /* (wired high speed only) */ 166 #define USB_DEVICE_BATTERY 2 /* (wireless) */ 167 #define USB_DEVICE_B_HNP_ENABLE 3 /* (otg) dev may initiate HNP */ 168 #define USB_DEVICE_WUSB_DEVICE 3 /* (wireless) */ 169 #define USB_DEVICE_A_HNP_SUPPORT 4 /* (otg) RH port supports HNP */ 170 #define USB_DEVICE_A_ALT_HNP_SUPPORT 5 /* (otg) other RH port does */ 171 #define USB_DEVICE_DEBUG_MODE 6 /* (special devices only) */ 172 173 #define USB_ENDPOINT_HALT 0 /* IN/OUT will STALL */ 174 175 #define PIPE_ISOCHRONOUS 0x01 /* UE_ISOCHRONOUS */ 176 #define PIPE_INTERRUPT 0x03 /* UE_INTERRUPT */ 177 #define PIPE_CONTROL 0x00 /* UE_CONTROL */ 178 #define PIPE_BULK 0x02 /* UE_BULK */ 179 180 #ifdef LOSCFG_NET_LWIP_SACK 181 #define USB_FRAMES_MAX 20 182 #endif 183 /* Whenever Linux references an USB endpoint: 184 * a) to initialize "urb->endpoint" 185 * b) second argument passed to "usb_control_msg()" 186 * 187 * Then it uses one of the following macros. The "endpoint" argument 188 * is the physical endpoint value masked by 0xF. The "dev" argument 189 * is a pointer to "struct usb_device". 190 */ 191 #define usb_sndctrlpipe(dev,endpoint) \ 192 usb_find_host_endpoint(dev, PIPE_CONTROL, (endpoint) | USB_DIR_OUT) 193 194 #define usb_rcvctrlpipe(dev,endpoint) \ 195 usb_find_host_endpoint(dev, PIPE_CONTROL, (endpoint) | USB_DIR_IN) 196 197 #define usb_sndisocpipe(dev,endpoint) \ 198 usb_find_host_endpoint(dev, PIPE_ISOCHRONOUS, (endpoint) | USB_DIR_OUT) 199 200 #define usb_rcvisocpipe(dev,endpoint) \ 201 usb_find_host_endpoint(dev, PIPE_ISOCHRONOUS, (endpoint) | USB_DIR_IN) 202 203 #define usb_sndbulkpipe(dev,endpoint) \ 204 usb_find_host_endpoint(dev, PIPE_BULK, (endpoint) | USB_DIR_OUT) 205 206 #define usb_rcvbulkpipe(dev,endpoint) \ 207 usb_find_host_endpoint(dev, PIPE_BULK, (endpoint) | USB_DIR_IN) 208 209 #define usb_sndintpipe(dev,endpoint) \ 210 usb_find_host_endpoint(dev, PIPE_INTERRUPT, (endpoint) | USB_DIR_OUT) 211 212 #define usb_rcvintpipe(dev,endpoint) \ 213 usb_find_host_endpoint(dev, PIPE_INTERRUPT, (endpoint) | USB_DIR_IN) 214 215 /* 216 * The following structure is used to extend "struct urb" when we are 217 * dealing with an isochronous endpoint. It contains information about 218 * the data offset and data length of an isochronous packet. 219 * The "actual_length" field is updated before the "complete" 220 * callback in the "urb" structure is called. 221 */ 222 struct usb_iso_packet_descriptor { 223 uint32_t offset; /* depreciated buffer offset (the 224 * packets are usually back to back) */ 225 uint16_t length; /* expected length */ 226 uint16_t actual_length; 227 int16_t status; /* transfer status */ 228 }; 229 230 /* 231 * The following structure holds various information about an USB 232 * transfer. This structure is used for all kinds of USB transfers. 233 * 234 * URB is short for USB Request Block. 235 */ 236 struct urb { 237 TAILQ_ENTRY(urb) bsd_urb_list; 238 struct cv cv_wait; 239 240 struct usb_device *dev; /* (in) pointer to associated device */ 241 struct usb_host_endpoint *endpoint; /* (in) pipe pointer */ 242 uint8_t *setup_packet; /* (in) setup packet (control only) */ 243 uint8_t *bsd_data_ptr; 244 void *transfer_buffer; /* (in) associated data buffer */ 245 void *context; /* (in) context for completion */ 246 usb_complete_t *complete; /* (in) completion routine */ 247 248 usb_size_t transfer_buffer_length;/* (in) data buffer length */ 249 usb_size_t bsd_length_rem; 250 usb_size_t actual_length; /* (return) actual transfer length */ 251 usb_timeout_t timeout; /* FreeBSD specific */ 252 253 uint16_t transfer_flags; /* (in) */ 254 #define URB_SHORT_NOT_OK 0x0001 /* report short transfers like errors */ 255 #define URB_ISO_ASAP 0x0002 /* ignore "start_frame" field */ 256 #define URB_ZERO_PACKET 0x0004 /* the USB transfer ends with a short 257 * packet */ 258 #define URB_NO_TRANSFER_DMA_MAP 0x0008 /* "transfer_dma" is valid on submit */ 259 #define URB_WAIT_WAKEUP 0x0010 /* custom flags */ 260 #define URB_IS_SLEEPING 0x0020 /* custom flags */ 261 262 usb_frcount_t start_frame; /* (modify) start frame (ISO) */ 263 usb_frcount_t number_of_packets; /* (in) number of ISO packets */ 264 uint16_t interval; /* (modify) transfer interval 265 * (INT/ISO) */ 266 uint16_t error_count; /* (return) number of ISO errors */ 267 int16_t status; /* (return) status */ 268 269 uint8_t setup_dma; /* (in) not used on FreeBSD */ 270 uint8_t transfer_dma; /* (in) not used on FreeBSD */ 271 uint8_t bsd_isread; 272 uint8_t kill_count; /* FreeBSD specific */ 273 274 #ifdef LOSCFG_NET_LWIP_SACK 275 uint8_t transfer_agg; 276 struct pbuf_dma_info *packets[USB_FRAMES_MAX]; /* ptr to packets */ 277 uint8_t agg_num; /* number of packets transfered once */ 278 #endif 279 struct usb_iso_packet_descriptor iso_frame_desc[]; /* (in) ISO ONLY */ 280 }; 281 282 /* various prototypes */ 283 #ifdef LOSCFG_DRIVERS_HDF_USB_DDK_HOST 284 int usb_create_usb_device(struct usb_device *udev); 285 #endif 286 int usb_submit_urb(struct urb *urb, uint16_t mem_flags); 287 int usb_unlink_urb(struct urb *urb); 288 int usb_clear_halt(struct usb_device *dev, struct usb_host_endpoint *uhe); 289 int usb_control_msg(struct usb_device *dev, struct usb_host_endpoint *ep, 290 uint8_t request, uint8_t requesttype, uint16_t value, 291 uint16_t index, void *data, uint16_t size, usb_timeout_t timeout); 292 int usb_set_interface(struct usb_device *dev, uint8_t ifnum, 293 uint8_t alternate); 294 int usb_setup_endpoint_agg(struct usb_device *dev, 295 struct usb_host_endpoint *uhe, usb_frlength_t bufsize, uint32_t packets); 296 int usb_setup_endpoint(struct usb_device *dev, 297 struct usb_host_endpoint *uhe, usb_frlength_t bufsize); 298 299 struct usb_host_endpoint *usb_find_host_endpoint(struct usb_device *dev, 300 uint8_t type, uint8_t ep); 301 struct urb *usb_alloc_urb(uint16_t iso_packets, uint16_t mem_flags); 302 struct usb_host_interface *usb_altnum_to_altsetting( 303 const struct usb_interface *intf, uint8_t alt_index); 304 struct usb_interface *usb_ifnum_to_if(struct usb_device *dev, uint8_t iface_no); 305 306 void *usb_buffer_alloc(struct usb_device *dev, usb_size_t size, 307 uint16_t mem_flags, uint8_t *dma_addr); 308 void *usbd_get_intfdata(struct usb_interface *intf); 309 310 void usb_buffer_free(struct usb_device *dev, usb_size_t size, void *addr, uint8_t dma_addr); 311 void usb_free_urb(struct urb *urb); 312 void usb_init_urb(struct urb *urb); 313 void usb_kill_urb(struct urb *urb); 314 void usb_set_intfdata(struct usb_interface *intf, void *data); 315 void usb_linux_register(void *arg); 316 void usb_linux_deregister(void *arg); 317 318 void usb_fill_bulk_urb(struct urb *, struct usb_device *, 319 struct usb_host_endpoint *, void *, int, usb_complete_t, void *); 320 int usb_bulk_msg(struct usb_device *, struct usb_host_endpoint *, 321 void *, int, uint16_t *, usb_timeout_t); 322 char *usb_alloc_dma(int length); 323 void usb_free_dma(char* buf); 324 void *usb_get_intfdata(struct usb_interface *intf); 325 326 #define interface_to_usbdev(intf) (intf)->linux_udev 327 #define interface_to_bsddev(intf) (intf)->linux_udev 328 329 #endif /* _USB_COMPAT_LINUX_H */ 330