1 /* 2 * (C) COPYRIGHT 2012-2013 ARM Limited. All rights reserved. 3 * 4 * Parts of this file were based on sources as follows: 5 * 6 * Copyright (c) 2006-2008 Intel Corporation 7 * Copyright (c) 2007 Dave Airlie <airlied@linux.ie> 8 * Copyright (C) 2011 Texas Instruments 9 * 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 13 * such GNU licence. 14 * 15 */ 16 17 /** 18 * DOC: ARM PrimeCell PL111 CLCD Driver 19 * 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. 22 * 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 29 * panel-simple.c). 30 * 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. 38 * 39 * TODO: 40 * 41 * - Fix race between setting plane base address and getting IRQ for 42 * vsync firing the pageflip completion. 43 * 44 * - Use the "max-memory-bandwidth" DT property to filter the 45 * supported formats. 46 * 47 * - Read back hardware state at boot to skip reprogramming the 48 * hardware when doing a no-op modeset. 49 * 50 * - Use the CLKSEL bit to support switching between the two external 51 * clock parents. 52 */ 53 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> 61 62 #include <drm/drmP.h> 63 #include <drm/drm_atomic_helper.h> 64 #include <drm/drm_crtc_helper.h> 65 #include <drm/drm_gem_cma_helper.h> 66 #include <drm/drm_gem_framebuffer_helper.h> 67 #include <drm/drm_fb_helper.h> 68 #include <drm/drm_fb_cma_helper.h> 69 #include <drm/drm_of.h> 70 #include <drm/drm_bridge.h> 71 #include <drm/drm_panel.h> 72 73 #include "pl111_drm.h" 74 #include "pl111_versatile.h" 75 76 #define DRIVER_DESC "DRM module for PL111" 77 78 static const struct drm_mode_config_funcs mode_config_funcs = { 79 .fb_create = drm_gem_fb_create, 80 .atomic_check = drm_atomic_helper_check, 81 .atomic_commit = drm_atomic_helper_commit, 82 }; 83 84 static int pl111_modeset_init(struct drm_device *dev) 85 { 86 struct drm_mode_config *mode_config; 87 struct pl111_drm_dev_private *priv = dev->dev_private; 88 struct drm_panel *panel; 89 struct drm_bridge *bridge; 90 int ret = 0; 91 92 drm_mode_config_init(dev); 93 mode_config = &dev->mode_config; 94 mode_config->funcs = &mode_config_funcs; 95 mode_config->min_width = 1; 96 mode_config->max_width = 1024; 97 mode_config->min_height = 1; 98 mode_config->max_height = 768; 99 100 ret = drm_of_find_panel_or_bridge(dev->dev->of_node, 101 0, 0, &panel, &bridge); 102 if (ret && ret != -ENODEV) 103 return ret; 104 if (panel) { 105 bridge = drm_panel_bridge_add(panel, 106 DRM_MODE_CONNECTOR_Unknown); 107 if (IS_ERR(bridge)) { 108 ret = PTR_ERR(bridge); 109 goto out_config; 110 } 111 /* 112 * TODO: when we are using a different bridge than a panel 113 * (such as a dumb VGA connector) we need to devise a different 114 * method to get the connector out of the bridge. 115 */ 116 } 117 118 ret = pl111_display_init(dev); 119 if (ret != 0) { 120 dev_err(dev->dev, "Failed to init display\n"); 121 goto out_bridge; 122 } 123 124 ret = drm_simple_display_pipe_attach_bridge(&priv->pipe, 125 bridge); 126 if (ret) 127 return ret; 128 129 priv->bridge = bridge; 130 priv->panel = panel; 131 priv->connector = panel->connector; 132 133 ret = drm_vblank_init(dev, 1); 134 if (ret != 0) { 135 dev_err(dev->dev, "Failed to init vblank\n"); 136 goto out_bridge; 137 } 138 139 drm_mode_config_reset(dev); 140 141 drm_fb_cma_fbdev_init(dev, 32, 0); 142 143 drm_kms_helper_poll_init(dev); 144 145 goto finish; 146 147 out_bridge: 148 if (panel) 149 drm_panel_bridge_remove(bridge); 150 out_config: 151 drm_mode_config_cleanup(dev); 152 finish: 153 return ret; 154 } 155 156 DEFINE_DRM_GEM_CMA_FOPS(drm_fops); 157 158 static struct drm_driver pl111_drm_driver = { 159 .driver_features = 160 DRIVER_MODESET | DRIVER_GEM | DRIVER_PRIME | DRIVER_ATOMIC, 161 .lastclose = drm_fb_helper_lastclose, 162 .ioctls = NULL, 163 .fops = &drm_fops, 164 .name = "pl111", 165 .desc = DRIVER_DESC, 166 .date = "20170317", 167 .major = 1, 168 .minor = 0, 169 .patchlevel = 0, 170 .dumb_create = drm_gem_cma_dumb_create, 171 .gem_free_object_unlocked = drm_gem_cma_free_object, 172 .gem_vm_ops = &drm_gem_cma_vm_ops, 173 174 .enable_vblank = pl111_enable_vblank, 175 .disable_vblank = pl111_disable_vblank, 176 177 .prime_handle_to_fd = drm_gem_prime_handle_to_fd, 178 .prime_fd_to_handle = drm_gem_prime_fd_to_handle, 179 .gem_prime_import = drm_gem_prime_import, 180 .gem_prime_import_sg_table = drm_gem_cma_prime_import_sg_table, 181 .gem_prime_export = drm_gem_prime_export, 182 .gem_prime_get_sg_table = drm_gem_cma_prime_get_sg_table, 183 184 #if defined(CONFIG_DEBUG_FS) 185 .debugfs_init = pl111_debugfs_init, 186 #endif 187 }; 188 189 static int pl111_amba_probe(struct amba_device *amba_dev, 190 const struct amba_id *id) 191 { 192 struct device *dev = &amba_dev->dev; 193 struct pl111_drm_dev_private *priv; 194 struct pl111_variant_data *variant = id->data; 195 struct drm_device *drm; 196 int ret; 197 198 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL); 199 if (!priv) 200 return -ENOMEM; 201 202 drm = drm_dev_alloc(&pl111_drm_driver, dev); 203 if (IS_ERR(drm)) 204 return PTR_ERR(drm); 205 amba_set_drvdata(amba_dev, drm); 206 priv->drm = drm; 207 drm->dev_private = priv; 208 priv->variant = variant; 209 210 /* 211 * The PL110 and PL111 variants have two registers 212 * swapped: interrupt enable and control. For this reason 213 * we use offsets that we can change per variant. 214 */ 215 if (variant->is_pl110) { 216 /* 217 * The ARM Versatile boards are even more special: 218 * their PrimeCell ID say they are PL110 but the 219 * control and interrupt enable registers are anyway 220 * swapped to the PL111 order so they are not following 221 * the PL110 datasheet. 222 */ 223 if (of_machine_is_compatible("arm,versatile-ab") || 224 of_machine_is_compatible("arm,versatile-pb")) { 225 priv->ienb = CLCD_PL111_IENB; 226 priv->ctrl = CLCD_PL111_CNTL; 227 } else { 228 priv->ienb = CLCD_PL110_IENB; 229 priv->ctrl = CLCD_PL110_CNTL; 230 } 231 } else { 232 priv->ienb = CLCD_PL111_IENB; 233 priv->ctrl = CLCD_PL111_CNTL; 234 } 235 236 priv->regs = devm_ioremap_resource(dev, &amba_dev->res); 237 if (IS_ERR(priv->regs)) { 238 dev_err(dev, "%s failed mmio\n", __func__); 239 return PTR_ERR(priv->regs); 240 } 241 242 /* turn off interrupts before requesting the irq */ 243 writel(0, priv->regs + priv->ienb); 244 245 ret = devm_request_irq(dev, amba_dev->irq[0], pl111_irq, 0, 246 variant->name, priv); 247 if (ret != 0) { 248 dev_err(dev, "%s failed irq %d\n", __func__, ret); 249 return ret; 250 } 251 252 ret = pl111_versatile_init(dev, priv); 253 if (ret) 254 goto dev_unref; 255 256 ret = pl111_modeset_init(drm); 257 if (ret != 0) 258 goto dev_unref; 259 260 ret = drm_dev_register(drm, 0); 261 if (ret < 0) 262 goto dev_unref; 263 264 return 0; 265 266 dev_unref: 267 drm_dev_unref(drm); 268 return ret; 269 } 270 271 static int pl111_amba_remove(struct amba_device *amba_dev) 272 { 273 struct drm_device *drm = amba_get_drvdata(amba_dev); 274 struct pl111_drm_dev_private *priv = drm->dev_private; 275 276 drm_dev_unregister(drm); 277 drm_fb_cma_fbdev_fini(drm); 278 if (priv->panel) 279 drm_panel_bridge_remove(priv->bridge); 280 drm_mode_config_cleanup(drm); 281 drm_dev_unref(drm); 282 283 return 0; 284 } 285 286 /* 287 * This variant exist in early versions like the ARM Integrator 288 * and this version lacks the 565 and 444 pixel formats. 289 */ 290 static const u32 pl110_pixel_formats[] = { 291 DRM_FORMAT_ABGR8888, 292 DRM_FORMAT_XBGR8888, 293 DRM_FORMAT_ARGB8888, 294 DRM_FORMAT_XRGB8888, 295 DRM_FORMAT_ABGR1555, 296 DRM_FORMAT_XBGR1555, 297 DRM_FORMAT_ARGB1555, 298 DRM_FORMAT_XRGB1555, 299 }; 300 301 static const struct pl111_variant_data pl110_variant = { 302 .name = "PL110", 303 .is_pl110 = true, 304 .formats = pl110_pixel_formats, 305 .nformats = ARRAY_SIZE(pl110_pixel_formats), 306 }; 307 308 /* RealView, Versatile Express etc use this modern variant */ 309 static const u32 pl111_pixel_formats[] = { 310 DRM_FORMAT_ABGR8888, 311 DRM_FORMAT_XBGR8888, 312 DRM_FORMAT_ARGB8888, 313 DRM_FORMAT_XRGB8888, 314 DRM_FORMAT_BGR565, 315 DRM_FORMAT_RGB565, 316 DRM_FORMAT_ABGR1555, 317 DRM_FORMAT_XBGR1555, 318 DRM_FORMAT_ARGB1555, 319 DRM_FORMAT_XRGB1555, 320 DRM_FORMAT_ABGR4444, 321 DRM_FORMAT_XBGR4444, 322 DRM_FORMAT_ARGB4444, 323 DRM_FORMAT_XRGB4444, 324 }; 325 326 static const struct pl111_variant_data pl111_variant = { 327 .name = "PL111", 328 .formats = pl111_pixel_formats, 329 .nformats = ARRAY_SIZE(pl111_pixel_formats), 330 }; 331 332 static const struct amba_id pl111_id_table[] = { 333 { 334 .id = 0x00041110, 335 .mask = 0x000fffff, 336 .data = (void*)&pl110_variant, 337 }, 338 { 339 .id = 0x00041111, 340 .mask = 0x000fffff, 341 .data = (void*)&pl111_variant, 342 }, 343 {0, 0}, 344 }; 345 346 static struct amba_driver pl111_amba_driver __maybe_unused = { 347 .drv = { 348 .name = "drm-clcd-pl111", 349 }, 350 .probe = pl111_amba_probe, 351 .remove = pl111_amba_remove, 352 .id_table = pl111_id_table, 353 }; 354 355 #ifdef CONFIG_ARM_AMBA 356 module_amba_driver(pl111_amba_driver); 357 #endif 358 359 MODULE_DESCRIPTION(DRIVER_DESC); 360 MODULE_AUTHOR("ARM Ltd."); 361 MODULE_LICENSE("GPL"); 362