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.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
21 #include <linux/clk.h>
22 #include <linux/clk-provider.h>
23 #include <linux/component.h>
24 #include <linux/module.h>
25 #include <linux/i2c.h>
26 #include <linux/regmap.h>
27 #include <linux/regulator/consumer.h>
28 #include <linux/spinlock.h>
29 #include <linux/videodev2.h>
31 #include <drm/drm_fb_helper.h>
32 #include <drm/drm_crtc_helper.h>
33 #include <video/imx-ipu-v3.h>
37 #define TVE_COM_CONF_REG 0x00
38 #define TVE_TVDAC0_CONT_REG 0x28
39 #define TVE_TVDAC1_CONT_REG 0x2c
40 #define TVE_TVDAC2_CONT_REG 0x30
41 #define TVE_CD_CONT_REG 0x34
42 #define TVE_INT_CONT_REG 0x64
43 #define TVE_STAT_REG 0x68
44 #define TVE_TST_MODE_REG 0x6c
45 #define TVE_MV_CONT_REG 0xdc
47 /* TVE_COM_CONF_REG */
48 #define TVE_SYNC_CH_2_EN BIT(22)
49 #define TVE_SYNC_CH_1_EN BIT(21)
50 #define TVE_SYNC_CH_0_EN BIT(20)
51 #define TVE_TV_OUT_MODE_MASK (0x7 << 12)
52 #define TVE_TV_OUT_DISABLE (0x0 << 12)
53 #define TVE_TV_OUT_CVBS_0 (0x1 << 12)
54 #define TVE_TV_OUT_CVBS_2 (0x2 << 12)
55 #define TVE_TV_OUT_CVBS_0_2 (0x3 << 12)
56 #define TVE_TV_OUT_SVIDEO_0_1 (0x4 << 12)
57 #define TVE_TV_OUT_SVIDEO_0_1_CVBS2_2 (0x5 << 12)
58 #define TVE_TV_OUT_YPBPR (0x6 << 12)
59 #define TVE_TV_OUT_RGB (0x7 << 12)
60 #define TVE_TV_STAND_MASK (0xf << 8)
61 #define TVE_TV_STAND_HD_1080P30 (0xc << 8)
62 #define TVE_P2I_CONV_EN BIT(7)
63 #define TVE_INP_VIDEO_FORM BIT(6)
64 #define TVE_INP_YCBCR_422 (0x0 << 6)
65 #define TVE_INP_YCBCR_444 (0x1 << 6)
66 #define TVE_DATA_SOURCE_MASK (0x3 << 4)
67 #define TVE_DATA_SOURCE_BUS1 (0x0 << 4)
68 #define TVE_DATA_SOURCE_BUS2 (0x1 << 4)
69 #define TVE_DATA_SOURCE_EXT (0x2 << 4)
70 #define TVE_DATA_SOURCE_TESTGEN (0x3 << 4)
71 #define TVE_IPU_CLK_EN_OFS 3
72 #define TVE_IPU_CLK_EN BIT(3)
73 #define TVE_DAC_SAMP_RATE_OFS 1
74 #define TVE_DAC_SAMP_RATE_WIDTH 2
75 #define TVE_DAC_SAMP_RATE_MASK (0x3 << 1)
76 #define TVE_DAC_FULL_RATE (0x0 << 1)
77 #define TVE_DAC_DIV2_RATE (0x1 << 1)
78 #define TVE_DAC_DIV4_RATE (0x2 << 1)
81 /* TVE_TVDACx_CONT_REG */
82 #define TVE_TVDAC_GAIN_MASK (0x3f << 0)
85 #define TVE_CD_CH_2_SM_EN BIT(22)
86 #define TVE_CD_CH_1_SM_EN BIT(21)
87 #define TVE_CD_CH_0_SM_EN BIT(20)
88 #define TVE_CD_CH_2_LM_EN BIT(18)
89 #define TVE_CD_CH_1_LM_EN BIT(17)
90 #define TVE_CD_CH_0_LM_EN BIT(16)
91 #define TVE_CD_CH_2_REF_LVL BIT(10)
92 #define TVE_CD_CH_1_REF_LVL BIT(9)
93 #define TVE_CD_CH_0_REF_LVL BIT(8)
94 #define TVE_CD_EN BIT(0)
96 /* TVE_INT_CONT_REG */
97 #define TVE_FRAME_END_IEN BIT(13)
98 #define TVE_CD_MON_END_IEN BIT(2)
99 #define TVE_CD_SM_IEN BIT(1)
100 #define TVE_CD_LM_IEN BIT(0)
102 /* TVE_TST_MODE_REG */
103 #define TVE_TVDAC_TEST_MODE_MASK (0x7 << 0)
105 #define con_to_tve(x) container_of(x, struct imx_tve, connector)
106 #define enc_to_tve(x) container_of(x, struct imx_tve, encoder)
114 struct drm_connector connector;
115 struct drm_encoder encoder;
117 spinlock_t lock; /* register lock */
121 struct regmap *regmap;
122 struct regulator *dac_reg;
123 struct i2c_adapter *ddc;
125 struct clk *di_sel_clk;
126 struct clk_hw clk_hw_di;
132 static void tve_lock(void *__tve)
133 __acquires(&tve->lock)
135 struct imx_tve *tve = __tve;
136 spin_lock(&tve->lock);
139 static void tve_unlock(void *__tve)
140 __releases(&tve->lock)
142 struct imx_tve *tve = __tve;
143 spin_unlock(&tve->lock);
146 static void tve_enable(struct imx_tve *tve)
152 clk_prepare_enable(tve->clk);
153 ret = regmap_update_bits(tve->regmap, TVE_COM_CONF_REG,
154 TVE_IPU_CLK_EN | TVE_EN,
155 TVE_IPU_CLK_EN | TVE_EN);
158 /* clear interrupt status register */
159 regmap_write(tve->regmap, TVE_STAT_REG, 0xffffffff);
161 /* cable detection irq disabled in VGA mode, enabled in TVOUT mode */
162 if (tve->mode == TVE_MODE_VGA)
163 regmap_write(tve->regmap, TVE_INT_CONT_REG, 0);
165 regmap_write(tve->regmap, TVE_INT_CONT_REG,
171 static void tve_disable(struct imx_tve *tve)
176 tve->enabled = false;
177 ret = regmap_update_bits(tve->regmap, TVE_COM_CONF_REG,
178 TVE_IPU_CLK_EN | TVE_EN, 0);
179 clk_disable_unprepare(tve->clk);
183 static int tve_setup_tvout(struct imx_tve *tve)
188 static int tve_setup_vga(struct imx_tve *tve)
194 /* set gain to (1 + 10/128) to provide 0.7V peak-to-peak amplitude */
195 ret = regmap_update_bits(tve->regmap, TVE_TVDAC0_CONT_REG,
196 TVE_TVDAC_GAIN_MASK, 0x0a);
197 ret = regmap_update_bits(tve->regmap, TVE_TVDAC1_CONT_REG,
198 TVE_TVDAC_GAIN_MASK, 0x0a);
199 ret = regmap_update_bits(tve->regmap, TVE_TVDAC2_CONT_REG,
200 TVE_TVDAC_GAIN_MASK, 0x0a);
202 /* set configuration register */
203 mask = TVE_DATA_SOURCE_MASK | TVE_INP_VIDEO_FORM;
204 val = TVE_DATA_SOURCE_BUS2 | TVE_INP_YCBCR_444;
205 mask |= TVE_TV_STAND_MASK | TVE_P2I_CONV_EN;
206 val |= TVE_TV_STAND_HD_1080P30 | 0;
207 mask |= TVE_TV_OUT_MODE_MASK | TVE_SYNC_CH_0_EN;
208 val |= TVE_TV_OUT_RGB | TVE_SYNC_CH_0_EN;
209 ret = regmap_update_bits(tve->regmap, TVE_COM_CONF_REG, mask, val);
211 dev_err(tve->dev, "failed to set configuration: %d\n", ret);
215 /* set test mode (as documented) */
216 ret = regmap_update_bits(tve->regmap, TVE_TST_MODE_REG,
217 TVE_TVDAC_TEST_MODE_MASK, 1);
222 static enum drm_connector_status imx_tve_connector_detect(
223 struct drm_connector *connector, bool force)
225 return connector_status_connected;
228 static int imx_tve_connector_get_modes(struct drm_connector *connector)
230 struct imx_tve *tve = con_to_tve(connector);
237 edid = drm_get_edid(connector, tve->ddc);
239 drm_mode_connector_update_edid_property(connector, edid);
240 ret = drm_add_edid_modes(connector, edid);
247 static int imx_tve_connector_mode_valid(struct drm_connector *connector,
248 struct drm_display_mode *mode)
250 struct imx_tve *tve = con_to_tve(connector);
253 /* pixel clock with 2x oversampling */
254 rate = clk_round_rate(tve->clk, 2000UL * mode->clock) / 2000;
255 if (rate == mode->clock)
258 /* pixel clock without oversampling */
259 rate = clk_round_rate(tve->clk, 1000UL * mode->clock) / 1000;
260 if (rate == mode->clock)
263 dev_warn(tve->dev, "ignoring mode %dx%d\n",
264 mode->hdisplay, mode->vdisplay);
269 static struct drm_encoder *imx_tve_connector_best_encoder(
270 struct drm_connector *connector)
272 struct imx_tve *tve = con_to_tve(connector);
274 return &tve->encoder;
277 static void imx_tve_encoder_dpms(struct drm_encoder *encoder, int mode)
279 struct imx_tve *tve = enc_to_tve(encoder);
282 ret = regmap_update_bits(tve->regmap, TVE_COM_CONF_REG,
283 TVE_TV_OUT_MODE_MASK, TVE_TV_OUT_DISABLE);
285 dev_err(tve->dev, "failed to disable TVOUT: %d\n", ret);
288 static bool imx_tve_encoder_mode_fixup(struct drm_encoder *encoder,
289 const struct drm_display_mode *mode,
290 struct drm_display_mode *adjusted_mode)
295 static void imx_tve_encoder_prepare(struct drm_encoder *encoder)
297 struct imx_tve *tve = enc_to_tve(encoder);
303 imx_drm_panel_format_pins(encoder, IPU_PIX_FMT_GBR24,
304 tve->hsync_pin, tve->vsync_pin);
307 imx_drm_panel_format(encoder, V4L2_PIX_FMT_YUV444);
312 static void imx_tve_encoder_mode_set(struct drm_encoder *encoder,
313 struct drm_display_mode *mode,
314 struct drm_display_mode *adjusted_mode)
316 struct imx_tve *tve = enc_to_tve(encoder);
317 unsigned long rounded_rate;
324 * we should try 4k * mode->clock first,
325 * and enable 4x oversampling for lower resolutions
327 rate = 2000UL * mode->clock;
328 clk_set_rate(tve->clk, rate);
329 rounded_rate = clk_get_rate(tve->clk);
330 if (rounded_rate >= rate)
332 clk_set_rate(tve->di_clk, rounded_rate / div);
334 ret = clk_set_parent(tve->di_sel_clk, tve->di_clk);
336 dev_err(tve->dev, "failed to set di_sel parent to tve_di: %d\n",
340 if (tve->mode == TVE_MODE_VGA)
343 tve_setup_tvout(tve);
346 static void imx_tve_encoder_commit(struct drm_encoder *encoder)
348 struct imx_tve *tve = enc_to_tve(encoder);
353 static void imx_tve_encoder_disable(struct drm_encoder *encoder)
355 struct imx_tve *tve = enc_to_tve(encoder);
360 static struct drm_connector_funcs imx_tve_connector_funcs = {
361 .dpms = drm_helper_connector_dpms,
362 .fill_modes = drm_helper_probe_single_connector_modes,
363 .detect = imx_tve_connector_detect,
364 .destroy = imx_drm_connector_destroy,
367 static struct drm_connector_helper_funcs imx_tve_connector_helper_funcs = {
368 .get_modes = imx_tve_connector_get_modes,
369 .best_encoder = imx_tve_connector_best_encoder,
370 .mode_valid = imx_tve_connector_mode_valid,
373 static struct drm_encoder_funcs imx_tve_encoder_funcs = {
374 .destroy = imx_drm_encoder_destroy,
377 static struct drm_encoder_helper_funcs imx_tve_encoder_helper_funcs = {
378 .dpms = imx_tve_encoder_dpms,
379 .mode_fixup = imx_tve_encoder_mode_fixup,
380 .prepare = imx_tve_encoder_prepare,
381 .mode_set = imx_tve_encoder_mode_set,
382 .commit = imx_tve_encoder_commit,
383 .disable = imx_tve_encoder_disable,
386 static irqreturn_t imx_tve_irq_handler(int irq, void *data)
388 struct imx_tve *tve = data;
391 regmap_read(tve->regmap, TVE_STAT_REG, &val);
393 /* clear interrupt status register */
394 regmap_write(tve->regmap, TVE_STAT_REG, 0xffffffff);
399 static unsigned long clk_tve_di_recalc_rate(struct clk_hw *hw,
400 unsigned long parent_rate)
402 struct imx_tve *tve = container_of(hw, struct imx_tve, clk_hw_di);
406 ret = regmap_read(tve->regmap, TVE_COM_CONF_REG, &val);
410 switch (val & TVE_DAC_SAMP_RATE_MASK) {
411 case TVE_DAC_DIV4_RATE:
412 return parent_rate / 4;
413 case TVE_DAC_DIV2_RATE:
414 return parent_rate / 2;
415 case TVE_DAC_FULL_RATE:
423 static long clk_tve_di_round_rate(struct clk_hw *hw, unsigned long rate,
424 unsigned long *prate)
437 static int clk_tve_di_set_rate(struct clk_hw *hw, unsigned long rate,
438 unsigned long parent_rate)
440 struct imx_tve *tve = container_of(hw, struct imx_tve, clk_hw_di);
445 div = parent_rate / rate;
447 val = TVE_DAC_DIV4_RATE;
449 val = TVE_DAC_DIV2_RATE;
451 val = TVE_DAC_FULL_RATE;
453 ret = regmap_update_bits(tve->regmap, TVE_COM_CONF_REG,
454 TVE_DAC_SAMP_RATE_MASK, val);
457 dev_err(tve->dev, "failed to set divider: %d\n", ret);
464 static struct clk_ops clk_tve_di_ops = {
465 .round_rate = clk_tve_di_round_rate,
466 .set_rate = clk_tve_di_set_rate,
467 .recalc_rate = clk_tve_di_recalc_rate,
470 static int tve_clk_init(struct imx_tve *tve, void __iomem *base)
472 const char *tve_di_parent[1];
473 struct clk_init_data init = {
475 .ops = &clk_tve_di_ops,
480 tve_di_parent[0] = __clk_get_name(tve->clk);
481 init.parent_names = (const char **)&tve_di_parent;
483 tve->clk_hw_di.init = &init;
484 tve->di_clk = clk_register(tve->dev, &tve->clk_hw_di);
485 if (IS_ERR(tve->di_clk)) {
486 dev_err(tve->dev, "failed to register TVE output clock: %ld\n",
487 PTR_ERR(tve->di_clk));
488 return PTR_ERR(tve->di_clk);
494 static int imx_tve_register(struct drm_device *drm, struct imx_tve *tve)
499 encoder_type = tve->mode == TVE_MODE_VGA ?
500 DRM_MODE_ENCODER_DAC : DRM_MODE_ENCODER_TVDAC;
502 ret = imx_drm_encoder_parse_of(drm, &tve->encoder,
507 drm_encoder_helper_add(&tve->encoder, &imx_tve_encoder_helper_funcs);
508 drm_encoder_init(drm, &tve->encoder, &imx_tve_encoder_funcs,
511 drm_connector_helper_add(&tve->connector,
512 &imx_tve_connector_helper_funcs);
513 drm_connector_init(drm, &tve->connector, &imx_tve_connector_funcs,
514 DRM_MODE_CONNECTOR_VGA);
516 drm_mode_connector_attach_encoder(&tve->connector, &tve->encoder);
521 static bool imx_tve_readable_reg(struct device *dev, unsigned int reg)
523 return (reg % 4 == 0) && (reg <= 0xdc);
526 static struct regmap_config tve_regmap_config = {
531 .readable_reg = imx_tve_readable_reg,
534 .unlock = tve_unlock,
536 .max_register = 0xdc,
539 static const char *imx_tve_modes[] = {
540 [TVE_MODE_TVOUT] = "tvout",
541 [TVE_MODE_VGA] = "vga",
544 static const int of_get_tve_mode(struct device_node *np)
549 ret = of_property_read_string(np, "fsl,tve-mode", &bm);
553 for (i = 0; i < ARRAY_SIZE(imx_tve_modes); i++)
554 if (!strcasecmp(bm, imx_tve_modes[i]))
560 static int imx_tve_bind(struct device *dev, struct device *master, void *data)
562 struct platform_device *pdev = to_platform_device(dev);
563 struct drm_device *drm = data;
564 struct device_node *np = dev->of_node;
565 struct device_node *ddc_node;
567 struct resource *res;
573 tve = devm_kzalloc(dev, sizeof(*tve), GFP_KERNEL);
578 spin_lock_init(&tve->lock);
580 ddc_node = of_parse_phandle(np, "ddc-i2c-bus", 0);
582 tve->ddc = of_find_i2c_adapter_by_node(ddc_node);
583 of_node_put(ddc_node);
586 tve->mode = of_get_tve_mode(np);
587 if (tve->mode != TVE_MODE_VGA) {
588 dev_err(dev, "only VGA mode supported, currently\n");
592 if (tve->mode == TVE_MODE_VGA) {
593 ret = of_property_read_u32(np, "fsl,hsync-pin",
597 dev_err(dev, "failed to get vsync pin\n");
601 ret |= of_property_read_u32(np, "fsl,vsync-pin",
605 dev_err(dev, "failed to get vsync pin\n");
610 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
611 base = devm_ioremap_resource(dev, res);
613 return PTR_ERR(base);
615 tve_regmap_config.lock_arg = tve;
616 tve->regmap = devm_regmap_init_mmio_clk(dev, "tve", base,
618 if (IS_ERR(tve->regmap)) {
619 dev_err(dev, "failed to init regmap: %ld\n",
620 PTR_ERR(tve->regmap));
621 return PTR_ERR(tve->regmap);
624 irq = platform_get_irq(pdev, 0);
626 dev_err(dev, "failed to get irq\n");
630 ret = devm_request_threaded_irq(dev, irq, NULL,
631 imx_tve_irq_handler, IRQF_ONESHOT,
634 dev_err(dev, "failed to request irq: %d\n", ret);
638 tve->dac_reg = devm_regulator_get(dev, "dac");
639 if (!IS_ERR(tve->dac_reg)) {
640 regulator_set_voltage(tve->dac_reg, 2750000, 2750000);
641 ret = regulator_enable(tve->dac_reg);
646 tve->clk = devm_clk_get(dev, "tve");
647 if (IS_ERR(tve->clk)) {
648 dev_err(dev, "failed to get high speed tve clock: %ld\n",
650 return PTR_ERR(tve->clk);
653 /* this is the IPU DI clock input selector, can be parented to tve_di */
654 tve->di_sel_clk = devm_clk_get(dev, "di_sel");
655 if (IS_ERR(tve->di_sel_clk)) {
656 dev_err(dev, "failed to get ipu di mux clock: %ld\n",
657 PTR_ERR(tve->di_sel_clk));
658 return PTR_ERR(tve->di_sel_clk);
661 ret = tve_clk_init(tve, base);
665 ret = regmap_read(tve->regmap, TVE_COM_CONF_REG, &val);
667 dev_err(dev, "failed to read configuration register: %d\n", ret);
670 if (val != 0x00100000) {
671 dev_err(dev, "configuration register default value indicates this is not a TVEv2\n");
675 /* disable cable detection for VGA mode */
676 ret = regmap_write(tve->regmap, TVE_CD_CONT_REG, 0);
678 ret = imx_tve_register(drm, tve);
682 dev_set_drvdata(dev, tve);
687 static void imx_tve_unbind(struct device *dev, struct device *master,
690 struct imx_tve *tve = dev_get_drvdata(dev);
692 tve->connector.funcs->destroy(&tve->connector);
693 tve->encoder.funcs->destroy(&tve->encoder);
695 if (!IS_ERR(tve->dac_reg))
696 regulator_disable(tve->dac_reg);
699 static const struct component_ops imx_tve_ops = {
700 .bind = imx_tve_bind,
701 .unbind = imx_tve_unbind,
704 static int imx_tve_probe(struct platform_device *pdev)
706 return component_add(&pdev->dev, &imx_tve_ops);
709 static int imx_tve_remove(struct platform_device *pdev)
711 component_del(&pdev->dev, &imx_tve_ops);
715 static const struct of_device_id imx_tve_dt_ids[] = {
716 { .compatible = "fsl,imx53-tve", },
720 static struct platform_driver imx_tve_driver = {
721 .probe = imx_tve_probe,
722 .remove = imx_tve_remove,
724 .of_match_table = imx_tve_dt_ids,
726 .owner = THIS_MODULE,
730 module_platform_driver(imx_tve_driver);
732 MODULE_DESCRIPTION("i.MX Television Encoder driver");
733 MODULE_AUTHOR("Philipp Zabel, Pengutronix");
734 MODULE_LICENSE("GPL");
735 MODULE_ALIAS("platform:imx-tve");