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