drm/sun4i/sun4i_drv.c

0001 // SPDX-License-Identifier: GPL-2.0-or-later
0002 /*
0003  * Copyright (C) 2015 Free Electrons
0004  * Copyright (C) 2015 NextThing Co
0005  *
0006  * Maxime Ripard <maxime.ripard@free-electrons.com>
0007  */
0008
0009 #include <linux/component.h>
0010 #include <linux/dma-mapping.h>
0011 #include <linux/kfifo.h>
0012 #include <linux/module.h>
0013 #include <linux/of_graph.h>
0014 #include <linux/of_reserved_mem.h>
0015 #include <linux/platform_device.h>
0016
0017 #include <drm/drm_aperture.h>
0018 #include <drm/drm_atomic_helper.h>
0019 #include <drm/drm_drv.h>
0020 #include <drm/drm_fb_cma_helper.h>
0021 #include <drm/drm_fb_helper.h>
0022 #include <drm/drm_gem_cma_helper.h>
0023 #include <drm/drm_module.h>
0024 #include <drm/drm_of.h>
0025 #include <drm/drm_probe_helper.h>
0026 #include <drm/drm_vblank.h>
0027
0028 #include "sun4i_drv.h"
0029 #include "sun4i_frontend.h"
0030 #include "sun4i_framebuffer.h"
0031 #include "sun4i_tcon.h"
0032 #include "sun8i_tcon_top.h"
0033
0034 static int drm_sun4i_gem_dumb_create(struct drm_file *file_priv,
0035                      struct drm_device *drm,
0036                      struct drm_mode_create_dumb *args)
0037 {
0038     /* The hardware only allows even pitches for YUV buffers. */
0039     args->pitch = ALIGN(DIV_ROUND_UP(args->width * args->bpp, 8), 2);
0040
0041     return drm_gem_cma_dumb_create_internal(file_priv, drm, args);
0042 }
0043
0044 DEFINE_DRM_GEM_CMA_FOPS(sun4i_drv_fops);
0045
0046 static const struct drm_driver sun4i_drv_driver = {
0047     .driver_features    = DRIVER_GEM | DRIVER_MODESET | DRIVER_ATOMIC,
0048
0049     /* Generic Operations */
0050     .fops           = &sun4i_drv_fops,
0051     .name           = "sun4i-drm",
0052     .desc           = "Allwinner sun4i Display Engine",
0053     .date           = "20150629",
0054     .major          = 1,
0055     .minor          = 0,
0056
0057     /* GEM Operations */
0058     DRM_GEM_CMA_DRIVER_OPS_WITH_DUMB_CREATE(drm_sun4i_gem_dumb_create),
0059 };
0060
0061 static int sun4i_drv_bind(struct device *dev)
0062 {
0063     struct drm_device *drm;
0064     struct sun4i_drv *drv;
0065     int ret;
0066
0067     drm = drm_dev_alloc(&sun4i_drv_driver, dev);
0068     if (IS_ERR(drm))
0069         return PTR_ERR(drm);
0070
0071     drv = devm_kzalloc(dev, sizeof(*drv), GFP_KERNEL);
0072     if (!drv) {
0073         ret = -ENOMEM;
0074         goto free_drm;
0075     }
0076
0077     drm->dev_private = drv;
0078     INIT_LIST_HEAD(&drv->frontend_list);
0079     INIT_LIST_HEAD(&drv->engine_list);
0080     INIT_LIST_HEAD(&drv->tcon_list);
0081
0082     ret = of_reserved_mem_device_init(dev);
0083     if (ret && ret != -ENODEV) {
0084         dev_err(drm->dev, "Couldn't claim our memory region\n");
0085         goto free_drm;
0086     }
0087
0088     drm_mode_config_init(drm);
0089
0090     ret = component_bind_all(drm->dev, drm);
0091     if (ret) {
0092         dev_err(drm->dev, "Couldn't bind all pipelines components\n");
0093         goto cleanup_mode_config;
0094     }
0095
0096     /* drm_vblank_init calls kcalloc, which can fail */
0097     ret = drm_vblank_init(drm, drm->mode_config.num_crtc);
0098     if (ret)
0099         goto cleanup_mode_config;
0100
0101     /* Remove early framebuffers (ie. simplefb) */
0102     ret = drm_aperture_remove_framebuffers(false, &sun4i_drv_driver);
0103     if (ret)
0104         goto cleanup_mode_config;
0105
0106     sun4i_framebuffer_init(drm);
0107
0108     /* Enable connectors polling */
0109     drm_kms_helper_poll_init(drm);
0110
0111     ret = drm_dev_register(drm, 0);
0112     if (ret)
0113         goto finish_poll;
0114
0115     drm_fbdev_generic_setup(drm, 32);
0116
0117     dev_set_drvdata(dev, drm);
0118
0119     return 0;
0120
0121 finish_poll:
0122     drm_kms_helper_poll_fini(drm);
0123 cleanup_mode_config:
0124     drm_mode_config_cleanup(drm);
0125     of_reserved_mem_device_release(dev);
0126 free_drm:
0127     drm_dev_put(drm);
0128     return ret;
0129 }
0130
0131 static void sun4i_drv_unbind(struct device *dev)
0132 {
0133     struct drm_device *drm = dev_get_drvdata(dev);
0134
0135     dev_set_drvdata(dev, NULL);
0136     drm_dev_unregister(drm);
0137     drm_kms_helper_poll_fini(drm);
0138     drm_atomic_helper_shutdown(drm);
0139     drm_mode_config_cleanup(drm);
0140
0141     component_unbind_all(dev, NULL);
0142     of_reserved_mem_device_release(dev);
0143
0144     drm_dev_put(drm);
0145 }
0146
0147 static const struct component_master_ops sun4i_drv_master_ops = {
0148     .bind   = sun4i_drv_bind,
0149     .unbind = sun4i_drv_unbind,
0150 };
0151
0152 static bool sun4i_drv_node_is_connector(struct device_node *node)
0153 {
0154     return of_device_is_compatible(node, "hdmi-connector");
0155 }
0156
0157 static bool sun4i_drv_node_is_frontend(struct device_node *node)
0158 {
0159     return of_device_is_compatible(node, "allwinner,sun4i-a10-display-frontend") ||
0160         of_device_is_compatible(node, "allwinner,sun5i-a13-display-frontend") ||
0161         of_device_is_compatible(node, "allwinner,sun6i-a31-display-frontend") ||
0162         of_device_is_compatible(node, "allwinner,sun7i-a20-display-frontend") ||
0163         of_device_is_compatible(node, "allwinner,sun8i-a23-display-frontend") ||
0164         of_device_is_compatible(node, "allwinner,sun8i-a33-display-frontend") ||
0165         of_device_is_compatible(node, "allwinner,sun9i-a80-display-frontend");
0166 }
0167
0168 static bool sun4i_drv_node_is_deu(struct device_node *node)
0169 {
0170     return of_device_is_compatible(node, "allwinner,sun9i-a80-deu");
0171 }
0172
0173 static bool sun4i_drv_node_is_supported_frontend(struct device_node *node)
0174 {
0175     if (IS_ENABLED(CONFIG_DRM_SUN4I_BACKEND))
0176         return !!of_match_node(sun4i_frontend_of_table, node);
0177
0178     return false;
0179 }
0180
0181 static bool sun4i_drv_node_is_tcon(struct device_node *node)
0182 {
0183     return !!of_match_node(sun4i_tcon_of_table, node);
0184 }
0185
0186 static bool sun4i_drv_node_is_tcon_with_ch0(struct device_node *node)
0187 {
0188     const struct of_device_id *match;
0189
0190     match = of_match_node(sun4i_tcon_of_table, node);
0191     if (match) {
0192         struct sun4i_tcon_quirks *quirks;
0193
0194         quirks = (struct sun4i_tcon_quirks *)match->data;
0195
0196         return quirks->has_channel_0;
0197     }
0198
0199     return false;
0200 }
0201
0202 static bool sun4i_drv_node_is_tcon_top(struct device_node *node)
0203 {
0204     return IS_ENABLED(CONFIG_DRM_SUN8I_TCON_TOP) &&
0205         !!of_match_node(sun8i_tcon_top_of_table, node);
0206 }
0207
0208 /*
0209  * The encoder drivers use drm_of_find_possible_crtcs to get upstream
0210  * crtcs from the device tree using of_graph. For the results to be
0211  * correct, encoders must be probed/bound after _all_ crtcs have been
0212  * created. The existing code uses a depth first recursive traversal
0213  * of the of_graph, which means the encoders downstream of the TCON
0214  * get add right after the first TCON. The second TCON or CRTC will
0215  * never be properly associated with encoders connected to it.
0216  *
0217  * Also, in a dual display pipeline setup, both frontends can feed
0218  * either backend, and both backends can feed either TCON, we want
0219  * all components of the same type to be added before the next type
0220  * in the pipeline. Fortunately, the pipelines are perfectly symmetric,
0221  * i.e. components of the same type are at the same depth when counted
0222  * from the frontend. The only exception is the third pipeline in
0223  * the A80 SoC, which we do not support anyway.
0224  *
0225  * Hence we can use a breadth first search traversal order to add
0226  * components. We do not need to check for duplicates. The component
0227  * matching system handles this for us.
0228  */
0229 struct endpoint_list {
0230     DECLARE_KFIFO(fifo, struct device_node *, 16);
0231 };
0232
0233 static void sun4i_drv_traverse_endpoints(struct endpoint_list *list,
0234                      struct device_node *node,
0235                      int port_id)
0236 {
0237     struct device_node *ep, *remote, *port;
0238
0239     port = of_graph_get_port_by_id(node, port_id);
0240     if (!port) {
0241         DRM_DEBUG_DRIVER("No output to bind on port %d\n", port_id);
0242         return;
0243     }
0244
0245     for_each_available_child_of_node(port, ep) {
0246         remote = of_graph_get_remote_port_parent(ep);
0247         if (!remote) {
0248             DRM_DEBUG_DRIVER("Error retrieving the output node\n");
0249             continue;
0250         }
0251
0252         if (sun4i_drv_node_is_tcon(node)) {
0253             /*
0254              * TCON TOP is always probed before TCON. However, TCON
0255              * points back to TCON TOP when it is source for HDMI.
0256              * We have to skip it here to prevent infinite looping
0257              * between TCON TOP and TCON.
0258              */
0259             if (sun4i_drv_node_is_tcon_top(remote)) {
0260                 DRM_DEBUG_DRIVER("TCON output endpoint is TCON TOP... skipping\n");
0261                 of_node_put(remote);
0262                 continue;
0263             }
0264
0265             /*
0266              * If the node is our TCON with channel 0, the first
0267              * port is used for panel or bridges, and will not be
0268              * part of the component framework.
0269              */
0270             if (sun4i_drv_node_is_tcon_with_ch0(node)) {
0271                 struct of_endpoint endpoint;
0272
0273                 if (of_graph_parse_endpoint(ep, &endpoint)) {
0274                     DRM_DEBUG_DRIVER("Couldn't parse endpoint\n");
0275                     of_node_put(remote);
0276                     continue;
0277                 }
0278
0279                 if (!endpoint.id) {
0280                     DRM_DEBUG_DRIVER("Endpoint is our panel... skipping\n");
0281                     of_node_put(remote);
0282                     continue;
0283                 }
0284             }
0285         }
0286
0287         kfifo_put(&list->fifo, remote);
0288     }
0289 }
0290
0291 static int sun4i_drv_add_endpoints(struct device *dev,
0292                    struct endpoint_list *list,
0293                    struct component_match **match,
0294                    struct device_node *node)
0295 {
0296     int count = 0;
0297
0298     /*
0299      * The frontend has been disabled in some of our old device
0300      * trees. If we find a node that is the frontend and is
0301      * disabled, we should just follow through and parse its
0302      * child, but without adding it to the component list.
0303      * Otherwise, we obviously want to add it to the list.
0304      */
0305     if (!sun4i_drv_node_is_frontend(node) &&
0306         !of_device_is_available(node))
0307         return 0;
0308
0309     /*
0310      * The connectors will be the last nodes in our pipeline, we
0311      * can just bail out.
0312      */
0313     if (sun4i_drv_node_is_connector(node))
0314         return 0;
0315
0316     /*
0317      * If the device is either just a regular device, or an
0318      * enabled frontend supported by the driver, we add it to our
0319      * component list.
0320      */
0321     if (!(sun4i_drv_node_is_frontend(node) ||
0322           sun4i_drv_node_is_deu(node)) ||
0323         (sun4i_drv_node_is_supported_frontend(node) &&
0324          of_device_is_available(node))) {
0325         /* Add current component */
0326         DRM_DEBUG_DRIVER("Adding component %pOF\n", node);
0327         drm_of_component_match_add(dev, match, component_compare_of, node);
0328         count++;
0329     }
0330
0331     /* each node has at least one output */
0332     sun4i_drv_traverse_endpoints(list, node, 1);
0333
0334     /* TCON TOP has second and third output */
0335     if (sun4i_drv_node_is_tcon_top(node)) {
0336         sun4i_drv_traverse_endpoints(list, node, 3);
0337         sun4i_drv_traverse_endpoints(list, node, 5);
0338     }
0339
0340     return count;
0341 }
0342
0343 #ifdef CONFIG_PM_SLEEP
0344 static int sun4i_drv_drm_sys_suspend(struct device *dev)
0345 {
0346     struct drm_device *drm = dev_get_drvdata(dev);
0347
0348     return drm_mode_config_helper_suspend(drm);
0349 }
0350
0351 static int sun4i_drv_drm_sys_resume(struct device *dev)
0352 {
0353     struct drm_device *drm = dev_get_drvdata(dev);
0354
0355     return drm_mode_config_helper_resume(drm);
0356 }
0357 #endif
0358
0359 static const struct dev_pm_ops sun4i_drv_drm_pm_ops = {
0360     SET_SYSTEM_SLEEP_PM_OPS(sun4i_drv_drm_sys_suspend,
0361                 sun4i_drv_drm_sys_resume)
0362 };
0363
0364 static int sun4i_drv_probe(struct platform_device *pdev)
0365 {
0366     struct component_match *match = NULL;
0367     struct device_node *np = pdev->dev.of_node, *endpoint;
0368     struct endpoint_list list;
0369     int i, ret, count = 0;
0370
0371     INIT_KFIFO(list.fifo);
0372
0373     /*
0374      * DE2 and DE3 cores actually supports 40-bit addresses, but
0375      * driver does not.
0376      */
0377     dma_set_mask_and_coherent(&pdev->dev, DMA_BIT_MASK(32));
0378     dma_set_max_seg_size(&pdev->dev, UINT_MAX);
0379
0380     for (i = 0;; i++) {
0381         struct device_node *pipeline = of_parse_phandle(np,
0382                                 "allwinner,pipelines",
0383                                 i);
0384         if (!pipeline)
0385             break;
0386
0387         kfifo_put(&list.fifo, pipeline);
0388     }
0389
0390     while (kfifo_get(&list.fifo, &endpoint)) {
0391         /* process this endpoint */
0392         ret = sun4i_drv_add_endpoints(&pdev->dev, &list, &match,
0393                           endpoint);
0394
0395         /* sun4i_drv_add_endpoints can fail to allocate memory */
0396         if (ret < 0)
0397             return ret;
0398
0399         count += ret;
0400     }
0401
0402     if (count)
0403         return component_master_add_with_match(&pdev->dev,
0404                                &sun4i_drv_master_ops,
0405                                match);
0406     else
0407         return 0;
0408 }
0409
0410 static int sun4i_drv_remove(struct platform_device *pdev)
0411 {
0412     component_master_del(&pdev->dev, &sun4i_drv_master_ops);
0413
0414     return 0;
0415 }
0416
0417 static const struct of_device_id sun4i_drv_of_table[] = {
0418     { .compatible = "allwinner,sun4i-a10-display-engine" },
0419     { .compatible = "allwinner,sun5i-a10s-display-engine" },
0420     { .compatible = "allwinner,sun5i-a13-display-engine" },
0421     { .compatible = "allwinner,sun6i-a31-display-engine" },
0422     { .compatible = "allwinner,sun6i-a31s-display-engine" },
0423     { .compatible = "allwinner,sun7i-a20-display-engine" },
0424     { .compatible = "allwinner,sun8i-a23-display-engine" },
0425     { .compatible = "allwinner,sun8i-a33-display-engine" },
0426     { .compatible = "allwinner,sun8i-a83t-display-engine" },
0427     { .compatible = "allwinner,sun8i-h3-display-engine" },
0428     { .compatible = "allwinner,sun8i-r40-display-engine" },
0429     { .compatible = "allwinner,sun8i-v3s-display-engine" },
0430     { .compatible = "allwinner,sun9i-a80-display-engine" },
0431     { .compatible = "allwinner,sun20i-d1-display-engine" },
0432     { .compatible = "allwinner,sun50i-a64-display-engine" },
0433     { .compatible = "allwinner,sun50i-h6-display-engine" },
0434     { }
0435 };
0436 MODULE_DEVICE_TABLE(of, sun4i_drv_of_table);
0437
0438 static struct platform_driver sun4i_drv_platform_driver = {
0439     .probe      = sun4i_drv_probe,
0440     .remove     = sun4i_drv_remove,
0441     .driver     = {
0442         .name       = "sun4i-drm",
0443         .of_match_table = sun4i_drv_of_table,
0444         .pm = &sun4i_drv_drm_pm_ops,
0445     },
0446 };
0447 drm_module_platform_driver(sun4i_drv_platform_driver);
0448
0449 MODULE_AUTHOR("Boris Brezillon <boris.brezillon@free-electrons.com>");
0450 MODULE_AUTHOR("Maxime Ripard <maxime.ripard@free-electrons.com>");
0451 MODULE_DESCRIPTION("Allwinner A10 Display Engine DRM/KMS Driver");
0452 MODULE_LICENSE("GPL");