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