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