1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2014 Traphandler
4 * Copyright (C) 2014 Free Electrons
5 * Copyright (C) 2014 Atmel
7 * Author: Jean-Jacques Hiblot <jjhiblot@traphandler.com>
8 * Author: Boris BREZILLON <boris.brezillon@free-electrons.com>
11 #include <linux/clk.h>
12 #include <linux/irq.h>
13 #include <linux/irqchip.h>
14 #include <linux/mfd/atmel-hlcdc.h>
15 #include <linux/module.h>
16 #include <linux/pm_runtime.h>
17 #include <linux/platform_device.h>
19 #include <drm/drm_atomic.h>
20 #include <drm/drm_atomic_helper.h>
21 #include <drm/drm_drv.h>
22 #include <drm/drm_fb_helper.h>
23 #include <drm/drm_gem_cma_helper.h>
24 #include <drm/drm_gem_framebuffer_helper.h>
25 #include <drm/drm_irq.h>
26 #include <drm/drm_probe_helper.h>
27 #include <drm/drm_vblank.h>
29 #include "atmel_hlcdc_dc.h"
31 #define ATMEL_HLCDC_LAYER_IRQS_OFFSET 8
33 static const struct atmel_hlcdc_layer_desc atmel_hlcdc_at91sam9n12_layers[] = {
36 .formats = &atmel_hlcdc_plane_rgb_formats,
39 .type = ATMEL_HLCDC_BASE_LAYER,
50 static const struct atmel_hlcdc_dc_desc atmel_hlcdc_dc_at91sam9n12 = {
58 .conflicting_output_formats = true,
59 .nlayers = ARRAY_SIZE(atmel_hlcdc_at91sam9n12_layers),
60 .layers = atmel_hlcdc_at91sam9n12_layers,
63 static const struct atmel_hlcdc_layer_desc atmel_hlcdc_at91sam9x5_layers[] = {
66 .formats = &atmel_hlcdc_plane_rgb_formats,
69 .type = ATMEL_HLCDC_BASE_LAYER,
82 .formats = &atmel_hlcdc_plane_rgb_formats,
85 .type = ATMEL_HLCDC_OVERLAY_LAYER,
100 .name = "high-end-overlay",
101 .formats = &atmel_hlcdc_plane_rgb_and_yuv_formats,
102 .regs_offset = 0x280,
104 .type = ATMEL_HLCDC_OVERLAY_LAYER,
114 .chroma_key_mask = 11,
115 .general_config = 12,
119 .clut_offset = 0x1000,
123 .formats = &atmel_hlcdc_plane_rgb_formats,
124 .regs_offset = 0x340,
126 .type = ATMEL_HLCDC_CURSOR_LAYER,
136 .chroma_key_mask = 8,
139 .clut_offset = 0x1400,
143 static const struct atmel_hlcdc_dc_desc atmel_hlcdc_dc_at91sam9x5 = {
151 .conflicting_output_formats = true,
152 .nlayers = ARRAY_SIZE(atmel_hlcdc_at91sam9x5_layers),
153 .layers = atmel_hlcdc_at91sam9x5_layers,
156 static const struct atmel_hlcdc_layer_desc atmel_hlcdc_sama5d3_layers[] = {
159 .formats = &atmel_hlcdc_plane_rgb_formats,
162 .type = ATMEL_HLCDC_BASE_LAYER,
171 .clut_offset = 0x600,
175 .formats = &atmel_hlcdc_plane_rgb_formats,
176 .regs_offset = 0x140,
178 .type = ATMEL_HLCDC_OVERLAY_LAYER,
187 .chroma_key_mask = 8,
190 .clut_offset = 0xa00,
194 .formats = &atmel_hlcdc_plane_rgb_formats,
195 .regs_offset = 0x240,
197 .type = ATMEL_HLCDC_OVERLAY_LAYER,
206 .chroma_key_mask = 8,
209 .clut_offset = 0xe00,
212 .name = "high-end-overlay",
213 .formats = &atmel_hlcdc_plane_rgb_and_yuv_formats,
214 .regs_offset = 0x340,
216 .type = ATMEL_HLCDC_OVERLAY_LAYER,
226 .chroma_key_mask = 11,
227 .general_config = 12,
235 .clut_offset = 0x1200,
239 .formats = &atmel_hlcdc_plane_rgb_formats,
240 .regs_offset = 0x440,
242 .type = ATMEL_HLCDC_CURSOR_LAYER,
253 .chroma_key_mask = 8,
257 .clut_offset = 0x1600,
261 static const struct atmel_hlcdc_dc_desc atmel_hlcdc_dc_sama5d3 = {
269 .conflicting_output_formats = true,
270 .nlayers = ARRAY_SIZE(atmel_hlcdc_sama5d3_layers),
271 .layers = atmel_hlcdc_sama5d3_layers,
274 static const struct atmel_hlcdc_layer_desc atmel_hlcdc_sama5d4_layers[] = {
277 .formats = &atmel_hlcdc_plane_rgb_formats,
280 .type = ATMEL_HLCDC_BASE_LAYER,
289 .clut_offset = 0x600,
293 .formats = &atmel_hlcdc_plane_rgb_formats,
294 .regs_offset = 0x140,
296 .type = ATMEL_HLCDC_OVERLAY_LAYER,
305 .chroma_key_mask = 8,
308 .clut_offset = 0xa00,
312 .formats = &atmel_hlcdc_plane_rgb_formats,
313 .regs_offset = 0x240,
315 .type = ATMEL_HLCDC_OVERLAY_LAYER,
324 .chroma_key_mask = 8,
327 .clut_offset = 0xe00,
330 .name = "high-end-overlay",
331 .formats = &atmel_hlcdc_plane_rgb_and_yuv_formats,
332 .regs_offset = 0x340,
334 .type = ATMEL_HLCDC_OVERLAY_LAYER,
344 .chroma_key_mask = 11,
345 .general_config = 12,
353 .clut_offset = 0x1200,
357 static const struct atmel_hlcdc_dc_desc atmel_hlcdc_dc_sama5d4 = {
365 .nlayers = ARRAY_SIZE(atmel_hlcdc_sama5d4_layers),
366 .layers = atmel_hlcdc_sama5d4_layers,
369 static const struct atmel_hlcdc_layer_desc atmel_hlcdc_sam9x60_layers[] = {
372 .formats = &atmel_hlcdc_plane_rgb_formats,
375 .type = ATMEL_HLCDC_BASE_LAYER,
384 .clut_offset = 0x600,
388 .formats = &atmel_hlcdc_plane_rgb_formats,
389 .regs_offset = 0x160,
391 .type = ATMEL_HLCDC_OVERLAY_LAYER,
400 .chroma_key_mask = 8,
403 .clut_offset = 0xa00,
407 .formats = &atmel_hlcdc_plane_rgb_formats,
408 .regs_offset = 0x260,
410 .type = ATMEL_HLCDC_OVERLAY_LAYER,
419 .chroma_key_mask = 8,
422 .clut_offset = 0xe00,
425 .name = "high-end-overlay",
426 .formats = &atmel_hlcdc_plane_rgb_and_yuv_formats,
427 .regs_offset = 0x360,
429 .type = ATMEL_HLCDC_OVERLAY_LAYER,
439 .chroma_key_mask = 11,
440 .general_config = 12,
448 .clut_offset = 0x1200,
452 static const struct atmel_hlcdc_dc_desc atmel_hlcdc_dc_sam9x60 = {
460 .fixed_clksrc = true,
461 .nlayers = ARRAY_SIZE(atmel_hlcdc_sam9x60_layers),
462 .layers = atmel_hlcdc_sam9x60_layers,
465 static const struct of_device_id atmel_hlcdc_of_match[] = {
467 .compatible = "atmel,at91sam9n12-hlcdc",
468 .data = &atmel_hlcdc_dc_at91sam9n12,
471 .compatible = "atmel,at91sam9x5-hlcdc",
472 .data = &atmel_hlcdc_dc_at91sam9x5,
475 .compatible = "atmel,sama5d2-hlcdc",
476 .data = &atmel_hlcdc_dc_sama5d4,
479 .compatible = "atmel,sama5d3-hlcdc",
480 .data = &atmel_hlcdc_dc_sama5d3,
483 .compatible = "atmel,sama5d4-hlcdc",
484 .data = &atmel_hlcdc_dc_sama5d4,
487 .compatible = "microchip,sam9x60-hlcdc",
488 .data = &atmel_hlcdc_dc_sam9x60,
492 MODULE_DEVICE_TABLE(of, atmel_hlcdc_of_match);
495 atmel_hlcdc_dc_mode_valid(struct atmel_hlcdc_dc *dc,
496 const struct drm_display_mode *mode)
498 int vfront_porch = mode->vsync_start - mode->vdisplay;
499 int vback_porch = mode->vtotal - mode->vsync_end;
500 int vsync_len = mode->vsync_end - mode->vsync_start;
501 int hfront_porch = mode->hsync_start - mode->hdisplay;
502 int hback_porch = mode->htotal - mode->hsync_end;
503 int hsync_len = mode->hsync_end - mode->hsync_start;
505 if (hsync_len > dc->desc->max_spw + 1 || hsync_len < 1)
508 if (vsync_len > dc->desc->max_spw + 1 || vsync_len < 1)
511 if (hfront_porch > dc->desc->max_hpw + 1 || hfront_porch < 1 ||
512 hback_porch > dc->desc->max_hpw + 1 || hback_porch < 1 ||
514 return MODE_H_ILLEGAL;
516 if (vfront_porch > dc->desc->max_vpw + 1 || vfront_porch < 1 ||
517 vback_porch > dc->desc->max_vpw || vback_porch < 0 ||
519 return MODE_V_ILLEGAL;
524 static void atmel_hlcdc_layer_irq(struct atmel_hlcdc_layer *layer)
529 if (layer->desc->type == ATMEL_HLCDC_BASE_LAYER ||
530 layer->desc->type == ATMEL_HLCDC_OVERLAY_LAYER ||
531 layer->desc->type == ATMEL_HLCDC_CURSOR_LAYER)
532 atmel_hlcdc_plane_irq(atmel_hlcdc_layer_to_plane(layer));
535 static irqreturn_t atmel_hlcdc_dc_irq_handler(int irq, void *data)
537 struct drm_device *dev = data;
538 struct atmel_hlcdc_dc *dc = dev->dev_private;
539 unsigned long status;
540 unsigned int imr, isr;
543 regmap_read(dc->hlcdc->regmap, ATMEL_HLCDC_IMR, &imr);
544 regmap_read(dc->hlcdc->regmap, ATMEL_HLCDC_ISR, &isr);
549 if (status & ATMEL_HLCDC_SOF)
550 atmel_hlcdc_crtc_irq(dc->crtc);
552 for (i = 0; i < ATMEL_HLCDC_MAX_LAYERS; i++) {
553 if (ATMEL_HLCDC_LAYER_STATUS(i) & status)
554 atmel_hlcdc_layer_irq(dc->layers[i]);
560 static const struct drm_mode_config_funcs mode_config_funcs = {
561 .fb_create = drm_gem_fb_create,
562 .atomic_check = drm_atomic_helper_check,
563 .atomic_commit = drm_atomic_helper_commit,
566 static int atmel_hlcdc_dc_modeset_init(struct drm_device *dev)
568 struct atmel_hlcdc_dc *dc = dev->dev_private;
571 drm_mode_config_init(dev);
573 ret = atmel_hlcdc_create_outputs(dev);
575 dev_err(dev->dev, "failed to create HLCDC outputs: %d\n", ret);
579 ret = atmel_hlcdc_create_planes(dev);
581 dev_err(dev->dev, "failed to create planes: %d\n", ret);
585 ret = atmel_hlcdc_crtc_create(dev);
587 dev_err(dev->dev, "failed to create crtc\n");
591 dev->mode_config.min_width = dc->desc->min_width;
592 dev->mode_config.min_height = dc->desc->min_height;
593 dev->mode_config.max_width = dc->desc->max_width;
594 dev->mode_config.max_height = dc->desc->max_height;
595 dev->mode_config.funcs = &mode_config_funcs;
596 dev->mode_config.async_page_flip = true;
601 static int atmel_hlcdc_dc_load(struct drm_device *dev)
603 struct platform_device *pdev = to_platform_device(dev->dev);
604 const struct of_device_id *match;
605 struct atmel_hlcdc_dc *dc;
608 match = of_match_node(atmel_hlcdc_of_match, dev->dev->parent->of_node);
610 dev_err(&pdev->dev, "invalid compatible string\n");
615 dev_err(&pdev->dev, "invalid hlcdc description\n");
619 dc = devm_kzalloc(dev->dev, sizeof(*dc), GFP_KERNEL);
623 dc->desc = match->data;
624 dc->hlcdc = dev_get_drvdata(dev->dev->parent);
625 dev->dev_private = dc;
627 ret = clk_prepare_enable(dc->hlcdc->periph_clk);
629 dev_err(dev->dev, "failed to enable periph_clk\n");
633 pm_runtime_enable(dev->dev);
635 ret = drm_vblank_init(dev, 1);
637 dev_err(dev->dev, "failed to initialize vblank\n");
638 goto err_periph_clk_disable;
641 ret = atmel_hlcdc_dc_modeset_init(dev);
643 dev_err(dev->dev, "failed to initialize mode setting\n");
644 goto err_periph_clk_disable;
647 drm_mode_config_reset(dev);
649 pm_runtime_get_sync(dev->dev);
650 ret = drm_irq_install(dev, dc->hlcdc->irq);
651 pm_runtime_put_sync(dev->dev);
653 dev_err(dev->dev, "failed to install IRQ handler\n");
654 goto err_periph_clk_disable;
657 platform_set_drvdata(pdev, dev);
659 drm_kms_helper_poll_init(dev);
663 err_periph_clk_disable:
664 pm_runtime_disable(dev->dev);
665 clk_disable_unprepare(dc->hlcdc->periph_clk);
670 static void atmel_hlcdc_dc_unload(struct drm_device *dev)
672 struct atmel_hlcdc_dc *dc = dev->dev_private;
674 drm_kms_helper_poll_fini(dev);
675 drm_atomic_helper_shutdown(dev);
676 drm_mode_config_cleanup(dev);
678 pm_runtime_get_sync(dev->dev);
679 drm_irq_uninstall(dev);
680 pm_runtime_put_sync(dev->dev);
682 dev->dev_private = NULL;
684 pm_runtime_disable(dev->dev);
685 clk_disable_unprepare(dc->hlcdc->periph_clk);
688 static int atmel_hlcdc_dc_irq_postinstall(struct drm_device *dev)
690 struct atmel_hlcdc_dc *dc = dev->dev_private;
691 unsigned int cfg = 0;
694 /* Enable interrupts on activated layers */
695 for (i = 0; i < ATMEL_HLCDC_MAX_LAYERS; i++) {
697 cfg |= ATMEL_HLCDC_LAYER_STATUS(i);
700 regmap_write(dc->hlcdc->regmap, ATMEL_HLCDC_IER, cfg);
705 static void atmel_hlcdc_dc_irq_uninstall(struct drm_device *dev)
707 struct atmel_hlcdc_dc *dc = dev->dev_private;
710 regmap_write(dc->hlcdc->regmap, ATMEL_HLCDC_IDR, 0xffffffff);
711 regmap_read(dc->hlcdc->regmap, ATMEL_HLCDC_ISR, &isr);
714 DEFINE_DRM_GEM_CMA_FOPS(fops);
716 static const struct drm_driver atmel_hlcdc_dc_driver = {
717 .driver_features = DRIVER_GEM | DRIVER_MODESET | DRIVER_ATOMIC,
718 .irq_handler = atmel_hlcdc_dc_irq_handler,
719 .irq_preinstall = atmel_hlcdc_dc_irq_uninstall,
720 .irq_postinstall = atmel_hlcdc_dc_irq_postinstall,
721 .irq_uninstall = atmel_hlcdc_dc_irq_uninstall,
722 DRM_GEM_CMA_DRIVER_OPS,
724 .name = "atmel-hlcdc",
725 .desc = "Atmel HLCD Controller DRM",
731 static int atmel_hlcdc_dc_drm_probe(struct platform_device *pdev)
733 struct drm_device *ddev;
736 ddev = drm_dev_alloc(&atmel_hlcdc_dc_driver, &pdev->dev);
738 return PTR_ERR(ddev);
740 ret = atmel_hlcdc_dc_load(ddev);
744 ret = drm_dev_register(ddev, 0);
748 drm_fbdev_generic_setup(ddev, 24);
753 atmel_hlcdc_dc_unload(ddev);
761 static int atmel_hlcdc_dc_drm_remove(struct platform_device *pdev)
763 struct drm_device *ddev = platform_get_drvdata(pdev);
765 drm_dev_unregister(ddev);
766 atmel_hlcdc_dc_unload(ddev);
772 #ifdef CONFIG_PM_SLEEP
773 static int atmel_hlcdc_dc_drm_suspend(struct device *dev)
775 struct drm_device *drm_dev = dev_get_drvdata(dev);
776 struct atmel_hlcdc_dc *dc = drm_dev->dev_private;
777 struct regmap *regmap = dc->hlcdc->regmap;
778 struct drm_atomic_state *state;
780 state = drm_atomic_helper_suspend(drm_dev);
782 return PTR_ERR(state);
784 dc->suspend.state = state;
786 regmap_read(regmap, ATMEL_HLCDC_IMR, &dc->suspend.imr);
787 regmap_write(regmap, ATMEL_HLCDC_IDR, dc->suspend.imr);
788 clk_disable_unprepare(dc->hlcdc->periph_clk);
793 static int atmel_hlcdc_dc_drm_resume(struct device *dev)
795 struct drm_device *drm_dev = dev_get_drvdata(dev);
796 struct atmel_hlcdc_dc *dc = drm_dev->dev_private;
798 clk_prepare_enable(dc->hlcdc->periph_clk);
799 regmap_write(dc->hlcdc->regmap, ATMEL_HLCDC_IER, dc->suspend.imr);
801 return drm_atomic_helper_resume(drm_dev, dc->suspend.state);
805 static SIMPLE_DEV_PM_OPS(atmel_hlcdc_dc_drm_pm_ops,
806 atmel_hlcdc_dc_drm_suspend, atmel_hlcdc_dc_drm_resume);
808 static const struct of_device_id atmel_hlcdc_dc_of_match[] = {
809 { .compatible = "atmel,hlcdc-display-controller" },
813 static struct platform_driver atmel_hlcdc_dc_platform_driver = {
814 .probe = atmel_hlcdc_dc_drm_probe,
815 .remove = atmel_hlcdc_dc_drm_remove,
817 .name = "atmel-hlcdc-display-controller",
818 .pm = &atmel_hlcdc_dc_drm_pm_ops,
819 .of_match_table = atmel_hlcdc_dc_of_match,
822 module_platform_driver(atmel_hlcdc_dc_platform_driver);
824 MODULE_AUTHOR("Jean-Jacques Hiblot <jjhiblot@traphandler.com>");
825 MODULE_AUTHOR("Boris Brezillon <boris.brezillon@free-electrons.com>");
826 MODULE_DESCRIPTION("Atmel HLCDC Display Controller DRM Driver");
827 MODULE_LICENSE("GPL");
828 MODULE_ALIAS("platform:atmel-hlcdc-dc");