1 /* SPDX-License-Identifier: GPL-2.0 */ 2 /* 3 * Thunderbolt driver - Port/Switch config area registers 4 * 5 * Every thunderbolt device consists (logically) of a switch with multiple 6 * ports. Every port contains up to four config regions (HOPS, PORT, SWITCH, 7 * COUNTERS) which are used to configure the device. 8 * 9 * Copyright (c) 2014 Andreas Noever <andreas.noever@gmail.com> 10 * Copyright (C) 2018, Intel Corporation 11 */ 12 13 #ifndef _TB_REGS 14 #define _TB_REGS 15 16 #include <linux/types.h> 17 18 19 #define TB_ROUTE_SHIFT 8 /* number of bits in a port entry of a route */ 20 21 22 /* 23 * TODO: should be 63? But we do not know how to receive frames larger than 256 24 * bytes at the frame level. (header + checksum = 16, 60*4 = 240) 25 */ 26 #define TB_MAX_CONFIG_RW_LENGTH 60 27 28 enum tb_switch_cap { 29 TB_SWITCH_CAP_TMU = 0x03, 30 TB_SWITCH_CAP_VSE = 0x05, 31 }; 32 33 enum tb_switch_vse_cap { 34 TB_VSE_CAP_PLUG_EVENTS = 0x01, /* also EEPROM */ 35 TB_VSE_CAP_TIME2 = 0x03, 36 TB_VSE_CAP_IECS = 0x04, 37 TB_VSE_CAP_LINK_CONTROLLER = 0x06, /* also IECS */ 38 }; 39 40 enum tb_port_cap { 41 TB_PORT_CAP_PHY = 0x01, 42 TB_PORT_CAP_POWER = 0x02, 43 TB_PORT_CAP_TIME1 = 0x03, 44 TB_PORT_CAP_ADAP = 0x04, 45 TB_PORT_CAP_VSE = 0x05, 46 TB_PORT_CAP_USB4 = 0x06, 47 }; 48 49 enum tb_port_state { 50 TB_PORT_DISABLED = 0, /* tb_cap_phy.disable == 1 */ 51 TB_PORT_CONNECTING = 1, /* retry */ 52 TB_PORT_UP = 2, 53 TB_PORT_UNPLUGGED = 7, 54 }; 55 56 /* capability headers */ 57 58 struct tb_cap_basic { 59 u8 next; 60 /* enum tb_cap cap:8; prevent "narrower than values of its type" */ 61 u8 cap; /* if cap == 0x05 then we have a extended capability */ 62 } __packed; 63 64 /** 65 * struct tb_cap_extended_short - Switch extended short capability 66 * @next: Pointer to the next capability. If @next and @length are zero 67 * then we have a long cap. 68 * @cap: Base capability ID (see &enum tb_switch_cap) 69 * @vsec_id: Vendor specific capability ID (see &enum switch_vse_cap) 70 * @length: Length of this capability 71 */ 72 struct tb_cap_extended_short { 73 u8 next; 74 u8 cap; 75 u8 vsec_id; 76 u8 length; 77 } __packed; 78 79 /** 80 * struct tb_cap_extended_long - Switch extended long capability 81 * @zero1: This field should be zero 82 * @cap: Base capability ID (see &enum tb_switch_cap) 83 * @vsec_id: Vendor specific capability ID (see &enum switch_vse_cap) 84 * @zero2: This field should be zero 85 * @next: Pointer to the next capability 86 * @length: Length of this capability 87 */ 88 struct tb_cap_extended_long { 89 u8 zero1; 90 u8 cap; 91 u8 vsec_id; 92 u8 zero2; 93 u16 next; 94 u16 length; 95 } __packed; 96 97 /** 98 * struct tb_cap_any - Structure capable of hold every capability 99 * @basic: Basic capability 100 * @extended_short: Vendor specific capability 101 * @extended_long: Vendor specific extended capability 102 */ 103 struct tb_cap_any { 104 union { 105 struct tb_cap_basic basic; 106 struct tb_cap_extended_short extended_short; 107 struct tb_cap_extended_long extended_long; 108 }; 109 } __packed; 110 111 /* capabilities */ 112 113 struct tb_cap_link_controller { 114 struct tb_cap_extended_long cap_header; 115 u32 count:4; /* number of link controllers */ 116 u32 unknown1:4; 117 u32 base_offset:8; /* 118 * offset (into this capability) of the configuration 119 * area of the first link controller 120 */ 121 u32 length:12; /* link controller configuration area length */ 122 u32 unknown2:4; /* TODO check that length is correct */ 123 } __packed; 124 125 struct tb_cap_phy { 126 struct tb_cap_basic cap_header; 127 u32 unknown1:16; 128 u32 unknown2:14; 129 bool disable:1; 130 u32 unknown3:11; 131 enum tb_port_state state:4; 132 u32 unknown4:2; 133 } __packed; 134 135 struct tb_eeprom_ctl { 136 bool clock:1; /* send pulse to transfer one bit */ 137 bool access_low:1; /* set to 0 before access */ 138 bool data_out:1; /* to eeprom */ 139 bool data_in:1; /* from eeprom */ 140 bool access_high:1; /* set to 1 before access */ 141 bool not_present:1; /* should be 0 */ 142 bool unknown1:1; 143 bool present:1; /* should be 1 */ 144 u32 unknown2:24; 145 } __packed; 146 147 struct tb_cap_plug_events { 148 struct tb_cap_extended_short cap_header; 149 u32 __unknown1:2; 150 u32 plug_events:5; 151 u32 __unknown2:25; 152 u32 __unknown3; 153 u32 __unknown4; 154 struct tb_eeprom_ctl eeprom_ctl; 155 u32 __unknown5[7]; 156 u32 drom_offset; /* 32 bit register, but eeprom addresses are 16 bit */ 157 } __packed; 158 159 /* device headers */ 160 161 /* Present on port 0 in TB_CFG_SWITCH at address zero. */ 162 struct tb_regs_switch_header { 163 /* DWORD 0 */ 164 u16 vendor_id; 165 u16 device_id; 166 /* DWORD 1 */ 167 u32 first_cap_offset:8; 168 u32 upstream_port_number:6; 169 u32 max_port_number:6; 170 u32 depth:3; 171 u32 __unknown1:1; 172 u32 revision:8; 173 /* DWORD 2 */ 174 u32 route_lo; 175 /* DWORD 3 */ 176 u32 route_hi:31; 177 bool enabled:1; 178 /* DWORD 4 */ 179 u32 plug_events_delay:8; /* 180 * RW, pause between plug events in 181 * milliseconds. Writing 0x00 is interpreted 182 * as 255ms. 183 */ 184 u32 cmuv:8; 185 u32 __unknown4:8; 186 u32 thunderbolt_version:8; 187 } __packed; 188 189 /* USB4 version 1.0 */ 190 #define USB4_VERSION_1_0 0x20 191 192 #define ROUTER_CS_1 0x01 193 #define ROUTER_CS_4 0x04 194 #define ROUTER_CS_5 0x05 195 #define ROUTER_CS_5_SLP BIT(0) 196 #define ROUTER_CS_5_WOP BIT(1) 197 #define ROUTER_CS_5_WOU BIT(2) 198 #define ROUTER_CS_5_C3S BIT(23) 199 #define ROUTER_CS_5_PTO BIT(24) 200 #define ROUTER_CS_5_UTO BIT(25) 201 #define ROUTER_CS_5_HCO BIT(26) 202 #define ROUTER_CS_5_CV BIT(31) 203 #define ROUTER_CS_6 0x06 204 #define ROUTER_CS_6_SLPR BIT(0) 205 #define ROUTER_CS_6_TNS BIT(1) 206 #define ROUTER_CS_6_WOPS BIT(2) 207 #define ROUTER_CS_6_WOUS BIT(3) 208 #define ROUTER_CS_6_HCI BIT(18) 209 #define ROUTER_CS_6_CR BIT(25) 210 #define ROUTER_CS_7 0x07 211 #define ROUTER_CS_9 0x09 212 #define ROUTER_CS_25 0x19 213 #define ROUTER_CS_26 0x1a 214 #define ROUTER_CS_26_OPCODE_MASK GENMASK(15, 0) 215 #define ROUTER_CS_26_STATUS_MASK GENMASK(29, 24) 216 #define ROUTER_CS_26_STATUS_SHIFT 24 217 #define ROUTER_CS_26_ONS BIT(30) 218 #define ROUTER_CS_26_OV BIT(31) 219 220 /* USB4 router operations opcodes */ 221 enum usb4_switch_op { 222 USB4_SWITCH_OP_QUERY_DP_RESOURCE = 0x10, 223 USB4_SWITCH_OP_ALLOC_DP_RESOURCE = 0x11, 224 USB4_SWITCH_OP_DEALLOC_DP_RESOURCE = 0x12, 225 USB4_SWITCH_OP_NVM_WRITE = 0x20, 226 USB4_SWITCH_OP_NVM_AUTH = 0x21, 227 USB4_SWITCH_OP_NVM_READ = 0x22, 228 USB4_SWITCH_OP_NVM_SET_OFFSET = 0x23, 229 USB4_SWITCH_OP_DROM_READ = 0x24, 230 USB4_SWITCH_OP_NVM_SECTOR_SIZE = 0x25, 231 }; 232 233 /* Router TMU configuration */ 234 #define TMU_RTR_CS_0 0x00 235 #define TMU_RTR_CS_0_TD BIT(27) 236 #define TMU_RTR_CS_0_UCAP BIT(30) 237 #define TMU_RTR_CS_1 0x01 238 #define TMU_RTR_CS_1_LOCAL_TIME_NS_MASK GENMASK(31, 16) 239 #define TMU_RTR_CS_1_LOCAL_TIME_NS_SHIFT 16 240 #define TMU_RTR_CS_2 0x02 241 #define TMU_RTR_CS_3 0x03 242 #define TMU_RTR_CS_3_LOCAL_TIME_NS_MASK GENMASK(15, 0) 243 #define TMU_RTR_CS_3_TS_PACKET_INTERVAL_MASK GENMASK(31, 16) 244 #define TMU_RTR_CS_3_TS_PACKET_INTERVAL_SHIFT 16 245 #define TMU_RTR_CS_22 0x16 246 #define TMU_RTR_CS_24 0x18 247 248 enum tb_port_type { 249 TB_TYPE_INACTIVE = 0x000000, 250 TB_TYPE_PORT = 0x000001, 251 TB_TYPE_NHI = 0x000002, 252 /* TB_TYPE_ETHERNET = 0x020000, lower order bits are not known */ 253 /* TB_TYPE_SATA = 0x080000, lower order bits are not known */ 254 TB_TYPE_DP_HDMI_IN = 0x0e0101, 255 TB_TYPE_DP_HDMI_OUT = 0x0e0102, 256 TB_TYPE_PCIE_DOWN = 0x100101, 257 TB_TYPE_PCIE_UP = 0x100102, 258 TB_TYPE_USB3_DOWN = 0x200101, 259 TB_TYPE_USB3_UP = 0x200102, 260 }; 261 262 /* Present on every port in TB_CF_PORT at address zero. */ 263 struct tb_regs_port_header { 264 /* DWORD 0 */ 265 u16 vendor_id; 266 u16 device_id; 267 /* DWORD 1 */ 268 u32 first_cap_offset:8; 269 u32 max_counters:11; 270 u32 counters_support:1; 271 u32 __unknown1:4; 272 u32 revision:8; 273 /* DWORD 2 */ 274 enum tb_port_type type:24; 275 u32 thunderbolt_version:8; 276 /* DWORD 3 */ 277 u32 __unknown2:20; 278 u32 port_number:6; 279 u32 __unknown3:6; 280 /* DWORD 4 */ 281 u32 nfc_credits; 282 /* DWORD 5 */ 283 u32 max_in_hop_id:11; 284 u32 max_out_hop_id:11; 285 u32 __unknown4:10; 286 /* DWORD 6 */ 287 u32 __unknown5; 288 /* DWORD 7 */ 289 u32 __unknown6; 290 291 } __packed; 292 293 /* Basic adapter configuration registers */ 294 #define ADP_CS_4 0x04 295 #define ADP_CS_4_NFC_BUFFERS_MASK GENMASK(9, 0) 296 #define ADP_CS_4_TOTAL_BUFFERS_MASK GENMASK(29, 20) 297 #define ADP_CS_4_TOTAL_BUFFERS_SHIFT 20 298 #define ADP_CS_4_LCK BIT(31) 299 #define ADP_CS_5 0x05 300 #define ADP_CS_5_LCA_MASK GENMASK(28, 22) 301 #define ADP_CS_5_LCA_SHIFT 22 302 303 /* TMU adapter registers */ 304 #define TMU_ADP_CS_3 0x03 305 #define TMU_ADP_CS_3_UDM BIT(29) 306 307 /* Lane adapter registers */ 308 #define LANE_ADP_CS_0 0x00 309 #define LANE_ADP_CS_0_SUPPORTED_WIDTH_MASK GENMASK(25, 20) 310 #define LANE_ADP_CS_0_SUPPORTED_WIDTH_SHIFT 20 311 #define LANE_ADP_CS_1 0x01 312 #define LANE_ADP_CS_1_TARGET_WIDTH_MASK GENMASK(9, 4) 313 #define LANE_ADP_CS_1_TARGET_WIDTH_SHIFT 4 314 #define LANE_ADP_CS_1_TARGET_WIDTH_SINGLE 0x1 315 #define LANE_ADP_CS_1_TARGET_WIDTH_DUAL 0x3 316 #define LANE_ADP_CS_1_LD BIT(14) 317 #define LANE_ADP_CS_1_LB BIT(15) 318 #define LANE_ADP_CS_1_CURRENT_SPEED_MASK GENMASK(19, 16) 319 #define LANE_ADP_CS_1_CURRENT_SPEED_SHIFT 16 320 #define LANE_ADP_CS_1_CURRENT_SPEED_GEN2 0x8 321 #define LANE_ADP_CS_1_CURRENT_SPEED_GEN3 0x4 322 #define LANE_ADP_CS_1_CURRENT_WIDTH_MASK GENMASK(25, 20) 323 #define LANE_ADP_CS_1_CURRENT_WIDTH_SHIFT 20 324 325 /* USB4 port registers */ 326 #define PORT_CS_1 0x01 327 #define PORT_CS_1_LENGTH_SHIFT 8 328 #define PORT_CS_1_TARGET_MASK GENMASK(18, 16) 329 #define PORT_CS_1_TARGET_SHIFT 16 330 #define PORT_CS_1_RETIMER_INDEX_SHIFT 20 331 #define PORT_CS_1_WNR_WRITE BIT(24) 332 #define PORT_CS_1_NR BIT(25) 333 #define PORT_CS_1_RC BIT(26) 334 #define PORT_CS_1_PND BIT(31) 335 #define PORT_CS_2 0x02 336 #define PORT_CS_18 0x12 337 #define PORT_CS_18_BE BIT(8) 338 #define PORT_CS_18_TCM BIT(9) 339 #define PORT_CS_18_WOU4S BIT(18) 340 #define PORT_CS_19 0x13 341 #define PORT_CS_19_PC BIT(3) 342 #define PORT_CS_19_PID BIT(4) 343 #define PORT_CS_19_WOC BIT(16) 344 #define PORT_CS_19_WOD BIT(17) 345 #define PORT_CS_19_WOU4 BIT(18) 346 347 /* Display Port adapter registers */ 348 #define ADP_DP_CS_0 0x00 349 #define ADP_DP_CS_0_VIDEO_HOPID_MASK GENMASK(26, 16) 350 #define ADP_DP_CS_0_VIDEO_HOPID_SHIFT 16 351 #define ADP_DP_CS_0_AE BIT(30) 352 #define ADP_DP_CS_0_VE BIT(31) 353 #define ADP_DP_CS_1_AUX_TX_HOPID_MASK GENMASK(10, 0) 354 #define ADP_DP_CS_1_AUX_RX_HOPID_MASK GENMASK(21, 11) 355 #define ADP_DP_CS_1_AUX_RX_HOPID_SHIFT 11 356 #define ADP_DP_CS_2 0x02 357 #define ADP_DP_CS_2_HDP BIT(6) 358 #define ADP_DP_CS_3 0x03 359 #define ADP_DP_CS_3_HDPC BIT(9) 360 #define DP_LOCAL_CAP 0x04 361 #define DP_REMOTE_CAP 0x05 362 #define DP_STATUS_CTRL 0x06 363 #define DP_STATUS_CTRL_CMHS BIT(25) 364 #define DP_STATUS_CTRL_UF BIT(26) 365 #define DP_COMMON_CAP 0x07 366 /* 367 * DP_COMMON_CAP offsets work also for DP_LOCAL_CAP and DP_REMOTE_CAP 368 * with exception of DPRX done. 369 */ 370 #define DP_COMMON_CAP_RATE_MASK GENMASK(11, 8) 371 #define DP_COMMON_CAP_RATE_SHIFT 8 372 #define DP_COMMON_CAP_RATE_RBR 0x0 373 #define DP_COMMON_CAP_RATE_HBR 0x1 374 #define DP_COMMON_CAP_RATE_HBR2 0x2 375 #define DP_COMMON_CAP_RATE_HBR3 0x3 376 #define DP_COMMON_CAP_LANES_MASK GENMASK(14, 12) 377 #define DP_COMMON_CAP_LANES_SHIFT 12 378 #define DP_COMMON_CAP_1_LANE 0x0 379 #define DP_COMMON_CAP_2_LANES 0x1 380 #define DP_COMMON_CAP_4_LANES 0x2 381 #define DP_COMMON_CAP_DPRX_DONE BIT(31) 382 383 /* PCIe adapter registers */ 384 #define ADP_PCIE_CS_0 0x00 385 #define ADP_PCIE_CS_0_PE BIT(31) 386 387 /* USB adapter registers */ 388 #define ADP_USB3_CS_0 0x00 389 #define ADP_USB3_CS_0_V BIT(30) 390 #define ADP_USB3_CS_0_PE BIT(31) 391 #define ADP_USB3_CS_1 0x01 392 #define ADP_USB3_CS_1_CUBW_MASK GENMASK(11, 0) 393 #define ADP_USB3_CS_1_CDBW_MASK GENMASK(23, 12) 394 #define ADP_USB3_CS_1_CDBW_SHIFT 12 395 #define ADP_USB3_CS_1_HCA BIT(31) 396 #define ADP_USB3_CS_2 0x02 397 #define ADP_USB3_CS_2_AUBW_MASK GENMASK(11, 0) 398 #define ADP_USB3_CS_2_ADBW_MASK GENMASK(23, 12) 399 #define ADP_USB3_CS_2_ADBW_SHIFT 12 400 #define ADP_USB3_CS_2_CMR BIT(31) 401 #define ADP_USB3_CS_3 0x03 402 #define ADP_USB3_CS_3_SCALE_MASK GENMASK(5, 0) 403 #define ADP_USB3_CS_4 0x04 404 #define ADP_USB3_CS_4_ALR_MASK GENMASK(6, 0) 405 #define ADP_USB3_CS_4_ALR_20G 0x1 406 #define ADP_USB3_CS_4_ULV BIT(7) 407 #define ADP_USB3_CS_4_MSLR_MASK GENMASK(18, 12) 408 #define ADP_USB3_CS_4_MSLR_SHIFT 12 409 #define ADP_USB3_CS_4_MSLR_20G 0x1 410 411 /* Hop register from TB_CFG_HOPS. 8 byte per entry. */ 412 struct tb_regs_hop { 413 /* DWORD 0 */ 414 u32 next_hop:11; /* 415 * hop to take after sending the packet through 416 * out_port (on the incoming port of the next switch) 417 */ 418 u32 out_port:6; /* next port of the path (on the same switch) */ 419 u32 initial_credits:8; 420 u32 unknown1:6; /* set to zero */ 421 bool enable:1; 422 423 /* DWORD 1 */ 424 u32 weight:4; 425 u32 unknown2:4; /* set to zero */ 426 u32 priority:3; 427 bool drop_packages:1; 428 u32 counter:11; /* index into TB_CFG_COUNTERS on this port */ 429 bool counter_enable:1; 430 bool ingress_fc:1; 431 bool egress_fc:1; 432 bool ingress_shared_buffer:1; 433 bool egress_shared_buffer:1; 434 bool pending:1; 435 u32 unknown3:3; /* set to zero */ 436 } __packed; 437 438 /* Common link controller registers */ 439 #define TB_LC_DESC 0x02 440 #define TB_LC_DESC_NLC_MASK GENMASK(3, 0) 441 #define TB_LC_DESC_SIZE_SHIFT 8 442 #define TB_LC_DESC_SIZE_MASK GENMASK(15, 8) 443 #define TB_LC_DESC_PORT_SIZE_SHIFT 16 444 #define TB_LC_DESC_PORT_SIZE_MASK GENMASK(27, 16) 445 #define TB_LC_FUSE 0x03 446 #define TB_LC_SNK_ALLOCATION 0x10 447 #define TB_LC_SNK_ALLOCATION_SNK0_MASK GENMASK(3, 0) 448 #define TB_LC_SNK_ALLOCATION_SNK0_CM 0x1 449 #define TB_LC_SNK_ALLOCATION_SNK1_SHIFT 4 450 #define TB_LC_SNK_ALLOCATION_SNK1_MASK GENMASK(7, 4) 451 #define TB_LC_SNK_ALLOCATION_SNK1_CM 0x1 452 #define TB_LC_POWER 0x740 453 454 /* Link controller registers */ 455 #define TB_LC_PORT_ATTR 0x8d 456 #define TB_LC_PORT_ATTR_BE BIT(12) 457 458 #define TB_LC_SX_CTRL 0x96 459 #define TB_LC_SX_CTRL_WOC BIT(1) 460 #define TB_LC_SX_CTRL_WOD BIT(2) 461 #define TB_LC_SX_CTRL_WOU4 BIT(5) 462 #define TB_LC_SX_CTRL_WOP BIT(6) 463 #define TB_LC_SX_CTRL_L1C BIT(16) 464 #define TB_LC_SX_CTRL_L1D BIT(17) 465 #define TB_LC_SX_CTRL_L2C BIT(20) 466 #define TB_LC_SX_CTRL_L2D BIT(21) 467 #define TB_LC_SX_CTRL_SLI BIT(29) 468 #define TB_LC_SX_CTRL_UPSTREAM BIT(30) 469 #define TB_LC_SX_CTRL_SLP BIT(31) 470 471 #endif 472