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
10 #include <linux/clk.h>
11 #include <linux/component.h>
12 #include <linux/kernel.h>
14 #include <linux/of_address.h>
15 #include <linux/of_device.h>
16 #include <linux/platform_device.h>
17 #include <linux/pm_runtime.h>
19 #include <video/of_display_timing.h>
20 #include <video/of_videomode.h>
22 #include <drm/drm_fourcc.h>
23 #include <drm/drm_vblank.h>
24 #include <drm/exynos_drm.h>
26 #include "exynos_drm_crtc.h"
27 #include "exynos_drm_drv.h"
28 #include "exynos_drm_fb.h"
29 #include "exynos_drm_plane.h"
30 #include "regs-decon7.h"
33 * DECON stands for Display and Enhancement controller.
36 #define MIN_FB_WIDTH_FOR_16WORD_BURST 128
40 struct decon_context {
42 struct drm_device *drm_dev;
44 struct exynos_drm_crtc *crtc;
45 struct exynos_drm_plane planes[WINDOWS_NR];
46 struct exynos_drm_plane_config configs[WINDOWS_NR];
52 unsigned long irq_flags;
55 wait_queue_head_t wait_vsync_queue;
56 atomic_t wait_vsync_event;
58 struct drm_encoder *encoder;
61 static const struct of_device_id decon_driver_dt_match[] = {
62 {.compatible = "samsung,exynos7-decon"},
65 MODULE_DEVICE_TABLE(of, decon_driver_dt_match);
67 static const uint32_t decon_formats[] = {
79 static const enum drm_plane_type decon_win_types[WINDOWS_NR] = {
80 DRM_PLANE_TYPE_PRIMARY,
81 DRM_PLANE_TYPE_CURSOR,
84 static void decon_wait_for_vblank(struct exynos_drm_crtc *crtc)
86 struct decon_context *ctx = crtc->ctx;
91 atomic_set(&ctx->wait_vsync_event, 1);
94 * wait for DECON to signal VSYNC interrupt or return after
95 * timeout which is set to 50ms (refresh rate of 20).
97 if (!wait_event_timeout(ctx->wait_vsync_queue,
98 !atomic_read(&ctx->wait_vsync_event),
100 DRM_DEV_DEBUG_KMS(ctx->dev, "vblank wait timed out.\n");
103 static void decon_clear_channels(struct exynos_drm_crtc *crtc)
105 struct decon_context *ctx = crtc->ctx;
106 unsigned int win, ch_enabled = 0;
108 /* Check if any channel is enabled. */
109 for (win = 0; win < WINDOWS_NR; win++) {
110 u32 val = readl(ctx->regs + WINCON(win));
112 if (val & WINCONx_ENWIN) {
113 val &= ~WINCONx_ENWIN;
114 writel(val, ctx->regs + WINCON(win));
119 /* Wait for vsync, as disable channel takes effect at next vsync */
121 decon_wait_for_vblank(ctx->crtc);
124 static int decon_ctx_initialize(struct decon_context *ctx,
125 struct drm_device *drm_dev)
127 ctx->drm_dev = drm_dev;
129 decon_clear_channels(ctx->crtc);
131 return exynos_drm_register_dma(drm_dev, ctx->dev, &ctx->dma_priv);
134 static void decon_ctx_remove(struct decon_context *ctx)
136 /* detach this sub driver from iommu mapping if supported. */
137 exynos_drm_unregister_dma(ctx->drm_dev, ctx->dev, &ctx->dma_priv);
140 static u32 decon_calc_clkdiv(struct decon_context *ctx,
141 const struct drm_display_mode *mode)
143 unsigned long ideal_clk = mode->clock;
146 /* Find the clock divider value that gets us closest to ideal_clk */
147 clkdiv = DIV_ROUND_UP(clk_get_rate(ctx->vclk), ideal_clk);
149 return (clkdiv < 0x100) ? clkdiv : 0xff;
152 static void decon_commit(struct exynos_drm_crtc *crtc)
154 struct decon_context *ctx = crtc->ctx;
155 struct drm_display_mode *mode = &crtc->base.state->adjusted_mode;
161 /* nothing to do if we haven't set the mode yet */
162 if (mode->htotal == 0 || mode->vtotal == 0)
166 int vsync_len, vbpd, vfpd, hsync_len, hbpd, hfpd;
167 /* setup vertical timing values. */
168 vsync_len = mode->crtc_vsync_end - mode->crtc_vsync_start;
169 vbpd = mode->crtc_vtotal - mode->crtc_vsync_end;
170 vfpd = mode->crtc_vsync_start - mode->crtc_vdisplay;
172 val = VIDTCON0_VBPD(vbpd - 1) | VIDTCON0_VFPD(vfpd - 1);
173 writel(val, ctx->regs + VIDTCON0);
175 val = VIDTCON1_VSPW(vsync_len - 1);
176 writel(val, ctx->regs + VIDTCON1);
178 /* setup horizontal timing values. */
179 hsync_len = mode->crtc_hsync_end - mode->crtc_hsync_start;
180 hbpd = mode->crtc_htotal - mode->crtc_hsync_end;
181 hfpd = mode->crtc_hsync_start - mode->crtc_hdisplay;
183 /* setup horizontal timing values. */
184 val = VIDTCON2_HBPD(hbpd - 1) | VIDTCON2_HFPD(hfpd - 1);
185 writel(val, ctx->regs + VIDTCON2);
187 val = VIDTCON3_HSPW(hsync_len - 1);
188 writel(val, ctx->regs + VIDTCON3);
191 /* setup horizontal and vertical display size. */
192 val = VIDTCON4_LINEVAL(mode->vdisplay - 1) |
193 VIDTCON4_HOZVAL(mode->hdisplay - 1);
194 writel(val, ctx->regs + VIDTCON4);
196 writel(mode->vdisplay - 1, ctx->regs + LINECNT_OP_THRESHOLD);
199 * fields of register with prefix '_F' would be updated
200 * at vsync(same as dma start)
202 val = VIDCON0_ENVID | VIDCON0_ENVID_F;
203 writel(val, ctx->regs + VIDCON0);
205 clkdiv = decon_calc_clkdiv(ctx, mode);
207 val = VCLKCON1_CLKVAL_NUM_VCLK(clkdiv - 1);
208 writel(val, ctx->regs + VCLKCON1);
209 writel(val, ctx->regs + VCLKCON2);
212 val = readl(ctx->regs + DECON_UPDATE);
213 val |= DECON_UPDATE_STANDALONE_F;
214 writel(val, ctx->regs + DECON_UPDATE);
217 static int decon_enable_vblank(struct exynos_drm_crtc *crtc)
219 struct decon_context *ctx = crtc->ctx;
225 if (!test_and_set_bit(0, &ctx->irq_flags)) {
226 val = readl(ctx->regs + VIDINTCON0);
228 val |= VIDINTCON0_INT_ENABLE;
231 val |= VIDINTCON0_INT_FRAME;
232 val &= ~VIDINTCON0_FRAMESEL0_MASK;
233 val |= VIDINTCON0_FRAMESEL0_VSYNC;
236 writel(val, ctx->regs + VIDINTCON0);
242 static void decon_disable_vblank(struct exynos_drm_crtc *crtc)
244 struct decon_context *ctx = crtc->ctx;
250 if (test_and_clear_bit(0, &ctx->irq_flags)) {
251 val = readl(ctx->regs + VIDINTCON0);
253 val &= ~VIDINTCON0_INT_ENABLE;
255 val &= ~VIDINTCON0_INT_FRAME;
257 writel(val, ctx->regs + VIDINTCON0);
261 static void decon_win_set_pixfmt(struct decon_context *ctx, unsigned int win,
262 struct drm_framebuffer *fb)
267 val = readl(ctx->regs + WINCON(win));
268 val &= ~WINCONx_BPPMODE_MASK;
270 switch (fb->format->format) {
271 case DRM_FORMAT_RGB565:
272 val |= WINCONx_BPPMODE_16BPP_565;
273 val |= WINCONx_BURSTLEN_16WORD;
275 case DRM_FORMAT_XRGB8888:
276 val |= WINCONx_BPPMODE_24BPP_xRGB;
277 val |= WINCONx_BURSTLEN_16WORD;
279 case DRM_FORMAT_XBGR8888:
280 val |= WINCONx_BPPMODE_24BPP_xBGR;
281 val |= WINCONx_BURSTLEN_16WORD;
283 case DRM_FORMAT_RGBX8888:
284 val |= WINCONx_BPPMODE_24BPP_RGBx;
285 val |= WINCONx_BURSTLEN_16WORD;
287 case DRM_FORMAT_BGRX8888:
288 val |= WINCONx_BPPMODE_24BPP_BGRx;
289 val |= WINCONx_BURSTLEN_16WORD;
291 case DRM_FORMAT_ARGB8888:
292 val |= WINCONx_BPPMODE_32BPP_ARGB | WINCONx_BLD_PIX |
294 val |= WINCONx_BURSTLEN_16WORD;
296 case DRM_FORMAT_ABGR8888:
297 val |= WINCONx_BPPMODE_32BPP_ABGR | WINCONx_BLD_PIX |
299 val |= WINCONx_BURSTLEN_16WORD;
301 case DRM_FORMAT_RGBA8888:
302 val |= WINCONx_BPPMODE_32BPP_RGBA | WINCONx_BLD_PIX |
304 val |= WINCONx_BURSTLEN_16WORD;
306 case DRM_FORMAT_BGRA8888:
308 val |= WINCONx_BPPMODE_32BPP_BGRA | WINCONx_BLD_PIX |
310 val |= WINCONx_BURSTLEN_16WORD;
314 DRM_DEV_DEBUG_KMS(ctx->dev, "cpp = %d\n", fb->format->cpp[0]);
317 * In case of exynos, setting dma-burst to 16Word causes permanent
318 * tearing for very small buffers, e.g. cursor buffer. Burst Mode
319 * switching which is based on plane size is not recommended as
320 * plane size varies a lot towards the end of the screen and rapid
321 * movement causes unstable DMA which results into iommu crash/tear.
324 padding = (fb->pitches[0] / fb->format->cpp[0]) - fb->width;
325 if (fb->width + padding < MIN_FB_WIDTH_FOR_16WORD_BURST) {
326 val &= ~WINCONx_BURSTLEN_MASK;
327 val |= WINCONx_BURSTLEN_8WORD;
330 writel(val, ctx->regs + WINCON(win));
333 static void decon_win_set_colkey(struct decon_context *ctx, unsigned int win)
335 unsigned int keycon0 = 0, keycon1 = 0;
337 keycon0 = ~(WxKEYCON0_KEYBL_EN | WxKEYCON0_KEYEN_F |
338 WxKEYCON0_DIRCON) | WxKEYCON0_COMPKEY(0);
340 keycon1 = WxKEYCON1_COLVAL(0xffffffff);
342 writel(keycon0, ctx->regs + WKEYCON0_BASE(win));
343 writel(keycon1, ctx->regs + WKEYCON1_BASE(win));
347 * shadow_protect_win() - disable updating values from shadow registers at vsync
349 * @ctx: display and enhancement controller context
350 * @win: window to protect registers for
351 * @protect: 1 to protect (disable updates)
353 static void decon_shadow_protect_win(struct decon_context *ctx,
354 unsigned int win, bool protect)
358 bits = SHADOWCON_WINx_PROTECT(win);
360 val = readl(ctx->regs + SHADOWCON);
365 writel(val, ctx->regs + SHADOWCON);
368 static void decon_atomic_begin(struct exynos_drm_crtc *crtc)
370 struct decon_context *ctx = crtc->ctx;
376 for (i = 0; i < WINDOWS_NR; i++)
377 decon_shadow_protect_win(ctx, i, true);
380 static void decon_update_plane(struct exynos_drm_crtc *crtc,
381 struct exynos_drm_plane *plane)
383 struct exynos_drm_plane_state *state =
384 to_exynos_plane_state(plane->base.state);
385 struct decon_context *ctx = crtc->ctx;
386 struct drm_framebuffer *fb = state->base.fb;
388 unsigned long val, alpha;
391 unsigned int win = plane->index;
392 unsigned int cpp = fb->format->cpp[0];
393 unsigned int pitch = fb->pitches[0];
399 * SHADOWCON/PRTCON register is used for enabling timing.
401 * for example, once only width value of a register is set,
402 * if the dma is started then decon hardware could malfunction so
403 * with protect window setting, the register fields with prefix '_F'
404 * wouldn't be updated at vsync also but updated once unprotect window
408 /* buffer start address */
409 val = (unsigned long)exynos_drm_fb_dma_addr(fb, 0);
410 writel(val, ctx->regs + VIDW_BUF_START(win));
412 padding = (pitch / cpp) - fb->width;
415 writel(fb->width + padding, ctx->regs + VIDW_WHOLE_X(win));
416 writel(fb->height, ctx->regs + VIDW_WHOLE_Y(win));
418 /* offset from the start of the buffer to read */
419 writel(state->src.x, ctx->regs + VIDW_OFFSET_X(win));
420 writel(state->src.y, ctx->regs + VIDW_OFFSET_Y(win));
422 DRM_DEV_DEBUG_KMS(ctx->dev, "start addr = 0x%lx\n",
424 DRM_DEV_DEBUG_KMS(ctx->dev, "ovl_width = %d, ovl_height = %d\n",
425 state->crtc.w, state->crtc.h);
427 val = VIDOSDxA_TOPLEFT_X(state->crtc.x) |
428 VIDOSDxA_TOPLEFT_Y(state->crtc.y);
429 writel(val, ctx->regs + VIDOSD_A(win));
431 last_x = state->crtc.x + state->crtc.w;
434 last_y = state->crtc.y + state->crtc.h;
438 val = VIDOSDxB_BOTRIGHT_X(last_x) | VIDOSDxB_BOTRIGHT_Y(last_y);
440 writel(val, ctx->regs + VIDOSD_B(win));
442 DRM_DEV_DEBUG_KMS(ctx->dev, "osd pos: tx = %d, ty = %d, bx = %d, by = %d\n",
443 state->crtc.x, state->crtc.y, last_x, last_y);
446 alpha = VIDOSDxC_ALPHA0_R_F(0x0) |
447 VIDOSDxC_ALPHA0_G_F(0x0) |
448 VIDOSDxC_ALPHA0_B_F(0x0);
450 writel(alpha, ctx->regs + VIDOSD_C(win));
452 alpha = VIDOSDxD_ALPHA1_R_F(0xff) |
453 VIDOSDxD_ALPHA1_G_F(0xff) |
454 VIDOSDxD_ALPHA1_B_F(0xff);
456 writel(alpha, ctx->regs + VIDOSD_D(win));
458 decon_win_set_pixfmt(ctx, win, fb);
460 /* hardware window 0 doesn't support color key. */
462 decon_win_set_colkey(ctx, win);
465 val = readl(ctx->regs + WINCON(win));
466 val |= WINCONx_TRIPLE_BUF_MODE;
467 val |= WINCONx_ENWIN;
468 writel(val, ctx->regs + WINCON(win));
470 /* Enable DMA channel and unprotect windows */
471 decon_shadow_protect_win(ctx, win, false);
473 val = readl(ctx->regs + DECON_UPDATE);
474 val |= DECON_UPDATE_STANDALONE_F;
475 writel(val, ctx->regs + DECON_UPDATE);
478 static void decon_disable_plane(struct exynos_drm_crtc *crtc,
479 struct exynos_drm_plane *plane)
481 struct decon_context *ctx = crtc->ctx;
482 unsigned int win = plane->index;
488 /* protect windows */
489 decon_shadow_protect_win(ctx, win, true);
492 val = readl(ctx->regs + WINCON(win));
493 val &= ~WINCONx_ENWIN;
494 writel(val, ctx->regs + WINCON(win));
496 val = readl(ctx->regs + DECON_UPDATE);
497 val |= DECON_UPDATE_STANDALONE_F;
498 writel(val, ctx->regs + DECON_UPDATE);
501 static void decon_atomic_flush(struct exynos_drm_crtc *crtc)
503 struct decon_context *ctx = crtc->ctx;
509 for (i = 0; i < WINDOWS_NR; i++)
510 decon_shadow_protect_win(ctx, i, false);
511 exynos_crtc_handle_event(crtc);
514 static void decon_init(struct decon_context *ctx)
518 writel(VIDCON0_SWRESET, ctx->regs + VIDCON0);
520 val = VIDOUTCON0_DISP_IF_0_ON;
522 val |= VIDOUTCON0_RGBIF;
523 writel(val, ctx->regs + VIDOUTCON0);
525 writel(VCLKCON0_CLKVALUP | VCLKCON0_VCLKFREE, ctx->regs + VCLKCON0);
528 writel(VIDCON1_VCLK_HOLD, ctx->regs + VIDCON1(0));
531 static void decon_atomic_enable(struct exynos_drm_crtc *crtc)
533 struct decon_context *ctx = crtc->ctx;
538 pm_runtime_get_sync(ctx->dev);
542 /* if vblank was enabled status, enable it again. */
543 if (test_and_clear_bit(0, &ctx->irq_flags))
544 decon_enable_vblank(ctx->crtc);
546 decon_commit(ctx->crtc);
548 ctx->suspended = false;
551 static void decon_atomic_disable(struct exynos_drm_crtc *crtc)
553 struct decon_context *ctx = crtc->ctx;
560 * We need to make sure that all windows are disabled before we
561 * suspend that connector. Otherwise we might try to scan from
562 * a destroyed buffer later.
564 for (i = 0; i < WINDOWS_NR; i++)
565 decon_disable_plane(crtc, &ctx->planes[i]);
567 pm_runtime_put_sync(ctx->dev);
569 ctx->suspended = true;
572 static const struct exynos_drm_crtc_ops decon_crtc_ops = {
573 .atomic_enable = decon_atomic_enable,
574 .atomic_disable = decon_atomic_disable,
575 .enable_vblank = decon_enable_vblank,
576 .disable_vblank = decon_disable_vblank,
577 .atomic_begin = decon_atomic_begin,
578 .update_plane = decon_update_plane,
579 .disable_plane = decon_disable_plane,
580 .atomic_flush = decon_atomic_flush,
584 static irqreturn_t decon_irq_handler(int irq, void *dev_id)
586 struct decon_context *ctx = (struct decon_context *)dev_id;
589 val = readl(ctx->regs + VIDINTCON1);
591 clear_bit = ctx->i80_if ? VIDINTCON1_INT_I80 : VIDINTCON1_INT_FRAME;
593 writel(clear_bit, ctx->regs + VIDINTCON1);
595 /* check the crtc is detached already from encoder */
600 drm_crtc_handle_vblank(&ctx->crtc->base);
602 /* set wait vsync event to zero and wake up queue. */
603 if (atomic_read(&ctx->wait_vsync_event)) {
604 atomic_set(&ctx->wait_vsync_event, 0);
605 wake_up(&ctx->wait_vsync_queue);
612 static int decon_bind(struct device *dev, struct device *master, void *data)
614 struct decon_context *ctx = dev_get_drvdata(dev);
615 struct drm_device *drm_dev = data;
616 struct exynos_drm_plane *exynos_plane;
620 ret = decon_ctx_initialize(ctx, drm_dev);
622 DRM_DEV_ERROR(dev, "decon_ctx_initialize failed.\n");
626 for (i = 0; i < WINDOWS_NR; i++) {
627 ctx->configs[i].pixel_formats = decon_formats;
628 ctx->configs[i].num_pixel_formats = ARRAY_SIZE(decon_formats);
629 ctx->configs[i].zpos = i;
630 ctx->configs[i].type = decon_win_types[i];
632 ret = exynos_plane_init(drm_dev, &ctx->planes[i], i,
638 exynos_plane = &ctx->planes[DEFAULT_WIN];
639 ctx->crtc = exynos_drm_crtc_create(drm_dev, &exynos_plane->base,
640 EXYNOS_DISPLAY_TYPE_LCD, &decon_crtc_ops, ctx);
641 if (IS_ERR(ctx->crtc)) {
642 decon_ctx_remove(ctx);
643 return PTR_ERR(ctx->crtc);
647 exynos_dpi_bind(drm_dev, ctx->encoder);
653 static void decon_unbind(struct device *dev, struct device *master,
656 struct decon_context *ctx = dev_get_drvdata(dev);
658 decon_atomic_disable(ctx->crtc);
661 exynos_dpi_remove(ctx->encoder);
663 decon_ctx_remove(ctx);
666 static const struct component_ops decon_component_ops = {
668 .unbind = decon_unbind,
671 static int decon_probe(struct platform_device *pdev)
673 struct device *dev = &pdev->dev;
674 struct decon_context *ctx;
675 struct device_node *i80_if_timings;
676 struct resource *res;
682 ctx = devm_kzalloc(dev, sizeof(*ctx), GFP_KERNEL);
687 ctx->suspended = true;
689 i80_if_timings = of_get_child_by_name(dev->of_node, "i80-if-timings");
692 of_node_put(i80_if_timings);
694 ctx->regs = of_iomap(dev->of_node, 0);
698 ctx->pclk = devm_clk_get(dev, "pclk_decon0");
699 if (IS_ERR(ctx->pclk)) {
700 dev_err(dev, "failed to get bus clock pclk\n");
701 ret = PTR_ERR(ctx->pclk);
705 ctx->aclk = devm_clk_get(dev, "aclk_decon0");
706 if (IS_ERR(ctx->aclk)) {
707 dev_err(dev, "failed to get bus clock aclk\n");
708 ret = PTR_ERR(ctx->aclk);
712 ctx->eclk = devm_clk_get(dev, "decon0_eclk");
713 if (IS_ERR(ctx->eclk)) {
714 dev_err(dev, "failed to get eclock\n");
715 ret = PTR_ERR(ctx->eclk);
719 ctx->vclk = devm_clk_get(dev, "decon0_vclk");
720 if (IS_ERR(ctx->vclk)) {
721 dev_err(dev, "failed to get vclock\n");
722 ret = PTR_ERR(ctx->vclk);
726 res = platform_get_resource_byname(pdev, IORESOURCE_IRQ,
727 ctx->i80_if ? "lcd_sys" : "vsync");
729 dev_err(dev, "irq request failed.\n");
734 ret = devm_request_irq(dev, res->start, decon_irq_handler,
735 0, "drm_decon", ctx);
737 dev_err(dev, "irq request failed.\n");
741 init_waitqueue_head(&ctx->wait_vsync_queue);
742 atomic_set(&ctx->wait_vsync_event, 0);
744 platform_set_drvdata(pdev, ctx);
746 ctx->encoder = exynos_dpi_probe(dev);
747 if (IS_ERR(ctx->encoder)) {
748 ret = PTR_ERR(ctx->encoder);
752 pm_runtime_enable(dev);
754 ret = component_add(dev, &decon_component_ops);
756 goto err_disable_pm_runtime;
760 err_disable_pm_runtime:
761 pm_runtime_disable(dev);
769 static int decon_remove(struct platform_device *pdev)
771 struct decon_context *ctx = dev_get_drvdata(&pdev->dev);
773 pm_runtime_disable(&pdev->dev);
777 component_del(&pdev->dev, &decon_component_ops);
783 static int exynos7_decon_suspend(struct device *dev)
785 struct decon_context *ctx = dev_get_drvdata(dev);
787 clk_disable_unprepare(ctx->vclk);
788 clk_disable_unprepare(ctx->eclk);
789 clk_disable_unprepare(ctx->aclk);
790 clk_disable_unprepare(ctx->pclk);
795 static int exynos7_decon_resume(struct device *dev)
797 struct decon_context *ctx = dev_get_drvdata(dev);
800 ret = clk_prepare_enable(ctx->pclk);
802 DRM_DEV_ERROR(dev, "Failed to prepare_enable the pclk [%d]\n",
807 ret = clk_prepare_enable(ctx->aclk);
809 DRM_DEV_ERROR(dev, "Failed to prepare_enable the aclk [%d]\n",
814 ret = clk_prepare_enable(ctx->eclk);
816 DRM_DEV_ERROR(dev, "Failed to prepare_enable the eclk [%d]\n",
821 ret = clk_prepare_enable(ctx->vclk);
823 DRM_DEV_ERROR(dev, "Failed to prepare_enable the vclk [%d]\n",
832 static const struct dev_pm_ops exynos7_decon_pm_ops = {
833 SET_RUNTIME_PM_OPS(exynos7_decon_suspend, exynos7_decon_resume,
835 SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
836 pm_runtime_force_resume)
839 struct platform_driver decon_driver = {
840 .probe = decon_probe,
841 .remove = decon_remove,
843 .name = "exynos-decon",
844 .pm = &exynos7_decon_pm_ops,
845 .of_match_table = decon_driver_dt_match,