usb.h revision 193644
1184610Salfred/* $FreeBSD: head/sys/dev/usb/usb_compat_linux.h 193644 2009-06-07 19:41:11Z thompsa $ */ 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 31184610Salfredstruct usb_device; 32184610Salfredstruct usb_interface; 33184610Salfredstruct usb_driver; 34184610Salfredstruct urb; 35184610Salfred 36184610Salfredtypedef void *pm_message_t; 37184610Salfredtypedef void (usb_complete_t)(struct urb *); 38184610Salfred 39184610Salfred#define USB_MAX_FULL_SPEED_ISOC_FRAMES (60 * 1) 40184610Salfred#define USB_MAX_HIGH_SPEED_ISOC_FRAMES (60 * 8) 41184610Salfred 42184610Salfred/* 43184610Salfred * Linux compatible USB device drivers put their device information 44184610Salfred * into the "usb_device_id" structure using the "USB_DEVICE()" macro. 45184610Salfred * The "MODULE_DEVICE_TABLE()" macro can be used to export this 46184610Salfred * information to userland. 47184610Salfred */ 48184610Salfredstruct usb_device_id { 49184610Salfred /* which fields to match against */ 50184610Salfred uint16_t match_flags; 51184610Salfred#define USB_DEVICE_ID_MATCH_VENDOR 0x0001 52184610Salfred#define USB_DEVICE_ID_MATCH_PRODUCT 0x0002 53184610Salfred#define USB_DEVICE_ID_MATCH_DEV_LO 0x0004 54184610Salfred#define USB_DEVICE_ID_MATCH_DEV_HI 0x0008 55184610Salfred#define USB_DEVICE_ID_MATCH_DEV_CLASS 0x0010 56184610Salfred#define USB_DEVICE_ID_MATCH_DEV_SUBCLASS 0x0020 57184610Salfred#define USB_DEVICE_ID_MATCH_DEV_PROTOCOL 0x0040 58184610Salfred#define USB_DEVICE_ID_MATCH_INT_CLASS 0x0080 59184610Salfred#define USB_DEVICE_ID_MATCH_INT_SUBCLASS 0x0100 60184610Salfred#define USB_DEVICE_ID_MATCH_INT_PROTOCOL 0x0200 61184610Salfred 62184610Salfred /* Used for product specific matches; the BCD range is inclusive */ 63184610Salfred uint16_t idVendor; 64184610Salfred uint16_t idProduct; 65184610Salfred uint16_t bcdDevice_lo; 66184610Salfred uint16_t bcdDevice_hi; 67184610Salfred 68184610Salfred /* Used for device class matches */ 69184610Salfred uint8_t bDeviceClass; 70184610Salfred uint8_t bDeviceSubClass; 71184610Salfred uint8_t bDeviceProtocol; 72184610Salfred 73184610Salfred /* Used for interface class matches */ 74184610Salfred uint8_t bInterfaceClass; 75184610Salfred uint8_t bInterfaceSubClass; 76184610Salfred uint8_t bInterfaceProtocol; 77184610Salfred 78184610Salfred /* Hook for driver specific information */ 79184610Salfred unsigned long driver_info; 80184610Salfred}; 81184610Salfred 82184610Salfred#define USB_DEVICE_ID_MATCH_DEVICE \ 83184610Salfred (USB_DEVICE_ID_MATCH_VENDOR | USB_DEVICE_ID_MATCH_PRODUCT) 84184610Salfred 85184610Salfred#define USB_DEVICE(vend,prod) \ 86184610Salfred .match_flags = USB_DEVICE_ID_MATCH_DEVICE, .idVendor = (vend), \ 87184610Salfred .idProduct = (prod) 88184610Salfred 89184610Salfred/* The "usb_driver" structure holds the Linux USB device driver 90184610Salfred * callbacks, and a pointer to device ID's which this entry should 91184610Salfred * match against. Usually this entry is exposed to the USB emulation 92184610Salfred * layer using the "USB_DRIVER_EXPORT()" macro, which is defined 93184610Salfred * below. 94184610Salfred */ 95184610Salfredstruct usb_driver { 96184610Salfred const char *name; 97184610Salfred 98184610Salfred int (*probe) (struct usb_interface *intf, 99184610Salfred const struct usb_device_id *id); 100184610Salfred 101184610Salfred void (*disconnect) (struct usb_interface *intf); 102184610Salfred 103184610Salfred int (*ioctl) (struct usb_interface *intf, unsigned int code, 104184610Salfred void *buf); 105184610Salfred 106184610Salfred int (*suspend) (struct usb_interface *intf, pm_message_t message); 107184610Salfred int (*resume) (struct usb_interface *intf); 108184610Salfred 109184610Salfred const struct usb_device_id *id_table; 110184610Salfred 111184610Salfred void (*shutdown) (struct usb_interface *intf); 112184610Salfred 113184610Salfred LIST_ENTRY(usb_driver) linux_driver_list; 114184610Salfred}; 115184610Salfred 116184610Salfred#define USB_DRIVER_EXPORT(id,p_usb_drv) \ 117184610Salfred SYSINIT(id,SI_SUB_KLD,SI_ORDER_FIRST,usb_linux_register,p_usb_drv); \ 118184610Salfred SYSUNINIT(id,SI_SUB_KLD,SI_ORDER_ANY,usb_linux_deregister,p_usb_drv) 119184610Salfred 120184610Salfred#define USB_DT_ENDPOINT_SIZE 7 121184610Salfred#define USB_DT_ENDPOINT_AUDIO_SIZE 9 122184610Salfred 123184610Salfred/* 124184610Salfred * Endpoints 125184610Salfred */ 126184610Salfred#define USB_ENDPOINT_NUMBER_MASK 0x0f /* in bEndpointAddress */ 127184610Salfred#define USB_ENDPOINT_DIR_MASK 0x80 128184610Salfred 129184610Salfred#define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */ 130184610Salfred#define USB_ENDPOINT_XFER_CONTROL 0 131184610Salfred#define USB_ENDPOINT_XFER_ISOC 1 132184610Salfred#define USB_ENDPOINT_XFER_BULK 2 133184610Salfred#define USB_ENDPOINT_XFER_INT 3 134184610Salfred#define USB_ENDPOINT_MAX_ADJUSTABLE 0x80 135184610Salfred 136184610Salfred/* CONTROL REQUEST SUPPORT */ 137184610Salfred 138184610Salfred/* 139184610Salfred * Definition of direction mask for 140184610Salfred * "bEndpointAddress" and "bmRequestType": 141184610Salfred */ 142184610Salfred#define USB_DIR_MASK 0x80 143184610Salfred#define USB_DIR_OUT 0x00 /* write to USB device */ 144184610Salfred#define USB_DIR_IN 0x80 /* read from USB device */ 145184610Salfred 146184610Salfred/* 147184610Salfred * Definition of type mask for 148184610Salfred * "bmRequestType": 149184610Salfred */ 150184610Salfred#define USB_TYPE_MASK (0x03 << 5) 151184610Salfred#define USB_TYPE_STANDARD (0x00 << 5) 152184610Salfred#define USB_TYPE_CLASS (0x01 << 5) 153184610Salfred#define USB_TYPE_VENDOR (0x02 << 5) 154184610Salfred#define USB_TYPE_RESERVED (0x03 << 5) 155184610Salfred 156184610Salfred/* 157184610Salfred * Definition of receiver mask for 158184610Salfred * "bmRequestType": 159184610Salfred */ 160184610Salfred#define USB_RECIP_MASK 0x1f 161184610Salfred#define USB_RECIP_DEVICE 0x00 162184610Salfred#define USB_RECIP_INTERFACE 0x01 163184610Salfred#define USB_RECIP_ENDPOINT 0x02 164184610Salfred#define USB_RECIP_OTHER 0x03 165184610Salfred 166184610Salfred/* 167184610Salfred * Definition of standard request values for 168184610Salfred * "bRequest": 169184610Salfred */ 170184610Salfred#define USB_REQ_GET_STATUS 0x00 171184610Salfred#define USB_REQ_CLEAR_FEATURE 0x01 172184610Salfred#define USB_REQ_SET_FEATURE 0x03 173184610Salfred#define USB_REQ_SET_ADDRESS 0x05 174184610Salfred#define USB_REQ_GET_DESCRIPTOR 0x06 175184610Salfred#define USB_REQ_SET_DESCRIPTOR 0x07 176184610Salfred#define USB_REQ_GET_CONFIGURATION 0x08 177184610Salfred#define USB_REQ_SET_CONFIGURATION 0x09 178184610Salfred#define USB_REQ_GET_INTERFACE 0x0A 179184610Salfred#define USB_REQ_SET_INTERFACE 0x0B 180184610Salfred#define USB_REQ_SYNCH_FRAME 0x0C 181184610Salfred 182184610Salfred#define USB_REQ_SET_ENCRYPTION 0x0D /* Wireless USB */ 183184610Salfred#define USB_REQ_GET_ENCRYPTION 0x0E 184184610Salfred#define USB_REQ_SET_HANDSHAKE 0x0F 185184610Salfred#define USB_REQ_GET_HANDSHAKE 0x10 186184610Salfred#define USB_REQ_SET_CONNECTION 0x11 187184610Salfred#define USB_REQ_SET_SECURITY_DATA 0x12 188184610Salfred#define USB_REQ_GET_SECURITY_DATA 0x13 189184610Salfred#define USB_REQ_SET_WUSB_DATA 0x14 190184610Salfred#define USB_REQ_LOOPBACK_DATA_WRITE 0x15 191184610Salfred#define USB_REQ_LOOPBACK_DATA_READ 0x16 192184610Salfred#define USB_REQ_SET_INTERFACE_DS 0x17 193184610Salfred 194184610Salfred/* 195184610Salfred * USB feature flags are written using USB_REQ_{CLEAR,SET}_FEATURE, and 196184610Salfred * are read as a bit array returned by USB_REQ_GET_STATUS. (So there 197184610Salfred * are at most sixteen features of each type.) 198184610Salfred */ 199184610Salfred#define USB_DEVICE_SELF_POWERED 0 /* (read only) */ 200184610Salfred#define USB_DEVICE_REMOTE_WAKEUP 1 /* dev may initiate wakeup */ 201184610Salfred#define USB_DEVICE_TEST_MODE 2 /* (wired high speed only) */ 202184610Salfred#define USB_DEVICE_BATTERY 2 /* (wireless) */ 203184610Salfred#define USB_DEVICE_B_HNP_ENABLE 3 /* (otg) dev may initiate HNP */ 204184610Salfred#define USB_DEVICE_WUSB_DEVICE 3 /* (wireless) */ 205184610Salfred#define USB_DEVICE_A_HNP_SUPPORT 4 /* (otg) RH port supports HNP */ 206184610Salfred#define USB_DEVICE_A_ALT_HNP_SUPPORT 5 /* (otg) other RH port does */ 207184610Salfred#define USB_DEVICE_DEBUG_MODE 6 /* (special devices only) */ 208184610Salfred 209184610Salfred#define USB_ENDPOINT_HALT 0 /* IN/OUT will STALL */ 210184610Salfred 211184610Salfred#define PIPE_ISOCHRONOUS 0x01 /* UE_ISOCHRONOUS */ 212184610Salfred#define PIPE_INTERRUPT 0x03 /* UE_INTERRUPT */ 213184610Salfred#define PIPE_CONTROL 0x00 /* UE_CONTROL */ 214184610Salfred#define PIPE_BULK 0x02 /* UE_BULK */ 215184610Salfred 216184610Salfred/* Whenever Linux references an USB endpoint: 217193644Sthompsa * a) to initialize "urb->endpoint" 218184610Salfred * b) second argument passed to "usb_control_msg()" 219184610Salfred * 220184610Salfred * Then it uses one of the following macros. The "endpoint" argument 221184610Salfred * is the physical endpoint value masked by 0xF. The "dev" argument 222184610Salfred * is a pointer to "struct usb_device". 223184610Salfred */ 224184610Salfred#define usb_sndctrlpipe(dev,endpoint) \ 225184610Salfred usb_find_host_endpoint(dev, PIPE_CONTROL, (endpoint) | USB_DIR_OUT) 226184610Salfred 227184610Salfred#define usb_rcvctrlpipe(dev,endpoint) \ 228184610Salfred usb_find_host_endpoint(dev, PIPE_CONTROL, (endpoint) | USB_DIR_IN) 229184610Salfred 230184610Salfred#define usb_sndisocpipe(dev,endpoint) \ 231184610Salfred usb_find_host_endpoint(dev, PIPE_ISOCHRONOUS, (endpoint) | USB_DIR_OUT) 232184610Salfred 233184610Salfred#define usb_rcvisocpipe(dev,endpoint) \ 234184610Salfred usb_find_host_endpoint(dev, PIPE_ISOCHRONOUS, (endpoint) | USB_DIR_IN) 235184610Salfred 236184610Salfred#define usb_sndbulkpipe(dev,endpoint) \ 237184610Salfred usb_find_host_endpoint(dev, PIPE_BULK, (endpoint) | USB_DIR_OUT) 238184610Salfred 239184610Salfred#define usb_rcvbulkpipe(dev,endpoint) \ 240184610Salfred usb_find_host_endpoint(dev, PIPE_BULK, (endpoint) | USB_DIR_IN) 241184610Salfred 242184610Salfred#define usb_sndintpipe(dev,endpoint) \ 243184610Salfred usb_find_host_endpoint(dev, PIPE_INTERRUPT, (endpoint) | USB_DIR_OUT) 244184610Salfred 245184610Salfred#define usb_rcvintpipe(dev,endpoint) \ 246184610Salfred usb_find_host_endpoint(dev, PIPE_INTERRUPT, (endpoint) | USB_DIR_IN) 247184610Salfred 248184610Salfred/* 249184610Salfred * The following structure is used to extend "struct urb" when we are 250184610Salfred * dealing with an isochronous endpoint. It contains information about 251184610Salfred * the data offset and data length of an isochronous packet. 252184610Salfred * The "actual_length" field is updated before the "complete" 253184610Salfred * callback in the "urb" structure is called. 254184610Salfred */ 255184610Salfredstruct usb_iso_packet_descriptor { 256184610Salfred uint32_t offset; /* depreciated buffer offset (the 257184610Salfred * packets are usually back to back) */ 258184610Salfred uint16_t length; /* expected length */ 259184610Salfred uint16_t actual_length; 260184610Salfred uint16_t status; 261184610Salfred}; 262184610Salfred 263184610Salfred/* 264184610Salfred * The following structure holds various information about an USB 265184610Salfred * transfer. This structure is used for all kinds of USB transfers. 266184610Salfred * 267184610Salfred * URB is short for USB Request Block. 268184610Salfred */ 269184610Salfredstruct urb { 270184610Salfred TAILQ_ENTRY(urb) bsd_urb_list; 271184610Salfred struct cv cv_wait; 272184610Salfred 273184610Salfred struct usb_device *dev; /* (in) pointer to associated device */ 274193644Sthompsa struct usb_host_endpoint *endpoint; /* (in) pipe pointer */ 275184610Salfred uint8_t *setup_packet; /* (in) setup packet (control only) */ 276184610Salfred uint8_t *bsd_data_ptr; 277184610Salfred void *transfer_buffer; /* (in) associated data buffer */ 278184610Salfred void *context; /* (in) context for completion */ 279184610Salfred usb_complete_t *complete; /* (in) completion routine */ 280184610Salfred 281193074Sthompsa usb_size_t transfer_buffer_length;/* (in) data buffer length */ 282193074Sthompsa usb_size_t bsd_length_rem; 283193074Sthompsa usb_size_t actual_length; /* (return) actual transfer length */ 284193045Sthompsa usb_timeout_t timeout; /* FreeBSD specific */ 285184610Salfred 286184610Salfred uint16_t transfer_flags; /* (in) */ 287184610Salfred#define URB_SHORT_NOT_OK 0x0001 /* report short transfers like errors */ 288184610Salfred#define URB_ISO_ASAP 0x0002 /* ignore "start_frame" field */ 289184610Salfred#define URB_ZERO_PACKET 0x0004 /* the USB transfer ends with a short 290184610Salfred * packet */ 291184610Salfred#define URB_NO_TRANSFER_DMA_MAP 0x0008 /* "transfer_dma" is valid on submit */ 292184610Salfred#define URB_WAIT_WAKEUP 0x0010 /* custom flags */ 293184610Salfred#define URB_IS_SLEEPING 0x0020 /* custom flags */ 294184610Salfred 295193045Sthompsa usb_frcount_t start_frame; /* (modify) start frame (ISO) */ 296193045Sthompsa usb_frcount_t number_of_packets; /* (in) number of ISO packets */ 297184610Salfred uint16_t interval; /* (modify) transfer interval 298184610Salfred * (INT/ISO) */ 299184610Salfred uint16_t error_count; /* (return) number of ISO errors */ 300184610Salfred int16_t status; /* (return) status */ 301184610Salfred 302184610Salfred uint8_t setup_dma; /* (in) not used on FreeBSD */ 303184610Salfred uint8_t transfer_dma; /* (in) not used on FreeBSD */ 304184610Salfred uint8_t bsd_isread; 305184610Salfred 306184610Salfred struct usb_iso_packet_descriptor iso_frame_desc[]; /* (in) ISO ONLY */ 307184610Salfred}; 308184610Salfred 309184610Salfred/* various prototypes */ 310184610Salfred 311184610Salfredint usb_submit_urb(struct urb *urb, uint16_t mem_flags); 312184610Salfredint usb_unlink_urb(struct urb *urb); 313184610Salfredint usb_clear_halt(struct usb_device *dev, struct usb_host_endpoint *uhe); 314193644Sthompsaint usb_control_msg(struct usb_device *dev, struct usb_host_endpoint *ep, 315185948Sthompsa uint8_t request, uint8_t requesttype, uint16_t value, 316193045Sthompsa uint16_t index, void *data, uint16_t size, usb_timeout_t timeout); 317185948Sthompsaint usb_set_interface(struct usb_device *dev, uint8_t ifnum, 318185948Sthompsa uint8_t alternate); 319185948Sthompsaint usb_setup_endpoint(struct usb_device *dev, 320193045Sthompsa struct usb_host_endpoint *uhe, usb_frlength_t bufsize); 321184610Salfred 322185948Sthompsastruct usb_host_endpoint *usb_find_host_endpoint(struct usb_device *dev, 323185948Sthompsa uint8_t type, uint8_t ep); 324184610Salfredstruct urb *usb_alloc_urb(uint16_t iso_packets, uint16_t mem_flags); 325185948Sthompsastruct usb_host_interface *usb_altnum_to_altsetting( 326185948Sthompsa const struct usb_interface *intf, uint8_t alt_index); 327184610Salfredstruct usb_interface *usb_ifnum_to_if(struct usb_device *dev, uint8_t iface_no); 328184610Salfred 329193074Sthompsavoid *usb_buffer_alloc(struct usb_device *dev, usb_size_t size, 330185948Sthompsa uint16_t mem_flags, uint8_t *dma_addr); 331184610Salfredvoid *usb_get_intfdata(struct usb_interface *intf); 332184610Salfred 333193074Sthompsavoid usb_buffer_free(struct usb_device *dev, usb_size_t size, void *addr, uint8_t dma_addr); 334184610Salfredvoid usb_free_urb(struct urb *urb); 335184610Salfredvoid usb_init_urb(struct urb *urb); 336184610Salfredvoid usb_kill_urb(struct urb *urb); 337184610Salfredvoid usb_set_intfdata(struct usb_interface *intf, void *data); 338184610Salfredvoid usb_linux_register(void *arg); 339184610Salfredvoid usb_linux_deregister(void *arg); 340184610Salfred 341184610Salfred#define interface_to_usbdev(intf) (intf)->linux_udev 342193317Sthompsa#define interface_to_bsddev(intf) (intf)->linux_udev 343184610Salfred 344184610Salfred#endif /* _USB_COMPAT_LINUX_H */ 345