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