xref: /openbmc/linux/drivers/gpu/drm/vc4/vc4_drv.c (revision b7019ac5)
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 #include <drm/drm_atomic_helper.h>
37 
38 #include "uapi/drm/vc4_drm.h"
39 #include "vc4_drv.h"
40 #include "vc4_regs.h"
41 
42 #define DRIVER_NAME "vc4"
43 #define DRIVER_DESC "Broadcom VC4 graphics"
44 #define DRIVER_DATE "20140616"
45 #define DRIVER_MAJOR 0
46 #define DRIVER_MINOR 0
47 #define DRIVER_PATCHLEVEL 0
48 
49 /* Helper function for mapping the regs on a platform device. */
50 void __iomem *vc4_ioremap_regs(struct platform_device *dev, int index)
51 {
52 	struct resource *res;
53 	void __iomem *map;
54 
55 	res = platform_get_resource(dev, IORESOURCE_MEM, index);
56 	map = devm_ioremap_resource(&dev->dev, res);
57 	if (IS_ERR(map)) {
58 		DRM_ERROR("Failed to map registers: %ld\n", PTR_ERR(map));
59 		return map;
60 	}
61 
62 	return map;
63 }
64 
65 static int vc4_get_param_ioctl(struct drm_device *dev, void *data,
66 			       struct drm_file *file_priv)
67 {
68 	struct vc4_dev *vc4 = to_vc4_dev(dev);
69 	struct drm_vc4_get_param *args = data;
70 	int ret;
71 
72 	if (args->pad != 0)
73 		return -EINVAL;
74 
75 	if (!vc4->v3d)
76 		return -ENODEV;
77 
78 	switch (args->param) {
79 	case DRM_VC4_PARAM_V3D_IDENT0:
80 		ret = vc4_v3d_pm_get(vc4);
81 		if (ret)
82 			return ret;
83 		args->value = V3D_READ(V3D_IDENT0);
84 		vc4_v3d_pm_put(vc4);
85 		break;
86 	case DRM_VC4_PARAM_V3D_IDENT1:
87 		ret = vc4_v3d_pm_get(vc4);
88 		if (ret)
89 			return ret;
90 		args->value = V3D_READ(V3D_IDENT1);
91 		vc4_v3d_pm_put(vc4);
92 		break;
93 	case DRM_VC4_PARAM_V3D_IDENT2:
94 		ret = vc4_v3d_pm_get(vc4);
95 		if (ret)
96 			return ret;
97 		args->value = V3D_READ(V3D_IDENT2);
98 		vc4_v3d_pm_put(vc4);
99 		break;
100 	case DRM_VC4_PARAM_SUPPORTS_BRANCHES:
101 	case DRM_VC4_PARAM_SUPPORTS_ETC1:
102 	case DRM_VC4_PARAM_SUPPORTS_THREADED_FS:
103 	case DRM_VC4_PARAM_SUPPORTS_FIXED_RCL_ORDER:
104 	case DRM_VC4_PARAM_SUPPORTS_MADVISE:
105 	case DRM_VC4_PARAM_SUPPORTS_PERFMON:
106 		args->value = true;
107 		break;
108 	default:
109 		DRM_DEBUG("Unknown parameter %d\n", args->param);
110 		return -EINVAL;
111 	}
112 
113 	return 0;
114 }
115 
116 static int vc4_open(struct drm_device *dev, struct drm_file *file)
117 {
118 	struct vc4_file *vc4file;
119 
120 	vc4file = kzalloc(sizeof(*vc4file), GFP_KERNEL);
121 	if (!vc4file)
122 		return -ENOMEM;
123 
124 	vc4_perfmon_open_file(vc4file);
125 	file->driver_priv = vc4file;
126 	return 0;
127 }
128 
129 static void vc4_close(struct drm_device *dev, struct drm_file *file)
130 {
131 	struct vc4_dev *vc4 = to_vc4_dev(dev);
132 	struct vc4_file *vc4file = file->driver_priv;
133 
134 	if (vc4file->bin_bo_used)
135 		vc4_v3d_bin_bo_put(vc4);
136 
137 	vc4_perfmon_close_file(vc4file);
138 	kfree(vc4file);
139 }
140 
141 static const struct vm_operations_struct vc4_vm_ops = {
142 	.fault = vc4_fault,
143 	.open = drm_gem_vm_open,
144 	.close = drm_gem_vm_close,
145 };
146 
147 static const struct file_operations vc4_drm_fops = {
148 	.owner = THIS_MODULE,
149 	.open = drm_open,
150 	.release = drm_release,
151 	.unlocked_ioctl = drm_ioctl,
152 	.mmap = vc4_mmap,
153 	.poll = drm_poll,
154 	.read = drm_read,
155 	.compat_ioctl = drm_compat_ioctl,
156 	.llseek = noop_llseek,
157 };
158 
159 static const struct drm_ioctl_desc vc4_drm_ioctls[] = {
160 	DRM_IOCTL_DEF_DRV(VC4_SUBMIT_CL, vc4_submit_cl_ioctl, DRM_RENDER_ALLOW),
161 	DRM_IOCTL_DEF_DRV(VC4_WAIT_SEQNO, vc4_wait_seqno_ioctl, DRM_RENDER_ALLOW),
162 	DRM_IOCTL_DEF_DRV(VC4_WAIT_BO, vc4_wait_bo_ioctl, DRM_RENDER_ALLOW),
163 	DRM_IOCTL_DEF_DRV(VC4_CREATE_BO, vc4_create_bo_ioctl, DRM_RENDER_ALLOW),
164 	DRM_IOCTL_DEF_DRV(VC4_MMAP_BO, vc4_mmap_bo_ioctl, DRM_RENDER_ALLOW),
165 	DRM_IOCTL_DEF_DRV(VC4_CREATE_SHADER_BO, vc4_create_shader_bo_ioctl, DRM_RENDER_ALLOW),
166 	DRM_IOCTL_DEF_DRV(VC4_GET_HANG_STATE, vc4_get_hang_state_ioctl,
167 			  DRM_ROOT_ONLY),
168 	DRM_IOCTL_DEF_DRV(VC4_GET_PARAM, vc4_get_param_ioctl, DRM_RENDER_ALLOW),
169 	DRM_IOCTL_DEF_DRV(VC4_SET_TILING, vc4_set_tiling_ioctl, DRM_RENDER_ALLOW),
170 	DRM_IOCTL_DEF_DRV(VC4_GET_TILING, vc4_get_tiling_ioctl, DRM_RENDER_ALLOW),
171 	DRM_IOCTL_DEF_DRV(VC4_LABEL_BO, vc4_label_bo_ioctl, DRM_RENDER_ALLOW),
172 	DRM_IOCTL_DEF_DRV(VC4_GEM_MADVISE, vc4_gem_madvise_ioctl, DRM_RENDER_ALLOW),
173 	DRM_IOCTL_DEF_DRV(VC4_PERFMON_CREATE, vc4_perfmon_create_ioctl, DRM_RENDER_ALLOW),
174 	DRM_IOCTL_DEF_DRV(VC4_PERFMON_DESTROY, vc4_perfmon_destroy_ioctl, DRM_RENDER_ALLOW),
175 	DRM_IOCTL_DEF_DRV(VC4_PERFMON_GET_VALUES, vc4_perfmon_get_values_ioctl, DRM_RENDER_ALLOW),
176 };
177 
178 static struct drm_driver vc4_drm_driver = {
179 	.driver_features = (DRIVER_MODESET |
180 			    DRIVER_ATOMIC |
181 			    DRIVER_GEM |
182 			    DRIVER_RENDER |
183 			    DRIVER_PRIME |
184 			    DRIVER_SYNCOBJ),
185 	.open = vc4_open,
186 	.postclose = vc4_close,
187 	.irq_handler = vc4_irq,
188 	.irq_preinstall = vc4_irq_preinstall,
189 	.irq_postinstall = vc4_irq_postinstall,
190 	.irq_uninstall = vc4_irq_uninstall,
191 
192 	.get_scanout_position = vc4_crtc_get_scanoutpos,
193 	.get_vblank_timestamp = drm_calc_vbltimestamp_from_scanoutpos,
194 
195 #if defined(CONFIG_DEBUG_FS)
196 	.debugfs_init = vc4_debugfs_init,
197 #endif
198 
199 	.gem_create_object = vc4_create_object,
200 	.gem_free_object_unlocked = vc4_free_object,
201 	.gem_vm_ops = &vc4_vm_ops,
202 
203 	.prime_handle_to_fd = drm_gem_prime_handle_to_fd,
204 	.prime_fd_to_handle = drm_gem_prime_fd_to_handle,
205 	.gem_prime_import = drm_gem_prime_import,
206 	.gem_prime_export = vc4_prime_export,
207 	.gem_prime_get_sg_table	= drm_gem_cma_prime_get_sg_table,
208 	.gem_prime_import_sg_table = vc4_prime_import_sg_table,
209 	.gem_prime_vmap = vc4_prime_vmap,
210 	.gem_prime_vunmap = drm_gem_cma_prime_vunmap,
211 	.gem_prime_mmap = vc4_prime_mmap,
212 
213 	.dumb_create = vc4_dumb_create,
214 
215 	.ioctls = vc4_drm_ioctls,
216 	.num_ioctls = ARRAY_SIZE(vc4_drm_ioctls),
217 	.fops = &vc4_drm_fops,
218 
219 	.name = DRIVER_NAME,
220 	.desc = DRIVER_DESC,
221 	.date = DRIVER_DATE,
222 	.major = DRIVER_MAJOR,
223 	.minor = DRIVER_MINOR,
224 	.patchlevel = DRIVER_PATCHLEVEL,
225 };
226 
227 static int compare_dev(struct device *dev, void *data)
228 {
229 	return dev == data;
230 }
231 
232 static void vc4_match_add_drivers(struct device *dev,
233 				  struct component_match **match,
234 				  struct platform_driver *const *drivers,
235 				  int count)
236 {
237 	int i;
238 
239 	for (i = 0; i < count; i++) {
240 		struct device_driver *drv = &drivers[i]->driver;
241 		struct device *p = NULL, *d;
242 
243 		while ((d = bus_find_device(&platform_bus_type, p, drv,
244 					    (void *)platform_bus_type.match))) {
245 			put_device(p);
246 			component_match_add(dev, match, compare_dev, d);
247 			p = d;
248 		}
249 		put_device(p);
250 	}
251 }
252 
253 static int vc4_drm_bind(struct device *dev)
254 {
255 	struct platform_device *pdev = to_platform_device(dev);
256 	struct drm_device *drm;
257 	struct vc4_dev *vc4;
258 	struct device_node *node;
259 	int ret = 0;
260 
261 	dev->coherent_dma_mask = DMA_BIT_MASK(32);
262 
263 	vc4 = devm_kzalloc(dev, sizeof(*vc4), GFP_KERNEL);
264 	if (!vc4)
265 		return -ENOMEM;
266 
267 	/* If VC4 V3D is missing, don't advertise render nodes. */
268 	node = of_find_matching_node_and_match(NULL, vc4_v3d_dt_match, NULL);
269 	if (!node || !of_device_is_available(node))
270 		vc4_drm_driver.driver_features &= ~DRIVER_RENDER;
271 	of_node_put(node);
272 
273 	drm = drm_dev_alloc(&vc4_drm_driver, dev);
274 	if (IS_ERR(drm))
275 		return PTR_ERR(drm);
276 	platform_set_drvdata(pdev, drm);
277 	vc4->dev = drm;
278 	drm->dev_private = vc4;
279 	INIT_LIST_HEAD(&vc4->debugfs_list);
280 
281 	mutex_init(&vc4->bin_bo_lock);
282 
283 	ret = vc4_bo_cache_init(drm);
284 	if (ret)
285 		goto dev_put;
286 
287 	drm_mode_config_init(drm);
288 
289 	vc4_gem_init(drm);
290 
291 	ret = component_bind_all(dev, drm);
292 	if (ret)
293 		goto gem_destroy;
294 
295 	drm_fb_helper_remove_conflicting_framebuffers(NULL, "vc4drmfb", false);
296 
297 	ret = vc4_kms_load(drm);
298 	if (ret < 0)
299 		goto unbind_all;
300 
301 	ret = drm_dev_register(drm, 0);
302 	if (ret < 0)
303 		goto unbind_all;
304 
305 	drm_fbdev_generic_setup(drm, 16);
306 
307 	return 0;
308 
309 unbind_all:
310 	component_unbind_all(dev, drm);
311 gem_destroy:
312 	vc4_gem_destroy(drm);
313 	vc4_bo_cache_destroy(drm);
314 dev_put:
315 	drm_dev_put(drm);
316 	return ret;
317 }
318 
319 static void vc4_drm_unbind(struct device *dev)
320 {
321 	struct drm_device *drm = dev_get_drvdata(dev);
322 	struct vc4_dev *vc4 = to_vc4_dev(drm);
323 
324 	drm_dev_unregister(drm);
325 
326 	drm_atomic_helper_shutdown(drm);
327 
328 	drm_mode_config_cleanup(drm);
329 
330 	drm_atomic_private_obj_fini(&vc4->load_tracker);
331 	drm_atomic_private_obj_fini(&vc4->ctm_manager);
332 
333 	drm_dev_put(drm);
334 }
335 
336 static const struct component_master_ops vc4_drm_ops = {
337 	.bind = vc4_drm_bind,
338 	.unbind = vc4_drm_unbind,
339 };
340 
341 static struct platform_driver *const component_drivers[] = {
342 	&vc4_hdmi_driver,
343 	&vc4_vec_driver,
344 	&vc4_dpi_driver,
345 	&vc4_dsi_driver,
346 	&vc4_txp_driver,
347 	&vc4_hvs_driver,
348 	&vc4_crtc_driver,
349 	&vc4_v3d_driver,
350 };
351 
352 static int vc4_platform_drm_probe(struct platform_device *pdev)
353 {
354 	struct component_match *match = NULL;
355 	struct device *dev = &pdev->dev;
356 
357 	vc4_match_add_drivers(dev, &match,
358 			      component_drivers, ARRAY_SIZE(component_drivers));
359 
360 	return component_master_add_with_match(dev, &vc4_drm_ops, match);
361 }
362 
363 static int vc4_platform_drm_remove(struct platform_device *pdev)
364 {
365 	component_master_del(&pdev->dev, &vc4_drm_ops);
366 
367 	return 0;
368 }
369 
370 static const struct of_device_id vc4_of_match[] = {
371 	{ .compatible = "brcm,bcm2835-vc4", },
372 	{ .compatible = "brcm,cygnus-vc4", },
373 	{},
374 };
375 MODULE_DEVICE_TABLE(of, vc4_of_match);
376 
377 static struct platform_driver vc4_platform_driver = {
378 	.probe		= vc4_platform_drm_probe,
379 	.remove		= vc4_platform_drm_remove,
380 	.driver		= {
381 		.name	= "vc4-drm",
382 		.of_match_table = vc4_of_match,
383 	},
384 };
385 
386 static int __init vc4_drm_register(void)
387 {
388 	int ret;
389 
390 	ret = platform_register_drivers(component_drivers,
391 					ARRAY_SIZE(component_drivers));
392 	if (ret)
393 		return ret;
394 
395 	return platform_driver_register(&vc4_platform_driver);
396 }
397 
398 static void __exit vc4_drm_unregister(void)
399 {
400 	platform_unregister_drivers(component_drivers,
401 				    ARRAY_SIZE(component_drivers));
402 	platform_driver_unregister(&vc4_platform_driver);
403 }
404 
405 module_init(vc4_drm_register);
406 module_exit(vc4_drm_unregister);
407 
408 MODULE_ALIAS("platform:vc4-drm");
409 MODULE_DESCRIPTION("Broadcom VC4 DRM Driver");
410 MODULE_AUTHOR("Eric Anholt <eric@anholt.net>");
411 MODULE_LICENSE("GPL v2");
412