1 // SPDX-License-Identifier: GPL-2.0+
3 * i.MX drm driver - Television Encoder (TVEv2)
5 * Copyright (C) 2013 Philipp Zabel, Pengutronix
8 #include <linux/clk-provider.h>
10 #include <linux/component.h>
11 #include <linux/i2c.h>
12 #include <linux/module.h>
13 #include <linux/platform_device.h>
14 #include <linux/regmap.h>
15 #include <linux/regulator/consumer.h>
16 #include <linux/spinlock.h>
17 #include <linux/videodev2.h>
19 #include <video/imx-ipu-v3.h>
21 #include <drm/drm_atomic_helper.h>
22 #include <drm/drm_fb_helper.h>
23 #include <drm/drm_probe_helper.h>
24 #include <drm/drm_simple_kms_helper.h>
28 #define TVE_COM_CONF_REG 0x00
29 #define TVE_TVDAC0_CONT_REG 0x28
30 #define TVE_TVDAC1_CONT_REG 0x2c
31 #define TVE_TVDAC2_CONT_REG 0x30
32 #define TVE_CD_CONT_REG 0x34
33 #define TVE_INT_CONT_REG 0x64
34 #define TVE_STAT_REG 0x68
35 #define TVE_TST_MODE_REG 0x6c
36 #define TVE_MV_CONT_REG 0xdc
38 /* TVE_COM_CONF_REG */
39 #define TVE_SYNC_CH_2_EN BIT(22)
40 #define TVE_SYNC_CH_1_EN BIT(21)
41 #define TVE_SYNC_CH_0_EN BIT(20)
42 #define TVE_TV_OUT_MODE_MASK (0x7 << 12)
43 #define TVE_TV_OUT_DISABLE (0x0 << 12)
44 #define TVE_TV_OUT_CVBS_0 (0x1 << 12)
45 #define TVE_TV_OUT_CVBS_2 (0x2 << 12)
46 #define TVE_TV_OUT_CVBS_0_2 (0x3 << 12)
47 #define TVE_TV_OUT_SVIDEO_0_1 (0x4 << 12)
48 #define TVE_TV_OUT_SVIDEO_0_1_CVBS2_2 (0x5 << 12)
49 #define TVE_TV_OUT_YPBPR (0x6 << 12)
50 #define TVE_TV_OUT_RGB (0x7 << 12)
51 #define TVE_TV_STAND_MASK (0xf << 8)
52 #define TVE_TV_STAND_HD_1080P30 (0xc << 8)
53 #define TVE_P2I_CONV_EN BIT(7)
54 #define TVE_INP_VIDEO_FORM BIT(6)
55 #define TVE_INP_YCBCR_422 (0x0 << 6)
56 #define TVE_INP_YCBCR_444 (0x1 << 6)
57 #define TVE_DATA_SOURCE_MASK (0x3 << 4)
58 #define TVE_DATA_SOURCE_BUS1 (0x0 << 4)
59 #define TVE_DATA_SOURCE_BUS2 (0x1 << 4)
60 #define TVE_DATA_SOURCE_EXT (0x2 << 4)
61 #define TVE_DATA_SOURCE_TESTGEN (0x3 << 4)
62 #define TVE_IPU_CLK_EN_OFS 3
63 #define TVE_IPU_CLK_EN BIT(3)
64 #define TVE_DAC_SAMP_RATE_OFS 1
65 #define TVE_DAC_SAMP_RATE_WIDTH 2
66 #define TVE_DAC_SAMP_RATE_MASK (0x3 << 1)
67 #define TVE_DAC_FULL_RATE (0x0 << 1)
68 #define TVE_DAC_DIV2_RATE (0x1 << 1)
69 #define TVE_DAC_DIV4_RATE (0x2 << 1)
72 /* TVE_TVDACx_CONT_REG */
73 #define TVE_TVDAC_GAIN_MASK (0x3f << 0)
76 #define TVE_CD_CH_2_SM_EN BIT(22)
77 #define TVE_CD_CH_1_SM_EN BIT(21)
78 #define TVE_CD_CH_0_SM_EN BIT(20)
79 #define TVE_CD_CH_2_LM_EN BIT(18)
80 #define TVE_CD_CH_1_LM_EN BIT(17)
81 #define TVE_CD_CH_0_LM_EN BIT(16)
82 #define TVE_CD_CH_2_REF_LVL BIT(10)
83 #define TVE_CD_CH_1_REF_LVL BIT(9)
84 #define TVE_CD_CH_0_REF_LVL BIT(8)
85 #define TVE_CD_EN BIT(0)
87 /* TVE_INT_CONT_REG */
88 #define TVE_FRAME_END_IEN BIT(13)
89 #define TVE_CD_MON_END_IEN BIT(2)
90 #define TVE_CD_SM_IEN BIT(1)
91 #define TVE_CD_LM_IEN BIT(0)
93 /* TVE_TST_MODE_REG */
94 #define TVE_TVDAC_TEST_MODE_MASK (0x7 << 0)
96 #define IMX_TVE_DAC_VOLTAGE 2750000
104 struct drm_connector connector;
105 struct drm_encoder encoder;
107 spinlock_t lock; /* register lock */
113 struct regmap *regmap;
114 struct regulator *dac_reg;
115 struct i2c_adapter *ddc;
117 struct clk *di_sel_clk;
118 struct clk_hw clk_hw_di;
122 static inline struct imx_tve *con_to_tve(struct drm_connector *c)
124 return container_of(c, struct imx_tve, connector);
127 static inline struct imx_tve *enc_to_tve(struct drm_encoder *e)
129 return container_of(e, struct imx_tve, encoder);
132 static void tve_lock(void *__tve)
133 __acquires(&tve->lock)
135 struct imx_tve *tve = __tve;
137 spin_lock(&tve->lock);
140 static void tve_unlock(void *__tve)
141 __releases(&tve->lock)
143 struct imx_tve *tve = __tve;
145 spin_unlock(&tve->lock);
148 static void tve_enable(struct imx_tve *tve)
152 clk_prepare_enable(tve->clk);
153 regmap_update_bits(tve->regmap, TVE_COM_CONF_REG,
157 /* clear interrupt status register */
158 regmap_write(tve->regmap, TVE_STAT_REG, 0xffffffff);
160 /* cable detection irq disabled in VGA mode, enabled in TVOUT mode */
161 if (tve->mode == TVE_MODE_VGA)
162 regmap_write(tve->regmap, TVE_INT_CONT_REG, 0);
164 regmap_write(tve->regmap, TVE_INT_CONT_REG,
170 static void tve_disable(struct imx_tve *tve)
173 tve->enabled = false;
174 regmap_update_bits(tve->regmap, TVE_COM_CONF_REG, TVE_EN, 0);
175 clk_disable_unprepare(tve->clk);
179 static int tve_setup_tvout(struct imx_tve *tve)
184 static int tve_setup_vga(struct imx_tve *tve)
190 /* set gain to (1 + 10/128) to provide 0.7V peak-to-peak amplitude */
191 ret = regmap_update_bits(tve->regmap, TVE_TVDAC0_CONT_REG,
192 TVE_TVDAC_GAIN_MASK, 0x0a);
196 ret = regmap_update_bits(tve->regmap, TVE_TVDAC1_CONT_REG,
197 TVE_TVDAC_GAIN_MASK, 0x0a);
201 ret = regmap_update_bits(tve->regmap, TVE_TVDAC2_CONT_REG,
202 TVE_TVDAC_GAIN_MASK, 0x0a);
206 /* set configuration register */
207 mask = TVE_DATA_SOURCE_MASK | TVE_INP_VIDEO_FORM;
208 val = TVE_DATA_SOURCE_BUS2 | TVE_INP_YCBCR_444;
209 mask |= TVE_TV_STAND_MASK | TVE_P2I_CONV_EN;
210 val |= TVE_TV_STAND_HD_1080P30 | 0;
211 mask |= TVE_TV_OUT_MODE_MASK | TVE_SYNC_CH_0_EN;
212 val |= TVE_TV_OUT_RGB | TVE_SYNC_CH_0_EN;
213 ret = regmap_update_bits(tve->regmap, TVE_COM_CONF_REG, mask, val);
217 /* set test mode (as documented) */
218 return regmap_update_bits(tve->regmap, TVE_TST_MODE_REG,
219 TVE_TVDAC_TEST_MODE_MASK, 1);
222 static int imx_tve_connector_get_modes(struct drm_connector *connector)
224 struct imx_tve *tve = con_to_tve(connector);
231 edid = drm_get_edid(connector, tve->ddc);
233 drm_connector_update_edid_property(connector, edid);
234 ret = drm_add_edid_modes(connector, edid);
241 static int imx_tve_connector_mode_valid(struct drm_connector *connector,
242 struct drm_display_mode *mode)
244 struct imx_tve *tve = con_to_tve(connector);
247 /* pixel clock with 2x oversampling */
248 rate = clk_round_rate(tve->clk, 2000UL * mode->clock) / 2000;
249 if (rate == mode->clock)
252 /* pixel clock without oversampling */
253 rate = clk_round_rate(tve->clk, 1000UL * mode->clock) / 1000;
254 if (rate == mode->clock)
257 dev_warn(tve->dev, "ignoring mode %dx%d\n",
258 mode->hdisplay, mode->vdisplay);
263 static struct drm_encoder *imx_tve_connector_best_encoder(
264 struct drm_connector *connector)
266 struct imx_tve *tve = con_to_tve(connector);
268 return &tve->encoder;
271 static void imx_tve_encoder_mode_set(struct drm_encoder *encoder,
272 struct drm_display_mode *orig_mode,
273 struct drm_display_mode *mode)
275 struct imx_tve *tve = enc_to_tve(encoder);
276 unsigned long rounded_rate;
283 * we should try 4k * mode->clock first,
284 * and enable 4x oversampling for lower resolutions
286 rate = 2000UL * mode->clock;
287 clk_set_rate(tve->clk, rate);
288 rounded_rate = clk_get_rate(tve->clk);
289 if (rounded_rate >= rate)
291 clk_set_rate(tve->di_clk, rounded_rate / div);
293 ret = clk_set_parent(tve->di_sel_clk, tve->di_clk);
295 dev_err(tve->dev, "failed to set di_sel parent to tve_di: %d\n",
299 regmap_update_bits(tve->regmap, TVE_COM_CONF_REG,
300 TVE_IPU_CLK_EN, TVE_IPU_CLK_EN);
302 if (tve->mode == TVE_MODE_VGA)
303 ret = tve_setup_vga(tve);
305 ret = tve_setup_tvout(tve);
307 dev_err(tve->dev, "failed to set configuration: %d\n", ret);
310 static void imx_tve_encoder_enable(struct drm_encoder *encoder)
312 struct imx_tve *tve = enc_to_tve(encoder);
317 static void imx_tve_encoder_disable(struct drm_encoder *encoder)
319 struct imx_tve *tve = enc_to_tve(encoder);
324 static int imx_tve_atomic_check(struct drm_encoder *encoder,
325 struct drm_crtc_state *crtc_state,
326 struct drm_connector_state *conn_state)
328 struct imx_crtc_state *imx_crtc_state = to_imx_crtc_state(crtc_state);
329 struct imx_tve *tve = enc_to_tve(encoder);
331 imx_crtc_state->bus_format = MEDIA_BUS_FMT_GBR888_1X24;
332 imx_crtc_state->di_hsync_pin = tve->di_hsync_pin;
333 imx_crtc_state->di_vsync_pin = tve->di_vsync_pin;
338 static const struct drm_connector_funcs imx_tve_connector_funcs = {
339 .fill_modes = drm_helper_probe_single_connector_modes,
340 .destroy = imx_drm_connector_destroy,
341 .reset = drm_atomic_helper_connector_reset,
342 .atomic_duplicate_state = drm_atomic_helper_connector_duplicate_state,
343 .atomic_destroy_state = drm_atomic_helper_connector_destroy_state,
346 static const struct drm_connector_helper_funcs imx_tve_connector_helper_funcs = {
347 .get_modes = imx_tve_connector_get_modes,
348 .best_encoder = imx_tve_connector_best_encoder,
349 .mode_valid = imx_tve_connector_mode_valid,
352 static const struct drm_encoder_helper_funcs imx_tve_encoder_helper_funcs = {
353 .mode_set = imx_tve_encoder_mode_set,
354 .enable = imx_tve_encoder_enable,
355 .disable = imx_tve_encoder_disable,
356 .atomic_check = imx_tve_atomic_check,
359 static irqreturn_t imx_tve_irq_handler(int irq, void *data)
361 struct imx_tve *tve = data;
364 regmap_read(tve->regmap, TVE_STAT_REG, &val);
366 /* clear interrupt status register */
367 regmap_write(tve->regmap, TVE_STAT_REG, 0xffffffff);
372 static unsigned long clk_tve_di_recalc_rate(struct clk_hw *hw,
373 unsigned long parent_rate)
375 struct imx_tve *tve = container_of(hw, struct imx_tve, clk_hw_di);
379 ret = regmap_read(tve->regmap, TVE_COM_CONF_REG, &val);
383 switch (val & TVE_DAC_SAMP_RATE_MASK) {
384 case TVE_DAC_DIV4_RATE:
385 return parent_rate / 4;
386 case TVE_DAC_DIV2_RATE:
387 return parent_rate / 2;
388 case TVE_DAC_FULL_RATE:
396 static long clk_tve_di_round_rate(struct clk_hw *hw, unsigned long rate,
397 unsigned long *prate)
409 static int clk_tve_di_set_rate(struct clk_hw *hw, unsigned long rate,
410 unsigned long parent_rate)
412 struct imx_tve *tve = container_of(hw, struct imx_tve, clk_hw_di);
417 div = parent_rate / rate;
419 val = TVE_DAC_DIV4_RATE;
421 val = TVE_DAC_DIV2_RATE;
423 val = TVE_DAC_FULL_RATE;
425 ret = regmap_update_bits(tve->regmap, TVE_COM_CONF_REG,
426 TVE_DAC_SAMP_RATE_MASK, val);
429 dev_err(tve->dev, "failed to set divider: %d\n", ret);
436 static const struct clk_ops clk_tve_di_ops = {
437 .round_rate = clk_tve_di_round_rate,
438 .set_rate = clk_tve_di_set_rate,
439 .recalc_rate = clk_tve_di_recalc_rate,
442 static int tve_clk_init(struct imx_tve *tve, void __iomem *base)
444 const char *tve_di_parent[1];
445 struct clk_init_data init = {
447 .ops = &clk_tve_di_ops,
452 tve_di_parent[0] = __clk_get_name(tve->clk);
453 init.parent_names = (const char **)&tve_di_parent;
455 tve->clk_hw_di.init = &init;
456 tve->di_clk = clk_register(tve->dev, &tve->clk_hw_di);
457 if (IS_ERR(tve->di_clk)) {
458 dev_err(tve->dev, "failed to register TVE output clock: %ld\n",
459 PTR_ERR(tve->di_clk));
460 return PTR_ERR(tve->di_clk);
466 static int imx_tve_register(struct drm_device *drm, struct imx_tve *tve)
471 encoder_type = tve->mode == TVE_MODE_VGA ?
472 DRM_MODE_ENCODER_DAC : DRM_MODE_ENCODER_TVDAC;
474 ret = imx_drm_encoder_parse_of(drm, &tve->encoder, tve->dev->of_node);
478 drm_encoder_helper_add(&tve->encoder, &imx_tve_encoder_helper_funcs);
479 drm_simple_encoder_init(drm, &tve->encoder, encoder_type);
481 drm_connector_helper_add(&tve->connector,
482 &imx_tve_connector_helper_funcs);
483 drm_connector_init_with_ddc(drm, &tve->connector,
484 &imx_tve_connector_funcs,
485 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");