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