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_wait_for_fences(struct drm_atomic_state *state)
43 struct drm_plane *plane;
44 struct drm_plane_state *new_plane_state;
47 for_each_new_plane_in_state(state, plane, new_plane_state, i)
48 mtk_fb_wait(new_plane_state->fb);
51 static void mtk_atomic_complete(struct mtk_drm_private *private,
52 struct drm_atomic_state *state)
54 struct drm_device *drm = private->drm;
56 mtk_atomic_wait_for_fences(state);
59 * Mediatek drm supports runtime PM, so plane registers cannot be
60 * written when their crtc is disabled.
62 * The comment for drm_atomic_helper_commit states:
63 * For drivers supporting runtime PM the recommended sequence is
65 * drm_atomic_helper_commit_modeset_disables(dev, state);
66 * drm_atomic_helper_commit_modeset_enables(dev, state);
67 * drm_atomic_helper_commit_planes(dev, state,
68 * DRM_PLANE_COMMIT_ACTIVE_ONLY);
70 * See the kerneldoc entries for these three functions for more details.
72 drm_atomic_helper_commit_modeset_disables(drm, state);
73 drm_atomic_helper_commit_modeset_enables(drm, state);
74 drm_atomic_helper_commit_planes(drm, state,
75 DRM_PLANE_COMMIT_ACTIVE_ONLY);
77 drm_atomic_helper_wait_for_vblanks(drm, state);
79 drm_atomic_helper_cleanup_planes(drm, state);
80 drm_atomic_state_put(state);
83 static void mtk_atomic_work(struct work_struct *work)
85 struct mtk_drm_private *private = container_of(work,
86 struct mtk_drm_private, commit.work);
88 mtk_atomic_complete(private, private->commit.state);
91 static int mtk_atomic_commit(struct drm_device *drm,
92 struct drm_atomic_state *state,
95 struct mtk_drm_private *private = drm->dev_private;
98 ret = drm_atomic_helper_prepare_planes(drm, state);
102 mutex_lock(&private->commit.lock);
103 flush_work(&private->commit.work);
105 ret = drm_atomic_helper_swap_state(state, true);
107 mutex_unlock(&private->commit.lock);
108 drm_atomic_helper_cleanup_planes(drm, state);
112 drm_atomic_state_get(state);
114 mtk_atomic_schedule(private, state);
116 mtk_atomic_complete(private, state);
118 mutex_unlock(&private->commit.lock);
123 static const struct drm_mode_config_funcs mtk_drm_mode_config_funcs = {
124 .fb_create = mtk_drm_mode_fb_create,
125 .atomic_check = drm_atomic_helper_check,
126 .atomic_commit = mtk_atomic_commit,
129 static const enum mtk_ddp_comp_id mt2701_mtk_ddp_main[] = {
132 DDP_COMPONENT_COLOR0,
137 static const enum mtk_ddp_comp_id mt2701_mtk_ddp_ext[] = {
142 static const enum mtk_ddp_comp_id mt2712_mtk_ddp_main[] = {
144 DDP_COMPONENT_COLOR0,
152 static const enum mtk_ddp_comp_id mt2712_mtk_ddp_ext[] = {
154 DDP_COMPONENT_COLOR1,
162 static const enum mtk_ddp_comp_id mt2712_mtk_ddp_third[] = {
168 static const enum mtk_ddp_comp_id mt8173_mtk_ddp_main[] = {
170 DDP_COMPONENT_COLOR0,
179 static const enum mtk_ddp_comp_id mt8173_mtk_ddp_ext[] = {
181 DDP_COMPONENT_COLOR1,
187 static const struct mtk_mmsys_driver_data mt2701_mmsys_driver_data = {
188 .main_path = mt2701_mtk_ddp_main,
189 .main_len = ARRAY_SIZE(mt2701_mtk_ddp_main),
190 .ext_path = mt2701_mtk_ddp_ext,
191 .ext_len = ARRAY_SIZE(mt2701_mtk_ddp_ext),
192 .shadow_register = true,
195 static const struct mtk_mmsys_driver_data mt2712_mmsys_driver_data = {
196 .main_path = mt2712_mtk_ddp_main,
197 .main_len = ARRAY_SIZE(mt2712_mtk_ddp_main),
198 .ext_path = mt2712_mtk_ddp_ext,
199 .ext_len = ARRAY_SIZE(mt2712_mtk_ddp_ext),
200 .third_path = mt2712_mtk_ddp_third,
201 .third_len = ARRAY_SIZE(mt2712_mtk_ddp_third),
204 static const struct mtk_mmsys_driver_data mt8173_mmsys_driver_data = {
205 .main_path = mt8173_mtk_ddp_main,
206 .main_len = ARRAY_SIZE(mt8173_mtk_ddp_main),
207 .ext_path = mt8173_mtk_ddp_ext,
208 .ext_len = ARRAY_SIZE(mt8173_mtk_ddp_ext),
211 static int mtk_drm_kms_init(struct drm_device *drm)
213 struct mtk_drm_private *private = drm->dev_private;
214 struct platform_device *pdev;
215 struct device_node *np;
218 if (!iommu_present(&platform_bus_type))
219 return -EPROBE_DEFER;
221 pdev = of_find_device_by_node(private->mutex_node);
223 dev_err(drm->dev, "Waiting for disp-mutex device %pOF\n",
224 private->mutex_node);
225 of_node_put(private->mutex_node);
226 return -EPROBE_DEFER;
228 private->mutex_dev = &pdev->dev;
230 drm_mode_config_init(drm);
232 drm->mode_config.min_width = 64;
233 drm->mode_config.min_height = 64;
236 * set max width and height as default value(4096x4096).
237 * this value would be used to check framebuffer size limitation
238 * at drm_mode_addfb().
240 drm->mode_config.max_width = 4096;
241 drm->mode_config.max_height = 4096;
242 drm->mode_config.funcs = &mtk_drm_mode_config_funcs;
244 ret = component_bind_all(drm->dev, drm);
246 goto err_config_cleanup;
249 * We currently support two fixed data streams, each optional,
250 * and each statically assigned to a crtc:
251 * OVL0 -> COLOR0 -> AAL -> OD -> RDMA0 -> UFOE -> DSI0 ...
253 ret = mtk_drm_crtc_create(drm, private->data->main_path,
254 private->data->main_len);
256 goto err_component_unbind;
257 /* ... and OVL1 -> COLOR1 -> GAMMA -> RDMA1 -> DPI0. */
258 ret = mtk_drm_crtc_create(drm, private->data->ext_path,
259 private->data->ext_len);
261 goto err_component_unbind;
263 ret = mtk_drm_crtc_create(drm, private->data->third_path,
264 private->data->third_len);
266 goto err_component_unbind;
268 /* Use OVL device for all DMA memory allocations */
269 np = private->comp_node[private->data->main_path[0]] ?:
270 private->comp_node[private->data->ext_path[0]];
271 pdev = of_find_device_by_node(np);
274 dev_err(drm->dev, "Need at least one OVL device\n");
275 goto err_component_unbind;
278 private->dma_dev = &pdev->dev;
281 * We don't use the drm_irq_install() helpers provided by the DRM
282 * core, so we need to set this manually in order to allow the
283 * DRM_IOCTL_WAIT_VBLANK to operate correctly.
285 drm->irq_enabled = true;
286 ret = drm_vblank_init(drm, MAX_CRTC);
288 goto err_component_unbind;
290 drm_kms_helper_poll_init(drm);
291 drm_mode_config_reset(drm);
295 err_component_unbind:
296 component_unbind_all(drm->dev, drm);
298 drm_mode_config_cleanup(drm);
303 static void mtk_drm_kms_deinit(struct drm_device *drm)
305 drm_kms_helper_poll_fini(drm);
306 drm_atomic_helper_shutdown(drm);
308 component_unbind_all(drm->dev, drm);
309 drm_mode_config_cleanup(drm);
312 static const struct file_operations mtk_drm_fops = {
313 .owner = THIS_MODULE,
315 .release = drm_release,
316 .unlocked_ioctl = drm_ioctl,
317 .mmap = mtk_drm_gem_mmap,
320 .compat_ioctl = drm_compat_ioctl,
323 static struct drm_driver mtk_drm_driver = {
324 .driver_features = DRIVER_MODESET | DRIVER_GEM | DRIVER_PRIME |
327 .gem_free_object_unlocked = mtk_drm_gem_free_object,
328 .gem_vm_ops = &drm_gem_cma_vm_ops,
329 .dumb_create = mtk_drm_gem_dumb_create,
331 .prime_handle_to_fd = drm_gem_prime_handle_to_fd,
332 .prime_fd_to_handle = drm_gem_prime_fd_to_handle,
333 .gem_prime_export = drm_gem_prime_export,
334 .gem_prime_import = drm_gem_prime_import,
335 .gem_prime_get_sg_table = mtk_gem_prime_get_sg_table,
336 .gem_prime_import_sg_table = mtk_gem_prime_import_sg_table,
337 .gem_prime_mmap = mtk_drm_gem_mmap_buf,
338 .gem_prime_vmap = mtk_drm_gem_prime_vmap,
339 .gem_prime_vunmap = mtk_drm_gem_prime_vunmap,
340 .fops = &mtk_drm_fops,
345 .major = DRIVER_MAJOR,
346 .minor = DRIVER_MINOR,
349 static int compare_of(struct device *dev, void *data)
351 return dev->of_node == data;
354 static int mtk_drm_bind(struct device *dev)
356 struct mtk_drm_private *private = dev_get_drvdata(dev);
357 struct drm_device *drm;
360 drm = drm_dev_alloc(&mtk_drm_driver, dev);
364 drm->dev_private = private;
367 ret = mtk_drm_kms_init(drm);
371 ret = drm_dev_register(drm, 0);
375 ret = drm_fbdev_generic_setup(drm, 32);
377 DRM_ERROR("Failed to initialize fbdev: %d\n", ret);
382 mtk_drm_kms_deinit(drm);
388 static void mtk_drm_unbind(struct device *dev)
390 struct mtk_drm_private *private = dev_get_drvdata(dev);
392 drm_dev_unregister(private->drm);
393 mtk_drm_kms_deinit(private->drm);
394 drm_dev_put(private->drm);
395 private->num_pipes = 0;
399 static const struct component_master_ops mtk_drm_ops = {
400 .bind = mtk_drm_bind,
401 .unbind = mtk_drm_unbind,
404 static const struct of_device_id mtk_ddp_comp_dt_ids[] = {
405 { .compatible = "mediatek,mt2701-disp-ovl",
406 .data = (void *)MTK_DISP_OVL },
407 { .compatible = "mediatek,mt8173-disp-ovl",
408 .data = (void *)MTK_DISP_OVL },
409 { .compatible = "mediatek,mt2701-disp-rdma",
410 .data = (void *)MTK_DISP_RDMA },
411 { .compatible = "mediatek,mt8173-disp-rdma",
412 .data = (void *)MTK_DISP_RDMA },
413 { .compatible = "mediatek,mt8173-disp-wdma",
414 .data = (void *)MTK_DISP_WDMA },
415 { .compatible = "mediatek,mt2701-disp-color",
416 .data = (void *)MTK_DISP_COLOR },
417 { .compatible = "mediatek,mt8173-disp-color",
418 .data = (void *)MTK_DISP_COLOR },
419 { .compatible = "mediatek,mt8173-disp-aal",
420 .data = (void *)MTK_DISP_AAL},
421 { .compatible = "mediatek,mt8173-disp-gamma",
422 .data = (void *)MTK_DISP_GAMMA, },
423 { .compatible = "mediatek,mt8173-disp-ufoe",
424 .data = (void *)MTK_DISP_UFOE },
425 { .compatible = "mediatek,mt2701-dsi",
426 .data = (void *)MTK_DSI },
427 { .compatible = "mediatek,mt8173-dsi",
428 .data = (void *)MTK_DSI },
429 { .compatible = "mediatek,mt2701-dpi",
430 .data = (void *)MTK_DPI },
431 { .compatible = "mediatek,mt8173-dpi",
432 .data = (void *)MTK_DPI },
433 { .compatible = "mediatek,mt2701-disp-mutex",
434 .data = (void *)MTK_DISP_MUTEX },
435 { .compatible = "mediatek,mt2712-disp-mutex",
436 .data = (void *)MTK_DISP_MUTEX },
437 { .compatible = "mediatek,mt8173-disp-mutex",
438 .data = (void *)MTK_DISP_MUTEX },
439 { .compatible = "mediatek,mt2701-disp-pwm",
440 .data = (void *)MTK_DISP_BLS },
441 { .compatible = "mediatek,mt8173-disp-pwm",
442 .data = (void *)MTK_DISP_PWM },
443 { .compatible = "mediatek,mt8173-disp-od",
444 .data = (void *)MTK_DISP_OD },
448 static int mtk_drm_probe(struct platform_device *pdev)
450 struct device *dev = &pdev->dev;
451 struct mtk_drm_private *private;
452 struct resource *mem;
453 struct device_node *node;
454 struct component_match *match = NULL;
458 private = devm_kzalloc(dev, sizeof(*private), GFP_KERNEL);
462 mutex_init(&private->commit.lock);
463 INIT_WORK(&private->commit.work, mtk_atomic_work);
464 private->data = of_device_get_match_data(dev);
466 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
467 private->config_regs = devm_ioremap_resource(dev, mem);
468 if (IS_ERR(private->config_regs)) {
469 ret = PTR_ERR(private->config_regs);
470 dev_err(dev, "Failed to ioremap mmsys-config resource: %d\n",
475 /* Iterate over sibling DISP function blocks */
476 for_each_child_of_node(dev->of_node->parent, node) {
477 const struct of_device_id *of_id;
478 enum mtk_ddp_comp_type comp_type;
481 of_id = of_match_node(mtk_ddp_comp_dt_ids, node);
485 if (!of_device_is_available(node)) {
486 dev_dbg(dev, "Skipping disabled component %pOF\n",
491 comp_type = (enum mtk_ddp_comp_type)of_id->data;
493 if (comp_type == MTK_DISP_MUTEX) {
494 private->mutex_node = of_node_get(node);
498 comp_id = mtk_ddp_comp_get_id(node, comp_type);
500 dev_warn(dev, "Skipping unknown component %pOF\n",
505 private->comp_node[comp_id] = of_node_get(node);
508 * Currently only the COLOR, OVL, RDMA, DSI, and DPI blocks have
509 * separate component platform drivers and initialize their own
510 * DDP component structure. The others are initialized here.
512 if (comp_type == MTK_DISP_COLOR ||
513 comp_type == MTK_DISP_OVL ||
514 comp_type == MTK_DISP_RDMA ||
515 comp_type == MTK_DSI ||
516 comp_type == MTK_DPI) {
517 dev_info(dev, "Adding component match for %pOF\n",
519 drm_of_component_match_add(dev, &match, compare_of,
522 struct mtk_ddp_comp *comp;
524 comp = devm_kzalloc(dev, sizeof(*comp), GFP_KERNEL);
530 ret = mtk_ddp_comp_init(dev, node, comp, comp_id, NULL);
534 private->ddp_comp[comp_id] = comp;
538 if (!private->mutex_node) {
539 dev_err(dev, "Failed to find disp-mutex node\n");
544 pm_runtime_enable(dev);
546 platform_set_drvdata(pdev, private);
548 ret = component_master_add_with_match(dev, &mtk_drm_ops, match);
555 pm_runtime_disable(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]);
563 static int mtk_drm_remove(struct platform_device *pdev)
565 struct mtk_drm_private *private = platform_get_drvdata(pdev);
568 component_master_del(&pdev->dev, &mtk_drm_ops);
569 pm_runtime_disable(&pdev->dev);
570 of_node_put(private->mutex_node);
571 for (i = 0; i < DDP_COMPONENT_ID_MAX; i++)
572 of_node_put(private->comp_node[i]);
577 #ifdef CONFIG_PM_SLEEP
578 static int mtk_drm_sys_suspend(struct device *dev)
580 struct mtk_drm_private *private = dev_get_drvdata(dev);
581 struct drm_device *drm = private->drm;
584 ret = drm_mode_config_helper_suspend(drm);
585 DRM_DEBUG_DRIVER("mtk_drm_sys_suspend\n");
590 static int mtk_drm_sys_resume(struct device *dev)
592 struct mtk_drm_private *private = dev_get_drvdata(dev);
593 struct drm_device *drm = private->drm;
596 ret = drm_mode_config_helper_resume(drm);
597 DRM_DEBUG_DRIVER("mtk_drm_sys_resume\n");
603 static SIMPLE_DEV_PM_OPS(mtk_drm_pm_ops, mtk_drm_sys_suspend,
606 static const struct of_device_id mtk_drm_of_ids[] = {
607 { .compatible = "mediatek,mt2701-mmsys",
608 .data = &mt2701_mmsys_driver_data},
609 { .compatible = "mediatek,mt2712-mmsys",
610 .data = &mt2712_mmsys_driver_data},
611 { .compatible = "mediatek,mt8173-mmsys",
612 .data = &mt8173_mmsys_driver_data},
616 static struct platform_driver mtk_drm_platform_driver = {
617 .probe = mtk_drm_probe,
618 .remove = mtk_drm_remove,
620 .name = "mediatek-drm",
621 .of_match_table = mtk_drm_of_ids,
622 .pm = &mtk_drm_pm_ops,
626 static struct platform_driver * const mtk_drm_drivers[] = {
628 &mtk_disp_color_driver,
629 &mtk_disp_ovl_driver,
630 &mtk_disp_rdma_driver,
632 &mtk_drm_platform_driver,
637 static int __init mtk_drm_init(void)
639 return platform_register_drivers(mtk_drm_drivers,
640 ARRAY_SIZE(mtk_drm_drivers));
643 static void __exit mtk_drm_exit(void)
645 platform_unregister_drivers(mtk_drm_drivers,
646 ARRAY_SIZE(mtk_drm_drivers));
649 module_init(mtk_drm_init);
650 module_exit(mtk_drm_exit);
652 MODULE_AUTHOR("YT SHEN <yt.shen@mediatek.com>");
653 MODULE_DESCRIPTION("Mediatek SoC DRM driver");
654 MODULE_LICENSE("GPL v2");