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_aperture.h>
34 #include <drm/drm_atomic_helper.h>
35 #include <drm/drm_drv.h>
36 #include <drm/drm_fb_cma_helper.h>
37 #include <drm/drm_fb_helper.h>
38 #include <drm/drm_vblank.h>
39
40 #include "uapi/drm/vc4_drm.h"
41
42 #include "vc4_drv.h"
43 #include "vc4_regs.h"
44
45 #define DRIVER_NAME "vc4"
46 #define DRIVER_DESC "Broadcom VC4 graphics"
47 #define DRIVER_DATE "20140616"
48 #define DRIVER_MAJOR 0
49 #define DRIVER_MINOR 0
50 #define DRIVER_PATCHLEVEL 0
51
52 /* Helper function for mapping the regs on a platform device. */
vc4_ioremap_regs(struct platform_device * dev,int index)53 void __iomem *vc4_ioremap_regs(struct platform_device *dev, int index)
54 {
55 struct resource *res;
56 void __iomem *map;
57
58 res = platform_get_resource(dev, IORESOURCE_MEM, index);
59 map = devm_ioremap_resource(&dev->dev, res);
60 if (IS_ERR(map))
61 return map;
62
63 return map;
64 }
65
vc4_get_param_ioctl(struct drm_device * dev,void * data,struct drm_file * file_priv)66 static int vc4_get_param_ioctl(struct drm_device *dev, void *data,
67 struct drm_file *file_priv)
68 {
69 struct vc4_dev *vc4 = to_vc4_dev(dev);
70 struct drm_vc4_get_param *args = data;
71 int ret;
72
73 if (args->pad != 0)
74 return -EINVAL;
75
76 if (!vc4->v3d)
77 return -ENODEV;
78
79 switch (args->param) {
80 case DRM_VC4_PARAM_V3D_IDENT0:
81 ret = vc4_v3d_pm_get(vc4);
82 if (ret)
83 return ret;
84 args->value = V3D_READ(V3D_IDENT0);
85 vc4_v3d_pm_put(vc4);
86 break;
87 case DRM_VC4_PARAM_V3D_IDENT1:
88 ret = vc4_v3d_pm_get(vc4);
89 if (ret)
90 return ret;
91 args->value = V3D_READ(V3D_IDENT1);
92 vc4_v3d_pm_put(vc4);
93 break;
94 case DRM_VC4_PARAM_V3D_IDENT2:
95 ret = vc4_v3d_pm_get(vc4);
96 if (ret)
97 return ret;
98 args->value = V3D_READ(V3D_IDENT2);
99 vc4_v3d_pm_put(vc4);
100 break;
101 case DRM_VC4_PARAM_SUPPORTS_BRANCHES:
102 case DRM_VC4_PARAM_SUPPORTS_ETC1:
103 case DRM_VC4_PARAM_SUPPORTS_THREADED_FS:
104 case DRM_VC4_PARAM_SUPPORTS_FIXED_RCL_ORDER:
105 case DRM_VC4_PARAM_SUPPORTS_MADVISE:
106 case DRM_VC4_PARAM_SUPPORTS_PERFMON:
107 args->value = true;
108 break;
109 default:
110 DRM_DEBUG("Unknown parameter %d\n", args->param);
111 return -EINVAL;
112 }
113
114 return 0;
115 }
116
vc4_open(struct drm_device * dev,struct drm_file * file)117 static int vc4_open(struct drm_device *dev, struct drm_file *file)
118 {
119 struct vc4_file *vc4file;
120
121 vc4file = kzalloc(sizeof(*vc4file), GFP_KERNEL);
122 if (!vc4file)
123 return -ENOMEM;
124
125 vc4_perfmon_open_file(vc4file);
126 file->driver_priv = vc4file;
127 return 0;
128 }
129
vc4_close(struct drm_device * dev,struct drm_file * file)130 static void vc4_close(struct drm_device *dev, struct drm_file *file)
131 {
132 struct vc4_dev *vc4 = to_vc4_dev(dev);
133 struct vc4_file *vc4file = file->driver_priv;
134
135 if (vc4file->bin_bo_used)
136 vc4_v3d_bin_bo_put(vc4);
137
138 vc4_perfmon_close_file(vc4file);
139 kfree(vc4file);
140 }
141
142 DEFINE_DRM_GEM_FOPS(vc4_drm_fops);
143
144 static const struct drm_ioctl_desc vc4_drm_ioctls[] = {
145 DRM_IOCTL_DEF_DRV(VC4_SUBMIT_CL, vc4_submit_cl_ioctl, DRM_RENDER_ALLOW),
146 DRM_IOCTL_DEF_DRV(VC4_WAIT_SEQNO, vc4_wait_seqno_ioctl, DRM_RENDER_ALLOW),
147 DRM_IOCTL_DEF_DRV(VC4_WAIT_BO, vc4_wait_bo_ioctl, DRM_RENDER_ALLOW),
148 DRM_IOCTL_DEF_DRV(VC4_CREATE_BO, vc4_create_bo_ioctl, DRM_RENDER_ALLOW),
149 DRM_IOCTL_DEF_DRV(VC4_MMAP_BO, vc4_mmap_bo_ioctl, DRM_RENDER_ALLOW),
150 DRM_IOCTL_DEF_DRV(VC4_CREATE_SHADER_BO, vc4_create_shader_bo_ioctl, DRM_RENDER_ALLOW),
151 DRM_IOCTL_DEF_DRV(VC4_GET_HANG_STATE, vc4_get_hang_state_ioctl,
152 DRM_ROOT_ONLY),
153 DRM_IOCTL_DEF_DRV(VC4_GET_PARAM, vc4_get_param_ioctl, DRM_RENDER_ALLOW),
154 DRM_IOCTL_DEF_DRV(VC4_SET_TILING, vc4_set_tiling_ioctl, DRM_RENDER_ALLOW),
155 DRM_IOCTL_DEF_DRV(VC4_GET_TILING, vc4_get_tiling_ioctl, DRM_RENDER_ALLOW),
156 DRM_IOCTL_DEF_DRV(VC4_LABEL_BO, vc4_label_bo_ioctl, DRM_RENDER_ALLOW),
157 DRM_IOCTL_DEF_DRV(VC4_GEM_MADVISE, vc4_gem_madvise_ioctl, DRM_RENDER_ALLOW),
158 DRM_IOCTL_DEF_DRV(VC4_PERFMON_CREATE, vc4_perfmon_create_ioctl, DRM_RENDER_ALLOW),
159 DRM_IOCTL_DEF_DRV(VC4_PERFMON_DESTROY, vc4_perfmon_destroy_ioctl, DRM_RENDER_ALLOW),
160 DRM_IOCTL_DEF_DRV(VC4_PERFMON_GET_VALUES, vc4_perfmon_get_values_ioctl, DRM_RENDER_ALLOW),
161 };
162
163 static struct drm_driver vc4_drm_driver = {
164 .driver_features = (DRIVER_MODESET |
165 DRIVER_ATOMIC |
166 DRIVER_GEM |
167 DRIVER_RENDER |
168 DRIVER_SYNCOBJ),
169 .open = vc4_open,
170 .postclose = vc4_close,
171
172 #if defined(CONFIG_DEBUG_FS)
173 .debugfs_init = vc4_debugfs_init,
174 #endif
175
176 .gem_create_object = vc4_create_object,
177
178 DRM_GEM_CMA_DRIVER_OPS_WITH_DUMB_CREATE(vc4_dumb_create),
179
180 .ioctls = vc4_drm_ioctls,
181 .num_ioctls = ARRAY_SIZE(vc4_drm_ioctls),
182 .fops = &vc4_drm_fops,
183
184 .name = DRIVER_NAME,
185 .desc = DRIVER_DESC,
186 .date = DRIVER_DATE,
187 .major = DRIVER_MAJOR,
188 .minor = DRIVER_MINOR,
189 .patchlevel = DRIVER_PATCHLEVEL,
190 };
191
compare_dev(struct device * dev,void * data)192 static int compare_dev(struct device *dev, void *data)
193 {
194 return dev == data;
195 }
196
vc4_match_add_drivers(struct device * dev,struct component_match ** match,struct platform_driver * const * drivers,int count)197 static void vc4_match_add_drivers(struct device *dev,
198 struct component_match **match,
199 struct platform_driver *const *drivers,
200 int count)
201 {
202 int i;
203
204 for (i = 0; i < count; i++) {
205 struct device_driver *drv = &drivers[i]->driver;
206 struct device *p = NULL, *d;
207
208 while ((d = platform_find_device_by_driver(p, drv))) {
209 put_device(p);
210 component_match_add(dev, match, compare_dev, d);
211 p = d;
212 }
213 put_device(p);
214 }
215 }
216
217 static const struct of_device_id vc4_dma_range_matches[] = {
218 { .compatible = "brcm,bcm2711-hvs" },
219 { .compatible = "brcm,bcm2835-hvs" },
220 { .compatible = "brcm,bcm2835-v3d" },
221 { .compatible = "brcm,cygnus-v3d" },
222 { .compatible = "brcm,vc4-v3d" },
223 {}
224 };
225
vc4_drm_bind(struct device * dev)226 static int vc4_drm_bind(struct device *dev)
227 {
228 struct platform_device *pdev = to_platform_device(dev);
229 struct drm_device *drm;
230 struct vc4_dev *vc4;
231 struct device_node *node;
232 struct drm_crtc *crtc;
233 int ret = 0;
234
235 dev->coherent_dma_mask = DMA_BIT_MASK(32);
236
237 /* If VC4 V3D is missing, don't advertise render nodes. */
238 node = of_find_matching_node_and_match(NULL, vc4_v3d_dt_match, NULL);
239 if (!node || !of_device_is_available(node))
240 vc4_drm_driver.driver_features &= ~DRIVER_RENDER;
241 of_node_put(node);
242
243 node = of_find_matching_node_and_match(NULL, vc4_dma_range_matches,
244 NULL);
245 if (node) {
246 ret = of_dma_configure(dev, node, true);
247 of_node_put(node);
248
249 if (ret)
250 return ret;
251 }
252
253 vc4 = devm_drm_dev_alloc(dev, &vc4_drm_driver, struct vc4_dev, base);
254 if (IS_ERR(vc4))
255 return PTR_ERR(vc4);
256
257 drm = &vc4->base;
258 platform_set_drvdata(pdev, drm);
259 INIT_LIST_HEAD(&vc4->debugfs_list);
260
261 mutex_init(&vc4->bin_bo_lock);
262
263 ret = vc4_bo_cache_init(drm);
264 if (ret)
265 return ret;
266
267 ret = drmm_mode_config_init(drm);
268 if (ret)
269 return ret;
270
271 ret = vc4_gem_init(drm);
272 if (ret)
273 return ret;
274
275 ret = component_bind_all(dev, drm);
276 if (ret)
277 return ret;
278
279 ret = vc4_plane_create_additional_planes(drm);
280 if (ret)
281 goto unbind_all;
282
283 ret = drm_aperture_remove_framebuffers(false, &vc4_drm_driver);
284 if (ret)
285 goto unbind_all;
286
287 ret = vc4_kms_load(drm);
288 if (ret < 0)
289 goto unbind_all;
290
291 drm_for_each_crtc(crtc, drm)
292 vc4_crtc_disable_at_boot(crtc);
293
294 ret = drm_dev_register(drm, 0);
295 if (ret < 0)
296 goto unbind_all;
297
298 drm_fbdev_generic_setup(drm, 16);
299
300 return 0;
301
302 unbind_all:
303 component_unbind_all(dev, drm);
304
305 return ret;
306 }
307
vc4_drm_unbind(struct device * dev)308 static void vc4_drm_unbind(struct device *dev)
309 {
310 struct drm_device *drm = dev_get_drvdata(dev);
311
312 drm_dev_unregister(drm);
313
314 drm_atomic_helper_shutdown(drm);
315 }
316
317 static const struct component_master_ops vc4_drm_ops = {
318 .bind = vc4_drm_bind,
319 .unbind = vc4_drm_unbind,
320 };
321
322 /*
323 * This list determines the binding order of our components, and we have
324 * a few constraints:
325 * - The TXP driver needs to be bound before the PixelValves (CRTC)
326 * but after the HVS to set the possible_crtc field properly
327 * - The HDMI driver needs to be bound after the HVS so that we can
328 * lookup the HVS maximum core clock rate and figure out if we
329 * support 4kp60 or not.
330 */
331 static struct platform_driver *const component_drivers[] = {
332 &vc4_hvs_driver,
333 &vc4_hdmi_driver,
334 &vc4_vec_driver,
335 &vc4_dpi_driver,
336 &vc4_dsi_driver,
337 &vc4_txp_driver,
338 &vc4_crtc_driver,
339 &vc4_v3d_driver,
340 };
341
vc4_platform_drm_probe(struct platform_device * pdev)342 static int vc4_platform_drm_probe(struct platform_device *pdev)
343 {
344 struct component_match *match = NULL;
345 struct device *dev = &pdev->dev;
346
347 vc4_match_add_drivers(dev, &match,
348 component_drivers, ARRAY_SIZE(component_drivers));
349
350 return component_master_add_with_match(dev, &vc4_drm_ops, match);
351 }
352
vc4_platform_drm_remove(struct platform_device * pdev)353 static int vc4_platform_drm_remove(struct platform_device *pdev)
354 {
355 component_master_del(&pdev->dev, &vc4_drm_ops);
356
357 return 0;
358 }
359
360 static const struct of_device_id vc4_of_match[] = {
361 { .compatible = "brcm,bcm2711-vc5", },
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
vc4_drm_register(void)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 ret = platform_driver_register(&vc4_platform_driver);
387 if (ret)
388 platform_unregister_drivers(component_drivers,
389 ARRAY_SIZE(component_drivers));
390
391 return ret;
392 }
393
vc4_drm_unregister(void)394 static void __exit vc4_drm_unregister(void)
395 {
396 platform_unregister_drivers(component_drivers,
397 ARRAY_SIZE(component_drivers));
398 platform_driver_unregister(&vc4_platform_driver);
399 }
400
401 module_init(vc4_drm_register);
402 module_exit(vc4_drm_unregister);
403
404 MODULE_ALIAS("platform:vc4-drm");
405 MODULE_SOFTDEP("pre: snd-soc-hdmi-codec");
406 MODULE_DESCRIPTION("Broadcom VC4 DRM Driver");
407 MODULE_AUTHOR("Eric Anholt <eric@anholt.net>");
408 MODULE_LICENSE("GPL v2");
409