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