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