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 
153 	return  drm_mode_config_helper_suspend(drm_dev);
154 }
155 
156 static void exynos_drm_resume(struct device *dev)
157 {
158 	struct drm_device *drm_dev = dev_get_drvdata(dev);
159 
160 	drm_mode_config_helper_resume(drm_dev);
161 }
162 
163 static const struct dev_pm_ops exynos_drm_pm_ops = {
164 	.prepare = exynos_drm_suspend,
165 	.complete = exynos_drm_resume,
166 };
167 
168 /* forward declaration */
169 static struct platform_driver exynos_drm_platform_driver;
170 
171 struct exynos_drm_driver_info {
172 	struct platform_driver *driver;
173 	unsigned int flags;
174 };
175 
176 #define DRM_COMPONENT_DRIVER	BIT(0)	/* supports component framework */
177 #define DRM_VIRTUAL_DEVICE	BIT(1)	/* create virtual platform device */
178 #define DRM_DMA_DEVICE		BIT(2)	/* can be used for dma allocations */
179 #define DRM_FIMC_DEVICE		BIT(3)	/* devices shared with V4L2 subsystem */
180 
181 #define DRV_PTR(drv, cond) (IS_ENABLED(cond) ? &drv : NULL)
182 
183 /*
184  * Connector drivers should not be placed before associated crtc drivers,
185  * because connector requires pipe number of its crtc during initialization.
186  */
187 static struct exynos_drm_driver_info exynos_drm_drivers[] = {
188 	{
189 		DRV_PTR(fimd_driver, CONFIG_DRM_EXYNOS_FIMD),
190 		DRM_COMPONENT_DRIVER | DRM_DMA_DEVICE
191 	}, {
192 		DRV_PTR(exynos5433_decon_driver, CONFIG_DRM_EXYNOS5433_DECON),
193 		DRM_COMPONENT_DRIVER | DRM_DMA_DEVICE
194 	}, {
195 		DRV_PTR(decon_driver, CONFIG_DRM_EXYNOS7_DECON),
196 		DRM_COMPONENT_DRIVER | DRM_DMA_DEVICE
197 	}, {
198 		DRV_PTR(mixer_driver, CONFIG_DRM_EXYNOS_MIXER),
199 		DRM_COMPONENT_DRIVER | DRM_DMA_DEVICE
200 	}, {
201 		DRV_PTR(mic_driver, CONFIG_DRM_EXYNOS_MIC),
202 		DRM_COMPONENT_DRIVER
203 	}, {
204 		DRV_PTR(dp_driver, CONFIG_DRM_EXYNOS_DP),
205 		DRM_COMPONENT_DRIVER
206 	}, {
207 		DRV_PTR(dsi_driver, CONFIG_DRM_EXYNOS_DSI),
208 		DRM_COMPONENT_DRIVER
209 	}, {
210 		DRV_PTR(hdmi_driver, CONFIG_DRM_EXYNOS_HDMI),
211 		DRM_COMPONENT_DRIVER
212 	}, {
213 		DRV_PTR(vidi_driver, CONFIG_DRM_EXYNOS_VIDI),
214 		DRM_COMPONENT_DRIVER | DRM_VIRTUAL_DEVICE
215 	}, {
216 		DRV_PTR(g2d_driver, CONFIG_DRM_EXYNOS_G2D),
217 		DRM_COMPONENT_DRIVER
218 	}, {
219 		DRV_PTR(fimc_driver, CONFIG_DRM_EXYNOS_FIMC),
220 		DRM_COMPONENT_DRIVER | DRM_FIMC_DEVICE,
221 	}, {
222 		DRV_PTR(rotator_driver, CONFIG_DRM_EXYNOS_ROTATOR),
223 		DRM_COMPONENT_DRIVER
224 	}, {
225 		DRV_PTR(scaler_driver, CONFIG_DRM_EXYNOS_SCALER),
226 		DRM_COMPONENT_DRIVER
227 	}, {
228 		DRV_PTR(gsc_driver, CONFIG_DRM_EXYNOS_GSC),
229 		DRM_COMPONENT_DRIVER
230 	}, {
231 		&exynos_drm_platform_driver,
232 		DRM_VIRTUAL_DEVICE
233 	}
234 };
235 
236 static int compare_dev(struct device *dev, void *data)
237 {
238 	return dev == (struct device *)data;
239 }
240 
241 static struct component_match *exynos_drm_match_add(struct device *dev)
242 {
243 	struct component_match *match = NULL;
244 	int i;
245 
246 	for (i = 0; i < ARRAY_SIZE(exynos_drm_drivers); ++i) {
247 		struct exynos_drm_driver_info *info = &exynos_drm_drivers[i];
248 		struct device *p = NULL, *d;
249 
250 		if (!info->driver || !(info->flags & DRM_COMPONENT_DRIVER))
251 			continue;
252 
253 		while ((d = bus_find_device(&platform_bus_type, p,
254 					    &info->driver->driver,
255 					    (void *)platform_bus_type.match))) {
256 			put_device(p);
257 
258 			if (!(info->flags & DRM_FIMC_DEVICE) ||
259 			    exynos_drm_check_fimc_device(d) == 0)
260 				component_match_add(dev, &match,
261 						    compare_dev, d);
262 			p = d;
263 		}
264 		put_device(p);
265 	}
266 
267 	return match ?: ERR_PTR(-ENODEV);
268 }
269 
270 static struct device *exynos_drm_get_dma_device(void)
271 {
272 	int i;
273 
274 	for (i = 0; i < ARRAY_SIZE(exynos_drm_drivers); ++i) {
275 		struct exynos_drm_driver_info *info = &exynos_drm_drivers[i];
276 		struct device *dev;
277 
278 		if (!info->driver || !(info->flags & DRM_DMA_DEVICE))
279 			continue;
280 
281 		while ((dev = bus_find_device(&platform_bus_type, NULL,
282 					    &info->driver->driver,
283 					    (void *)platform_bus_type.match))) {
284 			put_device(dev);
285 			return dev;
286 		}
287 	}
288 	return NULL;
289 }
290 
291 static int exynos_drm_bind(struct device *dev)
292 {
293 	struct exynos_drm_private *private;
294 	struct drm_encoder *encoder;
295 	struct drm_device *drm;
296 	unsigned int clone_mask;
297 	int cnt, ret;
298 
299 	drm = drm_dev_alloc(&exynos_drm_driver, dev);
300 	if (IS_ERR(drm))
301 		return PTR_ERR(drm);
302 
303 	private = kzalloc(sizeof(struct exynos_drm_private), GFP_KERNEL);
304 	if (!private) {
305 		ret = -ENOMEM;
306 		goto err_free_drm;
307 	}
308 
309 	init_waitqueue_head(&private->wait);
310 	spin_lock_init(&private->lock);
311 
312 	dev_set_drvdata(dev, drm);
313 	drm->dev_private = (void *)private;
314 
315 	/* the first real CRTC device is used for all dma mapping operations */
316 	private->dma_dev = exynos_drm_get_dma_device();
317 	if (!private->dma_dev) {
318 		DRM_ERROR("no device found for DMA mapping operations.\n");
319 		ret = -ENODEV;
320 		goto err_free_private;
321 	}
322 	DRM_INFO("Exynos DRM: using %s device for DMA mapping operations\n",
323 		 dev_name(private->dma_dev));
324 
325 	/* create common IOMMU mapping for all devices attached to Exynos DRM */
326 	ret = drm_create_iommu_mapping(drm);
327 	if (ret < 0) {
328 		DRM_ERROR("failed to create iommu mapping.\n");
329 		goto err_free_private;
330 	}
331 
332 	drm_mode_config_init(drm);
333 
334 	exynos_drm_mode_config_init(drm);
335 
336 	/* setup possible_clones. */
337 	cnt = 0;
338 	clone_mask = 0;
339 	list_for_each_entry(encoder, &drm->mode_config.encoder_list, head)
340 		clone_mask |= (1 << (cnt++));
341 
342 	list_for_each_entry(encoder, &drm->mode_config.encoder_list, head)
343 		encoder->possible_clones = clone_mask;
344 
345 	/* Try to bind all sub drivers. */
346 	ret = component_bind_all(drm->dev, drm);
347 	if (ret)
348 		goto err_mode_config_cleanup;
349 
350 	ret = drm_vblank_init(drm, drm->mode_config.num_crtc);
351 	if (ret)
352 		goto err_unbind_all;
353 
354 	drm_mode_config_reset(drm);
355 
356 	/*
357 	 * enable drm irq mode.
358 	 * - with irq_enabled = true, we can use the vblank feature.
359 	 *
360 	 * P.S. note that we wouldn't use drm irq handler but
361 	 *	just specific driver own one instead because
362 	 *	drm framework supports only one irq handler.
363 	 */
364 	drm->irq_enabled = true;
365 
366 	/* init kms poll for handling hpd */
367 	drm_kms_helper_poll_init(drm);
368 
369 	ret = exynos_drm_fbdev_init(drm);
370 	if (ret)
371 		goto err_cleanup_poll;
372 
373 	/* register the DRM device */
374 	ret = drm_dev_register(drm, 0);
375 	if (ret < 0)
376 		goto err_cleanup_fbdev;
377 
378 	return 0;
379 
380 err_cleanup_fbdev:
381 	exynos_drm_fbdev_fini(drm);
382 err_cleanup_poll:
383 	drm_kms_helper_poll_fini(drm);
384 err_unbind_all:
385 	component_unbind_all(drm->dev, drm);
386 err_mode_config_cleanup:
387 	drm_mode_config_cleanup(drm);
388 	drm_release_iommu_mapping(drm);
389 err_free_private:
390 	kfree(private);
391 err_free_drm:
392 	drm_dev_put(drm);
393 
394 	return ret;
395 }
396 
397 static void exynos_drm_unbind(struct device *dev)
398 {
399 	struct drm_device *drm = dev_get_drvdata(dev);
400 
401 	drm_dev_unregister(drm);
402 
403 	exynos_drm_fbdev_fini(drm);
404 	drm_kms_helper_poll_fini(drm);
405 
406 	component_unbind_all(drm->dev, drm);
407 	drm_mode_config_cleanup(drm);
408 	drm_release_iommu_mapping(drm);
409 
410 	kfree(drm->dev_private);
411 	drm->dev_private = NULL;
412 	dev_set_drvdata(dev, NULL);
413 
414 	drm_dev_put(drm);
415 }
416 
417 static const struct component_master_ops exynos_drm_ops = {
418 	.bind		= exynos_drm_bind,
419 	.unbind		= exynos_drm_unbind,
420 };
421 
422 static int exynos_drm_platform_probe(struct platform_device *pdev)
423 {
424 	struct component_match *match;
425 
426 	pdev->dev.coherent_dma_mask = DMA_BIT_MASK(32);
427 
428 	match = exynos_drm_match_add(&pdev->dev);
429 	if (IS_ERR(match))
430 		return PTR_ERR(match);
431 
432 	return component_master_add_with_match(&pdev->dev, &exynos_drm_ops,
433 					       match);
434 }
435 
436 static int exynos_drm_platform_remove(struct platform_device *pdev)
437 {
438 	component_master_del(&pdev->dev, &exynos_drm_ops);
439 	return 0;
440 }
441 
442 static struct platform_driver exynos_drm_platform_driver = {
443 	.probe	= exynos_drm_platform_probe,
444 	.remove	= exynos_drm_platform_remove,
445 	.driver	= {
446 		.name	= "exynos-drm",
447 		.pm	= &exynos_drm_pm_ops,
448 	},
449 };
450 
451 static void exynos_drm_unregister_devices(void)
452 {
453 	int i;
454 
455 	for (i = ARRAY_SIZE(exynos_drm_drivers) - 1; i >= 0; --i) {
456 		struct exynos_drm_driver_info *info = &exynos_drm_drivers[i];
457 		struct device *dev;
458 
459 		if (!info->driver || !(info->flags & DRM_VIRTUAL_DEVICE))
460 			continue;
461 
462 		while ((dev = bus_find_device(&platform_bus_type, NULL,
463 					    &info->driver->driver,
464 					    (void *)platform_bus_type.match))) {
465 			put_device(dev);
466 			platform_device_unregister(to_platform_device(dev));
467 		}
468 	}
469 }
470 
471 static int exynos_drm_register_devices(void)
472 {
473 	struct platform_device *pdev;
474 	int i;
475 
476 	for (i = 0; i < ARRAY_SIZE(exynos_drm_drivers); ++i) {
477 		struct exynos_drm_driver_info *info = &exynos_drm_drivers[i];
478 
479 		if (!info->driver || !(info->flags & DRM_VIRTUAL_DEVICE))
480 			continue;
481 
482 		pdev = platform_device_register_simple(
483 					info->driver->driver.name, -1, NULL, 0);
484 		if (IS_ERR(pdev))
485 			goto fail;
486 	}
487 
488 	return 0;
489 fail:
490 	exynos_drm_unregister_devices();
491 	return PTR_ERR(pdev);
492 }
493 
494 static void exynos_drm_unregister_drivers(void)
495 {
496 	int i;
497 
498 	for (i = ARRAY_SIZE(exynos_drm_drivers) - 1; i >= 0; --i) {
499 		struct exynos_drm_driver_info *info = &exynos_drm_drivers[i];
500 
501 		if (!info->driver)
502 			continue;
503 
504 		platform_driver_unregister(info->driver);
505 	}
506 }
507 
508 static int exynos_drm_register_drivers(void)
509 {
510 	int i, ret;
511 
512 	for (i = 0; i < ARRAY_SIZE(exynos_drm_drivers); ++i) {
513 		struct exynos_drm_driver_info *info = &exynos_drm_drivers[i];
514 
515 		if (!info->driver)
516 			continue;
517 
518 		ret = platform_driver_register(info->driver);
519 		if (ret)
520 			goto fail;
521 	}
522 	return 0;
523 fail:
524 	exynos_drm_unregister_drivers();
525 	return ret;
526 }
527 
528 static int exynos_drm_init(void)
529 {
530 	int ret;
531 
532 	ret = exynos_drm_register_devices();
533 	if (ret)
534 		return ret;
535 
536 	ret = exynos_drm_register_drivers();
537 	if (ret)
538 		goto err_unregister_pdevs;
539 
540 	return 0;
541 
542 err_unregister_pdevs:
543 	exynos_drm_unregister_devices();
544 
545 	return ret;
546 }
547 
548 static void exynos_drm_exit(void)
549 {
550 	exynos_drm_unregister_drivers();
551 	exynos_drm_unregister_devices();
552 }
553 
554 module_init(exynos_drm_init);
555 module_exit(exynos_drm_exit);
556 
557 MODULE_AUTHOR("Inki Dae <inki.dae@samsung.com>");
558 MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
559 MODULE_AUTHOR("Seung-Woo Kim <sw0312.kim@samsung.com>");
560 MODULE_DESCRIPTION("Samsung SoC DRM Driver");
561 MODULE_LICENSE("GPL");
562