1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
|
/* $OpenBSD: xhcireg.h,v 1.3 2014/08/08 14:28:02 mpi Exp $ */
/*-
* Copyright (c) 2014 Martin Pieuchot. All rights reserved.
* Copyright (c) 2010 Hans Petter Selasky. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#ifndef _XHCIREG_H_
#define _XHCIREG_H_
/* Default command execution time (implementation defined). */
#define XHCI_COMMAND_TIMEOUT 500 /* ms */
/* XHCI PCI config registers */
#define PCI_CBMEM 0x10 /* configuration base MEM */
#define PCI_INTERFACE_XHCI 0x30
#define PCI_USBREV 0x60 /* RO USB protocol revision */
#define PCI_USBREV_MASK 0xff
#define PCI_USBREV_3_0 0x30 /* USB 3.0 */
#define PCI_XHCI_FLADJ 0x61 /* RW frame length adjust */
#define PCI_XHCI_INTEL_XUSB2PR 0xd0 /* Intel USB2 Port Routing */
#define PCI_XHCI_INTEL_XUSB2PRM 0xd4 /* Intel USB2 Port Routing Mask */
#define PCI_XHCI_INTEL_USB3_PSSEN 0xd8 /* Intel USB3 Port SuperSpeed Enable */
#define PCI_XHCI_INTEL_USB3PRM 0xdc /* Intel USB3 Port Routing Mask */
/* XHCI capability registers */
#define XHCI_CAPLENGTH 0x00 /* RO Capability reg. length field */
#define XHCI_RESERVED 0x01 /* Reserved */
#define XHCI_HCIVERSION 0x02 /* RO Interface version number */
#define XHCI_HCIVERSION_0_9 0x0090 /* xHCI version 0.9 */
#define XHCI_HCIVERSION_1_0 0x0100 /* xHCI version 1.0 */
#define XHCI_HCSPARAMS1 0x04 /* RO structual parameters 1 */
#define XHCI_HCS1_DEVSLOT_MAX(x)((x) & 0xff)
#define XHCI_HCS1_IRQ_MAX(x) (((x) >> 8) & 0x3ff)
#define XHCI_HCS1_N_PORTS(x) (((x) >> 24) & 0xff)
#define XHCI_HCSPARAMS2 0x08 /* RO structual parameters 2 */
#define XHCI_HCS2_IST(x) ((x) & 0xF)
#define XHCI_HCS2_ERST_MAX(x) (((x) >> 4) & 0xf)
#define XHCI_HCS2_SPR(x) (((x) >> 24) & 0x1)
#define XHCI_HCS2_SPB_MAX(x) (((x) >> 27) & 0x7f)
#define XHCI_HCSPARAMS3 0x0c /* RO structual parameters 3 */
#define XHCI_HCS3_U1_DEL(x) ((x) & 0xff)
#define XHCI_HCS3_U2_DEL(x) (((x) >> 16) & 0xffff)
#define XHCI_HCCPARAMS 0x10 /* RO capability parameters */
#define XHCI_HCC_AC64(x) (((x) >> 0) & 0x1) /* 64-bit capable */
#define XHCI_HCC_BNC(x) (((x) >> 1) & 0x1) /* BW negotiation */
#define XHCI_HCC_CSZ(x) (((x) >> 2) & 0x1) /* Context size */
#define XHCI_HCC_PPC(x) (((x) >> 3) & 0x1) /* Port power control */
#define XHCI_HCC_PIND(x) (((x) >> 4) & 0x1) /* Port indicators */
#define XHCI_HCC_LHRC(x) (((x) >> 5) & 0x1) /* Light HC reset */
#define XHCI_HCC_LTC(x) (((x) >> 6) & 0x1) /* Latency tolerance msg */
#define XHCI_HCC_NSS(x) (((x) >> 7) & 0x1) /* No secondary sid */
#define XHCI_HCC_PAE(x) (((x) >> 8) & 0x1) /* Pase All Event Data */
#define XHCI_HCC_SPC(x) (((x) >> 9) & 0x1) /* Short packet */
#define XHCI_HCC_SEC(x) (((x) >> 10) & 0xf) /* Stopped EDTLA */
#define XHCI_HCC_CFC(x) (((x) >> 11) & 0xf) /* Configuous Frame ID */
#define XHCI_HCC_MAX_PSA_SZ(x) (((x) >> 12) & 0xf) /* Max pri. stream arr. */
#define XHCI_HCC_XECP(x) (((x) >> 16) & 0xffff) /* Ext. capabilities */
#define XHCI_DBOFF 0x14 /* RO doorbell offset */
#define XHCI_RTSOFF 0x18 /* RO runtime register space offset */
/*
* XHCI operational registers.
* Offset given by XHCI_CAPLENGTH register.
*/
#define XHCI_USBCMD 0x00 /* XHCI command */
#define XHCI_CMD_RS 0x00000001 /* RW Run/Stop */
#define XHCI_CMD_HCRST 0x00000002 /* RW Host Controller Reset */
#define XHCI_CMD_INTE 0x00000004 /* RW Interrupter Enable */
#define XHCI_CMD_HSEE 0x00000008 /* RW Host System Error Enable */
#define XHCI_CMD_LHCRST 0x00000080 /* RO/RW Light HC Reset */
#define XHCI_CMD_CSS 0x00000100 /* RW Controller Save State */
#define XHCI_CMD_CRS 0x00000200 /* RW Controller Restore State */
#define XHCI_CMD_EWE 0x00000400 /* RW Enable Wrap Event */
#define XHCI_CMD_EU3S 0x00000800 /* RW Enable U3 MFINDEX Stop */
#define XHCI_USBSTS 0x04 /* XHCI status */
#define XHCI_STS_HCH 0x00000001 /* RO - Host Controller Halted */
#define XHCI_STS_HSE 0x00000004 /* RW - Host System Error */
#define XHCI_STS_EINT 0x00000008 /* RW - Event Interrupt */
#define XHCI_STS_PCD 0x00000010 /* RW - Port Change Detect */
#define XHCI_STS_SSS 0x00000100 /* RO - Save State Status */
#define XHCI_STS_RSS 0x00000200 /* RO - Restore State Status */
#define XHCI_STS_SRE 0x00000400 /* RW - Save/Restore Error */
#define XHCI_STS_CNR 0x00000800 /* RO - Controller Not Ready */
#define XHCI_STS_HCE 0x00001000 /* RO - Host Controller Error */
#define XHCI_PAGESIZE 0x08 /* XHCI page size mask */
#define XHCI_PAGESIZE_4K 0x00000001 /* 4K Page Size */
#define XHCI_PAGESIZE_8K 0x00000002 /* 8K Page Size */
#define XHCI_PAGESIZE_16K 0x00000004 /* 16K Page Size */
#define XHCI_PAGESIZE_32K 0x00000008 /* 32K Page Size */
#define XHCI_PAGESIZE_64K 0x00000010 /* 64K Page Size */
#define XHCI_DNCTRL 0x14 /* XHCI device notification control */
#define XHCI_DNCTRL_MASK(n) (1 << (n))
#define XHCI_CRCR_LO 0x18 /* XHCI command ring control */
#define XHCI_CRCR_LO_RCS 0x00000001 /* RW - consumer cycle state */
#define XHCI_CRCR_LO_CS 0x00000002 /* RW - command stop */
#define XHCI_CRCR_LO_CA 0x00000004 /* RW - command abort */
#define XHCI_CRCR_LO_CRR 0x00000008 /* RW - command ring running */
#define XHCI_CRCR_LO_MASK 0x0000000F
#define XHCI_CRCR_HI 0x1C /* XHCI command ring control */
#define XHCI_DCBAAP_LO 0x30 /* XHCI dev context BA pointer */
#define XHCI_DCBAAP_HI 0x34 /* XHCI dev context BA pointer */
#define XHCI_CONFIG 0x38
#define XHCI_CONFIG_SLOTS_MASK 0x000000ff /* RW - nb of device slots enabled */
/*
* XHCI port status registers.
*/
#define XHCI_PORTSC(n) (0x3f0 + (0x10 * (n))) /* XHCI port status */
#define XHCI_PS_CCS 0x00000001 /* RO - current connect status */
#define XHCI_PS_PED 0x00000002 /* RW - port enabled / disabled */
#define XHCI_PS_OCA 0x00000008 /* RO - over current active */
#define XHCI_PS_PR 0x00000010 /* RW - port reset */
#define XHCI_PS_GET_PLS(x) (((x) >> 5) & 0xf) /* RW - port link state */
#define XHCI_PS_SET_PLS(x) (((x) & 0xf) << 5) /* RW - port link state */
#define XHCI_PS_PP 0x00000200 /* RW - port power */
#define XHCI_PS_SPEED(x) (((x) >> 10) & 0xf) /* RO - port speed */
#define XHCI_PS_GET_PIC(x) (((x) >> 14) & 0x3) /* RW - port indicator */
#define XHCI_PS_SET_PIC(x) (((x) & 0x3) << 14) /* RW - port indicator */
#define XHCI_PS_LWS 0x00010000 /* RW - link state write strobe */
#define XHCI_PS_CSC 0x00020000 /* RW - connect status change */
#define XHCI_PS_PEC 0x00040000 /* RW - port enable/disable change */
#define XHCI_PS_WRC 0x00080000 /* RW - warm port reset change */
#define XHCI_PS_OCC 0x00100000 /* RW - over-current change */
#define XHCI_PS_PRC 0x00200000 /* RW - port reset change */
#define XHCI_PS_PLC 0x00400000 /* RW - port link state change */
#define XHCI_PS_CEC 0x00800000 /* RW - config error change */
#define XHCI_PS_CAS 0x01000000 /* RO - cold attach status */
#define XHCI_PS_WCE 0x02000000 /* RW - wake on connect enable */
#define XHCI_PS_WDE 0x04000000 /* RW - wake on disconnect enable */
#define XHCI_PS_WOE 0x08000000 /* RW - wake on over-current enable*/
#define XHCI_PS_DR 0x40000000 /* RO - device removable */
#define XHCI_PS_WPR 0x80000000U /* RW - warm port reset */
#define XHCI_PS_CLEAR 0x80ff01ffu /* command bits */
#define XHCI_PORTPMSC(n) (0x3f4 + (0x10 * (n))) /* XHCI status & ctrl */
#define XHCI_PM3_U1TO(x) (((x) & 0xff) << 0) /* RW - U1 timeout */
#define XHCI_PM3_U2TO(x) (((x) & 0xff) << 8) /* RW - U2 timeout */
#define XHCI_PM3_FLA 0x00010000 /* RW - Force Link PM Accept */
#define XHCI_PM2_L1S(x) (((x) >> 0) & 0x7) /* RO - L1 status */
#define XHCI_PM2_RWE 0x00000008 /* RW - remote wakup enable */
#define XHCI_PM2_HIRD(x) (((x) & 0xf) << 4) /* RW - resume duration */
#define XHCI_PM2_L1SLOT(x) (((x) & 0xff) << 8) /* RW - L1 device slot */
#define XHCI_PM2_HLE 0x00010000 /* RW - hardware LPM enable */
#define XHCI_PORTLI(n) (0x3f8 + (0x10 * (n))) /* XHCI port link info */
#define XHCI_PORTRSV(n) (0x3fC + (0x10 * (n))) /* XHCI port reserved */
/*
* XHCI runtime registers.
* Offset given by XHCI_CAPLENGTH + XHCI_RTSOFF registers.
*/
#define XHCI_MFINDEX 0x0000 /* RO - microframe index */
#define XHCI_GET_MFINDEX(x) ((x) & 0x3fff)
#define XHCI_IMAN(n) (0x0020 + (0x20 * (n))) /* intr.management */
#define XHCI_IMAN_INTR_PEND 0x00000001 /* RW - interrupt pending */
#define XHCI_IMAN_INTR_ENA 0x00000002 /* RW - interrupt enable */
/* XHCI interrupt moderation */
#define XHCI_IMOD(n) (0x0024 + (0x20 * (n)))
#define XHCI_IMOD_IVAL_GET(x) (((x) >> 0) & 0xffff) /* 250ns unit */
#define XHCI_IMOD_IVAL_SET(x) (((x) & 0xffff) << 0) /* 250ns unit */
#define XHCI_IMOD_ICNT_GET(x) (((x) >> 16) & 0xffff) /* 250ns unit */
#define XHCI_IMOD_ICNT_SET(x) (((x) & 0xffff) << 16) /* 250ns unit */
#define XHCI_IMOD_DEFAULT 0x000001F4U /* 8000 IRQ/second */
#define XHCI_IMOD_DEFAULT_LP 0x000003E8U /* 4000 IRQ/second */
/* XHCI event ring segment table size */
#define XHCI_ERSTSZ(n) (0x0028 + (0x20 * (n)))
#define XHCI_ERSTS_SET(x) ((x) & 0xffff)
/* XHCI event ring segment table BA */
#define XHCI_ERSTBA_LO(n) (0x0030 + (0x20 * (n)))
#define XHCI_ERSTBA_HI(n) (0x0034 + (0x20 * (n)))
/* XHCI event ring dequeue pointer */
#define XHCI_ERDP_LO(n) (0x0038 + (0x20 * (n)))
#define XHCI_ERDP_LO_BUSY 0x00000008 /* RW - event handler busy */
#define XHCI_ERDP_HI(n) (0x003c + (0x20 * (n)))
/*
* XHCI doorbell registers.
* Offset given by XHCI_CAPLENGTH + XHCI_DBOFF registers.
*/
#define XHCI_DOORBELL(n) (0x0000 + (4 * (n)))
#define XHCI_DB_GET_SID(x) (((x) >> 16) & 0xffff) /* RW - stream ID */
#define XHCI_DB_SET_SID(x) (((x) & 0xffff) << 16) /* RW - stream ID */
/* XHCI legacy support */
#define XHCI_XECP_ID(x) ((x) & 0xff)
#define XHCI_XECP_NEXT(x) (((x) >> 8) & 0xff)
#define XHCI_XECP_BIOS_SEM 0x0002
#define XHCI_XECP_OS_SEM 0x0003
/* XHCI capability ID's */
#define XHCI_ID_USB_LEGACY 0x0001
#define XHCI_ID_PROTOCOLS 0x0002
#define XHCI_ID_POWER_MGMT 0x0003
#define XHCI_ID_VIRTUALIZATION 0x0004
#define XHCI_ID_MSG_IRQ 0x0005
#define XHCI_ID_USB_LOCAL_MEM 0x0006
struct xhci_erseg {
uint64_t er_addr;
uint32_t er_size;
uint32_t er_rsvd;
} __packed;
struct xhci_sctx {
uint32_t info_lo;
#define XHCI_SCTX_ROUTE(x) ((x) & 0xfffff)
#define XHCI_SCTX_SPEED(x) (((x) & 0xf) << 20)
#define XHCI_SCTX_MTT(x) (((x) & 0x1) << 25)
#define XHCI_SCTX_HUB(x) (((x) & 0x1) << 26)
#define XHCI_SCTX_DCI(x) (((x) & 0x1f) << 27)
uint32_t info_hi;
#define XHCI_SCTX_MAX_EL(x) ((x) & 0xffff)
#define XHCI_SCTX_RHPORT(x) (((x) & 0xff) << 16)
#define XHCI_SCTX_NPORTS(x) (((x) & 0xff) << 24)
uint32_t tt;
#define XHCI_SCTX_TT_HUB_SID(x) ((x) & 0xff)
#define XHCI_SCTX_SET_TT_PORT_NUM(x) (((x) & 0xff) << 8)
#define XHCI_SCTX_GET_TT_PORT_NUM(x) (((x) >> 8) & 0xff)
#define XHCI_SCTX_SET_TT_THINK_TIME(x) (((x) & 0x3) << 16)
#define XHCI_SCTX_GET_TT_THINK_TIME(x) (((x) >> 16) & 0x3)
#define XHCI_SCTX_SET_IRQ_TARGET(x) (((x) & 0x3ff) << 22)
#define XHCI_SCTX_GET_IRQ_TARGET(x) (((x) >> 22) & 0x3ff)
uint32_t state;
#define XHCI_SCTX_DEV_ADDR(x) ((x) & 0xff)
#define XHCI_SCTX_SLOT_STATE(x) (((x) >> 27) & 0x1f)
uint32_t rsvd[4];
} __packed;
struct xhci_epctx {
uint32_t info_lo;
#define XHCI_EPCTX_STATE(x) ((x) & 0x7)
#define XHCI_EP_DISABLED 0x0
#define XHCI_EP_RUNNING 0x1
#define XHCI_EP_HALTED 0x2
#define XHCI_EP_STOPPED 0x3
#define XHCI_EP_ERROR 0x4
#define XHCI_EPCTX_SET_MULT(x) (((x) & 0x3) << 8)
#define XHCI_EPCTX_GET_MULT(x) (((x) >> 8) & 0x3)
#define XHCI_EPCTX_SET_MAXP_STREAMS(x) (((x) & 0x1F) << 10)
#define XHCI_EPCTX_GET_MAXP_STREAMS(x) (((x) >> 10) & 0x1F)
#define XHCI_EPCTX_SET_LSA(x) (((x) & 0x1) << 15)
#define XHCI_EPCTX_GET_LSA(x) (((x) >> 15) & 0x1)
#define XHCI_EPCTX_SET_IVAL(x) (((x) & 0xff) << 16)
#define XHCI_EPCTX_GET_IVAL(x) (((x) >> 16) & 0xFF)
uint32_t info_hi;
#define XHCI_EPCTX_SET_CERR(x) (((x) & 0x3) << 1)
#define XHCI_EPCTX_SET_EPTYPE(x) (((x) & 0x7) << 3)
#define XHCI_EPCTX_GET_EPTYPE(x) (((x) >> 3) & 0x7)
#define XHCI_EPCTX_SET_HID(x) (((x) & 0x1) << 7)
#define XHCI_EPCTX_GET_HID(x) (((x) >> 7) & 0x1)
#define XHCI_EPCTX_SET_MAXB(x) (((x) & 0xff) << 8)
#define XHCI_EPCTX_GET_MAXB(x) (((x) >> 8) & 0xff)
#define XHCI_EPCTX_SET_MPS(x) (((x) & 0xffff) << 16)
#define XHCI_EPCTX_GET_MPS(x) (((x) >> 16) & 0xffff)
#define XHCI_SPEED_FULL 1
#define XHCI_SPEED_LOW 2
#define XHCI_SPEED_HIGH 3
#define XHCI_SPEED_SUPER 4
uint64_t deqp;
#define XHCI_EPCTX_DCS 0x1
uint32_t txinfo;
#define XHCI_EPCTX_AVG_TRB_LEN(x) ((x) & 0xffff)
#define XHCI_EPCTX_MAX_ESIT_PAYLOAD(x) (((x) & 0xffff) << 16)
uint32_t rsvd[3];
} __packed;
struct xhci_inctx {
uint32_t drop_flags;
uint32_t add_flags;
#define XHCI_INCTX_MASK_DCI(n) (0x1 << (n))
uint32_t rsvd[6];
} __packed;
struct xhci_trb {
uint64_t trb_paddr;
#define XHCI_TRB_PORTID(x) (((x) & (0xff << 24)) >> 24) /* Port ID */
uint32_t trb_status;
#define XHCI_TRB_GET_CODE(x) (((x) >> 24) & 0xff)
#define XHCI_TRB_TDREM(x) (((x) & 0x1f) << 17) /* TD remaining len. */
#define XHCI_TRB_REMAIN(x) ((x) & 0xffffff) /* Remaining length */
#define XHCI_TRB_LEN(x) ((x) & 0x1ffff) /* Transfer length */
#define XHCI_TRB_INTR(x) (((x) & 0x3ff) << 22) /* MSI-X intr. target */
uint32_t trb_flags;
#define XHCI_TRB_CYCLE (1 << 0) /* Enqueue point of xfer ring */
#define XHCI_TRB_ENT (1 << 1) /* Evaluate next TRB */
#define XHCI_TRB_LINKSEG XHCI_TRB_ENT /* Link to next segment */
#define XHCI_TRB_ISP (1 << 2) /* Interrupt on short packet */
#define XHCI_TRB_NOSNOOP (1 << 3) /* PCIe no snoop */
#define XHCI_TRB_CHAIN (1 << 4) /* Chained with next TRB */
#define XHCI_TRB_IOC (1 << 5) /* Interrupt On Completion */
#define XHCI_TRB_IDT (1 << 6) /* Immediate DaTa */
#define XHCI_TRB_BSR (1 << 9)
#define XHCI_TRB_DIR_IN (1 << 16)
#define XHCI_TRB_TRT_OUT (2 << 16)
#define XHCI_TRB_TRT_IN (3 << 16)
#define XHCI_TRB_GET_EP(x) (((x) >> 16) & 0x1f)
#define XHCI_TRB_SET_EP(x) (((x) & 0x1f) << 16)
#define XHCI_TRB_GET_SLOT(x) (((x) >> 24) & 0xff)
#define XHCI_TRB_SET_SLOT(x) (((x) & 0xff) << 24)
} __packed;
#define XHCI_TRB_TYPE_MASK 0xfc00
#define XHCI_TRB_TYPE(x) (((x) & XHCI_TRB_TYPE_MASK) >> 10)
/* Transfer Ring Types */
#define XHCI_TRB_TYPE_NORMAL (1 << 10)
#define XHCI_TRB_TYPE_SETUP (2 << 10) /* Setup stage (ctrl only) */
#define XHCI_TRB_TYPE_DATA (3 << 10) /* Data stage (ctrl only) */
#define XHCI_TRB_TYPE_STATUS (4 << 10) /* Status stage (ctrl only) */
#define XHCI_TRB_TYPE_ISOCH (5 << 10)
#define XHCI_TRB_TYPE_LINK (6 << 10) /* Link next seg. (all+cmd) */
#define XHCI_TRB_TYPE_EVENT (7 << 10) /* Generate event (all) */
#define XHCI_TRB_TYPE_NOOP (8 << 10) /* No-Op (all) */
/* Command ring Types */
#define XHCI_CMD_ENABLE_SLOT (9 << 10)
#define XHCI_CMD_DISABLE_SLOT (10 << 10)
#define XHCI_CMD_ADDRESS_DEVICE (11 << 10)
#define XHCI_CMD_CONFIG_EP (12 << 10)
#define XHCI_CMD_EVAL_CTX (13 << 10)
#define XHCI_CMD_RESET_EP (14 << 10)
#define XHCI_CMD_STOP_EP (15 << 10)
#define XHCI_CMD_SET_TR_DEQ (16 << 10)
#define XHCI_CMD_RESET_DEV (17 << 10)
#define XHCI_CMD_FEVENT (18 << 10)
#define XHCI_CMD_NEG_BW (19 << 10) /* Negociate bandwith */
#define XHCI_CMD_SET_LT (20 << 10) /* Set latency tolerance */
#define XHCI_CMD_GET_BW (21 << 10) /* Get port bandwith */
#define XHCI_CMD_FHEADER (22 << 10)
#define XHCI_CMD_NOOP (23 << 10) /* To test the command ring */
/* Event ring Types */
#define XHCI_EVT_XFER (32 << 10) /* Transfer event */
#define XHCI_EVT_CMD_COMPLETE (33 << 10)
#define XHCI_EVT_PORT_CHANGE (34 << 10) /* Port status change */
#define XHCI_EVT_BW_REQUEST (35 << 10)
#define XHCI_EVT_DOORBELL (36 << 10)
#define XHCI_EVT_HOST_CTRL (37 << 10)
#define XHCI_EVT_DEVICE_NOTIFY (38 << 10)
#define XHCI_EVT_MFINDEX_WRAP (39 << 10)
/* TRB Completion codes */
#define XHCI_CODE_INVALID 0 /* Producer didn't update the code. */
#define XHCI_CODE_SUCCESS 1 /* Badaboum, plaf, plouf, yeepee! */
#define XHCI_CODE_DATA_BUF 2 /* Overrun or underrun */
#define XHCI_CODE_BABBLE 3 /* Device is "babbling" */
#define XHCI_CODE_TXERR 4 /* USB Transaction error */
#define XHCI_CODE_TRB 5 /* Invalid TRB */
#define XHCI_CODE_STALL 6 /* Stall condition */
#define XHCI_CODE_RESOURCE 7 /* No resource available for the cmd */
#define XHCI_CODE_BANDWIDTH 8 /* Not enough bandwidth for the cmd */
#define XHCI_CODE_NO_SLOTS 9 /* MaxSlots limit reached */
#define XHCI_CODE_STREAM_TYPE 10 /* Stream Context Type value detected */
#define XHCI_CODE_SLOT_NOT_ON 11 /* Related device slot is disabled */
#define XHCI_CODE_ENDP_NOT_ON 12 /* Related enpoint is disabled */
#define XHCI_CODE_SHORT_XFER 13 /* Short packet */
#define XHCI_CODE_RING_UNDERRUN 14 /* Empty ring when transmitting isoc */
#define XHCI_CODE_RING_OVERRUN 15 /* Empty ring when receiving isoc */
#define XHCI_CODE_VF_RING_FULL 16 /* VF's event ring is full */
#define XHCI_CODE_PARAMETER 17 /* Context parameter is invalid */
#define XHCI_CODE_BW_OVERRUN 18 /* TD exceeds the bandwidth */
#define XHCI_CODE_CONTEXT_STATE 19 /* Transition from illegal ctx state */
#define XHCI_CODE_NO_PING_RESP 20 /* Unable to complete periodic xfer */
#define XHCI_CODE_EV_RING_FULL 21 /* Unable to post an evt to the ring */
#define XHCI_CODE_INCOMPAT_DEV 22 /* Device cannot be accessed */
#define XHCI_CODE_MISSED_SRV 23 /* Unable to service isoc EP in ESIT */
#define XHCI_CODE_CMD_RING_STOP 24 /* Command Stop (CS) requested */
#define XHCI_CODE_CMD_ABORTED 25 /* Command Abort (CA) operation */
#define XHCI_CODE_XFER_STOPPED 26 /* xfer terminated by a stop endpoint */
#define XHCI_CODE_XFER_INVLEN 27 /* TRB transfer length invalid */
#define XHCI_CODE_XFER_SHORTPKT 28 /* Stopped before reaching end of TD */
#define XHCI_CODE_MELAT 29 /* Max Exit Latency too large */
#define XHCI_CODE_RESERVED 30
#define XHCI_CODE_ISOC_OVERRUN 31 /* IN data buffer < Max ESIT Payload */
#define XHCI_CODE_EVENT_LOST 32 /* Internal overrun - impl. specific */
#define XHCI_CODE_UNDEFINED 33 /* Fatal error - impl. specific */
#define XHCI_CODE_INVALID_SID 34 /* Invalid stream ID received */
#define XHCI_CODE_SEC_BW 35 /* Cannot alloc secondary BW Domain */
#define XHCI_CODE_SPLIT_XACT 36 /* USB2 split transaction */
#endif /* _XHCIREG_H_ */
|