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 static int vc4_get_param_ioctl(struct drm_device *dev, void *data,
  69                                struct drm_file *file_priv)
  70 {
  71         struct vc4_dev *vc4 = to_vc4_dev(dev);
  72         struct drm_vc4_get_param *args = data;
  73         int ret;
  74
  75         if (args->pad != 0)
  76                 return -EINVAL;
  77
  78         if (!vc4->v3d)
  79                 return -ENODEV;
  80
  81         switch (args->param) {
  82         case DRM_VC4_PARAM_V3D_IDENT0:
  83                 ret = vc4_v3d_pm_get(vc4);
  84                 if (ret)
  85                         return ret;
  86                 args->value = V3D_READ(V3D_IDENT0);
  87                 vc4_v3d_pm_put(vc4);
  88                 break;
  89         case DRM_VC4_PARAM_V3D_IDENT1:
  90                 ret = vc4_v3d_pm_get(vc4);
  91                 if (ret)
  92                         return ret;
  93                 args->value = V3D_READ(V3D_IDENT1);
  94                 vc4_v3d_pm_put(vc4);
  95                 break;
  96         case DRM_VC4_PARAM_V3D_IDENT2:
  97                 ret = vc4_v3d_pm_get(vc4);
  98                 if (ret)
  99                         return ret;
 100                 args->value = V3D_READ(V3D_IDENT2);
 101                 vc4_v3d_pm_put(vc4);
 102                 break;
 103         case DRM_VC4_PARAM_SUPPORTS_BRANCHES:
 104         case DRM_VC4_PARAM_SUPPORTS_ETC1:
 105         case DRM_VC4_PARAM_SUPPORTS_THREADED_FS:
 106         case DRM_VC4_PARAM_SUPPORTS_FIXED_RCL_ORDER:
 107         case DRM_VC4_PARAM_SUPPORTS_MADVISE:
 108         case DRM_VC4_PARAM_SUPPORTS_PERFMON:
 109                 args->value = true;
 110                 break;
 111         default:
 112                 DRM_DEBUG("Unknown parameter %d\n", args->param);
 113                 return -EINVAL;
 114         }
 115
 116         return 0;
 117 }
 118
 119 static int vc4_open(struct drm_device *dev, struct drm_file *file)
 120 {
 121         struct vc4_file *vc4file;
 122
 123         vc4file = kzalloc(sizeof(*vc4file), GFP_KERNEL);
 124         if (!vc4file)
 125                 return -ENOMEM;
 126
 127         vc4_perfmon_open_file(vc4file);
 128         file->driver_priv = vc4file;
 129         return 0;
 130 }
 131
 132 static void vc4_close(struct drm_device *dev, struct drm_file *file)
 133 {
 134         struct vc4_dev *vc4 = to_vc4_dev(dev);
 135         struct vc4_file *vc4file = file->driver_priv;
 136
 137         if (vc4file->bin_bo_used)
 138                 vc4_v3d_bin_bo_put(vc4);
 139
 140         vc4_perfmon_close_file(vc4file);
 141         kfree(vc4file);
 142 }
 143
 144 DEFINE_DRM_GEM_FOPS(vc4_drm_fops);
 145
 146 static const struct drm_ioctl_desc vc4_drm_ioctls[] = {
 147         DRM_IOCTL_DEF_DRV(VC4_SUBMIT_CL, vc4_submit_cl_ioctl, DRM_RENDER_ALLOW),
 148         DRM_IOCTL_DEF_DRV(VC4_WAIT_SEQNO, vc4_wait_seqno_ioctl, DRM_RENDER_ALLOW),
 149         DRM_IOCTL_DEF_DRV(VC4_WAIT_BO, vc4_wait_bo_ioctl, DRM_RENDER_ALLOW),
 150         DRM_IOCTL_DEF_DRV(VC4_CREATE_BO, vc4_create_bo_ioctl, DRM_RENDER_ALLOW),
 151         DRM_IOCTL_DEF_DRV(VC4_MMAP_BO, vc4_mmap_bo_ioctl, DRM_RENDER_ALLOW),
 152         DRM_IOCTL_DEF_DRV(VC4_CREATE_SHADER_BO, vc4_create_shader_bo_ioctl, DRM_RENDER_ALLOW),
 153         DRM_IOCTL_DEF_DRV(VC4_GET_HANG_STATE, vc4_get_hang_state_ioctl,
 154                           DRM_ROOT_ONLY),
 155         DRM_IOCTL_DEF_DRV(VC4_GET_PARAM, vc4_get_param_ioctl, DRM_RENDER_ALLOW),
 156         DRM_IOCTL_DEF_DRV(VC4_SET_TILING, vc4_set_tiling_ioctl, DRM_RENDER_ALLOW),
 157         DRM_IOCTL_DEF_DRV(VC4_GET_TILING, vc4_get_tiling_ioctl, DRM_RENDER_ALLOW),
 158         DRM_IOCTL_DEF_DRV(VC4_LABEL_BO, vc4_label_bo_ioctl, DRM_RENDER_ALLOW),
 159         DRM_IOCTL_DEF_DRV(VC4_GEM_MADVISE, vc4_gem_madvise_ioctl, DRM_RENDER_ALLOW),
 160         DRM_IOCTL_DEF_DRV(VC4_PERFMON_CREATE, vc4_perfmon_create_ioctl, DRM_RENDER_ALLOW),
 161         DRM_IOCTL_DEF_DRV(VC4_PERFMON_DESTROY, vc4_perfmon_destroy_ioctl, DRM_RENDER_ALLOW),
 162         DRM_IOCTL_DEF_DRV(VC4_PERFMON_GET_VALUES, vc4_perfmon_get_values_ioctl, DRM_RENDER_ALLOW),
 163 };
 164
 165 static struct drm_driver vc4_drm_driver = {
 166         .driver_features = (DRIVER_MODESET |
 167                             DRIVER_ATOMIC |
 168                             DRIVER_GEM |
 169                             DRIVER_RENDER |
 170                             DRIVER_SYNCOBJ),
 171         .open = vc4_open,
 172         .postclose = vc4_close,
 173
 174 #if defined(CONFIG_DEBUG_FS)
 175         .debugfs_init = vc4_debugfs_init,
 176 #endif
 177
 178         .gem_create_object = vc4_create_object,
 179
 180         DRM_GEM_CMA_DRIVER_OPS_WITH_DUMB_CREATE(vc4_dumb_create),
 181
 182         .ioctls = vc4_drm_ioctls,
 183         .num_ioctls = ARRAY_SIZE(vc4_drm_ioctls),
 184         .fops = &vc4_drm_fops,
 185
 186         .name = DRIVER_NAME,
 187         .desc = DRIVER_DESC,
 188         .date = DRIVER_DATE,
 189         .major = DRIVER_MAJOR,
 190         .minor = DRIVER_MINOR,
 191         .patchlevel = DRIVER_PATCHLEVEL,
 192 };
 193
 194 static int compare_dev(struct device *dev, void *data)
 195 {
 196         return dev == data;
 197 }
 198
 199 static void vc4_match_add_drivers(struct device *dev,
 200                                   struct component_match **match,
 201                                   struct platform_driver *const *drivers,
 202                                   int count)
 203 {
 204         int i;
 205
 206         for (i = 0; i < count; i++) {
 207                 struct device_driver *drv = &drivers[i]->driver;
 208                 struct device *p = NULL, *d;
 209
 210                 while ((d = platform_find_device_by_driver(p, drv))) {
 211                         put_device(p);
 212                         component_match_add(dev, match, compare_dev, d);
 213                         p = d;
 214                 }
 215                 put_device(p);
 216         }
 217 }
 218
 219 const struct of_device_id vc4_dma_range_matches[] = {
 220         { .compatible = "brcm,bcm2835-hvs" },
 221         { .compatible = "brcm,bcm2711-hvs" },
 222         { .compatible = "raspberrypi,rpi-firmware-kms" },
 223         { .compatible = "brcm,bcm2835-v3d" },
 224         { .compatible = "brcm,cygnus-v3d" },
 225         { .compatible = "brcm,vc4-v3d" },
 226         {}
 227 };
 228
 229 /*
 230  * we need this helper function for determining presence of fkms
 231  * before it's been bound
 232  */
 233 static bool firmware_kms(void)
 234 {
 235         return of_device_is_available(of_find_compatible_node(NULL, NULL,
 236                "raspberrypi,rpi-firmware-kms")) ||
 237                of_device_is_available(of_find_compatible_node(NULL, NULL,
 238                "raspberrypi,rpi-firmware-kms-2711"));
 239 }
 240
 241 static int vc4_drm_bind(struct device *dev)
 242 {
 243         struct platform_device *pdev = to_platform_device(dev);
 244         struct rpi_firmware *firmware = NULL;
 245         struct drm_device *drm;
 246         struct vc4_dev *vc4;
 247         struct device_node *node;
 248         struct drm_crtc *crtc;
 249         int ret = 0;
 250
 251         dev->coherent_dma_mask = DMA_BIT_MASK(32);
 252
 253         /* If VC4 V3D is missing, don't advertise render nodes. */
 254         node = of_find_matching_node_and_match(NULL, vc4_v3d_dt_match, NULL);
 255         if (!node || !of_device_is_available(node))
 256                 vc4_drm_driver.driver_features &= ~DRIVER_RENDER;
 257         of_node_put(node);
 258
 259         node = of_find_matching_node_and_match(NULL, vc4_dma_range_matches,
 260                                                NULL);
 261         if (node) {
 262                 ret = of_dma_configure(dev, node, true);
 263                 of_node_put(node);
 264
 265                 if (ret)
 266                         return ret;
 267         }
 268
 269         vc4 = devm_drm_dev_alloc(dev, &vc4_drm_driver, struct vc4_dev, base);
 270         if (IS_ERR(vc4))
 271                 return PTR_ERR(vc4);
 272
 273         drm = &vc4->base;
 274         platform_set_drvdata(pdev, drm);
 275         INIT_LIST_HEAD(&vc4->debugfs_list);
 276
 277         mutex_init(&vc4->bin_bo_lock);
 278
 279         ret = vc4_bo_cache_init(drm);
 280         if (ret)
 281                 return ret;
 282
 283         ret = drmm_mode_config_init(drm);
 284         if (ret)
 285                 return ret;
 286
 287         ret = vc4_gem_init(drm);
 288         if (ret)
 289                 return ret;
 290
 291         node = of_find_compatible_node(NULL, NULL, "raspberrypi,bcm2835-firmware");
 292         if (node) {
 293                 firmware = rpi_firmware_get(node);
 294                 of_node_put(node);
 295
 296                 if (!firmware)
 297                         return -EPROBE_DEFER;
 298         }
 299
 300         ret = drm_aperture_remove_framebuffers(false, &vc4_drm_driver);
 301         if (ret)
 302                 return ret;
 303
 304         if (firmware && !firmware_kms()) {
 305                 ret = rpi_firmware_property(firmware,
 306                                             RPI_FIRMWARE_NOTIFY_DISPLAY_DONE,
 307                                             NULL, 0);
 308                 if (ret)
 309                         drm_warn(drm, "Couldn't stop firmware display driver: %d\n", ret);
 310
 311                 rpi_firmware_put(firmware);
 312         }
 313
 314         ret = component_bind_all(dev, drm);
 315         if (ret)
 316                 return ret;
 317
 318         if (!vc4->firmware_kms) {
 319                 ret = vc4_plane_create_additional_planes(drm);
 320                 if (ret)
 321                         goto unbind_all;
 322         }
 323
 324         ret = vc4_kms_load(drm);
 325         if (ret < 0)
 326                 goto unbind_all;
 327
 328         if (!vc4->firmware_kms) {
 329                 drm_for_each_crtc(crtc, drm)
 330                         vc4_crtc_disable_at_boot(crtc);
 331         }
 332
 333         ret = drm_dev_register(drm, 0);
 334         if (ret < 0)
 335                 goto unbind_all;
 336
 337         drm_fbdev_generic_setup(drm, 16);
 338
 339         return 0;
 340
 341 unbind_all:
 342         component_unbind_all(dev, drm);
 343
 344         return ret;
 345 }
 346
 347 static void vc4_drm_unbind(struct device *dev)
 348 {
 349         struct drm_device *drm = dev_get_drvdata(dev);
 350
 351         drm_dev_unregister(drm);
 352
 353         drm_atomic_helper_shutdown(drm);
 354 }
 355
 356 static const struct component_master_ops vc4_drm_ops = {
 357         .bind = vc4_drm_bind,
 358         .unbind = vc4_drm_unbind,
 359 };
 360
 361 /*
 362  * This list determines the binding order of our components, and we have
 363  * a few constraints:
 364  *   - The TXP driver needs to be bound before the PixelValves (CRTC)
 365  *     but after the HVS to set the possible_crtc field properly
 366  *   - The HDMI driver needs to be bound after the HVS so that we can
 367  *     lookup the HVS maximum core clock rate and figure out if we
 368  *     support 4kp60 or not.
 369  */
 370 static struct platform_driver *const component_drivers[] = {
 371         &vc4_hvs_driver,
 372         &vc4_hdmi_driver,
 373         &vc4_vec_driver,
 374         &vc4_dpi_driver,
 375         &vc4_dsi_driver,
 376         &vc4_txp_driver,
 377         &vc4_crtc_driver,
 378         &vc4_firmware_kms_driver,
 379         &vc4_v3d_driver,
 380 };
 381
 382 static int vc4_platform_drm_probe(struct platform_device *pdev)
 383 {
 384         struct component_match *match = NULL;
 385         struct device *dev = &pdev->dev;
 386
 387         vc4_match_add_drivers(dev, &match,
 388                               component_drivers, ARRAY_SIZE(component_drivers));
 389
 390         return component_master_add_with_match(dev, &vc4_drm_ops, match);
 391 }
 392
 393 static int vc4_platform_drm_remove(struct platform_device *pdev)
 394 {
 395         component_master_del(&pdev->dev, &vc4_drm_ops);
 396
 397         return 0;
 398 }
 399
 400 static const struct of_device_id vc4_of_match[] = {
 401         { .compatible = "brcm,bcm2711-vc5", },
 402         { .compatible = "brcm,bcm2835-vc4", },
 403         { .compatible = "brcm,cygnus-vc4", },
 404         {},
 405 };
 406 MODULE_DEVICE_TABLE(of, vc4_of_match);
 407
 408 static struct platform_driver vc4_platform_driver = {
 409         .probe          = vc4_platform_drm_probe,
 410         .remove         = vc4_platform_drm_remove,
 411         .driver         = {
 412                 .name   = "vc4-drm",
 413                 .of_match_table = vc4_of_match,
 414         },
 415 };
 416
 417 static int __init vc4_drm_register(void)
 418 {
 419         int ret;
 420
 421         ret = platform_register_drivers(component_drivers,
 422                                         ARRAY_SIZE(component_drivers));
 423         if (ret)
 424                 return ret;
 425
 426         return platform_driver_register(&vc4_platform_driver);
 427 }
 428
 429 static void __exit vc4_drm_unregister(void)
 430 {
 431         platform_unregister_drivers(component_drivers,
 432                                     ARRAY_SIZE(component_drivers));
 433         platform_driver_unregister(&vc4_platform_driver);
 434 }
 435
 436 module_init(vc4_drm_register);
 437 module_exit(vc4_drm_unregister);
 438
 439 MODULE_ALIAS("platform:vc4-drm");
 440 MODULE_DESCRIPTION("Broadcom VC4 DRM Driver");
 441 MODULE_AUTHOR("Eric Anholt <eric@anholt.net>");
 442 MODULE_LICENSE("GPL v2");