1 // SPDX-License-Identifier: GPL-2.0-only 2 /* 3 * Copyright (C) 2014-2015 Broadcom 4 * Copyright (C) 2013 Red Hat 5 */ 6 7 /** 8 * DOC: Broadcom VC4 Graphics Driver 9 * 10 * The Broadcom VideoCore 4 (present in the Raspberry Pi) contains a 11 * OpenGL ES 2.0-compatible 3D engine called V3D, and a highly 12 * configurable display output pipeline that supports HDMI, DSI, DPI, 13 * and Composite TV output. 14 * 15 * The 3D engine also has an interface for submitting arbitrary 16 * compute shader-style jobs using the same shader processor as is 17 * used for vertex and fragment shaders in GLES 2.0. However, given 18 * that the hardware isn't able to expose any standard interfaces like 19 * OpenGL compute shaders or OpenCL, it isn't supported by this 20 * driver. 21 */ 22 23 #include <linux/aperture.h> 24 #include <linux/clk.h> 25 #include <linux/component.h> 26 #include <linux/device.h> 27 #include <linux/dma-mapping.h> 28 #include <linux/io.h> 29 #include <linux/module.h> 30 #include <linux/of_device.h> 31 #include <linux/platform_device.h> 32 #include <linux/pm_runtime.h> 33 34 #include <drm/drm_atomic_helper.h> 35 #include <drm/drm_client_setup.h> 36 #include <drm/drm_drv.h> 37 #include <drm/drm_fbdev_dma.h> 38 #include <drm/drm_fourcc.h> 39 #include <drm/drm_vblank.h> 40 41 #include <soc/bcm2835/raspberrypi-firmware.h> 42 43 #include "uapi/drm/vc4_drm.h" 44 45 #include "vc4_drv.h" 46 #include "vc4_regs.h" 47 48 #define DRIVER_NAME "vc4" 49 #define DRIVER_DESC "Broadcom VC4 graphics" 50 #define DRIVER_DATE "20140616" 51 #define DRIVER_MAJOR 0 52 #define DRIVER_MINOR 0 53 #define DRIVER_PATCHLEVEL 0 54 55 /* Helper function for mapping the regs on a platform device. */ 56 void __iomem *vc4_ioremap_regs(struct platform_device *pdev, int index) 57 { 58 void __iomem *map; 59 60 map = devm_platform_ioremap_resource(pdev, index); 61 if (IS_ERR(map)) 62 return map; 63 64 return map; 65 } 66 67 int vc4_dumb_fixup_args(struct drm_mode_create_dumb *args) 68 { 69 int min_pitch = DIV_ROUND_UP(args->width * args->bpp, 8); 70 71 if (args->pitch < min_pitch) 72 args->pitch = min_pitch; 73 74 if (args->size < args->pitch * args->height) 75 args->size = args->pitch * args->height; 76 77 return 0; 78 } 79 80 static int vc5_dumb_create(struct drm_file *file_priv, 81 struct drm_device *dev, 82 struct drm_mode_create_dumb *args) 83 { 84 int ret; 85 86 ret = vc4_dumb_fixup_args(args); 87 if (ret) 88 return ret; 89 90 return drm_gem_dma_dumb_create_internal(file_priv, dev, args); 91 } 92 93 static int vc4_get_param_ioctl(struct drm_device *dev, void *data, 94 struct drm_file *file_priv) 95 { 96 struct vc4_dev *vc4 = to_vc4_dev(dev); 97 struct drm_vc4_get_param *args = data; 98 int ret; 99 100 if (args->pad != 0) 101 return -EINVAL; 102 103 if (WARN_ON_ONCE(vc4->gen > VC4_GEN_4)) 104 return -ENODEV; 105 106 if (!vc4->v3d) 107 return -ENODEV; 108 109 switch (args->param) { 110 case DRM_VC4_PARAM_V3D_IDENT0: 111 ret = vc4_v3d_pm_get(vc4); 112 if (ret) 113 return ret; 114 args->value = V3D_READ(V3D_IDENT0); 115 vc4_v3d_pm_put(vc4); 116 break; 117 case DRM_VC4_PARAM_V3D_IDENT1: 118 ret = vc4_v3d_pm_get(vc4); 119 if (ret) 120 return ret; 121 args->value = V3D_READ(V3D_IDENT1); 122 vc4_v3d_pm_put(vc4); 123 break; 124 case DRM_VC4_PARAM_V3D_IDENT2: 125 ret = vc4_v3d_pm_get(vc4); 126 if (ret) 127 return ret; 128 args->value = V3D_READ(V3D_IDENT2); 129 vc4_v3d_pm_put(vc4); 130 break; 131 case DRM_VC4_PARAM_SUPPORTS_BRANCHES: 132 case DRM_VC4_PARAM_SUPPORTS_ETC1: 133 case DRM_VC4_PARAM_SUPPORTS_THREADED_FS: 134 case DRM_VC4_PARAM_SUPPORTS_FIXED_RCL_ORDER: 135 case DRM_VC4_PARAM_SUPPORTS_MADVISE: 136 case DRM_VC4_PARAM_SUPPORTS_PERFMON: 137 args->value = true; 138 break; 139 default: 140 DRM_DEBUG("Unknown parameter %d\n", args->param); 141 return -EINVAL; 142 } 143 144 return 0; 145 } 146 147 static int vc4_open(struct drm_device *dev, struct drm_file *file) 148 { 149 struct vc4_dev *vc4 = to_vc4_dev(dev); 150 struct vc4_file *vc4file; 151 152 if (WARN_ON_ONCE(vc4->gen > VC4_GEN_4)) 153 return -ENODEV; 154 155 vc4file = kzalloc(sizeof(*vc4file), GFP_KERNEL); 156 if (!vc4file) 157 return -ENOMEM; 158 vc4file->dev = vc4; 159 160 vc4_perfmon_open_file(vc4file); 161 file->driver_priv = vc4file; 162 return 0; 163 } 164 165 static void vc4_close(struct drm_device *dev, struct drm_file *file) 166 { 167 struct vc4_dev *vc4 = to_vc4_dev(dev); 168 struct vc4_file *vc4file = file->driver_priv; 169 170 if (WARN_ON_ONCE(vc4->gen > VC4_GEN_4)) 171 return; 172 173 if (vc4file->bin_bo_used) 174 vc4_v3d_bin_bo_put(vc4); 175 176 vc4_perfmon_close_file(vc4file); 177 kfree(vc4file); 178 } 179 180 DEFINE_DRM_GEM_FOPS(vc4_drm_fops); 181 182 static const struct drm_ioctl_desc vc4_drm_ioctls[] = { 183 DRM_IOCTL_DEF_DRV(VC4_SUBMIT_CL, vc4_submit_cl_ioctl, DRM_RENDER_ALLOW), 184 DRM_IOCTL_DEF_DRV(VC4_WAIT_SEQNO, vc4_wait_seqno_ioctl, DRM_RENDER_ALLOW), 185 DRM_IOCTL_DEF_DRV(VC4_WAIT_BO, vc4_wait_bo_ioctl, DRM_RENDER_ALLOW), 186 DRM_IOCTL_DEF_DRV(VC4_CREATE_BO, vc4_create_bo_ioctl, DRM_RENDER_ALLOW), 187 DRM_IOCTL_DEF_DRV(VC4_MMAP_BO, vc4_mmap_bo_ioctl, DRM_RENDER_ALLOW), 188 DRM_IOCTL_DEF_DRV(VC4_CREATE_SHADER_BO, vc4_create_shader_bo_ioctl, DRM_RENDER_ALLOW), 189 DRM_IOCTL_DEF_DRV(VC4_GET_HANG_STATE, vc4_get_hang_state_ioctl, 190 DRM_ROOT_ONLY), 191 DRM_IOCTL_DEF_DRV(VC4_GET_PARAM, vc4_get_param_ioctl, DRM_RENDER_ALLOW), 192 DRM_IOCTL_DEF_DRV(VC4_SET_TILING, vc4_set_tiling_ioctl, DRM_RENDER_ALLOW), 193 DRM_IOCTL_DEF_DRV(VC4_GET_TILING, vc4_get_tiling_ioctl, DRM_RENDER_ALLOW), 194 DRM_IOCTL_DEF_DRV(VC4_LABEL_BO, vc4_label_bo_ioctl, DRM_RENDER_ALLOW), 195 DRM_IOCTL_DEF_DRV(VC4_GEM_MADVISE, vc4_gem_madvise_ioctl, DRM_RENDER_ALLOW), 196 DRM_IOCTL_DEF_DRV(VC4_PERFMON_CREATE, vc4_perfmon_create_ioctl, DRM_RENDER_ALLOW), 197 DRM_IOCTL_DEF_DRV(VC4_PERFMON_DESTROY, vc4_perfmon_destroy_ioctl, DRM_RENDER_ALLOW), 198 DRM_IOCTL_DEF_DRV(VC4_PERFMON_GET_VALUES, vc4_perfmon_get_values_ioctl, DRM_RENDER_ALLOW), 199 }; 200 201 const struct drm_driver vc4_drm_driver = { 202 .driver_features = (DRIVER_MODESET | 203 DRIVER_ATOMIC | 204 DRIVER_GEM | 205 DRIVER_RENDER | 206 DRIVER_SYNCOBJ), 207 .open = vc4_open, 208 .postclose = vc4_close, 209 210 #if defined(CONFIG_DEBUG_FS) 211 .debugfs_init = vc4_debugfs_init, 212 #endif 213 214 .gem_create_object = vc4_create_object, 215 216 DRM_GEM_DMA_DRIVER_OPS_WITH_DUMB_CREATE(vc4_bo_dumb_create), 217 DRM_FBDEV_DMA_DRIVER_OPS, 218 219 .ioctls = vc4_drm_ioctls, 220 .num_ioctls = ARRAY_SIZE(vc4_drm_ioctls), 221 .fops = &vc4_drm_fops, 222 223 .name = DRIVER_NAME, 224 .desc = DRIVER_DESC, 225 .date = DRIVER_DATE, 226 .major = DRIVER_MAJOR, 227 .minor = DRIVER_MINOR, 228 .patchlevel = DRIVER_PATCHLEVEL, 229 }; 230 231 const struct drm_driver vc5_drm_driver = { 232 .driver_features = (DRIVER_MODESET | 233 DRIVER_ATOMIC | 234 DRIVER_GEM), 235 236 #if defined(CONFIG_DEBUG_FS) 237 .debugfs_init = vc4_debugfs_init, 238 #endif 239 240 DRM_GEM_DMA_DRIVER_OPS_WITH_DUMB_CREATE(vc5_dumb_create), 241 DRM_FBDEV_DMA_DRIVER_OPS, 242 243 .fops = &vc4_drm_fops, 244 245 .name = DRIVER_NAME, 246 .desc = DRIVER_DESC, 247 .date = DRIVER_DATE, 248 .major = DRIVER_MAJOR, 249 .minor = DRIVER_MINOR, 250 .patchlevel = DRIVER_PATCHLEVEL, 251 }; 252 253 static void vc4_match_add_drivers(struct device *dev, 254 struct component_match **match, 255 struct platform_driver *const *drivers, 256 int count) 257 { 258 int i; 259 260 for (i = 0; i < count; i++) { 261 struct device_driver *drv = &drivers[i]->driver; 262 struct device *p = NULL, *d; 263 264 while ((d = platform_find_device_by_driver(p, drv))) { 265 put_device(p); 266 component_match_add(dev, match, component_compare_dev, d); 267 p = d; 268 } 269 put_device(p); 270 } 271 } 272 273 static void vc4_component_unbind_all(void *ptr) 274 { 275 struct vc4_dev *vc4 = ptr; 276 277 component_unbind_all(vc4->dev, &vc4->base); 278 } 279 280 static const struct of_device_id vc4_dma_range_matches[] = { 281 { .compatible = "brcm,bcm2711-hvs" }, 282 { .compatible = "brcm,bcm2835-hvs" }, 283 { .compatible = "brcm,bcm2835-v3d" }, 284 { .compatible = "brcm,cygnus-v3d" }, 285 { .compatible = "brcm,vc4-v3d" }, 286 {} 287 }; 288 289 static int vc4_drm_bind(struct device *dev) 290 { 291 struct platform_device *pdev = to_platform_device(dev); 292 const struct drm_driver *driver; 293 struct rpi_firmware *firmware = NULL; 294 struct drm_device *drm; 295 struct vc4_dev *vc4; 296 struct device_node *node; 297 struct drm_crtc *crtc; 298 enum vc4_gen gen; 299 int ret = 0; 300 301 dev->coherent_dma_mask = DMA_BIT_MASK(32); 302 303 if (of_device_is_compatible(dev->of_node, "brcm,bcm2711-vc5")) 304 gen = VC4_GEN_5; 305 else 306 gen = VC4_GEN_4; 307 308 if (gen > VC4_GEN_4) 309 driver = &vc5_drm_driver; 310 else 311 driver = &vc4_drm_driver; 312 313 node = of_find_matching_node_and_match(NULL, vc4_dma_range_matches, 314 NULL); 315 if (node) { 316 ret = of_dma_configure(dev, node, true); 317 of_node_put(node); 318 319 if (ret) 320 return ret; 321 } 322 323 vc4 = devm_drm_dev_alloc(dev, driver, struct vc4_dev, base); 324 if (IS_ERR(vc4)) 325 return PTR_ERR(vc4); 326 vc4->gen = gen; 327 vc4->dev = dev; 328 329 drm = &vc4->base; 330 platform_set_drvdata(pdev, drm); 331 332 if (gen == VC4_GEN_4) { 333 ret = drmm_mutex_init(drm, &vc4->bin_bo_lock); 334 if (ret) 335 goto err; 336 337 ret = vc4_bo_cache_init(drm); 338 if (ret) 339 goto err; 340 } 341 342 ret = drmm_mode_config_init(drm); 343 if (ret) 344 goto err; 345 346 if (gen == VC4_GEN_4) { 347 ret = vc4_gem_init(drm); 348 if (ret) 349 goto err; 350 } 351 352 node = of_find_compatible_node(NULL, NULL, "raspberrypi,bcm2835-firmware"); 353 if (node) { 354 firmware = rpi_firmware_get(node); 355 of_node_put(node); 356 357 if (!firmware) { 358 ret = -EPROBE_DEFER; 359 goto err; 360 } 361 } 362 363 ret = aperture_remove_all_conflicting_devices(driver->name); 364 if (ret) 365 goto err; 366 367 if (firmware) { 368 ret = rpi_firmware_property(firmware, 369 RPI_FIRMWARE_NOTIFY_DISPLAY_DONE, 370 NULL, 0); 371 if (ret) 372 drm_warn(drm, "Couldn't stop firmware display driver: %d\n", ret); 373 374 rpi_firmware_put(firmware); 375 } 376 377 ret = component_bind_all(dev, drm); 378 if (ret) 379 goto err; 380 381 ret = devm_add_action_or_reset(dev, vc4_component_unbind_all, vc4); 382 if (ret) 383 goto err; 384 385 ret = vc4_plane_create_additional_planes(drm); 386 if (ret) 387 goto err; 388 389 ret = vc4_kms_load(drm); 390 if (ret < 0) 391 goto err; 392 393 drm_for_each_crtc(crtc, drm) 394 vc4_crtc_disable_at_boot(crtc); 395 396 ret = drm_dev_register(drm, 0); 397 if (ret < 0) 398 goto err; 399 400 drm_client_setup_with_fourcc(drm, DRM_FORMAT_RGB565); 401 402 return 0; 403 404 err: 405 platform_set_drvdata(pdev, NULL); 406 return ret; 407 } 408 409 static void vc4_drm_unbind(struct device *dev) 410 { 411 struct drm_device *drm = dev_get_drvdata(dev); 412 413 drm_dev_unplug(drm); 414 drm_atomic_helper_shutdown(drm); 415 dev_set_drvdata(dev, NULL); 416 } 417 418 static const struct component_master_ops vc4_drm_ops = { 419 .bind = vc4_drm_bind, 420 .unbind = vc4_drm_unbind, 421 }; 422 423 /* 424 * This list determines the binding order of our components, and we have 425 * a few constraints: 426 * - The TXP driver needs to be bound before the PixelValves (CRTC) 427 * but after the HVS to set the possible_crtc field properly 428 * - The HDMI driver needs to be bound after the HVS so that we can 429 * lookup the HVS maximum core clock rate and figure out if we 430 * support 4kp60 or not. 431 */ 432 static struct platform_driver *const component_drivers[] = { 433 &vc4_hvs_driver, 434 &vc4_hdmi_driver, 435 &vc4_vec_driver, 436 &vc4_dpi_driver, 437 &vc4_dsi_driver, 438 &vc4_txp_driver, 439 &vc4_crtc_driver, 440 &vc4_v3d_driver, 441 }; 442 443 static int vc4_platform_drm_probe(struct platform_device *pdev) 444 { 445 struct component_match *match = NULL; 446 struct device *dev = &pdev->dev; 447 448 vc4_match_add_drivers(dev, &match, 449 component_drivers, ARRAY_SIZE(component_drivers)); 450 451 return component_master_add_with_match(dev, &vc4_drm_ops, match); 452 } 453 454 static void vc4_platform_drm_remove(struct platform_device *pdev) 455 { 456 component_master_del(&pdev->dev, &vc4_drm_ops); 457 } 458 459 static void vc4_platform_drm_shutdown(struct platform_device *pdev) 460 { 461 drm_atomic_helper_shutdown(platform_get_drvdata(pdev)); 462 } 463 464 static const struct of_device_id vc4_of_match[] = { 465 { .compatible = "brcm,bcm2711-vc5", }, 466 { .compatible = "brcm,bcm2835-vc4", }, 467 { .compatible = "brcm,cygnus-vc4", }, 468 {}, 469 }; 470 MODULE_DEVICE_TABLE(of, vc4_of_match); 471 472 static struct platform_driver vc4_platform_driver = { 473 .probe = vc4_platform_drm_probe, 474 .remove = vc4_platform_drm_remove, 475 .shutdown = vc4_platform_drm_shutdown, 476 .driver = { 477 .name = "vc4-drm", 478 .of_match_table = vc4_of_match, 479 }, 480 }; 481 482 static int __init vc4_drm_register(void) 483 { 484 int ret; 485 486 if (drm_firmware_drivers_only()) 487 return -ENODEV; 488 489 ret = platform_register_drivers(component_drivers, 490 ARRAY_SIZE(component_drivers)); 491 if (ret) 492 return ret; 493 494 ret = platform_driver_register(&vc4_platform_driver); 495 if (ret) 496 platform_unregister_drivers(component_drivers, 497 ARRAY_SIZE(component_drivers)); 498 499 return ret; 500 } 501 502 static void __exit vc4_drm_unregister(void) 503 { 504 platform_unregister_drivers(component_drivers, 505 ARRAY_SIZE(component_drivers)); 506 platform_driver_unregister(&vc4_platform_driver); 507 } 508 509 module_init(vc4_drm_register); 510 module_exit(vc4_drm_unregister); 511 512 MODULE_ALIAS("platform:vc4-drm"); 513 MODULE_SOFTDEP("pre: snd-soc-hdmi-codec"); 514 MODULE_DESCRIPTION("Broadcom VC4 DRM Driver"); 515 MODULE_AUTHOR("Eric Anholt <eric@anholt.net>"); 516 MODULE_LICENSE("GPL v2"); 517