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