2 * Copyright (C) 2015 Free Electrons
3 * Copyright (C) 2015 NextThing Co
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.
13 #include <linux/component.h>
14 #include <linux/kfifo.h>
15 #include <linux/of_graph.h>
16 #include <linux/of_reserved_mem.h>
19 #include <drm/drm_atomic_helper.h>
20 #include <drm/drm_fb_cma_helper.h>
21 #include <drm/drm_fb_helper.h>
22 #include <drm/drm_gem_cma_helper.h>
23 #include <drm/drm_of.h>
24 #include <drm/drm_probe_helper.h>
26 #include "sun4i_drv.h"
27 #include "sun4i_frontend.h"
28 #include "sun4i_framebuffer.h"
29 #include "sun4i_tcon.h"
30 #include "sun8i_tcon_top.h"
32 static int drm_sun4i_gem_dumb_create(struct drm_file *file_priv,
33 struct drm_device *drm,
34 struct drm_mode_create_dumb *args)
36 /* The hardware only allows even pitches for YUV buffers. */
37 args->pitch = ALIGN(DIV_ROUND_UP(args->width * args->bpp, 8), 2);
39 return drm_gem_cma_dumb_create_internal(file_priv, drm, args);
42 DEFINE_DRM_GEM_CMA_FOPS(sun4i_drv_fops);
44 static struct drm_driver sun4i_drv_driver = {
45 .driver_features = DRIVER_GEM | DRIVER_MODESET | DRIVER_PRIME | DRIVER_ATOMIC,
47 /* Generic Operations */
48 .fops = &sun4i_drv_fops,
50 .desc = "Allwinner sun4i Display Engine",
56 .dumb_create = drm_sun4i_gem_dumb_create,
57 .gem_free_object_unlocked = drm_gem_cma_free_object,
58 .gem_vm_ops = &drm_gem_cma_vm_ops,
60 /* PRIME Operations */
61 .prime_handle_to_fd = drm_gem_prime_handle_to_fd,
62 .prime_fd_to_handle = drm_gem_prime_fd_to_handle,
63 .gem_prime_import = drm_gem_prime_import,
64 .gem_prime_export = drm_gem_prime_export,
65 .gem_prime_get_sg_table = drm_gem_cma_prime_get_sg_table,
66 .gem_prime_import_sg_table = drm_gem_cma_prime_import_sg_table,
67 .gem_prime_vmap = drm_gem_cma_prime_vmap,
68 .gem_prime_vunmap = drm_gem_cma_prime_vunmap,
69 .gem_prime_mmap = drm_gem_cma_prime_mmap,
71 /* Frame Buffer Operations */
74 static int sun4i_drv_bind(struct device *dev)
76 struct drm_device *drm;
77 struct sun4i_drv *drv;
80 drm = drm_dev_alloc(&sun4i_drv_driver, dev);
84 drv = devm_kzalloc(dev, sizeof(*drv), GFP_KERNEL);
90 dev_set_drvdata(dev, drm);
91 drm->dev_private = drv;
92 INIT_LIST_HEAD(&drv->frontend_list);
93 INIT_LIST_HEAD(&drv->engine_list);
94 INIT_LIST_HEAD(&drv->tcon_list);
96 ret = of_reserved_mem_device_init(dev);
97 if (ret && ret != -ENODEV) {
98 dev_err(drm->dev, "Couldn't claim our memory region\n");
102 drm_mode_config_init(drm);
103 drm->mode_config.allow_fb_modifiers = true;
105 ret = component_bind_all(drm->dev, drm);
107 dev_err(drm->dev, "Couldn't bind all pipelines components\n");
108 goto cleanup_mode_config;
111 /* drm_vblank_init calls kcalloc, which can fail */
112 ret = drm_vblank_init(drm, drm->mode_config.num_crtc);
114 goto cleanup_mode_config;
116 drm->irq_enabled = true;
118 /* Remove early framebuffers (ie. simplefb) */
119 drm_fb_helper_remove_conflicting_framebuffers(NULL, "sun4i-drm-fb", false);
121 sun4i_framebuffer_init(drm);
123 /* Enable connectors polling */
124 drm_kms_helper_poll_init(drm);
126 ret = drm_dev_register(drm, 0);
130 drm_fbdev_generic_setup(drm, 32);
135 drm_kms_helper_poll_fini(drm);
137 drm_mode_config_cleanup(drm);
138 of_reserved_mem_device_release(dev);
144 static void sun4i_drv_unbind(struct device *dev)
146 struct drm_device *drm = dev_get_drvdata(dev);
148 drm_dev_unregister(drm);
149 drm_kms_helper_poll_fini(drm);
150 drm_atomic_helper_shutdown(drm);
151 drm_mode_config_cleanup(drm);
153 component_unbind_all(dev, NULL);
154 of_reserved_mem_device_release(dev);
159 static const struct component_master_ops sun4i_drv_master_ops = {
160 .bind = sun4i_drv_bind,
161 .unbind = sun4i_drv_unbind,
164 static bool sun4i_drv_node_is_connector(struct device_node *node)
166 return of_device_is_compatible(node, "hdmi-connector");
169 static bool sun4i_drv_node_is_frontend(struct device_node *node)
171 return of_device_is_compatible(node, "allwinner,sun4i-a10-display-frontend") ||
172 of_device_is_compatible(node, "allwinner,sun5i-a13-display-frontend") ||
173 of_device_is_compatible(node, "allwinner,sun6i-a31-display-frontend") ||
174 of_device_is_compatible(node, "allwinner,sun7i-a20-display-frontend") ||
175 of_device_is_compatible(node, "allwinner,sun8i-a23-display-frontend") ||
176 of_device_is_compatible(node, "allwinner,sun8i-a33-display-frontend") ||
177 of_device_is_compatible(node, "allwinner,sun9i-a80-display-frontend");
180 static bool sun4i_drv_node_is_deu(struct device_node *node)
182 return of_device_is_compatible(node, "allwinner,sun9i-a80-deu");
185 static bool sun4i_drv_node_is_supported_frontend(struct device_node *node)
187 if (IS_ENABLED(CONFIG_DRM_SUN4I_BACKEND))
188 return !!of_match_node(sun4i_frontend_of_table, node);
193 static bool sun4i_drv_node_is_tcon(struct device_node *node)
195 return !!of_match_node(sun4i_tcon_of_table, node);
198 static bool sun4i_drv_node_is_tcon_with_ch0(struct device_node *node)
200 const struct of_device_id *match;
202 match = of_match_node(sun4i_tcon_of_table, node);
204 struct sun4i_tcon_quirks *quirks;
206 quirks = (struct sun4i_tcon_quirks *)match->data;
208 return quirks->has_channel_0;
214 static bool sun4i_drv_node_is_tcon_top(struct device_node *node)
216 return IS_ENABLED(CONFIG_DRM_SUN8I_TCON_TOP) &&
217 !!of_match_node(sun8i_tcon_top_of_table, node);
220 static int compare_of(struct device *dev, void *data)
222 DRM_DEBUG_DRIVER("Comparing of node %pOF with %pOF\n",
226 return dev->of_node == data;
230 * The encoder drivers use drm_of_find_possible_crtcs to get upstream
231 * crtcs from the device tree using of_graph. For the results to be
232 * correct, encoders must be probed/bound after _all_ crtcs have been
233 * created. The existing code uses a depth first recursive traversal
234 * of the of_graph, which means the encoders downstream of the TCON
235 * get add right after the first TCON. The second TCON or CRTC will
236 * never be properly associated with encoders connected to it.
238 * Also, in a dual display pipeline setup, both frontends can feed
239 * either backend, and both backends can feed either TCON, we want
240 * all components of the same type to be added before the next type
241 * in the pipeline. Fortunately, the pipelines are perfectly symmetric,
242 * i.e. components of the same type are at the same depth when counted
243 * from the frontend. The only exception is the third pipeline in
244 * the A80 SoC, which we do not support anyway.
246 * Hence we can use a breadth first search traversal order to add
247 * components. We do not need to check for duplicates. The component
248 * matching system handles this for us.
250 struct endpoint_list {
251 DECLARE_KFIFO(fifo, struct device_node *, 16);
254 static void sun4i_drv_traverse_endpoints(struct endpoint_list *list,
255 struct device_node *node,
258 struct device_node *ep, *remote, *port;
260 port = of_graph_get_port_by_id(node, port_id);
262 DRM_DEBUG_DRIVER("No output to bind on port %d\n", port_id);
266 for_each_available_child_of_node(port, ep) {
267 remote = of_graph_get_remote_port_parent(ep);
269 DRM_DEBUG_DRIVER("Error retrieving the output node\n");
273 if (sun4i_drv_node_is_tcon(node)) {
275 * TCON TOP is always probed before TCON. However, TCON
276 * points back to TCON TOP when it is source for HDMI.
277 * We have to skip it here to prevent infinite looping
278 * between TCON TOP and TCON.
280 if (sun4i_drv_node_is_tcon_top(remote)) {
281 DRM_DEBUG_DRIVER("TCON output endpoint is TCON TOP... skipping\n");
287 * If the node is our TCON with channel 0, the first
288 * port is used for panel or bridges, and will not be
289 * part of the component framework.
291 if (sun4i_drv_node_is_tcon_with_ch0(node)) {
292 struct of_endpoint endpoint;
294 if (of_graph_parse_endpoint(ep, &endpoint)) {
295 DRM_DEBUG_DRIVER("Couldn't parse endpoint\n");
301 DRM_DEBUG_DRIVER("Endpoint is our panel... skipping\n");
308 kfifo_put(&list->fifo, remote);
312 static int sun4i_drv_add_endpoints(struct device *dev,
313 struct endpoint_list *list,
314 struct component_match **match,
315 struct device_node *node)
320 * The frontend has been disabled in some of our old device
321 * trees. If we find a node that is the frontend and is
322 * disabled, we should just follow through and parse its
323 * child, but without adding it to the component list.
324 * Otherwise, we obviously want to add it to the list.
326 if (!sun4i_drv_node_is_frontend(node) &&
327 !of_device_is_available(node))
331 * The connectors will be the last nodes in our pipeline, we
334 if (sun4i_drv_node_is_connector(node))
338 * If the device is either just a regular device, or an
339 * enabled frontend supported by the driver, we add it to our
342 if (!(sun4i_drv_node_is_frontend(node) ||
343 sun4i_drv_node_is_deu(node)) ||
344 (sun4i_drv_node_is_supported_frontend(node) &&
345 of_device_is_available(node))) {
346 /* Add current component */
347 DRM_DEBUG_DRIVER("Adding component %pOF\n", node);
348 drm_of_component_match_add(dev, match, compare_of, node);
352 /* each node has at least one output */
353 sun4i_drv_traverse_endpoints(list, node, 1);
355 /* TCON TOP has second and third output */
356 if (sun4i_drv_node_is_tcon_top(node)) {
357 sun4i_drv_traverse_endpoints(list, node, 3);
358 sun4i_drv_traverse_endpoints(list, node, 5);
364 static int sun4i_drv_probe(struct platform_device *pdev)
366 struct component_match *match = NULL;
367 struct device_node *np = pdev->dev.of_node, *endpoint;
368 struct endpoint_list list;
369 int i, ret, count = 0;
371 INIT_KFIFO(list.fifo);
374 struct device_node *pipeline = of_parse_phandle(np,
375 "allwinner,pipelines",
380 kfifo_put(&list.fifo, pipeline);
383 while (kfifo_get(&list.fifo, &endpoint)) {
384 /* process this endpoint */
385 ret = sun4i_drv_add_endpoints(&pdev->dev, &list, &match,
388 /* sun4i_drv_add_endpoints can fail to allocate memory */
396 return component_master_add_with_match(&pdev->dev,
397 &sun4i_drv_master_ops,
403 static int sun4i_drv_remove(struct platform_device *pdev)
405 component_master_del(&pdev->dev, &sun4i_drv_master_ops);
410 static const struct of_device_id sun4i_drv_of_table[] = {
411 { .compatible = "allwinner,sun4i-a10-display-engine" },
412 { .compatible = "allwinner,sun5i-a10s-display-engine" },
413 { .compatible = "allwinner,sun5i-a13-display-engine" },
414 { .compatible = "allwinner,sun6i-a31-display-engine" },
415 { .compatible = "allwinner,sun6i-a31s-display-engine" },
416 { .compatible = "allwinner,sun7i-a20-display-engine" },
417 { .compatible = "allwinner,sun8i-a23-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 { .compatible = "allwinner,sun50i-a64-display-engine" },
425 { .compatible = "allwinner,sun50i-h6-display-engine" },
428 MODULE_DEVICE_TABLE(of, sun4i_drv_of_table);
430 static struct platform_driver sun4i_drv_platform_driver = {
431 .probe = sun4i_drv_probe,
432 .remove = sun4i_drv_remove,
435 .of_match_table = sun4i_drv_of_table,
438 module_platform_driver(sun4i_drv_platform_driver);
442 MODULE_DESCRIPTION("Allwinner A10 Display Engine DRM/KMS Driver");
443 MODULE_LICENSE("GPL");