2 * (C) COPYRIGHT 2012-2013 ARM Limited. All rights reserved.
4 * Parts of this file were based on sources as follows:
6 * Copyright (c) 2006-2008 Intel Corporation
7 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie>
8 * Copyright (C) 2011 Texas Instruments
10 * This program is free software and is provided to you under the terms of the
11 * GNU General Public License version 2 as published by the Free Software
12 * Foundation, and any use by you of this program is subject to the terms of
18 * DOC: ARM PrimeCell PL111 CLCD Driver
20 * The PL111 is a simple LCD controller that can support TFT and STN
21 * displays. This driver exposes a standard KMS interface for them.
23 * This driver uses the same Device Tree binding as the fbdev CLCD
24 * driver. While the fbdev driver supports panels that may be
25 * connected to the CLCD internally to the CLCD driver, in DRM the
26 * panels get split out to drivers/gpu/drm/panels/. This means that,
27 * in converting from using fbdev to using DRM, you also need to write
28 * a panel driver (which may be as simple as an entry in
31 * The driver currently doesn't expose the cursor. The DRM API for
32 * cursors requires support for 64x64 ARGB8888 cursor images, while
33 * the hardware can only support 64x64 monochrome with masking
34 * cursors. While one could imagine trying to hack something together
35 * to look at the ARGB8888 and program reasonable in monochrome, we
36 * just don't expose the cursor at all instead, and leave cursor
37 * support to the X11 software cursor layer.
41 * - Fix race between setting plane base address and getting IRQ for
42 * vsync firing the pageflip completion.
44 * - Use the "max-memory-bandwidth" DT property to filter the
47 * - Read back hardware state at boot to skip reprogramming the
48 * hardware when doing a no-op modeset.
50 * - Use the CLKSEL bit to support switching between the two external
54 #include <linux/amba/bus.h>
55 #include <linux/amba/clcd-regs.h>
56 #include <linux/version.h>
57 #include <linux/shmem_fs.h>
58 #include <linux/dma-buf.h>
59 #include <linux/module.h>
60 #include <linux/slab.h>
62 #include <linux/of_graph.h>
63 #include <linux/of_reserved_mem.h>
66 #include <drm/drm_atomic_helper.h>
67 #include <drm/drm_crtc_helper.h>
68 #include <drm/drm_gem_cma_helper.h>
69 #include <drm/drm_gem_framebuffer_helper.h>
70 #include <drm/drm_fb_helper.h>
71 #include <drm/drm_fb_cma_helper.h>
72 #include <drm/drm_of.h>
73 #include <drm/drm_bridge.h>
74 #include <drm/drm_panel.h>
76 #include "pl111_drm.h"
77 #include "pl111_versatile.h"
78 #include "pl111_nomadik.h"
80 #define DRIVER_DESC "DRM module for PL111"
82 static const struct drm_mode_config_funcs mode_config_funcs = {
83 .fb_create = drm_gem_fb_create,
84 .atomic_check = drm_atomic_helper_check,
85 .atomic_commit = drm_atomic_helper_commit,
88 static int pl111_modeset_init(struct drm_device *dev)
90 struct drm_mode_config *mode_config;
91 struct pl111_drm_dev_private *priv = dev->dev_private;
92 struct device_node *np = dev->dev->of_node;
93 struct device_node *remote;
94 struct drm_panel *panel = NULL;
95 struct drm_bridge *bridge = NULL;
100 drm_mode_config_init(dev);
101 mode_config = &dev->mode_config;
102 mode_config->funcs = &mode_config_funcs;
103 mode_config->min_width = 1;
104 mode_config->max_width = 1024;
105 mode_config->min_height = 1;
106 mode_config->max_height = 768;
109 for_each_endpoint_of_node(np, remote) {
110 struct drm_panel *tmp_panel;
111 struct drm_bridge *tmp_bridge;
113 dev_dbg(dev->dev, "checking endpoint %d\n", i);
115 ret = drm_of_find_panel_or_bridge(dev->dev->of_node,
120 if (ret == -EPROBE_DEFER) {
122 * Something deferred, but that is often just
123 * another way of saying -ENODEV, but let's
124 * cast a vote for later deferral.
127 } else if (ret != -ENODEV) {
128 /* Continue, maybe something else is working */
130 "endpoint %d returns %d\n", i, ret);
136 "found panel on endpoint %d\n", i);
141 "found bridge on endpoint %d\n", i);
149 * If we can't find neither panel nor bridge on any of the
150 * endpoints, and any of them retured -EPROBE_DEFER, then
151 * let's defer this driver too.
153 if ((!panel && !bridge) && defer)
154 return -EPROBE_DEFER;
157 bridge = drm_panel_bridge_add(panel,
158 DRM_MODE_CONNECTOR_Unknown);
159 if (IS_ERR(bridge)) {
160 ret = PTR_ERR(bridge);
164 dev_info(dev->dev, "Using non-panel bridge\n");
166 dev_err(dev->dev, "No bridge, exiting\n");
170 priv->bridge = bridge;
173 priv->connector = panel->connector;
176 ret = pl111_display_init(dev);
178 dev_err(dev->dev, "Failed to init display\n");
182 ret = drm_simple_display_pipe_attach_bridge(&priv->pipe,
187 if (!priv->variant->broken_vblank) {
188 ret = drm_vblank_init(dev, 1);
190 dev_err(dev->dev, "Failed to init vblank\n");
195 drm_mode_config_reset(dev);
197 drm_fb_cma_fbdev_init(dev, priv->variant->fb_bpp, 0);
199 drm_kms_helper_poll_init(dev);
205 drm_panel_bridge_remove(bridge);
207 drm_mode_config_cleanup(dev);
212 static struct drm_gem_object *
213 pl111_gem_import_sg_table(struct drm_device *dev,
214 struct dma_buf_attachment *attach,
215 struct sg_table *sgt)
217 struct pl111_drm_dev_private *priv = dev->dev_private;
220 * When using device-specific reserved memory we can't import
221 * DMA buffers: those are passed by reference in any global
222 * memory and we can only handle a specific range of memory.
224 if (priv->use_device_memory)
225 return ERR_PTR(-EINVAL);
227 return drm_gem_cma_prime_import_sg_table(dev, attach, sgt);
230 DEFINE_DRM_GEM_CMA_FOPS(drm_fops);
232 static struct drm_driver pl111_drm_driver = {
234 DRIVER_MODESET | DRIVER_GEM | DRIVER_PRIME | DRIVER_ATOMIC,
235 .lastclose = drm_fb_helper_lastclose,
244 .dumb_create = drm_gem_cma_dumb_create,
245 .gem_free_object_unlocked = drm_gem_cma_free_object,
246 .gem_vm_ops = &drm_gem_cma_vm_ops,
247 .prime_handle_to_fd = drm_gem_prime_handle_to_fd,
248 .prime_fd_to_handle = drm_gem_prime_fd_to_handle,
249 .gem_prime_import = drm_gem_prime_import,
250 .gem_prime_import_sg_table = pl111_gem_import_sg_table,
251 .gem_prime_export = drm_gem_prime_export,
252 .gem_prime_get_sg_table = drm_gem_cma_prime_get_sg_table,
253 .gem_prime_mmap = drm_gem_cma_prime_mmap,
254 .gem_prime_vmap = drm_gem_cma_prime_vmap,
256 #if defined(CONFIG_DEBUG_FS)
257 .debugfs_init = pl111_debugfs_init,
261 static int pl111_amba_probe(struct amba_device *amba_dev,
262 const struct amba_id *id)
264 struct device *dev = &amba_dev->dev;
265 struct pl111_drm_dev_private *priv;
266 const struct pl111_variant_data *variant = id->data;
267 struct drm_device *drm;
270 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
274 drm = drm_dev_alloc(&pl111_drm_driver, dev);
277 amba_set_drvdata(amba_dev, drm);
279 drm->dev_private = priv;
280 priv->variant = variant;
282 ret = of_reserved_mem_device_init(dev);
284 dev_info(dev, "using device-specific reserved memory\n");
285 priv->use_device_memory = true;
288 if (of_property_read_u32(dev->of_node, "max-memory-bandwidth",
290 dev_info(dev, "no max memory bandwidth specified, assume unlimited\n");
294 /* The two main variants swap this register */
295 if (variant->is_pl110 || variant->is_lcdc) {
296 priv->ienb = CLCD_PL110_IENB;
297 priv->ctrl = CLCD_PL110_CNTL;
299 priv->ienb = CLCD_PL111_IENB;
300 priv->ctrl = CLCD_PL111_CNTL;
303 priv->regs = devm_ioremap_resource(dev, &amba_dev->res);
304 if (IS_ERR(priv->regs)) {
305 dev_err(dev, "%s failed mmio\n", __func__);
306 ret = PTR_ERR(priv->regs);
310 /* This may override some variant settings */
311 ret = pl111_versatile_init(dev, priv);
315 pl111_nomadik_init(dev);
317 /* turn off interrupts before requesting the irq */
318 writel(0, priv->regs + priv->ienb);
320 ret = devm_request_irq(dev, amba_dev->irq[0], pl111_irq, 0,
321 variant->name, priv);
323 dev_err(dev, "%s failed irq %d\n", __func__, ret);
327 ret = pl111_modeset_init(drm);
331 ret = drm_dev_register(drm, 0);
339 of_reserved_mem_device_release(dev);
344 static int pl111_amba_remove(struct amba_device *amba_dev)
346 struct device *dev = &amba_dev->dev;
347 struct drm_device *drm = amba_get_drvdata(amba_dev);
348 struct pl111_drm_dev_private *priv = drm->dev_private;
350 drm_dev_unregister(drm);
351 drm_fb_cma_fbdev_fini(drm);
353 drm_panel_bridge_remove(priv->bridge);
354 drm_mode_config_cleanup(drm);
356 of_reserved_mem_device_release(dev);
362 * This early variant lacks the 565 and 444 pixel formats.
364 static const u32 pl110_pixel_formats[] = {
375 static const struct pl111_variant_data pl110_variant = {
378 .formats = pl110_pixel_formats,
379 .nformats = ARRAY_SIZE(pl110_pixel_formats),
383 /* RealView, Versatile Express etc use this modern variant */
384 static const u32 pl111_pixel_formats[] = {
401 static const struct pl111_variant_data pl111_variant = {
403 .formats = pl111_pixel_formats,
404 .nformats = ARRAY_SIZE(pl111_pixel_formats),
408 static const u32 pl110_nomadik_pixel_formats[] = {
427 static const struct pl111_variant_data pl110_nomadik_variant = {
428 .name = "LCDC (PL110 Nomadik)",
429 .formats = pl110_nomadik_pixel_formats,
430 .nformats = ARRAY_SIZE(pl110_nomadik_pixel_formats),
432 .st_bitmux_control = true,
433 .broken_vblank = true,
437 static const struct amba_id pl111_id_table[] = {
441 .data = (void *)&pl110_variant,
446 .data = (void *)&pl110_nomadik_variant,
451 .data = (void *)&pl111_variant,
456 static struct amba_driver pl111_amba_driver __maybe_unused = {
458 .name = "drm-clcd-pl111",
460 .probe = pl111_amba_probe,
461 .remove = pl111_amba_remove,
462 .id_table = pl111_id_table,
465 #ifdef CONFIG_ARM_AMBA
466 module_amba_driver(pl111_amba_driver);
469 MODULE_DESCRIPTION(DRIVER_DESC);
470 MODULE_AUTHOR("ARM Ltd.");
471 MODULE_LICENSE("GPL");