1 /*
2  * Copyright (C) Fuzhou Rockchip Electronics Co.Ltd
3  * Author:Mark Yao <mark.yao@rock-chips.com>
4  *
5  * based on exynos_drm_drv.c
6  *
7  * This software is licensed under the terms of the GNU General Public
8  * License version 2, as published by the Free Software Foundation, and
9  * may be copied, distributed, and modified under those terms.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  */
16 
17 #include <drm/drmP.h>
18 #include <drm/drm_crtc_helper.h>
19 #include <drm/drm_fb_helper.h>
20 #include <drm/drm_gem_cma_helper.h>
21 #include <drm/drm_of.h>
22 #include <linux/dma-mapping.h>
23 #include <linux/dma-iommu.h>
24 #include <linux/pm_runtime.h>
25 #include <linux/module.h>
26 #include <linux/of_graph.h>
27 #include <linux/component.h>
28 #include <linux/console.h>
29 #include <linux/iommu.h>
30 
31 #include "rockchip_drm_drv.h"
32 #include "rockchip_drm_fb.h"
33 #include "rockchip_drm_fbdev.h"
34 #include "rockchip_drm_gem.h"
35 
36 #define DRIVER_NAME	"rockchip"
37 #define DRIVER_DESC	"RockChip Soc DRM"
38 #define DRIVER_DATE	"20140818"
39 #define DRIVER_MAJOR	1
40 #define DRIVER_MINOR	0
41 
42 static bool is_support_iommu = true;
43 static struct drm_driver rockchip_drm_driver;
44 
45 /*
46  * Attach a (component) device to the shared drm dma mapping from master drm
47  * device.  This is used by the VOPs to map GEM buffers to a common DMA
48  * mapping.
49  */
50 int rockchip_drm_dma_attach_device(struct drm_device *drm_dev,
51 				   struct device *dev)
52 {
53 	struct rockchip_drm_private *private = drm_dev->dev_private;
54 	int ret;
55 
56 	if (!is_support_iommu)
57 		return 0;
58 
59 	ret = iommu_attach_device(private->domain, dev);
60 	if (ret) {
61 		DRM_DEV_ERROR(dev, "Failed to attach iommu device\n");
62 		return ret;
63 	}
64 
65 	return 0;
66 }
67 
68 void rockchip_drm_dma_detach_device(struct drm_device *drm_dev,
69 				    struct device *dev)
70 {
71 	struct rockchip_drm_private *private = drm_dev->dev_private;
72 	struct iommu_domain *domain = private->domain;
73 
74 	if (!is_support_iommu)
75 		return;
76 
77 	iommu_detach_device(domain, dev);
78 }
79 
80 static int rockchip_drm_init_iommu(struct drm_device *drm_dev)
81 {
82 	struct rockchip_drm_private *private = drm_dev->dev_private;
83 	struct iommu_domain_geometry *geometry;
84 	u64 start, end;
85 
86 	if (!is_support_iommu)
87 		return 0;
88 
89 	private->domain = iommu_domain_alloc(&platform_bus_type);
90 	if (!private->domain)
91 		return -ENOMEM;
92 
93 	geometry = &private->domain->geometry;
94 	start = geometry->aperture_start;
95 	end = geometry->aperture_end;
96 
97 	DRM_DEBUG("IOMMU context initialized (aperture: %#llx-%#llx)\n",
98 		  start, end);
99 	drm_mm_init(&private->mm, start, end - start + 1);
100 	mutex_init(&private->mm_lock);
101 
102 	return 0;
103 }
104 
105 static void rockchip_iommu_cleanup(struct drm_device *drm_dev)
106 {
107 	struct rockchip_drm_private *private = drm_dev->dev_private;
108 
109 	if (!is_support_iommu)
110 		return;
111 
112 	drm_mm_takedown(&private->mm);
113 	iommu_domain_free(private->domain);
114 }
115 
116 static int rockchip_drm_bind(struct device *dev)
117 {
118 	struct drm_device *drm_dev;
119 	struct rockchip_drm_private *private;
120 	int ret;
121 
122 	drm_dev = drm_dev_alloc(&rockchip_drm_driver, dev);
123 	if (IS_ERR(drm_dev))
124 		return PTR_ERR(drm_dev);
125 
126 	dev_set_drvdata(dev, drm_dev);
127 
128 	private = devm_kzalloc(drm_dev->dev, sizeof(*private), GFP_KERNEL);
129 	if (!private) {
130 		ret = -ENOMEM;
131 		goto err_free;
132 	}
133 
134 	drm_dev->dev_private = private;
135 
136 	INIT_LIST_HEAD(&private->psr_list);
137 	spin_lock_init(&private->psr_list_lock);
138 
139 	ret = rockchip_drm_init_iommu(drm_dev);
140 	if (ret)
141 		goto err_free;
142 
143 	drm_mode_config_init(drm_dev);
144 
145 	rockchip_drm_mode_config_init(drm_dev);
146 
147 	/* Try to bind all sub drivers. */
148 	ret = component_bind_all(dev, drm_dev);
149 	if (ret)
150 		goto err_mode_config_cleanup;
151 
152 	ret = drm_vblank_init(drm_dev, drm_dev->mode_config.num_crtc);
153 	if (ret)
154 		goto err_unbind_all;
155 
156 	drm_mode_config_reset(drm_dev);
157 
158 	/*
159 	 * enable drm irq mode.
160 	 * - with irq_enabled = true, we can use the vblank feature.
161 	 */
162 	drm_dev->irq_enabled = true;
163 
164 	ret = rockchip_drm_fbdev_init(drm_dev);
165 	if (ret)
166 		goto err_unbind_all;
167 
168 	/* init kms poll for handling hpd */
169 	drm_kms_helper_poll_init(drm_dev);
170 
171 	ret = drm_dev_register(drm_dev, 0);
172 	if (ret)
173 		goto err_kms_helper_poll_fini;
174 
175 	return 0;
176 err_kms_helper_poll_fini:
177 	drm_kms_helper_poll_fini(drm_dev);
178 	rockchip_drm_fbdev_fini(drm_dev);
179 err_unbind_all:
180 	component_unbind_all(dev, drm_dev);
181 err_mode_config_cleanup:
182 	drm_mode_config_cleanup(drm_dev);
183 	rockchip_iommu_cleanup(drm_dev);
184 err_free:
185 	drm_dev->dev_private = NULL;
186 	dev_set_drvdata(dev, NULL);
187 	drm_dev_unref(drm_dev);
188 	return ret;
189 }
190 
191 static void rockchip_drm_unbind(struct device *dev)
192 {
193 	struct drm_device *drm_dev = dev_get_drvdata(dev);
194 
195 	drm_dev_unregister(drm_dev);
196 
197 	rockchip_drm_fbdev_fini(drm_dev);
198 	drm_kms_helper_poll_fini(drm_dev);
199 
200 	drm_atomic_helper_shutdown(drm_dev);
201 	component_unbind_all(dev, drm_dev);
202 	drm_mode_config_cleanup(drm_dev);
203 	rockchip_iommu_cleanup(drm_dev);
204 
205 	drm_dev->dev_private = NULL;
206 	dev_set_drvdata(dev, NULL);
207 	drm_dev_unref(drm_dev);
208 }
209 
210 static void rockchip_drm_lastclose(struct drm_device *dev)
211 {
212 	struct rockchip_drm_private *priv = dev->dev_private;
213 
214 	drm_fb_helper_restore_fbdev_mode_unlocked(&priv->fbdev_helper);
215 }
216 
217 static const struct file_operations rockchip_drm_driver_fops = {
218 	.owner = THIS_MODULE,
219 	.open = drm_open,
220 	.mmap = rockchip_gem_mmap,
221 	.poll = drm_poll,
222 	.read = drm_read,
223 	.unlocked_ioctl = drm_ioctl,
224 	.compat_ioctl = drm_compat_ioctl,
225 	.release = drm_release,
226 };
227 
228 static struct drm_driver rockchip_drm_driver = {
229 	.driver_features	= DRIVER_MODESET | DRIVER_GEM |
230 				  DRIVER_PRIME | DRIVER_ATOMIC,
231 	.lastclose		= rockchip_drm_lastclose,
232 	.gem_vm_ops		= &drm_gem_cma_vm_ops,
233 	.gem_free_object_unlocked = rockchip_gem_free_object,
234 	.dumb_create		= rockchip_gem_dumb_create,
235 	.prime_handle_to_fd	= drm_gem_prime_handle_to_fd,
236 	.prime_fd_to_handle	= drm_gem_prime_fd_to_handle,
237 	.gem_prime_import	= drm_gem_prime_import,
238 	.gem_prime_export	= drm_gem_prime_export,
239 	.gem_prime_get_sg_table	= rockchip_gem_prime_get_sg_table,
240 	.gem_prime_vmap		= rockchip_gem_prime_vmap,
241 	.gem_prime_vunmap	= rockchip_gem_prime_vunmap,
242 	.gem_prime_mmap		= rockchip_gem_mmap_buf,
243 	.fops			= &rockchip_drm_driver_fops,
244 	.name	= DRIVER_NAME,
245 	.desc	= DRIVER_DESC,
246 	.date	= DRIVER_DATE,
247 	.major	= DRIVER_MAJOR,
248 	.minor	= DRIVER_MINOR,
249 };
250 
251 #ifdef CONFIG_PM_SLEEP
252 static void rockchip_drm_fb_suspend(struct drm_device *drm)
253 {
254 	struct rockchip_drm_private *priv = drm->dev_private;
255 
256 	console_lock();
257 	drm_fb_helper_set_suspend(&priv->fbdev_helper, 1);
258 	console_unlock();
259 }
260 
261 static void rockchip_drm_fb_resume(struct drm_device *drm)
262 {
263 	struct rockchip_drm_private *priv = drm->dev_private;
264 
265 	console_lock();
266 	drm_fb_helper_set_suspend(&priv->fbdev_helper, 0);
267 	console_unlock();
268 }
269 
270 static int rockchip_drm_sys_suspend(struct device *dev)
271 {
272 	struct drm_device *drm = dev_get_drvdata(dev);
273 	struct rockchip_drm_private *priv;
274 
275 	if (!drm)
276 		return 0;
277 
278 	drm_kms_helper_poll_disable(drm);
279 	rockchip_drm_fb_suspend(drm);
280 
281 	priv = drm->dev_private;
282 	priv->state = drm_atomic_helper_suspend(drm);
283 	if (IS_ERR(priv->state)) {
284 		rockchip_drm_fb_resume(drm);
285 		drm_kms_helper_poll_enable(drm);
286 		return PTR_ERR(priv->state);
287 	}
288 
289 	return 0;
290 }
291 
292 static int rockchip_drm_sys_resume(struct device *dev)
293 {
294 	struct drm_device *drm = dev_get_drvdata(dev);
295 	struct rockchip_drm_private *priv;
296 
297 	if (!drm)
298 		return 0;
299 
300 	priv = drm->dev_private;
301 	drm_atomic_helper_resume(drm, priv->state);
302 	rockchip_drm_fb_resume(drm);
303 	drm_kms_helper_poll_enable(drm);
304 
305 	return 0;
306 }
307 #endif
308 
309 static const struct dev_pm_ops rockchip_drm_pm_ops = {
310 	SET_SYSTEM_SLEEP_PM_OPS(rockchip_drm_sys_suspend,
311 				rockchip_drm_sys_resume)
312 };
313 
314 #define MAX_ROCKCHIP_SUB_DRIVERS 16
315 static struct platform_driver *rockchip_sub_drivers[MAX_ROCKCHIP_SUB_DRIVERS];
316 static int num_rockchip_sub_drivers;
317 
318 static int compare_dev(struct device *dev, void *data)
319 {
320 	return dev == (struct device *)data;
321 }
322 
323 static struct component_match *rockchip_drm_match_add(struct device *dev)
324 {
325 	struct component_match *match = NULL;
326 	int i;
327 
328 	for (i = 0; i < num_rockchip_sub_drivers; i++) {
329 		struct platform_driver *drv = rockchip_sub_drivers[i];
330 		struct device *p = NULL, *d;
331 
332 		do {
333 			d = bus_find_device(&platform_bus_type, p, &drv->driver,
334 					    (void *)platform_bus_type.match);
335 			put_device(p);
336 			p = d;
337 
338 			if (!d)
339 				break;
340 			component_match_add(dev, &match, compare_dev, d);
341 		} while (true);
342 	}
343 
344 	return match ?: ERR_PTR(-ENODEV);
345 }
346 
347 static const struct component_master_ops rockchip_drm_ops = {
348 	.bind = rockchip_drm_bind,
349 	.unbind = rockchip_drm_unbind,
350 };
351 
352 static int rockchip_drm_platform_of_probe(struct device *dev)
353 {
354 	struct device_node *np = dev->of_node;
355 	struct device_node *port;
356 	bool found = false;
357 	int i;
358 
359 	if (!np)
360 		return -ENODEV;
361 
362 	for (i = 0;; i++) {
363 		struct device_node *iommu;
364 
365 		port = of_parse_phandle(np, "ports", i);
366 		if (!port)
367 			break;
368 
369 		if (!of_device_is_available(port->parent)) {
370 			of_node_put(port);
371 			continue;
372 		}
373 
374 		iommu = of_parse_phandle(port->parent, "iommus", 0);
375 		if (!iommu || !of_device_is_available(iommu->parent)) {
376 			DRM_DEV_DEBUG(dev,
377 				      "no iommu attached for %pOF, using non-iommu buffers\n",
378 				      port->parent);
379 			/*
380 			 * if there is a crtc not support iommu, force set all
381 			 * crtc use non-iommu buffer.
382 			 */
383 			is_support_iommu = false;
384 		}
385 
386 		found = true;
387 
388 		of_node_put(iommu);
389 		of_node_put(port);
390 	}
391 
392 	if (i == 0) {
393 		DRM_DEV_ERROR(dev, "missing 'ports' property\n");
394 		return -ENODEV;
395 	}
396 
397 	if (!found) {
398 		DRM_DEV_ERROR(dev,
399 			      "No available vop found for display-subsystem.\n");
400 		return -ENODEV;
401 	}
402 
403 	return 0;
404 }
405 
406 static int rockchip_drm_platform_probe(struct platform_device *pdev)
407 {
408 	struct device *dev = &pdev->dev;
409 	struct component_match *match = NULL;
410 	int ret;
411 
412 	ret = rockchip_drm_platform_of_probe(dev);
413 	if (ret)
414 		return ret;
415 
416 	match = rockchip_drm_match_add(dev);
417 	if (IS_ERR(match))
418 		return PTR_ERR(match);
419 
420 	return component_master_add_with_match(dev, &rockchip_drm_ops, match);
421 }
422 
423 static int rockchip_drm_platform_remove(struct platform_device *pdev)
424 {
425 	component_master_del(&pdev->dev, &rockchip_drm_ops);
426 
427 	return 0;
428 }
429 
430 static const struct of_device_id rockchip_drm_dt_ids[] = {
431 	{ .compatible = "rockchip,display-subsystem", },
432 	{ /* sentinel */ },
433 };
434 MODULE_DEVICE_TABLE(of, rockchip_drm_dt_ids);
435 
436 static struct platform_driver rockchip_drm_platform_driver = {
437 	.probe = rockchip_drm_platform_probe,
438 	.remove = rockchip_drm_platform_remove,
439 	.driver = {
440 		.name = "rockchip-drm",
441 		.of_match_table = rockchip_drm_dt_ids,
442 		.pm = &rockchip_drm_pm_ops,
443 	},
444 };
445 
446 #define ADD_ROCKCHIP_SUB_DRIVER(drv, cond) { \
447 	if (IS_ENABLED(cond) && \
448 	    !WARN_ON(num_rockchip_sub_drivers >= MAX_ROCKCHIP_SUB_DRIVERS)) \
449 		rockchip_sub_drivers[num_rockchip_sub_drivers++] = &drv; \
450 }
451 
452 static int __init rockchip_drm_init(void)
453 {
454 	int ret;
455 
456 	num_rockchip_sub_drivers = 0;
457 	ADD_ROCKCHIP_SUB_DRIVER(vop_platform_driver, CONFIG_DRM_ROCKCHIP);
458 	ADD_ROCKCHIP_SUB_DRIVER(rockchip_lvds_driver,
459 				CONFIG_ROCKCHIP_LVDS);
460 	ADD_ROCKCHIP_SUB_DRIVER(rockchip_dp_driver,
461 				CONFIG_ROCKCHIP_ANALOGIX_DP);
462 	ADD_ROCKCHIP_SUB_DRIVER(cdn_dp_driver, CONFIG_ROCKCHIP_CDN_DP);
463 	ADD_ROCKCHIP_SUB_DRIVER(dw_hdmi_rockchip_pltfm_driver,
464 				CONFIG_ROCKCHIP_DW_HDMI);
465 	ADD_ROCKCHIP_SUB_DRIVER(dw_mipi_dsi_driver,
466 				CONFIG_ROCKCHIP_DW_MIPI_DSI);
467 	ADD_ROCKCHIP_SUB_DRIVER(inno_hdmi_driver, CONFIG_ROCKCHIP_INNO_HDMI);
468 
469 	ret = platform_register_drivers(rockchip_sub_drivers,
470 					num_rockchip_sub_drivers);
471 	if (ret)
472 		return ret;
473 
474 	ret = platform_driver_register(&rockchip_drm_platform_driver);
475 	if (ret)
476 		goto err_unreg_drivers;
477 
478 	return 0;
479 
480 err_unreg_drivers:
481 	platform_unregister_drivers(rockchip_sub_drivers,
482 				    num_rockchip_sub_drivers);
483 	return ret;
484 }
485 
486 static void __exit rockchip_drm_fini(void)
487 {
488 	platform_driver_unregister(&rockchip_drm_platform_driver);
489 
490 	platform_unregister_drivers(rockchip_sub_drivers,
491 				    num_rockchip_sub_drivers);
492 }
493 
494 module_init(rockchip_drm_init);
495 module_exit(rockchip_drm_fini);
496 
497 MODULE_AUTHOR("Mark Yao <mark.yao@rock-chips.com>");
498 MODULE_DESCRIPTION("ROCKCHIP DRM Driver");
499 MODULE_LICENSE("GPL v2");
500