1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (c) 2015 MediaTek Inc.
4 * Author: YT SHEN <yt.shen@mediatek.com>
8 #include <drm/drm_atomic.h>
9 #include <drm/drm_atomic_helper.h>
10 #include <drm/drm_fb_helper.h>
11 #include <drm/drm_gem.h>
12 #include <drm/drm_gem_cma_helper.h>
13 #include <drm/drm_of.h>
14 #include <drm/drm_probe_helper.h>
15 #include <linux/component.h>
16 #include <linux/iommu.h>
17 #include <linux/of_address.h>
18 #include <linux/of_platform.h>
19 #include <linux/pm_runtime.h>
21 #include "mtk_drm_crtc.h"
22 #include "mtk_drm_ddp.h"
23 #include "mtk_drm_ddp_comp.h"
24 #include "mtk_drm_drv.h"
25 #include "mtk_drm_fb.h"
26 #include "mtk_drm_gem.h"
28 #define DRIVER_NAME "mediatek"
29 #define DRIVER_DESC "Mediatek SoC DRM"
30 #define DRIVER_DATE "20150513"
31 #define DRIVER_MAJOR 1
32 #define DRIVER_MINOR 0
34 static void mtk_atomic_schedule(struct mtk_drm_private *private,
35 struct drm_atomic_state *state)
37 private->commit.state = state;
38 schedule_work(&private->commit.work);
41 static void mtk_atomic_complete(struct mtk_drm_private *private,
42 struct drm_atomic_state *state)
44 struct drm_device *drm = private->drm;
46 drm_atomic_helper_wait_for_fences(drm, state, false);
49 * Mediatek drm supports runtime PM, so plane registers cannot be
50 * written when their crtc is disabled.
52 * The comment for drm_atomic_helper_commit states:
53 * For drivers supporting runtime PM the recommended sequence is
55 * drm_atomic_helper_commit_modeset_disables(dev, state);
56 * drm_atomic_helper_commit_modeset_enables(dev, state);
57 * drm_atomic_helper_commit_planes(dev, state,
58 * DRM_PLANE_COMMIT_ACTIVE_ONLY);
60 * See the kerneldoc entries for these three functions for more details.
62 drm_atomic_helper_commit_modeset_disables(drm, state);
63 drm_atomic_helper_commit_modeset_enables(drm, state);
64 drm_atomic_helper_commit_planes(drm, state,
65 DRM_PLANE_COMMIT_ACTIVE_ONLY);
67 drm_atomic_helper_wait_for_vblanks(drm, state);
69 drm_atomic_helper_cleanup_planes(drm, state);
70 drm_atomic_state_put(state);
73 static void mtk_atomic_work(struct work_struct *work)
75 struct mtk_drm_private *private = container_of(work,
76 struct mtk_drm_private, commit.work);
78 mtk_atomic_complete(private, private->commit.state);
81 static int mtk_atomic_commit(struct drm_device *drm,
82 struct drm_atomic_state *state,
85 struct mtk_drm_private *private = drm->dev_private;
88 ret = drm_atomic_helper_prepare_planes(drm, state);
92 mutex_lock(&private->commit.lock);
93 flush_work(&private->commit.work);
95 ret = drm_atomic_helper_swap_state(state, true);
97 mutex_unlock(&private->commit.lock);
98 drm_atomic_helper_cleanup_planes(drm, state);
102 drm_atomic_state_get(state);
104 mtk_atomic_schedule(private, state);
106 mtk_atomic_complete(private, state);
108 mutex_unlock(&private->commit.lock);
113 static const struct drm_mode_config_funcs mtk_drm_mode_config_funcs = {
114 .fb_create = mtk_drm_mode_fb_create,
115 .atomic_check = drm_atomic_helper_check,
116 .atomic_commit = mtk_atomic_commit,
119 static const enum mtk_ddp_comp_id mt2701_mtk_ddp_main[] = {
122 DDP_COMPONENT_COLOR0,
127 static const enum mtk_ddp_comp_id mt2701_mtk_ddp_ext[] = {
132 static const enum mtk_ddp_comp_id mt2712_mtk_ddp_main[] = {
134 DDP_COMPONENT_COLOR0,
142 static const enum mtk_ddp_comp_id mt2712_mtk_ddp_ext[] = {
144 DDP_COMPONENT_COLOR1,
152 static const enum mtk_ddp_comp_id mt2712_mtk_ddp_third[] = {
158 static const enum mtk_ddp_comp_id mt8173_mtk_ddp_main[] = {
160 DDP_COMPONENT_COLOR0,
169 static const enum mtk_ddp_comp_id mt8173_mtk_ddp_ext[] = {
171 DDP_COMPONENT_COLOR1,
177 static const struct mtk_mmsys_driver_data mt2701_mmsys_driver_data = {
178 .main_path = mt2701_mtk_ddp_main,
179 .main_len = ARRAY_SIZE(mt2701_mtk_ddp_main),
180 .ext_path = mt2701_mtk_ddp_ext,
181 .ext_len = ARRAY_SIZE(mt2701_mtk_ddp_ext),
182 .shadow_register = true,
185 static const struct mtk_mmsys_driver_data mt2712_mmsys_driver_data = {
186 .main_path = mt2712_mtk_ddp_main,
187 .main_len = ARRAY_SIZE(mt2712_mtk_ddp_main),
188 .ext_path = mt2712_mtk_ddp_ext,
189 .ext_len = ARRAY_SIZE(mt2712_mtk_ddp_ext),
190 .third_path = mt2712_mtk_ddp_third,
191 .third_len = ARRAY_SIZE(mt2712_mtk_ddp_third),
194 static const struct mtk_mmsys_driver_data mt8173_mmsys_driver_data = {
195 .main_path = mt8173_mtk_ddp_main,
196 .main_len = ARRAY_SIZE(mt8173_mtk_ddp_main),
197 .ext_path = mt8173_mtk_ddp_ext,
198 .ext_len = ARRAY_SIZE(mt8173_mtk_ddp_ext),
201 static int mtk_drm_kms_init(struct drm_device *drm)
203 struct mtk_drm_private *private = drm->dev_private;
204 struct platform_device *pdev;
205 struct device_node *np;
208 if (!iommu_present(&platform_bus_type))
209 return -EPROBE_DEFER;
211 pdev = of_find_device_by_node(private->mutex_node);
213 dev_err(drm->dev, "Waiting for disp-mutex device %pOF\n",
214 private->mutex_node);
215 of_node_put(private->mutex_node);
216 return -EPROBE_DEFER;
218 private->mutex_dev = &pdev->dev;
220 drm_mode_config_init(drm);
222 drm->mode_config.min_width = 64;
223 drm->mode_config.min_height = 64;
226 * set max width and height as default value(4096x4096).
227 * this value would be used to check framebuffer size limitation
228 * at drm_mode_addfb().
230 drm->mode_config.max_width = 4096;
231 drm->mode_config.max_height = 4096;
232 drm->mode_config.funcs = &mtk_drm_mode_config_funcs;
234 ret = component_bind_all(drm->dev, drm);
236 goto err_config_cleanup;
239 * We currently support two fixed data streams, each optional,
240 * and each statically assigned to a crtc:
241 * OVL0 -> COLOR0 -> AAL -> OD -> RDMA0 -> UFOE -> DSI0 ...
243 ret = mtk_drm_crtc_create(drm, private->data->main_path,
244 private->data->main_len);
246 goto err_component_unbind;
247 /* ... and OVL1 -> COLOR1 -> GAMMA -> RDMA1 -> DPI0. */
248 ret = mtk_drm_crtc_create(drm, private->data->ext_path,
249 private->data->ext_len);
251 goto err_component_unbind;
253 ret = mtk_drm_crtc_create(drm, private->data->third_path,
254 private->data->third_len);
256 goto err_component_unbind;
258 /* Use OVL device for all DMA memory allocations */
259 np = private->comp_node[private->data->main_path[0]] ?:
260 private->comp_node[private->data->ext_path[0]];
261 pdev = of_find_device_by_node(np);
264 dev_err(drm->dev, "Need at least one OVL device\n");
265 goto err_component_unbind;
268 private->dma_dev = &pdev->dev;
271 * We don't use the drm_irq_install() helpers provided by the DRM
272 * core, so we need to set this manually in order to allow the
273 * DRM_IOCTL_WAIT_VBLANK to operate correctly.
275 drm->irq_enabled = true;
276 ret = drm_vblank_init(drm, MAX_CRTC);
278 goto err_component_unbind;
280 drm_kms_helper_poll_init(drm);
281 drm_mode_config_reset(drm);
285 err_component_unbind:
286 component_unbind_all(drm->dev, drm);
288 drm_mode_config_cleanup(drm);
293 static void mtk_drm_kms_deinit(struct drm_device *drm)
295 drm_kms_helper_poll_fini(drm);
296 drm_atomic_helper_shutdown(drm);
298 component_unbind_all(drm->dev, drm);
299 drm_mode_config_cleanup(drm);
302 static const struct file_operations mtk_drm_fops = {
303 .owner = THIS_MODULE,
305 .release = drm_release,
306 .unlocked_ioctl = drm_ioctl,
307 .mmap = mtk_drm_gem_mmap,
310 .compat_ioctl = drm_compat_ioctl,
313 static struct drm_driver mtk_drm_driver = {
314 .driver_features = DRIVER_MODESET | DRIVER_GEM | DRIVER_ATOMIC,
316 .gem_free_object_unlocked = mtk_drm_gem_free_object,
317 .gem_vm_ops = &drm_gem_cma_vm_ops,
318 .dumb_create = mtk_drm_gem_dumb_create,
320 .prime_handle_to_fd = drm_gem_prime_handle_to_fd,
321 .prime_fd_to_handle = drm_gem_prime_fd_to_handle,
322 .gem_prime_get_sg_table = mtk_gem_prime_get_sg_table,
323 .gem_prime_import_sg_table = mtk_gem_prime_import_sg_table,
324 .gem_prime_mmap = mtk_drm_gem_mmap_buf,
325 .gem_prime_vmap = mtk_drm_gem_prime_vmap,
326 .gem_prime_vunmap = mtk_drm_gem_prime_vunmap,
327 .fops = &mtk_drm_fops,
332 .major = DRIVER_MAJOR,
333 .minor = DRIVER_MINOR,
336 static int compare_of(struct device *dev, void *data)
338 return dev->of_node == data;
341 static int mtk_drm_bind(struct device *dev)
343 struct mtk_drm_private *private = dev_get_drvdata(dev);
344 struct drm_device *drm;
347 drm = drm_dev_alloc(&mtk_drm_driver, dev);
351 drm->dev_private = private;
354 ret = mtk_drm_kms_init(drm);
358 ret = drm_dev_register(drm, 0);
362 ret = drm_fbdev_generic_setup(drm, 32);
364 DRM_ERROR("Failed to initialize fbdev: %d\n", ret);
369 mtk_drm_kms_deinit(drm);
375 static void mtk_drm_unbind(struct device *dev)
377 struct mtk_drm_private *private = dev_get_drvdata(dev);
379 drm_dev_unregister(private->drm);
380 mtk_drm_kms_deinit(private->drm);
381 drm_dev_put(private->drm);
382 private->num_pipes = 0;
386 static const struct component_master_ops mtk_drm_ops = {
387 .bind = mtk_drm_bind,
388 .unbind = mtk_drm_unbind,
391 static const struct of_device_id mtk_ddp_comp_dt_ids[] = {
392 { .compatible = "mediatek,mt2701-disp-ovl",
393 .data = (void *)MTK_DISP_OVL },
394 { .compatible = "mediatek,mt8173-disp-ovl",
395 .data = (void *)MTK_DISP_OVL },
396 { .compatible = "mediatek,mt2701-disp-rdma",
397 .data = (void *)MTK_DISP_RDMA },
398 { .compatible = "mediatek,mt8173-disp-rdma",
399 .data = (void *)MTK_DISP_RDMA },
400 { .compatible = "mediatek,mt8173-disp-wdma",
401 .data = (void *)MTK_DISP_WDMA },
402 { .compatible = "mediatek,mt2701-disp-color",
403 .data = (void *)MTK_DISP_COLOR },
404 { .compatible = "mediatek,mt8173-disp-color",
405 .data = (void *)MTK_DISP_COLOR },
406 { .compatible = "mediatek,mt8173-disp-aal",
407 .data = (void *)MTK_DISP_AAL},
408 { .compatible = "mediatek,mt8173-disp-gamma",
409 .data = (void *)MTK_DISP_GAMMA, },
410 { .compatible = "mediatek,mt8173-disp-ufoe",
411 .data = (void *)MTK_DISP_UFOE },
412 { .compatible = "mediatek,mt2701-dsi",
413 .data = (void *)MTK_DSI },
414 { .compatible = "mediatek,mt8173-dsi",
415 .data = (void *)MTK_DSI },
416 { .compatible = "mediatek,mt2701-dpi",
417 .data = (void *)MTK_DPI },
418 { .compatible = "mediatek,mt8173-dpi",
419 .data = (void *)MTK_DPI },
420 { .compatible = "mediatek,mt2701-disp-mutex",
421 .data = (void *)MTK_DISP_MUTEX },
422 { .compatible = "mediatek,mt2712-disp-mutex",
423 .data = (void *)MTK_DISP_MUTEX },
424 { .compatible = "mediatek,mt8173-disp-mutex",
425 .data = (void *)MTK_DISP_MUTEX },
426 { .compatible = "mediatek,mt2701-disp-pwm",
427 .data = (void *)MTK_DISP_BLS },
428 { .compatible = "mediatek,mt8173-disp-pwm",
429 .data = (void *)MTK_DISP_PWM },
430 { .compatible = "mediatek,mt8173-disp-od",
431 .data = (void *)MTK_DISP_OD },
435 static int mtk_drm_probe(struct platform_device *pdev)
437 struct device *dev = &pdev->dev;
438 struct mtk_drm_private *private;
439 struct resource *mem;
440 struct device_node *node;
441 struct component_match *match = NULL;
445 private = devm_kzalloc(dev, sizeof(*private), GFP_KERNEL);
449 mutex_init(&private->commit.lock);
450 INIT_WORK(&private->commit.work, mtk_atomic_work);
451 private->data = of_device_get_match_data(dev);
453 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
454 private->config_regs = devm_ioremap_resource(dev, mem);
455 if (IS_ERR(private->config_regs)) {
456 ret = PTR_ERR(private->config_regs);
457 dev_err(dev, "Failed to ioremap mmsys-config resource: %d\n",
462 /* Iterate over sibling DISP function blocks */
463 for_each_child_of_node(dev->of_node->parent, node) {
464 const struct of_device_id *of_id;
465 enum mtk_ddp_comp_type comp_type;
468 of_id = of_match_node(mtk_ddp_comp_dt_ids, node);
472 if (!of_device_is_available(node)) {
473 dev_dbg(dev, "Skipping disabled component %pOF\n",
478 comp_type = (enum mtk_ddp_comp_type)of_id->data;
480 if (comp_type == MTK_DISP_MUTEX) {
481 private->mutex_node = of_node_get(node);
485 comp_id = mtk_ddp_comp_get_id(node, comp_type);
487 dev_warn(dev, "Skipping unknown component %pOF\n",
492 private->comp_node[comp_id] = of_node_get(node);
495 * Currently only the COLOR, OVL, RDMA, DSI, and DPI blocks have
496 * separate component platform drivers and initialize their own
497 * DDP component structure. The others are initialized here.
499 if (comp_type == MTK_DISP_COLOR ||
500 comp_type == MTK_DISP_OVL ||
501 comp_type == MTK_DISP_RDMA ||
502 comp_type == MTK_DSI ||
503 comp_type == MTK_DPI) {
504 dev_info(dev, "Adding component match for %pOF\n",
506 drm_of_component_match_add(dev, &match, compare_of,
509 struct mtk_ddp_comp *comp;
511 comp = devm_kzalloc(dev, sizeof(*comp), GFP_KERNEL);
517 ret = mtk_ddp_comp_init(dev, node, comp, comp_id, NULL);
521 private->ddp_comp[comp_id] = comp;
525 if (!private->mutex_node) {
526 dev_err(dev, "Failed to find disp-mutex node\n");
531 pm_runtime_enable(dev);
533 platform_set_drvdata(pdev, private);
535 ret = component_master_add_with_match(dev, &mtk_drm_ops, match);
542 pm_runtime_disable(dev);
544 of_node_put(private->mutex_node);
545 for (i = 0; i < DDP_COMPONENT_ID_MAX; i++)
546 of_node_put(private->comp_node[i]);
550 static int mtk_drm_remove(struct platform_device *pdev)
552 struct mtk_drm_private *private = platform_get_drvdata(pdev);
555 component_master_del(&pdev->dev, &mtk_drm_ops);
556 pm_runtime_disable(&pdev->dev);
557 of_node_put(private->mutex_node);
558 for (i = 0; i < DDP_COMPONENT_ID_MAX; i++)
559 of_node_put(private->comp_node[i]);
564 #ifdef CONFIG_PM_SLEEP
565 static int mtk_drm_sys_suspend(struct device *dev)
567 struct mtk_drm_private *private = dev_get_drvdata(dev);
568 struct drm_device *drm = private->drm;
571 ret = drm_mode_config_helper_suspend(drm);
572 DRM_DEBUG_DRIVER("mtk_drm_sys_suspend\n");
577 static int mtk_drm_sys_resume(struct device *dev)
579 struct mtk_drm_private *private = dev_get_drvdata(dev);
580 struct drm_device *drm = private->drm;
583 ret = drm_mode_config_helper_resume(drm);
584 DRM_DEBUG_DRIVER("mtk_drm_sys_resume\n");
590 static SIMPLE_DEV_PM_OPS(mtk_drm_pm_ops, mtk_drm_sys_suspend,
593 static const struct of_device_id mtk_drm_of_ids[] = {
594 { .compatible = "mediatek,mt2701-mmsys",
595 .data = &mt2701_mmsys_driver_data},
596 { .compatible = "mediatek,mt2712-mmsys",
597 .data = &mt2712_mmsys_driver_data},
598 { .compatible = "mediatek,mt8173-mmsys",
599 .data = &mt8173_mmsys_driver_data},
603 static struct platform_driver mtk_drm_platform_driver = {
604 .probe = mtk_drm_probe,
605 .remove = mtk_drm_remove,
607 .name = "mediatek-drm",
608 .of_match_table = mtk_drm_of_ids,
609 .pm = &mtk_drm_pm_ops,
613 static struct platform_driver * const mtk_drm_drivers[] = {
615 &mtk_disp_color_driver,
616 &mtk_disp_ovl_driver,
617 &mtk_disp_rdma_driver,
619 &mtk_drm_platform_driver,
624 static int __init mtk_drm_init(void)
626 return platform_register_drivers(mtk_drm_drivers,
627 ARRAY_SIZE(mtk_drm_drivers));
630 static void __exit mtk_drm_exit(void)
632 platform_unregister_drivers(mtk_drm_drivers,
633 ARRAY_SIZE(mtk_drm_drivers));
636 module_init(mtk_drm_init);
637 module_exit(mtk_drm_exit);
639 MODULE_AUTHOR("YT SHEN <yt.shen@mediatek.com>");
640 MODULE_DESCRIPTION("Mediatek SoC DRM driver");
641 MODULE_LICENSE("GPL v2");