xref: /openbmc/linux/drivers/gpu/drm/vc4/vc4_drv.c (revision 28efb0046512e8a13ed9f9bdf0d68d10bbfbe9cf)
1 /*
2  * Copyright (C) 2014-2015 Broadcom
3  * Copyright (C) 2013 Red Hat
4  *
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.
8  */
9 
10 /**
11  * DOC: Broadcom VC4 Graphics Driver
12  *
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.
17  *
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
23  * driver.
24  */
25 
26 #include <linux/clk.h>
27 #include <linux/component.h>
28 #include <linux/device.h>
29 #include <linux/io.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>
36 
37 #include "uapi/drm/vc4_drm.h"
38 #include "vc4_drv.h"
39 #include "vc4_regs.h"
40 
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
47 
48 /* Helper function for mapping the regs on a platform device. */
49 void __iomem *vc4_ioremap_regs(struct platform_device *dev, int index)
50 {
51 	struct resource *res;
52 	void __iomem *map;
53 
54 	res = platform_get_resource(dev, IORESOURCE_MEM, index);
55 	map = devm_ioremap_resource(&dev->dev, res);
56 	if (IS_ERR(map)) {
57 		DRM_ERROR("Failed to map registers: %ld\n", PTR_ERR(map));
58 		return map;
59 	}
60 
61 	return map;
62 }
63 
64 static int vc4_get_param_ioctl(struct drm_device *dev, void *data,
65 			       struct drm_file *file_priv)
66 {
67 	struct vc4_dev *vc4 = to_vc4_dev(dev);
68 	struct drm_vc4_get_param *args = data;
69 	int ret;
70 
71 	if (args->pad != 0)
72 		return -EINVAL;
73 
74 	switch (args->param) {
75 	case DRM_VC4_PARAM_V3D_IDENT0:
76 		ret = pm_runtime_get_sync(&vc4->v3d->pdev->dev);
77 		if (ret < 0)
78 			return ret;
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);
82 		break;
83 	case DRM_VC4_PARAM_V3D_IDENT1:
84 		ret = pm_runtime_get_sync(&vc4->v3d->pdev->dev);
85 		if (ret < 0)
86 			return ret;
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);
90 		break;
91 	case DRM_VC4_PARAM_V3D_IDENT2:
92 		ret = pm_runtime_get_sync(&vc4->v3d->pdev->dev);
93 		if (ret < 0)
94 			return ret;
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);
98 		break;
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 		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 void vc4_lastclose(struct drm_device *dev)
114 {
115 	struct vc4_dev *vc4 = to_vc4_dev(dev);
116 
117 	drm_fbdev_cma_restore_mode(vc4->fbdev);
118 }
119 
120 static const struct file_operations vc4_drm_fops = {
121 	.owner = THIS_MODULE,
122 	.open = drm_open,
123 	.release = drm_release,
124 	.unlocked_ioctl = drm_ioctl,
125 	.mmap = vc4_mmap,
126 	.poll = drm_poll,
127 	.read = drm_read,
128 	.compat_ioctl = drm_compat_ioctl,
129 	.llseek = noop_llseek,
130 };
131 
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,
140 			  DRM_ROOT_ONLY),
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 };
146 
147 static struct drm_driver vc4_drm_driver = {
148 	.driver_features = (DRIVER_MODESET |
149 			    DRIVER_ATOMIC |
150 			    DRIVER_GEM |
151 			    DRIVER_HAVE_IRQ |
152 			    DRIVER_RENDER |
153 			    DRIVER_PRIME),
154 	.lastclose = vc4_lastclose,
155 	.irq_handler = vc4_irq,
156 	.irq_preinstall = vc4_irq_preinstall,
157 	.irq_postinstall = vc4_irq_postinstall,
158 	.irq_uninstall = vc4_irq_uninstall,
159 
160 	.get_scanout_position = vc4_crtc_get_scanoutpos,
161 	.get_vblank_timestamp = drm_calc_vbltimestamp_from_scanoutpos,
162 
163 #if defined(CONFIG_DEBUG_FS)
164 	.debugfs_init = vc4_debugfs_init,
165 #endif
166 
167 	.gem_create_object = vc4_create_object,
168 	.gem_free_object_unlocked = vc4_free_object,
169 	.gem_vm_ops = &drm_gem_cma_vm_ops,
170 
171 	.prime_handle_to_fd = drm_gem_prime_handle_to_fd,
172 	.prime_fd_to_handle = drm_gem_prime_fd_to_handle,
173 	.gem_prime_import = drm_gem_prime_import,
174 	.gem_prime_export = vc4_prime_export,
175 	.gem_prime_res_obj = vc4_prime_res_obj,
176 	.gem_prime_get_sg_table	= drm_gem_cma_prime_get_sg_table,
177 	.gem_prime_import_sg_table = vc4_prime_import_sg_table,
178 	.gem_prime_vmap = vc4_prime_vmap,
179 	.gem_prime_vunmap = drm_gem_cma_prime_vunmap,
180 	.gem_prime_mmap = vc4_prime_mmap,
181 
182 	.dumb_create = vc4_dumb_create,
183 
184 	.ioctls = vc4_drm_ioctls,
185 	.num_ioctls = ARRAY_SIZE(vc4_drm_ioctls),
186 	.fops = &vc4_drm_fops,
187 
188 	.name = DRIVER_NAME,
189 	.desc = DRIVER_DESC,
190 	.date = DRIVER_DATE,
191 	.major = DRIVER_MAJOR,
192 	.minor = DRIVER_MINOR,
193 	.patchlevel = DRIVER_PATCHLEVEL,
194 };
195 
196 static int compare_dev(struct device *dev, void *data)
197 {
198 	return dev == data;
199 }
200 
201 static void vc4_match_add_drivers(struct device *dev,
202 				  struct component_match **match,
203 				  struct platform_driver *const *drivers,
204 				  int count)
205 {
206 	int i;
207 
208 	for (i = 0; i < count; i++) {
209 		struct device_driver *drv = &drivers[i]->driver;
210 		struct device *p = NULL, *d;
211 
212 		while ((d = bus_find_device(&platform_bus_type, p, drv,
213 					    (void *)platform_bus_type.match))) {
214 			put_device(p);
215 			component_match_add(dev, match, compare_dev, d);
216 			p = d;
217 		}
218 		put_device(p);
219 	}
220 }
221 
222 static void vc4_kick_out_firmware_fb(void)
223 {
224 	struct apertures_struct *ap;
225 
226 	ap = alloc_apertures(1);
227 	if (!ap)
228 		return;
229 
230 	/* Since VC4 is a UMA device, the simplefb node may have been
231 	 * located anywhere in memory.
232 	 */
233 	ap->ranges[0].base = 0;
234 	ap->ranges[0].size = ~0;
235 
236 	drm_fb_helper_remove_conflicting_framebuffers(ap, "vc4drmfb", false);
237 	kfree(ap);
238 }
239 
240 static int vc4_drm_bind(struct device *dev)
241 {
242 	struct platform_device *pdev = to_platform_device(dev);
243 	struct drm_device *drm;
244 	struct vc4_dev *vc4;
245 	int ret = 0;
246 
247 	dev->coherent_dma_mask = DMA_BIT_MASK(32);
248 
249 	vc4 = devm_kzalloc(dev, sizeof(*vc4), GFP_KERNEL);
250 	if (!vc4)
251 		return -ENOMEM;
252 
253 	drm = drm_dev_alloc(&vc4_drm_driver, dev);
254 	if (IS_ERR(drm))
255 		return PTR_ERR(drm);
256 	platform_set_drvdata(pdev, drm);
257 	vc4->dev = drm;
258 	drm->dev_private = vc4;
259 
260 	ret = vc4_bo_cache_init(drm);
261 	if (ret)
262 		goto dev_unref;
263 
264 	drm_mode_config_init(drm);
265 
266 	vc4_gem_init(drm);
267 
268 	ret = component_bind_all(dev, drm);
269 	if (ret)
270 		goto gem_destroy;
271 
272 	vc4_kick_out_firmware_fb();
273 
274 	ret = drm_dev_register(drm, 0);
275 	if (ret < 0)
276 		goto unbind_all;
277 
278 	vc4_kms_load(drm);
279 
280 	return 0;
281 
282 unbind_all:
283 	component_unbind_all(dev, drm);
284 gem_destroy:
285 	vc4_gem_destroy(drm);
286 	vc4_bo_cache_destroy(drm);
287 dev_unref:
288 	drm_dev_unref(drm);
289 	return ret;
290 }
291 
292 static void vc4_drm_unbind(struct device *dev)
293 {
294 	struct platform_device *pdev = to_platform_device(dev);
295 	struct drm_device *drm = platform_get_drvdata(pdev);
296 	struct vc4_dev *vc4 = to_vc4_dev(drm);
297 
298 	drm_dev_unregister(drm);
299 
300 	if (vc4->fbdev)
301 		drm_fbdev_cma_fini(vc4->fbdev);
302 
303 	drm_mode_config_cleanup(drm);
304 
305 	drm_dev_unref(drm);
306 }
307 
308 static const struct component_master_ops vc4_drm_ops = {
309 	.bind = vc4_drm_bind,
310 	.unbind = vc4_drm_unbind,
311 };
312 
313 static struct platform_driver *const component_drivers[] = {
314 	&vc4_hdmi_driver,
315 	&vc4_vec_driver,
316 	&vc4_dpi_driver,
317 	&vc4_dsi_driver,
318 	&vc4_hvs_driver,
319 	&vc4_crtc_driver,
320 	&vc4_v3d_driver,
321 };
322 
323 static int vc4_platform_drm_probe(struct platform_device *pdev)
324 {
325 	struct component_match *match = NULL;
326 	struct device *dev = &pdev->dev;
327 
328 	vc4_match_add_drivers(dev, &match,
329 			      component_drivers, ARRAY_SIZE(component_drivers));
330 
331 	return component_master_add_with_match(dev, &vc4_drm_ops, match);
332 }
333 
334 static int vc4_platform_drm_remove(struct platform_device *pdev)
335 {
336 	component_master_del(&pdev->dev, &vc4_drm_ops);
337 
338 	return 0;
339 }
340 
341 static const struct of_device_id vc4_of_match[] = {
342 	{ .compatible = "brcm,bcm2835-vc4", },
343 	{ .compatible = "brcm,cygnus-vc4", },
344 	{},
345 };
346 MODULE_DEVICE_TABLE(of, vc4_of_match);
347 
348 static struct platform_driver vc4_platform_driver = {
349 	.probe		= vc4_platform_drm_probe,
350 	.remove		= vc4_platform_drm_remove,
351 	.driver		= {
352 		.name	= "vc4-drm",
353 		.of_match_table = vc4_of_match,
354 	},
355 };
356 
357 static int __init vc4_drm_register(void)
358 {
359 	int ret;
360 
361 	ret = platform_register_drivers(component_drivers,
362 					ARRAY_SIZE(component_drivers));
363 	if (ret)
364 		return ret;
365 
366 	return platform_driver_register(&vc4_platform_driver);
367 }
368 
369 static void __exit vc4_drm_unregister(void)
370 {
371 	platform_unregister_drivers(component_drivers,
372 				    ARRAY_SIZE(component_drivers));
373 	platform_driver_unregister(&vc4_platform_driver);
374 }
375 
376 module_init(vc4_drm_register);
377 module_exit(vc4_drm_unregister);
378 
379 MODULE_ALIAS("platform:vc4-drm");
380 MODULE_DESCRIPTION("Broadcom VC4 DRM Driver");
381 MODULE_AUTHOR("Eric Anholt <eric@anholt.net>");
382 MODULE_LICENSE("GPL v2");
383