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/dma-mapping.h>
15 #include <drm/drm_atomic.h>
16 #include <drm/drm_atomic_helper.h>
17 #include <drm/drm_drv.h>
18 #include <drm/drm_fb_helper.h>
19 #include <drm/drm_fourcc.h>
20 #include <drm/drm_gem.h>
21 #include <drm/drm_gem_cma_helper.h>
22 #include <drm/drm_gem_framebuffer_helper.h>
23 #include <drm/drm_of.h>
24 #include <drm/drm_probe_helper.h>
25 #include <drm/drm_vblank.h>
27 #include "mtk_drm_crtc.h"
28 #include "mtk_drm_ddp_comp.h"
29 #include "mtk_drm_drv.h"
30 #include "mtk_drm_gem.h"
32 #define DRIVER_NAME "mediatek"
33 #define DRIVER_DESC "Mediatek SoC DRM"
34 #define DRIVER_DATE "20150513"
35 #define DRIVER_MAJOR 1
36 #define DRIVER_MINOR 0
38 static const struct drm_mode_config_helper_funcs mtk_drm_mode_config_helpers = {
39 .atomic_commit_tail = drm_atomic_helper_commit_tail_rpm,
42 static struct drm_framebuffer *
43 mtk_drm_mode_fb_create(struct drm_device *dev,
44 struct drm_file *file,
45 const struct drm_mode_fb_cmd2 *cmd)
47 const struct drm_format_info *info = drm_get_format_info(dev, cmd);
49 if (info->num_planes != 1)
50 return ERR_PTR(-EINVAL);
52 return drm_gem_fb_create(dev, file, cmd);
55 static const struct drm_mode_config_funcs mtk_drm_mode_config_funcs = {
56 .fb_create = mtk_drm_mode_fb_create,
57 .atomic_check = drm_atomic_helper_check,
58 .atomic_commit = drm_atomic_helper_commit,
61 static const enum mtk_ddp_comp_id mt2701_mtk_ddp_main[] = {
69 static const enum mtk_ddp_comp_id mt2701_mtk_ddp_ext[] = {
74 static const enum mtk_ddp_comp_id mt7623_mtk_ddp_main[] = {
82 static const enum mtk_ddp_comp_id mt7623_mtk_ddp_ext[] = {
87 static const enum mtk_ddp_comp_id mt2712_mtk_ddp_main[] = {
97 static const enum mtk_ddp_comp_id mt2712_mtk_ddp_ext[] = {
107 static const enum mtk_ddp_comp_id mt2712_mtk_ddp_third[] = {
113 static enum mtk_ddp_comp_id mt8167_mtk_ddp_main[] = {
115 DDP_COMPONENT_COLOR0,
119 DDP_COMPONENT_DITHER,
124 static const enum mtk_ddp_comp_id mt8173_mtk_ddp_main[] = {
126 DDP_COMPONENT_COLOR0,
135 static const enum mtk_ddp_comp_id mt8173_mtk_ddp_ext[] = {
137 DDP_COMPONENT_COLOR1,
143 static const enum mtk_ddp_comp_id mt8183_mtk_ddp_main[] = {
145 DDP_COMPONENT_OVL_2L0,
147 DDP_COMPONENT_COLOR0,
151 DDP_COMPONENT_DITHER,
155 static const enum mtk_ddp_comp_id mt8183_mtk_ddp_ext[] = {
156 DDP_COMPONENT_OVL_2L1,
161 static const struct mtk_mmsys_driver_data mt2701_mmsys_driver_data = {
162 .main_path = mt2701_mtk_ddp_main,
163 .main_len = ARRAY_SIZE(mt2701_mtk_ddp_main),
164 .ext_path = mt2701_mtk_ddp_ext,
165 .ext_len = ARRAY_SIZE(mt2701_mtk_ddp_ext),
166 .shadow_register = true,
169 static const struct mtk_mmsys_driver_data mt7623_mmsys_driver_data = {
170 .main_path = mt7623_mtk_ddp_main,
171 .main_len = ARRAY_SIZE(mt7623_mtk_ddp_main),
172 .ext_path = mt7623_mtk_ddp_ext,
173 .ext_len = ARRAY_SIZE(mt7623_mtk_ddp_ext),
174 .shadow_register = true,
177 static const struct mtk_mmsys_driver_data mt2712_mmsys_driver_data = {
178 .main_path = mt2712_mtk_ddp_main,
179 .main_len = ARRAY_SIZE(mt2712_mtk_ddp_main),
180 .ext_path = mt2712_mtk_ddp_ext,
181 .ext_len = ARRAY_SIZE(mt2712_mtk_ddp_ext),
182 .third_path = mt2712_mtk_ddp_third,
183 .third_len = ARRAY_SIZE(mt2712_mtk_ddp_third),
186 static const struct mtk_mmsys_driver_data mt8167_mmsys_driver_data = {
187 .main_path = mt8167_mtk_ddp_main,
188 .main_len = ARRAY_SIZE(mt8167_mtk_ddp_main),
191 static const struct mtk_mmsys_driver_data mt8173_mmsys_driver_data = {
192 .main_path = mt8173_mtk_ddp_main,
193 .main_len = ARRAY_SIZE(mt8173_mtk_ddp_main),
194 .ext_path = mt8173_mtk_ddp_ext,
195 .ext_len = ARRAY_SIZE(mt8173_mtk_ddp_ext),
198 static const struct mtk_mmsys_driver_data mt8183_mmsys_driver_data = {
199 .main_path = mt8183_mtk_ddp_main,
200 .main_len = ARRAY_SIZE(mt8183_mtk_ddp_main),
201 .ext_path = mt8183_mtk_ddp_ext,
202 .ext_len = ARRAY_SIZE(mt8183_mtk_ddp_ext),
205 static int mtk_drm_kms_init(struct drm_device *drm)
207 struct mtk_drm_private *private = drm->dev_private;
208 struct platform_device *pdev;
209 struct device_node *np;
210 struct device *dma_dev;
213 if (!iommu_present(&platform_bus_type))
214 return -EPROBE_DEFER;
216 pdev = of_find_device_by_node(private->mutex_node);
218 dev_err(drm->dev, "Waiting for disp-mutex device %pOF\n",
219 private->mutex_node);
220 of_node_put(private->mutex_node);
221 return -EPROBE_DEFER;
223 private->mutex_dev = &pdev->dev;
225 ret = drmm_mode_config_init(drm);
229 drm->mode_config.min_width = 64;
230 drm->mode_config.min_height = 64;
233 * set max width and height as default value(4096x4096).
234 * this value would be used to check framebuffer size limitation
235 * at drm_mode_addfb().
237 drm->mode_config.max_width = 4096;
238 drm->mode_config.max_height = 4096;
239 drm->mode_config.funcs = &mtk_drm_mode_config_funcs;
240 drm->mode_config.helper_private = &mtk_drm_mode_config_helpers;
242 ret = component_bind_all(drm->dev, drm);
247 * We currently support two fixed data streams, each optional,
248 * and each statically assigned to a crtc:
249 * OVL0 -> COLOR0 -> AAL -> OD -> RDMA0 -> UFOE -> DSI0 ...
251 ret = mtk_drm_crtc_create(drm, private->data->main_path,
252 private->data->main_len);
254 goto err_component_unbind;
255 /* ... and OVL1 -> COLOR1 -> GAMMA -> RDMA1 -> DPI0. */
256 ret = mtk_drm_crtc_create(drm, private->data->ext_path,
257 private->data->ext_len);
259 goto err_component_unbind;
261 ret = mtk_drm_crtc_create(drm, private->data->third_path,
262 private->data->third_len);
264 goto err_component_unbind;
266 /* Use OVL device for all DMA memory allocations */
267 np = private->comp_node[private->data->main_path[0]] ?:
268 private->comp_node[private->data->ext_path[0]];
269 pdev = of_find_device_by_node(np);
272 dev_err(drm->dev, "Need at least one OVL device\n");
273 goto err_component_unbind;
276 dma_dev = &pdev->dev;
277 private->dma_dev = dma_dev;
280 * Configure the DMA segment size to make sure we get contiguous IOVA
281 * when importing PRIME buffers.
283 ret = dma_set_max_seg_size(dma_dev, UINT_MAX);
285 dev_err(dma_dev, "Failed to set DMA segment size\n");
286 goto err_component_unbind;
290 * We don't use the drm_irq_install() helpers provided by the DRM
291 * core, so we need to set this manually in order to allow the
292 * DRM_IOCTL_WAIT_VBLANK to operate correctly.
294 drm->irq_enabled = true;
295 ret = drm_vblank_init(drm, MAX_CRTC);
297 goto err_component_unbind;
299 drm_kms_helper_poll_init(drm);
300 drm_mode_config_reset(drm);
304 err_component_unbind:
305 component_unbind_all(drm->dev, drm);
307 put_device(private->mutex_dev);
311 static void mtk_drm_kms_deinit(struct drm_device *drm)
313 drm_kms_helper_poll_fini(drm);
314 drm_atomic_helper_shutdown(drm);
316 component_unbind_all(drm->dev, drm);
319 DEFINE_DRM_GEM_FOPS(mtk_drm_fops);
322 * We need to override this because the device used to import the memory is
323 * not dev->dev, as drm_gem_prime_import() expects.
325 static struct drm_gem_object *mtk_drm_gem_prime_import(struct drm_device *dev,
326 struct dma_buf *dma_buf)
328 struct mtk_drm_private *private = dev->dev_private;
330 return drm_gem_prime_import_dev(dev, dma_buf, private->dma_dev);
333 static const struct drm_driver mtk_drm_driver = {
334 .driver_features = DRIVER_MODESET | DRIVER_GEM | DRIVER_ATOMIC,
336 .dumb_create = mtk_drm_gem_dumb_create,
338 .prime_handle_to_fd = drm_gem_prime_handle_to_fd,
339 .prime_fd_to_handle = drm_gem_prime_fd_to_handle,
340 .gem_prime_import = mtk_drm_gem_prime_import,
341 .gem_prime_import_sg_table = mtk_gem_prime_import_sg_table,
342 .gem_prime_mmap = drm_gem_prime_mmap,
343 .fops = &mtk_drm_fops,
348 .major = DRIVER_MAJOR,
349 .minor = DRIVER_MINOR,
352 static int compare_of(struct device *dev, void *data)
354 return dev->of_node == data;
357 static int mtk_drm_bind(struct device *dev)
359 struct mtk_drm_private *private = dev_get_drvdata(dev);
360 struct drm_device *drm;
363 drm = drm_dev_alloc(&mtk_drm_driver, dev);
367 drm->dev_private = private;
370 ret = mtk_drm_kms_init(drm);
374 ret = drm_dev_register(drm, 0);
378 drm_fbdev_generic_setup(drm, 32);
383 mtk_drm_kms_deinit(drm);
389 static void mtk_drm_unbind(struct device *dev)
391 struct mtk_drm_private *private = dev_get_drvdata(dev);
393 drm_dev_unregister(private->drm);
394 mtk_drm_kms_deinit(private->drm);
395 drm_dev_put(private->drm);
396 private->num_pipes = 0;
400 static const struct component_master_ops mtk_drm_ops = {
401 .bind = mtk_drm_bind,
402 .unbind = mtk_drm_unbind,
405 static const struct of_device_id mtk_ddp_comp_dt_ids[] = {
406 { .compatible = "mediatek,mt2701-disp-ovl",
407 .data = (void *)MTK_DISP_OVL },
408 { .compatible = "mediatek,mt8167-disp-ovl",
409 .data = (void *)MTK_DISP_OVL },
410 { .compatible = "mediatek,mt8173-disp-ovl",
411 .data = (void *)MTK_DISP_OVL },
412 { .compatible = "mediatek,mt8183-disp-ovl",
413 .data = (void *)MTK_DISP_OVL },
414 { .compatible = "mediatek,mt8183-disp-ovl-2l",
415 .data = (void *)MTK_DISP_OVL_2L },
416 { .compatible = "mediatek,mt2701-disp-rdma",
417 .data = (void *)MTK_DISP_RDMA },
418 { .compatible = "mediatek,mt8167-disp-rdma",
419 .data = (void *)MTK_DISP_RDMA },
420 { .compatible = "mediatek,mt8173-disp-rdma",
421 .data = (void *)MTK_DISP_RDMA },
422 { .compatible = "mediatek,mt8183-disp-rdma",
423 .data = (void *)MTK_DISP_RDMA },
424 { .compatible = "mediatek,mt8173-disp-wdma",
425 .data = (void *)MTK_DISP_WDMA },
426 { .compatible = "mediatek,mt8167-disp-ccorr",
427 .data = (void *)MTK_DISP_CCORR },
428 { .compatible = "mediatek,mt8183-disp-ccorr",
429 .data = (void *)MTK_DISP_CCORR },
430 { .compatible = "mediatek,mt2701-disp-color",
431 .data = (void *)MTK_DISP_COLOR },
432 { .compatible = "mediatek,mt8167-disp-color",
433 .data = (void *)MTK_DISP_COLOR },
434 { .compatible = "mediatek,mt8173-disp-color",
435 .data = (void *)MTK_DISP_COLOR },
436 { .compatible = "mediatek,mt8167-disp-aal",
437 .data = (void *)MTK_DISP_AAL},
438 { .compatible = "mediatek,mt8173-disp-aal",
439 .data = (void *)MTK_DISP_AAL},
440 { .compatible = "mediatek,mt8183-disp-aal",
441 .data = (void *)MTK_DISP_AAL},
442 { .compatible = "mediatek,mt8167-disp-gamma",
443 .data = (void *)MTK_DISP_GAMMA, },
444 { .compatible = "mediatek,mt8173-disp-gamma",
445 .data = (void *)MTK_DISP_GAMMA, },
446 { .compatible = "mediatek,mt8183-disp-gamma",
447 .data = (void *)MTK_DISP_GAMMA, },
448 { .compatible = "mediatek,mt8167-disp-dither",
449 .data = (void *)MTK_DISP_DITHER },
450 { .compatible = "mediatek,mt8183-disp-dither",
451 .data = (void *)MTK_DISP_DITHER },
452 { .compatible = "mediatek,mt8173-disp-ufoe",
453 .data = (void *)MTK_DISP_UFOE },
454 { .compatible = "mediatek,mt2701-dsi",
455 .data = (void *)MTK_DSI },
456 { .compatible = "mediatek,mt8167-dsi",
457 .data = (void *)MTK_DSI },
458 { .compatible = "mediatek,mt8173-dsi",
459 .data = (void *)MTK_DSI },
460 { .compatible = "mediatek,mt8183-dsi",
461 .data = (void *)MTK_DSI },
462 { .compatible = "mediatek,mt2701-dpi",
463 .data = (void *)MTK_DPI },
464 { .compatible = "mediatek,mt8173-dpi",
465 .data = (void *)MTK_DPI },
466 { .compatible = "mediatek,mt8183-dpi",
467 .data = (void *)MTK_DPI },
468 { .compatible = "mediatek,mt2701-disp-mutex",
469 .data = (void *)MTK_DISP_MUTEX },
470 { .compatible = "mediatek,mt2712-disp-mutex",
471 .data = (void *)MTK_DISP_MUTEX },
472 { .compatible = "mediatek,mt8167-disp-mutex",
473 .data = (void *)MTK_DISP_MUTEX },
474 { .compatible = "mediatek,mt8173-disp-mutex",
475 .data = (void *)MTK_DISP_MUTEX },
476 { .compatible = "mediatek,mt8183-disp-mutex",
477 .data = (void *)MTK_DISP_MUTEX },
478 { .compatible = "mediatek,mt2701-disp-pwm",
479 .data = (void *)MTK_DISP_BLS },
480 { .compatible = "mediatek,mt8167-disp-pwm",
481 .data = (void *)MTK_DISP_PWM },
482 { .compatible = "mediatek,mt8173-disp-pwm",
483 .data = (void *)MTK_DISP_PWM },
484 { .compatible = "mediatek,mt8173-disp-od",
485 .data = (void *)MTK_DISP_OD },
489 static const struct of_device_id mtk_drm_of_ids[] = {
490 { .compatible = "mediatek,mt2701-mmsys",
491 .data = &mt2701_mmsys_driver_data},
492 { .compatible = "mediatek,mt7623-mmsys",
493 .data = &mt7623_mmsys_driver_data},
494 { .compatible = "mediatek,mt2712-mmsys",
495 .data = &mt2712_mmsys_driver_data},
496 { .compatible = "mediatek,mt8167-mmsys",
497 .data = &mt8167_mmsys_driver_data},
498 { .compatible = "mediatek,mt8173-mmsys",
499 .data = &mt8173_mmsys_driver_data},
500 { .compatible = "mediatek,mt8183-mmsys",
501 .data = &mt8183_mmsys_driver_data},
504 MODULE_DEVICE_TABLE(of, mtk_drm_of_ids);
506 static int mtk_drm_probe(struct platform_device *pdev)
508 struct device *dev = &pdev->dev;
509 struct device_node *phandle = dev->parent->of_node;
510 const struct of_device_id *of_id;
511 struct mtk_drm_private *private;
512 struct device_node *node;
513 struct component_match *match = NULL;
517 private = devm_kzalloc(dev, sizeof(*private), GFP_KERNEL);
521 private->mmsys_dev = dev->parent;
522 if (!private->mmsys_dev) {
523 dev_err(dev, "Failed to get MMSYS device\n");
527 of_id = of_match_node(mtk_drm_of_ids, phandle);
531 private->data = of_id->data;
533 /* Iterate over sibling DISP function blocks */
534 for_each_child_of_node(phandle->parent, node) {
535 const struct of_device_id *of_id;
536 enum mtk_ddp_comp_type comp_type;
539 of_id = of_match_node(mtk_ddp_comp_dt_ids, node);
543 if (!of_device_is_available(node)) {
544 dev_dbg(dev, "Skipping disabled component %pOF\n",
549 comp_type = (enum mtk_ddp_comp_type)of_id->data;
551 if (comp_type == MTK_DISP_MUTEX) {
552 private->mutex_node = of_node_get(node);
556 comp_id = mtk_ddp_comp_get_id(node, comp_type);
558 dev_warn(dev, "Skipping unknown component %pOF\n",
563 private->comp_node[comp_id] = of_node_get(node);
566 * Currently only the AAL, CCORR, COLOR, GAMMA, OVL, RDMA, DSI, and DPI
567 * blocks have separate component platform drivers and initialize their own
568 * DDP component structure. The others are initialized here.
570 if (comp_type == MTK_DISP_AAL ||
571 comp_type == MTK_DISP_CCORR ||
572 comp_type == MTK_DISP_COLOR ||
573 comp_type == MTK_DISP_GAMMA ||
574 comp_type == MTK_DISP_OVL ||
575 comp_type == MTK_DISP_OVL_2L ||
576 comp_type == MTK_DISP_RDMA ||
577 comp_type == MTK_DSI ||
578 comp_type == MTK_DPI) {
579 dev_info(dev, "Adding component match for %pOF\n",
581 drm_of_component_match_add(dev, &match, compare_of,
585 ret = mtk_ddp_comp_init(node, &private->ddp_comp[comp_id], comp_id);
592 if (!private->mutex_node) {
593 dev_err(dev, "Failed to find disp-mutex node\n");
598 pm_runtime_enable(dev);
600 platform_set_drvdata(pdev, private);
602 ret = component_master_add_with_match(dev, &mtk_drm_ops, match);
609 pm_runtime_disable(dev);
611 of_node_put(private->mutex_node);
612 for (i = 0; i < DDP_COMPONENT_ID_MAX; i++) {
613 of_node_put(private->comp_node[i]);
614 if (private->ddp_comp[i].larb_dev)
615 put_device(private->ddp_comp[i].larb_dev);
620 static int mtk_drm_remove(struct platform_device *pdev)
622 struct mtk_drm_private *private = platform_get_drvdata(pdev);
625 component_master_del(&pdev->dev, &mtk_drm_ops);
626 pm_runtime_disable(&pdev->dev);
627 of_node_put(private->mutex_node);
628 for (i = 0; i < DDP_COMPONENT_ID_MAX; i++)
629 of_node_put(private->comp_node[i]);
634 #ifdef CONFIG_PM_SLEEP
635 static int mtk_drm_sys_suspend(struct device *dev)
637 struct mtk_drm_private *private = dev_get_drvdata(dev);
638 struct drm_device *drm = private->drm;
641 ret = drm_mode_config_helper_suspend(drm);
646 static int mtk_drm_sys_resume(struct device *dev)
648 struct mtk_drm_private *private = dev_get_drvdata(dev);
649 struct drm_device *drm = private->drm;
652 ret = drm_mode_config_helper_resume(drm);
658 static SIMPLE_DEV_PM_OPS(mtk_drm_pm_ops, mtk_drm_sys_suspend,
661 static struct platform_driver mtk_drm_platform_driver = {
662 .probe = mtk_drm_probe,
663 .remove = mtk_drm_remove,
665 .name = "mediatek-drm",
666 .pm = &mtk_drm_pm_ops,
670 static struct platform_driver * const mtk_drm_drivers[] = {
671 &mtk_disp_aal_driver,
672 &mtk_disp_ccorr_driver,
673 &mtk_disp_color_driver,
674 &mtk_disp_gamma_driver,
675 &mtk_disp_ovl_driver,
676 &mtk_disp_rdma_driver,
678 &mtk_drm_platform_driver,
682 static int __init mtk_drm_init(void)
684 return platform_register_drivers(mtk_drm_drivers,
685 ARRAY_SIZE(mtk_drm_drivers));
688 static void __exit mtk_drm_exit(void)
690 platform_unregister_drivers(mtk_drm_drivers,
691 ARRAY_SIZE(mtk_drm_drivers));
694 module_init(mtk_drm_init);
695 module_exit(mtk_drm_exit);
697 MODULE_AUTHOR("YT SHEN <yt.shen@mediatek.com>");
698 MODULE_DESCRIPTION("Mediatek SoC DRM driver");
699 MODULE_LICENSE("GPL v2");