2 * Copyright (C) 2015 Free Electrons
3 * Copyright (C) 2015 NextThing Co
5 * Maxime Ripard <maxime.ripard@free-electrons.com>
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_fb_cma_helper.h>
20 #include <drm/drm_fb_helper.h>
21 #include <drm/drm_gem_cma_helper.h>
22 #include <drm/drm_of.h>
23 #include <drm/drm_probe_helper.h>
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"
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)
35 /* The hardware only allows even pitches for YUV buffers. */
36 args->pitch = ALIGN(DIV_ROUND_UP(args->width * args->bpp, 8), 2);
38 return drm_gem_cma_dumb_create_internal(file_priv, drm, args);
41 DEFINE_DRM_GEM_CMA_FOPS(sun4i_drv_fops);
43 static struct drm_driver sun4i_drv_driver = {
44 .driver_features = DRIVER_GEM | DRIVER_MODESET | DRIVER_PRIME | DRIVER_ATOMIC,
46 /* Generic Operations */
47 .fops = &sun4i_drv_fops,
49 .desc = "Allwinner sun4i Display Engine",
55 .dumb_create = drm_sun4i_gem_dumb_create,
56 .gem_free_object_unlocked = drm_gem_cma_free_object,
57 .gem_vm_ops = &drm_gem_cma_vm_ops,
59 /* PRIME Operations */
60 .prime_handle_to_fd = drm_gem_prime_handle_to_fd,
61 .prime_fd_to_handle = drm_gem_prime_fd_to_handle,
62 .gem_prime_import = drm_gem_prime_import,
63 .gem_prime_export = drm_gem_prime_export,
64 .gem_prime_get_sg_table = drm_gem_cma_prime_get_sg_table,
65 .gem_prime_import_sg_table = drm_gem_cma_prime_import_sg_table,
66 .gem_prime_vmap = drm_gem_cma_prime_vmap,
67 .gem_prime_vunmap = drm_gem_cma_prime_vunmap,
68 .gem_prime_mmap = drm_gem_cma_prime_mmap,
70 /* Frame Buffer Operations */
73 static int sun4i_drv_bind(struct device *dev)
75 struct drm_device *drm;
76 struct sun4i_drv *drv;
79 drm = drm_dev_alloc(&sun4i_drv_driver, dev);
83 drv = devm_kzalloc(dev, sizeof(*drv), GFP_KERNEL);
88 drm->dev_private = drv;
89 INIT_LIST_HEAD(&drv->frontend_list);
90 INIT_LIST_HEAD(&drv->engine_list);
91 INIT_LIST_HEAD(&drv->tcon_list);
93 ret = of_reserved_mem_device_init(dev);
94 if (ret && ret != -ENODEV) {
95 dev_err(drm->dev, "Couldn't claim our memory region\n");
99 drm_mode_config_init(drm);
100 drm->mode_config.allow_fb_modifiers = true;
102 ret = component_bind_all(drm->dev, drm);
104 dev_err(drm->dev, "Couldn't bind all pipelines components\n");
105 goto cleanup_mode_config;
108 /* drm_vblank_init calls kcalloc, which can fail */
109 ret = drm_vblank_init(drm, drm->mode_config.num_crtc);
111 goto cleanup_mode_config;
113 drm->irq_enabled = true;
115 /* Remove early framebuffers (ie. simplefb) */
116 drm_fb_helper_remove_conflicting_framebuffers(NULL, "sun4i-drm-fb", false);
118 sun4i_framebuffer_init(drm);
120 /* Enable connectors polling */
121 drm_kms_helper_poll_init(drm);
123 ret = drm_dev_register(drm, 0);
127 drm_fbdev_generic_setup(drm, 32);
132 drm_kms_helper_poll_fini(drm);
134 drm_mode_config_cleanup(drm);
135 of_reserved_mem_device_release(dev);
141 static void sun4i_drv_unbind(struct device *dev)
143 struct drm_device *drm = dev_get_drvdata(dev);
145 drm_dev_unregister(drm);
146 drm_kms_helper_poll_fini(drm);
147 drm_mode_config_cleanup(drm);
148 of_reserved_mem_device_release(dev);
152 static const struct component_master_ops sun4i_drv_master_ops = {
153 .bind = sun4i_drv_bind,
154 .unbind = sun4i_drv_unbind,
157 static bool sun4i_drv_node_is_connector(struct device_node *node)
159 return of_device_is_compatible(node, "hdmi-connector");
162 static bool sun4i_drv_node_is_frontend(struct device_node *node)
164 return of_device_is_compatible(node, "allwinner,sun4i-a10-display-frontend") ||
165 of_device_is_compatible(node, "allwinner,sun5i-a13-display-frontend") ||
166 of_device_is_compatible(node, "allwinner,sun6i-a31-display-frontend") ||
167 of_device_is_compatible(node, "allwinner,sun7i-a20-display-frontend") ||
168 of_device_is_compatible(node, "allwinner,sun8i-a33-display-frontend") ||
169 of_device_is_compatible(node, "allwinner,sun9i-a80-display-frontend");
172 static bool sun4i_drv_node_is_deu(struct device_node *node)
174 return of_device_is_compatible(node, "allwinner,sun9i-a80-deu");
177 static bool sun4i_drv_node_is_supported_frontend(struct device_node *node)
179 if (IS_ENABLED(CONFIG_DRM_SUN4I_BACKEND))
180 return !!of_match_node(sun4i_frontend_of_table, node);
185 static bool sun4i_drv_node_is_tcon(struct device_node *node)
187 return !!of_match_node(sun4i_tcon_of_table, node);
190 static bool sun4i_drv_node_is_tcon_with_ch0(struct device_node *node)
192 const struct of_device_id *match;
194 match = of_match_node(sun4i_tcon_of_table, node);
196 struct sun4i_tcon_quirks *quirks;
198 quirks = (struct sun4i_tcon_quirks *)match->data;
200 return quirks->has_channel_0;
206 static bool sun4i_drv_node_is_tcon_top(struct device_node *node)
208 return IS_ENABLED(CONFIG_DRM_SUN8I_TCON_TOP) &&
209 !!of_match_node(sun8i_tcon_top_of_table, node);
212 static int compare_of(struct device *dev, void *data)
214 DRM_DEBUG_DRIVER("Comparing of node %pOF with %pOF\n",
218 return dev->of_node == data;
222 * The encoder drivers use drm_of_find_possible_crtcs to get upstream
223 * crtcs from the device tree using of_graph. For the results to be
224 * correct, encoders must be probed/bound after _all_ crtcs have been
225 * created. The existing code uses a depth first recursive traversal
226 * of the of_graph, which means the encoders downstream of the TCON
227 * get add right after the first TCON. The second TCON or CRTC will
228 * never be properly associated with encoders connected to it.
230 * Also, in a dual display pipeline setup, both frontends can feed
231 * either backend, and both backends can feed either TCON, we want
232 * all components of the same type to be added before the next type
233 * in the pipeline. Fortunately, the pipelines are perfectly symmetric,
234 * i.e. components of the same type are at the same depth when counted
235 * from the frontend. The only exception is the third pipeline in
236 * the A80 SoC, which we do not support anyway.
238 * Hence we can use a breadth first search traversal order to add
239 * components. We do not need to check for duplicates. The component
240 * matching system handles this for us.
242 struct endpoint_list {
243 DECLARE_KFIFO(fifo, struct device_node *, 16);
246 static void sun4i_drv_traverse_endpoints(struct endpoint_list *list,
247 struct device_node *node,
250 struct device_node *ep, *remote, *port;
252 port = of_graph_get_port_by_id(node, port_id);
254 DRM_DEBUG_DRIVER("No output to bind on port %d\n", port_id);
258 for_each_available_child_of_node(port, ep) {
259 remote = of_graph_get_remote_port_parent(ep);
261 DRM_DEBUG_DRIVER("Error retrieving the output node\n");
265 if (sun4i_drv_node_is_tcon(node)) {
267 * TCON TOP is always probed before TCON. However, TCON
268 * points back to TCON TOP when it is source for HDMI.
269 * We have to skip it here to prevent infinite looping
270 * between TCON TOP and TCON.
272 if (sun4i_drv_node_is_tcon_top(remote)) {
273 DRM_DEBUG_DRIVER("TCON output endpoint is TCON TOP... skipping\n");
279 * If the node is our TCON with channel 0, the first
280 * port is used for panel or bridges, and will not be
281 * part of the component framework.
283 if (sun4i_drv_node_is_tcon_with_ch0(node)) {
284 struct of_endpoint endpoint;
286 if (of_graph_parse_endpoint(ep, &endpoint)) {
287 DRM_DEBUG_DRIVER("Couldn't parse endpoint\n");
293 DRM_DEBUG_DRIVER("Endpoint is our panel... skipping\n");
300 kfifo_put(&list->fifo, remote);
304 static int sun4i_drv_add_endpoints(struct device *dev,
305 struct endpoint_list *list,
306 struct component_match **match,
307 struct device_node *node)
312 * The frontend has been disabled in some of our old device
313 * trees. If we find a node that is the frontend and is
314 * disabled, we should just follow through and parse its
315 * child, but without adding it to the component list.
316 * Otherwise, we obviously want to add it to the list.
318 if (!sun4i_drv_node_is_frontend(node) &&
319 !of_device_is_available(node))
323 * The connectors will be the last nodes in our pipeline, we
326 if (sun4i_drv_node_is_connector(node))
330 * If the device is either just a regular device, or an
331 * enabled frontend supported by the driver, we add it to our
334 if (!(sun4i_drv_node_is_frontend(node) ||
335 sun4i_drv_node_is_deu(node)) ||
336 (sun4i_drv_node_is_supported_frontend(node) &&
337 of_device_is_available(node))) {
338 /* Add current component */
339 DRM_DEBUG_DRIVER("Adding component %pOF\n", node);
340 drm_of_component_match_add(dev, match, compare_of, node);
344 /* each node has at least one output */
345 sun4i_drv_traverse_endpoints(list, node, 1);
347 /* TCON TOP has second and third output */
348 if (sun4i_drv_node_is_tcon_top(node)) {
349 sun4i_drv_traverse_endpoints(list, node, 3);
350 sun4i_drv_traverse_endpoints(list, node, 5);
356 static int sun4i_drv_probe(struct platform_device *pdev)
358 struct component_match *match = NULL;
359 struct device_node *np = pdev->dev.of_node, *endpoint;
360 struct endpoint_list list;
361 int i, ret, count = 0;
363 INIT_KFIFO(list.fifo);
366 struct device_node *pipeline = of_parse_phandle(np,
367 "allwinner,pipelines",
372 kfifo_put(&list.fifo, pipeline);
375 while (kfifo_get(&list.fifo, &endpoint)) {
376 /* process this endpoint */
377 ret = sun4i_drv_add_endpoints(&pdev->dev, &list, &match,
380 /* sun4i_drv_add_endpoints can fail to allocate memory */
388 return component_master_add_with_match(&pdev->dev,
389 &sun4i_drv_master_ops,
395 static int sun4i_drv_remove(struct platform_device *pdev)
400 static const struct of_device_id sun4i_drv_of_table[] = {
401 { .compatible = "allwinner,sun4i-a10-display-engine" },
402 { .compatible = "allwinner,sun5i-a10s-display-engine" },
403 { .compatible = "allwinner,sun5i-a13-display-engine" },
404 { .compatible = "allwinner,sun6i-a31-display-engine" },
405 { .compatible = "allwinner,sun6i-a31s-display-engine" },
406 { .compatible = "allwinner,sun7i-a20-display-engine" },
407 { .compatible = "allwinner,sun8i-a33-display-engine" },
408 { .compatible = "allwinner,sun8i-a83t-display-engine" },
409 { .compatible = "allwinner,sun8i-h3-display-engine" },
410 { .compatible = "allwinner,sun8i-r40-display-engine" },
411 { .compatible = "allwinner,sun8i-v3s-display-engine" },
412 { .compatible = "allwinner,sun9i-a80-display-engine" },
413 { .compatible = "allwinner,sun50i-a64-display-engine" },
414 { .compatible = "allwinner,sun50i-h6-display-engine" },
417 MODULE_DEVICE_TABLE(of, sun4i_drv_of_table);
419 static struct platform_driver sun4i_drv_platform_driver = {
420 .probe = sun4i_drv_probe,
421 .remove = sun4i_drv_remove,
424 .of_match_table = sun4i_drv_of_table,
427 module_platform_driver(sun4i_drv_platform_driver);
429 MODULE_AUTHOR("Boris Brezillon <boris.brezillon@free-electrons.com>");
430 MODULE_AUTHOR("Maxime Ripard <maxime.ripard@free-electrons.com>");
431 MODULE_DESCRIPTION("Allwinner A10 Display Engine DRM/KMS Driver");
432 MODULE_LICENSE("GPL");