blob: 9305c718d789b703c3a073f339c9c9b7e0ea352e [file] [log] [blame]
Keith Packarda4fc5ed2009-04-07 16:16:42 -07001/*
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
Dave Airlieab2c0672009-12-04 10:55:24 +100023#ifndef _DRM_DP_HELPER_H_
24#define _DRM_DP_HELPER_H_
Keith Packarda4fc5ed2009-04-07 16:16:42 -070025
Jesse Barnes9f0e7ff2010-10-07 16:01:14 -070026#include <linux/types.h>
27#include <linux/i2c.h>
Daniel Vetter1a644cd2012-10-18 15:32:40 +020028#include <linux/delay.h>
Jesse Barnes9f0e7ff2010-10-07 16:01:14 -070029
Adam Jacksona477f4f2012-09-20 16:42:44 -040030/*
31 * Unless otherwise noted, all values are from the DP 1.1a spec. Note that
32 * DP and DPCD versions are independent. Differences from 1.0 are not noted,
33 * 1.0 devices basically don't exist in the wild.
34 *
35 * Abbreviations, in chronological order:
36 *
37 * eDP: Embedded DisplayPort version 1
38 * DPI: DisplayPort Interoperability Guideline v1.1a
39 * 1.2: DisplayPort 1.2
Dave Airlie3c8a0922014-05-02 11:05:21 +100040 * MST: Multistream Transport - part of DP 1.2a
Adam Jacksona477f4f2012-09-20 16:42:44 -040041 *
42 * 1.2 formally includes both eDP and DPI definitions.
43 */
Keith Packarda4fc5ed2009-04-07 16:16:42 -070044
Thierry Reding6b27f7f2013-12-16 17:01:29 +010045#define DP_AUX_I2C_WRITE 0x0
46#define DP_AUX_I2C_READ 0x1
47#define DP_AUX_I2C_STATUS 0x2
48#define DP_AUX_I2C_MOT 0x4
49#define DP_AUX_NATIVE_WRITE 0x8
50#define DP_AUX_NATIVE_READ 0x9
Keith Packarda4fc5ed2009-04-07 16:16:42 -070051
Thierry Reding6b27f7f2013-12-16 17:01:29 +010052#define DP_AUX_NATIVE_REPLY_ACK (0x0 << 0)
53#define DP_AUX_NATIVE_REPLY_NACK (0x1 << 0)
54#define DP_AUX_NATIVE_REPLY_DEFER (0x2 << 0)
55#define DP_AUX_NATIVE_REPLY_MASK (0x3 << 0)
Keith Packarda4fc5ed2009-04-07 16:16:42 -070056
Thierry Reding6b27f7f2013-12-16 17:01:29 +010057#define DP_AUX_I2C_REPLY_ACK (0x0 << 2)
58#define DP_AUX_I2C_REPLY_NACK (0x1 << 2)
59#define DP_AUX_I2C_REPLY_DEFER (0x2 << 2)
60#define DP_AUX_I2C_REPLY_MASK (0x3 << 2)
Keith Packarda4fc5ed2009-04-07 16:16:42 -070061
62/* AUX CH addresses */
Alex Deucher5801ead2009-11-24 13:32:59 -050063/* DPCD */
64#define DP_DPCD_REV 0x000
Dave Airlie746c1aa2009-12-08 07:07:28 +100065
Alex Deucher5801ead2009-11-24 13:32:59 -050066#define DP_MAX_LINK_RATE 0x001
67
68#define DP_MAX_LANE_COUNT 0x002
69# define DP_MAX_LANE_COUNT_MASK 0x1f
Adam Jacksona477f4f2012-09-20 16:42:44 -040070# define DP_TPS3_SUPPORTED (1 << 6) /* 1.2 */
Alex Deucher5801ead2009-11-24 13:32:59 -050071# define DP_ENHANCED_FRAME_CAP (1 << 7)
72
73#define DP_MAX_DOWNSPREAD 0x003
74# define DP_NO_AUX_HANDSHAKE_LINK_TRAINING (1 << 6)
75
76#define DP_NORP 0x004
77
78#define DP_DOWNSTREAMPORT_PRESENT 0x005
79# define DP_DWN_STRM_PORT_PRESENT (1 << 0)
80# define DP_DWN_STRM_PORT_TYPE_MASK 0x06
Jani Nikula3d2e4232013-09-27 14:48:41 +030081# define DP_DWN_STRM_PORT_TYPE_DP (0 << 1)
82# define DP_DWN_STRM_PORT_TYPE_ANALOG (1 << 1)
83# define DP_DWN_STRM_PORT_TYPE_TMDS (2 << 1)
84# define DP_DWN_STRM_PORT_TYPE_OTHER (3 << 1)
Alex Deucher5801ead2009-11-24 13:32:59 -050085# define DP_FORMAT_CONVERSION (1 << 3)
Adam Jacksona477f4f2012-09-20 16:42:44 -040086# define DP_DETAILED_CAP_INFO_AVAILABLE (1 << 4) /* DPI */
Alex Deucher5801ead2009-11-24 13:32:59 -050087
88#define DP_MAIN_LINK_CHANNEL_CODING 0x006
89
Adam Jacksonde44d972012-05-14 16:05:46 -040090#define DP_DOWN_STREAM_PORT_COUNT 0x007
Adam Jacksone89861d2012-09-18 10:58:48 -040091# define DP_PORT_COUNT_MASK 0x0f
Adam Jacksona477f4f2012-09-20 16:42:44 -040092# define DP_MSA_TIMING_PAR_IGNORED (1 << 6) /* eDP */
Adam Jacksone89861d2012-09-18 10:58:48 -040093# define DP_OUI_SUPPORT (1 << 7)
94
Adam Jacksona477f4f2012-09-20 16:42:44 -040095#define DP_I2C_SPEED_CAP 0x00c /* DPI */
Adam Jacksone89861d2012-09-18 10:58:48 -040096# define DP_I2C_SPEED_1K 0x01
97# define DP_I2C_SPEED_5K 0x02
98# define DP_I2C_SPEED_10K 0x04
99# define DP_I2C_SPEED_100K 0x08
100# define DP_I2C_SPEED_400K 0x10
101# define DP_I2C_SPEED_1M 0x20
Adam Jacksonde44d972012-05-14 16:05:46 -0400102
Adam Jacksona477f4f2012-09-20 16:42:44 -0400103#define DP_EDP_CONFIGURATION_CAP 0x00d /* XXX 1.2? */
104#define DP_TRAINING_AUX_RD_INTERVAL 0x00e /* XXX 1.2? */
Alex Deucher428c4b52011-05-20 04:34:25 -0400105
Adam Jacksone89861d2012-09-18 10:58:48 -0400106/* Multiple stream transport */
Dave Airlie3c8a0922014-05-02 11:05:21 +1000107#define DP_FAUX_CAP 0x020 /* 1.2 */
108# define DP_FAUX_CAP_1 (1 << 0)
109
Adam Jacksona477f4f2012-09-20 16:42:44 -0400110#define DP_MSTM_CAP 0x021 /* 1.2 */
Adam Jacksone89861d2012-09-18 10:58:48 -0400111# define DP_MST_CAP (1 << 0)
112
Dave Airlie3c8a0922014-05-02 11:05:21 +1000113#define DP_GUID 0x030 /* 1.2 */
114
Adam Jacksona477f4f2012-09-20 16:42:44 -0400115#define DP_PSR_SUPPORT 0x070 /* XXX 1.2? */
Ben Widawskyb73fe582011-10-04 15:16:48 -0700116# define DP_PSR_IS_SUPPORTED 1
Adam Jacksona477f4f2012-09-20 16:42:44 -0400117#define DP_PSR_CAPS 0x071 /* XXX 1.2? */
Ben Widawskyb73fe582011-10-04 15:16:48 -0700118# define DP_PSR_NO_TRAIN_ON_EXIT 1
119# define DP_PSR_SETUP_TIME_330 (0 << 1)
120# define DP_PSR_SETUP_TIME_275 (1 << 1)
121# define DP_PSR_SETUP_TIME_220 (2 << 1)
122# define DP_PSR_SETUP_TIME_165 (3 << 1)
123# define DP_PSR_SETUP_TIME_110 (4 << 1)
124# define DP_PSR_SETUP_TIME_55 (5 << 1)
125# define DP_PSR_SETUP_TIME_0 (6 << 1)
126# define DP_PSR_SETUP_TIME_MASK (7 << 1)
127# define DP_PSR_SETUP_TIME_SHIFT 1
128
Adam Jacksone89861d2012-09-18 10:58:48 -0400129/*
130 * 0x80-0x8f describe downstream port capabilities, but there are two layouts
131 * based on whether DP_DETAILED_CAP_INFO_AVAILABLE was set. If it was not,
132 * each port's descriptor is one byte wide. If it was set, each port's is
133 * four bytes wide, starting with the one byte from the base info. As of
134 * DP interop v1.1a only VGA defines additional detail.
135 */
136
137/* offset 0 */
138#define DP_DOWNSTREAM_PORT_0 0x80
139# define DP_DS_PORT_TYPE_MASK (7 << 0)
140# define DP_DS_PORT_TYPE_DP 0
141# define DP_DS_PORT_TYPE_VGA 1
142# define DP_DS_PORT_TYPE_DVI 2
143# define DP_DS_PORT_TYPE_HDMI 3
144# define DP_DS_PORT_TYPE_NON_EDID 4
145# define DP_DS_PORT_HPD (1 << 3)
146/* offset 1 for VGA is maximum megapixels per second / 8 */
147/* offset 2 */
148# define DP_DS_VGA_MAX_BPC_MASK (3 << 0)
149# define DP_DS_VGA_8BPC 0
150# define DP_DS_VGA_10BPC 1
151# define DP_DS_VGA_12BPC 2
152# define DP_DS_VGA_16BPC 3
153
Alex Deucher5801ead2009-11-24 13:32:59 -0500154/* link configuration */
155#define DP_LINK_BW_SET 0x100
Keith Packarda4fc5ed2009-04-07 16:16:42 -0700156# define DP_LINK_BW_1_62 0x06
157# define DP_LINK_BW_2_7 0x0a
Adam Jacksona477f4f2012-09-20 16:42:44 -0400158# define DP_LINK_BW_5_4 0x14 /* 1.2 */
Keith Packarda4fc5ed2009-04-07 16:16:42 -0700159
Alex Deucher5801ead2009-11-24 13:32:59 -0500160#define DP_LANE_COUNT_SET 0x101
Keith Packarda4fc5ed2009-04-07 16:16:42 -0700161# define DP_LANE_COUNT_MASK 0x0f
162# define DP_LANE_COUNT_ENHANCED_FRAME_EN (1 << 7)
163
Alex Deucher5801ead2009-11-24 13:32:59 -0500164#define DP_TRAINING_PATTERN_SET 0x102
Keith Packarda4fc5ed2009-04-07 16:16:42 -0700165# define DP_TRAINING_PATTERN_DISABLE 0
166# define DP_TRAINING_PATTERN_1 1
167# define DP_TRAINING_PATTERN_2 2
Adam Jacksona477f4f2012-09-20 16:42:44 -0400168# define DP_TRAINING_PATTERN_3 3 /* 1.2 */
Keith Packarda4fc5ed2009-04-07 16:16:42 -0700169# define DP_TRAINING_PATTERN_MASK 0x3
170
171# define DP_LINK_QUAL_PATTERN_DISABLE (0 << 2)
172# define DP_LINK_QUAL_PATTERN_D10_2 (1 << 2)
173# define DP_LINK_QUAL_PATTERN_ERROR_RATE (2 << 2)
174# define DP_LINK_QUAL_PATTERN_PRBS7 (3 << 2)
175# define DP_LINK_QUAL_PATTERN_MASK (3 << 2)
176
177# define DP_RECOVERED_CLOCK_OUT_EN (1 << 4)
178# define DP_LINK_SCRAMBLING_DISABLE (1 << 5)
179
180# define DP_SYMBOL_ERROR_COUNT_BOTH (0 << 6)
181# define DP_SYMBOL_ERROR_COUNT_DISPARITY (1 << 6)
182# define DP_SYMBOL_ERROR_COUNT_SYMBOL (2 << 6)
183# define DP_SYMBOL_ERROR_COUNT_MASK (3 << 6)
184
185#define DP_TRAINING_LANE0_SET 0x103
186#define DP_TRAINING_LANE1_SET 0x104
187#define DP_TRAINING_LANE2_SET 0x105
188#define DP_TRAINING_LANE3_SET 0x106
189
190# define DP_TRAIN_VOLTAGE_SWING_MASK 0x3
191# define DP_TRAIN_VOLTAGE_SWING_SHIFT 0
192# define DP_TRAIN_MAX_SWING_REACHED (1 << 2)
Sonika Jindal0504cd12014-08-08 16:23:40 +0530193# define DP_TRAIN_VOLTAGE_SWING_LEVEL_0 (0 << 0)
Sonika Jindal0504cd12014-08-08 16:23:40 +0530194# define DP_TRAIN_VOLTAGE_SWING_LEVEL_1 (1 << 0)
Sonika Jindal0504cd12014-08-08 16:23:40 +0530195# define DP_TRAIN_VOLTAGE_SWING_LEVEL_2 (2 << 0)
Sonika Jindal0504cd12014-08-08 16:23:40 +0530196# define DP_TRAIN_VOLTAGE_SWING_LEVEL_3 (3 << 0)
Keith Packarda4fc5ed2009-04-07 16:16:42 -0700197
198# define DP_TRAIN_PRE_EMPHASIS_MASK (3 << 3)
Sonika Jindal0504cd12014-08-08 16:23:40 +0530199# define DP_TRAIN_PRE_EMPH_LEVEL_0 (0 << 3)
Sonika Jindal0504cd12014-08-08 16:23:40 +0530200# define DP_TRAIN_PRE_EMPH_LEVEL_1 (1 << 3)
Sonika Jindal0504cd12014-08-08 16:23:40 +0530201# define DP_TRAIN_PRE_EMPH_LEVEL_2 (2 << 3)
Sonika Jindal0504cd12014-08-08 16:23:40 +0530202# define DP_TRAIN_PRE_EMPH_LEVEL_3 (3 << 3)
Keith Packarda4fc5ed2009-04-07 16:16:42 -0700203
204# define DP_TRAIN_PRE_EMPHASIS_SHIFT 3
205# define DP_TRAIN_MAX_PRE_EMPHASIS_REACHED (1 << 5)
206
207#define DP_DOWNSPREAD_CTRL 0x107
208# define DP_SPREAD_AMP_0_5 (1 << 4)
Adam Jacksona477f4f2012-09-20 16:42:44 -0400209# define DP_MSA_TIMING_PAR_IGNORE_EN (1 << 7) /* eDP */
Keith Packarda4fc5ed2009-04-07 16:16:42 -0700210
211#define DP_MAIN_LINK_CHANNEL_CODING_SET 0x108
212# define DP_SET_ANSI_8B10B (1 << 0)
213
Adam Jacksona477f4f2012-09-20 16:42:44 -0400214#define DP_I2C_SPEED_CONTROL_STATUS 0x109 /* DPI */
Adam Jacksone89861d2012-09-18 10:58:48 -0400215/* bitmask as for DP_I2C_SPEED_CAP */
216
Adam Jacksona477f4f2012-09-20 16:42:44 -0400217#define DP_EDP_CONFIGURATION_SET 0x10a /* XXX 1.2? */
Adam Jacksone89861d2012-09-18 10:58:48 -0400218
Adam Jacksona477f4f2012-09-20 16:42:44 -0400219#define DP_MSTM_CTRL 0x111 /* 1.2 */
Adam Jacksone89861d2012-09-18 10:58:48 -0400220# define DP_MST_EN (1 << 0)
221# define DP_UP_REQ_EN (1 << 1)
222# define DP_UPSTREAM_IS_SRC (1 << 2)
223
Adam Jacksona477f4f2012-09-20 16:42:44 -0400224#define DP_PSR_EN_CFG 0x170 /* XXX 1.2? */
Ben Widawskyb73fe582011-10-04 15:16:48 -0700225# define DP_PSR_ENABLE (1 << 0)
226# define DP_PSR_MAIN_LINK_ACTIVE (1 << 1)
227# define DP_PSR_CRC_VERIFICATION (1 << 2)
228# define DP_PSR_FRAME_CAPTURE (1 << 3)
229
Dave Airlie3c8a0922014-05-02 11:05:21 +1000230#define DP_ADAPTER_CTRL 0x1a0
231# define DP_ADAPTER_CTRL_FORCE_LOAD_SENSE (1 << 0)
232
233#define DP_BRANCH_DEVICE_CTRL 0x1a1
234# define DP_BRANCH_DEVICE_IRQ_HPD (1 << 0)
235
236#define DP_PAYLOAD_ALLOCATE_SET 0x1c0
237#define DP_PAYLOAD_ALLOCATE_START_TIME_SLOT 0x1c1
238#define DP_PAYLOAD_ALLOCATE_TIME_SLOT_COUNT 0x1c2
239
Adam Jacksone89861d2012-09-18 10:58:48 -0400240#define DP_SINK_COUNT 0x200
Adam Jacksonda131a42012-09-20 16:42:45 -0400241/* prior to 1.2 bit 7 was reserved mbz */
242# define DP_GET_SINK_COUNT(x) ((((x) & 0x80) >> 1) | ((x) & 0x3f))
Adam Jacksone89861d2012-09-18 10:58:48 -0400243# define DP_SINK_CP_READY (1 << 6)
244
Jesse Barnesa60f0e32011-10-20 15:09:17 -0700245#define DP_DEVICE_SERVICE_IRQ_VECTOR 0x201
246# define DP_REMOTE_CONTROL_COMMAND_PENDING (1 << 0)
247# define DP_AUTOMATED_TEST_REQUEST (1 << 1)
248# define DP_CP_IRQ (1 << 2)
Dave Airlie3c8a0922014-05-02 11:05:21 +1000249# define DP_MCCS_IRQ (1 << 3)
250# define DP_DOWN_REP_MSG_RDY (1 << 4) /* 1.2 MST */
251# define DP_UP_REQ_MSG_RDY (1 << 5) /* 1.2 MST */
Jesse Barnesa60f0e32011-10-20 15:09:17 -0700252# define DP_SINK_SPECIFIC_IRQ (1 << 6)
253
Keith Packarda4fc5ed2009-04-07 16:16:42 -0700254#define DP_LANE0_1_STATUS 0x202
255#define DP_LANE2_3_STATUS 0x203
Keith Packarda4fc5ed2009-04-07 16:16:42 -0700256# define DP_LANE_CR_DONE (1 << 0)
257# define DP_LANE_CHANNEL_EQ_DONE (1 << 1)
258# define DP_LANE_SYMBOL_LOCKED (1 << 2)
259
Alex Deucher5801ead2009-11-24 13:32:59 -0500260#define DP_CHANNEL_EQ_BITS (DP_LANE_CR_DONE | \
261 DP_LANE_CHANNEL_EQ_DONE | \
262 DP_LANE_SYMBOL_LOCKED)
263
Keith Packarda4fc5ed2009-04-07 16:16:42 -0700264#define DP_LANE_ALIGN_STATUS_UPDATED 0x204
265
266#define DP_INTERLANE_ALIGN_DONE (1 << 0)
267#define DP_DOWNSTREAM_PORT_STATUS_CHANGED (1 << 6)
268#define DP_LINK_STATUS_UPDATED (1 << 7)
269
270#define DP_SINK_STATUS 0x205
271
272#define DP_RECEIVE_PORT_0_STATUS (1 << 0)
273#define DP_RECEIVE_PORT_1_STATUS (1 << 1)
274
275#define DP_ADJUST_REQUEST_LANE0_1 0x206
276#define DP_ADJUST_REQUEST_LANE2_3 0x207
Alex Deucher5801ead2009-11-24 13:32:59 -0500277# define DP_ADJUST_VOLTAGE_SWING_LANE0_MASK 0x03
278# define DP_ADJUST_VOLTAGE_SWING_LANE0_SHIFT 0
279# define DP_ADJUST_PRE_EMPHASIS_LANE0_MASK 0x0c
280# define DP_ADJUST_PRE_EMPHASIS_LANE0_SHIFT 2
281# define DP_ADJUST_VOLTAGE_SWING_LANE1_MASK 0x30
282# define DP_ADJUST_VOLTAGE_SWING_LANE1_SHIFT 4
283# define DP_ADJUST_PRE_EMPHASIS_LANE1_MASK 0xc0
284# define DP_ADJUST_PRE_EMPHASIS_LANE1_SHIFT 6
Keith Packarda4fc5ed2009-04-07 16:16:42 -0700285
Jesse Barnesa60f0e32011-10-20 15:09:17 -0700286#define DP_TEST_REQUEST 0x218
287# define DP_TEST_LINK_TRAINING (1 << 0)
Todd Previtefe3c7032013-10-04 12:59:03 -0700288# define DP_TEST_LINK_VIDEO_PATTERN (1 << 1)
Jesse Barnesa60f0e32011-10-20 15:09:17 -0700289# define DP_TEST_LINK_EDID_READ (1 << 2)
290# define DP_TEST_LINK_PHY_TEST_PATTERN (1 << 3) /* DPCD >= 1.1 */
Todd Previtefe3c7032013-10-04 12:59:03 -0700291# define DP_TEST_LINK_FAUX_PATTERN (1 << 4) /* DPCD >= 1.2 */
Jesse Barnesa60f0e32011-10-20 15:09:17 -0700292
293#define DP_TEST_LINK_RATE 0x219
294# define DP_LINK_RATE_162 (0x6)
295# define DP_LINK_RATE_27 (0xa)
296
297#define DP_TEST_LANE_COUNT 0x220
298
299#define DP_TEST_PATTERN 0x221
300
Rodrigo Vivia25eebb2014-01-14 16:21:49 -0200301#define DP_TEST_CRC_R_CR 0x240
302#define DP_TEST_CRC_G_Y 0x242
303#define DP_TEST_CRC_B_CB 0x244
304
305#define DP_TEST_SINK_MISC 0x246
306#define DP_TEST_CRC_SUPPORTED (1 << 5)
307
Jesse Barnesa60f0e32011-10-20 15:09:17 -0700308#define DP_TEST_RESPONSE 0x260
309# define DP_TEST_ACK (1 << 0)
310# define DP_TEST_NAK (1 << 1)
311# define DP_TEST_EDID_CHECKSUM_WRITE (1 << 2)
312
Jingoo Han073ea2a2014-05-07 20:44:51 +0900313#define DP_TEST_EDID_CHECKSUM 0x261
314
Rodrigo Vivia25eebb2014-01-14 16:21:49 -0200315#define DP_TEST_SINK 0x270
316#define DP_TEST_SINK_START (1 << 0)
317
Dave Airlie3c8a0922014-05-02 11:05:21 +1000318#define DP_PAYLOAD_TABLE_UPDATE_STATUS 0x2c0 /* 1.2 MST */
319# define DP_PAYLOAD_TABLE_UPDATED (1 << 0)
320# define DP_PAYLOAD_ACT_HANDLED (1 << 1)
321
322#define DP_VC_PAYLOAD_ID_SLOT_1 0x2c1 /* 1.2 MST */
323/* up to ID_SLOT_63 at 0x2ff */
324
Adam Jackson86c3c3b2012-05-14 16:05:45 -0400325#define DP_SOURCE_OUI 0x300
326#define DP_SINK_OUI 0x400
327#define DP_BRANCH_OUI 0x500
328
Alex Deucher1a66c952009-11-20 19:40:13 -0500329#define DP_SET_POWER 0x600
Alex Deucher5801ead2009-11-24 13:32:59 -0500330# define DP_SET_POWER_D0 0x1
331# define DP_SET_POWER_D3 0x2
Thierry Reding516c0f72013-12-09 11:47:55 +0100332# define DP_SET_POWER_MASK 0x3
Alex Deucher1a66c952009-11-20 19:40:13 -0500333
Dave Airlie3c8a0922014-05-02 11:05:21 +1000334#define DP_SIDEBAND_MSG_DOWN_REQ_BASE 0x1000 /* 1.2 MST */
335#define DP_SIDEBAND_MSG_UP_REP_BASE 0x1200 /* 1.2 MST */
336#define DP_SIDEBAND_MSG_DOWN_REP_BASE 0x1400 /* 1.2 MST */
337#define DP_SIDEBAND_MSG_UP_REQ_BASE 0x1600 /* 1.2 MST */
338
339#define DP_SINK_COUNT_ESI 0x2002 /* 1.2 */
340/* 0-5 sink count */
341# define DP_SINK_COUNT_CP_READY (1 << 6)
342
343#define DP_DEVICE_SERVICE_IRQ_VECTOR_ESI0 0x2003 /* 1.2 */
344
345#define DP_DEVICE_SERVICE_IRQ_VECTOR_ESI1 0x2004 /* 1.2 */
346
347#define DP_LINK_SERVICE_IRQ_VECTOR_ESI0 0x2005 /* 1.2 */
348
Adam Jacksona477f4f2012-09-20 16:42:44 -0400349#define DP_PSR_ERROR_STATUS 0x2006 /* XXX 1.2? */
Ben Widawskyb73fe582011-10-04 15:16:48 -0700350# define DP_PSR_LINK_CRC_ERROR (1 << 0)
351# define DP_PSR_RFB_STORAGE_ERROR (1 << 1)
352
Adam Jacksona477f4f2012-09-20 16:42:44 -0400353#define DP_PSR_ESI 0x2007 /* XXX 1.2? */
Ben Widawskyb73fe582011-10-04 15:16:48 -0700354# define DP_PSR_CAPS_CHANGE (1 << 0)
355
Adam Jacksona477f4f2012-09-20 16:42:44 -0400356#define DP_PSR_STATUS 0x2008 /* XXX 1.2? */
Ben Widawskyb73fe582011-10-04 15:16:48 -0700357# define DP_PSR_SINK_INACTIVE 0
358# define DP_PSR_SINK_ACTIVE_SRC_SYNCED 1
359# define DP_PSR_SINK_ACTIVE_RFB 2
360# define DP_PSR_SINK_ACTIVE_SINK_SYNCED 3
361# define DP_PSR_SINK_ACTIVE_RESYNC 4
362# define DP_PSR_SINK_INTERNAL_ERROR 7
363# define DP_PSR_SINK_STATE_MASK 0x07
364
Dave Airlie3c8a0922014-05-02 11:05:21 +1000365/* DP 1.2 Sideband message defines */
366/* peer device type - DP 1.2a Table 2-92 */
367#define DP_PEER_DEVICE_NONE 0x0
368#define DP_PEER_DEVICE_SOURCE_OR_SST 0x1
369#define DP_PEER_DEVICE_MST_BRANCHING 0x2
370#define DP_PEER_DEVICE_SST_SINK 0x3
371#define DP_PEER_DEVICE_DP_LEGACY_CONV 0x4
372
373/* DP 1.2 MST sideband request names DP 1.2a Table 2-80 */
374#define DP_LINK_ADDRESS 0x01
375#define DP_CONNECTION_STATUS_NOTIFY 0x02
376#define DP_ENUM_PATH_RESOURCES 0x10
377#define DP_ALLOCATE_PAYLOAD 0x11
378#define DP_QUERY_PAYLOAD 0x12
379#define DP_RESOURCE_STATUS_NOTIFY 0x13
380#define DP_CLEAR_PAYLOAD_ID_TABLE 0x14
381#define DP_REMOTE_DPCD_READ 0x20
382#define DP_REMOTE_DPCD_WRITE 0x21
383#define DP_REMOTE_I2C_READ 0x22
384#define DP_REMOTE_I2C_WRITE 0x23
385#define DP_POWER_UP_PHY 0x24
386#define DP_POWER_DOWN_PHY 0x25
387#define DP_SINK_EVENT_NOTIFY 0x30
388#define DP_QUERY_STREAM_ENC_STATUS 0x38
389
390/* DP 1.2 MST sideband nak reasons - table 2.84 */
391#define DP_NAK_WRITE_FAILURE 0x01
392#define DP_NAK_INVALID_READ 0x02
393#define DP_NAK_CRC_FAILURE 0x03
394#define DP_NAK_BAD_PARAM 0x04
395#define DP_NAK_DEFER 0x05
396#define DP_NAK_LINK_FAILURE 0x06
397#define DP_NAK_NO_RESOURCES 0x07
398#define DP_NAK_DPCD_FAIL 0x08
399#define DP_NAK_I2C_NAK 0x09
400#define DP_NAK_ALLOCATE_FAIL 0x0a
401
Dave Airlieab2c0672009-12-04 10:55:24 +1000402#define MODE_I2C_START 1
403#define MODE_I2C_WRITE 2
404#define MODE_I2C_READ 4
405#define MODE_I2C_STOP 8
406
Daniel Vetter28164fd2012-11-01 14:45:18 +0100407/**
408 * struct i2c_algo_dp_aux_data - driver interface structure for i2c over dp
409 * aux algorithm
410 * @running: set by the algo indicating whether an i2c is ongoing or whether
411 * the i2c bus is quiescent
412 * @address: i2c target address for the currently ongoing transfer
413 * @aux_ch: driver callback to transfer a single byte of the i2c payload
414 */
Keith Packarda4fc5ed2009-04-07 16:16:42 -0700415struct i2c_algo_dp_aux_data {
416 bool running;
417 u16 address;
418 int (*aux_ch) (struct i2c_adapter *adapter,
Dave Airlieab2c0672009-12-04 10:55:24 +1000419 int mode, uint8_t write_byte,
420 uint8_t *read_byte);
Keith Packarda4fc5ed2009-04-07 16:16:42 -0700421};
422
423int
424i2c_dp_aux_add_bus(struct i2c_adapter *adapter);
425
Daniel Vetter1ffdff12012-10-18 10:15:24 +0200426
427#define DP_LINK_STATUS_SIZE 6
Jani Nikula0aec2882013-09-27 19:01:01 +0300428bool drm_dp_channel_eq_ok(const u8 link_status[DP_LINK_STATUS_SIZE],
Daniel Vetter1ffdff12012-10-18 10:15:24 +0200429 int lane_count);
Jani Nikula0aec2882013-09-27 19:01:01 +0300430bool drm_dp_clock_recovery_ok(const u8 link_status[DP_LINK_STATUS_SIZE],
Daniel Vetter01916272012-10-18 10:15:25 +0200431 int lane_count);
Jani Nikula0aec2882013-09-27 19:01:01 +0300432u8 drm_dp_get_adjust_request_voltage(const u8 link_status[DP_LINK_STATUS_SIZE],
Daniel Vetter0f037bd2012-10-18 10:15:27 +0200433 int lane);
Jani Nikula0aec2882013-09-27 19:01:01 +0300434u8 drm_dp_get_adjust_request_pre_emphasis(const u8 link_status[DP_LINK_STATUS_SIZE],
Daniel Vetter0f037bd2012-10-18 10:15:27 +0200435 int lane);
Daniel Vetter1ffdff12012-10-18 10:15:24 +0200436
Shobhit Kumar52604b12013-07-11 18:44:55 -0300437#define DP_RECEIVER_CAP_SIZE 0xf
438#define EDP_PSR_RECEIVER_CAP_SIZE 2
439
Jani Nikula0aec2882013-09-27 19:01:01 +0300440void drm_dp_link_train_clock_recovery_delay(const u8 dpcd[DP_RECEIVER_CAP_SIZE]);
441void drm_dp_link_train_channel_eq_delay(const u8 dpcd[DP_RECEIVER_CAP_SIZE]);
Daniel Vetter1a644cd2012-10-18 15:32:40 +0200442
Daniel Vetter3b5c6622012-10-18 10:15:31 +0200443u8 drm_dp_link_rate_to_bw_code(int link_rate);
444int drm_dp_bw_code_to_link_rate(u8 link_bw);
445
Shobhit Kumar52604b12013-07-11 18:44:55 -0300446struct edp_sdp_header {
447 u8 HB0; /* Secondary Data Packet ID */
448 u8 HB1; /* Secondary Data Packet Type */
449 u8 HB2; /* 7:5 reserved, 4:0 revision number */
450 u8 HB3; /* 7:5 reserved, 4:0 number of valid data bytes */
451} __packed;
452
453#define EDP_SDP_HEADER_REVISION_MASK 0x1F
454#define EDP_SDP_HEADER_VALID_PAYLOAD_BYTES 0x1F
455
456struct edp_vsc_psr {
457 struct edp_sdp_header sdp_header;
458 u8 DB0; /* Stereo Interface */
459 u8 DB1; /* 0 - PSR State; 1 - Update RFB; 2 - CRC Valid */
460 u8 DB2; /* CRC value bits 7:0 of the R or Cr component */
461 u8 DB3; /* CRC value bits 15:8 of the R or Cr component */
462 u8 DB4; /* CRC value bits 7:0 of the G or Y component */
463 u8 DB5; /* CRC value bits 15:8 of the G or Y component */
464 u8 DB6; /* CRC value bits 7:0 of the B or Cb component */
465 u8 DB7; /* CRC value bits 15:8 of the B or Cb component */
466 u8 DB8_31[24]; /* Reserved */
467} __packed;
468
469#define EDP_VSC_PSR_STATE_ACTIVE (1<<0)
470#define EDP_VSC_PSR_UPDATE_RFB (1<<1)
471#define EDP_VSC_PSR_CRC_VALUES_VALID (1<<2)
472
Daniel Vetter3b5c6622012-10-18 10:15:31 +0200473static inline int
Jani Nikula0aec2882013-09-27 19:01:01 +0300474drm_dp_max_link_rate(const u8 dpcd[DP_RECEIVER_CAP_SIZE])
Daniel Vetter3b5c6622012-10-18 10:15:31 +0200475{
476 return drm_dp_bw_code_to_link_rate(dpcd[DP_MAX_LINK_RATE]);
477}
Daniel Vetter397fe152012-10-22 22:56:43 +0200478
479static inline u8
Jani Nikula0aec2882013-09-27 19:01:01 +0300480drm_dp_max_lane_count(const u8 dpcd[DP_RECEIVER_CAP_SIZE])
Daniel Vetter397fe152012-10-22 22:56:43 +0200481{
482 return dpcd[DP_MAX_LANE_COUNT] & DP_MAX_LANE_COUNT_MASK;
483}
484
Jani Nikula58704e62013-10-04 15:08:08 +0300485static inline bool
486drm_dp_enhanced_frame_cap(const u8 dpcd[DP_RECEIVER_CAP_SIZE])
487{
488 return dpcd[DP_DPCD_REV] >= 0x11 &&
489 (dpcd[DP_MAX_LANE_COUNT] & DP_ENHANCED_FRAME_CAP);
490}
491
Thierry Redingc197db72013-11-28 11:31:00 +0100492/*
493 * DisplayPort AUX channel
494 */
495
496/**
497 * struct drm_dp_aux_msg - DisplayPort AUX channel transaction
498 * @address: address of the (first) register to access
499 * @request: contains the type of transaction (see DP_AUX_* macros)
500 * @reply: upon completion, contains the reply type of the transaction
501 * @buffer: pointer to a transmission or reception buffer
502 * @size: size of @buffer
503 */
504struct drm_dp_aux_msg {
505 unsigned int address;
506 u8 request;
507 u8 reply;
508 void *buffer;
509 size_t size;
510};
511
512/**
513 * struct drm_dp_aux - DisplayPort AUX channel
Thierry Redingb8380582014-04-23 15:49:04 +0200514 * @name: user-visible name of this AUX channel and the I2C-over-AUX adapter
Thierry Reding88759682013-12-12 09:57:53 +0100515 * @ddc: I2C adapter that can be used for I2C-over-AUX communication
Thierry Redingc197db72013-11-28 11:31:00 +0100516 * @dev: pointer to struct device that is the parent for this AUX channel
Dave Airlie4f71d0c2014-06-04 16:02:28 +1000517 * @hw_mutex: internal mutex used for locking transfers
Thierry Redingc197db72013-11-28 11:31:00 +0100518 * @transfer: transfers a message representing a single AUX transaction
519 *
520 * The .dev field should be set to a pointer to the device that implements
521 * the AUX channel.
522 *
Jani Nikula9dc40562014-03-14 16:51:12 +0200523 * The .name field may be used to specify the name of the I2C adapter. If set to
524 * NULL, dev_name() of .dev will be used.
525 *
Thierry Redingc197db72013-11-28 11:31:00 +0100526 * Drivers provide a hardware-specific implementation of how transactions
527 * are executed via the .transfer() function. A pointer to a drm_dp_aux_msg
528 * structure describing the transaction is passed into this function. Upon
529 * success, the implementation should return the number of payload bytes
530 * that were transferred, or a negative error-code on failure. Helpers
531 * propagate errors from the .transfer() function, with the exception of
532 * the -EBUSY error, which causes a transaction to be retried. On a short,
533 * helpers will return -EPROTO to make it simpler to check for failure.
Thierry Reding88759682013-12-12 09:57:53 +0100534 *
535 * An AUX channel can also be used to transport I2C messages to a sink. A
536 * typical application of that is to access an EDID that's present in the
537 * sink device. The .transfer() function can also be used to execute such
538 * transactions. The drm_dp_aux_register_i2c_bus() function registers an
539 * I2C adapter that can be passed to drm_probe_ddc(). Upon removal, drivers
540 * should call drm_dp_aux_unregister_i2c_bus() to remove the I2C adapter.
Alex Deucher732d50b2014-04-07 10:33:45 -0400541 *
542 * Note that the aux helper code assumes that the .transfer() function
543 * only modifies the reply field of the drm_dp_aux_msg structure. The
544 * retry logic and i2c helpers assume this is the case.
Thierry Redingc197db72013-11-28 11:31:00 +0100545 */
546struct drm_dp_aux {
Jani Nikula9dc40562014-03-14 16:51:12 +0200547 const char *name;
Thierry Reding88759682013-12-12 09:57:53 +0100548 struct i2c_adapter ddc;
Thierry Redingc197db72013-11-28 11:31:00 +0100549 struct device *dev;
Dave Airlie4f71d0c2014-06-04 16:02:28 +1000550 struct mutex hw_mutex;
Thierry Redingc197db72013-11-28 11:31:00 +0100551 ssize_t (*transfer)(struct drm_dp_aux *aux,
552 struct drm_dp_aux_msg *msg);
553};
554
555ssize_t drm_dp_dpcd_read(struct drm_dp_aux *aux, unsigned int offset,
556 void *buffer, size_t size);
557ssize_t drm_dp_dpcd_write(struct drm_dp_aux *aux, unsigned int offset,
558 void *buffer, size_t size);
559
560/**
561 * drm_dp_dpcd_readb() - read a single byte from the DPCD
562 * @aux: DisplayPort AUX channel
563 * @offset: address of the register to read
564 * @valuep: location where the value of the register will be stored
565 *
566 * Returns the number of bytes transferred (1) on success, or a negative
567 * error code on failure.
568 */
569static inline ssize_t drm_dp_dpcd_readb(struct drm_dp_aux *aux,
570 unsigned int offset, u8 *valuep)
571{
572 return drm_dp_dpcd_read(aux, offset, valuep, 1);
573}
574
575/**
576 * drm_dp_dpcd_writeb() - write a single byte to the DPCD
577 * @aux: DisplayPort AUX channel
578 * @offset: address of the register to write
579 * @value: value to write to the register
580 *
581 * Returns the number of bytes transferred (1) on success, or a negative
582 * error code on failure.
583 */
584static inline ssize_t drm_dp_dpcd_writeb(struct drm_dp_aux *aux,
585 unsigned int offset, u8 value)
586{
587 return drm_dp_dpcd_write(aux, offset, &value, 1);
588}
589
Thierry Reding8d4adc62013-11-22 16:37:57 +0100590int drm_dp_dpcd_read_link_status(struct drm_dp_aux *aux,
591 u8 status[DP_LINK_STATUS_SIZE]);
592
Thierry Reding516c0f72013-12-09 11:47:55 +0100593/*
594 * DisplayPort link
595 */
596#define DP_LINK_CAP_ENHANCED_FRAMING (1 << 0)
597
598struct drm_dp_link {
599 unsigned char revision;
600 unsigned int rate;
601 unsigned int num_lanes;
602 unsigned long capabilities;
603};
604
605int drm_dp_link_probe(struct drm_dp_aux *aux, struct drm_dp_link *link);
606int drm_dp_link_power_up(struct drm_dp_aux *aux, struct drm_dp_link *link);
607int drm_dp_link_configure(struct drm_dp_aux *aux, struct drm_dp_link *link);
608
Dave Airlie4f71d0c2014-06-04 16:02:28 +1000609int drm_dp_aux_register(struct drm_dp_aux *aux);
610void drm_dp_aux_unregister(struct drm_dp_aux *aux);
Thierry Reding88759682013-12-12 09:57:53 +0100611
Dave Airlieab2c0672009-12-04 10:55:24 +1000612#endif /* _DRM_DP_HELPER_H_ */