2 * Copyright (c) 2015 MediaTek Inc.
3 * Author: YT SHEN <yt.shen@mediatek.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
16 #include <drm/drm_atomic.h>
17 #include <drm/drm_atomic_helper.h>
18 #include <drm/drm_crtc_helper.h>
19 #include <drm/drm_gem.h>
20 #include <drm/drm_gem_cma_helper.h>
21 #include <drm/drm_of.h>
22 #include <linux/component.h>
23 #include <linux/iommu.h>
24 #include <linux/of_address.h>
25 #include <linux/of_platform.h>
26 #include <linux/pm_runtime.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_fb.h"
33 #include "mtk_drm_gem.h"
35 #define DRIVER_NAME "mediatek"
36 #define DRIVER_DESC "Mediatek SoC DRM"
37 #define DRIVER_DATE "20150513"
38 #define DRIVER_MAJOR 1
39 #define DRIVER_MINOR 0
41 static void mtk_atomic_schedule(struct mtk_drm_private *private,
42 struct drm_atomic_state *state)
44 private->commit.state = state;
45 schedule_work(&private->commit.work);
48 static void mtk_atomic_wait_for_fences(struct drm_atomic_state *state)
50 struct drm_plane *plane;
51 struct drm_plane_state *new_plane_state;
54 for_each_new_plane_in_state(state, plane, new_plane_state, i)
55 mtk_fb_wait(new_plane_state->fb);
58 static void mtk_atomic_complete(struct mtk_drm_private *private,
59 struct drm_atomic_state *state)
61 struct drm_device *drm = private->drm;
63 mtk_atomic_wait_for_fences(state);
66 * Mediatek drm supports runtime PM, so plane registers cannot be
67 * written when their crtc is disabled.
69 * The comment for drm_atomic_helper_commit states:
70 * For drivers supporting runtime PM the recommended sequence is
72 * drm_atomic_helper_commit_modeset_disables(dev, state);
73 * drm_atomic_helper_commit_modeset_enables(dev, state);
74 * drm_atomic_helper_commit_planes(dev, state,
75 * DRM_PLANE_COMMIT_ACTIVE_ONLY);
77 * See the kerneldoc entries for these three functions for more details.
79 drm_atomic_helper_commit_modeset_disables(drm, state);
80 drm_atomic_helper_commit_modeset_enables(drm, state);
81 drm_atomic_helper_commit_planes(drm, state,
82 DRM_PLANE_COMMIT_ACTIVE_ONLY);
84 drm_atomic_helper_wait_for_vblanks(drm, state);
86 drm_atomic_helper_cleanup_planes(drm, state);
87 drm_atomic_state_put(state);
90 static void mtk_atomic_work(struct work_struct *work)
92 struct mtk_drm_private *private = container_of(work,
93 struct mtk_drm_private, commit.work);
95 mtk_atomic_complete(private, private->commit.state);
98 static int mtk_atomic_commit(struct drm_device *drm,
99 struct drm_atomic_state *state,
102 struct mtk_drm_private *private = drm->dev_private;
105 ret = drm_atomic_helper_prepare_planes(drm, state);
109 mutex_lock(&private->commit.lock);
110 flush_work(&private->commit.work);
112 ret = drm_atomic_helper_swap_state(state, true);
114 mutex_unlock(&private->commit.lock);
115 drm_atomic_helper_cleanup_planes(drm, state);
119 drm_atomic_state_get(state);
121 mtk_atomic_schedule(private, state);
123 mtk_atomic_complete(private, state);
125 mutex_unlock(&private->commit.lock);
130 static const struct drm_mode_config_funcs mtk_drm_mode_config_funcs = {
131 .fb_create = mtk_drm_mode_fb_create,
132 .atomic_check = drm_atomic_helper_check,
133 .atomic_commit = mtk_atomic_commit,
136 static const enum mtk_ddp_comp_id mt2701_mtk_ddp_main[] = {
139 DDP_COMPONENT_COLOR0,
144 static const enum mtk_ddp_comp_id mt2701_mtk_ddp_ext[] = {
149 static const enum mtk_ddp_comp_id mt2712_mtk_ddp_main[] = {
151 DDP_COMPONENT_COLOR0,
159 static const enum mtk_ddp_comp_id mt2712_mtk_ddp_ext[] = {
161 DDP_COMPONENT_COLOR1,
169 static const enum mtk_ddp_comp_id mt2712_mtk_ddp_third[] = {
175 static const enum mtk_ddp_comp_id mt8173_mtk_ddp_main[] = {
177 DDP_COMPONENT_COLOR0,
186 static const enum mtk_ddp_comp_id mt8173_mtk_ddp_ext[] = {
188 DDP_COMPONENT_COLOR1,
194 static const struct mtk_mmsys_driver_data mt2701_mmsys_driver_data = {
195 .main_path = mt2701_mtk_ddp_main,
196 .main_len = ARRAY_SIZE(mt2701_mtk_ddp_main),
197 .ext_path = mt2701_mtk_ddp_ext,
198 .ext_len = ARRAY_SIZE(mt2701_mtk_ddp_ext),
199 .shadow_register = true,
202 static const struct mtk_mmsys_driver_data mt2712_mmsys_driver_data = {
203 .main_path = mt2712_mtk_ddp_main,
204 .main_len = ARRAY_SIZE(mt2712_mtk_ddp_main),
205 .ext_path = mt2712_mtk_ddp_ext,
206 .ext_len = ARRAY_SIZE(mt2712_mtk_ddp_ext),
207 .third_path = mt2712_mtk_ddp_third,
208 .third_len = ARRAY_SIZE(mt2712_mtk_ddp_third),
211 static const struct mtk_mmsys_driver_data mt8173_mmsys_driver_data = {
212 .main_path = mt8173_mtk_ddp_main,
213 .main_len = ARRAY_SIZE(mt8173_mtk_ddp_main),
214 .ext_path = mt8173_mtk_ddp_ext,
215 .ext_len = ARRAY_SIZE(mt8173_mtk_ddp_ext),
218 static int mtk_drm_kms_init(struct drm_device *drm)
220 struct mtk_drm_private *private = drm->dev_private;
221 struct platform_device *pdev;
222 struct device_node *np;
223 struct device *dma_dev;
226 if (!iommu_present(&platform_bus_type))
227 return -EPROBE_DEFER;
229 pdev = of_find_device_by_node(private->mutex_node);
231 dev_err(drm->dev, "Waiting for disp-mutex device %pOF\n",
232 private->mutex_node);
233 of_node_put(private->mutex_node);
234 return -EPROBE_DEFER;
236 private->mutex_dev = &pdev->dev;
238 drm_mode_config_init(drm);
240 drm->mode_config.min_width = 64;
241 drm->mode_config.min_height = 64;
244 * set max width and height as default value(4096x4096).
245 * this value would be used to check framebuffer size limitation
246 * at drm_mode_addfb().
248 drm->mode_config.max_width = 4096;
249 drm->mode_config.max_height = 4096;
250 drm->mode_config.funcs = &mtk_drm_mode_config_funcs;
252 ret = component_bind_all(drm->dev, drm);
254 goto err_config_cleanup;
257 * We currently support two fixed data streams, each optional,
258 * and each statically assigned to a crtc:
259 * OVL0 -> COLOR0 -> AAL -> OD -> RDMA0 -> UFOE -> DSI0 ...
261 ret = mtk_drm_crtc_create(drm, private->data->main_path,
262 private->data->main_len);
264 goto err_component_unbind;
265 /* ... and OVL1 -> COLOR1 -> GAMMA -> RDMA1 -> DPI0. */
266 ret = mtk_drm_crtc_create(drm, private->data->ext_path,
267 private->data->ext_len);
269 goto err_component_unbind;
271 ret = mtk_drm_crtc_create(drm, private->data->third_path,
272 private->data->third_len);
274 goto err_component_unbind;
276 /* Use OVL device for all DMA memory allocations */
277 np = private->comp_node[private->data->main_path[0]] ?:
278 private->comp_node[private->data->ext_path[0]];
279 pdev = of_find_device_by_node(np);
282 dev_err(drm->dev, "Need at least one OVL device\n");
283 goto err_component_unbind;
286 dma_dev = &pdev->dev;
287 private->dma_dev = dma_dev;
290 * Configure the DMA segment size to make sure we get contiguous IOVA
291 * when importing PRIME buffers.
293 if (!dma_dev->dma_parms) {
294 private->dma_parms_allocated = true;
296 devm_kzalloc(drm->dev, sizeof(*dma_dev->dma_parms),
299 if (!dma_dev->dma_parms) {
301 goto err_component_unbind;
304 ret = dma_set_max_seg_size(dma_dev, (unsigned int)DMA_BIT_MASK(32));
306 dev_err(dma_dev, "Failed to set DMA segment size\n");
307 goto err_unset_dma_parms;
311 * We don't use the drm_irq_install() helpers provided by the DRM
312 * core, so we need to set this manually in order to allow the
313 * DRM_IOCTL_WAIT_VBLANK to operate correctly.
315 drm->irq_enabled = true;
316 ret = drm_vblank_init(drm, MAX_CRTC);
318 goto err_unset_dma_parms;
320 drm_kms_helper_poll_init(drm);
321 drm_mode_config_reset(drm);
326 if (private->dma_parms_allocated)
327 dma_dev->dma_parms = NULL;
328 err_component_unbind:
329 component_unbind_all(drm->dev, drm);
331 drm_mode_config_cleanup(drm);
336 static void mtk_drm_kms_deinit(struct drm_device *drm)
338 struct mtk_drm_private *private = drm->dev_private;
340 drm_kms_helper_poll_fini(drm);
341 drm_atomic_helper_shutdown(drm);
343 if (private->dma_parms_allocated)
344 private->dma_dev->dma_parms = NULL;
346 component_unbind_all(drm->dev, drm);
347 drm_mode_config_cleanup(drm);
350 static const struct file_operations mtk_drm_fops = {
351 .owner = THIS_MODULE,
353 .release = drm_release,
354 .unlocked_ioctl = drm_ioctl,
355 .mmap = mtk_drm_gem_mmap,
358 .compat_ioctl = drm_compat_ioctl,
362 * We need to override this because the device used to import the memory is
363 * not dev->dev, as drm_gem_prime_import() expects.
365 struct drm_gem_object *mtk_drm_gem_prime_import(struct drm_device *dev,
366 struct dma_buf *dma_buf)
368 struct mtk_drm_private *private = dev->dev_private;
370 return drm_gem_prime_import_dev(dev, dma_buf, private->dma_dev);
373 static struct drm_driver mtk_drm_driver = {
374 .driver_features = DRIVER_MODESET | DRIVER_GEM | DRIVER_PRIME |
377 .gem_free_object_unlocked = mtk_drm_gem_free_object,
378 .gem_vm_ops = &drm_gem_cma_vm_ops,
379 .dumb_create = mtk_drm_gem_dumb_create,
381 .prime_handle_to_fd = drm_gem_prime_handle_to_fd,
382 .prime_fd_to_handle = drm_gem_prime_fd_to_handle,
383 .gem_prime_export = drm_gem_prime_export,
384 .gem_prime_import = mtk_drm_gem_prime_import,
385 .gem_prime_get_sg_table = mtk_gem_prime_get_sg_table,
386 .gem_prime_import_sg_table = mtk_gem_prime_import_sg_table,
387 .gem_prime_mmap = mtk_drm_gem_mmap_buf,
388 .fops = &mtk_drm_fops,
393 .major = DRIVER_MAJOR,
394 .minor = DRIVER_MINOR,
397 static int compare_of(struct device *dev, void *data)
399 return dev->of_node == data;
402 static int mtk_drm_bind(struct device *dev)
404 struct mtk_drm_private *private = dev_get_drvdata(dev);
405 struct drm_device *drm;
408 drm = drm_dev_alloc(&mtk_drm_driver, dev);
412 drm->dev_private = private;
415 ret = mtk_drm_kms_init(drm);
419 ret = drm_dev_register(drm, 0);
426 mtk_drm_kms_deinit(drm);
432 static void mtk_drm_unbind(struct device *dev)
434 struct mtk_drm_private *private = dev_get_drvdata(dev);
436 drm_dev_unregister(private->drm);
437 mtk_drm_kms_deinit(private->drm);
438 drm_dev_put(private->drm);
439 private->num_pipes = 0;
443 static const struct component_master_ops mtk_drm_ops = {
444 .bind = mtk_drm_bind,
445 .unbind = mtk_drm_unbind,
448 static const struct of_device_id mtk_ddp_comp_dt_ids[] = {
449 { .compatible = "mediatek,mt2701-disp-ovl",
450 .data = (void *)MTK_DISP_OVL },
451 { .compatible = "mediatek,mt8173-disp-ovl",
452 .data = (void *)MTK_DISP_OVL },
453 { .compatible = "mediatek,mt2701-disp-rdma",
454 .data = (void *)MTK_DISP_RDMA },
455 { .compatible = "mediatek,mt8173-disp-rdma",
456 .data = (void *)MTK_DISP_RDMA },
457 { .compatible = "mediatek,mt8173-disp-wdma",
458 .data = (void *)MTK_DISP_WDMA },
459 { .compatible = "mediatek,mt2701-disp-color",
460 .data = (void *)MTK_DISP_COLOR },
461 { .compatible = "mediatek,mt8173-disp-color",
462 .data = (void *)MTK_DISP_COLOR },
463 { .compatible = "mediatek,mt8173-disp-aal",
464 .data = (void *)MTK_DISP_AAL},
465 { .compatible = "mediatek,mt8173-disp-gamma",
466 .data = (void *)MTK_DISP_GAMMA, },
467 { .compatible = "mediatek,mt8173-disp-ufoe",
468 .data = (void *)MTK_DISP_UFOE },
469 { .compatible = "mediatek,mt2701-dsi",
470 .data = (void *)MTK_DSI },
471 { .compatible = "mediatek,mt8173-dsi",
472 .data = (void *)MTK_DSI },
473 { .compatible = "mediatek,mt8173-dpi",
474 .data = (void *)MTK_DPI },
475 { .compatible = "mediatek,mt2701-disp-mutex",
476 .data = (void *)MTK_DISP_MUTEX },
477 { .compatible = "mediatek,mt2712-disp-mutex",
478 .data = (void *)MTK_DISP_MUTEX },
479 { .compatible = "mediatek,mt8173-disp-mutex",
480 .data = (void *)MTK_DISP_MUTEX },
481 { .compatible = "mediatek,mt2701-disp-pwm",
482 .data = (void *)MTK_DISP_BLS },
483 { .compatible = "mediatek,mt8173-disp-pwm",
484 .data = (void *)MTK_DISP_PWM },
485 { .compatible = "mediatek,mt8173-disp-od",
486 .data = (void *)MTK_DISP_OD },
490 static int mtk_drm_probe(struct platform_device *pdev)
492 struct device *dev = &pdev->dev;
493 struct mtk_drm_private *private;
494 struct resource *mem;
495 struct device_node *node;
496 struct component_match *match = NULL;
500 private = devm_kzalloc(dev, sizeof(*private), GFP_KERNEL);
504 mutex_init(&private->commit.lock);
505 INIT_WORK(&private->commit.work, mtk_atomic_work);
506 private->data = of_device_get_match_data(dev);
508 mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
509 private->config_regs = devm_ioremap_resource(dev, mem);
510 if (IS_ERR(private->config_regs)) {
511 ret = PTR_ERR(private->config_regs);
512 dev_err(dev, "Failed to ioremap mmsys-config resource: %d\n",
517 /* Iterate over sibling DISP function blocks */
518 for_each_child_of_node(dev->of_node->parent, node) {
519 const struct of_device_id *of_id;
520 enum mtk_ddp_comp_type comp_type;
523 of_id = of_match_node(mtk_ddp_comp_dt_ids, node);
527 if (!of_device_is_available(node)) {
528 dev_dbg(dev, "Skipping disabled component %pOF\n",
533 comp_type = (enum mtk_ddp_comp_type)of_id->data;
535 if (comp_type == MTK_DISP_MUTEX) {
536 private->mutex_node = of_node_get(node);
540 comp_id = mtk_ddp_comp_get_id(node, comp_type);
542 dev_warn(dev, "Skipping unknown component %pOF\n",
547 private->comp_node[comp_id] = of_node_get(node);
550 * Currently only the COLOR, OVL, RDMA, DSI, and DPI blocks have
551 * separate component platform drivers and initialize their own
552 * DDP component structure. The others are initialized here.
554 if (comp_type == MTK_DISP_COLOR ||
555 comp_type == MTK_DISP_OVL ||
556 comp_type == MTK_DISP_RDMA ||
557 comp_type == MTK_DSI ||
558 comp_type == MTK_DPI) {
559 dev_info(dev, "Adding component match for %pOF\n",
561 drm_of_component_match_add(dev, &match, compare_of,
564 struct mtk_ddp_comp *comp;
566 comp = devm_kzalloc(dev, sizeof(*comp), GFP_KERNEL);
573 ret = mtk_ddp_comp_init(dev, node, comp, comp_id, NULL);
579 private->ddp_comp[comp_id] = comp;
583 if (!private->mutex_node) {
584 dev_err(dev, "Failed to find disp-mutex node\n");
589 pm_runtime_enable(dev);
591 platform_set_drvdata(pdev, private);
593 ret = component_master_add_with_match(dev, &mtk_drm_ops, match);
600 pm_runtime_disable(dev);
602 of_node_put(private->mutex_node);
603 for (i = 0; i < DDP_COMPONENT_ID_MAX; i++) {
604 of_node_put(private->comp_node[i]);
605 if (private->ddp_comp[i]) {
606 put_device(private->ddp_comp[i]->larb_dev);
607 private->ddp_comp[i] = NULL;
613 static int mtk_drm_remove(struct platform_device *pdev)
615 struct mtk_drm_private *private = platform_get_drvdata(pdev);
618 component_master_del(&pdev->dev, &mtk_drm_ops);
619 pm_runtime_disable(&pdev->dev);
620 of_node_put(private->mutex_node);
621 for (i = 0; i < DDP_COMPONENT_ID_MAX; i++)
622 of_node_put(private->comp_node[i]);
627 #ifdef CONFIG_PM_SLEEP
628 static int mtk_drm_sys_suspend(struct device *dev)
630 struct mtk_drm_private *private = dev_get_drvdata(dev);
631 struct drm_device *drm = private->drm;
634 ret = drm_mode_config_helper_suspend(drm);
635 DRM_DEBUG_DRIVER("mtk_drm_sys_suspend\n");
640 static int mtk_drm_sys_resume(struct device *dev)
642 struct mtk_drm_private *private = dev_get_drvdata(dev);
643 struct drm_device *drm = private->drm;
646 ret = drm_mode_config_helper_resume(drm);
647 DRM_DEBUG_DRIVER("mtk_drm_sys_resume\n");
653 static SIMPLE_DEV_PM_OPS(mtk_drm_pm_ops, mtk_drm_sys_suspend,
656 static const struct of_device_id mtk_drm_of_ids[] = {
657 { .compatible = "mediatek,mt2701-mmsys",
658 .data = &mt2701_mmsys_driver_data},
659 { .compatible = "mediatek,mt2712-mmsys",
660 .data = &mt2712_mmsys_driver_data},
661 { .compatible = "mediatek,mt8173-mmsys",
662 .data = &mt8173_mmsys_driver_data},
666 static struct platform_driver mtk_drm_platform_driver = {
667 .probe = mtk_drm_probe,
668 .remove = mtk_drm_remove,
670 .name = "mediatek-drm",
671 .of_match_table = mtk_drm_of_ids,
672 .pm = &mtk_drm_pm_ops,
676 static struct platform_driver * const mtk_drm_drivers[] = {
678 &mtk_disp_color_driver,
679 &mtk_disp_ovl_driver,
680 &mtk_disp_rdma_driver,
682 &mtk_drm_platform_driver,
687 static int __init mtk_drm_init(void)
689 return platform_register_drivers(mtk_drm_drivers,
690 ARRAY_SIZE(mtk_drm_drivers));
693 static void __exit mtk_drm_exit(void)
695 platform_unregister_drivers(mtk_drm_drivers,
696 ARRAY_SIZE(mtk_drm_drivers));
699 module_init(mtk_drm_init);
700 module_exit(mtk_drm_exit);
702 MODULE_AUTHOR("YT SHEN <yt.shen@mediatek.com>");
703 MODULE_DESCRIPTION("Mediatek SoC DRM driver");
704 MODULE_LICENSE("GPL v2");