1 // SPDX-License-Identifier: GPL-2.0+
2 /* Copyright (C) 2014-2018 Broadcom */
5 * DOC: Broadcom V3D Graphics Driver
7 * This driver supports the Broadcom V3D 3.3 and 4.1 OpenGL ES GPUs.
8 * For V3D 2.x support, see the VC4 driver.
10 * The V3D GPU includes a tiled render (composed of a bin and render
11 * pipelines), the TFU (texture formatting unit), and the CSD (compute
15 #include <linux/clk.h>
16 #include <linux/device.h>
18 #include <linux/module.h>
19 #include <linux/of_platform.h>
20 #include <linux/platform_device.h>
21 #include <linux/pm_runtime.h>
22 #include <linux/reset.h>
23 #include <drm/drm_fb_cma_helper.h>
24 #include <drm/drm_fb_helper.h>
26 #include "uapi/drm/v3d_drm.h"
30 #define DRIVER_NAME "v3d"
31 #define DRIVER_DESC "Broadcom V3D graphics"
32 #define DRIVER_DATE "20180419"
33 #define DRIVER_MAJOR 1
34 #define DRIVER_MINOR 0
35 #define DRIVER_PATCHLEVEL 0
38 static int v3d_runtime_suspend(struct device *dev)
40 struct drm_device *drm = dev_get_drvdata(dev);
41 struct v3d_dev *v3d = to_v3d_dev(drm);
45 clk_disable_unprepare(v3d->clk);
50 static int v3d_runtime_resume(struct device *dev)
52 struct drm_device *drm = dev_get_drvdata(dev);
53 struct v3d_dev *v3d = to_v3d_dev(drm);
56 ret = clk_prepare_enable(v3d->clk);
62 v3d_mmu_set_page_table(v3d);
69 static const struct dev_pm_ops v3d_pm_ops = {
70 SET_RUNTIME_PM_OPS(v3d_runtime_suspend, v3d_runtime_resume, NULL)
73 static int v3d_get_param_ioctl(struct drm_device *dev, void *data,
74 struct drm_file *file_priv)
76 struct v3d_dev *v3d = to_v3d_dev(dev);
77 struct drm_v3d_get_param *args = data;
78 static const u32 reg_map[] = {
79 [DRM_V3D_PARAM_V3D_UIFCFG] = V3D_HUB_UIFCFG,
80 [DRM_V3D_PARAM_V3D_HUB_IDENT1] = V3D_HUB_IDENT1,
81 [DRM_V3D_PARAM_V3D_HUB_IDENT2] = V3D_HUB_IDENT2,
82 [DRM_V3D_PARAM_V3D_HUB_IDENT3] = V3D_HUB_IDENT3,
83 [DRM_V3D_PARAM_V3D_CORE0_IDENT0] = V3D_CTL_IDENT0,
84 [DRM_V3D_PARAM_V3D_CORE0_IDENT1] = V3D_CTL_IDENT1,
85 [DRM_V3D_PARAM_V3D_CORE0_IDENT2] = V3D_CTL_IDENT2,
91 /* Note that DRM_V3D_PARAM_V3D_CORE0_IDENT0 is 0, so we need
92 * to explicitly allow it in the "the register in our
93 * parameter map" check.
95 if (args->param < ARRAY_SIZE(reg_map) &&
96 (reg_map[args->param] ||
97 args->param == DRM_V3D_PARAM_V3D_CORE0_IDENT0)) {
98 u32 offset = reg_map[args->param];
100 if (args->value != 0)
103 if (args->param >= DRM_V3D_PARAM_V3D_CORE0_IDENT0 &&
104 args->param <= DRM_V3D_PARAM_V3D_CORE0_IDENT2) {
105 args->value = V3D_CORE_READ(0, offset);
107 args->value = V3D_READ(offset);
113 switch (args->param) {
114 case DRM_V3D_PARAM_SUPPORTS_TFU:
117 case DRM_V3D_PARAM_SUPPORTS_CSD:
118 args->value = v3d_has_csd(v3d);
120 case DRM_V3D_PARAM_SUPPORTS_CACHE_FLUSH:
124 DRM_DEBUG("Unknown parameter %d\n", args->param);
130 v3d_open(struct drm_device *dev, struct drm_file *file)
132 struct v3d_dev *v3d = to_v3d_dev(dev);
133 struct v3d_file_priv *v3d_priv;
134 struct drm_sched_rq *rq;
137 v3d_priv = kzalloc(sizeof(*v3d_priv), GFP_KERNEL);
143 for (i = 0; i < V3D_MAX_QUEUES; i++) {
144 rq = &v3d->queue[i].sched.sched_rq[DRM_SCHED_PRIORITY_NORMAL];
145 drm_sched_entity_init(&v3d_priv->sched_entity[i], &rq, 1, NULL);
148 file->driver_priv = v3d_priv;
154 v3d_postclose(struct drm_device *dev, struct drm_file *file)
156 struct v3d_file_priv *v3d_priv = file->driver_priv;
159 for (q = 0; q < V3D_MAX_QUEUES; q++) {
160 drm_sched_entity_destroy(&v3d_priv->sched_entity[q]);
166 static const struct file_operations v3d_drm_fops = {
167 .owner = THIS_MODULE,
169 .release = drm_release,
170 .unlocked_ioctl = drm_ioctl,
174 .compat_ioctl = drm_compat_ioctl,
175 .llseek = noop_llseek,
178 /* DRM_AUTH is required on SUBMIT_CL for now, while we don't have GMP
179 * protection between clients. Note that render nodes would be be
180 * able to submit CLs that could access BOs from clients authenticated
181 * with the master node. The TFU doesn't use the GMP, so it would
182 * need to stay DRM_AUTH until we do buffer size/offset validation.
184 static const struct drm_ioctl_desc v3d_drm_ioctls[] = {
185 DRM_IOCTL_DEF_DRV(V3D_SUBMIT_CL, v3d_submit_cl_ioctl, DRM_RENDER_ALLOW | DRM_AUTH),
186 DRM_IOCTL_DEF_DRV(V3D_WAIT_BO, v3d_wait_bo_ioctl, DRM_RENDER_ALLOW),
187 DRM_IOCTL_DEF_DRV(V3D_CREATE_BO, v3d_create_bo_ioctl, DRM_RENDER_ALLOW),
188 DRM_IOCTL_DEF_DRV(V3D_MMAP_BO, v3d_mmap_bo_ioctl, DRM_RENDER_ALLOW),
189 DRM_IOCTL_DEF_DRV(V3D_GET_PARAM, v3d_get_param_ioctl, DRM_RENDER_ALLOW),
190 DRM_IOCTL_DEF_DRV(V3D_GET_BO_OFFSET, v3d_get_bo_offset_ioctl, DRM_RENDER_ALLOW),
191 DRM_IOCTL_DEF_DRV(V3D_SUBMIT_TFU, v3d_submit_tfu_ioctl, DRM_RENDER_ALLOW | DRM_AUTH),
192 DRM_IOCTL_DEF_DRV(V3D_SUBMIT_CSD, v3d_submit_csd_ioctl, DRM_RENDER_ALLOW | DRM_AUTH),
195 static const struct vm_operations_struct v3d_vm_ops = {
196 .fault = v3d_gem_fault,
197 .open = drm_gem_vm_open,
198 .close = drm_gem_vm_close,
201 static struct drm_driver v3d_drm_driver = {
202 .driver_features = (DRIVER_GEM |
208 .postclose = v3d_postclose,
210 #if defined(CONFIG_DEBUG_FS)
211 .debugfs_init = v3d_debugfs_init,
214 .gem_free_object_unlocked = v3d_free_object,
215 .gem_vm_ops = &v3d_vm_ops,
217 .prime_handle_to_fd = drm_gem_prime_handle_to_fd,
218 .prime_fd_to_handle = drm_gem_prime_fd_to_handle,
219 .gem_prime_import = drm_gem_prime_import,
220 .gem_prime_export = drm_gem_prime_export,
221 .gem_prime_res_obj = v3d_prime_res_obj,
222 .gem_prime_get_sg_table = v3d_prime_get_sg_table,
223 .gem_prime_import_sg_table = v3d_prime_import_sg_table,
224 .gem_prime_mmap = v3d_prime_mmap,
226 .ioctls = v3d_drm_ioctls,
227 .num_ioctls = ARRAY_SIZE(v3d_drm_ioctls),
228 .fops = &v3d_drm_fops,
233 .major = DRIVER_MAJOR,
234 .minor = DRIVER_MINOR,
235 .patchlevel = DRIVER_PATCHLEVEL,
238 static const struct of_device_id v3d_of_match[] = {
239 { .compatible = "brcm,7268-v3d" },
240 { .compatible = "brcm,7278-v3d" },
241 { .compatible = "brcm,2711-v3d" },
244 MODULE_DEVICE_TABLE(of, v3d_of_match);
247 map_regs(struct v3d_dev *v3d, void __iomem **regs, const char *name)
249 struct resource *res =
250 platform_get_resource_byname(v3d->pdev, IORESOURCE_MEM, name);
252 *regs = devm_ioremap_resource(v3d->dev, res);
253 return PTR_ERR_OR_ZERO(*regs);
256 static int v3d_platform_drm_probe(struct platform_device *pdev)
258 struct device *dev = &pdev->dev;
259 struct drm_device *drm;
264 dev->coherent_dma_mask = DMA_BIT_MASK(36);
266 v3d = kzalloc(sizeof(*v3d), GFP_KERNEL);
273 ret = map_regs(v3d, &v3d->hub_regs, "hub");
277 ret = map_regs(v3d, &v3d->core_regs[0], "core0");
281 ident1 = V3D_READ(V3D_HUB_IDENT1);
282 v3d->ver = (V3D_GET_FIELD(ident1, V3D_HUB_IDENT1_TVER) * 10 +
283 V3D_GET_FIELD(ident1, V3D_HUB_IDENT1_REV));
284 v3d->cores = V3D_GET_FIELD(ident1, V3D_HUB_IDENT1_NCORES);
285 WARN_ON(v3d->cores > 1); /* multicore not yet implemented */
287 v3d->reset = devm_reset_control_get_exclusive(dev, NULL);
288 if (IS_ERR(v3d->reset)) {
289 ret = PTR_ERR(v3d->reset);
291 if (ret == -EPROBE_DEFER)
295 ret = map_regs(v3d, &v3d->bridge_regs, "bridge");
298 "Failed to get reset control or bridge regs\n");
303 v3d->clk = devm_clk_get(dev, NULL);
304 if (IS_ERR(v3d->clk)) {
305 if (ret != -EPROBE_DEFER)
306 dev_err(dev, "Failed to get clock\n");
309 v3d->clk_up_rate = clk_get_rate(v3d->clk);
310 /* For downclocking, drop it to the minimum frequency we can get from
311 * the CPRMAN clock generator dividing off our parent. The divider is
312 * 4 bits, but ask for just higher than that so that rounding doesn't
313 * make cprman reject our rate.
316 (clk_get_rate(clk_get_parent(v3d->clk)) / (1 << 4)) + 10000;
319 ret = map_regs(v3d, &v3d->gca_regs, "gca");
324 v3d->mmu_scratch = dma_alloc_wc(dev, 4096, &v3d->mmu_scratch_paddr,
325 GFP_KERNEL | __GFP_NOWARN | __GFP_ZERO);
326 if (!v3d->mmu_scratch) {
327 dev_err(dev, "Failed to allocate MMU scratch page\n");
333 ret = drm_dev_init(&v3d->drm, &v3d_drm_driver, dev);
337 platform_set_drvdata(pdev, drm);
338 drm->dev_private = v3d;
340 ret = v3d_gem_init(drm);
344 ret = v3d_irq_init(v3d);
348 ret = drm_dev_register(drm, 0);
352 ret = clk_set_rate(v3d->clk, v3d->clk_down_rate);
353 WARN_ON_ONCE(ret != 0);
358 v3d_irq_disable(v3d);
360 v3d_gem_destroy(drm);
364 dma_free_wc(dev, 4096, v3d->mmu_scratch, v3d->mmu_scratch_paddr);
370 static int v3d_platform_drm_remove(struct platform_device *pdev)
372 struct drm_device *drm = platform_get_drvdata(pdev);
373 struct v3d_dev *v3d = to_v3d_dev(drm);
375 drm_dev_unregister(drm);
377 v3d_gem_destroy(drm);
381 dma_free_wc(v3d->dev, 4096, v3d->mmu_scratch, v3d->mmu_scratch_paddr);
386 static struct platform_driver v3d_platform_driver = {
387 .probe = v3d_platform_drm_probe,
388 .remove = v3d_platform_drm_remove,
391 .of_match_table = v3d_of_match,
396 static int __init v3d_drm_register(void)
398 return platform_driver_register(&v3d_platform_driver);
401 static void __exit v3d_drm_unregister(void)
403 platform_driver_unregister(&v3d_platform_driver);
406 module_init(v3d_drm_register);
407 module_exit(v3d_drm_unregister);
409 MODULE_ALIAS("platform:v3d-drm");
410 MODULE_DESCRIPTION("Broadcom V3D DRM Driver");
411 MODULE_AUTHOR("Eric Anholt <eric@anholt.net>");
412 MODULE_LICENSE("GPL v2");