xhcireg.h revision 1.16
1 /* $NetBSD: xhcireg.h,v 1.16 2020/06/04 19:50:21 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 55 #define XHCI_HCSPARAMS1 0x04 /* RO structual parameters 1 */ 56 #define XHCI_HCS1_MAXSLOTS(x) ((x) & 0xFF) 57 #define XHCI_HCS1_MAXINTRS(x) (((x) >> 8) & 0x7FF) 58 #define XHCI_HCS1_MAXPORTS(x) (((x) >> 24) & 0xFF) 59 60 #define XHCI_HCSPARAMS2 0x08 /* RO structual parameters 2 */ 61 #define XHCI_HCS2_IST(x) ((x) & 0xF) 62 #define XHCI_HCS2_ERST_MAX(x) (((x) >> 4) & 0xF) 63 #define XHCI_HCS2_SPR(x) (((x) >> 26) & 0x1) 64 #define XHCI_HCS2_SPBUFLO __BITS(31, 27) 65 #define XHCI_HCS2_SPBUFHI __BITS(25, 21) 66 #define XHCI_HCS2_MAXSPBUF(x) \ 67 (__SHIFTOUT((x), XHCI_HCS2_SPBUFHI) << 5) | \ 68 (__SHIFTOUT((x), XHCI_HCS2_SPBUFLO)) 69 70 #define XHCI_HCSPARAMS3 0x0c /* RO structual parameters 3 */ 71 #define XHCI_HCS3_U1_DEL(x) ((x) & 0xFF) 72 #define XHCI_HCS3_U2_DEL(x) (((x) >> 16) & 0xFFFF) 73 74 #define XHCI_HCCPARAMS 0x10 /* RO capability parameters */ 75 #define XHCI_HCC_AC64(x) (((x) >> 0) & 0x1) /* 64-bit capable */ 76 #define XHCI_HCC_BNC(x) (((x) >> 1) & 0x1) /* BW negotiation */ 77 #define XHCI_HCC_CSZ(x) (((x) >> 2) & 0x1) /* context size */ 78 #define XHCI_HCC_PPC(x) (((x) >> 3) & 0x1) /* port power control */ 79 #define XHCI_HCC_PIND(x) (((x) >> 4) & 0x1) /* port indicators */ 80 #define XHCI_HCC_LHRC(x) (((x) >> 5) & 0x1) /* light HC reset */ 81 #define XHCI_HCC_LTC(x) (((x) >> 6) & 0x1) /* latency tolerance msg */ 82 #define XHCI_HCC_NSS(x) (((x) >> 7) & 0x1) /* no secondary sid */ 83 #define XHCI_HCC_PAE(x) (((x) >> 8) & 0x1) /* Parse All Event Data */ 84 #define XHCI_HCC_SPC(x) (((x) >> 9) & 0x1) /* Short packet */ 85 #define XHCI_HCC_SEC(x) (((x) >> 10) & 0x1) /* Stopped EDTLA */ 86 #define XHCI_HCC_CFC(x) (((x) >> 11) & 0x1) /* Configuous Frame ID */ 87 #define XHCI_HCC_MAXPSASIZE(x) (((x) >> 12) & 0xF) /* max pri. stream array size */ 88 #define XHCI_HCC_XECP(x) (((x) >> 16) & 0xFFFF) /* extended capabilities pointer */ 89 90 #define XHCI_DBOFF 0x14 /* RO doorbell offset */ 91 #define XHCI_RTSOFF 0x18 /* RO runtime register space offset */ 92 #define XHCI_HCCPARAMS2 0x1c /* RO capability parameters 2 */ 93 #define XHCI_HCC2_U3C(x) (((x) >> 0) & 0x1) /* U3 Entry capable */ 94 #define XHCI_HCC2_CMC(x) (((x) >> 1) & 0x1) /* CEC MaxExLatTooLg */ 95 #define XHCI_HCC2_FSC(x) (((x) >> 2) & 0x1) /* Foce Save Context */ 96 #define XHCI_HCC2_CTC(x) (((x) >> 3) & 0x1) /* Compliance Transc */ 97 #define XHCI_HCC2_LEC(x) (((x) >> 4) & 0x1) /* Large ESIT Paylod */ 98 #define XHCI_HCC2_CIC(x) (((x) >> 5) & 0x1) /* Configuration Inf */ 99 #define XHCI_HCC2_ETC(x) (((x) >> 6) & 0x1) /* Extended TBC */ 100 #define XHCI_HCC2_ETC_TSC(x) (((x) >> 7) & 0x1) /* ExtTBC TRB Status */ 101 102 /* XHCI operational registers. Offset given by XHCI_CAPLENGTH register */ 103 #define XHCI_USBCMD 0x00 /* XHCI command */ 104 #define XHCI_CMD_RS 0x00000001 /* RW Run/Stop */ 105 #define XHCI_CMD_HCRST 0x00000002 /* RW Host Controller Reset */ 106 #define XHCI_CMD_INTE 0x00000004 /* RW Interrupter Enable */ 107 #define XHCI_CMD_HSEE 0x00000008 /* RW Host System Error Enable */ 108 #define XHCI_CMD_LHCRST 0x00000080 /* RO/RW Light Host Controller Reset */ 109 #define XHCI_CMD_CSS 0x00000100 /* RW Controller Save State */ 110 #define XHCI_CMD_CRS 0x00000200 /* RW Controller Restore State */ 111 #define XHCI_CMD_EWE 0x00000400 /* RW Enable Wrap Event */ 112 #define XHCI_CMD_EU3S 0x00000800 /* RW Enable U3 MFINDEX Stop */ 113 114 #define XHCI_WAIT_CNR 100 /* in 1ms */ 115 #define XHCI_WAIT_HCRST 100 /* in 1ms */ 116 117 #define XHCI_USBSTS 0x04 /* XHCI status */ 118 #define XHCI_STS_HCH 0x00000001 /* RO - Host Controller Halted */ 119 #define XHCI_STS_RSVDZ0 0x00000002 /* RsvdZ - 2:2 */ 120 #define XHCI_STS_HSE 0x00000004 /* RW - Host System Error */ 121 #define XHCI_STS_EINT 0x00000008 /* RW - Event Interrupt */ 122 #define XHCI_STS_PCD 0x00000010 /* RW - Port Change Detect */ 123 #define XHCI_STS_RSVDZ1 __BITS(7, 5) /* RsvdZ - 7:5 */ 124 #define XHCI_STS_SSS 0x00000100 /* RO - Save State Status */ 125 #define XHCI_STS_RSS 0x00000200 /* RO - Restore State Status */ 126 #define XHCI_STS_SRE 0x00000400 /* RW - Save/Restore Error */ 127 #define XHCI_STS_CNR 0x00000800 /* RO - Controller Not Ready */ 128 #define XHCI_STS_HCE 0x00001000 /* RO - Host Controller Error */ 129 #define XHCI_STS_RSVDP0 __BITS(31, 13) /* RsvdP - 31:13 */ 130 131 #define XHCI_PAGESIZE 0x08 /* XHCI page size mask */ 132 #define XHCI_PAGESIZE_4K 0x00000001 /* 4K Page Size */ 133 #define XHCI_PAGESIZE_8K 0x00000002 /* 8K Page Size */ 134 #define XHCI_PAGESIZE_16K 0x00000004 /* 16K Page Size */ 135 #define XHCI_PAGESIZE_32K 0x00000008 /* 32K Page Size */ 136 #define XHCI_PAGESIZE_64K 0x00000010 /* 64K Page Size */ 137 138 #define XHCI_DNCTRL 0x14 /* XHCI device notification control */ 139 #define XHCI_DNCTRL_MASK(n) (1U << (n)) 140 141 #define XHCI_CRCR 0x18 /* XHCI command ring control */ 142 #define XHCI_CRCR_LO_RCS 0x00000001 /* RW - consumer cycle state */ 143 #define XHCI_CRCR_LO_CS 0x00000002 /* RW - command stop */ 144 #define XHCI_CRCR_LO_CA 0x00000004 /* RW - command abort */ 145 #define XHCI_CRCR_LO_CRR 0x00000008 /* RW - command ring running */ 146 #define XHCI_CRCR_LO_MASK 0x0000000F 147 148 #define XHCI_CRCR_HI 0x1c /* XHCI command ring control */ 149 #define XHCI_DCBAAP 0x30 /* XHCI dev context BA pointer */ 150 #define XHCI_DCBAAP_HI 0x34 /* XHCI dev context BA pointer */ 151 #define XHCI_CONFIG 0x38 152 #define XHCI_CONFIG_SLOTS_MASK 0x000000FF /* RW - number of device slots enabled */ 153 154 /* XHCI port status registers */ 155 #define XHCI_PORTSC(n) (0x3f0 + (0x10 * (n))) /* XHCI port status */ 156 #define XHCI_PS_CCS 0x00000001 /* RO - current connect status */ 157 #define XHCI_PS_PED 0x00000002 /* RW - port enabled / disabled */ 158 #define XHCI_PS_OCA 0x00000008 /* RO - over current active */ 159 #define XHCI_PS_PR 0x00000010 /* RW - port reset */ 160 #define XHCI_PS_PLS_GET(x) (((x) >> 5) & 0xF) /* RW - port link state */ 161 #define XHCI_PS_PLS_SET(x) (((x) & 0xF) << 5) /* RW - port link state */ 162 #define XHCI_PS_PP 0x00000200 /* RW - port power */ 163 #define XHCI_PS_SPEED_GET(x) (((x) >> 10) & 0xF) /* RO - port speed */ 164 #define XHCI_PS_SPEED_FS 1 165 #define XHCI_PS_SPEED_LS 2 166 #define XHCI_PS_SPEED_HS 3 167 #define XHCI_PS_SPEED_SS 4 168 #define XHCI_PS_PIC_GET(x) (((x) >> 14) & 0x3) /* RW - port indicator */ 169 #define XHCI_PS_PIC_SET(x) (((x) & 0x3) << 14) /* RW - port indicator */ 170 #define XHCI_PS_LWS 0x00010000 /* RW - port link state write strobe */ 171 #define XHCI_PS_CSC 0x00020000 /* RW - connect status change */ 172 #define XHCI_PS_PEC 0x00040000 /* RW - port enable/disable change */ 173 #define XHCI_PS_WRC 0x00080000 /* RW - warm port reset change */ 174 #define XHCI_PS_OCC 0x00100000 /* RW - over-current change */ 175 #define XHCI_PS_PRC 0x00200000 /* RW - port reset change */ 176 #define XHCI_PS_PLC 0x00400000 /* RW - port link state change */ 177 #define XHCI_PS_CEC 0x00800000 /* RW - config error change */ 178 #define XHCI_PS_CAS 0x01000000 /* RO - cold attach status */ 179 #define XHCI_PS_WCE 0x02000000 /* RW - wake on connect enable */ 180 #define XHCI_PS_WDE 0x04000000 /* RW - wake on disconnect enable */ 181 #define XHCI_PS_WOE 0x08000000 /* RW - wake on over-current enable */ 182 #define XHCI_PS_DR 0x40000000 /* RO - device removable */ 183 #define XHCI_PS_WPR 0x80000000U /* RW - warm port reset */ 184 #define XHCI_PS_CLEAR 0x80FF01FFU /* command bits */ 185 186 #define XHCI_PORTPMSC(n) (0x3f4 + (0x10 * (n))) /* XHCI status and control */ 187 #define XHCI_PM3_U1TO_GET(x) (((x) >> 0) & 0xFF) /* RW - U1 timeout */ 188 #define XHCI_PM3_U1TO_SET(x) (((x) & 0xFF) << 0) /* RW - U1 timeout */ 189 #define XHCI_PM3_U2TO_GET(x) (((x) >> 8) & 0xFF) /* RW - U2 timeout */ 190 #define XHCI_PM3_U2TO_SET(x) (((x) & 0xFF) << 8) /* RW - U2 timeout */ 191 #define XHCI_PM3_FLA 0x00010000 /* RW - Force Link PM Accept */ 192 #define XHCI_PM2_L1S_GET(x) (((x) >> 0) & 0x7) /* RO - L1 status */ 193 #define XHCI_PM2_RWE 0x00000008 /* RW - remote wakup enable */ 194 #define XHCI_PM2_HIRD_GET(x) (((x) >> 4) & 0xF) /* RW - host initiated resume duration */ 195 #define XHCI_PM2_HIRD_SET(x) (((x) & 0xF) << 4) /* RW - host initiated resume duration */ 196 #define XHCI_PM2_L1SLOT_GET(x) (((x) >> 8) & 0xFF) /* RW - L1 device slot */ 197 #define XHCI_PM2_L1SLOT_SET(x) (((x) & 0xFF) << 8) /* RW - L1 device slot */ 198 #define XHCI_PM2_HLE 0x00010000 /* RW - hardware LPM enable */ 199 200 #define XHCI_PORTLI(n) (0x3f8 + (0x10 * (n))) /* XHCI port link info */ 201 #define XHCI_PLI3_ERR_GET(x) (((x) >> 0) & 0xFFFF) /* RO - port link errors */ 202 203 #define XHCI_PORTRSV(n) (0x3fc + (0x10 * (n))) /* XHCI port reserved */ 204 205 /* XHCI runtime registers. Offset given by XHCI_CAPLENGTH + XHCI_RTSOFF registers */ 206 #define XHCI_MFINDEX 0x0000 /* RO - microframe index */ 207 #define XHCI_MFINDEX_GET(x) ((x) & 0x3FFF) 208 209 #define XHCI_IMAN(n) (0x0020 + (0x20 * (n))) /* XHCI interrupt management */ 210 #define XHCI_IMAN_INTR_PEND 0x00000001 /* RW - interrupt pending */ 211 #define XHCI_IMAN_INTR_ENA 0x00000002 /* RW - interrupt enable */ 212 213 #define XHCI_IMOD(n) (0x0024 + (0x20 * (n))) /* XHCI interrupt moderation */ 214 #define XHCI_IMOD_IVAL_GET(x) (((x) >> 0) & 0xFFFF) /* 250ns unit */ 215 #define XHCI_IMOD_IVAL_SET(x) (((x) & 0xFFFF) << 0) /* 250ns unit */ 216 #define XHCI_IMOD_ICNT_GET(x) (((x) >> 16) & 0xFFFF) /* 250ns unit */ 217 #define XHCI_IMOD_ICNT_SET(x) (((x) & 0xFFFF) << 16) /* 250ns unit */ 218 #define XHCI_IMOD_DEFAULT 0x000001F4U /* 8000 IRQ/second */ 219 #define XHCI_IMOD_DEFAULT_LP 0x000003E8U /* 4000 IRQ/sec for LynxPoint */ 220 221 #define XHCI_ERSTSZ(n) (0x0028 + (0x20 * (n))) /* XHCI event ring segment table size */ 222 #define XHCI_ERSTS_GET(x) ((x) & 0xFFFF) 223 #define XHCI_ERSTS_SET(x) ((x) & 0xFFFF) 224 225 #define XHCI_ERSTBA(n) (0x0030 + (0x20 * (n))) /* XHCI event ring segment table BA */ 226 #define XHCI_ERSTBA_HI(n) (0x0034 + (0x20 * (n))) /* XHCI event ring segment table BA */ 227 228 #define XHCI_ERDP(n) (0x0038 + (0x20 * (n))) /* XHCI event ring dequeue pointer */ 229 #define XHCI_ERDP_HI(n) (0x003C + (0x20 * (n))) /* XHCI event ring dequeue pointer */ 230 #define XHCI_ERDP_LO_SINDEX(x) ((x) & 0x7) /* RO - dequeue segment index */ 231 #define XHCI_ERDP_LO_BUSY 0x00000008 /* RW - event handler busy */ 232 233 /* XHCI doorbell registers. Offset given by XHCI_CAPLENGTH + XHCI_DBOFF registers */ 234 #define XHCI_DOORBELL(n) (0x0000 + (4 * (n))) 235 #define XHCI_DB_TARGET_GET(x) ((x) & 0xFF) /* RW - doorbell target */ 236 #define XHCI_DB_TARGET_SET(x) ((x) & 0xFF) /* RW - doorbell target */ 237 #define XHCI_DB_SID_GET(x) (((x) >> 16) & 0xFFFF) /* RW - doorbell stream ID */ 238 #define XHCI_DB_SID_SET(x) (((x) & 0xFFFF) << 16) /* RW - doorbell stream ID */ 239 240 /* 7 xHCI Extendeded capabilities */ 241 #define XHCI_XECP_ID(x) ((x) & 0xFF) 242 #define XHCI_XECP_NEXT(x) (((x) >> 8) & 0xFF) 243 244 /* XHCI extended capability ID's */ 245 #define XHCI_ID_USB_LEGACY 0x0001 /* USB Legacy Support */ 246 #define XHCI_XECP_USBLEGSUP 0x0000 /* Legacy Support Capability Reg */ 247 #define XHCI_XECP_USBLEGCTLSTS 0x0004 /* Legacy Support Ctrl & Status Reg */ 248 #define XHCI_ID_PROTOCOLS 0x0002 /* Supported Protocol */ 249 #define XHCI_ID_POWER_MGMT 0x0003 /* Extended Power Management */ 250 #define XHCI_ID_VIRTUALIZATION 0x0004 /* I/O Virtualization */ 251 #define XHCI_ID_MSG_IRQ 0x0005 /* Message Interrupt */ 252 #define XHCI_ID_USB_LOCAL_MEM 0x0006 /* Local Memory */ 253 #define XHCI_ID_USB_DEBUG 0x000A /* USB Debug Capability */ 254 #define XHCI_ID_XMSG_IRQ 0x0011 /* Extended Message Interrupt */ 255 256 /* 7.1 xHCI legacy support */ 257 #define XHCI_XECP_BIOS_SEM 0x0002 258 #define XHCI_XECP_OS_SEM 0x0003 259 260 /* 7.2 xHCI Supported Protocol Capability */ 261 #define XHCI_XECP_USBID 0x20425355 262 263 #define XHCI_XECP_SP_W0_MINOR_MASK __BITS(23, 16) 264 #define XHCI_XECP_SP_W0_MINOR(x) __SHIFTOUT((x), XHCI_XECP_SP_W0_MINOR_MASK) 265 #define XHCI_XECP_SP_W0_MAJOR_MASK __BITS(31, 24) 266 #define XHCI_XECP_SP_W0_MAJOR(x) __SHIFTOUT((x), XHCI_XECP_SP_W0_MAJOR_MASK) 267 268 #define XHCI_XECP_SP_W8_CPO_MASK __BITS(7, 0) 269 #define XHCI_XECP_SP_W8_CPO(x) __SHIFTOUT((x), XHCI_XECP_SP_W8_CPO_MASK) 270 #define XHCI_XECP_SP_W8_CPC_MASK __BITS(15, 8) 271 #define XHCI_XECP_SP_W8_CPC(x) __SHIFTOUT((x), XHCI_XECP_SP_W8_CPC_MASK) 272 #define XHCI_XECP_SP_W8_PD_MASK __BITS(27, 16) 273 #define XHCI_XECP_SP_W8_PD(x) __SHIFTOUT((x), XHCI_XECP_SP_W8_PD_MASK) 274 #define XHCI_XECP_SP_W8_PSIC_MASK __BITS(31, 28) 275 #define XHCI_XECP_SP_W8_PSIC(x) __SHIFTOUT((x), XHCI_XECP_SP_W8_PSIC_MASK) 276 277 #define XHCI_PAGE_SIZE(sc) ((sc)->sc_pgsz) 278 279 /* Chapter 6, Table 49 */ 280 #define XHCI_DEVICE_CONTEXT_BASE_ADDRESS_ARRAY_ALIGN 64 281 #define XHCI_DEVICE_CONTEXT_ALIGN 64 282 #define XHCI_INPUT_CONTROL_CONTEXT_ALIGN 64 283 #define XHCI_SLOT_CONTEXT_ALIGN 32 284 #define XHCI_ENDPOINT_CONTEXT_ALIGN 32 285 #define XHCI_STREAM_CONTEXT_ALIGN 16 286 #define XHCI_STREAM_ARRAY_ALIGN 16 287 #define XHCI_TRANSFER_RING_SEGMENTS_ALIGN 16 288 #define XHCI_COMMAND_RING_SEGMENTS_ALIGN 64 289 #define XHCI_EVENT_RING_SEGMENTS_ALIGN 64 290 #define XHCI_EVENT_RING_SEGMENT_TABLE_ALIGN 64 291 #define XHCI_SCRATCHPAD_BUFFER_ARRAY_ALIGN 64 292 #define XHCI_SCRATCHPAD_BUFFERS_ALIGN XHCI_PAGE_SIZE 293 294 #define XHCI_ERSTE_ALIGN 16 295 #define XHCI_TRB_ALIGN 16 296 297 struct xhci_trb { 298 uint64_t trb_0; 299 uint32_t trb_2; 300 #define XHCI_TRB_2_ERROR_GET(x) (((x) >> 24) & 0xFF) 301 #define XHCI_TRB_2_ERROR_SET(x) (((x) & 0xFF) << 24) 302 #define XHCI_TRB_2_TDSZ_GET(x) (((x) >> 17) & 0x1F) 303 #define XHCI_TRB_2_TDSZ_SET(x) (((x) & 0x1F) << 17) 304 #define XHCI_TRB_2_REM_GET(x) ((x) & 0xFFFFFF) 305 #define XHCI_TRB_2_REM_SET(x) ((x) & 0xFFFFFF) 306 #define XHCI_TRB_2_BYTES_GET(x) ((x) & 0x1FFFF) 307 #define XHCI_TRB_2_BYTES_SET(x) ((x) & 0x1FFFF) 308 #define XHCI_TRB_2_IRQ_GET(x) (((x) >> 22) & 0x3FF) 309 #define XHCI_TRB_2_IRQ_SET(x) (((x) & 0x3FF) << 22) 310 #define XHCI_TRB_2_STREAM_GET(x) (((x) >> 16) & 0xFFFF) 311 #define XHCI_TRB_2_STREAM_SET(x) (((x) & 0xFFFF) << 16) 312 uint32_t trb_3; 313 #define XHCI_TRB_3_TYPE_GET(x) (((x) >> 10) & 0x3F) 314 #define XHCI_TRB_3_TYPE_SET(x) (((x) & 0x3F) << 10) 315 #define XHCI_TRB_3_CYCLE_BIT (1U << 0) 316 #define XHCI_TRB_3_TC_BIT (1U << 1) /* command ring only */ 317 #define XHCI_TRB_3_ENT_BIT (1U << 1) /* transfer ring only */ 318 #define XHCI_TRB_3_ISP_BIT (1U << 2) 319 #define XHCI_TRB_3_NSNOOP_BIT (1U << 3) 320 #define XHCI_TRB_3_CHAIN_BIT (1U << 4) 321 #define XHCI_TRB_3_IOC_BIT (1U << 5) 322 #define XHCI_TRB_3_IDT_BIT (1U << 6) 323 #define XHCI_TRB_3_TBC_GET(x) (((x) >> 7) & 3) 324 #define XHCI_TRB_3_TBC_SET(x) (((x) & 3) << 7) 325 #define XHCI_TRB_3_BEI_BIT (1U << 9) 326 #define XHCI_TRB_3_DCEP_BIT (1U << 9) 327 #define XHCI_TRB_3_PRSV_BIT (1U << 9) 328 #define XHCI_TRB_3_BSR_BIT (1U << 9) 329 #define XHCI_TRB_3_TRT_MASK (3U << 16) 330 #define XHCI_TRB_3_TRT_NONE (0U << 16) 331 #define XHCI_TRB_3_TRT_OUT (2U << 16) 332 #define XHCI_TRB_3_TRT_IN (3U << 16) 333 #define XHCI_TRB_3_DIR_IN (1U << 16) 334 #define XHCI_TRB_3_TLBPC_GET(x) (((x) >> 16) & 0xF) 335 #define XHCI_TRB_3_TLBPC_SET(x) (((x) & 0xF) << 16) 336 #define XHCI_TRB_3_EP_GET(x) (((x) >> 16) & 0x1F) 337 #define XHCI_TRB_3_EP_SET(x) (((x) & 0x1F) << 16) 338 #define XHCI_TRB_3_FRID_GET(x) (((x) >> 20) & 0x7FF) 339 #define XHCI_TRB_3_FRID_SET(x) (((x) & 0x7FF) << 20) 340 #define XHCI_TRB_3_ISO_SIA_BIT (1U << 31) 341 #define XHCI_TRB_3_SUSP_EP_BIT (1U << 23) 342 #define XHCI_TRB_3_VFID_GET(x) (((x) >> 16) & 0xFF) 343 #define XHCI_TRB_3_VFID_SET(x) (((x) & 0xFF) << 16) 344 #define XHCI_TRB_3_SLOT_GET(x) (((x) >> 24) & 0xFF) 345 #define XHCI_TRB_3_SLOT_SET(x) (((x) & 0xFF) << 24) 346 347 /* Commands */ 348 #define XHCI_TRB_TYPE_RESERVED 0x00 349 #define XHCI_TRB_TYPE_NORMAL 0x01 350 #define XHCI_TRB_TYPE_SETUP_STAGE 0x02 351 #define XHCI_TRB_TYPE_DATA_STAGE 0x03 352 #define XHCI_TRB_TYPE_STATUS_STAGE 0x04 353 #define XHCI_TRB_TYPE_ISOCH 0x05 354 #define XHCI_TRB_TYPE_LINK 0x06 355 #define XHCI_TRB_TYPE_EVENT_DATA 0x07 356 #define XHCI_TRB_TYPE_NOOP 0x08 357 #define XHCI_TRB_TYPE_ENABLE_SLOT 0x09 358 #define XHCI_TRB_TYPE_DISABLE_SLOT 0x0A 359 #define XHCI_TRB_TYPE_ADDRESS_DEVICE 0x0B 360 #define XHCI_TRB_TYPE_CONFIGURE_EP 0x0C 361 #define XHCI_TRB_TYPE_EVALUATE_CTX 0x0D 362 #define XHCI_TRB_TYPE_RESET_EP 0x0E 363 #define XHCI_TRB_TYPE_STOP_EP 0x0F 364 #define XHCI_TRB_TYPE_SET_TR_DEQUEUE 0x10 365 #define XHCI_TRB_TYPE_RESET_DEVICE 0x11 366 #define XHCI_TRB_TYPE_FORCE_EVENT 0x12 367 #define XHCI_TRB_TYPE_NEGOTIATE_BW 0x13 368 #define XHCI_TRB_TYPE_SET_LATENCY_TOL 0x14 369 #define XHCI_TRB_TYPE_GET_PORT_BW 0x15 370 #define XHCI_TRB_TYPE_FORCE_HEADER 0x16 371 #define XHCI_TRB_TYPE_NOOP_CMD 0x17 372 373 /* Events */ 374 #define XHCI_TRB_EVENT_TRANSFER 0x20 375 #define XHCI_TRB_EVENT_CMD_COMPLETE 0x21 376 #define XHCI_TRB_EVENT_PORT_STS_CHANGE 0x22 377 #define XHCI_TRB_EVENT_BW_REQUEST 0x23 378 #define XHCI_TRB_EVENT_DOORBELL 0x24 379 #define XHCI_TRB_EVENT_HOST_CTRL 0x25 380 #define XHCI_TRB_EVENT_DEVICE_NOTIFY 0x26 381 #define XHCI_TRB_EVENT_MFINDEX_WRAP 0x27 382 383 /* Error codes */ 384 #define XHCI_TRB_ERROR_INVALID 0x00 385 #define XHCI_TRB_ERROR_SUCCESS 0x01 386 #define XHCI_TRB_ERROR_DATA_BUF 0x02 387 #define XHCI_TRB_ERROR_BABBLE 0x03 388 #define XHCI_TRB_ERROR_XACT 0x04 389 #define XHCI_TRB_ERROR_TRB 0x05 390 #define XHCI_TRB_ERROR_STALL 0x06 391 #define XHCI_TRB_ERROR_RESOURCE 0x07 392 #define XHCI_TRB_ERROR_BANDWIDTH 0x08 393 #define XHCI_TRB_ERROR_NO_SLOTS 0x09 394 #define XHCI_TRB_ERROR_STREAM_TYPE 0x0A 395 #define XHCI_TRB_ERROR_SLOT_NOT_ON 0x0B 396 #define XHCI_TRB_ERROR_ENDP_NOT_ON 0x0C 397 #define XHCI_TRB_ERROR_SHORT_PKT 0x0D 398 #define XHCI_TRB_ERROR_RING_UNDERRUN 0x0E 399 #define XHCI_TRB_ERROR_RING_OVERRUN 0x0F 400 #define XHCI_TRB_ERROR_VF_RING_FULL 0x10 401 #define XHCI_TRB_ERROR_PARAMETER 0x11 402 #define XHCI_TRB_ERROR_BW_OVERRUN 0x12 403 #define XHCI_TRB_ERROR_CONTEXT_STATE 0x13 404 #define XHCI_TRB_ERROR_NO_PING_RESP 0x14 405 #define XHCI_TRB_ERROR_EV_RING_FULL 0x15 406 #define XHCI_TRB_ERROR_INCOMPAT_DEV 0x16 407 #define XHCI_TRB_ERROR_MISSED_SERVICE 0x17 408 #define XHCI_TRB_ERROR_CMD_RING_STOP 0x18 409 #define XHCI_TRB_ERROR_CMD_ABORTED 0x19 410 #define XHCI_TRB_ERROR_STOPPED 0x1A 411 #define XHCI_TRB_ERROR_LENGTH 0x1B 412 #define XHCI_TRB_ERROR_STOPPED_SHORT 0x1C 413 #define XHCI_TRB_ERROR_BAD_MELAT 0x1D 414 #define XHCI_TRB_ERROR_ISOC_OVERRUN 0x1F 415 #define XHCI_TRB_ERROR_EVENT_LOST 0x20 416 #define XHCI_TRB_ERROR_UNDEFINED 0x21 417 #define XHCI_TRB_ERROR_INVALID_SID 0x22 418 #define XHCI_TRB_ERROR_SEC_BW 0x23 419 #define XHCI_TRB_ERROR_SPLIT_XACT 0x24 420 } __packed __aligned(XHCI_TRB_ALIGN); 421 #define XHCI_TRB_SIZE sizeof(struct xhci_trb) 422 423 #define XHCI_SCTX_0_ROUTE_SET(x) ((x) & 0xFFFFF) 424 #define XHCI_SCTX_0_ROUTE_GET(x) ((x) & 0xFFFFF) 425 #define XHCI_SCTX_0_SPEED_SET(x) (((x) & 0xF) << 20) 426 #define XHCI_SCTX_0_SPEED_GET(x) (((x) >> 20) & 0xF) 427 #define XHCI_SCTX_0_MTT_SET(x) (((x) & 0x1) << 25) 428 #define XHCI_SCTX_0_MTT_GET(x) (((x) >> 25) & 0x1) 429 #define XHCI_SCTX_0_HUB_SET(x) (((x) & 0x1) << 26) 430 #define XHCI_SCTX_0_HUB_GET(x) (((x) >> 26) & 0x1) 431 #define XHCI_SCTX_0_CTX_NUM_SET(x) (((x) & 0x1F) << 27) 432 #define XHCI_SCTX_0_CTX_NUM_GET(x) (((x) >> 27) & 0x1F) 433 434 #define XHCI_SCTX_1_MAX_EL_SET(x) ((x) & 0xFFFF) 435 #define XHCI_SCTX_1_MAX_EL_GET(x) ((x) & 0xFFFF) 436 #define XHCI_SCTX_1_RH_PORT_SET(x) (((x) & 0xFF) << 16) 437 #define XHCI_SCTX_1_RH_PORT_GET(x) (((x) >> 16) & 0xFF) 438 #define XHCI_SCTX_1_NUM_PORTS_SET(x) (((x) & 0xFF) << 24) 439 #define XHCI_SCTX_1_NUM_PORTS_GET(x) (((x) >> 24) & 0xFF) 440 441 #define XHCI_SCTX_2_TT_HUB_SID_SET(x) ((x) & 0xFF) 442 #define XHCI_SCTX_2_TT_HUB_SID_GET(x) ((x) & 0xFF) 443 #define XHCI_SCTX_2_TT_PORT_NUM_SET(x) (((x) & 0xFF) << 8) 444 #define XHCI_SCTX_2_TT_PORT_NUM_GET(x) (((x) >> 8) & 0xFF) 445 #define XHCI_SCTX_2_TT_THINK_TIME_SET(x) (((x) & 0x3) << 16) 446 #define XHCI_SCTX_2_TT_THINK_TIME_GET(x) (((x) >> 16) & 0x3) 447 #define XHCI_SCTX_2_IRQ_TARGET_SET(x) (((x) & 0x3FF) << 22) 448 #define XHCI_SCTX_2_IRQ_TARGET_GET(x) (((x) >> 22) & 0x3FF) 449 450 #define XHCI_SCTX_3_DEV_ADDR_SET(x) ((x) & 0xFF) 451 #define XHCI_SCTX_3_DEV_ADDR_GET(x) ((x) & 0xFF) 452 #define XHCI_SCTX_3_SLOT_STATE_SET(x) (((x) & 0x1F) << 27) 453 #define XHCI_SCTX_3_SLOT_STATE_GET(x) (((x) >> 27) & 0x1F) 454 #define XHCI_SLOTSTATE_DISABLED 0 /* disabled or enabled */ 455 #define XHCI_SLOTSTATE_ENABLED 0 456 #define XHCI_SLOTSTATE_DEFAULT 1 457 #define XHCI_SLOTSTATE_ADDRESSED 2 458 #define XHCI_SLOTSTATE_CONFIGURED 3 459 460 461 #define XHCI_EPCTX_0_EPSTATE_SET(x) ((x) & 0x7) 462 #define XHCI_EPCTX_0_EPSTATE_GET(x) ((x) & 0x7) 463 #define XHCI_EPSTATE_DISABLED 0 464 #define XHCI_EPSTATE_RUNNING 1 465 #define XHCI_EPSTATE_HALTED 2 466 #define XHCI_EPSTATE_STOPPED 3 467 #define XHCI_EPSTATE_ERROR 4 468 #define XHCI_EPCTX_0_MULT_SET(x) (((x) & 0x3) << 8) 469 #define XHCI_EPCTX_0_MULT_GET(x) (((x) >> 8) & 0x3) 470 #define XHCI_EPCTX_0_MAXP_STREAMS_SET(x) (((x) & 0x1F) << 10) 471 #define XHCI_EPCTX_0_MAXP_STREAMS_GET(x) (((x) >> 10) & 0x1F) 472 #define XHCI_EPCTX_0_LSA_SET(x) (((x) & 0x1) << 15) 473 #define XHCI_EPCTX_0_LSA_GET(x) (((x) >> 15) & 0x1) 474 #define XHCI_EPCTX_0_IVAL_SET(x) (((x) & 0xFF) << 16) 475 #define XHCI_EPCTX_0_IVAL_GET(x) (((x) >> 16) & 0xFF) 476 #define XHCI_EPCTX_0_MAX_ESIT_PAYLOAD_HI_MASK __BITS(31,24) 477 #define XHCI_EPCTX_0_MAX_ESIT_PAYLOAD_HI_SET(x) __SHIFTIN((x), XHCI_EPCTX_0_MAX_ESIT_PAYLOAD_HI_MASK) 478 #define XHCI_EPCTX_0_MAX_ESIT_PAYLOAD_HI_GET(x) __SHIFTOUT((x), XHCI_EPCTX_0_MAX_ESIT_PAYLOAD_HI_MASK) 479 480 #define XHCI_EPCTX_1_CERR_SET(x) (((x) & 0x3) << 1) 481 #define XHCI_EPCTX_1_CERR_GET(x) (((x) >> 1) & 0x3) 482 #define XHCI_EPCTX_1_EPTYPE_SET(x) (((x) & 0x7) << 3) 483 #define XHCI_EPCTX_1_EPTYPE_GET(x) (((x) >> 3) & 0x7) 484 #define XHCI_EPCTX_1_HID_SET(x) (((x) & 0x1) << 7) 485 #define XHCI_EPCTX_1_HID_GET(x) (((x) >> 7) & 0x1) 486 #define XHCI_EPCTX_1_MAXB_SET(x) (((x) & 0xFF) << 8) 487 #define XHCI_EPCTX_1_MAXB_GET(x) (((x) >> 8) & 0xFF) 488 #define XHCI_EPCTX_1_MAXP_SIZE_SET(x) (((x) & 0xFFFF) << 16) 489 #define XHCI_EPCTX_1_MAXP_SIZE_GET(x) (((x) >> 16) & 0xFFFF) 490 491 #define XHCI_EPCTX_2_DCS_SET(x) ((x) & 0x1) 492 #define XHCI_EPCTX_2_DCS_GET(x) ((x) & 0x1) 493 #define XHCI_EPCTX_2_TR_DQ_PTR_MASK 0xFFFFFFFFFFFFFFF0U 494 495 #define XHCI_EPCTX_4_AVG_TRB_LEN_SET(x) ((x) & 0xFFFF) 496 #define XHCI_EPCTX_4_AVG_TRB_LEN_GET(x) ((x) & 0xFFFF) 497 #define XHCI_EPCTX_4_MAX_ESIT_PAYLOAD_SET(x) (((x) & 0xFFFF) << 16) 498 #define XHCI_EPCTX_4_MAX_ESIT_PAYLOAD_GET(x) (((x) >> 16) & 0xFFFF) 499 500 501 #define XHCI_INCTX_NON_CTRL_MASK 0xFFFFFFFCU 502 503 #define XHCI_INCTX_0_DROP_MASK(n) (1U << (n)) 504 505 #define XHCI_INCTX_1_ADD_MASK(n) (1U << (n)) 506 507 508 struct xhci_erste { 509 uint64_t erste_0; /* 63:6 base */ 510 uint32_t erste_2; /* 15:0 trb count (16 to 4096) */ 511 uint32_t erste_3; /* RsvdZ */ 512 } __packed __aligned(XHCI_ERSTE_ALIGN); 513 #define XHCI_ERSTE_SIZE sizeof(struct xhci_erste) 514 515 #endif /* _DEV_USB_XHCIREG_H_ */ 516
Indexes created Tue Sep 30 20:09:53 GMT 2025