1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (c) 2015 MediaTek Inc.
4 * Author: YT SHEN <yt.shen@mediatek.com>
7 #include <linux/component.h>
8 #include <linux/iommu.h>
9 #include <linux/module.h>
10 #include <linux/of_address.h>
11 #include <linux/of_platform.h>
12 #include <linux/pm_runtime.h>
13 #include <linux/soc/mediatek/mtk-mmsys.h>
14 #include <linux/dma-mapping.h>
16 #include <drm/drm_atomic.h>
17 #include <drm/drm_atomic_helper.h>
18 #include <drm/drm_drv.h>
19 #include <drm/drm_fb_helper.h>
20 #include <drm/drm_fourcc.h>
21 #include <drm/drm_gem.h>
22 #include <drm/drm_gem_cma_helper.h>
23 #include <drm/drm_gem_framebuffer_helper.h>
24 #include <drm/drm_of.h>
25 #include <drm/drm_probe_helper.h>
26 #include <drm/drm_vblank.h>
28 #include "mtk_drm_crtc.h"
29 #include "mtk_drm_ddp.h"
30 #include "mtk_drm_ddp_comp.h"
31 #include "mtk_drm_drv.h"
32 #include "mtk_drm_gem.h"
34 #define DRIVER_NAME "mediatek"
35 #define DRIVER_DESC "Mediatek SoC DRM"
36 #define DRIVER_DATE "20150513"
37 #define DRIVER_MAJOR 1
38 #define DRIVER_MINOR 0
40 static const struct drm_mode_config_helper_funcs mtk_drm_mode_config_helpers = {
41 .atomic_commit_tail = drm_atomic_helper_commit_tail_rpm,
44 static struct drm_framebuffer *
45 mtk_drm_mode_fb_create(struct drm_device *dev,
46 struct drm_file *file,
47 const struct drm_mode_fb_cmd2 *cmd)
49 const struct drm_format_info *info = drm_get_format_info(dev, cmd);
51 if (info->num_planes != 1)
52 return ERR_PTR(-EINVAL);
54 return drm_gem_fb_create(dev, file, cmd);
57 static const struct drm_mode_config_funcs mtk_drm_mode_config_funcs = {
58 .fb_create = mtk_drm_mode_fb_create,
59 .atomic_check = drm_atomic_helper_check,
60 .atomic_commit = drm_atomic_helper_commit,
63 static const enum mtk_ddp_comp_id mt2701_mtk_ddp_main[] = {
71 static const enum mtk_ddp_comp_id mt2701_mtk_ddp_ext[] = {
76 static const enum mtk_ddp_comp_id mt7623_mtk_ddp_main[] = {
84 static const enum mtk_ddp_comp_id mt7623_mtk_ddp_ext[] = {
89 static const enum mtk_ddp_comp_id mt2712_mtk_ddp_main[] = {
99 static const enum mtk_ddp_comp_id mt2712_mtk_ddp_ext[] = {
101 DDP_COMPONENT_COLOR1,
109 static const enum mtk_ddp_comp_id mt2712_mtk_ddp_third[] = {
115 static const enum mtk_ddp_comp_id mt8173_mtk_ddp_main[] = {
117 DDP_COMPONENT_COLOR0,
126 static const enum mtk_ddp_comp_id mt8173_mtk_ddp_ext[] = {
128 DDP_COMPONENT_COLOR1,
134 static const struct mtk_mmsys_driver_data mt2701_mmsys_driver_data = {
135 .main_path = mt2701_mtk_ddp_main,
136 .main_len = ARRAY_SIZE(mt2701_mtk_ddp_main),
137 .ext_path = mt2701_mtk_ddp_ext,
138 .ext_len = ARRAY_SIZE(mt2701_mtk_ddp_ext),
139 .shadow_register = true,
142 static const struct mtk_mmsys_driver_data mt7623_mmsys_driver_data = {
143 .main_path = mt7623_mtk_ddp_main,
144 .main_len = ARRAY_SIZE(mt7623_mtk_ddp_main),
145 .ext_path = mt7623_mtk_ddp_ext,
146 .ext_len = ARRAY_SIZE(mt7623_mtk_ddp_ext),
147 .shadow_register = true,
150 static const struct mtk_mmsys_driver_data mt2712_mmsys_driver_data = {
151 .main_path = mt2712_mtk_ddp_main,
152 .main_len = ARRAY_SIZE(mt2712_mtk_ddp_main),
153 .ext_path = mt2712_mtk_ddp_ext,
154 .ext_len = ARRAY_SIZE(mt2712_mtk_ddp_ext),
155 .third_path = mt2712_mtk_ddp_third,
156 .third_len = ARRAY_SIZE(mt2712_mtk_ddp_third),
159 static const struct mtk_mmsys_driver_data mt8173_mmsys_driver_data = {
160 .main_path = mt8173_mtk_ddp_main,
161 .main_len = ARRAY_SIZE(mt8173_mtk_ddp_main),
162 .ext_path = mt8173_mtk_ddp_ext,
163 .ext_len = ARRAY_SIZE(mt8173_mtk_ddp_ext),
166 static int mtk_drm_kms_init(struct drm_device *drm)
168 struct mtk_drm_private *private = drm->dev_private;
169 struct platform_device *pdev;
170 struct device_node *np;
171 struct device *dma_dev;
174 if (!iommu_present(&platform_bus_type))
175 return -EPROBE_DEFER;
177 pdev = of_find_device_by_node(private->mutex_node);
179 dev_err(drm->dev, "Waiting for disp-mutex device %pOF\n",
180 private->mutex_node);
181 of_node_put(private->mutex_node);
182 return -EPROBE_DEFER;
184 private->mutex_dev = &pdev->dev;
186 ret = drmm_mode_config_init(drm);
190 drm->mode_config.min_width = 64;
191 drm->mode_config.min_height = 64;
194 * set max width and height as default value(4096x4096).
195 * this value would be used to check framebuffer size limitation
196 * at drm_mode_addfb().
198 drm->mode_config.max_width = 4096;
199 drm->mode_config.max_height = 4096;
200 drm->mode_config.funcs = &mtk_drm_mode_config_funcs;
201 drm->mode_config.helper_private = &mtk_drm_mode_config_helpers;
203 ret = component_bind_all(drm->dev, drm);
208 * We currently support two fixed data streams, each optional,
209 * and each statically assigned to a crtc:
210 * OVL0 -> COLOR0 -> AAL -> OD -> RDMA0 -> UFOE -> DSI0 ...
212 ret = mtk_drm_crtc_create(drm, private->data->main_path,
213 private->data->main_len);
215 goto err_component_unbind;
216 /* ... and OVL1 -> COLOR1 -> GAMMA -> RDMA1 -> DPI0. */
217 ret = mtk_drm_crtc_create(drm, private->data->ext_path,
218 private->data->ext_len);
220 goto err_component_unbind;
222 ret = mtk_drm_crtc_create(drm, private->data->third_path,
223 private->data->third_len);
225 goto err_component_unbind;
227 /* Use OVL device for all DMA memory allocations */
228 np = private->comp_node[private->data->main_path[0]] ?:
229 private->comp_node[private->data->ext_path[0]];
230 pdev = of_find_device_by_node(np);
233 dev_err(drm->dev, "Need at least one OVL device\n");
234 goto err_component_unbind;
237 dma_dev = &pdev->dev;
238 private->dma_dev = dma_dev;
241 * Configure the DMA segment size to make sure we get contiguous IOVA
242 * when importing PRIME buffers.
244 if (!dma_dev->dma_parms) {
245 private->dma_parms_allocated = true;
247 devm_kzalloc(drm->dev, sizeof(*dma_dev->dma_parms),
250 if (!dma_dev->dma_parms) {
255 ret = dma_set_max_seg_size(dma_dev, (unsigned int)DMA_BIT_MASK(32));
257 dev_err(dma_dev, "Failed to set DMA segment size\n");
258 goto err_unset_dma_parms;
262 * We don't use the drm_irq_install() helpers provided by the DRM
263 * core, so we need to set this manually in order to allow the
264 * DRM_IOCTL_WAIT_VBLANK to operate correctly.
266 drm->irq_enabled = true;
267 ret = drm_vblank_init(drm, MAX_CRTC);
269 goto err_unset_dma_parms;
271 drm_kms_helper_poll_init(drm);
272 drm_mode_config_reset(drm);
277 if (private->dma_parms_allocated)
278 dma_dev->dma_parms = NULL;
280 put_device(private->dma_dev);
281 err_component_unbind:
282 component_unbind_all(drm->dev, drm);
284 put_device(private->mutex_dev);
288 static void mtk_drm_kms_deinit(struct drm_device *drm)
290 struct mtk_drm_private *private = drm->dev_private;
292 drm_kms_helper_poll_fini(drm);
293 drm_atomic_helper_shutdown(drm);
295 if (private->dma_parms_allocated)
296 private->dma_dev->dma_parms = NULL;
298 component_unbind_all(drm->dev, drm);
301 static const struct file_operations mtk_drm_fops = {
302 .owner = THIS_MODULE,
304 .release = drm_release,
305 .unlocked_ioctl = drm_ioctl,
306 .mmap = mtk_drm_gem_mmap,
309 .compat_ioctl = drm_compat_ioctl,
313 * We need to override this because the device used to import the memory is
314 * not dev->dev, as drm_gem_prime_import() expects.
316 struct drm_gem_object *mtk_drm_gem_prime_import(struct drm_device *dev,
317 struct dma_buf *dma_buf)
319 struct mtk_drm_private *private = dev->dev_private;
321 return drm_gem_prime_import_dev(dev, dma_buf, private->dma_dev);
324 static struct drm_driver mtk_drm_driver = {
325 .driver_features = DRIVER_MODESET | DRIVER_GEM | DRIVER_ATOMIC,
327 .dumb_create = mtk_drm_gem_dumb_create,
329 .prime_handle_to_fd = drm_gem_prime_handle_to_fd,
330 .prime_fd_to_handle = drm_gem_prime_fd_to_handle,
331 .gem_prime_import = mtk_drm_gem_prime_import,
332 .gem_prime_import_sg_table = mtk_gem_prime_import_sg_table,
333 .gem_prime_mmap = mtk_drm_gem_mmap_buf,
334 .fops = &mtk_drm_fops,
339 .major = DRIVER_MAJOR,
340 .minor = DRIVER_MINOR,
343 static int compare_of(struct device *dev, void *data)
345 return dev->of_node == data;
348 static int mtk_drm_bind(struct device *dev)
350 struct mtk_drm_private *private = dev_get_drvdata(dev);
351 struct drm_device *drm;
354 drm = drm_dev_alloc(&mtk_drm_driver, dev);
358 drm->dev_private = private;
361 ret = mtk_drm_kms_init(drm);
365 ret = drm_dev_register(drm, 0);
369 drm_fbdev_generic_setup(drm, 32);
374 mtk_drm_kms_deinit(drm);
380 static void mtk_drm_unbind(struct device *dev)
382 struct mtk_drm_private *private = dev_get_drvdata(dev);
384 drm_dev_unregister(private->drm);
385 mtk_drm_kms_deinit(private->drm);
386 drm_dev_put(private->drm);
387 private->num_pipes = 0;
391 static const struct component_master_ops mtk_drm_ops = {
392 .bind = mtk_drm_bind,
393 .unbind = mtk_drm_unbind,
396 static const struct of_device_id mtk_ddp_comp_dt_ids[] = {
397 { .compatible = "mediatek,mt2701-disp-ovl",
398 .data = (void *)MTK_DISP_OVL },
399 { .compatible = "mediatek,mt8173-disp-ovl",
400 .data = (void *)MTK_DISP_OVL },
401 { .compatible = "mediatek,mt2701-disp-rdma",
402 .data = (void *)MTK_DISP_RDMA },
403 { .compatible = "mediatek,mt8173-disp-rdma",
404 .data = (void *)MTK_DISP_RDMA },
405 { .compatible = "mediatek,mt8173-disp-wdma",
406 .data = (void *)MTK_DISP_WDMA },
407 { .compatible = "mediatek,mt2701-disp-color",
408 .data = (void *)MTK_DISP_COLOR },
409 { .compatible = "mediatek,mt8173-disp-color",
410 .data = (void *)MTK_DISP_COLOR },
411 { .compatible = "mediatek,mt8173-disp-aal",
412 .data = (void *)MTK_DISP_AAL},
413 { .compatible = "mediatek,mt8173-disp-gamma",
414 .data = (void *)MTK_DISP_GAMMA, },
415 { .compatible = "mediatek,mt8173-disp-ufoe",
416 .data = (void *)MTK_DISP_UFOE },
417 { .compatible = "mediatek,mt2701-dsi",
418 .data = (void *)MTK_DSI },
419 { .compatible = "mediatek,mt8173-dsi",
420 .data = (void *)MTK_DSI },
421 { .compatible = "mediatek,mt2701-dpi",
422 .data = (void *)MTK_DPI },
423 { .compatible = "mediatek,mt8173-dpi",
424 .data = (void *)MTK_DPI },
425 { .compatible = "mediatek,mt2701-disp-mutex",
426 .data = (void *)MTK_DISP_MUTEX },
427 { .compatible = "mediatek,mt2712-disp-mutex",
428 .data = (void *)MTK_DISP_MUTEX },
429 { .compatible = "mediatek,mt8173-disp-mutex",
430 .data = (void *)MTK_DISP_MUTEX },
431 { .compatible = "mediatek,mt2701-disp-pwm",
432 .data = (void *)MTK_DISP_BLS },
433 { .compatible = "mediatek,mt8173-disp-pwm",
434 .data = (void *)MTK_DISP_PWM },
435 { .compatible = "mediatek,mt8173-disp-od",
436 .data = (void *)MTK_DISP_OD },
440 static const struct of_device_id mtk_drm_of_ids[] = {
441 { .compatible = "mediatek,mt2701-mmsys",
442 .data = &mt2701_mmsys_driver_data},
443 { .compatible = "mediatek,mt7623-mmsys",
444 .data = &mt7623_mmsys_driver_data},
445 { .compatible = "mediatek,mt2712-mmsys",
446 .data = &mt2712_mmsys_driver_data},
447 { .compatible = "mediatek,mt8173-mmsys",
448 .data = &mt8173_mmsys_driver_data},
452 static int mtk_drm_probe(struct platform_device *pdev)
454 struct device *dev = &pdev->dev;
455 struct device_node *phandle = dev->parent->of_node;
456 const struct of_device_id *of_id;
457 struct mtk_drm_private *private;
458 struct device_node *node;
459 struct component_match *match = NULL;
463 private = devm_kzalloc(dev, sizeof(*private), GFP_KERNEL);
467 private->mmsys_dev = dev->parent;
468 if (!private->mmsys_dev) {
469 dev_err(dev, "Failed to get MMSYS device\n");
473 of_id = of_match_node(mtk_drm_of_ids, phandle);
477 private->data = of_id->data;
479 /* Iterate over sibling DISP function blocks */
480 for_each_child_of_node(phandle->parent, node) {
481 const struct of_device_id *of_id;
482 enum mtk_ddp_comp_type comp_type;
485 of_id = of_match_node(mtk_ddp_comp_dt_ids, node);
489 if (!of_device_is_available(node)) {
490 dev_dbg(dev, "Skipping disabled component %pOF\n",
495 comp_type = (enum mtk_ddp_comp_type)of_id->data;
497 if (comp_type == MTK_DISP_MUTEX) {
498 private->mutex_node = of_node_get(node);
502 comp_id = mtk_ddp_comp_get_id(node, comp_type);
504 dev_warn(dev, "Skipping unknown component %pOF\n",
509 private->comp_node[comp_id] = of_node_get(node);
512 * Currently only the COLOR, OVL, RDMA, DSI, and DPI blocks have
513 * separate component platform drivers and initialize their own
514 * DDP component structure. The others are initialized here.
516 if (comp_type == MTK_DISP_COLOR ||
517 comp_type == MTK_DISP_OVL ||
518 comp_type == MTK_DISP_OVL_2L ||
519 comp_type == MTK_DISP_RDMA ||
520 comp_type == MTK_DSI ||
521 comp_type == MTK_DPI) {
522 dev_info(dev, "Adding component match for %pOF\n",
524 drm_of_component_match_add(dev, &match, compare_of,
527 struct mtk_ddp_comp *comp;
529 comp = devm_kzalloc(dev, sizeof(*comp), GFP_KERNEL);
536 ret = mtk_ddp_comp_init(dev->parent, node, comp,
543 private->ddp_comp[comp_id] = comp;
547 if (!private->mutex_node) {
548 dev_err(dev, "Failed to find disp-mutex node\n");
553 pm_runtime_enable(dev);
555 platform_set_drvdata(pdev, private);
557 ret = component_master_add_with_match(dev, &mtk_drm_ops, match);
564 pm_runtime_disable(dev);
566 of_node_put(private->mutex_node);
567 for (i = 0; i < DDP_COMPONENT_ID_MAX; i++) {
568 of_node_put(private->comp_node[i]);
569 if (private->ddp_comp[i]) {
570 put_device(private->ddp_comp[i]->larb_dev);
571 private->ddp_comp[i] = NULL;
577 static int mtk_drm_remove(struct platform_device *pdev)
579 struct mtk_drm_private *private = platform_get_drvdata(pdev);
582 component_master_del(&pdev->dev, &mtk_drm_ops);
583 pm_runtime_disable(&pdev->dev);
584 of_node_put(private->mutex_node);
585 for (i = 0; i < DDP_COMPONENT_ID_MAX; i++)
586 of_node_put(private->comp_node[i]);
591 #ifdef CONFIG_PM_SLEEP
592 static int mtk_drm_sys_suspend(struct device *dev)
594 struct mtk_drm_private *private = dev_get_drvdata(dev);
595 struct drm_device *drm = private->drm;
598 ret = drm_mode_config_helper_suspend(drm);
603 static int mtk_drm_sys_resume(struct device *dev)
605 struct mtk_drm_private *private = dev_get_drvdata(dev);
606 struct drm_device *drm = private->drm;
609 ret = drm_mode_config_helper_resume(drm);
615 static SIMPLE_DEV_PM_OPS(mtk_drm_pm_ops, mtk_drm_sys_suspend,
618 static struct platform_driver mtk_drm_platform_driver = {
619 .probe = mtk_drm_probe,
620 .remove = mtk_drm_remove,
622 .name = "mediatek-drm",
623 .pm = &mtk_drm_pm_ops,
627 static struct platform_driver * const mtk_drm_drivers[] = {
629 &mtk_disp_color_driver,
630 &mtk_disp_ovl_driver,
631 &mtk_disp_rdma_driver,
633 &mtk_drm_platform_driver,
638 static int __init mtk_drm_init(void)
640 return platform_register_drivers(mtk_drm_drivers,
641 ARRAY_SIZE(mtk_drm_drivers));
644 static void __exit mtk_drm_exit(void)
646 platform_unregister_drivers(mtk_drm_drivers,
647 ARRAY_SIZE(mtk_drm_drivers));
650 module_init(mtk_drm_init);
651 module_exit(mtk_drm_exit);
653 MODULE_AUTHOR("YT SHEN <yt.shen@mediatek.com>");
654 MODULE_DESCRIPTION("Mediatek SoC DRM driver");
655 MODULE_LICENSE("GPL v2");