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