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_sgtable(dev->dev, sgt, DMA_BIDIRECTIONAL, 0);
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_sgtable(dev->dev, sgt, DMA_BIDIRECTIONAL, 0);
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->base.dev,
107 etnaviv_obj->pages, npages);
109 dev_err(dev->dev, "failed to allocate sgt: %ld\n",
111 return ERR_CAST(sgt);
114 etnaviv_obj->sgt = sgt;
116 etnaviv_gem_scatter_map(etnaviv_obj);
119 return etnaviv_obj->pages;
122 void etnaviv_gem_put_pages(struct etnaviv_gem_object *etnaviv_obj)
124 lockdep_assert_held(&etnaviv_obj->lock);
125 /* when we start tracking the pin count, then do something here */
128 static int etnaviv_gem_mmap_obj(struct etnaviv_gem_object *etnaviv_obj,
129 struct vm_area_struct *vma)
131 pgprot_t vm_page_prot;
133 vma->vm_flags &= ~VM_PFNMAP;
134 vma->vm_flags |= VM_MIXEDMAP;
136 vm_page_prot = vm_get_page_prot(vma->vm_flags);
138 if (etnaviv_obj->flags & ETNA_BO_WC) {
139 vma->vm_page_prot = pgprot_writecombine(vm_page_prot);
140 } else if (etnaviv_obj->flags & ETNA_BO_UNCACHED) {
141 vma->vm_page_prot = pgprot_noncached(vm_page_prot);
144 * Shunt off cached objs to shmem file so they have their own
145 * address_space (so unmap_mapping_range does what we want,
146 * in particular in the case of mmap'd dmabufs)
149 get_file(etnaviv_obj->base.filp);
151 vma->vm_file = etnaviv_obj->base.filp;
153 vma->vm_page_prot = vm_page_prot;
159 int etnaviv_gem_mmap(struct file *filp, struct vm_area_struct *vma)
161 struct etnaviv_gem_object *obj;
164 ret = drm_gem_mmap(filp, vma);
166 DBG("mmap failed: %d", ret);
170 obj = to_etnaviv_bo(vma->vm_private_data);
171 return obj->ops->mmap(obj, vma);
174 static vm_fault_t etnaviv_gem_fault(struct vm_fault *vmf)
176 struct vm_area_struct *vma = vmf->vma;
177 struct drm_gem_object *obj = vma->vm_private_data;
178 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
179 struct page **pages, *page;
184 * Make sure we don't parallel update on a fault, nor move or remove
185 * something from beneath our feet. Note that vmf_insert_page() is
186 * specifically coded to take care of this, so we don't have to.
188 err = mutex_lock_interruptible(&etnaviv_obj->lock);
190 return VM_FAULT_NOPAGE;
191 /* make sure we have pages attached now */
192 pages = etnaviv_gem_get_pages(etnaviv_obj);
193 mutex_unlock(&etnaviv_obj->lock);
196 err = PTR_ERR(pages);
197 return vmf_error(err);
200 /* We don't use vmf->pgoff since that has the fake offset: */
201 pgoff = (vmf->address - vma->vm_start) >> PAGE_SHIFT;
205 VERB("Inserting %p pfn %lx, pa %lx", (void *)vmf->address,
206 page_to_pfn(page), page_to_pfn(page) << PAGE_SHIFT);
208 return vmf_insert_page(vma, vmf->address, page);
211 int etnaviv_gem_mmap_offset(struct drm_gem_object *obj, u64 *offset)
215 /* Make it mmapable */
216 ret = drm_gem_create_mmap_offset(obj);
218 dev_err(obj->dev->dev, "could not allocate mmap offset\n");
220 *offset = drm_vma_node_offset_addr(&obj->vma_node);
225 static struct etnaviv_vram_mapping *
226 etnaviv_gem_get_vram_mapping(struct etnaviv_gem_object *obj,
227 struct etnaviv_iommu_context *context)
229 struct etnaviv_vram_mapping *mapping;
231 list_for_each_entry(mapping, &obj->vram_list, obj_node) {
232 if (mapping->context == context)
239 void etnaviv_gem_mapping_unreference(struct etnaviv_vram_mapping *mapping)
241 struct etnaviv_gem_object *etnaviv_obj = mapping->object;
243 mutex_lock(&etnaviv_obj->lock);
244 WARN_ON(mapping->use == 0);
246 mutex_unlock(&etnaviv_obj->lock);
248 drm_gem_object_put(&etnaviv_obj->base);
251 struct etnaviv_vram_mapping *etnaviv_gem_mapping_get(
252 struct drm_gem_object *obj, struct etnaviv_iommu_context *mmu_context,
255 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
256 struct etnaviv_vram_mapping *mapping;
260 mutex_lock(&etnaviv_obj->lock);
261 mapping = etnaviv_gem_get_vram_mapping(etnaviv_obj, mmu_context);
264 * Holding the object lock prevents the use count changing
265 * beneath us. If the use count is zero, the MMU might be
266 * reaping this object, so take the lock and re-check that
267 * the MMU owns this mapping to close this race.
269 if (mapping->use == 0) {
270 mutex_lock(&mmu_context->lock);
271 if (mapping->context == mmu_context)
275 mutex_unlock(&mmu_context->lock);
284 pages = etnaviv_gem_get_pages(etnaviv_obj);
286 ret = PTR_ERR(pages);
291 * See if we have a reaped vram mapping we can re-use before
292 * allocating a fresh mapping.
294 mapping = etnaviv_gem_get_vram_mapping(etnaviv_obj, NULL);
296 mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
302 INIT_LIST_HEAD(&mapping->scan_node);
303 mapping->object = etnaviv_obj;
305 list_del(&mapping->obj_node);
308 etnaviv_iommu_context_get(mmu_context);
309 mapping->context = mmu_context;
312 ret = etnaviv_iommu_map_gem(mmu_context, etnaviv_obj,
313 mmu_context->global->memory_base,
316 etnaviv_iommu_context_put(mmu_context);
319 list_add_tail(&mapping->obj_node, &etnaviv_obj->vram_list);
323 mutex_unlock(&etnaviv_obj->lock);
328 /* Take a reference on the object */
329 drm_gem_object_get(obj);
333 void *etnaviv_gem_vmap(struct drm_gem_object *obj)
335 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
337 if (etnaviv_obj->vaddr)
338 return etnaviv_obj->vaddr;
340 mutex_lock(&etnaviv_obj->lock);
342 * Need to check again, as we might have raced with another thread
343 * while waiting for the mutex.
345 if (!etnaviv_obj->vaddr)
346 etnaviv_obj->vaddr = etnaviv_obj->ops->vmap(etnaviv_obj);
347 mutex_unlock(&etnaviv_obj->lock);
349 return etnaviv_obj->vaddr;
352 static void *etnaviv_gem_vmap_impl(struct etnaviv_gem_object *obj)
356 lockdep_assert_held(&obj->lock);
358 pages = etnaviv_gem_get_pages(obj);
362 return vmap(pages, obj->base.size >> PAGE_SHIFT,
363 VM_MAP, pgprot_writecombine(PAGE_KERNEL));
366 static inline enum dma_data_direction etnaviv_op_to_dma_dir(u32 op)
368 if (op & ETNA_PREP_READ)
369 return DMA_FROM_DEVICE;
370 else if (op & ETNA_PREP_WRITE)
371 return DMA_TO_DEVICE;
373 return DMA_BIDIRECTIONAL;
376 int etnaviv_gem_cpu_prep(struct drm_gem_object *obj, u32 op,
377 struct drm_etnaviv_timespec *timeout)
379 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
380 struct drm_device *dev = obj->dev;
381 bool write = !!(op & ETNA_PREP_WRITE);
384 if (!etnaviv_obj->sgt) {
387 mutex_lock(&etnaviv_obj->lock);
388 ret = etnaviv_gem_get_pages(etnaviv_obj);
389 mutex_unlock(&etnaviv_obj->lock);
394 if (op & ETNA_PREP_NOSYNC) {
395 if (!dma_resv_test_signaled_rcu(obj->resv,
399 unsigned long remain = etnaviv_timeout_to_jiffies(timeout);
401 ret = dma_resv_wait_timeout_rcu(obj->resv,
402 write, true, remain);
404 return ret == 0 ? -ETIMEDOUT : ret;
407 if (etnaviv_obj->flags & ETNA_BO_CACHED) {
408 dma_sync_sgtable_for_cpu(dev->dev, etnaviv_obj->sgt,
409 etnaviv_op_to_dma_dir(op));
410 etnaviv_obj->last_cpu_prep_op = op;
416 int etnaviv_gem_cpu_fini(struct drm_gem_object *obj)
418 struct drm_device *dev = obj->dev;
419 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
421 if (etnaviv_obj->flags & ETNA_BO_CACHED) {
422 /* fini without a prep is almost certainly a userspace error */
423 WARN_ON(etnaviv_obj->last_cpu_prep_op == 0);
424 dma_sync_sgtable_for_device(dev->dev, etnaviv_obj->sgt,
425 etnaviv_op_to_dma_dir(etnaviv_obj->last_cpu_prep_op));
426 etnaviv_obj->last_cpu_prep_op = 0;
432 int etnaviv_gem_wait_bo(struct etnaviv_gpu *gpu, struct drm_gem_object *obj,
433 struct drm_etnaviv_timespec *timeout)
435 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
437 return etnaviv_gpu_wait_obj_inactive(gpu, etnaviv_obj, timeout);
440 #ifdef CONFIG_DEBUG_FS
441 static void etnaviv_gem_describe_fence(struct dma_fence *fence,
442 const char *type, struct seq_file *m)
444 if (!test_bit(DMA_FENCE_FLAG_SIGNALED_BIT, &fence->flags))
445 seq_printf(m, "\t%9s: %s %s seq %llu\n",
447 fence->ops->get_driver_name(fence),
448 fence->ops->get_timeline_name(fence),
452 static void etnaviv_gem_describe(struct drm_gem_object *obj, struct seq_file *m)
454 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
455 struct dma_resv *robj = obj->resv;
456 struct dma_resv_list *fobj;
457 struct dma_fence *fence;
458 unsigned long off = drm_vma_node_start(&obj->vma_node);
460 seq_printf(m, "%08x: %c %2d (%2d) %08lx %p %zd\n",
461 etnaviv_obj->flags, is_active(etnaviv_obj) ? 'A' : 'I',
462 obj->name, kref_read(&obj->refcount),
463 off, etnaviv_obj->vaddr, obj->size);
466 fobj = rcu_dereference(robj->fence);
468 unsigned int i, shared_count = fobj->shared_count;
470 for (i = 0; i < shared_count; i++) {
471 fence = rcu_dereference(fobj->shared[i]);
472 etnaviv_gem_describe_fence(fence, "Shared", m);
476 fence = rcu_dereference(robj->fence_excl);
478 etnaviv_gem_describe_fence(fence, "Exclusive", m);
482 void etnaviv_gem_describe_objects(struct etnaviv_drm_private *priv,
485 struct etnaviv_gem_object *etnaviv_obj;
489 mutex_lock(&priv->gem_lock);
490 list_for_each_entry(etnaviv_obj, &priv->gem_list, gem_node) {
491 struct drm_gem_object *obj = &etnaviv_obj->base;
494 etnaviv_gem_describe(obj, m);
498 mutex_unlock(&priv->gem_lock);
500 seq_printf(m, "Total %d objects, %zu bytes\n", count, size);
504 static void etnaviv_gem_shmem_release(struct etnaviv_gem_object *etnaviv_obj)
506 vunmap(etnaviv_obj->vaddr);
507 put_pages(etnaviv_obj);
510 static const struct etnaviv_gem_ops etnaviv_gem_shmem_ops = {
511 .get_pages = etnaviv_gem_shmem_get_pages,
512 .release = etnaviv_gem_shmem_release,
513 .vmap = etnaviv_gem_vmap_impl,
514 .mmap = etnaviv_gem_mmap_obj,
517 void etnaviv_gem_free_object(struct drm_gem_object *obj)
519 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
520 struct etnaviv_drm_private *priv = obj->dev->dev_private;
521 struct etnaviv_vram_mapping *mapping, *tmp;
523 /* object should not be active */
524 WARN_ON(is_active(etnaviv_obj));
526 mutex_lock(&priv->gem_lock);
527 list_del(&etnaviv_obj->gem_node);
528 mutex_unlock(&priv->gem_lock);
530 list_for_each_entry_safe(mapping, tmp, &etnaviv_obj->vram_list,
532 struct etnaviv_iommu_context *context = mapping->context;
534 WARN_ON(mapping->use);
537 etnaviv_iommu_unmap_gem(context, mapping);
538 etnaviv_iommu_context_put(context);
541 list_del(&mapping->obj_node);
545 drm_gem_free_mmap_offset(obj);
546 etnaviv_obj->ops->release(etnaviv_obj);
547 drm_gem_object_release(obj);
552 void etnaviv_gem_obj_add(struct drm_device *dev, struct drm_gem_object *obj)
554 struct etnaviv_drm_private *priv = dev->dev_private;
555 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
557 mutex_lock(&priv->gem_lock);
558 list_add_tail(&etnaviv_obj->gem_node, &priv->gem_list);
559 mutex_unlock(&priv->gem_lock);
562 static const struct vm_operations_struct vm_ops = {
563 .fault = etnaviv_gem_fault,
564 .open = drm_gem_vm_open,
565 .close = drm_gem_vm_close,
568 static const struct drm_gem_object_funcs etnaviv_gem_object_funcs = {
569 .free = etnaviv_gem_free_object,
570 .pin = etnaviv_gem_prime_pin,
571 .unpin = etnaviv_gem_prime_unpin,
572 .get_sg_table = etnaviv_gem_prime_get_sg_table,
573 .vmap = etnaviv_gem_prime_vmap,
574 .vunmap = etnaviv_gem_prime_vunmap,
578 static int etnaviv_gem_new_impl(struct drm_device *dev, u32 size, u32 flags,
579 const struct etnaviv_gem_ops *ops, struct drm_gem_object **obj)
581 struct etnaviv_gem_object *etnaviv_obj;
582 unsigned sz = sizeof(*etnaviv_obj);
586 switch (flags & ETNA_BO_CACHE_MASK) {
587 case ETNA_BO_UNCACHED:
596 dev_err(dev->dev, "invalid cache flag: %x\n",
597 (flags & ETNA_BO_CACHE_MASK));
601 etnaviv_obj = kzalloc(sz, GFP_KERNEL);
605 etnaviv_obj->flags = flags;
606 etnaviv_obj->ops = ops;
608 mutex_init(&etnaviv_obj->lock);
609 INIT_LIST_HEAD(&etnaviv_obj->vram_list);
611 *obj = &etnaviv_obj->base;
612 (*obj)->funcs = &etnaviv_gem_object_funcs;
617 /* convenience method to construct a GEM buffer object, and userspace handle */
618 int etnaviv_gem_new_handle(struct drm_device *dev, struct drm_file *file,
619 u32 size, u32 flags, u32 *handle)
621 struct etnaviv_drm_private *priv = dev->dev_private;
622 struct drm_gem_object *obj = NULL;
625 size = PAGE_ALIGN(size);
627 ret = etnaviv_gem_new_impl(dev, size, flags,
628 &etnaviv_gem_shmem_ops, &obj);
632 lockdep_set_class(&to_etnaviv_bo(obj)->lock, &etnaviv_shm_lock_class);
634 ret = drm_gem_object_init(dev, obj, size);
639 * Our buffers are kept pinned, so allocating them from the MOVABLE
640 * zone is a really bad idea, and conflicts with CMA. See comments
641 * above new_inode() why this is required _and_ expected if you're
642 * going to pin these pages.
644 mapping_set_gfp_mask(obj->filp->f_mapping, priv->shm_gfp_mask);
646 etnaviv_gem_obj_add(dev, obj);
648 ret = drm_gem_handle_create(file, obj, handle);
650 /* drop reference from allocate - handle holds it now */
652 drm_gem_object_put(obj);
657 int etnaviv_gem_new_private(struct drm_device *dev, size_t size, u32 flags,
658 const struct etnaviv_gem_ops *ops, struct etnaviv_gem_object **res)
660 struct drm_gem_object *obj;
663 ret = etnaviv_gem_new_impl(dev, size, flags, ops, &obj);
667 drm_gem_private_object_init(dev, obj, size);
669 *res = to_etnaviv_bo(obj);
674 static int etnaviv_gem_userptr_get_pages(struct etnaviv_gem_object *etnaviv_obj)
676 struct page **pvec = NULL;
677 struct etnaviv_gem_userptr *userptr = &etnaviv_obj->userptr;
678 int ret, pinned = 0, npages = etnaviv_obj->base.size >> PAGE_SHIFT;
680 might_lock_read(¤t->mm->mmap_lock);
682 if (userptr->mm != current->mm)
685 pvec = kvmalloc_array(npages, sizeof(struct page *), GFP_KERNEL);
690 unsigned num_pages = npages - pinned;
691 uint64_t ptr = userptr->ptr + pinned * PAGE_SIZE;
692 struct page **pages = pvec + pinned;
694 ret = pin_user_pages_fast(ptr, num_pages,
695 !userptr->ro ? FOLL_WRITE : 0, pages);
697 unpin_user_pages(pvec, pinned);
704 } while (pinned < npages);
706 etnaviv_obj->pages = pvec;
711 static void etnaviv_gem_userptr_release(struct etnaviv_gem_object *etnaviv_obj)
713 if (etnaviv_obj->sgt) {
714 etnaviv_gem_scatterlist_unmap(etnaviv_obj);
715 sg_free_table(etnaviv_obj->sgt);
716 kfree(etnaviv_obj->sgt);
718 if (etnaviv_obj->pages) {
719 int npages = etnaviv_obj->base.size >> PAGE_SHIFT;
721 unpin_user_pages(etnaviv_obj->pages, npages);
722 kvfree(etnaviv_obj->pages);
726 static int etnaviv_gem_userptr_mmap_obj(struct etnaviv_gem_object *etnaviv_obj,
727 struct vm_area_struct *vma)
732 static const struct etnaviv_gem_ops etnaviv_gem_userptr_ops = {
733 .get_pages = etnaviv_gem_userptr_get_pages,
734 .release = etnaviv_gem_userptr_release,
735 .vmap = etnaviv_gem_vmap_impl,
736 .mmap = etnaviv_gem_userptr_mmap_obj,
739 int etnaviv_gem_new_userptr(struct drm_device *dev, struct drm_file *file,
740 uintptr_t ptr, u32 size, u32 flags, u32 *handle)
742 struct etnaviv_gem_object *etnaviv_obj;
745 ret = etnaviv_gem_new_private(dev, size, ETNA_BO_CACHED,
746 &etnaviv_gem_userptr_ops, &etnaviv_obj);
750 lockdep_set_class(&etnaviv_obj->lock, &etnaviv_userptr_lock_class);
752 etnaviv_obj->userptr.ptr = ptr;
753 etnaviv_obj->userptr.mm = current->mm;
754 etnaviv_obj->userptr.ro = !(flags & ETNA_USERPTR_WRITE);
756 etnaviv_gem_obj_add(dev, &etnaviv_obj->base);
758 ret = drm_gem_handle_create(file, &etnaviv_obj->base, handle);
760 /* drop reference from allocate - handle holds it now */
761 drm_gem_object_put(&etnaviv_obj->base);