usb_ioctl.h revision 246789
1272343Sngie/* $FreeBSD: head/sys/dev/usb/usb_ioctl.h 246789 2013-02-14 12:22:40Z hselasky $ */ 2272343Sngie/*- 3272343Sngie * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 4272343Sngie * Copyright (c) 1998 The NetBSD Foundation, Inc. All rights reserved. 5272343Sngie * Copyright (c) 1998 Lennart Augustsson. All rights reserved. 6272343Sngie * 7272343Sngie * Redistribution and use in source and binary forms, with or without 8272343Sngie * modification, are permitted provided that the following conditions 9272343Sngie * are met: 10272343Sngie * 1. Redistributions of source code must retain the above copyright 11272343Sngie * notice, this list of conditions and the following disclaimer. 12272343Sngie * 2. Redistributions in binary form must reproduce the above copyright 13272343Sngie * notice, this list of conditions and the following disclaimer in the 14272343Sngie * 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_IOCTL_H_ 30#define _USB_IOCTL_H_ 31 32#ifndef USB_GLOBAL_INCLUDE_FILE 33#include <sys/ioccom.h> 34 35/* Building "kdump" depends on these includes */ 36 37#include <dev/usb/usb_endian.h> 38#include <dev/usb/usb.h> 39#endif 40 41#define USB_DEVICE_NAME "usbctl" 42#define USB_DEVICE_DIR "usb" 43#define USB_GENERIC_NAME "ugen" 44#define USB_TEMPLATE_SYSCTL "hw.usb.template" /* integer type */ 45 46/* Definition of valid template sysctl values */ 47 48enum { 49 USB_TEMP_MSC, /* USB Mass Storage */ 50 USB_TEMP_CDCE, /* USB CDC Ethernet */ 51 USB_TEMP_MTP, /* Message Transfer Protocol */ 52 USB_TEMP_MODEM, /* USB CDC Modem */ 53 USB_TEMP_AUDIO, /* USB Audio */ 54 USB_TEMP_KBD, /* USB Keyboard */ 55 USB_TEMP_MOUSE, /* USB Mouse */ 56 USB_TEMP_MAX, 57}; 58 59struct usb_read_dir { 60#ifdef COMPAT_32BIT 61 uint64_t urd_data; 62#else 63 void *urd_data; 64#endif 65 uint32_t urd_startentry; 66 uint32_t urd_maxlen; 67}; 68 69struct usb_ctl_request { 70#ifdef COMPAT_32BIT 71 uint64_t ucr_data; 72#else 73 void *ucr_data; 74#endif 75 uint16_t ucr_flags; 76 uint16_t ucr_actlen; /* actual length transferred */ 77 uint8_t ucr_addr; /* zero - currently not used */ 78 struct usb_device_request ucr_request; 79}; 80 81struct usb_alt_interface { 82 uint8_t uai_interface_index; 83 uint8_t uai_alt_index; 84}; 85 86struct usb_gen_descriptor { 87#ifdef COMPAT_32BIT 88 uint64_t ugd_data; 89#else 90 void *ugd_data; 91#endif 92 uint16_t ugd_lang_id; 93 uint16_t ugd_maxlen; 94 uint16_t ugd_actlen; 95 uint16_t ugd_offset; 96 uint8_t ugd_config_index; 97 uint8_t ugd_string_index; 98 uint8_t ugd_iface_index; 99 uint8_t ugd_altif_index; 100 uint8_t ugd_endpt_index; 101 uint8_t ugd_report_type; 102 uint8_t reserved[8]; 103}; 104 105struct usb_device_info { 106 uint16_t udi_productNo; 107 uint16_t udi_vendorNo; 108 uint16_t udi_releaseNo; 109 uint16_t udi_power; /* power consumption in mA, 0 if 110 * selfpowered */ 111 uint8_t udi_bus; 112 uint8_t udi_addr; /* device address */ 113 uint8_t udi_index; /* device index */ 114 uint8_t udi_class; 115 uint8_t udi_subclass; 116 uint8_t udi_protocol; 117 uint8_t udi_config_no; /* current config number */ 118 uint8_t udi_config_index; /* current config index */ 119 uint8_t udi_speed; /* see "USB_SPEED_XXX" */ 120 uint8_t udi_mode; /* see "USB_MODE_XXX" */ 121 uint8_t udi_nports; 122 uint8_t udi_hubaddr; /* parent HUB address */ 123 uint8_t udi_hubindex; /* parent HUB device index */ 124 uint8_t udi_hubport; /* parent HUB port */ 125 uint8_t udi_power_mode; /* see "USB_POWER_MODE_XXX" */ 126 uint8_t udi_suspended; /* set if device is suspended */ 127 uint8_t udi_reserved[16]; /* leave space for the future */ 128 char udi_product[128]; 129 char udi_vendor[128]; 130 char udi_serial[64]; 131 char udi_release[8]; 132}; 133 134struct usb_device_stats { 135 uint32_t uds_requests_ok[4]; /* Indexed by transfer type UE_XXX */ 136 uint32_t uds_requests_fail[4]; /* Indexed by transfer type UE_XXX */ 137}; 138 139struct usb_fs_start { 140 uint8_t ep_index; 141}; 142 143struct usb_fs_stop { 144 uint8_t ep_index; 145}; 146 147struct usb_fs_complete { 148 uint8_t ep_index; 149}; 150 151/* This structure is used for all endpoint types */ 152struct usb_fs_endpoint { 153 /* 154 * NOTE: isochronous USB transfer only use one buffer, but can have 155 * multiple frame lengths ! 156 */ 157#ifdef COMPAT_32BIT 158 uint64_t ppBuffer; 159 uint64_t pLength; 160#else 161 void **ppBuffer; /* pointer to userland buffers */ 162 uint32_t *pLength; /* pointer to frame lengths, updated 163 * to actual length */ 164#endif 165 uint32_t nFrames; /* number of frames */ 166 uint32_t aFrames; /* actual number of frames */ 167 uint16_t flags; 168 /* a single short frame will terminate */ 169#define USB_FS_FLAG_SINGLE_SHORT_OK 0x0001 170 /* multiple short frames are allowed */ 171#define USB_FS_FLAG_MULTI_SHORT_OK 0x0002 172 /* all frame(s) transmitted are short terminated */ 173#define USB_FS_FLAG_FORCE_SHORT 0x0004 174 /* will do a clear-stall before xfer */ 175#define USB_FS_FLAG_CLEAR_STALL 0x0008 176 uint16_t timeout; /* in milliseconds */ 177 /* isocronous completion time in milliseconds - used for echo cancel */ 178 uint16_t isoc_time_complete; 179 /* timeout value for no timeout */ 180#define USB_FS_TIMEOUT_NONE 0 181 int status; /* see USB_ERR_XXX */ 182}; 183 184struct usb_fs_init { 185 /* userland pointer to endpoints structure */ 186#ifdef COMPAT_32BIT 187 uint64_t pEndpoints; 188#else 189 struct usb_fs_endpoint *pEndpoints; 190#endif 191 /* maximum number of endpoints */ 192 uint8_t ep_index_max; 193}; 194 195struct usb_fs_uninit { 196 uint8_t dummy; /* zero */ 197}; 198 199struct usb_fs_open { 200#define USB_FS_MAX_BUFSIZE (1 << 18) 201 uint32_t max_bufsize; 202#define USB_FS_MAX_FRAMES (1U << 12) 203#define USB_FS_MAX_FRAMES_PRE_SCALE (1U << 31) /* for ISOCHRONOUS transfers */ 204 uint32_t max_frames; /* read and write */ 205 uint16_t max_packet_length; /* read only */ 206 uint8_t dev_index; /* currently unused */ 207 uint8_t ep_index; 208 uint8_t ep_no; /* bEndpointNumber */ 209}; 210 211struct usb_fs_open_stream { 212 struct usb_fs_open fs_open; 213 uint16_t stream_id; 214}; 215 216struct usb_fs_close { 217 uint8_t ep_index; 218}; 219 220struct usb_fs_clear_stall_sync { 221 uint8_t ep_index; 222}; 223 224struct usb_gen_quirk { 225 uint16_t index; /* Quirk Index */ 226 uint16_t vid; /* Vendor ID */ 227 uint16_t pid; /* Product ID */ 228 uint16_t bcdDeviceLow; /* Low Device Revision */ 229 uint16_t bcdDeviceHigh; /* High Device Revision */ 230 uint16_t reserved[2]; 231 /* 232 * String version of quirk including terminating zero. See UQ_XXX in 233 * "usb_quirk.h". 234 */ 235 char quirkname[64 - 14]; 236}; 237 238/* USB controller */ 239#define USB_REQUEST _IOWR('U', 1, struct usb_ctl_request) 240#define USB_SETDEBUG _IOW ('U', 2, int) 241#define USB_DISCOVER _IO ('U', 3) 242#define USB_DEVICEINFO _IOWR('U', 4, struct usb_device_info) 243#define USB_DEVICESTATS _IOR ('U', 5, struct usb_device_stats) 244#define USB_DEVICEENUMERATE _IOW ('U', 6, int) 245 246/* Generic HID device */ 247#define USB_GET_REPORT_DESC _IOWR('U', 21, struct usb_gen_descriptor) 248#define USB_SET_IMMED _IOW ('U', 22, int) 249#define USB_GET_REPORT _IOWR('U', 23, struct usb_gen_descriptor) 250#define USB_SET_REPORT _IOW ('U', 24, struct usb_gen_descriptor) 251#define USB_GET_REPORT_ID _IOR ('U', 25, int) 252 253/* Generic USB device */ 254#define USB_GET_CONFIG _IOR ('U', 100, int) 255#define USB_SET_CONFIG _IOW ('U', 101, int) 256#define USB_GET_ALTINTERFACE _IOWR('U', 102, struct usb_alt_interface) 257#define USB_SET_ALTINTERFACE _IOWR('U', 103, struct usb_alt_interface) 258#define USB_GET_DEVICE_DESC _IOR ('U', 105, struct usb_device_descriptor) 259#define USB_GET_CONFIG_DESC _IOR ('U', 106, struct usb_config_descriptor) 260#define USB_GET_RX_INTERFACE_DESC _IOR ('U', 107, struct usb_interface_descriptor) 261#define USB_GET_RX_ENDPOINT_DESC _IOR ('U', 108, struct usb_endpoint_descriptor) 262#define USB_GET_FULL_DESC _IOWR('U', 109, struct usb_gen_descriptor) 263#define USB_GET_STRING_DESC _IOWR('U', 110, struct usb_gen_descriptor) 264#define USB_DO_REQUEST _IOWR('U', 111, struct usb_ctl_request) 265#define USB_GET_DEVICEINFO _IOR ('U', 112, struct usb_device_info) 266#define USB_SET_RX_SHORT_XFER _IOW ('U', 113, int) 267#define USB_SET_RX_TIMEOUT _IOW ('U', 114, int) 268#define USB_GET_RX_FRAME_SIZE _IOR ('U', 115, int) 269#define USB_GET_RX_BUFFER_SIZE _IOR ('U', 117, int) 270#define USB_SET_RX_BUFFER_SIZE _IOW ('U', 118, int) 271#define USB_SET_RX_STALL_FLAG _IOW ('U', 119, int) 272#define USB_SET_TX_STALL_FLAG _IOW ('U', 120, int) 273#define USB_GET_IFACE_DRIVER _IOWR('U', 121, struct usb_gen_descriptor) 274#define USB_CLAIM_INTERFACE _IOW ('U', 122, int) 275#define USB_RELEASE_INTERFACE _IOW ('U', 123, int) 276#define USB_IFACE_DRIVER_ACTIVE _IOW ('U', 124, int) 277#define USB_IFACE_DRIVER_DETACH _IOW ('U', 125, int) 278#define USB_GET_PLUGTIME _IOR ('U', 126, uint32_t) 279#define USB_READ_DIR _IOW ('U', 127, struct usb_read_dir) 280/* 128 - 134 unused */ 281#define USB_GET_POWER_USAGE _IOR ('U', 135, int) 282#define USB_SET_TX_FORCE_SHORT _IOW ('U', 136, int) 283#define USB_SET_TX_TIMEOUT _IOW ('U', 137, int) 284#define USB_GET_TX_FRAME_SIZE _IOR ('U', 138, int) 285#define USB_GET_TX_BUFFER_SIZE _IOR ('U', 139, int) 286#define USB_SET_TX_BUFFER_SIZE _IOW ('U', 140, int) 287#define USB_GET_TX_INTERFACE_DESC _IOR ('U', 141, struct usb_interface_descriptor) 288#define USB_GET_TX_ENDPOINT_DESC _IOR ('U', 142, struct usb_endpoint_descriptor) 289#define USB_SET_PORT_ENABLE _IOW ('U', 143, int) 290#define USB_SET_PORT_DISABLE _IOW ('U', 144, int) 291#define USB_SET_POWER_MODE _IOW ('U', 145, int) 292#define USB_GET_POWER_MODE _IOR ('U', 146, int) 293#define USB_SET_TEMPLATE _IOW ('U', 147, int) 294#define USB_GET_TEMPLATE _IOR ('U', 148, int) 295 296/* Modem device */ 297#define USB_GET_CM_OVER_DATA _IOR ('U', 180, int) 298#define USB_SET_CM_OVER_DATA _IOW ('U', 181, int) 299 300/* GPIO control */ 301#define USB_GET_GPIO _IOR ('U', 182, int) 302#define USB_SET_GPIO _IOW ('U', 183, int) 303 304/* USB file system interface */ 305#define USB_FS_START _IOW ('U', 192, struct usb_fs_start) 306#define USB_FS_STOP _IOW ('U', 193, struct usb_fs_stop) 307#define USB_FS_COMPLETE _IOR ('U', 194, struct usb_fs_complete) 308#define USB_FS_INIT _IOW ('U', 195, struct usb_fs_init) 309#define USB_FS_UNINIT _IOW ('U', 196, struct usb_fs_uninit) 310#define USB_FS_OPEN _IOWR('U', 197, struct usb_fs_open) 311#define USB_FS_CLOSE _IOW ('U', 198, struct usb_fs_close) 312#define USB_FS_CLEAR_STALL_SYNC _IOW ('U', 199, struct usb_fs_clear_stall_sync) 313#define USB_FS_OPEN_STREAM _IOWR('U', 200, struct usb_fs_open_stream) 314 315/* USB quirk system interface */ 316#define USB_DEV_QUIRK_GET _IOWR('Q', 0, struct usb_gen_quirk) 317#define USB_QUIRK_NAME_GET _IOWR('Q', 1, struct usb_gen_quirk) 318#define USB_DEV_QUIRK_ADD _IOW ('Q', 2, struct usb_gen_quirk) 319#define USB_DEV_QUIRK_REMOVE _IOW ('Q', 3, struct usb_gen_quirk) 320 321#endif /* _USB_IOCTL_H_ */ 322