1 /* $FreeBSD$ */ 2 /*- 3 * SPDX-License-Identifier: BSD-2-Clause 4 * 5 * Copyright (c) 2008 Hans Petter Selasky. All rights reserved. 6 * Copyright (c) 1998 The NetBSD Foundation, Inc. All rights reserved. 7 * Copyright (c) 1998 Lennart Augustsson. All rights reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer. 14 * 2. Redistributions in binary form must reproduce the above copyright 15 * notice, this list of conditions and the following disclaimer in the 16 * documentation and/or other materials provided with the distribution. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28 * SUCH DAMAGE. 29 */ 30 31 #ifndef _USB_IOCTL_H_ 32 #define _USB_IOCTL_H_ 33 34 #ifndef USB_GLOBAL_INCLUDE_FILE 35 #include <sys/ioccom.h> 36 #include <sys/cdefs.h> 37 38 /* Building "kdump" depends on these includes */ 39 40 #include <dev/usb/usb_endian.h> 41 #include <dev/usb/usb.h> 42 #endif 43 44 #define USB_DEVICE_NAME "usbctl" 45 #define USB_DEVICE_DIR "usb" 46 #define USB_GENERIC_NAME "ugen" 47 #define USB_TEMPLATE_SYSCTL "hw.usb.template" /* integer type */ 48 49 /* Definition of valid template sysctl values */ 50 51 enum { 52 USB_TEMP_MSC, /* USB Mass Storage */ 53 USB_TEMP_CDCE, /* USB CDC Ethernet */ 54 USB_TEMP_MTP, /* Message Transfer Protocol */ 55 USB_TEMP_MODEM, /* USB CDC Modem */ 56 USB_TEMP_AUDIO, /* USB Audio */ 57 USB_TEMP_KBD, /* USB Keyboard */ 58 USB_TEMP_MOUSE, /* USB Mouse */ 59 USB_TEMP_PHONE, /* USB Phone */ 60 USB_TEMP_SERIALNET, /* USB CDC Ethernet and Modem */ 61 USB_TEMP_MIDI, /* USB MIDI */ 62 USB_TEMP_MULTI, /* USB Ethernet, serial, and storage */ 63 USB_TEMP_CDCEEM, /* USB Ethernet Emulation Model */ 64 USB_TEMP_MAX, 65 }; 66 67 struct usb_read_dir { 68 void *urd_data; 69 uint32_t urd_startentry; 70 uint32_t urd_maxlen; 71 }; 72 73 struct usb_ctl_request { 74 void *ucr_data; 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 81 struct usb_alt_interface { 82 uint8_t uai_interface_index; 83 uint8_t uai_alt_index; 84 }; 85 86 struct usb_gen_descriptor { 87 void *ugd_data; 88 uint16_t ugd_lang_id; 89 uint16_t ugd_maxlen; 90 uint16_t ugd_actlen; 91 uint16_t ugd_offset; 92 uint8_t ugd_config_index; 93 uint8_t ugd_string_index; 94 uint8_t ugd_iface_index; 95 uint8_t ugd_altif_index; 96 uint8_t ugd_endpt_index; 97 uint8_t ugd_report_type; 98 uint8_t reserved[8]; 99 }; 100 101 struct usb_device_info { 102 uint16_t udi_productNo; 103 uint16_t udi_vendorNo; 104 uint16_t udi_releaseNo; 105 uint16_t udi_power; /* power consumption in mA, 0 if 106 * selfpowered */ 107 uint8_t udi_bus; 108 uint8_t udi_addr; /* device address */ 109 uint8_t udi_index; /* device index */ 110 uint8_t udi_class; 111 uint8_t udi_subclass; 112 uint8_t udi_protocol; 113 uint8_t udi_config_no; /* current config number */ 114 uint8_t udi_config_index; /* current config index */ 115 uint8_t udi_speed; /* see "USB_SPEED_XXX" */ 116 uint8_t udi_mode; /* see "USB_MODE_XXX" */ 117 uint8_t udi_nports; 118 uint8_t udi_hubaddr; /* parent HUB address */ 119 uint8_t udi_hubindex; /* parent HUB device index */ 120 uint8_t udi_hubport; /* parent HUB port */ 121 uint8_t udi_power_mode; /* see "USB_POWER_MODE_XXX" */ 122 uint8_t udi_suspended; /* set if device is suspended */ 123 uint8_t udi_reserved[16]; /* leave space for the future */ 124 char udi_product[128]; 125 char udi_vendor[128]; 126 char udi_serial[64]; 127 char udi_release[8]; 128 }; 129 130 #define USB_DEVICE_PORT_PATH_MAX 32 131 132 struct usb_device_port_path { 133 uint8_t udp_bus; /* which bus we are on */ 134 uint8_t udp_index; /* which device index */ 135 uint8_t udp_port_level; /* how many levels: 0, 1, 2 ... */ 136 uint8_t udp_port_no[USB_DEVICE_PORT_PATH_MAX]; 137 }; 138 139 struct usb_device_stats { 140 uint32_t uds_requests_ok[4]; /* Indexed by transfer type UE_XXX */ 141 uint32_t uds_requests_fail[4]; /* Indexed by transfer type UE_XXX */ 142 }; 143 144 struct usb_fs_start { 145 uint8_t ep_index; 146 }; 147 148 struct usb_fs_stop { 149 uint8_t ep_index; 150 }; 151 152 struct usb_fs_complete { 153 uint8_t ep_index; 154 }; 155 156 /* This structure is used for all endpoint types */ 157 struct usb_fs_endpoint { 158 /* 159 * NOTE: isochronous USB transfer only use one buffer, but can have 160 * multiple frame lengths ! 161 */ 162 void **ppBuffer; /* pointer to userland buffers */ 163 uint32_t *pLength; /* pointer to frame lengths, updated 164 * to actual length */ 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 184 struct usb_fs_init { 185 /* userland pointer to endpoints structure */ 186 struct usb_fs_endpoint *pEndpoints; 187 /* maximum number of endpoints */ 188 uint8_t ep_index_max; 189 }; 190 191 struct usb_fs_uninit { 192 uint8_t dummy; /* zero */ 193 }; 194 195 struct usb_fs_open { 196 #define USB_FS_MAX_BUFSIZE (1 << 25) /* 32 MBytes */ 197 uint32_t max_bufsize; 198 #define USB_FS_MAX_FRAMES (1U << 12) 199 #define USB_FS_MAX_FRAMES_PRE_SCALE (1U << 31) /* for ISOCHRONOUS transfers */ 200 uint32_t max_frames; /* read and write */ 201 uint16_t max_packet_length; /* read only */ 202 uint8_t dev_index; /* currently unused */ 203 uint8_t ep_index; 204 uint8_t ep_no; /* bEndpointNumber */ 205 }; 206 207 struct usb_fs_open_stream { 208 struct usb_fs_open fs_open; 209 uint16_t stream_id; /* stream ID */ 210 }; 211 212 struct usb_fs_close { 213 uint8_t ep_index; 214 }; 215 216 struct usb_fs_clear_stall_sync { 217 uint8_t ep_index; 218 }; 219 220 struct usb_gen_quirk { 221 uint16_t index; /* Quirk Index */ 222 uint16_t vid; /* Vendor ID */ 223 uint16_t pid; /* Product ID */ 224 uint16_t bcdDeviceLow; /* Low Device Revision */ 225 uint16_t bcdDeviceHigh; /* High Device Revision */ 226 uint16_t reserved[2]; 227 /* 228 * String version of quirk including terminating zero. See 229 * UQ_XXX in "usb_quirk.h". 230 */ 231 char quirkname[64 - 14]; 232 }; 233 234 /* USB controller */ 235 #define USB_REQUEST _IOWR('U', 1, struct usb_ctl_request) 236 #define USB_SETDEBUG _IOW ('U', 2, int) 237 #define USB_DISCOVER _IO ('U', 3) 238 #define USB_DEVICEINFO _IOWR('U', 4, struct usb_device_info) 239 #define USB_DEVICESTATS _IOR ('U', 5, struct usb_device_stats) 240 #define USB_DEVICEENUMERATE _IOW ('U', 6, int) 241 242 /* Generic HID device. Numbers 26 and 30-39 are occupied by hidraw. */ 243 #define USB_GET_REPORT_DESC _IOWR('U', 21, struct usb_gen_descriptor) 244 #define USB_SET_IMMED _IOW ('U', 22, int) 245 #define USB_GET_REPORT _IOWR('U', 23, struct usb_gen_descriptor) 246 #define USB_SET_REPORT _IOW ('U', 24, struct usb_gen_descriptor) 247 #define USB_GET_REPORT_ID _IOR ('U', 25, int) 248 249 /* Generic USB device */ 250 #define USB_GET_CONFIG _IOR ('U', 100, int) 251 #define USB_SET_CONFIG _IOW ('U', 101, int) 252 #define USB_GET_ALTINTERFACE _IOWR('U', 102, struct usb_alt_interface) 253 #define USB_SET_ALTINTERFACE _IOWR('U', 103, struct usb_alt_interface) 254 #define USB_GET_DEVICE_DESC _IOR ('U', 105, struct usb_device_descriptor) 255 #define USB_GET_CONFIG_DESC _IOR ('U', 106, struct usb_config_descriptor) 256 #define USB_GET_RX_INTERFACE_DESC _IOR ('U', 107, struct usb_interface_descriptor) 257 #define USB_GET_RX_ENDPOINT_DESC _IOR ('U', 108, struct usb_endpoint_descriptor) 258 #define USB_GET_FULL_DESC _IOWR('U', 109, struct usb_gen_descriptor) 259 #define USB_GET_STRING_DESC _IOWR('U', 110, struct usb_gen_descriptor) 260 #define USB_DO_REQUEST _IOWR('U', 111, struct usb_ctl_request) 261 #define USB_GET_DEVICEINFO _IOR ('U', 112, struct usb_device_info) 262 #define USB_SET_RX_SHORT_XFER _IOW ('U', 113, int) 263 #define USB_SET_RX_TIMEOUT _IOW ('U', 114, int) 264 #define USB_GET_RX_FRAME_SIZE _IOR ('U', 115, int) 265 #define USB_GET_RX_BUFFER_SIZE _IOR ('U', 117, int) 266 #define USB_SET_RX_BUFFER_SIZE _IOW ('U', 118, int) 267 #define USB_SET_RX_STALL_FLAG _IOW ('U', 119, int) 268 #define USB_SET_TX_STALL_FLAG _IOW ('U', 120, int) 269 #define USB_GET_IFACE_DRIVER _IOWR('U', 121, struct usb_gen_descriptor) 270 #define USB_CLAIM_INTERFACE _IOW ('U', 122, int) 271 #define USB_RELEASE_INTERFACE _IOW ('U', 123, int) 272 #define USB_IFACE_DRIVER_ACTIVE _IOW ('U', 124, int) 273 #define USB_IFACE_DRIVER_DETACH _IOW ('U', 125, int) 274 #define USB_GET_PLUGTIME _IOR ('U', 126, uint32_t) 275 #define USB_READ_DIR _IOW ('U', 127, struct usb_read_dir) 276 /* 128 - 133 unused */ 277 #define USB_GET_DEV_PORT_PATH _IOR ('U', 134, struct usb_device_port_path) 278 #define USB_GET_POWER_USAGE _IOR ('U', 135, int) 279 #define USB_SET_TX_FORCE_SHORT _IOW ('U', 136, int) 280 #define USB_SET_TX_TIMEOUT _IOW ('U', 137, int) 281 #define USB_GET_TX_FRAME_SIZE _IOR ('U', 138, int) 282 #define USB_GET_TX_BUFFER_SIZE _IOR ('U', 139, int) 283 #define USB_SET_TX_BUFFER_SIZE _IOW ('U', 140, int) 284 #define USB_GET_TX_INTERFACE_DESC _IOR ('U', 141, struct usb_interface_descriptor) 285 #define USB_GET_TX_ENDPOINT_DESC _IOR ('U', 142, struct usb_endpoint_descriptor) 286 #define USB_SET_PORT_ENABLE _IOW ('U', 143, int) 287 #define USB_SET_PORT_DISABLE _IOW ('U', 144, int) 288 #define USB_SET_POWER_MODE _IOW ('U', 145, int) 289 #define USB_GET_POWER_MODE _IOR ('U', 146, int) 290 #define USB_SET_TEMPLATE _IOW ('U', 147, int) 291 #define USB_GET_TEMPLATE _IOR ('U', 148, int) 292 293 /* Modem device */ 294 #define USB_GET_CM_OVER_DATA _IOR ('U', 180, int) 295 #define USB_SET_CM_OVER_DATA _IOW ('U', 181, int) 296 297 /* GPIO control */ 298 #define USB_GET_GPIO _IOR ('U', 182, int) 299 #define USB_SET_GPIO _IOW ('U', 183, int) 300 301 /* USB file system interface */ 302 #define USB_FS_START _IOW ('U', 192, struct usb_fs_start) 303 #define USB_FS_STOP _IOW ('U', 193, struct usb_fs_stop) 304 #define USB_FS_COMPLETE _IOR ('U', 194, struct usb_fs_complete) 305 #define USB_FS_INIT _IOW ('U', 195, struct usb_fs_init) 306 #define USB_FS_UNINIT _IOW ('U', 196, struct usb_fs_uninit) 307 #define USB_FS_OPEN _IOWR('U', 197, struct usb_fs_open) 308 #define USB_FS_CLOSE _IOW ('U', 198, struct usb_fs_close) 309 #define USB_FS_CLEAR_STALL_SYNC _IOW ('U', 199, struct usb_fs_clear_stall_sync) 310 #define USB_FS_OPEN_STREAM _IOWR('U', 200, struct usb_fs_open_stream) 311 312 /* USB quirk system interface */ 313 #define USB_DEV_QUIRK_GET _IOWR('Q', 0, struct usb_gen_quirk) 314 #define USB_QUIRK_NAME_GET _IOWR('Q', 1, struct usb_gen_quirk) 315 #define USB_DEV_QUIRK_ADD _IOW ('Q', 2, struct usb_gen_quirk) 316 #define USB_DEV_QUIRK_REMOVE _IOW ('Q', 3, struct usb_gen_quirk) 317 318 #ifdef _KERNEL 319 #ifdef COMPAT_FREEBSD32 320 321 struct usb_read_dir32 { 322 uint32_t urd_data; 323 uint32_t urd_startentry; 324 uint32_t urd_maxlen; 325 }; 326 #define USB_READ_DIR32 \ 327 _IOC_NEWTYPE(USB_READ_DIR, struct usb_read_dir32) 328 329 struct usb_ctl_request32 { 330 uint32_t ucr_data; 331 uint16_t ucr_flags; 332 uint16_t ucr_actlen; 333 uint8_t ucr_addr; 334 struct usb_device_request ucr_request; 335 }; 336 #define USB_REQUEST32 _IOC_NEWTYPE(USB_REQUEST, struct usb_ctl_request32) 337 #define USB_DO_REQUEST32 _IOC_NEWTYPE(USB_DO_REQUEST, struct usb_ctl_request32) 338 339 struct usb_gen_descriptor32 { 340 uint32_t ugd_data; /* void * */ 341 uint16_t ugd_lang_id; 342 uint16_t ugd_maxlen; 343 uint16_t ugd_actlen; 344 uint16_t ugd_offset; 345 uint8_t ugd_config_index; 346 uint8_t ugd_string_index; 347 uint8_t ugd_iface_index; 348 uint8_t ugd_altif_index; 349 uint8_t ugd_endpt_index; 350 uint8_t ugd_report_type; 351 uint8_t reserved[8]; 352 }; 353 354 #define USB_GET_REPORT_DESC32 \ 355 _IOC_NEWTYPE(USB_GET_REPORT_DESC, struct usb_gen_descriptor32) 356 #define USB_GET_REPORT32 \ 357 _IOC_NEWTYPE(USB_GET_REPORT, struct usb_gen_descriptor32) 358 #define USB_SET_REPORT32 \ 359 _IOC_NEWTYPE(USB_SET_REPORT, struct usb_gen_descriptor32) 360 #define USB_GET_FULL_DESC32 \ 361 _IOC_NEWTYPE(USB_GET_FULL_DESC, struct usb_gen_descriptor32) 362 #define USB_GET_STRING_DESC32 \ 363 _IOC_NEWTYPE(USB_GET_STRING_DESC, struct usb_gen_descriptor32) 364 #define USB_GET_IFACE_DRIVER32 \ 365 _IOC_NEWTYPE(USB_GET_IFACE_DRIVER, struct usb_gen_descriptor32) 366 367 void usb_gen_descriptor_from32(struct usb_gen_descriptor *ugd, 368 const struct usb_gen_descriptor32 *ugd32); 369 void update_usb_gen_descriptor32(struct usb_gen_descriptor32 *ugd32, 370 struct usb_gen_descriptor *ugd); 371 372 struct usb_fs_endpoint32 { 373 uint32_t ppBuffer; /* void ** */ 374 uint32_t pLength; /* uint32_t * */ 375 uint32_t nFrames; 376 uint32_t aFrames; 377 uint16_t flags; 378 uint16_t timeout; 379 uint16_t isoc_time_complete; 380 int status; 381 }; 382 383 struct usb_fs_init32 { 384 uint32_t pEndpoints; /* struct usb_fs_endpoint32 * */ 385 uint8_t ep_index_max; 386 }; 387 388 #define USB_FS_INIT32 _IOC_NEWTYPE(USB_FS_INIT, struct usb_fs_init32) 389 390 #endif /* COMPAT_FREEBSD32 */ 391 #endif /* _KERNEL */ 392 393 #endif /* _USB_IOCTL_H_ */ 394