1 // SPDX-License-Identifier: GPL-2.0+
3 * i.MX drm driver - Television Encoder (TVEv2)
5 * Copyright (C) 2013 Philipp Zabel, Pengutronix
9 #include <linux/clk-provider.h>
10 #include <linux/component.h>
11 #include <linux/module.h>
12 #include <linux/i2c.h>
13 #include <linux/regmap.h>
14 #include <linux/regulator/consumer.h>
15 #include <linux/spinlock.h>
16 #include <linux/videodev2.h>
18 #include <drm/drm_atomic_helper.h>
19 #include <drm/drm_fb_helper.h>
20 #include <drm/drm_probe_helper.h>
21 #include <video/imx-ipu-v3.h>
25 #define TVE_COM_CONF_REG 0x00
26 #define TVE_TVDAC0_CONT_REG 0x28
27 #define TVE_TVDAC1_CONT_REG 0x2c
28 #define TVE_TVDAC2_CONT_REG 0x30
29 #define TVE_CD_CONT_REG 0x34
30 #define TVE_INT_CONT_REG 0x64
31 #define TVE_STAT_REG 0x68
32 #define TVE_TST_MODE_REG 0x6c
33 #define TVE_MV_CONT_REG 0xdc
35 /* TVE_COM_CONF_REG */
36 #define TVE_SYNC_CH_2_EN BIT(22)
37 #define TVE_SYNC_CH_1_EN BIT(21)
38 #define TVE_SYNC_CH_0_EN BIT(20)
39 #define TVE_TV_OUT_MODE_MASK (0x7 << 12)
40 #define TVE_TV_OUT_DISABLE (0x0 << 12)
41 #define TVE_TV_OUT_CVBS_0 (0x1 << 12)
42 #define TVE_TV_OUT_CVBS_2 (0x2 << 12)
43 #define TVE_TV_OUT_CVBS_0_2 (0x3 << 12)
44 #define TVE_TV_OUT_SVIDEO_0_1 (0x4 << 12)
45 #define TVE_TV_OUT_SVIDEO_0_1_CVBS2_2 (0x5 << 12)
46 #define TVE_TV_OUT_YPBPR (0x6 << 12)
47 #define TVE_TV_OUT_RGB (0x7 << 12)
48 #define TVE_TV_STAND_MASK (0xf << 8)
49 #define TVE_TV_STAND_HD_1080P30 (0xc << 8)
50 #define TVE_P2I_CONV_EN BIT(7)
51 #define TVE_INP_VIDEO_FORM BIT(6)
52 #define TVE_INP_YCBCR_422 (0x0 << 6)
53 #define TVE_INP_YCBCR_444 (0x1 << 6)
54 #define TVE_DATA_SOURCE_MASK (0x3 << 4)
55 #define TVE_DATA_SOURCE_BUS1 (0x0 << 4)
56 #define TVE_DATA_SOURCE_BUS2 (0x1 << 4)
57 #define TVE_DATA_SOURCE_EXT (0x2 << 4)
58 #define TVE_DATA_SOURCE_TESTGEN (0x3 << 4)
59 #define TVE_IPU_CLK_EN_OFS 3
60 #define TVE_IPU_CLK_EN BIT(3)
61 #define TVE_DAC_SAMP_RATE_OFS 1
62 #define TVE_DAC_SAMP_RATE_WIDTH 2
63 #define TVE_DAC_SAMP_RATE_MASK (0x3 << 1)
64 #define TVE_DAC_FULL_RATE (0x0 << 1)
65 #define TVE_DAC_DIV2_RATE (0x1 << 1)
66 #define TVE_DAC_DIV4_RATE (0x2 << 1)
69 /* TVE_TVDACx_CONT_REG */
70 #define TVE_TVDAC_GAIN_MASK (0x3f << 0)
73 #define TVE_CD_CH_2_SM_EN BIT(22)
74 #define TVE_CD_CH_1_SM_EN BIT(21)
75 #define TVE_CD_CH_0_SM_EN BIT(20)
76 #define TVE_CD_CH_2_LM_EN BIT(18)
77 #define TVE_CD_CH_1_LM_EN BIT(17)
78 #define TVE_CD_CH_0_LM_EN BIT(16)
79 #define TVE_CD_CH_2_REF_LVL BIT(10)
80 #define TVE_CD_CH_1_REF_LVL BIT(9)
81 #define TVE_CD_CH_0_REF_LVL BIT(8)
82 #define TVE_CD_EN BIT(0)
84 /* TVE_INT_CONT_REG */
85 #define TVE_FRAME_END_IEN BIT(13)
86 #define TVE_CD_MON_END_IEN BIT(2)
87 #define TVE_CD_SM_IEN BIT(1)
88 #define TVE_CD_LM_IEN BIT(0)
90 /* TVE_TST_MODE_REG */
91 #define TVE_TVDAC_TEST_MODE_MASK (0x7 << 0)
93 #define IMX_TVE_DAC_VOLTAGE 2750000
101 struct drm_connector connector
;
102 struct drm_encoder encoder
;
104 spinlock_t lock
; /* register lock */
110 struct regmap
*regmap
;
111 struct regulator
*dac_reg
;
112 struct i2c_adapter
*ddc
;
114 struct clk
*di_sel_clk
;
115 struct clk_hw clk_hw_di
;
119 static inline struct imx_tve
*con_to_tve(struct drm_connector
*c
)
121 return container_of(c
, struct imx_tve
, connector
);
124 static inline struct imx_tve
*enc_to_tve(struct drm_encoder
*e
)
126 return container_of(e
, struct imx_tve
, encoder
);
129 static void tve_lock(void *__tve
)
130 __acquires(&tve
->lock
)
132 struct imx_tve
*tve
= __tve
;
134 spin_lock(&tve
->lock
);
137 static void tve_unlock(void *__tve
)
138 __releases(&tve
->lock
)
140 struct imx_tve
*tve
= __tve
;
142 spin_unlock(&tve
->lock
);
145 static void tve_enable(struct imx_tve
*tve
)
149 clk_prepare_enable(tve
->clk
);
150 regmap_update_bits(tve
->regmap
, TVE_COM_CONF_REG
,
154 /* clear interrupt status register */
155 regmap_write(tve
->regmap
, TVE_STAT_REG
, 0xffffffff);
157 /* cable detection irq disabled in VGA mode, enabled in TVOUT mode */
158 if (tve
->mode
== TVE_MODE_VGA
)
159 regmap_write(tve
->regmap
, TVE_INT_CONT_REG
, 0);
161 regmap_write(tve
->regmap
, TVE_INT_CONT_REG
,
167 static void tve_disable(struct imx_tve
*tve
)
170 tve
->enabled
= false;
171 regmap_update_bits(tve
->regmap
, TVE_COM_CONF_REG
, TVE_EN
, 0);
172 clk_disable_unprepare(tve
->clk
);
176 static int tve_setup_tvout(struct imx_tve
*tve
)
181 static int tve_setup_vga(struct imx_tve
*tve
)
187 /* set gain to (1 + 10/128) to provide 0.7V peak-to-peak amplitude */
188 ret
= regmap_update_bits(tve
->regmap
, TVE_TVDAC0_CONT_REG
,
189 TVE_TVDAC_GAIN_MASK
, 0x0a);
193 ret
= regmap_update_bits(tve
->regmap
, TVE_TVDAC1_CONT_REG
,
194 TVE_TVDAC_GAIN_MASK
, 0x0a);
198 ret
= regmap_update_bits(tve
->regmap
, TVE_TVDAC2_CONT_REG
,
199 TVE_TVDAC_GAIN_MASK
, 0x0a);
203 /* set configuration register */
204 mask
= TVE_DATA_SOURCE_MASK
| TVE_INP_VIDEO_FORM
;
205 val
= TVE_DATA_SOURCE_BUS2
| TVE_INP_YCBCR_444
;
206 mask
|= TVE_TV_STAND_MASK
| TVE_P2I_CONV_EN
;
207 val
|= TVE_TV_STAND_HD_1080P30
| 0;
208 mask
|= TVE_TV_OUT_MODE_MASK
| TVE_SYNC_CH_0_EN
;
209 val
|= TVE_TV_OUT_RGB
| TVE_SYNC_CH_0_EN
;
210 ret
= regmap_update_bits(tve
->regmap
, TVE_COM_CONF_REG
, mask
, val
);
214 /* set test mode (as documented) */
215 return regmap_update_bits(tve
->regmap
, TVE_TST_MODE_REG
,
216 TVE_TVDAC_TEST_MODE_MASK
, 1);
219 static int imx_tve_connector_get_modes(struct drm_connector
*connector
)
221 struct imx_tve
*tve
= con_to_tve(connector
);
228 edid
= drm_get_edid(connector
, tve
->ddc
);
230 drm_connector_update_edid_property(connector
, edid
);
231 ret
= drm_add_edid_modes(connector
, edid
);
238 static int imx_tve_connector_mode_valid(struct drm_connector
*connector
,
239 struct drm_display_mode
*mode
)
241 struct imx_tve
*tve
= con_to_tve(connector
);
244 /* pixel clock with 2x oversampling */
245 rate
= clk_round_rate(tve
->clk
, 2000UL * mode
->clock
) / 2000;
246 if (rate
== mode
->clock
)
249 /* pixel clock without oversampling */
250 rate
= clk_round_rate(tve
->clk
, 1000UL * mode
->clock
) / 1000;
251 if (rate
== mode
->clock
)
254 dev_warn(tve
->dev
, "ignoring mode %dx%d\n",
255 mode
->hdisplay
, mode
->vdisplay
);
260 static struct drm_encoder
*imx_tve_connector_best_encoder(
261 struct drm_connector
*connector
)
263 struct imx_tve
*tve
= con_to_tve(connector
);
265 return &tve
->encoder
;
268 static void imx_tve_encoder_mode_set(struct drm_encoder
*encoder
,
269 struct drm_display_mode
*orig_mode
,
270 struct drm_display_mode
*mode
)
272 struct imx_tve
*tve
= enc_to_tve(encoder
);
273 unsigned long rounded_rate
;
280 * we should try 4k * mode->clock first,
281 * and enable 4x oversampling for lower resolutions
283 rate
= 2000UL * mode
->clock
;
284 clk_set_rate(tve
->clk
, rate
);
285 rounded_rate
= clk_get_rate(tve
->clk
);
286 if (rounded_rate
>= rate
)
288 clk_set_rate(tve
->di_clk
, rounded_rate
/ div
);
290 ret
= clk_set_parent(tve
->di_sel_clk
, tve
->di_clk
);
292 dev_err(tve
->dev
, "failed to set di_sel parent to tve_di: %d\n",
296 regmap_update_bits(tve
->regmap
, TVE_COM_CONF_REG
,
297 TVE_IPU_CLK_EN
, TVE_IPU_CLK_EN
);
299 if (tve
->mode
== TVE_MODE_VGA
)
300 ret
= tve_setup_vga(tve
);
302 ret
= tve_setup_tvout(tve
);
304 dev_err(tve
->dev
, "failed to set configuration: %d\n", ret
);
307 static void imx_tve_encoder_enable(struct drm_encoder
*encoder
)
309 struct imx_tve
*tve
= enc_to_tve(encoder
);
314 static void imx_tve_encoder_disable(struct drm_encoder
*encoder
)
316 struct imx_tve
*tve
= enc_to_tve(encoder
);
321 static int imx_tve_atomic_check(struct drm_encoder
*encoder
,
322 struct drm_crtc_state
*crtc_state
,
323 struct drm_connector_state
*conn_state
)
325 struct imx_crtc_state
*imx_crtc_state
= to_imx_crtc_state(crtc_state
);
326 struct imx_tve
*tve
= enc_to_tve(encoder
);
328 imx_crtc_state
->bus_format
= MEDIA_BUS_FMT_GBR888_1X24
;
329 imx_crtc_state
->di_hsync_pin
= tve
->di_hsync_pin
;
330 imx_crtc_state
->di_vsync_pin
= tve
->di_vsync_pin
;
335 static const struct drm_connector_funcs imx_tve_connector_funcs
= {
336 .fill_modes
= drm_helper_probe_single_connector_modes
,
337 .destroy
= imx_drm_connector_destroy
,
338 .reset
= drm_atomic_helper_connector_reset
,
339 .atomic_duplicate_state
= drm_atomic_helper_connector_duplicate_state
,
340 .atomic_destroy_state
= drm_atomic_helper_connector_destroy_state
,
343 static const struct drm_connector_helper_funcs imx_tve_connector_helper_funcs
= {
344 .get_modes
= imx_tve_connector_get_modes
,
345 .best_encoder
= imx_tve_connector_best_encoder
,
346 .mode_valid
= imx_tve_connector_mode_valid
,
349 static const struct drm_encoder_funcs imx_tve_encoder_funcs
= {
350 .destroy
= imx_drm_encoder_destroy
,
353 static const struct drm_encoder_helper_funcs imx_tve_encoder_helper_funcs
= {
354 .mode_set
= imx_tve_encoder_mode_set
,
355 .enable
= imx_tve_encoder_enable
,
356 .disable
= imx_tve_encoder_disable
,
357 .atomic_check
= imx_tve_atomic_check
,
360 static irqreturn_t
imx_tve_irq_handler(int irq
, void *data
)
362 struct imx_tve
*tve
= data
;
365 regmap_read(tve
->regmap
, TVE_STAT_REG
, &val
);
367 /* clear interrupt status register */
368 regmap_write(tve
->regmap
, TVE_STAT_REG
, 0xffffffff);
373 static unsigned long clk_tve_di_recalc_rate(struct clk_hw
*hw
,
374 unsigned long parent_rate
)
376 struct imx_tve
*tve
= container_of(hw
, struct imx_tve
, clk_hw_di
);
380 ret
= regmap_read(tve
->regmap
, TVE_COM_CONF_REG
, &val
);
384 switch (val
& TVE_DAC_SAMP_RATE_MASK
) {
385 case TVE_DAC_DIV4_RATE
:
386 return parent_rate
/ 4;
387 case TVE_DAC_DIV2_RATE
:
388 return parent_rate
/ 2;
389 case TVE_DAC_FULL_RATE
:
397 static long clk_tve_di_round_rate(struct clk_hw
*hw
, unsigned long rate
,
398 unsigned long *prate
)
410 static int clk_tve_di_set_rate(struct clk_hw
*hw
, unsigned long rate
,
411 unsigned long parent_rate
)
413 struct imx_tve
*tve
= container_of(hw
, struct imx_tve
, clk_hw_di
);
418 div
= parent_rate
/ rate
;
420 val
= TVE_DAC_DIV4_RATE
;
422 val
= TVE_DAC_DIV2_RATE
;
424 val
= TVE_DAC_FULL_RATE
;
426 ret
= regmap_update_bits(tve
->regmap
, TVE_COM_CONF_REG
,
427 TVE_DAC_SAMP_RATE_MASK
, val
);
430 dev_err(tve
->dev
, "failed to set divider: %d\n", ret
);
437 static const struct clk_ops clk_tve_di_ops
= {
438 .round_rate
= clk_tve_di_round_rate
,
439 .set_rate
= clk_tve_di_set_rate
,
440 .recalc_rate
= clk_tve_di_recalc_rate
,
443 static int tve_clk_init(struct imx_tve
*tve
, void __iomem
*base
)
445 const char *tve_di_parent
[1];
446 struct clk_init_data init
= {
448 .ops
= &clk_tve_di_ops
,
453 tve_di_parent
[0] = __clk_get_name(tve
->clk
);
454 init
.parent_names
= (const char **)&tve_di_parent
;
456 tve
->clk_hw_di
.init
= &init
;
457 tve
->di_clk
= clk_register(tve
->dev
, &tve
->clk_hw_di
);
458 if (IS_ERR(tve
->di_clk
)) {
459 dev_err(tve
->dev
, "failed to register TVE output clock: %ld\n",
460 PTR_ERR(tve
->di_clk
));
461 return PTR_ERR(tve
->di_clk
);
467 static int imx_tve_register(struct drm_device
*drm
, struct imx_tve
*tve
)
472 encoder_type
= tve
->mode
== TVE_MODE_VGA
?
473 DRM_MODE_ENCODER_DAC
: DRM_MODE_ENCODER_TVDAC
;
475 ret
= imx_drm_encoder_parse_of(drm
, &tve
->encoder
, tve
->dev
->of_node
);
479 drm_encoder_helper_add(&tve
->encoder
, &imx_tve_encoder_helper_funcs
);
480 drm_encoder_init(drm
, &tve
->encoder
, &imx_tve_encoder_funcs
,
483 drm_connector_helper_add(&tve
->connector
,
484 &imx_tve_connector_helper_funcs
);
485 drm_connector_init(drm
, &tve
->connector
, &imx_tve_connector_funcs
,
486 DRM_MODE_CONNECTOR_VGA
);
488 drm_connector_attach_encoder(&tve
->connector
, &tve
->encoder
);
493 static bool imx_tve_readable_reg(struct device
*dev
, unsigned int reg
)
495 return (reg
% 4 == 0) && (reg
<= 0xdc);
498 static struct regmap_config tve_regmap_config
= {
503 .readable_reg
= imx_tve_readable_reg
,
506 .unlock
= tve_unlock
,
508 .max_register
= 0xdc,
511 static const char * const imx_tve_modes
[] = {
512 [TVE_MODE_TVOUT
] = "tvout",
513 [TVE_MODE_VGA
] = "vga",
516 static const int of_get_tve_mode(struct device_node
*np
)
521 ret
= of_property_read_string(np
, "fsl,tve-mode", &bm
);
525 for (i
= 0; i
< ARRAY_SIZE(imx_tve_modes
); i
++)
526 if (!strcasecmp(bm
, imx_tve_modes
[i
]))
532 static int imx_tve_bind(struct device
*dev
, struct device
*master
, void *data
)
534 struct platform_device
*pdev
= to_platform_device(dev
);
535 struct drm_device
*drm
= data
;
536 struct device_node
*np
= dev
->of_node
;
537 struct device_node
*ddc_node
;
539 struct resource
*res
;
545 tve
= devm_kzalloc(dev
, sizeof(*tve
), GFP_KERNEL
);
550 spin_lock_init(&tve
->lock
);
552 ddc_node
= of_parse_phandle(np
, "ddc-i2c-bus", 0);
554 tve
->ddc
= of_find_i2c_adapter_by_node(ddc_node
);
555 of_node_put(ddc_node
);
558 tve
->mode
= of_get_tve_mode(np
);
559 if (tve
->mode
!= TVE_MODE_VGA
) {
560 dev_err(dev
, "only VGA mode supported, currently\n");
564 if (tve
->mode
== TVE_MODE_VGA
) {
565 ret
= of_property_read_u32(np
, "fsl,hsync-pin",
569 dev_err(dev
, "failed to get hsync pin\n");
573 ret
= of_property_read_u32(np
, "fsl,vsync-pin",
577 dev_err(dev
, "failed to get vsync pin\n");
582 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
583 base
= devm_ioremap_resource(dev
, res
);
585 return PTR_ERR(base
);
587 tve_regmap_config
.lock_arg
= tve
;
588 tve
->regmap
= devm_regmap_init_mmio_clk(dev
, "tve", base
,
590 if (IS_ERR(tve
->regmap
)) {
591 dev_err(dev
, "failed to init regmap: %ld\n",
592 PTR_ERR(tve
->regmap
));
593 return PTR_ERR(tve
->regmap
);
596 irq
= platform_get_irq(pdev
, 0);
598 dev_err(dev
, "failed to get irq\n");
602 ret
= devm_request_threaded_irq(dev
, irq
, NULL
,
603 imx_tve_irq_handler
, IRQF_ONESHOT
,
606 dev_err(dev
, "failed to request irq: %d\n", ret
);
610 tve
->dac_reg
= devm_regulator_get(dev
, "dac");
611 if (!IS_ERR(tve
->dac_reg
)) {
612 if (regulator_get_voltage(tve
->dac_reg
) != IMX_TVE_DAC_VOLTAGE
)
613 dev_warn(dev
, "dac voltage is not %d uV\n", IMX_TVE_DAC_VOLTAGE
);
614 ret
= regulator_enable(tve
->dac_reg
);
619 tve
->clk
= devm_clk_get(dev
, "tve");
620 if (IS_ERR(tve
->clk
)) {
621 dev_err(dev
, "failed to get high speed tve clock: %ld\n",
623 return PTR_ERR(tve
->clk
);
626 /* this is the IPU DI clock input selector, can be parented to tve_di */
627 tve
->di_sel_clk
= devm_clk_get(dev
, "di_sel");
628 if (IS_ERR(tve
->di_sel_clk
)) {
629 dev_err(dev
, "failed to get ipu di mux clock: %ld\n",
630 PTR_ERR(tve
->di_sel_clk
));
631 return PTR_ERR(tve
->di_sel_clk
);
634 ret
= tve_clk_init(tve
, base
);
638 ret
= regmap_read(tve
->regmap
, TVE_COM_CONF_REG
, &val
);
640 dev_err(dev
, "failed to read configuration register: %d\n",
644 if (val
!= 0x00100000) {
645 dev_err(dev
, "configuration register default value indicates this is not a TVEv2\n");
649 /* disable cable detection for VGA mode */
650 ret
= regmap_write(tve
->regmap
, TVE_CD_CONT_REG
, 0);
654 ret
= imx_tve_register(drm
, tve
);
658 dev_set_drvdata(dev
, tve
);
663 static void imx_tve_unbind(struct device
*dev
, struct device
*master
,
666 struct imx_tve
*tve
= dev_get_drvdata(dev
);
668 if (!IS_ERR(tve
->dac_reg
))
669 regulator_disable(tve
->dac_reg
);
672 static const struct component_ops imx_tve_ops
= {
673 .bind
= imx_tve_bind
,
674 .unbind
= imx_tve_unbind
,
677 static int imx_tve_probe(struct platform_device
*pdev
)
679 return component_add(&pdev
->dev
, &imx_tve_ops
);
682 static int imx_tve_remove(struct platform_device
*pdev
)
684 component_del(&pdev
->dev
, &imx_tve_ops
);
688 static const struct of_device_id imx_tve_dt_ids
[] = {
689 { .compatible
= "fsl,imx53-tve", },
692 MODULE_DEVICE_TABLE(of
, imx_tve_dt_ids
);
694 static struct platform_driver imx_tve_driver
= {
695 .probe
= imx_tve_probe
,
696 .remove
= imx_tve_remove
,
698 .of_match_table
= imx_tve_dt_ids
,
703 module_platform_driver(imx_tve_driver
);
705 MODULE_DESCRIPTION("i.MX Television Encoder driver");
706 MODULE_AUTHOR("Philipp Zabel, Pengutronix");
707 MODULE_LICENSE("GPL");
708 MODULE_ALIAS("platform:imx-tve");