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.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
30 * This file contains standard definitions for the following USB
39 #ifndef _USB_STANDARD_H_
40 #define _USB_STANDARD_H_
45 /* Declare parent SYSCTL USB node. */
50 #include <sys/malloc.h>
52 MALLOC_DECLARE(M_USB);
53 MALLOC_DECLARE(M_USBDEV);
54 MALLOC_DECLARE(M_USBHC);
57 #include <dev/usb/usb_endian.h>
58 #include <dev/usb/usb_freebsd.h>
60 #define USB_STACK_VERSION 2000 /* 2.0 */
62 /* Definition of some hardcoded USB constants. */
64 #define USB_MAX_IPACKET 8 /* initial USB packet size */
65 #define USB_EP_MAX (2*16) /* hardcoded */
66 #define USB_ROOT_HUB_ADDR 1 /* index */
67 #define USB_MIN_DEVICES 2 /* unused + root HUB */
68 #define USB_UNCONFIG_INDEX 0xFF /* internal use only */
69 #define USB_IFACE_INDEX_ANY 0xFF /* internal use only */
70 #define USB_START_ADDR 0 /* default USB device BUS address
71 * after USB bus reset */
72 #define USB_CONTROL_ENDPOINT 0 /* default control endpoint */
74 #define USB_FRAMES_PER_SECOND_FS 1000 /* full speed */
75 #define USB_FRAMES_PER_SECOND_HS 8000 /* high speed */
77 #define USB_FS_BYTES_PER_HS_UFRAME 188 /* bytes */
78 #define USB_HS_MICRO_FRAMES_MAX 8 /* units */
80 #define USB_ISOC_TIME_MAX 128 /* ms */
83 * Minimum time a device needs to be powered down to go through a
84 * power cycle. These values are not in the USB specification.
86 #define USB_POWER_DOWN_TIME 200 /* ms */
87 #define USB_PORT_POWER_DOWN_TIME 100 /* ms */
89 /* Definition of software USB power modes */
90 #define USB_POWER_MODE_OFF 0 /* turn off device */
91 #define USB_POWER_MODE_ON 1 /* always on */
92 #define USB_POWER_MODE_SAVE 2 /* automatic suspend and resume */
93 #define USB_POWER_MODE_SUSPEND 3 /* force suspend */
94 #define USB_POWER_MODE_RESUME 4 /* force resume */
96 /* These are the values from the USB specification. */
97 #define USB_PORT_RESET_DELAY_SPEC 10 /* ms */
98 #define USB_PORT_ROOT_RESET_DELAY_SPEC 50 /* ms */
99 #define USB_PORT_RESET_RECOVERY_SPEC 10 /* ms */
100 #define USB_PORT_POWERUP_DELAY_SPEC 100 /* ms */
101 #define USB_PORT_RESUME_DELAY_SPEC 20 /* ms */
102 #define USB_SET_ADDRESS_SETTLE_SPEC 2 /* ms */
103 #define USB_RESUME_DELAY_SPEC (20*5) /* ms */
104 #define USB_RESUME_WAIT_SPEC 10 /* ms */
105 #define USB_RESUME_RECOVERY_SPEC 10 /* ms */
106 #define USB_EXTRA_POWER_UP_TIME_SPEC 0 /* ms */
108 /* Allow for marginal and non-conforming devices. */
109 #define USB_PORT_RESET_DELAY 50 /* ms */
110 #define USB_PORT_ROOT_RESET_DELAY 250 /* ms */
111 #define USB_PORT_RESET_RECOVERY 250 /* ms */
112 #define USB_PORT_POWERUP_DELAY 300 /* ms */
113 #define USB_PORT_RESUME_DELAY (20*2) /* ms */
114 #define USB_SET_ADDRESS_SETTLE 10 /* ms */
115 #define USB_RESUME_DELAY (50*5) /* ms */
116 #define USB_RESUME_WAIT 50 /* ms */
117 #define USB_RESUME_RECOVERY 50 /* ms */
118 #define USB_EXTRA_POWER_UP_TIME 20 /* ms */
120 #define USB_MIN_POWER 100 /* mA */
121 #define USB_MAX_POWER 500 /* mA */
123 #define USB_BUS_RESET_DELAY 100 /* ms */
126 * USB record layout in memory:
130 * - USB alternative interfaces
135 * - USB alternative interfaces
139 /* Declaration of USB records */
141 struct usb_device_request {
148 typedef struct usb_device_request usb_device_request_t;
150 #define UT_WRITE 0x00
152 #define UT_STANDARD 0x00
153 #define UT_CLASS 0x20
154 #define UT_VENDOR 0x40
155 #define UT_DEVICE 0x00
156 #define UT_INTERFACE 0x01
157 #define UT_ENDPOINT 0x02
158 #define UT_OTHER 0x03
160 #define UT_READ_DEVICE (UT_READ | UT_STANDARD | UT_DEVICE)
161 #define UT_READ_INTERFACE (UT_READ | UT_STANDARD | UT_INTERFACE)
162 #define UT_READ_ENDPOINT (UT_READ | UT_STANDARD | UT_ENDPOINT)
163 #define UT_WRITE_DEVICE (UT_WRITE | UT_STANDARD | UT_DEVICE)
164 #define UT_WRITE_INTERFACE (UT_WRITE | UT_STANDARD | UT_INTERFACE)
165 #define UT_WRITE_ENDPOINT (UT_WRITE | UT_STANDARD | UT_ENDPOINT)
166 #define UT_READ_CLASS_DEVICE (UT_READ | UT_CLASS | UT_DEVICE)
167 #define UT_READ_CLASS_INTERFACE (UT_READ | UT_CLASS | UT_INTERFACE)
168 #define UT_READ_CLASS_OTHER (UT_READ | UT_CLASS | UT_OTHER)
169 #define UT_READ_CLASS_ENDPOINT (UT_READ | UT_CLASS | UT_ENDPOINT)
170 #define UT_WRITE_CLASS_DEVICE (UT_WRITE | UT_CLASS | UT_DEVICE)
171 #define UT_WRITE_CLASS_INTERFACE (UT_WRITE | UT_CLASS | UT_INTERFACE)
172 #define UT_WRITE_CLASS_OTHER (UT_WRITE | UT_CLASS | UT_OTHER)
173 #define UT_WRITE_CLASS_ENDPOINT (UT_WRITE | UT_CLASS | UT_ENDPOINT)
174 #define UT_READ_VENDOR_DEVICE (UT_READ | UT_VENDOR | UT_DEVICE)
175 #define UT_READ_VENDOR_INTERFACE (UT_READ | UT_VENDOR | UT_INTERFACE)
176 #define UT_READ_VENDOR_OTHER (UT_READ | UT_VENDOR | UT_OTHER)
177 #define UT_READ_VENDOR_ENDPOINT (UT_READ | UT_VENDOR | UT_ENDPOINT)
178 #define UT_WRITE_VENDOR_DEVICE (UT_WRITE | UT_VENDOR | UT_DEVICE)
179 #define UT_WRITE_VENDOR_INTERFACE (UT_WRITE | UT_VENDOR | UT_INTERFACE)
180 #define UT_WRITE_VENDOR_OTHER (UT_WRITE | UT_VENDOR | UT_OTHER)
181 #define UT_WRITE_VENDOR_ENDPOINT (UT_WRITE | UT_VENDOR | UT_ENDPOINT)
184 #define UR_GET_STATUS 0x00
185 #define UR_CLEAR_FEATURE 0x01
186 #define UR_SET_FEATURE 0x03
187 #define UR_SET_ADDRESS 0x05
188 #define UR_GET_DESCRIPTOR 0x06
189 #define UDESC_DEVICE 0x01
190 #define UDESC_CONFIG 0x02
191 #define UDESC_STRING 0x03
192 #define USB_LANGUAGE_TABLE 0x00 /* language ID string index */
193 #define UDESC_INTERFACE 0x04
194 #define UDESC_ENDPOINT 0x05
195 #define UDESC_DEVICE_QUALIFIER 0x06
196 #define UDESC_OTHER_SPEED_CONFIGURATION 0x07
197 #define UDESC_INTERFACE_POWER 0x08
198 #define UDESC_OTG 0x09
199 #define UDESC_DEBUG 0x0A
200 #define UDESC_IFACE_ASSOC 0x0B /* interface association */
201 #define UDESC_BOS 0x0F /* binary object store */
202 #define UDESC_DEVICE_CAPABILITY 0x10
203 #define UDESC_CS_DEVICE 0x21 /* class specific */
204 #define UDESC_CS_CONFIG 0x22
205 #define UDESC_CS_STRING 0x23
206 #define UDESC_CS_INTERFACE 0x24
207 #define UDESC_CS_ENDPOINT 0x25
208 #define UDESC_HUB 0x29
209 #define UDESC_SS_HUB 0x2A /* super speed */
210 #define UDESC_ENDPOINT_SS_COMP 0x30 /* super speed */
211 #define UR_SET_DESCRIPTOR 0x07
212 #define UR_GET_CONFIG 0x08
213 #define UR_SET_CONFIG 0x09
214 #define UR_GET_INTERFACE 0x0a
215 #define UR_SET_INTERFACE 0x0b
216 #define UR_SYNCH_FRAME 0x0c
217 #define UR_SET_SEL 0x30
218 #define UR_ISOCH_DELAY 0x31
220 /* HUB specific request */
221 #define UR_GET_BUS_STATE 0x02
222 #define UR_CLEAR_TT_BUFFER 0x08
223 #define UR_RESET_TT 0x09
224 #define UR_GET_TT_STATE 0x0a
225 #define UR_STOP_TT 0x0b
226 #define UR_SET_HUB_DEPTH 0x0c
227 #define USB_SS_HUB_DEPTH_MAX 5
228 #define UR_GET_PORT_ERR_COUNT 0x0d
230 /* Feature numbers */
231 #define UF_ENDPOINT_HALT 0
232 #define UF_DEVICE_REMOTE_WAKEUP 1
233 #define UF_TEST_MODE 2
234 #define UF_U1_ENABLE 0x30
235 #define UF_U2_ENABLE 0x31
236 #define UF_LTM_ENABLE 0x32
238 /* HUB specific features */
239 #define UHF_C_HUB_LOCAL_POWER 0
240 #define UHF_C_HUB_OVER_CURRENT 1
241 #define UHF_PORT_CONNECTION 0
242 #define UHF_PORT_ENABLE 1
243 #define UHF_PORT_SUSPEND 2
244 #define UHF_PORT_OVER_CURRENT 3
245 #define UHF_PORT_RESET 4
246 #define UHF_PORT_LINK_STATE 5
247 #define UHF_PORT_POWER 8
248 #define UHF_PORT_LOW_SPEED 9
249 #define UHF_C_PORT_CONNECTION 16
250 #define UHF_C_PORT_ENABLE 17
251 #define UHF_C_PORT_SUSPEND 18
252 #define UHF_C_PORT_OVER_CURRENT 19
253 #define UHF_C_PORT_RESET 20
254 #define UHF_PORT_TEST 21
255 #define UHF_PORT_INDICATOR 22
257 /* SuperSpeed HUB specific features */
258 #define UHF_PORT_U1_TIMEOUT 23
259 #define UHF_PORT_U2_TIMEOUT 24
260 #define UHF_C_PORT_LINK_STATE 25
261 #define UHF_C_PORT_CONFIG_ERROR 26
262 #define UHF_PORT_REMOTE_WAKE_MASK 27
263 #define UHF_BH_PORT_RESET 28
264 #define UHF_C_BH_PORT_RESET 29
265 #define UHF_FORCE_LINKPM_ACCEPT 30
267 struct usb_descriptor {
269 uByte bDescriptorType;
270 uByte bDescriptorSubtype;
272 typedef struct usb_descriptor usb_descriptor_t;
274 struct usb_device_descriptor {
276 uByte bDescriptorType;
278 #define UD_USB_2_0 0x0200
279 #define UD_USB_3_0 0x0300
280 #define UD_IS_USB2(d) ((d)->bcdUSB[1] == 0x02)
281 #define UD_IS_USB3(d) ((d)->bcdUSB[1] == 0x03)
283 uByte bDeviceSubClass;
284 uByte bDeviceProtocol;
285 uByte bMaxPacketSize;
286 /* The fields below are not part of the initial descriptor. */
293 uByte bNumConfigurations;
295 typedef struct usb_device_descriptor usb_device_descriptor_t;
297 /* Binary Device Object Store (BOS) */
298 struct usb_bos_descriptor {
300 uByte bDescriptorType;
302 uByte bNumDeviceCaps;
304 typedef struct usb_bos_descriptor usb_bos_descriptor_t;
306 /* Binary Device Object Store Capability */
307 struct usb_bos_cap_descriptor {
309 uByte bDescriptorType;
310 uByte bDevCapabilityType;
311 #define USB_DEVCAP_RESERVED 0x00
312 #define USB_DEVCAP_WUSB 0x01
313 #define USB_DEVCAP_USB2EXT 0x02
314 #define USB_DEVCAP_SUPER_SPEED 0x03
315 #define USB_DEVCAP_CONTAINER_ID 0x04
318 typedef struct usb_bos_cap_descriptor usb_bos_cap_descriptor_t;
320 struct usb_devcap_usb2ext_descriptor {
322 uByte bDescriptorType;
323 uByte bDevCapabilityType;
325 #define USB_V2EXT_LPM 0x02
327 typedef struct usb_devcap_usb2ext_descriptor usb_devcap_usb2ext_descriptor_t;
329 struct usb_devcap_ss_descriptor {
331 uByte bDescriptorType;
332 uByte bDevCapabilityType;
334 uWord wSpeedsSupported;
335 uByte bFunctionalitySupport;
339 typedef struct usb_devcap_ss_descriptor usb_devcap_ss_descriptor_t;
341 struct usb_devcap_container_id_descriptor {
343 uByte bDescriptorType;
344 uByte bDevCapabilityType;
348 typedef struct usb_devcap_container_id_descriptor
349 usb_devcap_container_id_descriptor_t;
351 /* Device class codes */
352 #define UDCLASS_IN_INTERFACE 0x00
353 #define UDCLASS_COMM 0x02
354 #define UDCLASS_HUB 0x09
355 #define UDSUBCLASS_HUB 0x00
356 #define UDPROTO_FSHUB 0x00
357 #define UDPROTO_HSHUBSTT 0x01
358 #define UDPROTO_HSHUBMTT 0x02
359 #define UDPROTO_SSHUB 0x03
360 #define UDCLASS_DIAGNOSTIC 0xdc
361 #define UDCLASS_WIRELESS 0xe0
362 #define UDSUBCLASS_RF 0x01
363 #define UDPROTO_BLUETOOTH 0x01
364 #define UDCLASS_VENDOR 0xff
366 struct usb_config_descriptor {
368 uByte bDescriptorType;
371 uByte bConfigurationValue;
372 #define USB_UNCONFIG_NO 0
373 uByte iConfiguration;
375 #define UC_BUS_POWERED 0x80
376 #define UC_SELF_POWERED 0x40
377 #define UC_REMOTE_WAKEUP 0x20
378 uByte bMaxPower; /* max current in 2 mA units */
379 #define UC_POWER_FACTOR 2
381 typedef struct usb_config_descriptor usb_config_descriptor_t;
383 struct usb_interface_descriptor {
385 uByte bDescriptorType;
386 uByte bInterfaceNumber;
387 uByte bAlternateSetting;
389 uByte bInterfaceClass;
390 uByte bInterfaceSubClass;
391 uByte bInterfaceProtocol;
394 typedef struct usb_interface_descriptor usb_interface_descriptor_t;
396 struct usb_interface_assoc_descriptor {
398 uByte bDescriptorType;
399 uByte bFirstInterface;
400 uByte bInterfaceCount;
401 uByte bFunctionClass;
402 uByte bFunctionSubClass;
403 uByte bFunctionProtocol;
406 typedef struct usb_interface_assoc_descriptor usb_interface_assoc_descriptor_t;
408 /* Interface class codes */
409 #define UICLASS_UNSPEC 0x00
410 #define UICLASS_AUDIO 0x01 /* audio */
411 #define UISUBCLASS_AUDIOCONTROL 1
412 #define UISUBCLASS_AUDIOSTREAM 2
413 #define UISUBCLASS_MIDISTREAM 3
415 #define UICLASS_CDC 0x02 /* communication */
416 #define UISUBCLASS_DIRECT_LINE_CONTROL_MODEL 1
417 #define UISUBCLASS_ABSTRACT_CONTROL_MODEL 2
418 #define UISUBCLASS_TELEPHONE_CONTROL_MODEL 3
419 #define UISUBCLASS_MULTICHANNEL_CONTROL_MODEL 4
420 #define UISUBCLASS_CAPI_CONTROLMODEL 5
421 #define UISUBCLASS_ETHERNET_NETWORKING_CONTROL_MODEL 6
422 #define UISUBCLASS_ATM_NETWORKING_CONTROL_MODEL 7
423 #define UISUBCLASS_WIRELESS_HANDSET_CM 8
424 #define UISUBCLASS_DEVICE_MGMT 9
425 #define UISUBCLASS_MOBILE_DIRECT_LINE_MODEL 10
426 #define UISUBCLASS_OBEX 11
427 #define UISUBCLASS_ETHERNET_EMULATION_MODEL 12
428 #define UISUBCLASS_NETWORK_CONTROL_MODEL 13
430 #define UIPROTO_CDC_AT 1
432 #define UICLASS_HID 0x03
433 #define UISUBCLASS_BOOT 1
434 #define UIPROTO_BOOT_KEYBOARD 1
435 #define UIPROTO_MOUSE 2
437 #define UICLASS_PHYSICAL 0x05
438 #define UICLASS_IMAGE 0x06
439 #define UISUBCLASS_SIC 1 /* still image class */
440 #define UICLASS_PRINTER 0x07
441 #define UISUBCLASS_PRINTER 1
442 #define UIPROTO_PRINTER_UNI 1
443 #define UIPROTO_PRINTER_BI 2
444 #define UIPROTO_PRINTER_1284 3
446 #define UICLASS_MASS 0x08
447 #define UISUBCLASS_RBC 1
448 #define UISUBCLASS_SFF8020I 2
449 #define UISUBCLASS_QIC157 3
450 #define UISUBCLASS_UFI 4
451 #define UISUBCLASS_SFF8070I 5
452 #define UISUBCLASS_SCSI 6
453 #define UIPROTO_MASS_CBI_I 0
454 #define UIPROTO_MASS_CBI 1
455 #define UIPROTO_MASS_BBB_OLD 2 /* Not in the spec anymore */
456 #define UIPROTO_MASS_BBB 80 /* 'P' for the Iomega Zip drive */
458 #define UICLASS_HUB 0x09
459 #define UISUBCLASS_HUB 0
460 #define UIPROTO_FSHUB 0
461 #define UIPROTO_HSHUBSTT 0 /* Yes, same as previous */
462 #define UIPROTO_HSHUBMTT 1
464 #define UICLASS_CDC_DATA 0x0a
465 #define UISUBCLASS_DATA 0x00
466 #define UIPROTO_DATA_ISDNBRI 0x30 /* Physical iface */
467 #define UIPROTO_DATA_HDLC 0x31 /* HDLC */
468 #define UIPROTO_DATA_TRANSPARENT 0x32 /* Transparent */
469 #define UIPROTO_DATA_Q921M 0x50 /* Management for Q921 */
470 #define UIPROTO_DATA_Q921 0x51 /* Data for Q921 */
471 #define UIPROTO_DATA_Q921TM 0x52 /* TEI multiplexer for Q921 */
472 #define UIPROTO_DATA_V42BIS 0x90 /* Data compression */
473 #define UIPROTO_DATA_Q931 0x91 /* Euro-ISDN */
474 #define UIPROTO_DATA_V120 0x92 /* V.24 rate adaption */
475 #define UIPROTO_DATA_CAPI 0x93 /* CAPI 2.0 commands */
476 #define UIPROTO_DATA_HOST_BASED 0xfd /* Host based driver */
477 #define UIPROTO_DATA_PUF 0xfe /* see Prot. Unit Func. Desc. */
478 #define UIPROTO_DATA_VENDOR 0xff /* Vendor specific */
479 #define UIPROTO_DATA_NCM 0x01 /* Network Control Model */
481 #define UICLASS_SMARTCARD 0x0b
482 #define UICLASS_FIRM_UPD 0x0c
483 #define UICLASS_SECURITY 0x0d
484 #define UICLASS_DIAGNOSTIC 0xdc
485 #define UICLASS_WIRELESS 0xe0
486 #define UISUBCLASS_RF 0x01
487 #define UIPROTO_BLUETOOTH 0x01
489 #define UICLASS_IAD 0xEF /* Interface Association Descriptor */
491 #define UICLASS_APPL_SPEC 0xfe
492 #define UISUBCLASS_FIRMWARE_DOWNLOAD 1
493 #define UISUBCLASS_IRDA 2
494 #define UIPROTO_IRDA 0
496 #define UICLASS_VENDOR 0xff
497 #define UISUBCLASS_XBOX360_CONTROLLER 0x5d
498 #define UIPROTO_XBOX360_GAMEPAD 0x01
500 struct usb_endpoint_descriptor {
502 uByte bDescriptorType;
503 uByte bEndpointAddress;
504 #define UE_GET_DIR(a) ((a) & 0x80)
505 #define UE_SET_DIR(a,d) ((a) | (((d)&1) << 7))
506 #define UE_DIR_IN 0x80 /* IN-token endpoint, fixed */
507 #define UE_DIR_OUT 0x00 /* OUT-token endpoint, fixed */
508 #define UE_DIR_RX 0xfd /* for internal use only! */
509 #define UE_DIR_TX 0xfe /* for internal use only! */
510 #define UE_DIR_ANY 0xff /* for internal use only! */
512 #define UE_ADDR_ANY 0xff /* for internal use only! */
513 #define UE_GET_ADDR(a) ((a) & UE_ADDR)
515 #define UE_XFERTYPE 0x03
516 #define UE_CONTROL 0x00
517 #define UE_ISOCHRONOUS 0x01
519 #define UE_INTERRUPT 0x03
520 #define UE_BULK_INTR 0xfe /* for internal use only! */
521 #define UE_TYPE_ANY 0xff /* for internal use only! */
522 #define UE_GET_XFERTYPE(a) ((a) & UE_XFERTYPE)
523 #define UE_ISO_TYPE 0x0c
524 #define UE_ISO_ASYNC 0x04
525 #define UE_ISO_ADAPT 0x08
526 #define UE_ISO_SYNC 0x0c
527 #define UE_GET_ISO_TYPE(a) ((a) & UE_ISO_TYPE)
528 #define UE_ISO_USAGE 0x30
529 #define UE_ISO_USAGE_DATA 0x00
530 #define UE_ISO_USAGE_FEEDBACK 0x10
531 #define UE_ISO_USAGE_IMPLICT_FB 0x20
532 #define UE_GET_ISO_USAGE(a) ((a) & UE_ISO_USAGE)
533 uWord wMaxPacketSize;
534 #define UE_ZERO_MPS 0xFFFF /* for internal use only */
537 typedef struct usb_endpoint_descriptor usb_endpoint_descriptor_t;
539 struct usb_endpoint_ss_comp_descriptor {
541 uByte bDescriptorType;
544 uWord wBytesPerInterval;
546 typedef struct usb_endpoint_ss_comp_descriptor
547 usb_endpoint_ss_comp_descriptor_t;
549 struct usb_string_descriptor {
551 uByte bDescriptorType;
555 typedef struct usb_string_descriptor usb_string_descriptor_t;
557 #define USB_MAKE_STRING_DESC(m,name) \
560 uByte bDescriptorType; \
561 uByte bData[sizeof((uint8_t []){m})]; \
563 static const struct name name = { \
564 .bLength = sizeof(struct name), \
565 .bDescriptorType = UDESC_STRING, \
569 struct usb_hub_descriptor {
571 uByte bDescriptorType;
573 uWord wHubCharacteristics;
574 #define UHD_PWR 0x0003
575 #define UHD_PWR_GANGED 0x0000
576 #define UHD_PWR_INDIVIDUAL 0x0001
577 #define UHD_PWR_NO_SWITCH 0x0002
578 #define UHD_COMPOUND 0x0004
579 #define UHD_OC 0x0018
580 #define UHD_OC_GLOBAL 0x0000
581 #define UHD_OC_INDIVIDUAL 0x0008
582 #define UHD_OC_NONE 0x0010
583 #define UHD_TT_THINK 0x0060
584 #define UHD_TT_THINK_8 0x0000
585 #define UHD_TT_THINK_16 0x0020
586 #define UHD_TT_THINK_24 0x0040
587 #define UHD_TT_THINK_32 0x0060
588 #define UHD_PORT_IND 0x0080
589 uByte bPwrOn2PwrGood; /* delay in 2 ms units */
590 #define UHD_PWRON_FACTOR 2
591 uByte bHubContrCurrent;
592 uByte DeviceRemovable[32]; /* max 255 ports */
593 #define UHD_NOT_REMOV(desc, i) \
594 (((desc)->DeviceRemovable[(i)/8] >> ((i) % 8)) & 1)
595 uByte PortPowerCtrlMask[1]; /* deprecated */
597 typedef struct usb_hub_descriptor usb_hub_descriptor_t;
599 struct usb_hub_ss_descriptor {
601 uByte bDescriptorType;
603 uWord wHubCharacteristics;
604 uByte bPwrOn2PwrGood; /* delay in 2 ms units */
605 uByte bHubContrCurrent;
608 uByte DeviceRemovable[32]; /* max 255 ports */
610 typedef struct usb_hub_ss_descriptor usb_hub_ss_descriptor_t;
612 /* minimum HUB descriptor (8-ports maximum) */
613 struct usb_hub_descriptor_min {
615 uByte bDescriptorType;
617 uWord wHubCharacteristics;
618 uByte bPwrOn2PwrGood;
619 uByte bHubContrCurrent;
620 uByte DeviceRemovable[1];
621 uByte PortPowerCtrlMask[1];
623 typedef struct usb_hub_descriptor_min usb_hub_descriptor_min_t;
625 struct usb_device_qualifier {
627 uByte bDescriptorType;
630 uByte bDeviceSubClass;
631 uByte bDeviceProtocol;
632 uByte bMaxPacketSize0;
633 uByte bNumConfigurations;
636 typedef struct usb_device_qualifier usb_device_qualifier_t;
638 struct usb_otg_descriptor {
640 uByte bDescriptorType;
642 #define UOTG_SRP 0x01
643 #define UOTG_HNP 0x02
645 typedef struct usb_otg_descriptor usb_otg_descriptor_t;
647 /* OTG feature selectors */
648 #define UOTG_B_HNP_ENABLE 3
649 #define UOTG_A_HNP_SUPPORT 4
650 #define UOTG_A_ALT_HNP_SUPPORT 5
654 /* Device status flags */
655 #define UDS_SELF_POWERED 0x0001
656 #define UDS_REMOTE_WAKEUP 0x0002
657 /* Endpoint status flags */
658 #define UES_HALT 0x0001
660 typedef struct usb_status usb_status_t;
662 struct usb_hub_status {
664 #define UHS_LOCAL_POWER 0x0001
665 #define UHS_OVER_CURRENT 0x0002
668 typedef struct usb_hub_status usb_hub_status_t;
670 struct usb_port_status {
672 #define UPS_CURRENT_CONNECT_STATUS 0x0001
673 #define UPS_PORT_ENABLED 0x0002
674 #define UPS_SUSPEND 0x0004
675 #define UPS_OVERCURRENT_INDICATOR 0x0008
676 #define UPS_RESET 0x0010
677 /* The link-state bits are valid for Super-Speed USB HUBs */
678 #define UPS_PORT_LINK_STATE_GET(x) (((x) >> 5) & 0xF)
679 #define UPS_PORT_LINK_STATE_SET(x) (((x) & 0xF) << 5)
680 #define UPS_PORT_LS_U0 0x00
681 #define UPS_PORT_LS_U1 0x01
682 #define UPS_PORT_LS_U2 0x02
683 #define UPS_PORT_LS_U3 0x03
684 #define UPS_PORT_LS_SS_DIS 0x04
685 #define UPS_PORT_LS_RX_DET 0x05
686 #define UPS_PORT_LS_SS_INA 0x06
687 #define UPS_PORT_LS_POLL 0x07
688 #define UPS_PORT_LS_RECOVER 0x08
689 #define UPS_PORT_LS_HOT_RST 0x09
690 #define UPS_PORT_LS_COMP_MODE 0x0A
691 #define UPS_PORT_LS_LOOPBACK 0x0B
692 #define UPS_PORT_LS_RESUME 0x0F
693 #define UPS_PORT_POWER 0x0100
694 #define UPS_PORT_POWER_SS 0x0200 /* super-speed only */
695 #define UPS_LOW_SPEED 0x0200
696 #define UPS_HIGH_SPEED 0x0400
697 #define UPS_OTHER_SPEED 0x0600 /* currently FreeBSD specific */
698 #define UPS_PORT_TEST 0x0800
699 #define UPS_PORT_INDICATOR 0x1000
700 #define UPS_PORT_MODE_DEVICE 0x8000 /* currently FreeBSD specific */
702 #define UPS_C_CONNECT_STATUS 0x0001
703 #define UPS_C_PORT_ENABLED 0x0002
704 #define UPS_C_SUSPEND 0x0004
705 #define UPS_C_OVERCURRENT_INDICATOR 0x0008
706 #define UPS_C_PORT_RESET 0x0010
707 #define UPS_C_BH_PORT_RESET 0x0020
708 #define UPS_C_PORT_LINK_STATE 0x0040
709 #define UPS_C_PORT_CONFIG_ERROR 0x0080
711 typedef struct usb_port_status usb_port_status_t;
714 * The "USB_SPEED" macros defines all the supported USB speeds.
723 #define USB_SPEED_MAX (USB_SPEED_SUPER+1)
726 * The "USB_REV" macros defines all the supported USB revisions.
737 #define USB_REV_MAX (USB_REV_3_0+1)
740 * Supported host contoller modes.
743 USB_MODE_HOST, /* initiates transfers */
744 USB_MODE_DEVICE, /* bus transfer target */
745 USB_MODE_DUAL /* can be host or device */
747 #define USB_MODE_MAX (USB_MODE_DUAL+1)
750 * The "USB_MODE" macros defines all the supported device states.
757 USB_STATE_CONFIGURED,
759 #define USB_STATE_MAX (USB_STATE_CONFIGURED+1)
760 #endif /* _USB_STANDARD_H_ */