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 vm_flags_set(vma, VM_PFNMAP | VM_DONTEXPAND | VM_DONTDUMP);
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 vma_set_file(vma, etnaviv_obj->base.filp);
150 vma->vm_page_prot = vm_page_prot;
156 static int etnaviv_gem_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma)
158 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
160 return etnaviv_obj->ops->mmap(etnaviv_obj, vma);
163 static vm_fault_t etnaviv_gem_fault(struct vm_fault *vmf)
165 struct vm_area_struct *vma = vmf->vma;
166 struct drm_gem_object *obj = vma->vm_private_data;
167 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
174 * Make sure we don't parallel update on a fault, nor move or remove
175 * something from beneath our feet. Note that vmf_insert_page() is
176 * specifically coded to take care of this, so we don't have to.
178 err = mutex_lock_interruptible(&etnaviv_obj->lock);
180 return VM_FAULT_NOPAGE;
181 /* make sure we have pages attached now */
182 pages = etnaviv_gem_get_pages(etnaviv_obj);
183 mutex_unlock(&etnaviv_obj->lock);
186 err = PTR_ERR(pages);
187 return vmf_error(err);
190 /* We don't use vmf->pgoff since that has the fake offset: */
191 pgoff = (vmf->address - vma->vm_start) >> PAGE_SHIFT;
193 pfn = page_to_pfn(pages[pgoff]);
195 VERB("Inserting %p pfn %lx, pa %lx", (void *)vmf->address,
196 pfn, pfn << PAGE_SHIFT);
198 return vmf_insert_pfn(vma, vmf->address, pfn);
201 int etnaviv_gem_mmap_offset(struct drm_gem_object *obj, u64 *offset)
205 /* Make it mmapable */
206 ret = drm_gem_create_mmap_offset(obj);
208 dev_err(obj->dev->dev, "could not allocate mmap offset\n");
210 *offset = drm_vma_node_offset_addr(&obj->vma_node);
215 static struct etnaviv_vram_mapping *
216 etnaviv_gem_get_vram_mapping(struct etnaviv_gem_object *obj,
217 struct etnaviv_iommu_context *context)
219 struct etnaviv_vram_mapping *mapping;
221 list_for_each_entry(mapping, &obj->vram_list, obj_node) {
222 if (mapping->context == context)
229 void etnaviv_gem_mapping_unreference(struct etnaviv_vram_mapping *mapping)
231 struct etnaviv_gem_object *etnaviv_obj = mapping->object;
233 mutex_lock(&etnaviv_obj->lock);
234 WARN_ON(mapping->use == 0);
236 mutex_unlock(&etnaviv_obj->lock);
238 drm_gem_object_put(&etnaviv_obj->base);
241 struct etnaviv_vram_mapping *etnaviv_gem_mapping_get(
242 struct drm_gem_object *obj, struct etnaviv_iommu_context *mmu_context,
245 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
246 struct etnaviv_vram_mapping *mapping;
250 mutex_lock(&etnaviv_obj->lock);
251 mapping = etnaviv_gem_get_vram_mapping(etnaviv_obj, mmu_context);
254 * Holding the object lock prevents the use count changing
255 * beneath us. If the use count is zero, the MMU might be
256 * reaping this object, so take the lock and re-check that
257 * the MMU owns this mapping to close this race.
259 if (mapping->use == 0) {
260 mutex_lock(&mmu_context->lock);
261 if (mapping->context == mmu_context)
262 if (va && mapping->iova != va) {
263 etnaviv_iommu_reap_mapping(mapping);
270 mutex_unlock(&mmu_context->lock);
279 pages = etnaviv_gem_get_pages(etnaviv_obj);
281 ret = PTR_ERR(pages);
286 * See if we have a reaped vram mapping we can re-use before
287 * allocating a fresh mapping.
289 mapping = etnaviv_gem_get_vram_mapping(etnaviv_obj, NULL);
291 mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
297 INIT_LIST_HEAD(&mapping->scan_node);
298 mapping->object = etnaviv_obj;
300 list_del(&mapping->obj_node);
305 ret = etnaviv_iommu_map_gem(mmu_context, etnaviv_obj,
306 mmu_context->global->memory_base,
311 list_add_tail(&mapping->obj_node, &etnaviv_obj->vram_list);
314 mutex_unlock(&etnaviv_obj->lock);
319 /* Take a reference on the object */
320 drm_gem_object_get(obj);
324 void *etnaviv_gem_vmap(struct drm_gem_object *obj)
326 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
328 if (etnaviv_obj->vaddr)
329 return etnaviv_obj->vaddr;
331 mutex_lock(&etnaviv_obj->lock);
333 * Need to check again, as we might have raced with another thread
334 * while waiting for the mutex.
336 if (!etnaviv_obj->vaddr)
337 etnaviv_obj->vaddr = etnaviv_obj->ops->vmap(etnaviv_obj);
338 mutex_unlock(&etnaviv_obj->lock);
340 return etnaviv_obj->vaddr;
343 static void *etnaviv_gem_vmap_impl(struct etnaviv_gem_object *obj)
347 lockdep_assert_held(&obj->lock);
349 pages = etnaviv_gem_get_pages(obj);
353 return vmap(pages, obj->base.size >> PAGE_SHIFT,
354 VM_MAP, pgprot_writecombine(PAGE_KERNEL));
357 static inline enum dma_data_direction etnaviv_op_to_dma_dir(u32 op)
359 if (op & ETNA_PREP_READ)
360 return DMA_FROM_DEVICE;
361 else if (op & ETNA_PREP_WRITE)
362 return DMA_TO_DEVICE;
364 return DMA_BIDIRECTIONAL;
367 int etnaviv_gem_cpu_prep(struct drm_gem_object *obj, u32 op,
368 struct drm_etnaviv_timespec *timeout)
370 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
371 struct drm_device *dev = obj->dev;
372 bool write = !!(op & ETNA_PREP_WRITE);
375 if (!etnaviv_obj->sgt) {
378 mutex_lock(&etnaviv_obj->lock);
379 ret = etnaviv_gem_get_pages(etnaviv_obj);
380 mutex_unlock(&etnaviv_obj->lock);
385 if (op & ETNA_PREP_NOSYNC) {
386 if (!dma_resv_test_signaled(obj->resv,
387 dma_resv_usage_rw(write)))
390 unsigned long remain = etnaviv_timeout_to_jiffies(timeout);
392 ret = dma_resv_wait_timeout(obj->resv, dma_resv_usage_rw(write),
395 return ret == 0 ? -ETIMEDOUT : ret;
398 if (etnaviv_obj->flags & ETNA_BO_CACHED) {
399 dma_sync_sgtable_for_cpu(dev->dev, etnaviv_obj->sgt,
400 etnaviv_op_to_dma_dir(op));
401 etnaviv_obj->last_cpu_prep_op = op;
407 int etnaviv_gem_cpu_fini(struct drm_gem_object *obj)
409 struct drm_device *dev = obj->dev;
410 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
412 if (etnaviv_obj->flags & ETNA_BO_CACHED) {
413 /* fini without a prep is almost certainly a userspace error */
414 WARN_ON(etnaviv_obj->last_cpu_prep_op == 0);
415 dma_sync_sgtable_for_device(dev->dev, etnaviv_obj->sgt,
416 etnaviv_op_to_dma_dir(etnaviv_obj->last_cpu_prep_op));
417 etnaviv_obj->last_cpu_prep_op = 0;
423 int etnaviv_gem_wait_bo(struct etnaviv_gpu *gpu, struct drm_gem_object *obj,
424 struct drm_etnaviv_timespec *timeout)
426 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
428 return etnaviv_gpu_wait_obj_inactive(gpu, etnaviv_obj, timeout);
431 #ifdef CONFIG_DEBUG_FS
432 static void etnaviv_gem_describe(struct drm_gem_object *obj, struct seq_file *m)
434 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
435 struct dma_resv *robj = obj->resv;
436 unsigned long off = drm_vma_node_start(&obj->vma_node);
439 seq_printf(m, "%08x: %c %2d (%2d) %08lx %p %zd\n",
440 etnaviv_obj->flags, is_active(etnaviv_obj) ? 'A' : 'I',
441 obj->name, kref_read(&obj->refcount),
442 off, etnaviv_obj->vaddr, obj->size);
444 r = dma_resv_lock(robj, NULL);
448 dma_resv_describe(robj, m);
449 dma_resv_unlock(robj);
452 void etnaviv_gem_describe_objects(struct etnaviv_drm_private *priv,
455 struct etnaviv_gem_object *etnaviv_obj;
459 mutex_lock(&priv->gem_lock);
460 list_for_each_entry(etnaviv_obj, &priv->gem_list, gem_node) {
461 struct drm_gem_object *obj = &etnaviv_obj->base;
464 etnaviv_gem_describe(obj, m);
468 mutex_unlock(&priv->gem_lock);
470 seq_printf(m, "Total %d objects, %zu bytes\n", count, size);
474 static void etnaviv_gem_shmem_release(struct etnaviv_gem_object *etnaviv_obj)
476 vunmap(etnaviv_obj->vaddr);
477 put_pages(etnaviv_obj);
480 static const struct etnaviv_gem_ops etnaviv_gem_shmem_ops = {
481 .get_pages = etnaviv_gem_shmem_get_pages,
482 .release = etnaviv_gem_shmem_release,
483 .vmap = etnaviv_gem_vmap_impl,
484 .mmap = etnaviv_gem_mmap_obj,
487 void etnaviv_gem_free_object(struct drm_gem_object *obj)
489 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
490 struct etnaviv_drm_private *priv = obj->dev->dev_private;
491 struct etnaviv_vram_mapping *mapping, *tmp;
493 /* object should not be active */
494 WARN_ON(is_active(etnaviv_obj));
496 mutex_lock(&priv->gem_lock);
497 list_del(&etnaviv_obj->gem_node);
498 mutex_unlock(&priv->gem_lock);
500 list_for_each_entry_safe(mapping, tmp, &etnaviv_obj->vram_list,
502 struct etnaviv_iommu_context *context = mapping->context;
504 WARN_ON(mapping->use);
507 etnaviv_iommu_unmap_gem(context, mapping);
509 list_del(&mapping->obj_node);
513 etnaviv_obj->ops->release(etnaviv_obj);
514 drm_gem_object_release(obj);
519 void etnaviv_gem_obj_add(struct drm_device *dev, struct drm_gem_object *obj)
521 struct etnaviv_drm_private *priv = dev->dev_private;
522 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
524 mutex_lock(&priv->gem_lock);
525 list_add_tail(&etnaviv_obj->gem_node, &priv->gem_list);
526 mutex_unlock(&priv->gem_lock);
529 static const struct vm_operations_struct vm_ops = {
530 .fault = etnaviv_gem_fault,
531 .open = drm_gem_vm_open,
532 .close = drm_gem_vm_close,
535 static const struct drm_gem_object_funcs etnaviv_gem_object_funcs = {
536 .free = etnaviv_gem_free_object,
537 .pin = etnaviv_gem_prime_pin,
538 .unpin = etnaviv_gem_prime_unpin,
539 .get_sg_table = etnaviv_gem_prime_get_sg_table,
540 .vmap = etnaviv_gem_prime_vmap,
541 .mmap = etnaviv_gem_mmap,
545 static int etnaviv_gem_new_impl(struct drm_device *dev, u32 size, u32 flags,
546 const struct etnaviv_gem_ops *ops, struct drm_gem_object **obj)
548 struct etnaviv_gem_object *etnaviv_obj;
549 unsigned sz = sizeof(*etnaviv_obj);
553 switch (flags & ETNA_BO_CACHE_MASK) {
554 case ETNA_BO_UNCACHED:
563 dev_err(dev->dev, "invalid cache flag: %x\n",
564 (flags & ETNA_BO_CACHE_MASK));
568 etnaviv_obj = kzalloc(sz, GFP_KERNEL);
572 etnaviv_obj->flags = flags;
573 etnaviv_obj->ops = ops;
575 mutex_init(&etnaviv_obj->lock);
576 INIT_LIST_HEAD(&etnaviv_obj->vram_list);
578 *obj = &etnaviv_obj->base;
579 (*obj)->funcs = &etnaviv_gem_object_funcs;
584 /* convenience method to construct a GEM buffer object, and userspace handle */
585 int etnaviv_gem_new_handle(struct drm_device *dev, struct drm_file *file,
586 u32 size, u32 flags, u32 *handle)
588 struct etnaviv_drm_private *priv = dev->dev_private;
589 struct drm_gem_object *obj = NULL;
592 size = PAGE_ALIGN(size);
594 ret = etnaviv_gem_new_impl(dev, size, flags,
595 &etnaviv_gem_shmem_ops, &obj);
599 lockdep_set_class(&to_etnaviv_bo(obj)->lock, &etnaviv_shm_lock_class);
601 ret = drm_gem_object_init(dev, obj, size);
606 * Our buffers are kept pinned, so allocating them from the MOVABLE
607 * zone is a really bad idea, and conflicts with CMA. See comments
608 * above new_inode() why this is required _and_ expected if you're
609 * going to pin these pages.
611 mapping_set_gfp_mask(obj->filp->f_mapping, priv->shm_gfp_mask);
613 etnaviv_gem_obj_add(dev, obj);
615 ret = drm_gem_handle_create(file, obj, handle);
617 /* drop reference from allocate - handle holds it now */
619 drm_gem_object_put(obj);
624 int etnaviv_gem_new_private(struct drm_device *dev, size_t size, u32 flags,
625 const struct etnaviv_gem_ops *ops, struct etnaviv_gem_object **res)
627 struct drm_gem_object *obj;
630 ret = etnaviv_gem_new_impl(dev, size, flags, ops, &obj);
634 drm_gem_private_object_init(dev, obj, size);
636 *res = to_etnaviv_bo(obj);
641 static int etnaviv_gem_userptr_get_pages(struct etnaviv_gem_object *etnaviv_obj)
643 struct page **pvec = NULL;
644 struct etnaviv_gem_userptr *userptr = &etnaviv_obj->userptr;
645 int ret, pinned = 0, npages = etnaviv_obj->base.size >> PAGE_SHIFT;
646 unsigned int gup_flags = FOLL_LONGTERM;
648 might_lock_read(¤t->mm->mmap_lock);
650 if (userptr->mm != current->mm)
653 pvec = kvmalloc_array(npages, sizeof(struct page *), GFP_KERNEL);
658 gup_flags |= FOLL_WRITE;
661 unsigned num_pages = npages - pinned;
662 uint64_t ptr = userptr->ptr + pinned * PAGE_SIZE;
663 struct page **pages = pvec + pinned;
665 ret = pin_user_pages_fast(ptr, num_pages, gup_flags, pages);
667 unpin_user_pages(pvec, pinned);
674 } while (pinned < npages);
676 etnaviv_obj->pages = pvec;
681 static void etnaviv_gem_userptr_release(struct etnaviv_gem_object *etnaviv_obj)
683 if (etnaviv_obj->sgt) {
684 etnaviv_gem_scatterlist_unmap(etnaviv_obj);
685 sg_free_table(etnaviv_obj->sgt);
686 kfree(etnaviv_obj->sgt);
688 if (etnaviv_obj->pages) {
689 int npages = etnaviv_obj->base.size >> PAGE_SHIFT;
691 unpin_user_pages(etnaviv_obj->pages, npages);
692 kvfree(etnaviv_obj->pages);
696 static int etnaviv_gem_userptr_mmap_obj(struct etnaviv_gem_object *etnaviv_obj,
697 struct vm_area_struct *vma)
702 static const struct etnaviv_gem_ops etnaviv_gem_userptr_ops = {
703 .get_pages = etnaviv_gem_userptr_get_pages,
704 .release = etnaviv_gem_userptr_release,
705 .vmap = etnaviv_gem_vmap_impl,
706 .mmap = etnaviv_gem_userptr_mmap_obj,
709 int etnaviv_gem_new_userptr(struct drm_device *dev, struct drm_file *file,
710 uintptr_t ptr, u32 size, u32 flags, u32 *handle)
712 struct etnaviv_gem_object *etnaviv_obj;
715 ret = etnaviv_gem_new_private(dev, size, ETNA_BO_CACHED,
716 &etnaviv_gem_userptr_ops, &etnaviv_obj);
720 lockdep_set_class(&etnaviv_obj->lock, &etnaviv_userptr_lock_class);
722 etnaviv_obj->userptr.ptr = ptr;
723 etnaviv_obj->userptr.mm = current->mm;
724 etnaviv_obj->userptr.ro = !(flags & ETNA_USERPTR_WRITE);
726 etnaviv_gem_obj_add(dev, &etnaviv_obj->base);
728 ret = drm_gem_handle_create(file, &etnaviv_obj->base, handle);
730 /* drop reference from allocate - handle holds it now */
731 drm_gem_object_put(&etnaviv_obj->base);