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_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>
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 DEFINE_DRM_GEM_CMA_FOPS(sun4i_drv_fops
);
33 static struct drm_driver sun4i_drv_driver
= {
34 .driver_features
= DRIVER_GEM
| DRIVER_MODESET
| DRIVER_PRIME
| DRIVER_ATOMIC
,
36 /* Generic Operations */
37 .lastclose
= drm_fb_helper_lastclose
,
38 .fops
= &sun4i_drv_fops
,
40 .desc
= "Allwinner sun4i Display Engine",
46 .dumb_create
= drm_gem_cma_dumb_create
,
47 .gem_free_object_unlocked
= drm_gem_cma_free_object
,
48 .gem_vm_ops
= &drm_gem_cma_vm_ops
,
50 /* PRIME Operations */
51 .prime_handle_to_fd
= drm_gem_prime_handle_to_fd
,
52 .prime_fd_to_handle
= drm_gem_prime_fd_to_handle
,
53 .gem_prime_import
= drm_gem_prime_import
,
54 .gem_prime_export
= drm_gem_prime_export
,
55 .gem_prime_get_sg_table
= drm_gem_cma_prime_get_sg_table
,
56 .gem_prime_import_sg_table
= drm_gem_cma_prime_import_sg_table
,
57 .gem_prime_vmap
= drm_gem_cma_prime_vmap
,
58 .gem_prime_vunmap
= drm_gem_cma_prime_vunmap
,
59 .gem_prime_mmap
= drm_gem_cma_prime_mmap
,
61 /* Frame Buffer Operations */
64 static void sun4i_remove_framebuffers(void)
66 struct apertures_struct
*ap
;
68 ap
= alloc_apertures(1);
72 /* The framebuffer can be located anywhere in RAM */
73 ap
->ranges
[0].base
= 0;
74 ap
->ranges
[0].size
= ~0;
76 drm_fb_helper_remove_conflicting_framebuffers(ap
, "sun4i-drm-fb", false);
80 static int sun4i_drv_bind(struct device
*dev
)
82 struct drm_device
*drm
;
83 struct sun4i_drv
*drv
;
86 drm
= drm_dev_alloc(&sun4i_drv_driver
, dev
);
90 drv
= devm_kzalloc(dev
, sizeof(*drv
), GFP_KERNEL
);
95 drm
->dev_private
= drv
;
96 INIT_LIST_HEAD(&drv
->frontend_list
);
97 INIT_LIST_HEAD(&drv
->engine_list
);
98 INIT_LIST_HEAD(&drv
->tcon_list
);
100 ret
= of_reserved_mem_device_init(dev
);
101 if (ret
&& ret
!= -ENODEV
) {
102 dev_err(drm
->dev
, "Couldn't claim our memory region\n");
106 drm_mode_config_init(drm
);
108 ret
= component_bind_all(drm
->dev
, drm
);
110 dev_err(drm
->dev
, "Couldn't bind all pipelines components\n");
111 goto cleanup_mode_config
;
114 /* drm_vblank_init calls kcalloc, which can fail */
115 ret
= drm_vblank_init(drm
, drm
->mode_config
.num_crtc
);
117 goto cleanup_mode_config
;
119 drm
->irq_enabled
= true;
121 /* Remove early framebuffers (ie. simplefb) */
122 sun4i_remove_framebuffers();
124 /* Create our framebuffer */
125 ret
= sun4i_framebuffer_init(drm
);
127 dev_err(drm
->dev
, "Couldn't create our framebuffer\n");
128 goto cleanup_mode_config
;
131 /* Enable connectors polling */
132 drm_kms_helper_poll_init(drm
);
134 ret
= drm_dev_register(drm
, 0);
141 drm_kms_helper_poll_fini(drm
);
142 sun4i_framebuffer_free(drm
);
144 drm_mode_config_cleanup(drm
);
145 of_reserved_mem_device_release(dev
);
151 static void sun4i_drv_unbind(struct device
*dev
)
153 struct drm_device
*drm
= dev_get_drvdata(dev
);
155 drm_dev_unregister(drm
);
156 drm_kms_helper_poll_fini(drm
);
157 sun4i_framebuffer_free(drm
);
158 drm_mode_config_cleanup(drm
);
159 of_reserved_mem_device_release(dev
);
163 static const struct component_master_ops sun4i_drv_master_ops
= {
164 .bind
= sun4i_drv_bind
,
165 .unbind
= sun4i_drv_unbind
,
168 static bool sun4i_drv_node_is_connector(struct device_node
*node
)
170 return of_device_is_compatible(node
, "hdmi-connector");
173 static bool sun4i_drv_node_is_frontend(struct device_node
*node
)
175 return of_device_is_compatible(node
, "allwinner,sun4i-a10-display-frontend") ||
176 of_device_is_compatible(node
, "allwinner,sun5i-a13-display-frontend") ||
177 of_device_is_compatible(node
, "allwinner,sun6i-a31-display-frontend") ||
178 of_device_is_compatible(node
, "allwinner,sun7i-a20-display-frontend") ||
179 of_device_is_compatible(node
, "allwinner,sun8i-a33-display-frontend") ||
180 of_device_is_compatible(node
, "allwinner,sun9i-a80-display-frontend");
183 static bool sun4i_drv_node_is_deu(struct device_node
*node
)
185 return of_device_is_compatible(node
, "allwinner,sun9i-a80-deu");
188 static bool sun4i_drv_node_is_supported_frontend(struct device_node
*node
)
190 if (IS_ENABLED(CONFIG_DRM_SUN4I_BACKEND
))
191 return !!of_match_node(sun4i_frontend_of_table
, node
);
196 static bool sun4i_drv_node_is_tcon(struct device_node
*node
)
198 return !!of_match_node(sun4i_tcon_of_table
, node
);
201 static bool sun4i_drv_node_is_tcon_with_ch0(struct device_node
*node
)
203 const struct of_device_id
*match
;
205 match
= of_match_node(sun4i_tcon_of_table
, node
);
207 struct sun4i_tcon_quirks
*quirks
;
209 quirks
= (struct sun4i_tcon_quirks
*)match
->data
;
211 return quirks
->has_channel_0
;
217 static bool sun4i_drv_node_is_tcon_top(struct device_node
*node
)
219 return IS_ENABLED(CONFIG_DRM_SUN8I_TCON_TOP
) &&
220 !!of_match_node(sun8i_tcon_top_of_table
, node
);
223 static int compare_of(struct device
*dev
, void *data
)
225 DRM_DEBUG_DRIVER("Comparing of node %pOF with %pOF\n",
229 return dev
->of_node
== data
;
233 * The encoder drivers use drm_of_find_possible_crtcs to get upstream
234 * crtcs from the device tree using of_graph. For the results to be
235 * correct, encoders must be probed/bound after _all_ crtcs have been
236 * created. The existing code uses a depth first recursive traversal
237 * of the of_graph, which means the encoders downstream of the TCON
238 * get add right after the first TCON. The second TCON or CRTC will
239 * never be properly associated with encoders connected to it.
241 * Also, in a dual display pipeline setup, both frontends can feed
242 * either backend, and both backends can feed either TCON, we want
243 * all components of the same type to be added before the next type
244 * in the pipeline. Fortunately, the pipelines are perfectly symmetric,
245 * i.e. components of the same type are at the same depth when counted
246 * from the frontend. The only exception is the third pipeline in
247 * the A80 SoC, which we do not support anyway.
249 * Hence we can use a breadth first search traversal order to add
250 * components. We do not need to check for duplicates. The component
251 * matching system handles this for us.
253 struct endpoint_list
{
254 DECLARE_KFIFO(fifo
, struct device_node
*, 16);
257 static void sun4i_drv_traverse_endpoints(struct endpoint_list
*list
,
258 struct device_node
*node
,
261 struct device_node
*ep
, *remote
, *port
;
263 port
= of_graph_get_port_by_id(node
, port_id
);
265 DRM_DEBUG_DRIVER("No output to bind on port %d\n", port_id
);
269 for_each_available_child_of_node(port
, ep
) {
270 remote
= of_graph_get_remote_port_parent(ep
);
272 DRM_DEBUG_DRIVER("Error retrieving the output node\n");
276 if (sun4i_drv_node_is_tcon(node
)) {
278 * TCON TOP is always probed before TCON. However, TCON
279 * points back to TCON TOP when it is source for HDMI.
280 * We have to skip it here to prevent infinite looping
281 * between TCON TOP and TCON.
283 if (sun4i_drv_node_is_tcon_top(remote
)) {
284 DRM_DEBUG_DRIVER("TCON output endpoint is TCON TOP... skipping\n");
290 * If the node is our TCON with channel 0, the first
291 * port is used for panel or bridges, and will not be
292 * part of the component framework.
294 if (sun4i_drv_node_is_tcon_with_ch0(node
)) {
295 struct of_endpoint endpoint
;
297 if (of_graph_parse_endpoint(ep
, &endpoint
)) {
298 DRM_DEBUG_DRIVER("Couldn't parse endpoint\n");
304 DRM_DEBUG_DRIVER("Endpoint is our panel... skipping\n");
311 kfifo_put(&list
->fifo
, remote
);
315 static int sun4i_drv_add_endpoints(struct device
*dev
,
316 struct endpoint_list
*list
,
317 struct component_match
**match
,
318 struct device_node
*node
)
323 * The frontend has been disabled in some of our old device
324 * trees. If we find a node that is the frontend and is
325 * disabled, we should just follow through and parse its
326 * child, but without adding it to the component list.
327 * Otherwise, we obviously want to add it to the list.
329 if (!sun4i_drv_node_is_frontend(node
) &&
330 !of_device_is_available(node
))
334 * The connectors will be the last nodes in our pipeline, we
337 if (sun4i_drv_node_is_connector(node
))
341 * If the device is either just a regular device, or an
342 * enabled frontend supported by the driver, we add it to our
345 if (!(sun4i_drv_node_is_frontend(node
) ||
346 sun4i_drv_node_is_deu(node
)) ||
347 (sun4i_drv_node_is_supported_frontend(node
) &&
348 of_device_is_available(node
))) {
349 /* Add current component */
350 DRM_DEBUG_DRIVER("Adding component %pOF\n", node
);
351 drm_of_component_match_add(dev
, match
, compare_of
, node
);
355 /* each node has at least one output */
356 sun4i_drv_traverse_endpoints(list
, node
, 1);
358 /* TCON TOP has second and third output */
359 if (sun4i_drv_node_is_tcon_top(node
)) {
360 sun4i_drv_traverse_endpoints(list
, node
, 3);
361 sun4i_drv_traverse_endpoints(list
, node
, 5);
367 static int sun4i_drv_probe(struct platform_device
*pdev
)
369 struct component_match
*match
= NULL
;
370 struct device_node
*np
= pdev
->dev
.of_node
, *endpoint
;
371 struct endpoint_list list
;
372 int i
, ret
, count
= 0;
374 INIT_KFIFO(list
.fifo
);
377 struct device_node
*pipeline
= of_parse_phandle(np
,
378 "allwinner,pipelines",
383 kfifo_put(&list
.fifo
, pipeline
);
386 while (kfifo_get(&list
.fifo
, &endpoint
)) {
387 /* process this endpoint */
388 ret
= sun4i_drv_add_endpoints(&pdev
->dev
, &list
, &match
,
391 /* sun4i_drv_add_endpoints can fail to allocate memory */
399 return component_master_add_with_match(&pdev
->dev
,
400 &sun4i_drv_master_ops
,
406 static int sun4i_drv_remove(struct platform_device
*pdev
)
411 static const struct of_device_id sun4i_drv_of_table
[] = {
412 { .compatible
= "allwinner,sun4i-a10-display-engine" },
413 { .compatible
= "allwinner,sun5i-a10s-display-engine" },
414 { .compatible
= "allwinner,sun5i-a13-display-engine" },
415 { .compatible
= "allwinner,sun6i-a31-display-engine" },
416 { .compatible
= "allwinner,sun6i-a31s-display-engine" },
417 { .compatible
= "allwinner,sun7i-a20-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-v3s-display-engine" },
422 { .compatible
= "allwinner,sun9i-a80-display-engine" },
425 MODULE_DEVICE_TABLE(of
, sun4i_drv_of_table
);
427 static struct platform_driver sun4i_drv_platform_driver
= {
428 .probe
= sun4i_drv_probe
,
429 .remove
= sun4i_drv_remove
,
432 .of_match_table
= sun4i_drv_of_table
,
435 module_platform_driver(sun4i_drv_platform_driver
);
437 MODULE_AUTHOR("Boris Brezillon <boris.brezillon@free-electrons.com>");
438 MODULE_AUTHOR("Maxime Ripard <maxime.ripard@free-electrons.com>");
439 MODULE_DESCRIPTION("Allwinner A10 Display Engine DRM/KMS Driver");
440 MODULE_LICENSE("GPL");