1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* drivers/gpu/drm/exynos/exynos7_drm_decon.c
4 * Copyright (C) 2014 Samsung Electronics Co.Ltd
6 * Akshu Agarwal <akshua@gmail.com>
7 * Ajay Kumar <ajaykumar.rs@samsung.com>
10 #include <drm/exynos_drm.h>
12 #include <linux/clk.h>
13 #include <linux/component.h>
14 #include <linux/kernel.h>
16 #include <linux/of_address.h>
17 #include <linux/of_device.h>
18 #include <linux/platform_device.h>
19 #include <linux/pm_runtime.h>
21 #include <video/of_display_timing.h>
22 #include <video/of_videomode.h>
24 #include "exynos_drm_crtc.h"
25 #include "exynos_drm_plane.h"
26 #include "exynos_drm_drv.h"
27 #include "exynos_drm_fb.h"
28 #include "regs-decon7.h"
31 * DECON stands for Display and Enhancement controller.
34 #define MIN_FB_WIDTH_FOR_16WORD_BURST 128
38 struct decon_context {
40 struct drm_device *drm_dev;
41 struct exynos_drm_crtc *crtc;
42 struct exynos_drm_plane planes[WINDOWS_NR];
43 struct exynos_drm_plane_config configs[WINDOWS_NR];
49 unsigned long irq_flags;
52 wait_queue_head_t wait_vsync_queue;
53 atomic_t wait_vsync_event;
55 struct drm_encoder *encoder;
58 static const struct of_device_id decon_driver_dt_match[] = {
59 {.compatible = "samsung,exynos7-decon"},
62 MODULE_DEVICE_TABLE(of, decon_driver_dt_match);
64 static const uint32_t decon_formats[] = {
76 static const enum drm_plane_type decon_win_types[WINDOWS_NR] = {
77 DRM_PLANE_TYPE_PRIMARY,
78 DRM_PLANE_TYPE_CURSOR,
81 static void decon_wait_for_vblank(struct exynos_drm_crtc *crtc)
83 struct decon_context *ctx = crtc->ctx;
88 atomic_set(&ctx->wait_vsync_event, 1);
91 * wait for DECON to signal VSYNC interrupt or return after
92 * timeout which is set to 50ms (refresh rate of 20).
94 if (!wait_event_timeout(ctx->wait_vsync_queue,
95 !atomic_read(&ctx->wait_vsync_event),
97 DRM_DEV_DEBUG_KMS(ctx->dev, "vblank wait timed out.\n");
100 static void decon_clear_channels(struct exynos_drm_crtc *crtc)
102 struct decon_context *ctx = crtc->ctx;
103 unsigned int win, ch_enabled = 0;
105 /* Check if any channel is enabled. */
106 for (win = 0; win < WINDOWS_NR; win++) {
107 u32 val = readl(ctx->regs + WINCON(win));
109 if (val & WINCONx_ENWIN) {
110 val &= ~WINCONx_ENWIN;
111 writel(val, ctx->regs + WINCON(win));
116 /* Wait for vsync, as disable channel takes effect at next vsync */
118 decon_wait_for_vblank(ctx->crtc);
121 static int decon_ctx_initialize(struct decon_context *ctx,
122 struct drm_device *drm_dev)
124 ctx->drm_dev = drm_dev;
126 decon_clear_channels(ctx->crtc);
128 return exynos_drm_register_dma(drm_dev, ctx->dev);
131 static void decon_ctx_remove(struct decon_context *ctx)
133 /* detach this sub driver from iommu mapping if supported. */
134 exynos_drm_unregister_dma(ctx->drm_dev, ctx->dev);
137 static u32 decon_calc_clkdiv(struct decon_context *ctx,
138 const struct drm_display_mode *mode)
140 unsigned long ideal_clk = mode->htotal * mode->vtotal * mode->vrefresh;
143 /* Find the clock divider value that gets us closest to ideal_clk */
144 clkdiv = DIV_ROUND_UP(clk_get_rate(ctx->vclk), ideal_clk);
146 return (clkdiv < 0x100) ? clkdiv : 0xff;
149 static void decon_commit(struct exynos_drm_crtc *crtc)
151 struct decon_context *ctx = crtc->ctx;
152 struct drm_display_mode *mode = &crtc->base.state->adjusted_mode;
158 /* nothing to do if we haven't set the mode yet */
159 if (mode->htotal == 0 || mode->vtotal == 0)
163 int vsync_len, vbpd, vfpd, hsync_len, hbpd, hfpd;
164 /* setup vertical timing values. */
165 vsync_len = mode->crtc_vsync_end - mode->crtc_vsync_start;
166 vbpd = mode->crtc_vtotal - mode->crtc_vsync_end;
167 vfpd = mode->crtc_vsync_start - mode->crtc_vdisplay;
169 val = VIDTCON0_VBPD(vbpd - 1) | VIDTCON0_VFPD(vfpd - 1);
170 writel(val, ctx->regs + VIDTCON0);
172 val = VIDTCON1_VSPW(vsync_len - 1);
173 writel(val, ctx->regs + VIDTCON1);
175 /* setup horizontal timing values. */
176 hsync_len = mode->crtc_hsync_end - mode->crtc_hsync_start;
177 hbpd = mode->crtc_htotal - mode->crtc_hsync_end;
178 hfpd = mode->crtc_hsync_start - mode->crtc_hdisplay;
180 /* setup horizontal timing values. */
181 val = VIDTCON2_HBPD(hbpd - 1) | VIDTCON2_HFPD(hfpd - 1);
182 writel(val, ctx->regs + VIDTCON2);
184 val = VIDTCON3_HSPW(hsync_len - 1);
185 writel(val, ctx->regs + VIDTCON3);
188 /* setup horizontal and vertical display size. */
189 val = VIDTCON4_LINEVAL(mode->vdisplay - 1) |
190 VIDTCON4_HOZVAL(mode->hdisplay - 1);
191 writel(val, ctx->regs + VIDTCON4);
193 writel(mode->vdisplay - 1, ctx->regs + LINECNT_OP_THRESHOLD);
196 * fields of register with prefix '_F' would be updated
197 * at vsync(same as dma start)
199 val = VIDCON0_ENVID | VIDCON0_ENVID_F;
200 writel(val, ctx->regs + VIDCON0);
202 clkdiv = decon_calc_clkdiv(ctx, mode);
204 val = VCLKCON1_CLKVAL_NUM_VCLK(clkdiv - 1);
205 writel(val, ctx->regs + VCLKCON1);
206 writel(val, ctx->regs + VCLKCON2);
209 val = readl(ctx->regs + DECON_UPDATE);
210 val |= DECON_UPDATE_STANDALONE_F;
211 writel(val, ctx->regs + DECON_UPDATE);
214 static int decon_enable_vblank(struct exynos_drm_crtc *crtc)
216 struct decon_context *ctx = crtc->ctx;
222 if (!test_and_set_bit(0, &ctx->irq_flags)) {
223 val = readl(ctx->regs + VIDINTCON0);
225 val |= VIDINTCON0_INT_ENABLE;
228 val |= VIDINTCON0_INT_FRAME;
229 val &= ~VIDINTCON0_FRAMESEL0_MASK;
230 val |= VIDINTCON0_FRAMESEL0_VSYNC;
233 writel(val, ctx->regs + VIDINTCON0);
239 static void decon_disable_vblank(struct exynos_drm_crtc *crtc)
241 struct decon_context *ctx = crtc->ctx;
247 if (test_and_clear_bit(0, &ctx->irq_flags)) {
248 val = readl(ctx->regs + VIDINTCON0);
250 val &= ~VIDINTCON0_INT_ENABLE;
252 val &= ~VIDINTCON0_INT_FRAME;
254 writel(val, ctx->regs + VIDINTCON0);
258 static void decon_win_set_pixfmt(struct decon_context *ctx, unsigned int win,
259 struct drm_framebuffer *fb)
264 val = readl(ctx->regs + WINCON(win));
265 val &= ~WINCONx_BPPMODE_MASK;
267 switch (fb->format->format) {
268 case DRM_FORMAT_RGB565:
269 val |= WINCONx_BPPMODE_16BPP_565;
270 val |= WINCONx_BURSTLEN_16WORD;
272 case DRM_FORMAT_XRGB8888:
273 val |= WINCONx_BPPMODE_24BPP_xRGB;
274 val |= WINCONx_BURSTLEN_16WORD;
276 case DRM_FORMAT_XBGR8888:
277 val |= WINCONx_BPPMODE_24BPP_xBGR;
278 val |= WINCONx_BURSTLEN_16WORD;
280 case DRM_FORMAT_RGBX8888:
281 val |= WINCONx_BPPMODE_24BPP_RGBx;
282 val |= WINCONx_BURSTLEN_16WORD;
284 case DRM_FORMAT_BGRX8888:
285 val |= WINCONx_BPPMODE_24BPP_BGRx;
286 val |= WINCONx_BURSTLEN_16WORD;
288 case DRM_FORMAT_ARGB8888:
289 val |= WINCONx_BPPMODE_32BPP_ARGB | WINCONx_BLD_PIX |
291 val |= WINCONx_BURSTLEN_16WORD;
293 case DRM_FORMAT_ABGR8888:
294 val |= WINCONx_BPPMODE_32BPP_ABGR | WINCONx_BLD_PIX |
296 val |= WINCONx_BURSTLEN_16WORD;
298 case DRM_FORMAT_RGBA8888:
299 val |= WINCONx_BPPMODE_32BPP_RGBA | WINCONx_BLD_PIX |
301 val |= WINCONx_BURSTLEN_16WORD;
303 case DRM_FORMAT_BGRA8888:
305 val |= WINCONx_BPPMODE_32BPP_BGRA | WINCONx_BLD_PIX |
307 val |= WINCONx_BURSTLEN_16WORD;
311 DRM_DEV_DEBUG_KMS(ctx->dev, "cpp = %d\n", fb->format->cpp[0]);
314 * In case of exynos, setting dma-burst to 16Word causes permanent
315 * tearing for very small buffers, e.g. cursor buffer. Burst Mode
316 * switching which is based on plane size is not recommended as
317 * plane size varies a lot towards the end of the screen and rapid
318 * movement causes unstable DMA which results into iommu crash/tear.
321 padding = (fb->pitches[0] / fb->format->cpp[0]) - fb->width;
322 if (fb->width + padding < MIN_FB_WIDTH_FOR_16WORD_BURST) {
323 val &= ~WINCONx_BURSTLEN_MASK;
324 val |= WINCONx_BURSTLEN_8WORD;
327 writel(val, ctx->regs + WINCON(win));
330 static void decon_win_set_colkey(struct decon_context *ctx, unsigned int win)
332 unsigned int keycon0 = 0, keycon1 = 0;
334 keycon0 = ~(WxKEYCON0_KEYBL_EN | WxKEYCON0_KEYEN_F |
335 WxKEYCON0_DIRCON) | WxKEYCON0_COMPKEY(0);
337 keycon1 = WxKEYCON1_COLVAL(0xffffffff);
339 writel(keycon0, ctx->regs + WKEYCON0_BASE(win));
340 writel(keycon1, ctx->regs + WKEYCON1_BASE(win));
344 * shadow_protect_win() - disable updating values from shadow registers at vsync
346 * @win: window to protect registers for
347 * @protect: 1 to protect (disable updates)
349 static void decon_shadow_protect_win(struct decon_context *ctx,
350 unsigned int win, bool protect)
354 bits = SHADOWCON_WINx_PROTECT(win);
356 val = readl(ctx->regs + SHADOWCON);
361 writel(val, ctx->regs + SHADOWCON);
364 static void decon_atomic_begin(struct exynos_drm_crtc *crtc)
366 struct decon_context *ctx = crtc->ctx;
372 for (i = 0; i < WINDOWS_NR; i++)
373 decon_shadow_protect_win(ctx, i, true);
376 static void decon_update_plane(struct exynos_drm_crtc *crtc,
377 struct exynos_drm_plane *plane)
379 struct exynos_drm_plane_state *state =
380 to_exynos_plane_state(plane->base.state);
381 struct decon_context *ctx = crtc->ctx;
382 struct drm_framebuffer *fb = state->base.fb;
384 unsigned long val, alpha;
387 unsigned int win = plane->index;
388 unsigned int cpp = fb->format->cpp[0];
389 unsigned int pitch = fb->pitches[0];
395 * SHADOWCON/PRTCON register is used for enabling timing.
397 * for example, once only width value of a register is set,
398 * if the dma is started then decon hardware could malfunction so
399 * with protect window setting, the register fields with prefix '_F'
400 * wouldn't be updated at vsync also but updated once unprotect window
404 /* buffer start address */
405 val = (unsigned long)exynos_drm_fb_dma_addr(fb, 0);
406 writel(val, ctx->regs + VIDW_BUF_START(win));
408 padding = (pitch / cpp) - fb->width;
411 writel(fb->width + padding, ctx->regs + VIDW_WHOLE_X(win));
412 writel(fb->height, ctx->regs + VIDW_WHOLE_Y(win));
414 /* offset from the start of the buffer to read */
415 writel(state->src.x, ctx->regs + VIDW_OFFSET_X(win));
416 writel(state->src.y, ctx->regs + VIDW_OFFSET_Y(win));
418 DRM_DEV_DEBUG_KMS(ctx->dev, "start addr = 0x%lx\n",
420 DRM_DEV_DEBUG_KMS(ctx->dev, "ovl_width = %d, ovl_height = %d\n",
421 state->crtc.w, state->crtc.h);
423 val = VIDOSDxA_TOPLEFT_X(state->crtc.x) |
424 VIDOSDxA_TOPLEFT_Y(state->crtc.y);
425 writel(val, ctx->regs + VIDOSD_A(win));
427 last_x = state->crtc.x + state->crtc.w;
430 last_y = state->crtc.y + state->crtc.h;
434 val = VIDOSDxB_BOTRIGHT_X(last_x) | VIDOSDxB_BOTRIGHT_Y(last_y);
436 writel(val, ctx->regs + VIDOSD_B(win));
438 DRM_DEV_DEBUG_KMS(ctx->dev, "osd pos: tx = %d, ty = %d, bx = %d, by = %d\n",
439 state->crtc.x, state->crtc.y, last_x, last_y);
442 alpha = VIDOSDxC_ALPHA0_R_F(0x0) |
443 VIDOSDxC_ALPHA0_G_F(0x0) |
444 VIDOSDxC_ALPHA0_B_F(0x0);
446 writel(alpha, ctx->regs + VIDOSD_C(win));
448 alpha = VIDOSDxD_ALPHA1_R_F(0xff) |
449 VIDOSDxD_ALPHA1_G_F(0xff) |
450 VIDOSDxD_ALPHA1_B_F(0xff);
452 writel(alpha, ctx->regs + VIDOSD_D(win));
454 decon_win_set_pixfmt(ctx, win, fb);
456 /* hardware window 0 doesn't support color key. */
458 decon_win_set_colkey(ctx, win);
461 val = readl(ctx->regs + WINCON(win));
462 val |= WINCONx_TRIPLE_BUF_MODE;
463 val |= WINCONx_ENWIN;
464 writel(val, ctx->regs + WINCON(win));
466 /* Enable DMA channel and unprotect windows */
467 decon_shadow_protect_win(ctx, win, false);
469 val = readl(ctx->regs + DECON_UPDATE);
470 val |= DECON_UPDATE_STANDALONE_F;
471 writel(val, ctx->regs + DECON_UPDATE);
474 static void decon_disable_plane(struct exynos_drm_crtc *crtc,
475 struct exynos_drm_plane *plane)
477 struct decon_context *ctx = crtc->ctx;
478 unsigned int win = plane->index;
484 /* protect windows */
485 decon_shadow_protect_win(ctx, win, true);
488 val = readl(ctx->regs + WINCON(win));
489 val &= ~WINCONx_ENWIN;
490 writel(val, ctx->regs + WINCON(win));
492 val = readl(ctx->regs + DECON_UPDATE);
493 val |= DECON_UPDATE_STANDALONE_F;
494 writel(val, ctx->regs + DECON_UPDATE);
497 static void decon_atomic_flush(struct exynos_drm_crtc *crtc)
499 struct decon_context *ctx = crtc->ctx;
505 for (i = 0; i < WINDOWS_NR; i++)
506 decon_shadow_protect_win(ctx, i, false);
507 exynos_crtc_handle_event(crtc);
510 static void decon_init(struct decon_context *ctx)
514 writel(VIDCON0_SWRESET, ctx->regs + VIDCON0);
516 val = VIDOUTCON0_DISP_IF_0_ON;
518 val |= VIDOUTCON0_RGBIF;
519 writel(val, ctx->regs + VIDOUTCON0);
521 writel(VCLKCON0_CLKVALUP | VCLKCON0_VCLKFREE, ctx->regs + VCLKCON0);
524 writel(VIDCON1_VCLK_HOLD, ctx->regs + VIDCON1(0));
527 static void decon_enable(struct exynos_drm_crtc *crtc)
529 struct decon_context *ctx = crtc->ctx;
534 pm_runtime_get_sync(ctx->dev);
538 /* if vblank was enabled status, enable it again. */
539 if (test_and_clear_bit(0, &ctx->irq_flags))
540 decon_enable_vblank(ctx->crtc);
542 decon_commit(ctx->crtc);
544 ctx->suspended = false;
547 static void decon_disable(struct exynos_drm_crtc *crtc)
549 struct decon_context *ctx = crtc->ctx;
556 * We need to make sure that all windows are disabled before we
557 * suspend that connector. Otherwise we might try to scan from
558 * a destroyed buffer later.
560 for (i = 0; i < WINDOWS_NR; i++)
561 decon_disable_plane(crtc, &ctx->planes[i]);
563 pm_runtime_put_sync(ctx->dev);
565 ctx->suspended = true;
568 static const struct exynos_drm_crtc_ops decon_crtc_ops = {
569 .enable = decon_enable,
570 .disable = decon_disable,
571 .enable_vblank = decon_enable_vblank,
572 .disable_vblank = decon_disable_vblank,
573 .atomic_begin = decon_atomic_begin,
574 .update_plane = decon_update_plane,
575 .disable_plane = decon_disable_plane,
576 .atomic_flush = decon_atomic_flush,
580 static irqreturn_t decon_irq_handler(int irq, void *dev_id)
582 struct decon_context *ctx = (struct decon_context *)dev_id;
585 val = readl(ctx->regs + VIDINTCON1);
587 clear_bit = ctx->i80_if ? VIDINTCON1_INT_I80 : VIDINTCON1_INT_FRAME;
589 writel(clear_bit, ctx->regs + VIDINTCON1);
591 /* check the crtc is detached already from encoder */
596 drm_crtc_handle_vblank(&ctx->crtc->base);
598 /* set wait vsync event to zero and wake up queue. */
599 if (atomic_read(&ctx->wait_vsync_event)) {
600 atomic_set(&ctx->wait_vsync_event, 0);
601 wake_up(&ctx->wait_vsync_queue);
608 static int decon_bind(struct device *dev, struct device *master, void *data)
610 struct decon_context *ctx = dev_get_drvdata(dev);
611 struct drm_device *drm_dev = data;
612 struct exynos_drm_plane *exynos_plane;
616 ret = decon_ctx_initialize(ctx, drm_dev);
618 DRM_DEV_ERROR(dev, "decon_ctx_initialize failed.\n");
622 for (i = 0; i < WINDOWS_NR; i++) {
623 ctx->configs[i].pixel_formats = decon_formats;
624 ctx->configs[i].num_pixel_formats = ARRAY_SIZE(decon_formats);
625 ctx->configs[i].zpos = i;
626 ctx->configs[i].type = decon_win_types[i];
628 ret = exynos_plane_init(drm_dev, &ctx->planes[i], i,
634 exynos_plane = &ctx->planes[DEFAULT_WIN];
635 ctx->crtc = exynos_drm_crtc_create(drm_dev, &exynos_plane->base,
636 EXYNOS_DISPLAY_TYPE_LCD, &decon_crtc_ops, ctx);
637 if (IS_ERR(ctx->crtc)) {
638 decon_ctx_remove(ctx);
639 return PTR_ERR(ctx->crtc);
643 exynos_dpi_bind(drm_dev, ctx->encoder);
649 static void decon_unbind(struct device *dev, struct device *master,
652 struct decon_context *ctx = dev_get_drvdata(dev);
654 decon_disable(ctx->crtc);
657 exynos_dpi_remove(ctx->encoder);
659 decon_ctx_remove(ctx);
662 static const struct component_ops decon_component_ops = {
664 .unbind = decon_unbind,
667 static int decon_probe(struct platform_device *pdev)
669 struct device *dev = &pdev->dev;
670 struct decon_context *ctx;
671 struct device_node *i80_if_timings;
672 struct resource *res;
678 ctx = devm_kzalloc(dev, sizeof(*ctx), GFP_KERNEL);
683 ctx->suspended = true;
685 i80_if_timings = of_get_child_by_name(dev->of_node, "i80-if-timings");
688 of_node_put(i80_if_timings);
690 ctx->regs = of_iomap(dev->of_node, 0);
694 ctx->pclk = devm_clk_get(dev, "pclk_decon0");
695 if (IS_ERR(ctx->pclk)) {
696 dev_err(dev, "failed to get bus clock pclk\n");
697 ret = PTR_ERR(ctx->pclk);
701 ctx->aclk = devm_clk_get(dev, "aclk_decon0");
702 if (IS_ERR(ctx->aclk)) {
703 dev_err(dev, "failed to get bus clock aclk\n");
704 ret = PTR_ERR(ctx->aclk);
708 ctx->eclk = devm_clk_get(dev, "decon0_eclk");
709 if (IS_ERR(ctx->eclk)) {
710 dev_err(dev, "failed to get eclock\n");
711 ret = PTR_ERR(ctx->eclk);
715 ctx->vclk = devm_clk_get(dev, "decon0_vclk");
716 if (IS_ERR(ctx->vclk)) {
717 dev_err(dev, "failed to get vclock\n");
718 ret = PTR_ERR(ctx->vclk);
722 res = platform_get_resource_byname(pdev, IORESOURCE_IRQ,
723 ctx->i80_if ? "lcd_sys" : "vsync");
725 dev_err(dev, "irq request failed.\n");
730 ret = devm_request_irq(dev, res->start, decon_irq_handler,
731 0, "drm_decon", ctx);
733 dev_err(dev, "irq request failed.\n");
737 init_waitqueue_head(&ctx->wait_vsync_queue);
738 atomic_set(&ctx->wait_vsync_event, 0);
740 platform_set_drvdata(pdev, ctx);
742 ctx->encoder = exynos_dpi_probe(dev);
743 if (IS_ERR(ctx->encoder)) {
744 ret = PTR_ERR(ctx->encoder);
748 pm_runtime_enable(dev);
750 ret = component_add(dev, &decon_component_ops);
752 goto err_disable_pm_runtime;
756 err_disable_pm_runtime:
757 pm_runtime_disable(dev);
765 static int decon_remove(struct platform_device *pdev)
767 struct decon_context *ctx = dev_get_drvdata(&pdev->dev);
769 pm_runtime_disable(&pdev->dev);
773 component_del(&pdev->dev, &decon_component_ops);
779 static int exynos7_decon_suspend(struct device *dev)
781 struct decon_context *ctx = dev_get_drvdata(dev);
783 clk_disable_unprepare(ctx->vclk);
784 clk_disable_unprepare(ctx->eclk);
785 clk_disable_unprepare(ctx->aclk);
786 clk_disable_unprepare(ctx->pclk);
791 static int exynos7_decon_resume(struct device *dev)
793 struct decon_context *ctx = dev_get_drvdata(dev);
796 ret = clk_prepare_enable(ctx->pclk);
798 DRM_DEV_ERROR(dev, "Failed to prepare_enable the pclk [%d]\n",
803 ret = clk_prepare_enable(ctx->aclk);
805 DRM_DEV_ERROR(dev, "Failed to prepare_enable the aclk [%d]\n",
810 ret = clk_prepare_enable(ctx->eclk);
812 DRM_DEV_ERROR(dev, "Failed to prepare_enable the eclk [%d]\n",
817 ret = clk_prepare_enable(ctx->vclk);
819 DRM_DEV_ERROR(dev, "Failed to prepare_enable the vclk [%d]\n",
828 static const struct dev_pm_ops exynos7_decon_pm_ops = {
829 SET_RUNTIME_PM_OPS(exynos7_decon_suspend, exynos7_decon_resume,
831 SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
832 pm_runtime_force_resume)
835 struct platform_driver decon_driver = {
836 .probe = decon_probe,
837 .remove = decon_remove,
839 .name = "exynos-decon",
840 .pm = &exynos7_decon_pm_ops,
841 .of_match_table = decon_driver_dt_match,