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