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