xref: /linux/drivers/gpu/drm/bridge/adv7511/adv7511.h (revision 1f2367a39f17bd553a75e179a747f9b257bc9478)
1 /*
2  * Analog Devices ADV7511 HDMI transmitter driver
3  *
4  * Copyright 2012 Analog Devices Inc.
5  *
6  * Licensed under the GPL-2.
7  */
8 
9 #ifndef __DRM_I2C_ADV7511_H__
10 #define __DRM_I2C_ADV7511_H__
11 
12 #include <linux/hdmi.h>
13 #include <linux/i2c.h>
14 #include <linux/regmap.h>
15 #include <linux/regulator/consumer.h>
16 
17 #include <drm/drm_bridge.h>
18 #include <drm/drm_connector.h>
19 #include <drm/drm_mipi_dsi.h>
20 #include <drm/drm_modes.h>
21 
22 #define ADV7511_REG_CHIP_REVISION		0x00
23 #define ADV7511_REG_N0				0x01
24 #define ADV7511_REG_N1				0x02
25 #define ADV7511_REG_N2				0x03
26 #define ADV7511_REG_SPDIF_FREQ			0x04
27 #define ADV7511_REG_CTS_AUTOMATIC1		0x05
28 #define ADV7511_REG_CTS_AUTOMATIC2		0x06
29 #define ADV7511_REG_CTS_MANUAL0			0x07
30 #define ADV7511_REG_CTS_MANUAL1			0x08
31 #define ADV7511_REG_CTS_MANUAL2			0x09
32 #define ADV7511_REG_AUDIO_SOURCE		0x0a
33 #define ADV7511_REG_AUDIO_CONFIG		0x0b
34 #define ADV7511_REG_I2S_CONFIG			0x0c
35 #define ADV7511_REG_I2S_WIDTH			0x0d
36 #define ADV7511_REG_AUDIO_SUB_SRC0		0x0e
37 #define ADV7511_REG_AUDIO_SUB_SRC1		0x0f
38 #define ADV7511_REG_AUDIO_SUB_SRC2		0x10
39 #define ADV7511_REG_AUDIO_SUB_SRC3		0x11
40 #define ADV7511_REG_AUDIO_CFG1			0x12
41 #define ADV7511_REG_AUDIO_CFG2			0x13
42 #define ADV7511_REG_AUDIO_CFG3			0x14
43 #define ADV7511_REG_I2C_FREQ_ID_CFG		0x15
44 #define ADV7511_REG_VIDEO_INPUT_CFG1		0x16
45 #define ADV7511_REG_CSC_UPPER(x)		(0x18 + (x) * 2)
46 #define ADV7511_REG_CSC_LOWER(x)		(0x19 + (x) * 2)
47 #define ADV7511_REG_SYNC_DECODER(x)		(0x30 + (x))
48 #define ADV7511_REG_DE_GENERATOR		(0x35 + (x))
49 #define ADV7511_REG_PIXEL_REPETITION		0x3b
50 #define ADV7511_REG_VIC_MANUAL			0x3c
51 #define ADV7511_REG_VIC_SEND			0x3d
52 #define ADV7511_REG_VIC_DETECTED		0x3e
53 #define ADV7511_REG_AUX_VIC_DETECTED		0x3f
54 #define ADV7511_REG_PACKET_ENABLE0		0x40
55 #define ADV7511_REG_POWER			0x41
56 #define ADV7511_REG_STATUS			0x42
57 #define ADV7511_REG_EDID_I2C_ADDR		0x43
58 #define ADV7511_REG_PACKET_ENABLE1		0x44
59 #define ADV7511_REG_PACKET_I2C_ADDR		0x45
60 #define ADV7511_REG_DSD_ENABLE			0x46
61 #define ADV7511_REG_VIDEO_INPUT_CFG2		0x48
62 #define ADV7511_REG_INFOFRAME_UPDATE		0x4a
63 #define ADV7511_REG_GC(x)			(0x4b + (x)) /* 0x4b - 0x51 */
64 #define ADV7511_REG_AVI_INFOFRAME_VERSION	0x52
65 #define ADV7511_REG_AVI_INFOFRAME_LENGTH	0x53
66 #define ADV7511_REG_AVI_INFOFRAME_CHECKSUM	0x54
67 #define ADV7511_REG_AVI_INFOFRAME(x)		(0x55 + (x)) /* 0x55 - 0x6f */
68 #define ADV7511_REG_AUDIO_INFOFRAME_VERSION	0x70
69 #define ADV7511_REG_AUDIO_INFOFRAME_LENGTH	0x71
70 #define ADV7511_REG_AUDIO_INFOFRAME_CHECKSUM	0x72
71 #define ADV7511_REG_AUDIO_INFOFRAME(x)		(0x73 + (x)) /* 0x73 - 0x7c */
72 #define ADV7511_REG_INT_ENABLE(x)		(0x94 + (x))
73 #define ADV7511_REG_INT(x)			(0x96 + (x))
74 #define ADV7511_REG_INPUT_CLK_DIV		0x9d
75 #define ADV7511_REG_PLL_STATUS			0x9e
76 #define ADV7511_REG_HDMI_POWER			0xa1
77 #define ADV7511_REG_HDCP_HDMI_CFG		0xaf
78 #define ADV7511_REG_AN(x)			(0xb0 + (x)) /* 0xb0 - 0xb7 */
79 #define ADV7511_REG_HDCP_STATUS			0xb8
80 #define ADV7511_REG_BCAPS			0xbe
81 #define ADV7511_REG_BKSV(x)			(0xc0 + (x)) /* 0xc0 - 0xc3 */
82 #define ADV7511_REG_EDID_SEGMENT		0xc4
83 #define ADV7511_REG_DDC_STATUS			0xc8
84 #define ADV7511_REG_EDID_READ_CTRL		0xc9
85 #define ADV7511_REG_BSTATUS(x)			(0xca + (x)) /* 0xca - 0xcb */
86 #define ADV7511_REG_TIMING_GEN_SEQ		0xd0
87 #define ADV7511_REG_POWER2			0xd6
88 #define ADV7511_REG_HSYNC_PLACEMENT_MSB		0xfa
89 
90 #define ADV7511_REG_SYNC_ADJUSTMENT(x)		(0xd7 + (x)) /* 0xd7 - 0xdc */
91 #define ADV7511_REG_TMDS_CLOCK_INV		0xde
92 #define ADV7511_REG_ARC_CTRL			0xdf
93 #define ADV7511_REG_CEC_I2C_ADDR		0xe1
94 #define ADV7511_REG_CEC_CTRL			0xe2
95 #define ADV7511_REG_CHIP_ID_HIGH		0xf5
96 #define ADV7511_REG_CHIP_ID_LOW			0xf6
97 
98 /* Hardware defined default addresses for I2C register maps */
99 #define ADV7511_CEC_I2C_ADDR_DEFAULT		0x3c
100 #define ADV7511_EDID_I2C_ADDR_DEFAULT		0x3f
101 #define ADV7511_PACKET_I2C_ADDR_DEFAULT		0x38
102 
103 #define ADV7511_CSC_ENABLE			BIT(7)
104 #define ADV7511_CSC_UPDATE_MODE			BIT(5)
105 
106 #define ADV7511_INT0_HPD			BIT(7)
107 #define ADV7511_INT0_VSYNC			BIT(5)
108 #define ADV7511_INT0_AUDIO_FIFO_FULL		BIT(4)
109 #define ADV7511_INT0_EDID_READY			BIT(2)
110 #define ADV7511_INT0_HDCP_AUTHENTICATED		BIT(1)
111 
112 #define ADV7511_INT1_DDC_ERROR			BIT(7)
113 #define ADV7511_INT1_BKSV			BIT(6)
114 #define ADV7511_INT1_CEC_TX_READY		BIT(5)
115 #define ADV7511_INT1_CEC_TX_ARBIT_LOST		BIT(4)
116 #define ADV7511_INT1_CEC_TX_RETRY_TIMEOUT	BIT(3)
117 #define ADV7511_INT1_CEC_RX_READY3		BIT(2)
118 #define ADV7511_INT1_CEC_RX_READY2		BIT(1)
119 #define ADV7511_INT1_CEC_RX_READY1		BIT(0)
120 
121 #define ADV7511_ARC_CTRL_POWER_DOWN		BIT(0)
122 
123 #define ADV7511_CEC_CTRL_POWER_DOWN		BIT(0)
124 
125 #define ADV7511_POWER_POWER_DOWN		BIT(6)
126 
127 #define ADV7511_HDMI_CFG_MODE_MASK		0x2
128 #define ADV7511_HDMI_CFG_MODE_DVI		0x0
129 #define ADV7511_HDMI_CFG_MODE_HDMI		0x2
130 
131 #define ADV7511_AUDIO_SELECT_I2C		0x0
132 #define ADV7511_AUDIO_SELECT_SPDIF		0x1
133 #define ADV7511_AUDIO_SELECT_DSD		0x2
134 #define ADV7511_AUDIO_SELECT_HBR		0x3
135 #define ADV7511_AUDIO_SELECT_DST		0x4
136 
137 #define ADV7511_I2S_SAMPLE_LEN_16		0x2
138 #define ADV7511_I2S_SAMPLE_LEN_20		0x3
139 #define ADV7511_I2S_SAMPLE_LEN_18		0x4
140 #define ADV7511_I2S_SAMPLE_LEN_22		0x5
141 #define ADV7511_I2S_SAMPLE_LEN_19		0x8
142 #define ADV7511_I2S_SAMPLE_LEN_23		0x9
143 #define ADV7511_I2S_SAMPLE_LEN_24		0xb
144 #define ADV7511_I2S_SAMPLE_LEN_17		0xc
145 #define ADV7511_I2S_SAMPLE_LEN_21		0xd
146 
147 #define ADV7511_SAMPLE_FREQ_44100		0x0
148 #define ADV7511_SAMPLE_FREQ_48000		0x2
149 #define ADV7511_SAMPLE_FREQ_32000		0x3
150 #define ADV7511_SAMPLE_FREQ_88200		0x8
151 #define ADV7511_SAMPLE_FREQ_96000		0xa
152 #define ADV7511_SAMPLE_FREQ_176400		0xc
153 #define ADV7511_SAMPLE_FREQ_192000		0xe
154 
155 #define ADV7511_STATUS_POWER_DOWN_POLARITY	BIT(7)
156 #define ADV7511_STATUS_HPD			BIT(6)
157 #define ADV7511_STATUS_MONITOR_SENSE		BIT(5)
158 #define ADV7511_STATUS_I2S_32BIT_MODE		BIT(3)
159 
160 #define ADV7511_PACKET_ENABLE_N_CTS		BIT(8+6)
161 #define ADV7511_PACKET_ENABLE_AUDIO_SAMPLE	BIT(8+5)
162 #define ADV7511_PACKET_ENABLE_AVI_INFOFRAME	BIT(8+4)
163 #define ADV7511_PACKET_ENABLE_AUDIO_INFOFRAME	BIT(8+3)
164 #define ADV7511_PACKET_ENABLE_GC		BIT(7)
165 #define ADV7511_PACKET_ENABLE_SPD		BIT(6)
166 #define ADV7511_PACKET_ENABLE_MPEG		BIT(5)
167 #define ADV7511_PACKET_ENABLE_ACP		BIT(4)
168 #define ADV7511_PACKET_ENABLE_ISRC		BIT(3)
169 #define ADV7511_PACKET_ENABLE_GM		BIT(2)
170 #define ADV7511_PACKET_ENABLE_SPARE2		BIT(1)
171 #define ADV7511_PACKET_ENABLE_SPARE1		BIT(0)
172 
173 #define ADV7511_REG_POWER2_HPD_SRC_MASK		0xc0
174 #define ADV7511_REG_POWER2_HPD_SRC_BOTH		0x00
175 #define ADV7511_REG_POWER2_HPD_SRC_HPD		0x40
176 #define ADV7511_REG_POWER2_HPD_SRC_CEC		0x80
177 #define ADV7511_REG_POWER2_HPD_SRC_NONE		0xc0
178 #define ADV7511_REG_POWER2_TDMS_ENABLE		BIT(4)
179 #define ADV7511_REG_POWER2_GATE_INPUT_CLK	BIT(0)
180 
181 #define ADV7511_LOW_REFRESH_RATE_NONE		0x0
182 #define ADV7511_LOW_REFRESH_RATE_24HZ		0x1
183 #define ADV7511_LOW_REFRESH_RATE_25HZ		0x2
184 #define ADV7511_LOW_REFRESH_RATE_30HZ		0x3
185 
186 #define ADV7511_AUDIO_CFG3_LEN_MASK		0x0f
187 #define ADV7511_I2C_FREQ_ID_CFG_RATE_MASK	0xf0
188 
189 #define ADV7511_AUDIO_SOURCE_I2S		0
190 #define ADV7511_AUDIO_SOURCE_SPDIF		1
191 
192 #define ADV7511_I2S_FORMAT_I2S			0
193 #define ADV7511_I2S_FORMAT_RIGHT_J		1
194 #define ADV7511_I2S_FORMAT_LEFT_J		2
195 
196 #define ADV7511_PACKET(p, x)	    ((p) * 0x20 + (x))
197 #define ADV7511_PACKET_SDP(x)	    ADV7511_PACKET(0, x)
198 #define ADV7511_PACKET_MPEG(x)	    ADV7511_PACKET(1, x)
199 #define ADV7511_PACKET_ACP(x)	    ADV7511_PACKET(2, x)
200 #define ADV7511_PACKET_ISRC1(x)	    ADV7511_PACKET(3, x)
201 #define ADV7511_PACKET_ISRC2(x)	    ADV7511_PACKET(4, x)
202 #define ADV7511_PACKET_GM(x)	    ADV7511_PACKET(5, x)
203 #define ADV7511_PACKET_SPARE(x)	    ADV7511_PACKET(6, x)
204 
205 #define ADV7511_REG_CEC_TX_FRAME_HDR	0x00
206 #define ADV7511_REG_CEC_TX_FRAME_DATA0	0x01
207 #define ADV7511_REG_CEC_TX_FRAME_LEN	0x10
208 #define ADV7511_REG_CEC_TX_ENABLE	0x11
209 #define ADV7511_REG_CEC_TX_RETRY	0x12
210 #define ADV7511_REG_CEC_TX_LOW_DRV_CNT	0x14
211 #define ADV7511_REG_CEC_RX_FRAME_HDR	0x15
212 #define ADV7511_REG_CEC_RX_FRAME_DATA0	0x16
213 #define ADV7511_REG_CEC_RX_FRAME_LEN	0x25
214 #define ADV7511_REG_CEC_RX_ENABLE	0x26
215 #define ADV7511_REG_CEC_RX_BUFFERS	0x4a
216 #define ADV7511_REG_CEC_LOG_ADDR_MASK	0x4b
217 #define ADV7511_REG_CEC_LOG_ADDR_0_1	0x4c
218 #define ADV7511_REG_CEC_LOG_ADDR_2	0x4d
219 #define ADV7511_REG_CEC_CLK_DIV		0x4e
220 #define ADV7511_REG_CEC_SOFT_RESET	0x50
221 
222 #define ADV7533_REG_CEC_OFFSET		0x70
223 
224 enum adv7511_input_clock {
225 	ADV7511_INPUT_CLOCK_1X,
226 	ADV7511_INPUT_CLOCK_2X,
227 	ADV7511_INPUT_CLOCK_DDR,
228 };
229 
230 enum adv7511_input_justification {
231 	ADV7511_INPUT_JUSTIFICATION_EVENLY = 0,
232 	ADV7511_INPUT_JUSTIFICATION_RIGHT = 1,
233 	ADV7511_INPUT_JUSTIFICATION_LEFT = 2,
234 };
235 
236 enum adv7511_input_sync_pulse {
237 	ADV7511_INPUT_SYNC_PULSE_DE = 0,
238 	ADV7511_INPUT_SYNC_PULSE_HSYNC = 1,
239 	ADV7511_INPUT_SYNC_PULSE_VSYNC = 2,
240 	ADV7511_INPUT_SYNC_PULSE_NONE = 3,
241 };
242 
243 /**
244  * enum adv7511_sync_polarity - Polarity for the input sync signals
245  * @ADV7511_SYNC_POLARITY_PASSTHROUGH:  Sync polarity matches that of
246  *				       the currently configured mode.
247  * @ADV7511_SYNC_POLARITY_LOW:	    Sync polarity is low
248  * @ADV7511_SYNC_POLARITY_HIGH:	    Sync polarity is high
249  *
250  * If the polarity is set to either LOW or HIGH the driver will configure the
251  * ADV7511 to internally invert the sync signal if required to match the sync
252  * polarity setting for the currently selected output mode.
253  *
254  * If the polarity is set to PASSTHROUGH, the ADV7511 will route the signal
255  * unchanged. This is used when the upstream graphics core already generates
256  * the sync signals with the correct polarity.
257  */
258 enum adv7511_sync_polarity {
259 	ADV7511_SYNC_POLARITY_PASSTHROUGH,
260 	ADV7511_SYNC_POLARITY_LOW,
261 	ADV7511_SYNC_POLARITY_HIGH,
262 };
263 
264 /**
265  * struct adv7511_link_config - Describes adv7511 hardware configuration
266  * @input_color_depth:		Number of bits per color component (8, 10 or 12)
267  * @input_colorspace:		The input colorspace (RGB, YUV444, YUV422)
268  * @input_clock:		The input video clock style (1x, 2x, DDR)
269  * @input_style:		The input component arrangement variant
270  * @input_justification:	Video input format bit justification
271  * @clock_delay:		Clock delay for the input clock (in ps)
272  * @embedded_sync:		Video input uses BT.656-style embedded sync
273  * @sync_pulse:			Select the sync pulse
274  * @vsync_polarity:		vsync input signal configuration
275  * @hsync_polarity:		hsync input signal configuration
276  */
277 struct adv7511_link_config {
278 	unsigned int input_color_depth;
279 	enum hdmi_colorspace input_colorspace;
280 	enum adv7511_input_clock input_clock;
281 	unsigned int input_style;
282 	enum adv7511_input_justification input_justification;
283 
284 	int clock_delay;
285 
286 	bool embedded_sync;
287 	enum adv7511_input_sync_pulse sync_pulse;
288 	enum adv7511_sync_polarity vsync_polarity;
289 	enum adv7511_sync_polarity hsync_polarity;
290 };
291 
292 /**
293  * enum adv7511_csc_scaling - Scaling factor for the ADV7511 CSC
294  * @ADV7511_CSC_SCALING_1: CSC results are not scaled
295  * @ADV7511_CSC_SCALING_2: CSC results are scaled by a factor of two
296  * @ADV7511_CSC_SCALING_4: CSC results are scalled by a factor of four
297  */
298 enum adv7511_csc_scaling {
299 	ADV7511_CSC_SCALING_1 = 0,
300 	ADV7511_CSC_SCALING_2 = 1,
301 	ADV7511_CSC_SCALING_4 = 2,
302 };
303 
304 /**
305  * struct adv7511_video_config - Describes adv7511 hardware configuration
306  * @csc_enable:			Whether to enable color space conversion
307  * @csc_scaling_factor:		Color space conversion scaling factor
308  * @csc_coefficents:		Color space conversion coefficents
309  * @hdmi_mode:			Whether to use HDMI or DVI output mode
310  * @avi_infoframe:		HDMI infoframe
311  */
312 struct adv7511_video_config {
313 	bool csc_enable;
314 	enum adv7511_csc_scaling csc_scaling_factor;
315 	const uint16_t *csc_coefficents;
316 
317 	bool hdmi_mode;
318 	struct hdmi_avi_infoframe avi_infoframe;
319 };
320 
321 enum adv7511_type {
322 	ADV7511,
323 	ADV7533,
324 };
325 
326 #define ADV7511_MAX_ADDRS 3
327 
328 struct adv7511 {
329 	struct i2c_client *i2c_main;
330 	struct i2c_client *i2c_edid;
331 	struct i2c_client *i2c_packet;
332 	struct i2c_client *i2c_cec;
333 
334 	struct regmap *regmap;
335 	struct regmap *regmap_cec;
336 	enum drm_connector_status status;
337 	bool powered;
338 
339 	struct drm_display_mode curr_mode;
340 
341 	unsigned int f_tmds;
342 	unsigned int f_audio;
343 	unsigned int audio_source;
344 
345 	unsigned int current_edid_segment;
346 	uint8_t edid_buf[256];
347 	bool edid_read;
348 
349 	wait_queue_head_t wq;
350 	struct work_struct hpd_work;
351 
352 	struct drm_bridge bridge;
353 	struct drm_connector connector;
354 
355 	bool embedded_sync;
356 	enum adv7511_sync_polarity vsync_polarity;
357 	enum adv7511_sync_polarity hsync_polarity;
358 	bool rgb;
359 
360 	struct gpio_desc *gpio_pd;
361 
362 	struct regulator_bulk_data *supplies;
363 	unsigned int num_supplies;
364 
365 	/* ADV7533 DSI RX related params */
366 	struct device_node *host_node;
367 	struct mipi_dsi_device *dsi;
368 	u8 num_dsi_lanes;
369 	bool use_timing_gen;
370 
371 	enum adv7511_type type;
372 	struct platform_device *audio_pdev;
373 
374 	struct cec_adapter *cec_adap;
375 	u8   cec_addr[ADV7511_MAX_ADDRS];
376 	u8   cec_valid_addrs;
377 	bool cec_enabled_adap;
378 	struct clk *cec_clk;
379 	u32 cec_clk_freq;
380 };
381 
382 #ifdef CONFIG_DRM_I2C_ADV7511_CEC
383 int adv7511_cec_init(struct device *dev, struct adv7511 *adv7511);
384 void adv7511_cec_irq_process(struct adv7511 *adv7511, unsigned int irq1);
385 #else
386 static inline int adv7511_cec_init(struct device *dev, struct adv7511 *adv7511)
387 {
388 	unsigned int offset = adv7511->type == ADV7533 ?
389 						ADV7533_REG_CEC_OFFSET : 0;
390 
391 	regmap_write(adv7511->regmap, ADV7511_REG_CEC_CTRL + offset,
392 		     ADV7511_CEC_CTRL_POWER_DOWN);
393 	return 0;
394 }
395 #endif
396 
397 #ifdef CONFIG_DRM_I2C_ADV7533
398 void adv7533_dsi_power_on(struct adv7511 *adv);
399 void adv7533_dsi_power_off(struct adv7511 *adv);
400 void adv7533_mode_set(struct adv7511 *adv, const struct drm_display_mode *mode);
401 int adv7533_patch_registers(struct adv7511 *adv);
402 int adv7533_patch_cec_registers(struct adv7511 *adv);
403 int adv7533_attach_dsi(struct adv7511 *adv);
404 void adv7533_detach_dsi(struct adv7511 *adv);
405 int adv7533_parse_dt(struct device_node *np, struct adv7511 *adv);
406 #else
407 static inline void adv7533_dsi_power_on(struct adv7511 *adv)
408 {
409 }
410 
411 static inline void adv7533_dsi_power_off(struct adv7511 *adv)
412 {
413 }
414 
415 static inline void adv7533_mode_set(struct adv7511 *adv,
416 				    const struct drm_display_mode *mode)
417 {
418 }
419 
420 static inline int adv7533_patch_registers(struct adv7511 *adv)
421 {
422 	return -ENODEV;
423 }
424 
425 static inline int adv7533_patch_cec_registers(struct adv7511 *adv)
426 {
427 	return -ENODEV;
428 }
429 
430 static inline int adv7533_attach_dsi(struct adv7511 *adv)
431 {
432 	return -ENODEV;
433 }
434 
435 static inline void adv7533_detach_dsi(struct adv7511 *adv)
436 {
437 }
438 
439 static inline int adv7533_parse_dt(struct device_node *np, struct adv7511 *adv)
440 {
441 	return -ENODEV;
442 }
443 #endif
444 
445 #ifdef CONFIG_DRM_I2C_ADV7511_AUDIO
446 int adv7511_audio_init(struct device *dev, struct adv7511 *adv7511);
447 void adv7511_audio_exit(struct adv7511 *adv7511);
448 #else /*CONFIG_DRM_I2C_ADV7511_AUDIO */
449 static inline int adv7511_audio_init(struct device *dev, struct adv7511 *adv7511)
450 {
451 	return 0;
452 }
453 static inline void adv7511_audio_exit(struct adv7511 *adv7511)
454 {
455 }
456 #endif /* CONFIG_DRM_I2C_ADV7511_AUDIO */
457 
458 #endif /* __DRM_I2C_ADV7511_H__ */
459