drm: Split out drm_probe_helper.h
[linux-block.git] / drivers / gpu / drm / sun4i / sun4i_drv.c
1 /*
2  * Copyright (C) 2015 Free Electrons
3  * Copyright (C) 2015 NextThing Co
4  *
5  * Maxime Ripard <maxime.ripard@free-electrons.com>
6  *
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.
11  */
12
13 #include <linux/component.h>
14 #include <linux/kfifo.h>
15 #include <linux/of_graph.h>
16 #include <linux/of_reserved_mem.h>
17
18 #include <drm/drmP.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>
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_PRIME | 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         .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,
58
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,
69
70         /* Frame Buffer Operations */
71 };
72
73 static int sun4i_drv_bind(struct device *dev)
74 {
75         struct drm_device *drm;
76         struct sun4i_drv *drv;
77         int ret;
78
79         drm = drm_dev_alloc(&sun4i_drv_driver, dev);
80         if (IS_ERR(drm))
81                 return PTR_ERR(drm);
82
83         drv = devm_kzalloc(dev, sizeof(*drv), GFP_KERNEL);
84         if (!drv) {
85                 ret = -ENOMEM;
86                 goto free_drm;
87         }
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);
92
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");
96                 goto free_drm;
97         }
98
99         drm_mode_config_init(drm);
100         drm->mode_config.allow_fb_modifiers = true;
101
102         ret = component_bind_all(drm->dev, drm);
103         if (ret) {
104                 dev_err(drm->dev, "Couldn't bind all pipelines components\n");
105                 goto cleanup_mode_config;
106         }
107
108         /* drm_vblank_init calls kcalloc, which can fail */
109         ret = drm_vblank_init(drm, drm->mode_config.num_crtc);
110         if (ret)
111                 goto cleanup_mode_config;
112
113         drm->irq_enabled = true;
114
115         /* Remove early framebuffers (ie. simplefb) */
116         drm_fb_helper_remove_conflicting_framebuffers(NULL, "sun4i-drm-fb", false);
117
118         sun4i_framebuffer_init(drm);
119
120         /* Enable connectors polling */
121         drm_kms_helper_poll_init(drm);
122
123         ret = drm_dev_register(drm, 0);
124         if (ret)
125                 goto finish_poll;
126
127         drm_fbdev_generic_setup(drm, 32);
128
129         return 0;
130
131 finish_poll:
132         drm_kms_helper_poll_fini(drm);
133 cleanup_mode_config:
134         drm_mode_config_cleanup(drm);
135         of_reserved_mem_device_release(dev);
136 free_drm:
137         drm_dev_put(drm);
138         return ret;
139 }
140
141 static void sun4i_drv_unbind(struct device *dev)
142 {
143         struct drm_device *drm = dev_get_drvdata(dev);
144
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);
149         drm_dev_put(drm);
150 }
151
152 static const struct component_master_ops sun4i_drv_master_ops = {
153         .bind   = sun4i_drv_bind,
154         .unbind = sun4i_drv_unbind,
155 };
156
157 static bool sun4i_drv_node_is_connector(struct device_node *node)
158 {
159         return of_device_is_compatible(node, "hdmi-connector");
160 }
161
162 static bool sun4i_drv_node_is_frontend(struct device_node *node)
163 {
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");
170 }
171
172 static bool sun4i_drv_node_is_deu(struct device_node *node)
173 {
174         return of_device_is_compatible(node, "allwinner,sun9i-a80-deu");
175 }
176
177 static bool sun4i_drv_node_is_supported_frontend(struct device_node *node)
178 {
179         if (IS_ENABLED(CONFIG_DRM_SUN4I_BACKEND))
180                 return !!of_match_node(sun4i_frontend_of_table, node);
181
182         return false;
183 }
184
185 static bool sun4i_drv_node_is_tcon(struct device_node *node)
186 {
187         return !!of_match_node(sun4i_tcon_of_table, node);
188 }
189
190 static bool sun4i_drv_node_is_tcon_with_ch0(struct device_node *node)
191 {
192         const struct of_device_id *match;
193
194         match = of_match_node(sun4i_tcon_of_table, node);
195         if (match) {
196                 struct sun4i_tcon_quirks *quirks;
197
198                 quirks = (struct sun4i_tcon_quirks *)match->data;
199
200                 return quirks->has_channel_0;
201         }
202
203         return false;
204 }
205
206 static bool sun4i_drv_node_is_tcon_top(struct device_node *node)
207 {
208         return IS_ENABLED(CONFIG_DRM_SUN8I_TCON_TOP) &&
209                 !!of_match_node(sun8i_tcon_top_of_table, node);
210 }
211
212 static int compare_of(struct device *dev, void *data)
213 {
214         DRM_DEBUG_DRIVER("Comparing of node %pOF with %pOF\n",
215                          dev->of_node,
216                          data);
217
218         return dev->of_node == data;
219 }
220
221 /*
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.
229  *
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.
237  *
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.
241  */
242 struct endpoint_list {
243         DECLARE_KFIFO(fifo, struct device_node *, 16);
244 };
245
246 static void sun4i_drv_traverse_endpoints(struct endpoint_list *list,
247                                          struct device_node *node,
248                                          int port_id)
249 {
250         struct device_node *ep, *remote, *port;
251
252         port = of_graph_get_port_by_id(node, port_id);
253         if (!port) {
254                 DRM_DEBUG_DRIVER("No output to bind on port %d\n", port_id);
255                 return;
256         }
257
258         for_each_available_child_of_node(port, ep) {
259                 remote = of_graph_get_remote_port_parent(ep);
260                 if (!remote) {
261                         DRM_DEBUG_DRIVER("Error retrieving the output node\n");
262                         continue;
263                 }
264
265                 if (sun4i_drv_node_is_tcon(node)) {
266                         /*
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.
271                          */
272                         if (sun4i_drv_node_is_tcon_top(remote)) {
273                                 DRM_DEBUG_DRIVER("TCON output endpoint is TCON TOP... skipping\n");
274                                 of_node_put(remote);
275                                 continue;
276                         }
277
278                         /*
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.
282                          */
283                         if (sun4i_drv_node_is_tcon_with_ch0(node)) {
284                                 struct of_endpoint endpoint;
285
286                                 if (of_graph_parse_endpoint(ep, &endpoint)) {
287                                         DRM_DEBUG_DRIVER("Couldn't parse endpoint\n");
288                                         of_node_put(remote);
289                                         continue;
290                                 }
291
292                                 if (!endpoint.id) {
293                                         DRM_DEBUG_DRIVER("Endpoint is our panel... skipping\n");
294                                         of_node_put(remote);
295                                         continue;
296                                 }
297                         }
298                 }
299
300                 kfifo_put(&list->fifo, remote);
301         }
302 }
303
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)
308 {
309         int count = 0;
310
311         /*
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.
317          */
318         if (!sun4i_drv_node_is_frontend(node) &&
319             !of_device_is_available(node))
320                 return 0;
321
322         /*
323          * The connectors will be the last nodes in our pipeline, we
324          * can just bail out.
325          */
326         if (sun4i_drv_node_is_connector(node))
327                 return 0;
328
329         /*
330          * If the device is either just a regular device, or an
331          * enabled frontend supported by the driver, we add it to our
332          * component list.
333          */
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);
341                 count++;
342         }
343
344         /* each node has at least one output */
345         sun4i_drv_traverse_endpoints(list, node, 1);
346
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);
351         }
352
353         return count;
354 }
355
356 static int sun4i_drv_probe(struct platform_device *pdev)
357 {
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;
362
363         INIT_KFIFO(list.fifo);
364
365         for (i = 0;; i++) {
366                 struct device_node *pipeline = of_parse_phandle(np,
367                                                                 "allwinner,pipelines",
368                                                                 i);
369                 if (!pipeline)
370                         break;
371
372                 kfifo_put(&list.fifo, pipeline);
373         }
374
375         while (kfifo_get(&list.fifo, &endpoint)) {
376                 /* process this endpoint */
377                 ret = sun4i_drv_add_endpoints(&pdev->dev, &list, &match,
378                                               endpoint);
379
380                 /* sun4i_drv_add_endpoints can fail to allocate memory */
381                 if (ret < 0)
382                         return ret;
383
384                 count += ret;
385         }
386
387         if (count)
388                 return component_master_add_with_match(&pdev->dev,
389                                                        &sun4i_drv_master_ops,
390                                                        match);
391         else
392                 return 0;
393 }
394
395 static int sun4i_drv_remove(struct platform_device *pdev)
396 {
397         return 0;
398 }
399
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" },
415         { }
416 };
417 MODULE_DEVICE_TABLE(of, sun4i_drv_of_table);
418
419 static struct platform_driver sun4i_drv_platform_driver = {
420         .probe          = sun4i_drv_probe,
421         .remove         = sun4i_drv_remove,
422         .driver         = {
423                 .name           = "sun4i-drm",
424                 .of_match_table = sun4i_drv_of_table,
425         },
426 };
427 module_platform_driver(sun4i_drv_platform_driver);
428
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");