1 /*
2  * Copyright 2016 Advanced Micro Devices, Inc.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20  * OTHER DEALINGS IN THE SOFTWARE.
21  *
22  * Authors: AMD
23  *
24  */
25 
26 #ifndef DC_DP_TYPES_H
27 #define DC_DP_TYPES_H
28 
29 #include "os_types.h"
30 
31 enum dc_lane_count {
32 	LANE_COUNT_UNKNOWN = 0,
33 	LANE_COUNT_ONE = 1,
34 	LANE_COUNT_TWO = 2,
35 	LANE_COUNT_FOUR = 4,
36 	LANE_COUNT_EIGHT = 8,
37 	LANE_COUNT_DP_MAX = LANE_COUNT_FOUR
38 };
39 
40 /* This is actually a reference clock (27MHz) multiplier
41  * 162MBps bandwidth for 1.62GHz like rate,
42  * 270MBps for 2.70GHz,
43  * 324MBps for 3.24Ghz,
44  * 540MBps for 5.40GHz
45  * 810MBps for 8.10GHz
46  */
47 enum dc_link_rate {
48 	LINK_RATE_UNKNOWN = 0,
49 	LINK_RATE_LOW = 0x06,		// Rate_1 (RBR)	- 1.62 Gbps/Lane
50 	LINK_RATE_RATE_2 = 0x08,	// Rate_2		- 2.16 Gbps/Lane
51 	LINK_RATE_RATE_3 = 0x09,	// Rate_3		- 2.43 Gbps/Lane
52 	LINK_RATE_HIGH = 0x0A,		// Rate_4 (HBR)	- 2.70 Gbps/Lane
53 	LINK_RATE_RBR2 = 0x0C,		// Rate_5 (RBR2)- 3.24 Gbps/Lane
54 	LINK_RATE_RATE_6 = 0x10,	// Rate_6		- 4.32 Gbps/Lane
55 	LINK_RATE_HIGH2 = 0x14,		// Rate_7 (HBR2)- 5.40 Gbps/Lane
56 #if defined(CONFIG_DRM_AMD_DC_DCN)
57 	LINK_RATE_HIGH3 = 0x1E,		// Rate_8 (HBR3)- 8.10 Gbps/Lane
58 	/* Starting from DP2.0 link rate enum directly represents actual
59 	 * link rate value in unit of 10 mbps
60 	 */
61 	LINK_RATE_UHBR10 = 1000,	// UHBR10 - 10.0 Gbps/Lane
62 	LINK_RATE_UHBR13_5 = 1350,	// UHBR13.5 - 13.5 Gbps/Lane
63 	LINK_RATE_UHBR20 = 2000,	// UHBR10 - 20.0 Gbps/Lane
64 #else
65 	LINK_RATE_HIGH3 = 0x1E		// Rate_8 (HBR3)- 8.10 Gbps/Lane
66 #endif
67 };
68 
69 enum dc_link_spread {
70 	LINK_SPREAD_DISABLED = 0x00,
71 	/* 0.5 % downspread 30 kHz */
72 	LINK_SPREAD_05_DOWNSPREAD_30KHZ = 0x10,
73 	/* 0.5 % downspread 33 kHz */
74 	LINK_SPREAD_05_DOWNSPREAD_33KHZ = 0x11
75 };
76 
77 enum dc_voltage_swing {
78 	VOLTAGE_SWING_LEVEL0 = 0,	/* direct HW translation! */
79 	VOLTAGE_SWING_LEVEL1,
80 	VOLTAGE_SWING_LEVEL2,
81 	VOLTAGE_SWING_LEVEL3,
82 	VOLTAGE_SWING_MAX_LEVEL = VOLTAGE_SWING_LEVEL3
83 };
84 
85 enum dc_pre_emphasis {
86 	PRE_EMPHASIS_DISABLED = 0,	/* direct HW translation! */
87 	PRE_EMPHASIS_LEVEL1,
88 	PRE_EMPHASIS_LEVEL2,
89 	PRE_EMPHASIS_LEVEL3,
90 	PRE_EMPHASIS_MAX_LEVEL = PRE_EMPHASIS_LEVEL3
91 };
92 /* Post Cursor 2 is optional for transmitter
93  * and it applies only to the main link operating at HBR2
94  */
95 enum dc_post_cursor2 {
96 	POST_CURSOR2_DISABLED = 0,	/* direct HW translation! */
97 	POST_CURSOR2_LEVEL1,
98 	POST_CURSOR2_LEVEL2,
99 	POST_CURSOR2_LEVEL3,
100 	POST_CURSOR2_MAX_LEVEL = POST_CURSOR2_LEVEL3,
101 };
102 
103 #if defined(CONFIG_DRM_AMD_DC_DCN)
104 enum dc_dp_ffe_preset_level {
105 	DP_FFE_PRESET_LEVEL0 = 0,
106 	DP_FFE_PRESET_LEVEL1,
107 	DP_FFE_PRESET_LEVEL2,
108 	DP_FFE_PRESET_LEVEL3,
109 	DP_FFE_PRESET_LEVEL4,
110 	DP_FFE_PRESET_LEVEL5,
111 	DP_FFE_PRESET_LEVEL6,
112 	DP_FFE_PRESET_LEVEL7,
113 	DP_FFE_PRESET_LEVEL8,
114 	DP_FFE_PRESET_LEVEL9,
115 	DP_FFE_PRESET_LEVEL10,
116 	DP_FFE_PRESET_LEVEL11,
117 	DP_FFE_PRESET_LEVEL12,
118 	DP_FFE_PRESET_LEVEL13,
119 	DP_FFE_PRESET_LEVEL14,
120 	DP_FFE_PRESET_LEVEL15,
121 	DP_FFE_PRESET_MAX_LEVEL = DP_FFE_PRESET_LEVEL15,
122 };
123 #endif
124 
125 enum dc_dp_training_pattern {
126 	DP_TRAINING_PATTERN_SEQUENCE_1 = 0,
127 	DP_TRAINING_PATTERN_SEQUENCE_2,
128 	DP_TRAINING_PATTERN_SEQUENCE_3,
129 	DP_TRAINING_PATTERN_SEQUENCE_4,
130 	DP_TRAINING_PATTERN_VIDEOIDLE,
131 #if defined(CONFIG_DRM_AMD_DC_DCN)
132 	DP_128b_132b_TPS1,
133 	DP_128b_132b_TPS2,
134 	DP_128b_132b_TPS2_CDS,
135 #endif
136 };
137 
138 enum dp_link_encoding {
139 	DP_UNKNOWN_ENCODING = 0,
140 	DP_8b_10b_ENCODING = 1,
141 #if defined(CONFIG_DRM_AMD_DC_DCN)
142 	DP_128b_132b_ENCODING = 2,
143 #endif
144 };
145 
146 struct dc_link_settings {
147 	enum dc_lane_count lane_count;
148 	enum dc_link_rate link_rate;
149 	enum dc_link_spread link_spread;
150 	bool use_link_rate_set;
151 	uint8_t link_rate_set;
152 	bool dpcd_source_device_specific_field_support;
153 };
154 
155 #if defined(CONFIG_DRM_AMD_DC_DCN)
156 union dc_dp_ffe_preset {
157 	struct {
158 		uint8_t level		: 4;
159 		uint8_t reserved	: 1;
160 		uint8_t no_preshoot	: 1;
161 		uint8_t no_deemphasis	: 1;
162 		uint8_t method2		: 1;
163 	} settings;
164 	uint8_t raw;
165 };
166 #endif
167 
168 struct dc_lane_settings {
169 	enum dc_voltage_swing VOLTAGE_SWING;
170 	enum dc_pre_emphasis PRE_EMPHASIS;
171 	enum dc_post_cursor2 POST_CURSOR2;
172 #if defined(CONFIG_DRM_AMD_DC_DCN)
173 	union dc_dp_ffe_preset FFE_PRESET;
174 #endif
175 };
176 
177 struct dc_link_training_overrides {
178 	enum dc_voltage_swing *voltage_swing;
179 	enum dc_pre_emphasis *pre_emphasis;
180 	enum dc_post_cursor2 *post_cursor2;
181 #if defined(CONFIG_DRM_AMD_DC_DCN)
182 	union dc_dp_ffe_preset *ffe_preset;
183 #endif
184 
185 	uint16_t *cr_pattern_time;
186 	uint16_t *eq_pattern_time;
187 	enum dc_dp_training_pattern *pattern_for_cr;
188 	enum dc_dp_training_pattern *pattern_for_eq;
189 
190 	enum dc_link_spread *downspread;
191 	bool *alternate_scrambler_reset;
192 	bool *enhanced_framing;
193 	bool *mst_enable;
194 	bool *fec_enable;
195 };
196 
197 #if defined(CONFIG_DRM_AMD_DC_DCN)
198 union payload_table_update_status {
199 	struct {
200 		uint8_t  VC_PAYLOAD_TABLE_UPDATED:1;
201 		uint8_t  ACT_HANDLED:1;
202 	} bits;
203 	uint8_t  raw;
204 };
205 #endif
206 
207 union dpcd_rev {
208 	struct {
209 		uint8_t MINOR:4;
210 		uint8_t MAJOR:4;
211 	} bits;
212 	uint8_t raw;
213 };
214 
215 union max_lane_count {
216 	struct {
217 		uint8_t MAX_LANE_COUNT:5;
218 		uint8_t POST_LT_ADJ_REQ_SUPPORTED:1;
219 		uint8_t TPS3_SUPPORTED:1;
220 		uint8_t ENHANCED_FRAME_CAP:1;
221 	} bits;
222 	uint8_t raw;
223 };
224 
225 union max_down_spread {
226 	struct {
227 		uint8_t MAX_DOWN_SPREAD:1;
228 		uint8_t RESERVED:5;
229 		uint8_t NO_AUX_HANDSHAKE_LINK_TRAINING:1;
230 		uint8_t TPS4_SUPPORTED:1;
231 	} bits;
232 	uint8_t raw;
233 };
234 
235 union mstm_cap {
236 	struct {
237 		uint8_t MST_CAP:1;
238 		uint8_t RESERVED:7;
239 	} bits;
240 	uint8_t raw;
241 };
242 
243 union lane_count_set {
244 	struct {
245 		uint8_t LANE_COUNT_SET:5;
246 		uint8_t POST_LT_ADJ_REQ_GRANTED:1;
247 		uint8_t RESERVED:1;
248 		uint8_t ENHANCED_FRAMING:1;
249 	} bits;
250 	uint8_t raw;
251 };
252 
253 union lane_status {
254 	struct {
255 		uint8_t CR_DONE_0:1;
256 		uint8_t CHANNEL_EQ_DONE_0:1;
257 		uint8_t SYMBOL_LOCKED_0:1;
258 		uint8_t RESERVED0:1;
259 		uint8_t CR_DONE_1:1;
260 		uint8_t CHANNEL_EQ_DONE_1:1;
261 		uint8_t SYMBOL_LOCKED_1:1;
262 		uint8_t RESERVED_1:1;
263 	} bits;
264 	uint8_t raw;
265 };
266 
267 union device_service_irq {
268 	struct {
269 		uint8_t REMOTE_CONTROL_CMD_PENDING:1;
270 		uint8_t AUTOMATED_TEST:1;
271 		uint8_t CP_IRQ:1;
272 		uint8_t MCCS_IRQ:1;
273 		uint8_t DOWN_REP_MSG_RDY:1;
274 		uint8_t UP_REQ_MSG_RDY:1;
275 		uint8_t SINK_SPECIFIC:1;
276 		uint8_t reserved:1;
277 	} bits;
278 	uint8_t raw;
279 };
280 
281 union sink_count {
282 	struct {
283 		uint8_t SINK_COUNT:6;
284 		uint8_t CPREADY:1;
285 		uint8_t RESERVED:1;
286 	} bits;
287 	uint8_t raw;
288 };
289 
290 union lane_align_status_updated {
291 	struct {
292 		uint8_t INTERLANE_ALIGN_DONE:1;
293 		uint8_t POST_LT_ADJ_REQ_IN_PROGRESS:1;
294 #if defined(CONFIG_DRM_AMD_DC_DCN)
295 		uint8_t EQ_INTERLANE_ALIGN_DONE_128b_132b:1;
296 		uint8_t CDS_INTERLANE_ALIGN_DONE_128b_132b:1;
297 		uint8_t LT_FAILED_128b_132b:1;
298 		uint8_t RESERVED:1;
299 #else
300 		uint8_t RESERVED:4;
301 #endif
302 		uint8_t DOWNSTREAM_PORT_STATUS_CHANGED:1;
303 		uint8_t LINK_STATUS_UPDATED:1;
304 	} bits;
305 	uint8_t raw;
306 };
307 
308 union lane_adjust {
309 	struct {
310 		uint8_t VOLTAGE_SWING_LANE:2;
311 		uint8_t PRE_EMPHASIS_LANE:2;
312 		uint8_t RESERVED:4;
313 	} bits;
314 #if defined(CONFIG_DRM_AMD_DC_DCN)
315 	struct {
316 		uint8_t PRESET_VALUE	:4;
317 		uint8_t RESERVED	:4;
318 	} tx_ffe;
319 #endif
320 	uint8_t raw;
321 };
322 
323 union dpcd_training_pattern {
324 	struct {
325 		uint8_t TRAINING_PATTERN_SET:4;
326 		uint8_t RECOVERED_CLOCK_OUT_EN:1;
327 		uint8_t SCRAMBLING_DISABLE:1;
328 		uint8_t SYMBOL_ERROR_COUNT_SEL:2;
329 	} v1_4;
330 	struct {
331 		uint8_t TRAINING_PATTERN_SET:2;
332 		uint8_t LINK_QUAL_PATTERN_SET:2;
333 		uint8_t RESERVED:4;
334 	} v1_3;
335 	uint8_t raw;
336 };
337 
338 /* Training Lane is used to configure downstream DP device's voltage swing
339 and pre-emphasis levels*/
340 /* The DPCD addresses are from 0x103 to 0x106*/
341 union dpcd_training_lane {
342 	struct {
343 		uint8_t VOLTAGE_SWING_SET:2;
344 		uint8_t MAX_SWING_REACHED:1;
345 		uint8_t PRE_EMPHASIS_SET:2;
346 		uint8_t MAX_PRE_EMPHASIS_REACHED:1;
347 		uint8_t RESERVED:2;
348 	} bits;
349 #if defined(CONFIG_DRM_AMD_DC_DCN)
350 	struct {
351 		uint8_t PRESET_VALUE	:4;
352 		uint8_t RESERVED	:4;
353 	} tx_ffe;
354 #endif
355 	uint8_t raw;
356 };
357 
358 /* TMDS-converter related */
359 union dwnstream_port_caps_byte0 {
360 	struct {
361 		uint8_t DWN_STRM_PORTX_TYPE:3;
362 		uint8_t DWN_STRM_PORTX_HPD:1;
363 		uint8_t RESERVERD:4;
364 	} bits;
365 	uint8_t raw;
366 };
367 
368 /* these are the detailed types stored at DWN_STRM_PORTX_CAP (00080h)*/
369 enum dpcd_downstream_port_detailed_type {
370 	DOWN_STREAM_DETAILED_DP = 0,
371 	DOWN_STREAM_DETAILED_VGA,
372 	DOWN_STREAM_DETAILED_DVI,
373 	DOWN_STREAM_DETAILED_HDMI,
374 	DOWN_STREAM_DETAILED_NONDDC,/* has no EDID (TV,CV)*/
375 	DOWN_STREAM_DETAILED_DP_PLUS_PLUS
376 };
377 
378 union dwnstream_port_caps_byte2 {
379 	struct {
380 		uint8_t MAX_BITS_PER_COLOR_COMPONENT:2;
381 		uint8_t RESERVED:6;
382 	} bits;
383 	uint8_t raw;
384 };
385 
386 union dp_downstream_port_present {
387 	uint8_t byte;
388 	struct {
389 		uint8_t PORT_PRESENT:1;
390 		uint8_t PORT_TYPE:2;
391 		uint8_t FMT_CONVERSION:1;
392 		uint8_t DETAILED_CAPS:1;
393 		uint8_t RESERVED:3;
394 	} fields;
395 };
396 
397 union dwnstream_port_caps_byte3_dvi {
398 	struct {
399 		uint8_t RESERVED1:1;
400 		uint8_t DUAL_LINK:1;
401 		uint8_t HIGH_COLOR_DEPTH:1;
402 		uint8_t RESERVED2:5;
403 	} bits;
404 	uint8_t raw;
405 };
406 
407 union dwnstream_port_caps_byte3_hdmi {
408 	struct {
409 		uint8_t FRAME_SEQ_TO_FRAME_PACK:1;
410 		uint8_t YCrCr422_PASS_THROUGH:1;
411 		uint8_t YCrCr420_PASS_THROUGH:1;
412 		uint8_t YCrCr422_CONVERSION:1;
413 		uint8_t YCrCr420_CONVERSION:1;
414 		uint8_t RESERVED:3;
415 	} bits;
416 	uint8_t raw;
417 };
418 
419 /*4-byte structure for detailed capabilities of a down-stream port
420 (DP-to-TMDS converter).*/
421 union dwnstream_portxcaps {
422 	struct {
423 		union dwnstream_port_caps_byte0 byte0;
424 		unsigned char max_TMDS_clock;   //byte1
425 		union dwnstream_port_caps_byte2 byte2;
426 
427 		union {
428 			union dwnstream_port_caps_byte3_dvi byteDVI;
429 			union dwnstream_port_caps_byte3_hdmi byteHDMI;
430 		} byte3;
431 	} bytes;
432 
433 	unsigned char raw[4];
434 };
435 
436 union downstream_port {
437 	struct {
438 		unsigned char   present:1;
439 		unsigned char   type:2;
440 		unsigned char   format_conv:1;
441 		unsigned char   detailed_caps:1;
442 		unsigned char   reserved:3;
443 	} bits;
444 	unsigned char raw;
445 };
446 
447 
448 union sink_status {
449 	struct {
450 		uint8_t RX_PORT0_STATUS:1;
451 		uint8_t RX_PORT1_STATUS:1;
452 		uint8_t RESERVED:6;
453 	} bits;
454 	uint8_t raw;
455 };
456 
457 /*6-byte structure corresponding to 6 registers (200h-205h)
458 read during handling of HPD-IRQ*/
459 union hpd_irq_data {
460 	struct {
461 		union sink_count sink_cnt;/* 200h */
462 		union device_service_irq device_service_irq;/* 201h */
463 		union lane_status lane01_status;/* 202h */
464 		union lane_status lane23_status;/* 203h */
465 		union lane_align_status_updated lane_status_updated;/* 204h */
466 		union sink_status sink_status;
467 	} bytes;
468 	uint8_t raw[6];
469 };
470 
471 union down_stream_port_count {
472 	struct {
473 		uint8_t DOWN_STR_PORT_COUNT:4;
474 		uint8_t RESERVED:2; /*Bits 5:4 = RESERVED. Read all 0s.*/
475 		/*Bit 6 = MSA_TIMING_PAR_IGNORED
476 		0 = Sink device requires the MSA timing parameters
477 		1 = Sink device is capable of rendering incoming video
478 		 stream without MSA timing parameters*/
479 		uint8_t IGNORE_MSA_TIMING_PARAM:1;
480 		/*Bit 7 = OUI Support
481 		0 = OUI not supported
482 		1 = OUI supported
483 		(OUI and Device Identification mandatory for DP 1.2)*/
484 		uint8_t OUI_SUPPORT:1;
485 	} bits;
486 	uint8_t raw;
487 };
488 
489 union down_spread_ctrl {
490 	struct {
491 		uint8_t RESERVED1:4;/* Bit 3:0 = RESERVED. Read all 0s*/
492 	/* Bits 4 = SPREAD_AMP. Spreading amplitude
493 	0 = Main link signal is not downspread
494 	1 = Main link signal is downspread <= 0.5%
495 	with frequency in the range of 30kHz ~ 33kHz*/
496 		uint8_t SPREAD_AMP:1;
497 		uint8_t RESERVED2:2;/*Bit 6:5 = RESERVED. Read all 0s*/
498 	/*Bit 7 = MSA_TIMING_PAR_IGNORE_EN
499 	0 = Source device will send valid data for the MSA Timing Params
500 	1 = Source device may send invalid data for these MSA Timing Params*/
501 		uint8_t IGNORE_MSA_TIMING_PARAM:1;
502 	} bits;
503 	uint8_t raw;
504 };
505 
506 union dpcd_edp_config {
507 	struct {
508 		uint8_t PANEL_MODE_EDP:1;
509 		uint8_t FRAMING_CHANGE_ENABLE:1;
510 		uint8_t RESERVED:5;
511 		uint8_t PANEL_SELF_TEST_ENABLE:1;
512 	} bits;
513 	uint8_t raw;
514 };
515 
516 struct dp_device_vendor_id {
517 	uint8_t ieee_oui[3];/*24-bit IEEE OUI*/
518 	uint8_t ieee_device_id[6];/*usually 6-byte ASCII name*/
519 };
520 
521 struct dp_sink_hw_fw_revision {
522 	uint8_t ieee_hw_rev;
523 	uint8_t ieee_fw_rev[2];
524 };
525 
526 struct dpcd_vendor_signature {
527 	bool is_valid;
528 
529 	union dpcd_ieee_vendor_signature {
530 		struct {
531 			uint8_t ieee_oui[3];/*24-bit IEEE OUI*/
532 			uint8_t ieee_device_id[6];/*usually 6-byte ASCII name*/
533 			uint8_t ieee_hw_rev;
534 			uint8_t ieee_fw_rev[2];
535 		};
536 		uint8_t raw[12];
537 	} data;
538 };
539 
540 struct dpcd_amd_signature {
541 	uint8_t AMD_IEEE_TxSignature_byte1;
542 	uint8_t AMD_IEEE_TxSignature_byte2;
543 	uint8_t AMD_IEEE_TxSignature_byte3;
544 };
545 
546 struct dpcd_amd_device_id {
547 	uint8_t device_id_byte1;
548 	uint8_t device_id_byte2;
549 	uint8_t zero[4];
550 	uint8_t dce_version;
551 	uint8_t dal_version_byte1;
552 	uint8_t dal_version_byte2;
553 };
554 
555 struct dpcd_source_backlight_set {
556 	struct  {
557 		uint8_t byte0;
558 		uint8_t byte1;
559 		uint8_t byte2;
560 		uint8_t byte3;
561 	} backlight_level_millinits;
562 
563 	struct  {
564 		uint8_t byte0;
565 		uint8_t byte1;
566 	} backlight_transition_time_ms;
567 };
568 
569 union dpcd_source_backlight_get {
570 	struct {
571 		uint32_t backlight_millinits_peak; /* 326h */
572 		uint32_t backlight_millinits_avg; /* 32Ah */
573 	} bytes;
574 	uint8_t raw[8];
575 };
576 
577 /*DPCD register of DP receiver capability field bits-*/
578 union edp_configuration_cap {
579 	struct {
580 		uint8_t ALT_SCRAMBLER_RESET:1;
581 		uint8_t FRAMING_CHANGE:1;
582 		uint8_t RESERVED:1;
583 		uint8_t DPCD_DISPLAY_CONTROL_CAPABLE:1;
584 		uint8_t RESERVED2:4;
585 	} bits;
586 	uint8_t raw;
587 };
588 
589 union dprx_feature {
590 	struct {
591 		uint8_t GTC_CAP:1;                             // bit 0: DP 1.3+
592 		uint8_t SST_SPLIT_SDP_CAP:1;                   // bit 1: DP 1.4
593 		uint8_t AV_SYNC_CAP:1;                         // bit 2: DP 1.3+
594 		uint8_t VSC_SDP_COLORIMETRY_SUPPORTED:1;       // bit 3: DP 1.3+
595 		uint8_t VSC_EXT_VESA_SDP_SUPPORTED:1;          // bit 4: DP 1.4
596 		uint8_t VSC_EXT_VESA_SDP_CHAINING_SUPPORTED:1; // bit 5: DP 1.4
597 		uint8_t VSC_EXT_CEA_SDP_SUPPORTED:1;           // bit 6: DP 1.4
598 		uint8_t VSC_EXT_CEA_SDP_CHAINING_SUPPORTED:1;  // bit 7: DP 1.4
599 	} bits;
600 	uint8_t raw;
601 };
602 
603 union training_aux_rd_interval {
604 	struct {
605 		uint8_t TRAINIG_AUX_RD_INTERVAL:7;
606 		uint8_t EXT_RECEIVER_CAP_FIELD_PRESENT:1;
607 	} bits;
608 	uint8_t raw;
609 };
610 
611 /* Automated test structures */
612 union test_request {
613 	struct {
614 	uint8_t LINK_TRAINING                :1;
615 	uint8_t LINK_TEST_PATTRN             :1;
616 	uint8_t EDID_READ                    :1;
617 	uint8_t PHY_TEST_PATTERN             :1;
618 	uint8_t RESERVED                     :1;
619 	uint8_t AUDIO_TEST_PATTERN           :1;
620 	uint8_t TEST_AUDIO_DISABLED_VIDEO    :1;
621 	} bits;
622 	uint8_t raw;
623 };
624 
625 union test_response {
626 	struct {
627 		uint8_t ACK         :1;
628 		uint8_t NO_ACK      :1;
629 		uint8_t EDID_CHECKSUM_WRITE:1;
630 		uint8_t RESERVED    :5;
631 	} bits;
632 	uint8_t raw;
633 };
634 
635 union phy_test_pattern {
636 	struct {
637 #if defined(CONFIG_DRM_AMD_DC_DCN)
638 		/* This field is 7 bits for DP2.0 */
639 		uint8_t PATTERN     :7;
640 		uint8_t RESERVED    :1;
641 #else
642 		/* DpcdPhyTestPatterns. This field is 2 bits for DP1.1
643 		 * and 3 bits for DP1.2.
644 		 */
645 		uint8_t PATTERN     :3;
646 		/* BY speci, bit7:2 is 0 for DP1.1. */
647 		uint8_t RESERVED    :5;
648 #endif
649 	} bits;
650 	uint8_t raw;
651 };
652 
653 /* States of Compliance Test Specification (CTS DP1.2). */
654 union compliance_test_state {
655 	struct {
656 		unsigned char STEREO_3D_RUNNING        : 1;
657 		unsigned char RESERVED                 : 7;
658 	} bits;
659 	unsigned char raw;
660 };
661 
662 union link_test_pattern {
663 	struct {
664 		/* dpcd_link_test_patterns */
665 		unsigned char PATTERN :2;
666 		unsigned char RESERVED:6;
667 	} bits;
668 	unsigned char raw;
669 };
670 
671 union test_misc {
672 	struct dpcd_test_misc_bits {
673 		unsigned char SYNC_CLOCK  :1;
674 		/* dpcd_test_color_format */
675 		unsigned char CLR_FORMAT  :2;
676 		/* dpcd_test_dyn_range */
677 		unsigned char DYN_RANGE   :1;
678 		unsigned char YCBCR_COEFS :1;
679 		/* dpcd_test_bit_depth */
680 		unsigned char BPC         :3;
681 	} bits;
682 	unsigned char raw;
683 };
684 
685 union audio_test_mode {
686 	struct {
687 		unsigned char sampling_rate   :4;
688 		unsigned char channel_count   :4;
689 	} bits;
690 	unsigned char raw;
691 };
692 
693 union audio_test_pattern_period {
694 	struct {
695 		unsigned char pattern_period   :4;
696 		unsigned char reserved         :4;
697 	} bits;
698 	unsigned char raw;
699 };
700 
701 struct audio_test_pattern_type {
702 	unsigned char value;
703 };
704 
705 struct dp_audio_test_data_flags {
706 	uint8_t test_requested  :1;
707 	uint8_t disable_video   :1;
708 };
709 
710 struct dp_audio_test_data {
711 
712 	struct dp_audio_test_data_flags flags;
713 	uint8_t sampling_rate;
714 	uint8_t channel_count;
715 	uint8_t pattern_type;
716 	uint8_t pattern_period[8];
717 };
718 
719 /* FEC capability DPCD register field bits-*/
720 union dpcd_fec_capability {
721 	struct {
722 		uint8_t FEC_CAPABLE:1;
723 		uint8_t UNCORRECTED_BLOCK_ERROR_COUNT_CAPABLE:1;
724 		uint8_t CORRECTED_BLOCK_ERROR_COUNT_CAPABLE:1;
725 		uint8_t BIT_ERROR_COUNT_CAPABLE:1;
726 #if defined(CONFIG_DRM_AMD_DC_DCN)
727 		uint8_t PARITY_BLOCK_ERROR_COUNT_CAPABLE:1;
728 		uint8_t ARITY_BIT_ERROR_COUNT_CAPABLE:1;
729 		uint8_t FEC_RUNNING_INDICATOR_SUPPORTED:1;
730 		uint8_t FEC_ERROR_REPORTING_POLICY_SUPPORTED:1;
731 #else
732 		uint8_t RESERVED:4;
733 #endif
734 	} bits;
735 	uint8_t raw;
736 };
737 
738 /* DSC capability DPCD register field bits-*/
739 struct dpcd_dsc_support {
740 	uint8_t DSC_SUPPORT		:1;
741 	uint8_t DSC_PASSTHROUGH_SUPPORT	:1;
742 	uint8_t RESERVED		:6;
743 };
744 
745 struct dpcd_dsc_algorithm_revision {
746 	uint8_t DSC_VERSION_MAJOR	:4;
747 	uint8_t DSC_VERSION_MINOR	:4;
748 };
749 
750 struct dpcd_dsc_rc_buffer_block_size {
751 	uint8_t RC_BLOCK_BUFFER_SIZE	:2;
752 	uint8_t RESERVED		:6;
753 };
754 
755 struct dpcd_dsc_slice_capability1 {
756 	uint8_t ONE_SLICE_PER_DP_DSC_SINK_DEVICE	:1;
757 	uint8_t TWO_SLICES_PER_DP_DSC_SINK_DEVICE	:1;
758 	uint8_t RESERVED				:1;
759 	uint8_t FOUR_SLICES_PER_DP_DSC_SINK_DEVICE	:1;
760 	uint8_t SIX_SLICES_PER_DP_DSC_SINK_DEVICE	:1;
761 	uint8_t EIGHT_SLICES_PER_DP_DSC_SINK_DEVICE	:1;
762 	uint8_t TEN_SLICES_PER_DP_DSC_SINK_DEVICE	:1;
763 	uint8_t TWELVE_SLICES_PER_DP_DSC_SINK_DEVICE	:1;
764 };
765 
766 struct dpcd_dsc_line_buffer_bit_depth {
767 	uint8_t LINE_BUFFER_BIT_DEPTH	:4;
768 	uint8_t RESERVED		:4;
769 };
770 
771 struct dpcd_dsc_block_prediction_support {
772 	uint8_t BLOCK_PREDICTION_SUPPORT:1;
773 	uint8_t RESERVED		:7;
774 };
775 
776 struct dpcd_maximum_bits_per_pixel_supported_by_the_decompressor {
777 	uint8_t MAXIMUM_BITS_PER_PIXEL_SUPPORTED_BY_THE_DECOMPRESSOR_LOW	:7;
778 	uint8_t MAXIMUM_BITS_PER_PIXEL_SUPPORTED_BY_THE_DECOMPRESSOR_HIGH	:7;
779 	uint8_t RESERVED							:2;
780 };
781 
782 struct dpcd_dsc_decoder_color_format_capabilities {
783 	uint8_t RGB_SUPPORT			:1;
784 	uint8_t Y_CB_CR_444_SUPPORT		:1;
785 	uint8_t Y_CB_CR_SIMPLE_422_SUPPORT	:1;
786 	uint8_t Y_CB_CR_NATIVE_422_SUPPORT	:1;
787 	uint8_t Y_CB_CR_NATIVE_420_SUPPORT	:1;
788 	uint8_t RESERVED			:3;
789 };
790 
791 struct dpcd_dsc_decoder_color_depth_capabilities {
792 	uint8_t RESERVED0			:1;
793 	uint8_t EIGHT_BITS_PER_COLOR_SUPPORT	:1;
794 	uint8_t TEN_BITS_PER_COLOR_SUPPORT	:1;
795 	uint8_t TWELVE_BITS_PER_COLOR_SUPPORT	:1;
796 	uint8_t RESERVED1			:4;
797 };
798 
799 struct dpcd_peak_dsc_throughput_dsc_sink {
800 	uint8_t THROUGHPUT_MODE_0:4;
801 	uint8_t THROUGHPUT_MODE_1:4;
802 };
803 
804 struct dpcd_dsc_slice_capabilities_2 {
805 	uint8_t SIXTEEN_SLICES_PER_DSC_SINK_DEVICE	:1;
806 	uint8_t TWENTY_SLICES_PER_DSC_SINK_DEVICE	:1;
807 	uint8_t TWENTYFOUR_SLICES_PER_DSC_SINK_DEVICE	:1;
808 	uint8_t RESERVED				:5;
809 };
810 
811 struct dpcd_bits_per_pixel_increment{
812 	uint8_t INCREMENT_OF_BITS_PER_PIXEL_SUPPORTED	:3;
813 	uint8_t RESERVED				:5;
814 };
815 union dpcd_dsc_basic_capabilities {
816 	struct {
817 		struct dpcd_dsc_support dsc_support;
818 		struct dpcd_dsc_algorithm_revision dsc_algorithm_revision;
819 		struct dpcd_dsc_rc_buffer_block_size dsc_rc_buffer_block_size;
820 		uint8_t dsc_rc_buffer_size;
821 		struct dpcd_dsc_slice_capability1 dsc_slice_capabilities_1;
822 		struct dpcd_dsc_line_buffer_bit_depth dsc_line_buffer_bit_depth;
823 		struct dpcd_dsc_block_prediction_support dsc_block_prediction_support;
824 		struct dpcd_maximum_bits_per_pixel_supported_by_the_decompressor maximum_bits_per_pixel_supported_by_the_decompressor;
825 		struct dpcd_dsc_decoder_color_format_capabilities dsc_decoder_color_format_capabilities;
826 		struct dpcd_dsc_decoder_color_depth_capabilities dsc_decoder_color_depth_capabilities;
827 		struct dpcd_peak_dsc_throughput_dsc_sink peak_dsc_throughput_dsc_sink;
828 		uint8_t dsc_maximum_slice_width;
829 		struct dpcd_dsc_slice_capabilities_2 dsc_slice_capabilities_2;
830 		uint8_t reserved;
831 		struct dpcd_bits_per_pixel_increment bits_per_pixel_increment;
832 	} fields;
833 	uint8_t raw[16];
834 };
835 
836 union dpcd_dsc_branch_decoder_capabilities {
837 	struct {
838 		uint8_t BRANCH_OVERALL_THROUGHPUT_0;
839 		uint8_t BRANCH_OVERALL_THROUGHPUT_1;
840 		uint8_t BRANCH_MAX_LINE_WIDTH;
841 	} fields;
842 	uint8_t raw[3];
843 };
844 
845 struct dpcd_dsc_capabilities {
846 	union dpcd_dsc_basic_capabilities dsc_basic_caps;
847 	union dpcd_dsc_branch_decoder_capabilities dsc_branch_decoder_caps;
848 };
849 
850 /* These parameters are from PSR capabilities reported by Sink DPCD */
851 struct psr_caps {
852 	unsigned char psr_version;
853 	unsigned int psr_rfb_setup_time;
854 	bool psr_exit_link_training_required;
855 };
856 
857 /* Length of router topology ID read from DPCD in bytes. */
858 #define DPCD_USB4_TOPOLOGY_ID_LEN 5
859 
860 /* DPCD[0xE000D] DP_TUNNELING_CAPABILITIES SUPPORT register. */
861 union dp_tun_cap_support {
862 	struct {
863 		uint8_t dp_tunneling :1;
864 		uint8_t rsvd :5;
865 		uint8_t panel_replay_tun_opt :1;
866 		uint8_t dpia_bw_alloc :1;
867 	} bits;
868 	uint8_t raw;
869 };
870 
871 /* DPCD[0xE000E] DP_IN_ADAPTER_INFO register. */
872 union dpia_info {
873 	struct {
874 		uint8_t dpia_num :5;
875 		uint8_t rsvd :3;
876 	} bits;
877 	uint8_t raw;
878 };
879 
880 /* DP Tunneling over USB4 */
881 struct dpcd_usb4_dp_tunneling_info {
882 	union dp_tun_cap_support dp_tun_cap;
883 	union dpia_info dpia_info;
884 	uint8_t usb4_driver_id;
885 	uint8_t usb4_topology_id[DPCD_USB4_TOPOLOGY_ID_LEN];
886 };
887 
888 #if defined(CONFIG_DRM_AMD_DC_DCN)
889 #ifndef DP_MAIN_LINK_CHANNEL_CODING_CAP
890 #define DP_MAIN_LINK_CHANNEL_CODING_CAP			0x006
891 #endif
892 #ifndef DP_SINK_VIDEO_FALLBACK_FORMATS
893 #define DP_SINK_VIDEO_FALLBACK_FORMATS			0x020
894 #endif
895 #ifndef DP_FEC_CAPABILITY_1
896 #define DP_FEC_CAPABILITY_1				0x091
897 #endif
898 #ifndef DP_DFP_CAPABILITY_EXTENSION_SUPPORT
899 #define DP_DFP_CAPABILITY_EXTENSION_SUPPORT		0x0A3
900 #endif
901 #ifndef DP_LINK_SQUARE_PATTERN
902 #define DP_LINK_SQUARE_PATTERN				0x10F
903 #endif
904 #ifndef DP_DSC_CONFIGURATION
905 #define DP_DSC_CONFIGURATION				0x161
906 #endif
907 #ifndef DP_PHY_SQUARE_PATTERN
908 #define DP_PHY_SQUARE_PATTERN				0x249
909 #endif
910 #ifndef DP_128b_132b_SUPPORTED_LINK_RATES
911 #define DP_128b_132b_SUPPORTED_LINK_RATES		0x2215
912 #endif
913 #ifndef DP_128b_132b_TRAINING_AUX_RD_INTERVAL
914 #define DP_128b_132b_TRAINING_AUX_RD_INTERVAL		0x2216
915 #endif
916 #ifndef DP_TEST_264BIT_CUSTOM_PATTERN_7_0
917 #define DP_TEST_264BIT_CUSTOM_PATTERN_7_0		0X2230
918 #endif
919 #ifndef DP_TEST_264BIT_CUSTOM_PATTERN_263_256
920 #define DP_TEST_264BIT_CUSTOM_PATTERN_263_256		0X2250
921 #endif
922 #ifndef DP_DSC_SUPPORT_AND_DECODER_COUNT
923 #define DP_DSC_SUPPORT_AND_DECODER_COUNT		0x2260
924 #endif
925 #ifndef DP_DSC_MAX_SLICE_COUNT_AND_AGGREGATION_0
926 #define DP_DSC_MAX_SLICE_COUNT_AND_AGGREGATION_0	0x2270
927 #endif
928 #ifndef DP_DSC_DECODER_0_MAXIMUM_SLICE_COUNT_MASK
929 #define DP_DSC_DECODER_0_MAXIMUM_SLICE_COUNT_MASK	(1 << 0)
930 #endif
931 #ifndef DP_DSC_DECODER_0_AGGREGATION_SUPPORT_MASK
932 #define DP_DSC_DECODER_0_AGGREGATION_SUPPORT_MASK	(0b111 << 1)
933 #endif
934 #ifndef DP_DSC_DECODER_0_AGGREGATION_SUPPORT_SHIFT
935 #define DP_DSC_DECODER_0_AGGREGATION_SUPPORT_SHIFT	1
936 #endif
937 #ifndef DP_DSC_DECODER_COUNT_MASK
938 #define DP_DSC_DECODER_COUNT_MASK			(0b111 << 5)
939 #endif
940 #ifndef DP_DSC_DECODER_COUNT_SHIFT
941 #define DP_DSC_DECODER_COUNT_SHIFT			5
942 #endif
943 #ifndef DP_MAIN_LINK_CHANNEL_CODING_SET
944 #define DP_MAIN_LINK_CHANNEL_CODING_SET			0x108
945 #endif
946 #ifndef DP_MAIN_LINK_CHANNEL_CODING_PHY_REPEATER
947 #define DP_MAIN_LINK_CHANNEL_CODING_PHY_REPEATER	0xF0006
948 #endif
949 #ifndef DP_PHY_REPEATER_128b_132b_RATES
950 #define DP_PHY_REPEATER_128b_132b_RATES			0xF0007
951 #endif
952 #ifndef DP_128b_132b_TRAINING_AUX_RD_INTERVAL_PHY_REPEATER1
953 #define DP_128b_132b_TRAINING_AUX_RD_INTERVAL_PHY_REPEATER1	0xF0022
954 #endif
955 #ifndef DP_INTRA_HOP_AUX_REPLY_INDICATION
956 #define DP_INTRA_HOP_AUX_REPLY_INDICATION		(1 << 3)
957 #endif
958 /* TODO - Use DRM header to replace above once available */
959 
960 union dp_main_line_channel_coding_cap {
961 	struct {
962 		uint8_t DP_8b_10b_SUPPORTED	:1;
963 		uint8_t DP_128b_132b_SUPPORTED	:1;
964 		uint8_t RESERVED		:6;
965 	} bits;
966 	uint8_t raw;
967 };
968 
969 union dp_main_link_channel_coding_lttpr_cap {
970 	struct {
971 		uint8_t DP_128b_132b_SUPPORTED	:1;
972 		uint8_t RESERVED		:7;
973 	} bits;
974 	uint8_t raw;
975 };
976 
977 union dp_128b_132b_supported_link_rates {
978 	struct {
979 		uint8_t UHBR10	:1;
980 		uint8_t UHBR20	:1;
981 		uint8_t UHBR13_5:1;
982 		uint8_t RESERVED:5;
983 	} bits;
984 	uint8_t raw;
985 };
986 
987 union dp_128b_132b_supported_lttpr_link_rates {
988 	struct {
989 		uint8_t UHBR10	:1;
990 		uint8_t UHBR13_5:1;
991 		uint8_t UHBR20	:1;
992 		uint8_t RESERVED:5;
993 	} bits;
994 	uint8_t raw;
995 };
996 
997 union dp_sink_video_fallback_formats {
998 	struct {
999 		uint8_t dp_1024x768_60Hz_24bpp_support	:1;
1000 		uint8_t dp_1280x720_60Hz_24bpp_support	:1;
1001 		uint8_t dp_1920x1080_60Hz_24bpp_support	:1;
1002 		uint8_t RESERVED			:5;
1003 	} bits;
1004 	uint8_t raw;
1005 };
1006 
1007 union dp_fec_capability1 {
1008 	struct {
1009 		uint8_t AGGREGATED_ERROR_COUNTERS_CAPABLE	:1;
1010 		uint8_t RESERVED				:7;
1011 	} bits;
1012 	uint8_t raw;
1013 };
1014 
1015 struct dp_color_depth_caps {
1016 	uint8_t support_6bpc	:1;
1017 	uint8_t support_8bpc	:1;
1018 	uint8_t support_10bpc	:1;
1019 	uint8_t support_12bpc	:1;
1020 	uint8_t support_16bpc	:1;
1021 	uint8_t RESERVED	:3;
1022 };
1023 
1024 struct dp_encoding_format_caps {
1025 	uint8_t support_rgb	:1;
1026 	uint8_t support_ycbcr444:1;
1027 	uint8_t support_ycbcr422:1;
1028 	uint8_t support_ycbcr420:1;
1029 	uint8_t RESERVED	:4;
1030 };
1031 
1032 union dp_dfp_cap_ext {
1033 	struct {
1034 		uint8_t supported;
1035 		uint8_t max_pixel_rate_in_mps[2];
1036 		uint8_t max_video_h_active_width[2];
1037 		uint8_t max_video_v_active_height[2];
1038 		struct dp_encoding_format_caps encoding_format_caps;
1039 		struct dp_color_depth_caps rgb_color_depth_caps;
1040 		struct dp_color_depth_caps ycbcr444_color_depth_caps;
1041 		struct dp_color_depth_caps ycbcr422_color_depth_caps;
1042 		struct dp_color_depth_caps ycbcr420_color_depth_caps;
1043 	} fields;
1044 	uint8_t raw[12];
1045 };
1046 
1047 union dp_128b_132b_training_aux_rd_interval {
1048 	struct {
1049 		uint8_t VALUE	:7;
1050 		uint8_t UNIT	:1;
1051 	} bits;
1052 	uint8_t raw;
1053 };
1054 #endif
1055 
1056 #endif /* DC_DP_TYPES_H */
1057