usb.h revision 290335
1184610Salfred/* $FreeBSD: head/sys/compat/linuxkpi/common/include/linux/usb.h 290335 2015-11-03 12:37:55Z hselasky $ */ 2184610Salfred/*- 3184610Salfred * Copyright (c) 2007 Luigi Rizzo - Universita` di Pisa. All rights reserved. 4184610Salfred * Copyright (c) 2007 Hans Petter Selasky. All rights reserved. 5184610Salfred * 6184610Salfred * Redistribution and use in source and binary forms, with or without 7184610Salfred * modification, are permitted provided that the following conditions 8184610Salfred * are met: 9184610Salfred * 1. Redistributions of source code must retain the above copyright 10184610Salfred * notice, this list of conditions and the following disclaimer. 11184610Salfred * 2. Redistributions in binary form must reproduce the above copyright 12184610Salfred * notice, this list of conditions and the following disclaimer in the 13184610Salfred * documentation and/or other materials provided with the distribution. 14184610Salfred * 15184610Salfred * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16184610Salfred * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17184610Salfred * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18184610Salfred * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19184610Salfred * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20184610Salfred * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21184610Salfred * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22184610Salfred * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23184610Salfred * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24184610Salfred * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25184610Salfred * SUCH DAMAGE. 26184610Salfred */ 27184610Salfred 28184610Salfred#ifndef _USB_COMPAT_LINUX_H 29184610Salfred#define _USB_COMPAT_LINUX_H 30184610Salfred 31290335Shselasky#include <sys/types.h> 32290335Shselasky#include <sys/param.h> 33290335Shselasky#include <sys/proc.h> 34290335Shselasky#include <sys/condvar.h> 35290335Shselasky 36290335Shselasky#include <dev/usb/usb.h> 37290335Shselasky#include <dev/usb/usbdi.h> 38290335Shselasky#include <dev/usb/usbdi_util.h> 39290335Shselasky 40184610Salfredstruct usb_device; 41184610Salfredstruct usb_interface; 42184610Salfredstruct usb_driver; 43184610Salfredstruct urb; 44184610Salfred 45184610Salfredtypedef void *pm_message_t; 46184610Salfredtypedef void (usb_complete_t)(struct urb *); 47184610Salfred 48184610Salfred#define USB_MAX_FULL_SPEED_ISOC_FRAMES (60 * 1) 49184610Salfred#define USB_MAX_HIGH_SPEED_ISOC_FRAMES (60 * 8) 50184610Salfred 51184610Salfred#define USB_DEVICE_ID_MATCH_DEVICE \ 52184610Salfred (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT) 53184610Salfred 54184610Salfred#define USB_DEVICE(vend,prod) \ 55184610Salfred .match_flags = USB_DEVICE_ID_MATCH_DEVICE, .idVendor = (vend), \ 56184610Salfred .idProduct = (prod) 57184610Salfred 58184610Salfred/* The "usb_driver" structure holds the Linux USB device driver 59184610Salfred * callbacks, and a pointer to device ID's which this entry should 60184610Salfred * match against. Usually this entry is exposed to the USB emulation 61184610Salfred * layer using the "USB_DRIVER_EXPORT()" macro, which is defined 62184610Salfred * below. 63184610Salfred */ 64184610Salfredstruct usb_driver { 65184610Salfred const char *name; 66184610Salfred 67184610Salfred int (*probe) (struct usb_interface *intf, 68184610Salfred const struct usb_device_id *id); 69184610Salfred 70184610Salfred void (*disconnect) (struct usb_interface *intf); 71184610Salfred 72184610Salfred int (*ioctl) (struct usb_interface *intf, unsigned int code, 73184610Salfred void *buf); 74184610Salfred 75184610Salfred int (*suspend) (struct usb_interface *intf, pm_message_t message); 76184610Salfred int (*resume) (struct usb_interface *intf); 77184610Salfred 78184610Salfred const struct usb_device_id *id_table; 79184610Salfred 80184610Salfred void (*shutdown) (struct usb_interface *intf); 81184610Salfred 82184610Salfred LIST_ENTRY(usb_driver) linux_driver_list; 83184610Salfred}; 84184610Salfred 85184610Salfred#define USB_DRIVER_EXPORT(id,p_usb_drv) \ 86184610Salfred SYSINIT(id,SI_SUB_KLD,SI_ORDER_FIRST,usb_linux_register,p_usb_drv); \ 87184610Salfred SYSUNINIT(id,SI_SUB_KLD,SI_ORDER_ANY,usb_linux_deregister,p_usb_drv) 88184610Salfred 89184610Salfred#define USB_DT_ENDPOINT_SIZE 7 90184610Salfred#define USB_DT_ENDPOINT_AUDIO_SIZE 9 91184610Salfred 92184610Salfred/* 93184610Salfred * Endpoints 94184610Salfred */ 95184610Salfred#define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */ 96184610Salfred#define USB_ENDPOINT_DIR_MASK 0x80 97184610Salfred 98184610Salfred#define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */ 99184610Salfred#define USB_ENDPOINT_XFER_CONTROL 0 100184610Salfred#define USB_ENDPOINT_XFER_ISOC 1 101184610Salfred#define USB_ENDPOINT_XFER_BULK 2 102184610Salfred#define USB_ENDPOINT_XFER_INT 3 103184610Salfred#define USB_ENDPOINT_MAX_ADJUSTABLE 0x80 104184610Salfred 105184610Salfred/* CONTROL REQUEST SUPPORT */ 106184610Salfred 107184610Salfred/* 108184610Salfred * Definition of direction mask for 109184610Salfred * "bEndpointAddress" and "bmRequestType": 110184610Salfred */ 111184610Salfred#define USB_DIR_MASK 0x80 112184610Salfred#define USB_DIR_OUT 0x00 /* write to USB device */ 113184610Salfred#define USB_DIR_IN 0x80 /* read from USB device */ 114184610Salfred 115184610Salfred/* 116184610Salfred * Definition of type mask for 117184610Salfred * "bmRequestType": 118184610Salfred */ 119184610Salfred#define USB_TYPE_MASK (0x03 << 5) 120184610Salfred#define USB_TYPE_STANDARD (0x00 << 5) 121184610Salfred#define USB_TYPE_CLASS (0x01 << 5) 122184610Salfred#define USB_TYPE_VENDOR (0x02 << 5) 123184610Salfred#define USB_TYPE_RESERVED (0x03 << 5) 124184610Salfred 125184610Salfred/* 126184610Salfred * Definition of receiver mask for 127184610Salfred * "bmRequestType": 128184610Salfred */ 129184610Salfred#define USB_RECIP_MASK 0x1f 130184610Salfred#define USB_RECIP_DEVICE 0x00 131184610Salfred#define USB_RECIP_INTERFACE 0x01 132184610Salfred#define USB_RECIP_ENDPOINT 0x02 133184610Salfred#define USB_RECIP_OTHER 0x03 134184610Salfred 135184610Salfred/* 136184610Salfred * Definition of standard request values for 137184610Salfred * "bRequest": 138184610Salfred */ 139184610Salfred#define USB_REQ_GET_STATUS 0x00 140184610Salfred#define USB_REQ_CLEAR_FEATURE 0x01 141184610Salfred#define USB_REQ_SET_FEATURE 0x03 142184610Salfred#define USB_REQ_SET_ADDRESS 0x05 143184610Salfred#define USB_REQ_GET_DESCRIPTOR 0x06 144184610Salfred#define USB_REQ_SET_DESCRIPTOR 0x07 145184610Salfred#define USB_REQ_GET_CONFIGURATION 0x08 146184610Salfred#define USB_REQ_SET_CONFIGURATION 0x09 147184610Salfred#define USB_REQ_GET_INTERFACE 0x0A 148184610Salfred#define USB_REQ_SET_INTERFACE 0x0B 149184610Salfred#define USB_REQ_SYNCH_FRAME 0x0C 150184610Salfred 151184610Salfred#define USB_REQ_SET_ENCRYPTION 0x0D /* Wireless USB */ 152184610Salfred#define USB_REQ_GET_ENCRYPTION 0x0E 153184610Salfred#define USB_REQ_SET_HANDSHAKE 0x0F 154184610Salfred#define USB_REQ_GET_HANDSHAKE 0x10 155184610Salfred#define USB_REQ_SET_CONNECTION 0x11 156184610Salfred#define USB_REQ_SET_SECURITY_DATA 0x12 157184610Salfred#define USB_REQ_GET_SECURITY_DATA 0x13 158184610Salfred#define USB_REQ_SET_WUSB_DATA 0x14 159184610Salfred#define USB_REQ_LOOPBACK_DATA_WRITE 0x15 160184610Salfred#define USB_REQ_LOOPBACK_DATA_READ 0x16 161184610Salfred#define USB_REQ_SET_INTERFACE_DS 0x17 162184610Salfred 163184610Salfred/* 164184610Salfred * USB feature flags are written using USB_REQ_{CLEAR,SET}_FEATURE, and 165184610Salfred * are read as a bit array returned by USB_REQ_GET_STATUS. (So there 166184610Salfred * are at most sixteen features of each type.) 167184610Salfred */ 168184610Salfred#define USB_DEVICE_SELF_POWERED 0 /* (read only) */ 169184610Salfred#define USB_DEVICE_REMOTE_WAKEUP 1 /* dev may initiate wakeup */ 170184610Salfred#define USB_DEVICE_TEST_MODE 2 /* (wired high speed only) */ 171184610Salfred#define USB_DEVICE_BATTERY 2 /* (wireless) */ 172184610Salfred#define USB_DEVICE_B_HNP_ENABLE 3 /* (otg) dev may initiate HNP */ 173184610Salfred#define USB_DEVICE_WUSB_DEVICE 3 /* (wireless) */ 174184610Salfred#define USB_DEVICE_A_HNP_SUPPORT 4 /* (otg) RH port supports HNP */ 175184610Salfred#define USB_DEVICE_A_ALT_HNP_SUPPORT 5 /* (otg) other RH port does */ 176184610Salfred#define USB_DEVICE_DEBUG_MODE 6 /* (special devices only) */ 177184610Salfred 178184610Salfred#define USB_ENDPOINT_HALT 0 /* IN/OUT will STALL */ 179184610Salfred 180184610Salfred#define PIPE_ISOCHRONOUS 0x01 /* UE_ISOCHRONOUS */ 181184610Salfred#define PIPE_INTERRUPT 0x03 /* UE_INTERRUPT */ 182184610Salfred#define PIPE_CONTROL 0x00 /* UE_CONTROL */ 183184610Salfred#define PIPE_BULK 0x02 /* UE_BULK */ 184184610Salfred 185184610Salfred/* Whenever Linux references an USB endpoint: 186193644Sthompsa * a) to initialize "urb->endpoint" 187184610Salfred * b) second argument passed to "usb_control_msg()" 188184610Salfred * 189184610Salfred * Then it uses one of the following macros. The "endpoint" argument 190184610Salfred * is the physical endpoint value masked by 0xF. The "dev" argument 191184610Salfred * is a pointer to "struct usb_device". 192184610Salfred */ 193184610Salfred#define usb_sndctrlpipe(dev,endpoint) \ 194184610Salfred usb_find_host_endpoint(dev, PIPE_CONTROL, (endpoint) | USB_DIR_OUT) 195184610Salfred 196184610Salfred#define usb_rcvctrlpipe(dev,endpoint) \ 197184610Salfred usb_find_host_endpoint(dev, PIPE_CONTROL, (endpoint) | USB_DIR_IN) 198184610Salfred 199184610Salfred#define usb_sndisocpipe(dev,endpoint) \ 200184610Salfred usb_find_host_endpoint(dev, PIPE_ISOCHRONOUS, (endpoint) | USB_DIR_OUT) 201184610Salfred 202184610Salfred#define usb_rcvisocpipe(dev,endpoint) \ 203184610Salfred usb_find_host_endpoint(dev, PIPE_ISOCHRONOUS, (endpoint) | USB_DIR_IN) 204184610Salfred 205184610Salfred#define usb_sndbulkpipe(dev,endpoint) \ 206184610Salfred usb_find_host_endpoint(dev, PIPE_BULK, (endpoint) | USB_DIR_OUT) 207184610Salfred 208184610Salfred#define usb_rcvbulkpipe(dev,endpoint) \ 209184610Salfred usb_find_host_endpoint(dev, PIPE_BULK, (endpoint) | USB_DIR_IN) 210184610Salfred 211184610Salfred#define usb_sndintpipe(dev,endpoint) \ 212184610Salfred usb_find_host_endpoint(dev, PIPE_INTERRUPT, (endpoint) | USB_DIR_OUT) 213184610Salfred 214184610Salfred#define usb_rcvintpipe(dev,endpoint) \ 215184610Salfred usb_find_host_endpoint(dev, PIPE_INTERRUPT, (endpoint) | USB_DIR_IN) 216184610Salfred 217184610Salfred/* 218184610Salfred * The following structure is used to extend "struct urb" when we are 219184610Salfred * dealing with an isochronous endpoint. It contains information about 220184610Salfred * the data offset and data length of an isochronous packet. 221184610Salfred * The "actual_length" field is updated before the "complete" 222184610Salfred * callback in the "urb" structure is called. 223184610Salfred */ 224184610Salfredstruct usb_iso_packet_descriptor { 225184610Salfred uint32_t offset; /* depreciated buffer offset (the 226184610Salfred * packets are usually back to back) */ 227184610Salfred uint16_t length; /* expected length */ 228184610Salfred uint16_t actual_length; 229198776Sthompsa int16_t status; /* transfer status */ 230184610Salfred}; 231184610Salfred 232184610Salfred/* 233184610Salfred * The following structure holds various information about an USB 234184610Salfred * transfer. This structure is used for all kinds of USB transfers. 235184610Salfred * 236184610Salfred * URB is short for USB Request Block. 237184610Salfred */ 238184610Salfredstruct urb { 239184610Salfred TAILQ_ENTRY(urb) bsd_urb_list; 240184610Salfred struct cv cv_wait; 241184610Salfred 242184610Salfred struct usb_device *dev; /* (in) pointer to associated device */ 243193644Sthompsa struct usb_host_endpoint *endpoint; /* (in) pipe pointer */ 244184610Salfred uint8_t *setup_packet; /* (in) setup packet (control only) */ 245184610Salfred uint8_t *bsd_data_ptr; 246184610Salfred void *transfer_buffer; /* (in) associated data buffer */ 247184610Salfred void *context; /* (in) context for completion */ 248184610Salfred usb_complete_t *complete; /* (in) completion routine */ 249184610Salfred 250193074Sthompsa usb_size_t transfer_buffer_length;/* (in) data buffer length */ 251193074Sthompsa usb_size_t bsd_length_rem; 252193074Sthompsa usb_size_t actual_length; /* (return) actual transfer length */ 253193045Sthompsa usb_timeout_t timeout; /* FreeBSD specific */ 254184610Salfred 255184610Salfred uint16_t transfer_flags; /* (in) */ 256184610Salfred#define URB_SHORT_NOT_OK 0x0001 /* report short transfers like errors */ 257184610Salfred#define URB_ISO_ASAP 0x0002 /* ignore "start_frame" field */ 258184610Salfred#define URB_ZERO_PACKET 0x0004 /* the USB transfer ends with a short 259184610Salfred * packet */ 260184610Salfred#define URB_NO_TRANSFER_DMA_MAP 0x0008 /* "transfer_dma" is valid on submit */ 261184610Salfred#define URB_WAIT_WAKEUP 0x0010 /* custom flags */ 262184610Salfred#define URB_IS_SLEEPING 0x0020 /* custom flags */ 263184610Salfred 264193045Sthompsa usb_frcount_t start_frame; /* (modify) start frame (ISO) */ 265193045Sthompsa usb_frcount_t number_of_packets; /* (in) number of ISO packets */ 266184610Salfred uint16_t interval; /* (modify) transfer interval 267184610Salfred * (INT/ISO) */ 268184610Salfred uint16_t error_count; /* (return) number of ISO errors */ 269184610Salfred int16_t status; /* (return) status */ 270184610Salfred 271184610Salfred uint8_t setup_dma; /* (in) not used on FreeBSD */ 272184610Salfred uint8_t transfer_dma; /* (in) not used on FreeBSD */ 273184610Salfred uint8_t bsd_isread; 274195966Salfred uint8_t kill_count; /* FreeBSD specific */ 275184610Salfred 276184610Salfred struct usb_iso_packet_descriptor iso_frame_desc[]; /* (in) ISO ONLY */ 277184610Salfred}; 278184610Salfred 279184610Salfred/* various prototypes */ 280184610Salfred 281184610Salfredint usb_submit_urb(struct urb *urb, uint16_t mem_flags); 282184610Salfredint usb_unlink_urb(struct urb *urb); 283184610Salfredint usb_clear_halt(struct usb_device *dev, struct usb_host_endpoint *uhe); 284193644Sthompsaint usb_control_msg(struct usb_device *dev, struct usb_host_endpoint *ep, 285185948Sthompsa uint8_t request, uint8_t requesttype, uint16_t value, 286193045Sthompsa uint16_t index, void *data, uint16_t size, usb_timeout_t timeout); 287185948Sthompsaint usb_set_interface(struct usb_device *dev, uint8_t ifnum, 288185948Sthompsa uint8_t alternate); 289185948Sthompsaint usb_setup_endpoint(struct usb_device *dev, 290193045Sthompsa struct usb_host_endpoint *uhe, usb_frlength_t bufsize); 291184610Salfred 292185948Sthompsastruct usb_host_endpoint *usb_find_host_endpoint(struct usb_device *dev, 293185948Sthompsa uint8_t type, uint8_t ep); 294184610Salfredstruct urb *usb_alloc_urb(uint16_t iso_packets, uint16_t mem_flags); 295185948Sthompsastruct usb_host_interface *usb_altnum_to_altsetting( 296185948Sthompsa const struct usb_interface *intf, uint8_t alt_index); 297184610Salfredstruct usb_interface *usb_ifnum_to_if(struct usb_device *dev, uint8_t iface_no); 298184610Salfred 299193074Sthompsavoid *usb_buffer_alloc(struct usb_device *dev, usb_size_t size, 300185948Sthompsa uint16_t mem_flags, uint8_t *dma_addr); 301194228Sthompsavoid *usbd_get_intfdata(struct usb_interface *intf); 302184610Salfred 303193074Sthompsavoid usb_buffer_free(struct usb_device *dev, usb_size_t size, void *addr, uint8_t dma_addr); 304184610Salfredvoid usb_free_urb(struct urb *urb); 305184610Salfredvoid usb_init_urb(struct urb *urb); 306184610Salfredvoid usb_kill_urb(struct urb *urb); 307184610Salfredvoid usb_set_intfdata(struct usb_interface *intf, void *data); 308184610Salfredvoid usb_linux_register(void *arg); 309184610Salfredvoid usb_linux_deregister(void *arg); 310184610Salfred 311198776Sthompsavoid usb_fill_bulk_urb(struct urb *, struct usb_device *, 312198776Sthompsa struct usb_host_endpoint *, void *, int, usb_complete_t, void *); 313198776Sthompsaint usb_bulk_msg(struct usb_device *, struct usb_host_endpoint *, 314198776Sthompsa void *, int, uint16_t *, usb_timeout_t); 315198776Sthompsa 316184610Salfred#define interface_to_usbdev(intf) (intf)->linux_udev 317193317Sthompsa#define interface_to_bsddev(intf) (intf)->linux_udev 318184610Salfred 319184610Salfred#endif /* _USB_COMPAT_LINUX_H */ 320