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