2 * Copyright (C) 2014-2015 Broadcom
3 * Copyright (C) 2013 Red Hat
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
11 * DOC: Broadcom VC4 Graphics Driver
13 * The Broadcom VideoCore 4 (present in the Raspberry Pi) contains a
14 * OpenGL ES 2.0-compatible 3D engine called V3D, and a highly
15 * configurable display output pipeline that supports HDMI, DSI, DPI,
16 * and Composite TV output.
18 * The 3D engine also has an interface for submitting arbitrary
19 * compute shader-style jobs using the same shader processor as is
20 * used for vertex and fragment shaders in GLES 2.0. However, given
21 * that the hardware isn't able to expose any standard interfaces like
22 * OpenGL compute shaders or OpenCL, it isn't supported by this
26 #include <linux/clk.h>
27 #include <linux/component.h>
28 #include <linux/device.h>
30 #include <linux/module.h>
31 #include <linux/of_platform.h>
32 #include <linux/platform_device.h>
33 #include <linux/pm_runtime.h>
34 #include <drm/drm_fb_cma_helper.h>
35 #include <drm/drm_fb_helper.h>
37 #include "uapi/drm/vc4_drm.h"
41 #define DRIVER_NAME "vc4"
42 #define DRIVER_DESC "Broadcom VC4 graphics"
43 #define DRIVER_DATE "20140616"
44 #define DRIVER_MAJOR 0
45 #define DRIVER_MINOR 0
46 #define DRIVER_PATCHLEVEL 0
48 /* Helper function for mapping the regs on a platform device. */
49 void __iomem *vc4_ioremap_regs(struct platform_device *dev, int index)
54 res = platform_get_resource(dev, IORESOURCE_MEM, index);
55 map = devm_ioremap_resource(&dev->dev, res);
57 DRM_ERROR("Failed to map registers: %ld\n", PTR_ERR(map));
64 static int vc4_get_param_ioctl(struct drm_device *dev, void *data,
65 struct drm_file *file_priv)
67 struct vc4_dev *vc4 = to_vc4_dev(dev);
68 struct drm_vc4_get_param *args = data;
74 switch (args->param) {
75 case DRM_VC4_PARAM_V3D_IDENT0:
76 ret = pm_runtime_get_sync(&vc4->v3d->pdev->dev);
79 args->value = V3D_READ(V3D_IDENT0);
80 pm_runtime_mark_last_busy(&vc4->v3d->pdev->dev);
81 pm_runtime_put_autosuspend(&vc4->v3d->pdev->dev);
83 case DRM_VC4_PARAM_V3D_IDENT1:
84 ret = pm_runtime_get_sync(&vc4->v3d->pdev->dev);
87 args->value = V3D_READ(V3D_IDENT1);
88 pm_runtime_mark_last_busy(&vc4->v3d->pdev->dev);
89 pm_runtime_put_autosuspend(&vc4->v3d->pdev->dev);
91 case DRM_VC4_PARAM_V3D_IDENT2:
92 ret = pm_runtime_get_sync(&vc4->v3d->pdev->dev);
95 args->value = V3D_READ(V3D_IDENT2);
96 pm_runtime_mark_last_busy(&vc4->v3d->pdev->dev);
97 pm_runtime_put_autosuspend(&vc4->v3d->pdev->dev);
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:
107 DRM_DEBUG("Unknown parameter %d\n", args->param);
114 static const struct vm_operations_struct vc4_vm_ops = {
116 .open = drm_gem_vm_open,
117 .close = drm_gem_vm_close,
120 static const struct file_operations vc4_drm_fops = {
121 .owner = THIS_MODULE,
123 .release = drm_release,
124 .unlocked_ioctl = drm_ioctl,
128 .compat_ioctl = drm_compat_ioctl,
129 .llseek = noop_llseek,
132 static const struct drm_ioctl_desc vc4_drm_ioctls[] = {
133 DRM_IOCTL_DEF_DRV(VC4_SUBMIT_CL, vc4_submit_cl_ioctl, DRM_RENDER_ALLOW),
134 DRM_IOCTL_DEF_DRV(VC4_WAIT_SEQNO, vc4_wait_seqno_ioctl, DRM_RENDER_ALLOW),
135 DRM_IOCTL_DEF_DRV(VC4_WAIT_BO, vc4_wait_bo_ioctl, DRM_RENDER_ALLOW),
136 DRM_IOCTL_DEF_DRV(VC4_CREATE_BO, vc4_create_bo_ioctl, DRM_RENDER_ALLOW),
137 DRM_IOCTL_DEF_DRV(VC4_MMAP_BO, vc4_mmap_bo_ioctl, DRM_RENDER_ALLOW),
138 DRM_IOCTL_DEF_DRV(VC4_CREATE_SHADER_BO, vc4_create_shader_bo_ioctl, DRM_RENDER_ALLOW),
139 DRM_IOCTL_DEF_DRV(VC4_GET_HANG_STATE, vc4_get_hang_state_ioctl,
141 DRM_IOCTL_DEF_DRV(VC4_GET_PARAM, vc4_get_param_ioctl, DRM_RENDER_ALLOW),
142 DRM_IOCTL_DEF_DRV(VC4_SET_TILING, vc4_set_tiling_ioctl, DRM_RENDER_ALLOW),
143 DRM_IOCTL_DEF_DRV(VC4_GET_TILING, vc4_get_tiling_ioctl, DRM_RENDER_ALLOW),
144 DRM_IOCTL_DEF_DRV(VC4_LABEL_BO, vc4_label_bo_ioctl, DRM_RENDER_ALLOW),
145 DRM_IOCTL_DEF_DRV(VC4_GEM_MADVISE, vc4_gem_madvise_ioctl, DRM_RENDER_ALLOW),
148 static struct drm_driver vc4_drm_driver = {
149 .driver_features = (DRIVER_MODESET |
155 .lastclose = drm_fb_helper_lastclose,
156 .irq_handler = vc4_irq,
157 .irq_preinstall = vc4_irq_preinstall,
158 .irq_postinstall = vc4_irq_postinstall,
159 .irq_uninstall = vc4_irq_uninstall,
161 .get_scanout_position = vc4_crtc_get_scanoutpos,
162 .get_vblank_timestamp = drm_calc_vbltimestamp_from_scanoutpos,
164 #if defined(CONFIG_DEBUG_FS)
165 .debugfs_init = vc4_debugfs_init,
168 .gem_create_object = vc4_create_object,
169 .gem_free_object_unlocked = vc4_free_object,
170 .gem_vm_ops = &vc4_vm_ops,
172 .prime_handle_to_fd = drm_gem_prime_handle_to_fd,
173 .prime_fd_to_handle = drm_gem_prime_fd_to_handle,
174 .gem_prime_import = drm_gem_prime_import,
175 .gem_prime_export = vc4_prime_export,
176 .gem_prime_res_obj = vc4_prime_res_obj,
177 .gem_prime_get_sg_table = drm_gem_cma_prime_get_sg_table,
178 .gem_prime_import_sg_table = vc4_prime_import_sg_table,
179 .gem_prime_vmap = vc4_prime_vmap,
180 .gem_prime_vunmap = drm_gem_cma_prime_vunmap,
181 .gem_prime_mmap = vc4_prime_mmap,
183 .dumb_create = vc4_dumb_create,
185 .ioctls = vc4_drm_ioctls,
186 .num_ioctls = ARRAY_SIZE(vc4_drm_ioctls),
187 .fops = &vc4_drm_fops,
192 .major = DRIVER_MAJOR,
193 .minor = DRIVER_MINOR,
194 .patchlevel = DRIVER_PATCHLEVEL,
197 static int compare_dev(struct device *dev, void *data)
202 static void vc4_match_add_drivers(struct device *dev,
203 struct component_match **match,
204 struct platform_driver *const *drivers,
209 for (i = 0; i < count; i++) {
210 struct device_driver *drv = &drivers[i]->driver;
211 struct device *p = NULL, *d;
213 while ((d = bus_find_device(&platform_bus_type, p, drv,
214 (void *)platform_bus_type.match))) {
216 component_match_add(dev, match, compare_dev, d);
223 static void vc4_kick_out_firmware_fb(void)
225 struct apertures_struct *ap;
227 ap = alloc_apertures(1);
231 /* Since VC4 is a UMA device, the simplefb node may have been
232 * located anywhere in memory.
234 ap->ranges[0].base = 0;
235 ap->ranges[0].size = ~0;
237 drm_fb_helper_remove_conflicting_framebuffers(ap, "vc4drmfb", false);
241 static int vc4_drm_bind(struct device *dev)
243 struct platform_device *pdev = to_platform_device(dev);
244 struct drm_device *drm;
248 dev->coherent_dma_mask = DMA_BIT_MASK(32);
250 vc4 = devm_kzalloc(dev, sizeof(*vc4), GFP_KERNEL);
254 drm = drm_dev_alloc(&vc4_drm_driver, dev);
257 platform_set_drvdata(pdev, drm);
259 drm->dev_private = vc4;
261 ret = vc4_bo_cache_init(drm);
265 drm_mode_config_init(drm);
269 ret = component_bind_all(dev, drm);
273 vc4_kick_out_firmware_fb();
275 ret = drm_dev_register(drm, 0);
284 component_unbind_all(dev, drm);
286 vc4_gem_destroy(drm);
287 vc4_bo_cache_destroy(drm);
293 static void vc4_drm_unbind(struct device *dev)
295 struct platform_device *pdev = to_platform_device(dev);
296 struct drm_device *drm = platform_get_drvdata(pdev);
298 drm_dev_unregister(drm);
300 drm_fb_cma_fbdev_fini(drm);
302 drm_mode_config_cleanup(drm);
307 static const struct component_master_ops vc4_drm_ops = {
308 .bind = vc4_drm_bind,
309 .unbind = vc4_drm_unbind,
312 static struct platform_driver *const component_drivers[] = {
322 static int vc4_platform_drm_probe(struct platform_device *pdev)
324 struct component_match *match = NULL;
325 struct device *dev = &pdev->dev;
327 vc4_match_add_drivers(dev, &match,
328 component_drivers, ARRAY_SIZE(component_drivers));
330 return component_master_add_with_match(dev, &vc4_drm_ops, match);
333 static int vc4_platform_drm_remove(struct platform_device *pdev)
335 component_master_del(&pdev->dev, &vc4_drm_ops);
340 static const struct of_device_id vc4_of_match[] = {
341 { .compatible = "brcm,bcm2835-vc4", },
342 { .compatible = "brcm,cygnus-vc4", },
345 MODULE_DEVICE_TABLE(of, vc4_of_match);
347 static struct platform_driver vc4_platform_driver = {
348 .probe = vc4_platform_drm_probe,
349 .remove = vc4_platform_drm_remove,
352 .of_match_table = vc4_of_match,
356 static int __init vc4_drm_register(void)
360 ret = platform_register_drivers(component_drivers,
361 ARRAY_SIZE(component_drivers));
365 return platform_driver_register(&vc4_platform_driver);
368 static void __exit vc4_drm_unregister(void)
370 platform_unregister_drivers(component_drivers,
371 ARRAY_SIZE(component_drivers));
372 platform_driver_unregister(&vc4_platform_driver);
375 module_init(vc4_drm_register);
376 module_exit(vc4_drm_unregister);
378 MODULE_ALIAS("platform:vc4-drm");
379 MODULE_DESCRIPTION("Broadcom VC4 DRM Driver");
381 MODULE_LICENSE("GPL v2");