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 int vc4_dumb_fixup_args(struct drm_mode_create_dumb *args)
70 int min_pitch = DIV_ROUND_UP(args->width * args->bpp, 8);
72 if (args->pitch < min_pitch)
73 args->pitch = min_pitch;
75 if (args->size < args->pitch * args->height)
76 args->size = args->pitch * args->height;
81 static int vc4_dumb_create(struct drm_file *file_priv,
82 struct drm_device *dev,
83 struct drm_mode_create_dumb *args)
87 ret = vc4_dumb_fixup_args(args);
91 return drm_gem_cma_dumb_create_internal(file_priv, dev, args);
94 static int vc4_get_param_ioctl(struct drm_device *dev, void *data,
95 struct drm_file *file_priv)
97 struct vc4_dev *vc4 = to_vc4_dev(dev);
98 struct drm_vc4_get_param *args = data;
104 if (WARN_ON_ONCE(vc4->is_vc5))
110 switch (args->param) {
111 case DRM_VC4_PARAM_V3D_IDENT0:
112 ret = vc4_v3d_pm_get(vc4);
115 args->value = V3D_READ(V3D_IDENT0);
118 case DRM_VC4_PARAM_V3D_IDENT1:
119 ret = vc4_v3d_pm_get(vc4);
122 args->value = V3D_READ(V3D_IDENT1);
125 case DRM_VC4_PARAM_V3D_IDENT2:
126 ret = vc4_v3d_pm_get(vc4);
129 args->value = V3D_READ(V3D_IDENT2);
132 case DRM_VC4_PARAM_SUPPORTS_BRANCHES:
133 case DRM_VC4_PARAM_SUPPORTS_ETC1:
134 case DRM_VC4_PARAM_SUPPORTS_THREADED_FS:
135 case DRM_VC4_PARAM_SUPPORTS_FIXED_RCL_ORDER:
136 case DRM_VC4_PARAM_SUPPORTS_MADVISE:
137 case DRM_VC4_PARAM_SUPPORTS_PERFMON:
141 DRM_DEBUG("Unknown parameter %d\n", args->param);
148 static int vc4_open(struct drm_device *dev, struct drm_file *file)
150 struct vc4_dev *vc4 = to_vc4_dev(dev);
151 struct vc4_file *vc4file;
153 if (WARN_ON_ONCE(vc4->is_vc5))
156 vc4file = kzalloc(sizeof(*vc4file), GFP_KERNEL);
161 vc4_perfmon_open_file(vc4file);
162 file->driver_priv = vc4file;
166 static void vc4_close(struct drm_device *dev, struct drm_file *file)
168 struct vc4_dev *vc4 = to_vc4_dev(dev);
169 struct vc4_file *vc4file = file->driver_priv;
171 if (WARN_ON_ONCE(vc4->is_vc5))
174 if (vc4file->bin_bo_used)
175 vc4_v3d_bin_bo_put(vc4);
177 vc4_perfmon_close_file(vc4file);
181 DEFINE_DRM_GEM_FOPS(vc4_drm_fops);
183 static const struct drm_ioctl_desc vc4_drm_ioctls[] = {
184 DRM_IOCTL_DEF_DRV(VC4_SUBMIT_CL, vc4_submit_cl_ioctl, DRM_RENDER_ALLOW),
185 DRM_IOCTL_DEF_DRV(VC4_WAIT_SEQNO, vc4_wait_seqno_ioctl, DRM_RENDER_ALLOW),
186 DRM_IOCTL_DEF_DRV(VC4_WAIT_BO, vc4_wait_bo_ioctl, DRM_RENDER_ALLOW),
187 DRM_IOCTL_DEF_DRV(VC4_CREATE_BO, vc4_create_bo_ioctl, DRM_RENDER_ALLOW),
188 DRM_IOCTL_DEF_DRV(VC4_MMAP_BO, vc4_mmap_bo_ioctl, DRM_RENDER_ALLOW),
189 DRM_IOCTL_DEF_DRV(VC4_CREATE_SHADER_BO, vc4_create_shader_bo_ioctl, DRM_RENDER_ALLOW),
190 DRM_IOCTL_DEF_DRV(VC4_GET_HANG_STATE, vc4_get_hang_state_ioctl,
192 DRM_IOCTL_DEF_DRV(VC4_GET_PARAM, vc4_get_param_ioctl, DRM_RENDER_ALLOW),
193 DRM_IOCTL_DEF_DRV(VC4_SET_TILING, vc4_set_tiling_ioctl, DRM_RENDER_ALLOW),
194 DRM_IOCTL_DEF_DRV(VC4_GET_TILING, vc4_get_tiling_ioctl, DRM_RENDER_ALLOW),
195 DRM_IOCTL_DEF_DRV(VC4_LABEL_BO, vc4_label_bo_ioctl, DRM_RENDER_ALLOW),
196 DRM_IOCTL_DEF_DRV(VC4_GEM_MADVISE, vc4_gem_madvise_ioctl, DRM_RENDER_ALLOW),
197 DRM_IOCTL_DEF_DRV(VC4_PERFMON_CREATE, vc4_perfmon_create_ioctl, DRM_RENDER_ALLOW),
198 DRM_IOCTL_DEF_DRV(VC4_PERFMON_DESTROY, vc4_perfmon_destroy_ioctl, DRM_RENDER_ALLOW),
199 DRM_IOCTL_DEF_DRV(VC4_PERFMON_GET_VALUES, vc4_perfmon_get_values_ioctl, DRM_RENDER_ALLOW),
202 static const struct drm_driver vc4_drm_driver = {
203 .driver_features = (DRIVER_MODESET |
209 .postclose = vc4_close,
211 #if defined(CONFIG_DEBUG_FS)
212 .debugfs_init = vc4_debugfs_init,
215 .gem_create_object = vc4_create_object,
217 DRM_GEM_CMA_DRIVER_OPS_WITH_DUMB_CREATE(vc4_bo_dumb_create),
219 .ioctls = vc4_drm_ioctls,
220 .num_ioctls = ARRAY_SIZE(vc4_drm_ioctls),
221 .fops = &vc4_drm_fops,
226 .major = DRIVER_MAJOR,
227 .minor = DRIVER_MINOR,
228 .patchlevel = DRIVER_PATCHLEVEL,
231 static const struct drm_driver vc5_drm_driver = {
232 .driver_features = (DRIVER_MODESET |
236 #if defined(CONFIG_DEBUG_FS)
237 .debugfs_init = vc4_debugfs_init,
240 DRM_GEM_CMA_DRIVER_OPS_WITH_DUMB_CREATE(vc4_dumb_create),
242 .fops = &vc4_drm_fops,
247 .major = DRIVER_MAJOR,
248 .minor = DRIVER_MINOR,
249 .patchlevel = DRIVER_PATCHLEVEL,
252 static int compare_dev(struct device *dev, void *data)
257 static void vc4_match_add_drivers(struct device *dev,
258 struct component_match **match,
259 struct platform_driver *const *drivers,
264 for (i = 0; i < count; i++) {
265 struct device_driver *drv = &drivers[i]->driver;
266 struct device *p = NULL, *d;
268 while ((d = platform_find_device_by_driver(p, drv))) {
270 component_match_add(dev, match, compare_dev, d);
277 static void vc4_component_unbind_all(void *ptr)
279 struct vc4_dev *vc4 = ptr;
281 component_unbind_all(vc4->dev, &vc4->base);
284 const struct of_device_id vc4_dma_range_matches[] = {
285 { .compatible = "brcm,bcm2835-hvs" },
286 { .compatible = "brcm,bcm2711-hvs" },
287 { .compatible = "raspberrypi,rpi-firmware-kms" },
288 { .compatible = "brcm,bcm2835-v3d" },
289 { .compatible = "brcm,cygnus-v3d" },
290 { .compatible = "brcm,vc4-v3d" },
295 * we need this helper function for determining presence of fkms
296 * before it's been bound
298 static bool firmware_kms(void)
300 return of_device_is_available(of_find_compatible_node(NULL, NULL,
301 "raspberrypi,rpi-firmware-kms")) ||
302 of_device_is_available(of_find_compatible_node(NULL, NULL,
303 "raspberrypi,rpi-firmware-kms-2711"));
306 static int vc4_drm_bind(struct device *dev)
308 struct platform_device *pdev = to_platform_device(dev);
309 const struct drm_driver *driver;
310 struct rpi_firmware *firmware = NULL;
311 struct drm_device *drm;
313 struct device_node *node;
314 struct drm_crtc *crtc;
318 dev->coherent_dma_mask = DMA_BIT_MASK(32);
320 is_vc5 = of_device_is_compatible(dev->of_node, "brcm,bcm2711-vc5");
322 driver = &vc5_drm_driver;
324 driver = &vc4_drm_driver;
326 node = of_find_matching_node_and_match(NULL, vc4_dma_range_matches,
329 ret = of_dma_configure(dev, node, true);
336 vc4 = devm_drm_dev_alloc(dev, driver, struct vc4_dev, base);
339 vc4->is_vc5 = is_vc5;
343 platform_set_drvdata(pdev, drm);
344 INIT_LIST_HEAD(&vc4->debugfs_list);
347 ret = drmm_mutex_init(drm, &vc4->bin_bo_lock);
351 ret = vc4_bo_cache_init(drm);
356 ret = drmm_mode_config_init(drm);
361 ret = vc4_gem_init(drm);
366 node = of_find_compatible_node(NULL, NULL, "raspberrypi,bcm2835-firmware");
368 firmware = rpi_firmware_get(node);
372 return -EPROBE_DEFER;
375 ret = drm_aperture_remove_framebuffers(false, driver);
379 if (firmware && !firmware_kms()) {
380 ret = rpi_firmware_property(firmware,
381 RPI_FIRMWARE_NOTIFY_DISPLAY_DONE,
384 drm_warn(drm, "Couldn't stop firmware display driver: %d\n", ret);
386 rpi_firmware_put(firmware);
389 ret = component_bind_all(dev, drm);
393 ret = devm_add_action_or_reset(dev, vc4_component_unbind_all, vc4);
397 if (!vc4->firmware_kms) {
398 ret = vc4_plane_create_additional_planes(drm);
403 ret = vc4_kms_load(drm);
407 if (!vc4->firmware_kms) {
408 drm_for_each_crtc(crtc, drm)
409 vc4_crtc_disable_at_boot(crtc);
412 ret = drm_dev_register(drm, 0);
416 drm_fbdev_generic_setup(drm, 16);
424 static void vc4_drm_unbind(struct device *dev)
426 struct drm_device *drm = dev_get_drvdata(dev);
429 drm_atomic_helper_shutdown(drm);
432 static const struct component_master_ops vc4_drm_ops = {
433 .bind = vc4_drm_bind,
434 .unbind = vc4_drm_unbind,
438 * This list determines the binding order of our components, and we have
440 * - The TXP driver needs to be bound before the PixelValves (CRTC)
441 * but after the HVS to set the possible_crtc field properly
442 * - The HDMI driver needs to be bound after the HVS so that we can
443 * lookup the HVS maximum core clock rate and figure out if we
444 * support 4kp60 or not.
446 static struct platform_driver *const component_drivers[] = {
454 &vc4_firmware_kms_driver,
458 static int vc4_platform_drm_probe(struct platform_device *pdev)
460 struct component_match *match = NULL;
461 struct device *dev = &pdev->dev;
463 vc4_match_add_drivers(dev, &match,
464 component_drivers, ARRAY_SIZE(component_drivers));
466 return component_master_add_with_match(dev, &vc4_drm_ops, match);
469 static int vc4_platform_drm_remove(struct platform_device *pdev)
471 component_master_del(&pdev->dev, &vc4_drm_ops);
476 static const struct of_device_id vc4_of_match[] = {
477 { .compatible = "brcm,bcm2711-vc5", },
478 { .compatible = "brcm,bcm2835-vc4", },
479 { .compatible = "brcm,cygnus-vc4", },
482 MODULE_DEVICE_TABLE(of, vc4_of_match);
484 static struct platform_driver vc4_platform_driver = {
485 .probe = vc4_platform_drm_probe,
486 .remove = vc4_platform_drm_remove,
489 .of_match_table = vc4_of_match,
493 static int __init vc4_drm_register(void)
497 ret = platform_register_drivers(component_drivers,
498 ARRAY_SIZE(component_drivers));
502 return platform_driver_register(&vc4_platform_driver);
505 static void __exit vc4_drm_unregister(void)
507 platform_unregister_drivers(component_drivers,
508 ARRAY_SIZE(component_drivers));
509 platform_driver_unregister(&vc4_platform_driver);
512 module_init(vc4_drm_register);
513 module_exit(vc4_drm_unregister);
515 MODULE_ALIAS("platform:vc4-drm");
516 MODULE_SOFTDEP("pre: snd-soc-hdmi-codec");
517 MODULE_DESCRIPTION("Broadcom VC4 DRM Driver");
518 MODULE_AUTHOR("Eric Anholt <eric@anholt.net>");
519 MODULE_LICENSE("GPL v2");