xref: /openbmc/linux/drivers/gpu/drm/vc4/vc4_drv.c (revision 35267cea)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Copyright (C) 2014-2015 Broadcom
4  * Copyright (C) 2013 Red Hat
5  */
6 
7 /**
8  * DOC: Broadcom VC4 Graphics Driver
9  *
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.
14  *
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
20  * driver.
21  */
22 
23 #include <linux/clk.h>
24 #include <linux/component.h>
25 #include <linux/device.h>
26 #include <linux/dma-mapping.h>
27 #include <linux/io.h>
28 #include <linux/module.h>
29 #include <linux/of_platform.h>
30 #include <linux/platform_device.h>
31 #include <linux/pm_runtime.h>
32 
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>
39 
40 #include "uapi/drm/vc4_drm.h"
41 
42 #include "vc4_drv.h"
43 #include "vc4_regs.h"
44 
45 #define DRIVER_NAME "vc4"
46 #define DRIVER_DESC "Broadcom VC4 graphics"
47 #define DRIVER_DATE "20140616"
48 #define DRIVER_MAJOR 0
49 #define DRIVER_MINOR 0
50 #define DRIVER_PATCHLEVEL 0
51 
52 /* Helper function for mapping the regs on a platform device. */
53 void __iomem *vc4_ioremap_regs(struct platform_device *dev, int index)
54 {
55 	struct resource *res;
56 	void __iomem *map;
57 
58 	res = platform_get_resource(dev, IORESOURCE_MEM, index);
59 	map = devm_ioremap_resource(&dev->dev, res);
60 	if (IS_ERR(map))
61 		return map;
62 
63 	return map;
64 }
65 
66 static int vc4_get_param_ioctl(struct drm_device *dev, void *data,
67 			       struct drm_file *file_priv)
68 {
69 	struct vc4_dev *vc4 = to_vc4_dev(dev);
70 	struct drm_vc4_get_param *args = data;
71 	int ret;
72 
73 	if (args->pad != 0)
74 		return -EINVAL;
75 
76 	if (!vc4->v3d)
77 		return -ENODEV;
78 
79 	switch (args->param) {
80 	case DRM_VC4_PARAM_V3D_IDENT0:
81 		ret = vc4_v3d_pm_get(vc4);
82 		if (ret)
83 			return ret;
84 		args->value = V3D_READ(V3D_IDENT0);
85 		vc4_v3d_pm_put(vc4);
86 		break;
87 	case DRM_VC4_PARAM_V3D_IDENT1:
88 		ret = vc4_v3d_pm_get(vc4);
89 		if (ret)
90 			return ret;
91 		args->value = V3D_READ(V3D_IDENT1);
92 		vc4_v3d_pm_put(vc4);
93 		break;
94 	case DRM_VC4_PARAM_V3D_IDENT2:
95 		ret = vc4_v3d_pm_get(vc4);
96 		if (ret)
97 			return ret;
98 		args->value = V3D_READ(V3D_IDENT2);
99 		vc4_v3d_pm_put(vc4);
100 		break;
101 	case DRM_VC4_PARAM_SUPPORTS_BRANCHES:
102 	case DRM_VC4_PARAM_SUPPORTS_ETC1:
103 	case DRM_VC4_PARAM_SUPPORTS_THREADED_FS:
104 	case DRM_VC4_PARAM_SUPPORTS_FIXED_RCL_ORDER:
105 	case DRM_VC4_PARAM_SUPPORTS_MADVISE:
106 	case DRM_VC4_PARAM_SUPPORTS_PERFMON:
107 		args->value = true;
108 		break;
109 	default:
110 		DRM_DEBUG("Unknown parameter %d\n", args->param);
111 		return -EINVAL;
112 	}
113 
114 	return 0;
115 }
116 
117 static int vc4_open(struct drm_device *dev, struct drm_file *file)
118 {
119 	struct vc4_file *vc4file;
120 
121 	vc4file = kzalloc(sizeof(*vc4file), GFP_KERNEL);
122 	if (!vc4file)
123 		return -ENOMEM;
124 
125 	vc4_perfmon_open_file(vc4file);
126 	file->driver_priv = vc4file;
127 	return 0;
128 }
129 
130 static void vc4_close(struct drm_device *dev, struct drm_file *file)
131 {
132 	struct vc4_dev *vc4 = to_vc4_dev(dev);
133 	struct vc4_file *vc4file = file->driver_priv;
134 
135 	if (vc4file->bin_bo_used)
136 		vc4_v3d_bin_bo_put(vc4);
137 
138 	vc4_perfmon_close_file(vc4file);
139 	kfree(vc4file);
140 }
141 
142 DEFINE_DRM_GEM_FOPS(vc4_drm_fops);
143 
144 static const struct drm_ioctl_desc vc4_drm_ioctls[] = {
145 	DRM_IOCTL_DEF_DRV(VC4_SUBMIT_CL, vc4_submit_cl_ioctl, DRM_RENDER_ALLOW),
146 	DRM_IOCTL_DEF_DRV(VC4_WAIT_SEQNO, vc4_wait_seqno_ioctl, DRM_RENDER_ALLOW),
147 	DRM_IOCTL_DEF_DRV(VC4_WAIT_BO, vc4_wait_bo_ioctl, DRM_RENDER_ALLOW),
148 	DRM_IOCTL_DEF_DRV(VC4_CREATE_BO, vc4_create_bo_ioctl, DRM_RENDER_ALLOW),
149 	DRM_IOCTL_DEF_DRV(VC4_MMAP_BO, vc4_mmap_bo_ioctl, DRM_RENDER_ALLOW),
150 	DRM_IOCTL_DEF_DRV(VC4_CREATE_SHADER_BO, vc4_create_shader_bo_ioctl, DRM_RENDER_ALLOW),
151 	DRM_IOCTL_DEF_DRV(VC4_GET_HANG_STATE, vc4_get_hang_state_ioctl,
152 			  DRM_ROOT_ONLY),
153 	DRM_IOCTL_DEF_DRV(VC4_GET_PARAM, vc4_get_param_ioctl, DRM_RENDER_ALLOW),
154 	DRM_IOCTL_DEF_DRV(VC4_SET_TILING, vc4_set_tiling_ioctl, DRM_RENDER_ALLOW),
155 	DRM_IOCTL_DEF_DRV(VC4_GET_TILING, vc4_get_tiling_ioctl, DRM_RENDER_ALLOW),
156 	DRM_IOCTL_DEF_DRV(VC4_LABEL_BO, vc4_label_bo_ioctl, DRM_RENDER_ALLOW),
157 	DRM_IOCTL_DEF_DRV(VC4_GEM_MADVISE, vc4_gem_madvise_ioctl, DRM_RENDER_ALLOW),
158 	DRM_IOCTL_DEF_DRV(VC4_PERFMON_CREATE, vc4_perfmon_create_ioctl, DRM_RENDER_ALLOW),
159 	DRM_IOCTL_DEF_DRV(VC4_PERFMON_DESTROY, vc4_perfmon_destroy_ioctl, DRM_RENDER_ALLOW),
160 	DRM_IOCTL_DEF_DRV(VC4_PERFMON_GET_VALUES, vc4_perfmon_get_values_ioctl, DRM_RENDER_ALLOW),
161 };
162 
163 static struct drm_driver vc4_drm_driver = {
164 	.driver_features = (DRIVER_MODESET |
165 			    DRIVER_ATOMIC |
166 			    DRIVER_GEM |
167 			    DRIVER_RENDER |
168 			    DRIVER_SYNCOBJ),
169 	.open = vc4_open,
170 	.postclose = vc4_close,
171 	.irq_handler = vc4_irq,
172 	.irq_preinstall = vc4_irq_preinstall,
173 	.irq_postinstall = vc4_irq_postinstall,
174 	.irq_uninstall = vc4_irq_uninstall,
175 
176 #if defined(CONFIG_DEBUG_FS)
177 	.debugfs_init = vc4_debugfs_init,
178 #endif
179 
180 	.gem_create_object = vc4_create_object,
181 
182 	DRM_GEM_CMA_DRIVER_OPS_WITH_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 = platform_find_device_by_driver(p, drv))) {
213 			put_device(p);
214 			component_match_add(dev, match, compare_dev, d);
215 			p = d;
216 		}
217 		put_device(p);
218 	}
219 }
220 
221 static int vc4_drm_bind(struct device *dev)
222 {
223 	struct platform_device *pdev = to_platform_device(dev);
224 	struct drm_device *drm;
225 	struct vc4_dev *vc4;
226 	struct device_node *node;
227 	struct drm_crtc *crtc;
228 	int ret = 0;
229 
230 	dev->coherent_dma_mask = DMA_BIT_MASK(32);
231 
232 	/* If VC4 V3D is missing, don't advertise render nodes. */
233 	node = of_find_matching_node_and_match(NULL, vc4_v3d_dt_match, NULL);
234 	if (!node || !of_device_is_available(node))
235 		vc4_drm_driver.driver_features &= ~DRIVER_RENDER;
236 	of_node_put(node);
237 
238 	vc4 = devm_drm_dev_alloc(dev, &vc4_drm_driver, struct vc4_dev, base);
239 	if (IS_ERR(vc4))
240 		return PTR_ERR(vc4);
241 
242 	drm = &vc4->base;
243 	platform_set_drvdata(pdev, drm);
244 	INIT_LIST_HEAD(&vc4->debugfs_list);
245 
246 	mutex_init(&vc4->bin_bo_lock);
247 
248 	ret = vc4_bo_cache_init(drm);
249 	if (ret)
250 		return ret;
251 
252 	ret = drmm_mode_config_init(drm);
253 	if (ret)
254 		return ret;
255 
256 	ret = vc4_gem_init(drm);
257 	if (ret)
258 		return ret;
259 
260 	ret = component_bind_all(dev, drm);
261 	if (ret)
262 		return ret;
263 
264 	ret = vc4_plane_create_additional_planes(drm);
265 	if (ret)
266 		goto unbind_all;
267 
268 	ret = drm_aperture_remove_framebuffers(false, "vc4drmfb");
269 	if (ret)
270 		goto unbind_all;
271 
272 	ret = vc4_kms_load(drm);
273 	if (ret < 0)
274 		goto unbind_all;
275 
276 	drm_for_each_crtc(crtc, drm)
277 		vc4_crtc_disable_at_boot(crtc);
278 
279 	ret = drm_dev_register(drm, 0);
280 	if (ret < 0)
281 		goto unbind_all;
282 
283 	drm_fbdev_generic_setup(drm, 16);
284 
285 	return 0;
286 
287 unbind_all:
288 	component_unbind_all(dev, drm);
289 
290 	return ret;
291 }
292 
293 static void vc4_drm_unbind(struct device *dev)
294 {
295 	struct drm_device *drm = dev_get_drvdata(dev);
296 
297 	drm_dev_unregister(drm);
298 
299 	drm_atomic_helper_shutdown(drm);
300 }
301 
302 static const struct component_master_ops vc4_drm_ops = {
303 	.bind = vc4_drm_bind,
304 	.unbind = vc4_drm_unbind,
305 };
306 
307 /*
308  * This list determines the binding order of our components, and we have
309  * a few constraints:
310  *   - The TXP driver needs to be bound before the PixelValves (CRTC)
311  *     but after the HVS to set the possible_crtc field properly
312  *   - The HDMI driver needs to be bound after the HVS so that we can
313  *     lookup the HVS maximum core clock rate and figure out if we
314  *     support 4kp60 or not.
315  */
316 static struct platform_driver *const component_drivers[] = {
317 	&vc4_hvs_driver,
318 	&vc4_hdmi_driver,
319 	&vc4_vec_driver,
320 	&vc4_dpi_driver,
321 	&vc4_dsi_driver,
322 	&vc4_txp_driver,
323 	&vc4_crtc_driver,
324 	&vc4_v3d_driver,
325 };
326 
327 static int vc4_platform_drm_probe(struct platform_device *pdev)
328 {
329 	struct component_match *match = NULL;
330 	struct device *dev = &pdev->dev;
331 
332 	vc4_match_add_drivers(dev, &match,
333 			      component_drivers, ARRAY_SIZE(component_drivers));
334 
335 	return component_master_add_with_match(dev, &vc4_drm_ops, match);
336 }
337 
338 static int vc4_platform_drm_remove(struct platform_device *pdev)
339 {
340 	component_master_del(&pdev->dev, &vc4_drm_ops);
341 
342 	return 0;
343 }
344 
345 static const struct of_device_id vc4_of_match[] = {
346 	{ .compatible = "brcm,bcm2711-vc5", },
347 	{ .compatible = "brcm,bcm2835-vc4", },
348 	{ .compatible = "brcm,cygnus-vc4", },
349 	{},
350 };
351 MODULE_DEVICE_TABLE(of, vc4_of_match);
352 
353 static struct platform_driver vc4_platform_driver = {
354 	.probe		= vc4_platform_drm_probe,
355 	.remove		= vc4_platform_drm_remove,
356 	.driver		= {
357 		.name	= "vc4-drm",
358 		.of_match_table = vc4_of_match,
359 	},
360 };
361 
362 static int __init vc4_drm_register(void)
363 {
364 	int ret;
365 
366 	ret = platform_register_drivers(component_drivers,
367 					ARRAY_SIZE(component_drivers));
368 	if (ret)
369 		return ret;
370 
371 	return platform_driver_register(&vc4_platform_driver);
372 }
373 
374 static void __exit vc4_drm_unregister(void)
375 {
376 	platform_unregister_drivers(component_drivers,
377 				    ARRAY_SIZE(component_drivers));
378 	platform_driver_unregister(&vc4_platform_driver);
379 }
380 
381 module_init(vc4_drm_register);
382 module_exit(vc4_drm_unregister);
383 
384 MODULE_ALIAS("platform:vc4-drm");
385 MODULE_DESCRIPTION("Broadcom VC4 DRM Driver");
386 MODULE_AUTHOR("Eric Anholt <eric@anholt.net>");
387 MODULE_LICENSE("GPL v2");
388