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