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-fb");
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 	/*
166 	 * enable drm irq mode.
167 	 * - with irq_enabled = true, we can use the vblank feature.
168 	 */
169 	drm_dev->irq_enabled = true;
170 
171 	ret = rockchip_drm_fbdev_init(drm_dev);
172 	if (ret)
173 		goto err_unbind_all;
174 
175 	/* init kms poll for handling hpd */
176 	drm_kms_helper_poll_init(drm_dev);
177 
178 	ret = drm_dev_register(drm_dev, 0);
179 	if (ret)
180 		goto err_kms_helper_poll_fini;
181 
182 	return 0;
183 err_kms_helper_poll_fini:
184 	drm_kms_helper_poll_fini(drm_dev);
185 	rockchip_drm_fbdev_fini(drm_dev);
186 err_unbind_all:
187 	component_unbind_all(dev, drm_dev);
188 err_iommu_cleanup:
189 	rockchip_iommu_cleanup(drm_dev);
190 err_free:
191 	drm_dev_put(drm_dev);
192 	return ret;
193 }
194 
195 static void rockchip_drm_unbind(struct device *dev)
196 {
197 	struct drm_device *drm_dev = dev_get_drvdata(dev);
198 
199 	drm_dev_unregister(drm_dev);
200 
201 	rockchip_drm_fbdev_fini(drm_dev);
202 	drm_kms_helper_poll_fini(drm_dev);
203 
204 	drm_atomic_helper_shutdown(drm_dev);
205 	component_unbind_all(dev, drm_dev);
206 	rockchip_iommu_cleanup(drm_dev);
207 
208 	drm_dev_put(drm_dev);
209 }
210 
211 static const struct file_operations rockchip_drm_driver_fops = {
212 	.owner = THIS_MODULE,
213 	.open = drm_open,
214 	.mmap = rockchip_gem_mmap,
215 	.poll = drm_poll,
216 	.read = drm_read,
217 	.unlocked_ioctl = drm_ioctl,
218 	.compat_ioctl = drm_compat_ioctl,
219 	.release = drm_release,
220 };
221 
222 static const struct drm_driver rockchip_drm_driver = {
223 	.driver_features	= DRIVER_MODESET | DRIVER_GEM | DRIVER_ATOMIC,
224 	.lastclose		= drm_fb_helper_lastclose,
225 	.dumb_create		= rockchip_gem_dumb_create,
226 	.prime_handle_to_fd	= drm_gem_prime_handle_to_fd,
227 	.prime_fd_to_handle	= drm_gem_prime_fd_to_handle,
228 	.gem_prime_import_sg_table	= rockchip_gem_prime_import_sg_table,
229 	.gem_prime_mmap		= rockchip_gem_mmap_buf,
230 	.fops			= &rockchip_drm_driver_fops,
231 	.name	= DRIVER_NAME,
232 	.desc	= DRIVER_DESC,
233 	.date	= DRIVER_DATE,
234 	.major	= DRIVER_MAJOR,
235 	.minor	= DRIVER_MINOR,
236 };
237 
238 #ifdef CONFIG_PM_SLEEP
239 static int rockchip_drm_sys_suspend(struct device *dev)
240 {
241 	struct drm_device *drm = dev_get_drvdata(dev);
242 
243 	return drm_mode_config_helper_suspend(drm);
244 }
245 
246 static int rockchip_drm_sys_resume(struct device *dev)
247 {
248 	struct drm_device *drm = dev_get_drvdata(dev);
249 
250 	return drm_mode_config_helper_resume(drm);
251 }
252 #endif
253 
254 static const struct dev_pm_ops rockchip_drm_pm_ops = {
255 	SET_SYSTEM_SLEEP_PM_OPS(rockchip_drm_sys_suspend,
256 				rockchip_drm_sys_resume)
257 };
258 
259 #define MAX_ROCKCHIP_SUB_DRIVERS 16
260 static struct platform_driver *rockchip_sub_drivers[MAX_ROCKCHIP_SUB_DRIVERS];
261 static int num_rockchip_sub_drivers;
262 
263 /*
264  * Check if a vop endpoint is leading to a rockchip subdriver or bridge.
265  * Should be called from the component bind stage of the drivers
266  * to ensure that all subdrivers are probed.
267  *
268  * @ep: endpoint of a rockchip vop
269  *
270  * returns true if subdriver, false if external bridge and -ENODEV
271  * if remote port does not contain a device.
272  */
273 int rockchip_drm_endpoint_is_subdriver(struct device_node *ep)
274 {
275 	struct device_node *node = of_graph_get_remote_port_parent(ep);
276 	struct platform_device *pdev;
277 	struct device_driver *drv;
278 	int i;
279 
280 	if (!node)
281 		return -ENODEV;
282 
283 	/* status disabled will prevent creation of platform-devices */
284 	pdev = of_find_device_by_node(node);
285 	of_node_put(node);
286 	if (!pdev)
287 		return -ENODEV;
288 
289 	/*
290 	 * All rockchip subdrivers have probed at this point, so
291 	 * any device not having a driver now is an external bridge.
292 	 */
293 	drv = pdev->dev.driver;
294 	if (!drv) {
295 		platform_device_put(pdev);
296 		return false;
297 	}
298 
299 	for (i = 0; i < num_rockchip_sub_drivers; i++) {
300 		if (rockchip_sub_drivers[i] == to_platform_driver(drv)) {
301 			platform_device_put(pdev);
302 			return true;
303 		}
304 	}
305 
306 	platform_device_put(pdev);
307 	return false;
308 }
309 
310 static int compare_dev(struct device *dev, void *data)
311 {
312 	return dev == (struct device *)data;
313 }
314 
315 static void rockchip_drm_match_remove(struct device *dev)
316 {
317 	struct device_link *link;
318 
319 	list_for_each_entry(link, &dev->links.consumers, s_node)
320 		device_link_del(link);
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 = platform_find_device_by_driver(p, &drv->driver);
334 			put_device(p);
335 			p = d;
336 
337 			if (!d)
338 				break;
339 
340 			device_link_add(dev, d, DL_FLAG_STATELESS);
341 			component_match_add(dev, &match, compare_dev, d);
342 		} while (true);
343 	}
344 
345 	if (IS_ERR(match))
346 		rockchip_drm_match_remove(dev);
347 
348 	return match ?: ERR_PTR(-ENODEV);
349 }
350 
351 static const struct component_master_ops rockchip_drm_ops = {
352 	.bind = rockchip_drm_bind,
353 	.unbind = rockchip_drm_unbind,
354 };
355 
356 static int rockchip_drm_platform_of_probe(struct device *dev)
357 {
358 	struct device_node *np = dev->of_node;
359 	struct device_node *port;
360 	bool found = false;
361 	int i;
362 
363 	if (!np)
364 		return -ENODEV;
365 
366 	for (i = 0;; i++) {
367 		struct device_node *iommu;
368 
369 		port = of_parse_phandle(np, "ports", i);
370 		if (!port)
371 			break;
372 
373 		if (!of_device_is_available(port->parent)) {
374 			of_node_put(port);
375 			continue;
376 		}
377 
378 		iommu = of_parse_phandle(port->parent, "iommus", 0);
379 		if (!iommu || !of_device_is_available(iommu->parent)) {
380 			DRM_DEV_DEBUG(dev,
381 				      "no iommu attached for %pOF, using non-iommu buffers\n",
382 				      port->parent);
383 			/*
384 			 * if there is a crtc not support iommu, force set all
385 			 * crtc use non-iommu buffer.
386 			 */
387 			is_support_iommu = false;
388 		}
389 
390 		found = true;
391 
392 		of_node_put(iommu);
393 		of_node_put(port);
394 	}
395 
396 	if (i == 0) {
397 		DRM_DEV_ERROR(dev, "missing 'ports' property\n");
398 		return -ENODEV;
399 	}
400 
401 	if (!found) {
402 		DRM_DEV_ERROR(dev,
403 			      "No available vop found for display-subsystem.\n");
404 		return -ENODEV;
405 	}
406 
407 	return 0;
408 }
409 
410 static int rockchip_drm_platform_probe(struct platform_device *pdev)
411 {
412 	struct device *dev = &pdev->dev;
413 	struct component_match *match = NULL;
414 	int ret;
415 
416 	ret = rockchip_drm_platform_of_probe(dev);
417 	if (ret)
418 		return ret;
419 
420 	match = rockchip_drm_match_add(dev);
421 	if (IS_ERR(match))
422 		return PTR_ERR(match);
423 
424 	ret = component_master_add_with_match(dev, &rockchip_drm_ops, match);
425 	if (ret < 0) {
426 		rockchip_drm_match_remove(dev);
427 		return ret;
428 	}
429 
430 	return 0;
431 }
432 
433 static int rockchip_drm_platform_remove(struct platform_device *pdev)
434 {
435 	component_master_del(&pdev->dev, &rockchip_drm_ops);
436 
437 	rockchip_drm_match_remove(&pdev->dev);
438 
439 	return 0;
440 }
441 
442 static void rockchip_drm_platform_shutdown(struct platform_device *pdev)
443 {
444 	struct drm_device *drm = platform_get_drvdata(pdev);
445 
446 	if (drm)
447 		drm_atomic_helper_shutdown(drm);
448 }
449 
450 static const struct of_device_id rockchip_drm_dt_ids[] = {
451 	{ .compatible = "rockchip,display-subsystem", },
452 	{ /* sentinel */ },
453 };
454 MODULE_DEVICE_TABLE(of, rockchip_drm_dt_ids);
455 
456 static struct platform_driver rockchip_drm_platform_driver = {
457 	.probe = rockchip_drm_platform_probe,
458 	.remove = rockchip_drm_platform_remove,
459 	.shutdown = rockchip_drm_platform_shutdown,
460 	.driver = {
461 		.name = "rockchip-drm",
462 		.of_match_table = rockchip_drm_dt_ids,
463 		.pm = &rockchip_drm_pm_ops,
464 	},
465 };
466 
467 #define ADD_ROCKCHIP_SUB_DRIVER(drv, cond) { \
468 	if (IS_ENABLED(cond) && \
469 	    !WARN_ON(num_rockchip_sub_drivers >= MAX_ROCKCHIP_SUB_DRIVERS)) \
470 		rockchip_sub_drivers[num_rockchip_sub_drivers++] = &drv; \
471 }
472 
473 static int __init rockchip_drm_init(void)
474 {
475 	int ret;
476 
477 	num_rockchip_sub_drivers = 0;
478 	ADD_ROCKCHIP_SUB_DRIVER(vop_platform_driver, CONFIG_DRM_ROCKCHIP);
479 	ADD_ROCKCHIP_SUB_DRIVER(rockchip_lvds_driver,
480 				CONFIG_ROCKCHIP_LVDS);
481 	ADD_ROCKCHIP_SUB_DRIVER(rockchip_dp_driver,
482 				CONFIG_ROCKCHIP_ANALOGIX_DP);
483 	ADD_ROCKCHIP_SUB_DRIVER(cdn_dp_driver, CONFIG_ROCKCHIP_CDN_DP);
484 	ADD_ROCKCHIP_SUB_DRIVER(dw_hdmi_rockchip_pltfm_driver,
485 				CONFIG_ROCKCHIP_DW_HDMI);
486 	ADD_ROCKCHIP_SUB_DRIVER(dw_mipi_dsi_rockchip_driver,
487 				CONFIG_ROCKCHIP_DW_MIPI_DSI);
488 	ADD_ROCKCHIP_SUB_DRIVER(inno_hdmi_driver, CONFIG_ROCKCHIP_INNO_HDMI);
489 	ADD_ROCKCHIP_SUB_DRIVER(rk3066_hdmi_driver,
490 				CONFIG_ROCKCHIP_RK3066_HDMI);
491 
492 	ret = platform_register_drivers(rockchip_sub_drivers,
493 					num_rockchip_sub_drivers);
494 	if (ret)
495 		return ret;
496 
497 	ret = platform_driver_register(&rockchip_drm_platform_driver);
498 	if (ret)
499 		goto err_unreg_drivers;
500 
501 	return 0;
502 
503 err_unreg_drivers:
504 	platform_unregister_drivers(rockchip_sub_drivers,
505 				    num_rockchip_sub_drivers);
506 	return ret;
507 }
508 
509 static void __exit rockchip_drm_fini(void)
510 {
511 	platform_driver_unregister(&rockchip_drm_platform_driver);
512 
513 	platform_unregister_drivers(rockchip_sub_drivers,
514 				    num_rockchip_sub_drivers);
515 }
516 
517 module_init(rockchip_drm_init);
518 module_exit(rockchip_drm_fini);
519 
520 MODULE_AUTHOR("Mark Yao <mark.yao@rock-chips.com>");
521 MODULE_DESCRIPTION("ROCKCHIP DRM Driver");
522 MODULE_LICENSE("GPL v2");
523