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