1 /*
2  * Header file for Analogix DP (Display Port) core interface driver.
3  *
4  * Copyright (C) 2012 Samsung Electronics Co., Ltd.
5  * Author: Jingoo Han <jg1.han@samsung.com>
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * under the terms of the GNU General Public License as published by the
9  * Free Software Foundation; either version 2 of the License, or (at your
10  * option) any later version.
11  */
12 
13 #ifndef _ANALOGIX_DP_CORE_H
14 #define _ANALOGIX_DP_CORE_H
15 
16 #include <drm/drm_crtc.h>
17 #include <drm/drm_dp_helper.h>
18 
19 #define DP_TIMEOUT_LOOP_COUNT 100
20 #define MAX_CR_LOOP 5
21 #define MAX_EQ_LOOP 5
22 
23 /* Training takes 22ms if AUX channel comm fails. Use this as retry interval */
24 #define DP_TIMEOUT_TRAINING_US			22000
25 #define DP_TIMEOUT_PSR_LOOP_MS			300
26 
27 /* DP_MAX_LANE_COUNT */
28 #define DPCD_ENHANCED_FRAME_CAP(x)		(((x) >> 7) & 0x1)
29 #define DPCD_MAX_LANE_COUNT(x)			((x) & 0x1f)
30 
31 /* DP_LANE_COUNT_SET */
32 #define DPCD_LANE_COUNT_SET(x)			((x) & 0x1f)
33 
34 /* DP_TRAINING_LANE0_SET */
35 #define DPCD_PRE_EMPHASIS_SET(x)		(((x) & 0x3) << 3)
36 #define DPCD_PRE_EMPHASIS_GET(x)		(((x) >> 3) & 0x3)
37 #define DPCD_VOLTAGE_SWING_SET(x)		(((x) & 0x3) << 0)
38 #define DPCD_VOLTAGE_SWING_GET(x)		(((x) >> 0) & 0x3)
39 
40 enum link_lane_count_type {
41 	LANE_COUNT1 = 1,
42 	LANE_COUNT2 = 2,
43 	LANE_COUNT4 = 4
44 };
45 
46 enum link_training_state {
47 	START,
48 	CLOCK_RECOVERY,
49 	EQUALIZER_TRAINING,
50 	FINISHED,
51 	FAILED
52 };
53 
54 enum voltage_swing_level {
55 	VOLTAGE_LEVEL_0,
56 	VOLTAGE_LEVEL_1,
57 	VOLTAGE_LEVEL_2,
58 	VOLTAGE_LEVEL_3,
59 };
60 
61 enum pre_emphasis_level {
62 	PRE_EMPHASIS_LEVEL_0,
63 	PRE_EMPHASIS_LEVEL_1,
64 	PRE_EMPHASIS_LEVEL_2,
65 	PRE_EMPHASIS_LEVEL_3,
66 };
67 
68 enum pattern_set {
69 	PRBS7,
70 	D10_2,
71 	TRAINING_PTN1,
72 	TRAINING_PTN2,
73 	DP_NONE
74 };
75 
76 enum color_space {
77 	COLOR_RGB,
78 	COLOR_YCBCR422,
79 	COLOR_YCBCR444
80 };
81 
82 enum color_depth {
83 	COLOR_6,
84 	COLOR_8,
85 	COLOR_10,
86 	COLOR_12
87 };
88 
89 enum color_coefficient {
90 	COLOR_YCBCR601,
91 	COLOR_YCBCR709
92 };
93 
94 enum dynamic_range {
95 	VESA,
96 	CEA
97 };
98 
99 enum pll_status {
100 	PLL_UNLOCKED,
101 	PLL_LOCKED
102 };
103 
104 enum clock_recovery_m_value_type {
105 	CALCULATED_M,
106 	REGISTER_M
107 };
108 
109 enum video_timing_recognition_type {
110 	VIDEO_TIMING_FROM_CAPTURE,
111 	VIDEO_TIMING_FROM_REGISTER
112 };
113 
114 enum analog_power_block {
115 	AUX_BLOCK,
116 	CH0_BLOCK,
117 	CH1_BLOCK,
118 	CH2_BLOCK,
119 	CH3_BLOCK,
120 	ANALOG_TOTAL,
121 	POWER_ALL
122 };
123 
124 enum dp_irq_type {
125 	DP_IRQ_TYPE_HP_CABLE_IN  = BIT(0),
126 	DP_IRQ_TYPE_HP_CABLE_OUT = BIT(1),
127 	DP_IRQ_TYPE_HP_CHANGE    = BIT(2),
128 	DP_IRQ_TYPE_UNKNOWN      = BIT(3),
129 };
130 
131 struct video_info {
132 	char *name;
133 
134 	bool h_sync_polarity;
135 	bool v_sync_polarity;
136 	bool interlaced;
137 
138 	enum color_space color_space;
139 	enum dynamic_range dynamic_range;
140 	enum color_coefficient ycbcr_coeff;
141 	enum color_depth color_depth;
142 
143 	int max_link_rate;
144 	enum link_lane_count_type max_lane_count;
145 };
146 
147 struct link_train {
148 	int eq_loop;
149 	int cr_loop[4];
150 
151 	u8 link_rate;
152 	u8 lane_count;
153 	u8 training_lane[4];
154 
155 	enum link_training_state lt_state;
156 };
157 
158 struct analogix_dp_device {
159 	struct drm_encoder	*encoder;
160 	struct device		*dev;
161 	struct drm_device	*drm_dev;
162 	struct drm_connector	connector;
163 	struct drm_bridge	*bridge;
164 	struct drm_dp_aux       aux;
165 	struct clk		*clock;
166 	unsigned int		irq;
167 	void __iomem		*reg_base;
168 
169 	struct video_info	video_info;
170 	struct link_train	link_train;
171 	struct phy		*phy;
172 	int			dpms_mode;
173 	int			hpd_gpio;
174 	bool                    force_hpd;
175 	bool			psr_enable;
176 	bool			fast_train_support;
177 
178 	struct mutex		panel_lock;
179 	bool			panel_is_modeset;
180 
181 	struct analogix_dp_plat_data *plat_data;
182 };
183 
184 /* analogix_dp_reg.c */
185 void analogix_dp_enable_video_mute(struct analogix_dp_device *dp, bool enable);
186 void analogix_dp_stop_video(struct analogix_dp_device *dp);
187 void analogix_dp_lane_swap(struct analogix_dp_device *dp, bool enable);
188 void analogix_dp_init_analog_param(struct analogix_dp_device *dp);
189 void analogix_dp_init_interrupt(struct analogix_dp_device *dp);
190 void analogix_dp_reset(struct analogix_dp_device *dp);
191 void analogix_dp_swreset(struct analogix_dp_device *dp);
192 void analogix_dp_config_interrupt(struct analogix_dp_device *dp);
193 void analogix_dp_mute_hpd_interrupt(struct analogix_dp_device *dp);
194 void analogix_dp_unmute_hpd_interrupt(struct analogix_dp_device *dp);
195 enum pll_status analogix_dp_get_pll_lock_status(struct analogix_dp_device *dp);
196 void analogix_dp_set_pll_power_down(struct analogix_dp_device *dp, bool enable);
197 void analogix_dp_set_analog_power_down(struct analogix_dp_device *dp,
198 				       enum analog_power_block block,
199 				       bool enable);
200 void analogix_dp_init_analog_func(struct analogix_dp_device *dp);
201 void analogix_dp_init_hpd(struct analogix_dp_device *dp);
202 void analogix_dp_force_hpd(struct analogix_dp_device *dp);
203 enum dp_irq_type analogix_dp_get_irq_type(struct analogix_dp_device *dp);
204 void analogix_dp_clear_hotplug_interrupts(struct analogix_dp_device *dp);
205 void analogix_dp_reset_aux(struct analogix_dp_device *dp);
206 void analogix_dp_init_aux(struct analogix_dp_device *dp);
207 int analogix_dp_get_plug_in_status(struct analogix_dp_device *dp);
208 void analogix_dp_enable_sw_function(struct analogix_dp_device *dp);
209 void analogix_dp_set_link_bandwidth(struct analogix_dp_device *dp, u32 bwtype);
210 void analogix_dp_get_link_bandwidth(struct analogix_dp_device *dp, u32 *bwtype);
211 void analogix_dp_set_lane_count(struct analogix_dp_device *dp, u32 count);
212 void analogix_dp_get_lane_count(struct analogix_dp_device *dp, u32 *count);
213 void analogix_dp_enable_enhanced_mode(struct analogix_dp_device *dp,
214 				      bool enable);
215 void analogix_dp_set_training_pattern(struct analogix_dp_device *dp,
216 				      enum pattern_set pattern);
217 void analogix_dp_set_lane0_pre_emphasis(struct analogix_dp_device *dp,
218 					u32 level);
219 void analogix_dp_set_lane1_pre_emphasis(struct analogix_dp_device *dp,
220 					u32 level);
221 void analogix_dp_set_lane2_pre_emphasis(struct analogix_dp_device *dp,
222 					u32 level);
223 void analogix_dp_set_lane3_pre_emphasis(struct analogix_dp_device *dp,
224 					u32 level);
225 void analogix_dp_set_lane0_link_training(struct analogix_dp_device *dp,
226 					 u32 training_lane);
227 void analogix_dp_set_lane1_link_training(struct analogix_dp_device *dp,
228 					 u32 training_lane);
229 void analogix_dp_set_lane2_link_training(struct analogix_dp_device *dp,
230 					 u32 training_lane);
231 void analogix_dp_set_lane3_link_training(struct analogix_dp_device *dp,
232 					 u32 training_lane);
233 u32 analogix_dp_get_lane0_link_training(struct analogix_dp_device *dp);
234 u32 analogix_dp_get_lane1_link_training(struct analogix_dp_device *dp);
235 u32 analogix_dp_get_lane2_link_training(struct analogix_dp_device *dp);
236 u32 analogix_dp_get_lane3_link_training(struct analogix_dp_device *dp);
237 void analogix_dp_reset_macro(struct analogix_dp_device *dp);
238 void analogix_dp_init_video(struct analogix_dp_device *dp);
239 
240 void analogix_dp_set_video_color_format(struct analogix_dp_device *dp);
241 int analogix_dp_is_slave_video_stream_clock_on(struct analogix_dp_device *dp);
242 void analogix_dp_set_video_cr_mn(struct analogix_dp_device *dp,
243 				 enum clock_recovery_m_value_type type,
244 				 u32 m_value,
245 				 u32 n_value);
246 void analogix_dp_set_video_timing_mode(struct analogix_dp_device *dp, u32 type);
247 void analogix_dp_enable_video_master(struct analogix_dp_device *dp,
248 				     bool enable);
249 void analogix_dp_start_video(struct analogix_dp_device *dp);
250 int analogix_dp_is_video_stream_on(struct analogix_dp_device *dp);
251 void analogix_dp_config_video_slave_mode(struct analogix_dp_device *dp);
252 void analogix_dp_enable_scrambling(struct analogix_dp_device *dp);
253 void analogix_dp_disable_scrambling(struct analogix_dp_device *dp);
254 void analogix_dp_enable_psr_crc(struct analogix_dp_device *dp);
255 int analogix_dp_send_psr_spd(struct analogix_dp_device *dp,
256 			     struct edp_vsc_psr *vsc, bool blocking);
257 ssize_t analogix_dp_transfer(struct analogix_dp_device *dp,
258 			     struct drm_dp_aux_msg *msg);
259 
260 #endif /* _ANALOGIX_DP_CORE_H */
261