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/aperture.h>
24#include <linux/clk.h>
25#include <linux/component.h>
26#include <linux/device.h>
27#include <linux/dma-mapping.h>
28#include <linux/io.h>
29#include <linux/module.h>
30#include <linux/of_device.h>
31#include <linux/platform_device.h>
32#include <linux/pm_runtime.h>
33
34#include <drm/clients/drm_client_setup.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_fourcc.h>
39#include <drm/drm_print.h>
40#include <drm/drm_vblank.h>
41
42#include <soc/bcm2835/raspberrypi-firmware.h>
43
44#include "uapi/drm/vc4_drm.h"
45
46#include "vc4_drv.h"
47#include "vc4_regs.h"
48
49#define DRIVER_NAME "vc4"
50#define DRIVER_DESC "Broadcom VC4 graphics"
51#define DRIVER_MAJOR 0
52#define DRIVER_MINOR 0
53#define DRIVER_PATCHLEVEL 0
54
55/* Helper function for mapping the regs on a platform device. */
56void __iomem *vc4_ioremap_regs(struct platform_device *pdev, int index)
57{
58 void __iomem *map;
59
60 map = devm_platform_ioremap_resource(pdev, index);
61 if (IS_ERR(ptr: map))
62 return map;
63
64 return map;
65}
66
67int vc4_dumb_fixup_args(struct drm_mode_create_dumb *args)
68{
69 int min_pitch = DIV_ROUND_UP(args->width * args->bpp, 8);
70
71 if (args->pitch < min_pitch)
72 args->pitch = min_pitch;
73
74 if (args->size < args->pitch * args->height)
75 args->size = args->pitch * args->height;
76
77 return 0;
78}
79
80static int vc5_dumb_create(struct drm_file *file_priv,
81 struct drm_device *dev,
82 struct drm_mode_create_dumb *args)
83{
84 int ret;
85
86 ret = vc4_dumb_fixup_args(args);
87 if (ret)
88 return ret;
89
90 return drm_gem_dma_dumb_create_internal(file_priv, drm: dev, args);
91}
92
93static int vc4_get_param_ioctl(struct drm_device *dev, void *data,
94 struct drm_file *file_priv)
95{
96 struct vc4_dev *vc4 = to_vc4_dev(dev);
97 struct drm_vc4_get_param *args = data;
98 int ret;
99
100 if (args->pad != 0)
101 return -EINVAL;
102
103 if (WARN_ON_ONCE(vc4->gen > VC4_GEN_4))
104 return -ENODEV;
105
106 if (!vc4->v3d)
107 return -ENODEV;
108
109 switch (args->param) {
110 case DRM_VC4_PARAM_V3D_IDENT0:
111 ret = vc4_v3d_pm_get(vc4);
112 if (ret)
113 return ret;
114 args->value = V3D_READ(V3D_IDENT0);
115 vc4_v3d_pm_put(vc4);
116 break;
117 case DRM_VC4_PARAM_V3D_IDENT1:
118 ret = vc4_v3d_pm_get(vc4);
119 if (ret)
120 return ret;
121 args->value = V3D_READ(V3D_IDENT1);
122 vc4_v3d_pm_put(vc4);
123 break;
124 case DRM_VC4_PARAM_V3D_IDENT2:
125 ret = vc4_v3d_pm_get(vc4);
126 if (ret)
127 return ret;
128 args->value = V3D_READ(V3D_IDENT2);
129 vc4_v3d_pm_put(vc4);
130 break;
131 case DRM_VC4_PARAM_SUPPORTS_BRANCHES:
132 case DRM_VC4_PARAM_SUPPORTS_ETC1:
133 case DRM_VC4_PARAM_SUPPORTS_THREADED_FS:
134 case DRM_VC4_PARAM_SUPPORTS_FIXED_RCL_ORDER:
135 case DRM_VC4_PARAM_SUPPORTS_MADVISE:
136 case DRM_VC4_PARAM_SUPPORTS_PERFMON:
137 args->value = true;
138 break;
139 default:
140 DRM_DEBUG("Unknown parameter %d\n", args->param);
141 return -EINVAL;
142 }
143
144 return 0;
145}
146
147static int vc4_open(struct drm_device *dev, struct drm_file *file)
148{
149 struct vc4_dev *vc4 = to_vc4_dev(dev);
150 struct vc4_file *vc4file;
151
152 if (WARN_ON_ONCE(vc4->gen > VC4_GEN_4))
153 return -ENODEV;
154
155 vc4file = kzalloc(sizeof(*vc4file), GFP_KERNEL);
156 if (!vc4file)
157 return -ENOMEM;
158 vc4file->dev = vc4;
159
160 vc4_perfmon_open_file(vc4file);
161 file->driver_priv = vc4file;
162 return 0;
163}
164
165static void vc4_close(struct drm_device *dev, struct drm_file *file)
166{
167 struct vc4_dev *vc4 = to_vc4_dev(dev);
168 struct vc4_file *vc4file = file->driver_priv;
169
170 if (WARN_ON_ONCE(vc4->gen > VC4_GEN_4))
171 return;
172
173 if (vc4file->bin_bo_used)
174 vc4_v3d_bin_bo_put(vc4);
175
176 vc4_perfmon_close_file(vc4file);
177 kfree(objp: vc4file);
178}
179
180DEFINE_DRM_GEM_FOPS(vc4_drm_fops);
181
182static const struct drm_ioctl_desc vc4_drm_ioctls[] = {
183 DRM_IOCTL_DEF_DRV(VC4_SUBMIT_CL, vc4_submit_cl_ioctl, DRM_RENDER_ALLOW),
184 DRM_IOCTL_DEF_DRV(VC4_WAIT_SEQNO, vc4_wait_seqno_ioctl, DRM_RENDER_ALLOW),
185 DRM_IOCTL_DEF_DRV(VC4_WAIT_BO, vc4_wait_bo_ioctl, DRM_RENDER_ALLOW),
186 DRM_IOCTL_DEF_DRV(VC4_CREATE_BO, vc4_create_bo_ioctl, DRM_RENDER_ALLOW),
187 DRM_IOCTL_DEF_DRV(VC4_MMAP_BO, vc4_mmap_bo_ioctl, DRM_RENDER_ALLOW),
188 DRM_IOCTL_DEF_DRV(VC4_CREATE_SHADER_BO, vc4_create_shader_bo_ioctl, DRM_RENDER_ALLOW),
189 DRM_IOCTL_DEF_DRV(VC4_GET_HANG_STATE, vc4_get_hang_state_ioctl,
190 DRM_ROOT_ONLY),
191 DRM_IOCTL_DEF_DRV(VC4_GET_PARAM, vc4_get_param_ioctl, DRM_RENDER_ALLOW),
192 DRM_IOCTL_DEF_DRV(VC4_SET_TILING, vc4_set_tiling_ioctl, DRM_RENDER_ALLOW),
193 DRM_IOCTL_DEF_DRV(VC4_GET_TILING, vc4_get_tiling_ioctl, DRM_RENDER_ALLOW),
194 DRM_IOCTL_DEF_DRV(VC4_LABEL_BO, vc4_label_bo_ioctl, DRM_RENDER_ALLOW),
195 DRM_IOCTL_DEF_DRV(VC4_GEM_MADVISE, vc4_gem_madvise_ioctl, DRM_RENDER_ALLOW),
196 DRM_IOCTL_DEF_DRV(VC4_PERFMON_CREATE, vc4_perfmon_create_ioctl, DRM_RENDER_ALLOW),
197 DRM_IOCTL_DEF_DRV(VC4_PERFMON_DESTROY, vc4_perfmon_destroy_ioctl, DRM_RENDER_ALLOW),
198 DRM_IOCTL_DEF_DRV(VC4_PERFMON_GET_VALUES, vc4_perfmon_get_values_ioctl, DRM_RENDER_ALLOW),
199};
200
201const struct drm_driver vc4_drm_driver = {
202 .driver_features = (DRIVER_MODESET |
203 DRIVER_ATOMIC |
204 DRIVER_GEM |
205 DRIVER_RENDER |
206 DRIVER_SYNCOBJ),
207 .open = vc4_open,
208 .postclose = vc4_close,
209
210#if defined(CONFIG_DEBUG_FS)
211 .debugfs_init = vc4_debugfs_init,
212#endif
213
214 .gem_create_object = vc4_create_object,
215
216 DRM_GEM_DMA_DRIVER_OPS_WITH_DUMB_CREATE(vc4_bo_dumb_create),
217 DRM_FBDEV_DMA_DRIVER_OPS,
218
219 .ioctls = vc4_drm_ioctls,
220 .num_ioctls = ARRAY_SIZE(vc4_drm_ioctls),
221 .fops = &vc4_drm_fops,
222
223 .name = DRIVER_NAME,
224 .desc = DRIVER_DESC,
225 .major = DRIVER_MAJOR,
226 .minor = DRIVER_MINOR,
227 .patchlevel = DRIVER_PATCHLEVEL,
228};
229
230const struct drm_driver vc5_drm_driver = {
231 .driver_features = (DRIVER_MODESET |
232 DRIVER_ATOMIC |
233 DRIVER_GEM),
234
235#if defined(CONFIG_DEBUG_FS)
236 .debugfs_init = vc4_debugfs_init,
237#endif
238
239 DRM_GEM_DMA_DRIVER_OPS_WITH_DUMB_CREATE(vc5_dumb_create),
240 DRM_FBDEV_DMA_DRIVER_OPS,
241
242 .fops = &vc4_drm_fops,
243
244 .name = DRIVER_NAME,
245 .desc = DRIVER_DESC,
246 .major = DRIVER_MAJOR,
247 .minor = DRIVER_MINOR,
248 .patchlevel = DRIVER_PATCHLEVEL,
249};
250
251static void vc4_match_add_drivers(struct device *dev,
252 struct component_match **match,
253 struct platform_driver *const *drivers,
254 int count)
255{
256 int i;
257
258 for (i = 0; i < count; i++) {
259 struct device_driver *drv = &drivers[i]->driver;
260 struct device *p = NULL, *d;
261
262 while ((d = platform_find_device_by_driver(start: p, drv))) {
263 put_device(dev: p);
264 component_match_add(parent: dev, matchptr: match, compare: component_compare_dev, compare_data: d);
265 p = d;
266 }
267 put_device(dev: p);
268 }
269}
270
271static void vc4_component_unbind_all(void *ptr)
272{
273 struct vc4_dev *vc4 = ptr;
274
275 component_unbind_all(parent: vc4->dev, data: &vc4->base);
276}
277
278static const struct of_device_id vc4_dma_range_matches[] = {
279 { .compatible = "brcm,bcm2711-hvs" },
280 { .compatible = "brcm,bcm2712-hvs" },
281 { .compatible = "brcm,bcm2835-hvs" },
282 { .compatible = "brcm,bcm2835-v3d" },
283 { .compatible = "brcm,cygnus-v3d" },
284 { .compatible = "brcm,vc4-v3d" },
285 {}
286};
287
288static int vc4_drm_bind(struct device *dev)
289{
290 struct platform_device *pdev = to_platform_device(dev);
291 const struct drm_driver *driver;
292 struct rpi_firmware *firmware = NULL;
293 struct drm_device *drm;
294 struct vc4_dev *vc4;
295 struct device_node *node;
296 struct drm_crtc *crtc;
297 enum vc4_gen gen;
298 int ret = 0;
299
300 dev->coherent_dma_mask = DMA_BIT_MASK(32);
301
302 gen = (enum vc4_gen)of_device_get_match_data(dev);
303
304 if (gen > VC4_GEN_4)
305 driver = &vc5_drm_driver;
306 else
307 driver = &vc4_drm_driver;
308
309 if (gen >= VC4_GEN_6_C)
310 dma_set_mask_and_coherent(dev, DMA_BIT_MASK(36));
311 else
312 dma_set_mask_and_coherent(dev, DMA_BIT_MASK(32));
313
314 node = of_find_matching_node_and_match(NULL, matches: vc4_dma_range_matches,
315 NULL);
316 if (node) {
317 ret = of_dma_configure(dev, np: node, force_dma: true);
318 of_node_put(node);
319
320 if (ret)
321 return ret;
322 }
323
324 vc4 = devm_drm_dev_alloc(dev, driver, struct vc4_dev, base);
325 if (IS_ERR(ptr: vc4))
326 return PTR_ERR(ptr: vc4);
327 vc4->gen = gen;
328 vc4->dev = dev;
329
330 drm = &vc4->base;
331 platform_set_drvdata(pdev, data: drm);
332
333 if (gen == VC4_GEN_4) {
334 ret = drmm_mutex_init(drm, &vc4->bin_bo_lock);
335 if (ret)
336 goto err;
337
338 ret = vc4_bo_cache_init(dev: drm);
339 if (ret)
340 goto err;
341 }
342
343 ret = drmm_mode_config_init(dev: drm);
344 if (ret)
345 goto err;
346
347 if (gen == VC4_GEN_4) {
348 ret = vc4_gem_init(dev: drm);
349 if (ret)
350 goto err;
351 }
352
353 node = of_find_compatible_node(NULL, NULL, compat: "raspberrypi,bcm2835-firmware");
354 if (node) {
355 firmware = rpi_firmware_get(firmware_node: node);
356 of_node_put(node);
357
358 if (!firmware) {
359 ret = -EPROBE_DEFER;
360 goto err;
361 }
362 }
363
364 ret = aperture_remove_all_conflicting_devices(name: driver->name);
365 if (ret)
366 goto err;
367
368 if (firmware) {
369 ret = rpi_firmware_property(fw: firmware,
370 tag: RPI_FIRMWARE_NOTIFY_DISPLAY_DONE,
371 NULL, len: 0);
372 if (ret)
373 drm_warn(drm, "Couldn't stop firmware display driver: %d\n", ret);
374
375 rpi_firmware_put(fw: firmware);
376 }
377
378 ret = component_bind_all(parent: dev, data: drm);
379 if (ret)
380 goto err;
381
382 ret = devm_add_action_or_reset(dev, vc4_component_unbind_all, vc4);
383 if (ret)
384 goto err;
385
386 ret = vc4_plane_create_additional_planes(dev: drm);
387 if (ret)
388 goto err;
389
390 ret = vc4_kms_load(dev: drm);
391 if (ret < 0)
392 goto err;
393
394 drm_for_each_crtc(crtc, drm)
395 vc4_crtc_disable_at_boot(crtc);
396
397 ret = drm_dev_register(dev: drm, flags: 0);
398 if (ret < 0)
399 goto err;
400
401 drm_client_setup_with_fourcc(dev: drm, DRM_FORMAT_RGB565);
402
403 return 0;
404
405err:
406 platform_set_drvdata(pdev, NULL);
407 return ret;
408}
409
410static void vc4_drm_unbind(struct device *dev)
411{
412 struct drm_device *drm = dev_get_drvdata(dev);
413
414 drm_dev_unplug(dev: drm);
415 drm_atomic_helper_shutdown(dev: drm);
416 dev_set_drvdata(dev, NULL);
417}
418
419static const struct component_master_ops vc4_drm_ops = {
420 .bind = vc4_drm_bind,
421 .unbind = vc4_drm_unbind,
422};
423
424/*
425 * This list determines the binding order of our components, and we have
426 * a few constraints:
427 * - The TXP driver needs to be bound before the PixelValves (CRTC)
428 * but after the HVS to set the possible_crtc field properly
429 * - The HDMI driver needs to be bound after the HVS so that we can
430 * lookup the HVS maximum core clock rate and figure out if we
431 * support 4kp60 or not.
432 */
433static struct platform_driver *const component_drivers[] = {
434 &vc4_hvs_driver,
435 &vc4_hdmi_driver,
436 &vc4_vec_driver,
437 &vc4_dpi_driver,
438 &vc4_dsi_driver,
439 &vc4_txp_driver,
440 &vc4_crtc_driver,
441 &vc4_v3d_driver,
442};
443
444static int vc4_platform_drm_probe(struct platform_device *pdev)
445{
446 struct component_match *match = NULL;
447 struct device *dev = &pdev->dev;
448
449 vc4_match_add_drivers(dev, match: &match,
450 drivers: component_drivers, ARRAY_SIZE(component_drivers));
451
452 return component_master_add_with_match(dev, &vc4_drm_ops, match);
453}
454
455static void vc4_platform_drm_remove(struct platform_device *pdev)
456{
457 component_master_del(&pdev->dev, &vc4_drm_ops);
458}
459
460static void vc4_platform_drm_shutdown(struct platform_device *pdev)
461{
462 drm_atomic_helper_shutdown(dev: platform_get_drvdata(pdev));
463}
464
465static const struct of_device_id vc4_of_match[] = {
466 { .compatible = "brcm,bcm2711-vc5", .data = (void *)VC4_GEN_5 },
467 /* NB GEN_6_C will be corrected on D0 hw to GEN_6_D via vc4_hvs_bind */
468 { .compatible = "brcm,bcm2712-vc6", .data = (void *)VC4_GEN_6_C },
469 { .compatible = "brcm,bcm2835-vc4", .data = (void *)VC4_GEN_4 },
470 { .compatible = "brcm,cygnus-vc4", .data = (void *)VC4_GEN_4 },
471 {},
472};
473MODULE_DEVICE_TABLE(of, vc4_of_match);
474
475static struct platform_driver vc4_platform_driver = {
476 .probe = vc4_platform_drm_probe,
477 .remove = vc4_platform_drm_remove,
478 .shutdown = vc4_platform_drm_shutdown,
479 .driver = {
480 .name = "vc4-drm",
481 .of_match_table = vc4_of_match,
482 },
483};
484
485static int __init vc4_drm_register(void)
486{
487 int ret;
488
489 if (drm_firmware_drivers_only())
490 return -ENODEV;
491
492 ret = platform_register_drivers(component_drivers,
493 ARRAY_SIZE(component_drivers));
494 if (ret)
495 return ret;
496
497 ret = platform_driver_register(&vc4_platform_driver);
498 if (ret)
499 platform_unregister_drivers(drivers: component_drivers,
500 ARRAY_SIZE(component_drivers));
501
502 return ret;
503}
504
505static void __exit vc4_drm_unregister(void)
506{
507 platform_unregister_drivers(drivers: component_drivers,
508 ARRAY_SIZE(component_drivers));
509 platform_driver_unregister(&vc4_platform_driver);
510}
511
512module_init(vc4_drm_register);
513module_exit(vc4_drm_unregister);
514
515MODULE_ALIAS("platform:vc4-drm");
516MODULE_SOFTDEP("pre: snd-soc-hdmi-codec");
517MODULE_DESCRIPTION("Broadcom VC4 DRM Driver");
518MODULE_AUTHOR("Eric Anholt <eric@anholt.net>");
519MODULE_LICENSE("GPL v2");
520

source code of linux/drivers/gpu/drm/vc4/vc4_drv.c