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