Quelle  pl111_drv.c   Sprache: C

// SPDX-License-Identifier: GPL-2.0-only
/*
 * (C) COPYRIGHT 2012-2013 ARM Limited. All rights reserved.
 *
 * Parts of this file were based on sources as follows:
 *
 * Copyright (c) 2006-2008 Intel Corporation
 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
 * Copyright (C) 2011 Texas Instruments
 */

/**
 * DOC: ARM PrimeCell PL110 and PL111 CLCD Driver
 *
 * The PL110/PL111 is a simple LCD controller that can support TFT
 * and STN displays. This driver exposes a standard KMS interface
 * for them.
 *
 * The driver currently doesn't expose the cursor.  The DRM API for
 * cursors requires support for 64x64 ARGB8888 cursor images, while
 * the hardware can only support 64x64 monochrome with masking
 * cursors.  While one could imagine trying to hack something together
 * to look at the ARGB8888 and program reasonable in monochrome, we
 * just don't expose the cursor at all instead, and leave cursor
 * support to the application software cursor layer.
 *
 * TODO:
 *
 * - Fix race between setting plane base address and getting IRQ for
 *   vsync firing the pageflip completion.
 *
 * - Read back hardware state at boot to skip reprogramming the
 *   hardware when doing a no-op modeset.
 *
 * - Use the CLKSEL bit to support switching between the two external
 *   clock parents.
 */

#include <linux/amba/bus.h>
#include <linux/dma-buf.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/of_graph.h>
#include <linux/of_reserved_mem.h>
#include <linux/shmem_fs.h>
#include <linux/slab.h>

#include <drm/clients/drm_client_setup.h>
#include <drm/drm_atomic_helper.h>
#include <drm/drm_bridge.h>
#include <drm/drm_drv.h>
#include <drm/drm_fbdev_dma.h>
#include <drm/drm_fourcc.h>
#include <drm/drm_gem_dma_helper.h>
#include <drm/drm_gem_framebuffer_helper.h>
#include <drm/drm_of.h>
#include <drm/drm_panel.h>
#include <drm/drm_probe_helper.h>
#include <drm/drm_vblank.h>

#include "pl111_drm.h"
#include "pl111_versatile.h"
#include "pl111_nomadik.h"

#define DRIVER_DESC      "DRM module for PL111"

static const struct drm_mode_config_funcs mode_config_funcs = {
 .fb_create = drm_gem_fb_create,
 .atomic_check = drm_atomic_helper_check,
 .atomic_commit = drm_atomic_helper_commit,
};

static int pl111_modeset_init(struct drm_device *dev)
{
 struct drm_mode_config *mode_config;
 struct pl111_drm_dev_private *priv = dev->dev_private;
 struct device_node *np = dev->dev->of_node;
 struct device_node *remote;
 struct drm_panel *panel = NULL;
 struct drm_bridge *bridge = NULL;
 bool defer = false;
 int ret;
 int i;

 ret = drmm_mode_config_init(dev);
 if (ret)
  return ret;

 mode_config = &dev->mode_config;
 mode_config->funcs = &mode_config_funcs;
 mode_config->min_width = 1;
 mode_config->max_width = 1024;
 mode_config->min_height = 1;
 mode_config->max_height = 768;

 i = 0;
 for_each_endpoint_of_node(np, remote) {
  struct drm_panel *tmp_panel;
  struct drm_bridge *tmp_bridge;

  dev_dbg(dev->dev, "checking endpoint %d\n", i);

  ret = drm_of_find_panel_or_bridge(dev->dev->of_node,
        0, i,
        &tmp_panel,
        &tmp_bridge);
  if (ret) {
   if (ret == -EPROBE_DEFER) {
    /*
 * Something deferred, but that is often just
 * another way of saying -ENODEV, but let's
 * cast a vote for later deferral.
 */
    defer = true;
   } else if (ret != -ENODEV) {
    /* Continue, maybe something else is working */
    dev_err(dev->dev,
     "endpoint %d returns %d\n", i, ret);
   }
  }

  if (tmp_panel) {
   dev_info(dev->dev,
     "found panel on endpoint %d\n", i);
   panel = tmp_panel;
  }
  if (tmp_bridge) {
   dev_info(dev->dev,
     "found bridge on endpoint %d\n", i);
   bridge = tmp_bridge;
  }

  i++;
 }

 /*
 * If we can't find neither panel nor bridge on any of the
 * endpoints, and any of them retured -EPROBE_DEFER, then
 * let's defer this driver too.
 */
 if ((!panel && !bridge) && defer)
  return -EPROBE_DEFER;

 if (panel) {
  bridge = drm_panel_bridge_add_typed(panel,
          DRM_MODE_CONNECTOR_Unknown);
  if (IS_ERR(bridge)) {
   ret = PTR_ERR(bridge);
   goto finish;
  }
 } else if (bridge) {
  dev_info(dev->dev, "Using non-panel bridge\n");
 } else {
  dev_err(dev->dev, "No bridge, exiting\n");
  return -ENODEV;
 }

 priv->bridge = bridge;
 if (panel) {
  priv->panel = panel;
  priv->connector = drm_panel_bridge_connector(bridge);
 }

 ret = pl111_display_init(dev);
 if (ret != 0) {
  dev_err(dev->dev, "Failed to init display\n");
  goto out_bridge;
 }

 ret = drm_simple_display_pipe_attach_bridge(&priv->pipe,
          bridge);
 if (ret)
  return ret;

 if (!priv->variant->broken_vblank) {
  ret = drm_vblank_init(dev, 1);
  if (ret != 0) {
   dev_err(dev->dev, "Failed to init vblank\n");
   goto out_bridge;
  }
 }

 drm_mode_config_reset(dev);

 drm_kms_helper_poll_init(dev);

 goto finish;

out_bridge:
 if (panel)
  drm_panel_bridge_remove(bridge);
finish:
 return ret;
}

