1 /* 2 * Copyright © 2008 Keith Packard 3 * 4 * Permission to use, copy, modify, distribute, and sell this software and its 5 * documentation for any purpose is hereby granted without fee, provided that 6 * the above copyright notice appear in all copies and that both that copyright 7 * notice and this permission notice appear in supporting documentation, and 8 * that the name of the copyright holders not be used in advertising or 9 * publicity pertaining to distribution of the software without specific, 10 * written prior permission. The copyright holders make no representations 11 * about the suitability of this software for any purpose. It is provided "as 12 * is" without express or implied warranty. 13 * 14 * THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, 15 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO 16 * EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY SPECIAL, INDIRECT OR 17 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, 18 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER 19 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE 20 * OF THIS SOFTWARE. 21 * 22 * $FreeBSD: src/sys/dev/drm2/drm_dp_helper.h,v 1.1 2012/05/22 11:07:44 kib Exp $ 23 */ 24 25 #ifndef _DRM_DP_HELPER_H_ 26 #define _DRM_DP_HELPER_H_ 27 28 /* 29 * Unless otherwise noted, all values are from the DP 1.1a spec. Note that 30 * DP and DPCD versions are independent. Differences from 1.0 are not noted, 31 * 1.0 devices basically don't exist in the wild. 32 * 33 * Abbreviations, in chronological order: 34 * 35 * eDP: Embedded DisplayPort version 1 36 * DPI: DisplayPort Interoperability Guideline v1.1a 37 * 1.2: DisplayPort 1.2 38 * 39 * 1.2 formally includes both eDP and DPI definitions. 40 */ 41 42 #define AUX_NATIVE_WRITE 0x8 43 #define AUX_NATIVE_READ 0x9 44 #define AUX_I2C_WRITE 0x0 45 #define AUX_I2C_READ 0x1 46 #define AUX_I2C_STATUS 0x2 47 #define AUX_I2C_MOT 0x4 48 49 #define AUX_NATIVE_REPLY_ACK (0x0 << 4) 50 #define AUX_NATIVE_REPLY_NACK (0x1 << 4) 51 #define AUX_NATIVE_REPLY_DEFER (0x2 << 4) 52 #define AUX_NATIVE_REPLY_MASK (0x3 << 4) 53 54 #define AUX_I2C_REPLY_ACK (0x0 << 6) 55 #define AUX_I2C_REPLY_NACK (0x1 << 6) 56 #define AUX_I2C_REPLY_DEFER (0x2 << 6) 57 #define AUX_I2C_REPLY_MASK (0x3 << 6) 58 59 /* AUX CH addresses */ 60 /* DPCD */ 61 #define DP_DPCD_REV 0x000 62 63 #define DP_MAX_LINK_RATE 0x001 64 65 #define DP_MAX_LANE_COUNT 0x002 66 # define DP_MAX_LANE_COUNT_MASK 0x1f 67 # define DP_TPS3_SUPPORTED (1 << 6) /* 1.2 */ 68 # define DP_ENHANCED_FRAME_CAP (1 << 7) 69 70 #define DP_MAX_DOWNSPREAD 0x003 71 # define DP_NO_AUX_HANDSHAKE_LINK_TRAINING (1 << 6) 72 73 #define DP_NORP 0x004 74 75 #define DP_DOWNSTREAMPORT_PRESENT 0x005 76 # define DP_DWN_STRM_PORT_PRESENT (1 << 0) 77 # define DP_DWN_STRM_PORT_TYPE_MASK 0x06 78 /* 00b = DisplayPort */ 79 /* 01b = Analog */ 80 /* 10b = TMDS or HDMI */ 81 /* 11b = Other */ 82 # define DP_FORMAT_CONVERSION (1 << 3) 83 # define DP_DETAILED_CAP_INFO_AVAILABLE (1 << 4) /* DPI */ 84 85 #define DP_MAIN_LINK_CHANNEL_CODING 0x006 86 87 #define DP_DOWN_STREAM_PORT_COUNT 0x007 88 # define DP_PORT_COUNT_MASK 0x0f 89 # define DP_MSA_TIMING_PAR_IGNORED (1 << 6) /* eDP */ 90 # define DP_OUI_SUPPORT (1 << 7) 91 92 #define DP_I2C_SPEED_CAP 0x00c /* DPI */ 93 # define DP_I2C_SPEED_1K 0x01 94 # define DP_I2C_SPEED_5K 0x02 95 # define DP_I2C_SPEED_10K 0x04 96 # define DP_I2C_SPEED_100K 0x08 97 # define DP_I2C_SPEED_400K 0x10 98 # define DP_I2C_SPEED_1M 0x20 99 100 #define DP_EDP_CONFIGURATION_CAP 0x00d /* XXX 1.2? */ 101 #define DP_TRAINING_AUX_RD_INTERVAL 0x00e /* XXX 1.2? */ 102 103 /* Multiple stream transport */ 104 #define DP_MSTM_CAP 0x021 /* 1.2 */ 105 # define DP_MST_CAP (1 << 0) 106 107 #define DP_PSR_SUPPORT 0x070 /* XXX 1.2? */ 108 # define DP_PSR_IS_SUPPORTED 1 109 #define DP_PSR_CAPS 0x071 /* XXX 1.2? */ 110 # define DP_PSR_NO_TRAIN_ON_EXIT 1 111 # define DP_PSR_SETUP_TIME_330 (0 << 1) 112 # define DP_PSR_SETUP_TIME_275 (1 << 1) 113 # define DP_PSR_SETUP_TIME_220 (2 << 1) 114 # define DP_PSR_SETUP_TIME_165 (3 << 1) 115 # define DP_PSR_SETUP_TIME_110 (4 << 1) 116 # define DP_PSR_SETUP_TIME_55 (5 << 1) 117 # define DP_PSR_SETUP_TIME_0 (6 << 1) 118 # define DP_PSR_SETUP_TIME_MASK (7 << 1) 119 # define DP_PSR_SETUP_TIME_SHIFT 1 120 121 /* 122 * 0x80-0x8f describe downstream port capabilities, but there are two layouts 123 * based on whether DP_DETAILED_CAP_INFO_AVAILABLE was set. If it was not, 124 * each port's descriptor is one byte wide. If it was set, each port's is 125 * four bytes wide, starting with the one byte from the base info. As of 126 * DP interop v1.1a only VGA defines additional detail. 127 */ 128 129 /* offset 0 */ 130 #define DP_DOWNSTREAM_PORT_0 0x80 131 # define DP_DS_PORT_TYPE_MASK (7 << 0) 132 # define DP_DS_PORT_TYPE_DP 0 133 # define DP_DS_PORT_TYPE_VGA 1 134 # define DP_DS_PORT_TYPE_DVI 2 135 # define DP_DS_PORT_TYPE_HDMI 3 136 # define DP_DS_PORT_TYPE_NON_EDID 4 137 # define DP_DS_PORT_HPD (1 << 3) 138 /* offset 1 for VGA is maximum megapixels per second / 8 */ 139 /* offset 2 */ 140 # define DP_DS_VGA_MAX_BPC_MASK (3 << 0) 141 # define DP_DS_VGA_8BPC 0 142 # define DP_DS_VGA_10BPC 1 143 # define DP_DS_VGA_12BPC 2 144 # define DP_DS_VGA_16BPC 3 145 146 /* link configuration */ 147 #define DP_LINK_BW_SET 0x100 148 # define DP_LINK_BW_1_62 0x06 149 # define DP_LINK_BW_2_7 0x0a 150 # define DP_LINK_BW_5_4 0x14 /* 1.2 */ 151 152 #define DP_LANE_COUNT_SET 0x101 153 # define DP_LANE_COUNT_MASK 0x0f 154 # define DP_LANE_COUNT_ENHANCED_FRAME_EN (1 << 7) 155 156 #define DP_TRAINING_PATTERN_SET 0x102 157 # define DP_TRAINING_PATTERN_DISABLE 0 158 # define DP_TRAINING_PATTERN_1 1 159 # define DP_TRAINING_PATTERN_2 2 160 # define DP_TRAINING_PATTERN_3 3 /* 1.2 */ 161 # define DP_TRAINING_PATTERN_MASK 0x3 162 163 # define DP_LINK_QUAL_PATTERN_DISABLE (0 << 2) 164 # define DP_LINK_QUAL_PATTERN_D10_2 (1 << 2) 165 # define DP_LINK_QUAL_PATTERN_ERROR_RATE (2 << 2) 166 # define DP_LINK_QUAL_PATTERN_PRBS7 (3 << 2) 167 # define DP_LINK_QUAL_PATTERN_MASK (3 << 2) 168 169 # define DP_RECOVERED_CLOCK_OUT_EN (1 << 4) 170 # define DP_LINK_SCRAMBLING_DISABLE (1 << 5) 171 172 # define DP_SYMBOL_ERROR_COUNT_BOTH (0 << 6) 173 # define DP_SYMBOL_ERROR_COUNT_DISPARITY (1 << 6) 174 # define DP_SYMBOL_ERROR_COUNT_SYMBOL (2 << 6) 175 # define DP_SYMBOL_ERROR_COUNT_MASK (3 << 6) 176 177 #define DP_TRAINING_LANE0_SET 0x103 178 #define DP_TRAINING_LANE1_SET 0x104 179 #define DP_TRAINING_LANE2_SET 0x105 180 #define DP_TRAINING_LANE3_SET 0x106 181 182 # define DP_TRAIN_VOLTAGE_SWING_MASK 0x3 183 # define DP_TRAIN_VOLTAGE_SWING_SHIFT 0 184 # define DP_TRAIN_MAX_SWING_REACHED (1 << 2) 185 # define DP_TRAIN_VOLTAGE_SWING_400 (0 << 0) 186 # define DP_TRAIN_VOLTAGE_SWING_600 (1 << 0) 187 # define DP_TRAIN_VOLTAGE_SWING_800 (2 << 0) 188 # define DP_TRAIN_VOLTAGE_SWING_1200 (3 << 0) 189 190 # define DP_TRAIN_PRE_EMPHASIS_MASK (3 << 3) 191 # define DP_TRAIN_PRE_EMPHASIS_0 (0 << 3) 192 # define DP_TRAIN_PRE_EMPHASIS_3_5 (1 << 3) 193 # define DP_TRAIN_PRE_EMPHASIS_6 (2 << 3) 194 # define DP_TRAIN_PRE_EMPHASIS_9_5 (3 << 3) 195 196 # define DP_TRAIN_PRE_EMPHASIS_SHIFT 3 197 # define DP_TRAIN_MAX_PRE_EMPHASIS_REACHED (1 << 5) 198 199 #define DP_DOWNSPREAD_CTRL 0x107 200 # define DP_SPREAD_AMP_0_5 (1 << 4) 201 # define DP_MSA_TIMING_PAR_IGNORE_EN (1 << 7) /* eDP */ 202 203 #define DP_MAIN_LINK_CHANNEL_CODING_SET 0x108 204 # define DP_SET_ANSI_8B10B (1 << 0) 205 206 #define DP_I2C_SPEED_CONTROL_STATUS 0x109 /* DPI */ 207 /* bitmask as for DP_I2C_SPEED_CAP */ 208 209 #define DP_EDP_CONFIGURATION_SET 0x10a /* XXX 1.2? */ 210 211 #define DP_MSTM_CTRL 0x111 /* 1.2 */ 212 # define DP_MST_EN (1 << 0) 213 # define DP_UP_REQ_EN (1 << 1) 214 # define DP_UPSTREAM_IS_SRC (1 << 2) 215 216 #define DP_PSR_EN_CFG 0x170 /* XXX 1.2? */ 217 # define DP_PSR_ENABLE (1 << 0) 218 # define DP_PSR_MAIN_LINK_ACTIVE (1 << 1) 219 # define DP_PSR_CRC_VERIFICATION (1 << 2) 220 # define DP_PSR_FRAME_CAPTURE (1 << 3) 221 222 #define DP_SINK_COUNT 0x200 223 /* prior to 1.2 bit 7 was reserved mbz */ 224 # define DP_GET_SINK_COUNT(x) ((((x) & 0x80) >> 1) | ((x) & 0x3f)) 225 # define DP_SINK_CP_READY (1 << 6) 226 227 #define DP_DEVICE_SERVICE_IRQ_VECTOR 0x201 228 # define DP_REMOTE_CONTROL_COMMAND_PENDING (1 << 0) 229 # define DP_AUTOMATED_TEST_REQUEST (1 << 1) 230 # define DP_CP_IRQ (1 << 2) 231 # define DP_SINK_SPECIFIC_IRQ (1 << 6) 232 233 #define DP_LANE0_1_STATUS 0x202 234 #define DP_LANE2_3_STATUS 0x203 235 # define DP_LANE_CR_DONE (1 << 0) 236 # define DP_LANE_CHANNEL_EQ_DONE (1 << 1) 237 # define DP_LANE_SYMBOL_LOCKED (1 << 2) 238 239 #define DP_CHANNEL_EQ_BITS (DP_LANE_CR_DONE | \ 240 DP_LANE_CHANNEL_EQ_DONE | \ 241 DP_LANE_SYMBOL_LOCKED) 242 243 #define DP_LANE_ALIGN_STATUS_UPDATED 0x204 244 245 #define DP_INTERLANE_ALIGN_DONE (1 << 0) 246 #define DP_DOWNSTREAM_PORT_STATUS_CHANGED (1 << 6) 247 #define DP_LINK_STATUS_UPDATED (1 << 7) 248 249 #define DP_SINK_STATUS 0x205 250 251 #define DP_RECEIVE_PORT_0_STATUS (1 << 0) 252 #define DP_RECEIVE_PORT_1_STATUS (1 << 1) 253 254 #define DP_ADJUST_REQUEST_LANE0_1 0x206 255 #define DP_ADJUST_REQUEST_LANE2_3 0x207 256 # define DP_ADJUST_VOLTAGE_SWING_LANE0_MASK 0x03 257 # define DP_ADJUST_VOLTAGE_SWING_LANE0_SHIFT 0 258 # define DP_ADJUST_PRE_EMPHASIS_LANE0_MASK 0x0c 259 # define DP_ADJUST_PRE_EMPHASIS_LANE0_SHIFT 2 260 # define DP_ADJUST_VOLTAGE_SWING_LANE1_MASK 0x30 261 # define DP_ADJUST_VOLTAGE_SWING_LANE1_SHIFT 4 262 # define DP_ADJUST_PRE_EMPHASIS_LANE1_MASK 0xc0 263 # define DP_ADJUST_PRE_EMPHASIS_LANE1_SHIFT 6 264 265 #define DP_TEST_REQUEST 0x218 266 # define DP_TEST_LINK_TRAINING (1 << 0) 267 # define DP_TEST_LINK_PATTERN (1 << 1) 268 # define DP_TEST_LINK_EDID_READ (1 << 2) 269 # define DP_TEST_LINK_PHY_TEST_PATTERN (1 << 3) /* DPCD >= 1.1 */ 270 271 #define DP_TEST_LINK_RATE 0x219 272 # define DP_LINK_RATE_162 (0x6) 273 # define DP_LINK_RATE_27 (0xa) 274 275 #define DP_TEST_LANE_COUNT 0x220 276 277 #define DP_TEST_PATTERN 0x221 278 279 #define DP_TEST_RESPONSE 0x260 280 # define DP_TEST_ACK (1 << 0) 281 # define DP_TEST_NAK (1 << 1) 282 # define DP_TEST_EDID_CHECKSUM_WRITE (1 << 2) 283 284 #define DP_SOURCE_OUI 0x300 285 #define DP_SINK_OUI 0x400 286 #define DP_BRANCH_OUI 0x500 287 288 #define DP_SET_POWER 0x600 289 # define DP_SET_POWER_D0 0x1 290 # define DP_SET_POWER_D3 0x2 291 292 #define DP_PSR_ERROR_STATUS 0x2006 /* XXX 1.2? */ 293 # define DP_PSR_LINK_CRC_ERROR (1 << 0) 294 # define DP_PSR_RFB_STORAGE_ERROR (1 << 1) 295 296 #define DP_PSR_ESI 0x2007 /* XXX 1.2? */ 297 # define DP_PSR_CAPS_CHANGE (1 << 0) 298 299 #define DP_PSR_STATUS 0x2008 /* XXX 1.2? */ 300 # define DP_PSR_SINK_INACTIVE 0 301 # define DP_PSR_SINK_ACTIVE_SRC_SYNCED 1 302 # define DP_PSR_SINK_ACTIVE_RFB 2 303 # define DP_PSR_SINK_ACTIVE_SINK_SYNCED 3 304 # define DP_PSR_SINK_ACTIVE_RESYNC 4 305 # define DP_PSR_SINK_INTERNAL_ERROR 7 306 # define DP_PSR_SINK_STATE_MASK 0x07 307 308 #define MODE_I2C_START 1 309 #define MODE_I2C_WRITE 2 310 #define MODE_I2C_READ 4 311 #define MODE_I2C_STOP 8 312 313 /** 314 * struct i2c_algo_dp_aux_data - driver interface structure for i2c over dp 315 * aux algorithm 316 * @running: set by the algo indicating whether an i2c is ongoing or whether 317 * the i2c bus is quiescent 318 * @address: i2c target address for the currently ongoing transfer 319 * @aux_ch: driver callback to transfer a single byte of the i2c payload 320 */ 321 struct iic_dp_aux_data { 322 bool running; 323 u16 address; 324 void *priv; 325 int (*aux_ch)(device_t adapter, int mode, uint8_t write_byte, 326 uint8_t *read_byte); 327 device_t port; 328 }; 329 330 int iic_dp_aux_add_bus(device_t dev, const char *name, 331 int (*ch)(device_t idev, int mode, uint8_t write_byte, uint8_t *read_byte), 332 void *priv, device_t *bus, device_t *adapter); 333 334 335 #define DP_LINK_STATUS_SIZE 6 336 bool drm_dp_channel_eq_ok(u8 link_status[DP_LINK_STATUS_SIZE], 337 int lane_count); 338 bool drm_dp_clock_recovery_ok(u8 link_status[DP_LINK_STATUS_SIZE], 339 int lane_count); 340 u8 drm_dp_get_adjust_request_voltage(u8 link_status[DP_LINK_STATUS_SIZE], 341 int lane); 342 u8 drm_dp_get_adjust_request_pre_emphasis(u8 link_status[DP_LINK_STATUS_SIZE], 343 int lane); 344 345 #define DP_RECEIVER_CAP_SIZE 0xf 346 void drm_dp_link_train_clock_recovery_delay(u8 dpcd[DP_RECEIVER_CAP_SIZE]); 347 void drm_dp_link_train_channel_eq_delay(u8 dpcd[DP_RECEIVER_CAP_SIZE]); 348 349 u8 drm_dp_link_rate_to_bw_code(int link_rate); 350 int drm_dp_bw_code_to_link_rate(u8 link_bw); 351 352 static inline int 353 drm_dp_max_link_rate(u8 dpcd[DP_RECEIVER_CAP_SIZE]) 354 { 355 return drm_dp_bw_code_to_link_rate(dpcd[DP_MAX_LINK_RATE]); 356 } 357 358 static inline u8 359 drm_dp_max_lane_count(u8 dpcd[DP_RECEIVER_CAP_SIZE]) 360 { 361 return dpcd[DP_MAX_LANE_COUNT] & DP_MAX_LANE_COUNT_MASK; 362 } 363 364 #endif /* _DRM_DP_HELPER_H_ */ 365