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