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