1 /* 2 * Copyright 2011-2012, Haiku Inc. All rights reserved. 3 * Distributed under the terms of the MIT License. 4 * 5 * Authors: 6 * Jian Chiang <j.jian.chiang@gmail.com> 7 * Jérôme Duval <jerome.duval@gmail.com> 8 * Akshay Jaggi <akshay1994.leo@gmail.com> 9 */ 10 #ifndef XHCI_HARDWARE_H 11 #define XHCI_HARDWARE_H 12 13 // PCI IDs 14 #define PCI_VENDOR_INTEL 0x8086 15 #define PCI_DEVICE_INTEL_PANTHER_POINT_XHCI 0x1e31 16 #define PCI_DEVICE_INTEL_LYNX_POINT_XHCI 0x8c31 17 #define PCI_DEVICE_INTEL_LYNX_POINT_LP_XHCI 0x9c31 18 #define PCI_DEVICE_INTEL_BAYTRAIL_XHCI 0x0f35 19 #define PCI_DEVICE_INTEL_WILDCAT_POINT_XHCI 0x8cb1 20 #define PCI_DEVICE_INTEL_WILDCAT_POINT_LP_XHCI 0x9cb1 21 22 // Intel quirks registers in PCI config 23 #define XHCI_INTEL_USB3PRM 0xdc // USB 3.0 Port Routing Mask 24 #define XHCI_INTEL_USB3_PSSEN 0xd8 // USB 3.0 Port SuperSpeed Enable 25 #define XHCI_INTEL_USB2PRM 0xd4 // USB 2.0 Port Routing Mask 26 #define XHCI_INTEL_XUSB2PR 0xd0 // USB 2.0 Port Routing 27 28 // Host Controller Capability Registers 29 #define XHCI_HCI_CAPLENGTH 0x00 // HCI Capability Register Length 30 #define HCI_CAPLENGTH(p) (((p) >> 0) & 0xff) 31 #define HCI_VERSION(p) (((p) >> 16) & 0xffff) // HCI Version 32 #define XHCI_HCSPARAMS1 0x04 // Structural Parameters 1 33 // HCSPARAMS1 34 #define HCS_MAX_SLOTS(p) (((p) >> 0) & 0xff) 35 #define HCS_MAX_PORTS(p) (((p) >> 24) & 0xff) 36 #define XHCI_HCSPARAMS2 0x08 // Structural Parameters 2 37 #define HCS_IST(p) (((p) >> 0) & 0xf) 38 #define HCS_ERST_MAX(p) (((p) >> 4) & 0xf) 39 #define HCS_SPR(p) (((p) >> 26) & 0x1) 40 #define HCS_MAX_SC_BUFFERS(p) (((((p) >> 21) & 0x1f)<<5)|(((p) >> 27) & 0x1f)) 41 #define XHCI_HCSPARAMS3 0x0C // Structural Parameters 3 42 #define HCS_U1_DEVICE_LATENCY(p) (((p) >> 0) & 0xff) 43 #define HCS_U2_DEVICE_LATENCY(p) (((p) >> 16) & 0xffff) 44 #define XHCI_HCCPARAMS 0x10 // Capability Parameters 45 #define XHCI_DBOFF 0x14 // Doorbell Register offset 46 #define XHCI_RTSOFF 0x18 // Runtime Register Space offset 47 48 49 // Host Controller Operational Registers 50 #define XHCI_CMD 0x00 // USB Command 51 // USB Command Register 52 #define CMD_RUN (1 << 0) 53 #define CMD_HCRST (1 << 1) // Host Controller Reset 54 #define CMD_EIE (1 << 2) 55 #define CMD_HSEIE (1 << 3) 56 57 #define XHCI_STS 0x04 // USB Status 58 // USB Status Register 59 #define STS_HCH (1 << 0) 60 #define STS_HSE (1 << 2) 61 #define STS_EINT (1 << 3) 62 #define STS_PCD (1 << 4) 63 #define STS_CNR (1 << 11) 64 #define STS_HCE (1 << 12) 65 #define XHCI_PAGESIZE 0x08 // PAGE SIZE 66 #define XHCI_DNCTRL 0x14 67 // Section 5.4.5 68 #define XHCI_CRCR_LO 0x18 69 #define XHCI_CRCR_HI 0x1C 70 #define CRCR_RCS (1<<0) 71 // Section 5.4.6 72 #define XHCI_DCBAAP_LO 0x30 73 #define XHCI_DCBAAP_HI 0x34 74 // Section 5.4.7 75 #define XHCI_CONFIG 0x38 76 77 78 // Host Controller Runtime Registers 79 // Section 5.5.2.1 80 #define XHCI_IMAN(n) (0x0020 + (0x20 * (n))) 81 // IMAN 82 #define IMAN_INTR_ENA 0x00000002 83 // Section 5.5.2.2 84 #define XHCI_IMOD(n) (0x0024 + (0x20 * (n))) 85 // Section 5.5.2.3.1 86 #define XHCI_ERSTSZ(n) (0x0028 + (0x20 * (n))) 87 // ERSTSZ 88 #define XHCI_ERSTS_SET(x) ((x) & 0xFFFF) 89 // Section 5.5.2.3.2 90 #define XHCI_ERSTBA_LO(n) (0x0030 + (0x20 * (n))) 91 #define XHCI_ERSTBA_HI(n) (0x0034 + (0x20 * (n))) 92 // Section 5.5.2.3.3 93 #define XHCI_ERDP_LO(n) (0x0038 + (0x20 * (n))) 94 #define XHCI_ERDP_HI(n) (0x003C + (0x20 * (n))) 95 // Event Handler Busy (EHB) 96 #define ERST_EHB (1 << 3) 97 98 99 // Host Controller Doorbell Registers 100 #define XHCI_DOORBELL(n) (0x0000 + (4 * (n))) 101 #define XHCI_DOORBELL_TARGET(x) ((x) & 0xff) 102 #define XHCI_DOORBELL_TARGET_GET(x) ((x) & 0xff) 103 #define XHCI_DOORBELL_STREAMID(x) (((x) & 0xffff) << 16) 104 #define XHCI_DOORBELL_STREAMID_GET(x) (((x) >> 16) & 0xffff) 105 106 107 // Extended Capabilities 108 #define XECP_ID(x) ((x) & 0xff) 109 #define HCS0_XECP(x) (((x) >> 16) & 0xffff) 110 #define XECP_NEXT(x) (((x) >> 8) & 0xff) 111 #define XHCI_LEGSUP_CAPID 0x01 112 #define XHCI_LEGSUP_OSOWNED (1 << 24) // OS Owned Semaphore 113 #define XHCI_LEGSUP_BIOSOWNED (1 << 16) // BIOS Owned Semaphore 114 115 #define XHCI_LEGCTLSTS 0x04 116 #define XHCI_LEGCTLSTS_DISABLE_SMI ((0x7 << 1) + (0xff << 5) + (0x7 << 17)) 117 #define XHCI_LEGCTLSTS_EVENTS_SMI (0x7 << 29) 118 119 #define XHCI_SUPPORTED_PROTOCOLS_CAPID 0x02 120 #define XHCI_SUPPORTED_PROTOCOLS_0_MINOR(x) (((x) >> 16) & 0xff) 121 #define XHCI_SUPPORTED_PROTOCOLS_0_MAJOR(x) (((x) >> 24) & 0xff) 122 123 #define XHCI_SUPPORTED_PROTOCOLS_1_COUNT(x) (((x) >> 8) & 0xff) 124 #define XHCI_SUPPORTED_PROTOCOLS_1_OFFSET(x) (((x) >> 0) & 0xff) 125 126 127 128 // Port status Registers 129 // Section 5.4.8 130 #define XHCI_PORTSC(n) (0x400 + (0x10 * (n))) 131 #define PS_CCS (1 << 0) 132 #define PS_PED (1 << 1) 133 #define PS_OCA (1 << 3) 134 #define PS_PR (1 << 4) 135 #define PS_PP (1 << 9) 136 #define PS_SPEED_GET(x) (((x) >> 10) & 0xF) 137 #define PS_LWS (1 << 16) 138 #define PS_CSC (1 << 17) 139 #define PS_PEC (1 << 18) 140 #define PS_WRC (1 << 19) 141 #define PS_OCC (1 << 20) 142 #define PS_PRC (1 << 21) 143 #define PS_PLC (1 << 22) 144 #define PS_CEC (1 << 23) 145 #define PS_CAS (1 << 24) 146 #define PS_WCE (1 << 25) 147 #define PS_WDE (1 << 26) 148 #define PS_WPR (1 << 30) 149 150 #define PS_CLEAR 0x80FF00F7U 151 152 #define PS_PLS_MASK (0xf << 5) 153 #define PS_XDEV_U0 (0x0 << 5) 154 #define PS_XDEV_U3 (0x3 << 5) 155 156 157 // Completion Code 158 #define TRB_2_COMP_CODE_GET(x) (((x) >> 24) & 0xff) 159 #define COMP_INVALID 0 160 #define COMP_SUCCESS 1 161 #define COMP_DATA_BUFFER 2 162 #define COMP_BABBLE 3 163 #define COMP_USB_TRANSACTION 4 164 #define COMP_TRB 5 165 #define COMP_STALL 6 166 #define COMP_RESOURCE 7 167 #define COMP_BANDWIDTH 8 168 #define COMP_NO_SLOTS 9 169 #define COMP_INVALID_STREAM 10 170 #define COMP_SLOT_NOT_ENABLED 11 171 #define COMP_ENDPOINT_NOT_ENABLED 12 172 #define COMP_SHORT_PACKET 13 173 #define COMP_RING_UNDERRUN 14 174 #define COMP_RING_OVERRUN 15 175 #define COMP_VF_RING_FULL 16 176 #define COMP_PARAMETER 17 177 #define COMP_BANDWIDTH_OVERRUN 18 178 #define COMP_CONTEXT_STATE 19 179 #define COMP_NO_PING_RESPONSE 20 180 #define COMP_EVENT_RING_FULL 21 181 #define COMP_INCOMPATIBLE_DEVICE 22 182 #define COMP_MISSED_SERVICE 23 183 #define COMP_COMMAND_RING_STOPPED 24 184 #define COMP_COMMAND_ABORTED 25 185 #define COMP_STOPPED 26 186 #define COMP_LENGTH_INVALID 27 187 #define COMP_MAX_EXIT_LATENCY 29 188 #define COMP_ISOC_OVERRUN 31 189 #define COMP_EVENT_LOST 32 190 #define COMP_UNDEFINED 33 191 #define COMP_INVALID_STREAM_ID 34 192 #define COMP_SECONDARY_BANDWIDTH 35 193 #define COMP_SPLIT_TRANSACTION 36 194 195 #define TRB_2_TD_SIZE(x) (((x) & 0x1F) << 17) 196 #define TRB_2_TD_SIZE_GET(x) (((x) >> 17) & 0x1F) 197 #define TRB_2_REM(x) ((x) & 0xFFFFFF) 198 #define TRB_2_REM_GET(x) ((x) & 0xFFFFFF) 199 #define TRB_2_BYTES(x) ((x) & 0x1FFFF) 200 #define TRB_2_BYTES_GET(x) ((x) & 0x1FFFF) 201 #define TRB_2_IRQ(x) (((x) & 0x3FF) << 22) 202 #define TRB_2_IRQ_GET(x) (((x) >> 22) & 0x3FF) 203 #define TRB_2_STREAM(x) (((x) & 0xFF) << 16) 204 #define TRB_2_STREAM_GET(x) (((x) >> 16) & 0xFF) 205 206 #define TRB_3_TYPE(x) (((x) & 0x3F) << 10) 207 #define TRB_3_TYPE_GET(x) (((x) >> 10) & 0x3F) 208 // TRB Type (table 131) 209 #define TRB_TYPE_NORMAL 1 210 #define TRB_TYPE_SETUP_STAGE 2 211 #define TRB_TYPE_DATA_STAGE 3 212 #define TRB_TYPE_STATUS_STAGE 4 213 #define TRB_TYPE_ISOCH 5 214 #define TRB_TYPE_LINK 6 215 #define TRB_TYPE_EVENT_DATA 7 216 #define TRB_TYPE_TR_NOOP 8 217 // commands 218 #define TRB_TYPE_ENABLE_SLOT 9 219 #define TRB_TYPE_DISABLE_SLOT 10 220 #define TRB_TYPE_ADDRESS_DEVICE 11 221 #define TRB_TYPE_CONFIGURE_ENDPOINT 12 222 #define TRB_TYPE_EVALUATE_CONTEXT 13 223 #define TRB_TYPE_RESET_ENDPOINT 14 224 #define TRB_TYPE_STOP_ENDPOINT 15 225 #define TRB_TYPE_SET_TR_DEQUEUE 16 226 #define TRB_TYPE_RESET_DEVICE 17 227 #define TRB_TYPE_FORCE_EVENT 18 228 #define TRB_TYPE_NEGOCIATE_BW 19 229 #define TRB_TYPE_SET_LATENCY_TOLERANCE 20 230 #define TRB_TYPE_GET_PORT_BW 21 231 #define TRB_TYPE_FORCE_HEADER 22 232 #define TRB_TYPE_CMD_NOOP 23 233 // events 234 #define TRB_TYPE_TRANSFER 32 235 #define TRB_TYPE_COMMAND_COMPLETION 33 236 #define TRB_TYPE_PORT_STATUS_CHANGE 34 237 #define TRB_TYPE_BANDWIDTH_REQUEST 35 238 #define TRB_TYPE_DOORBELL 36 239 #define TRB_TYPE_HOST_CONTROLLER 37 240 #define TRB_TYPE_DEVICE_NOTIFICATION 38 241 #define TRB_TYPE_MFINDEX_WRAP 39 242 // vendor 243 #define TRB_TYPE_NEC_COMMAND_COMPLETION 48 244 #define TRB_TYPE_NEC_GET_FIRMWARE_REV 49 245 246 #define TRB_3_CYCLE_BIT (1U << 0) 247 #define TRB_3_TC_BIT (1U << 1) 248 #define TRB_3_ENT_BIT (1U << 1) 249 #define TRB_3_ISP_BIT (1U << 2) 250 #define TRB_3_NSNOOP_BIT (1U << 3) 251 #define TRB_3_CHAIN_BIT (1U << 4) 252 #define TRB_3_IOC_BIT (1U << 5) 253 #define TRB_3_IDT_BIT (1U << 6) 254 #define TRB_3_BEI_BIT (1U << 9) 255 #define TRB_3_DCEP_BIT (1U << 9) 256 #define TRB_3_PRSV_BIT (1U << 9) 257 #define TRB_3_BSR_BIT (1U << 9) 258 #define TRB_3_TRT_MASK (3U << 16) 259 #define TRB_3_DIR_IN (1U << 16) 260 #define TRB_3_TRT_OUT (2U << 16) 261 #define TRB_3_TRT_IN (3U << 16) 262 #define TRB_3_SUSPEND_ENDPOINT_BIT (1U << 23) 263 #define TRB_3_ISO_SIA_BIT (1U << 31) 264 265 #define TRB_3_TBC(x) (((x) & 0x3) << 7) 266 #define TRB_3_TBC_GET(x) (((x) >> 7) & 0x3) 267 #define TRB_3_TLBPC(x) (((x) & 0xf) << 16) 268 #define TRB_3_TLBPC_GET(x) (((x) >> 16) & 0xf) 269 #define TRB_3_ENDPOINT(x) (((x) & 0xf) << 16) 270 #define TRB_3_ENDPOINT_GET(x) (((x) >> 16) & 0xf) 271 #define TRB_3_FRID(x) (((x) & 0x7ff) << 20) 272 #define TRB_3_FRID_GET(x) (((x) >> 20) & 0x7ff) 273 #define TRB_3_SLOT(x) (((x) & 0xff) << 24) 274 #define TRB_3_SLOT_GET(x) (((x) >> 24) & 0xff) 275 276 277 #define XHCI_MAX_EVENTS (16 * 13) 278 #define XHCI_MAX_COMMANDS (16 * 1) 279 #define XHCI_MAX_SLOTS 255 280 #define XHCI_MAX_PORTS 127 281 #define XHCI_MAX_ENDPOINTS 32 282 #define XHCI_MAX_SCRATCHPADS 32 283 #define XHCI_MAX_DEVICES 128 284 #define XHCI_MAX_TRANSFERS 8 285 #define XHCI_MAX_TRBS_PER_TD 18 286 287 288 struct xhci_trb { 289 uint64 qwtrb0; 290 uint32 dwtrb2; 291 uint32 dwtrb3; 292 } __attribute__((__aligned__(4))); 293 294 295 struct xhci_segment { 296 xhci_trb * trbs; 297 xhci_segment * next; 298 }; 299 300 301 struct xhci_ring { 302 xhci_segment * first_seg; 303 xhci_trb * enqueue; 304 xhci_trb * dequeue; 305 }; 306 307 308 // Section 6.5 309 struct xhci_erst_element { 310 uint64 rs_addr; 311 uint32 rs_size; 312 uint32 rsvdz; 313 } __attribute__((__aligned__(64))); 314 315 316 struct xhci_device_context_array { 317 uint64 baseAddress[XHCI_MAX_SLOTS]; 318 struct { 319 uint64 padding; 320 } __attribute__((__aligned__(64))); 321 uint64 scratchpad[XHCI_MAX_SCRATCHPADS]; 322 }; 323 324 325 struct xhci_slot_ctx { 326 uint32 dwslot0; 327 uint32 dwslot1; 328 uint32 dwslot2; 329 uint32 dwslot3; 330 uint32 reserved[4]; 331 }; 332 333 #define SLOT_0_ROUTE(x) ((x) & 0xFFFFF) 334 #define SLOT_0_ROUTE_GET(x) ((x) & 0xFFFFF) 335 #define SLOT_0_SPEED(x) (((x) & 0xF) << 20) 336 #define SLOT_0_SPEED_GET(x) (((x) >> 20) & 0xF) 337 #define SLOT_0_MTT_BIT (1U << 25) 338 #define SLOT_0_HUB_BIT (1U << 26) 339 #define SLOT_0_NUM_ENTRIES(x) (((x) & 0x1F) << 27) 340 #define SLOT_0_NUM_ENTRIES_GET(x) (((x) >> 27) & 0x1F) 341 342 #define SLOT_1_MAX_EXIT_LATENCY(x) ((x) & 0xFFFF) 343 #define SLOT_1_MAX_EXIT_LATENCY_GET(x) ((x) & 0xFFFF) 344 #define SLOT_1_RH_PORT(x) (((x) & 0xFF) << 16) 345 #define SLOT_1_RH_PORT_GET(x) (((x) >> 16) & 0xFF) 346 #define SLOT_1_NUM_PORTS(x) (((x) & 0xFF) << 24) 347 #define SLOT_1_NUM_PORTS_GET(x) (((x) >> 24) & 0xFF) 348 349 #define SLOT_2_TT_HUB_SLOT(x) ((x) & 0xFF) 350 #define SLOT_2_TT_HUB_SLOT_GET(x) ((x) & 0xFF) 351 #define SLOT_2_PORT_NUM(x) (((x) & 0xFF) << 8) 352 #define SLOT_2_PORT_NUM_GET(x) (((x) >> 8) & 0xFF) 353 #define SLOT_2_TT_TIME(x) (((x) & 0x3) << 16) 354 #define SLOT_2_TT_TIME_GET(x) (((x) >> 16) & 0x3) 355 #define SLOT_2_IRQ_TARGET(x) (((x) & 0x7F) << 22) 356 #define SLOT_2_IRQ_TARGET_GET(x) (((x) >> 22) & 0x7F) 357 358 #define SLOT_3_DEVICE_ADDRESS(x) ((x) & 0xFF) 359 #define SLOT_3_DEVICE_ADDRESS_GET(x) ((x) & 0xFF) 360 #define SLOT_3_SLOT_STATE(x) (((x) & 0x1F) << 27) 361 #define SLOT_3_SLOT_STATE_GET(x) (((x) >> 27) & 0x1F) 362 363 #define HUB_TTT_GET(x) (((x) >> 5) & 0x3) 364 365 struct xhci_endpoint_ctx { 366 uint32 dwendpoint0; 367 uint32 dwendpoint1; 368 uint64 qwendpoint2; 369 uint32 dwendpoint4; 370 uint32 reserved[3]; 371 }; 372 373 374 #define ENDPOINT_0_STATE(x) ((x) & 0x3) 375 #define ENDPOINT_0_STATE_GET(x) ((x) & 0x3) 376 #define ENDPOINT_0_MULT(x) (((x) & 0x3) << 8) 377 #define ENDPOINT_0_MULT_GET(x) (((x) >> 8) & 0x3) 378 #define ENDPOINT_0_MAXPSTREAMS(x) (((x) & 0x1F) << 10) 379 #define ENDPOINT_0_MAXPSTREAMS_GET(x) (((x) >> 10) & 0x1F) 380 #define ENDPOINT_0_LSA_BIT (1U << 15) 381 #define ENDPOINT_0_INTERVAL(x) (((x) & 0xFF) << 16) 382 #define ENDPOINT_0_INTERVAL_GET(x) (((x) >> 16) & 0xFF) 383 384 #define ENDPOINT_1_CERR(x) (((x) & 0x3) << 1) 385 #define ENDPOINT_1_CERR_GET(x) (((x) >> 1) & 0x3) 386 #define ENDPOINT_1_EPTYPE(x) (((x) & 0x7) << 3) 387 #define ENDPOINT_1_EPTYPE_GET(x) (((x) >> 3) & 0x7) 388 #define ENDPOINT_1_HID_BIT (1U << 7) 389 #define ENDPOINT_1_MAXBURST(x) (((x) & 0xFF) << 8) 390 #define ENDPOINT_1_MAXBURST_GET(x) (((x) >> 8) & 0xFF) 391 #define ENDPOINT_1_MAXPACKETSIZE(x) (((x) & 0xFFFF) << 16) 392 #define ENDPOINT_1_MAXPACKETSIZE_GET(x) (((x) >> 16) & 0xFFFF) 393 394 #define ENDPOINT_2_DCS_BIT (1U << 0) 395 396 #define ENDPOINT_4_AVGTRBLENGTH(x) ((x) & 0xFFFF) 397 #define ENDPOINT_4_AVGTRBLENGTH_GET(x) ((x) & 0xFFFF) 398 #define ENDPOINT_4_MAXESITPAYLOAD(x) (((x) & 0xFFFF) << 16) 399 #define ENDPOINT_4_MAXESITPAYLOAD_GET(x) (((x) >> 16) & 0xFFFF) 400 401 402 struct xhci_stream_ctx { 403 uint64 qwstream0; 404 uint32 reserved[2]; 405 }; 406 407 408 struct xhci_input_ctx { 409 uint32 dropFlags; 410 uint32 addFlags; 411 uint32 reserved[6]; 412 }; 413 414 415 struct xhci_input_device_ctx { 416 struct xhci_input_ctx input; 417 struct xhci_slot_ctx slot; 418 struct xhci_endpoint_ctx endpoints[XHCI_MAX_ENDPOINTS - 1]; 419 }; 420 421 422 struct xhci_device_ctx { 423 struct xhci_slot_ctx slot; 424 struct xhci_endpoint_ctx endpoints[XHCI_MAX_ENDPOINTS - 1]; 425 }; 426 427 428 #define XHCI_ENDPOINT_ID(pipe) (2 * pipe->EndpointAddress() \ 429 + (pipe->Direction() != Pipe::Out ? 1 : 0)) 430 431 432 #endif // !XHCI_HARDWARE_H 433