drivers/gpu/drm/pl111/pl111_drv.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * (C) COPYRIGHT 2012-2013 ARM Limited. All rights reserved.
   4  *
   5  * Parts of this file were based on sources as follows:
   6  *
   7  * Copyright (c) 2006-2008 Intel Corporation
   8  * Copyright (c) 2007 Dave Airlie <[email protected]>
   9  * Copyright (C) 2011 Texas Instruments
  10  */
  11
  12 /**
  13  * DOC: ARM PrimeCell PL111 CLCD Driver
  14  *
  15  * The PL111 is a simple LCD controller that can support TFT and STN
  16  * displays.  This driver exposes a standard KMS interface for them.
  17  *
  18  * This driver uses the same Device Tree binding as the fbdev CLCD
  19  * driver.  While the fbdev driver supports panels that may be
  20  * connected to the CLCD internally to the CLCD driver, in DRM the
  21  * panels get split out to drivers/gpu/drm/panels/.  This means that,
  22  * in converting from using fbdev to using DRM, you also need to write
  23  * a panel driver (which may be as simple as an entry in
  24  * panel-simple.c).
  25  *
  26  * The driver currently doesn't expose the cursor.  The DRM API for
  27  * cursors requires support for 64x64 ARGB8888 cursor images, while
  28  * the hardware can only support 64x64 monochrome with masking
  29  * cursors.  While one could imagine trying to hack something together
  30  * to look at the ARGB8888 and program reasonable in monochrome, we
  31  * just don't expose the cursor at all instead, and leave cursor
  32  * support to the X11 software cursor layer.
  33  *
  34  * TODO:
  35  *
  36  * - Fix race between setting plane base address and getting IRQ for
  37  *   vsync firing the pageflip completion.
  38  *
  39  * - Use the "max-memory-bandwidth" DT property to filter the
  40  *   supported formats.
  41  *
  42  * - Read back hardware state at boot to skip reprogramming the
  43  *   hardware when doing a no-op modeset.
  44  *
  45  * - Use the CLKSEL bit to support switching between the two external
  46  *   clock parents.
  47  */
  48
  49 #include <linux/amba/bus.h>
  50 #include <linux/dma-buf.h>
  51 #include <linux/module.h>
  52 #include <linux/of.h>
  53 #include <linux/of_graph.h>
  54 #include <linux/of_reserved_mem.h>
  55 #include <linux/shmem_fs.h>
  56 #include <linux/slab.h>
  57 #include <linux/version.h>
  58
  59 #include <drm/drm_atomic_helper.h>
  60 #include <drm/drm_bridge.h>
  61 #include <drm/drm_drv.h>
  62 #include <drm/drm_fb_cma_helper.h>
  63 #include <drm/drm_fb_helper.h>
  64 #include <drm/drm_gem_cma_helper.h>
  65 #include <drm/drm_gem_framebuffer_helper.h>
  66 #include <drm/drm_of.h>
  67 #include <drm/drm_panel.h>
  68 #include <drm/drm_probe_helper.h>
  69 #include <drm/drm_vblank.h>
  70
  71 #include "pl111_drm.h"
  72 #include "pl111_versatile.h"
  73 #include "pl111_nomadik.h"
  74
  75 #define DRIVER_DESC      "DRM module for PL111"
  76
  77 static const struct drm_mode_config_funcs mode_config_funcs = {
  78         .fb_create = drm_gem_fb_create,
  79         .atomic_check = drm_atomic_helper_check,
  80         .atomic_commit = drm_atomic_helper_commit,
  81 };
  82
  83 static int pl111_modeset_init(struct drm_device *dev)
  84 {
  85         struct drm_mode_config *mode_config;
  86         struct pl111_drm_dev_private *priv = dev->dev_private;
  87         struct device_node *np = dev->dev->of_node;
  88         struct device_node *remote;
  89         struct drm_panel *panel = NULL;
  90         struct drm_bridge *bridge = NULL;
  91         bool defer = false;
  92         int ret;
  93         int i;
  94
  95         ret = drmm_mode_config_init(dev);
  96         if (ret)
  97                 return ret;
  98
  99         mode_config = &dev->mode_config;
 100         mode_config->funcs = &mode_config_funcs;
 101         mode_config->min_width = 1;
 102         mode_config->max_width = 1024;
 103         mode_config->min_height = 1;
 104         mode_config->max_height = 768;
 105
 106         i = 0;
 107         for_each_endpoint_of_node(np, remote) {
 108                 struct drm_panel *tmp_panel;
 109                 struct drm_bridge *tmp_bridge;
 110
 111                 dev_dbg(dev->dev, "checking endpoint %d\n", i);
 112
 113                 ret = drm_of_find_panel_or_bridge(dev->dev->of_node,
 114                                                   0, i,
 115                                                   &tmp_panel,
 116                                                   &tmp_bridge);
 117                 if (ret) {
 118                         if (ret == -EPROBE_DEFER) {
 119                                 /*
 120                                  * Something deferred, but that is often just
 121                                  * another way of saying -ENODEV, but let's
 122                                  * cast a vote for later deferral.
 123                                  */
 124                                 defer = true;
 125                         } else if (ret != -ENODEV) {
 126                                 /* Continue, maybe something else is working */
 127                                 dev_err(dev->dev,
 128                                         "endpoint %d returns %d\n", i, ret);
 129                         }
 130                 }
 131
 132                 if (tmp_panel) {
 133                         dev_info(dev->dev,
 134                                  "found panel on endpoint %d\n", i);
 135                         panel = tmp_panel;
 136                 }
 137                 if (tmp_bridge) {
 138                         dev_info(dev->dev,
 139                                  "found bridge on endpoint %d\n", i);
 140                         bridge = tmp_bridge;
 141                 }
 142
 143                 i++;
 144         }
 145
 146         /*
 147          * If we can't find neither panel nor bridge on any of the
 148          * endpoints, and any of them retured -EPROBE_DEFER, then
 149          * let's defer this driver too.
 150          */
 151         if ((!panel && !bridge) && defer)
 152                 return -EPROBE_DEFER;
 153
 154         if (panel) {
 155                 bridge = drm_panel_bridge_add_typed(panel,
 156                                                     DRM_MODE_CONNECTOR_Unknown);
 157                 if (IS_ERR(bridge)) {
 158                         ret = PTR_ERR(bridge);
 159                         goto finish;
 160                 }
 161         } else if (bridge) {
 162                 dev_info(dev->dev, "Using non-panel bridge\n");
 163         } else {
 164                 dev_err(dev->dev, "No bridge, exiting\n");
 165                 return -ENODEV;
 166         }
 167
 168         priv->bridge = bridge;
 169         if (panel) {
 170                 priv->panel = panel;
 171                 priv->connector = drm_panel_bridge_connector(bridge);
 172         }
 173
 174         ret = pl111_display_init(dev);
 175         if (ret != 0) {
 176                 dev_err(dev->dev, "Failed to init display\n");
 177                 goto out_bridge;
 178         }
 179
 180         ret = drm_simple_display_pipe_attach_bridge(&priv->pipe,
 181                                                     bridge);
 182         if (ret)
 183                 return ret;
 184
 185         if (!priv->variant->broken_vblank) {
 186                 ret = drm_vblank_init(dev, 1);
 187                 if (ret != 0) {
 188                         dev_err(dev->dev, "Failed to init vblank\n");
 189                         goto out_bridge;
 190                 }
 191         }
 192
 193         drm_mode_config_reset(dev);
 194
 195         drm_kms_helper_poll_init(dev);
 196
 197         goto finish;
 198
 199 out_bridge:
 200         if (panel)
 201                 drm_panel_bridge_remove(bridge);
 202 finish:
 203         return ret;
 204 }
 205
 206 static struct drm_gem_object *
 207 pl111_gem_import_sg_table(struct drm_device *dev,
 208                           struct dma_buf_attachment *attach,
 209                           struct sg_table *sgt)
 210 {
 211         struct pl111_drm_dev_private *priv = dev->dev_private;
 212
 213         /*
 214          * When using device-specific reserved memory we can't import
 215          * DMA buffers: those are passed by reference in any global
 216          * memory and we can only handle a specific range of memory.
 217          */
 218         if (priv->use_device_memory)
 219                 return ERR_PTR(-EINVAL);
 220
 221         return drm_gem_cma_prime_import_sg_table(dev, attach, sgt);
 222 }
 223
 224 DEFINE_DRM_GEM_CMA_FOPS(drm_fops);
 225
 226 static struct drm_driver pl111_drm_driver = {
 227         .driver_features =
 228                 DRIVER_MODESET | DRIVER_GEM | DRIVER_ATOMIC,
 229         .ioctls = NULL,
 230         .fops = &drm_fops,
 231         .name = "pl111",
 232         .desc = DRIVER_DESC,
 233         .date = "20170317",
 234         .major = 1,
 235         .minor = 0,
 236         .patchlevel = 0,
 237         .dumb_create = drm_gem_cma_dumb_create,
 238         .gem_free_object_unlocked = drm_gem_cma_free_object,
 239         .gem_vm_ops = &drm_gem_cma_vm_ops,
 240         .prime_handle_to_fd = drm_gem_prime_handle_to_fd,
 241         .prime_fd_to_handle = drm_gem_prime_fd_to_handle,
 242         .gem_prime_import_sg_table = pl111_gem_import_sg_table,
 243         .gem_prime_get_sg_table = drm_gem_cma_prime_get_sg_table,
 244         .gem_prime_mmap = drm_gem_cma_prime_mmap,
 245         .gem_prime_vmap = drm_gem_cma_prime_vmap,
 246
 247 #if defined(CONFIG_DEBUG_FS)
 248         .debugfs_init = pl111_debugfs_init,
 249 #endif
 250 };
 251
 252 static int pl111_amba_probe(struct amba_device *amba_dev,
 253                             const struct amba_id *id)
 254 {
 255         struct device *dev = &amba_dev->dev;
 256         struct pl111_drm_dev_private *priv;
 257         const struct pl111_variant_data *variant = id->data;
 258         struct drm_device *drm;
 259         int ret;
 260
 261         priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
 262         if (!priv)
 263                 return -ENOMEM;
 264
 265         drm = drm_dev_alloc(&pl111_drm_driver, dev);
 266         if (IS_ERR(drm))
 267                 return PTR_ERR(drm);
 268         amba_set_drvdata(amba_dev, drm);
 269         priv->drm = drm;
 270         drm->dev_private = priv;
 271         priv->variant = variant;
 272
 273         ret = of_reserved_mem_device_init(dev);
 274         if (!ret) {
 275                 dev_info(dev, "using device-specific reserved memory\n");
 276                 priv->use_device_memory = true;
 277         }
 278
 279         if (of_property_read_u32(dev->of_node, "max-memory-bandwidth",
 280                                  &priv->memory_bw)) {
 281                 dev_info(dev, "no max memory bandwidth specified, assume unlimited\n");
 282                 priv->memory_bw = 0;
 283         }
 284
 285         /* The two main variants swap this register */
 286         if (variant->is_pl110 || variant->is_lcdc) {
 287                 priv->ienb = CLCD_PL110_IENB;
 288                 priv->ctrl = CLCD_PL110_CNTL;
 289         } else {
 290                 priv->ienb = CLCD_PL111_IENB;
 291                 priv->ctrl = CLCD_PL111_CNTL;
 292         }
 293
 294         priv->regs = devm_ioremap_resource(dev, &amba_dev->res);
 295         if (IS_ERR(priv->regs)) {
 296                 dev_err(dev, "%s failed mmio\n", __func__);
 297                 ret = PTR_ERR(priv->regs);
 298                 goto dev_put;
 299         }
 300
 301         /* This may override some variant settings */
 302         ret = pl111_versatile_init(dev, priv);
 303         if (ret)
 304                 goto dev_put;
 305
 306         pl111_nomadik_init(dev);
 307
 308         /* turn off interrupts before requesting the irq */
 309         writel(0, priv->regs + priv->ienb);
 310
 311         ret = devm_request_irq(dev, amba_dev->irq[0], pl111_irq, 0,
 312                                variant->name, priv);
 313         if (ret != 0) {
 314                 dev_err(dev, "%s failed irq %d\n", __func__, ret);
 315                 return ret;
 316         }
 317
 318         ret = pl111_modeset_init(drm);
 319         if (ret != 0)
 320                 goto dev_put;
 321
 322         ret = drm_dev_register(drm, 0);
 323         if (ret < 0)
 324                 goto dev_put;
 325
 326         drm_fbdev_generic_setup(drm, priv->variant->fb_bpp);
 327
 328         return 0;
 329
 330 dev_put:
 331         drm_dev_put(drm);
 332         of_reserved_mem_device_release(dev);
 333
 334         return ret;
 335 }
 336
 337 static int pl111_amba_remove(struct amba_device *amba_dev)
 338 {
 339         struct device *dev = &amba_dev->dev;
 340         struct drm_device *drm = amba_get_drvdata(amba_dev);
 341         struct pl111_drm_dev_private *priv = drm->dev_private;
 342
 343         drm_dev_unregister(drm);
 344         if (priv->panel)
 345                 drm_panel_bridge_remove(priv->bridge);
 346         drm_dev_put(drm);
 347         of_reserved_mem_device_release(dev);
 348
 349         return 0;
 350 }
 351
 352 /*
 353  * This early variant lacks the 565 and 444 pixel formats.
 354  */
 355 static const u32 pl110_pixel_formats[] = {
 356         DRM_FORMAT_ABGR8888,
 357         DRM_FORMAT_XBGR8888,
 358         DRM_FORMAT_ARGB8888,
 359         DRM_FORMAT_XRGB8888,
 360         DRM_FORMAT_ABGR1555,
 361         DRM_FORMAT_XBGR1555,
 362         DRM_FORMAT_ARGB1555,
 363         DRM_FORMAT_XRGB1555,
 364 };
 365
 366 static const struct pl111_variant_data pl110_variant = {
 367         .name = "PL110",
 368         .is_pl110 = true,
 369         .formats = pl110_pixel_formats,
 370         .nformats = ARRAY_SIZE(pl110_pixel_formats),
 371         .fb_bpp = 16,
 372 };
 373
 374 /* RealView, Versatile Express etc use this modern variant */
 375 static const u32 pl111_pixel_formats[] = {
 376         DRM_FORMAT_ABGR8888,
 377         DRM_FORMAT_XBGR8888,
 378         DRM_FORMAT_ARGB8888,
 379         DRM_FORMAT_XRGB8888,
 380         DRM_FORMAT_BGR565,
 381         DRM_FORMAT_RGB565,
 382         DRM_FORMAT_ABGR1555,
 383         DRM_FORMAT_XBGR1555,
 384         DRM_FORMAT_ARGB1555,
 385         DRM_FORMAT_XRGB1555,
 386         DRM_FORMAT_ABGR4444,
 387         DRM_FORMAT_XBGR4444,
 388         DRM_FORMAT_ARGB4444,
 389         DRM_FORMAT_XRGB4444,
 390 };
 391
 392 static const struct pl111_variant_data pl111_variant = {
 393         .name = "PL111",
 394         .formats = pl111_pixel_formats,
 395         .nformats = ARRAY_SIZE(pl111_pixel_formats),
 396         .fb_bpp = 32,
 397 };
 398
 399 static const u32 pl110_nomadik_pixel_formats[] = {
 400         DRM_FORMAT_RGB888,
 401         DRM_FORMAT_BGR888,
 402         DRM_FORMAT_ABGR8888,
 403         DRM_FORMAT_XBGR8888,
 404         DRM_FORMAT_ARGB8888,
 405         DRM_FORMAT_XRGB8888,
 406         DRM_FORMAT_BGR565,
 407         DRM_FORMAT_RGB565,
 408         DRM_FORMAT_ABGR1555,
 409         DRM_FORMAT_XBGR1555,
 410         DRM_FORMAT_ARGB1555,
 411         DRM_FORMAT_XRGB1555,
 412         DRM_FORMAT_ABGR4444,
 413         DRM_FORMAT_XBGR4444,
 414         DRM_FORMAT_ARGB4444,
 415         DRM_FORMAT_XRGB4444,
 416 };
 417
 418 static const struct pl111_variant_data pl110_nomadik_variant = {
 419         .name = "LCDC (PL110 Nomadik)",
 420         .formats = pl110_nomadik_pixel_formats,
 421         .nformats = ARRAY_SIZE(pl110_nomadik_pixel_formats),
 422         .is_lcdc = true,
 423         .st_bitmux_control = true,
 424         .broken_vblank = true,
 425         .fb_bpp = 16,
 426 };
 427
 428 static const struct amba_id pl111_id_table[] = {
 429         {
 430                 .id = 0x00041110,
 431                 .mask = 0x000fffff,
 432                 .data = (void *)&pl110_variant,
 433         },
 434         {
 435                 .id = 0x00180110,
 436                 .mask = 0x00fffffe,
 437                 .data = (void *)&pl110_nomadik_variant,
 438         },
 439         {
 440                 .id = 0x00041111,
 441                 .mask = 0x000fffff,
 442                 .data = (void *)&pl111_variant,
 443         },
 444         {0, 0},
 445 };
 446 MODULE_DEVICE_TABLE(amba, pl111_id_table);
 447
 448 static struct amba_driver pl111_amba_driver __maybe_unused = {
 449         .drv = {
 450                 .name = "drm-clcd-pl111",
 451         },
 452         .probe = pl111_amba_probe,
 453         .remove = pl111_amba_remove,
 454         .id_table = pl111_id_table,
 455 };
 456
 457 #ifdef CONFIG_ARM_AMBA
 458 module_amba_driver(pl111_amba_driver);
 459 #endif
 460
 461 MODULE_DESCRIPTION(DRIVER_DESC);
 462 MODULE_AUTHOR("ARM Ltd.");
 463 MODULE_LICENSE("GPL");