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