Merge tag 'i3c/for-5.13' of git://git.kernel.org/pub/scm/linux/kernel/git/i3c/linux
[linux-2.6-microblaze.git] / drivers / gpu / drm / vc4 / vc4_drv.c
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. */
52 void __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
67 static 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
118 static 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
131 static 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
143 DEFINE_DRM_GEM_FOPS(vc4_drm_fops);
144
145 static const struct drm_ioctl_desc vc4_drm_ioctls[] = {
146         DRM_IOCTL_DEF_DRV(VC4_SUBMIT_CL, vc4_submit_cl_ioctl, DRM_RENDER_ALLOW),
147         DRM_IOCTL_DEF_DRV(VC4_WAIT_SEQNO, vc4_wait_seqno_ioctl, DRM_RENDER_ALLOW),
148         DRM_IOCTL_DEF_DRV(VC4_WAIT_BO, vc4_wait_bo_ioctl, DRM_RENDER_ALLOW),
149         DRM_IOCTL_DEF_DRV(VC4_CREATE_BO, vc4_create_bo_ioctl, DRM_RENDER_ALLOW),
150         DRM_IOCTL_DEF_DRV(VC4_MMAP_BO, vc4_mmap_bo_ioctl, DRM_RENDER_ALLOW),
151         DRM_IOCTL_DEF_DRV(VC4_CREATE_SHADER_BO, vc4_create_shader_bo_ioctl, DRM_RENDER_ALLOW),
152         DRM_IOCTL_DEF_DRV(VC4_GET_HANG_STATE, vc4_get_hang_state_ioctl,
153                           DRM_ROOT_ONLY),
154         DRM_IOCTL_DEF_DRV(VC4_GET_PARAM, vc4_get_param_ioctl, DRM_RENDER_ALLOW),
155         DRM_IOCTL_DEF_DRV(VC4_SET_TILING, vc4_set_tiling_ioctl, DRM_RENDER_ALLOW),
156         DRM_IOCTL_DEF_DRV(VC4_GET_TILING, vc4_get_tiling_ioctl, DRM_RENDER_ALLOW),
157         DRM_IOCTL_DEF_DRV(VC4_LABEL_BO, vc4_label_bo_ioctl, DRM_RENDER_ALLOW),
158         DRM_IOCTL_DEF_DRV(VC4_GEM_MADVISE, vc4_gem_madvise_ioctl, DRM_RENDER_ALLOW),
159         DRM_IOCTL_DEF_DRV(VC4_PERFMON_CREATE, vc4_perfmon_create_ioctl, DRM_RENDER_ALLOW),
160         DRM_IOCTL_DEF_DRV(VC4_PERFMON_DESTROY, vc4_perfmon_destroy_ioctl, DRM_RENDER_ALLOW),
161         DRM_IOCTL_DEF_DRV(VC4_PERFMON_GET_VALUES, vc4_perfmon_get_values_ioctl, DRM_RENDER_ALLOW),
162 };
163
164 static struct drm_driver vc4_drm_driver = {
165         .driver_features = (DRIVER_MODESET |
166                             DRIVER_ATOMIC |
167                             DRIVER_GEM |
168                             DRIVER_RENDER |
169                             DRIVER_SYNCOBJ),
170         .open = vc4_open,
171         .postclose = vc4_close,
172         .irq_handler = vc4_irq,
173         .irq_preinstall = vc4_irq_preinstall,
174         .irq_postinstall = vc4_irq_postinstall,
175         .irq_uninstall = vc4_irq_uninstall,
176
177 #if defined(CONFIG_DEBUG_FS)
178         .debugfs_init = vc4_debugfs_init,
179 #endif
180
181         .gem_create_object = vc4_create_object,
182
183         DRM_GEM_CMA_DRIVER_OPS_WITH_DUMB_CREATE(vc4_dumb_create),
184
185         .ioctls = vc4_drm_ioctls,
186         .num_ioctls = ARRAY_SIZE(vc4_drm_ioctls),
187         .fops = &vc4_drm_fops,
188
189         .name = DRIVER_NAME,
190         .desc = DRIVER_DESC,
191         .date = DRIVER_DATE,
192         .major = DRIVER_MAJOR,
193         .minor = DRIVER_MINOR,
194         .patchlevel = DRIVER_PATCHLEVEL,
195 };
196
197 static int compare_dev(struct device *dev, void *data)
198 {
199         return dev == data;
200 }
201
202 static void vc4_match_add_drivers(struct device *dev,
203                                   struct component_match **match,
204                                   struct platform_driver *const *drivers,
205                                   int count)
206 {
207         int i;
208
209         for (i = 0; i < count; i++) {
210                 struct device_driver *drv = &drivers[i]->driver;
211                 struct device *p = NULL, *d;
212
213                 while ((d = platform_find_device_by_driver(p, drv))) {
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 int vc4_drm_bind(struct device *dev)
223 {
224         struct platform_device *pdev = to_platform_device(dev);
225         struct drm_device *drm;
226         struct vc4_dev *vc4;
227         struct device_node *node;
228         struct drm_crtc *crtc;
229         int ret = 0;
230
231         dev->coherent_dma_mask = DMA_BIT_MASK(32);
232
233         /* If VC4 V3D is missing, don't advertise render nodes. */
234         node = of_find_matching_node_and_match(NULL, vc4_v3d_dt_match, NULL);
235         if (!node || !of_device_is_available(node))
236                 vc4_drm_driver.driver_features &= ~DRIVER_RENDER;
237         of_node_put(node);
238
239         vc4 = devm_drm_dev_alloc(dev, &vc4_drm_driver, struct vc4_dev, base);
240         if (IS_ERR(vc4))
241                 return PTR_ERR(vc4);
242
243         drm = &vc4->base;
244         platform_set_drvdata(pdev, drm);
245         INIT_LIST_HEAD(&vc4->debugfs_list);
246
247         mutex_init(&vc4->bin_bo_lock);
248
249         ret = vc4_bo_cache_init(drm);
250         if (ret)
251                 return ret;
252
253         ret = drmm_mode_config_init(drm);
254         if (ret)
255                 return ret;
256
257         ret = vc4_gem_init(drm);
258         if (ret)
259                 return ret;
260
261         ret = component_bind_all(dev, drm);
262         if (ret)
263                 return ret;
264
265         ret = vc4_plane_create_additional_planes(drm);
266         if (ret)
267                 goto unbind_all;
268
269         drm_fb_helper_remove_conflicting_framebuffers(NULL, "vc4drmfb", false);
270
271         ret = vc4_kms_load(drm);
272         if (ret < 0)
273                 goto unbind_all;
274
275         drm_for_each_crtc(crtc, drm)
276                 vc4_crtc_disable_at_boot(crtc);
277
278         ret = drm_dev_register(drm, 0);
279         if (ret < 0)
280                 goto unbind_all;
281
282         drm_fbdev_generic_setup(drm, 16);
283
284         return 0;
285
286 unbind_all:
287         component_unbind_all(dev, drm);
288
289         return ret;
290 }
291
292 static void vc4_drm_unbind(struct device *dev)
293 {
294         struct drm_device *drm = dev_get_drvdata(dev);
295
296         drm_dev_unregister(drm);
297
298         drm_atomic_helper_shutdown(drm);
299 }
300
301 static const struct component_master_ops vc4_drm_ops = {
302         .bind = vc4_drm_bind,
303         .unbind = vc4_drm_unbind,
304 };
305
306 static struct platform_driver *const component_drivers[] = {
307         &vc4_hdmi_driver,
308         &vc4_vec_driver,
309         &vc4_dpi_driver,
310         &vc4_dsi_driver,
311         &vc4_hvs_driver,
312         &vc4_txp_driver,
313         &vc4_crtc_driver,
314         &vc4_v3d_driver,
315 };
316
317 static int vc4_platform_drm_probe(struct platform_device *pdev)
318 {
319         struct component_match *match = NULL;
320         struct device *dev = &pdev->dev;
321
322         vc4_match_add_drivers(dev, &match,
323                               component_drivers, ARRAY_SIZE(component_drivers));
324
325         return component_master_add_with_match(dev, &vc4_drm_ops, match);
326 }
327
328 static int vc4_platform_drm_remove(struct platform_device *pdev)
329 {
330         component_master_del(&pdev->dev, &vc4_drm_ops);
331
332         return 0;
333 }
334
335 static const struct of_device_id vc4_of_match[] = {
336         { .compatible = "brcm,bcm2711-vc5", },
337         { .compatible = "brcm,bcm2835-vc4", },
338         { .compatible = "brcm,cygnus-vc4", },
339         {},
340 };
341 MODULE_DEVICE_TABLE(of, vc4_of_match);
342
343 static struct platform_driver vc4_platform_driver = {
344         .probe          = vc4_platform_drm_probe,
345         .remove         = vc4_platform_drm_remove,
346         .driver         = {
347                 .name   = "vc4-drm",
348                 .of_match_table = vc4_of_match,
349         },
350 };
351
352 static int __init vc4_drm_register(void)
353 {
354         int ret;
355
356         ret = platform_register_drivers(component_drivers,
357                                         ARRAY_SIZE(component_drivers));
358         if (ret)
359                 return ret;
360
361         return platform_driver_register(&vc4_platform_driver);
362 }
363
364 static void __exit vc4_drm_unregister(void)
365 {
366         platform_unregister_drivers(component_drivers,
367                                     ARRAY_SIZE(component_drivers));
368         platform_driver_unregister(&vc4_platform_driver);
369 }
370
371 module_init(vc4_drm_register);
372 module_exit(vc4_drm_unregister);
373
374 MODULE_ALIAS("platform:vc4-drm");
375 MODULE_DESCRIPTION("Broadcom VC4 DRM Driver");
376 MODULE_AUTHOR("Eric Anholt <eric@anholt.net>");
377 MODULE_LICENSE("GPL v2");