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