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