drm/vc4: Add gem_info node via debugfs for vc5
[platform/kernel/linux-rpi.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_device.h>
30 #include <linux/platform_device.h>
31 #include <linux/pm_runtime.h>
32 #include <linux/dma-direct.h>
33
34 #include <drm/drm_aperture.h>
35 #include <drm/drm_atomic_helper.h>
36 #include <drm/drm_drv.h>
37 #include <drm/drm_fbdev_dma.h>
38 #include <drm/drm_vblank.h>
39
40 #include <soc/bcm2835/raspberrypi-firmware.h>
41
42 #include "uapi/drm/vc4_drm.h"
43
44 #include "vc4_drv.h"
45 #include "vc4_regs.h"
46
47 #define DRIVER_NAME "vc4"
48 #define DRIVER_DESC "Broadcom VC4 graphics"
49 #define DRIVER_DATE "20140616"
50 #define DRIVER_MAJOR 0
51 #define DRIVER_MINOR 0
52 #define DRIVER_PATCHLEVEL 0
53
54 /* Helper function for mapping the regs on a platform device. */
55 void __iomem *vc4_ioremap_regs(struct platform_device *pdev, int index)
56 {
57         void __iomem *map;
58
59         map = devm_platform_ioremap_resource(pdev, index);
60         if (IS_ERR(map))
61                 return map;
62
63         return map;
64 }
65
66 int vc4_dumb_fixup_args(struct drm_mode_create_dumb *args)
67 {
68         int min_pitch = DIV_ROUND_UP(args->width * args->bpp, 8);
69
70         if (args->pitch < min_pitch)
71                 args->pitch = min_pitch;
72
73         if (args->size < args->pitch * args->height)
74                 args->size = args->pitch * args->height;
75
76         return 0;
77 }
78
79 static void vc5_gem_register_pid(struct drm_file *file_priv)
80 {
81         struct vc4_file *vc4file = file_priv->driver_priv;
82         struct drm_vc5_file_private *driver_priv = &vc4file->priv;
83
84         if (!driver_priv->pid && !driver_priv->tgid) {
85                 driver_priv->pid = task_pid_nr(current);
86                 driver_priv->tgid = task_tgid_nr(current);
87         } else {
88                 if (driver_priv->pid != task_pid_nr(current))
89                         DRM_DEBUG_KMS("wrong pid: %ld, %ld\n",
90                                         (unsigned long)driver_priv->pid,
91                                         (unsigned long)task_pid_nr(current));
92                 if (driver_priv->tgid != task_tgid_nr(current))
93                         DRM_DEBUG_KMS("wrong tgid: %ld, %ld\n",
94                                         (unsigned long)driver_priv->tgid,
95                                         (unsigned long)task_tgid_nr(current));
96         }
97 }
98
99 int vc5_drm_gem_prime_fd_to_handle(struct drm_device *dev,
100                                    struct drm_file *file_priv, int prime_fd,
101                                    uint32_t *handle)
102 {
103         int ret;
104
105         ret = drm_gem_prime_fd_to_handle(dev, file_priv, prime_fd, handle);
106         if (ret < 0)
107                 return ret;
108
109         vc5_gem_register_pid(file_priv);
110
111         return ret;
112 }
113
114 static int vc5_dumb_create(struct drm_file *file_priv,
115                            struct drm_device *dev,
116                            struct drm_mode_create_dumb *args)
117 {
118         int ret;
119
120         ret = vc4_dumb_fixup_args(args);
121         if (ret)
122                 return ret;
123
124         ret = drm_gem_dma_dumb_create_internal(file_priv, dev, args);
125         if (!ret)
126                 vc5_gem_register_pid(file_priv);
127
128         return ret;
129 }
130
131 static int vc4_get_param_ioctl(struct drm_device *dev, void *data,
132                                struct drm_file *file_priv)
133 {
134         struct vc4_dev *vc4 = to_vc4_dev(dev);
135         struct drm_vc4_get_param *args = data;
136         int ret;
137
138         if (args->pad != 0)
139                 return -EINVAL;
140
141         if (WARN_ON_ONCE(vc4->gen > VC4_GEN_4))
142                 return -ENODEV;
143
144         if (!vc4->v3d)
145                 return -ENODEV;
146
147         switch (args->param) {
148         case DRM_VC4_PARAM_V3D_IDENT0:
149                 ret = vc4_v3d_pm_get(vc4);
150                 if (ret)
151                         return ret;
152                 args->value = V3D_READ(V3D_IDENT0);
153                 vc4_v3d_pm_put(vc4);
154                 break;
155         case DRM_VC4_PARAM_V3D_IDENT1:
156                 ret = vc4_v3d_pm_get(vc4);
157                 if (ret)
158                         return ret;
159                 args->value = V3D_READ(V3D_IDENT1);
160                 vc4_v3d_pm_put(vc4);
161                 break;
162         case DRM_VC4_PARAM_V3D_IDENT2:
163                 ret = vc4_v3d_pm_get(vc4);
164                 if (ret)
165                         return ret;
166                 args->value = V3D_READ(V3D_IDENT2);
167                 vc4_v3d_pm_put(vc4);
168                 break;
169         case DRM_VC4_PARAM_SUPPORTS_BRANCHES:
170         case DRM_VC4_PARAM_SUPPORTS_ETC1:
171         case DRM_VC4_PARAM_SUPPORTS_THREADED_FS:
172         case DRM_VC4_PARAM_SUPPORTS_FIXED_RCL_ORDER:
173         case DRM_VC4_PARAM_SUPPORTS_MADVISE:
174         case DRM_VC4_PARAM_SUPPORTS_PERFMON:
175                 args->value = true;
176                 break;
177         default:
178                 DRM_DEBUG("Unknown parameter %d\n", args->param);
179                 return -EINVAL;
180         }
181
182         return 0;
183 }
184
185 static int vc4_open(struct drm_device *dev, struct drm_file *file)
186 {
187         struct vc4_dev *vc4 = to_vc4_dev(dev);
188         struct vc4_file *vc4file;
189
190         if (WARN_ON_ONCE(vc4->gen > VC4_GEN_4))
191                 return -ENODEV;
192
193         vc4file = kzalloc(sizeof(*vc4file), GFP_KERNEL);
194         if (!vc4file)
195                 return -ENOMEM;
196         vc4file->dev = vc4;
197
198         vc4_perfmon_open_file(vc4file);
199         file->driver_priv = vc4file;
200         return 0;
201 }
202
203 static void vc4_close(struct drm_device *dev, struct drm_file *file)
204 {
205         struct vc4_dev *vc4 = to_vc4_dev(dev);
206         struct vc4_file *vc4file = file->driver_priv;
207
208         if (WARN_ON_ONCE(vc4->gen > VC4_GEN_4))
209                 return;
210
211         if (vc4file->bin_bo_used)
212                 vc4_v3d_bin_bo_put(vc4);
213
214         vc4_perfmon_close_file(vc4file);
215         kfree(vc4file);
216 }
217
218 struct drm_gem_object *
219 vc4_prime_import_sg_table(struct drm_device *dev,
220                           struct dma_buf_attachment *attach,
221                           struct sg_table *sgt)
222 {
223         phys_addr_t phys = dma_to_phys(dev->dev, sg_dma_address(sgt->sgl));
224
225         if (is_swiotlb_buffer(dev->dev, phys))
226                 return ERR_PTR(-EINVAL);
227
228         return drm_gem_dma_prime_import_sg_table(dev, attach, sgt);
229 }
230
231 static int vc5_open(struct drm_device *dev, struct drm_file *file)
232 {
233         struct vc4_dev *vc4 = to_vc4_dev(dev);
234         struct vc4_file *vc4file;
235
236         vc4file = kzalloc(sizeof(*vc4file), GFP_KERNEL);
237         if (!vc4file)
238                 return -ENOMEM;
239         vc4file->dev = vc4;
240
241         file->driver_priv = vc4file;
242         return 0;
243 }
244
245 static void vc5_close(struct drm_device *dev, struct drm_file *file)
246 {
247         struct vc4_file *vc4file = file->driver_priv;
248
249         kfree(vc4file);
250 }
251
252 DEFINE_DRM_GEM_FOPS(vc4_drm_fops);
253
254 static const struct drm_ioctl_desc vc4_drm_ioctls[] = {
255         DRM_IOCTL_DEF_DRV(VC4_SUBMIT_CL, vc4_submit_cl_ioctl, DRM_RENDER_ALLOW),
256         DRM_IOCTL_DEF_DRV(VC4_WAIT_SEQNO, vc4_wait_seqno_ioctl, DRM_RENDER_ALLOW),
257         DRM_IOCTL_DEF_DRV(VC4_WAIT_BO, vc4_wait_bo_ioctl, DRM_RENDER_ALLOW),
258         DRM_IOCTL_DEF_DRV(VC4_CREATE_BO, vc4_create_bo_ioctl, DRM_RENDER_ALLOW),
259         DRM_IOCTL_DEF_DRV(VC4_MMAP_BO, vc4_mmap_bo_ioctl, DRM_RENDER_ALLOW),
260         DRM_IOCTL_DEF_DRV(VC4_CREATE_SHADER_BO, vc4_create_shader_bo_ioctl, DRM_RENDER_ALLOW),
261         DRM_IOCTL_DEF_DRV(VC4_GET_HANG_STATE, vc4_get_hang_state_ioctl,
262                           DRM_ROOT_ONLY),
263         DRM_IOCTL_DEF_DRV(VC4_GET_PARAM, vc4_get_param_ioctl, DRM_RENDER_ALLOW),
264         DRM_IOCTL_DEF_DRV(VC4_SET_TILING, vc4_set_tiling_ioctl, DRM_RENDER_ALLOW),
265         DRM_IOCTL_DEF_DRV(VC4_GET_TILING, vc4_get_tiling_ioctl, DRM_RENDER_ALLOW),
266         DRM_IOCTL_DEF_DRV(VC4_LABEL_BO, vc4_label_bo_ioctl, DRM_RENDER_ALLOW),
267         DRM_IOCTL_DEF_DRV(VC4_GEM_MADVISE, vc4_gem_madvise_ioctl, DRM_RENDER_ALLOW),
268         DRM_IOCTL_DEF_DRV(VC4_PERFMON_CREATE, vc4_perfmon_create_ioctl, DRM_RENDER_ALLOW),
269         DRM_IOCTL_DEF_DRV(VC4_PERFMON_DESTROY, vc4_perfmon_destroy_ioctl, DRM_RENDER_ALLOW),
270         DRM_IOCTL_DEF_DRV(VC4_PERFMON_GET_VALUES, vc4_perfmon_get_values_ioctl, DRM_RENDER_ALLOW),
271 };
272
273 const struct drm_driver vc4_drm_driver = {
274         .driver_features = (DRIVER_MODESET |
275                             DRIVER_ATOMIC |
276                             DRIVER_GEM |
277                             DRIVER_RENDER |
278                             DRIVER_SYNCOBJ),
279         .open = vc4_open,
280         .postclose = vc4_close,
281
282 #if defined(CONFIG_DEBUG_FS)
283         .debugfs_init = vc4_debugfs_init,
284 #endif
285
286         .gem_create_object = vc4_create_object,
287
288         .dumb_create            = vc4_bo_dumb_create,
289         .gem_prime_import_sg_table = vc4_prime_import_sg_table,
290
291         .ioctls = vc4_drm_ioctls,
292         .num_ioctls = ARRAY_SIZE(vc4_drm_ioctls),
293         .fops = &vc4_drm_fops,
294
295         .name = DRIVER_NAME,
296         .desc = DRIVER_DESC,
297         .date = DRIVER_DATE,
298         .major = DRIVER_MAJOR,
299         .minor = DRIVER_MINOR,
300         .patchlevel = DRIVER_PATCHLEVEL,
301 };
302
303 const struct drm_driver vc5_drm_driver = {
304         .driver_features = (DRIVER_MODESET |
305                             DRIVER_ATOMIC |
306                             DRIVER_GEM),
307
308         .open = vc5_open,
309         .postclose = vc5_close,
310 #if defined(CONFIG_DEBUG_FS)
311         .debugfs_init = vc4_debugfs_init,
312 #endif
313
314         .dumb_create            = vc5_dumb_create,
315         .gem_prime_import_sg_table = vc4_prime_import_sg_table,
316
317         .prime_fd_to_handle = vc5_drm_gem_prime_fd_to_handle,
318         .fops = &vc4_drm_fops,
319
320         .name = DRIVER_NAME,
321         .desc = DRIVER_DESC,
322         .date = DRIVER_DATE,
323         .major = DRIVER_MAJOR,
324         .minor = DRIVER_MINOR,
325         .patchlevel = DRIVER_PATCHLEVEL,
326 };
327
328 static void vc4_match_add_drivers(struct device *dev,
329                                   struct component_match **match,
330                                   struct platform_driver *const *drivers,
331                                   int count)
332 {
333         int i;
334
335         for (i = 0; i < count; i++) {
336                 struct device_driver *drv = &drivers[i]->driver;
337                 struct device *p = NULL, *d;
338
339                 while ((d = platform_find_device_by_driver(p, drv))) {
340                         put_device(p);
341                         component_match_add(dev, match, component_compare_dev, d);
342                         p = d;
343                 }
344                 put_device(p);
345         }
346 }
347
348 static void vc4_component_unbind_all(void *ptr)
349 {
350         struct vc4_dev *vc4 = ptr;
351
352         component_unbind_all(vc4->dev, &vc4->base);
353 }
354
355 static const struct of_device_id vc4_dma_range_matches[] = {
356         { .compatible = "brcm,bcm2711-hvs" },
357         { .compatible = "brcm,bcm2712-hvs" },
358         { .compatible = "brcm,bcm2835-hvs" },
359         { .compatible = "raspberrypi,rpi-firmware-kms" },
360         { .compatible = "brcm,bcm2835-v3d" },
361         { .compatible = "brcm,cygnus-v3d" },
362         { .compatible = "brcm,vc4-v3d" },
363         {}
364 };
365
366 /*
367  * we need this helper function for determining presence of fkms
368  * before it's been bound
369  */
370 static bool firmware_kms(void)
371 {
372         return of_device_is_available(of_find_compatible_node(NULL, NULL,
373                "raspberrypi,rpi-firmware-kms")) ||
374                of_device_is_available(of_find_compatible_node(NULL, NULL,
375                "raspberrypi,rpi-firmware-kms-2711"));
376 }
377
378 int vc5_bo_debugfs_init(struct drm_minor *minor)
379 {
380         struct drm_device *drm = minor->dev;
381         struct vc4_dev *vc4 = to_vc4_dev(drm);
382
383         if (vc4->gen == VC4_GEN_4)
384                 return -ENODEV;
385
386         drm_debugfs_add_file(drm, "gem_info", vc5_debugfs_gem_info, NULL);
387         return 0;
388 }
389
390 static int vc4_drm_bind(struct device *dev)
391 {
392         struct platform_device *pdev = to_platform_device(dev);
393         const struct drm_driver *driver;
394         struct rpi_firmware *firmware = NULL;
395         struct drm_device *drm;
396         struct vc4_dev *vc4;
397         struct device_node *node;
398         struct drm_crtc *crtc;
399         enum vc4_gen gen;
400         bool step_d0 = false;
401         int ret = 0;
402
403         if (of_device_is_compatible(dev->of_node, "brcm,bcm2712d0-vc6")) {
404                 gen = VC4_GEN_6;
405                 step_d0 = true;
406         } else if (of_device_is_compatible(dev->of_node, "brcm,bcm2712-vc6"))
407                 gen = VC4_GEN_6;
408         else if (of_device_is_compatible(dev->of_node, "brcm,bcm2711-vc5"))
409                 gen = VC4_GEN_5;
410         else
411                 gen = VC4_GEN_4;
412
413         if (gen > VC4_GEN_4)
414                 driver = &vc5_drm_driver;
415         else
416                 driver = &vc4_drm_driver;
417
418         if (gen >= VC4_GEN_6)
419                 dma_set_mask_and_coherent(dev, DMA_BIT_MASK(36));
420         else
421                 dma_set_mask_and_coherent(dev, DMA_BIT_MASK(32));
422
423         node = of_find_matching_node_and_match(NULL, vc4_dma_range_matches,
424                                                NULL);
425         if (node) {
426                 ret = of_dma_configure(dev, node, true);
427                 of_node_put(node);
428
429                 if (ret)
430                         return ret;
431         }
432
433         vc4 = devm_drm_dev_alloc(dev, driver, struct vc4_dev, base);
434         if (IS_ERR(vc4))
435                 return PTR_ERR(vc4);
436         vc4->gen = gen;
437         vc4->step_d0 = step_d0;
438         vc4->dev = dev;
439
440         drm = &vc4->base;
441         platform_set_drvdata(pdev, drm);
442
443         if (gen == VC4_GEN_4) {
444                 ret = drmm_mutex_init(drm, &vc4->bin_bo_lock);
445                 if (ret)
446                         return ret;
447
448                 ret = vc4_bo_cache_init(drm);
449                 if (ret)
450                         return ret;
451         }
452
453         ret = drmm_mode_config_init(drm);
454         if (ret)
455                 return ret;
456
457         if (gen == VC4_GEN_4) {
458                 ret = vc4_gem_init(drm);
459                 if (ret)
460                         return ret;
461         }
462
463         node = of_find_compatible_node(NULL, NULL, "raspberrypi,bcm2835-firmware");
464         if (node) {
465                 firmware = rpi_firmware_get(node);
466                 of_node_put(node);
467
468                 if (!firmware)
469                         return -EPROBE_DEFER;
470         }
471
472         ret = drm_aperture_remove_framebuffers(driver);
473         if (ret)
474                 return ret;
475
476         if (firmware && !firmware_kms()) {
477                 ret = rpi_firmware_property(firmware,
478                                             RPI_FIRMWARE_NOTIFY_DISPLAY_DONE,
479                                             NULL, 0);
480                 if (ret)
481                         drm_warn(drm, "Couldn't stop firmware display driver: %d\n", ret);
482
483                 rpi_firmware_put(firmware);
484         }
485
486         ret = component_bind_all(dev, drm);
487         if (ret)
488                 return ret;
489
490         ret = devm_add_action_or_reset(dev, vc4_component_unbind_all, vc4);
491         if (ret)
492                 return ret;
493
494         if (!vc4->firmware_kms) {
495                 ret = vc4_plane_create_additional_planes(drm);
496                 if (ret)
497                         return ret;
498         }
499
500         ret = vc4_kms_load(drm);
501         if (ret < 0)
502                 goto unbind_all;
503
504         if (!vc4->firmware_kms) {
505                 drm_for_each_crtc(crtc, drm)
506                         vc4_crtc_disable_at_boot(crtc);
507         }
508
509         ret = drm_dev_register(drm, 0);
510         if (ret < 0)
511                 goto unbind_all;
512
513         drm_fbdev_dma_setup(drm, 16);
514
515         return 0;
516
517 unbind_all:
518         return ret;
519 }
520
521 static void vc4_drm_unbind(struct device *dev)
522 {
523         struct drm_device *drm = dev_get_drvdata(dev);
524
525         drm_dev_unplug(drm);
526         drm_atomic_helper_shutdown(drm);
527 }
528
529 static const struct component_master_ops vc4_drm_ops = {
530         .bind = vc4_drm_bind,
531         .unbind = vc4_drm_unbind,
532 };
533
534 /*
535  * This list determines the binding order of our components, and we have
536  * a few constraints:
537  *   - The TXP driver needs to be bound before the PixelValves (CRTC)
538  *     but after the HVS to set the possible_crtc field properly
539  *   - The HDMI driver needs to be bound after the HVS so that we can
540  *     lookup the HVS maximum core clock rate and figure out if we
541  *     support 4kp60 or not.
542  */
543 static struct platform_driver *const component_drivers[] = {
544         &vc4_hvs_driver,
545         &vc4_hdmi_driver,
546         &vc4_vec_driver,
547         &vc4_dpi_driver,
548         &vc4_dsi_driver,
549         &vc4_txp_driver,
550         &vc4_crtc_driver,
551         &vc4_firmware_kms_driver,
552         &vc4_v3d_driver,
553 };
554
555 static int vc4_platform_drm_probe(struct platform_device *pdev)
556 {
557         struct component_match *match = NULL;
558         struct device *dev = &pdev->dev;
559
560         vc4_match_add_drivers(dev, &match,
561                               component_drivers, ARRAY_SIZE(component_drivers));
562
563         if (!match)
564                 return -ENODEV;
565
566         return component_master_add_with_match(dev, &vc4_drm_ops, match);
567 }
568
569 static void vc4_platform_drm_remove(struct platform_device *pdev)
570 {
571         component_master_del(&pdev->dev, &vc4_drm_ops);
572 }
573
574 static const struct of_device_id vc4_of_match[] = {
575         { .compatible = "brcm,bcm2711-vc5", },
576         { .compatible = "brcm,bcm2712-vc6", },
577         { .compatible = "brcm,bcm2712d0-vc6", },
578         { .compatible = "brcm,bcm2835-vc4", },
579         { .compatible = "brcm,cygnus-vc4", },
580         {},
581 };
582 MODULE_DEVICE_TABLE(of, vc4_of_match);
583
584 static struct platform_driver vc4_platform_driver = {
585         .probe          = vc4_platform_drm_probe,
586         .remove_new     = vc4_platform_drm_remove,
587         .driver         = {
588                 .name   = "vc4-drm",
589                 .of_match_table = vc4_of_match,
590         },
591 };
592
593 static int __init vc4_drm_register(void)
594 {
595         int ret;
596
597         if (drm_firmware_drivers_only())
598                 return -ENODEV;
599
600         ret = platform_register_drivers(component_drivers,
601                                         ARRAY_SIZE(component_drivers));
602         if (ret)
603                 return ret;
604
605         ret = platform_driver_register(&vc4_platform_driver);
606         if (ret)
607                 platform_unregister_drivers(component_drivers,
608                                             ARRAY_SIZE(component_drivers));
609
610         return ret;
611 }
612
613 static void __exit vc4_drm_unregister(void)
614 {
615         platform_unregister_drivers(component_drivers,
616                                     ARRAY_SIZE(component_drivers));
617         platform_driver_unregister(&vc4_platform_driver);
618 }
619
620 module_init(vc4_drm_register);
621 module_exit(vc4_drm_unregister);
622
623 MODULE_ALIAS("platform:vc4-drm");
624 MODULE_SOFTDEP("pre: snd-soc-hdmi-codec");
625 MODULE_DESCRIPTION("Broadcom VC4 DRM Driver");
626 MODULE_AUTHOR("Eric Anholt <eric@anholt.net>");
627 MODULE_LICENSE("GPL v2");