| 1 | /* $NetBSD: usb.h,v 1.114 2016/09/17 06:29:50 skrll Exp $ */ |
| 2 | |
| 3 | /* |
| 4 | * Copyright (c) 1998 The NetBSD Foundation, Inc. |
| 5 | * All rights reserved. |
| 6 | * |
| 7 | * This code is derived from software contributed to The NetBSD Foundation |
| 8 | * by Lennart Augustsson (lennart@augustsson.net) at |
| 9 | * Carlstedt Research & Technology. |
| 10 | * |
| 11 | * Redistribution and use in source and binary forms, with or without |
| 12 | * modification, are permitted provided that the following conditions |
| 13 | * are met: |
| 14 | * 1. Redistributions of source code must retain the above copyright |
| 15 | * notice, this list of conditions and the following disclaimer. |
| 16 | * 2. Redistributions in binary form must reproduce the above copyright |
| 17 | * notice, this list of conditions and the following disclaimer in the |
| 18 | * documentation and/or other materials provided with the distribution. |
| 19 | * |
| 20 | * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS |
| 21 | * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED |
| 22 | * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
| 23 | * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS |
| 24 | * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| 25 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| 26 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| 27 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| 28 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| 29 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| 30 | * POSSIBILITY OF SUCH DAMAGE. |
| 31 | */ |
| 32 | |
| 33 | |
| 34 | #ifndef _USB_H_ |
| 35 | #define _USB_H_ |
| 36 | |
| 37 | #include <sys/types.h> |
| 38 | #include <sys/time.h> |
| 39 | |
| 40 | #include <sys/ioctl.h> |
| 41 | |
| 42 | #if defined(_KERNEL) |
| 43 | |
| 44 | #include <sys/device.h> |
| 45 | |
| 46 | #endif |
| 47 | |
| 48 | #ifdef USB_DEBUG |
| 49 | #define Static |
| 50 | #else |
| 51 | #define Static static |
| 52 | #endif |
| 53 | |
| 54 | #define USB_STACK_VERSION 2 |
| 55 | |
| 56 | #define USB_MAX_DEVICES 128 |
| 57 | #define USB_MIN_DEVICES 2 /* unused + root HUB */ |
| 58 | #define USB_START_ADDR 0 |
| 59 | |
| 60 | #define USB_CONTROL_ENDPOINT 0 |
| 61 | #define USB_MAX_ENDPOINTS 16 |
| 62 | |
| 63 | #define USB_FRAMES_PER_SECOND 1000 |
| 64 | #define USB_UFRAMES_PER_FRAME 8 |
| 65 | |
| 66 | /* |
| 67 | * The USB records contain some unaligned little-endian word |
| 68 | * components. The U[SG]ETW macros take care of both the alignment |
| 69 | * and endian problem and should always be used to access non-byte |
| 70 | * values. |
| 71 | */ |
| 72 | typedef uint8_t uByte; |
| 73 | typedef uint8_t uWord[2]; |
| 74 | typedef uint8_t uDWord[4]; |
| 75 | |
| 76 | #define USETW2(w,h,l) ((w)[0] = (uint8_t)(l), (w)[1] = (uint8_t)(h)) |
| 77 | |
| 78 | #define UGETW(w) ((w)[0] | ((w)[1] << 8)) |
| 79 | #define USETW(w,v) ((w)[0] = (uint8_t)(v), (w)[1] = (uint8_t)((v) >> 8)) |
| 80 | #define USETWD(val) { (uint8_t)(val), (uint8_t)((val) >> 8) } |
| 81 | #define UGETDW(w) ((w)[0] | ((w)[1] << 8) | ((w)[2] << 16) | ((w)[3] << 24)) |
| 82 | #define USETDW(w,v) ((w)[0] = (uint8_t)(v), \ |
| 83 | (w)[1] = (uint8_t)((v) >> 8), \ |
| 84 | (w)[2] = (uint8_t)((v) >> 16), \ |
| 85 | (w)[3] = (uint8_t)((v) >> 24)) |
| 86 | #define UPACKED __packed |
| 87 | |
| 88 | typedef struct { |
| 89 | uByte bmRequestType; |
| 90 | uByte bRequest; |
| 91 | uWord wValue; |
| 92 | uWord wIndex; |
| 93 | uWord wLength; |
| 94 | } UPACKED usb_device_request_t; |
| 95 | |
| 96 | #define UT_GET_DIR(a) ((a) & 0x80) |
| 97 | #define UT_WRITE 0x00 |
| 98 | #define UT_READ 0x80 |
| 99 | |
| 100 | #define UT_GET_TYPE(a) ((a) & 0x60) |
| 101 | #define UT_STANDARD 0x00 |
| 102 | #define UT_CLASS 0x20 |
| 103 | #define UT_VENDOR 0x40 |
| 104 | |
| 105 | #define UT_GET_RECIPIENT(a) ((a) & 0x1f) |
| 106 | #define UT_DEVICE 0x00 |
| 107 | #define UT_INTERFACE 0x01 |
| 108 | #define UT_ENDPOINT 0x02 |
| 109 | #define UT_OTHER 0x03 |
| 110 | |
| 111 | #define UT_READ_DEVICE (UT_READ | UT_STANDARD | UT_DEVICE) |
| 112 | #define UT_READ_INTERFACE (UT_READ | UT_STANDARD | UT_INTERFACE) |
| 113 | #define UT_READ_ENDPOINT (UT_READ | UT_STANDARD | UT_ENDPOINT) |
| 114 | #define UT_WRITE_DEVICE (UT_WRITE | UT_STANDARD | UT_DEVICE) |
| 115 | #define UT_WRITE_INTERFACE (UT_WRITE | UT_STANDARD | UT_INTERFACE) |
| 116 | #define UT_WRITE_ENDPOINT (UT_WRITE | UT_STANDARD | UT_ENDPOINT) |
| 117 | #define UT_READ_CLASS_DEVICE (UT_READ | UT_CLASS | UT_DEVICE) |
| 118 | #define UT_READ_CLASS_INTERFACE (UT_READ | UT_CLASS | UT_INTERFACE) |
| 119 | #define UT_READ_CLASS_OTHER (UT_READ | UT_CLASS | UT_OTHER) |
| 120 | #define UT_READ_CLASS_ENDPOINT (UT_READ | UT_CLASS | UT_ENDPOINT) |
| 121 | #define UT_WRITE_CLASS_DEVICE (UT_WRITE | UT_CLASS | UT_DEVICE) |
| 122 | #define UT_WRITE_CLASS_INTERFACE (UT_WRITE | UT_CLASS | UT_INTERFACE) |
| 123 | #define UT_WRITE_CLASS_OTHER (UT_WRITE | UT_CLASS | UT_OTHER) |
| 124 | #define UT_WRITE_CLASS_ENDPOINT (UT_WRITE | UT_CLASS | UT_ENDPOINT) |
| 125 | #define UT_READ_VENDOR_DEVICE (UT_READ | UT_VENDOR | UT_DEVICE) |
| 126 | #define UT_READ_VENDOR_INTERFACE (UT_READ | UT_VENDOR | UT_INTERFACE) |
| 127 | #define UT_READ_VENDOR_OTHER (UT_READ | UT_VENDOR | UT_OTHER) |
| 128 | #define UT_READ_VENDOR_ENDPOINT (UT_READ | UT_VENDOR | UT_ENDPOINT) |
| 129 | #define UT_WRITE_VENDOR_DEVICE (UT_WRITE | UT_VENDOR | UT_DEVICE) |
| 130 | #define UT_WRITE_VENDOR_INTERFACE (UT_WRITE | UT_VENDOR | UT_INTERFACE) |
| 131 | #define UT_WRITE_VENDOR_OTHER (UT_WRITE | UT_VENDOR | UT_OTHER) |
| 132 | #define UT_WRITE_VENDOR_ENDPOINT (UT_WRITE | UT_VENDOR | UT_ENDPOINT) |
| 133 | |
| 134 | /* Standard Requests Codes from the USB 2.0 spec, table 9-4 */ |
| 135 | #define UR_GET_STATUS 0x00 |
| 136 | #define UR_CLEAR_FEATURE 0x01 |
| 137 | #define UR_SET_FEATURE 0x03 |
| 138 | #define UR_SET_ADDRESS 0x05 |
| 139 | #define UR_GET_DESCRIPTOR 0x06 |
| 140 | #define UDESC_DEVICE 0x01 |
| 141 | #define UDESC_CONFIG 0x02 |
| 142 | #define UDESC_STRING 0x03 |
| 143 | #define UDESC_INTERFACE 0x04 |
| 144 | #define UDESC_ENDPOINT 0x05 |
| 145 | #define UDESC_DEVICE_QUALIFIER 0x06 |
| 146 | #define UDESC_OTHER_SPEED_CONFIGURATION 0x07 |
| 147 | #define UDESC_INTERFACE_POWER 0x08 |
| 148 | #define UDESC_OTG 0x09 |
| 149 | #define UDESC_DEBUG 0x0a |
| 150 | #define UDESC_INTERFACE_ASSOC 0x0b |
| 151 | #define UDESC_BOS 0x0f |
| 152 | #define UDESC_DEVICE_CAPABILITY 0x10 |
| 153 | #define UDESC_CS_DEVICE 0x21 /* class specific */ |
| 154 | #define UDESC_CS_CONFIG 0x22 |
| 155 | #define UDESC_CS_STRING 0x23 |
| 156 | #define UDESC_CS_INTERFACE 0x24 |
| 157 | #define UDESC_CS_ENDPOINT 0x25 |
| 158 | #define UDESC_HUB 0x29 |
| 159 | #define UDESC_SS_HUB 0x2a /* super speed */ |
| 160 | #define UDESC_ENDPOINT_SS_COMP 0x30 /* super speed */ |
| 161 | #define UDESC_ENDPOINT_ISOCH_SSP_COMP 0x31 |
| 162 | #define UR_SET_DESCRIPTOR 0x07 |
| 163 | #define UR_GET_CONFIG 0x08 |
| 164 | #define UR_SET_CONFIG 0x09 |
| 165 | #define UR_GET_INTERFACE 0x0a |
| 166 | #define UR_SET_INTERFACE 0x0b |
| 167 | #define UR_SYNCH_FRAME 0x0c |
| 168 | #define UR_SET_ENCRYPTION 0x0d |
| 169 | #define UR_GET_ENCRYPTION 0x0e |
| 170 | #define UR_SET_HANDSHAKE 0x0f |
| 171 | #define UR_GET_HANDSHAKE 0x10 |
| 172 | #define UR_SET_CONNECTION 0x11 |
| 173 | #define UR_SET_SECURITY_DATA 0x12 |
| 174 | #define UR_GET_SECURITY_DATA 0x13 |
| 175 | #define UR_SET_WUSB_DATA 0x14 |
| 176 | #define UR_LOOPBACK_DATA_WRITE 0x15 |
| 177 | #define UR_LOOPBACK_DATA_READ 0x16 |
| 178 | #define UR_SET_INTERFACE_DS 0x17 |
| 179 | #define UR_SET_SEL 0x30 |
| 180 | #define UR_SET_ISOCH_DELAY 0x31 |
| 181 | |
| 182 | /* |
| 183 | * Feature selectors. USB 2.0 spec, table 9-6 and OTG and EH suppliment, |
| 184 | * table 6-2 |
| 185 | */ |
| 186 | #define UF_ENDPOINT_HALT 0 |
| 187 | #define UF_INTERFACE_FUNCTION_SUSPEND 0 |
| 188 | #define UF_DEVICE_REMOTE_WAKEUP 1 |
| 189 | #define UF_TEST_MODE 2 |
| 190 | #define UF_DEVICE_B_HNP_ENABLE 3 |
| 191 | #define UF_DEVICE_A_HNP_SUPPORT 4 |
| 192 | #define UF_DEVICE_A_ALT_HNP_SUPPORT 5 |
| 193 | #define UF_DEVICE_WUSB_DEVICE 6 |
| 194 | #define UF_U1_ENABLE 0x30 |
| 195 | #define UF_U2_ENABLE 0x31 |
| 196 | #define UF_LTM_ENABLE 0x32 |
| 197 | |
| 198 | #define USB_MAX_IPACKET 8 /* maximum size of the initial packet */ |
| 199 | |
| 200 | #define USB_2_MAX_CTRL_PACKET 64 |
| 201 | #define USB_2_MAX_BULK_PACKET 512 |
| 202 | |
| 203 | #define USB_3_MAX_CTRL_PACKET 512 |
| 204 | |
| 205 | typedef struct { |
| 206 | uByte bLength; |
| 207 | uByte bDescriptorType; |
| 208 | } UPACKED usb_descriptor_t; |
| 209 | |
| 210 | typedef struct { |
| 211 | uByte bLength; |
| 212 | uByte bDescriptorType; |
| 213 | uWord bcdUSB; |
| 214 | #define UD_USB_2_0 0x0200 |
| 215 | #define UD_USB_3_0 0x0300 |
| 216 | #define UD_IS_USB2(d) (UGETW((d)->bcdUSB) >= UD_USB_2_0) |
| 217 | #define UD_IS_USB3(d) (UGETW((d)->bcdUSB) >= UD_USB_3_0) |
| 218 | uByte bDeviceClass; |
| 219 | uByte bDeviceSubClass; |
| 220 | uByte bDeviceProtocol; |
| 221 | uByte bMaxPacketSize; |
| 222 | /* The fields below are not part of the initial descriptor. */ |
| 223 | uWord idVendor; |
| 224 | uWord idProduct; |
| 225 | uWord bcdDevice; |
| 226 | uByte iManufacturer; |
| 227 | uByte iProduct; |
| 228 | uByte iSerialNumber; |
| 229 | uByte bNumConfigurations; |
| 230 | } UPACKED usb_device_descriptor_t; |
| 231 | #define USB_DEVICE_DESCRIPTOR_SIZE 18 |
| 232 | |
| 233 | typedef struct { |
| 234 | uByte bLength; |
| 235 | uByte bDescriptorType; |
| 236 | uWord wTotalLength; |
| 237 | uByte bNumInterface; |
| 238 | uByte bConfigurationValue; |
| 239 | uByte iConfiguration; |
| 240 | uByte bmAttributes; |
| 241 | #define UC_ATTR_MBO 0x80 |
| 242 | #define UC_SELF_POWERED 0x40 |
| 243 | #define UC_REMOTE_WAKEUP 0x20 |
| 244 | uByte bMaxPower; /* max current in 2 mA units */ |
| 245 | #define UC_POWER_FACTOR 2 |
| 246 | #define UC_POWER_FACTOR_SS 8 |
| 247 | } UPACKED usb_config_descriptor_t; |
| 248 | #define USB_CONFIG_DESCRIPTOR_SIZE 9 |
| 249 | |
| 250 | typedef struct { |
| 251 | uByte bLength; |
| 252 | uByte bDescriptorType; |
| 253 | uByte bInterfaceNumber; |
| 254 | uByte bAlternateSetting; |
| 255 | uByte bNumEndpoints; |
| 256 | uByte bInterfaceClass; |
| 257 | uByte bInterfaceSubClass; |
| 258 | uByte bInterfaceProtocol; |
| 259 | uByte iInterface; |
| 260 | } UPACKED usb_interface_descriptor_t; |
| 261 | #define USB_INTERFACE_DESCRIPTOR_SIZE 9 |
| 262 | |
| 263 | typedef struct { |
| 264 | uByte bLength; |
| 265 | uByte bDescriptorType; |
| 266 | uByte bFirstInterface; |
| 267 | uByte bInterfaceCount; |
| 268 | uByte bFunctionClass; |
| 269 | uByte bFunctionSubClass; |
| 270 | uByte bFunctionProtocol; |
| 271 | uByte iFunction; |
| 272 | } UPACKED usb_interface_assoc_descriptor_t; |
| 273 | #define USB_INTERFACE_ASSOC_DESCRIPTOR_SIZE 8 |
| 274 | |
| 275 | typedef struct { |
| 276 | uByte bLength; |
| 277 | uByte bDescriptorType; |
| 278 | uByte bEndpointAddress; |
| 279 | #define UE_GET_DIR(a) ((a) & 0x80) |
| 280 | #define UE_SET_DIR(a,d) ((a) | (((d)&1) << 7)) |
| 281 | #define UE_DIR_IN 0x80 |
| 282 | #define UE_DIR_OUT 0x00 |
| 283 | #define UE_ADDR 0x0f |
| 284 | #define UE_GET_ADDR(a) ((a) & UE_ADDR) |
| 285 | uByte bmAttributes; |
| 286 | #define UE_XFERTYPE 0x03 |
| 287 | #define UE_CONTROL 0x00 |
| 288 | #define UE_ISOCHRONOUS 0x01 |
| 289 | #define UE_BULK 0x02 |
| 290 | #define UE_INTERRUPT 0x03 |
| 291 | #define UE_GET_XFERTYPE(a) ((a) & UE_XFERTYPE) |
| 292 | #define UE_ISO_TYPE 0x0c |
| 293 | #define UE_ISO_ASYNC 0x04 |
| 294 | #define UE_ISO_ADAPT 0x08 |
| 295 | #define UE_ISO_SYNC 0x0c |
| 296 | #define UE_GET_ISO_TYPE(a) ((a) & UE_ISO_TYPE) |
| 297 | uWord wMaxPacketSize; |
| 298 | #define UE_GET_TRANS(a) (((a) >> 11) & 0x3) |
| 299 | #define UE_GET_SIZE(a) ((a) & 0x7ff) |
| 300 | uByte bInterval; |
| 301 | } UPACKED usb_endpoint_descriptor_t; |
| 302 | #define USB_ENDPOINT_DESCRIPTOR_SIZE 7 |
| 303 | |
| 304 | typedef struct { |
| 305 | uByte bLength; |
| 306 | uByte bDescriptorType; |
| 307 | uByte bMaxBurst; |
| 308 | uByte bmAttributes; |
| 309 | #define UE_GET_BULK_STREAMS_MASK __BITS(4,0) |
| 310 | #define UE_GET_BULK_STREAMS(x) __SHIFTOUT(x, UE_GET_BULK_STREAMS_MASK) |
| 311 | #define UE_GET_SS_ISO_MULT_MASK __BITS(1,0) |
| 312 | #define UE_GET_SS_ISO_MULT(x) __SHIFTOUT(x, UE_GET_SS_ISO_MULT_MASK) |
| 313 | #define UE_GET_SS_ISO_SSP_MASK __BIT(7) |
| 314 | #define UE_GET_SS_ISO_SSP(x) __SHIFTOUT(x, UE_GET_SS_ISO_SSP_MASK) |
| 315 | /* The fields below are only valid for periodic endpoints */ |
| 316 | uWord wBytesPerInterval; |
| 317 | } UPACKED usb_endpoint_ss_comp_descriptor_t; |
| 318 | #define USB_ENDPOINT_SS_COMP_DESCRIPTOR_SIZE 6 |
| 319 | |
| 320 | /* USB 3.0 9.6.2, Table 9-12 */ |
| 321 | typedef struct { |
| 322 | uByte bLength; |
| 323 | uByte bDescriptorType; |
| 324 | uWord wTotalLength; |
| 325 | uByte bNumDeviceCaps; |
| 326 | } UPACKED usb_bos_descriptor_t; |
| 327 | #define USB_BOS_DESCRIPTOR_SIZE 5 |
| 328 | |
| 329 | /* common members of device capability descriptors */ |
| 330 | typedef struct { |
| 331 | uByte bLength; |
| 332 | uByte bDescriptorType; |
| 333 | uByte bDevCapabilityType; |
| 334 | /* Table 9-14 */ |
| 335 | #define USB_DEVCAP_RESERVED 0x00 |
| 336 | #define USB_DEVCAP_WUSB 0x01 |
| 337 | #define USB_DEVCAP_USB2EXT 0x02 |
| 338 | #define USB_DEVCAP_SUPER_SPEED 0x03 |
| 339 | #define USB_DEVCAP_CONTAINER_ID 0x04 |
| 340 | #define USB_DEVCAP_PLATFORM 0x05 |
| 341 | #define USB_DEVCAP_POWER_DELIVERY_CAPABILITY 0x06 |
| 342 | #define USB_DEVCAP_BATTERY_INFO_CAPABILITY 0x07 |
| 343 | #define USB_DEVCAP_PD_CONSUMER_PORT_CAPABILITY 0x08 |
| 344 | #define USB_DEVCAP_PD_PROVIDER_PORT_CAPABILITY 0x09 |
| 345 | #define USB_DEVCAP_SUPERSPEED_PLUS 0x0a |
| 346 | #define USB_DEVCAP_PRECISION_TIME_MEASUREMENT 0x0b |
| 347 | #define USB_DEVCAP_WUSB_EXT 0x0c |
| 348 | /* data ... */ |
| 349 | } UPACKED usb_device_capability_descriptor_t; |
| 350 | #define USB_DEVICE_CAPABILITY_DESCRIPTOR_SIZE 3 /* at least */ |
| 351 | |
| 352 | /* 9.6.2.1 */ |
| 353 | typedef struct { |
| 354 | uByte bLength; |
| 355 | uByte bDescriptorType; |
| 356 | uByte bDevCapabilityType; |
| 357 | uDWord bmAttributes; |
| 358 | #define USB_DEVCAP_V2EXT_LPM __BIT(1) |
| 359 | #define USB_DEVCAP_V2EXT_BESL_SUPPORTED __BIT(2) |
| 360 | #define USB_DEVCAP_V2EXT_BESL_BASELINE_VALID __BIT(3) |
| 361 | #define USB_DEVCAP_V2EXT_BESL_DEEP_VALID __BIT(4) |
| 362 | #define USB_DEVCAP_V2EXT_BESL_BASELINE_MASK __BITS(11, 8) |
| 363 | #define USB_DEVCAP_V2EXT_BESL_BASELINE_GET(x) __SHIFTOUT(x, USB_V2EXT_BESL_BASELINE_MASK) |
| 364 | #define USB_DEVCAP_V2EXT_BESL_DEEP_MASK __BITS(15, 12) |
| 365 | #define USB_DEVCAP_V2EXT_BESL_DEEP_GET(x) __SHIFTOUT(x, USB_V2EXT_BESL_DEEP_MASK) |
| 366 | } UPACKED usb_devcap_usb2ext_descriptor_t; |
| 367 | #define USB_DEVCAP_USB2EXT_DESCRIPTOR_SIZE 7 |
| 368 | |
| 369 | /* 9.6.2.2 */ |
| 370 | typedef struct { |
| 371 | uByte bLength; |
| 372 | uByte bDescriptorType; |
| 373 | uByte bDevCapabilityType; |
| 374 | uByte bmAttributes; |
| 375 | #define USB_DEVCAP_SS_LTM __BIT(1) |
| 376 | uWord wSpeedsSupported; |
| 377 | #define USB_DEVCAP_SS_SPEED_LS __BIT(0) |
| 378 | #define USB_DEVCAP_SS_SPEED_FS __BIT(1) |
| 379 | #define USB_DEVCAP_SS_SPEED_HS __BIT(2) |
| 380 | #define USB_DEVCAP_SS_SPEED_SS __BIT(3) |
| 381 | uByte bFunctionalitySupport; |
| 382 | uByte bU1DevExitLat; |
| 383 | uWord wU2DevExitLat; |
| 384 | } UPACKED usb_devcap_ss_descriptor_t; |
| 385 | #define USB_DEVCAP_SS_DESCRIPTOR_SIZE 10 |
| 386 | |
| 387 | /* 9.6.2.4 */ |
| 388 | typedef struct { |
| 389 | uByte bLength; |
| 390 | uByte bDescriptorType; |
| 391 | uByte bDevCapabilityType; |
| 392 | uByte bReserved; |
| 393 | uByte ContainerID[16]; |
| 394 | } UPACKED usb_devcap_container_id_descriptor_t; |
| 395 | #define USB_DEVCAP_CONTAINER_ID_DESCRIPTOR_SIZE 20 |
| 396 | |
| 397 | typedef struct { |
| 398 | uByte bLength; |
| 399 | uByte bDescriptorType; |
| 400 | uByte bDevCapabilityType; |
| 401 | uByte bReserved; |
| 402 | uByte PlatformCapabilityUUID[16]; |
| 403 | uByte CapabilityData[0]; |
| 404 | } UPACKED usb_devcap_platform_descriptor_t; |
| 405 | #define USB_DEVCAP_PLATFORM_DESCRIPTOR_SIZE 20 |
| 406 | |
| 407 | /* usb 3.1 ch 9.6.2.5 */ |
| 408 | typedef struct { |
| 409 | uByte bLength; |
| 410 | uByte bDescriptorType; |
| 411 | uByte bDevCapabilityType; |
| 412 | uByte bReserved; |
| 413 | uDWord bmAttributes; |
| 414 | #define USB_DEVCAP_SSP_SSAC(x) __SHIFTOUT(x, __BITS(4,0)) |
| 415 | #define USB_DEVCAP_SSP_SSIC(x) __SHIFTOUT(x, __BITS(8,5)) |
| 416 | uWord wFunctionalitySupport; |
| 417 | #define USB_DEVCAP_SSP_SSID(x) __SHIFTOUT(x, __BITS(3,0)) |
| 418 | #define USB_DEVCAP_SSP_MIN_RXLANE_COUNT(x) __SHIFTOUT(x, __BITS(11,8)) |
| 419 | #define USB_DEVCAP_SSP_MIN_TXLANE_COUNT(x) __SHIFTOUT(x, __BITS(15,12)) |
| 420 | uWord wReserved; |
| 421 | uDWord bmSublinkSpeedAttr[0]; |
| 422 | #define USB_DEVCAP_SSP_SSID(x) __SHIFTOUT(x, __BITS(3,0)) |
| 423 | #define USB_DEVCAP_SSP_LSE(x) __SHIFTOUT(x, __BITS(5,4)) |
| 424 | #define USB_DEVCAP_SSP_ST(x) __SHIFTOUT(x, __BITS(7,6)) |
| 425 | #define USB_DEVCAP_SSP_LP(x) __SHIFTOUT(x, __BITS(15,14)) |
| 426 | #define USB_DEVCAP_SSP_LSM(x) __SHIFTOUT(x, __BITS(31,16)) |
| 427 | } UPACKED usb_devcap_ssp_descriptor_t; |
| 428 | #define USB_DEVCAP_SSP_DESCRIPTOR_SIZE 12 /* variable length */ |
| 429 | |
| 430 | typedef struct { |
| 431 | uByte bLength; |
| 432 | uByte bDescriptorType; |
| 433 | uWord bString[126]; |
| 434 | } UPACKED usb_string_descriptor_t; |
| 435 | #define USB_MAX_STRING_LEN 128 |
| 436 | #define USB_LANGUAGE_TABLE 0 /* # of the string language id table */ |
| 437 | #define USB_MAX_ENCODED_STRING_LEN (USB_MAX_STRING_LEN * 3) /* UTF8 */ |
| 438 | |
| 439 | /* Hub specific request */ |
| 440 | #define UR_GET_BUS_STATE 0x02 |
| 441 | #define UR_CLEAR_TT_BUFFER 0x08 |
| 442 | #define UR_RESET_TT 0x09 |
| 443 | #define UR_GET_TT_STATE 0x0a |
| 444 | #define UR_STOP_TT 0x0b |
| 445 | #define UR_SET_AND_TEST 0x0c /* USB 2.0 only */ |
| 446 | #define UR_SET_HUB_DEPTH 0x0c /* USB 3.0 only */ |
| 447 | #define UR_GET_PORT_ERR_COUNT 0x0d |
| 448 | /* Port Status Type for GET_STATUS, USB 3.1 10.16.2.6 and Table 10-12 */ |
| 449 | #define UR_PST_PORT_STATUS 0 |
| 450 | #define UR_PST_PD_STATUS 1 |
| 451 | #define UR_PST_EXT_PORT_STATUS 2 |
| 452 | |
| 453 | /* |
| 454 | * Hub features from USB 2.0 spec, table 11-17 and updated by the |
| 455 | * LPM ECN table 4-7. |
| 456 | */ |
| 457 | #define UHF_C_HUB_LOCAL_POWER 0 |
| 458 | #define UHF_C_HUB_OVER_CURRENT 1 |
| 459 | #define UHF_PORT_CONNECTION 0 |
| 460 | #define UHF_PORT_ENABLE 1 |
| 461 | #define UHF_PORT_SUSPEND 2 |
| 462 | #define UHF_PORT_OVER_CURRENT 3 |
| 463 | #define UHF_PORT_RESET 4 |
| 464 | #define UHF_PORT_LINK_STATE 5 |
| 465 | #define UHF_PORT_POWER 8 |
| 466 | #define UHF_PORT_LOW_SPEED 9 |
| 467 | #define UHF_PORT_L1 10 |
| 468 | #define UHF_C_PORT_CONNECTION 16 |
| 469 | #define UHF_C_PORT_ENABLE 17 |
| 470 | #define UHF_C_PORT_SUSPEND 18 |
| 471 | #define UHF_C_PORT_OVER_CURRENT 19 |
| 472 | #define UHF_C_PORT_RESET 20 |
| 473 | #define UHF_PORT_TEST 21 |
| 474 | #define UHF_PORT_INDICATOR 22 |
| 475 | #define UHF_C_PORT_L1 23 |
| 476 | |
| 477 | /* SS HUB specific features */ |
| 478 | #define UHF_PORT_U1_TIMEOUT 23 |
| 479 | #define UHF_PORT_U2_TIMEOUT 24 |
| 480 | #define UHF_C_PORT_LINK_STATE 25 |
| 481 | #define UHF_C_PORT_CONFIG_ERROR 26 |
| 482 | #define UHF_PORT_REMOTE_WAKE_MASK 27 |
| 483 | #define UHF_BH_PORT_RESET 28 |
| 484 | #define UHF_C_BH_PORT_RESET 29 |
| 485 | #define UHF_FORCE_LINKPM_ACCEPT 30 |
| 486 | |
| 487 | typedef struct { |
| 488 | uByte bDescLength; |
| 489 | uByte bDescriptorType; |
| 490 | uByte bNbrPorts; |
| 491 | #define UHD_NPORTS_MAX 255 |
| 492 | uWord wHubCharacteristics; |
| 493 | #define UHD_PWR 0x0003 |
| 494 | #define UHD_PWR_GANGED 0x0000 |
| 495 | #define UHD_PWR_INDIVIDUAL 0x0001 |
| 496 | #define UHD_PWR_NO_SWITCH 0x0002 |
| 497 | #define UHD_COMPOUND 0x0004 |
| 498 | #define UHD_OC 0x0018 |
| 499 | #define UHD_OC_GLOBAL 0x0000 |
| 500 | #define UHD_OC_INDIVIDUAL 0x0008 |
| 501 | #define UHD_OC_NONE 0x0010 |
| 502 | #define UHD_TT_THINK 0x0060 |
| 503 | #define UHD_TT_THINK_8 0x0000 |
| 504 | #define UHD_TT_THINK_16 0x0020 |
| 505 | #define UHD_TT_THINK_24 0x0040 |
| 506 | #define UHD_TT_THINK_32 0x0060 |
| 507 | #define UHD_PORT_IND 0x0080 |
| 508 | uByte bPwrOn2PwrGood; /* delay in 2 ms units */ |
| 509 | #define UHD_PWRON_FACTOR 2 |
| 510 | uByte bHubContrCurrent; |
| 511 | uByte DeviceRemovable[32]; /* max 255 ports */ |
| 512 | #define UHD_NOT_REMOV(desc, i) \ |
| 513 | (((desc)->DeviceRemovable[(i)/8] >> ((i) % 8)) & 1) |
| 514 | /* deprecated */ uByte PortPowerCtrlMask[1]; |
| 515 | } UPACKED usb_hub_descriptor_t; |
| 516 | #define USB_HUB_DESCRIPTOR_SIZE 9 /* includes deprecated PortPowerCtrlMask */ |
| 517 | |
| 518 | typedef struct { |
| 519 | uByte bLength; |
| 520 | uByte bDescriptorType; |
| 521 | uByte bNbrPorts; |
| 522 | #define UHD_SS_NPORTS_MAX 15 |
| 523 | uWord wHubCharacteristics; |
| 524 | uByte bPwrOn2PwrGood; /* delay in 2 ms units */ |
| 525 | uByte bHubContrCurrent; |
| 526 | uByte bHubHdrDecLat; |
| 527 | uWord wHubDelay; /* forward delay in nanosec */ |
| 528 | uByte DeviceRemovable[2]; /* max 15 ports */ |
| 529 | } UPACKED usb_hub_ss_descriptor_t; |
| 530 | #define USB_HUB_SS_DESCRIPTOR_SIZE 12 |
| 531 | |
| 532 | typedef struct { |
| 533 | uByte bLength; |
| 534 | uByte bDescriptorType; |
| 535 | uWord bcdUSB; |
| 536 | uByte bDeviceClass; |
| 537 | uByte bDeviceSubClass; |
| 538 | uByte bDeviceProtocol; |
| 539 | uByte bMaxPacketSize0; |
| 540 | uByte bNumConfigurations; |
| 541 | uByte bReserved; |
| 542 | } UPACKED usb_device_qualifier_t; |
| 543 | #define USB_DEVICE_QUALIFIER_SIZE 10 |
| 544 | |
| 545 | typedef struct { |
| 546 | uByte bLength; |
| 547 | uByte bDescriptorType; |
| 548 | uByte bmAttributes; |
| 549 | #define UOTG_SRP 0x01 |
| 550 | #define UOTG_HNP 0x02 |
| 551 | } UPACKED usb_otg_descriptor_t; |
| 552 | |
| 553 | /* OTG feature selectors */ |
| 554 | #define UOTG_B_HNP_ENABLE 3 |
| 555 | #define UOTG_A_HNP_SUPPORT 4 |
| 556 | #define UOTG_A_ALT_HNP_SUPPORT 5 |
| 557 | |
| 558 | typedef struct { |
| 559 | uByte bLength; |
| 560 | uByte bDescriptorType; |
| 561 | uByte bDebugInEndpoint; |
| 562 | uByte bDebugOutEndpoint; |
| 563 | } UPACKED usb_debug_descriptor_t; |
| 564 | |
| 565 | typedef struct { |
| 566 | uWord wStatus; |
| 567 | /* Device status flags */ |
| 568 | #define UDS_SELF_POWERED 0x0001 |
| 569 | #define UDS_REMOTE_WAKEUP 0x0002 |
| 570 | /* Endpoint status flags */ |
| 571 | #define UES_HALT 0x0001 |
| 572 | } UPACKED usb_status_t; |
| 573 | |
| 574 | typedef struct { |
| 575 | uWord wHubStatus; |
| 576 | #define UHS_LOCAL_POWER 0x0001 |
| 577 | #define UHS_OVER_CURRENT 0x0002 |
| 578 | uWord wHubChange; |
| 579 | } UPACKED usb_hub_status_t; |
| 580 | |
| 581 | typedef struct { |
| 582 | uWord wPortStatus; |
| 583 | #define UPS_CURRENT_CONNECT_STATUS 0x0001 |
| 584 | #define UPS_PORT_ENABLED 0x0002 |
| 585 | #define UPS_SUSPEND 0x0004 |
| 586 | #define UPS_OVERCURRENT_INDICATOR 0x0008 |
| 587 | #define UPS_RESET 0x0010 |
| 588 | #define UPS_PORT_L1 0x0020 |
| 589 | #define UPS_PORT_LS_MASK __BITS(8,5) |
| 590 | #define UPS_PORT_LS_GET(x) __SHIFTOUT(x, UPS_PORT_LS_MASK) |
| 591 | #define UPS_PORT_LS_SET(x) __SHIFTIN(x, UPS_PORT_LS_MASK) |
| 592 | #define UPS_PORT_LS_U0 0x00 |
| 593 | #define UPS_PORT_LS_U1 0x01 |
| 594 | #define UPS_PORT_LS_U2 0x02 |
| 595 | #define UPS_PORT_LS_U3 0x03 |
| 596 | #define UPS_PORT_LS_SS_DIS 0x04 |
| 597 | #define UPS_PORT_LS_RX_DET 0x05 |
| 598 | #define UPS_PORT_LS_SS_INA 0x06 |
| 599 | #define UPS_PORT_LS_POLL 0x07 |
| 600 | #define UPS_PORT_LS_RECOVER 0x08 |
| 601 | #define UPS_PORT_LS_HOT_RST 0x09 |
| 602 | #define UPS_PORT_LS_COMP_MODE 0x0a |
| 603 | #define UPS_PORT_LS_LOOPBACK 0x0b |
| 604 | #define UPS_PORT_LS_RESUME 0x0f |
| 605 | #define UPS_PORT_POWER 0x0100 |
| 606 | #define UPS_PORT_POWER_SS 0x0200 |
| 607 | #define UPS_FULL_SPEED 0x0000 /* for completeness */ |
| 608 | #define UPS_LOW_SPEED 0x0200 |
| 609 | #define UPS_HIGH_SPEED 0x0400 |
| 610 | #define UPS_PORT_TEST 0x0800 |
| 611 | #define UPS_PORT_INDICATOR 0x1000 |
| 612 | #define UPS_OTHER_SPEED 0x2000 /* currently NetBSD specific */ |
| 613 | uWord wPortChange; |
| 614 | #define UPS_C_CONNECT_STATUS 0x0001 |
| 615 | #define UPS_C_PORT_ENABLED 0x0002 |
| 616 | #define UPS_C_SUSPEND 0x0004 |
| 617 | #define UPS_C_OVERCURRENT_INDICATOR 0x0008 |
| 618 | #define UPS_C_PORT_RESET 0x0010 |
| 619 | #define UPS_C_PORT_L1 0x0020 |
| 620 | #define UPS_C_BH_PORT_RESET 0x0020 |
| 621 | #define UPS_C_PORT_LINK_STATE 0x0040 |
| 622 | #define UPS_C_PORT_CONFIG_ERROR 0x0080 |
| 623 | } UPACKED usb_port_status_t; |
| 624 | |
| 625 | /* 10.16.2.6 */ |
| 626 | /* Valid when port status type is UR_PST_EXT_PORT_STATUS. */ |
| 627 | typedef struct { |
| 628 | uWord wPortStatus; |
| 629 | uWord wPortChange; |
| 630 | uDWord dwExtPortStatus; |
| 631 | } UPACKED usb_port_status_ext_t; |
| 632 | |
| 633 | /* Device class codes */ |
| 634 | #define UDCLASS_IN_INTERFACE 0x00 |
| 635 | #define UDCLASS_COMM 0x02 |
| 636 | #define UDCLASS_HUB 0x09 |
| 637 | #define UDSUBCLASS_HUB 0x00 |
| 638 | #define UDPROTO_FSHUB 0x00 |
| 639 | #define UDPROTO_HSHUBSTT 0x01 |
| 640 | #define UDPROTO_HSHUBMTT 0x02 |
| 641 | #define UDPROTO_SSHUB 0x03 |
| 642 | #define UDCLASS_DIAGNOSTIC 0xdc |
| 643 | #define UDCLASS_WIRELESS 0xe0 |
| 644 | #define UDSUBCLASS_RF 0x01 |
| 645 | #define UDPROTO_BLUETOOTH 0x01 |
| 646 | #define UDCLASS_VENDOR 0xff |
| 647 | |
| 648 | /* Interface class codes */ |
| 649 | #define UICLASS_UNSPEC 0x00 |
| 650 | |
| 651 | #define UICLASS_AUDIO 0x01 |
| 652 | #define UISUBCLASS_AUDIOCONTROL 1 |
| 653 | #define UISUBCLASS_AUDIOSTREAM 2 |
| 654 | #define UISUBCLASS_MIDISTREAM 3 |
| 655 | |
| 656 | #define UICLASS_VIDEO 0x0e |
| 657 | #define UISUBCLASS_VIDEOCONTROL 1 |
| 658 | #define UISUBCLASS_VIDEOSTREAMING 2 |
| 659 | #define UISUBCLASS_VIDEOCOLLECTION 3 |
| 660 | |
| 661 | #define UICLASS_CDC 0x02 /* communication */ |
| 662 | #define UISUBCLASS_DIRECT_LINE_CONTROL_MODEL 1 |
| 663 | #define UISUBCLASS_ABSTRACT_CONTROL_MODEL 2 |
| 664 | #define UISUBCLASS_TELEPHONE_CONTROL_MODEL 3 |
| 665 | #define UISUBCLASS_MULTICHANNEL_CONTROL_MODEL 4 |
| 666 | #define UISUBCLASS_CAPI_CONTROLMODEL 5 |
| 667 | #define UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL 6 |
| 668 | #define UISUBCLASS_ATM_NETWORKING_CONTROL_MODEL 7 |
| 669 | #define UIPROTO_CDC_NOCLASS 0 /* no class specific |
| 670 | protocol required */ |
| 671 | #define UIPROTO_CDC_AT 1 |
| 672 | |
| 673 | #define UICLASS_HID 0x03 |
| 674 | #define UISUBCLASS_BOOT 1 |
| 675 | #define UIPROTO_BOOT_KEYBOARD 1 |
| 676 | #define UIPROTO_MOUSE 2 |
| 677 | |
| 678 | #define UICLASS_PHYSICAL 0x05 |
| 679 | |
| 680 | #define UICLASS_IMAGE 0x06 |
| 681 | |
| 682 | #define UICLASS_PRINTER 0x07 |
| 683 | #define UISUBCLASS_PRINTER 1 |
| 684 | #define UIPROTO_PRINTER_UNI 1 |
| 685 | #define UIPROTO_PRINTER_BI 2 |
| 686 | #define UIPROTO_PRINTER_1284 3 |
| 687 | |
| 688 | #define UICLASS_MASS 0x08 |
| 689 | #define UISUBCLASS_RBC 1 |
| 690 | #define UISUBCLASS_SFF8020I 2 |
| 691 | #define UISUBCLASS_QIC157 3 |
| 692 | #define UISUBCLASS_UFI 4 |
| 693 | #define UISUBCLASS_SFF8070I 5 |
| 694 | #define UISUBCLASS_SCSI 6 |
| 695 | #define UIPROTO_MASS_CBI_I 0 |
| 696 | #define UIPROTO_MASS_CBI 1 |
| 697 | #define UIPROTO_MASS_BBB_OLD 2 /* Not in the spec anymore */ |
| 698 | #define UIPROTO_MASS_BBB 80 /* 'P' for the Iomega Zip drive */ |
| 699 | #define UIPROTO_MASS_UAS 98 /* USB Attached SCSI */ |
| 700 | |
| 701 | #define UICLASS_HUB 0x09 |
| 702 | #define UISUBCLASS_HUB 0 |
| 703 | #define UIPROTO_FSHUB 0 |
| 704 | #define UIPROTO_HSHUBSTT 0 /* Yes, same as previous */ |
| 705 | #define UIPROTO_HSHUBMTT 1 |
| 706 | |
| 707 | #define UICLASS_CDC_DATA 0x0a |
| 708 | #define UISUBCLASS_DATA 0 |
| 709 | #define UIPROTO_DATA_ISDNBRI 0x30 /* Physical iface */ |
| 710 | #define UIPROTO_DATA_HDLC 0x31 /* HDLC */ |
| 711 | #define UIPROTO_DATA_TRANSPARENT 0x32 /* Transparent */ |
| 712 | #define UIPROTO_DATA_Q921M 0x50 /* Management for Q921 */ |
| 713 | #define UIPROTO_DATA_Q921 0x51 /* Data for Q921 */ |
| 714 | #define UIPROTO_DATA_Q921TM 0x52 /* TEI multiplexer for Q921 */ |
| 715 | #define UIPROTO_DATA_V42BIS 0x90 /* Data compression */ |
| 716 | #define UIPROTO_DATA_Q931 0x91 /* Euro-ISDN */ |
| 717 | #define UIPROTO_DATA_V120 0x92 /* V.24 rate adaption */ |
| 718 | #define UIPROTO_DATA_CAPI 0x93 /* CAPI 2.0 commands */ |
| 719 | #define UIPROTO_DATA_HOST_BASED 0xfd /* Host based driver */ |
| 720 | #define UIPROTO_DATA_PUF 0xfe /* see Prot. Unit Func. Desc.*/ |
| 721 | #define UIPROTO_DATA_VENDOR 0xff /* Vendor specific */ |
| 722 | |
| 723 | #define UICLASS_SMARTCARD 0x0b |
| 724 | |
| 725 | /*#define UICLASS_FIRM_UPD 0x0c*/ |
| 726 | |
| 727 | #define UICLASS_SECURITY 0x0d |
| 728 | |
| 729 | #define UICLASS_DIAGNOSTIC 0xdc |
| 730 | |
| 731 | #define UICLASS_WIRELESS 0xe0 |
| 732 | #define UISUBCLASS_RF 0x01 |
| 733 | #define UIPROTO_BLUETOOTH 0x01 |
| 734 | #define UIPROTO_RNDIS 0x03 |
| 735 | |
| 736 | #define UICLASS_APPL_SPEC 0xfe |
| 737 | #define UISUBCLASS_FIRMWARE_DOWNLOAD 1 |
| 738 | #define UISUBCLASS_IRDA 2 |
| 739 | #define UIPROTO_IRDA 0 |
| 740 | |
| 741 | #define UICLASS_VENDOR 0xff |
| 742 | |
| 743 | |
| 744 | #define USB_HUB_MAX_DEPTH 5 |
| 745 | |
| 746 | /* |
| 747 | * Minimum time a device needs to be powered down to go through |
| 748 | * a power cycle. XXX Are these time in the spec? |
| 749 | */ |
| 750 | #define USB_POWER_DOWN_TIME 200 /* ms */ |
| 751 | #define USB_PORT_POWER_DOWN_TIME 100 /* ms */ |
| 752 | |
| 753 | #if 0 |
| 754 | /* These are the values from the spec. */ |
| 755 | #define USB_PORT_RESET_DELAY 10 /* ms */ |
| 756 | #define USB_PORT_ROOT_RESET_DELAY 50 /* ms */ |
| 757 | #define USB_PORT_RESET_RECOVERY 10 /* ms */ |
| 758 | #define USB_PORT_POWERUP_DELAY 100 /* ms */ |
| 759 | #define USB_SET_ADDRESS_SETTLE 2 /* ms */ |
| 760 | #define USB_RESUME_DELAY (20*5) /* ms */ |
| 761 | #define USB_RESUME_WAIT 10 /* ms */ |
| 762 | #define USB_RESUME_RECOVERY 10 /* ms */ |
| 763 | #define USB_EXTRA_POWER_UP_TIME 0 /* ms */ |
| 764 | #else |
| 765 | /* Allow for marginal (i.e. non-conforming) devices. */ |
| 766 | #define USB_PORT_RESET_DELAY 50 /* ms */ |
| 767 | #define USB_PORT_ROOT_RESET_DELAY 250 /* ms */ |
| 768 | #define USB_PORT_RESET_RECOVERY 250 /* ms */ |
| 769 | #define USB_PORT_POWERUP_DELAY 300 /* ms */ |
| 770 | #define USB_SET_ADDRESS_SETTLE 10 /* ms */ |
| 771 | #define USB_RESUME_DELAY (50*5) /* ms */ |
| 772 | #define USB_RESUME_WAIT 50 /* ms */ |
| 773 | #define USB_RESUME_RECOVERY 50 /* ms */ |
| 774 | #define 20 /* ms */ |
| 775 | #endif |
| 776 | |
| 777 | #define USB_MIN_POWER 100 /* mA */ |
| 778 | #define USB_MIN_POWER_SS 150 /* mA */ |
| 779 | #define USB_MAX_POWER 500 /* mA */ |
| 780 | #define USB_MAX_POWER_SS 900 /* mA */ |
| 781 | |
| 782 | #define USB_BUS_RESET_DELAY 100 /* ms XXX?*/ |
| 783 | |
| 784 | |
| 785 | #define USB_UNCONFIG_NO 0 |
| 786 | #define USB_UNCONFIG_INDEX (-1) |
| 787 | |
| 788 | |
| 789 | /* Packet IDs */ |
| 790 | #define UPID_RESERVED 0xf0 |
| 791 | #define UPID_OUT 0xe1 |
| 792 | #define UPID_ACK 0xd2 |
| 793 | #define UPID_DATA0 0xc3 |
| 794 | #define UPID_PING 0xb4 |
| 795 | #define UPID_SOF 0xa5 |
| 796 | #define UPID_NYET 0x96 |
| 797 | #define UPID_DATA2 0x87 |
| 798 | #define UPID_SPLIT 0x78 |
| 799 | #define UPID_IN 0x69 |
| 800 | #define UPID_NAK 0x5a |
| 801 | #define UPID_DATA1 0x4b |
| 802 | #define UPID_ERR 0x3c |
| 803 | #define UPID_PREAMBLE 0x3c |
| 804 | #define UPID_SETUP 0x2d |
| 805 | #define UPID_STALL 0x1e |
| 806 | #define UPID_MDATA 0x0f |
| 807 | |
| 808 | |
| 809 | /*** ioctl() related stuff ***/ |
| 810 | |
| 811 | struct usb_ctl_request { |
| 812 | int ucr_addr; |
| 813 | usb_device_request_t ucr_request; |
| 814 | void *ucr_data; |
| 815 | int ucr_flags; |
| 816 | #define USBD_SHORT_XFER_OK 0x04 /* allow short reads */ |
| 817 | int ucr_actlen; /* actual length transferred */ |
| 818 | }; |
| 819 | |
| 820 | struct usb_alt_interface { |
| 821 | int uai_config_index; |
| 822 | int uai_interface_index; |
| 823 | int uai_alt_no; |
| 824 | }; |
| 825 | |
| 826 | #define USB_CURRENT_CONFIG_INDEX (-1) |
| 827 | #define USB_CURRENT_ALT_INDEX (-1) |
| 828 | |
| 829 | struct usb_config_desc { |
| 830 | int ucd_config_index; |
| 831 | usb_config_descriptor_t ucd_desc; |
| 832 | }; |
| 833 | |
| 834 | struct usb_interface_desc { |
| 835 | int uid_config_index; |
| 836 | int uid_interface_index; |
| 837 | int uid_alt_index; |
| 838 | usb_interface_descriptor_t uid_desc; |
| 839 | }; |
| 840 | |
| 841 | struct usb_endpoint_desc { |
| 842 | int ued_config_index; |
| 843 | int ued_interface_index; |
| 844 | int ued_alt_index; |
| 845 | int ued_endpoint_index; |
| 846 | usb_endpoint_descriptor_t ued_desc; |
| 847 | }; |
| 848 | |
| 849 | struct usb_full_desc { |
| 850 | int ufd_config_index; |
| 851 | u_int ufd_size; |
| 852 | u_char *ufd_data; |
| 853 | }; |
| 854 | |
| 855 | struct usb_string_desc { |
| 856 | int usd_string_index; |
| 857 | int usd_language_id; |
| 858 | usb_string_descriptor_t usd_desc; |
| 859 | }; |
| 860 | |
| 861 | struct usb_ctl_report_desc { |
| 862 | int ucrd_size; |
| 863 | u_char ucrd_data[1024]; /* filled data size will vary */ |
| 864 | }; |
| 865 | |
| 866 | typedef struct { uint32_t cookie; } usb_event_cookie_t; |
| 867 | |
| 868 | #define USB_MAX_DEVNAMES 4 |
| 869 | #define USB_MAX_DEVNAMELEN 16 |
| 870 | struct usb_device_info { |
| 871 | uint8_t udi_bus; |
| 872 | uint8_t udi_addr; /* device address */ |
| 873 | usb_event_cookie_t udi_cookie; |
| 874 | char udi_product[USB_MAX_ENCODED_STRING_LEN]; |
| 875 | char udi_vendor[USB_MAX_ENCODED_STRING_LEN]; |
| 876 | char udi_release[8]; |
| 877 | char udi_serial[USB_MAX_ENCODED_STRING_LEN]; |
| 878 | uint16_t udi_productNo; |
| 879 | uint16_t udi_vendorNo; |
| 880 | uint16_t udi_releaseNo; |
| 881 | uint8_t udi_class; |
| 882 | uint8_t udi_subclass; |
| 883 | uint8_t udi_protocol; |
| 884 | uint8_t udi_config; |
| 885 | uint8_t udi_speed; |
| 886 | #define USB_SPEED_LOW 1 |
| 887 | #define USB_SPEED_FULL 2 |
| 888 | #define USB_SPEED_HIGH 3 |
| 889 | #define USB_SPEED_SUPER 4 |
| 890 | #define USB_SPEED_SUPER_PLUS 5 |
| 891 | #define USB_IS_SS(X) ((X) == USB_SPEED_SUPER || (X) == USB_SPEED_SUPER_PLUS) |
| 892 | int udi_power; /* power consumption in mA, 0 if selfpowered */ |
| 893 | int udi_nports; |
| 894 | char udi_devnames[USB_MAX_DEVNAMES][USB_MAX_DEVNAMELEN]; |
| 895 | uint8_t udi_ports[16];/* hub only: addresses of devices on ports */ |
| 896 | #define USB_PORT_ENABLED 0xff |
| 897 | #define USB_PORT_SUSPENDED 0xfe |
| 898 | #define USB_PORT_POWERED 0xfd |
| 899 | #define USB_PORT_DISABLED 0xfc |
| 900 | }; |
| 901 | |
| 902 | /* <=3.0 had this layout of the structure */ |
| 903 | struct usb_device_info_old { |
| 904 | uint8_t udi_bus; |
| 905 | uint8_t udi_addr; /* device address */ |
| 906 | usb_event_cookie_t udi_cookie; |
| 907 | char udi_product[USB_MAX_STRING_LEN]; |
| 908 | char udi_vendor[USB_MAX_STRING_LEN]; |
| 909 | char udi_release[8]; |
| 910 | uint16_t udi_productNo; |
| 911 | uint16_t udi_vendorNo; |
| 912 | uint16_t udi_releaseNo; |
| 913 | uint8_t udi_class; |
| 914 | uint8_t udi_subclass; |
| 915 | uint8_t udi_protocol; |
| 916 | uint8_t udi_config; |
| 917 | uint8_t udi_speed; |
| 918 | int udi_power; /* power consumption in mA, 0 if selfpowered */ |
| 919 | int udi_nports; |
| 920 | char udi_devnames[USB_MAX_DEVNAMES][USB_MAX_DEVNAMELEN]; |
| 921 | uint8_t udi_ports[16];/* hub only: addresses of devices on ports */ |
| 922 | }; |
| 923 | |
| 924 | struct usb_ctl_report { |
| 925 | int ucr_report; |
| 926 | u_char ucr_data[1024]; /* filled data size will vary */ |
| 927 | }; |
| 928 | |
| 929 | struct usb_device_stats { |
| 930 | u_long uds_requests[4]; /* indexed by transfer type UE_* */ |
| 931 | }; |
| 932 | |
| 933 | struct usb_bulk_ra_wb_opt { |
| 934 | u_int ra_wb_buffer_size; |
| 935 | u_int ra_wb_request_size; |
| 936 | }; |
| 937 | |
| 938 | /* Events that can be read from /dev/usb */ |
| 939 | struct usb_event { |
| 940 | int ue_type; |
| 941 | #define USB_EVENT_CTRLR_ATTACH 1 |
| 942 | #define USB_EVENT_CTRLR_DETACH 2 |
| 943 | #define USB_EVENT_DEVICE_ATTACH 3 |
| 944 | #define USB_EVENT_DEVICE_DETACH 4 |
| 945 | #define USB_EVENT_DRIVER_ATTACH 5 |
| 946 | #define USB_EVENT_DRIVER_DETACH 6 |
| 947 | #define USB_EVENT_IS_ATTACH(n) ((n) == USB_EVENT_CTRLR_ATTACH || (n) == USB_EVENT_DEVICE_ATTACH || (n) == USB_EVENT_DRIVER_ATTACH) |
| 948 | #define USB_EVENT_IS_DETACH(n) ((n) == USB_EVENT_CTRLR_DETACH || (n) == USB_EVENT_DEVICE_DETACH || (n) == USB_EVENT_DRIVER_DETACH) |
| 949 | struct timespec ue_time; |
| 950 | union { |
| 951 | struct { |
| 952 | int ue_bus; |
| 953 | } ue_ctrlr; |
| 954 | struct usb_device_info ue_device; |
| 955 | struct { |
| 956 | usb_event_cookie_t ue_cookie; |
| 957 | char ue_devname[16]; |
| 958 | } ue_driver; |
| 959 | } u; |
| 960 | }; |
| 961 | |
| 962 | /* old <=3.0 compat event */ |
| 963 | struct usb_event_old { |
| 964 | int ue_type; |
| 965 | struct timespec ue_time; |
| 966 | union { |
| 967 | struct { |
| 968 | int ue_bus; |
| 969 | } ue_ctrlr; |
| 970 | struct usb_device_info_old ue_device; |
| 971 | struct { |
| 972 | usb_event_cookie_t ue_cookie; |
| 973 | char ue_devname[16]; |
| 974 | } ue_driver; |
| 975 | } u; |
| 976 | }; |
| 977 | |
| 978 | |
| 979 | /* USB controller */ |
| 980 | #define USB_REQUEST _IOWR('U', 1, struct usb_ctl_request) |
| 981 | #define USB_SETDEBUG _IOW ('U', 2, int) |
| 982 | #define USB_DISCOVER _IO ('U', 3) |
| 983 | #define USB_DEVICEINFO _IOWR('U', 4, struct usb_device_info) |
| 984 | #define USB_DEVICEINFO_OLD _IOWR('U', 4, struct usb_device_info_old) |
| 985 | #define USB_DEVICESTATS _IOR ('U', 5, struct usb_device_stats) |
| 986 | |
| 987 | /* Generic HID device */ |
| 988 | #define USB_GET_REPORT_DESC _IOR ('U', 21, struct usb_ctl_report_desc) |
| 989 | #define USB_SET_IMMED _IOW ('U', 22, int) |
| 990 | #define USB_GET_REPORT _IOWR('U', 23, struct usb_ctl_report) |
| 991 | #define USB_SET_REPORT _IOW ('U', 24, struct usb_ctl_report) |
| 992 | #define USB_GET_REPORT_ID _IOR ('U', 25, int) |
| 993 | |
| 994 | /* Generic USB device */ |
| 995 | #define USB_GET_CONFIG _IOR ('U', 100, int) |
| 996 | #define USB_SET_CONFIG _IOW ('U', 101, int) |
| 997 | #define USB_GET_ALTINTERFACE _IOWR('U', 102, struct usb_alt_interface) |
| 998 | #define USB_SET_ALTINTERFACE _IOWR('U', 103, struct usb_alt_interface) |
| 999 | #define USB_GET_NO_ALT _IOWR('U', 104, struct usb_alt_interface) |
| 1000 | #define USB_GET_DEVICE_DESC _IOR ('U', 105, usb_device_descriptor_t) |
| 1001 | #define USB_GET_CONFIG_DESC _IOWR('U', 106, struct usb_config_desc) |
| 1002 | #define USB_GET_INTERFACE_DESC _IOWR('U', 107, struct usb_interface_desc) |
| 1003 | #define USB_GET_ENDPOINT_DESC _IOWR('U', 108, struct usb_endpoint_desc) |
| 1004 | #define USB_GET_FULL_DESC _IOWR('U', 109, struct usb_full_desc) |
| 1005 | #define USB_GET_STRING_DESC _IOWR('U', 110, struct usb_string_desc) |
| 1006 | #define USB_DO_REQUEST _IOWR('U', 111, struct usb_ctl_request) |
| 1007 | #define USB_GET_DEVICEINFO _IOR ('U', 112, struct usb_device_info) |
| 1008 | #define USB_GET_DEVICEINFO_OLD _IOR ('U', 112, struct usb_device_info_old) |
| 1009 | #define USB_SET_SHORT_XFER _IOW ('U', 113, int) |
| 1010 | #define USB_SET_TIMEOUT _IOW ('U', 114, int) |
| 1011 | #define USB_SET_BULK_RA _IOW ('U', 115, int) |
| 1012 | #define USB_SET_BULK_WB _IOW ('U', 116, int) |
| 1013 | #define USB_SET_BULK_RA_OPT _IOW ('U', 117, struct usb_bulk_ra_wb_opt) |
| 1014 | #define USB_SET_BULK_WB_OPT _IOW ('U', 118, struct usb_bulk_ra_wb_opt) |
| 1015 | |
| 1016 | /* Modem device */ |
| 1017 | #define USB_GET_CM_OVER_DATA _IOR ('U', 130, int) |
| 1018 | #define USB_SET_CM_OVER_DATA _IOW ('U', 131, int) |
| 1019 | |
| 1020 | #endif /* _USB_H_ */ |
| 1021 | |