1 /*
2  * Copyright (c) 2011 Samsung Electronics Co., Ltd.
3  * Authors:
4  *	Inki Dae <inki.dae@samsung.com>
5  *	Joonyoung Shim <jy0922.shim@samsung.com>
6  *	Seung-Woo Kim <sw0312.kim@samsung.com>
7  *
8  * This program is free software; you can redistribute  it and/or modify it
9  * under  the terms of  the GNU General  Public License as published by the
10  * Free Software Foundation;  either version 2 of the  License, or (at your
11  * option) any later version.
12  */
13 
14 #include <linux/pm_runtime.h>
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 
20 #include <linux/component.h>
21 
22 #include <drm/exynos_drm.h>
23 
24 #include "exynos_drm_drv.h"
25 #include "exynos_drm_fbdev.h"
26 #include "exynos_drm_fb.h"
27 #include "exynos_drm_gem.h"
28 #include "exynos_drm_plane.h"
29 #include "exynos_drm_vidi.h"
30 #include "exynos_drm_g2d.h"
31 #include "exynos_drm_ipp.h"
32 #include "exynos_drm_iommu.h"
33 
34 #define DRIVER_NAME	"exynos"
35 #define DRIVER_DESC	"Samsung SoC DRM"
36 #define DRIVER_DATE	"20110530"
37 #define DRIVER_MAJOR	1
38 #define DRIVER_MINOR	0
39 
40 static struct device *exynos_drm_get_dma_device(void);
41 
42 int exynos_atomic_check(struct drm_device *dev,
43 			struct drm_atomic_state *state)
44 {
45 	int ret;
46 
47 	ret = drm_atomic_helper_check_modeset(dev, state);
48 	if (ret)
49 		return ret;
50 
51 	ret = drm_atomic_normalize_zpos(dev, state);
52 	if (ret)
53 		return ret;
54 
55 	ret = drm_atomic_helper_check_planes(dev, state);
56 	if (ret)
57 		return ret;
58 
59 	return ret;
60 }
61 
62 static int exynos_drm_open(struct drm_device *dev, struct drm_file *file)
63 {
64 	struct drm_exynos_file_private *file_priv;
65 	int ret;
66 
67 	file_priv = kzalloc(sizeof(*file_priv), GFP_KERNEL);
68 	if (!file_priv)
69 		return -ENOMEM;
70 
71 	file->driver_priv = file_priv;
72 
73 	ret = exynos_drm_subdrv_open(dev, file);
74 	if (ret)
75 		goto err_file_priv_free;
76 
77 	return ret;
78 
79 err_file_priv_free:
80 	kfree(file_priv);
81 	file->driver_priv = NULL;
82 	return ret;
83 }
84 
85 static void exynos_drm_postclose(struct drm_device *dev, struct drm_file *file)
86 {
87 	exynos_drm_subdrv_close(dev, file);
88 	kfree(file->driver_priv);
89 	file->driver_priv = NULL;
90 }
91 
92 static void exynos_drm_lastclose(struct drm_device *dev)
93 {
94 	exynos_drm_fbdev_restore_mode(dev);
95 }
96 
97 static const struct vm_operations_struct exynos_drm_gem_vm_ops = {
98 	.fault = exynos_drm_gem_fault,
99 	.open = drm_gem_vm_open,
100 	.close = drm_gem_vm_close,
101 };
102 
103 static const struct drm_ioctl_desc exynos_ioctls[] = {
104 	DRM_IOCTL_DEF_DRV(EXYNOS_GEM_CREATE, exynos_drm_gem_create_ioctl,
105 			DRM_AUTH | DRM_RENDER_ALLOW),
106 	DRM_IOCTL_DEF_DRV(EXYNOS_GEM_MAP, exynos_drm_gem_map_ioctl,
107 			DRM_AUTH | DRM_RENDER_ALLOW),
108 	DRM_IOCTL_DEF_DRV(EXYNOS_GEM_GET, exynos_drm_gem_get_ioctl,
109 			DRM_RENDER_ALLOW),
110 	DRM_IOCTL_DEF_DRV(EXYNOS_VIDI_CONNECTION, vidi_connection_ioctl,
111 			DRM_AUTH),
112 	DRM_IOCTL_DEF_DRV(EXYNOS_G2D_GET_VER, exynos_g2d_get_ver_ioctl,
113 			DRM_AUTH | DRM_RENDER_ALLOW),
114 	DRM_IOCTL_DEF_DRV(EXYNOS_G2D_SET_CMDLIST, exynos_g2d_set_cmdlist_ioctl,
115 			DRM_AUTH | DRM_RENDER_ALLOW),
116 	DRM_IOCTL_DEF_DRV(EXYNOS_G2D_EXEC, exynos_g2d_exec_ioctl,
117 			DRM_AUTH | DRM_RENDER_ALLOW),
118 	DRM_IOCTL_DEF_DRV(EXYNOS_IPP_GET_PROPERTY, exynos_drm_ipp_get_property,
119 			DRM_AUTH | DRM_RENDER_ALLOW),
120 	DRM_IOCTL_DEF_DRV(EXYNOS_IPP_SET_PROPERTY, exynos_drm_ipp_set_property,
121 			DRM_AUTH | DRM_RENDER_ALLOW),
122 	DRM_IOCTL_DEF_DRV(EXYNOS_IPP_QUEUE_BUF, exynos_drm_ipp_queue_buf,
123 			DRM_AUTH | DRM_RENDER_ALLOW),
124 	DRM_IOCTL_DEF_DRV(EXYNOS_IPP_CMD_CTRL, exynos_drm_ipp_cmd_ctrl,
125 			DRM_AUTH | DRM_RENDER_ALLOW),
126 };
127 
128 static const struct file_operations exynos_drm_driver_fops = {
129 	.owner		= THIS_MODULE,
130 	.open		= drm_open,
131 	.mmap		= exynos_drm_gem_mmap,
132 	.poll		= drm_poll,
133 	.read		= drm_read,
134 	.unlocked_ioctl	= drm_ioctl,
135 	.compat_ioctl = drm_compat_ioctl,
136 	.release	= drm_release,
137 };
138 
139 static struct drm_driver exynos_drm_driver = {
140 	.driver_features	= DRIVER_MODESET | DRIVER_GEM | DRIVER_PRIME
141 				  | DRIVER_ATOMIC | DRIVER_RENDER,
142 	.open			= exynos_drm_open,
143 	.lastclose		= exynos_drm_lastclose,
144 	.postclose		= exynos_drm_postclose,
145 	.gem_free_object_unlocked = exynos_drm_gem_free_object,
146 	.gem_vm_ops		= &exynos_drm_gem_vm_ops,
147 	.dumb_create		= exynos_drm_gem_dumb_create,
148 	.prime_handle_to_fd	= drm_gem_prime_handle_to_fd,
149 	.prime_fd_to_handle	= drm_gem_prime_fd_to_handle,
150 	.gem_prime_export	= drm_gem_prime_export,
151 	.gem_prime_import	= drm_gem_prime_import,
152 	.gem_prime_get_sg_table	= exynos_drm_gem_prime_get_sg_table,
153 	.gem_prime_import_sg_table	= exynos_drm_gem_prime_import_sg_table,
154 	.gem_prime_vmap		= exynos_drm_gem_prime_vmap,
155 	.gem_prime_vunmap	= exynos_drm_gem_prime_vunmap,
156 	.gem_prime_mmap		= exynos_drm_gem_prime_mmap,
157 	.ioctls			= exynos_ioctls,
158 	.num_ioctls		= ARRAY_SIZE(exynos_ioctls),
159 	.fops			= &exynos_drm_driver_fops,
160 	.name	= DRIVER_NAME,
161 	.desc	= DRIVER_DESC,
162 	.date	= DRIVER_DATE,
163 	.major	= DRIVER_MAJOR,
164 	.minor	= DRIVER_MINOR,
165 };
166 
167 #ifdef CONFIG_PM_SLEEP
168 static int exynos_drm_suspend(struct device *dev)
169 {
170 	struct drm_device *drm_dev = dev_get_drvdata(dev);
171 	struct exynos_drm_private *private = drm_dev->dev_private;
172 
173 	if (pm_runtime_suspended(dev) || !drm_dev)
174 		return 0;
175 
176 	drm_kms_helper_poll_disable(drm_dev);
177 	exynos_drm_fbdev_suspend(drm_dev);
178 	private->suspend_state = drm_atomic_helper_suspend(drm_dev);
179 	if (IS_ERR(private->suspend_state)) {
180 		exynos_drm_fbdev_resume(drm_dev);
181 		drm_kms_helper_poll_enable(drm_dev);
182 		return PTR_ERR(private->suspend_state);
183 	}
184 
185 	return 0;
186 }
187 
188 static int exynos_drm_resume(struct device *dev)
189 {
190 	struct drm_device *drm_dev = dev_get_drvdata(dev);
191 	struct exynos_drm_private *private = drm_dev->dev_private;
192 
193 	if (pm_runtime_suspended(dev) || !drm_dev)
194 		return 0;
195 
196 	drm_atomic_helper_resume(drm_dev, private->suspend_state);
197 	exynos_drm_fbdev_resume(drm_dev);
198 	drm_kms_helper_poll_enable(drm_dev);
199 
200 	return 0;
201 }
202 #endif
203 
204 static const struct dev_pm_ops exynos_drm_pm_ops = {
205 	SET_SYSTEM_SLEEP_PM_OPS(exynos_drm_suspend, exynos_drm_resume)
206 };
207 
208 /* forward declaration */
209 static struct platform_driver exynos_drm_platform_driver;
210 
211 struct exynos_drm_driver_info {
212 	struct platform_driver *driver;
213 	unsigned int flags;
214 };
215 
216 #define DRM_COMPONENT_DRIVER	BIT(0)	/* supports component framework */
217 #define DRM_VIRTUAL_DEVICE	BIT(1)	/* create virtual platform device */
218 #define DRM_DMA_DEVICE		BIT(2)	/* can be used for dma allocations */
219 
220 #define DRV_PTR(drv, cond) (IS_ENABLED(cond) ? &drv : NULL)
221 
222 /*
223  * Connector drivers should not be placed before associated crtc drivers,
224  * because connector requires pipe number of its crtc during initialization.
225  */
226 static struct exynos_drm_driver_info exynos_drm_drivers[] = {
227 	{
228 		DRV_PTR(fimd_driver, CONFIG_DRM_EXYNOS_FIMD),
229 		DRM_COMPONENT_DRIVER | DRM_DMA_DEVICE
230 	}, {
231 		DRV_PTR(exynos5433_decon_driver, CONFIG_DRM_EXYNOS5433_DECON),
232 		DRM_COMPONENT_DRIVER | DRM_DMA_DEVICE
233 	}, {
234 		DRV_PTR(decon_driver, CONFIG_DRM_EXYNOS7_DECON),
235 		DRM_COMPONENT_DRIVER | DRM_DMA_DEVICE
236 	}, {
237 		DRV_PTR(mixer_driver, CONFIG_DRM_EXYNOS_MIXER),
238 		DRM_COMPONENT_DRIVER | DRM_DMA_DEVICE
239 	}, {
240 		DRV_PTR(mic_driver, CONFIG_DRM_EXYNOS_MIC),
241 		DRM_COMPONENT_DRIVER
242 	}, {
243 		DRV_PTR(dp_driver, CONFIG_DRM_EXYNOS_DP),
244 		DRM_COMPONENT_DRIVER
245 	}, {
246 		DRV_PTR(dsi_driver, CONFIG_DRM_EXYNOS_DSI),
247 		DRM_COMPONENT_DRIVER
248 	}, {
249 		DRV_PTR(hdmi_driver, CONFIG_DRM_EXYNOS_HDMI),
250 		DRM_COMPONENT_DRIVER
251 	}, {
252 		DRV_PTR(vidi_driver, CONFIG_DRM_EXYNOS_VIDI),
253 		DRM_COMPONENT_DRIVER | DRM_VIRTUAL_DEVICE
254 	}, {
255 		DRV_PTR(g2d_driver, CONFIG_DRM_EXYNOS_G2D),
256 	}, {
257 		DRV_PTR(fimc_driver, CONFIG_DRM_EXYNOS_FIMC),
258 	}, {
259 		DRV_PTR(rotator_driver, CONFIG_DRM_EXYNOS_ROTATOR),
260 	}, {
261 		DRV_PTR(gsc_driver, CONFIG_DRM_EXYNOS_GSC),
262 	}, {
263 		DRV_PTR(ipp_driver, CONFIG_DRM_EXYNOS_IPP),
264 		DRM_VIRTUAL_DEVICE
265 	}, {
266 		&exynos_drm_platform_driver,
267 		DRM_VIRTUAL_DEVICE
268 	}
269 };
270 
271 static int compare_dev(struct device *dev, void *data)
272 {
273 	return dev == (struct device *)data;
274 }
275 
276 static struct component_match *exynos_drm_match_add(struct device *dev)
277 {
278 	struct component_match *match = NULL;
279 	int i;
280 
281 	for (i = 0; i < ARRAY_SIZE(exynos_drm_drivers); ++i) {
282 		struct exynos_drm_driver_info *info = &exynos_drm_drivers[i];
283 		struct device *p = NULL, *d;
284 
285 		if (!info->driver || !(info->flags & DRM_COMPONENT_DRIVER))
286 			continue;
287 
288 		while ((d = bus_find_device(&platform_bus_type, p,
289 					    &info->driver->driver,
290 					    (void *)platform_bus_type.match))) {
291 			put_device(p);
292 			component_match_add(dev, &match, compare_dev, d);
293 			p = d;
294 		}
295 		put_device(p);
296 	}
297 
298 	return match ?: ERR_PTR(-ENODEV);
299 }
300 
301 static int exynos_drm_bind(struct device *dev)
302 {
303 	struct exynos_drm_private *private;
304 	struct drm_encoder *encoder;
305 	struct drm_device *drm;
306 	unsigned int clone_mask;
307 	int cnt, ret;
308 
309 	drm = drm_dev_alloc(&exynos_drm_driver, dev);
310 	if (IS_ERR(drm))
311 		return PTR_ERR(drm);
312 
313 	private = kzalloc(sizeof(struct exynos_drm_private), GFP_KERNEL);
314 	if (!private) {
315 		ret = -ENOMEM;
316 		goto err_free_drm;
317 	}
318 
319 	init_waitqueue_head(&private->wait);
320 	spin_lock_init(&private->lock);
321 
322 	dev_set_drvdata(dev, drm);
323 	drm->dev_private = (void *)private;
324 
325 	/* the first real CRTC device is used for all dma mapping operations */
326 	private->dma_dev = exynos_drm_get_dma_device();
327 	if (!private->dma_dev) {
328 		DRM_ERROR("no device found for DMA mapping operations.\n");
329 		ret = -ENODEV;
330 		goto err_free_private;
331 	}
332 	DRM_INFO("Exynos DRM: using %s device for DMA mapping operations\n",
333 		 dev_name(private->dma_dev));
334 
335 	/* create common IOMMU mapping for all devices attached to Exynos DRM */
336 	ret = drm_create_iommu_mapping(drm);
337 	if (ret < 0) {
338 		DRM_ERROR("failed to create iommu mapping.\n");
339 		goto err_free_private;
340 	}
341 
342 	drm_mode_config_init(drm);
343 
344 	exynos_drm_mode_config_init(drm);
345 
346 	/* setup possible_clones. */
347 	cnt = 0;
348 	clone_mask = 0;
349 	list_for_each_entry(encoder, &drm->mode_config.encoder_list, head)
350 		clone_mask |= (1 << (cnt++));
351 
352 	list_for_each_entry(encoder, &drm->mode_config.encoder_list, head)
353 		encoder->possible_clones = clone_mask;
354 
355 	/* Try to bind all sub drivers. */
356 	ret = component_bind_all(drm->dev, drm);
357 	if (ret)
358 		goto err_mode_config_cleanup;
359 
360 	ret = drm_vblank_init(drm, drm->mode_config.num_crtc);
361 	if (ret)
362 		goto err_unbind_all;
363 
364 	/* Probe non kms sub drivers and virtual display driver. */
365 	ret = exynos_drm_device_subdrv_probe(drm);
366 	if (ret)
367 		goto err_unbind_all;
368 
369 	drm_mode_config_reset(drm);
370 
371 	/*
372 	 * enable drm irq mode.
373 	 * - with irq_enabled = true, we can use the vblank feature.
374 	 *
375 	 * P.S. note that we wouldn't use drm irq handler but
376 	 *	just specific driver own one instead because
377 	 *	drm framework supports only one irq handler.
378 	 */
379 	drm->irq_enabled = true;
380 
381 	/* init kms poll for handling hpd */
382 	drm_kms_helper_poll_init(drm);
383 
384 	ret = exynos_drm_fbdev_init(drm);
385 	if (ret)
386 		goto err_cleanup_poll;
387 
388 	/* register the DRM device */
389 	ret = drm_dev_register(drm, 0);
390 	if (ret < 0)
391 		goto err_cleanup_fbdev;
392 
393 	return 0;
394 
395 err_cleanup_fbdev:
396 	exynos_drm_fbdev_fini(drm);
397 err_cleanup_poll:
398 	drm_kms_helper_poll_fini(drm);
399 	exynos_drm_device_subdrv_remove(drm);
400 err_unbind_all:
401 	component_unbind_all(drm->dev, drm);
402 err_mode_config_cleanup:
403 	drm_mode_config_cleanup(drm);
404 	drm_release_iommu_mapping(drm);
405 err_free_private:
406 	kfree(private);
407 err_free_drm:
408 	drm_dev_unref(drm);
409 
410 	return ret;
411 }
412 
413 static void exynos_drm_unbind(struct device *dev)
414 {
415 	struct drm_device *drm = dev_get_drvdata(dev);
416 
417 	drm_dev_unregister(drm);
418 
419 	exynos_drm_device_subdrv_remove(drm);
420 
421 	exynos_drm_fbdev_fini(drm);
422 	drm_kms_helper_poll_fini(drm);
423 
424 	component_unbind_all(drm->dev, drm);
425 	drm_mode_config_cleanup(drm);
426 	drm_release_iommu_mapping(drm);
427 
428 	kfree(drm->dev_private);
429 	drm->dev_private = NULL;
430 
431 	drm_dev_unref(drm);
432 }
433 
434 static const struct component_master_ops exynos_drm_ops = {
435 	.bind		= exynos_drm_bind,
436 	.unbind		= exynos_drm_unbind,
437 };
438 
439 static int exynos_drm_platform_probe(struct platform_device *pdev)
440 {
441 	struct component_match *match;
442 
443 	pdev->dev.coherent_dma_mask = DMA_BIT_MASK(32);
444 
445 	match = exynos_drm_match_add(&pdev->dev);
446 	if (IS_ERR(match))
447 		return PTR_ERR(match);
448 
449 	return component_master_add_with_match(&pdev->dev, &exynos_drm_ops,
450 					       match);
451 }
452 
453 static int exynos_drm_platform_remove(struct platform_device *pdev)
454 {
455 	component_master_del(&pdev->dev, &exynos_drm_ops);
456 	return 0;
457 }
458 
459 static struct platform_driver exynos_drm_platform_driver = {
460 	.probe	= exynos_drm_platform_probe,
461 	.remove	= exynos_drm_platform_remove,
462 	.driver	= {
463 		.name	= "exynos-drm",
464 		.pm	= &exynos_drm_pm_ops,
465 	},
466 };
467 
468 static struct device *exynos_drm_get_dma_device(void)
469 {
470 	int i;
471 
472 	for (i = 0; i < ARRAY_SIZE(exynos_drm_drivers); ++i) {
473 		struct exynos_drm_driver_info *info = &exynos_drm_drivers[i];
474 		struct device *dev;
475 
476 		if (!info->driver || !(info->flags & DRM_DMA_DEVICE))
477 			continue;
478 
479 		while ((dev = bus_find_device(&platform_bus_type, NULL,
480 					    &info->driver->driver,
481 					    (void *)platform_bus_type.match))) {
482 			put_device(dev);
483 			return dev;
484 		}
485 	}
486 	return NULL;
487 }
488 
489 static void exynos_drm_unregister_devices(void)
490 {
491 	int i;
492 
493 	for (i = ARRAY_SIZE(exynos_drm_drivers) - 1; i >= 0; --i) {
494 		struct exynos_drm_driver_info *info = &exynos_drm_drivers[i];
495 		struct device *dev;
496 
497 		if (!info->driver || !(info->flags & DRM_VIRTUAL_DEVICE))
498 			continue;
499 
500 		while ((dev = bus_find_device(&platform_bus_type, NULL,
501 					    &info->driver->driver,
502 					    (void *)platform_bus_type.match))) {
503 			put_device(dev);
504 			platform_device_unregister(to_platform_device(dev));
505 		}
506 	}
507 }
508 
509 static int exynos_drm_register_devices(void)
510 {
511 	struct platform_device *pdev;
512 	int i;
513 
514 	for (i = 0; i < ARRAY_SIZE(exynos_drm_drivers); ++i) {
515 		struct exynos_drm_driver_info *info = &exynos_drm_drivers[i];
516 
517 		if (!info->driver || !(info->flags & DRM_VIRTUAL_DEVICE))
518 			continue;
519 
520 		pdev = platform_device_register_simple(
521 					info->driver->driver.name, -1, NULL, 0);
522 		if (IS_ERR(pdev))
523 			goto fail;
524 	}
525 
526 	return 0;
527 fail:
528 	exynos_drm_unregister_devices();
529 	return PTR_ERR(pdev);
530 }
531 
532 static void exynos_drm_unregister_drivers(void)
533 {
534 	int i;
535 
536 	for (i = ARRAY_SIZE(exynos_drm_drivers) - 1; i >= 0; --i) {
537 		struct exynos_drm_driver_info *info = &exynos_drm_drivers[i];
538 
539 		if (!info->driver)
540 			continue;
541 
542 		platform_driver_unregister(info->driver);
543 	}
544 }
545 
546 static int exynos_drm_register_drivers(void)
547 {
548 	int i, ret;
549 
550 	for (i = 0; i < ARRAY_SIZE(exynos_drm_drivers); ++i) {
551 		struct exynos_drm_driver_info *info = &exynos_drm_drivers[i];
552 
553 		if (!info->driver)
554 			continue;
555 
556 		ret = platform_driver_register(info->driver);
557 		if (ret)
558 			goto fail;
559 	}
560 	return 0;
561 fail:
562 	exynos_drm_unregister_drivers();
563 	return ret;
564 }
565 
566 static int exynos_drm_init(void)
567 {
568 	int ret;
569 
570 	ret = exynos_drm_register_devices();
571 	if (ret)
572 		return ret;
573 
574 	ret = exynos_drm_register_drivers();
575 	if (ret)
576 		goto err_unregister_pdevs;
577 
578 	return 0;
579 
580 err_unregister_pdevs:
581 	exynos_drm_unregister_devices();
582 
583 	return ret;
584 }
585 
586 static void exynos_drm_exit(void)
587 {
588 	exynos_drm_unregister_drivers();
589 	exynos_drm_unregister_devices();
590 }
591 
592 module_init(exynos_drm_init);
593 module_exit(exynos_drm_exit);
594 
595 MODULE_AUTHOR("Inki Dae <inki.dae@samsung.com>");
596 MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
597 MODULE_AUTHOR("Seung-Woo Kim <sw0312.kim@samsung.com>");
598 MODULE_DESCRIPTION("Samsung SoC DRM Driver");
599 MODULE_LICENSE("GPL");
600