static struct drm_gem_object *
pl111_gem_import_sg_table(struct drm_device *dev,
     struct dma_buf_attachment *attach,
     struct sg_table *sgt)
{
 struct pl111_drm_dev_private *priv = dev->dev_private;

 /*
 * When using device-specific reserved memory we can't import
 * DMA buffers: those are passed by reference in any global
 * memory and we can only handle a specific range of memory.
 */
 if (priv->use_device_memory)
  return ERR_PTR(-EINVAL);

 return drm_gem_dma_prime_import_sg_table(dev, attach, sgt);
}

DEFINE_DRM_GEM_DMA_FOPS(drm_fops);

static const struct drm_driver pl111_drm_driver = {
 .driver_features =
  DRIVER_MODESET | DRIVER_GEM | DRIVER_ATOMIC,
 .ioctls = NULL,
 .fops = &drm_fops,
 .name = "pl111",
 .desc = DRIVER_DESC,
 .major = 1,
 .minor = 0,
 .patchlevel = 0,
 .dumb_create = drm_gem_dma_dumb_create,
 .gem_prime_import_sg_table = pl111_gem_import_sg_table,
 DRM_FBDEV_DMA_DRIVER_OPS,

#if defined(CONFIG_DEBUG_FS)
 .debugfs_init = pl111_debugfs_init,
#endif
};

static int pl111_amba_probe(struct amba_device *amba_dev,
       const struct amba_id *id)
{
 struct device *dev = &amba_dev->dev;
 struct pl111_drm_dev_private *priv;
 const struct pl111_variant_data *variant = id->data;
 struct drm_device *drm;
 int ret;

 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
 if (!priv)
  return -ENOMEM;

 drm = drm_dev_alloc(&pl111_drm_driver, dev);
 if (IS_ERR(drm))
  return PTR_ERR(drm);
 amba_set_drvdata(amba_dev, drm);
 priv->drm = drm;
 drm->dev_private = priv;
 priv->variant = variant;

 ret = of_reserved_mem_device_init(dev);
 if (!ret) {
  dev_info(dev, "using device-specific reserved memory\n");
  priv->use_device_memory = true;
 }

 if (of_property_read_u32(dev->of_node, "max-memory-bandwidth",
     &priv->memory_bw)) {
  dev_info(dev, "no max memory bandwidth specified, assume unlimited\n");
  priv->memory_bw = 0;
 }

 /* The two main variants swap this register */
 if (variant->is_pl110 || variant->is_lcdc) {
  priv->ienb = CLCD_PL110_IENB;
  priv->ctrl = CLCD_PL110_CNTL;
 } else {
  priv->ienb = CLCD_PL111_IENB;
  priv->ctrl = CLCD_PL111_CNTL;
 }

 priv->regs = devm_ioremap_resource(dev, &amba_dev->res);
 if (IS_ERR(priv->regs)) {
  dev_err(dev, "%s failed mmio\n", __func__);
  ret = PTR_ERR(priv->regs);
  goto dev_put;
 }

 /* This may override some variant settings */
 ret = pl111_versatile_init(dev, priv);
 if (ret)
  goto dev_put;

 pl111_nomadik_init(dev);

 /* turn off interrupts before requesting the irq */
 writel(0, priv->regs + priv->ienb);

 ret = devm_request_irq(dev, amba_dev->irq[0], pl111_irq, 0,
          variant->name, priv);
 if (ret != 0) {
  dev_err(dev, "%s failed irq %d\n", __func__, ret);
  return ret;
 }

 ret = pl111_modeset_init(drm);
 if (ret != 0)
  goto dev_put;

 ret = drm_dev_register(drm, 0);
 if (ret < 0)
  goto dev_put;

 drm_client_setup_with_color_mode(drm, priv->variant->fb_depth);

 return 0;

dev_put:
 drm_dev_put(drm);
 of_reserved_mem_device_release(dev);

 return ret;
}

