xref: /linux/drivers/thunderbolt/tb_regs.h (revision 0e2b2a76278153d1ac312b0691cb65dabb9aef3e)
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_CP_LP		= 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_TX_CL0S		= 3,
54 	TB_PORT_RX_CL0S		= 4,
55 	TB_PORT_CL1		= 5,
56 	TB_PORT_CL2		= 6,
57 	TB_PORT_UNPLUGGED	= 7,
58 };
59 
60 /* capability headers */
61 
62 struct tb_cap_basic {
63 	u8 next;
64 	/* enum tb_cap cap:8; prevent "narrower than values of its type" */
65 	u8 cap; /* if cap == 0x05 then we have a extended capability */
66 } __packed;
67 
68 /**
69  * struct tb_cap_extended_short - Switch extended short capability
70  * @next: Pointer to the next capability. If @next and @length are zero
71  *	  then we have a long cap.
72  * @cap: Base capability ID (see &enum tb_switch_cap)
73  * @vsec_id: Vendor specific capability ID (see &enum switch_vse_cap)
74  * @length: Length of this capability
75  */
76 struct tb_cap_extended_short {
77 	u8 next;
78 	u8 cap;
79 	u8 vsec_id;
80 	u8 length;
81 } __packed;
82 
83 /**
84  * struct tb_cap_extended_long - Switch extended long capability
85  * @zero1: This field should be zero
86  * @cap: Base capability ID (see &enum tb_switch_cap)
87  * @vsec_id: Vendor specific capability ID (see &enum switch_vse_cap)
88  * @zero2: This field should be zero
89  * @next: Pointer to the next capability
90  * @length: Length of this capability
91  */
92 struct tb_cap_extended_long {
93 	u8 zero1;
94 	u8 cap;
95 	u8 vsec_id;
96 	u8 zero2;
97 	u16 next;
98 	u16 length;
99 } __packed;
100 
101 /**
102  * struct tb_cap_any - Structure capable of hold every capability
103  * @basic: Basic capability
104  * @extended_short: Vendor specific capability
105  * @extended_long: Vendor specific extended capability
106  */
107 struct tb_cap_any {
108 	union {
109 		struct tb_cap_basic basic;
110 		struct tb_cap_extended_short extended_short;
111 		struct tb_cap_extended_long extended_long;
112 	};
113 } __packed;
114 
115 /* capabilities */
116 
117 struct tb_cap_link_controller {
118 	struct tb_cap_extended_long cap_header;
119 	u32 count:4; /* number of link controllers */
120 	u32 unknown1:4;
121 	u32 base_offset:8; /*
122 			    * offset (into this capability) of the configuration
123 			    * area of the first link controller
124 			    */
125 	u32 length:12; /* link controller configuration area length */
126 	u32 unknown2:4; /* TODO check that length is correct */
127 } __packed;
128 
129 struct tb_cap_phy {
130 	struct tb_cap_basic cap_header;
131 	u32 unknown1:16;
132 	u32 unknown2:14;
133 	bool disable:1;
134 	u32 unknown3:11;
135 	enum tb_port_state state:4;
136 	u32 unknown4:2;
137 } __packed;
138 
139 struct tb_eeprom_ctl {
140 	bool fl_sk:1; /* send pulse to transfer one bit */
141 	bool fl_cs:1; /* set to 0 before access */
142 	bool fl_di:1; /* to eeprom */
143 	bool fl_do:1; /* from eeprom */
144 	bool bit_banging_enable:1; /* set to 1 before access */
145 	bool not_present:1; /* should be 0 */
146 	bool unknown1:1;
147 	bool present:1; /* should be 1 */
148 	u32 unknown2:24;
149 } __packed;
150 
151 struct tb_cap_plug_events {
152 	struct tb_cap_extended_short cap_header;
153 	u32 __unknown1:2; /* VSC_CS_1 */
154 	u32 plug_events:5; /* VSC_CS_1 */
155 	u32 __unknown2:25; /* VSC_CS_1 */
156 	u32 vsc_cs_2;
157 	u32 vsc_cs_3;
158 	struct tb_eeprom_ctl eeprom_ctl;
159 	u32 __unknown5[7]; /* VSC_CS_5 -> VSC_CS_11 */
160 	u32 drom_offset; /* VSC_CS_12: 32 bit register, but eeprom addresses are 16 bit */
161 } __packed;
162 
163 /* device headers */
164 
165 /* Present on port 0 in TB_CFG_SWITCH at address zero. */
166 struct tb_regs_switch_header {
167 	/* DWORD 0 */
168 	u16 vendor_id;
169 	u16 device_id;
170 	/* DWORD 1 */
171 	u32 first_cap_offset:8;
172 	u32 upstream_port_number:6;
173 	u32 max_port_number:6;
174 	u32 depth:3;
175 	u32 __unknown1:1;
176 	u32 revision:8;
177 	/* DWORD 2 */
178 	u32 route_lo;
179 	/* DWORD 3 */
180 	u32 route_hi:31;
181 	bool enabled:1;
182 	/* DWORD 4 */
183 	u32 plug_events_delay:8; /*
184 				  * RW, pause between plug events in
185 				  * milliseconds. Writing 0x00 is interpreted
186 				  * as 255ms.
187 				  */
188 	u32 cmuv:8;
189 	u32 __unknown4:8;
190 	u32 thunderbolt_version:8;
191 } __packed;
192 
193 /* Used with the router thunderbolt_version */
194 #define USB4_VERSION_MAJOR_MASK			GENMASK(7, 5)
195 
196 #define ROUTER_CS_1				0x01
197 #define ROUTER_CS_4				0x04
198 /* Used with the router cmuv field */
199 #define ROUTER_CS_4_CMUV_V1			0x10
200 #define ROUTER_CS_4_CMUV_V2			0x20
201 #define ROUTER_CS_5				0x05
202 #define ROUTER_CS_5_SLP				BIT(0)
203 #define ROUTER_CS_5_WOP				BIT(1)
204 #define ROUTER_CS_5_WOU				BIT(2)
205 #define ROUTER_CS_5_WOD				BIT(3)
206 #define ROUTER_CS_5_C3S				BIT(23)
207 #define ROUTER_CS_5_PTO				BIT(24)
208 #define ROUTER_CS_5_UTO				BIT(25)
209 #define ROUTER_CS_5_HCO				BIT(26)
210 #define ROUTER_CS_5_CV				BIT(31)
211 #define ROUTER_CS_6				0x06
212 #define ROUTER_CS_6_SLPR			BIT(0)
213 #define ROUTER_CS_6_TNS				BIT(1)
214 #define ROUTER_CS_6_WOPS			BIT(2)
215 #define ROUTER_CS_6_WOUS			BIT(3)
216 #define ROUTER_CS_6_HCI				BIT(18)
217 #define ROUTER_CS_6_CR				BIT(25)
218 #define ROUTER_CS_7				0x07
219 #define ROUTER_CS_9				0x09
220 #define ROUTER_CS_25				0x19
221 #define ROUTER_CS_26				0x1a
222 #define ROUTER_CS_26_OPCODE_MASK		GENMASK(15, 0)
223 #define ROUTER_CS_26_STATUS_MASK		GENMASK(29, 24)
224 #define ROUTER_CS_26_STATUS_SHIFT		24
225 #define ROUTER_CS_26_ONS			BIT(30)
226 #define ROUTER_CS_26_OV				BIT(31)
227 
228 /* USB4 router operations opcodes */
229 enum usb4_switch_op {
230 	USB4_SWITCH_OP_QUERY_DP_RESOURCE = 0x10,
231 	USB4_SWITCH_OP_ALLOC_DP_RESOURCE = 0x11,
232 	USB4_SWITCH_OP_DEALLOC_DP_RESOURCE = 0x12,
233 	USB4_SWITCH_OP_NVM_WRITE = 0x20,
234 	USB4_SWITCH_OP_NVM_AUTH = 0x21,
235 	USB4_SWITCH_OP_NVM_READ = 0x22,
236 	USB4_SWITCH_OP_NVM_SET_OFFSET = 0x23,
237 	USB4_SWITCH_OP_DROM_READ = 0x24,
238 	USB4_SWITCH_OP_NVM_SECTOR_SIZE = 0x25,
239 	USB4_SWITCH_OP_BUFFER_ALLOC = 0x33,
240 };
241 
242 /* Router TMU configuration */
243 #define TMU_RTR_CS_0				0x00
244 #define TMU_RTR_CS_0_FREQ_WIND_MASK		GENMASK(26, 16)
245 #define TMU_RTR_CS_0_TD				BIT(27)
246 #define TMU_RTR_CS_0_UCAP			BIT(30)
247 #define TMU_RTR_CS_1				0x01
248 #define TMU_RTR_CS_1_LOCAL_TIME_NS_MASK		GENMASK(31, 16)
249 #define TMU_RTR_CS_1_LOCAL_TIME_NS_SHIFT	16
250 #define TMU_RTR_CS_2				0x02
251 #define TMU_RTR_CS_3				0x03
252 #define TMU_RTR_CS_3_LOCAL_TIME_NS_MASK		GENMASK(15, 0)
253 #define TMU_RTR_CS_3_TS_PACKET_INTERVAL_MASK	GENMASK(31, 16)
254 #define TMU_RTR_CS_3_TS_PACKET_INTERVAL_SHIFT	16
255 #define TMU_RTR_CS_15				0x0f
256 #define TMU_RTR_CS_15_FREQ_AVG_MASK		GENMASK(5, 0)
257 #define TMU_RTR_CS_15_DELAY_AVG_MASK		GENMASK(11, 6)
258 #define TMU_RTR_CS_15_OFFSET_AVG_MASK		GENMASK(17, 12)
259 #define TMU_RTR_CS_15_ERROR_AVG_MASK		GENMASK(23, 18)
260 #define TMU_RTR_CS_18				0x12
261 #define TMU_RTR_CS_18_DELTA_AVG_CONST_MASK	GENMASK(23, 16)
262 #define TMU_RTR_CS_22				0x16
263 #define TMU_RTR_CS_24				0x18
264 #define TMU_RTR_CS_25				0x19
265 
266 enum tb_port_type {
267 	TB_TYPE_INACTIVE	= 0x000000,
268 	TB_TYPE_PORT		= 0x000001,
269 	TB_TYPE_NHI		= 0x000002,
270 	/* TB_TYPE_ETHERNET	= 0x020000, lower order bits are not known */
271 	/* TB_TYPE_SATA		= 0x080000, lower order bits are not known */
272 	TB_TYPE_DP_HDMI_IN	= 0x0e0101,
273 	TB_TYPE_DP_HDMI_OUT	= 0x0e0102,
274 	TB_TYPE_PCIE_DOWN	= 0x100101,
275 	TB_TYPE_PCIE_UP		= 0x100102,
276 	TB_TYPE_USB3_DOWN	= 0x200101,
277 	TB_TYPE_USB3_UP		= 0x200102,
278 };
279 
280 /* Present on every port in TB_CF_PORT at address zero. */
281 struct tb_regs_port_header {
282 	/* DWORD 0 */
283 	u16 vendor_id;
284 	u16 device_id;
285 	/* DWORD 1 */
286 	u32 first_cap_offset:8;
287 	u32 max_counters:11;
288 	u32 counters_support:1;
289 	u32 __unknown1:4;
290 	u32 revision:8;
291 	/* DWORD 2 */
292 	enum tb_port_type type:24;
293 	u32 thunderbolt_version:8;
294 	/* DWORD 3 */
295 	u32 __unknown2:20;
296 	u32 port_number:6;
297 	u32 __unknown3:6;
298 	/* DWORD 4 */
299 	u32 nfc_credits;
300 	/* DWORD 5 */
301 	u32 max_in_hop_id:11;
302 	u32 max_out_hop_id:11;
303 	u32 __unknown4:10;
304 	/* DWORD 6 */
305 	u32 __unknown5;
306 	/* DWORD 7 */
307 	u32 __unknown6;
308 
309 } __packed;
310 
311 /* Basic adapter configuration registers */
312 #define ADP_CS_4				0x04
313 #define ADP_CS_4_NFC_BUFFERS_MASK		GENMASK(9, 0)
314 #define ADP_CS_4_TOTAL_BUFFERS_MASK		GENMASK(29, 20)
315 #define ADP_CS_4_TOTAL_BUFFERS_SHIFT		20
316 #define ADP_CS_4_LCK				BIT(31)
317 #define ADP_CS_5				0x05
318 #define ADP_CS_5_LCA_MASK			GENMASK(28, 22)
319 #define ADP_CS_5_LCA_SHIFT			22
320 #define ADP_CS_5_DHP				BIT(31)
321 
322 /* TMU adapter registers */
323 #define TMU_ADP_CS_3				0x03
324 #define TMU_ADP_CS_3_UDM			BIT(29)
325 #define TMU_ADP_CS_6				0x06
326 #define TMU_ADP_CS_6_DTS			BIT(1)
327 #define TMU_ADP_CS_8				0x08
328 #define TMU_ADP_CS_8_REPL_TIMEOUT_MASK		GENMASK(14, 0)
329 #define TMU_ADP_CS_8_EUDM			BIT(15)
330 #define TMU_ADP_CS_8_REPL_THRESHOLD_MASK	GENMASK(25, 16)
331 #define TMU_ADP_CS_9				0x09
332 #define TMU_ADP_CS_9_REPL_N_MASK		GENMASK(7, 0)
333 #define TMU_ADP_CS_9_DIRSWITCH_N_MASK		GENMASK(15, 8)
334 #define TMU_ADP_CS_9_ADP_TS_INTERVAL_MASK	GENMASK(31, 16)
335 
336 /* Lane adapter registers */
337 #define LANE_ADP_CS_0				0x00
338 #define LANE_ADP_CS_0_SUPPORTED_SPEED_MASK	GENMASK(19, 16)
339 #define LANE_ADP_CS_0_SUPPORTED_SPEED_SHIFT	16
340 #define LANE_ADP_CS_0_SUPPORTED_WIDTH_MASK	GENMASK(25, 20)
341 #define LANE_ADP_CS_0_SUPPORTED_WIDTH_SHIFT	20
342 #define LANE_ADP_CS_0_SUPPORTED_WIDTH_DUAL	0x2
343 #define LANE_ADP_CS_0_CL0S_SUPPORT		BIT(26)
344 #define LANE_ADP_CS_0_CL1_SUPPORT		BIT(27)
345 #define LANE_ADP_CS_0_CL2_SUPPORT		BIT(28)
346 #define LANE_ADP_CS_1				0x01
347 #define LANE_ADP_CS_1_TARGET_SPEED_MASK		GENMASK(3, 0)
348 #define LANE_ADP_CS_1_TARGET_SPEED_GEN3		0xc
349 #define LANE_ADP_CS_1_TARGET_WIDTH_MASK		GENMASK(9, 4)
350 #define LANE_ADP_CS_1_TARGET_WIDTH_SHIFT	4
351 #define LANE_ADP_CS_1_TARGET_WIDTH_SINGLE	0x1
352 #define LANE_ADP_CS_1_TARGET_WIDTH_DUAL		0x3
353 #define LANE_ADP_CS_1_CL0S_ENABLE		BIT(10)
354 #define LANE_ADP_CS_1_CL1_ENABLE		BIT(11)
355 #define LANE_ADP_CS_1_CL2_ENABLE		BIT(12)
356 #define LANE_ADP_CS_1_LD			BIT(14)
357 #define LANE_ADP_CS_1_LB			BIT(15)
358 #define LANE_ADP_CS_1_CURRENT_SPEED_MASK	GENMASK(19, 16)
359 #define LANE_ADP_CS_1_CURRENT_SPEED_SHIFT	16
360 #define LANE_ADP_CS_1_CURRENT_SPEED_GEN2	0x8
361 #define LANE_ADP_CS_1_CURRENT_SPEED_GEN3	0x4
362 #define LANE_ADP_CS_1_CURRENT_SPEED_GEN4	0x2
363 #define LANE_ADP_CS_1_CURRENT_WIDTH_MASK	GENMASK(25, 20)
364 #define LANE_ADP_CS_1_CURRENT_WIDTH_SHIFT	20
365 #define LANE_ADP_CS_1_PMS			BIT(30)
366 
367 /* USB4 port registers */
368 #define PORT_CS_1				0x01
369 #define PORT_CS_1_LENGTH_SHIFT			8
370 #define PORT_CS_1_TARGET_MASK			GENMASK(18, 16)
371 #define PORT_CS_1_TARGET_SHIFT			16
372 #define PORT_CS_1_RETIMER_INDEX_SHIFT		20
373 #define PORT_CS_1_WNR_WRITE			BIT(24)
374 #define PORT_CS_1_NR				BIT(25)
375 #define PORT_CS_1_RC				BIT(26)
376 #define PORT_CS_1_PND				BIT(31)
377 #define PORT_CS_2				0x02
378 #define PORT_CS_18				0x12
379 #define PORT_CS_18_BE				BIT(8)
380 #define PORT_CS_18_TCM				BIT(9)
381 #define PORT_CS_18_CPS				BIT(10)
382 #define PORT_CS_18_WOCS				BIT(16)
383 #define PORT_CS_18_WODS				BIT(17)
384 #define PORT_CS_18_WOU4S			BIT(18)
385 #define PORT_CS_19				0x13
386 #define PORT_CS_19_PC				BIT(3)
387 #define PORT_CS_19_PID				BIT(4)
388 #define PORT_CS_19_WOC				BIT(16)
389 #define PORT_CS_19_WOD				BIT(17)
390 #define PORT_CS_19_WOU4				BIT(18)
391 
392 /* Display Port adapter registers */
393 #define ADP_DP_CS_0				0x00
394 #define ADP_DP_CS_0_VIDEO_HOPID_MASK		GENMASK(26, 16)
395 #define ADP_DP_CS_0_VIDEO_HOPID_SHIFT		16
396 #define ADP_DP_CS_0_AE				BIT(30)
397 #define ADP_DP_CS_0_VE				BIT(31)
398 #define ADP_DP_CS_1_AUX_TX_HOPID_MASK		GENMASK(10, 0)
399 #define ADP_DP_CS_1_AUX_RX_HOPID_MASK		GENMASK(21, 11)
400 #define ADP_DP_CS_1_AUX_RX_HOPID_SHIFT		11
401 #define ADP_DP_CS_2				0x02
402 #define ADP_DP_CS_2_NRD_MLC_MASK		GENMASK(2, 0)
403 #define ADP_DP_CS_2_HDP				BIT(6)
404 #define ADP_DP_CS_2_NRD_MLR_MASK		GENMASK(9, 7)
405 #define ADP_DP_CS_2_NRD_MLR_SHIFT		7
406 #define ADP_DP_CS_2_CA				BIT(10)
407 #define ADP_DP_CS_2_GR_MASK			GENMASK(12, 11)
408 #define ADP_DP_CS_2_GR_SHIFT			11
409 #define ADP_DP_CS_2_GR_0_25G			0x0
410 #define ADP_DP_CS_2_GR_0_5G			0x1
411 #define ADP_DP_CS_2_GR_1G			0x2
412 #define ADP_DP_CS_2_GROUP_ID_MASK		GENMASK(15, 13)
413 #define ADP_DP_CS_2_GROUP_ID_SHIFT		13
414 #define ADP_DP_CS_2_CM_ID_MASK			GENMASK(19, 16)
415 #define ADP_DP_CS_2_CM_ID_SHIFT			16
416 #define ADP_DP_CS_2_CMMS			BIT(20)
417 #define ADP_DP_CS_2_ESTIMATED_BW_MASK		GENMASK(31, 24)
418 #define ADP_DP_CS_2_ESTIMATED_BW_SHIFT		24
419 #define ADP_DP_CS_3				0x03
420 #define ADP_DP_CS_3_HDPC			BIT(9)
421 #define DP_LOCAL_CAP				0x04
422 #define DP_REMOTE_CAP				0x05
423 /* For DP IN adapter */
424 #define DP_STATUS				0x06
425 #define DP_STATUS_ALLOCATED_BW_MASK		GENMASK(31, 24)
426 #define DP_STATUS_ALLOCATED_BW_SHIFT		24
427 /* For DP OUT adapter */
428 #define DP_STATUS_CTRL				0x06
429 #define DP_STATUS_CTRL_CMHS			BIT(25)
430 #define DP_STATUS_CTRL_UF			BIT(26)
431 #define DP_COMMON_CAP				0x07
432 /* Only if DP IN supports BW allocation mode */
433 #define ADP_DP_CS_8				0x08
434 #define ADP_DP_CS_8_REQUESTED_BW_MASK		GENMASK(7, 0)
435 #define ADP_DP_CS_8_DPME			BIT(30)
436 #define ADP_DP_CS_8_DR				BIT(31)
437 
438 /*
439  * DP_COMMON_CAP offsets work also for DP_LOCAL_CAP and DP_REMOTE_CAP
440  * with exception of DPRX done.
441  */
442 #define DP_COMMON_CAP_RATE_MASK			GENMASK(11, 8)
443 #define DP_COMMON_CAP_RATE_SHIFT		8
444 #define DP_COMMON_CAP_RATE_RBR			0x0
445 #define DP_COMMON_CAP_RATE_HBR			0x1
446 #define DP_COMMON_CAP_RATE_HBR2			0x2
447 #define DP_COMMON_CAP_RATE_HBR3			0x3
448 #define DP_COMMON_CAP_LANES_MASK		GENMASK(14, 12)
449 #define DP_COMMON_CAP_LANES_SHIFT		12
450 #define DP_COMMON_CAP_1_LANE			0x0
451 #define DP_COMMON_CAP_2_LANES			0x1
452 #define DP_COMMON_CAP_4_LANES			0x2
453 #define DP_COMMON_CAP_UHBR10			BIT(17)
454 #define DP_COMMON_CAP_UHBR20			BIT(18)
455 #define DP_COMMON_CAP_UHBR13_5			BIT(19)
456 #define DP_COMMON_CAP_LTTPR_NS			BIT(27)
457 #define DP_COMMON_CAP_BW_MODE			BIT(28)
458 #define DP_COMMON_CAP_DPRX_DONE			BIT(31)
459 /* Only present if DP IN supports BW allocation mode */
460 #define ADP_DP_CS_8				0x08
461 #define ADP_DP_CS_8_DPME			BIT(30)
462 #define ADP_DP_CS_8_DR				BIT(31)
463 
464 /* PCIe adapter registers */
465 #define ADP_PCIE_CS_0				0x00
466 #define ADP_PCIE_CS_0_PE			BIT(31)
467 #define ADP_PCIE_CS_1				0x01
468 #define ADP_PCIE_CS_1_EE			BIT(0)
469 
470 /* USB adapter registers */
471 #define ADP_USB3_CS_0				0x00
472 #define ADP_USB3_CS_0_V				BIT(30)
473 #define ADP_USB3_CS_0_PE			BIT(31)
474 #define ADP_USB3_CS_1				0x01
475 #define ADP_USB3_CS_1_CUBW_MASK			GENMASK(11, 0)
476 #define ADP_USB3_CS_1_CDBW_MASK			GENMASK(23, 12)
477 #define ADP_USB3_CS_1_CDBW_SHIFT		12
478 #define ADP_USB3_CS_1_HCA			BIT(31)
479 #define ADP_USB3_CS_2				0x02
480 #define ADP_USB3_CS_2_AUBW_MASK			GENMASK(11, 0)
481 #define ADP_USB3_CS_2_ADBW_MASK			GENMASK(23, 12)
482 #define ADP_USB3_CS_2_ADBW_SHIFT		12
483 #define ADP_USB3_CS_2_CMR			BIT(31)
484 #define ADP_USB3_CS_3				0x03
485 #define ADP_USB3_CS_3_SCALE_MASK		GENMASK(5, 0)
486 #define ADP_USB3_CS_4				0x04
487 #define ADP_USB3_CS_4_ALR_MASK			GENMASK(6, 0)
488 #define ADP_USB3_CS_4_ALR_20G			0x1
489 #define ADP_USB3_CS_4_ULV			BIT(7)
490 #define ADP_USB3_CS_4_MSLR_MASK			GENMASK(18, 12)
491 #define ADP_USB3_CS_4_MSLR_SHIFT		12
492 #define ADP_USB3_CS_4_MSLR_20G			0x1
493 
494 /* Hop register from TB_CFG_HOPS. 8 byte per entry. */
495 struct tb_regs_hop {
496 	/* DWORD 0 */
497 	u32 next_hop:11; /*
498 			  * hop to take after sending the packet through
499 			  * out_port (on the incoming port of the next switch)
500 			  */
501 	u32 out_port:6; /* next port of the path (on the same switch) */
502 	u32 initial_credits:8;
503 	u32 unknown1:6; /* set to zero */
504 	bool enable:1;
505 
506 	/* DWORD 1 */
507 	u32 weight:4;
508 	u32 unknown2:4; /* set to zero */
509 	u32 priority:3;
510 	bool drop_packages:1;
511 	u32 counter:11; /* index into TB_CFG_COUNTERS on this port */
512 	bool counter_enable:1;
513 	bool ingress_fc:1;
514 	bool egress_fc:1;
515 	bool ingress_shared_buffer:1;
516 	bool egress_shared_buffer:1;
517 	bool pending:1;
518 	u32 unknown3:3; /* set to zero */
519 } __packed;
520 
521 /* TMU Thunderbolt 3 registers */
522 #define TB_TIME_VSEC_3_CS_9			0x9
523 #define TB_TIME_VSEC_3_CS_9_TMU_OBJ_MASK	GENMASK(17, 16)
524 #define TB_TIME_VSEC_3_CS_26			0x1a
525 #define TB_TIME_VSEC_3_CS_26_TD			BIT(22)
526 
527 /*
528  * Used for Titan Ridge only. Bits are part of the same register: TMU_ADP_CS_6
529  * (see above) as in USB4 spec, but these specific bits used for Titan Ridge
530  * only and reserved in USB4 spec.
531  */
532 #define TMU_ADP_CS_6_DISABLE_TMU_OBJ_MASK	GENMASK(3, 2)
533 #define TMU_ADP_CS_6_DISABLE_TMU_OBJ_CL1	BIT(2)
534 #define TMU_ADP_CS_6_DISABLE_TMU_OBJ_CL2	BIT(3)
535 
536 /* Plug Events registers */
537 #define TB_PLUG_EVENTS_USB_DISABLE		BIT(2)
538 #define TB_PLUG_EVENTS_CS_1_LANE_DISABLE	BIT(3)
539 #define TB_PLUG_EVENTS_CS_1_DPOUT_DISABLE	BIT(4)
540 #define TB_PLUG_EVENTS_CS_1_LOW_DPIN_DISABLE	BIT(5)
541 #define TB_PLUG_EVENTS_CS_1_HIGH_DPIN_DISABLE	BIT(6)
542 
543 #define TB_PLUG_EVENTS_PCIE_WR_DATA		0x1b
544 #define TB_PLUG_EVENTS_PCIE_CMD			0x1c
545 #define TB_PLUG_EVENTS_PCIE_CMD_DW_OFFSET_MASK	GENMASK(9, 0)
546 #define TB_PLUG_EVENTS_PCIE_CMD_BR_SHIFT	10
547 #define TB_PLUG_EVENTS_PCIE_CMD_BR_MASK		GENMASK(17, 10)
548 #define TB_PLUG_EVENTS_PCIE_CMD_RD_WR_MASK	BIT(21)
549 #define TB_PLUG_EVENTS_PCIE_CMD_WR		0x1
550 #define TB_PLUG_EVENTS_PCIE_CMD_COMMAND_SHIFT	22
551 #define TB_PLUG_EVENTS_PCIE_CMD_COMMAND_MASK	GENMASK(24, 22)
552 #define TB_PLUG_EVENTS_PCIE_CMD_COMMAND_VAL	0x2
553 #define TB_PLUG_EVENTS_PCIE_CMD_REQ_ACK_MASK	BIT(30)
554 #define TB_PLUG_EVENTS_PCIE_CMD_TIMEOUT_MASK	BIT(31)
555 #define TB_PLUG_EVENTS_PCIE_CMD_RD_DATA		0x1d
556 
557 /* CP Low Power registers */
558 #define TB_LOW_PWR_C1_CL1			0x1
559 #define TB_LOW_PWR_C1_CL1_OBJ_MASK		GENMASK(4, 1)
560 #define TB_LOW_PWR_C1_CL2_OBJ_MASK		GENMASK(4, 1)
561 #define TB_LOW_PWR_C1_PORT_A_MASK		GENMASK(2, 1)
562 #define TB_LOW_PWR_C0_PORT_B_MASK		GENMASK(4, 3)
563 #define TB_LOW_PWR_C3_CL1			0x3
564 
565 /* Common link controller registers */
566 #define TB_LC_DESC				0x02
567 #define TB_LC_DESC_NLC_MASK			GENMASK(3, 0)
568 #define TB_LC_DESC_SIZE_SHIFT			8
569 #define TB_LC_DESC_SIZE_MASK			GENMASK(15, 8)
570 #define TB_LC_DESC_PORT_SIZE_SHIFT		16
571 #define TB_LC_DESC_PORT_SIZE_MASK		GENMASK(27, 16)
572 #define TB_LC_FUSE				0x03
573 #define TB_LC_SNK_ALLOCATION			0x10
574 #define TB_LC_SNK_ALLOCATION_SNK0_MASK		GENMASK(3, 0)
575 #define TB_LC_SNK_ALLOCATION_SNK0_CM		0x1
576 #define TB_LC_SNK_ALLOCATION_SNK1_SHIFT		4
577 #define TB_LC_SNK_ALLOCATION_SNK1_MASK		GENMASK(7, 4)
578 #define TB_LC_SNK_ALLOCATION_SNK1_CM		0x1
579 #define TB_LC_POWER				0x740
580 
581 /* Link controller registers */
582 #define TB_LC_CS_42				0x2a
583 #define TB_LC_CS_42_USB_PLUGGED			BIT(31)
584 
585 #define TB_LC_PORT_ATTR				0x8d
586 #define TB_LC_PORT_ATTR_BE			BIT(12)
587 
588 #define TB_LC_SX_CTRL				0x96
589 #define TB_LC_SX_CTRL_WOC			BIT(1)
590 #define TB_LC_SX_CTRL_WOD			BIT(2)
591 #define TB_LC_SX_CTRL_WODPC			BIT(3)
592 #define TB_LC_SX_CTRL_WODPD			BIT(4)
593 #define TB_LC_SX_CTRL_WOU4			BIT(5)
594 #define TB_LC_SX_CTRL_WOP			BIT(6)
595 #define TB_LC_SX_CTRL_L1C			BIT(16)
596 #define TB_LC_SX_CTRL_L1D			BIT(17)
597 #define TB_LC_SX_CTRL_L2C			BIT(20)
598 #define TB_LC_SX_CTRL_L2D			BIT(21)
599 #define TB_LC_SX_CTRL_SLI			BIT(29)
600 #define TB_LC_SX_CTRL_UPSTREAM			BIT(30)
601 #define TB_LC_SX_CTRL_SLP			BIT(31)
602 #define TB_LC_LINK_ATTR				0x97
603 #define TB_LC_LINK_ATTR_CPS			BIT(18)
604 
605 #define TB_LC_LINK_REQ				0xad
606 #define TB_LC_LINK_REQ_XHCI_CONNECT		BIT(31)
607 
608 #endif
609