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