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