drivers/gpu/drm/vc4/vc4_drv.c

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