xref: /haiku/headers/private/graphics/common/dp_raw.h (revision 4fd62caa9acc437534c41bbb7d3fc9d53e915005)
1 /*
2  * Copyright 2012 Haiku, Inc. All rights reserved.
3  * Distributed under the terms of the MIT License.
4  *
5  * Authors:
6  *		Alexander von Gluck, kallisti5@unixzen.com
7  */
8 #ifndef _DP_RAW_H
9 #define _DP_RAW_H
10 
11 
12 /* ****************************************************** */
13 /* *** AUX Channel Communications                     *** */
14 // Native AUX Communications
15 #define AUX_NATIVE_WRITE                    (8 << 0)
16 #define AUX_NATIVE_READ                     (9 << 0)
17 #define AUX_NATIVE_REPLY_ACK                (0 << 4)
18 #define AUX_NATIVE_REPLY_NACK               (1 << 4)
19 #define AUX_NATIVE_REPLY_DEFER              (2 << 4)
20 #define AUX_NATIVE_REPLY_MASK               (3 << 4)
21 // AUX i2c Communications
22 #define AUX_I2C_WRITE                       (0 << 0)
23 #define AUX_I2C_READ                        (1 << 0)
24 #define AUX_I2C_STATUS                      (2 << 0)
25 #define AUX_I2C_MOT                         (4 << 0)
26 #define AUX_I2C_REPLY_ACK                   (0 << 6)
27 #define AUX_I2C_REPLY_NACK                  (1 << 6)
28 #define AUX_I2C_REPLY_DEFER                 (2 << 6)
29 #define AUX_I2C_REPLY_MASK                  (3 << 6)
30 
31 
32 /* ****************************************************** */
33 /* *** DPCD (DisplayPort Configuration Data)          *** */
34 /* *** Read / Written over DisplayPort AUX link       *** */
35 
36 /* *** DPCD Receiver Compatibility Field (0x0000)     *** */
37 /* *** VESA DisplayPort Standard, rev 1.1, p112       *** */
38 // DPCD Version (0x0)
39 #define DP_DPCD_REV							0x0000		// Reg
40 #define DP_DPCD_REV_MINOR_MASK				(15 << 0)	// Int
41 #define DP_DPCD_REV_MAJOR_MASK				(15 << 4)	// Int
42 #define DP_DPCD_REV_10						0x0010		// Value
43 #define DP_DPCD_REV_11						0x0011		// Value
44 // DP Maximum Link Rate (0x1)
45 #define DP_MAX_LINK_RATE					0x0001		// Reg
46 // Use DP_LINK_RATE_* for speed.
47 // DP Maximum Lane Count (0x2)
48 #define DP_MAX_LANE_COUNT					0x0002		// Reg
49 #define DP_MAX_LANE_COUNT_MASK				(31 << 0)	// Count
50 #define DP_MAX_LANE_COUNT_1					(1 << 0)	// Value
51 #define DP_MAX_LANE_COUNT_2					(2 << 0)	// Value
52 #define DP_MAX_LANE_COUNT_4					(4 << 0)	// Value
53 #define DP_ENHANCED_FRAME_CAP_EN			(1 << 7)	// Bool, Rev 1.1
54 // DP Maximum Downspread (0x3)
55 #define DP_MAX_DOWNSPREAD					0x0003		// Reg
56 #define DP_MAX_DOWNSPREAD_EN				(1 << 0)	// Bool
57 #define DP_MAX_DOWNSPREAD_REQ_NO_HANDSHAKE	(1 << 6)	// Bool
58 // DP Number of Receiver Ports (0x4)
59 #define DP_NORP								0x0004		// Reg
60 #define DP_NORP_MASK						(1 << 0)	// Count
61 // DP Downstream Port Present (0x5)
62 #define DP_DOWNSTREAMPORT					0x0005		// Reg
63 #define DP_DOWNSTREAMPORT_EN				(1 << 0)	// Bool
64 #define DP_DOWNSTREAMPORT_TYPE_MASK			(3 << 1)	// Mask
65 #define DP_DOWNSTREAMPORT_TYPE_DP			(0 << 1)	// Value
66 #define DP_DOWNSTREAMPORT_TYPE_ANALOG		(1 << 1)	// Value
67 #define DP_DOWNSTREAMPORT_TYPE_DIGITAL		(2 << 1)	// Value
68 #define DP_DOWNSTREAMPORT_TYPE_OTHER		(3 << 1)	// Value
69 #define DP_DOWNSTREAMPORT_FORMAT_EN			(1 << 3)	// Bool
70 // DP Main Link Channel Coding (0x6)
71 #define DP_CURR_MAIN_CHAN_CODE				0x0006		// Reg
72 #define DP_CURR_MAIN_CHAN_CODE_ANSIX3_EN	(1 << 0)	// Bool
73 // DP Downstream Port Count (0x7) (Only 1.1+)
74 #define DP_DOWNSTREAMPORT_COUNT				0x0007		// Reg
75 #define DP_DOWNSTREAMPORT_COUNT_MASK		(15 << 0)	// Count
76 #define DP_DOWNSTREAMPORT_COUNT_OUI_EN		(1 << 7)	// Bool
77 // DP Port Capability 0
78 #define DP_PORT0_CAPABILITY0				0x0008		// Reg
79 #define DP_PORT1_CAPABILITY0				0x000A		// Reg
80 #define DP_PORT_CAPABILITY0_EDID_EN			(1 << 1)	// Bool
81 #define DP_PORT_CAPABILITY0_SECOND_EN		(1 << 2)	// Bool
82 // DP Port Capability 1
83 #define DP_PORT0_CAPABILITY1				0x0009		// Reg
84 #define DP_PORT1_CAPABILITY1				0x000B		// Reg
85 #define DP_PORT_CAPABILITY1_BUF_SIZE_MASK	(255 << 0)	// Size
86 	// (value + 1) * 32 bytes per lane
87 
88 /* *** DPCD Link Configuration Field (0x0100)         *** */
89 /* *** VESA DisplayPort Standard, rev 1.1, p117       *** */
90 
91 // DP Set Link Rate Per Lane (0x0100)
92 #define DP_LINK_RATE						0x0100		// Reg
93 #define DP_LINK_RATE_162					0x0006		// 1.62Ghz
94 #define DP_LINK_RATE_270					0x000A		// 2.70Ghz
95 #define DP_LINK_RATE_540					0x0014		// 5.40Ghz
96 // DP Set Lane Count (0x0101)
97 #define DP_LANE_COUNT						0x0101		// Reg
98 #define DP_LANE_COUNT_MASK					(31 << 0)	// Count
99 #define DP_ENHANCED_FRAME_EN				(1 << 7)	// Bool, Rev 1.1
100 // DP Training Pattern (0x0102)
101 #define DP_TRAIN							0x0102		// Reg
102 #define DP_TRAIN_PATTERN_MASK				(3 << 0)	// Mask
103 #define DP_TRAIN_PATTERN_DISABLED			(0 << 0)	// Value
104 #define DP_TRAIN_PATTERN_1					(1 << 0)	// Value
105 #define DP_TRAIN_PATTERN_2					(2 << 0)	// Value
106 #define DP_TRAIN_PATTERN_3					(3 << 0)	// Value
107 
108 #define DP_TRAIN_QUAL_MASK					(3 << 2)	// Mask
109 #define DP_TRAIN_QUAL_NONE					(0 << 2)	// Value
110 #define DP_TRAIN_QUAL_D102					(1 << 2)	// Value
111 #define DP_TRAIN_QUAL_SYMB_ERR				(2 << 2)	// Value
112 #define DP_TRAIN_QUAL_PRBS7					(3 << 2)	// Value
113 
114 #define DP_TRAIN_CLOCK_RECOVER_EN			(1 << 4)	// Bool
115 #define DP_TRAIN_SCRAMBLE_DI				(1 << 5)	// Bool (rev)
116 #define DP_TRAIN_SYMBL_ERR_SEL_MASK			(3 << 6)	// Mask
117 #define DP_TRAIN_SYMBL_ERR_SEL_BOTH			(0 << 6)	// Value
118 #define DP_TRAIN_SYMBL_ERR_SEL_DISPARITY	(1 << 6)	// Value
119 #define DP_TRAIN_SYMBL_ERR_SEL_SYMBOL		(2 << 6)	// Value
120 // DP Training Lane n (0x0103 - 0x0106)
121 #define DP_TRAIN_LANE0						0x0103		// Reg
122 #define DP_TRAIN_LANE1						0x0104		// Reg
123 #define DP_TRAIN_LANE2						0x0105		// Reg
124 #define DP_TRAIN_LANE3						0x0106		// Reg
125 
126 #define DP_TRAIN_VCC_SWING_SHIFT			(0 << 0)	// Shift
127 #define DP_TRAIN_VCC_SWING_MASK				(3 << 0)	// Mask
128 #define DP_TRAIN_VCC_SWING_400				(0 << 0)	// Value
129 #define DP_TRAIN_VCC_SWING_600				(1 << 0)	// Value
130 #define DP_TRAIN_VCC_SWING_800				(2 << 0)	// Value
131 #define DP_TRAIN_VCC_SWING_1200				(3 << 0)	// Value
132 #define DP_TRAIN_MAX_SWING_EN				(1 << 2)	// Bool
133 
134 #define DP_TRAIN_PRE_EMPHASIS_SHIFT			(3 << 0)	// Shift
135 #define DP_TRAIN_PRE_EMPHASIS_MASK			(3 << 3)	// Mask
136 #define DP_TRAIN_PRE_EMPHASIS_0				(0 << 3)	// Value
137 #define DP_TRAIN_PRE_EMPHASIS_3_5			(1 << 3)	// Value
138 #define DP_TRAIN_PRE_EMPHASIS_6				(2 << 3)	// Value
139 #define DP_TRAIN_PRE_EMPHASIS_9_5			(3 << 3)	// Value
140 #define DP_TRAIN_MAX_EMPHASIS_EN			(1 << 5)	// Bool
141 // DP Down-spread Control (0x0107)
142 #define DP_DOWNSPREAD_CTRL					0x0107		// Reg
143 #define DP_DOWNSPREAD_CTRL_FREQ_MASK		(1 << 0)	// Int
144 #define DP_DOWNSPREAD_CTRL_AMP_EN			(1 << 4)	// Int
145 // DP Main Link Channel Coding (0x0108)
146 #define DP_MAIN_CHAN_CODE					0x0108		// Reg
147 #define DP_MAIN_CHAN_CODE_ANSIX3_EN			(1 << 0)	// Bool
148 
149 /* *** DPCD Link / Sink Status Field (0x0200)         *** */
150 /* *** VESA DisplayPort Standard, rev 1.1, p120       *** */
151 
152 // DP Sink Count (0x0200)
153 #define DP_SINK_COUNT						0x0200		// Reg
154 #define DP_SINK_COUNT_MASK					(63 << 0)	// Mask
155 #define DP_SINK_COUNT_CP_READY				(1 << 6)	// Bool
156 // DP Service IRQ Vector (0x0201)
157 #define DP_SINK_IRQ_VECTOR					0x0201		// Reg
158 #define DP_SINK_IRQ_TEST_REQ				(1 << 1)	// Bool
159 #define DP_SINK_IRQ_CP_IRQ					(1 << 2)	// Bool
160 #define DP_SINK_IRQ_VENDOR					(1 << 6)	// Bool
161 // DP Lane Status      A B
162 #define DP_LANE_STATUS_0_1					0x0202		// Reg
163 #define DP_LANE_STATUS_2_3					0x0203		// Reg
164 #define DP_LINK_STATUS_SIZE					6			// Size
165 #define DP_LANE_STATUS_CR_DONE_A			(1 << 0)	// Bool
166 #define DP_LANE_STATUS_CHEQ_DONE_A			(1 << 1)	// Bool
167 #define DP_LANE_STATUS_SYMB_LOCK_A			(1 << 2)	// Bool
168 #define DP_LANE_STATUS_CR_DONE_B			(1 << 4)	// Bool
169 #define DP_LANE_STATUS_CHEQ_DONE_B			(1 << 5)	// Bool
170 #define DP_LANE_STATUS_SYMB_LOCK_B			(1 << 6)	// Bool
171 #define DP_LANE_STATUS_EQUALIZED_A			DP_LANE_STATUS_CR_DONE_A \
172 											|| DP_LANE_STATUS_CHEQ_DONE_A \
173 											|| DP_LANE_STATUS_SYMB_LOCK_A
174 #define DP_LANE_STATUS_EQUALIZED_B			DP_LANE_STATUS_CR_DONE_B \
175 											|| DP_LANE_STATUS_CHEQ_DONE_B \
176 											|| DP_LANE_STATUS_SYMB_LOCK_B
177 // DP Lane Align Status (0x0204)
178 #define DP_LANE_ALIGN						0x0204		// Reg
179 #define DP_LANE_ALIGN_DONE					(1 << 0)	// Bool
180 #define DP_LANE_ALIGN_PORT_STATUS_CHANGE	(1 << 6)	// Bool
181 #define DP_LANE_ALIGN_LINK_STATUS_UPDATE	(1 << 7)	// Bool
182 // DP Sink Status (0x0205)
183 #define DP_SINK_STATUS						0x0205		// Reg
184 #define DP_SINK_STATUS_IN_SYNC_0			(1 << 0)	// Bool
185 #define DP_SINK_STATUS_IN_SYNC_1			(1 << 1)	// Bool
186 // DP Adjust Request   A B
187 #define DP_ADJ_REQUEST_0_1					0x0206		// Reg
188 #define DP_ADJ_REQUEST_2_3					0x0207		// Reg
189 #define DP_ADJ_VCC_SWING_LANEA_SHIFT		0			// Shift
190 #define DP_ADJ_VCC_SWING_LANEA_MASK			(3 << 0)	// Mask
191 #define DP_ADJ_PRE_EMPHASIS_LANEA_SHIFT		2			// Shift
192 #define DP_ADJ_PRE_EMPHASIS_LANEA_MASK		(3 << 2)	// Mask
193 #define DP_ADJ_VCC_SWING_LANEB_SHIFT		4			// Shift
194 #define DP_ADJ_VCC_SRING_LANEB_MASK			(3 << 4)	// Mask
195 #define DP_ADJ_PRE_EMPHASIS_LANEB_SHIFT		6			// Shift
196 #define DP_ADJ_PRE_EMPHASIS_LANEB_MASK		(3 << 6)	// Mask
197 
198 // TODO: 0x0210 - 0x0217
199 
200 /* *** DPCD Automated Self-testing Field (0x0218)     *** */
201 /* *** VESA DisplayPort Standard, rev 1.1, p123       *** */
202 
203 // TODO: Optional Field
204 
205 /* *** DPCD Source Device Specific Field (0x0300)     *** */
206 /* *** VESA DisplayPort Standard, rev 1.1, p127       *** */
207 
208 // TODO
209 
210 /* *** DPCD Sink Device Specific Field (0x0400)       *** */
211 /* *** VESA DisplayPort Standard, rev 1.1, p127       *** */
212 
213 // TODO
214 
215 /* *** DPCD Branch Device Specific Field (0x0500)     *** */
216 /* *** VESA DisplayPort Standard, rev 1.1, p127       *** */
217 
218 // TODO
219 
220 /* *** DPCD Sink Control Field (0x0600)               *** */
221 /* *** VESA DisplayPort Standard, rev 1.1, p128       *** */
222 
223 #define DP_SET_POWER						0x0600		// Reg
224 #define DP_SET_POWER_D0						(1 << 0)	// Value
225 #define DP_SET_POWER_D3						(1 << 1)	// Value
226 
227 /* *** DPCD Reserved (0x0700+)                        *** */
228 /* ****************************************************** */
229 
230 
231 #endif /* _DP_RAW_H */
232