xref: /netbsd-src/sys/dev/usb/xhcireg.h (revision eceb233b9bd0dfebb902ed73b531ae6964fa3f9b)
1 /* $NetBSD: xhcireg.h,v 1.18 2020/06/06 08:56:30 skrll Exp $ */
2 
3 /*-
4  * Copyright (c) 2010 Hans Petter Selasky. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #ifndef _DEV_USB_XHCIREG_H_
29 #define	_DEV_USB_XHCIREG_H_
30 
31 /* XHCI PCI config registers */
32 #define	PCI_CBMEM		0x10	/* configuration base MEM */
33 #define	PCI_INTERFACE_XHCI	0x30
34 
35 #define	PCI_USBREV		0x60	/* RO USB protocol revision */
36 #define	 PCI_USBREV_MASK	0xFF
37 #define	 PCI_USBREV_3_0		0x30	/* USB 3.0 */
38 #define	 PCI_USBREV_3_1		0x31	/* USB 3.1 */
39 
40 #define	PCI_XHCI_FLADJ		0x61	/* RW frame length adjust */
41 
42 #define	PCI_XHCI_INTEL_XUSB2PR	0xd0    /* Intel USB2 Port Routing */
43 #define	PCI_XHCI_INTEL_USB2PRM	0xd4    /* Intel USB2 Port Routing Mask */
44 #define	PCI_XHCI_INTEL_USB3_PSSEN 0xd8  /* Intel USB3 Port SuperSpeed Enable */
45 #define	PCI_XHCI_INTEL_USB3PRM	0xdc    /* Intel USB3 Port Routing Mask */
46 
47 /* XHCI capability registers */
48 #define	XHCI_CAPLENGTH		0x00	/* RO capability - 1 byte */
49 #define	XHCI_HCIVERSION		0x02	/* RO version - 2 bytes */
50 #define	 XHCI_HCIVERSION_0_9	0x0090	/* xHCI version 0.9 */
51 #define	 XHCI_HCIVERSION_0_96	0x0096	/* xHCI version 0.96 */
52 #define	 XHCI_HCIVERSION_1_0	0x0100	/* xHCI version 1.0 */
53 #define	 XHCI_HCIVERSION_1_1	0x0110	/* xHCI version 1.1 */
54 #define	 XHCI_HCIVERSION_1_2	0x0120	/* xHCI version 1.2 */
55 
56 #define	XHCI_HCSPARAMS1		0x04	/* RO structual parameters 1 */
57 #define	 XHCI_HCS1_MAXSLOTS_MASK	__BITS(7, 0)
58 #define	 XHCI_HCS1_MAXSLOTS(x)		__SHIFTOUT((x), XHCI_HCS1_MAXSLOTS_MASK)
59 #define	 XHCI_HCS1_MAXINTRS_MASK	__BITS(18, 8)
60 #define	 XHCI_HCS1_MAXINTRS(x)		__SHIFTOUT((x), XHCI_HCS1_MAXINTRS_MASK)
61 #define	 XHCI_HCS1_MAXPORTS_MASK	__BITS(31, 24)
62 #define	 XHCI_HCS1_MAXPORTS(x)		__SHIFTOUT((x), XHCI_HCS1_MAXPORTS_MASK)
63 
64 #define	XHCI_HCSPARAMS2		0x08	/* RO structual parameters 2 */
65 #define	 XHCI_HCS2_IST_MASK	__BITS(3, 0)
66 #define	 XHCI_HCS2_IST(x)	__SHIFTOUT((x), XHCI_HCS2_IST_MASK)
67 #define	 XHCI_HCS2_ERSTMAX_MASK	__BITS(7, 4)
68 #define	 XHCI_HCS2_ERSTMAX(x)	__SHIFTOUT((x), XHCI_HCS2_ERSTMAX_MASK)
69 #define  XHCI_HCS2_SPBUFHI_MASK	__BITS(25, 21)
70 #define	 XHCI_HCS2_SPR_MASK	__BIT(26)
71 #define	 XHCI_HCS2_SPR(x)	__SHIFTOUT((x), XHCI_HCS2_SPR_MASK)
72 #define  XHCI_HCS2_SPBUFLO_MASK	__BITS(31, 27)
73 #define	 XHCI_HCS2_MAXSPBUF(x)	\
74     (__SHIFTOUT((x), XHCI_HCS2_SPBUFHI_MASK) << 5) | \
75     (__SHIFTOUT((x), XHCI_HCS2_SPBUFLO_MASK))
76 
77 #define	XHCI_HCSPARAMS3		0x0c	/* RO structual parameters 3 */
78 #define	 XHCI_HCS3_U1_DEL_MASK	__BITS(7, 0)
79 #define	 XHCI_HCS3_U1_DEL(x)	__SHIFTOUT((x), XHCI_HCS3_U1_DEL_MASK)
80 #define	 XHCI_HCS3_U2_DEL_MASK	__BITS(15, 8)
81 #define	 XHCI_HCS3_U2_DEL(x)	__SHIFTOUT((x), XHCI_HCS3_U2_DEL_MASK)
82 
83 #define	XHCI_HCCPARAMS		0x10	/* RO capability parameters */
84 #define	 XHCI_HCC_AC64(x)	__SHIFTOUT((x), __BIT(0))	/* 64-bit capable */
85 #define	 XHCI_HCC_BNC(x)	__SHIFTOUT((x), __BIT(1))	/* BW negotiation */
86 #define	 XHCI_HCC_CSZ(x)	__SHIFTOUT((x), __BIT(2))	/* context size */
87 #define	 XHCI_HCC_PPC(x)	__SHIFTOUT((x), __BIT(3))	/* port power control */
88 #define	 XHCI_HCC_PIND(x)	__SHIFTOUT((x), __BIT(4))	/* port indicators */
89 #define	 XHCI_HCC_LHRC(x)	__SHIFTOUT((x), __BIT(5))	/* light HC reset */
90 #define	 XHCI_HCC_LTC(x)	__SHIFTOUT((x), __BIT(6))	/* latency tolerance msg */
91 #define	 XHCI_HCC_NSS(x)	__SHIFTOUT((x), __BIT(7))	/* no secondary sid */
92 #define	 XHCI_HCC_PAE(x)	__SHIFTOUT((x), __BIT(8))	/* Parse All Event Data */
93 #define	 XHCI_HCC_SPC(x)	__SHIFTOUT((x), __BIT(9))	/* Short packet */
94 #define	 XHCI_HCC_SEC(x)	__SHIFTOUT((x), __BIT(10))	/* Stopped EDTLA */
95 #define	 XHCI_HCC_CFC(x)	__SHIFTOUT((x), __BIT(11))	/* Configuous Frame ID */
96 #define	 XHCI_HCC_MAXPSASIZE_MASK __BITS(15, 12)	/* max pri. stream array size */
97 #define	 XHCI_HCC_MAXPSASIZE(x)	__SHIFTOUT((x), XHCI_HCC_MAXPSASIZE_MASK)
98 #define	 XHCI_HCC_XECP_MASK	__BITS(31, 16)		/* extended capabilities pointer */
99 #define	 XHCI_HCC_XECP(x)	__SHIFTOUT((x), XHCI_HCC_XECP_MASK)
100 
101 #define	XHCI_DBOFF		0x14	/* RO doorbell offset */
102 #define	XHCI_RTSOFF		0x18	/* RO runtime register space offset */
103 #define XHCI_HCCPARAMS2		0x1c	/* RO capability parameters 2 */
104 #define	 XHCI_HCC2_U3C(x)	__SHIFTOUT((x), __BIT(0))	/* U3 Entry capable */
105 #define	 XHCI_HCC2_CMC(x)	__SHIFTOUT((x), __BIT(1))	/* CEC MaxExLatTooLg */
106 #define	 XHCI_HCC2_FSC(x)	__SHIFTOUT((x), __BIT(2))	/* Foce Save Context */
107 #define	 XHCI_HCC2_CTC(x)	__SHIFTOUT((x), __BIT(3))	/* Compliance Transc */
108 #define	 XHCI_HCC2_LEC(x)	__SHIFTOUT((x), __BIT(4))	/* Large ESIT Paylod */
109 #define	 XHCI_HCC2_CIC(x)	__SHIFTOUT((x), __BIT(5))	/* Configuration Inf */
110 #define	 XHCI_HCC2_ETC(x)	__SHIFTOUT((x), __BIT(6))	/* Extended TBC */
111 #define	 XHCI_HCC2_ETC_TSC(x)	__SHIFTOUT((x), __BIT(7))	/* ExtTBC TRB Status */
112 #define	 XHCI_HCC2_GSC(x)	__SHIFTOUT((x), __BIT(8))	/* Get/Set Extended Property */
113 #define	 XHCI_HCC2_VTC(x)	__SHIFTOUT((x), __BIT(9))	/* Virt. Based Trust */
114 
115 #define XHCI_VTIOSOFF		0x20	/* RO Virtualization Base Trusted IO Offset */
116 
117 /* XHCI operational registers.  Offset given by XHCI_CAPLENGTH register */
118 #define	XHCI_USBCMD		0x00	/* XHCI command */
119 #define	 XHCI_CMD_RS		__BIT(0)	/* RW Run/Stop */
120 #define	 XHCI_CMD_HCRST		__BIT(1)	/* RW Host Controller Reset */
121 #define	 XHCI_CMD_INTE		__BIT(2)	/* RW Interrupter Enable */
122 #define	 XHCI_CMD_HSEE		__BIT(3)	/* RW Host System Error Enable */
123 #define	 XHCI_CMD_LHCRST	__BIT(7)	/* RO/RW Light Host Controller Reset */
124 #define	 XHCI_CMD_CSS		__BIT(8)	/* RW Controller Save State */
125 #define	 XHCI_CMD_CRS		__BIT(9)	/* RW Controller Restore State */
126 #define	 XHCI_CMD_EWE		__BIT(10)	/* RW Enable Wrap Event */
127 #define	 XHCI_CMD_EU3S		__BIT(11)	/* RW Enable U3 MFINDEX Stop */
128 #define	 XHCI_CMD_CME		__BIT(13)	/* RW CEM Enable */
129 #define	 XHCI_CMD_ETE		__BIT(14)	/* RW Extended TBC Enable */
130 #define	 XHCI_CMD_TSC_EN	__BIT(15)	/* RW Extended TBC TRB Status Enable */
131 #define	 XHCI_CMD_VTIOE		__BIT(16)	/* RW VTIO Enable */
132 
133 #define	XHCI_WAIT_CNR		100		/* in 1ms */
134 #define	XHCI_WAIT_HCRST		100		/* in 1ms */
135 
136 #define	XHCI_USBSTS		0x04	/* XHCI status */
137 #define	 XHCI_STS_HCH		__BIT(0)	/* RO - Host Controller Halted */
138 #define	 XHCI_STS_RSVDZ0	__BIT(1)	/* RsvdZ - 1:1 */
139 #define	 XHCI_STS_HSE		__BIT(2)	/* RW - Host System Error */
140 #define	 XHCI_STS_EINT		__BIT(3)	/* RW - Event Interrupt */
141 #define	 XHCI_STS_PCD		__BIT(4)	/* RW - Port Change Detect */
142 #define	 XHCI_STS_RSVDZ1	__BITS(7, 5)	/* RsvdZ - 7:5 */
143 #define	 XHCI_STS_SSS		__BIT(8)	/* RO - Save State Status */
144 #define	 XHCI_STS_RSS		__BIT(9)	/* RO - Restore State Status */
145 #define	 XHCI_STS_SRE		__BIT(10)	/* RW - Save/Restore Error */
146 #define	 XHCI_STS_CNR		__BIT(11)	/* RO - Controller Not Ready */
147 #define	 XHCI_STS_HCE		__BIT(12)	/* RO - Host Controller Error */
148 #define	 XHCI_STS_RSVDP0	__BITS(13, 31)	/* RsvdP - 31:13 */
149 
150 #define	XHCI_PAGESIZE		0x08	/* XHCI page size mask */
151 #define	 XHCI_PAGESIZE_4K	__BIT(0)	/* 4K Page Size */
152 #define	 XHCI_PAGESIZE_8K	__BIT(1)	/* 8K Page Size */
153 #define	 XHCI_PAGESIZE_16K	__BIT(2)	/* 16K Page Size */
154 #define	 XHCI_PAGESIZE_32K	__BIT(3)	/* 32K Page Size */
155 #define	 XHCI_PAGESIZE_64K	__BIT(4)	/* 64K Page Size */
156 #define	 XHCI_PAGESIZE_128K	__BIT(5)	/* 128K Page Size */
157 #define	 XHCI_PAGESIZE_256K	__BIT(6)	/* 256K Page Size */
158 #define	 XHCI_PAGESIZE_512K	__BIT(7)	/* 512K Page Size */
159 #define	 XHCI_PAGESIZE_1M	__BIT(8)	/* 1M Page Size */
160 #define	 XHCI_PAGESIZE_2M	__BIT(9)	/* 2M Page Size */
161 /* ... extends to 128M */
162 
163 #define	XHCI_DNCTRL		0x14	/* XHCI device notification control */
164 #define	 XHCI_DNCTRL_MASK(n)	__BIT((n))
165 
166 /* 5.4.5 Command Ring Control Register */
167 #define	XHCI_CRCR		0x18	/* XHCI command ring control */
168 #define	 XHCI_CRCR_LO_RCS	__BIT(0)	/* RW - consumer cycle state */
169 #define	 XHCI_CRCR_LO_CS	__BIT(1)	/* RW - command stop */
170 #define	 XHCI_CRCR_LO_CA	__BIT(2)	/* RW - command abort */
171 #define	 XHCI_CRCR_LO_CRR	__BIT(3)	/* RW - command ring running */
172 #define	 XHCI_CRCR_LO_MASK	__BITS(31, 6)
173 
174 #define	XHCI_CRCR_HI		0x1c	/* XHCI command ring control */
175 
176 /* 5.4.6 Device Context Base Address Array Pointer Registers */
177 #define	XHCI_DCBAAP		0x30	/* XHCI dev context BA pointer */
178 #define	XHCI_DCBAAP_HI		0x34	/* XHCI dev context BA pointer */
179 
180 /* 5.4.7 Configure Register */
181 #define	XHCI_CONFIG		0x38
182 #define	 XHCI_CONFIG_SLOTS_MASK	__BITS(7, 0)	/* RW - number of device slots enabled */
183 #define	 XHCI_CONFIG_U3E	__BIT(8)	/* RW - U3 Entry Enable */
184 #define	 XHCI_CONFIG_CIE	__BIT(9)	/* RW - Configuration Information Enable */
185 
186 /* 5.4.8 XHCI port status registers */
187 #define	XHCI_PORTSC(n)		(0x3f0 + (0x10 * (n)))	/* XHCI port status */
188 #define	 XHCI_PS_CCS		__BIT(0)	/* RO - current connect status */
189 #define	 XHCI_PS_PED		__BIT(1)	/* RW - port enabled / disabled */
190 #define	 XHCI_PS_OCA		__BIT(3)	/* RO - over current active */
191 #define	 XHCI_PS_PR		__BIT(4)	/* RW - port reset */
192 #define	 XHCI_PS_PLS_MASK	__BITS(8, 5)	/* RW - port link state */
193 #define	 XHCI_PS_PLS_GET(x)	__SHIFTOUT((x), XHCI_PS_PLS_MASK)	/* RW - port link state */
194 #define	 XHCI_PS_PLS_SET(x)	__SHIFTIN((x), XHCI_PS_PLS_MASK)	/* RW - port link state */
195 
196 #define  XHCI_PS_PLS_SETU0	0
197 #define  XHCI_PS_PLS_SETU2	2
198 #define  XHCI_PS_PLS_SETU3	3
199 #define  XHCI_PS_PLS_SETDISC	5
200 #define  XHCI_PS_PLS_SETCOMP	10
201 #define  XHCI_PS_PLS_SETRESUME	15
202 
203 #define  XHCI_PS_PLS_U0		0
204 #define  XHCI_PS_PLS_U1		1
205 #define  XHCI_PS_PLS_U2		2
206 #define  XHCI_PS_PLS_U3		3
207 #define  XHCI_PS_PLS_DISABLED	4
208 #define  XHCI_PS_PLS_RXDETECT	5
209 #define  XHCI_PS_PLS_INACTIVE	6
210 #define  XHCI_PS_PLS_POLLING	7
211 #define  XHCI_PS_PLS_RECOVERY	8
212 #define  XHCI_PS_PLS_HOTRESET	9
213 #define  XHCI_PS_PLS_COMPLIANCE	10
214 #define  XHCI_PS_PLS_TEST	11
215 #define  XHCI_PS_PLS_RESUME	15
216 
217 #define	 XHCI_PS_PP		__BIT(9)	/* RW - port power */
218 #define	 XHCI_PS_SPEED_MASK	__BITS(13, 10)	/* RO - port speed */
219 #define	 XHCI_PS_SPEED_GET(x)	__SHIFTOUT((x), XHCI_PS_SPEED_MASK)
220 #define	 XHCI_PS_SPEED_FS	1
221 #define	 XHCI_PS_SPEED_LS	2
222 #define	 XHCI_PS_SPEED_HS	3
223 #define	 XHCI_PS_SPEED_SS	4
224 #define	 XHCI_PS_PIC_MASK	__BITS(15, 14)	/* RW - port indicator */
225 #define	 XHCI_PS_PIC_GET(x)	__SHIFTOUT((x), XHCI_PS_PIC_MASK)
226 #define	 XHCI_PS_PIC_SET(x)	__SHIFTIN((x), XHCI_PS_PIC_MASK)
227 #define	 XHCI_PS_LWS		__BIT(16)	/* RW - port link state write strobe */
228 #define	 XHCI_PS_CSC		__BIT(17)	/* RW - connect status change */
229 #define	 XHCI_PS_PEC		__BIT(18)	/* RW - port enable/disable change */
230 #define	 XHCI_PS_WRC		__BIT(19)	/* RW - warm port reset change */
231 #define	 XHCI_PS_OCC		__BIT(20)	/* RW - over-current change */
232 #define	 XHCI_PS_PRC		__BIT(21)	/* RW - port reset change */
233 #define	 XHCI_PS_PLC		__BIT(22)	/* RW - port link state change */
234 #define	 XHCI_PS_CEC		__BIT(23)	/* RW - config error change */
235 #define	 XHCI_PS_CAS		__BIT(24)	/* RO - cold attach status */
236 #define	 XHCI_PS_WCE		__BIT(25)	/* RW - wake on connect enable */
237 #define	 XHCI_PS_WDE		__BIT(26)	/* RW - wake on disconnect enable */
238 #define	 XHCI_PS_WOE		__BIT(27)	/* RW - wake on over-current enable */
239 #define	 XHCI_PS_DR		__BIT(30)	/* RO - device removable */
240 #define	 XHCI_PS_WPR		__BIT(31)	/* RW - warm port reset */
241 #define	 XHCI_PS_CLEAR		0x80FF01FFU	/* command bits */
242 
243 /* 5.4.9 Port PM Status and Control Register */
244 #define	XHCI_PORTPMSC(n)	(0x3f4 + (0x10 * (n)))	/* XHCI status and control */
245 /* 5.4.9.1 */
246 #define	 XHCI_PM3_U1TO_MASK	__BITS(7, 0)	/* RW - U1 timeout */
247 #define	 XHCI_PM3_U1TO_GET(x)	__SHIFTOUT((x), XHCI_PM3_U1TO_MASK)
248 #define	 XHCI_PM3_U1TO_SET(x)	__SHIFTIN((x), XHCI_PM3_U1TO_MASK)
249 #define	 XHCI_PM3_U2TO_MASK	__BITS(15, 8)	/* RW - U2 timeout */
250 #define	 XHCI_PM3_U2TO_GET(x)	__SHIFTOUT((x), XHCI_PM3_U2TO_MASK)
251 #define	 XHCI_PM3_U2TO_SET(x)	__SHIFTIN((x), XHCI_PM3_U2TO_MASK)
252 #define	 XHCI_PM3_FLA		__BIT(16)	/* RW - Force Link PM Accept */
253 
254 /* 5.4.9.2 */
255 #define	 XHCI_PM2_L1S_MASK	__BITS(2, 0)	/* RO - L1 status */
256 #define	 XHCI_PM2_L1S_GET(x)	__SHIFTOUT((x), XHCI_PM2_L1S_MASK)
257 #define	 XHCI_PM2_RWE		__BIT(3)	/* RW - remote wakup enable */
258 #define	 XHCI_PM2_BESL_MASK	__BITS(7, 4)	/* RW - Best Effort Service Latency */
259 #define	 XHCI_PM2_BESL_GET(x)	__SHIFTOUT((x), XHCI_PM2_BESL_MASK)
260 #define	 XHCI_PM2_BESL_SET(x)	__SHIFTIN((x), XHCI_PM2_BESL_MASK)
261 #define	 XHCI_PM2_L1SLOT_MASK	__BITS(15, 8)	/* RW - L1 device slot */
262 #define	 XHCI_PM2_L1SLOT_GET(x)	__SHIFTOUT((x), XHCI_PM2_L1SLOT_MASK)
263 #define	 XHCI_PM2_L1SLOT_SET(x)	__SHIFTIN((x), XHCI_PM2_L1SLOT_MASK)
264 #define	 XHCI_PM2_HLE		__BIT(16)	/* RW - hardware LPM enable */
265 #define	 XHCI_PM2_PTC_MASK	__BITS(31, 28)	/* RW - port test control */
266 #define	 XHCI_PM2_PTC_GET(x)	__SHIFTOUT((x), XHCI_PM2_PTC_MASK)
267 #define	 XHCI_PM2_PTC_SET(x)	__SHIFTOUT((x), XHCI_PM2_PTC_MASK)
268 
269 /* 5.4.10 Port Link Info Register */
270 #define	XHCI_PORTLI(n)		(0x3f8 + (0x10 * (n)))	/* XHCI port link info */
271 /* 5.4.10.1 */
272 #define	 XHCI_PLI3_ERR_MASK	__BITS(15, 0)	/* RW - port link errors */
273 #define	 XHCI_PLI3_ERR_GET(x)	__SHIFTOUT((x), XHCI_PLI3_ERR_MASK)
274 #define	 XHCI_PLI3_RLC_MASK	__BITS(19, 16)	/* RO - Rx Lane Count */
275 #define	 XHCI_PLI3_RLC_GET	__SHIFTOUT((x), XHCI_PLI3_RLC_MASK)
276 #define	 XHCI_PLI3_TLC_MASK	__BITS(23, 20)	/* RO - Tx Lane Count */
277 #define	 XHCI_PLI3_TLC_GET	__SHIFTOUT((x), XHCI_PLI3_TLC_MASK)
278 
279 /* 5.4.11 */
280 #define	XHCI_PORTHLPMC(n)	(0x3fc + (0x10 * (n)))	/* XHCI port hardware LPM control */
281 /* 5.4.11.1 */
282 #define	XHCI_PLMC3_LSEC_MASK	__BITS(15, 0)	/* RW - Link Soft Error Count */
283 #define	XHCI_PLMC3_LSEC_GET(x)	__SHIFTOUT((x), XHCI_PLMC3_LSEC_MASK)
284 
285 /* 5.5.1 */
286 /* XHCI runtime registers.  Offset given by XHCI_CAPLENGTH + XHCI_RTSOFF registers */
287 #define	XHCI_MFINDEX		0x0000
288 #define	 XHCI_MFINDEX_MASK	__BITS(13, 0)	/* RO - microframe index */
289 #define	 XHCI_MFINDEX_GET(x)	__SHIFTOUT((x), XHCI_MFINDEX_MASK)
290 
291 /* 5.5.2 Interrupter Register set */
292 /* 5.5.2.1 interrupt management */
293 #define	XHCI_IMAN(n)		(0x0020 + (0x20 * (n)))
294 #define	 XHCI_IMAN_INTR_PEND	__BIT(0)	/* RW - interrupt pending */
295 #define	 XHCI_IMAN_INTR_ENA	__BIT(1)	/* RW - interrupt enable */
296 
297 /* 5.5.2.2 Interrupter Moderation */
298 #define	XHCI_IMOD(n)		(0x0024 + (0x20 * (n)))	/* XHCI interrupt moderation */
299 #define	 XHCI_IMOD_IVAL_MASK	__BITS(15,0)	/* 250ns unit */
300 #define	 XHCI_IMOD_IVAL_GET(x)	__SHIFTOUT((x), XHCI_IMOD_IVAL_MASK)
301 #define	 XHCI_IMOD_IVAL_SET(x)	__SHIFTIN((x), XHCI_IMOD_IVAL_MASK)
302 #define	 XHCI_IMOD_ICNT_MASK	__BITS(31, 16)	/* 250ns unit */
303 #define	 XHCI_IMOD_ICNT_GET(x)	__SHIFTOUT((x), XHCI_IMOD_ICNT_MASK)
304 #define	 XHCI_IMOD_ICNT_SET(x)	__SHIFTIN((x), XHCI_IMOD_ICNT_MASK)
305 #define	 XHCI_IMOD_DEFAULT	0x000001F4U	/* 8000 IRQ/second */
306 #define	 XHCI_IMOD_DEFAULT_LP	0x000003E8U	/* 4000 IRQ/sec for LynxPoint */
307 
308 /* 5.5.2.3 Event Ring */
309 /* 5.5.2.3.1 Event Ring Segment Table Size */
310 #define	XHCI_ERSTSZ(n)		(0x0028 + (0x20 * (n)))
311 #define	 XHCI_ERSTS_MASK	__BITS(15, 0)	/* Event Ring Segment Table Size */
312 #define	 XHCI_ERSTS_GET(x)	__SHIFTOUT((x), XHCI_ERSTS_MASK)
313 #define	 XHCI_ERSTS_SET(x)	__SHIFTIN((x), XHCI_ERSTS_MASK)
314 
315 /* 5.5.2.3.2 Event Ring Segment Table Base Address Register */
316 #define	XHCI_ERSTBA(n)		(0x0030 + (0x20 * (n)))
317 #define	 XHCI_ERSTBA_MASK	__BIT(31,6)	/* RW - segment base address (low) */
318 #define	XHCI_ERSTBA_HI(n)	(0x0034 + (0x20 * (n)))
319 
320 /* 5.5.2.3.3 Event Ring Dequeue Pointer */
321 #define	XHCI_ERDP(n)		(0x0038 + (0x20 * (n)))
322 #define	 XHCI_ERDP_DESI_MASK	__BITS(2,0)	/* RO - dequeue segment index */
323 #define	 XHCI_ERDP_GET_DESI(x)	__SHIFTOUT(x), XHCI_ERDP_DESI_MASK)
324 #define	 XHCI_ERDP_BUSY		__BIT(3)	/* RW - event handler busy */
325 #define	 XHCI_ERDP_PTRLO_MASK	__BIT(31,4)	/* RW - dequeue pointer (low) */
326 #define	XHCI_ERDP_HI(n)		(0x003C + (0x20 * (n)))
327 
328 /* 5.6 XHCI doorbell registers. Offset given by XHCI_CAPLENGTH + XHCI_DBOFF registers */
329 #define	XHCI_DOORBELL(n)	(0x0000 + (4 * (n)))
330 #define	 XHCI_DB_TARGET_MASK	__BITS(7, 0)	/* RW - doorbell target */
331 #define	 XHCI_DB_TARGET_GET(x)	__SHIFTOUT((x), XHCI_DB_TARGET_MASK)
332 #define	 XHCI_DB_TARGET_SET(x)	__SHIFTIN((x), XHCI_DB_TARGET_MASK)
333 #define	 XHCI_DB_SID_MASK	__BITS(31, 16)	/* RW - doorbell stream ID */
334 #define	 XHCI_DB_SID_GET(x)	__SHIFTOUT((x), XHCI_DB_SID_MASK)
335 #define	 XHCI_DB_SID_SET(x)	__SHIFTIN((x), XHCI_DB_SID_MASK)
336 
337 /* 7 xHCI Extendeded capabilities */
338 #define	XHCI_XECP_ID_MASK	__BITS(7, 0)
339 #define	XHCI_XECP_ID(x)		__SHIFTOUT((x), XHCI_XECP_ID_MASK)
340 #define	XHCI_XECP_NEXT_MASK	__BITS(15, 8)
341 #define	XHCI_XECP_NEXT(x)	__SHIFTOUT((x), XHCI_XECP_NEXT_MASK)
342 
343 /* XHCI extended capability ID's */
344 #define	XHCI_ID_USB_LEGACY	0x0001	/* USB Legacy Support */
345 #define	 XHCI_XECP_USBLEGSUP	0x0000	/* Legacy Support Capability Reg */
346 #define	 XHCI_XECP_USBLEGCTLSTS	0x0004	/* Legacy Support Ctrl & Status Reg */
347 #define	XHCI_ID_PROTOCOLS	0x0002	/* Supported Protocol */
348 #define	XHCI_ID_POWER_MGMT	0x0003	/* Extended Power Management */
349 #define	XHCI_ID_VIRTUALIZATION	0x0004	/* I/O Virtualization */
350 #define	XHCI_ID_MSG_IRQ		0x0005	/* Message Interrupt */
351 #define	XHCI_ID_USB_LOCAL_MEM	0x0006	/* Local Memory */
352 #define	XHCI_ID_USB_DEBUG	0x000A	/* USB Debug Capability */
353 #define	XHCI_ID_XMSG_IRQ	0x0011	/* Extended Message Interrupt */
354 
355 /* 7.1 xHCI legacy support */
356 #define	XHCI_XECP_BIOS_SEM	0x0002
357 #define	XHCI_XECP_OS_SEM	0x0003
358 
359 /* 7.2 xHCI Supported Protocol Capability */
360 #define	XHCI_XECP_USBID 	0x20425355
361 
362 #define	XHCI_XECP_SP_W0_MINOR_MASK	__BITS(23, 16)
363 #define	XHCI_XECP_SP_W0_MINOR(x)	__SHIFTOUT((x), XHCI_XECP_SP_W0_MINOR_MASK)
364 #define	XHCI_XECP_SP_W0_MAJOR_MASK	__BITS(31, 24)
365 #define	XHCI_XECP_SP_W0_MAJOR(x)	__SHIFTOUT((x), XHCI_XECP_SP_W0_MAJOR_MASK)
366 
367 #define	XHCI_XECP_SP_W8_CPO_MASK	__BITS(7, 0)
368 #define	XHCI_XECP_SP_W8_CPO(x)		__SHIFTOUT((x), XHCI_XECP_SP_W8_CPO_MASK)
369 #define	XHCI_XECP_SP_W8_CPC_MASK	__BITS(15, 8)
370 #define	XHCI_XECP_SP_W8_CPC(x)		__SHIFTOUT((x), XHCI_XECP_SP_W8_CPC_MASK)
371 #define	XHCI_XECP_SP_W8_PD_MASK		__BITS(27, 16)
372 #define	XHCI_XECP_SP_W8_PD(x)		__SHIFTOUT((x), XHCI_XECP_SP_W8_PD_MASK)
373 #define	XHCI_XECP_SP_W8_PSIC_MASK	__BITS(31, 28)
374 #define	XHCI_XECP_SP_W8_PSIC(x)		__SHIFTOUT((x), XHCI_XECP_SP_W8_PSIC_MASK)
375 
376 #define XHCI_PAGE_SIZE(sc) ((sc)->sc_pgsz)
377 
378 /* Chapter 6, Table 49 */
379 #define XHCI_DEVICE_CONTEXT_BASE_ADDRESS_ARRAY_ALIGN	64
380 #define XHCI_DEVICE_CONTEXT_ALIGN			64
381 #define XHCI_INPUT_CONTROL_CONTEXT_ALIGN		64
382 #define XHCI_SLOT_CONTEXT_ALIGN				32
383 #define XHCI_ENDPOINT_CONTEXT_ALIGN			32
384 #define XHCI_STREAM_CONTEXT_ALIGN			16
385 #define XHCI_STREAM_ARRAY_ALIGN				16
386 #define XHCI_TRANSFER_RING_SEGMENTS_ALIGN		16
387 #define XHCI_COMMAND_RING_SEGMENTS_ALIGN		64
388 #define XHCI_EVENT_RING_SEGMENTS_ALIGN			64
389 #define XHCI_EVENT_RING_SEGMENT_TABLE_ALIGN		64
390 #define XHCI_SCRATCHPAD_BUFFER_ARRAY_ALIGN		64
391 #define XHCI_SCRATCHPAD_BUFFERS_ALIGN			XHCI_PAGE_SIZE
392 
393 #define XHCI_ERSTE_ALIGN				16
394 #define XHCI_TRB_ALIGN					16
395 
396 struct xhci_trb {
397 	uint64_t trb_0;
398 	uint32_t trb_2;
399 #define XHCI_TRB_2_ERROR_MASK		__BITS(31, 24)
400 #define XHCI_TRB_2_ERROR_GET(x)		__SHIFTOUT((x), XHCI_TRB_2_ERROR_MASK)
401 #define XHCI_TRB_2_ERROR_SET(x)		__SHIFTIN((x), XHCI_TRB_2_ERROR_MASK)
402 
403 #define XHCI_TRB_2_TDSZ_MASK		__BITS(21, 17)	/* TD Size */
404 #define XHCI_TRB_2_TDSZ_GET(x)		__SHIFTOUT((x), XHCI_TRB_2_TDSZ_MASK)
405 #define XHCI_TRB_2_TDSZ_SET(x)		__SHIFTIN((x), XHCI_TRB_2_TDSZ_MASK)
406 #define XHCI_TRB_2_REM_MASK		__BITS(23, 0)
407 #define XHCI_TRB_2_REM_GET(x)		__SHIFTOUT((x), XHCI_TRB_2_REM_MASK)
408 #define XHCI_TRB_2_REM_SET(x)		__SHIFTIN((x), XHCI_TRB_2_REM_MASK)
409 
410 #define XHCI_TRB_2_BYTES_MASK		__BITS(16, 0)
411 #define XHCI_TRB_2_BYTES_GET(x)		__SHIFTOUT((x), XHCI_TRB_2_BYTES_MASK)
412 #define XHCI_TRB_2_BYTES_SET(x)		__SHIFTIN((x), XHCI_TRB_2_BYTES_MASK)
413 #define XHCI_TRB_2_IRQ_MASK		__BITS(31, 22)
414 #define XHCI_TRB_2_IRQ_GET(x)		__SHIFTOUT((x), XHCI_TRB_2_IRQ_MASK)
415 #define XHCI_TRB_2_IRQ_SET(x)		__SHIFTIN((x), XHCI_TRB_2_IRQ_MASK)
416 #define XHCI_TRB_2_STREAM_MASK		__BITS(31, 16)
417 #define XHCI_TRB_2_STREAM_GET(x)	__SHIFTOUT((x), XHCI_TRB_2_STREAM_MASK)
418 #define XHCI_TRB_2_STREAM_SET(x)	__SHIFTIN((x), XHCI_TRB_2_STREAM_MASK)
419 	uint32_t trb_3;
420 #define XHCI_TRB_3_TYPE_MASK		__BITS(15, 10)
421 #define XHCI_TRB_3_TYPE_GET(x)		__SHIFTOUT((x), XHCI_TRB_3_TYPE_MASK)
422 #define XHCI_TRB_3_TYPE_SET(x)		__SHIFTIN((x), XHCI_TRB_3_TYPE_MASK)
423 #define XHCI_TRB_3_CYCLE_BIT		__BIT(0)
424 #define XHCI_TRB_3_TC_BIT		__BIT(1)       /* command ring only */
425 #define XHCI_TRB_3_ENT_BIT		__BIT(1)       /* transfer ring only */
426 #define XHCI_TRB_3_ISP_BIT		__BIT(2)
427 #define XHCI_TRB_3_NSNOOP_BIT		__BIT(3)
428 #define XHCI_TRB_3_CHAIN_BIT		__BIT(4)
429 #define XHCI_TRB_3_IOC_BIT		__BIT(5)
430 #define XHCI_TRB_3_IDT_BIT		__BIT(6)
431 #define XHCI_TRB_3_TBC_MASK		__BITS(8, 7)
432 #define XHCI_TRB_3_TBC_GET(x)		__SHIFTOUT((x), XHCI_TRB_3_TBC_MASK)
433 #define XHCI_TRB_3_TBC_SET(x)		__SHIFTIN((x), XHCI_TRB_3_TBC_MASK)
434 #define XHCI_TRB_3_BEI_BIT		__BIT(9)
435 #define XHCI_TRB_3_DCEP_BIT		__BIT(9)
436 #define XHCI_TRB_3_PRSV_BIT		__BIT(9)
437 #define XHCI_TRB_3_BSR_BIT		__BIT(9)
438 
439 #define XHCI_TRB_3_TRT_MASK		__BITS(17, 16)
440 #define XHCI_TRB_3_TRT_NONE		__SHIFTIN(0U, XHCI_TRB_3_TRT_MASK)
441 #define XHCI_TRB_3_TRT_OUT		__SHIFTIN(2U, XHCI_TRB_3_TRT_MASK)
442 #define XHCI_TRB_3_TRT_IN		__SHIFTIN(3U, XHCI_TRB_3_TRT_MASK)
443 #define XHCI_TRB_3_DIR_IN		__BIT(16)
444 #define XHCI_TRB_3_TLBPC_MASK		__BITS(19, 16)
445 #define XHCI_TRB_3_TLBPC_GET(x)		__SHIFTOUT((x), XHCI_TRB_3_TLBPC_MASK)
446 #define XHCI_TRB_3_TLBPC_SET(x)		__SHIFTIN((x), XHCI_TRB_3_TLBPC_MASK)
447 #define XHCI_TRB_3_EP_MASK		__BITS(20, 16)
448 #define XHCI_TRB_3_EP_GET(x)		__SHIFTOUT((x), XHCI_TRB_3_EP_MASK)
449 #define XHCI_TRB_3_EP_SET(x)		__SHIFTIN((x), XHCI_TRB_3_EP_MASK)
450 #define XHCI_TRB_3_FRID_MASK		__BITS(30, 20)
451 #define XHCI_TRB_3_FRID_GET(x)		__SHIFTOUT((x), XHCI_TRB_3_FRID_MASK)
452 #define XHCI_TRB_3_FRID_SET(x)		__SHIFTIN((x), XHCI_TRB_3_FRID_MASK)
453 #define XHCI_TRB_3_ISO_SIA_BIT		__BIT(31)
454 #define XHCI_TRB_3_SUSP_EP_BIT		__BIT(23)
455 #define XHCI_TRB_3_VFID_MASK		__BITS(23, 16)
456 #define XHCI_TRB_3_VFID_GET(x)		__SHIFTOUT((x), XHCI_TRB_3_VFID_MASK)
457 #define XHCI_TRB_3_VFID_SET(x)		__SHIFTIN((x), XHCI_TRB_3_VFID_MASK)
458 #define XHCI_TRB_3_SLOT_MASK		__BITS(31, 24)
459 #define XHCI_TRB_3_SLOT_GET(x)		__SHIFTOUT((x), XHCI_TRB_3_SLOT_MASK)
460 #define XHCI_TRB_3_SLOT_SET(x)		__SHIFTIN((x), XHCI_TRB_3_SLOT_MASK)
461 
462 	/* Commands */
463 #define XHCI_TRB_TYPE_RESERVED          0x00
464 #define XHCI_TRB_TYPE_NORMAL            0x01
465 #define XHCI_TRB_TYPE_SETUP_STAGE       0x02
466 #define XHCI_TRB_TYPE_DATA_STAGE        0x03
467 #define XHCI_TRB_TYPE_STATUS_STAGE      0x04
468 #define XHCI_TRB_TYPE_ISOCH             0x05
469 #define XHCI_TRB_TYPE_LINK              0x06
470 #define XHCI_TRB_TYPE_EVENT_DATA        0x07
471 #define XHCI_TRB_TYPE_NOOP              0x08
472 #define XHCI_TRB_TYPE_ENABLE_SLOT       0x09
473 #define XHCI_TRB_TYPE_DISABLE_SLOT      0x0A
474 #define XHCI_TRB_TYPE_ADDRESS_DEVICE    0x0B
475 #define XHCI_TRB_TYPE_CONFIGURE_EP      0x0C
476 #define XHCI_TRB_TYPE_EVALUATE_CTX      0x0D
477 #define XHCI_TRB_TYPE_RESET_EP          0x0E
478 #define XHCI_TRB_TYPE_STOP_EP           0x0F
479 #define XHCI_TRB_TYPE_SET_TR_DEQUEUE    0x10
480 #define XHCI_TRB_TYPE_RESET_DEVICE      0x11
481 #define XHCI_TRB_TYPE_FORCE_EVENT       0x12
482 #define XHCI_TRB_TYPE_NEGOTIATE_BW      0x13
483 #define XHCI_TRB_TYPE_SET_LATENCY_TOL   0x14
484 #define XHCI_TRB_TYPE_GET_PORT_BW       0x15
485 #define XHCI_TRB_TYPE_FORCE_HEADER      0x16
486 #define XHCI_TRB_TYPE_NOOP_CMD          0x17
487 
488 	/* Events */
489 #define XHCI_TRB_EVENT_TRANSFER         0x20
490 #define XHCI_TRB_EVENT_CMD_COMPLETE     0x21
491 #define XHCI_TRB_EVENT_PORT_STS_CHANGE  0x22
492 #define XHCI_TRB_EVENT_BW_REQUEST       0x23
493 #define XHCI_TRB_EVENT_DOORBELL         0x24
494 #define XHCI_TRB_EVENT_HOST_CTRL        0x25
495 #define XHCI_TRB_EVENT_DEVICE_NOTIFY    0x26
496 #define XHCI_TRB_EVENT_MFINDEX_WRAP     0x27
497 
498 	/* Error codes */
499 #define XHCI_TRB_ERROR_INVALID          0x00
500 #define XHCI_TRB_ERROR_SUCCESS          0x01
501 #define XHCI_TRB_ERROR_DATA_BUF         0x02
502 #define XHCI_TRB_ERROR_BABBLE           0x03
503 #define XHCI_TRB_ERROR_XACT             0x04
504 #define XHCI_TRB_ERROR_TRB              0x05
505 #define XHCI_TRB_ERROR_STALL            0x06
506 #define XHCI_TRB_ERROR_RESOURCE         0x07
507 #define XHCI_TRB_ERROR_BANDWIDTH        0x08
508 #define XHCI_TRB_ERROR_NO_SLOTS         0x09
509 #define XHCI_TRB_ERROR_STREAM_TYPE      0x0A
510 #define XHCI_TRB_ERROR_SLOT_NOT_ON      0x0B
511 #define XHCI_TRB_ERROR_ENDP_NOT_ON      0x0C
512 #define XHCI_TRB_ERROR_SHORT_PKT        0x0D
513 #define XHCI_TRB_ERROR_RING_UNDERRUN    0x0E
514 #define XHCI_TRB_ERROR_RING_OVERRUN     0x0F
515 #define XHCI_TRB_ERROR_VF_RING_FULL     0x10
516 #define XHCI_TRB_ERROR_PARAMETER        0x11
517 #define XHCI_TRB_ERROR_BW_OVERRUN       0x12
518 #define XHCI_TRB_ERROR_CONTEXT_STATE    0x13
519 #define XHCI_TRB_ERROR_NO_PING_RESP     0x14
520 #define XHCI_TRB_ERROR_EV_RING_FULL     0x15
521 #define XHCI_TRB_ERROR_INCOMPAT_DEV     0x16
522 #define XHCI_TRB_ERROR_MISSED_SERVICE   0x17
523 #define XHCI_TRB_ERROR_CMD_RING_STOP    0x18
524 #define XHCI_TRB_ERROR_CMD_ABORTED      0x19
525 #define XHCI_TRB_ERROR_STOPPED          0x1A
526 #define XHCI_TRB_ERROR_LENGTH           0x1B
527 #define XHCI_TRB_ERROR_STOPPED_SHORT    0x1C
528 #define XHCI_TRB_ERROR_BAD_MELAT        0x1D
529 #define XHCI_TRB_ERROR_ISOC_OVERRUN     0x1F
530 #define XHCI_TRB_ERROR_EVENT_LOST       0x20
531 #define XHCI_TRB_ERROR_UNDEFINED        0x21
532 #define XHCI_TRB_ERROR_INVALID_SID      0x22
533 #define XHCI_TRB_ERROR_SEC_BW           0x23
534 #define XHCI_TRB_ERROR_SPLIT_XACT       0x24
535 } __packed __aligned(XHCI_TRB_ALIGN);
536 #define XHCI_TRB_SIZE sizeof(struct xhci_trb)
537 
538 /*
539  * 6.2.2 Slot context
540  */
541 #define XHCI_SCTX_0_ROUTE_MASK			__BITS(19, 0)
542 #define XHCI_SCTX_0_ROUTE_GET(x)		__SHIFTOUT((x), XHCI_SCTX_0_ROUTE_MASK)
543 #define XHCI_SCTX_0_ROUTE_SET(x)		__SHIFTIN((x), XHCI_SCTX_0_ROUTE_MASK)
544 #define XHCI_SCTX_0_SPEED_MASK			__BITS(23, 20)
545 #define XHCI_SCTX_0_SPEED_GET(x)		__SHIFTOUT((x), XHCI_SCTX_0_SPEED_MASK)
546 #define XHCI_SCTX_0_SPEED_SET(x)		__SHIFTIN((x), XHCI_SCTX_0_SPEED_MASK)
547 #define XHCI_SCTX_0_MTT_MASK			__BIT(25)
548 #define XHCI_SCTX_0_MTT_SET(x)			__SHIFTIN((x), XHCI_SCTX_0_MTT_MASK)
549 #define XHCI_SCTX_0_MTT_GET(x)                  __SHIFTOUT((x), XHCI_SCTX_0_MTT_MASK)
550 #define XHCI_SCTX_0_HUB_MASK			__BIT(26)
551 #define XHCI_SCTX_0_HUB_SET(x)			__SHIFTIN((x), XHCI_SCTX_0_HUB_MASK)
552 #define XHCI_SCTX_0_HUB_GET(x)			__SHIFTOUT((x), XHCI_SCTX_0_HUB_MASK)
553 #define XHCI_SCTX_0_CTX_NUM_MASK		__BITS(31, 27)
554 #define XHCI_SCTX_0_CTX_NUM_SET(x)		__SHIFTIN((x), XHCI_SCTX_0_CTX_NUM_MASK)
555 #define XHCI_SCTX_0_CTX_NUM_GET(x)		__SHIFTOUT((x), XHCI_SCTX_0_CTX_NUM_MASK)
556 
557 #define XHCI_SCTX_1_MAX_EL_MASK			__BITS(15, 0)
558 #define XHCI_SCTX_1_MAX_EL_SET(x)		__SHIFTIN((x), XHCI_SCTX_1_MAX_EL_MASK)
559 #define XHCI_SCTX_1_MAX_EL_GET(x)		__SHIFTOUT((x), XHCI_SCTX_1_MAX_EL_MASK)
560 #define XHCI_SCTX_1_RH_PORT_MASK		__BITS(23, 16)
561 #define XHCI_SCTX_1_RH_PORT_SET(x)		__SHIFTIN((x), XHCI_SCTX_1_RH_PORT_MASK)
562 #define XHCI_SCTX_1_RH_PORT_GET(x)		__SHIFTOUT((x), XHCI_SCTX_1_RH_PORT_MASK)
563 #define XHCI_SCTX_1_NUM_PORTS_MASK		__BITS(31, 24)
564 #define XHCI_SCTX_1_NUM_PORTS_SET(x)		__SHIFTIN((x), XHCI_SCTX_1_NUM_PORTS_MASK)
565 #define XHCI_SCTX_1_NUM_PORTS_GET(x)		__SHIFTOUT((x), XHCI_SCTX_1_NUM_PORTS_MASK)
566 
567 #define XHCI_SCTX_2_TT_HUB_SID_MASK		__BITS(7, 0)
568 #define XHCI_SCTX_2_TT_HUB_SID_SET(x)		__SHIFTIN((x), XHCI_SCTX_2_TT_HUB_SID_MASK)
569 #define XHCI_SCTX_2_TT_HUB_SID_GET(x)		__SHIFTOUT((x), XHCI_SCTX_2_TT_HUB_SID_MASK)
570 #define XHCI_SCTX_2_TT_PORT_NUM_MASK		__BITS(15, 8)
571 #define XHCI_SCTX_2_TT_PORT_NUM_SET(x)		__SHIFTIN((x), XHCI_SCTX_2_TT_PORT_NUM_MASK)
572 #define XHCI_SCTX_2_TT_PORT_NUM_GET(x)		__SHIFTOUT((x), XHCI_SCTX_2_TT_PORT_NUM_MASK)
573 #define XHCI_SCTX_2_TT_THINK_TIME_MASK		__BITS(17, 16)
574 #define XHCI_SCTX_2_TT_THINK_TIME_SET(x)	__SHIFTIN((x), XHCI_SCTX_2_TT_THINK_TIME_MASK)
575 #define XHCI_SCTX_2_TT_THINK_TIME_GET(x)	__SHIFTOUT((x), XHCI_SCTX_2_TT_THINK_TIME_MASK)
576 #define XHCI_SCTX_2_IRQ_TARGET_MASK		__BITS(31, 22)
577 #define XHCI_SCTX_2_IRQ_TARGET_SET(x)		__SHIFTIN((x), XHCI_SCTX_2_IRQ_TARGET_MASK)
578 #define XHCI_SCTX_2_IRQ_TARGET_GET(x)		__SHIFTOUT((x), XHCI_SCTX_2_IRQ_TARGET_MASK)
579 
580 #define XHCI_SCTX_3_DEV_ADDR_MASK		__BITS(7, 0)
581 #define XHCI_SCTX_3_DEV_ADDR_SET(x)		__SHIFTIN((x), XHCI_SCTX_3_DEV_ADDR_MASK)
582 #define XHCI_SCTX_3_DEV_ADDR_GET(x)		__SHIFTOUT((x), XHCI_SCTX_3_DEV_ADDR_MASK)
583 #define XHCI_SCTX_3_SLOT_STATE_MASK		__BITS(31, 27)
584 #define XHCI_SCTX_3_SLOT_STATE_SET(x)		__SHIFTIN((x), XHCI_SCTX_3_SLOT_STATE_MASK)
585 #define XHCI_SCTX_3_SLOT_STATE_GET(x)		__SHIFTOUT((x), XHCI_SCTX_3_SLOT_STATE_MASK)
586 #define XHCI_SLOTSTATE_DISABLED			0 /* disabled or enabled */
587 #define XHCI_SLOTSTATE_ENABLED			0
588 #define XHCI_SLOTSTATE_DEFAULT			1
589 #define XHCI_SLOTSTATE_ADDRESSED		2
590 #define XHCI_SLOTSTATE_CONFIGURED		3
591 
592 /*
593  * 6.2.3 Endpoint Context
594  * */
595 #define XHCI_EPCTX_0_EPSTATE_MASK		__BITS(2, 0)
596 #define XHCI_EPCTX_0_EPSTATE_SET(x)		__SHIFTIN((x), XHCI_EPCTX_0_EPSTATE_MASK)
597 #define XHCI_EPCTX_0_EPSTATE_GET(x)		__SHIFTOUT((x), XHCI_EPCTX_0_EPSTATE_MASK)
598 #define XHCI_EPSTATE_DISABLED			0
599 #define XHCI_EPSTATE_RUNNING			1
600 #define XHCI_EPSTATE_HALTED			2
601 #define XHCI_EPSTATE_STOPPED			3
602 #define XHCI_EPSTATE_ERROR			4
603 #define XHCI_EPCTX_0_MULT_MASK			__BITS(9, 8)
604 #define XHCI_EPCTX_0_MULT_SET(x)		__SHIFTIN((x), XHCI_EPCTX_0_MULT_MASK)
605 #define XHCI_EPCTX_0_MULT_GET(x)		__SHIFTOUT((x), XHCI_EPCTX_0_MULT_MASK)
606 #define XHCI_EPCTX_0_MAXP_STREAMS_MASK		__BITS(14, 10)
607 #define XHCI_EPCTX_0_MAXP_STREAMS_SET(x)	__SHIFTIN((x), XHCI_EPCTX_0_MAXP_STREAMS_MASK)
608 #define XHCI_EPCTX_0_MAXP_STREAMS_GET(x)	__SHIFTOUT((x), XHCI_EPCTX_0_MAXP_STREAMS_MASK)
609 #define XHCI_EPCTX_0_LSA_MASK			__BIT(15)
610 #define XHCI_EPCTX_0_LSA_SET(x)			__SHIFTIN((x), XHCI_EPCTX_0_LSA_MASK)
611 #define XHCI_EPCTX_0_LSA_GET(x)			__SHIFTOUT((x), XHCI_EPCTX_0_LSA_MASK)
612 #define XHCI_EPCTX_0_IVAL_MASK			__BITS(23, 16)
613 #define XHCI_EPCTX_0_IVAL_SET(x)                __SHIFTIN((x), XHCI_EPCTX_0_IVAL_MASK)
614 #define XHCI_EPCTX_0_IVAL_GET(x)                __SHIFTOUT((x), XHCI_EPCTX_0_IVAL_MASK)
615 #define XHCI_EPCTX_0_MAX_ESIT_PAYLOAD_HI_MASK	__BITS(31, 24)
616 #define XHCI_EPCTX_0_MAX_ESIT_PAYLOAD_HI_SET(x) __SHIFTIN((x), XHCI_EPCTX_0_MAX_ESIT_PAYLOAD_HI_MASK)
617 #define XHCI_EPCTX_0_MAX_ESIT_PAYLOAD_HI_GET(x) __SHIFTOUT((x), XHCI_EPCTX_0_MAX_ESIT_PAYLOAD_HI_MASK)
618 
619 #define XHCI_EPCTX_1_CERR_MASK			__BITS(2, 1)
620 #define XHCI_EPCTX_1_CERR_SET(x)		__SHIFTIN((x), XHCI_EPCTX_1_CERR_MASK)
621 #define XHCI_EPCTX_1_CERR_GET(x)		__SHIFTOUT((x), XHCI_EPCTX_1_CERR_MASK)
622 #define XHCI_EPCTX_1_EPTYPE_MASK		__BITS(5, 3)
623 #define XHCI_EPCTX_1_EPTYPE_SET(x)		__SHIFTIN((x), XHCI_EPCTX_1_EPTYPE_MASK)
624 #define XHCI_EPCTX_1_EPTYPE_GET(x)		__SHIFTOUT((x), XHCI_EPCTX_1_EPTYPE_MASK)
625 #define XHCI_EPCTX_1_HID_MASK			__BIT(7)
626 #define XHCI_EPCTX_1_HID_SET(x)			__SHIFTIN((x), XHCI_EPCTX_1_HID_MASK)
627 #define XHCI_EPCTX_1_HID_GET(x)			__SHIFTOUT((x), XHCI_EPCTX_1_HID_MASK)
628 #define XHCI_EPCTX_1_MAXB_MASK			__BITS(15, 8)
629 #define XHCI_EPCTX_1_MAXB_SET(x)		__SHIFTIN((x), XHCI_EPCTX_1_MAXB_MASK)
630 #define XHCI_EPCTX_1_MAXB_GET(x)		__SHIFTOUT((x), XHCI_EPCTX_1_MAXB_MASK)
631 #define XHCI_EPCTX_1_MAXP_SIZE_MASK		__BITS(31, 16)
632 #define XHCI_EPCTX_1_MAXP_SIZE_SET(x)		__SHIFTIN((x), XHCI_EPCTX_1_MAXP_SIZE_MASK)
633 #define XHCI_EPCTX_1_MAXP_SIZE_GET(x)		__SHIFTOUT((x), XHCI_EPCTX_1_MAXP_SIZE_MASK)
634 
635 
636 #define XHCI_EPCTX_2_DCS_MASK			__BIT(0)
637 #define XHCI_EPCTX_2_DCS_SET(x)			__SHIFTIN((x), XHCI_EPCTX_2_DCS_MASK)
638 #define XHCI_EPCTX_2_DCS_GET(x)			__SHIFTOUT((x), XHCI_EPCTX_2_DCS_MASK)
639 #define XHCI_EPCTX_2_TR_DQ_PTR_MASK             0xFFFFFFFFFFFFFFF0ULL
640 
641 #define XHCI_EPCTX_4_AVG_TRB_LEN_MASK		__BITS(15, 0)
642 #define XHCI_EPCTX_4_AVG_TRB_LEN_SET(x)		__SHIFTIN((x), XHCI_EPCTX_4_AVG_TRB_LEN_MASK)
643 #define XHCI_EPCTX_4_AVG_TRB_LEN_GET(x)         __SHIFTOUT((x), XHCI_EPCTX_4_AVG_TRB_LEN_MASK)
644 #define XHCI_EPCTX_4_MAX_ESIT_PAYLOAD_MASK	__BITS(16, 31)
645 #define XHCI_EPCTX_4_MAX_ESIT_PAYLOAD_SET(x)    __SHIFTIN((x), XHCI_EPCTX_4_MAX_ESIT_PAYLOAD_MASK)
646 #define XHCI_EPCTX_4_MAX_ESIT_PAYLOAD_GET(x)    __SHIFTOUT((x), XHCI_EPCTX_4_MAX_ESIT_PAYLOAD_MASK)
647 
648 
649 #define XHCI_INCTX_NON_CTRL_MASK        0xFFFFFFFCU
650 
651 #define XHCI_INCTX_0_DROP_MASK(n)       __BIT((n))
652 
653 #define XHCI_INCTX_1_ADD_MASK(n)        __BIT((n))
654 
655 
656 struct xhci_erste {
657 	uint64_t       erste_0;		/* 63:6 base */
658 	uint32_t       erste_2;		/* 15:0 trb count (16 to 4096) */
659 	uint32_t       erste_3;		/* RsvdZ */
660 } __packed __aligned(XHCI_ERSTE_ALIGN);
661 #define XHCI_ERSTE_SIZE sizeof(struct xhci_erste)
662 
663 #endif	/* _DEV_USB_XHCIREG_H_ */
664