1 /* drivers/gpu/drm/exynos/exynos7_drm_decon.c
3 * Copyright (C) 2014 Samsung Electronics Co.Ltd
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version.
15 #include <drm/exynos_drm.h>
17 #include <linux/clk.h>
18 #include <linux/component.h>
19 #include <linux/kernel.h>
21 #include <linux/of_address.h>
22 #include <linux/of_device.h>
23 #include <linux/platform_device.h>
24 #include <linux/pm_runtime.h>
26 #include <video/of_display_timing.h>
27 #include <video/of_videomode.h>
29 #include "exynos_drm_crtc.h"
30 #include "exynos_drm_plane.h"
31 #include "exynos_drm_drv.h"
32 #include "exynos_drm_fb.h"
33 #include "regs-decon7.h"
36 * DECON stands for Display and Enhancement controller.
39 #define MIN_FB_WIDTH_FOR_16WORD_BURST 128
43 struct decon_context {
45 struct drm_device *drm_dev;
46 struct exynos_drm_crtc *crtc;
47 struct exynos_drm_plane planes[WINDOWS_NR];
48 struct exynos_drm_plane_config configs[WINDOWS_NR];
54 unsigned long irq_flags;
57 wait_queue_head_t wait_vsync_queue;
58 atomic_t wait_vsync_event;
60 struct drm_encoder *encoder;
63 static const struct of_device_id decon_driver_dt_match[] = {
64 {.compatible = "samsung,exynos7-decon"},
67 MODULE_DEVICE_TABLE(of, decon_driver_dt_match);
69 static const uint32_t decon_formats[] = {
81 static const enum drm_plane_type decon_win_types[WINDOWS_NR] = {
82 DRM_PLANE_TYPE_PRIMARY,
83 DRM_PLANE_TYPE_CURSOR,
86 static void decon_wait_for_vblank(struct exynos_drm_crtc *crtc)
88 struct decon_context *ctx = crtc->ctx;
93 atomic_set(&ctx->wait_vsync_event, 1);
96 * wait for DECON to signal VSYNC interrupt or return after
97 * timeout which is set to 50ms (refresh rate of 20).
99 if (!wait_event_timeout(ctx->wait_vsync_queue,
100 !atomic_read(&ctx->wait_vsync_event),
102 DRM_DEBUG_KMS("vblank wait timed out.\n");
105 static void decon_clear_channels(struct exynos_drm_crtc *crtc)
107 struct decon_context *ctx = crtc->ctx;
108 unsigned int win, ch_enabled = 0;
110 DRM_DEBUG_KMS("%s\n", __FILE__);
112 /* Check if any channel is enabled. */
113 for (win = 0; win < WINDOWS_NR; win++) {
114 u32 val = readl(ctx->regs + WINCON(win));
116 if (val & WINCONx_ENWIN) {
117 val &= ~WINCONx_ENWIN;
118 writel(val, ctx->regs + WINCON(win));
123 /* Wait for vsync, as disable channel takes effect at next vsync */
125 decon_wait_for_vblank(ctx->crtc);
128 static int decon_ctx_initialize(struct decon_context *ctx,
129 struct drm_device *drm_dev)
131 ctx->drm_dev = drm_dev;
133 decon_clear_channels(ctx->crtc);
135 return exynos_drm_register_dma(drm_dev, ctx->dev);
138 static void decon_ctx_remove(struct decon_context *ctx)
140 /* detach this sub driver from iommu mapping if supported. */
141 exynos_drm_unregister_dma(ctx->drm_dev, ctx->dev);
144 static u32 decon_calc_clkdiv(struct decon_context *ctx,
145 const struct drm_display_mode *mode)
147 unsigned long ideal_clk = mode->htotal * mode->vtotal * mode->vrefresh;
150 /* Find the clock divider value that gets us closest to ideal_clk */
151 clkdiv = DIV_ROUND_UP(clk_get_rate(ctx->vclk), ideal_clk);
153 return (clkdiv < 0x100) ? clkdiv : 0xff;
156 static void decon_commit(struct exynos_drm_crtc *crtc)
158 struct decon_context *ctx = crtc->ctx;
159 struct drm_display_mode *mode = &crtc->base.state->adjusted_mode;
165 /* nothing to do if we haven't set the mode yet */
166 if (mode->htotal == 0 || mode->vtotal == 0)
170 int vsync_len, vbpd, vfpd, hsync_len, hbpd, hfpd;
171 /* setup vertical timing values. */
172 vsync_len = mode->crtc_vsync_end - mode->crtc_vsync_start;
173 vbpd = mode->crtc_vtotal - mode->crtc_vsync_end;
174 vfpd = mode->crtc_vsync_start - mode->crtc_vdisplay;
176 val = VIDTCON0_VBPD(vbpd - 1) | VIDTCON0_VFPD(vfpd - 1);
177 writel(val, ctx->regs + VIDTCON0);
179 val = VIDTCON1_VSPW(vsync_len - 1);
180 writel(val, ctx->regs + VIDTCON1);
182 /* setup horizontal timing values. */
183 hsync_len = mode->crtc_hsync_end - mode->crtc_hsync_start;
184 hbpd = mode->crtc_htotal - mode->crtc_hsync_end;
185 hfpd = mode->crtc_hsync_start - mode->crtc_hdisplay;
187 /* setup horizontal timing values. */
188 val = VIDTCON2_HBPD(hbpd - 1) | VIDTCON2_HFPD(hfpd - 1);
189 writel(val, ctx->regs + VIDTCON2);
191 val = VIDTCON3_HSPW(hsync_len - 1);
192 writel(val, ctx->regs + VIDTCON3);
195 /* setup horizontal and vertical display size. */
196 val = VIDTCON4_LINEVAL(mode->vdisplay - 1) |
197 VIDTCON4_HOZVAL(mode->hdisplay - 1);
198 writel(val, ctx->regs + VIDTCON4);
200 writel(mode->vdisplay - 1, ctx->regs + LINECNT_OP_THRESHOLD);
203 * fields of register with prefix '_F' would be updated
204 * at vsync(same as dma start)
206 val = VIDCON0_ENVID | VIDCON0_ENVID_F;
207 writel(val, ctx->regs + VIDCON0);
209 clkdiv = decon_calc_clkdiv(ctx, mode);
211 val = VCLKCON1_CLKVAL_NUM_VCLK(clkdiv - 1);
212 writel(val, ctx->regs + VCLKCON1);
213 writel(val, ctx->regs + VCLKCON2);
216 val = readl(ctx->regs + DECON_UPDATE);
217 val |= DECON_UPDATE_STANDALONE_F;
218 writel(val, ctx->regs + DECON_UPDATE);
221 static int decon_enable_vblank(struct exynos_drm_crtc *crtc)
223 struct decon_context *ctx = crtc->ctx;
229 if (!test_and_set_bit(0, &ctx->irq_flags)) {
230 val = readl(ctx->regs + VIDINTCON0);
232 val |= VIDINTCON0_INT_ENABLE;
235 val |= VIDINTCON0_INT_FRAME;
236 val &= ~VIDINTCON0_FRAMESEL0_MASK;
237 val |= VIDINTCON0_FRAMESEL0_VSYNC;
240 writel(val, ctx->regs + VIDINTCON0);
246 static void decon_disable_vblank(struct exynos_drm_crtc *crtc)
248 struct decon_context *ctx = crtc->ctx;
254 if (test_and_clear_bit(0, &ctx->irq_flags)) {
255 val = readl(ctx->regs + VIDINTCON0);
257 val &= ~VIDINTCON0_INT_ENABLE;
259 val &= ~VIDINTCON0_INT_FRAME;
261 writel(val, ctx->regs + VIDINTCON0);
265 static void decon_win_set_pixfmt(struct decon_context *ctx, unsigned int win,
266 struct drm_framebuffer *fb)
271 val = readl(ctx->regs + WINCON(win));
272 val &= ~WINCONx_BPPMODE_MASK;
274 switch (fb->format->format) {
275 case DRM_FORMAT_RGB565:
276 val |= WINCONx_BPPMODE_16BPP_565;
277 val |= WINCONx_BURSTLEN_16WORD;
279 case DRM_FORMAT_XRGB8888:
280 val |= WINCONx_BPPMODE_24BPP_xRGB;
281 val |= WINCONx_BURSTLEN_16WORD;
283 case DRM_FORMAT_XBGR8888:
284 val |= WINCONx_BPPMODE_24BPP_xBGR;
285 val |= WINCONx_BURSTLEN_16WORD;
287 case DRM_FORMAT_RGBX8888:
288 val |= WINCONx_BPPMODE_24BPP_RGBx;
289 val |= WINCONx_BURSTLEN_16WORD;
291 case DRM_FORMAT_BGRX8888:
292 val |= WINCONx_BPPMODE_24BPP_BGRx;
293 val |= WINCONx_BURSTLEN_16WORD;
295 case DRM_FORMAT_ARGB8888:
296 val |= WINCONx_BPPMODE_32BPP_ARGB | WINCONx_BLD_PIX |
298 val |= WINCONx_BURSTLEN_16WORD;
300 case DRM_FORMAT_ABGR8888:
301 val |= WINCONx_BPPMODE_32BPP_ABGR | WINCONx_BLD_PIX |
303 val |= WINCONx_BURSTLEN_16WORD;
305 case DRM_FORMAT_RGBA8888:
306 val |= WINCONx_BPPMODE_32BPP_RGBA | WINCONx_BLD_PIX |
308 val |= WINCONx_BURSTLEN_16WORD;
310 case DRM_FORMAT_BGRA8888:
312 val |= WINCONx_BPPMODE_32BPP_BGRA | WINCONx_BLD_PIX |
314 val |= WINCONx_BURSTLEN_16WORD;
318 DRM_DEBUG_KMS("cpp = %d\n", fb->format->cpp[0]);
321 * In case of exynos, setting dma-burst to 16Word causes permanent
322 * tearing for very small buffers, e.g. cursor buffer. Burst Mode
323 * switching which is based on plane size is not recommended as
324 * plane size varies a lot towards the end of the screen and rapid
325 * movement causes unstable DMA which results into iommu crash/tear.
328 padding = (fb->pitches[0] / fb->format->cpp[0]) - fb->width;
329 if (fb->width + padding < MIN_FB_WIDTH_FOR_16WORD_BURST) {
330 val &= ~WINCONx_BURSTLEN_MASK;
331 val |= WINCONx_BURSTLEN_8WORD;
334 writel(val, ctx->regs + WINCON(win));
337 static void decon_win_set_colkey(struct decon_context *ctx, unsigned int win)
339 unsigned int keycon0 = 0, keycon1 = 0;
341 keycon0 = ~(WxKEYCON0_KEYBL_EN | WxKEYCON0_KEYEN_F |
342 WxKEYCON0_DIRCON) | WxKEYCON0_COMPKEY(0);
344 keycon1 = WxKEYCON1_COLVAL(0xffffffff);
346 writel(keycon0, ctx->regs + WKEYCON0_BASE(win));
347 writel(keycon1, ctx->regs + WKEYCON1_BASE(win));
351 * shadow_protect_win() - disable updating values from shadow registers at vsync
353 * @win: window to protect registers for
354 * @protect: 1 to protect (disable updates)
356 static void decon_shadow_protect_win(struct decon_context *ctx,
357 unsigned int win, bool protect)
361 bits = SHADOWCON_WINx_PROTECT(win);
363 val = readl(ctx->regs + SHADOWCON);
368 writel(val, ctx->regs + SHADOWCON);
371 static void decon_atomic_begin(struct exynos_drm_crtc *crtc)
373 struct decon_context *ctx = crtc->ctx;
379 for (i = 0; i < WINDOWS_NR; i++)
380 decon_shadow_protect_win(ctx, i, true);
383 static void decon_update_plane(struct exynos_drm_crtc *crtc,
384 struct exynos_drm_plane *plane)
386 struct exynos_drm_plane_state *state =
387 to_exynos_plane_state(plane->base.state);
388 struct decon_context *ctx = crtc->ctx;
389 struct drm_framebuffer *fb = state->base.fb;
391 unsigned long val, alpha;
394 unsigned int win = plane->index;
395 unsigned int cpp = fb->format->cpp[0];
396 unsigned int pitch = fb->pitches[0];
402 * SHADOWCON/PRTCON register is used for enabling timing.
404 * for example, once only width value of a register is set,
405 * if the dma is started then decon hardware could malfunction so
406 * with protect window setting, the register fields with prefix '_F'
407 * wouldn't be updated at vsync also but updated once unprotect window
411 /* buffer start address */
412 val = (unsigned long)exynos_drm_fb_dma_addr(fb, 0);
413 writel(val, ctx->regs + VIDW_BUF_START(win));
415 padding = (pitch / cpp) - fb->width;
418 writel(fb->width + padding, ctx->regs + VIDW_WHOLE_X(win));
419 writel(fb->height, ctx->regs + VIDW_WHOLE_Y(win));
421 /* offset from the start of the buffer to read */
422 writel(state->src.x, ctx->regs + VIDW_OFFSET_X(win));
423 writel(state->src.y, ctx->regs + VIDW_OFFSET_Y(win));
425 DRM_DEBUG_KMS("start addr = 0x%lx\n",
427 DRM_DEBUG_KMS("ovl_width = %d, ovl_height = %d\n",
428 state->crtc.w, state->crtc.h);
430 val = VIDOSDxA_TOPLEFT_X(state->crtc.x) |
431 VIDOSDxA_TOPLEFT_Y(state->crtc.y);
432 writel(val, ctx->regs + VIDOSD_A(win));
434 last_x = state->crtc.x + state->crtc.w;
437 last_y = state->crtc.y + state->crtc.h;
441 val = VIDOSDxB_BOTRIGHT_X(last_x) | VIDOSDxB_BOTRIGHT_Y(last_y);
443 writel(val, ctx->regs + VIDOSD_B(win));
445 DRM_DEBUG_KMS("osd pos: tx = %d, ty = %d, bx = %d, by = %d\n",
446 state->crtc.x, state->crtc.y, last_x, last_y);
449 alpha = VIDOSDxC_ALPHA0_R_F(0x0) |
450 VIDOSDxC_ALPHA0_G_F(0x0) |
451 VIDOSDxC_ALPHA0_B_F(0x0);
453 writel(alpha, ctx->regs + VIDOSD_C(win));
455 alpha = VIDOSDxD_ALPHA1_R_F(0xff) |
456 VIDOSDxD_ALPHA1_G_F(0xff) |
457 VIDOSDxD_ALPHA1_B_F(0xff);
459 writel(alpha, ctx->regs + VIDOSD_D(win));
461 decon_win_set_pixfmt(ctx, win, fb);
463 /* hardware window 0 doesn't support color key. */
465 decon_win_set_colkey(ctx, win);
468 val = readl(ctx->regs + WINCON(win));
469 val |= WINCONx_TRIPLE_BUF_MODE;
470 val |= WINCONx_ENWIN;
471 writel(val, ctx->regs + WINCON(win));
473 /* Enable DMA channel and unprotect windows */
474 decon_shadow_protect_win(ctx, win, false);
476 val = readl(ctx->regs + DECON_UPDATE);
477 val |= DECON_UPDATE_STANDALONE_F;
478 writel(val, ctx->regs + DECON_UPDATE);
481 static void decon_disable_plane(struct exynos_drm_crtc *crtc,
482 struct exynos_drm_plane *plane)
484 struct decon_context *ctx = crtc->ctx;
485 unsigned int win = plane->index;
491 /* protect windows */
492 decon_shadow_protect_win(ctx, win, true);
495 val = readl(ctx->regs + WINCON(win));
496 val &= ~WINCONx_ENWIN;
497 writel(val, ctx->regs + WINCON(win));
499 val = readl(ctx->regs + DECON_UPDATE);
500 val |= DECON_UPDATE_STANDALONE_F;
501 writel(val, ctx->regs + DECON_UPDATE);
504 static void decon_atomic_flush(struct exynos_drm_crtc *crtc)
506 struct decon_context *ctx = crtc->ctx;
512 for (i = 0; i < WINDOWS_NR; i++)
513 decon_shadow_protect_win(ctx, i, false);
514 exynos_crtc_handle_event(crtc);
517 static void decon_init(struct decon_context *ctx)
521 writel(VIDCON0_SWRESET, ctx->regs + VIDCON0);
523 val = VIDOUTCON0_DISP_IF_0_ON;
525 val |= VIDOUTCON0_RGBIF;
526 writel(val, ctx->regs + VIDOUTCON0);
528 writel(VCLKCON0_CLKVALUP | VCLKCON0_VCLKFREE, ctx->regs + VCLKCON0);
531 writel(VIDCON1_VCLK_HOLD, ctx->regs + VIDCON1(0));
534 static void decon_enable(struct exynos_drm_crtc *crtc)
536 struct decon_context *ctx = crtc->ctx;
541 pm_runtime_get_sync(ctx->dev);
545 /* if vblank was enabled status, enable it again. */
546 if (test_and_clear_bit(0, &ctx->irq_flags))
547 decon_enable_vblank(ctx->crtc);
549 decon_commit(ctx->crtc);
551 ctx->suspended = false;
554 static void decon_disable(struct exynos_drm_crtc *crtc)
556 struct decon_context *ctx = crtc->ctx;
563 * We need to make sure that all windows are disabled before we
564 * suspend that connector. Otherwise we might try to scan from
565 * a destroyed buffer later.
567 for (i = 0; i < WINDOWS_NR; i++)
568 decon_disable_plane(crtc, &ctx->planes[i]);
570 pm_runtime_put_sync(ctx->dev);
572 ctx->suspended = true;
575 static const struct exynos_drm_crtc_ops decon_crtc_ops = {
576 .enable = decon_enable,
577 .disable = decon_disable,
578 .enable_vblank = decon_enable_vblank,
579 .disable_vblank = decon_disable_vblank,
580 .atomic_begin = decon_atomic_begin,
581 .update_plane = decon_update_plane,
582 .disable_plane = decon_disable_plane,
583 .atomic_flush = decon_atomic_flush,
587 static irqreturn_t decon_irq_handler(int irq, void *dev_id)
589 struct decon_context *ctx = (struct decon_context *)dev_id;
592 val = readl(ctx->regs + VIDINTCON1);
594 clear_bit = ctx->i80_if ? VIDINTCON1_INT_I80 : VIDINTCON1_INT_FRAME;
596 writel(clear_bit, ctx->regs + VIDINTCON1);
598 /* check the crtc is detached already from encoder */
603 drm_crtc_handle_vblank(&ctx->crtc->base);
605 /* set wait vsync event to zero and wake up queue. */
606 if (atomic_read(&ctx->wait_vsync_event)) {
607 atomic_set(&ctx->wait_vsync_event, 0);
608 wake_up(&ctx->wait_vsync_queue);
615 static int decon_bind(struct device *dev, struct device *master, void *data)
617 struct decon_context *ctx = dev_get_drvdata(dev);
618 struct drm_device *drm_dev = data;
619 struct exynos_drm_plane *exynos_plane;
623 ret = decon_ctx_initialize(ctx, drm_dev);
625 DRM_ERROR("decon_ctx_initialize failed.\n");
629 for (i = 0; i < WINDOWS_NR; i++) {
630 ctx->configs[i].pixel_formats = decon_formats;
631 ctx->configs[i].num_pixel_formats = ARRAY_SIZE(decon_formats);
632 ctx->configs[i].zpos = i;
633 ctx->configs[i].type = decon_win_types[i];
635 ret = exynos_plane_init(drm_dev, &ctx->planes[i], i,
641 exynos_plane = &ctx->planes[DEFAULT_WIN];
642 ctx->crtc = exynos_drm_crtc_create(drm_dev, &exynos_plane->base,
643 EXYNOS_DISPLAY_TYPE_LCD, &decon_crtc_ops, ctx);
644 if (IS_ERR(ctx->crtc)) {
645 decon_ctx_remove(ctx);
646 return PTR_ERR(ctx->crtc);
650 exynos_dpi_bind(drm_dev, ctx->encoder);
656 static void decon_unbind(struct device *dev, struct device *master,
659 struct decon_context *ctx = dev_get_drvdata(dev);
661 decon_disable(ctx->crtc);
664 exynos_dpi_remove(ctx->encoder);
666 decon_ctx_remove(ctx);
669 static const struct component_ops decon_component_ops = {
671 .unbind = decon_unbind,
674 static int decon_probe(struct platform_device *pdev)
676 struct device *dev = &pdev->dev;
677 struct decon_context *ctx;
678 struct device_node *i80_if_timings;
679 struct resource *res;
685 ctx = devm_kzalloc(dev, sizeof(*ctx), GFP_KERNEL);
690 ctx->suspended = true;
692 i80_if_timings = of_get_child_by_name(dev->of_node, "i80-if-timings");
695 of_node_put(i80_if_timings);
697 ctx->regs = of_iomap(dev->of_node, 0);
701 ctx->pclk = devm_clk_get(dev, "pclk_decon0");
702 if (IS_ERR(ctx->pclk)) {
703 dev_err(dev, "failed to get bus clock pclk\n");
704 ret = PTR_ERR(ctx->pclk);
708 ctx->aclk = devm_clk_get(dev, "aclk_decon0");
709 if (IS_ERR(ctx->aclk)) {
710 dev_err(dev, "failed to get bus clock aclk\n");
711 ret = PTR_ERR(ctx->aclk);
715 ctx->eclk = devm_clk_get(dev, "decon0_eclk");
716 if (IS_ERR(ctx->eclk)) {
717 dev_err(dev, "failed to get eclock\n");
718 ret = PTR_ERR(ctx->eclk);
722 ctx->vclk = devm_clk_get(dev, "decon0_vclk");
723 if (IS_ERR(ctx->vclk)) {
724 dev_err(dev, "failed to get vclock\n");
725 ret = PTR_ERR(ctx->vclk);
729 res = platform_get_resource_byname(pdev, IORESOURCE_IRQ,
730 ctx->i80_if ? "lcd_sys" : "vsync");
732 dev_err(dev, "irq request failed.\n");
737 ret = devm_request_irq(dev, res->start, decon_irq_handler,
738 0, "drm_decon", ctx);
740 dev_err(dev, "irq request failed.\n");
744 init_waitqueue_head(&ctx->wait_vsync_queue);
745 atomic_set(&ctx->wait_vsync_event, 0);
747 platform_set_drvdata(pdev, ctx);
749 ctx->encoder = exynos_dpi_probe(dev);
750 if (IS_ERR(ctx->encoder)) {
751 ret = PTR_ERR(ctx->encoder);
755 pm_runtime_enable(dev);
757 ret = component_add(dev, &decon_component_ops);
759 goto err_disable_pm_runtime;
763 err_disable_pm_runtime:
764 pm_runtime_disable(dev);
772 static int decon_remove(struct platform_device *pdev)
774 struct decon_context *ctx = dev_get_drvdata(&pdev->dev);
776 pm_runtime_disable(&pdev->dev);
780 component_del(&pdev->dev, &decon_component_ops);
786 static int exynos7_decon_suspend(struct device *dev)
788 struct decon_context *ctx = dev_get_drvdata(dev);
790 clk_disable_unprepare(ctx->vclk);
791 clk_disable_unprepare(ctx->eclk);
792 clk_disable_unprepare(ctx->aclk);
793 clk_disable_unprepare(ctx->pclk);
798 static int exynos7_decon_resume(struct device *dev)
800 struct decon_context *ctx = dev_get_drvdata(dev);
803 ret = clk_prepare_enable(ctx->pclk);
805 DRM_ERROR("Failed to prepare_enable the pclk [%d]\n", ret);
809 ret = clk_prepare_enable(ctx->aclk);
811 DRM_ERROR("Failed to prepare_enable the aclk [%d]\n", ret);
815 ret = clk_prepare_enable(ctx->eclk);
817 DRM_ERROR("Failed to prepare_enable the eclk [%d]\n", ret);
821 ret = clk_prepare_enable(ctx->vclk);
823 DRM_ERROR("Failed to prepare_enable the vclk [%d]\n", ret);
831 static const struct dev_pm_ops exynos7_decon_pm_ops = {
832 SET_RUNTIME_PM_OPS(exynos7_decon_suspend, exynos7_decon_resume,
834 SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
835 pm_runtime_force_resume)
838 struct platform_driver decon_driver = {
839 .probe = decon_probe,
840 .remove = decon_remove,
842 .name = "exynos-decon",
843 .pm = &exynos7_decon_pm_ops,
844 .of_match_table = decon_driver_dt_match,