static void pl111_amba_remove(struct amba_device *amba_dev)
{
 struct device *dev = &amba_dev->dev;
 struct drm_device *drm = amba_get_drvdata(amba_dev);
 struct pl111_drm_dev_private *priv = drm->dev_private;

 drm_dev_unregister(drm);
 drm_atomic_helper_shutdown(drm);
 if (priv->panel)
  drm_panel_bridge_remove(priv->bridge);
 drm_dev_put(drm);
 of_reserved_mem_device_release(dev);
}

static void pl111_amba_shutdown(struct amba_device *amba_dev)
{
 drm_atomic_helper_shutdown(amba_get_drvdata(amba_dev));
}

/*
 * This early variant lacks the 565 and 444 pixel formats.
 */
static const u32 pl110_pixel_formats[] = {
 DRM_FORMAT_ABGR8888,
 DRM_FORMAT_XBGR8888,
 DRM_FORMAT_ARGB8888,
 DRM_FORMAT_XRGB8888,
 DRM_FORMAT_ABGR1555,
 DRM_FORMAT_XBGR1555,
 DRM_FORMAT_ARGB1555,
 DRM_FORMAT_XRGB1555,
};

static const struct pl111_variant_data pl110_variant = {
 .name = "PL110",
 .is_pl110 = true,
 .formats = pl110_pixel_formats,
 .nformats = ARRAY_SIZE(pl110_pixel_formats),
 .fb_depth = 16,
};

/* RealView, Versatile Express etc use this modern variant */
static const u32 pl111_pixel_formats[] = {
 DRM_FORMAT_ABGR8888,
 DRM_FORMAT_XBGR8888,
 DRM_FORMAT_ARGB8888,
 DRM_FORMAT_XRGB8888,
 DRM_FORMAT_BGR565,
 DRM_FORMAT_RGB565,
 DRM_FORMAT_ABGR1555,
 DRM_FORMAT_XBGR1555,
 DRM_FORMAT_ARGB1555,
 DRM_FORMAT_XRGB1555,
 DRM_FORMAT_ABGR4444,
 DRM_FORMAT_XBGR4444,
 DRM_FORMAT_ARGB4444,
 DRM_FORMAT_XRGB4444,
};

static const struct pl111_variant_data pl111_variant = {
 .name = "PL111",
 .formats = pl111_pixel_formats,
 .nformats = ARRAY_SIZE(pl111_pixel_formats),
 .fb_depth = 32,
};

static const u32 pl110_nomadik_pixel_formats[] = {
 DRM_FORMAT_RGB888,
 DRM_FORMAT_BGR888,
 DRM_FORMAT_ABGR8888,
 DRM_FORMAT_XBGR8888,
 DRM_FORMAT_ARGB8888,
 DRM_FORMAT_XRGB8888,
 DRM_FORMAT_BGR565,
 DRM_FORMAT_RGB565,
 DRM_FORMAT_ABGR1555,
 DRM_FORMAT_XBGR1555,
 DRM_FORMAT_ARGB1555,
 DRM_FORMAT_XRGB1555,
 DRM_FORMAT_ABGR4444,
 DRM_FORMAT_XBGR4444,
 DRM_FORMAT_ARGB4444,
 DRM_FORMAT_XRGB4444,
};

static const struct pl111_variant_data pl110_nomadik_variant = {
 .name = "LCDC (PL110 Nomadik)",
 .formats = pl110_nomadik_pixel_formats,
 .nformats = ARRAY_SIZE(pl110_nomadik_pixel_formats),
 .is_lcdc = true,
 .st_bitmux_control = true,
 .broken_vblank = true,
 .fb_depth = 16,
};

static const struct amba_id pl111_id_table[] = {
 {
  .id = 0x00041110,
  .mask = 0x000fffff,
  .data = (void *)&pl110_variant,
 },
 {
  .id = 0x00180110,
  .mask = 0x00fffffe,
  .data = (void *)&pl110_nomadik_variant,
 },
 {
  .id = 0x00041111,
  .mask = 0x000fffff,
  .data = (void *)&pl111_variant,
 },
 {0, 0},
};
MODULE_DEVICE_TABLE(amba, pl111_id_table);

static struct amba_driver pl111_amba_driver __maybe_unused = {
 .drv = {
  .name = "drm-clcd-pl111",
 },
 .probe = pl111_amba_probe,
 .remove = pl111_amba_remove,
 .shutdown = pl111_amba_shutdown,
 .id_table = pl111_id_table,
};

#ifdef CONFIG_ARM_AMBA
module_amba_driver(pl111_amba_driver);
#endif

MODULE_DESCRIPTION(DRIVER_DESC);
MODULE_AUTHOR("ARM Ltd.");
MODULE_LICENSE("GPL");