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. */
 49void __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
 64static 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	case DRM_VC4_PARAM_SUPPORTS_MADVISE:
104	case DRM_VC4_PARAM_SUPPORTS_PERFMON:
105		args->value = true;
106		break;
107	default:
108		DRM_DEBUG("Unknown parameter %d\n", args->param);
109		return -EINVAL;
110	}
111
112	return 0;
113}
114
115static int vc4_open(struct drm_device *dev, struct drm_file *file)
116{
117	struct vc4_file *vc4file;
118
119	vc4file = kzalloc(sizeof(*vc4file), GFP_KERNEL);
120	if (!vc4file)
121		return -ENOMEM;
122
123	vc4_perfmon_open_file(vc4file);
124	file->driver_priv = vc4file;
125	return 0;
126}
127
128static void vc4_close(struct drm_device *dev, struct drm_file *file)
129{
130	struct vc4_file *vc4file = file->driver_priv;
131
132	vc4_perfmon_close_file(vc4file);
133	kfree(vc4file);
134}
135
136static const struct vm_operations_struct vc4_vm_ops = {
137	.fault = vc4_fault,
138	.open = drm_gem_vm_open,
139	.close = drm_gem_vm_close,
140};
141
142static const struct file_operations vc4_drm_fops = {
143	.owner = THIS_MODULE,
144	.open = drm_open,
145	.release = drm_release,
146	.unlocked_ioctl = drm_ioctl,
147	.mmap = vc4_mmap,
148	.poll = drm_poll,
149	.read = drm_read,
150	.compat_ioctl = drm_compat_ioctl,
151	.llseek = noop_llseek,
152};
153
154static const struct drm_ioctl_desc vc4_drm_ioctls[] = {
155	DRM_IOCTL_DEF_DRV(VC4_SUBMIT_CL, vc4_submit_cl_ioctl, DRM_RENDER_ALLOW),
156	DRM_IOCTL_DEF_DRV(VC4_WAIT_SEQNO, vc4_wait_seqno_ioctl, DRM_RENDER_ALLOW),
157	DRM_IOCTL_DEF_DRV(VC4_WAIT_BO, vc4_wait_bo_ioctl, DRM_RENDER_ALLOW),
158	DRM_IOCTL_DEF_DRV(VC4_CREATE_BO, vc4_create_bo_ioctl, DRM_RENDER_ALLOW),
159	DRM_IOCTL_DEF_DRV(VC4_MMAP_BO, vc4_mmap_bo_ioctl, DRM_RENDER_ALLOW),
160	DRM_IOCTL_DEF_DRV(VC4_CREATE_SHADER_BO, vc4_create_shader_bo_ioctl, DRM_RENDER_ALLOW),
161	DRM_IOCTL_DEF_DRV(VC4_GET_HANG_STATE, vc4_get_hang_state_ioctl,
162			  DRM_ROOT_ONLY),
163	DRM_IOCTL_DEF_DRV(VC4_GET_PARAM, vc4_get_param_ioctl, DRM_RENDER_ALLOW),
164	DRM_IOCTL_DEF_DRV(VC4_SET_TILING, vc4_set_tiling_ioctl, DRM_RENDER_ALLOW),
165	DRM_IOCTL_DEF_DRV(VC4_GET_TILING, vc4_get_tiling_ioctl, DRM_RENDER_ALLOW),
166	DRM_IOCTL_DEF_DRV(VC4_LABEL_BO, vc4_label_bo_ioctl, DRM_RENDER_ALLOW),
167	DRM_IOCTL_DEF_DRV(VC4_GEM_MADVISE, vc4_gem_madvise_ioctl, DRM_RENDER_ALLOW),
168	DRM_IOCTL_DEF_DRV(VC4_PERFMON_CREATE, vc4_perfmon_create_ioctl, DRM_RENDER_ALLOW),
169	DRM_IOCTL_DEF_DRV(VC4_PERFMON_DESTROY, vc4_perfmon_destroy_ioctl, DRM_RENDER_ALLOW),
170	DRM_IOCTL_DEF_DRV(VC4_PERFMON_GET_VALUES, vc4_perfmon_get_values_ioctl, DRM_RENDER_ALLOW),
171};
172
173static struct drm_driver vc4_drm_driver = {
174	.driver_features = (DRIVER_MODESET |
175			    DRIVER_ATOMIC |
176			    DRIVER_GEM |
177			    DRIVER_HAVE_IRQ |
178			    DRIVER_RENDER |
179			    DRIVER_PRIME),
180	.lastclose = drm_fb_helper_lastclose,
181	.open = vc4_open,
182	.postclose = vc4_close,
183	.irq_handler = vc4_irq,
184	.irq_preinstall = vc4_irq_preinstall,
185	.irq_postinstall = vc4_irq_postinstall,
186	.irq_uninstall = vc4_irq_uninstall,
187
188	.get_scanout_position = vc4_crtc_get_scanoutpos,
189	.get_vblank_timestamp = drm_calc_vbltimestamp_from_scanoutpos,
190
191#if defined(CONFIG_DEBUG_FS)
192	.debugfs_init = vc4_debugfs_init,
193#endif
194
195	.gem_create_object = vc4_create_object,
196	.gem_free_object_unlocked = vc4_free_object,
197	.gem_vm_ops = &vc4_vm_ops,
198
199	.prime_handle_to_fd = drm_gem_prime_handle_to_fd,
200	.prime_fd_to_handle = drm_gem_prime_fd_to_handle,
201	.gem_prime_import = drm_gem_prime_import,
202	.gem_prime_export = vc4_prime_export,
203	.gem_prime_res_obj = vc4_prime_res_obj,
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 = bus_find_device(&platform_bus_type, p, drv,
241					    (void *)platform_bus_type.match))) {
242			put_device(p);
243			component_match_add(dev, match, compare_dev, d);
244			p = d;
245		}
246		put_device(p);
247	}
248}
249
250static void vc4_kick_out_firmware_fb(void)
251{
252	struct apertures_struct *ap;
253
254	ap = alloc_apertures(1);
255	if (!ap)
256		return;
257
258	/* Since VC4 is a UMA device, the simplefb node may have been
259	 * located anywhere in memory.
260	 */
261	ap->ranges[0].base = 0;
262	ap->ranges[0].size = ~0;
263
264	drm_fb_helper_remove_conflicting_framebuffers(ap, "vc4drmfb", false);
265	kfree(ap);
266}
267
268static int vc4_drm_bind(struct device *dev)
269{
270	struct platform_device *pdev = to_platform_device(dev);
271	struct drm_device *drm;
272	struct vc4_dev *vc4;
273	int ret = 0;
274
275	dev->coherent_dma_mask = DMA_BIT_MASK(32);
276
277	vc4 = devm_kzalloc(dev, sizeof(*vc4), GFP_KERNEL);
278	if (!vc4)
279		return -ENOMEM;
280
281	drm = drm_dev_alloc(&vc4_drm_driver, dev);
282	if (IS_ERR(drm))
283		return PTR_ERR(drm);
284	platform_set_drvdata(pdev, drm);
285	vc4->dev = drm;
286	drm->dev_private = vc4;
287
288	ret = vc4_bo_cache_init(drm);
289	if (ret)
290		goto dev_unref;
291
292	drm_mode_config_init(drm);
293
294	vc4_gem_init(drm);
295
296	ret = component_bind_all(dev, drm);
297	if (ret)
298		goto gem_destroy;
299
300	vc4_kick_out_firmware_fb();
301
302	ret = drm_dev_register(drm, 0);
303	if (ret < 0)
304		goto unbind_all;
305
306	vc4_kms_load(drm);
307
308	return 0;
309
310unbind_all:
311	component_unbind_all(dev, drm);
312gem_destroy:
313	vc4_gem_destroy(drm);
314	vc4_bo_cache_destroy(drm);
315dev_unref:
316	drm_dev_unref(drm);
317	return ret;
318}
319
320static void vc4_drm_unbind(struct device *dev)
321{
322	struct platform_device *pdev = to_platform_device(dev);
323	struct drm_device *drm = platform_get_drvdata(pdev);
324
325	drm_dev_unregister(drm);
326
327	drm_fb_cma_fbdev_fini(drm);
328
329	drm_mode_config_cleanup(drm);
330
331	drm_dev_unref(drm);
332}
333
334static const struct component_master_ops vc4_drm_ops = {
335	.bind = vc4_drm_bind,
336	.unbind = vc4_drm_unbind,
337};
338
339static struct platform_driver *const component_drivers[] = {
340	&vc4_hdmi_driver,
341	&vc4_vec_driver,
342	&vc4_dpi_driver,
343	&vc4_dsi_driver,
344	&vc4_hvs_driver,
345	&vc4_crtc_driver,
346	&vc4_v3d_driver,
347};
348
349static int vc4_platform_drm_probe(struct platform_device *pdev)
350{
351	struct component_match *match = NULL;
352	struct device *dev = &pdev->dev;
353
354	vc4_match_add_drivers(dev, &match,
355			      component_drivers, ARRAY_SIZE(component_drivers));
356
357	return component_master_add_with_match(dev, &vc4_drm_ops, match);
358}
359
360static int vc4_platform_drm_remove(struct platform_device *pdev)
361{
362	component_master_del(&pdev->dev, &vc4_drm_ops);
363
364	return 0;
365}
366
367static const struct of_device_id vc4_of_match[] = {
368	{ .compatible = "brcm,bcm2835-vc4", },
369	{ .compatible = "brcm,cygnus-vc4", },
370	{},
371};
372MODULE_DEVICE_TABLE(of, vc4_of_match);
373
374static struct platform_driver vc4_platform_driver = {
375	.probe		= vc4_platform_drm_probe,
376	.remove		= vc4_platform_drm_remove,
377	.driver		= {
378		.name	= "vc4-drm",
379		.of_match_table = vc4_of_match,
380	},
381};
382
383static int __init vc4_drm_register(void)
384{
385	int ret;
386
387	ret = platform_register_drivers(component_drivers,
388					ARRAY_SIZE(component_drivers));
389	if (ret)
390		return ret;
391
392	return platform_driver_register(&vc4_platform_driver);
393}
394
395static void __exit vc4_drm_unregister(void)
396{
397	platform_unregister_drivers(component_drivers,
398				    ARRAY_SIZE(component_drivers));
399	platform_driver_unregister(&vc4_platform_driver);
400}
401
402module_init(vc4_drm_register);
403module_exit(vc4_drm_unregister);
404
405MODULE_ALIAS("platform:vc4-drm");
406MODULE_DESCRIPTION("Broadcom VC4 DRM Driver");
407MODULE_AUTHOR("Eric Anholt <eric@anholt.net>");
408MODULE_LICENSE("GPL v2");