2 * Copyright (C) 2013 Red Hat
3 * Author: Rob Clark <robdclark@gmail.com>
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 as published by
7 * the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 * You should have received a copy of the GNU General Public License along with
15 * this program. If not, see <http://www.gnu.org/licenses/>.
18 #include <linux/spinlock.h>
19 #include <linux/shmem_fs.h>
20 #include <linux/dma-buf.h>
27 /* called with dev->struct_mutex held */
28 static struct page **get_pages(struct drm_gem_object *obj)
30 struct msm_gem_object *msm_obj = to_msm_bo(obj);
32 if (!msm_obj->pages) {
33 struct drm_device *dev = obj->dev;
34 struct page **p = drm_gem_get_pages(obj, 0);
35 int npages = obj->size >> PAGE_SHIFT;
38 dev_err(dev->dev, "could not get pages: %ld\n",
43 msm_obj->sgt = drm_prime_pages_to_sg(p, npages);
44 if (IS_ERR(msm_obj->sgt)) {
45 dev_err(dev->dev, "failed to allocate sgt\n");
46 return ERR_CAST(msm_obj->sgt);
51 /* For non-cached buffers, ensure the new pages are clean
52 * because display controller, GPU, etc. are not coherent:
54 if (msm_obj->flags & (MSM_BO_WC|MSM_BO_UNCACHED))
55 dma_map_sg(dev->dev, msm_obj->sgt->sgl,
56 msm_obj->sgt->nents, DMA_BIDIRECTIONAL);
59 return msm_obj->pages;
62 static void put_pages(struct drm_gem_object *obj)
64 struct msm_gem_object *msm_obj = to_msm_bo(obj);
67 /* For non-cached buffers, ensure the new pages are clean
68 * because display controller, GPU, etc. are not coherent:
70 if (msm_obj->flags & (MSM_BO_WC|MSM_BO_UNCACHED))
71 dma_unmap_sg(obj->dev->dev, msm_obj->sgt->sgl,
72 msm_obj->sgt->nents, DMA_BIDIRECTIONAL);
73 sg_free_table(msm_obj->sgt);
76 drm_gem_put_pages(obj, msm_obj->pages, true, false);
77 msm_obj->pages = NULL;
81 struct page **msm_gem_get_pages(struct drm_gem_object *obj)
83 struct drm_device *dev = obj->dev;
85 mutex_lock(&dev->struct_mutex);
87 mutex_unlock(&dev->struct_mutex);
91 void msm_gem_put_pages(struct drm_gem_object *obj)
93 /* when we start tracking the pin count, then do something here */
96 int msm_gem_mmap_obj(struct drm_gem_object *obj,
97 struct vm_area_struct *vma)
99 struct msm_gem_object *msm_obj = to_msm_bo(obj);
101 vma->vm_flags &= ~VM_PFNMAP;
102 vma->vm_flags |= VM_MIXEDMAP;
104 if (msm_obj->flags & MSM_BO_WC) {
105 vma->vm_page_prot = pgprot_writecombine(vm_get_page_prot(vma->vm_flags));
106 } else if (msm_obj->flags & MSM_BO_UNCACHED) {
107 vma->vm_page_prot = pgprot_noncached(vm_get_page_prot(vma->vm_flags));
110 * Shunt off cached objs to shmem file so they have their own
111 * address_space (so unmap_mapping_range does what we want,
112 * in particular in the case of mmap'd dmabufs)
117 vma->vm_file = obj->filp;
119 vma->vm_page_prot = vm_get_page_prot(vma->vm_flags);
125 int msm_gem_mmap(struct file *filp, struct vm_area_struct *vma)
129 ret = drm_gem_mmap(filp, vma);
131 DBG("mmap failed: %d", ret);
135 return msm_gem_mmap_obj(vma->vm_private_data, vma);
138 int msm_gem_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
140 struct drm_gem_object *obj = vma->vm_private_data;
141 struct msm_gem_object *msm_obj = to_msm_bo(obj);
142 struct drm_device *dev = obj->dev;
148 /* Make sure we don't parallel update on a fault, nor move or remove
149 * something from beneath our feet
151 ret = mutex_lock_interruptible(&dev->struct_mutex);
155 /* make sure we have pages attached now */
156 pages = get_pages(obj);
158 ret = PTR_ERR(pages);
162 /* We don't use vmf->pgoff since that has the fake offset: */
163 pgoff = ((unsigned long)vmf->virtual_address -
164 vma->vm_start) >> PAGE_SHIFT;
166 pfn = page_to_pfn(msm_obj->pages[pgoff]);
168 VERB("Inserting %p pfn %lx, pa %lx", vmf->virtual_address,
169 pfn, pfn << PAGE_SHIFT);
171 ret = vm_insert_mixed(vma, (unsigned long)vmf->virtual_address, pfn);
174 mutex_unlock(&dev->struct_mutex);
183 * EBUSY is ok: this just means that another thread
184 * already did the job.
186 return VM_FAULT_NOPAGE;
190 return VM_FAULT_SIGBUS;
194 /** get mmap offset */
195 static uint64_t mmap_offset(struct drm_gem_object *obj)
197 struct drm_device *dev = obj->dev;
200 WARN_ON(!mutex_is_locked(&dev->struct_mutex));
202 /* Make it mmapable */
203 ret = drm_gem_create_mmap_offset(obj);
206 dev_err(dev->dev, "could not allocate mmap offset\n");
210 return drm_vma_node_offset_addr(&obj->vma_node);
213 uint64_t msm_gem_mmap_offset(struct drm_gem_object *obj)
216 mutex_lock(&obj->dev->struct_mutex);
217 offset = mmap_offset(obj);
218 mutex_unlock(&obj->dev->struct_mutex);
222 /* helpers for dealing w/ iommu: */
223 static int map_range(struct iommu_domain *domain, unsigned int iova,
224 struct sg_table *sgt, unsigned int len, int prot)
226 struct scatterlist *sg;
227 unsigned int da = iova;
234 for_each_sg(sgt->sgl, sg, sgt->nents, i) {
235 u32 pa = sg_phys(sg) - sg->offset;
236 size_t bytes = sg->length + sg->offset;
238 VERB("map[%d]: %08x %08x(%x)", i, iova, pa, bytes);
240 ret = iommu_map(domain, da, pa, bytes, prot);
252 for_each_sg(sgt->sgl, sg, i, j) {
253 size_t bytes = sg->length + sg->offset;
254 iommu_unmap(domain, da, bytes);
260 static void unmap_range(struct iommu_domain *domain, unsigned int iova,
261 struct sg_table *sgt, unsigned int len)
263 struct scatterlist *sg;
264 unsigned int da = iova;
267 for_each_sg(sgt->sgl, sg, sgt->nents, i) {
268 size_t bytes = sg->length + sg->offset;
271 unmapped = iommu_unmap(domain, da, bytes);
272 if (unmapped < bytes)
275 VERB("unmap[%d]: %08x(%x)", i, iova, bytes);
277 BUG_ON(!IS_ALIGNED(bytes, PAGE_SIZE));
283 /* should be called under struct_mutex.. although it can be called
284 * from atomic context without struct_mutex to acquire an extra
285 * iova ref if you know one is already held.
287 * That means when I do eventually need to add support for unpinning
288 * the refcnt counter needs to be atomic_t.
290 int msm_gem_get_iova_locked(struct drm_gem_object *obj, int id,
293 struct msm_gem_object *msm_obj = to_msm_bo(obj);
296 if (!msm_obj->domain[id].iova) {
297 struct msm_drm_private *priv = obj->dev->dev_private;
298 uint32_t offset = (uint32_t)mmap_offset(obj);
300 pages = get_pages(obj);
302 return PTR_ERR(pages);
303 // XXX ideally we would not map buffers writable when not needed...
304 ret = map_range(priv->iommus[id], offset, msm_obj->sgt,
305 obj->size, IOMMU_READ | IOMMU_WRITE);
306 msm_obj->domain[id].iova = offset;
310 *iova = msm_obj->domain[id].iova;
315 int msm_gem_get_iova(struct drm_gem_object *obj, int id, uint32_t *iova)
317 struct msm_gem_object *msm_obj = to_msm_bo(obj);
320 /* this is safe right now because we don't unmap until the
323 if (msm_obj->domain[id].iova) {
324 *iova = msm_obj->domain[id].iova;
328 mutex_lock(&obj->dev->struct_mutex);
329 ret = msm_gem_get_iova_locked(obj, id, iova);
330 mutex_unlock(&obj->dev->struct_mutex);
334 void msm_gem_put_iova(struct drm_gem_object *obj, int id)
337 // NOTE: probably don't need a _locked() version.. we wouldn't
338 // normally unmap here, but instead just mark that it could be
339 // unmapped (if the iova refcnt drops to zero), but then later
340 // if another _get_iova_locked() fails we can start unmapping
341 // things that are no longer needed..
344 int msm_gem_dumb_create(struct drm_file *file, struct drm_device *dev,
345 struct drm_mode_create_dumb *args)
347 args->pitch = align_pitch(args->width, args->bpp);
348 args->size = PAGE_ALIGN(args->pitch * args->height);
349 return msm_gem_new_handle(dev, file, args->size,
350 MSM_BO_SCANOUT | MSM_BO_WC, &args->handle);
353 int msm_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev,
354 uint32_t handle, uint64_t *offset)
356 struct drm_gem_object *obj;
359 /* GEM does all our handle to object mapping */
360 obj = drm_gem_object_lookup(dev, file, handle);
366 *offset = msm_gem_mmap_offset(obj);
368 drm_gem_object_unreference_unlocked(obj);
374 void *msm_gem_vaddr_locked(struct drm_gem_object *obj)
376 struct msm_gem_object *msm_obj = to_msm_bo(obj);
377 WARN_ON(!mutex_is_locked(&obj->dev->struct_mutex));
378 if (!msm_obj->vaddr) {
379 struct page **pages = get_pages(obj);
381 return ERR_CAST(pages);
382 msm_obj->vaddr = vmap(pages, obj->size >> PAGE_SHIFT,
383 VM_MAP, pgprot_writecombine(PAGE_KERNEL));
385 return msm_obj->vaddr;
388 void *msm_gem_vaddr(struct drm_gem_object *obj)
391 mutex_lock(&obj->dev->struct_mutex);
392 ret = msm_gem_vaddr_locked(obj);
393 mutex_unlock(&obj->dev->struct_mutex);
397 /* setup callback for when bo is no longer busy..
398 * TODO probably want to differentiate read vs write..
400 int msm_gem_queue_inactive_cb(struct drm_gem_object *obj,
401 struct msm_fence_cb *cb)
403 struct drm_device *dev = obj->dev;
404 struct msm_drm_private *priv = dev->dev_private;
405 struct msm_gem_object *msm_obj = to_msm_bo(obj);
408 mutex_lock(&dev->struct_mutex);
409 if (!list_empty(&cb->work.entry)) {
411 } else if (is_active(msm_obj)) {
412 cb->fence = max(msm_obj->read_fence, msm_obj->write_fence);
413 list_add_tail(&cb->work.entry, &priv->fence_cbs);
415 queue_work(priv->wq, &cb->work);
417 mutex_unlock(&dev->struct_mutex);
422 void msm_gem_move_to_active(struct drm_gem_object *obj,
423 struct msm_gpu *gpu, bool write, uint32_t fence)
425 struct msm_gem_object *msm_obj = to_msm_bo(obj);
428 msm_obj->write_fence = fence;
430 msm_obj->read_fence = fence;
431 list_del_init(&msm_obj->mm_list);
432 list_add_tail(&msm_obj->mm_list, &gpu->active_list);
435 void msm_gem_move_to_inactive(struct drm_gem_object *obj)
437 struct drm_device *dev = obj->dev;
438 struct msm_drm_private *priv = dev->dev_private;
439 struct msm_gem_object *msm_obj = to_msm_bo(obj);
441 WARN_ON(!mutex_is_locked(&dev->struct_mutex));
444 msm_obj->read_fence = 0;
445 msm_obj->write_fence = 0;
446 list_del_init(&msm_obj->mm_list);
447 list_add_tail(&msm_obj->mm_list, &priv->inactive_list);
450 int msm_gem_cpu_prep(struct drm_gem_object *obj, uint32_t op,
451 struct timespec *timeout)
453 struct drm_device *dev = obj->dev;
454 struct msm_gem_object *msm_obj = to_msm_bo(obj);
457 if (is_active(msm_obj)) {
460 if (op & MSM_PREP_READ)
461 fence = msm_obj->write_fence;
462 if (op & MSM_PREP_WRITE)
463 fence = max(fence, msm_obj->read_fence);
464 if (op & MSM_PREP_NOSYNC)
467 ret = msm_wait_fence_interruptable(dev, fence, timeout);
470 /* TODO cache maintenance */
475 int msm_gem_cpu_fini(struct drm_gem_object *obj)
477 /* TODO cache maintenance */
481 #ifdef CONFIG_DEBUG_FS
482 void msm_gem_describe(struct drm_gem_object *obj, struct seq_file *m)
484 struct drm_device *dev = obj->dev;
485 struct msm_gem_object *msm_obj = to_msm_bo(obj);
486 uint64_t off = drm_vma_node_start(&obj->vma_node);
488 WARN_ON(!mutex_is_locked(&dev->struct_mutex));
489 seq_printf(m, "%08x: %c(r=%u,w=%u) %2d (%2d) %08llx %p %d\n",
490 msm_obj->flags, is_active(msm_obj) ? 'A' : 'I',
491 msm_obj->read_fence, msm_obj->write_fence,
492 obj->name, obj->refcount.refcount.counter,
493 off, msm_obj->vaddr, obj->size);
496 void msm_gem_describe_objects(struct list_head *list, struct seq_file *m)
498 struct msm_gem_object *msm_obj;
502 list_for_each_entry(msm_obj, list, mm_list) {
503 struct drm_gem_object *obj = &msm_obj->base;
505 msm_gem_describe(obj, m);
510 seq_printf(m, "Total %d objects, %zu bytes\n", count, size);
514 void msm_gem_free_object(struct drm_gem_object *obj)
516 struct drm_device *dev = obj->dev;
517 struct msm_gem_object *msm_obj = to_msm_bo(obj);
520 WARN_ON(!mutex_is_locked(&dev->struct_mutex));
522 /* object should not be on active list: */
523 WARN_ON(is_active(msm_obj));
525 list_del(&msm_obj->mm_list);
527 for (id = 0; id < ARRAY_SIZE(msm_obj->domain); id++) {
528 if (msm_obj->domain[id].iova) {
529 struct msm_drm_private *priv = obj->dev->dev_private;
530 uint32_t offset = (uint32_t)mmap_offset(obj);
531 unmap_range(priv->iommus[id], offset,
532 msm_obj->sgt, obj->size);
536 drm_gem_free_mmap_offset(obj);
538 if (obj->import_attach) {
540 dma_buf_vunmap(obj->import_attach->dmabuf, msm_obj->vaddr);
542 /* Don't drop the pages for imported dmabuf, as they are not
543 * ours, just free the array we allocated:
546 drm_free_large(msm_obj->pages);
550 vunmap(msm_obj->vaddr);
554 if (msm_obj->resv == &msm_obj->_resv)
555 reservation_object_fini(msm_obj->resv);
557 drm_gem_object_release(obj);
562 /* convenience method to construct a GEM buffer object, and userspace handle */
563 int msm_gem_new_handle(struct drm_device *dev, struct drm_file *file,
564 uint32_t size, uint32_t flags, uint32_t *handle)
566 struct drm_gem_object *obj;
569 ret = mutex_lock_interruptible(&dev->struct_mutex);
573 obj = msm_gem_new(dev, size, flags);
575 mutex_unlock(&dev->struct_mutex);
580 ret = drm_gem_handle_create(file, obj, handle);
582 /* drop reference from allocate - handle holds it now */
583 drm_gem_object_unreference_unlocked(obj);
588 static int msm_gem_new_impl(struct drm_device *dev,
589 uint32_t size, uint32_t flags,
590 struct drm_gem_object **obj)
592 struct msm_drm_private *priv = dev->dev_private;
593 struct msm_gem_object *msm_obj;
595 switch (flags & MSM_BO_CACHE_MASK) {
596 case MSM_BO_UNCACHED:
601 dev_err(dev->dev, "invalid cache flag: %x\n",
602 (flags & MSM_BO_CACHE_MASK));
606 msm_obj = kzalloc(sizeof(*msm_obj), GFP_KERNEL);
610 msm_obj->flags = flags;
612 msm_obj->resv = &msm_obj->_resv;
613 reservation_object_init(msm_obj->resv);
615 INIT_LIST_HEAD(&msm_obj->submit_entry);
616 list_add_tail(&msm_obj->mm_list, &priv->inactive_list);
618 *obj = &msm_obj->base;
623 struct drm_gem_object *msm_gem_new(struct drm_device *dev,
624 uint32_t size, uint32_t flags)
626 struct drm_gem_object *obj;
629 WARN_ON(!mutex_is_locked(&dev->struct_mutex));
631 size = PAGE_ALIGN(size);
633 ret = msm_gem_new_impl(dev, size, flags, &obj);
637 ret = drm_gem_object_init(dev, obj, size);
645 drm_gem_object_unreference_unlocked(obj);
650 struct drm_gem_object *msm_gem_import(struct drm_device *dev,
651 uint32_t size, struct sg_table *sgt)
653 struct msm_gem_object *msm_obj;
654 struct drm_gem_object *obj;
657 size = PAGE_ALIGN(size);
659 ret = msm_gem_new_impl(dev, size, MSM_BO_WC, &obj);
663 drm_gem_private_object_init(dev, obj, size);
665 npages = size / PAGE_SIZE;
667 msm_obj = to_msm_bo(obj);
669 msm_obj->pages = drm_malloc_ab(npages, sizeof(struct page *));
670 if (!msm_obj->pages) {
675 ret = drm_prime_sg_to_page_addr_arrays(sgt, msm_obj->pages, NULL, npages);
683 drm_gem_object_unreference_unlocked(obj);