2 * i.MX drm driver - Television Encoder (TVEv2)
4 * Copyright (C) 2013 Philipp Zabel, Pengutronix
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
16 #include <linux/clk.h>
17 #include <linux/clk-provider.h>
18 #include <linux/component.h>
19 #include <linux/module.h>
20 #include <linux/i2c.h>
21 #include <linux/regmap.h>
22 #include <linux/regulator/consumer.h>
23 #include <linux/spinlock.h>
24 #include <linux/videodev2.h>
26 #include <drm/drm_atomic_helper.h>
27 #include <drm/drm_fb_helper.h>
28 #include <drm/drm_crtc_helper.h>
29 #include <video/imx-ipu-v3.h>
33 #define TVE_COM_CONF_REG 0x00
34 #define TVE_TVDAC0_CONT_REG 0x28
35 #define TVE_TVDAC1_CONT_REG 0x2c
36 #define TVE_TVDAC2_CONT_REG 0x30
37 #define TVE_CD_CONT_REG 0x34
38 #define TVE_INT_CONT_REG 0x64
39 #define TVE_STAT_REG 0x68
40 #define TVE_TST_MODE_REG 0x6c
41 #define TVE_MV_CONT_REG 0xdc
43 /* TVE_COM_CONF_REG */
44 #define TVE_SYNC_CH_2_EN BIT(22)
45 #define TVE_SYNC_CH_1_EN BIT(21)
46 #define TVE_SYNC_CH_0_EN BIT(20)
47 #define TVE_TV_OUT_MODE_MASK (0x7 << 12)
48 #define TVE_TV_OUT_DISABLE (0x0 << 12)
49 #define TVE_TV_OUT_CVBS_0 (0x1 << 12)
50 #define TVE_TV_OUT_CVBS_2 (0x2 << 12)
51 #define TVE_TV_OUT_CVBS_0_2 (0x3 << 12)
52 #define TVE_TV_OUT_SVIDEO_0_1 (0x4 << 12)
53 #define TVE_TV_OUT_SVIDEO_0_1_CVBS2_2 (0x5 << 12)
54 #define TVE_TV_OUT_YPBPR (0x6 << 12)
55 #define TVE_TV_OUT_RGB (0x7 << 12)
56 #define TVE_TV_STAND_MASK (0xf << 8)
57 #define TVE_TV_STAND_HD_1080P30 (0xc << 8)
58 #define TVE_P2I_CONV_EN BIT(7)
59 #define TVE_INP_VIDEO_FORM BIT(6)
60 #define TVE_INP_YCBCR_422 (0x0 << 6)
61 #define TVE_INP_YCBCR_444 (0x1 << 6)
62 #define TVE_DATA_SOURCE_MASK (0x3 << 4)
63 #define TVE_DATA_SOURCE_BUS1 (0x0 << 4)
64 #define TVE_DATA_SOURCE_BUS2 (0x1 << 4)
65 #define TVE_DATA_SOURCE_EXT (0x2 << 4)
66 #define TVE_DATA_SOURCE_TESTGEN (0x3 << 4)
67 #define TVE_IPU_CLK_EN_OFS 3
68 #define TVE_IPU_CLK_EN BIT(3)
69 #define TVE_DAC_SAMP_RATE_OFS 1
70 #define TVE_DAC_SAMP_RATE_WIDTH 2
71 #define TVE_DAC_SAMP_RATE_MASK (0x3 << 1)
72 #define TVE_DAC_FULL_RATE (0x0 << 1)
73 #define TVE_DAC_DIV2_RATE (0x1 << 1)
74 #define TVE_DAC_DIV4_RATE (0x2 << 1)
77 /* TVE_TVDACx_CONT_REG */
78 #define TVE_TVDAC_GAIN_MASK (0x3f << 0)
81 #define TVE_CD_CH_2_SM_EN BIT(22)
82 #define TVE_CD_CH_1_SM_EN BIT(21)
83 #define TVE_CD_CH_0_SM_EN BIT(20)
84 #define TVE_CD_CH_2_LM_EN BIT(18)
85 #define TVE_CD_CH_1_LM_EN BIT(17)
86 #define TVE_CD_CH_0_LM_EN BIT(16)
87 #define TVE_CD_CH_2_REF_LVL BIT(10)
88 #define TVE_CD_CH_1_REF_LVL BIT(9)
89 #define TVE_CD_CH_0_REF_LVL BIT(8)
90 #define TVE_CD_EN BIT(0)
92 /* TVE_INT_CONT_REG */
93 #define TVE_FRAME_END_IEN BIT(13)
94 #define TVE_CD_MON_END_IEN BIT(2)
95 #define TVE_CD_SM_IEN BIT(1)
96 #define TVE_CD_LM_IEN BIT(0)
98 /* TVE_TST_MODE_REG */
99 #define TVE_TVDAC_TEST_MODE_MASK (0x7 << 0)
101 #define IMX_TVE_DAC_VOLTAGE 2750000
109 struct drm_connector connector
;
110 struct drm_encoder encoder
;
112 spinlock_t lock
; /* register lock */
118 struct regmap
*regmap
;
119 struct regulator
*dac_reg
;
120 struct i2c_adapter
*ddc
;
122 struct clk
*di_sel_clk
;
123 struct clk_hw clk_hw_di
;
127 static inline struct imx_tve
*con_to_tve(struct drm_connector
*c
)
129 return container_of(c
, struct imx_tve
, connector
);
132 static inline struct imx_tve
*enc_to_tve(struct drm_encoder
*e
)
134 return container_of(e
, struct imx_tve
, encoder
);
137 static void tve_lock(void *__tve
)
138 __acquires(&tve
->lock
)
140 struct imx_tve
*tve
= __tve
;
142 spin_lock(&tve
->lock
);
145 static void tve_unlock(void *__tve
)
146 __releases(&tve
->lock
)
148 struct imx_tve
*tve
= __tve
;
150 spin_unlock(&tve
->lock
);
153 static void tve_enable(struct imx_tve
*tve
)
157 clk_prepare_enable(tve
->clk
);
158 regmap_update_bits(tve
->regmap
, TVE_COM_CONF_REG
,
162 /* clear interrupt status register */
163 regmap_write(tve
->regmap
, TVE_STAT_REG
, 0xffffffff);
165 /* cable detection irq disabled in VGA mode, enabled in TVOUT mode */
166 if (tve
->mode
== TVE_MODE_VGA
)
167 regmap_write(tve
->regmap
, TVE_INT_CONT_REG
, 0);
169 regmap_write(tve
->regmap
, TVE_INT_CONT_REG
,
175 static void tve_disable(struct imx_tve
*tve
)
178 tve
->enabled
= false;
179 regmap_update_bits(tve
->regmap
, TVE_COM_CONF_REG
, TVE_EN
, 0);
180 clk_disable_unprepare(tve
->clk
);
184 static int tve_setup_tvout(struct imx_tve
*tve
)
189 static int tve_setup_vga(struct imx_tve
*tve
)
195 /* set gain to (1 + 10/128) to provide 0.7V peak-to-peak amplitude */
196 ret
= regmap_update_bits(tve
->regmap
, TVE_TVDAC0_CONT_REG
,
197 TVE_TVDAC_GAIN_MASK
, 0x0a);
201 ret
= regmap_update_bits(tve
->regmap
, TVE_TVDAC1_CONT_REG
,
202 TVE_TVDAC_GAIN_MASK
, 0x0a);
206 ret
= regmap_update_bits(tve
->regmap
, TVE_TVDAC2_CONT_REG
,
207 TVE_TVDAC_GAIN_MASK
, 0x0a);
211 /* set configuration register */
212 mask
= TVE_DATA_SOURCE_MASK
| TVE_INP_VIDEO_FORM
;
213 val
= TVE_DATA_SOURCE_BUS2
| TVE_INP_YCBCR_444
;
214 mask
|= TVE_TV_STAND_MASK
| TVE_P2I_CONV_EN
;
215 val
|= TVE_TV_STAND_HD_1080P30
| 0;
216 mask
|= TVE_TV_OUT_MODE_MASK
| TVE_SYNC_CH_0_EN
;
217 val
|= TVE_TV_OUT_RGB
| TVE_SYNC_CH_0_EN
;
218 ret
= regmap_update_bits(tve
->regmap
, TVE_COM_CONF_REG
, mask
, val
);
222 /* set test mode (as documented) */
223 return regmap_update_bits(tve
->regmap
, TVE_TST_MODE_REG
,
224 TVE_TVDAC_TEST_MODE_MASK
, 1);
227 static int imx_tve_connector_get_modes(struct drm_connector
*connector
)
229 struct imx_tve
*tve
= con_to_tve(connector
);
236 edid
= drm_get_edid(connector
, tve
->ddc
);
238 drm_connector_update_edid_property(connector
, edid
);
239 ret
= drm_add_edid_modes(connector
, edid
);
246 static int imx_tve_connector_mode_valid(struct drm_connector
*connector
,
247 struct drm_display_mode
*mode
)
249 struct imx_tve
*tve
= con_to_tve(connector
);
252 /* pixel clock with 2x oversampling */
253 rate
= clk_round_rate(tve
->clk
, 2000UL * mode
->clock
) / 2000;
254 if (rate
== mode
->clock
)
257 /* pixel clock without oversampling */
258 rate
= clk_round_rate(tve
->clk
, 1000UL * mode
->clock
) / 1000;
259 if (rate
== mode
->clock
)
262 dev_warn(tve
->dev
, "ignoring mode %dx%d\n",
263 mode
->hdisplay
, mode
->vdisplay
);
268 static struct drm_encoder
*imx_tve_connector_best_encoder(
269 struct drm_connector
*connector
)
271 struct imx_tve
*tve
= con_to_tve(connector
);
273 return &tve
->encoder
;
276 static void imx_tve_encoder_mode_set(struct drm_encoder
*encoder
,
277 struct drm_display_mode
*orig_mode
,
278 struct drm_display_mode
*mode
)
280 struct imx_tve
*tve
= enc_to_tve(encoder
);
281 unsigned long rounded_rate
;
288 * we should try 4k * mode->clock first,
289 * and enable 4x oversampling for lower resolutions
291 rate
= 2000UL * mode
->clock
;
292 clk_set_rate(tve
->clk
, rate
);
293 rounded_rate
= clk_get_rate(tve
->clk
);
294 if (rounded_rate
>= rate
)
296 clk_set_rate(tve
->di_clk
, rounded_rate
/ div
);
298 ret
= clk_set_parent(tve
->di_sel_clk
, tve
->di_clk
);
300 dev_err(tve
->dev
, "failed to set di_sel parent to tve_di: %d\n",
304 regmap_update_bits(tve
->regmap
, TVE_COM_CONF_REG
,
305 TVE_IPU_CLK_EN
, TVE_IPU_CLK_EN
);
307 if (tve
->mode
== TVE_MODE_VGA
)
308 ret
= tve_setup_vga(tve
);
310 ret
= tve_setup_tvout(tve
);
312 dev_err(tve
->dev
, "failed to set configuration: %d\n", ret
);
315 static void imx_tve_encoder_enable(struct drm_encoder
*encoder
)
317 struct imx_tve
*tve
= enc_to_tve(encoder
);
322 static void imx_tve_encoder_disable(struct drm_encoder
*encoder
)
324 struct imx_tve
*tve
= enc_to_tve(encoder
);
329 static int imx_tve_atomic_check(struct drm_encoder
*encoder
,
330 struct drm_crtc_state
*crtc_state
,
331 struct drm_connector_state
*conn_state
)
333 struct imx_crtc_state
*imx_crtc_state
= to_imx_crtc_state(crtc_state
);
334 struct imx_tve
*tve
= enc_to_tve(encoder
);
336 imx_crtc_state
->bus_format
= MEDIA_BUS_FMT_GBR888_1X24
;
337 imx_crtc_state
->di_hsync_pin
= tve
->di_hsync_pin
;
338 imx_crtc_state
->di_vsync_pin
= tve
->di_vsync_pin
;
343 static const struct drm_connector_funcs imx_tve_connector_funcs
= {
344 .fill_modes
= drm_helper_probe_single_connector_modes
,
345 .destroy
= imx_drm_connector_destroy
,
346 .reset
= drm_atomic_helper_connector_reset
,
347 .atomic_duplicate_state
= drm_atomic_helper_connector_duplicate_state
,
348 .atomic_destroy_state
= drm_atomic_helper_connector_destroy_state
,
351 static const struct drm_connector_helper_funcs imx_tve_connector_helper_funcs
= {
352 .get_modes
= imx_tve_connector_get_modes
,
353 .best_encoder
= imx_tve_connector_best_encoder
,
354 .mode_valid
= imx_tve_connector_mode_valid
,
357 static const struct drm_encoder_funcs imx_tve_encoder_funcs
= {
358 .destroy
= imx_drm_encoder_destroy
,
361 static const struct drm_encoder_helper_funcs imx_tve_encoder_helper_funcs
= {
362 .mode_set
= imx_tve_encoder_mode_set
,
363 .enable
= imx_tve_encoder_enable
,
364 .disable
= imx_tve_encoder_disable
,
365 .atomic_check
= imx_tve_atomic_check
,
368 static irqreturn_t
imx_tve_irq_handler(int irq
, void *data
)
370 struct imx_tve
*tve
= data
;
373 regmap_read(tve
->regmap
, TVE_STAT_REG
, &val
);
375 /* clear interrupt status register */
376 regmap_write(tve
->regmap
, TVE_STAT_REG
, 0xffffffff);
381 static unsigned long clk_tve_di_recalc_rate(struct clk_hw
*hw
,
382 unsigned long parent_rate
)
384 struct imx_tve
*tve
= container_of(hw
, struct imx_tve
, clk_hw_di
);
388 ret
= regmap_read(tve
->regmap
, TVE_COM_CONF_REG
, &val
);
392 switch (val
& TVE_DAC_SAMP_RATE_MASK
) {
393 case TVE_DAC_DIV4_RATE
:
394 return parent_rate
/ 4;
395 case TVE_DAC_DIV2_RATE
:
396 return parent_rate
/ 2;
397 case TVE_DAC_FULL_RATE
:
405 static long clk_tve_di_round_rate(struct clk_hw
*hw
, unsigned long rate
,
406 unsigned long *prate
)
418 static int clk_tve_di_set_rate(struct clk_hw
*hw
, unsigned long rate
,
419 unsigned long parent_rate
)
421 struct imx_tve
*tve
= container_of(hw
, struct imx_tve
, clk_hw_di
);
426 div
= parent_rate
/ rate
;
428 val
= TVE_DAC_DIV4_RATE
;
430 val
= TVE_DAC_DIV2_RATE
;
432 val
= TVE_DAC_FULL_RATE
;
434 ret
= regmap_update_bits(tve
->regmap
, TVE_COM_CONF_REG
,
435 TVE_DAC_SAMP_RATE_MASK
, val
);
438 dev_err(tve
->dev
, "failed to set divider: %d\n", ret
);
445 static struct clk_ops clk_tve_di_ops
= {
446 .round_rate
= clk_tve_di_round_rate
,
447 .set_rate
= clk_tve_di_set_rate
,
448 .recalc_rate
= clk_tve_di_recalc_rate
,
451 static int tve_clk_init(struct imx_tve
*tve
, void __iomem
*base
)
453 const char *tve_di_parent
[1];
454 struct clk_init_data init
= {
456 .ops
= &clk_tve_di_ops
,
461 tve_di_parent
[0] = __clk_get_name(tve
->clk
);
462 init
.parent_names
= (const char **)&tve_di_parent
;
464 tve
->clk_hw_di
.init
= &init
;
465 tve
->di_clk
= clk_register(tve
->dev
, &tve
->clk_hw_di
);
466 if (IS_ERR(tve
->di_clk
)) {
467 dev_err(tve
->dev
, "failed to register TVE output clock: %ld\n",
468 PTR_ERR(tve
->di_clk
));
469 return PTR_ERR(tve
->di_clk
);
475 static int imx_tve_register(struct drm_device
*drm
, struct imx_tve
*tve
)
480 encoder_type
= tve
->mode
== TVE_MODE_VGA
?
481 DRM_MODE_ENCODER_DAC
: DRM_MODE_ENCODER_TVDAC
;
483 ret
= imx_drm_encoder_parse_of(drm
, &tve
->encoder
, tve
->dev
->of_node
);
487 drm_encoder_helper_add(&tve
->encoder
, &imx_tve_encoder_helper_funcs
);
488 drm_encoder_init(drm
, &tve
->encoder
, &imx_tve_encoder_funcs
,
491 drm_connector_helper_add(&tve
->connector
,
492 &imx_tve_connector_helper_funcs
);
493 drm_connector_init(drm
, &tve
->connector
, &imx_tve_connector_funcs
,
494 DRM_MODE_CONNECTOR_VGA
);
496 drm_connector_attach_encoder(&tve
->connector
, &tve
->encoder
);
501 static bool imx_tve_readable_reg(struct device
*dev
, unsigned int reg
)
503 return (reg
% 4 == 0) && (reg
<= 0xdc);
506 static struct regmap_config tve_regmap_config
= {
511 .readable_reg
= imx_tve_readable_reg
,
514 .unlock
= tve_unlock
,
516 .max_register
= 0xdc,
519 static const char * const imx_tve_modes
[] = {
520 [TVE_MODE_TVOUT
] = "tvout",
521 [TVE_MODE_VGA
] = "vga",
524 static const int of_get_tve_mode(struct device_node
*np
)
529 ret
= of_property_read_string(np
, "fsl,tve-mode", &bm
);
533 for (i
= 0; i
< ARRAY_SIZE(imx_tve_modes
); i
++)
534 if (!strcasecmp(bm
, imx_tve_modes
[i
]))
540 static int imx_tve_bind(struct device
*dev
, struct device
*master
, void *data
)
542 struct platform_device
*pdev
= to_platform_device(dev
);
543 struct drm_device
*drm
= data
;
544 struct device_node
*np
= dev
->of_node
;
545 struct device_node
*ddc_node
;
547 struct resource
*res
;
553 tve
= devm_kzalloc(dev
, sizeof(*tve
), GFP_KERNEL
);
558 spin_lock_init(&tve
->lock
);
560 ddc_node
= of_parse_phandle(np
, "ddc-i2c-bus", 0);
562 tve
->ddc
= of_find_i2c_adapter_by_node(ddc_node
);
563 of_node_put(ddc_node
);
566 tve
->mode
= of_get_tve_mode(np
);
567 if (tve
->mode
!= TVE_MODE_VGA
) {
568 dev_err(dev
, "only VGA mode supported, currently\n");
572 if (tve
->mode
== TVE_MODE_VGA
) {
573 ret
= of_property_read_u32(np
, "fsl,hsync-pin",
577 dev_err(dev
, "failed to get hsync pin\n");
581 ret
= of_property_read_u32(np
, "fsl,vsync-pin",
585 dev_err(dev
, "failed to get vsync pin\n");
590 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
591 base
= devm_ioremap_resource(dev
, res
);
593 return PTR_ERR(base
);
595 tve_regmap_config
.lock_arg
= tve
;
596 tve
->regmap
= devm_regmap_init_mmio_clk(dev
, "tve", base
,
598 if (IS_ERR(tve
->regmap
)) {
599 dev_err(dev
, "failed to init regmap: %ld\n",
600 PTR_ERR(tve
->regmap
));
601 return PTR_ERR(tve
->regmap
);
604 irq
= platform_get_irq(pdev
, 0);
606 dev_err(dev
, "failed to get irq\n");
610 ret
= devm_request_threaded_irq(dev
, irq
, NULL
,
611 imx_tve_irq_handler
, IRQF_ONESHOT
,
614 dev_err(dev
, "failed to request irq: %d\n", ret
);
618 tve
->dac_reg
= devm_regulator_get(dev
, "dac");
619 if (!IS_ERR(tve
->dac_reg
)) {
620 if (regulator_get_voltage(tve
->dac_reg
) != IMX_TVE_DAC_VOLTAGE
)
621 dev_warn(dev
, "dac voltage is not %d uV\n", IMX_TVE_DAC_VOLTAGE
);
622 ret
= regulator_enable(tve
->dac_reg
);
627 tve
->clk
= devm_clk_get(dev
, "tve");
628 if (IS_ERR(tve
->clk
)) {
629 dev_err(dev
, "failed to get high speed tve clock: %ld\n",
631 return PTR_ERR(tve
->clk
);
634 /* this is the IPU DI clock input selector, can be parented to tve_di */
635 tve
->di_sel_clk
= devm_clk_get(dev
, "di_sel");
636 if (IS_ERR(tve
->di_sel_clk
)) {
637 dev_err(dev
, "failed to get ipu di mux clock: %ld\n",
638 PTR_ERR(tve
->di_sel_clk
));
639 return PTR_ERR(tve
->di_sel_clk
);
642 ret
= tve_clk_init(tve
, base
);
646 ret
= regmap_read(tve
->regmap
, TVE_COM_CONF_REG
, &val
);
648 dev_err(dev
, "failed to read configuration register: %d\n",
652 if (val
!= 0x00100000) {
653 dev_err(dev
, "configuration register default value indicates this is not a TVEv2\n");
657 /* disable cable detection for VGA mode */
658 ret
= regmap_write(tve
->regmap
, TVE_CD_CONT_REG
, 0);
662 ret
= imx_tve_register(drm
, tve
);
666 dev_set_drvdata(dev
, tve
);
671 static void imx_tve_unbind(struct device
*dev
, struct device
*master
,
674 struct imx_tve
*tve
= dev_get_drvdata(dev
);
676 if (!IS_ERR(tve
->dac_reg
))
677 regulator_disable(tve
->dac_reg
);
680 static const struct component_ops imx_tve_ops
= {
681 .bind
= imx_tve_bind
,
682 .unbind
= imx_tve_unbind
,
685 static int imx_tve_probe(struct platform_device
*pdev
)
687 return component_add(&pdev
->dev
, &imx_tve_ops
);
690 static int imx_tve_remove(struct platform_device
*pdev
)
692 component_del(&pdev
->dev
, &imx_tve_ops
);
696 static const struct of_device_id imx_tve_dt_ids
[] = {
697 { .compatible
= "fsl,imx53-tve", },
700 MODULE_DEVICE_TABLE(of
, imx_tve_dt_ids
);
702 static struct platform_driver imx_tve_driver
= {
703 .probe
= imx_tve_probe
,
704 .remove
= imx_tve_remove
,
706 .of_match_table
= imx_tve_dt_ids
,
711 module_platform_driver(imx_tve_driver
);
713 MODULE_DESCRIPTION("i.MX Television Encoder driver");
714 MODULE_AUTHOR("Philipp Zabel, Pengutronix");
715 MODULE_LICENSE("GPL");
716 MODULE_ALIAS("platform:imx-tve");