1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2015-2018 Etnaviv Project
6 #include <drm/drm_prime.h>
7 #include <linux/dma-mapping.h>
8 #include <linux/shmem_fs.h>
9 #include <linux/spinlock.h>
10 #include <linux/vmalloc.h>
12 #include "etnaviv_drv.h"
13 #include "etnaviv_gem.h"
14 #include "etnaviv_gpu.h"
15 #include "etnaviv_mmu.h"
17 static struct lock_class_key etnaviv_shm_lock_class;
18 static struct lock_class_key etnaviv_userptr_lock_class;
20 static void etnaviv_gem_scatter_map(struct etnaviv_gem_object *etnaviv_obj)
22 struct drm_device *dev = etnaviv_obj->base.dev;
23 struct sg_table *sgt = etnaviv_obj->sgt;
26 * For non-cached buffers, ensure the new pages are clean
27 * because display controller, GPU, etc. are not coherent.
29 if (etnaviv_obj->flags & ETNA_BO_CACHE_MASK)
30 dma_map_sg(dev->dev, sgt->sgl, sgt->nents, DMA_BIDIRECTIONAL);
33 static void etnaviv_gem_scatterlist_unmap(struct etnaviv_gem_object *etnaviv_obj)
35 struct drm_device *dev = etnaviv_obj->base.dev;
36 struct sg_table *sgt = etnaviv_obj->sgt;
39 * For non-cached buffers, ensure the new pages are clean
40 * because display controller, GPU, etc. are not coherent:
42 * WARNING: The DMA API does not support concurrent CPU
43 * and device access to the memory area. With BIDIRECTIONAL,
44 * we will clean the cache lines which overlap the region,
45 * and invalidate all cache lines (partially) contained in
48 * If you have dirty data in the overlapping cache lines,
49 * that will corrupt the GPU-written data. If you have
50 * written into the remainder of the region, this can
51 * discard those writes.
53 if (etnaviv_obj->flags & ETNA_BO_CACHE_MASK)
54 dma_unmap_sg(dev->dev, sgt->sgl, sgt->nents, DMA_BIDIRECTIONAL);
57 /* called with etnaviv_obj->lock held */
58 static int etnaviv_gem_shmem_get_pages(struct etnaviv_gem_object *etnaviv_obj)
60 struct drm_device *dev = etnaviv_obj->base.dev;
61 struct page **p = drm_gem_get_pages(&etnaviv_obj->base);
64 dev_dbg(dev->dev, "could not get pages: %ld\n", PTR_ERR(p));
68 etnaviv_obj->pages = p;
73 static void put_pages(struct etnaviv_gem_object *etnaviv_obj)
75 if (etnaviv_obj->sgt) {
76 etnaviv_gem_scatterlist_unmap(etnaviv_obj);
77 sg_free_table(etnaviv_obj->sgt);
78 kfree(etnaviv_obj->sgt);
79 etnaviv_obj->sgt = NULL;
81 if (etnaviv_obj->pages) {
82 drm_gem_put_pages(&etnaviv_obj->base, etnaviv_obj->pages,
85 etnaviv_obj->pages = NULL;
89 struct page **etnaviv_gem_get_pages(struct etnaviv_gem_object *etnaviv_obj)
93 lockdep_assert_held(&etnaviv_obj->lock);
95 if (!etnaviv_obj->pages) {
96 ret = etnaviv_obj->ops->get_pages(etnaviv_obj);
101 if (!etnaviv_obj->sgt) {
102 struct drm_device *dev = etnaviv_obj->base.dev;
103 int npages = etnaviv_obj->base.size >> PAGE_SHIFT;
104 struct sg_table *sgt;
106 sgt = drm_prime_pages_to_sg(etnaviv_obj->pages, npages);
108 dev_err(dev->dev, "failed to allocate sgt: %ld\n",
110 return ERR_CAST(sgt);
113 etnaviv_obj->sgt = sgt;
115 etnaviv_gem_scatter_map(etnaviv_obj);
118 return etnaviv_obj->pages;
121 void etnaviv_gem_put_pages(struct etnaviv_gem_object *etnaviv_obj)
123 lockdep_assert_held(&etnaviv_obj->lock);
124 /* when we start tracking the pin count, then do something here */
127 static int etnaviv_gem_mmap_obj(struct etnaviv_gem_object *etnaviv_obj,
128 struct vm_area_struct *vma)
130 pgprot_t vm_page_prot;
132 vma->vm_flags &= ~VM_PFNMAP;
133 vma->vm_flags |= VM_MIXEDMAP;
135 vm_page_prot = vm_get_page_prot(vma->vm_flags);
137 if (etnaviv_obj->flags & ETNA_BO_WC) {
138 vma->vm_page_prot = pgprot_writecombine(vm_page_prot);
139 } else if (etnaviv_obj->flags & ETNA_BO_UNCACHED) {
140 vma->vm_page_prot = pgprot_noncached(vm_page_prot);
143 * Shunt off cached objs to shmem file so they have their own
144 * address_space (so unmap_mapping_range does what we want,
145 * in particular in the case of mmap'd dmabufs)
148 get_file(etnaviv_obj->base.filp);
150 vma->vm_file = etnaviv_obj->base.filp;
152 vma->vm_page_prot = vm_page_prot;
158 int etnaviv_gem_mmap(struct file *filp, struct vm_area_struct *vma)
160 struct etnaviv_gem_object *obj;
163 ret = drm_gem_mmap(filp, vma);
165 DBG("mmap failed: %d", ret);
169 obj = to_etnaviv_bo(vma->vm_private_data);
170 return obj->ops->mmap(obj, vma);
173 vm_fault_t etnaviv_gem_fault(struct vm_fault *vmf)
175 struct vm_area_struct *vma = vmf->vma;
176 struct drm_gem_object *obj = vma->vm_private_data;
177 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
178 struct page **pages, *page;
183 * Make sure we don't parallel update on a fault, nor move or remove
184 * something from beneath our feet. Note that vmf_insert_page() is
185 * specifically coded to take care of this, so we don't have to.
187 err = mutex_lock_interruptible(&etnaviv_obj->lock);
189 return VM_FAULT_NOPAGE;
190 /* make sure we have pages attached now */
191 pages = etnaviv_gem_get_pages(etnaviv_obj);
192 mutex_unlock(&etnaviv_obj->lock);
195 err = PTR_ERR(pages);
196 return vmf_error(err);
199 /* We don't use vmf->pgoff since that has the fake offset: */
200 pgoff = (vmf->address - vma->vm_start) >> PAGE_SHIFT;
204 VERB("Inserting %p pfn %lx, pa %lx", (void *)vmf->address,
205 page_to_pfn(page), page_to_pfn(page) << PAGE_SHIFT);
207 return vmf_insert_page(vma, vmf->address, page);
210 int etnaviv_gem_mmap_offset(struct drm_gem_object *obj, u64 *offset)
214 /* Make it mmapable */
215 ret = drm_gem_create_mmap_offset(obj);
217 dev_err(obj->dev->dev, "could not allocate mmap offset\n");
219 *offset = drm_vma_node_offset_addr(&obj->vma_node);
224 static struct etnaviv_vram_mapping *
225 etnaviv_gem_get_vram_mapping(struct etnaviv_gem_object *obj,
226 struct etnaviv_iommu *mmu)
228 struct etnaviv_vram_mapping *mapping;
230 list_for_each_entry(mapping, &obj->vram_list, obj_node) {
231 if (mapping->mmu == mmu)
238 void etnaviv_gem_mapping_reference(struct etnaviv_vram_mapping *mapping)
240 struct etnaviv_gem_object *etnaviv_obj = mapping->object;
242 drm_gem_object_get(&etnaviv_obj->base);
244 mutex_lock(&etnaviv_obj->lock);
245 WARN_ON(mapping->use == 0);
247 mutex_unlock(&etnaviv_obj->lock);
250 void etnaviv_gem_mapping_unreference(struct etnaviv_vram_mapping *mapping)
252 struct etnaviv_gem_object *etnaviv_obj = mapping->object;
254 mutex_lock(&etnaviv_obj->lock);
255 WARN_ON(mapping->use == 0);
257 mutex_unlock(&etnaviv_obj->lock);
259 drm_gem_object_put_unlocked(&etnaviv_obj->base);
262 struct etnaviv_vram_mapping *etnaviv_gem_mapping_get(
263 struct drm_gem_object *obj, struct etnaviv_gpu *gpu)
265 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
266 struct etnaviv_vram_mapping *mapping;
270 mutex_lock(&etnaviv_obj->lock);
271 mapping = etnaviv_gem_get_vram_mapping(etnaviv_obj, gpu->mmu);
274 * Holding the object lock prevents the use count changing
275 * beneath us. If the use count is zero, the MMU might be
276 * reaping this object, so take the lock and re-check that
277 * the MMU owns this mapping to close this race.
279 if (mapping->use == 0) {
280 mutex_lock(&gpu->mmu->lock);
281 if (mapping->mmu == gpu->mmu)
285 mutex_unlock(&gpu->mmu->lock);
294 pages = etnaviv_gem_get_pages(etnaviv_obj);
296 ret = PTR_ERR(pages);
301 * See if we have a reaped vram mapping we can re-use before
302 * allocating a fresh mapping.
304 mapping = etnaviv_gem_get_vram_mapping(etnaviv_obj, NULL);
306 mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
312 INIT_LIST_HEAD(&mapping->scan_node);
313 mapping->object = etnaviv_obj;
315 list_del(&mapping->obj_node);
318 mapping->mmu = gpu->mmu;
321 ret = etnaviv_iommu_map_gem(gpu->mmu, etnaviv_obj, gpu->memory_base,
326 list_add_tail(&mapping->obj_node, &etnaviv_obj->vram_list);
329 mutex_unlock(&etnaviv_obj->lock);
334 /* Take a reference on the object */
335 drm_gem_object_get(obj);
339 void *etnaviv_gem_vmap(struct drm_gem_object *obj)
341 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
343 if (etnaviv_obj->vaddr)
344 return etnaviv_obj->vaddr;
346 mutex_lock(&etnaviv_obj->lock);
348 * Need to check again, as we might have raced with another thread
349 * while waiting for the mutex.
351 if (!etnaviv_obj->vaddr)
352 etnaviv_obj->vaddr = etnaviv_obj->ops->vmap(etnaviv_obj);
353 mutex_unlock(&etnaviv_obj->lock);
355 return etnaviv_obj->vaddr;
358 static void *etnaviv_gem_vmap_impl(struct etnaviv_gem_object *obj)
362 lockdep_assert_held(&obj->lock);
364 pages = etnaviv_gem_get_pages(obj);
368 return vmap(pages, obj->base.size >> PAGE_SHIFT,
369 VM_MAP, pgprot_writecombine(PAGE_KERNEL));
372 static inline enum dma_data_direction etnaviv_op_to_dma_dir(u32 op)
374 if (op & ETNA_PREP_READ)
375 return DMA_FROM_DEVICE;
376 else if (op & ETNA_PREP_WRITE)
377 return DMA_TO_DEVICE;
379 return DMA_BIDIRECTIONAL;
382 int etnaviv_gem_cpu_prep(struct drm_gem_object *obj, u32 op,
383 struct timespec *timeout)
385 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
386 struct drm_device *dev = obj->dev;
387 bool write = !!(op & ETNA_PREP_WRITE);
390 if (!etnaviv_obj->sgt) {
393 mutex_lock(&etnaviv_obj->lock);
394 ret = etnaviv_gem_get_pages(etnaviv_obj);
395 mutex_unlock(&etnaviv_obj->lock);
400 if (op & ETNA_PREP_NOSYNC) {
401 if (!reservation_object_test_signaled_rcu(obj->resv,
405 unsigned long remain = etnaviv_timeout_to_jiffies(timeout);
407 ret = reservation_object_wait_timeout_rcu(obj->resv,
408 write, true, remain);
410 return ret == 0 ? -ETIMEDOUT : ret;
413 if (etnaviv_obj->flags & ETNA_BO_CACHED) {
414 dma_sync_sg_for_cpu(dev->dev, etnaviv_obj->sgt->sgl,
415 etnaviv_obj->sgt->nents,
416 etnaviv_op_to_dma_dir(op));
417 etnaviv_obj->last_cpu_prep_op = op;
423 int etnaviv_gem_cpu_fini(struct drm_gem_object *obj)
425 struct drm_device *dev = obj->dev;
426 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
428 if (etnaviv_obj->flags & ETNA_BO_CACHED) {
429 /* fini without a prep is almost certainly a userspace error */
430 WARN_ON(etnaviv_obj->last_cpu_prep_op == 0);
431 dma_sync_sg_for_device(dev->dev, etnaviv_obj->sgt->sgl,
432 etnaviv_obj->sgt->nents,
433 etnaviv_op_to_dma_dir(etnaviv_obj->last_cpu_prep_op));
434 etnaviv_obj->last_cpu_prep_op = 0;
440 int etnaviv_gem_wait_bo(struct etnaviv_gpu *gpu, struct drm_gem_object *obj,
441 struct timespec *timeout)
443 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
445 return etnaviv_gpu_wait_obj_inactive(gpu, etnaviv_obj, timeout);
448 #ifdef CONFIG_DEBUG_FS
449 static void etnaviv_gem_describe_fence(struct dma_fence *fence,
450 const char *type, struct seq_file *m)
452 if (!test_bit(DMA_FENCE_FLAG_SIGNALED_BIT, &fence->flags))
453 seq_printf(m, "\t%9s: %s %s seq %llu\n",
455 fence->ops->get_driver_name(fence),
456 fence->ops->get_timeline_name(fence),
460 static void etnaviv_gem_describe(struct drm_gem_object *obj, struct seq_file *m)
462 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
463 struct reservation_object *robj = obj->resv;
464 struct reservation_object_list *fobj;
465 struct dma_fence *fence;
466 unsigned long off = drm_vma_node_start(&obj->vma_node);
468 seq_printf(m, "%08x: %c %2d (%2d) %08lx %p %zd\n",
469 etnaviv_obj->flags, is_active(etnaviv_obj) ? 'A' : 'I',
470 obj->name, kref_read(&obj->refcount),
471 off, etnaviv_obj->vaddr, obj->size);
474 fobj = rcu_dereference(robj->fence);
476 unsigned int i, shared_count = fobj->shared_count;
478 for (i = 0; i < shared_count; i++) {
479 fence = rcu_dereference(fobj->shared[i]);
480 etnaviv_gem_describe_fence(fence, "Shared", m);
484 fence = rcu_dereference(robj->fence_excl);
486 etnaviv_gem_describe_fence(fence, "Exclusive", m);
490 void etnaviv_gem_describe_objects(struct etnaviv_drm_private *priv,
493 struct etnaviv_gem_object *etnaviv_obj;
497 mutex_lock(&priv->gem_lock);
498 list_for_each_entry(etnaviv_obj, &priv->gem_list, gem_node) {
499 struct drm_gem_object *obj = &etnaviv_obj->base;
502 etnaviv_gem_describe(obj, m);
506 mutex_unlock(&priv->gem_lock);
508 seq_printf(m, "Total %d objects, %zu bytes\n", count, size);
512 static void etnaviv_gem_shmem_release(struct etnaviv_gem_object *etnaviv_obj)
514 vunmap(etnaviv_obj->vaddr);
515 put_pages(etnaviv_obj);
518 static const struct etnaviv_gem_ops etnaviv_gem_shmem_ops = {
519 .get_pages = etnaviv_gem_shmem_get_pages,
520 .release = etnaviv_gem_shmem_release,
521 .vmap = etnaviv_gem_vmap_impl,
522 .mmap = etnaviv_gem_mmap_obj,
525 void etnaviv_gem_free_object(struct drm_gem_object *obj)
527 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
528 struct etnaviv_drm_private *priv = obj->dev->dev_private;
529 struct etnaviv_vram_mapping *mapping, *tmp;
531 /* object should not be active */
532 WARN_ON(is_active(etnaviv_obj));
534 mutex_lock(&priv->gem_lock);
535 list_del(&etnaviv_obj->gem_node);
536 mutex_unlock(&priv->gem_lock);
538 list_for_each_entry_safe(mapping, tmp, &etnaviv_obj->vram_list,
540 struct etnaviv_iommu *mmu = mapping->mmu;
542 WARN_ON(mapping->use);
545 etnaviv_iommu_unmap_gem(mmu, mapping);
547 list_del(&mapping->obj_node);
551 drm_gem_free_mmap_offset(obj);
552 etnaviv_obj->ops->release(etnaviv_obj);
553 drm_gem_object_release(obj);
558 void etnaviv_gem_obj_add(struct drm_device *dev, struct drm_gem_object *obj)
560 struct etnaviv_drm_private *priv = dev->dev_private;
561 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
563 mutex_lock(&priv->gem_lock);
564 list_add_tail(&etnaviv_obj->gem_node, &priv->gem_list);
565 mutex_unlock(&priv->gem_lock);
568 static int etnaviv_gem_new_impl(struct drm_device *dev, u32 size, u32 flags,
569 struct reservation_object *robj, const struct etnaviv_gem_ops *ops,
570 struct drm_gem_object **obj)
572 struct etnaviv_gem_object *etnaviv_obj;
573 unsigned sz = sizeof(*etnaviv_obj);
577 switch (flags & ETNA_BO_CACHE_MASK) {
578 case ETNA_BO_UNCACHED:
587 dev_err(dev->dev, "invalid cache flag: %x\n",
588 (flags & ETNA_BO_CACHE_MASK));
592 etnaviv_obj = kzalloc(sz, GFP_KERNEL);
596 etnaviv_obj->flags = flags;
597 etnaviv_obj->ops = ops;
599 etnaviv_obj->base.resv = robj;
601 mutex_init(&etnaviv_obj->lock);
602 INIT_LIST_HEAD(&etnaviv_obj->vram_list);
604 *obj = &etnaviv_obj->base;
609 /* convenience method to construct a GEM buffer object, and userspace handle */
610 int etnaviv_gem_new_handle(struct drm_device *dev, struct drm_file *file,
611 u32 size, u32 flags, u32 *handle)
613 struct drm_gem_object *obj = NULL;
616 size = PAGE_ALIGN(size);
618 ret = etnaviv_gem_new_impl(dev, size, flags, NULL,
619 &etnaviv_gem_shmem_ops, &obj);
623 lockdep_set_class(&to_etnaviv_bo(obj)->lock, &etnaviv_shm_lock_class);
625 ret = drm_gem_object_init(dev, obj, size);
630 * Our buffers are kept pinned, so allocating them from the MOVABLE
631 * zone is a really bad idea, and conflicts with CMA. See comments
632 * above new_inode() why this is required _and_ expected if you're
633 * going to pin these pages.
635 mapping_set_gfp_mask(obj->filp->f_mapping, GFP_HIGHUSER |
636 __GFP_RETRY_MAYFAIL | __GFP_NOWARN);
638 etnaviv_gem_obj_add(dev, obj);
640 ret = drm_gem_handle_create(file, obj, handle);
642 /* drop reference from allocate - handle holds it now */
644 drm_gem_object_put_unlocked(obj);
649 int etnaviv_gem_new_private(struct drm_device *dev, size_t size, u32 flags,
650 struct reservation_object *robj, const struct etnaviv_gem_ops *ops,
651 struct etnaviv_gem_object **res)
653 struct drm_gem_object *obj;
656 ret = etnaviv_gem_new_impl(dev, size, flags, robj, ops, &obj);
660 drm_gem_private_object_init(dev, obj, size);
662 *res = to_etnaviv_bo(obj);
667 static int etnaviv_gem_userptr_get_pages(struct etnaviv_gem_object *etnaviv_obj)
669 struct page **pvec = NULL;
670 struct etnaviv_gem_userptr *userptr = &etnaviv_obj->userptr;
671 int ret, pinned = 0, npages = etnaviv_obj->base.size >> PAGE_SHIFT;
673 might_lock_read(¤t->mm->mmap_sem);
675 if (userptr->mm != current->mm)
678 pvec = kvmalloc_array(npages, sizeof(struct page *), GFP_KERNEL);
683 unsigned num_pages = npages - pinned;
684 uint64_t ptr = userptr->ptr + pinned * PAGE_SIZE;
685 struct page **pages = pvec + pinned;
687 ret = get_user_pages_fast(ptr, num_pages,
688 !userptr->ro ? FOLL_WRITE : 0, pages);
690 release_pages(pvec, pinned);
697 } while (pinned < npages);
699 etnaviv_obj->pages = pvec;
704 static void etnaviv_gem_userptr_release(struct etnaviv_gem_object *etnaviv_obj)
706 if (etnaviv_obj->sgt) {
707 etnaviv_gem_scatterlist_unmap(etnaviv_obj);
708 sg_free_table(etnaviv_obj->sgt);
709 kfree(etnaviv_obj->sgt);
711 if (etnaviv_obj->pages) {
712 int npages = etnaviv_obj->base.size >> PAGE_SHIFT;
714 release_pages(etnaviv_obj->pages, npages);
715 kvfree(etnaviv_obj->pages);
719 static int etnaviv_gem_userptr_mmap_obj(struct etnaviv_gem_object *etnaviv_obj,
720 struct vm_area_struct *vma)
725 static const struct etnaviv_gem_ops etnaviv_gem_userptr_ops = {
726 .get_pages = etnaviv_gem_userptr_get_pages,
727 .release = etnaviv_gem_userptr_release,
728 .vmap = etnaviv_gem_vmap_impl,
729 .mmap = etnaviv_gem_userptr_mmap_obj,
732 int etnaviv_gem_new_userptr(struct drm_device *dev, struct drm_file *file,
733 uintptr_t ptr, u32 size, u32 flags, u32 *handle)
735 struct etnaviv_gem_object *etnaviv_obj;
738 ret = etnaviv_gem_new_private(dev, size, ETNA_BO_CACHED, NULL,
739 &etnaviv_gem_userptr_ops, &etnaviv_obj);
743 lockdep_set_class(&etnaviv_obj->lock, &etnaviv_userptr_lock_class);
745 etnaviv_obj->userptr.ptr = ptr;
746 etnaviv_obj->userptr.mm = current->mm;
747 etnaviv_obj->userptr.ro = !(flags & ETNA_USERPTR_WRITE);
749 etnaviv_gem_obj_add(dev, &etnaviv_obj->base);
751 ret = drm_gem_handle_create(file, &etnaviv_obj->base, handle);
753 /* drop reference from allocate - handle holds it now */
754 drm_gem_object_put_unlocked(&etnaviv_obj->base);