xref: /linux/drivers/gpu/drm/sun4i/sun4i_drv.c (revision 0a94608f0f7de9b1135ffea3546afe68eafef57f)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * Copyright (C) 2015 Free Electrons
4  * Copyright (C) 2015 NextThing Co
5  *
6  * Maxime Ripard <maxime.ripard@free-electrons.com>
7  */
8 
9 #include <linux/component.h>
10 #include <linux/kfifo.h>
11 #include <linux/module.h>
12 #include <linux/of_graph.h>
13 #include <linux/of_reserved_mem.h>
14 #include <linux/platform_device.h>
15 
16 #include <drm/drm_aperture.h>
17 #include <drm/drm_atomic_helper.h>
18 #include <drm/drm_drv.h>
19 #include <drm/drm_fb_cma_helper.h>
20 #include <drm/drm_fb_helper.h>
21 #include <drm/drm_gem_cma_helper.h>
22 #include <drm/drm_module.h>
23 #include <drm/drm_of.h>
24 #include <drm/drm_probe_helper.h>
25 #include <drm/drm_vblank.h>
26 
27 #include "sun4i_drv.h"
28 #include "sun4i_frontend.h"
29 #include "sun4i_framebuffer.h"
30 #include "sun4i_tcon.h"
31 #include "sun8i_tcon_top.h"
32 
33 static int drm_sun4i_gem_dumb_create(struct drm_file *file_priv,
34 				     struct drm_device *drm,
35 				     struct drm_mode_create_dumb *args)
36 {
37 	/* The hardware only allows even pitches for YUV buffers. */
38 	args->pitch = ALIGN(DIV_ROUND_UP(args->width * args->bpp, 8), 2);
39 
40 	return drm_gem_cma_dumb_create_internal(file_priv, drm, args);
41 }
42 
43 DEFINE_DRM_GEM_CMA_FOPS(sun4i_drv_fops);
44 
45 static const struct drm_driver sun4i_drv_driver = {
46 	.driver_features	= DRIVER_GEM | DRIVER_MODESET | DRIVER_ATOMIC,
47 
48 	/* Generic Operations */
49 	.fops			= &sun4i_drv_fops,
50 	.name			= "sun4i-drm",
51 	.desc			= "Allwinner sun4i Display Engine",
52 	.date			= "20150629",
53 	.major			= 1,
54 	.minor			= 0,
55 
56 	/* GEM Operations */
57 	DRM_GEM_CMA_DRIVER_OPS_WITH_DUMB_CREATE(drm_sun4i_gem_dumb_create),
58 };
59 
60 static int sun4i_drv_bind(struct device *dev)
61 {
62 	struct drm_device *drm;
63 	struct sun4i_drv *drv;
64 	int ret;
65 
66 	drm = drm_dev_alloc(&sun4i_drv_driver, dev);
67 	if (IS_ERR(drm))
68 		return PTR_ERR(drm);
69 
70 	drv = devm_kzalloc(dev, sizeof(*drv), GFP_KERNEL);
71 	if (!drv) {
72 		ret = -ENOMEM;
73 		goto free_drm;
74 	}
75 
76 	dev_set_drvdata(dev, drm);
77 	drm->dev_private = drv;
78 	INIT_LIST_HEAD(&drv->frontend_list);
79 	INIT_LIST_HEAD(&drv->engine_list);
80 	INIT_LIST_HEAD(&drv->tcon_list);
81 
82 	ret = of_reserved_mem_device_init(dev);
83 	if (ret && ret != -ENODEV) {
84 		dev_err(drm->dev, "Couldn't claim our memory region\n");
85 		goto free_drm;
86 	}
87 
88 	drm_mode_config_init(drm);
89 
90 	ret = component_bind_all(drm->dev, drm);
91 	if (ret) {
92 		dev_err(drm->dev, "Couldn't bind all pipelines components\n");
93 		goto cleanup_mode_config;
94 	}
95 
96 	/* drm_vblank_init calls kcalloc, which can fail */
97 	ret = drm_vblank_init(drm, drm->mode_config.num_crtc);
98 	if (ret)
99 		goto cleanup_mode_config;
100 
101 	/* Remove early framebuffers (ie. simplefb) */
102 	ret = drm_aperture_remove_framebuffers(false, &sun4i_drv_driver);
103 	if (ret)
104 		goto cleanup_mode_config;
105 
106 	sun4i_framebuffer_init(drm);
107 
108 	/* Enable connectors polling */
109 	drm_kms_helper_poll_init(drm);
110 
111 	ret = drm_dev_register(drm, 0);
112 	if (ret)
113 		goto finish_poll;
114 
115 	drm_fbdev_generic_setup(drm, 32);
116 
117 	return 0;
118 
119 finish_poll:
120 	drm_kms_helper_poll_fini(drm);
121 cleanup_mode_config:
122 	drm_mode_config_cleanup(drm);
123 	of_reserved_mem_device_release(dev);
124 free_drm:
125 	drm_dev_put(drm);
126 	return ret;
127 }
128 
129 static void sun4i_drv_unbind(struct device *dev)
130 {
131 	struct drm_device *drm = dev_get_drvdata(dev);
132 
133 	drm_dev_unregister(drm);
134 	drm_kms_helper_poll_fini(drm);
135 	drm_atomic_helper_shutdown(drm);
136 	drm_mode_config_cleanup(drm);
137 
138 	component_unbind_all(dev, NULL);
139 	of_reserved_mem_device_release(dev);
140 
141 	drm_dev_put(drm);
142 }
143 
144 static const struct component_master_ops sun4i_drv_master_ops = {
145 	.bind	= sun4i_drv_bind,
146 	.unbind	= sun4i_drv_unbind,
147 };
148 
149 static bool sun4i_drv_node_is_connector(struct device_node *node)
150 {
151 	return of_device_is_compatible(node, "hdmi-connector");
152 }
153 
154 static bool sun4i_drv_node_is_frontend(struct device_node *node)
155 {
156 	return of_device_is_compatible(node, "allwinner,sun4i-a10-display-frontend") ||
157 		of_device_is_compatible(node, "allwinner,sun5i-a13-display-frontend") ||
158 		of_device_is_compatible(node, "allwinner,sun6i-a31-display-frontend") ||
159 		of_device_is_compatible(node, "allwinner,sun7i-a20-display-frontend") ||
160 		of_device_is_compatible(node, "allwinner,sun8i-a23-display-frontend") ||
161 		of_device_is_compatible(node, "allwinner,sun8i-a33-display-frontend") ||
162 		of_device_is_compatible(node, "allwinner,sun9i-a80-display-frontend");
163 }
164 
165 static bool sun4i_drv_node_is_deu(struct device_node *node)
166 {
167 	return of_device_is_compatible(node, "allwinner,sun9i-a80-deu");
168 }
169 
170 static bool sun4i_drv_node_is_supported_frontend(struct device_node *node)
171 {
172 	if (IS_ENABLED(CONFIG_DRM_SUN4I_BACKEND))
173 		return !!of_match_node(sun4i_frontend_of_table, node);
174 
175 	return false;
176 }
177 
178 static bool sun4i_drv_node_is_tcon(struct device_node *node)
179 {
180 	return !!of_match_node(sun4i_tcon_of_table, node);
181 }
182 
183 static bool sun4i_drv_node_is_tcon_with_ch0(struct device_node *node)
184 {
185 	const struct of_device_id *match;
186 
187 	match = of_match_node(sun4i_tcon_of_table, node);
188 	if (match) {
189 		struct sun4i_tcon_quirks *quirks;
190 
191 		quirks = (struct sun4i_tcon_quirks *)match->data;
192 
193 		return quirks->has_channel_0;
194 	}
195 
196 	return false;
197 }
198 
199 static bool sun4i_drv_node_is_tcon_top(struct device_node *node)
200 {
201 	return IS_ENABLED(CONFIG_DRM_SUN8I_TCON_TOP) &&
202 		!!of_match_node(sun8i_tcon_top_of_table, node);
203 }
204 
205 /*
206  * The encoder drivers use drm_of_find_possible_crtcs to get upstream
207  * crtcs from the device tree using of_graph. For the results to be
208  * correct, encoders must be probed/bound after _all_ crtcs have been
209  * created. The existing code uses a depth first recursive traversal
210  * of the of_graph, which means the encoders downstream of the TCON
211  * get add right after the first TCON. The second TCON or CRTC will
212  * never be properly associated with encoders connected to it.
213  *
214  * Also, in a dual display pipeline setup, both frontends can feed
215  * either backend, and both backends can feed either TCON, we want
216  * all components of the same type to be added before the next type
217  * in the pipeline. Fortunately, the pipelines are perfectly symmetric,
218  * i.e. components of the same type are at the same depth when counted
219  * from the frontend. The only exception is the third pipeline in
220  * the A80 SoC, which we do not support anyway.
221  *
222  * Hence we can use a breadth first search traversal order to add
223  * components. We do not need to check for duplicates. The component
224  * matching system handles this for us.
225  */
226 struct endpoint_list {
227 	DECLARE_KFIFO(fifo, struct device_node *, 16);
228 };
229 
230 static void sun4i_drv_traverse_endpoints(struct endpoint_list *list,
231 					 struct device_node *node,
232 					 int port_id)
233 {
234 	struct device_node *ep, *remote, *port;
235 
236 	port = of_graph_get_port_by_id(node, port_id);
237 	if (!port) {
238 		DRM_DEBUG_DRIVER("No output to bind on port %d\n", port_id);
239 		return;
240 	}
241 
242 	for_each_available_child_of_node(port, ep) {
243 		remote = of_graph_get_remote_port_parent(ep);
244 		if (!remote) {
245 			DRM_DEBUG_DRIVER("Error retrieving the output node\n");
246 			continue;
247 		}
248 
249 		if (sun4i_drv_node_is_tcon(node)) {
250 			/*
251 			 * TCON TOP is always probed before TCON. However, TCON
252 			 * points back to TCON TOP when it is source for HDMI.
253 			 * We have to skip it here to prevent infinite looping
254 			 * between TCON TOP and TCON.
255 			 */
256 			if (sun4i_drv_node_is_tcon_top(remote)) {
257 				DRM_DEBUG_DRIVER("TCON output endpoint is TCON TOP... skipping\n");
258 				of_node_put(remote);
259 				continue;
260 			}
261 
262 			/*
263 			 * If the node is our TCON with channel 0, the first
264 			 * port is used for panel or bridges, and will not be
265 			 * part of the component framework.
266 			 */
267 			if (sun4i_drv_node_is_tcon_with_ch0(node)) {
268 				struct of_endpoint endpoint;
269 
270 				if (of_graph_parse_endpoint(ep, &endpoint)) {
271 					DRM_DEBUG_DRIVER("Couldn't parse endpoint\n");
272 					of_node_put(remote);
273 					continue;
274 				}
275 
276 				if (!endpoint.id) {
277 					DRM_DEBUG_DRIVER("Endpoint is our panel... skipping\n");
278 					of_node_put(remote);
279 					continue;
280 				}
281 			}
282 		}
283 
284 		kfifo_put(&list->fifo, remote);
285 	}
286 }
287 
288 static int sun4i_drv_add_endpoints(struct device *dev,
289 				   struct endpoint_list *list,
290 				   struct component_match **match,
291 				   struct device_node *node)
292 {
293 	int count = 0;
294 
295 	/*
296 	 * The frontend has been disabled in some of our old device
297 	 * trees. If we find a node that is the frontend and is
298 	 * disabled, we should just follow through and parse its
299 	 * child, but without adding it to the component list.
300 	 * Otherwise, we obviously want to add it to the list.
301 	 */
302 	if (!sun4i_drv_node_is_frontend(node) &&
303 	    !of_device_is_available(node))
304 		return 0;
305 
306 	/*
307 	 * The connectors will be the last nodes in our pipeline, we
308 	 * can just bail out.
309 	 */
310 	if (sun4i_drv_node_is_connector(node))
311 		return 0;
312 
313 	/*
314 	 * If the device is either just a regular device, or an
315 	 * enabled frontend supported by the driver, we add it to our
316 	 * component list.
317 	 */
318 	if (!(sun4i_drv_node_is_frontend(node) ||
319 	      sun4i_drv_node_is_deu(node)) ||
320 	    (sun4i_drv_node_is_supported_frontend(node) &&
321 	     of_device_is_available(node))) {
322 		/* Add current component */
323 		DRM_DEBUG_DRIVER("Adding component %pOF\n", node);
324 		drm_of_component_match_add(dev, match, component_compare_of, node);
325 		count++;
326 	}
327 
328 	/* each node has at least one output */
329 	sun4i_drv_traverse_endpoints(list, node, 1);
330 
331 	/* TCON TOP has second and third output */
332 	if (sun4i_drv_node_is_tcon_top(node)) {
333 		sun4i_drv_traverse_endpoints(list, node, 3);
334 		sun4i_drv_traverse_endpoints(list, node, 5);
335 	}
336 
337 	return count;
338 }
339 
340 #ifdef CONFIG_PM_SLEEP
341 static int sun4i_drv_drm_sys_suspend(struct device *dev)
342 {
343 	struct drm_device *drm = dev_get_drvdata(dev);
344 
345 	return drm_mode_config_helper_suspend(drm);
346 }
347 
348 static int sun4i_drv_drm_sys_resume(struct device *dev)
349 {
350 	struct drm_device *drm = dev_get_drvdata(dev);
351 
352 	return drm_mode_config_helper_resume(drm);
353 }
354 #endif
355 
356 static const struct dev_pm_ops sun4i_drv_drm_pm_ops = {
357 	SET_SYSTEM_SLEEP_PM_OPS(sun4i_drv_drm_sys_suspend,
358 				sun4i_drv_drm_sys_resume)
359 };
360 
361 static int sun4i_drv_probe(struct platform_device *pdev)
362 {
363 	struct component_match *match = NULL;
364 	struct device_node *np = pdev->dev.of_node, *endpoint;
365 	struct endpoint_list list;
366 	int i, ret, count = 0;
367 
368 	INIT_KFIFO(list.fifo);
369 
370 	for (i = 0;; i++) {
371 		struct device_node *pipeline = of_parse_phandle(np,
372 								"allwinner,pipelines",
373 								i);
374 		if (!pipeline)
375 			break;
376 
377 		kfifo_put(&list.fifo, pipeline);
378 	}
379 
380 	while (kfifo_get(&list.fifo, &endpoint)) {
381 		/* process this endpoint */
382 		ret = sun4i_drv_add_endpoints(&pdev->dev, &list, &match,
383 					      endpoint);
384 
385 		/* sun4i_drv_add_endpoints can fail to allocate memory */
386 		if (ret < 0)
387 			return ret;
388 
389 		count += ret;
390 	}
391 
392 	if (count)
393 		return component_master_add_with_match(&pdev->dev,
394 						       &sun4i_drv_master_ops,
395 						       match);
396 	else
397 		return 0;
398 }
399 
400 static int sun4i_drv_remove(struct platform_device *pdev)
401 {
402 	component_master_del(&pdev->dev, &sun4i_drv_master_ops);
403 
404 	return 0;
405 }
406 
407 static const struct of_device_id sun4i_drv_of_table[] = {
408 	{ .compatible = "allwinner,sun4i-a10-display-engine" },
409 	{ .compatible = "allwinner,sun5i-a10s-display-engine" },
410 	{ .compatible = "allwinner,sun5i-a13-display-engine" },
411 	{ .compatible = "allwinner,sun6i-a31-display-engine" },
412 	{ .compatible = "allwinner,sun6i-a31s-display-engine" },
413 	{ .compatible = "allwinner,sun7i-a20-display-engine" },
414 	{ .compatible = "allwinner,sun8i-a23-display-engine" },
415 	{ .compatible = "allwinner,sun8i-a33-display-engine" },
416 	{ .compatible = "allwinner,sun8i-a83t-display-engine" },
417 	{ .compatible = "allwinner,sun8i-h3-display-engine" },
418 	{ .compatible = "allwinner,sun8i-r40-display-engine" },
419 	{ .compatible = "allwinner,sun8i-v3s-display-engine" },
420 	{ .compatible = "allwinner,sun9i-a80-display-engine" },
421 	{ .compatible = "allwinner,sun20i-d1-display-engine" },
422 	{ .compatible = "allwinner,sun50i-a64-display-engine" },
423 	{ .compatible = "allwinner,sun50i-h6-display-engine" },
424 	{ }
425 };
426 MODULE_DEVICE_TABLE(of, sun4i_drv_of_table);
427 
428 static struct platform_driver sun4i_drv_platform_driver = {
429 	.probe		= sun4i_drv_probe,
430 	.remove		= sun4i_drv_remove,
431 	.driver		= {
432 		.name		= "sun4i-drm",
433 		.of_match_table	= sun4i_drv_of_table,
434 		.pm = &sun4i_drv_drm_pm_ops,
435 	},
436 };
437 drm_module_platform_driver(sun4i_drv_platform_driver);
438 
439 MODULE_AUTHOR("Boris Brezillon <boris.brezillon@free-electrons.com>");
440 MODULE_AUTHOR("Maxime Ripard <maxime.ripard@free-electrons.com>");
441 MODULE_DESCRIPTION("Allwinner A10 Display Engine DRM/KMS Driver");
442 MODULE_LICENSE("GPL");
443