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/clients/drm_client_setup.h> 35 #include <drm/drm_atomic_helper.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_MAJOR 0 51 #define DRIVER_MINOR 0 52 #define DRIVER_PATCHLEVEL 0 53 54 /* Helper function for mapping the regs on a platform device. */ 55 void __iomem *vc4_ioremap_regs(struct platform_device *pdev, int index) 56 { 57 void __iomem *map; 58 59 map = devm_platform_ioremap_resource(pdev, index); 60 if (IS_ERR(map)) 61 return map; 62 63 return map; 64 } 65 66 int vc4_dumb_fixup_args(struct drm_mode_create_dumb *args) 67 { 68 int min_pitch = DIV_ROUND_UP(args->width * args->bpp, 8); 69 70 if (args->pitch < min_pitch) 71 args->pitch = min_pitch; 72 73 if (args->size < args->pitch * args->height) 74 args->size = args->pitch * args->height; 75 76 return 0; 77 } 78 79 static int vc5_dumb_create(struct drm_file *file_priv, 80 struct drm_device *dev, 81 struct drm_mode_create_dumb *args) 82 { 83 int ret; 84 85 ret = vc4_dumb_fixup_args(args); 86 if (ret) 87 return ret; 88 89 return drm_gem_dma_dumb_create_internal(file_priv, dev, args); 90 } 91 92 static int vc4_get_param_ioctl(struct drm_device *dev, void *data, 93 struct drm_file *file_priv) 94 { 95 struct vc4_dev *vc4 = to_vc4_dev(dev); 96 struct drm_vc4_get_param *args = data; 97 int ret; 98 99 if (args->pad != 0) 100 return -EINVAL; 101 102 if (WARN_ON_ONCE(vc4->gen > VC4_GEN_4)) 103 return -ENODEV; 104 105 if (!vc4->v3d) 106 return -ENODEV; 107 108 switch (args->param) { 109 case DRM_VC4_PARAM_V3D_IDENT0: 110 ret = vc4_v3d_pm_get(vc4); 111 if (ret) 112 return ret; 113 args->value = V3D_READ(V3D_IDENT0); 114 vc4_v3d_pm_put(vc4); 115 break; 116 case DRM_VC4_PARAM_V3D_IDENT1: 117 ret = vc4_v3d_pm_get(vc4); 118 if (ret) 119 return ret; 120 args->value = V3D_READ(V3D_IDENT1); 121 vc4_v3d_pm_put(vc4); 122 break; 123 case DRM_VC4_PARAM_V3D_IDENT2: 124 ret = vc4_v3d_pm_get(vc4); 125 if (ret) 126 return ret; 127 args->value = V3D_READ(V3D_IDENT2); 128 vc4_v3d_pm_put(vc4); 129 break; 130 case DRM_VC4_PARAM_SUPPORTS_BRANCHES: 131 case DRM_VC4_PARAM_SUPPORTS_ETC1: 132 case DRM_VC4_PARAM_SUPPORTS_THREADED_FS: 133 case DRM_VC4_PARAM_SUPPORTS_FIXED_RCL_ORDER: 134 case DRM_VC4_PARAM_SUPPORTS_MADVISE: 135 case DRM_VC4_PARAM_SUPPORTS_PERFMON: 136 args->value = true; 137 break; 138 default: 139 DRM_DEBUG("Unknown parameter %d\n", args->param); 140 return -EINVAL; 141 } 142 143 return 0; 144 } 145 146 static int vc4_open(struct drm_device *dev, struct drm_file *file) 147 { 148 struct vc4_dev *vc4 = to_vc4_dev(dev); 149 struct vc4_file *vc4file; 150 151 if (WARN_ON_ONCE(vc4->gen > VC4_GEN_4)) 152 return -ENODEV; 153 154 vc4file = kzalloc(sizeof(*vc4file), GFP_KERNEL); 155 if (!vc4file) 156 return -ENOMEM; 157 vc4file->dev = vc4; 158 159 vc4_perfmon_open_file(vc4file); 160 file->driver_priv = vc4file; 161 return 0; 162 } 163 164 static void vc4_close(struct drm_device *dev, struct drm_file *file) 165 { 166 struct vc4_dev *vc4 = to_vc4_dev(dev); 167 struct vc4_file *vc4file = file->driver_priv; 168 169 if (WARN_ON_ONCE(vc4->gen > VC4_GEN_4)) 170 return; 171 172 if (vc4file->bin_bo_used) 173 vc4_v3d_bin_bo_put(vc4); 174 175 vc4_perfmon_close_file(vc4file); 176 kfree(vc4file); 177 } 178 179 DEFINE_DRM_GEM_FOPS(vc4_drm_fops); 180 181 static const struct drm_ioctl_desc vc4_drm_ioctls[] = { 182 DRM_IOCTL_DEF_DRV(VC4_SUBMIT_CL, vc4_submit_cl_ioctl, DRM_RENDER_ALLOW), 183 DRM_IOCTL_DEF_DRV(VC4_WAIT_SEQNO, vc4_wait_seqno_ioctl, DRM_RENDER_ALLOW), 184 DRM_IOCTL_DEF_DRV(VC4_WAIT_BO, vc4_wait_bo_ioctl, DRM_RENDER_ALLOW), 185 DRM_IOCTL_DEF_DRV(VC4_CREATE_BO, vc4_create_bo_ioctl, DRM_RENDER_ALLOW), 186 DRM_IOCTL_DEF_DRV(VC4_MMAP_BO, vc4_mmap_bo_ioctl, DRM_RENDER_ALLOW), 187 DRM_IOCTL_DEF_DRV(VC4_CREATE_SHADER_BO, vc4_create_shader_bo_ioctl, DRM_RENDER_ALLOW), 188 DRM_IOCTL_DEF_DRV(VC4_GET_HANG_STATE, vc4_get_hang_state_ioctl, 189 DRM_ROOT_ONLY), 190 DRM_IOCTL_DEF_DRV(VC4_GET_PARAM, vc4_get_param_ioctl, DRM_RENDER_ALLOW), 191 DRM_IOCTL_DEF_DRV(VC4_SET_TILING, vc4_set_tiling_ioctl, DRM_RENDER_ALLOW), 192 DRM_IOCTL_DEF_DRV(VC4_GET_TILING, vc4_get_tiling_ioctl, DRM_RENDER_ALLOW), 193 DRM_IOCTL_DEF_DRV(VC4_LABEL_BO, vc4_label_bo_ioctl, DRM_RENDER_ALLOW), 194 DRM_IOCTL_DEF_DRV(VC4_GEM_MADVISE, vc4_gem_madvise_ioctl, DRM_RENDER_ALLOW), 195 DRM_IOCTL_DEF_DRV(VC4_PERFMON_CREATE, vc4_perfmon_create_ioctl, DRM_RENDER_ALLOW), 196 DRM_IOCTL_DEF_DRV(VC4_PERFMON_DESTROY, vc4_perfmon_destroy_ioctl, DRM_RENDER_ALLOW), 197 DRM_IOCTL_DEF_DRV(VC4_PERFMON_GET_VALUES, vc4_perfmon_get_values_ioctl, DRM_RENDER_ALLOW), 198 }; 199 200 const struct drm_driver vc4_drm_driver = { 201 .driver_features = (DRIVER_MODESET | 202 DRIVER_ATOMIC | 203 DRIVER_GEM | 204 DRIVER_RENDER | 205 DRIVER_SYNCOBJ), 206 .open = vc4_open, 207 .postclose = vc4_close, 208 209 #if defined(CONFIG_DEBUG_FS) 210 .debugfs_init = vc4_debugfs_init, 211 #endif 212 213 .gem_create_object = vc4_create_object, 214 215 DRM_GEM_DMA_DRIVER_OPS_WITH_DUMB_CREATE(vc4_bo_dumb_create), 216 DRM_FBDEV_DMA_DRIVER_OPS, 217 218 .ioctls = vc4_drm_ioctls, 219 .num_ioctls = ARRAY_SIZE(vc4_drm_ioctls), 220 .fops = &vc4_drm_fops, 221 222 .name = DRIVER_NAME, 223 .desc = DRIVER_DESC, 224 .major = DRIVER_MAJOR, 225 .minor = DRIVER_MINOR, 226 .patchlevel = DRIVER_PATCHLEVEL, 227 }; 228 229 const struct drm_driver vc5_drm_driver = { 230 .driver_features = (DRIVER_MODESET | 231 DRIVER_ATOMIC | 232 DRIVER_GEM), 233 234 #if defined(CONFIG_DEBUG_FS) 235 .debugfs_init = vc4_debugfs_init, 236 #endif 237 238 DRM_GEM_DMA_DRIVER_OPS_WITH_DUMB_CREATE(vc5_dumb_create), 239 DRM_FBDEV_DMA_DRIVER_OPS, 240 241 .fops = &vc4_drm_fops, 242 243 .name = DRIVER_NAME, 244 .desc = DRIVER_DESC, 245 .major = DRIVER_MAJOR, 246 .minor = DRIVER_MINOR, 247 .patchlevel = DRIVER_PATCHLEVEL, 248 }; 249 250 static void vc4_match_add_drivers(struct device *dev, 251 struct component_match **match, 252 struct platform_driver *const *drivers, 253 int count) 254 { 255 int i; 256 257 for (i = 0; i < count; i++) { 258 struct device_driver *drv = &drivers[i]->driver; 259 struct device *p = NULL, *d; 260 261 while ((d = platform_find_device_by_driver(p, drv))) { 262 put_device(p); 263 component_match_add(dev, match, component_compare_dev, d); 264 p = d; 265 } 266 put_device(p); 267 } 268 } 269 270 static void vc4_component_unbind_all(void *ptr) 271 { 272 struct vc4_dev *vc4 = ptr; 273 274 component_unbind_all(vc4->dev, &vc4->base); 275 } 276 277 static const struct of_device_id vc4_dma_range_matches[] = { 278 { .compatible = "brcm,bcm2711-hvs" }, 279 { .compatible = "brcm,bcm2712-hvs" }, 280 { .compatible = "brcm,bcm2835-hvs" }, 281 { .compatible = "brcm,bcm2835-v3d" }, 282 { .compatible = "brcm,cygnus-v3d" }, 283 { .compatible = "brcm,vc4-v3d" }, 284 {} 285 }; 286 287 static int vc4_drm_bind(struct device *dev) 288 { 289 struct platform_device *pdev = to_platform_device(dev); 290 const struct drm_driver *driver; 291 struct rpi_firmware *firmware = NULL; 292 struct drm_device *drm; 293 struct vc4_dev *vc4; 294 struct device_node *node; 295 struct drm_crtc *crtc; 296 enum vc4_gen gen; 297 int ret = 0; 298 299 dev->coherent_dma_mask = DMA_BIT_MASK(32); 300 301 gen = (enum vc4_gen)of_device_get_match_data(dev); 302 303 if (gen > VC4_GEN_4) 304 driver = &vc5_drm_driver; 305 else 306 driver = &vc4_drm_driver; 307 308 if (gen >= VC4_GEN_6_C) 309 dma_set_mask_and_coherent(dev, DMA_BIT_MASK(36)); 310 else 311 dma_set_mask_and_coherent(dev, DMA_BIT_MASK(32)); 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", .data = (void *)VC4_GEN_5 }, 466 /* NB GEN_6_C will be corrected on D0 hw to GEN_6_D via vc4_hvs_bind */ 467 { .compatible = "brcm,bcm2712-vc6", .data = (void *)VC4_GEN_6_C }, 468 { .compatible = "brcm,bcm2835-vc4", .data = (void *)VC4_GEN_4 }, 469 { .compatible = "brcm,cygnus-vc4", .data = (void *)VC4_GEN_4 }, 470 {}, 471 }; 472 MODULE_DEVICE_TABLE(of, vc4_of_match); 473 474 static struct platform_driver vc4_platform_driver = { 475 .probe = vc4_platform_drm_probe, 476 .remove = vc4_platform_drm_remove, 477 .shutdown = vc4_platform_drm_shutdown, 478 .driver = { 479 .name = "vc4-drm", 480 .of_match_table = vc4_of_match, 481 }, 482 }; 483 484 static int __init vc4_drm_register(void) 485 { 486 int ret; 487 488 if (drm_firmware_drivers_only()) 489 return -ENODEV; 490 491 ret = platform_register_drivers(component_drivers, 492 ARRAY_SIZE(component_drivers)); 493 if (ret) 494 return ret; 495 496 ret = platform_driver_register(&vc4_platform_driver); 497 if (ret) 498 platform_unregister_drivers(component_drivers, 499 ARRAY_SIZE(component_drivers)); 500 501 return ret; 502 } 503 504 static void __exit vc4_drm_unregister(void) 505 { 506 platform_unregister_drivers(component_drivers, 507 ARRAY_SIZE(component_drivers)); 508 platform_driver_unregister(&vc4_platform_driver); 509 } 510 511 module_init(vc4_drm_register); 512 module_exit(vc4_drm_unregister); 513 514 MODULE_ALIAS("platform:vc4-drm"); 515 MODULE_SOFTDEP("pre: snd-soc-hdmi-codec"); 516 MODULE_DESCRIPTION("Broadcom VC4 DRM Driver"); 517 MODULE_AUTHOR("Eric Anholt <eric@anholt.net>"); 518 MODULE_LICENSE("GPL v2"); 519