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/io.h> 27 #include <linux/module.h> 28 #include <linux/of_platform.h> 29 #include <linux/platform_device.h> 30 #include <linux/pm_runtime.h> 31 #include <drm/drm_fb_cma_helper.h> 32 #include <drm/drm_fb_helper.h> 33 #include <drm/drm_atomic_helper.h> 34 35 #include "uapi/drm/vc4_drm.h" 36 #include "vc4_drv.h" 37 #include "vc4_regs.h" 38 39 #define DRIVER_NAME "vc4" 40 #define DRIVER_DESC "Broadcom VC4 graphics" 41 #define DRIVER_DATE "20140616" 42 #define DRIVER_MAJOR 0 43 #define DRIVER_MINOR 0 44 #define DRIVER_PATCHLEVEL 0 45 46 /* Helper function for mapping the regs on a platform device. */ 47 void __iomem *vc4_ioremap_regs(struct platform_device *dev, int index) 48 { 49 struct resource *res; 50 void __iomem *map; 51 52 res = platform_get_resource(dev, IORESOURCE_MEM, index); 53 map = devm_ioremap_resource(&dev->dev, res); 54 if (IS_ERR(map)) { 55 DRM_ERROR("Failed to map registers: %ld\n", PTR_ERR(map)); 56 return map; 57 } 58 59 return map; 60 } 61 62 static int vc4_get_param_ioctl(struct drm_device *dev, void *data, 63 struct drm_file *file_priv) 64 { 65 struct vc4_dev *vc4 = to_vc4_dev(dev); 66 struct drm_vc4_get_param *args = data; 67 int ret; 68 69 if (args->pad != 0) 70 return -EINVAL; 71 72 if (!vc4->v3d) 73 return -ENODEV; 74 75 switch (args->param) { 76 case DRM_VC4_PARAM_V3D_IDENT0: 77 ret = vc4_v3d_pm_get(vc4); 78 if (ret) 79 return ret; 80 args->value = V3D_READ(V3D_IDENT0); 81 vc4_v3d_pm_put(vc4); 82 break; 83 case DRM_VC4_PARAM_V3D_IDENT1: 84 ret = vc4_v3d_pm_get(vc4); 85 if (ret) 86 return ret; 87 args->value = V3D_READ(V3D_IDENT1); 88 vc4_v3d_pm_put(vc4); 89 break; 90 case DRM_VC4_PARAM_V3D_IDENT2: 91 ret = vc4_v3d_pm_get(vc4); 92 if (ret) 93 return ret; 94 args->value = V3D_READ(V3D_IDENT2); 95 vc4_v3d_pm_put(vc4); 96 break; 97 case DRM_VC4_PARAM_SUPPORTS_BRANCHES: 98 case DRM_VC4_PARAM_SUPPORTS_ETC1: 99 case DRM_VC4_PARAM_SUPPORTS_THREADED_FS: 100 case DRM_VC4_PARAM_SUPPORTS_FIXED_RCL_ORDER: 101 case DRM_VC4_PARAM_SUPPORTS_MADVISE: 102 case DRM_VC4_PARAM_SUPPORTS_PERFMON: 103 args->value = true; 104 break; 105 default: 106 DRM_DEBUG("Unknown parameter %d\n", args->param); 107 return -EINVAL; 108 } 109 110 return 0; 111 } 112 113 static int vc4_open(struct drm_device *dev, struct drm_file *file) 114 { 115 struct vc4_file *vc4file; 116 117 vc4file = kzalloc(sizeof(*vc4file), GFP_KERNEL); 118 if (!vc4file) 119 return -ENOMEM; 120 121 vc4_perfmon_open_file(vc4file); 122 file->driver_priv = vc4file; 123 return 0; 124 } 125 126 static void vc4_close(struct drm_device *dev, struct drm_file *file) 127 { 128 struct vc4_dev *vc4 = to_vc4_dev(dev); 129 struct vc4_file *vc4file = file->driver_priv; 130 131 if (vc4file->bin_bo_used) 132 vc4_v3d_bin_bo_put(vc4); 133 134 vc4_perfmon_close_file(vc4file); 135 kfree(vc4file); 136 } 137 138 static const struct vm_operations_struct vc4_vm_ops = { 139 .fault = vc4_fault, 140 .open = drm_gem_vm_open, 141 .close = drm_gem_vm_close, 142 }; 143 144 static const struct file_operations vc4_drm_fops = { 145 .owner = THIS_MODULE, 146 .open = drm_open, 147 .release = drm_release, 148 .unlocked_ioctl = drm_ioctl, 149 .mmap = vc4_mmap, 150 .poll = drm_poll, 151 .read = drm_read, 152 .compat_ioctl = drm_compat_ioctl, 153 .llseek = noop_llseek, 154 }; 155 156 static const struct drm_ioctl_desc vc4_drm_ioctls[] = { 157 DRM_IOCTL_DEF_DRV(VC4_SUBMIT_CL, vc4_submit_cl_ioctl, DRM_RENDER_ALLOW), 158 DRM_IOCTL_DEF_DRV(VC4_WAIT_SEQNO, vc4_wait_seqno_ioctl, DRM_RENDER_ALLOW), 159 DRM_IOCTL_DEF_DRV(VC4_WAIT_BO, vc4_wait_bo_ioctl, DRM_RENDER_ALLOW), 160 DRM_IOCTL_DEF_DRV(VC4_CREATE_BO, vc4_create_bo_ioctl, DRM_RENDER_ALLOW), 161 DRM_IOCTL_DEF_DRV(VC4_MMAP_BO, vc4_mmap_bo_ioctl, DRM_RENDER_ALLOW), 162 DRM_IOCTL_DEF_DRV(VC4_CREATE_SHADER_BO, vc4_create_shader_bo_ioctl, DRM_RENDER_ALLOW), 163 DRM_IOCTL_DEF_DRV(VC4_GET_HANG_STATE, vc4_get_hang_state_ioctl, 164 DRM_ROOT_ONLY), 165 DRM_IOCTL_DEF_DRV(VC4_GET_PARAM, vc4_get_param_ioctl, DRM_RENDER_ALLOW), 166 DRM_IOCTL_DEF_DRV(VC4_SET_TILING, vc4_set_tiling_ioctl, DRM_RENDER_ALLOW), 167 DRM_IOCTL_DEF_DRV(VC4_GET_TILING, vc4_get_tiling_ioctl, DRM_RENDER_ALLOW), 168 DRM_IOCTL_DEF_DRV(VC4_LABEL_BO, vc4_label_bo_ioctl, DRM_RENDER_ALLOW), 169 DRM_IOCTL_DEF_DRV(VC4_GEM_MADVISE, vc4_gem_madvise_ioctl, DRM_RENDER_ALLOW), 170 DRM_IOCTL_DEF_DRV(VC4_PERFMON_CREATE, vc4_perfmon_create_ioctl, DRM_RENDER_ALLOW), 171 DRM_IOCTL_DEF_DRV(VC4_PERFMON_DESTROY, vc4_perfmon_destroy_ioctl, DRM_RENDER_ALLOW), 172 DRM_IOCTL_DEF_DRV(VC4_PERFMON_GET_VALUES, vc4_perfmon_get_values_ioctl, DRM_RENDER_ALLOW), 173 }; 174 175 static struct drm_driver vc4_drm_driver = { 176 .driver_features = (DRIVER_MODESET | 177 DRIVER_ATOMIC | 178 DRIVER_GEM | 179 DRIVER_RENDER | 180 DRIVER_PRIME | 181 DRIVER_SYNCOBJ), 182 .open = vc4_open, 183 .postclose = vc4_close, 184 .irq_handler = vc4_irq, 185 .irq_preinstall = vc4_irq_preinstall, 186 .irq_postinstall = vc4_irq_postinstall, 187 .irq_uninstall = vc4_irq_uninstall, 188 189 .get_scanout_position = vc4_crtc_get_scanoutpos, 190 .get_vblank_timestamp = drm_calc_vbltimestamp_from_scanoutpos, 191 192 #if defined(CONFIG_DEBUG_FS) 193 .debugfs_init = vc4_debugfs_init, 194 #endif 195 196 .gem_create_object = vc4_create_object, 197 .gem_free_object_unlocked = vc4_free_object, 198 .gem_vm_ops = &vc4_vm_ops, 199 200 .prime_handle_to_fd = drm_gem_prime_handle_to_fd, 201 .prime_fd_to_handle = drm_gem_prime_fd_to_handle, 202 .gem_prime_import = drm_gem_prime_import, 203 .gem_prime_export = vc4_prime_export, 204 .gem_prime_get_sg_table = drm_gem_cma_prime_get_sg_table, 205 .gem_prime_import_sg_table = vc4_prime_import_sg_table, 206 .gem_prime_vmap = vc4_prime_vmap, 207 .gem_prime_vunmap = drm_gem_cma_prime_vunmap, 208 .gem_prime_mmap = vc4_prime_mmap, 209 210 .dumb_create = vc4_dumb_create, 211 212 .ioctls = vc4_drm_ioctls, 213 .num_ioctls = ARRAY_SIZE(vc4_drm_ioctls), 214 .fops = &vc4_drm_fops, 215 216 .name = DRIVER_NAME, 217 .desc = DRIVER_DESC, 218 .date = DRIVER_DATE, 219 .major = DRIVER_MAJOR, 220 .minor = DRIVER_MINOR, 221 .patchlevel = DRIVER_PATCHLEVEL, 222 }; 223 224 static int compare_dev(struct device *dev, void *data) 225 { 226 return dev == data; 227 } 228 229 static void vc4_match_add_drivers(struct device *dev, 230 struct component_match **match, 231 struct platform_driver *const *drivers, 232 int count) 233 { 234 int i; 235 236 for (i = 0; i < count; i++) { 237 struct device_driver *drv = &drivers[i]->driver; 238 struct device *p = NULL, *d; 239 240 while ((d = bus_find_device(&platform_bus_type, p, drv, 241 (void *)platform_bus_type.match))) { 242 put_device(p); 243 component_match_add(dev, match, compare_dev, d); 244 p = d; 245 } 246 put_device(p); 247 } 248 } 249 250 static int vc4_drm_bind(struct device *dev) 251 { 252 struct platform_device *pdev = to_platform_device(dev); 253 struct drm_device *drm; 254 struct vc4_dev *vc4; 255 struct device_node *node; 256 int ret = 0; 257 258 dev->coherent_dma_mask = DMA_BIT_MASK(32); 259 260 vc4 = devm_kzalloc(dev, sizeof(*vc4), GFP_KERNEL); 261 if (!vc4) 262 return -ENOMEM; 263 264 /* If VC4 V3D is missing, don't advertise render nodes. */ 265 node = of_find_matching_node_and_match(NULL, vc4_v3d_dt_match, NULL); 266 if (!node || !of_device_is_available(node)) 267 vc4_drm_driver.driver_features &= ~DRIVER_RENDER; 268 of_node_put(node); 269 270 drm = drm_dev_alloc(&vc4_drm_driver, dev); 271 if (IS_ERR(drm)) 272 return PTR_ERR(drm); 273 platform_set_drvdata(pdev, drm); 274 vc4->dev = drm; 275 drm->dev_private = vc4; 276 INIT_LIST_HEAD(&vc4->debugfs_list); 277 278 mutex_init(&vc4->bin_bo_lock); 279 280 ret = vc4_bo_cache_init(drm); 281 if (ret) 282 goto dev_put; 283 284 drm_mode_config_init(drm); 285 286 vc4_gem_init(drm); 287 288 ret = component_bind_all(dev, drm); 289 if (ret) 290 goto gem_destroy; 291 292 drm_fb_helper_remove_conflicting_framebuffers(NULL, "vc4drmfb", false); 293 294 ret = vc4_kms_load(drm); 295 if (ret < 0) 296 goto unbind_all; 297 298 ret = drm_dev_register(drm, 0); 299 if (ret < 0) 300 goto unbind_all; 301 302 drm_fbdev_generic_setup(drm, 16); 303 304 return 0; 305 306 unbind_all: 307 component_unbind_all(dev, drm); 308 gem_destroy: 309 vc4_gem_destroy(drm); 310 vc4_bo_cache_destroy(drm); 311 dev_put: 312 drm_dev_put(drm); 313 return ret; 314 } 315 316 static void vc4_drm_unbind(struct device *dev) 317 { 318 struct drm_device *drm = dev_get_drvdata(dev); 319 struct vc4_dev *vc4 = to_vc4_dev(drm); 320 321 drm_dev_unregister(drm); 322 323 drm_atomic_helper_shutdown(drm); 324 325 drm_mode_config_cleanup(drm); 326 327 drm_atomic_private_obj_fini(&vc4->load_tracker); 328 drm_atomic_private_obj_fini(&vc4->ctm_manager); 329 330 drm_dev_put(drm); 331 } 332 333 static const struct component_master_ops vc4_drm_ops = { 334 .bind = vc4_drm_bind, 335 .unbind = vc4_drm_unbind, 336 }; 337 338 static struct platform_driver *const component_drivers[] = { 339 &vc4_hdmi_driver, 340 &vc4_vec_driver, 341 &vc4_dpi_driver, 342 &vc4_dsi_driver, 343 &vc4_txp_driver, 344 &vc4_hvs_driver, 345 &vc4_crtc_driver, 346 &vc4_v3d_driver, 347 }; 348 349 static int vc4_platform_drm_probe(struct platform_device *pdev) 350 { 351 struct component_match *match = NULL; 352 struct device *dev = &pdev->dev; 353 354 vc4_match_add_drivers(dev, &match, 355 component_drivers, ARRAY_SIZE(component_drivers)); 356 357 return component_master_add_with_match(dev, &vc4_drm_ops, match); 358 } 359 360 static int vc4_platform_drm_remove(struct platform_device *pdev) 361 { 362 component_master_del(&pdev->dev, &vc4_drm_ops); 363 364 return 0; 365 } 366 367 static const struct of_device_id vc4_of_match[] = { 368 { .compatible = "brcm,bcm2835-vc4", }, 369 { .compatible = "brcm,cygnus-vc4", }, 370 {}, 371 }; 372 MODULE_DEVICE_TABLE(of, vc4_of_match); 373 374 static struct platform_driver vc4_platform_driver = { 375 .probe = vc4_platform_drm_probe, 376 .remove = vc4_platform_drm_remove, 377 .driver = { 378 .name = "vc4-drm", 379 .of_match_table = vc4_of_match, 380 }, 381 }; 382 383 static int __init vc4_drm_register(void) 384 { 385 int ret; 386 387 ret = platform_register_drivers(component_drivers, 388 ARRAY_SIZE(component_drivers)); 389 if (ret) 390 return ret; 391 392 return platform_driver_register(&vc4_platform_driver); 393 } 394 395 static void __exit vc4_drm_unregister(void) 396 { 397 platform_unregister_drivers(component_drivers, 398 ARRAY_SIZE(component_drivers)); 399 platform_driver_unregister(&vc4_platform_driver); 400 } 401 402 module_init(vc4_drm_register); 403 module_exit(vc4_drm_unregister); 404 405 MODULE_ALIAS("platform:vc4-drm"); 406 MODULE_DESCRIPTION("Broadcom VC4 DRM Driver"); 407 MODULE_AUTHOR("Eric Anholt <eric@anholt.net>"); 408 MODULE_LICENSE("GPL v2"); 409