drivers/gpu/drm/mcde/mcde_drv.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Copyright (C) 2018 Linus Walleij <linus.walleij@linaro.org>
   4  * Parts of this file were based on the MCDE driver by Marcus Lorentzon
   5  * (C) ST-Ericsson SA 2013
   6  */
   7
   8 /**
   9  * DOC: ST-Ericsson MCDE Driver
  10  *
  11  * The MCDE (short for multi-channel display engine) is a graphics
  12  * controller found in the Ux500 chipsets, such as NovaThor U8500.
  13  * It was initially conceptualized by ST Microelectronics for the
  14  * successor of the Nomadik line, STn8500 but productified in the
  15  * ST-Ericsson U8500 where is was used for mass-market deployments
  16  * in Android phones from Samsung and Sony Ericsson.
  17  *
  18  * It can do 1080p30 on SDTV CCIR656, DPI-2, DBI-2 or DSI for
  19  * panels with or without frame buffering and can convert most
  20  * input formats including most variants of RGB and YUV.
  21  *
  22  * The hardware has four display pipes, and the layout is a little
  23  * bit like this::
  24  *
  25  *   Memory     -> Overlay -> Channel -> FIFO -> 5 formatters -> DSI/DPI
  26  *   External      0..5       0..3       A,B,    3 x DSI         bridge
  27  *   source 0..9                         C0,C1   2 x DPI
  28  *
  29  * FIFOs A and B are for LCD and HDMI while FIFO CO/C1 are for
  30  * panels with embedded buffer.
  31  * 3 of the formatters are for DSI.
  32  * 2 of the formatters are for DPI.
  33  *
  34  * Behind the formatters are the DSI or DPI ports that route to
  35  * the external pins of the chip. As there are 3 DSI ports and one
  36  * DPI port, it is possible to configure up to 4 display pipelines
  37  * (effectively using channels 0..3) for concurrent use.
  38  *
  39  * In the current DRM/KMS setup, we use one external source, one overlay,
  40  * one FIFO and one formatter which we connect to the simple CMA framebuffer
  41  * helpers. We then provide a bridge to the DSI port, and on the DSI port
  42  * bridge we connect hang a panel bridge or other bridge. This may be subject
  43  * to change as we exploit more of the hardware capabilities.
  44  *
  45  * TODO:
  46  *
  47  * - Enabled damaged rectangles using drm_plane_enable_fb_damage_clips()
  48  *   so we can selectively just transmit the damaged area to a
  49  *   command-only display.
  50  * - Enable mixing of more planes, possibly at the cost of moving away
  51  *   from using the simple framebuffer pipeline.
  52  * - Enable output to bridges such as the AV8100 HDMI encoder from
  53  *   the DSI bridge.
  54  */
  55
  56 #include <linux/clk.h>
  57 #include <linux/component.h>
  58 #include <linux/dma-buf.h>
  59 #include <linux/irq.h>
  60 #include <linux/io.h>
  61 #include <linux/module.h>
  62 #include <linux/of_platform.h>
  63 #include <linux/platform_device.h>
  64 #include <linux/regulator/consumer.h>
  65 #include <linux/slab.h>
  66 #include <linux/delay.h>
  67
  68 #include <drm/drm_atomic_helper.h>
  69 #include <drm/drm_bridge.h>
  70 #include <drm/drm_drv.h>
  71 #include <drm/drm_fb_cma_helper.h>
  72 #include <drm/drm_fb_helper.h>
  73 #include <drm/drm_gem.h>
  74 #include <drm/drm_gem_cma_helper.h>
  75 #include <drm/drm_gem_framebuffer_helper.h>
  76 #include <drm/drm_managed.h>
  77 #include <drm/drm_of.h>
  78 #include <drm/drm_probe_helper.h>
  79 #include <drm/drm_panel.h>
  80 #include <drm/drm_vblank.h>
  81
  82 #include "mcde_drm.h"
  83
  84 #define DRIVER_DESC     "DRM module for MCDE"
  85
  86 #define MCDE_PID 0x000001FC
  87 #define MCDE_PID_METALFIX_VERSION_SHIFT 0
  88 #define MCDE_PID_METALFIX_VERSION_MASK 0x000000FF
  89 #define MCDE_PID_DEVELOPMENT_VERSION_SHIFT 8
  90 #define MCDE_PID_DEVELOPMENT_VERSION_MASK 0x0000FF00
  91 #define MCDE_PID_MINOR_VERSION_SHIFT 16
  92 #define MCDE_PID_MINOR_VERSION_MASK 0x00FF0000
  93 #define MCDE_PID_MAJOR_VERSION_SHIFT 24
  94 #define MCDE_PID_MAJOR_VERSION_MASK 0xFF000000
  95
  96 static const struct drm_mode_config_funcs mcde_mode_config_funcs = {
  97         .fb_create = drm_gem_fb_create_with_dirty,
  98         .atomic_check = drm_atomic_helper_check,
  99         .atomic_commit = drm_atomic_helper_commit,
 100 };
 101
 102 static const struct drm_mode_config_helper_funcs mcde_mode_config_helpers = {
 103         /*
 104          * Using this function is necessary to commit atomic updates
 105          * that need the CRTC to be enabled before a commit, as is
 106          * the case with e.g. DSI displays.
 107          */
 108         .atomic_commit_tail = drm_atomic_helper_commit_tail_rpm,
 109 };
 110
 111 static irqreturn_t mcde_irq(int irq, void *data)
 112 {
 113         struct mcde *mcde = data;
 114         u32 val;
 115
 116         val = readl(mcde->regs + MCDE_MISERR);
 117
 118         mcde_display_irq(mcde);
 119
 120         if (val)
 121                 dev_info(mcde->dev, "some error IRQ\n");
 122         writel(val, mcde->regs + MCDE_RISERR);
 123
 124         return IRQ_HANDLED;
 125 }
 126
 127 static int mcde_modeset_init(struct drm_device *drm)
 128 {
 129         struct drm_mode_config *mode_config;
 130         struct mcde *mcde = to_mcde(drm);
 131         int ret;
 132
 133         if (!mcde->bridge) {
 134                 dev_err(drm->dev, "no display output bridge yet\n");
 135                 return -EPROBE_DEFER;
 136         }
 137
 138         mode_config = &drm->mode_config;
 139         mode_config->funcs = &mcde_mode_config_funcs;
 140         mode_config->helper_private = &mcde_mode_config_helpers;
 141         /* This hardware can do 1080p */
 142         mode_config->min_width = 1;
 143         mode_config->max_width = 1920;
 144         mode_config->min_height = 1;
 145         mode_config->max_height = 1080;
 146
 147         ret = drm_vblank_init(drm, 1);
 148         if (ret) {
 149                 dev_err(drm->dev, "failed to init vblank\n");
 150                 return ret;
 151         }
 152
 153         ret = mcde_display_init(drm);
 154         if (ret) {
 155                 dev_err(drm->dev, "failed to init display\n");
 156                 return ret;
 157         }
 158
 159         /*
 160          * Attach the DSI bridge
 161          *
 162          * TODO: when adding support for the DPI bridge or several DSI bridges,
 163          * we selectively connect the bridge(s) here instead of this simple
 164          * attachment.
 165          */
 166         ret = drm_simple_display_pipe_attach_bridge(&mcde->pipe,
 167                                                     mcde->bridge);
 168         if (ret) {
 169                 dev_err(drm->dev, "failed to attach display output bridge\n");
 170                 return ret;
 171         }
 172
 173         drm_mode_config_reset(drm);
 174         drm_kms_helper_poll_init(drm);
 175
 176         return 0;
 177 }
 178
 179 DEFINE_DRM_GEM_CMA_FOPS(drm_fops);
 180
 181 static const struct drm_driver mcde_drm_driver = {
 182         .driver_features =
 183                 DRIVER_MODESET | DRIVER_GEM | DRIVER_ATOMIC,
 184         .lastclose = drm_fb_helper_lastclose,
 185         .ioctls = NULL,
 186         .fops = &drm_fops,
 187         .name = "mcde",
 188         .desc = DRIVER_DESC,
 189         .date = "20180529",
 190         .major = 1,
 191         .minor = 0,
 192         .patchlevel = 0,
 193         DRM_GEM_CMA_DRIVER_OPS,
 194 };
 195
 196 static int mcde_drm_bind(struct device *dev)
 197 {
 198         struct drm_device *drm = dev_get_drvdata(dev);
 199         int ret;
 200
 201         ret = drmm_mode_config_init(drm);
 202         if (ret)
 203                 return ret;
 204
 205         ret = component_bind_all(drm->dev, drm);
 206         if (ret) {
 207                 dev_err(dev, "can't bind component devices\n");
 208                 return ret;
 209         }
 210
 211         ret = mcde_modeset_init(drm);
 212         if (ret)
 213                 goto unbind;
 214
 215         ret = drm_dev_register(drm, 0);
 216         if (ret < 0)
 217                 goto unbind;
 218
 219         drm_fbdev_generic_setup(drm, 32);
 220
 221         return 0;
 222
 223 unbind:
 224         component_unbind_all(drm->dev, drm);
 225         return ret;
 226 }
 227
 228 static void mcde_drm_unbind(struct device *dev)
 229 {
 230         struct drm_device *drm = dev_get_drvdata(dev);
 231
 232         drm_dev_unregister(drm);
 233         drm_atomic_helper_shutdown(drm);
 234         component_unbind_all(drm->dev, drm);
 235 }
 236
 237 static const struct component_master_ops mcde_drm_comp_ops = {
 238         .bind = mcde_drm_bind,
 239         .unbind = mcde_drm_unbind,
 240 };
 241
 242 static struct platform_driver *const mcde_component_drivers[] = {
 243         &mcde_dsi_driver,
 244 };
 245
 246 static int mcde_compare_dev(struct device *dev, void *data)
 247 {
 248         return dev == data;
 249 }
 250
 251 static int mcde_probe(struct platform_device *pdev)
 252 {
 253         struct device *dev = &pdev->dev;
 254         struct drm_device *drm;
 255         struct mcde *mcde;
 256         struct component_match *match = NULL;
 257         struct resource *res;
 258         u32 pid;
 259         int irq;
 260         int ret;
 261         int i;
 262
 263         mcde = devm_drm_dev_alloc(dev, &mcde_drm_driver, struct mcde, drm);
 264         if (IS_ERR(mcde))
 265                 return PTR_ERR(mcde);
 266         drm = &mcde->drm;
 267         mcde->dev = dev;
 268         platform_set_drvdata(pdev, drm);
 269
 270         /* First obtain and turn on the main power */
 271         mcde->epod = devm_regulator_get(dev, "epod");
 272         if (IS_ERR(mcde->epod)) {
 273                 ret = PTR_ERR(mcde->epod);
 274                 dev_err(dev, "can't get EPOD regulator\n");
 275                 return ret;
 276         }
 277         ret = regulator_enable(mcde->epod);
 278         if (ret) {
 279                 dev_err(dev, "can't enable EPOD regulator\n");
 280                 return ret;
 281         }
 282         mcde->vana = devm_regulator_get(dev, "vana");
 283         if (IS_ERR(mcde->vana)) {
 284                 ret = PTR_ERR(mcde->vana);
 285                 dev_err(dev, "can't get VANA regulator\n");
 286                 goto regulator_epod_off;
 287         }
 288         ret = regulator_enable(mcde->vana);
 289         if (ret) {
 290                 dev_err(dev, "can't enable VANA regulator\n");
 291                 goto regulator_epod_off;
 292         }
 293         /*
 294          * The vendor code uses ESRAM (onchip RAM) and need to activate
 295          * the v-esram34 regulator, but we don't use that yet
 296          */
 297
 298         /* Clock the silicon so we can access the registers */
 299         mcde->mcde_clk = devm_clk_get(dev, "mcde");
 300         if (IS_ERR(mcde->mcde_clk)) {
 301                 dev_err(dev, "unable to get MCDE main clock\n");
 302                 ret = PTR_ERR(mcde->mcde_clk);
 303                 goto regulator_off;
 304         }
 305         ret = clk_prepare_enable(mcde->mcde_clk);
 306         if (ret) {
 307                 dev_err(dev, "failed to enable MCDE main clock\n");
 308                 goto regulator_off;
 309         }
 310         dev_info(dev, "MCDE clk rate %lu Hz\n", clk_get_rate(mcde->mcde_clk));
 311
 312         mcde->lcd_clk = devm_clk_get(dev, "lcd");
 313         if (IS_ERR(mcde->lcd_clk)) {
 314                 dev_err(dev, "unable to get LCD clock\n");
 315                 ret = PTR_ERR(mcde->lcd_clk);
 316                 goto clk_disable;
 317         }
 318         mcde->hdmi_clk = devm_clk_get(dev, "hdmi");
 319         if (IS_ERR(mcde->hdmi_clk)) {
 320                 dev_err(dev, "unable to get HDMI clock\n");
 321                 ret = PTR_ERR(mcde->hdmi_clk);
 322                 goto clk_disable;
 323         }
 324
 325         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 326         mcde->regs = devm_ioremap_resource(dev, res);
 327         if (IS_ERR(mcde->regs)) {
 328                 dev_err(dev, "no MCDE regs\n");
 329                 ret = -EINVAL;
 330                 goto clk_disable;
 331         }
 332
 333         irq = platform_get_irq(pdev, 0);
 334         if (irq < 0) {
 335                 ret = irq;
 336                 goto clk_disable;
 337         }
 338
 339         ret = devm_request_irq(dev, irq, mcde_irq, 0, "mcde", mcde);
 340         if (ret) {
 341                 dev_err(dev, "failed to request irq %d\n", ret);
 342                 goto clk_disable;
 343         }
 344
 345         /*
 346          * Check hardware revision, we only support U8500v2 version
 347          * as this was the only version used for mass market deployment,
 348          * but surely you can add more versions if you have them and
 349          * need them.
 350          */
 351         pid = readl(mcde->regs + MCDE_PID);
 352         dev_info(dev, "found MCDE HW revision %d.%d (dev %d, metal fix %d)\n",
 353                  (pid & MCDE_PID_MAJOR_VERSION_MASK)
 354                  >> MCDE_PID_MAJOR_VERSION_SHIFT,
 355                  (pid & MCDE_PID_MINOR_VERSION_MASK)
 356                  >> MCDE_PID_MINOR_VERSION_SHIFT,
 357                  (pid & MCDE_PID_DEVELOPMENT_VERSION_MASK)
 358                  >> MCDE_PID_DEVELOPMENT_VERSION_SHIFT,
 359                  (pid & MCDE_PID_METALFIX_VERSION_MASK)
 360                  >> MCDE_PID_METALFIX_VERSION_SHIFT);
 361         if (pid != 0x03000800) {
 362                 dev_err(dev, "unsupported hardware revision\n");
 363                 ret = -ENODEV;
 364                 goto clk_disable;
 365         }
 366
 367         /* Disable and clear any pending interrupts */
 368         mcde_display_disable_irqs(mcde);
 369         writel(0, mcde->regs + MCDE_IMSCERR);
 370         writel(0xFFFFFFFF, mcde->regs + MCDE_RISERR);
 371
 372         /* Spawn child devices for the DSI ports */
 373         devm_of_platform_populate(dev);
 374
 375         /* Create something that will match the subdrivers when we bind */
 376         for (i = 0; i < ARRAY_SIZE(mcde_component_drivers); i++) {
 377                 struct device_driver *drv = &mcde_component_drivers[i]->driver;
 378                 struct device *p = NULL, *d;
 379
 380                 while ((d = platform_find_device_by_driver(p, drv))) {
 381                         put_device(p);
 382                         component_match_add(dev, &match, mcde_compare_dev, d);
 383                         p = d;
 384                 }
 385                 put_device(p);
 386         }
 387         if (!match) {
 388                 dev_err(dev, "no matching components\n");
 389                 ret = -ENODEV;
 390                 goto clk_disable;
 391         }
 392         if (IS_ERR(match)) {
 393                 dev_err(dev, "could not create component match\n");
 394                 ret = PTR_ERR(match);
 395                 goto clk_disable;
 396         }
 397
 398         /*
 399          * Perform an invasive reset of the MCDE and all blocks by
 400          * cutting the power to the subsystem, then bring it back up
 401          * later when we enable the display as a result of
 402          * component_master_add_with_match().
 403          */
 404         ret = regulator_disable(mcde->epod);
 405         if (ret) {
 406                 dev_err(dev, "can't disable EPOD regulator\n");
 407                 return ret;
 408         }
 409         /* Wait 50 ms so we are sure we cut the power */
 410         usleep_range(50000, 70000);
 411
 412         ret = component_master_add_with_match(&pdev->dev, &mcde_drm_comp_ops,
 413                                               match);
 414         if (ret) {
 415                 dev_err(dev, "failed to add component master\n");
 416                 /*
 417                  * The EPOD regulator is already disabled at this point so some
 418                  * special errorpath code is needed
 419                  */
 420                 clk_disable_unprepare(mcde->mcde_clk);
 421                 regulator_disable(mcde->vana);
 422                 return ret;
 423         }
 424
 425         return 0;
 426
 427 clk_disable:
 428         clk_disable_unprepare(mcde->mcde_clk);
 429 regulator_off:
 430         regulator_disable(mcde->vana);
 431 regulator_epod_off:
 432         regulator_disable(mcde->epod);
 433         return ret;
 434
 435 }
 436
 437 static int mcde_remove(struct platform_device *pdev)
 438 {
 439         struct drm_device *drm = platform_get_drvdata(pdev);
 440         struct mcde *mcde = to_mcde(drm);
 441
 442         component_master_del(&pdev->dev, &mcde_drm_comp_ops);
 443         clk_disable_unprepare(mcde->mcde_clk);
 444         regulator_disable(mcde->vana);
 445         regulator_disable(mcde->epod);
 446
 447         return 0;
 448 }
 449
 450 static const struct of_device_id mcde_of_match[] = {
 451         {
 452                 .compatible = "ste,mcde",
 453         },
 454         {},
 455 };
 456
 457 static struct platform_driver mcde_driver = {
 458         .driver = {
 459                 .name           = "mcde",
 460                 .of_match_table = of_match_ptr(mcde_of_match),
 461         },
 462         .probe = mcde_probe,
 463         .remove = mcde_remove,
 464 };
 465
 466 static struct platform_driver *const component_drivers[] = {
 467         &mcde_dsi_driver,
 468 };
 469
 470 static int __init mcde_drm_register(void)
 471 {
 472         int ret;
 473
 474         ret = platform_register_drivers(component_drivers,
 475                                         ARRAY_SIZE(component_drivers));
 476         if (ret)
 477                 return ret;
 478
 479         return platform_driver_register(&mcde_driver);
 480 }
 481
 482 static void __exit mcde_drm_unregister(void)
 483 {
 484         platform_unregister_drivers(component_drivers,
 485                                     ARRAY_SIZE(component_drivers));
 486         platform_driver_unregister(&mcde_driver);
 487 }
 488
 489 module_init(mcde_drm_register);
 490 module_exit(mcde_drm_unregister);
 491
 492 MODULE_ALIAS("platform:mcde-drm");
 493 MODULE_DESCRIPTION(DRIVER_DESC);
 494 MODULE_AUTHOR("Linus Walleij <linus.walleij@linaro.org>");
 495 MODULE_LICENSE("GPL");