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_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>
40 #include <soc/bcm2835/raspberrypi-firmware.h>
42 #include "uapi/drm/vc4_drm.h"
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
54 /* Helper function for mapping the regs on a platform device. */
55 void __iomem *vc4_ioremap_regs(struct platform_device *dev, int index)
60 res = platform_get_resource(dev, IORESOURCE_MEM, index);
61 map = devm_ioremap_resource(&dev->dev, res);
68 static int vc4_get_param_ioctl(struct drm_device *dev, void *data,
69 struct drm_file *file_priv)
71 struct vc4_dev *vc4 = to_vc4_dev(dev);
72 struct drm_vc4_get_param *args = data;
81 switch (args->param) {
82 case DRM_VC4_PARAM_V3D_IDENT0:
83 ret = vc4_v3d_pm_get(vc4);
86 args->value = V3D_READ(V3D_IDENT0);
89 case DRM_VC4_PARAM_V3D_IDENT1:
90 ret = vc4_v3d_pm_get(vc4);
93 args->value = V3D_READ(V3D_IDENT1);
96 case DRM_VC4_PARAM_V3D_IDENT2:
97 ret = vc4_v3d_pm_get(vc4);
100 args->value = V3D_READ(V3D_IDENT2);
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:
112 DRM_DEBUG("Unknown parameter %d\n", args->param);
119 static int vc4_open(struct drm_device *dev, struct drm_file *file)
121 struct vc4_file *vc4file;
123 vc4file = kzalloc(sizeof(*vc4file), GFP_KERNEL);
127 vc4_perfmon_open_file(vc4file);
128 file->driver_priv = vc4file;
132 static void vc4_close(struct drm_device *dev, struct drm_file *file)
134 struct vc4_dev *vc4 = to_vc4_dev(dev);
135 struct vc4_file *vc4file = file->driver_priv;
137 if (vc4file->bin_bo_used)
138 vc4_v3d_bin_bo_put(vc4);
140 vc4_perfmon_close_file(vc4file);
144 DEFINE_DRM_GEM_FOPS(vc4_drm_fops);
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,
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),
165 static struct drm_driver vc4_drm_driver = {
166 .driver_features = (DRIVER_MODESET |
172 .postclose = vc4_close,
174 #if defined(CONFIG_DEBUG_FS)
175 .debugfs_init = vc4_debugfs_init,
178 .gem_create_object = vc4_create_object,
180 DRM_GEM_CMA_DRIVER_OPS_WITH_DUMB_CREATE(vc4_dumb_create),
182 .ioctls = vc4_drm_ioctls,
183 .num_ioctls = ARRAY_SIZE(vc4_drm_ioctls),
184 .fops = &vc4_drm_fops,
189 .major = DRIVER_MAJOR,
190 .minor = DRIVER_MINOR,
191 .patchlevel = DRIVER_PATCHLEVEL,
194 static int compare_dev(struct device *dev, void *data)
199 static void vc4_match_add_drivers(struct device *dev,
200 struct component_match **match,
201 struct platform_driver *const *drivers,
206 for (i = 0; i < count; i++) {
207 struct device_driver *drv = &drivers[i]->driver;
208 struct device *p = NULL, *d;
210 while ((d = platform_find_device_by_driver(p, drv))) {
212 component_match_add(dev, match, compare_dev, d);
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" },
229 static int vc4_drm_bind(struct device *dev)
231 struct platform_device *pdev = to_platform_device(dev);
232 struct rpi_firmware *firmware = NULL;
233 struct drm_device *drm;
235 struct device_node *node;
236 struct drm_crtc *crtc;
239 dev->coherent_dma_mask = DMA_BIT_MASK(32);
241 /* If VC4 V3D is missing, don't advertise render nodes. */
242 node = of_find_matching_node_and_match(NULL, vc4_v3d_dt_match, NULL);
243 if (!node || !of_device_is_available(node))
244 vc4_drm_driver.driver_features &= ~DRIVER_RENDER;
247 node = of_find_matching_node_and_match(NULL, vc4_dma_range_matches,
250 ret = of_dma_configure(dev, node, true);
257 vc4 = devm_drm_dev_alloc(dev, &vc4_drm_driver, struct vc4_dev, base);
262 platform_set_drvdata(pdev, drm);
263 INIT_LIST_HEAD(&vc4->debugfs_list);
265 mutex_init(&vc4->bin_bo_lock);
267 ret = vc4_bo_cache_init(drm);
271 ret = drmm_mode_config_init(drm);
275 ret = vc4_gem_init(drm);
279 node = of_find_compatible_node(NULL, NULL, "raspberrypi,bcm2835-firmware");
281 firmware = rpi_firmware_get(node);
285 return -EPROBE_DEFER;
288 ret = drm_aperture_remove_framebuffers(false, &vc4_drm_driver);
293 ret = rpi_firmware_property(firmware,
294 RPI_FIRMWARE_NOTIFY_DISPLAY_DONE,
297 drm_warn(drm, "Couldn't stop firmware display driver: %d\n", ret);
299 rpi_firmware_put(firmware);
302 ret = component_bind_all(dev, drm);
306 ret = vc4_plane_create_additional_planes(drm);
310 ret = vc4_kms_load(drm);
314 drm_for_each_crtc(crtc, drm)
315 vc4_crtc_disable_at_boot(crtc);
317 ret = drm_dev_register(drm, 0);
321 drm_fbdev_generic_setup(drm, 16);
326 component_unbind_all(dev, drm);
331 static void vc4_drm_unbind(struct device *dev)
333 struct drm_device *drm = dev_get_drvdata(dev);
335 drm_dev_unregister(drm);
337 drm_atomic_helper_shutdown(drm);
340 static const struct component_master_ops vc4_drm_ops = {
341 .bind = vc4_drm_bind,
342 .unbind = vc4_drm_unbind,
346 * This list determines the binding order of our components, and we have
348 * - The TXP driver needs to be bound before the PixelValves (CRTC)
349 * but after the HVS to set the possible_crtc field properly
350 * - The HDMI driver needs to be bound after the HVS so that we can
351 * lookup the HVS maximum core clock rate and figure out if we
352 * support 4kp60 or not.
354 static struct platform_driver *const component_drivers[] = {
365 static int vc4_platform_drm_probe(struct platform_device *pdev)
367 struct component_match *match = NULL;
368 struct device *dev = &pdev->dev;
370 vc4_match_add_drivers(dev, &match,
371 component_drivers, ARRAY_SIZE(component_drivers));
373 return component_master_add_with_match(dev, &vc4_drm_ops, match);
376 static int vc4_platform_drm_remove(struct platform_device *pdev)
378 component_master_del(&pdev->dev, &vc4_drm_ops);
383 static const struct of_device_id vc4_of_match[] = {
384 { .compatible = "brcm,bcm2711-vc5", },
385 { .compatible = "brcm,bcm2835-vc4", },
386 { .compatible = "brcm,cygnus-vc4", },
389 MODULE_DEVICE_TABLE(of, vc4_of_match);
391 static struct platform_driver vc4_platform_driver = {
392 .probe = vc4_platform_drm_probe,
393 .remove = vc4_platform_drm_remove,
396 .of_match_table = vc4_of_match,
400 static int __init vc4_drm_register(void)
404 ret = platform_register_drivers(component_drivers,
405 ARRAY_SIZE(component_drivers));
409 return platform_driver_register(&vc4_platform_driver);
412 static void __exit vc4_drm_unregister(void)
414 platform_unregister_drivers(component_drivers,
415 ARRAY_SIZE(component_drivers));
416 platform_driver_unregister(&vc4_platform_driver);
419 module_init(vc4_drm_register);
420 module_exit(vc4_drm_unregister);
422 MODULE_ALIAS("platform:vc4-drm");
423 MODULE_DESCRIPTION("Broadcom VC4 DRM Driver");
424 MODULE_AUTHOR("Eric Anholt <eric@anholt.net>");
425 MODULE_LICENSE("GPL v2");