1 // SPDX-License-Identifier: GPL-2.0
2 /* Copyright 2018 Marty E. Plummer <hanetzer@startmail.com> */
3 /* Copyright 2019 Linaro, Ltd., Rob Herring <robh@kernel.org> */
4 /* Copyright 2019 Collabora ltd. */
6 #include <linux/module.h>
7 #include <linux/of_platform.h>
8 #include <linux/pagemap.h>
9 #include <linux/pm_runtime.h>
10 #include <drm/panfrost_drm.h>
11 #include <drm/drm_drv.h>
12 #include <drm/drm_ioctl.h>
13 #include <drm/drm_syncobj.h>
14 #include <drm/drm_utils.h>
16 #include "panfrost_device.h"
17 #include "panfrost_devfreq.h"
18 #include "panfrost_gem.h"
19 #include "panfrost_mmu.h"
20 #include "panfrost_job.h"
21 #include "panfrost_gpu.h"
22 #include "panfrost_perfcnt.h"
24 static bool unstable_ioctls;
25 module_param_unsafe(unstable_ioctls, bool, 0600);
27 static int panfrost_ioctl_get_param(struct drm_device *ddev, void *data, struct drm_file *file)
29 struct drm_panfrost_get_param *param = data;
30 struct panfrost_device *pfdev = ddev->dev_private;
35 #define PANFROST_FEATURE(name, member) \
36 case DRM_PANFROST_PARAM_ ## name: \
37 param->value = pfdev->features.member; \
39 #define PANFROST_FEATURE_ARRAY(name, member, max) \
40 case DRM_PANFROST_PARAM_ ## name ## 0 ... \
41 DRM_PANFROST_PARAM_ ## name ## max: \
42 param->value = pfdev->features.member[param->param - \
43 DRM_PANFROST_PARAM_ ## name ## 0]; \
46 switch (param->param) {
47 PANFROST_FEATURE(GPU_PROD_ID, id);
48 PANFROST_FEATURE(GPU_REVISION, revision);
49 PANFROST_FEATURE(SHADER_PRESENT, shader_present);
50 PANFROST_FEATURE(TILER_PRESENT, tiler_present);
51 PANFROST_FEATURE(L2_PRESENT, l2_present);
52 PANFROST_FEATURE(STACK_PRESENT, stack_present);
53 PANFROST_FEATURE(AS_PRESENT, as_present);
54 PANFROST_FEATURE(JS_PRESENT, js_present);
55 PANFROST_FEATURE(L2_FEATURES, l2_features);
56 PANFROST_FEATURE(CORE_FEATURES, core_features);
57 PANFROST_FEATURE(TILER_FEATURES, tiler_features);
58 PANFROST_FEATURE(MEM_FEATURES, mem_features);
59 PANFROST_FEATURE(MMU_FEATURES, mmu_features);
60 PANFROST_FEATURE(THREAD_FEATURES, thread_features);
61 PANFROST_FEATURE(MAX_THREADS, max_threads);
62 PANFROST_FEATURE(THREAD_MAX_WORKGROUP_SZ,
63 thread_max_workgroup_sz);
64 PANFROST_FEATURE(THREAD_MAX_BARRIER_SZ,
65 thread_max_barrier_sz);
66 PANFROST_FEATURE(COHERENCY_FEATURES, coherency_features);
67 PANFROST_FEATURE_ARRAY(TEXTURE_FEATURES, texture_features, 3);
68 PANFROST_FEATURE_ARRAY(JS_FEATURES, js_features, 15);
69 PANFROST_FEATURE(NR_CORE_GROUPS, nr_core_groups);
70 PANFROST_FEATURE(THREAD_TLS_ALLOC, thread_tls_alloc);
78 static int panfrost_ioctl_create_bo(struct drm_device *dev, void *data,
79 struct drm_file *file)
81 struct panfrost_gem_object *bo;
82 struct drm_panfrost_create_bo *args = data;
84 if (!args->size || args->pad ||
85 (args->flags & ~(PANFROST_BO_NOEXEC | PANFROST_BO_HEAP)))
88 /* Heaps should never be executable */
89 if ((args->flags & PANFROST_BO_HEAP) &&
90 !(args->flags & PANFROST_BO_NOEXEC))
93 bo = panfrost_gem_create_with_handle(file, dev, args->size, args->flags,
98 args->offset = bo->node.start << PAGE_SHIFT;
104 * panfrost_lookup_bos() - Sets up job->bo[] with the GEM objects
105 * referenced by the job.
107 * @file_priv: DRM file for this fd
109 * @job: job being set up
111 * Resolve handles from userspace to BOs and attach them to job.
113 * Note that this function doesn't need to unreference the BOs on
114 * failure, because that will happen at panfrost_job_cleanup() time.
117 panfrost_lookup_bos(struct drm_device *dev,
118 struct drm_file *file_priv,
119 struct drm_panfrost_submit *args,
120 struct panfrost_job *job)
122 job->bo_count = args->bo_handle_count;
127 job->implicit_fences = kvmalloc_array(job->bo_count,
128 sizeof(struct dma_fence *),
129 GFP_KERNEL | __GFP_ZERO);
130 if (!job->implicit_fences)
133 return drm_gem_objects_lookup(file_priv,
134 (void __user *)(uintptr_t)args->bo_handles,
135 job->bo_count, &job->bos);
139 * panfrost_copy_in_sync() - Sets up job->in_fences[] with the sync objects
140 * referenced by the job.
142 * @file_priv: DRM file for this fd
144 * @job: job being set up
146 * Resolve syncobjs from userspace to fences and attach them to job.
148 * Note that this function doesn't need to unreference the fences on
149 * failure, because that will happen at panfrost_job_cleanup() time.
152 panfrost_copy_in_sync(struct drm_device *dev,
153 struct drm_file *file_priv,
154 struct drm_panfrost_submit *args,
155 struct panfrost_job *job)
161 job->in_fence_count = args->in_sync_count;
163 if (!job->in_fence_count)
166 job->in_fences = kvmalloc_array(job->in_fence_count,
167 sizeof(struct dma_fence *),
168 GFP_KERNEL | __GFP_ZERO);
169 if (!job->in_fences) {
170 DRM_DEBUG("Failed to allocate job in fences\n");
174 handles = kvmalloc_array(job->in_fence_count, sizeof(u32), GFP_KERNEL);
177 DRM_DEBUG("Failed to allocate incoming syncobj handles\n");
181 if (copy_from_user(handles,
182 (void __user *)(uintptr_t)args->in_syncs,
183 job->in_fence_count * sizeof(u32))) {
185 DRM_DEBUG("Failed to copy in syncobj handles\n");
189 for (i = 0; i < job->in_fence_count; i++) {
190 ret = drm_syncobj_find_fence(file_priv, handles[i], 0, 0,
201 static int panfrost_ioctl_submit(struct drm_device *dev, void *data,
202 struct drm_file *file)
204 struct panfrost_device *pfdev = dev->dev_private;
205 struct drm_panfrost_submit *args = data;
206 struct drm_syncobj *sync_out = NULL;
207 struct panfrost_job *job;
213 if (args->requirements && args->requirements != PANFROST_JD_REQ_FS)
216 if (args->out_sync > 0) {
217 sync_out = drm_syncobj_find(file, args->out_sync);
222 job = kzalloc(sizeof(*job), GFP_KERNEL);
228 kref_init(&job->refcount);
232 job->requirements = args->requirements;
233 job->flush_id = panfrost_gpu_get_latest_flush_id(pfdev);
234 job->file_priv = file->driver_priv;
236 ret = panfrost_copy_in_sync(dev, file, args, job);
240 ret = panfrost_lookup_bos(dev, file, args, job);
244 ret = panfrost_job_push(job);
248 /* Update the return sync object for the job */
250 drm_syncobj_replace_fence(sync_out, job->render_done_fence);
253 panfrost_job_put(job);
256 drm_syncobj_put(sync_out);
262 panfrost_ioctl_wait_bo(struct drm_device *dev, void *data,
263 struct drm_file *file_priv)
266 struct drm_panfrost_wait_bo *args = data;
267 struct drm_gem_object *gem_obj;
268 unsigned long timeout = drm_timeout_abs_to_jiffies(args->timeout_ns);
273 gem_obj = drm_gem_object_lookup(file_priv, args->handle);
277 ret = dma_resv_wait_timeout_rcu(gem_obj->resv, true,
280 ret = timeout ? -ETIMEDOUT : -EBUSY;
282 drm_gem_object_put_unlocked(gem_obj);
287 static int panfrost_ioctl_mmap_bo(struct drm_device *dev, void *data,
288 struct drm_file *file_priv)
290 struct drm_panfrost_mmap_bo *args = data;
291 struct drm_gem_object *gem_obj;
294 if (args->flags != 0) {
295 DRM_INFO("unknown mmap_bo flags: %d\n", args->flags);
299 gem_obj = drm_gem_object_lookup(file_priv, args->handle);
301 DRM_DEBUG("Failed to look up GEM BO %d\n", args->handle);
305 /* Don't allow mmapping of heap objects as pages are not pinned. */
306 if (to_panfrost_bo(gem_obj)->is_heap) {
311 ret = drm_gem_create_mmap_offset(gem_obj);
313 args->offset = drm_vma_node_offset_addr(&gem_obj->vma_node);
316 drm_gem_object_put_unlocked(gem_obj);
320 static int panfrost_ioctl_get_bo_offset(struct drm_device *dev, void *data,
321 struct drm_file *file_priv)
323 struct drm_panfrost_get_bo_offset *args = data;
324 struct drm_gem_object *gem_obj;
325 struct panfrost_gem_object *bo;
327 gem_obj = drm_gem_object_lookup(file_priv, args->handle);
329 DRM_DEBUG("Failed to look up GEM BO %d\n", args->handle);
332 bo = to_panfrost_bo(gem_obj);
334 args->offset = bo->node.start << PAGE_SHIFT;
336 drm_gem_object_put_unlocked(gem_obj);
340 static int panfrost_ioctl_madvise(struct drm_device *dev, void *data,
341 struct drm_file *file_priv)
343 struct drm_panfrost_madvise *args = data;
344 struct panfrost_device *pfdev = dev->dev_private;
345 struct drm_gem_object *gem_obj;
347 gem_obj = drm_gem_object_lookup(file_priv, args->handle);
349 DRM_DEBUG("Failed to look up GEM BO %d\n", args->handle);
353 mutex_lock(&pfdev->shrinker_lock);
354 args->retained = drm_gem_shmem_madvise(gem_obj, args->madv);
356 if (args->retained) {
357 struct panfrost_gem_object *bo = to_panfrost_bo(gem_obj);
359 if (args->madv == PANFROST_MADV_DONTNEED)
360 list_add_tail(&bo->base.madv_list,
361 &pfdev->shrinker_list);
362 else if (args->madv == PANFROST_MADV_WILLNEED)
363 list_del_init(&bo->base.madv_list);
365 mutex_unlock(&pfdev->shrinker_lock);
367 drm_gem_object_put_unlocked(gem_obj);
371 int panfrost_unstable_ioctl_check(void)
373 if (!unstable_ioctls)
379 #define PFN_4G (SZ_4G >> PAGE_SHIFT)
380 #define PFN_4G_MASK (PFN_4G - 1)
381 #define PFN_16M (SZ_16M >> PAGE_SHIFT)
383 static void panfrost_drm_mm_color_adjust(const struct drm_mm_node *node,
385 u64 *start, u64 *end)
387 /* Executable buffers can't start or end on a 4GB boundary */
388 if (!(color & PANFROST_BO_NOEXEC)) {
391 if ((*start & PFN_4G_MASK) == 0)
394 if ((*end & PFN_4G_MASK) == 0)
397 next_seg = ALIGN(*start, PFN_4G);
398 if (next_seg - *start <= PFN_16M)
399 *start = next_seg + 1;
401 *end = min(*end, ALIGN(*start, PFN_4G) - 1);
406 panfrost_open(struct drm_device *dev, struct drm_file *file)
409 struct panfrost_device *pfdev = dev->dev_private;
410 struct panfrost_file_priv *panfrost_priv;
412 panfrost_priv = kzalloc(sizeof(*panfrost_priv), GFP_KERNEL);
416 panfrost_priv->pfdev = pfdev;
417 file->driver_priv = panfrost_priv;
419 spin_lock_init(&panfrost_priv->mm_lock);
421 /* 4G enough for now. can be 48-bit */
422 drm_mm_init(&panfrost_priv->mm, SZ_32M >> PAGE_SHIFT, (SZ_4G - SZ_32M) >> PAGE_SHIFT);
423 panfrost_priv->mm.color_adjust = panfrost_drm_mm_color_adjust;
425 ret = panfrost_mmu_pgtable_alloc(panfrost_priv);
429 ret = panfrost_job_open(panfrost_priv);
436 panfrost_mmu_pgtable_free(panfrost_priv);
438 drm_mm_takedown(&panfrost_priv->mm);
439 kfree(panfrost_priv);
444 panfrost_postclose(struct drm_device *dev, struct drm_file *file)
446 struct panfrost_file_priv *panfrost_priv = file->driver_priv;
448 panfrost_perfcnt_close(file);
449 panfrost_job_close(panfrost_priv);
451 panfrost_mmu_pgtable_free(panfrost_priv);
452 drm_mm_takedown(&panfrost_priv->mm);
453 kfree(panfrost_priv);
456 static const struct drm_ioctl_desc panfrost_drm_driver_ioctls[] = {
457 #define PANFROST_IOCTL(n, func, flags) \
458 DRM_IOCTL_DEF_DRV(PANFROST_##n, panfrost_ioctl_##func, flags)
460 PANFROST_IOCTL(SUBMIT, submit, DRM_RENDER_ALLOW),
461 PANFROST_IOCTL(WAIT_BO, wait_bo, DRM_RENDER_ALLOW),
462 PANFROST_IOCTL(CREATE_BO, create_bo, DRM_RENDER_ALLOW),
463 PANFROST_IOCTL(MMAP_BO, mmap_bo, DRM_RENDER_ALLOW),
464 PANFROST_IOCTL(GET_PARAM, get_param, DRM_RENDER_ALLOW),
465 PANFROST_IOCTL(GET_BO_OFFSET, get_bo_offset, DRM_RENDER_ALLOW),
466 PANFROST_IOCTL(PERFCNT_ENABLE, perfcnt_enable, DRM_RENDER_ALLOW),
467 PANFROST_IOCTL(PERFCNT_DUMP, perfcnt_dump, DRM_RENDER_ALLOW),
468 PANFROST_IOCTL(MADVISE, madvise, DRM_RENDER_ALLOW),
471 DEFINE_DRM_GEM_FOPS(panfrost_drm_driver_fops);
474 * Panfrost driver version:
475 * - 1.0 - initial interface
476 * - 1.1 - adds HEAP and NOEXEC flags for CREATE_BO
478 static struct drm_driver panfrost_drm_driver = {
479 .driver_features = DRIVER_RENDER | DRIVER_GEM | DRIVER_SYNCOBJ,
480 .open = panfrost_open,
481 .postclose = panfrost_postclose,
482 .ioctls = panfrost_drm_driver_ioctls,
483 .num_ioctls = ARRAY_SIZE(panfrost_drm_driver_ioctls),
484 .fops = &panfrost_drm_driver_fops,
486 .desc = "panfrost DRM",
491 .gem_create_object = panfrost_gem_create_object,
492 .prime_handle_to_fd = drm_gem_prime_handle_to_fd,
493 .prime_fd_to_handle = drm_gem_prime_fd_to_handle,
494 .gem_prime_import_sg_table = panfrost_gem_prime_import_sg_table,
495 .gem_prime_mmap = drm_gem_prime_mmap,
498 static int panfrost_probe(struct platform_device *pdev)
500 struct panfrost_device *pfdev;
501 struct drm_device *ddev;
504 pfdev = devm_kzalloc(&pdev->dev, sizeof(*pfdev), GFP_KERNEL);
509 pfdev->dev = &pdev->dev;
511 platform_set_drvdata(pdev, pfdev);
513 /* Allocate and initialze the DRM device. */
514 ddev = drm_dev_alloc(&panfrost_drm_driver, &pdev->dev);
516 return PTR_ERR(ddev);
518 ddev->dev_private = pfdev;
521 mutex_init(&pfdev->shrinker_lock);
522 INIT_LIST_HEAD(&pfdev->shrinker_list);
524 err = panfrost_device_init(pfdev);
526 if (err != -EPROBE_DEFER)
527 dev_err(&pdev->dev, "Fatal error during GPU init\n");
531 err = panfrost_devfreq_init(pfdev);
533 if (err != -EPROBE_DEFER)
534 dev_err(&pdev->dev, "Fatal error during devfreq init\n");
538 pm_runtime_set_active(pfdev->dev);
539 pm_runtime_mark_last_busy(pfdev->dev);
540 pm_runtime_enable(pfdev->dev);
541 pm_runtime_set_autosuspend_delay(pfdev->dev, 50); /* ~3 frames */
542 pm_runtime_use_autosuspend(pfdev->dev);
545 * Register the DRM device with the core and the connectors with
548 err = drm_dev_register(ddev, 0);
552 panfrost_gem_shrinker_init(ddev);
557 pm_runtime_disable(pfdev->dev);
558 panfrost_devfreq_fini(pfdev);
560 panfrost_device_fini(pfdev);
566 static int panfrost_remove(struct platform_device *pdev)
568 struct panfrost_device *pfdev = platform_get_drvdata(pdev);
569 struct drm_device *ddev = pfdev->ddev;
571 drm_dev_unregister(ddev);
572 panfrost_gem_shrinker_cleanup(ddev);
574 pm_runtime_get_sync(pfdev->dev);
575 panfrost_devfreq_fini(pfdev);
576 panfrost_device_fini(pfdev);
577 pm_runtime_put_sync_suspend(pfdev->dev);
578 pm_runtime_disable(pfdev->dev);
584 static const struct of_device_id dt_match[] = {
585 { .compatible = "arm,mali-t604" },
586 { .compatible = "arm,mali-t624" },
587 { .compatible = "arm,mali-t628" },
588 { .compatible = "arm,mali-t720" },
589 { .compatible = "arm,mali-t760" },
590 { .compatible = "arm,mali-t820" },
591 { .compatible = "arm,mali-t830" },
592 { .compatible = "arm,mali-t860" },
593 { .compatible = "arm,mali-t880" },
596 MODULE_DEVICE_TABLE(of, dt_match);
598 static const struct dev_pm_ops panfrost_pm_ops = {
599 SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend, pm_runtime_force_resume)
600 SET_RUNTIME_PM_OPS(panfrost_device_suspend, panfrost_device_resume, NULL)
603 static struct platform_driver panfrost_driver = {
604 .probe = panfrost_probe,
605 .remove = panfrost_remove,
608 .pm = &panfrost_pm_ops,
609 .of_match_table = dt_match,
612 module_platform_driver(panfrost_driver);
614 MODULE_AUTHOR("Panfrost Project Developers");
615 MODULE_DESCRIPTION("Panfrost DRM Driver");
616 MODULE_LICENSE("GPL v2");