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