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_device.h>
  30 #include <linux/platform_device.h>
  31 #include <linux/pm_runtime.h>
  32 #include <linux/dma-direct.h>
  33
  34 #include <drm/drm_aperture.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_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 *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 struct drm_gem_object *
 180 vc4_prime_import_sg_table(struct drm_device *dev,
 181                           struct dma_buf_attachment *attach,
 182                           struct sg_table *sgt)
 183 {
 184         phys_addr_t phys = dma_to_phys(dev->dev, sg_dma_address(sgt->sgl));
 185
 186         if (is_swiotlb_buffer(dev->dev, phys))
 187                 return ERR_PTR(-EINVAL);
 188
 189         return drm_gem_dma_prime_import_sg_table(dev, attach, sgt);
 190 }
 191
 192 DEFINE_DRM_GEM_FOPS(vc4_drm_fops);
 193
 194 static const struct drm_ioctl_desc vc4_drm_ioctls[] = {
 195         DRM_IOCTL_DEF_DRV(VC4_SUBMIT_CL, vc4_submit_cl_ioctl, DRM_RENDER_ALLOW),
 196         DRM_IOCTL_DEF_DRV(VC4_WAIT_SEQNO, vc4_wait_seqno_ioctl, DRM_RENDER_ALLOW),
 197         DRM_IOCTL_DEF_DRV(VC4_WAIT_BO, vc4_wait_bo_ioctl, DRM_RENDER_ALLOW),
 198         DRM_IOCTL_DEF_DRV(VC4_CREATE_BO, vc4_create_bo_ioctl, DRM_RENDER_ALLOW),
 199         DRM_IOCTL_DEF_DRV(VC4_MMAP_BO, vc4_mmap_bo_ioctl, DRM_RENDER_ALLOW),
 200         DRM_IOCTL_DEF_DRV(VC4_CREATE_SHADER_BO, vc4_create_shader_bo_ioctl, DRM_RENDER_ALLOW),
 201         DRM_IOCTL_DEF_DRV(VC4_GET_HANG_STATE, vc4_get_hang_state_ioctl,
 202                           DRM_ROOT_ONLY),
 203         DRM_IOCTL_DEF_DRV(VC4_GET_PARAM, vc4_get_param_ioctl, DRM_RENDER_ALLOW),
 204         DRM_IOCTL_DEF_DRV(VC4_SET_TILING, vc4_set_tiling_ioctl, DRM_RENDER_ALLOW),
 205         DRM_IOCTL_DEF_DRV(VC4_GET_TILING, vc4_get_tiling_ioctl, DRM_RENDER_ALLOW),
 206         DRM_IOCTL_DEF_DRV(VC4_LABEL_BO, vc4_label_bo_ioctl, DRM_RENDER_ALLOW),
 207         DRM_IOCTL_DEF_DRV(VC4_GEM_MADVISE, vc4_gem_madvise_ioctl, DRM_RENDER_ALLOW),
 208         DRM_IOCTL_DEF_DRV(VC4_PERFMON_CREATE, vc4_perfmon_create_ioctl, DRM_RENDER_ALLOW),
 209         DRM_IOCTL_DEF_DRV(VC4_PERFMON_DESTROY, vc4_perfmon_destroy_ioctl, DRM_RENDER_ALLOW),
 210         DRM_IOCTL_DEF_DRV(VC4_PERFMON_GET_VALUES, vc4_perfmon_get_values_ioctl, DRM_RENDER_ALLOW),
 211 };
 212
 213 const struct drm_driver vc4_drm_driver = {
 214         .driver_features = (DRIVER_MODESET |
 215                             DRIVER_ATOMIC |
 216                             DRIVER_GEM |
 217                             DRIVER_RENDER |
 218                             DRIVER_SYNCOBJ),
 219         .open = vc4_open,
 220         .postclose = vc4_close,
 221
 222 #if defined(CONFIG_DEBUG_FS)
 223         .debugfs_init = vc4_debugfs_init,
 224 #endif
 225
 226         .gem_create_object = vc4_create_object,
 227
 228         .dumb_create            = vc4_bo_dumb_create,
 229         .gem_prime_import_sg_table = vc4_prime_import_sg_table,
 230
 231         .ioctls = vc4_drm_ioctls,
 232         .num_ioctls = ARRAY_SIZE(vc4_drm_ioctls),
 233         .fops = &vc4_drm_fops,
 234
 235         .name = DRIVER_NAME,
 236         .desc = DRIVER_DESC,
 237         .date = DRIVER_DATE,
 238         .major = DRIVER_MAJOR,
 239         .minor = DRIVER_MINOR,
 240         .patchlevel = DRIVER_PATCHLEVEL,
 241 };
 242
 243 const struct drm_driver vc5_drm_driver = {
 244         .driver_features = (DRIVER_MODESET |
 245                             DRIVER_ATOMIC |
 246                             DRIVER_GEM),
 247
 248 #if defined(CONFIG_DEBUG_FS)
 249         .debugfs_init = vc4_debugfs_init,
 250 #endif
 251
 252         .dumb_create            = vc5_dumb_create,
 253         .gem_prime_import_sg_table = vc4_prime_import_sg_table,
 254
 255         .fops = &vc4_drm_fops,
 256
 257         .name = DRIVER_NAME,
 258         .desc = DRIVER_DESC,
 259         .date = DRIVER_DATE,
 260         .major = DRIVER_MAJOR,
 261         .minor = DRIVER_MINOR,
 262         .patchlevel = DRIVER_PATCHLEVEL,
 263 };
 264
 265 static void vc4_match_add_drivers(struct device *dev,
 266                                   struct component_match **match,
 267                                   struct platform_driver *const *drivers,
 268                                   int count)
 269 {
 270         int i;
 271
 272         for (i = 0; i < count; i++) {
 273                 struct device_driver *drv = &drivers[i]->driver;
 274                 struct device *p = NULL, *d;
 275
 276                 while ((d = platform_find_device_by_driver(p, drv))) {
 277                         put_device(p);
 278                         component_match_add(dev, match, component_compare_dev, d);
 279                         p = d;
 280                 }
 281                 put_device(p);
 282         }
 283 }
 284
 285 static void vc4_component_unbind_all(void *ptr)
 286 {
 287         struct vc4_dev *vc4 = ptr;
 288
 289         component_unbind_all(vc4->dev, &vc4->base);
 290 }
 291
 292 static const struct of_device_id vc4_dma_range_matches[] = {
 293         { .compatible = "brcm,bcm2711-hvs" },
 294         { .compatible = "brcm,bcm2712-hvs" },
 295         { .compatible = "brcm,bcm2835-hvs" },
 296         { .compatible = "raspberrypi,rpi-firmware-kms" },
 297         { .compatible = "brcm,bcm2835-v3d" },
 298         { .compatible = "brcm,cygnus-v3d" },
 299         { .compatible = "brcm,vc4-v3d" },
 300         {}
 301 };
 302
 303 /*
 304  * we need this helper function for determining presence of fkms
 305  * before it's been bound
 306  */
 307 static bool firmware_kms(void)
 308 {
 309         return of_device_is_available(of_find_compatible_node(NULL, NULL,
 310                "raspberrypi,rpi-firmware-kms")) ||
 311                of_device_is_available(of_find_compatible_node(NULL, NULL,
 312                "raspberrypi,rpi-firmware-kms-2711"));
 313 }
 314
 315 static int vc4_drm_bind(struct device *dev)
 316 {
 317         struct platform_device *pdev = to_platform_device(dev);
 318         const struct drm_driver *driver;
 319         struct rpi_firmware *firmware = NULL;
 320         struct drm_device *drm;
 321         struct vc4_dev *vc4;
 322         struct device_node *node;
 323         struct drm_crtc *crtc;
 324         enum vc4_gen gen;
 325         int ret = 0;
 326
 327         if (of_device_is_compatible(dev->of_node, "brcm,bcm2712-vc6"))
 328                 gen = VC4_GEN_6;
 329         else if (of_device_is_compatible(dev->of_node, "brcm,bcm2711-vc5"))
 330                 gen = VC4_GEN_5;
 331         else
 332                 gen = VC4_GEN_4;
 333
 334         if (gen > VC4_GEN_4)
 335                 driver = &vc5_drm_driver;
 336         else
 337                 driver = &vc4_drm_driver;
 338
 339         if (gen >= VC4_GEN_6)
 340                 dma_set_mask_and_coherent(dev, DMA_BIT_MASK(36));
 341         else
 342                 dma_set_mask_and_coherent(dev, DMA_BIT_MASK(32));
 343
 344         node = of_find_matching_node_and_match(NULL, vc4_dma_range_matches,
 345                                                NULL);
 346         if (node) {
 347                 ret = of_dma_configure(dev, node, true);
 348                 of_node_put(node);
 349
 350                 if (ret)
 351                         return ret;
 352         }
 353
 354         vc4 = devm_drm_dev_alloc(dev, driver, struct vc4_dev, base);
 355         if (IS_ERR(vc4))
 356                 return PTR_ERR(vc4);
 357         vc4->gen = gen;
 358         vc4->dev = dev;
 359
 360         drm = &vc4->base;
 361         platform_set_drvdata(pdev, drm);
 362
 363         if (gen == VC4_GEN_4) {
 364                 ret = drmm_mutex_init(drm, &vc4->bin_bo_lock);
 365                 if (ret)
 366                         return ret;
 367
 368                 ret = vc4_bo_cache_init(drm);
 369                 if (ret)
 370                         return ret;
 371         }
 372
 373         ret = drmm_mode_config_init(drm);
 374         if (ret)
 375                 return ret;
 376
 377         if (gen == VC4_GEN_4) {
 378                 ret = vc4_gem_init(drm);
 379                 if (ret)
 380                         return ret;
 381         }
 382
 383         node = of_find_compatible_node(NULL, NULL, "raspberrypi,bcm2835-firmware");
 384         if (node) {
 385                 firmware = rpi_firmware_get(node);
 386                 of_node_put(node);
 387
 388                 if (!firmware)
 389                         return -EPROBE_DEFER;
 390         }
 391
 392         ret = drm_aperture_remove_framebuffers(driver);
 393         if (ret)
 394                 return ret;
 395
 396         if (firmware && !firmware_kms()) {
 397                 ret = rpi_firmware_property(firmware,
 398                                             RPI_FIRMWARE_NOTIFY_DISPLAY_DONE,
 399                                             NULL, 0);
 400                 if (ret)
 401                         drm_warn(drm, "Couldn't stop firmware display driver: %d\n", ret);
 402
 403                 rpi_firmware_put(firmware);
 404         }
 405
 406         ret = component_bind_all(dev, drm);
 407         if (ret)
 408                 return ret;
 409
 410         ret = devm_add_action_or_reset(dev, vc4_component_unbind_all, vc4);
 411         if (ret)
 412                 return ret;
 413
 414         if (!vc4->firmware_kms) {
 415                 ret = vc4_plane_create_additional_planes(drm);
 416                 if (ret)
 417                         return ret;
 418         }
 419
 420         ret = vc4_kms_load(drm);
 421         if (ret < 0)
 422                 goto unbind_all;
 423
 424         if (!vc4->firmware_kms) {
 425                 drm_for_each_crtc(crtc, drm)
 426                         vc4_crtc_disable_at_boot(crtc);
 427         }
 428
 429         ret = drm_dev_register(drm, 0);
 430         if (ret < 0)
 431                 goto unbind_all;
 432
 433         drm_fbdev_dma_setup(drm, 16);
 434
 435         return 0;
 436
 437 unbind_all:
 438         return ret;
 439 }
 440
 441 static void vc4_drm_unbind(struct device *dev)
 442 {
 443         struct drm_device *drm = dev_get_drvdata(dev);
 444
 445         drm_dev_unplug(drm);
 446         drm_atomic_helper_shutdown(drm);
 447 }
 448
 449 static const struct component_master_ops vc4_drm_ops = {
 450         .bind = vc4_drm_bind,
 451         .unbind = vc4_drm_unbind,
 452 };
 453
 454 /*
 455  * This list determines the binding order of our components, and we have
 456  * a few constraints:
 457  *   - The TXP driver needs to be bound before the PixelValves (CRTC)
 458  *     but after the HVS to set the possible_crtc field properly
 459  *   - The HDMI driver needs to be bound after the HVS so that we can
 460  *     lookup the HVS maximum core clock rate and figure out if we
 461  *     support 4kp60 or not.
 462  */
 463 static struct platform_driver *const component_drivers[] = {
 464         &vc4_hvs_driver,
 465         &vc4_hdmi_driver,
 466         &vc4_vec_driver,
 467         &vc4_dpi_driver,
 468         &vc4_dsi_driver,
 469         &vc4_txp_driver,
 470         &vc4_crtc_driver,
 471         &vc4_firmware_kms_driver,
 472         &vc4_v3d_driver,
 473 };
 474
 475 static int vc4_platform_drm_probe(struct platform_device *pdev)
 476 {
 477         struct component_match *match = NULL;
 478         struct device *dev = &pdev->dev;
 479
 480         vc4_match_add_drivers(dev, &match,
 481                               component_drivers, ARRAY_SIZE(component_drivers));
 482
 483         if (!match)
 484                 return -ENODEV;
 485
 486         return component_master_add_with_match(dev, &vc4_drm_ops, match);
 487 }
 488
 489 static void vc4_platform_drm_remove(struct platform_device *pdev)
 490 {
 491         component_master_del(&pdev->dev, &vc4_drm_ops);
 492 }
 493
 494 static const struct of_device_id vc4_of_match[] = {
 495         { .compatible = "brcm,bcm2711-vc5", },
 496         { .compatible = "brcm,bcm2712-vc6", },
 497         { .compatible = "brcm,bcm2835-vc4", },
 498         { .compatible = "brcm,cygnus-vc4", },
 499         {},
 500 };
 501 MODULE_DEVICE_TABLE(of, vc4_of_match);
 502
 503 static struct platform_driver vc4_platform_driver = {
 504         .probe          = vc4_platform_drm_probe,
 505         .remove_new     = vc4_platform_drm_remove,
 506         .driver         = {
 507                 .name   = "vc4-drm",
 508                 .of_match_table = vc4_of_match,
 509         },
 510 };
 511
 512 static int __init vc4_drm_register(void)
 513 {
 514         int ret;
 515
 516         if (drm_firmware_drivers_only())
 517                 return -ENODEV;
 518
 519         ret = platform_register_drivers(component_drivers,
 520                                         ARRAY_SIZE(component_drivers));
 521         if (ret)
 522                 return ret;
 523
 524         ret = platform_driver_register(&vc4_platform_driver);
 525         if (ret)
 526                 platform_unregister_drivers(component_drivers,
 527                                             ARRAY_SIZE(component_drivers));
 528
 529         return ret;
 530 }
 531
 532 static void __exit vc4_drm_unregister(void)
 533 {
 534         platform_unregister_drivers(component_drivers,
 535                                     ARRAY_SIZE(component_drivers));
 536         platform_driver_unregister(&vc4_platform_driver);
 537 }
 538
 539 module_init(vc4_drm_register);
 540 module_exit(vc4_drm_unregister);
 541
 542 MODULE_ALIAS("platform:vc4-drm");
 543 MODULE_SOFTDEP("pre: snd-soc-hdmi-codec");
 544 MODULE_DESCRIPTION("Broadcom VC4 DRM Driver");
 545 MODULE_AUTHOR("Eric Anholt <eric@anholt.net>");
 546 MODULE_LICENSE("GPL v2");