1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2011 Texas Instruments Incorporated - https://www.ti.com/
7 #include <linux/dma-mapping.h>
8 #include <linux/seq_file.h>
9 #include <linux/shmem_fs.h>
10 #include <linux/spinlock.h>
11 #include <linux/pfn_t.h>
13 #include <drm/drm_prime.h>
14 #include <drm/drm_vma_manager.h>
17 #include "omap_dmm_tiler.h"
20 * GEM buffer object implementation.
23 /* note: we use upper 8 bits of flags for driver-internal flags: */
24 #define OMAP_BO_MEM_DMA_API 0x01000000 /* memory allocated with the dma_alloc_* API */
25 #define OMAP_BO_MEM_SHMEM 0x02000000 /* memory allocated through shmem backing */
26 #define OMAP_BO_MEM_DMABUF 0x08000000 /* memory imported from a dmabuf */
28 struct omap_gem_object {
29 struct drm_gem_object base;
31 struct list_head mm_list;
35 /** width/height for tiled formats (rounded up to slot boundaries) */
38 /** roll applied when mapping to DMM */
41 /** protects pin_cnt, block, pages, dma_addrs and vaddr */
45 * dma_addr contains the buffer DMA address. It is valid for
47 * - buffers allocated through the DMA mapping API (with the
48 * OMAP_BO_MEM_DMA_API flag set)
50 * - buffers imported from dmabuf (with the OMAP_BO_MEM_DMABUF flag set)
51 * if they are physically contiguous
53 * - buffers mapped through the TILER when pin_cnt is not zero, in which
54 * case the DMA address points to the TILER aperture
56 * Physically contiguous buffers have their DMA address equal to the
57 * physical address as we don't remap those buffers through the TILER.
59 * Buffers mapped to the TILER have their DMA address pointing to the
60 * TILER aperture. As TILER mappings are refcounted (through pin_cnt)
61 * the DMA address must be accessed through omap_gem_pin() to ensure
62 * that the mapping won't disappear unexpectedly. References must be
63 * released with omap_gem_unpin().
73 * If the buffer has been imported from a dmabuf the OMAP_DB_DMABUF flag
74 * is set and the sgt field is valid.
79 * tiler block used when buffer is remapped in DMM/TILER.
81 struct tiler_block *block;
84 * Array of backing pages, if allocated. Note that pages are never
85 * allocated for buffers originally allocated from contiguous memory
89 /** addresses corresponding to pages in above array */
90 dma_addr_t *dma_addrs;
93 * Virtual address, if mapped.
98 #define to_omap_bo(x) container_of(x, struct omap_gem_object, base)
100 /* To deal with userspace mmap'ings of 2d tiled buffers, which (a) are
101 * not necessarily pinned in TILER all the time, and (b) when they are
102 * they are not necessarily page aligned, we reserve one or more small
103 * regions in each of the 2d containers to use as a user-GART where we
104 * can create a second page-aligned mapping of parts of the buffer
105 * being accessed from userspace.
107 * Note that we could optimize slightly when we know that multiple
108 * tiler containers are backed by the same PAT.. but I'll leave that
111 #define NUM_USERGART_ENTRIES 2
112 struct omap_drm_usergart_entry {
113 struct tiler_block *block; /* the reserved tiler block */
115 struct drm_gem_object *obj; /* the current pinned obj */
116 pgoff_t obj_pgoff; /* page offset of obj currently
120 struct omap_drm_usergart {
121 struct omap_drm_usergart_entry entry[NUM_USERGART_ENTRIES];
122 int height; /* height in rows */
123 int height_shift; /* ilog2(height in rows) */
124 int slot_shift; /* ilog2(width per slot) */
125 int stride_pfn; /* stride in pages */
126 int last; /* index of last used entry */
129 /* -----------------------------------------------------------------------------
133 /** get mmap offset */
134 u64 omap_gem_mmap_offset(struct drm_gem_object *obj)
136 struct drm_device *dev = obj->dev;
140 /* Make it mmapable */
141 size = omap_gem_mmap_size(obj);
142 ret = drm_gem_create_mmap_offset_size(obj, size);
144 dev_err(dev->dev, "could not allocate mmap offset\n");
148 return drm_vma_node_offset_addr(&obj->vma_node);
151 static bool omap_gem_sgt_is_contiguous(struct sg_table *sgt, size_t size)
153 return !(drm_prime_get_contiguous_size(sgt) < size);
156 static bool omap_gem_is_contiguous(struct omap_gem_object *omap_obj)
158 if (omap_obj->flags & OMAP_BO_MEM_DMA_API)
161 if ((omap_obj->flags & OMAP_BO_MEM_DMABUF) &&
162 omap_gem_sgt_is_contiguous(omap_obj->sgt, omap_obj->base.size))
168 /* -----------------------------------------------------------------------------
172 static void omap_gem_evict_entry(struct drm_gem_object *obj,
173 enum tiler_fmt fmt, struct omap_drm_usergart_entry *entry)
175 struct omap_gem_object *omap_obj = to_omap_bo(obj);
176 struct omap_drm_private *priv = obj->dev->dev_private;
177 int n = priv->usergart[fmt].height;
178 size_t size = PAGE_SIZE * n;
179 loff_t off = omap_gem_mmap_offset(obj) +
180 (entry->obj_pgoff << PAGE_SHIFT);
181 const int m = DIV_ROUND_UP(omap_obj->width << fmt, PAGE_SIZE);
185 /* if stride > than PAGE_SIZE then sparse mapping: */
186 for (i = n; i > 0; i--) {
187 unmap_mapping_range(obj->dev->anon_inode->i_mapping,
189 off += PAGE_SIZE * m;
192 unmap_mapping_range(obj->dev->anon_inode->i_mapping,
199 /* Evict a buffer from usergart, if it is mapped there */
200 static void omap_gem_evict(struct drm_gem_object *obj)
202 struct omap_gem_object *omap_obj = to_omap_bo(obj);
203 struct omap_drm_private *priv = obj->dev->dev_private;
205 if (omap_obj->flags & OMAP_BO_TILED_MASK) {
206 enum tiler_fmt fmt = gem2fmt(omap_obj->flags);
209 for (i = 0; i < NUM_USERGART_ENTRIES; i++) {
210 struct omap_drm_usergart_entry *entry =
211 &priv->usergart[fmt].entry[i];
213 if (entry->obj == obj)
214 omap_gem_evict_entry(obj, fmt, entry);
219 /* -----------------------------------------------------------------------------
224 * Ensure backing pages are allocated. Must be called with the omap_obj.lock
227 static int omap_gem_attach_pages(struct drm_gem_object *obj)
229 struct drm_device *dev = obj->dev;
230 struct omap_gem_object *omap_obj = to_omap_bo(obj);
232 int npages = obj->size >> PAGE_SHIFT;
236 lockdep_assert_held(&omap_obj->lock);
239 * If not using shmem (in which case backing pages don't need to be
240 * allocated) or if pages are already allocated we're done.
242 if (!(omap_obj->flags & OMAP_BO_MEM_SHMEM) || omap_obj->pages)
245 pages = drm_gem_get_pages(obj);
247 dev_err(obj->dev->dev, "could not get pages: %ld\n", PTR_ERR(pages));
248 return PTR_ERR(pages);
251 /* for non-cached buffers, ensure the new pages are clean because
252 * DSS, GPU, etc. are not cache coherent:
254 if (omap_obj->flags & (OMAP_BO_WC|OMAP_BO_UNCACHED)) {
255 addrs = kmalloc_array(npages, sizeof(*addrs), GFP_KERNEL);
261 for (i = 0; i < npages; i++) {
262 addrs[i] = dma_map_page(dev->dev, pages[i],
263 0, PAGE_SIZE, DMA_TO_DEVICE);
265 if (dma_mapping_error(dev->dev, addrs[i])) {
267 "%s: failed to map page\n", __func__);
269 for (i = i - 1; i >= 0; --i) {
270 dma_unmap_page(dev->dev, addrs[i],
271 PAGE_SIZE, DMA_TO_DEVICE);
279 addrs = kcalloc(npages, sizeof(*addrs), GFP_KERNEL);
286 omap_obj->dma_addrs = addrs;
287 omap_obj->pages = pages;
294 drm_gem_put_pages(obj, pages, true, false);
299 /* Release backing pages. Must be called with the omap_obj.lock held. */
300 static void omap_gem_detach_pages(struct drm_gem_object *obj)
302 struct omap_gem_object *omap_obj = to_omap_bo(obj);
303 unsigned int npages = obj->size >> PAGE_SHIFT;
306 lockdep_assert_held(&omap_obj->lock);
308 for (i = 0; i < npages; i++) {
309 if (omap_obj->dma_addrs[i])
310 dma_unmap_page(obj->dev->dev, omap_obj->dma_addrs[i],
311 PAGE_SIZE, DMA_TO_DEVICE);
314 kfree(omap_obj->dma_addrs);
315 omap_obj->dma_addrs = NULL;
317 drm_gem_put_pages(obj, omap_obj->pages, true, false);
318 omap_obj->pages = NULL;
321 /* get buffer flags */
322 u32 omap_gem_flags(struct drm_gem_object *obj)
324 return to_omap_bo(obj)->flags;
328 size_t omap_gem_mmap_size(struct drm_gem_object *obj)
330 struct omap_gem_object *omap_obj = to_omap_bo(obj);
331 size_t size = obj->size;
333 if (omap_obj->flags & OMAP_BO_TILED_MASK) {
334 /* for tiled buffers, the virtual size has stride rounded up
335 * to 4kb.. (to hide the fact that row n+1 might start 16kb or
336 * 32kb later!). But we don't back the entire buffer with
337 * pages, only the valid picture part.. so need to adjust for
338 * this in the size used to mmap and generate mmap offset
340 size = tiler_vsize(gem2fmt(omap_obj->flags),
341 omap_obj->width, omap_obj->height);
347 /* -----------------------------------------------------------------------------
351 /* Normal handling for the case of faulting in non-tiled buffers */
352 static vm_fault_t omap_gem_fault_1d(struct drm_gem_object *obj,
353 struct vm_area_struct *vma, struct vm_fault *vmf)
355 struct omap_gem_object *omap_obj = to_omap_bo(obj);
359 /* We don't use vmf->pgoff since that has the fake offset: */
360 pgoff = (vmf->address - vma->vm_start) >> PAGE_SHIFT;
362 if (omap_obj->pages) {
363 omap_gem_cpu_sync_page(obj, pgoff);
364 pfn = page_to_pfn(omap_obj->pages[pgoff]);
366 BUG_ON(!omap_gem_is_contiguous(omap_obj));
367 pfn = (omap_obj->dma_addr >> PAGE_SHIFT) + pgoff;
370 VERB("Inserting %p pfn %lx, pa %lx", (void *)vmf->address,
371 pfn, pfn << PAGE_SHIFT);
373 return vmf_insert_mixed(vma, vmf->address,
374 __pfn_to_pfn_t(pfn, PFN_DEV));
377 /* Special handling for the case of faulting in 2d tiled buffers */
378 static vm_fault_t omap_gem_fault_2d(struct drm_gem_object *obj,
379 struct vm_area_struct *vma, struct vm_fault *vmf)
381 struct omap_gem_object *omap_obj = to_omap_bo(obj);
382 struct omap_drm_private *priv = obj->dev->dev_private;
383 struct omap_drm_usergart_entry *entry;
384 enum tiler_fmt fmt = gem2fmt(omap_obj->flags);
385 struct page *pages[64]; /* XXX is this too much to have on stack? */
387 pgoff_t pgoff, base_pgoff;
390 vm_fault_t ret = VM_FAULT_NOPAGE;
393 * Note the height of the slot is also equal to the number of pages
394 * that need to be mapped in to fill 4kb wide CPU page. If the slot
395 * height is 64, then 64 pages fill a 4kb wide by 64 row region.
397 const int n = priv->usergart[fmt].height;
398 const int n_shift = priv->usergart[fmt].height_shift;
401 * If buffer width in bytes > PAGE_SIZE then the virtual stride is
402 * rounded up to next multiple of PAGE_SIZE.. this need to be taken
403 * into account in some of the math, so figure out virtual stride
406 const int m = DIV_ROUND_UP(omap_obj->width << fmt, PAGE_SIZE);
408 /* We don't use vmf->pgoff since that has the fake offset: */
409 pgoff = (vmf->address - vma->vm_start) >> PAGE_SHIFT;
412 * Actual address we start mapping at is rounded down to previous slot
413 * boundary in the y direction:
415 base_pgoff = round_down(pgoff, m << n_shift);
417 /* figure out buffer width in slots */
418 slots = omap_obj->width >> priv->usergart[fmt].slot_shift;
420 vaddr = vmf->address - ((pgoff - base_pgoff) << PAGE_SHIFT);
422 entry = &priv->usergart[fmt].entry[priv->usergart[fmt].last];
424 /* evict previous buffer using this usergart entry, if any: */
426 omap_gem_evict_entry(entry->obj, fmt, entry);
429 entry->obj_pgoff = base_pgoff;
431 /* now convert base_pgoff to phys offset from virt offset: */
432 base_pgoff = (base_pgoff >> n_shift) * slots;
434 /* for wider-than 4k.. figure out which part of the slot-row we want: */
437 entry->obj_pgoff += off;
439 slots = min(slots - (off << n_shift), n);
440 base_pgoff += off << n_shift;
441 vaddr += off << PAGE_SHIFT;
445 * Map in pages. Beyond the valid pixel part of the buffer, we set
446 * pages[i] to NULL to get a dummy page mapped in.. if someone
447 * reads/writes it they will get random/undefined content, but at
448 * least it won't be corrupting whatever other random page used to
449 * be mapped in, or other undefined behavior.
451 memcpy(pages, &omap_obj->pages[base_pgoff],
452 sizeof(struct page *) * slots);
453 memset(pages + slots, 0,
454 sizeof(struct page *) * (n - slots));
456 err = tiler_pin(entry->block, pages, ARRAY_SIZE(pages), 0, true);
458 ret = vmf_error(err);
459 dev_err(obj->dev->dev, "failed to pin: %d\n", err);
463 pfn = entry->dma_addr >> PAGE_SHIFT;
465 VERB("Inserting %p pfn %lx, pa %lx", (void *)vmf->address,
466 pfn, pfn << PAGE_SHIFT);
468 for (i = n; i > 0; i--) {
469 ret = vmf_insert_mixed(vma,
470 vaddr, __pfn_to_pfn_t(pfn, PFN_DEV));
471 if (ret & VM_FAULT_ERROR)
473 pfn += priv->usergart[fmt].stride_pfn;
474 vaddr += PAGE_SIZE * m;
477 /* simple round-robin: */
478 priv->usergart[fmt].last = (priv->usergart[fmt].last + 1)
479 % NUM_USERGART_ENTRIES;
485 * omap_gem_fault - pagefault handler for GEM objects
488 * Invoked when a fault occurs on an mmap of a GEM managed area. GEM
489 * does most of the work for us including the actual map/unmap calls
490 * but we need to do the actual page work.
492 * The VMA was set up by GEM. In doing so it also ensured that the
493 * vma->vm_private_data points to the GEM object that is backing this
496 static vm_fault_t omap_gem_fault(struct vm_fault *vmf)
498 struct vm_area_struct *vma = vmf->vma;
499 struct drm_gem_object *obj = vma->vm_private_data;
500 struct omap_gem_object *omap_obj = to_omap_bo(obj);
504 /* Make sure we don't parallel update on a fault, nor move or remove
505 * something from beneath our feet
507 mutex_lock(&omap_obj->lock);
509 /* if a shmem backed object, make sure we have pages attached now */
510 err = omap_gem_attach_pages(obj);
512 ret = vmf_error(err);
516 /* where should we do corresponding put_pages().. we are mapping
517 * the original page, rather than thru a GART, so we can't rely
518 * on eviction to trigger this. But munmap() or all mappings should
519 * probably trigger put_pages()?
522 if (omap_obj->flags & OMAP_BO_TILED_MASK)
523 ret = omap_gem_fault_2d(obj, vma, vmf);
525 ret = omap_gem_fault_1d(obj, vma, vmf);
529 mutex_unlock(&omap_obj->lock);
533 static int omap_gem_object_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma)
535 struct omap_gem_object *omap_obj = to_omap_bo(obj);
537 vm_flags_set(vma, VM_DONTEXPAND | VM_DONTDUMP | VM_IO | VM_MIXEDMAP);
539 if (omap_obj->flags & OMAP_BO_WC) {
540 vma->vm_page_prot = pgprot_writecombine(vm_get_page_prot(vma->vm_flags));
541 } else if (omap_obj->flags & OMAP_BO_UNCACHED) {
542 vma->vm_page_prot = pgprot_noncached(vm_get_page_prot(vma->vm_flags));
545 * We do have some private objects, at least for scanout buffers
546 * on hardware without DMM/TILER. But these are allocated write-
549 if (WARN_ON(!obj->filp))
553 * Shunt off cached objs to shmem file so they have their own
554 * address_space (so unmap_mapping_range does what we want,
555 * in particular in the case of mmap'd dmabufs)
557 vma->vm_pgoff -= drm_vma_node_start(&obj->vma_node);
558 vma_set_file(vma, obj->filp);
560 vma->vm_page_prot = vm_get_page_prot(vma->vm_flags);
563 vma->vm_page_prot = pgprot_decrypted(vma->vm_page_prot);
568 /* -----------------------------------------------------------------------------
573 * omap_gem_dumb_create - create a dumb buffer
574 * @file: our client file
576 * @args: the requested arguments copied from userspace
578 * Allocate a buffer suitable for use for a frame buffer of the
579 * form described by user space. Give userspace a handle by which
582 int omap_gem_dumb_create(struct drm_file *file, struct drm_device *dev,
583 struct drm_mode_create_dumb *args)
585 union omap_gem_size gsize;
587 args->pitch = DIV_ROUND_UP(args->width * args->bpp, 8);
589 args->size = PAGE_ALIGN(args->pitch * args->height);
591 gsize = (union omap_gem_size){
595 return omap_gem_new_handle(dev, file, gsize,
596 OMAP_BO_SCANOUT | OMAP_BO_WC, &args->handle);
600 * omap_gem_dumb_map_offset - create an offset for a dumb buffer
601 * @file: our drm client file
603 * @handle: GEM handle to the object (from dumb_create)
604 * @offset: memory map offset placeholder
606 * Do the necessary setup to allow the mapping of the frame buffer
607 * into user memory. We don't have to do much here at the moment.
609 int omap_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev,
610 u32 handle, u64 *offset)
612 struct drm_gem_object *obj;
615 /* GEM does all our handle to object mapping */
616 obj = drm_gem_object_lookup(file, handle);
622 *offset = omap_gem_mmap_offset(obj);
624 drm_gem_object_put(obj);
630 #ifdef CONFIG_DRM_FBDEV_EMULATION
631 /* Set scrolling position. This allows us to implement fast scrolling
634 * Call only from non-atomic contexts.
636 int omap_gem_roll(struct drm_gem_object *obj, u32 roll)
638 struct omap_gem_object *omap_obj = to_omap_bo(obj);
639 u32 npages = obj->size >> PAGE_SHIFT;
643 dev_err(obj->dev->dev, "invalid roll: %d\n", roll);
647 omap_obj->roll = roll;
649 mutex_lock(&omap_obj->lock);
651 /* if we aren't mapped yet, we don't need to do anything */
652 if (omap_obj->block) {
653 ret = omap_gem_attach_pages(obj);
657 ret = tiler_pin(omap_obj->block, omap_obj->pages, npages,
660 dev_err(obj->dev->dev, "could not repin: %d\n", ret);
664 mutex_unlock(&omap_obj->lock);
670 /* -----------------------------------------------------------------------------
671 * Memory Management & DMA Sync
675 * shmem buffers that are mapped cached are not coherent.
677 * We keep track of dirty pages using page faulting to perform cache management.
678 * When a page is mapped to the CPU in read/write mode the device can't access
679 * it and omap_obj->dma_addrs[i] is NULL. When a page is mapped to the device
680 * the omap_obj->dma_addrs[i] is set to the DMA address, and the page is
681 * unmapped from the CPU.
683 static inline bool omap_gem_is_cached_coherent(struct drm_gem_object *obj)
685 struct omap_gem_object *omap_obj = to_omap_bo(obj);
687 return !((omap_obj->flags & OMAP_BO_MEM_SHMEM) &&
688 ((omap_obj->flags & OMAP_BO_CACHE_MASK) == OMAP_BO_CACHED));
691 /* Sync the buffer for CPU access.. note pages should already be
692 * attached, ie. omap_gem_get_pages()
694 void omap_gem_cpu_sync_page(struct drm_gem_object *obj, int pgoff)
696 struct drm_device *dev = obj->dev;
697 struct omap_gem_object *omap_obj = to_omap_bo(obj);
699 if (omap_gem_is_cached_coherent(obj))
702 if (omap_obj->dma_addrs[pgoff]) {
703 dma_unmap_page(dev->dev, omap_obj->dma_addrs[pgoff],
704 PAGE_SIZE, DMA_TO_DEVICE);
705 omap_obj->dma_addrs[pgoff] = 0;
709 /* sync the buffer for DMA access */
710 void omap_gem_dma_sync_buffer(struct drm_gem_object *obj,
711 enum dma_data_direction dir)
713 struct drm_device *dev = obj->dev;
714 struct omap_gem_object *omap_obj = to_omap_bo(obj);
715 int i, npages = obj->size >> PAGE_SHIFT;
716 struct page **pages = omap_obj->pages;
719 if (omap_gem_is_cached_coherent(obj))
722 for (i = 0; i < npages; i++) {
723 if (!omap_obj->dma_addrs[i]) {
726 addr = dma_map_page(dev->dev, pages[i], 0,
728 if (dma_mapping_error(dev->dev, addr)) {
729 dev_warn(dev->dev, "%s: failed to map page\n",
735 omap_obj->dma_addrs[i] = addr;
740 unmap_mapping_range(obj->filp->f_mapping, 0,
741 omap_gem_mmap_size(obj), 1);
745 static int omap_gem_pin_tiler(struct drm_gem_object *obj)
747 struct omap_gem_object *omap_obj = to_omap_bo(obj);
748 u32 npages = obj->size >> PAGE_SHIFT;
749 enum tiler_fmt fmt = gem2fmt(omap_obj->flags);
750 struct tiler_block *block;
753 BUG_ON(omap_obj->block);
755 if (omap_obj->flags & OMAP_BO_TILED_MASK) {
756 block = tiler_reserve_2d(fmt, omap_obj->width, omap_obj->height,
759 block = tiler_reserve_1d(obj->size);
763 ret = PTR_ERR(block);
764 dev_err(obj->dev->dev, "could not remap: %d (%d)\n", ret, fmt);
768 /* TODO: enable async refill.. */
769 ret = tiler_pin(block, omap_obj->pages, npages, omap_obj->roll, true);
771 tiler_release(block);
772 dev_err(obj->dev->dev, "could not pin: %d\n", ret);
776 omap_obj->dma_addr = tiler_ssptr(block);
777 omap_obj->block = block;
779 DBG("got dma address: %pad", &omap_obj->dma_addr);
786 * omap_gem_pin() - Pin a GEM object in memory
787 * @obj: the GEM object
788 * @dma_addr: the DMA address
790 * Pin the given GEM object in memory and fill the dma_addr pointer with the
791 * object's DMA address. If the buffer is not physically contiguous it will be
792 * remapped through the TILER to provide a contiguous view.
794 * Pins are reference-counted, calling this function multiple times is allowed
795 * as long the corresponding omap_gem_unpin() calls are balanced.
797 * Return 0 on success or a negative error code otherwise.
799 int omap_gem_pin(struct drm_gem_object *obj, dma_addr_t *dma_addr)
801 struct omap_drm_private *priv = obj->dev->dev_private;
802 struct omap_gem_object *omap_obj = to_omap_bo(obj);
805 mutex_lock(&omap_obj->lock);
807 if (!omap_gem_is_contiguous(omap_obj)) {
808 if (refcount_read(&omap_obj->pin_cnt) == 0) {
810 refcount_set(&omap_obj->pin_cnt, 1);
812 ret = omap_gem_attach_pages(obj);
816 if (omap_obj->flags & OMAP_BO_SCANOUT) {
818 ret = omap_gem_pin_tiler(obj);
824 refcount_inc(&omap_obj->pin_cnt);
829 *dma_addr = omap_obj->dma_addr;
832 mutex_unlock(&omap_obj->lock);
838 * omap_gem_unpin_locked() - Unpin a GEM object from memory
839 * @obj: the GEM object
841 * omap_gem_unpin() without locking.
843 static void omap_gem_unpin_locked(struct drm_gem_object *obj)
845 struct omap_drm_private *priv = obj->dev->dev_private;
846 struct omap_gem_object *omap_obj = to_omap_bo(obj);
849 if (omap_gem_is_contiguous(omap_obj))
852 if (refcount_dec_and_test(&omap_obj->pin_cnt)) {
854 sg_free_table(omap_obj->sgt);
855 kfree(omap_obj->sgt);
856 omap_obj->sgt = NULL;
858 if (!(omap_obj->flags & OMAP_BO_SCANOUT))
861 ret = tiler_unpin(omap_obj->block);
863 dev_err(obj->dev->dev,
864 "could not unpin pages: %d\n", ret);
866 ret = tiler_release(omap_obj->block);
868 dev_err(obj->dev->dev,
869 "could not release unmap: %d\n", ret);
871 omap_obj->dma_addr = 0;
872 omap_obj->block = NULL;
878 * omap_gem_unpin() - Unpin a GEM object from memory
879 * @obj: the GEM object
881 * Unpin the given GEM object previously pinned with omap_gem_pin(). Pins are
882 * reference-counted, the actual unpin will only be performed when the number
883 * of calls to this function matches the number of calls to omap_gem_pin().
885 void omap_gem_unpin(struct drm_gem_object *obj)
887 struct omap_gem_object *omap_obj = to_omap_bo(obj);
889 mutex_lock(&omap_obj->lock);
890 omap_gem_unpin_locked(obj);
891 mutex_unlock(&omap_obj->lock);
894 /* Get rotated scanout address (only valid if already pinned), at the
895 * specified orientation and x,y offset from top-left corner of buffer
896 * (only valid for tiled 2d buffers)
898 int omap_gem_rotated_dma_addr(struct drm_gem_object *obj, u32 orient,
899 int x, int y, dma_addr_t *dma_addr)
901 struct omap_gem_object *omap_obj = to_omap_bo(obj);
904 mutex_lock(&omap_obj->lock);
906 if ((refcount_read(&omap_obj->pin_cnt) > 0) && omap_obj->block &&
907 (omap_obj->flags & OMAP_BO_TILED_MASK)) {
908 *dma_addr = tiler_tsptr(omap_obj->block, orient, x, y);
912 mutex_unlock(&omap_obj->lock);
917 /* Get tiler stride for the buffer (only valid for 2d tiled buffers) */
918 int omap_gem_tiled_stride(struct drm_gem_object *obj, u32 orient)
920 struct omap_gem_object *omap_obj = to_omap_bo(obj);
922 if (omap_obj->flags & OMAP_BO_TILED_MASK)
923 ret = tiler_stride(gem2fmt(omap_obj->flags), orient);
927 /* if !remap, and we don't have pages backing, then fail, rather than
928 * increasing the pin count (which we don't really do yet anyways,
929 * because we don't support swapping pages back out). And 'remap'
930 * might not be quite the right name, but I wanted to keep it working
931 * similarly to omap_gem_pin(). Note though that mutex is not
932 * aquired if !remap (because this can be called in atomic ctxt),
933 * but probably omap_gem_unpin() should be changed to work in the
934 * same way. If !remap, a matching omap_gem_put_pages() call is not
935 * required (and should not be made).
937 int omap_gem_get_pages(struct drm_gem_object *obj, struct page ***pages,
940 struct omap_gem_object *omap_obj = to_omap_bo(obj);
943 mutex_lock(&omap_obj->lock);
946 ret = omap_gem_attach_pages(obj);
951 if (!omap_obj->pages) {
956 *pages = omap_obj->pages;
959 mutex_unlock(&omap_obj->lock);
964 /* release pages when DMA no longer being performed */
965 int omap_gem_put_pages(struct drm_gem_object *obj)
967 /* do something here if we dynamically attach/detach pages.. at
968 * least they would no longer need to be pinned if everyone has
969 * released the pages..
974 struct sg_table *omap_gem_get_sg(struct drm_gem_object *obj,
975 enum dma_data_direction dir)
977 struct omap_gem_object *omap_obj = to_omap_bo(obj);
979 struct sg_table *sgt;
980 struct scatterlist *sg;
981 unsigned int count, len, stride, i;
984 ret = omap_gem_pin(obj, &addr);
988 mutex_lock(&omap_obj->lock);
994 sgt = kzalloc(sizeof(*sgt), GFP_KERNEL);
1001 if (omap_obj->flags & OMAP_BO_TILED_MASK) {
1002 enum tiler_fmt fmt = gem2fmt(omap_obj->flags);
1004 len = omap_obj->width << (int)fmt;
1005 count = omap_obj->height;
1006 stride = tiler_stride(fmt, 0);
1013 count = obj->size >> PAGE_SHIFT;
1016 ret = sg_alloc_table(sgt, count, GFP_KERNEL);
1020 /* this must be after omap_gem_pin() to ensure we have pages attached */
1021 omap_gem_dma_sync_buffer(obj, dir);
1024 for_each_sg(sgt->sgl, sg, count, i) {
1025 sg_set_page(sg, phys_to_page(addr), len,
1026 offset_in_page(addr));
1027 sg_dma_address(sg) = addr;
1028 sg_dma_len(sg) = len;
1033 for_each_sg(sgt->sgl, sg, count, i) {
1034 sg_set_page(sg, omap_obj->pages[i], PAGE_SIZE, 0);
1035 sg_dma_address(sg) = omap_obj->dma_addrs[i];
1036 sg_dma_len(sg) = PAGE_SIZE;
1040 omap_obj->sgt = sgt;
1042 mutex_unlock(&omap_obj->lock);
1048 mutex_unlock(&omap_obj->lock);
1049 omap_gem_unpin(obj);
1050 return ERR_PTR(ret);
1053 void omap_gem_put_sg(struct drm_gem_object *obj, struct sg_table *sgt)
1055 struct omap_gem_object *omap_obj = to_omap_bo(obj);
1057 if (WARN_ON(omap_obj->sgt != sgt))
1060 omap_gem_unpin(obj);
1063 #ifdef CONFIG_DRM_FBDEV_EMULATION
1065 * Get kernel virtual address for CPU access.. this more or less only
1066 * exists for omap_fbdev.
1068 void *omap_gem_vaddr(struct drm_gem_object *obj)
1070 struct omap_gem_object *omap_obj = to_omap_bo(obj);
1074 mutex_lock(&omap_obj->lock);
1076 if (!omap_obj->vaddr) {
1077 ret = omap_gem_attach_pages(obj);
1079 vaddr = ERR_PTR(ret);
1083 omap_obj->vaddr = vmap(omap_obj->pages, obj->size >> PAGE_SHIFT,
1084 VM_MAP, pgprot_writecombine(PAGE_KERNEL));
1087 vaddr = omap_obj->vaddr;
1090 mutex_unlock(&omap_obj->lock);
1095 /* -----------------------------------------------------------------------------
1100 /* re-pin objects in DMM in resume path: */
1101 int omap_gem_resume(struct drm_device *dev)
1103 struct omap_drm_private *priv = dev->dev_private;
1104 struct omap_gem_object *omap_obj;
1107 mutex_lock(&priv->list_lock);
1108 list_for_each_entry(omap_obj, &priv->obj_list, mm_list) {
1109 if (omap_obj->block) {
1110 struct drm_gem_object *obj = &omap_obj->base;
1111 u32 npages = obj->size >> PAGE_SHIFT;
1113 WARN_ON(!omap_obj->pages); /* this can't happen */
1114 ret = tiler_pin(omap_obj->block,
1115 omap_obj->pages, npages,
1116 omap_obj->roll, true);
1118 dev_err(dev->dev, "could not repin: %d\n", ret);
1125 mutex_unlock(&priv->list_lock);
1130 /* -----------------------------------------------------------------------------
1134 #ifdef CONFIG_DEBUG_FS
1135 void omap_gem_describe(struct drm_gem_object *obj, struct seq_file *m)
1137 struct omap_gem_object *omap_obj = to_omap_bo(obj);
1140 off = drm_vma_node_start(&obj->vma_node);
1142 mutex_lock(&omap_obj->lock);
1144 seq_printf(m, "%08x: %2d (%2d) %08llx %pad (%2d) %p %4d",
1145 omap_obj->flags, obj->name, kref_read(&obj->refcount),
1146 off, &omap_obj->dma_addr,
1147 refcount_read(&omap_obj->pin_cnt),
1148 omap_obj->vaddr, omap_obj->roll);
1150 if (omap_obj->flags & OMAP_BO_TILED_MASK) {
1151 seq_printf(m, " %dx%d", omap_obj->width, omap_obj->height);
1152 if (omap_obj->block) {
1153 struct tcm_area *area = &omap_obj->block->area;
1154 seq_printf(m, " (%dx%d, %dx%d)",
1155 area->p0.x, area->p0.y,
1156 area->p1.x, area->p1.y);
1159 seq_printf(m, " %zu", obj->size);
1162 mutex_unlock(&omap_obj->lock);
1164 seq_printf(m, "\n");
1167 void omap_gem_describe_objects(struct list_head *list, struct seq_file *m)
1169 struct omap_gem_object *omap_obj;
1173 list_for_each_entry(omap_obj, list, mm_list) {
1174 struct drm_gem_object *obj = &omap_obj->base;
1176 omap_gem_describe(obj, m);
1181 seq_printf(m, "Total %d objects, %zu bytes\n", count, size);
1185 /* -----------------------------------------------------------------------------
1186 * Constructor & Destructor
1189 static void omap_gem_free_object(struct drm_gem_object *obj)
1191 struct drm_device *dev = obj->dev;
1192 struct omap_drm_private *priv = dev->dev_private;
1193 struct omap_gem_object *omap_obj = to_omap_bo(obj);
1195 omap_gem_evict(obj);
1197 mutex_lock(&priv->list_lock);
1198 list_del(&omap_obj->mm_list);
1199 mutex_unlock(&priv->list_lock);
1202 * We own the sole reference to the object at this point, but to keep
1203 * lockdep happy, we must still take the omap_obj_lock to call
1204 * omap_gem_detach_pages(). This should hardly make any difference as
1205 * there can't be any lock contention.
1207 mutex_lock(&omap_obj->lock);
1209 /* The object should not be pinned. */
1210 WARN_ON(refcount_read(&omap_obj->pin_cnt) > 0);
1212 if (omap_obj->pages) {
1213 if (omap_obj->flags & OMAP_BO_MEM_DMABUF)
1214 kfree(omap_obj->pages);
1216 omap_gem_detach_pages(obj);
1219 if (omap_obj->flags & OMAP_BO_MEM_DMA_API) {
1220 dma_free_wc(dev->dev, obj->size, omap_obj->vaddr,
1221 omap_obj->dma_addr);
1222 } else if (omap_obj->vaddr) {
1223 vunmap(omap_obj->vaddr);
1224 } else if (obj->import_attach) {
1225 drm_prime_gem_destroy(obj, omap_obj->sgt);
1228 mutex_unlock(&omap_obj->lock);
1230 drm_gem_object_release(obj);
1232 mutex_destroy(&omap_obj->lock);
1237 static bool omap_gem_validate_flags(struct drm_device *dev, u32 flags)
1239 struct omap_drm_private *priv = dev->dev_private;
1241 switch (flags & OMAP_BO_CACHE_MASK) {
1242 case OMAP_BO_CACHED:
1244 case OMAP_BO_CACHE_MASK:
1251 if (flags & OMAP_BO_TILED_MASK) {
1252 if (!priv->usergart)
1255 switch (flags & OMAP_BO_TILED_MASK) {
1256 case OMAP_BO_TILED_8:
1257 case OMAP_BO_TILED_16:
1258 case OMAP_BO_TILED_32:
1269 static const struct vm_operations_struct omap_gem_vm_ops = {
1270 .fault = omap_gem_fault,
1271 .open = drm_gem_vm_open,
1272 .close = drm_gem_vm_close,
1275 static const struct drm_gem_object_funcs omap_gem_object_funcs = {
1276 .free = omap_gem_free_object,
1277 .export = omap_gem_prime_export,
1278 .mmap = omap_gem_object_mmap,
1279 .vm_ops = &omap_gem_vm_ops,
1282 /* GEM buffer object constructor */
1283 struct drm_gem_object *omap_gem_new(struct drm_device *dev,
1284 union omap_gem_size gsize, u32 flags)
1286 struct omap_drm_private *priv = dev->dev_private;
1287 struct omap_gem_object *omap_obj;
1288 struct drm_gem_object *obj;
1289 struct address_space *mapping;
1293 if (!omap_gem_validate_flags(dev, flags))
1296 /* Validate the flags and compute the memory and cache flags. */
1297 if (flags & OMAP_BO_TILED_MASK) {
1299 * Tiled buffers are always shmem paged backed. When they are
1300 * scanned out, they are remapped into DMM/TILER.
1302 flags |= OMAP_BO_MEM_SHMEM;
1305 * Currently don't allow cached buffers. There is some caching
1306 * stuff that needs to be handled better.
1308 flags &= ~(OMAP_BO_CACHED|OMAP_BO_WC|OMAP_BO_UNCACHED);
1309 flags |= tiler_get_cpu_cache_flags();
1310 } else if ((flags & OMAP_BO_SCANOUT) && !priv->has_dmm) {
1312 * If we don't have DMM, we must allocate scanout buffers
1313 * from contiguous DMA memory.
1315 flags |= OMAP_BO_MEM_DMA_API;
1316 } else if (!(flags & OMAP_BO_MEM_DMABUF)) {
1318 * All other buffers not backed by dma_buf are shmem-backed.
1320 flags |= OMAP_BO_MEM_SHMEM;
1323 /* Allocate the initialize the OMAP GEM object. */
1324 omap_obj = kzalloc(sizeof(*omap_obj), GFP_KERNEL);
1328 obj = &omap_obj->base;
1329 omap_obj->flags = flags;
1330 mutex_init(&omap_obj->lock);
1332 if (flags & OMAP_BO_TILED_MASK) {
1334 * For tiled buffers align dimensions to slot boundaries and
1335 * calculate size based on aligned dimensions.
1337 tiler_align(gem2fmt(flags), &gsize.tiled.width,
1338 &gsize.tiled.height);
1340 size = tiler_size(gem2fmt(flags), gsize.tiled.width,
1341 gsize.tiled.height);
1343 omap_obj->width = gsize.tiled.width;
1344 omap_obj->height = gsize.tiled.height;
1346 size = PAGE_ALIGN(gsize.bytes);
1349 obj->funcs = &omap_gem_object_funcs;
1351 /* Initialize the GEM object. */
1352 if (!(flags & OMAP_BO_MEM_SHMEM)) {
1353 drm_gem_private_object_init(dev, obj, size);
1355 ret = drm_gem_object_init(dev, obj, size);
1359 mapping = obj->filp->f_mapping;
1360 mapping_set_gfp_mask(mapping, GFP_USER | __GFP_DMA32);
1363 /* Allocate memory if needed. */
1364 if (flags & OMAP_BO_MEM_DMA_API) {
1365 omap_obj->vaddr = dma_alloc_wc(dev->dev, size,
1366 &omap_obj->dma_addr,
1368 if (!omap_obj->vaddr)
1372 mutex_lock(&priv->list_lock);
1373 list_add(&omap_obj->mm_list, &priv->obj_list);
1374 mutex_unlock(&priv->list_lock);
1379 drm_gem_object_release(obj);
1385 struct drm_gem_object *omap_gem_new_dmabuf(struct drm_device *dev, size_t size,
1386 struct sg_table *sgt)
1388 struct omap_drm_private *priv = dev->dev_private;
1389 struct omap_gem_object *omap_obj;
1390 struct drm_gem_object *obj;
1391 union omap_gem_size gsize;
1393 /* Without a DMM only physically contiguous buffers can be supported. */
1394 if (!omap_gem_sgt_is_contiguous(sgt, size) && !priv->has_dmm)
1395 return ERR_PTR(-EINVAL);
1397 gsize.bytes = PAGE_ALIGN(size);
1398 obj = omap_gem_new(dev, gsize, OMAP_BO_MEM_DMABUF | OMAP_BO_WC);
1400 return ERR_PTR(-ENOMEM);
1402 omap_obj = to_omap_bo(obj);
1404 mutex_lock(&omap_obj->lock);
1406 omap_obj->sgt = sgt;
1408 if (omap_gem_sgt_is_contiguous(sgt, size)) {
1409 omap_obj->dma_addr = sg_dma_address(sgt->sgl);
1411 /* Create pages list from sgt */
1412 struct page **pages;
1413 unsigned int npages;
1416 npages = DIV_ROUND_UP(size, PAGE_SIZE);
1417 pages = kcalloc(npages, sizeof(*pages), GFP_KERNEL);
1419 omap_gem_free_object(obj);
1420 obj = ERR_PTR(-ENOMEM);
1424 omap_obj->pages = pages;
1425 ret = drm_prime_sg_to_page_array(sgt, pages, npages);
1427 omap_gem_free_object(obj);
1428 obj = ERR_PTR(-ENOMEM);
1434 mutex_unlock(&omap_obj->lock);
1438 /* convenience method to construct a GEM buffer object, and userspace handle */
1439 int omap_gem_new_handle(struct drm_device *dev, struct drm_file *file,
1440 union omap_gem_size gsize, u32 flags, u32 *handle)
1442 struct drm_gem_object *obj;
1445 obj = omap_gem_new(dev, gsize, flags);
1449 ret = drm_gem_handle_create(file, obj, handle);
1451 omap_gem_free_object(obj);
1455 /* drop reference from allocate - handle holds it now */
1456 drm_gem_object_put(obj);
1461 /* -----------------------------------------------------------------------------
1465 /* If DMM is used, we need to set some stuff up.. */
1466 void omap_gem_init(struct drm_device *dev)
1468 struct omap_drm_private *priv = dev->dev_private;
1469 struct omap_drm_usergart *usergart;
1470 const enum tiler_fmt fmts[] = {
1471 TILFMT_8BIT, TILFMT_16BIT, TILFMT_32BIT
1475 if (!dmm_is_available()) {
1476 /* DMM only supported on OMAP4 and later, so this isn't fatal */
1477 dev_warn(dev->dev, "DMM not available, disable DMM support\n");
1481 usergart = kcalloc(3, sizeof(*usergart), GFP_KERNEL);
1485 /* reserve 4k aligned/wide regions for userspace mappings: */
1486 for (i = 0; i < ARRAY_SIZE(fmts); i++) {
1487 u16 h = 1, w = PAGE_SIZE >> i;
1489 tiler_align(fmts[i], &w, &h);
1490 /* note: since each region is 1 4kb page wide, and minimum
1491 * number of rows, the height ends up being the same as the
1492 * # of pages in the region
1494 usergart[i].height = h;
1495 usergart[i].height_shift = ilog2(h);
1496 usergart[i].stride_pfn = tiler_stride(fmts[i], 0) >> PAGE_SHIFT;
1497 usergart[i].slot_shift = ilog2((PAGE_SIZE / h) >> i);
1498 for (j = 0; j < NUM_USERGART_ENTRIES; j++) {
1499 struct omap_drm_usergart_entry *entry;
1500 struct tiler_block *block;
1502 entry = &usergart[i].entry[j];
1503 block = tiler_reserve_2d(fmts[i], w, h, PAGE_SIZE);
1504 if (IS_ERR(block)) {
1506 "reserve failed: %d, %d, %ld\n",
1507 i, j, PTR_ERR(block));
1510 entry->dma_addr = tiler_ssptr(block);
1511 entry->block = block;
1513 DBG("%d:%d: %dx%d: dma_addr=%pad stride=%d", i, j, w, h,
1515 usergart[i].stride_pfn << PAGE_SHIFT);
1519 priv->usergart = usergart;
1520 priv->has_dmm = true;
1523 void omap_gem_deinit(struct drm_device *dev)
1525 struct omap_drm_private *priv = dev->dev_private;
1527 /* I believe we can rely on there being no more outstanding GEM
1528 * objects which could depend on usergart/dmm at this point.
1530 kfree(priv->usergart);