1 /*
2  * Copyright (c) 2015 MediaTek Inc.
3  * Author: YT SHEN <yt.shen@mediatek.com>
4  *
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.
8  *
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.
13  */
14 
15 #include <drm/drmP.h>
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>
27 
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"
34 
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
40 
41 static void mtk_atomic_schedule(struct mtk_drm_private *private,
42 				struct drm_atomic_state *state)
43 {
44 	private->commit.state = state;
45 	schedule_work(&private->commit.work);
46 }
47 
48 static void mtk_atomic_wait_for_fences(struct drm_atomic_state *state)
49 {
50 	struct drm_plane *plane;
51 	struct drm_plane_state *plane_state;
52 	int i;
53 
54 	for_each_plane_in_state(state, plane, plane_state, i)
55 		mtk_fb_wait(plane->state->fb);
56 }
57 
58 static void mtk_atomic_complete(struct mtk_drm_private *private,
59 				struct drm_atomic_state *state)
60 {
61 	struct drm_device *drm = private->drm;
62 
63 	mtk_atomic_wait_for_fences(state);
64 
65 	/*
66 	 * Mediatek drm supports runtime PM, so plane registers cannot be
67 	 * written when their crtc is disabled.
68 	 *
69 	 * The comment for drm_atomic_helper_commit states:
70 	 *     For drivers supporting runtime PM the recommended sequence is
71 	 *
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);
76 	 *
77 	 * See the kerneldoc entries for these three functions for more details.
78 	 */
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);
83 
84 	drm_atomic_helper_wait_for_vblanks(drm, state);
85 
86 	drm_atomic_helper_cleanup_planes(drm, state);
87 	drm_atomic_state_put(state);
88 }
89 
90 static void mtk_atomic_work(struct work_struct *work)
91 {
92 	struct mtk_drm_private *private = container_of(work,
93 			struct mtk_drm_private, commit.work);
94 
95 	mtk_atomic_complete(private, private->commit.state);
96 }
97 
98 static int mtk_atomic_commit(struct drm_device *drm,
99 			     struct drm_atomic_state *state,
100 			     bool async)
101 {
102 	struct mtk_drm_private *private = drm->dev_private;
103 	int ret;
104 
105 	ret = drm_atomic_helper_prepare_planes(drm, state);
106 	if (ret)
107 		return ret;
108 
109 	mutex_lock(&private->commit.lock);
110 	flush_work(&private->commit.work);
111 
112 	drm_atomic_helper_swap_state(state, true);
113 
114 	drm_atomic_state_get(state);
115 	if (async)
116 		mtk_atomic_schedule(private, state);
117 	else
118 		mtk_atomic_complete(private, state);
119 
120 	mutex_unlock(&private->commit.lock);
121 
122 	return 0;
123 }
124 
125 static const struct drm_mode_config_funcs mtk_drm_mode_config_funcs = {
126 	.fb_create = mtk_drm_mode_fb_create,
127 	.atomic_check = drm_atomic_helper_check,
128 	.atomic_commit = mtk_atomic_commit,
129 };
130 
131 static const enum mtk_ddp_comp_id mtk_ddp_main[] = {
132 	DDP_COMPONENT_OVL0,
133 	DDP_COMPONENT_COLOR0,
134 	DDP_COMPONENT_AAL,
135 	DDP_COMPONENT_OD,
136 	DDP_COMPONENT_RDMA0,
137 	DDP_COMPONENT_UFOE,
138 	DDP_COMPONENT_DSI0,
139 	DDP_COMPONENT_PWM0,
140 };
141 
142 static const enum mtk_ddp_comp_id mtk_ddp_ext[] = {
143 	DDP_COMPONENT_OVL1,
144 	DDP_COMPONENT_COLOR1,
145 	DDP_COMPONENT_GAMMA,
146 	DDP_COMPONENT_RDMA1,
147 	DDP_COMPONENT_DPI0,
148 };
149 
150 static int mtk_drm_kms_init(struct drm_device *drm)
151 {
152 	struct mtk_drm_private *private = drm->dev_private;
153 	struct platform_device *pdev;
154 	struct device_node *np;
155 	int ret;
156 
157 	if (!iommu_present(&platform_bus_type))
158 		return -EPROBE_DEFER;
159 
160 	pdev = of_find_device_by_node(private->mutex_node);
161 	if (!pdev) {
162 		dev_err(drm->dev, "Waiting for disp-mutex device %s\n",
163 			private->mutex_node->full_name);
164 		of_node_put(private->mutex_node);
165 		return -EPROBE_DEFER;
166 	}
167 	private->mutex_dev = &pdev->dev;
168 
169 	drm_mode_config_init(drm);
170 
171 	drm->mode_config.min_width = 64;
172 	drm->mode_config.min_height = 64;
173 
174 	/*
175 	 * set max width and height as default value(4096x4096).
176 	 * this value would be used to check framebuffer size limitation
177 	 * at drm_mode_addfb().
178 	 */
179 	drm->mode_config.max_width = 4096;
180 	drm->mode_config.max_height = 4096;
181 	drm->mode_config.funcs = &mtk_drm_mode_config_funcs;
182 
183 	ret = component_bind_all(drm->dev, drm);
184 	if (ret)
185 		goto err_config_cleanup;
186 
187 	/*
188 	 * We currently support two fixed data streams, each optional,
189 	 * and each statically assigned to a crtc:
190 	 * OVL0 -> COLOR0 -> AAL -> OD -> RDMA0 -> UFOE -> DSI0 ...
191 	 */
192 	ret = mtk_drm_crtc_create(drm, mtk_ddp_main, ARRAY_SIZE(mtk_ddp_main));
193 	if (ret < 0)
194 		goto err_component_unbind;
195 	/* ... and OVL1 -> COLOR1 -> GAMMA -> RDMA1 -> DPI0. */
196 	ret = mtk_drm_crtc_create(drm, mtk_ddp_ext, ARRAY_SIZE(mtk_ddp_ext));
197 	if (ret < 0)
198 		goto err_component_unbind;
199 
200 	/* Use OVL device for all DMA memory allocations */
201 	np = private->comp_node[mtk_ddp_main[0]] ?:
202 	     private->comp_node[mtk_ddp_ext[0]];
203 	pdev = of_find_device_by_node(np);
204 	if (!pdev) {
205 		ret = -ENODEV;
206 		dev_err(drm->dev, "Need at least one OVL device\n");
207 		goto err_component_unbind;
208 	}
209 
210 	private->dma_dev = &pdev->dev;
211 
212 	/*
213 	 * We don't use the drm_irq_install() helpers provided by the DRM
214 	 * core, so we need to set this manually in order to allow the
215 	 * DRM_IOCTL_WAIT_VBLANK to operate correctly.
216 	 */
217 	drm->irq_enabled = true;
218 	ret = drm_vblank_init(drm, MAX_CRTC);
219 	if (ret < 0)
220 		goto err_component_unbind;
221 
222 	drm_kms_helper_poll_init(drm);
223 	drm_mode_config_reset(drm);
224 
225 	return 0;
226 
227 err_component_unbind:
228 	component_unbind_all(drm->dev, drm);
229 err_config_cleanup:
230 	drm_mode_config_cleanup(drm);
231 
232 	return ret;
233 }
234 
235 static void mtk_drm_kms_deinit(struct drm_device *drm)
236 {
237 	drm_kms_helper_poll_fini(drm);
238 
239 	drm_vblank_cleanup(drm);
240 	component_unbind_all(drm->dev, drm);
241 	drm_mode_config_cleanup(drm);
242 }
243 
244 static const struct file_operations mtk_drm_fops = {
245 	.owner = THIS_MODULE,
246 	.open = drm_open,
247 	.release = drm_release,
248 	.unlocked_ioctl = drm_ioctl,
249 	.mmap = mtk_drm_gem_mmap,
250 	.poll = drm_poll,
251 	.read = drm_read,
252 	.compat_ioctl = drm_compat_ioctl,
253 };
254 
255 static struct drm_driver mtk_drm_driver = {
256 	.driver_features = DRIVER_MODESET | DRIVER_GEM | DRIVER_PRIME |
257 			   DRIVER_ATOMIC,
258 
259 	.gem_free_object_unlocked = mtk_drm_gem_free_object,
260 	.gem_vm_ops = &drm_gem_cma_vm_ops,
261 	.dumb_create = mtk_drm_gem_dumb_create,
262 	.dumb_map_offset = mtk_drm_gem_dumb_map_offset,
263 	.dumb_destroy = drm_gem_dumb_destroy,
264 
265 	.prime_handle_to_fd = drm_gem_prime_handle_to_fd,
266 	.prime_fd_to_handle = drm_gem_prime_fd_to_handle,
267 	.gem_prime_export = drm_gem_prime_export,
268 	.gem_prime_import = drm_gem_prime_import,
269 	.gem_prime_get_sg_table = mtk_gem_prime_get_sg_table,
270 	.gem_prime_import_sg_table = mtk_gem_prime_import_sg_table,
271 	.gem_prime_mmap = mtk_drm_gem_mmap_buf,
272 	.fops = &mtk_drm_fops,
273 
274 	.name = DRIVER_NAME,
275 	.desc = DRIVER_DESC,
276 	.date = DRIVER_DATE,
277 	.major = DRIVER_MAJOR,
278 	.minor = DRIVER_MINOR,
279 };
280 
281 static int compare_of(struct device *dev, void *data)
282 {
283 	return dev->of_node == data;
284 }
285 
286 static int mtk_drm_bind(struct device *dev)
287 {
288 	struct mtk_drm_private *private = dev_get_drvdata(dev);
289 	struct drm_device *drm;
290 	int ret;
291 
292 	drm = drm_dev_alloc(&mtk_drm_driver, dev);
293 	if (IS_ERR(drm))
294 		return PTR_ERR(drm);
295 
296 	drm->dev_private = private;
297 	private->drm = drm;
298 
299 	ret = mtk_drm_kms_init(drm);
300 	if (ret < 0)
301 		goto err_free;
302 
303 	ret = drm_dev_register(drm, 0);
304 	if (ret < 0)
305 		goto err_deinit;
306 
307 	return 0;
308 
309 err_deinit:
310 	mtk_drm_kms_deinit(drm);
311 err_free:
312 	drm_dev_unref(drm);
313 	return ret;
314 }
315 
316 static void mtk_drm_unbind(struct device *dev)
317 {
318 	struct mtk_drm_private *private = dev_get_drvdata(dev);
319 
320 	drm_dev_unregister(private->drm);
321 	drm_dev_unref(private->drm);
322 	private->drm = NULL;
323 }
324 
325 static const struct component_master_ops mtk_drm_ops = {
326 	.bind		= mtk_drm_bind,
327 	.unbind		= mtk_drm_unbind,
328 };
329 
330 static const struct of_device_id mtk_ddp_comp_dt_ids[] = {
331 	{ .compatible = "mediatek,mt8173-disp-ovl",   .data = (void *)MTK_DISP_OVL },
332 	{ .compatible = "mediatek,mt8173-disp-rdma",  .data = (void *)MTK_DISP_RDMA },
333 	{ .compatible = "mediatek,mt8173-disp-wdma",  .data = (void *)MTK_DISP_WDMA },
334 	{ .compatible = "mediatek,mt8173-disp-color", .data = (void *)MTK_DISP_COLOR },
335 	{ .compatible = "mediatek,mt8173-disp-aal",   .data = (void *)MTK_DISP_AAL},
336 	{ .compatible = "mediatek,mt8173-disp-gamma", .data = (void *)MTK_DISP_GAMMA, },
337 	{ .compatible = "mediatek,mt8173-disp-ufoe",  .data = (void *)MTK_DISP_UFOE },
338 	{ .compatible = "mediatek,mt8173-dsi",        .data = (void *)MTK_DSI },
339 	{ .compatible = "mediatek,mt8173-dpi",        .data = (void *)MTK_DPI },
340 	{ .compatible = "mediatek,mt8173-disp-mutex", .data = (void *)MTK_DISP_MUTEX },
341 	{ .compatible = "mediatek,mt8173-disp-pwm",   .data = (void *)MTK_DISP_PWM },
342 	{ .compatible = "mediatek,mt8173-disp-od",    .data = (void *)MTK_DISP_OD },
343 	{ }
344 };
345 
346 static int mtk_drm_probe(struct platform_device *pdev)
347 {
348 	struct device *dev = &pdev->dev;
349 	struct mtk_drm_private *private;
350 	struct resource *mem;
351 	struct device_node *node;
352 	struct component_match *match = NULL;
353 	int ret;
354 	int i;
355 
356 	private = devm_kzalloc(dev, sizeof(*private), GFP_KERNEL);
357 	if (!private)
358 		return -ENOMEM;
359 
360 	mutex_init(&private->commit.lock);
361 	INIT_WORK(&private->commit.work, mtk_atomic_work);
362 
363 	mem = platform_get_resource(pdev, IORESOURCE_MEM, 0);
364 	private->config_regs = devm_ioremap_resource(dev, mem);
365 	if (IS_ERR(private->config_regs)) {
366 		ret = PTR_ERR(private->config_regs);
367 		dev_err(dev, "Failed to ioremap mmsys-config resource: %d\n",
368 			ret);
369 		return ret;
370 	}
371 
372 	/* Iterate over sibling DISP function blocks */
373 	for_each_child_of_node(dev->of_node->parent, node) {
374 		const struct of_device_id *of_id;
375 		enum mtk_ddp_comp_type comp_type;
376 		int comp_id;
377 
378 		of_id = of_match_node(mtk_ddp_comp_dt_ids, node);
379 		if (!of_id)
380 			continue;
381 
382 		if (!of_device_is_available(node)) {
383 			dev_dbg(dev, "Skipping disabled component %s\n",
384 				node->full_name);
385 			continue;
386 		}
387 
388 		comp_type = (enum mtk_ddp_comp_type)of_id->data;
389 
390 		if (comp_type == MTK_DISP_MUTEX) {
391 			private->mutex_node = of_node_get(node);
392 			continue;
393 		}
394 
395 		comp_id = mtk_ddp_comp_get_id(node, comp_type);
396 		if (comp_id < 0) {
397 			dev_warn(dev, "Skipping unknown component %s\n",
398 				 node->full_name);
399 			continue;
400 		}
401 
402 		private->comp_node[comp_id] = of_node_get(node);
403 
404 		/*
405 		 * Currently only the OVL, RDMA, DSI, and DPI blocks have
406 		 * separate component platform drivers and initialize their own
407 		 * DDP component structure. The others are initialized here.
408 		 */
409 		if (comp_type == MTK_DISP_OVL ||
410 		    comp_type == MTK_DISP_RDMA ||
411 		    comp_type == MTK_DSI ||
412 		    comp_type == MTK_DPI) {
413 			dev_info(dev, "Adding component match for %s\n",
414 				 node->full_name);
415 			drm_of_component_match_add(dev, &match, compare_of,
416 						   node);
417 		} else {
418 			struct mtk_ddp_comp *comp;
419 
420 			comp = devm_kzalloc(dev, sizeof(*comp), GFP_KERNEL);
421 			if (!comp) {
422 				ret = -ENOMEM;
423 				goto err_node;
424 			}
425 
426 			ret = mtk_ddp_comp_init(dev, node, comp, comp_id, NULL);
427 			if (ret)
428 				goto err_node;
429 
430 			private->ddp_comp[comp_id] = comp;
431 		}
432 	}
433 
434 	if (!private->mutex_node) {
435 		dev_err(dev, "Failed to find disp-mutex node\n");
436 		ret = -ENODEV;
437 		goto err_node;
438 	}
439 
440 	pm_runtime_enable(dev);
441 
442 	platform_set_drvdata(pdev, private);
443 
444 	ret = component_master_add_with_match(dev, &mtk_drm_ops, match);
445 	if (ret)
446 		goto err_pm;
447 
448 	return 0;
449 
450 err_pm:
451 	pm_runtime_disable(dev);
452 err_node:
453 	of_node_put(private->mutex_node);
454 	for (i = 0; i < DDP_COMPONENT_ID_MAX; i++)
455 		of_node_put(private->comp_node[i]);
456 	return ret;
457 }
458 
459 static int mtk_drm_remove(struct platform_device *pdev)
460 {
461 	struct mtk_drm_private *private = platform_get_drvdata(pdev);
462 	struct drm_device *drm = private->drm;
463 	int i;
464 
465 	drm_dev_unregister(drm);
466 	mtk_drm_kms_deinit(drm);
467 	drm_dev_unref(drm);
468 
469 	component_master_del(&pdev->dev, &mtk_drm_ops);
470 	pm_runtime_disable(&pdev->dev);
471 	of_node_put(private->mutex_node);
472 	for (i = 0; i < DDP_COMPONENT_ID_MAX; i++)
473 		of_node_put(private->comp_node[i]);
474 
475 	return 0;
476 }
477 
478 #ifdef CONFIG_PM_SLEEP
479 static int mtk_drm_sys_suspend(struct device *dev)
480 {
481 	struct mtk_drm_private *private = dev_get_drvdata(dev);
482 	struct drm_device *drm = private->drm;
483 
484 	drm_kms_helper_poll_disable(drm);
485 
486 	private->suspend_state = drm_atomic_helper_suspend(drm);
487 	if (IS_ERR(private->suspend_state)) {
488 		drm_kms_helper_poll_enable(drm);
489 		return PTR_ERR(private->suspend_state);
490 	}
491 
492 	DRM_DEBUG_DRIVER("mtk_drm_sys_suspend\n");
493 	return 0;
494 }
495 
496 static int mtk_drm_sys_resume(struct device *dev)
497 {
498 	struct mtk_drm_private *private = dev_get_drvdata(dev);
499 	struct drm_device *drm = private->drm;
500 
501 	drm_atomic_helper_resume(drm, private->suspend_state);
502 	drm_kms_helper_poll_enable(drm);
503 
504 	DRM_DEBUG_DRIVER("mtk_drm_sys_resume\n");
505 	return 0;
506 }
507 #endif
508 
509 static SIMPLE_DEV_PM_OPS(mtk_drm_pm_ops, mtk_drm_sys_suspend,
510 			 mtk_drm_sys_resume);
511 
512 static const struct of_device_id mtk_drm_of_ids[] = {
513 	{ .compatible = "mediatek,mt8173-mmsys", },
514 	{ }
515 };
516 
517 static struct platform_driver mtk_drm_platform_driver = {
518 	.probe	= mtk_drm_probe,
519 	.remove	= mtk_drm_remove,
520 	.driver	= {
521 		.name	= "mediatek-drm",
522 		.of_match_table = mtk_drm_of_ids,
523 		.pm     = &mtk_drm_pm_ops,
524 	},
525 };
526 
527 static struct platform_driver * const mtk_drm_drivers[] = {
528 	&mtk_ddp_driver,
529 	&mtk_disp_ovl_driver,
530 	&mtk_disp_rdma_driver,
531 	&mtk_dpi_driver,
532 	&mtk_drm_platform_driver,
533 	&mtk_dsi_driver,
534 	&mtk_mipi_tx_driver,
535 };
536 
537 static int __init mtk_drm_init(void)
538 {
539 	int ret;
540 	int i;
541 
542 	for (i = 0; i < ARRAY_SIZE(mtk_drm_drivers); i++) {
543 		ret = platform_driver_register(mtk_drm_drivers[i]);
544 		if (ret < 0) {
545 			pr_err("Failed to register %s driver: %d\n",
546 			       mtk_drm_drivers[i]->driver.name, ret);
547 			goto err;
548 		}
549 	}
550 
551 	return 0;
552 
553 err:
554 	while (--i >= 0)
555 		platform_driver_unregister(mtk_drm_drivers[i]);
556 
557 	return ret;
558 }
559 
560 static void __exit mtk_drm_exit(void)
561 {
562 	int i;
563 
564 	for (i = ARRAY_SIZE(mtk_drm_drivers) - 1; i >= 0; i--)
565 		platform_driver_unregister(mtk_drm_drivers[i]);
566 }
567 
568 module_init(mtk_drm_init);
569 module_exit(mtk_drm_exit);
570 
571 MODULE_AUTHOR("YT SHEN <yt.shen@mediatek.com>");
572 MODULE_DESCRIPTION("Mediatek SoC DRM driver");
573 MODULE_LICENSE("GPL v2");
574