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