2 * Copyright (C) Fuzhou Rockchip Electronics Co.Ltd
3 * Author:Mark Yao <mark.yao@rock-chips.com>
5 * This software is licensed under the terms of the GNU General Public
6 * License version 2, as published by the Free Software Foundation, and
7 * may be copied, distributed, and modified under those terms.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
17 #include <drm/drm_gem.h>
18 #include <drm/drm_sync_helper.h>
19 #include <drm/drm_vma_manager.h>
20 #include <drm/rockchip_drm.h>
22 #include <linux/completion.h>
23 #include <linux/dma-attrs.h>
24 #include <linux/dma-buf.h>
25 #include <linux/reservation.h>
26 #include <linux/iommu.h>
28 #include "rockchip_drm_drv.h"
29 #include "rockchip_drm_gem.h"
31 static int rockchip_gem_iommu_map(struct rockchip_gem_object *rk_obj)
33 struct drm_device *drm = rk_obj->base.dev;
34 struct rockchip_drm_private *private = drm->dev_private;
35 int prot = IOMMU_READ | IOMMU_WRITE;
38 mutex_lock(&private->mm_lock);
40 ret = drm_mm_insert_node_generic(&private->mm, &rk_obj->mm,
41 rk_obj->base.size, PAGE_SIZE,
44 mutex_unlock(&private->mm_lock);
46 DRM_ERROR("out of I/O virtual memory: %zd\n", ret);
50 rk_obj->dma_addr = rk_obj->mm.start;
52 ret = iommu_map_sg(private->domain, rk_obj->dma_addr, rk_obj->sgt->sgl,
53 rk_obj->sgt->nents, prot);
54 if (ret < rk_obj->base.size) {
55 DRM_ERROR("failed to map buffer: size=%zd request_size=%zd\n",
56 ret, rk_obj->base.size);
66 drm_mm_remove_node(&rk_obj->mm);
71 static int rockchip_gem_iommu_unmap(struct rockchip_gem_object *rk_obj)
73 struct drm_device *drm = rk_obj->base.dev;
74 struct rockchip_drm_private *private = drm->dev_private;
76 iommu_unmap(private->domain, rk_obj->dma_addr, rk_obj->size);
78 mutex_lock(&private->mm_lock);
80 drm_mm_remove_node(&rk_obj->mm);
82 mutex_unlock(&private->mm_lock);
87 static int rockchip_gem_get_pages(struct rockchip_gem_object *rk_obj)
89 struct drm_device *drm = rk_obj->base.dev;
91 struct scatterlist *s;
93 rk_obj->pages = drm_gem_get_pages(&rk_obj->base);
94 if (IS_ERR(rk_obj->pages))
95 return PTR_ERR(rk_obj->pages);
97 rk_obj->num_pages = rk_obj->base.size >> PAGE_SHIFT;
99 rk_obj->sgt = drm_prime_pages_to_sg(rk_obj->pages, rk_obj->num_pages);
100 if (IS_ERR(rk_obj->sgt)) {
101 ret = PTR_ERR(rk_obj->sgt);
106 * Fake up the SG table so that dma_sync_sg_for_device() can be used
107 * to flush the pages associated with it.
109 * TODO: Replace this by drm_clflush_sg() once it can be implemented
110 * without relying on symbols that are not exported.
112 for_each_sg(rk_obj->sgt->sgl, s, rk_obj->sgt->nents, i)
113 sg_dma_address(s) = sg_phys(s);
115 dma_sync_sg_for_device(drm->dev, rk_obj->sgt->sgl, rk_obj->sgt->nents,
121 drm_gem_put_pages(&rk_obj->base, rk_obj->pages, false, false);
125 static void rockchip_gem_put_pages(struct rockchip_gem_object *rk_obj)
127 sg_free_table(rk_obj->sgt);
129 drm_gem_put_pages(&rk_obj->base, rk_obj->pages, true, true);
132 static int rockchip_gem_alloc_iommu(struct rockchip_gem_object *rk_obj,
137 ret = rockchip_gem_get_pages(rk_obj);
141 ret = rockchip_gem_iommu_map(rk_obj);
146 rk_obj->kvaddr = vmap(rk_obj->pages, rk_obj->num_pages, VM_MAP,
147 pgprot_writecombine(PAGE_KERNEL));
148 if (!rk_obj->kvaddr) {
149 DRM_ERROR("failed to vmap() buffer\n");
158 rockchip_gem_iommu_unmap(rk_obj);
160 rockchip_gem_put_pages(rk_obj);
165 static int rockchip_gem_alloc_dma(struct rockchip_gem_object *rk_obj,
168 struct drm_gem_object *obj = &rk_obj->base;
169 struct drm_device *drm = obj->dev;
171 init_dma_attrs(&rk_obj->dma_attrs);
172 dma_set_attr(DMA_ATTR_WRITE_COMBINE, &rk_obj->dma_attrs);
175 dma_set_attr(DMA_ATTR_NO_KERNEL_MAPPING, &rk_obj->dma_attrs);
177 rk_obj->kvaddr = dma_alloc_attrs(drm->dev, obj->size,
178 &rk_obj->dma_addr, GFP_KERNEL,
180 if (!rk_obj->kvaddr) {
181 DRM_ERROR("failed to allocate %zu byte dma buffer", obj->size);
188 static int rockchip_gem_alloc_buf(struct rockchip_gem_object *rk_obj,
191 struct drm_gem_object *obj = &rk_obj->base;
192 struct drm_device *drm = obj->dev;
193 struct rockchip_drm_private *private = drm->dev_private;
196 return rockchip_gem_alloc_iommu(rk_obj, alloc_kmap);
198 return rockchip_gem_alloc_dma(rk_obj, alloc_kmap);
201 static void rockchip_gem_free_iommu(struct rockchip_gem_object *rk_obj)
203 vunmap(rk_obj->kvaddr);
204 rockchip_gem_iommu_unmap(rk_obj);
205 rockchip_gem_put_pages(rk_obj);
208 static void rockchip_gem_free_dma(struct rockchip_gem_object *rk_obj)
210 struct drm_gem_object *obj = &rk_obj->base;
211 struct drm_device *drm = obj->dev;
213 dma_free_attrs(drm->dev, obj->size, rk_obj->kvaddr,
214 rk_obj->dma_addr, &rk_obj->dma_attrs);
217 static void rockchip_gem_free_buf(struct rockchip_gem_object *rk_obj)
220 rockchip_gem_free_iommu(rk_obj);
222 rockchip_gem_free_dma(rk_obj);
225 static int rockchip_drm_gem_object_mmap_iommu(struct drm_gem_object *obj,
226 struct vm_area_struct *vma)
228 struct rockchip_gem_object *rk_obj = to_rockchip_obj(obj);
229 unsigned int i, count = obj->size >> PAGE_SHIFT;
230 unsigned long user_count = (vma->vm_end - vma->vm_start) >> PAGE_SHIFT;
231 unsigned long uaddr = vma->vm_start;
232 unsigned long offset = vma->vm_pgoff;
233 unsigned long end = user_count + offset;
241 for (i = offset; i < end; i++) {
242 ret = vm_insert_page(vma, uaddr, rk_obj->pages[i]);
251 static int rockchip_drm_gem_object_mmap_dma(struct drm_gem_object *obj,
252 struct vm_area_struct *vma)
254 struct rockchip_gem_object *rk_obj = to_rockchip_obj(obj);
255 struct drm_device *drm = obj->dev;
257 return dma_mmap_attrs(drm->dev, vma, rk_obj->kvaddr, rk_obj->dma_addr,
258 obj->size, &rk_obj->dma_attrs);
261 static int rockchip_drm_gem_object_mmap(struct drm_gem_object *obj,
262 struct vm_area_struct *vma)
265 struct rockchip_gem_object *rk_obj = to_rockchip_obj(obj);
268 if (rk_obj->flags & ROCKCHIP_BO_CACHABLE)
269 vma->vm_page_prot = vm_get_page_prot(vma->vm_flags);
272 * We allocated a struct page table for rk_obj, so clear
273 * VM_PFNMAP flag that was set by drm_gem_mmap_obj()/drm_gem_mmap().
275 vma->vm_flags &= ~VM_PFNMAP;
278 ret = rockchip_drm_gem_object_mmap_iommu(obj, vma);
280 ret = rockchip_drm_gem_object_mmap_dma(obj, vma);
283 drm_gem_vm_close(vma);
288 int rockchip_gem_mmap_buf(struct drm_gem_object *obj,
289 struct vm_area_struct *vma)
293 ret = drm_gem_mmap_obj(obj, obj->size, vma);
297 return rockchip_drm_gem_object_mmap(obj, vma);
300 /* drm driver mmap file operations */
301 int rockchip_gem_mmap(struct file *filp, struct vm_area_struct *vma)
303 struct drm_gem_object *obj;
306 ret = drm_gem_mmap(filp, vma);
311 * Set vm_pgoff (used as a fake buffer offset by DRM) to 0 and map the
312 * whole buffer from the start.
316 obj = vma->vm_private_data;
318 return rockchip_drm_gem_object_mmap(obj, vma);
321 static struct rockchip_gem_object *
322 rockchip_gem_alloc_object(struct drm_device *drm, unsigned int size)
324 struct rockchip_gem_object *rk_obj;
325 struct drm_gem_object *obj;
327 size = round_up(size, PAGE_SIZE);
329 rk_obj = kzalloc(sizeof(*rk_obj), GFP_KERNEL);
331 return ERR_PTR(-ENOMEM);
335 drm_gem_object_init(drm, obj, size);
340 static void rockchip_gem_release_object(struct rockchip_gem_object *rk_obj)
342 drm_gem_object_release(&rk_obj->base);
346 struct rockchip_gem_object *
347 rockchip_gem_create_object(struct drm_device *drm, unsigned int size,
350 struct rockchip_gem_object *rk_obj;
353 rk_obj = rockchip_gem_alloc_object(drm, size);
357 ret = rockchip_gem_alloc_buf(rk_obj, alloc_kmap);
359 goto err_free_rk_obj;
364 rockchip_gem_release_object(rk_obj);
369 * rockchip_gem_free_object - (struct drm_driver)->gem_free_object callback
372 void rockchip_gem_free_object(struct drm_gem_object *obj)
374 struct drm_device *drm = obj->dev;
375 struct rockchip_drm_private *private = drm->dev_private;
376 struct rockchip_gem_object *rk_obj = to_rockchip_obj(obj);
378 if (obj->import_attach) {
379 if (private->domain) {
380 rockchip_gem_iommu_unmap(rk_obj);
382 dma_unmap_sg(drm->dev, rk_obj->sgt->sgl,
383 rk_obj->sgt->nents, DMA_BIDIRECTIONAL);
385 drm_prime_gem_destroy(obj, rk_obj->sgt);
387 rockchip_gem_free_buf(rk_obj);
390 #ifdef CONFIG_DRM_DMA_SYNC
391 drm_fence_signal_and_put(&rk_obj->acquire_fence);
394 rockchip_gem_release_object(rk_obj);
398 * rockchip_gem_create_with_handle - allocate an object with the given
399 * size and create a gem handle on it
401 * returns a struct rockchip_gem_object* on success or ERR_PTR values
404 static struct rockchip_gem_object *
405 rockchip_gem_create_with_handle(struct drm_file *file_priv,
406 struct drm_device *drm, unsigned int size,
407 unsigned int *handle, unsigned int flags)
409 struct rockchip_gem_object *rk_obj;
410 struct drm_gem_object *obj;
413 rk_obj = rockchip_gem_create_object(drm, size, false);
415 return ERR_CAST(rk_obj);
420 * allocate a id of idr table where the obj is registered
421 * and handle has the id what user can see.
423 ret = drm_gem_handle_create(file_priv, obj, handle);
425 goto err_handle_create;
427 rk_obj->flags = flags;
429 /* drop reference from allocate - handle holds it now. */
430 drm_gem_object_unreference_unlocked(obj);
435 rockchip_gem_free_object(obj);
440 int rockchip_gem_dumb_map_offset(struct drm_file *file_priv,
441 struct drm_device *dev, uint32_t handle,
444 struct drm_gem_object *obj;
447 obj = drm_gem_object_lookup(dev, file_priv, handle);
449 DRM_ERROR("failed to lookup gem object.\n");
453 ret = drm_gem_create_mmap_offset(obj);
457 *offset = drm_vma_node_offset_addr(&obj->vma_node);
458 DRM_DEBUG_KMS("offset = 0x%llx\n", *offset);
461 drm_gem_object_unreference_unlocked(obj);
467 * rockchip_gem_dumb_create - (struct drm_driver)->dumb_create callback
470 * This aligns the pitch and size arguments to the minimum required. wrap
471 * this into your own function if you need bigger alignment.
473 int rockchip_gem_dumb_create(struct drm_file *file_priv,
474 struct drm_device *dev,
475 struct drm_mode_create_dumb *args)
477 struct rockchip_gem_object *rk_obj;
478 int min_pitch = DIV_ROUND_UP(args->width * args->bpp, 8);
481 * align to 64 bytes since Mali requires it.
483 args->pitch = ALIGN(min_pitch, 64);
484 args->size = args->pitch * args->height;
486 rk_obj = rockchip_gem_create_with_handle(file_priv, dev, args->size,
487 &args->handle, args->flags);
489 return PTR_ERR_OR_ZERO(rk_obj);
492 int rockchip_gem_map_offset_ioctl(struct drm_device *drm, void *data,
493 struct drm_file *file_priv)
495 struct drm_rockchip_gem_map_off *args = data;
497 return rockchip_gem_dumb_map_offset(file_priv, drm, args->handle,
501 int rockchip_gem_create_ioctl(struct drm_device *dev, void *data,
502 struct drm_file *file_priv)
504 struct drm_rockchip_gem_create *args = data;
505 struct rockchip_gem_object *rk_obj;
507 rk_obj = rockchip_gem_create_with_handle(file_priv, dev, args->size,
508 &args->handle, args->flags);
509 return PTR_ERR_OR_ZERO(rk_obj);
512 static struct reservation_object *drm_gem_get_resv(struct drm_gem_object *gem)
514 struct dma_buf *dma_buf = gem->dma_buf;
515 return dma_buf ? dma_buf->resv : NULL;
518 #ifdef CONFIG_DRM_DMA_SYNC
519 static void rockchip_gem_acquire_complete(struct drm_reservation_cb *rcb,
522 struct completion *compl = context;
526 static int rockchip_gem_acquire(struct drm_device *dev,
527 struct rockchip_gem_object *rockchip_gem_obj,
531 struct rockchip_drm_private *dev_priv = dev->dev_private;
532 struct reservation_object *resv =
533 drm_gem_get_resv(&rockchip_gem_obj->base);
535 struct drm_reservation_cb rcb;
536 DECLARE_COMPLETION_ONSTACK(compl);
542 !rockchip_gem_obj->acquire_exclusive &&
543 rockchip_gem_obj->acquire_fence) {
544 atomic_inc(&rockchip_gem_obj->acquire_shared_count);
548 fence = drm_sw_fence_new(dev_priv->cpu_fence_context,
549 atomic_add_return(1, &dev_priv->cpu_fence_seqno));
551 ret = PTR_ERR(fence);
552 DRM_ERROR("Failed to create acquire fence %d.\n", ret);
555 ww_mutex_lock(&resv->lock, NULL);
557 ret = reservation_object_reserve_shared(resv);
559 DRM_ERROR("Failed to reserve space for shared fence %d.\n",
564 drm_reservation_cb_init(&rcb, rockchip_gem_acquire_complete, &compl);
565 ret = drm_reservation_cb_add(&rcb, resv, exclusive);
567 DRM_ERROR("Failed to add reservation to callback %d.\n", ret);
570 drm_reservation_cb_done(&rcb);
572 reservation_object_add_excl_fence(resv, fence);
574 reservation_object_add_shared_fence(resv, fence);
576 ww_mutex_unlock(&resv->lock);
577 mutex_unlock(&dev->struct_mutex);
578 ret = wait_for_completion_interruptible(&compl);
579 mutex_lock(&dev->struct_mutex);
581 DRM_ERROR("Failed wait for reservation callback %d.\n", ret);
582 drm_reservation_cb_fini(&rcb);
583 /* somebody else may be already waiting on it */
584 drm_fence_signal_and_put(&fence);
587 rockchip_gem_obj->acquire_fence = fence;
588 rockchip_gem_obj->acquire_exclusive = exclusive;
589 atomic_set(&rockchip_gem_obj->acquire_shared_count, 1);
593 ww_mutex_unlock(&resv->lock);
598 static void rockchip_gem_release(struct rockchip_gem_object *rockchip_gem_obj)
600 BUG_ON(!rockchip_gem_obj->acquire_fence);
601 if (atomic_sub_and_test(1,
602 &rockchip_gem_obj->acquire_shared_count))
603 drm_fence_signal_and_put(&rockchip_gem_obj->acquire_fence);
607 int rockchip_gem_cpu_acquire_ioctl(struct drm_device *dev, void *data,
608 struct drm_file *file)
610 struct drm_rockchip_gem_cpu_acquire *args = data;
611 struct rockchip_drm_file_private *file_priv = file->driver_priv;
612 struct drm_gem_object *obj;
613 struct rockchip_gem_object *rockchip_gem_obj;
614 struct rockchip_gem_object_node *gem_node;
617 DRM_DEBUG_KMS("[BO:%u] flags: 0x%x\n", args->handle, args->flags);
619 mutex_lock(&dev->struct_mutex);
621 obj = drm_gem_object_lookup(dev, file, args->handle);
623 DRM_ERROR("failed to lookup gem object.\n");
628 rockchip_gem_obj = to_rockchip_obj(obj);
630 if (!drm_gem_get_resv(&rockchip_gem_obj->base)) {
631 /* If there is no reservation object present, there is no
632 * cross-process/cross-device sharing and sync is unnecessary.
638 #ifdef CONFIG_DRM_DMA_SYNC
639 ret = rockchip_gem_acquire(dev, rockchip_gem_obj,
640 args->flags & DRM_ROCKCHIP_GEM_CPU_ACQUIRE_EXCLUSIVE);
645 gem_node = kzalloc(sizeof(*gem_node), GFP_KERNEL);
647 DRM_ERROR("Failed to allocate rockchip_drm_gem_obj_node.\n");
652 gem_node->rockchip_gem_obj = rockchip_gem_obj;
653 list_add(&gem_node->list, &file_priv->gem_cpu_acquire_list);
654 mutex_unlock(&dev->struct_mutex);
658 #ifdef CONFIG_DRM_DMA_SYNC
659 rockchip_gem_release(rockchip_gem_obj);
662 drm_gem_object_unreference(obj);
665 mutex_unlock(&dev->struct_mutex);
669 int rockchip_gem_cpu_release_ioctl(struct drm_device *dev, void *data,
670 struct drm_file *file)
672 struct drm_rockchip_gem_cpu_release *args = data;
673 struct rockchip_drm_file_private *file_priv = file->driver_priv;
674 struct drm_gem_object *obj;
675 struct rockchip_gem_object *rockchip_gem_obj;
676 struct list_head *cur;
679 DRM_DEBUG_KMS("[BO:%u]\n", args->handle);
681 mutex_lock(&dev->struct_mutex);
683 obj = drm_gem_object_lookup(dev, file, args->handle);
685 DRM_ERROR("failed to lookup gem object.\n");
690 rockchip_gem_obj = to_rockchip_obj(obj);
692 if (!drm_gem_get_resv(&rockchip_gem_obj->base)) {
693 /* If there is no reservation object present, there is no
694 * cross-process/cross-device sharing and sync is unnecessary.
700 list_for_each(cur, &file_priv->gem_cpu_acquire_list) {
701 struct rockchip_gem_object_node *node = list_entry(
702 cur, struct rockchip_gem_object_node, list);
703 if (node->rockchip_gem_obj == rockchip_gem_obj)
706 if (cur == &file_priv->gem_cpu_acquire_list) {
707 DRM_ERROR("gem object not acquired for current process.\n");
712 #ifdef CONFIG_DRM_DMA_SYNC
713 rockchip_gem_release(rockchip_gem_obj);
717 kfree(list_entry(cur, struct rockchip_gem_object_node, list));
718 /* unreference for the reference held since cpu_acquire_ioctl */
719 drm_gem_object_unreference(obj);
723 /* unreference for the reference from drm_gem_object_lookup() */
724 drm_gem_object_unreference(obj);
727 mutex_unlock(&dev->struct_mutex);
732 * Allocate a sg_table for this GEM object.
733 * Note: Both the table's contents, and the sg_table itself must be freed by
735 * Returns a pointer to the newly allocated sg_table, or an ERR_PTR() error.
737 struct sg_table *rockchip_gem_prime_get_sg_table(struct drm_gem_object *obj)
739 struct rockchip_gem_object *rk_obj = to_rockchip_obj(obj);
740 struct drm_device *drm = obj->dev;
741 struct sg_table *sgt;
745 return drm_prime_pages_to_sg(rk_obj->pages, rk_obj->num_pages);
747 sgt = kzalloc(sizeof(*sgt), GFP_KERNEL);
749 return ERR_PTR(-ENOMEM);
751 ret = dma_get_sgtable_attrs(drm->dev, sgt, rk_obj->kvaddr,
752 rk_obj->dma_addr, obj->size,
755 DRM_ERROR("failed to allocate sgt, %d\n", ret);
763 static unsigned long rockchip_sg_get_contiguous_size(struct sg_table *sgt,
766 struct scatterlist *s;
767 dma_addr_t expected = sg_dma_address(sgt->sgl);
769 unsigned long size = 0;
771 for_each_sg(sgt->sgl, s, count, i) {
772 if (sg_dma_address(s) != expected)
774 expected = sg_dma_address(s) + sg_dma_len(s);
775 size += sg_dma_len(s);
781 rockchip_gem_iommu_map_sg(struct drm_device *drm,
782 struct dma_buf_attachment *attach,
784 struct rockchip_gem_object *rk_obj)
787 return rockchip_gem_iommu_map(rk_obj);
791 rockchip_gem_dma_map_sg(struct drm_device *drm,
792 struct dma_buf_attachment *attach,
794 struct rockchip_gem_object *rk_obj)
796 int count = dma_map_sg(drm->dev, sg->sgl, sg->nents,
801 if (rockchip_sg_get_contiguous_size(sg, count) < attach->dmabuf->size) {
802 DRM_ERROR("failed to map sg_table to contiguous linear address.\n");
803 dma_unmap_sg(drm->dev, sg->sgl, sg->nents,
808 rk_obj->dma_addr = sg_dma_address(sg->sgl);
813 struct drm_gem_object *
814 rockchip_gem_prime_import_sg_table(struct drm_device *drm,
815 struct dma_buf_attachment *attach,
818 struct rockchip_drm_private *private = drm->dev_private;
819 struct rockchip_gem_object *rk_obj;
822 rk_obj = rockchip_gem_alloc_object(drm, attach->dmabuf->size);
824 return ERR_CAST(rk_obj);
827 ret = rockchip_gem_iommu_map_sg(drm, attach, sg, rk_obj);
829 ret = rockchip_gem_dma_map_sg(drm, attach, sg, rk_obj);
832 DRM_ERROR("failed to import sg table: %d\n", ret);
833 goto err_free_rk_obj;
836 return &rk_obj->base;
839 rockchip_gem_release_object(rk_obj);
843 void *rockchip_gem_prime_vmap(struct drm_gem_object *obj)
845 struct rockchip_gem_object *rk_obj = to_rockchip_obj(obj);
848 return vmap(rk_obj->pages, rk_obj->num_pages, VM_MAP,
849 pgprot_writecombine(PAGE_KERNEL));
851 if (dma_get_attr(DMA_ATTR_NO_KERNEL_MAPPING, &rk_obj->dma_attrs))
854 return rk_obj->kvaddr;
857 void rockchip_gem_prime_vunmap(struct drm_gem_object *obj, void *vaddr)
859 struct rockchip_gem_object *rk_obj = to_rockchip_obj(obj);
866 /* Nothing to do if allocated by DMA mapping API. */