1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2014-2015 Broadcom
4 * Copyright (C) 2013 Red Hat
8 * DOC: Broadcom VC4 Graphics Driver
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.
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
23 #include <linux/clk.h>
24 #include <linux/component.h>
25 #include <linux/device.h>
26 #include <linux/dma-mapping.h>
28 #include <linux/module.h>
29 #include <linux/of_platform.h>
30 #include <linux/platform_device.h>
31 #include <linux/pm_runtime.h>
33 #include <drm/drm_atomic_helper.h>
34 #include <drm/drm_drv.h>
35 #include <drm/drm_fb_cma_helper.h>
36 #include <drm/drm_fb_helper.h>
37 #include <drm/drm_vblank.h>
39 #include "uapi/drm/vc4_drm.h"
44 #define DRIVER_NAME "vc4"
45 #define DRIVER_DESC "Broadcom VC4 graphics"
46 #define DRIVER_DATE "20140616"
47 #define DRIVER_MAJOR 0
48 #define DRIVER_MINOR 0
49 #define DRIVER_PATCHLEVEL 0
51 /* Helper function for mapping the regs on a platform device. */
52 void __iomem *vc4_ioremap_regs(struct platform_device *dev, int index)
57 res = platform_get_resource(dev, IORESOURCE_MEM, index);
58 map = devm_ioremap_resource(&dev->dev, res);
60 DRM_ERROR("Failed to map registers: %ld\n", PTR_ERR(map));
67 static int vc4_get_param_ioctl(struct drm_device *dev, void *data,
68 struct drm_file *file_priv)
70 struct vc4_dev *vc4 = to_vc4_dev(dev);
71 struct drm_vc4_get_param *args = data;
80 switch (args->param) {
81 case DRM_VC4_PARAM_V3D_IDENT0:
82 ret = vc4_v3d_pm_get(vc4);
85 args->value = V3D_READ(V3D_IDENT0);
88 case DRM_VC4_PARAM_V3D_IDENT1:
89 ret = vc4_v3d_pm_get(vc4);
92 args->value = V3D_READ(V3D_IDENT1);
95 case DRM_VC4_PARAM_V3D_IDENT2:
96 ret = vc4_v3d_pm_get(vc4);
99 args->value = V3D_READ(V3D_IDENT2);
102 case DRM_VC4_PARAM_SUPPORTS_BRANCHES:
103 case DRM_VC4_PARAM_SUPPORTS_ETC1:
104 case DRM_VC4_PARAM_SUPPORTS_THREADED_FS:
105 case DRM_VC4_PARAM_SUPPORTS_FIXED_RCL_ORDER:
106 case DRM_VC4_PARAM_SUPPORTS_MADVISE:
107 case DRM_VC4_PARAM_SUPPORTS_PERFMON:
111 DRM_DEBUG("Unknown parameter %d\n", args->param);
118 static int vc4_open(struct drm_device *dev, struct drm_file *file)
120 struct vc4_file *vc4file;
122 vc4file = kzalloc(sizeof(*vc4file), GFP_KERNEL);
126 vc4_perfmon_open_file(vc4file);
127 file->driver_priv = vc4file;
131 static void vc4_close(struct drm_device *dev, struct drm_file *file)
133 struct vc4_dev *vc4 = to_vc4_dev(dev);
134 struct vc4_file *vc4file = file->driver_priv;
136 if (vc4file->bin_bo_used)
137 vc4_v3d_bin_bo_put(vc4);
139 vc4_perfmon_close_file(vc4file);
143 static const struct file_operations vc4_drm_fops = {
144 .owner = THIS_MODULE,
146 .release = drm_release,
147 .unlocked_ioctl = drm_ioctl,
151 .compat_ioctl = drm_compat_ioctl,
152 .llseek = noop_llseek,
155 static const struct drm_ioctl_desc vc4_drm_ioctls[] = {
156 DRM_IOCTL_DEF_DRV(VC4_SUBMIT_CL, vc4_submit_cl_ioctl, DRM_RENDER_ALLOW),
157 DRM_IOCTL_DEF_DRV(VC4_WAIT_SEQNO, vc4_wait_seqno_ioctl, DRM_RENDER_ALLOW),
158 DRM_IOCTL_DEF_DRV(VC4_WAIT_BO, vc4_wait_bo_ioctl, DRM_RENDER_ALLOW),
159 DRM_IOCTL_DEF_DRV(VC4_CREATE_BO, vc4_create_bo_ioctl, DRM_RENDER_ALLOW),
160 DRM_IOCTL_DEF_DRV(VC4_MMAP_BO, vc4_mmap_bo_ioctl, DRM_RENDER_ALLOW),
161 DRM_IOCTL_DEF_DRV(VC4_CREATE_SHADER_BO, vc4_create_shader_bo_ioctl, DRM_RENDER_ALLOW),
162 DRM_IOCTL_DEF_DRV(VC4_GET_HANG_STATE, vc4_get_hang_state_ioctl,
164 DRM_IOCTL_DEF_DRV(VC4_GET_PARAM, vc4_get_param_ioctl, DRM_RENDER_ALLOW),
165 DRM_IOCTL_DEF_DRV(VC4_SET_TILING, vc4_set_tiling_ioctl, DRM_RENDER_ALLOW),
166 DRM_IOCTL_DEF_DRV(VC4_GET_TILING, vc4_get_tiling_ioctl, DRM_RENDER_ALLOW),
167 DRM_IOCTL_DEF_DRV(VC4_LABEL_BO, vc4_label_bo_ioctl, DRM_RENDER_ALLOW),
168 DRM_IOCTL_DEF_DRV(VC4_GEM_MADVISE, vc4_gem_madvise_ioctl, DRM_RENDER_ALLOW),
169 DRM_IOCTL_DEF_DRV(VC4_PERFMON_CREATE, vc4_perfmon_create_ioctl, DRM_RENDER_ALLOW),
170 DRM_IOCTL_DEF_DRV(VC4_PERFMON_DESTROY, vc4_perfmon_destroy_ioctl, DRM_RENDER_ALLOW),
171 DRM_IOCTL_DEF_DRV(VC4_PERFMON_GET_VALUES, vc4_perfmon_get_values_ioctl, DRM_RENDER_ALLOW),
174 static struct drm_driver vc4_drm_driver = {
175 .driver_features = (DRIVER_MODESET |
181 .postclose = vc4_close,
182 .irq_handler = vc4_irq,
183 .irq_preinstall = vc4_irq_preinstall,
184 .irq_postinstall = vc4_irq_postinstall,
185 .irq_uninstall = vc4_irq_uninstall,
187 #if defined(CONFIG_DEBUG_FS)
188 .debugfs_init = vc4_debugfs_init,
191 .gem_create_object = vc4_create_object,
193 .prime_handle_to_fd = drm_gem_prime_handle_to_fd,
194 .prime_fd_to_handle = drm_gem_prime_fd_to_handle,
195 .gem_prime_import_sg_table = vc4_prime_import_sg_table,
196 .gem_prime_mmap = vc4_prime_mmap,
198 .dumb_create = vc4_dumb_create,
200 .ioctls = vc4_drm_ioctls,
201 .num_ioctls = ARRAY_SIZE(vc4_drm_ioctls),
202 .fops = &vc4_drm_fops,
207 .major = DRIVER_MAJOR,
208 .minor = DRIVER_MINOR,
209 .patchlevel = DRIVER_PATCHLEVEL,
212 static int compare_dev(struct device *dev, void *data)
217 static void vc4_match_add_drivers(struct device *dev,
218 struct component_match **match,
219 struct platform_driver *const *drivers,
224 for (i = 0; i < count; i++) {
225 struct device_driver *drv = &drivers[i]->driver;
226 struct device *p = NULL, *d;
228 while ((d = platform_find_device_by_driver(p, drv))) {
230 component_match_add(dev, match, compare_dev, d);
237 static int vc4_drm_bind(struct device *dev)
239 struct platform_device *pdev = to_platform_device(dev);
240 struct drm_device *drm;
242 struct device_node *node;
243 struct drm_crtc *crtc;
246 dev->coherent_dma_mask = DMA_BIT_MASK(32);
248 /* If VC4 V3D is missing, don't advertise render nodes. */
249 node = of_find_matching_node_and_match(NULL, vc4_v3d_dt_match, NULL);
250 if (!node || !of_device_is_available(node))
251 vc4_drm_driver.driver_features &= ~DRIVER_RENDER;
254 vc4 = devm_drm_dev_alloc(dev, &vc4_drm_driver, struct vc4_dev, base);
259 platform_set_drvdata(pdev, drm);
260 INIT_LIST_HEAD(&vc4->debugfs_list);
262 mutex_init(&vc4->bin_bo_lock);
264 ret = vc4_bo_cache_init(drm);
268 ret = drmm_mode_config_init(drm);
272 ret = vc4_gem_init(drm);
276 ret = component_bind_all(dev, drm);
280 ret = vc4_plane_create_additional_planes(drm);
284 drm_fb_helper_remove_conflicting_framebuffers(NULL, "vc4drmfb", false);
286 ret = vc4_kms_load(drm);
290 drm_for_each_crtc(crtc, drm)
291 vc4_crtc_disable_at_boot(crtc);
293 ret = drm_dev_register(drm, 0);
297 drm_fbdev_generic_setup(drm, 16);
302 component_unbind_all(dev, drm);
307 static void vc4_drm_unbind(struct device *dev)
309 struct drm_device *drm = dev_get_drvdata(dev);
311 drm_dev_unregister(drm);
313 drm_atomic_helper_shutdown(drm);
316 static const struct component_master_ops vc4_drm_ops = {
317 .bind = vc4_drm_bind,
318 .unbind = vc4_drm_unbind,
321 static struct platform_driver *const component_drivers[] = {
332 static int vc4_platform_drm_probe(struct platform_device *pdev)
334 struct component_match *match = NULL;
335 struct device *dev = &pdev->dev;
337 vc4_match_add_drivers(dev, &match,
338 component_drivers, ARRAY_SIZE(component_drivers));
340 return component_master_add_with_match(dev, &vc4_drm_ops, match);
343 static int vc4_platform_drm_remove(struct platform_device *pdev)
345 component_master_del(&pdev->dev, &vc4_drm_ops);
350 static const struct of_device_id vc4_of_match[] = {
351 { .compatible = "brcm,bcm2711-vc5", },
352 { .compatible = "brcm,bcm2835-vc4", },
353 { .compatible = "brcm,cygnus-vc4", },
356 MODULE_DEVICE_TABLE(of, vc4_of_match);
358 static struct platform_driver vc4_platform_driver = {
359 .probe = vc4_platform_drm_probe,
360 .remove = vc4_platform_drm_remove,
363 .of_match_table = vc4_of_match,
367 static int __init vc4_drm_register(void)
371 ret = platform_register_drivers(component_drivers,
372 ARRAY_SIZE(component_drivers));
376 return platform_driver_register(&vc4_platform_driver);
379 static void __exit vc4_drm_unregister(void)
381 platform_unregister_drivers(component_drivers,
382 ARRAY_SIZE(component_drivers));
383 platform_driver_unregister(&vc4_platform_driver);
386 module_init(vc4_drm_register);
387 module_exit(vc4_drm_unregister);
389 MODULE_ALIAS("platform:vc4-drm");
390 MODULE_DESCRIPTION("Broadcom VC4 DRM Driver");
391 MODULE_AUTHOR("Eric Anholt <eric@anholt.net>");
392 MODULE_LICENSE("GPL v2");