]> git.sur5r.net Git - u-boot/blob - include/usb_defs.h
powerpc: add CONFIG_SECURE_BOOT condition into fsl_secure_boot.h
[u-boot] / include / usb_defs.h
1 /*
2  * (C) Copyright 2001
3  * Denis Peter, MPL AG Switzerland
4  *
5  * SPDX-License-Identifier:     GPL-2.0+
6  *
7  * Note: Part of this code has been derived from linux
8  */
9 #ifndef _USB_DEFS_H_
10 #define _USB_DEFS_H_
11
12 /* USB constants */
13
14 /* Device and/or Interface Class codes */
15 #define USB_CLASS_PER_INTERFACE  0      /* for DeviceClass */
16 #define USB_CLASS_AUDIO          1
17 #define USB_CLASS_COMM           2
18 #define USB_CLASS_HID            3
19 #define USB_CLASS_PRINTER              7
20 #define USB_CLASS_MASS_STORAGE   8
21 #define USB_CLASS_HUB            9
22 #define USB_CLASS_DATA           10
23 #define USB_CLASS_VENDOR_SPEC    0xff
24
25 /* some HID sub classes */
26 #define USB_SUB_HID_NONE        0
27 #define USB_SUB_HID_BOOT        1
28
29 /* some UID Protocols */
30 #define USB_PROT_HID_NONE       0
31 #define USB_PROT_HID_KEYBOARD   1
32 #define USB_PROT_HID_MOUSE      2
33
34
35 /* Sub STORAGE Classes */
36 #define US_SC_RBC              1                /* Typically, flash devices */
37 #define US_SC_8020             2                /* CD-ROM */
38 #define US_SC_QIC              3                /* QIC-157 Tapes */
39 #define US_SC_UFI              4                /* Floppy */
40 #define US_SC_8070             5                /* Removable media */
41 #define US_SC_SCSI             6                /* Transparent */
42 #define US_SC_MIN              US_SC_RBC
43 #define US_SC_MAX              US_SC_SCSI
44
45 /* STORAGE Protocols */
46 #define US_PR_CB               1                /* Control/Bulk w/o interrupt */
47 #define US_PR_CBI              0                /* Control/Bulk/Interrupt */
48 #define US_PR_BULK             0x50             /* bulk only */
49
50 /* USB types */
51 #define USB_TYPE_STANDARD   (0x00 << 5)
52 #define USB_TYPE_CLASS      (0x01 << 5)
53 #define USB_TYPE_VENDOR     (0x02 << 5)
54 #define USB_TYPE_RESERVED   (0x03 << 5)
55
56 /* USB recipients */
57 #define USB_RECIP_DEVICE      0x00
58 #define USB_RECIP_INTERFACE   0x01
59 #define USB_RECIP_ENDPOINT    0x02
60 #define USB_RECIP_OTHER       0x03
61
62 /* USB directions */
63 #define USB_DIR_OUT           0
64 #define USB_DIR_IN            0x80
65
66 /* Descriptor types */
67 #define USB_DT_DEVICE        0x01
68 #define USB_DT_CONFIG        0x02
69 #define USB_DT_STRING        0x03
70 #define USB_DT_INTERFACE     0x04
71 #define USB_DT_ENDPOINT      0x05
72
73 #define USB_DT_HID          (USB_TYPE_CLASS | 0x01)
74 #define USB_DT_REPORT       (USB_TYPE_CLASS | 0x02)
75 #define USB_DT_PHYSICAL     (USB_TYPE_CLASS | 0x03)
76 #define USB_DT_HUB          (USB_TYPE_CLASS | 0x09)
77
78 /* Descriptor sizes per descriptor type */
79 #define USB_DT_DEVICE_SIZE      18
80 #define USB_DT_CONFIG_SIZE      9
81 #define USB_DT_INTERFACE_SIZE   9
82 #define USB_DT_ENDPOINT_SIZE    7
83 #define USB_DT_ENDPOINT_AUDIO_SIZE  9   /* Audio extension */
84 #define USB_DT_HUB_NONVAR_SIZE  7
85 #define USB_DT_HID_SIZE         9
86
87 /* Endpoints */
88 #define USB_ENDPOINT_NUMBER_MASK  0x0f  /* in bEndpointAddress */
89 #define USB_ENDPOINT_DIR_MASK     0x80
90
91 #define USB_ENDPOINT_XFERTYPE_MASK 0x03 /* in bmAttributes */
92 #define USB_ENDPOINT_XFER_CONTROL  0
93 #define USB_ENDPOINT_XFER_ISOC     1
94 #define USB_ENDPOINT_XFER_BULK     2
95 #define USB_ENDPOINT_XFER_INT      3
96
97 /* USB Packet IDs (PIDs) */
98 #define USB_PID_UNDEF_0             0xf0
99 #define USB_PID_OUT                 0xe1
100 #define USB_PID_ACK                 0xd2
101 #define USB_PID_DATA0               0xc3
102 #define USB_PID_UNDEF_4             0xb4
103 #define USB_PID_SOF                 0xa5
104 #define USB_PID_UNDEF_6             0x96
105 #define USB_PID_UNDEF_7             0x87
106 #define USB_PID_UNDEF_8             0x78
107 #define USB_PID_IN                  0x69
108 #define USB_PID_NAK                 0x5a
109 #define USB_PID_DATA1               0x4b
110 #define USB_PID_PREAMBLE            0x3c
111 #define USB_PID_SETUP               0x2d
112 #define USB_PID_STALL               0x1e
113 #define USB_PID_UNDEF_F             0x0f
114
115 /* Standard requests */
116 #define USB_REQ_GET_STATUS          0x00
117 #define USB_REQ_CLEAR_FEATURE       0x01
118 #define USB_REQ_SET_FEATURE         0x03
119 #define USB_REQ_SET_ADDRESS         0x05
120 #define USB_REQ_GET_DESCRIPTOR      0x06
121 #define USB_REQ_SET_DESCRIPTOR      0x07
122 #define USB_REQ_GET_CONFIGURATION   0x08
123 #define USB_REQ_SET_CONFIGURATION   0x09
124 #define USB_REQ_GET_INTERFACE       0x0A
125 #define USB_REQ_SET_INTERFACE       0x0B
126 #define USB_REQ_SYNCH_FRAME         0x0C
127
128 /* HID requests */
129 #define USB_REQ_GET_REPORT          0x01
130 #define USB_REQ_GET_IDLE            0x02
131 #define USB_REQ_GET_PROTOCOL        0x03
132 #define USB_REQ_SET_REPORT          0x09
133 #define USB_REQ_SET_IDLE            0x0A
134 #define USB_REQ_SET_PROTOCOL        0x0B
135
136 /* Device features */
137 #define USB_FEAT_HALT               0x00
138 #define USB_FEAT_WAKEUP             0x01
139 #define USB_FEAT_TEST               0x02
140
141 /* Test modes */
142 #define USB_TEST_MODE_J             0x01
143 #define USB_TEST_MODE_K             0x02
144 #define USB_TEST_MODE_SE0_NAK       0x03
145 #define USB_TEST_MODE_PACKET        0x04
146 #define USB_TEST_MODE_FORCE_ENABLE  0x05
147
148
149 /* "pipe" definitions */
150
151 #define PIPE_ISOCHRONOUS    0
152 #define PIPE_INTERRUPT      1
153 #define PIPE_CONTROL        2
154 #define PIPE_BULK           3
155 #define PIPE_DEVEP_MASK     0x0007ff00
156
157 #define USB_ISOCHRONOUS    0
158 #define USB_INTERRUPT      1
159 #define USB_CONTROL        2
160 #define USB_BULK           3
161
162 /* USB-status codes: */
163 #define USB_ST_ACTIVE           0x1             /* TD is active */
164 #define USB_ST_STALLED          0x2             /* TD is stalled */
165 #define USB_ST_BUF_ERR          0x4             /* buffer error */
166 #define USB_ST_BABBLE_DET       0x8             /* Babble detected */
167 #define USB_ST_NAK_REC          0x10    /* NAK Received*/
168 #define USB_ST_CRC_ERR          0x20    /* CRC/timeout Error */
169 #define USB_ST_BIT_ERR          0x40    /* Bitstuff error */
170 #define USB_ST_NOT_PROC         0x80000000L     /* Not yet processed */
171
172
173 /*************************************************************************
174  * Hub defines
175  */
176
177 /*
178  * Hub request types
179  */
180
181 #define USB_RT_HUB      (USB_TYPE_CLASS | USB_RECIP_DEVICE)
182 #define USB_RT_PORT     (USB_TYPE_CLASS | USB_RECIP_OTHER)
183
184 /*
185  * Hub Class feature numbers
186  */
187 #define C_HUB_LOCAL_POWER   0
188 #define C_HUB_OVER_CURRENT  1
189
190 /*
191  * Port feature numbers
192  */
193 #define USB_PORT_FEAT_CONNECTION     0
194 #define USB_PORT_FEAT_ENABLE         1
195 #define USB_PORT_FEAT_SUSPEND        2
196 #define USB_PORT_FEAT_OVER_CURRENT   3
197 #define USB_PORT_FEAT_RESET          4
198 #define USB_PORT_FEAT_POWER          8
199 #define USB_PORT_FEAT_LOWSPEED       9
200 #define USB_PORT_FEAT_HIGHSPEED      10
201 #define USB_PORT_FEAT_C_CONNECTION   16
202 #define USB_PORT_FEAT_C_ENABLE       17
203 #define USB_PORT_FEAT_C_SUSPEND      18
204 #define USB_PORT_FEAT_C_OVER_CURRENT 19
205 #define USB_PORT_FEAT_C_RESET        20
206 #define USB_PORT_FEAT_TEST           21
207
208 /*
209  * Changes to Port feature numbers for Super speed,
210  * from USB 3.0 spec Table 10-8
211  */
212 #define USB_SS_PORT_FEAT_U1_TIMEOUT     23
213 #define USB_SS_PORT_FEAT_U2_TIMEOUT     24
214 #define USB_SS_PORT_FEAT_C_LINK_STATE   25
215 #define USB_SS_PORT_FEAT_C_CONFIG_ERROR 26
216 #define USB_SS_PORT_FEAT_BH_RESET       28
217 #define USB_SS_PORT_FEAT_C_BH_RESET     29
218
219 /* wPortStatus bits */
220 #define USB_PORT_STAT_CONNECTION    0x0001
221 #define USB_PORT_STAT_ENABLE        0x0002
222 #define USB_PORT_STAT_SUSPEND       0x0004
223 #define USB_PORT_STAT_OVERCURRENT   0x0008
224 #define USB_PORT_STAT_RESET         0x0010
225 #define USB_PORT_STAT_POWER         0x0100
226 #define USB_PORT_STAT_LOW_SPEED     0x0200
227 #define USB_PORT_STAT_HIGH_SPEED    0x0400      /* support for EHCI */
228 #define USB_PORT_STAT_SUPER_SPEED   0x0600      /* faking support to XHCI */
229 #define USB_PORT_STAT_SPEED_MASK        \
230         (USB_PORT_STAT_LOW_SPEED | USB_PORT_STAT_HIGH_SPEED)
231
232 /*
233  * Changes to wPortStatus bit field in USB 3.0
234  * See USB 3.0 spec Table 10-11
235  */
236 #define USB_SS_PORT_STAT_LINK_STATE     0x01e0
237 #define USB_SS_PORT_STAT_POWER          0x0200
238 #define USB_SS_PORT_STAT_SPEED          0x1c00
239 #define USB_SS_PORT_STAT_SPEED_5GBPS    0x0000
240
241 /* wPortChange bits */
242 #define USB_PORT_STAT_C_CONNECTION  0x0001
243 #define USB_PORT_STAT_C_ENABLE      0x0002
244 #define USB_PORT_STAT_C_SUSPEND     0x0004
245 #define USB_PORT_STAT_C_OVERCURRENT 0x0008
246 #define USB_PORT_STAT_C_RESET       0x0010
247
248 /*
249  * Changes to wPortChange bit fields in USB 3.0
250  * See USB 3.0 spec Table 10-12
251  */
252 #define USB_SS_PORT_STAT_C_BH_RESET     0x0020
253 #define USB_SS_PORT_STAT_C_LINK_STATE   0x0040
254 #define USB_SS_PORT_STAT_C_CONFIG_ERROR 0x0080
255
256 /* wHubCharacteristics (masks) */
257 #define HUB_CHAR_LPSM               0x0003
258 #define HUB_CHAR_COMPOUND           0x0004
259 #define HUB_CHAR_OCPM               0x0018
260
261 /*
262  * Hub Status & Hub Change bit masks
263  */
264 #define HUB_STATUS_LOCAL_POWER  0x0001
265 #define HUB_STATUS_OVERCURRENT  0x0002
266
267 #define HUB_CHANGE_LOCAL_POWER  0x0001
268 #define HUB_CHANGE_OVERCURRENT  0x0002
269
270 #endif /*_USB_DEFS_H_ */