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 <airlied@linux.ie> 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/amba/clcd-regs.h> 51 #include <linux/dma-buf.h> 52 #include <linux/module.h> 53 #include <linux/of.h> 54 #include <linux/of_graph.h> 55 #include <linux/of_reserved_mem.h> 56 #include <linux/shmem_fs.h> 57 #include <linux/slab.h> 58 #include <linux/version.h> 59 60 #include <drm/drm_atomic_helper.h> 61 #include <drm/drm_bridge.h> 62 #include <drm/drm_drv.h> 63 #include <drm/drm_fb_cma_helper.h> 64 #include <drm/drm_fb_helper.h> 65 #include <drm/drm_gem_cma_helper.h> 66 #include <drm/drm_gem_framebuffer_helper.h> 67 #include <drm/drm_of.h> 68 #include <drm/drm_panel.h> 69 #include <drm/drm_probe_helper.h> 70 #include <drm/drm_vblank.h> 71 72 #include "pl111_drm.h" 73 #include "pl111_versatile.h" 74 #include "pl111_nomadik.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 device_node *np = dev->dev->of_node; 89 struct device_node *remote; 90 struct drm_panel *panel = NULL; 91 struct drm_bridge *bridge = NULL; 92 bool defer = false; 93 int ret; 94 int i; 95 96 ret = drmm_mode_config_init(dev); 97 if (ret) 98 return ret; 99 100 mode_config = &dev->mode_config; 101 mode_config->funcs = &mode_config_funcs; 102 mode_config->min_width = 1; 103 mode_config->max_width = 1024; 104 mode_config->min_height = 1; 105 mode_config->max_height = 768; 106 107 i = 0; 108 for_each_endpoint_of_node(np, remote) { 109 struct drm_panel *tmp_panel; 110 struct drm_bridge *tmp_bridge; 111 112 dev_dbg(dev->dev, "checking endpoint %d\n", i); 113 114 ret = drm_of_find_panel_or_bridge(dev->dev->of_node, 115 0, i, 116 &tmp_panel, 117 &tmp_bridge); 118 if (ret) { 119 if (ret == -EPROBE_DEFER) { 120 /* 121 * Something deferred, but that is often just 122 * another way of saying -ENODEV, but let's 123 * cast a vote for later deferral. 124 */ 125 defer = true; 126 } else if (ret != -ENODEV) { 127 /* Continue, maybe something else is working */ 128 dev_err(dev->dev, 129 "endpoint %d returns %d\n", i, ret); 130 } 131 } 132 133 if (tmp_panel) { 134 dev_info(dev->dev, 135 "found panel on endpoint %d\n", i); 136 panel = tmp_panel; 137 } 138 if (tmp_bridge) { 139 dev_info(dev->dev, 140 "found bridge on endpoint %d\n", i); 141 bridge = tmp_bridge; 142 } 143 144 i++; 145 } 146 147 /* 148 * If we can't find neither panel nor bridge on any of the 149 * endpoints, and any of them retured -EPROBE_DEFER, then 150 * let's defer this driver too. 151 */ 152 if ((!panel && !bridge) && defer) 153 return -EPROBE_DEFER; 154 155 if (panel) { 156 bridge = drm_panel_bridge_add_typed(panel, 157 DRM_MODE_CONNECTOR_Unknown); 158 if (IS_ERR(bridge)) { 159 ret = PTR_ERR(bridge); 160 goto finish; 161 } 162 } else if (bridge) { 163 dev_info(dev->dev, "Using non-panel bridge\n"); 164 } else { 165 dev_err(dev->dev, "No bridge, exiting\n"); 166 return -ENODEV; 167 } 168 169 priv->bridge = bridge; 170 if (panel) { 171 priv->panel = panel; 172 priv->connector = drm_panel_bridge_connector(bridge); 173 } 174 175 ret = pl111_display_init(dev); 176 if (ret != 0) { 177 dev_err(dev->dev, "Failed to init display\n"); 178 goto out_bridge; 179 } 180 181 ret = drm_simple_display_pipe_attach_bridge(&priv->pipe, 182 bridge); 183 if (ret) 184 return ret; 185 186 if (!priv->variant->broken_vblank) { 187 ret = drm_vblank_init(dev, 1); 188 if (ret != 0) { 189 dev_err(dev->dev, "Failed to init vblank\n"); 190 goto out_bridge; 191 } 192 } 193 194 drm_mode_config_reset(dev); 195 196 drm_kms_helper_poll_init(dev); 197 198 goto finish; 199 200 out_bridge: 201 if (panel) 202 drm_panel_bridge_remove(bridge); 203 finish: 204 return ret; 205 } 206 207 static struct drm_gem_object * 208 pl111_gem_import_sg_table(struct drm_device *dev, 209 struct dma_buf_attachment *attach, 210 struct sg_table *sgt) 211 { 212 struct pl111_drm_dev_private *priv = dev->dev_private; 213 214 /* 215 * When using device-specific reserved memory we can't import 216 * DMA buffers: those are passed by reference in any global 217 * memory and we can only handle a specific range of memory. 218 */ 219 if (priv->use_device_memory) 220 return ERR_PTR(-EINVAL); 221 222 return drm_gem_cma_prime_import_sg_table(dev, attach, sgt); 223 } 224 225 DEFINE_DRM_GEM_CMA_FOPS(drm_fops); 226 227 static struct drm_driver pl111_drm_driver = { 228 .driver_features = 229 DRIVER_MODESET | DRIVER_GEM | DRIVER_ATOMIC, 230 .ioctls = NULL, 231 .fops = &drm_fops, 232 .name = "pl111", 233 .desc = DRIVER_DESC, 234 .date = "20170317", 235 .major = 1, 236 .minor = 0, 237 .patchlevel = 0, 238 .dumb_create = drm_gem_cma_dumb_create, 239 .gem_free_object_unlocked = drm_gem_cma_free_object, 240 .gem_vm_ops = &drm_gem_cma_vm_ops, 241 .prime_handle_to_fd = drm_gem_prime_handle_to_fd, 242 .prime_fd_to_handle = drm_gem_prime_fd_to_handle, 243 .gem_prime_import_sg_table = pl111_gem_import_sg_table, 244 .gem_prime_get_sg_table = drm_gem_cma_prime_get_sg_table, 245 .gem_prime_mmap = drm_gem_cma_prime_mmap, 246 .gem_prime_vmap = drm_gem_cma_prime_vmap, 247 248 #if defined(CONFIG_DEBUG_FS) 249 .debugfs_init = pl111_debugfs_init, 250 #endif 251 }; 252 253 static int pl111_amba_probe(struct amba_device *amba_dev, 254 const struct amba_id *id) 255 { 256 struct device *dev = &amba_dev->dev; 257 struct pl111_drm_dev_private *priv; 258 const struct pl111_variant_data *variant = id->data; 259 struct drm_device *drm; 260 int ret; 261 262 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL); 263 if (!priv) 264 return -ENOMEM; 265 266 drm = drm_dev_alloc(&pl111_drm_driver, dev); 267 if (IS_ERR(drm)) 268 return PTR_ERR(drm); 269 amba_set_drvdata(amba_dev, drm); 270 priv->drm = drm; 271 drm->dev_private = priv; 272 priv->variant = variant; 273 274 ret = of_reserved_mem_device_init(dev); 275 if (!ret) { 276 dev_info(dev, "using device-specific reserved memory\n"); 277 priv->use_device_memory = true; 278 } 279 280 if (of_property_read_u32(dev->of_node, "max-memory-bandwidth", 281 &priv->memory_bw)) { 282 dev_info(dev, "no max memory bandwidth specified, assume unlimited\n"); 283 priv->memory_bw = 0; 284 } 285 286 /* The two main variants swap this register */ 287 if (variant->is_pl110 || variant->is_lcdc) { 288 priv->ienb = CLCD_PL110_IENB; 289 priv->ctrl = CLCD_PL110_CNTL; 290 } else { 291 priv->ienb = CLCD_PL111_IENB; 292 priv->ctrl = CLCD_PL111_CNTL; 293 } 294 295 priv->regs = devm_ioremap_resource(dev, &amba_dev->res); 296 if (IS_ERR(priv->regs)) { 297 dev_err(dev, "%s failed mmio\n", __func__); 298 ret = PTR_ERR(priv->regs); 299 goto dev_put; 300 } 301 302 /* This may override some variant settings */ 303 ret = pl111_versatile_init(dev, priv); 304 if (ret) 305 goto dev_put; 306 307 pl111_nomadik_init(dev); 308 309 /* turn off interrupts before requesting the irq */ 310 writel(0, priv->regs + priv->ienb); 311 312 ret = devm_request_irq(dev, amba_dev->irq[0], pl111_irq, 0, 313 variant->name, priv); 314 if (ret != 0) { 315 dev_err(dev, "%s failed irq %d\n", __func__, ret); 316 return ret; 317 } 318 319 ret = pl111_modeset_init(drm); 320 if (ret != 0) 321 goto dev_put; 322 323 ret = drm_dev_register(drm, 0); 324 if (ret < 0) 325 goto dev_put; 326 327 drm_fbdev_generic_setup(drm, priv->variant->fb_bpp); 328 329 return 0; 330 331 dev_put: 332 drm_dev_put(drm); 333 of_reserved_mem_device_release(dev); 334 335 return ret; 336 } 337 338 static int pl111_amba_remove(struct amba_device *amba_dev) 339 { 340 struct device *dev = &amba_dev->dev; 341 struct drm_device *drm = amba_get_drvdata(amba_dev); 342 struct pl111_drm_dev_private *priv = drm->dev_private; 343 344 drm_dev_unregister(drm); 345 if (priv->panel) 346 drm_panel_bridge_remove(priv->bridge); 347 drm_dev_put(drm); 348 of_reserved_mem_device_release(dev); 349 350 return 0; 351 } 352 353 /* 354 * This early variant lacks the 565 and 444 pixel formats. 355 */ 356 static const u32 pl110_pixel_formats[] = { 357 DRM_FORMAT_ABGR8888, 358 DRM_FORMAT_XBGR8888, 359 DRM_FORMAT_ARGB8888, 360 DRM_FORMAT_XRGB8888, 361 DRM_FORMAT_ABGR1555, 362 DRM_FORMAT_XBGR1555, 363 DRM_FORMAT_ARGB1555, 364 DRM_FORMAT_XRGB1555, 365 }; 366 367 static const struct pl111_variant_data pl110_variant = { 368 .name = "PL110", 369 .is_pl110 = true, 370 .formats = pl110_pixel_formats, 371 .nformats = ARRAY_SIZE(pl110_pixel_formats), 372 .fb_bpp = 16, 373 }; 374 375 /* RealView, Versatile Express etc use this modern variant */ 376 static const u32 pl111_pixel_formats[] = { 377 DRM_FORMAT_ABGR8888, 378 DRM_FORMAT_XBGR8888, 379 DRM_FORMAT_ARGB8888, 380 DRM_FORMAT_XRGB8888, 381 DRM_FORMAT_BGR565, 382 DRM_FORMAT_RGB565, 383 DRM_FORMAT_ABGR1555, 384 DRM_FORMAT_XBGR1555, 385 DRM_FORMAT_ARGB1555, 386 DRM_FORMAT_XRGB1555, 387 DRM_FORMAT_ABGR4444, 388 DRM_FORMAT_XBGR4444, 389 DRM_FORMAT_ARGB4444, 390 DRM_FORMAT_XRGB4444, 391 }; 392 393 static const struct pl111_variant_data pl111_variant = { 394 .name = "PL111", 395 .formats = pl111_pixel_formats, 396 .nformats = ARRAY_SIZE(pl111_pixel_formats), 397 .fb_bpp = 32, 398 }; 399 400 static const u32 pl110_nomadik_pixel_formats[] = { 401 DRM_FORMAT_RGB888, 402 DRM_FORMAT_BGR888, 403 DRM_FORMAT_ABGR8888, 404 DRM_FORMAT_XBGR8888, 405 DRM_FORMAT_ARGB8888, 406 DRM_FORMAT_XRGB8888, 407 DRM_FORMAT_BGR565, 408 DRM_FORMAT_RGB565, 409 DRM_FORMAT_ABGR1555, 410 DRM_FORMAT_XBGR1555, 411 DRM_FORMAT_ARGB1555, 412 DRM_FORMAT_XRGB1555, 413 DRM_FORMAT_ABGR4444, 414 DRM_FORMAT_XBGR4444, 415 DRM_FORMAT_ARGB4444, 416 DRM_FORMAT_XRGB4444, 417 }; 418 419 static const struct pl111_variant_data pl110_nomadik_variant = { 420 .name = "LCDC (PL110 Nomadik)", 421 .formats = pl110_nomadik_pixel_formats, 422 .nformats = ARRAY_SIZE(pl110_nomadik_pixel_formats), 423 .is_lcdc = true, 424 .st_bitmux_control = true, 425 .broken_vblank = true, 426 .fb_bpp = 16, 427 }; 428 429 static const struct amba_id pl111_id_table[] = { 430 { 431 .id = 0x00041110, 432 .mask = 0x000fffff, 433 .data = (void *)&pl110_variant, 434 }, 435 { 436 .id = 0x00180110, 437 .mask = 0x00fffffe, 438 .data = (void *)&pl110_nomadik_variant, 439 }, 440 { 441 .id = 0x00041111, 442 .mask = 0x000fffff, 443 .data = (void *)&pl111_variant, 444 }, 445 {0, 0}, 446 }; 447 MODULE_DEVICE_TABLE(amba, pl111_id_table); 448 449 static struct amba_driver pl111_amba_driver __maybe_unused = { 450 .drv = { 451 .name = "drm-clcd-pl111", 452 }, 453 .probe = pl111_amba_probe, 454 .remove = pl111_amba_remove, 455 .id_table = pl111_id_table, 456 }; 457 458 #ifdef CONFIG_ARM_AMBA 459 module_amba_driver(pl111_amba_driver); 460 #endif 461 462 MODULE_DESCRIPTION(DRIVER_DESC); 463 MODULE_AUTHOR("ARM Ltd."); 464 MODULE_LICENSE("GPL"); 465