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_IO | VM_MIXEDMAP | 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);
168 struct page **pages, *page;
173 * Make sure we don't parallel update on a fault, nor move or remove
174 * something from beneath our feet. Note that vmf_insert_page() is
175 * specifically coded to take care of this, so we don't have to.
177 err = mutex_lock_interruptible(&etnaviv_obj->lock);
179 return VM_FAULT_NOPAGE;
180 /* make sure we have pages attached now */
181 pages = etnaviv_gem_get_pages(etnaviv_obj);
182 mutex_unlock(&etnaviv_obj->lock);
185 err = PTR_ERR(pages);
186 return vmf_error(err);
189 /* We don't use vmf->pgoff since that has the fake offset: */
190 pgoff = (vmf->address - vma->vm_start) >> PAGE_SHIFT;
194 VERB("Inserting %p pfn %lx, pa %lx", (void *)vmf->address,
195 page_to_pfn(page), page_to_pfn(page) << PAGE_SHIFT);
197 return vmf_insert_page(vma, vmf->address, page);
200 int etnaviv_gem_mmap_offset(struct drm_gem_object *obj, u64 *offset)
204 /* Make it mmapable */
205 ret = drm_gem_create_mmap_offset(obj);
207 dev_err(obj->dev->dev, "could not allocate mmap offset\n");
209 *offset = drm_vma_node_offset_addr(&obj->vma_node);
214 static struct etnaviv_vram_mapping *
215 etnaviv_gem_get_vram_mapping(struct etnaviv_gem_object *obj,
216 struct etnaviv_iommu_context *context)
218 struct etnaviv_vram_mapping *mapping;
220 list_for_each_entry(mapping, &obj->vram_list, obj_node) {
221 if (mapping->context == context)
228 void etnaviv_gem_mapping_unreference(struct etnaviv_vram_mapping *mapping)
230 struct etnaviv_gem_object *etnaviv_obj = mapping->object;
232 mutex_lock(&etnaviv_obj->lock);
233 WARN_ON(mapping->use == 0);
235 mutex_unlock(&etnaviv_obj->lock);
237 drm_gem_object_put(&etnaviv_obj->base);
240 struct etnaviv_vram_mapping *etnaviv_gem_mapping_get(
241 struct drm_gem_object *obj, struct etnaviv_iommu_context *mmu_context,
244 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
245 struct etnaviv_vram_mapping *mapping;
249 mutex_lock(&etnaviv_obj->lock);
250 mapping = etnaviv_gem_get_vram_mapping(etnaviv_obj, mmu_context);
253 * Holding the object lock prevents the use count changing
254 * beneath us. If the use count is zero, the MMU might be
255 * reaping this object, so take the lock and re-check that
256 * the MMU owns this mapping to close this race.
258 if (mapping->use == 0) {
259 mutex_lock(&mmu_context->lock);
260 if (mapping->context == mmu_context)
264 mutex_unlock(&mmu_context->lock);
273 pages = etnaviv_gem_get_pages(etnaviv_obj);
275 ret = PTR_ERR(pages);
280 * See if we have a reaped vram mapping we can re-use before
281 * allocating a fresh mapping.
283 mapping = etnaviv_gem_get_vram_mapping(etnaviv_obj, NULL);
285 mapping = kzalloc(sizeof(*mapping), GFP_KERNEL);
291 INIT_LIST_HEAD(&mapping->scan_node);
292 mapping->object = etnaviv_obj;
294 list_del(&mapping->obj_node);
297 mapping->context = etnaviv_iommu_context_get(mmu_context);
300 ret = etnaviv_iommu_map_gem(mmu_context, etnaviv_obj,
301 mmu_context->global->memory_base,
304 etnaviv_iommu_context_put(mmu_context);
307 list_add_tail(&mapping->obj_node, &etnaviv_obj->vram_list);
311 mutex_unlock(&etnaviv_obj->lock);
316 /* Take a reference on the object */
317 drm_gem_object_get(obj);
321 void *etnaviv_gem_vmap(struct drm_gem_object *obj)
323 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
325 if (etnaviv_obj->vaddr)
326 return etnaviv_obj->vaddr;
328 mutex_lock(&etnaviv_obj->lock);
330 * Need to check again, as we might have raced with another thread
331 * while waiting for the mutex.
333 if (!etnaviv_obj->vaddr)
334 etnaviv_obj->vaddr = etnaviv_obj->ops->vmap(etnaviv_obj);
335 mutex_unlock(&etnaviv_obj->lock);
337 return etnaviv_obj->vaddr;
340 static void *etnaviv_gem_vmap_impl(struct etnaviv_gem_object *obj)
344 lockdep_assert_held(&obj->lock);
346 pages = etnaviv_gem_get_pages(obj);
350 return vmap(pages, obj->base.size >> PAGE_SHIFT,
351 VM_MAP, pgprot_writecombine(PAGE_KERNEL));
354 static inline enum dma_data_direction etnaviv_op_to_dma_dir(u32 op)
356 if (op & ETNA_PREP_READ)
357 return DMA_FROM_DEVICE;
358 else if (op & ETNA_PREP_WRITE)
359 return DMA_TO_DEVICE;
361 return DMA_BIDIRECTIONAL;
364 int etnaviv_gem_cpu_prep(struct drm_gem_object *obj, u32 op,
365 struct drm_etnaviv_timespec *timeout)
367 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
368 struct drm_device *dev = obj->dev;
369 bool write = !!(op & ETNA_PREP_WRITE);
372 if (!etnaviv_obj->sgt) {
375 mutex_lock(&etnaviv_obj->lock);
376 ret = etnaviv_gem_get_pages(etnaviv_obj);
377 mutex_unlock(&etnaviv_obj->lock);
382 if (op & ETNA_PREP_NOSYNC) {
383 if (!dma_resv_test_signaled(obj->resv, write))
386 unsigned long remain = etnaviv_timeout_to_jiffies(timeout);
388 ret = dma_resv_wait_timeout(obj->resv, write, true, remain);
390 return ret == 0 ? -ETIMEDOUT : ret;
393 if (etnaviv_obj->flags & ETNA_BO_CACHED) {
394 dma_sync_sgtable_for_cpu(dev->dev, etnaviv_obj->sgt,
395 etnaviv_op_to_dma_dir(op));
396 etnaviv_obj->last_cpu_prep_op = op;
402 int etnaviv_gem_cpu_fini(struct drm_gem_object *obj)
404 struct drm_device *dev = obj->dev;
405 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
407 if (etnaviv_obj->flags & ETNA_BO_CACHED) {
408 /* fini without a prep is almost certainly a userspace error */
409 WARN_ON(etnaviv_obj->last_cpu_prep_op == 0);
410 dma_sync_sgtable_for_device(dev->dev, etnaviv_obj->sgt,
411 etnaviv_op_to_dma_dir(etnaviv_obj->last_cpu_prep_op));
412 etnaviv_obj->last_cpu_prep_op = 0;
418 int etnaviv_gem_wait_bo(struct etnaviv_gpu *gpu, struct drm_gem_object *obj,
419 struct drm_etnaviv_timespec *timeout)
421 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
423 return etnaviv_gpu_wait_obj_inactive(gpu, etnaviv_obj, timeout);
426 #ifdef CONFIG_DEBUG_FS
427 static void etnaviv_gem_describe(struct drm_gem_object *obj, struct seq_file *m)
429 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
430 struct dma_resv *robj = obj->resv;
431 unsigned long off = drm_vma_node_start(&obj->vma_node);
434 seq_printf(m, "%08x: %c %2d (%2d) %08lx %p %zd\n",
435 etnaviv_obj->flags, is_active(etnaviv_obj) ? 'A' : 'I',
436 obj->name, kref_read(&obj->refcount),
437 off, etnaviv_obj->vaddr, obj->size);
439 r = dma_resv_lock(robj, NULL);
443 dma_resv_describe(robj, m);
444 dma_resv_unlock(robj);
447 void etnaviv_gem_describe_objects(struct etnaviv_drm_private *priv,
450 struct etnaviv_gem_object *etnaviv_obj;
454 mutex_lock(&priv->gem_lock);
455 list_for_each_entry(etnaviv_obj, &priv->gem_list, gem_node) {
456 struct drm_gem_object *obj = &etnaviv_obj->base;
459 etnaviv_gem_describe(obj, m);
463 mutex_unlock(&priv->gem_lock);
465 seq_printf(m, "Total %d objects, %zu bytes\n", count, size);
469 static void etnaviv_gem_shmem_release(struct etnaviv_gem_object *etnaviv_obj)
471 vunmap(etnaviv_obj->vaddr);
472 put_pages(etnaviv_obj);
475 static const struct etnaviv_gem_ops etnaviv_gem_shmem_ops = {
476 .get_pages = etnaviv_gem_shmem_get_pages,
477 .release = etnaviv_gem_shmem_release,
478 .vmap = etnaviv_gem_vmap_impl,
479 .mmap = etnaviv_gem_mmap_obj,
482 void etnaviv_gem_free_object(struct drm_gem_object *obj)
484 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
485 struct etnaviv_drm_private *priv = obj->dev->dev_private;
486 struct etnaviv_vram_mapping *mapping, *tmp;
488 /* object should not be active */
489 WARN_ON(is_active(etnaviv_obj));
491 mutex_lock(&priv->gem_lock);
492 list_del(&etnaviv_obj->gem_node);
493 mutex_unlock(&priv->gem_lock);
495 list_for_each_entry_safe(mapping, tmp, &etnaviv_obj->vram_list,
497 struct etnaviv_iommu_context *context = mapping->context;
499 WARN_ON(mapping->use);
502 etnaviv_iommu_unmap_gem(context, mapping);
503 etnaviv_iommu_context_put(context);
506 list_del(&mapping->obj_node);
510 drm_gem_free_mmap_offset(obj);
511 etnaviv_obj->ops->release(etnaviv_obj);
512 drm_gem_object_release(obj);
517 void etnaviv_gem_obj_add(struct drm_device *dev, struct drm_gem_object *obj)
519 struct etnaviv_drm_private *priv = dev->dev_private;
520 struct etnaviv_gem_object *etnaviv_obj = to_etnaviv_bo(obj);
522 mutex_lock(&priv->gem_lock);
523 list_add_tail(&etnaviv_obj->gem_node, &priv->gem_list);
524 mutex_unlock(&priv->gem_lock);
527 static const struct vm_operations_struct vm_ops = {
528 .fault = etnaviv_gem_fault,
529 .open = drm_gem_vm_open,
530 .close = drm_gem_vm_close,
533 static const struct drm_gem_object_funcs etnaviv_gem_object_funcs = {
534 .free = etnaviv_gem_free_object,
535 .pin = etnaviv_gem_prime_pin,
536 .unpin = etnaviv_gem_prime_unpin,
537 .get_sg_table = etnaviv_gem_prime_get_sg_table,
538 .vmap = etnaviv_gem_prime_vmap,
539 .mmap = etnaviv_gem_mmap,
543 static int etnaviv_gem_new_impl(struct drm_device *dev, u32 size, u32 flags,
544 const struct etnaviv_gem_ops *ops, struct drm_gem_object **obj)
546 struct etnaviv_gem_object *etnaviv_obj;
547 unsigned sz = sizeof(*etnaviv_obj);
551 switch (flags & ETNA_BO_CACHE_MASK) {
552 case ETNA_BO_UNCACHED:
561 dev_err(dev->dev, "invalid cache flag: %x\n",
562 (flags & ETNA_BO_CACHE_MASK));
566 etnaviv_obj = kzalloc(sz, GFP_KERNEL);
570 etnaviv_obj->flags = flags;
571 etnaviv_obj->ops = ops;
573 mutex_init(&etnaviv_obj->lock);
574 INIT_LIST_HEAD(&etnaviv_obj->vram_list);
576 *obj = &etnaviv_obj->base;
577 (*obj)->funcs = &etnaviv_gem_object_funcs;
582 /* convenience method to construct a GEM buffer object, and userspace handle */
583 int etnaviv_gem_new_handle(struct drm_device *dev, struct drm_file *file,
584 u32 size, u32 flags, u32 *handle)
586 struct etnaviv_drm_private *priv = dev->dev_private;
587 struct drm_gem_object *obj = NULL;
590 size = PAGE_ALIGN(size);
592 ret = etnaviv_gem_new_impl(dev, size, flags,
593 &etnaviv_gem_shmem_ops, &obj);
597 lockdep_set_class(&to_etnaviv_bo(obj)->lock, &etnaviv_shm_lock_class);
599 ret = drm_gem_object_init(dev, obj, size);
604 * Our buffers are kept pinned, so allocating them from the MOVABLE
605 * zone is a really bad idea, and conflicts with CMA. See comments
606 * above new_inode() why this is required _and_ expected if you're
607 * going to pin these pages.
609 mapping_set_gfp_mask(obj->filp->f_mapping, priv->shm_gfp_mask);
611 etnaviv_gem_obj_add(dev, obj);
613 ret = drm_gem_handle_create(file, obj, handle);
615 /* drop reference from allocate - handle holds it now */
617 drm_gem_object_put(obj);
622 int etnaviv_gem_new_private(struct drm_device *dev, size_t size, u32 flags,
623 const struct etnaviv_gem_ops *ops, struct etnaviv_gem_object **res)
625 struct drm_gem_object *obj;
628 ret = etnaviv_gem_new_impl(dev, size, flags, ops, &obj);
632 drm_gem_private_object_init(dev, obj, size);
634 *res = to_etnaviv_bo(obj);
639 static int etnaviv_gem_userptr_get_pages(struct etnaviv_gem_object *etnaviv_obj)
641 struct page **pvec = NULL;
642 struct etnaviv_gem_userptr *userptr = &etnaviv_obj->userptr;
643 int ret, pinned = 0, npages = etnaviv_obj->base.size >> PAGE_SHIFT;
645 might_lock_read(¤t->mm->mmap_lock);
647 if (userptr->mm != current->mm)
650 pvec = kvmalloc_array(npages, sizeof(struct page *), GFP_KERNEL);
655 unsigned num_pages = npages - pinned;
656 uint64_t ptr = userptr->ptr + pinned * PAGE_SIZE;
657 struct page **pages = pvec + pinned;
659 ret = pin_user_pages_fast(ptr, num_pages,
660 FOLL_WRITE | FOLL_FORCE | FOLL_LONGTERM,
663 unpin_user_pages(pvec, pinned);
670 } while (pinned < npages);
672 etnaviv_obj->pages = pvec;
677 static void etnaviv_gem_userptr_release(struct etnaviv_gem_object *etnaviv_obj)
679 if (etnaviv_obj->sgt) {
680 etnaviv_gem_scatterlist_unmap(etnaviv_obj);
681 sg_free_table(etnaviv_obj->sgt);
682 kfree(etnaviv_obj->sgt);
684 if (etnaviv_obj->pages) {
685 int npages = etnaviv_obj->base.size >> PAGE_SHIFT;
687 unpin_user_pages(etnaviv_obj->pages, npages);
688 kvfree(etnaviv_obj->pages);
692 static int etnaviv_gem_userptr_mmap_obj(struct etnaviv_gem_object *etnaviv_obj,
693 struct vm_area_struct *vma)
698 static const struct etnaviv_gem_ops etnaviv_gem_userptr_ops = {
699 .get_pages = etnaviv_gem_userptr_get_pages,
700 .release = etnaviv_gem_userptr_release,
701 .vmap = etnaviv_gem_vmap_impl,
702 .mmap = etnaviv_gem_userptr_mmap_obj,
705 int etnaviv_gem_new_userptr(struct drm_device *dev, struct drm_file *file,
706 uintptr_t ptr, u32 size, u32 flags, u32 *handle)
708 struct etnaviv_gem_object *etnaviv_obj;
711 ret = etnaviv_gem_new_private(dev, size, ETNA_BO_CACHED,
712 &etnaviv_gem_userptr_ops, &etnaviv_obj);
716 lockdep_set_class(&etnaviv_obj->lock, &etnaviv_userptr_lock_class);
718 etnaviv_obj->userptr.ptr = ptr;
719 etnaviv_obj->userptr.mm = current->mm;
720 etnaviv_obj->userptr.ro = !(flags & ETNA_USERPTR_WRITE);
722 etnaviv_gem_obj_add(dev, &etnaviv_obj->base);
724 ret = drm_gem_handle_create(file, &etnaviv_obj->base, handle);
726 /* drop reference from allocate - handle holds it now */
727 drm_gem_object_put(&etnaviv_obj->base);