2 * drivers/gpu/drm/omapdrm/omap_gem.c
4 * Copyright (C) 2011 Texas Instruments
7 * This program is free software; you can redistribute it and/or modify it
8 * under the terms of the GNU General Public License version 2 as published by
9 * the Free Software Foundation.
11 * This program is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 * You should have received a copy of the GNU General Public License along with
17 * this program. If not, see <http://www.gnu.org/licenses/>.
20 #include <linux/shmem_fs.h>
21 #include <linux/spinlock.h>
23 #include <drm/drm_vma_manager.h>
26 #include "omap_dmm_tiler.h"
29 * GEM buffer object implementation.
32 /* note: we use upper 8 bits of flags for driver-internal flags: */
33 #define OMAP_BO_DMA 0x01000000 /* actually is physically contiguous */
34 #define OMAP_BO_EXT_SYNC 0x02000000 /* externally allocated sync object */
35 #define OMAP_BO_EXT_MEM 0x04000000 /* externally allocated memory */
37 struct omap_gem_object {
38 struct drm_gem_object base;
40 struct list_head mm_list;
44 /** width/height for tiled formats (rounded up to slot boundaries) */
45 uint16_t width, height;
47 /** roll applied when mapping to DMM */
51 * If buffer is allocated physically contiguous, the OMAP_BO_DMA flag
52 * is set and the paddr is valid. Also if the buffer is remapped in
53 * TILER and paddr_cnt > 0, then paddr is valid. But if you are using
54 * the physical address and OMAP_BO_DMA is not set, then you should
55 * be going thru omap_gem_{get,put}_paddr() to ensure the mapping is
56 * not removed from under your feet.
58 * Note that OMAP_BO_SCANOUT is a hint from userspace that DMA capable
59 * buffer is requested, but doesn't mean that it is. Use the
60 * OMAP_BO_DMA flag to determine if the buffer has a DMA capable
71 * tiler block used when buffer is remapped in DMM/TILER.
73 struct tiler_block *block;
76 * Array of backing pages, if allocated. Note that pages are never
77 * allocated for buffers originally allocated from contiguous memory
81 /** addresses corresponding to pages in above array */
85 * Virtual address, if mapped.
90 * sync-object allocated on demand (if needed)
92 * Per-buffer sync-object for tracking pending and completed hw/dma
93 * read and write operations. The layout in memory is dictated by
94 * the SGX firmware, which uses this information to stall the command
95 * stream if a surface is not ready yet.
97 * Note that when buffer is used by SGX, the sync-object needs to be
98 * allocated from a special heap of sync-objects. This way many sync
99 * objects can be packed in a page, and not waste GPU virtual address
100 * space. Because of this we have to have a omap_gem_set_sync_object()
101 * API to allow replacement of the syncobj after it has (potentially)
102 * already been allocated. A bit ugly but I haven't thought of a
103 * better alternative.
106 uint32_t write_pending;
107 uint32_t write_complete;
108 uint32_t read_pending;
109 uint32_t read_complete;
113 #define to_omap_bo(x) container_of(x, struct omap_gem_object, base)
115 /* To deal with userspace mmap'ings of 2d tiled buffers, which (a) are
116 * not necessarily pinned in TILER all the time, and (b) when they are
117 * they are not necessarily page aligned, we reserve one or more small
118 * regions in each of the 2d containers to use as a user-GART where we
119 * can create a second page-aligned mapping of parts of the buffer
120 * being accessed from userspace.
122 * Note that we could optimize slightly when we know that multiple
123 * tiler containers are backed by the same PAT.. but I'll leave that
126 #define NUM_USERGART_ENTRIES 2
127 struct omap_drm_usergart_entry {
128 struct tiler_block *block; /* the reserved tiler block */
130 struct drm_gem_object *obj; /* the current pinned obj */
131 pgoff_t obj_pgoff; /* page offset of obj currently
135 struct omap_drm_usergart {
136 struct omap_drm_usergart_entry entry[NUM_USERGART_ENTRIES];
137 int height; /* height in rows */
138 int height_shift; /* ilog2(height in rows) */
139 int slot_shift; /* ilog2(width per slot) */
140 int stride_pfn; /* stride in pages */
141 int last; /* index of last used entry */
144 /* -----------------------------------------------------------------------------
148 /** get mmap offset */
149 static uint64_t mmap_offset(struct drm_gem_object *obj)
151 struct drm_device *dev = obj->dev;
155 WARN_ON(!mutex_is_locked(&dev->struct_mutex));
157 /* Make it mmapable */
158 size = omap_gem_mmap_size(obj);
159 ret = drm_gem_create_mmap_offset_size(obj, size);
161 dev_err(dev->dev, "could not allocate mmap offset\n");
165 return drm_vma_node_offset_addr(&obj->vma_node);
168 /* GEM objects can either be allocated from contiguous memory (in which
169 * case obj->filp==NULL), or w/ shmem backing (obj->filp!=NULL). But non
170 * contiguous buffers can be remapped in TILER/DMM if they need to be
171 * contiguous... but we don't do this all the time to reduce pressure
172 * on TILER/DMM space when we know at allocation time that the buffer
173 * will need to be scanned out.
175 static inline bool is_shmem(struct drm_gem_object *obj)
177 return obj->filp != NULL;
180 /* -----------------------------------------------------------------------------
184 static void evict_entry(struct drm_gem_object *obj,
185 enum tiler_fmt fmt, struct omap_drm_usergart_entry *entry)
187 struct omap_gem_object *omap_obj = to_omap_bo(obj);
188 struct omap_drm_private *priv = obj->dev->dev_private;
189 int n = priv->usergart[fmt].height;
190 size_t size = PAGE_SIZE * n;
191 loff_t off = mmap_offset(obj) +
192 (entry->obj_pgoff << PAGE_SHIFT);
193 const int m = 1 + ((omap_obj->width << fmt) / PAGE_SIZE);
197 /* if stride > than PAGE_SIZE then sparse mapping: */
198 for (i = n; i > 0; i--) {
199 unmap_mapping_range(obj->dev->anon_inode->i_mapping,
201 off += PAGE_SIZE * m;
204 unmap_mapping_range(obj->dev->anon_inode->i_mapping,
211 /* Evict a buffer from usergart, if it is mapped there */
212 static void evict(struct drm_gem_object *obj)
214 struct omap_gem_object *omap_obj = to_omap_bo(obj);
215 struct omap_drm_private *priv = obj->dev->dev_private;
217 if (omap_obj->flags & OMAP_BO_TILED) {
218 enum tiler_fmt fmt = gem2fmt(omap_obj->flags);
221 for (i = 0; i < NUM_USERGART_ENTRIES; i++) {
222 struct omap_drm_usergart_entry *entry =
223 &priv->usergart[fmt].entry[i];
225 if (entry->obj == obj)
226 evict_entry(obj, fmt, entry);
231 /* -----------------------------------------------------------------------------
235 /** ensure backing pages are allocated */
236 static int omap_gem_attach_pages(struct drm_gem_object *obj)
238 struct drm_device *dev = obj->dev;
239 struct omap_gem_object *omap_obj = to_omap_bo(obj);
241 int npages = obj->size >> PAGE_SHIFT;
245 WARN_ON(omap_obj->pages);
247 pages = drm_gem_get_pages(obj);
249 dev_err(obj->dev->dev, "could not get pages: %ld\n", PTR_ERR(pages));
250 return PTR_ERR(pages);
253 /* for non-cached buffers, ensure the new pages are clean because
254 * DSS, GPU, etc. are not cache coherent:
256 if (omap_obj->flags & (OMAP_BO_WC|OMAP_BO_UNCACHED)) {
257 addrs = kmalloc(npages * sizeof(*addrs), GFP_KERNEL);
263 for (i = 0; i < npages; i++) {
264 addrs[i] = dma_map_page(dev->dev, pages[i],
265 0, PAGE_SIZE, DMA_BIDIRECTIONAL);
268 addrs = kzalloc(npages * sizeof(*addrs), GFP_KERNEL);
275 omap_obj->addrs = addrs;
276 omap_obj->pages = pages;
281 drm_gem_put_pages(obj, pages, true, false);
286 /* acquire pages when needed (for example, for DMA where physically
287 * contiguous buffer is not required
289 static int get_pages(struct drm_gem_object *obj, struct page ***pages)
291 struct omap_gem_object *omap_obj = to_omap_bo(obj);
294 if (is_shmem(obj) && !omap_obj->pages) {
295 ret = omap_gem_attach_pages(obj);
297 dev_err(obj->dev->dev, "could not attach pages\n");
302 /* TODO: even phys-contig.. we should have a list of pages? */
303 *pages = omap_obj->pages;
308 /** release backing pages */
309 static void omap_gem_detach_pages(struct drm_gem_object *obj)
311 struct omap_gem_object *omap_obj = to_omap_bo(obj);
313 /* for non-cached buffers, ensure the new pages are clean because
314 * DSS, GPU, etc. are not cache coherent:
316 if (omap_obj->flags & (OMAP_BO_WC|OMAP_BO_UNCACHED)) {
317 int i, npages = obj->size >> PAGE_SHIFT;
318 for (i = 0; i < npages; i++) {
319 dma_unmap_page(obj->dev->dev, omap_obj->addrs[i],
320 PAGE_SIZE, DMA_BIDIRECTIONAL);
324 kfree(omap_obj->addrs);
325 omap_obj->addrs = NULL;
327 drm_gem_put_pages(obj, omap_obj->pages, true, false);
328 omap_obj->pages = NULL;
331 /* get buffer flags */
332 uint32_t omap_gem_flags(struct drm_gem_object *obj)
334 return to_omap_bo(obj)->flags;
337 uint64_t omap_gem_mmap_offset(struct drm_gem_object *obj)
340 mutex_lock(&obj->dev->struct_mutex);
341 offset = mmap_offset(obj);
342 mutex_unlock(&obj->dev->struct_mutex);
347 size_t omap_gem_mmap_size(struct drm_gem_object *obj)
349 struct omap_gem_object *omap_obj = to_omap_bo(obj);
350 size_t size = obj->size;
352 if (omap_obj->flags & OMAP_BO_TILED) {
353 /* for tiled buffers, the virtual size has stride rounded up
354 * to 4kb.. (to hide the fact that row n+1 might start 16kb or
355 * 32kb later!). But we don't back the entire buffer with
356 * pages, only the valid picture part.. so need to adjust for
357 * this in the size used to mmap and generate mmap offset
359 size = tiler_vsize(gem2fmt(omap_obj->flags),
360 omap_obj->width, omap_obj->height);
366 /* get tiled size, returns -EINVAL if not tiled buffer */
367 int omap_gem_tiled_size(struct drm_gem_object *obj, uint16_t *w, uint16_t *h)
369 struct omap_gem_object *omap_obj = to_omap_bo(obj);
370 if (omap_obj->flags & OMAP_BO_TILED) {
371 *w = omap_obj->width;
372 *h = omap_obj->height;
378 /* -----------------------------------------------------------------------------
382 /* Normal handling for the case of faulting in non-tiled buffers */
383 static int fault_1d(struct drm_gem_object *obj,
384 struct vm_area_struct *vma, struct vm_fault *vmf)
386 struct omap_gem_object *omap_obj = to_omap_bo(obj);
390 /* We don't use vmf->pgoff since that has the fake offset: */
391 pgoff = ((unsigned long)vmf->virtual_address -
392 vma->vm_start) >> PAGE_SHIFT;
394 if (omap_obj->pages) {
395 omap_gem_cpu_sync(obj, pgoff);
396 pfn = page_to_pfn(omap_obj->pages[pgoff]);
398 BUG_ON(!(omap_obj->flags & OMAP_BO_DMA));
399 pfn = (omap_obj->paddr >> PAGE_SHIFT) + pgoff;
402 VERB("Inserting %p pfn %lx, pa %lx", vmf->virtual_address,
403 pfn, pfn << PAGE_SHIFT);
405 return vm_insert_mixed(vma, (unsigned long)vmf->virtual_address, pfn);
408 /* Special handling for the case of faulting in 2d tiled buffers */
409 static int fault_2d(struct drm_gem_object *obj,
410 struct vm_area_struct *vma, struct vm_fault *vmf)
412 struct omap_gem_object *omap_obj = to_omap_bo(obj);
413 struct omap_drm_private *priv = obj->dev->dev_private;
414 struct omap_drm_usergart_entry *entry;
415 enum tiler_fmt fmt = gem2fmt(omap_obj->flags);
416 struct page *pages[64]; /* XXX is this too much to have on stack? */
418 pgoff_t pgoff, base_pgoff;
423 * Note the height of the slot is also equal to the number of pages
424 * that need to be mapped in to fill 4kb wide CPU page. If the slot
425 * height is 64, then 64 pages fill a 4kb wide by 64 row region.
427 const int n = priv->usergart[fmt].height;
428 const int n_shift = priv->usergart[fmt].height_shift;
431 * If buffer width in bytes > PAGE_SIZE then the virtual stride is
432 * rounded up to next multiple of PAGE_SIZE.. this need to be taken
433 * into account in some of the math, so figure out virtual stride
436 const int m = 1 + ((omap_obj->width << fmt) / PAGE_SIZE);
438 /* We don't use vmf->pgoff since that has the fake offset: */
439 pgoff = ((unsigned long)vmf->virtual_address -
440 vma->vm_start) >> PAGE_SHIFT;
443 * Actual address we start mapping at is rounded down to previous slot
444 * boundary in the y direction:
446 base_pgoff = round_down(pgoff, m << n_shift);
448 /* figure out buffer width in slots */
449 slots = omap_obj->width >> priv->usergart[fmt].slot_shift;
451 vaddr = vmf->virtual_address - ((pgoff - base_pgoff) << PAGE_SHIFT);
453 entry = &priv->usergart[fmt].entry[priv->usergart[fmt].last];
455 /* evict previous buffer using this usergart entry, if any: */
457 evict_entry(entry->obj, fmt, entry);
460 entry->obj_pgoff = base_pgoff;
462 /* now convert base_pgoff to phys offset from virt offset: */
463 base_pgoff = (base_pgoff >> n_shift) * slots;
465 /* for wider-than 4k.. figure out which part of the slot-row we want: */
468 entry->obj_pgoff += off;
470 slots = min(slots - (off << n_shift), n);
471 base_pgoff += off << n_shift;
472 vaddr += off << PAGE_SHIFT;
476 * Map in pages. Beyond the valid pixel part of the buffer, we set
477 * pages[i] to NULL to get a dummy page mapped in.. if someone
478 * reads/writes it they will get random/undefined content, but at
479 * least it won't be corrupting whatever other random page used to
480 * be mapped in, or other undefined behavior.
482 memcpy(pages, &omap_obj->pages[base_pgoff],
483 sizeof(struct page *) * slots);
484 memset(pages + slots, 0,
485 sizeof(struct page *) * (n - slots));
487 ret = tiler_pin(entry->block, pages, ARRAY_SIZE(pages), 0, true);
489 dev_err(obj->dev->dev, "failed to pin: %d\n", ret);
493 pfn = entry->paddr >> PAGE_SHIFT;
495 VERB("Inserting %p pfn %lx, pa %lx", vmf->virtual_address,
496 pfn, pfn << PAGE_SHIFT);
498 for (i = n; i > 0; i--) {
499 vm_insert_mixed(vma, (unsigned long)vaddr, pfn);
500 pfn += priv->usergart[fmt].stride_pfn;
501 vaddr += PAGE_SIZE * m;
504 /* simple round-robin: */
505 priv->usergart[fmt].last = (priv->usergart[fmt].last + 1)
506 % NUM_USERGART_ENTRIES;
512 * omap_gem_fault - pagefault handler for GEM objects
513 * @vma: the VMA of the GEM object
516 * Invoked when a fault occurs on an mmap of a GEM managed area. GEM
517 * does most of the work for us including the actual map/unmap calls
518 * but we need to do the actual page work.
520 * The VMA was set up by GEM. In doing so it also ensured that the
521 * vma->vm_private_data points to the GEM object that is backing this
524 int omap_gem_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
526 struct drm_gem_object *obj = vma->vm_private_data;
527 struct omap_gem_object *omap_obj = to_omap_bo(obj);
528 struct drm_device *dev = obj->dev;
532 /* Make sure we don't parallel update on a fault, nor move or remove
533 * something from beneath our feet
535 mutex_lock(&dev->struct_mutex);
537 /* if a shmem backed object, make sure we have pages attached now */
538 ret = get_pages(obj, &pages);
542 /* where should we do corresponding put_pages().. we are mapping
543 * the original page, rather than thru a GART, so we can't rely
544 * on eviction to trigger this. But munmap() or all mappings should
545 * probably trigger put_pages()?
548 if (omap_obj->flags & OMAP_BO_TILED)
549 ret = fault_2d(obj, vma, vmf);
551 ret = fault_1d(obj, vma, vmf);
555 mutex_unlock(&dev->struct_mutex);
560 return VM_FAULT_NOPAGE;
564 return VM_FAULT_SIGBUS;
568 /** We override mainly to fix up some of the vm mapping flags.. */
569 int omap_gem_mmap(struct file *filp, struct vm_area_struct *vma)
573 ret = drm_gem_mmap(filp, vma);
575 DBG("mmap failed: %d", ret);
579 return omap_gem_mmap_obj(vma->vm_private_data, vma);
582 int omap_gem_mmap_obj(struct drm_gem_object *obj,
583 struct vm_area_struct *vma)
585 struct omap_gem_object *omap_obj = to_omap_bo(obj);
587 vma->vm_flags &= ~VM_PFNMAP;
588 vma->vm_flags |= VM_MIXEDMAP;
590 if (omap_obj->flags & OMAP_BO_WC) {
591 vma->vm_page_prot = pgprot_writecombine(vm_get_page_prot(vma->vm_flags));
592 } else if (omap_obj->flags & OMAP_BO_UNCACHED) {
593 vma->vm_page_prot = pgprot_noncached(vm_get_page_prot(vma->vm_flags));
596 * We do have some private objects, at least for scanout buffers
597 * on hardware without DMM/TILER. But these are allocated write-
600 if (WARN_ON(!obj->filp))
604 * Shunt off cached objs to shmem file so they have their own
605 * address_space (so unmap_mapping_range does what we want,
606 * in particular in the case of mmap'd dmabufs)
610 vma->vm_file = get_file(obj->filp);
612 vma->vm_page_prot = vm_get_page_prot(vma->vm_flags);
618 /* -----------------------------------------------------------------------------
623 * omap_gem_dumb_create - create a dumb buffer
624 * @drm_file: our client file
626 * @args: the requested arguments copied from userspace
628 * Allocate a buffer suitable for use for a frame buffer of the
629 * form described by user space. Give userspace a handle by which
632 int omap_gem_dumb_create(struct drm_file *file, struct drm_device *dev,
633 struct drm_mode_create_dumb *args)
635 union omap_gem_size gsize;
637 args->pitch = align_pitch(0, args->width, args->bpp);
638 args->size = PAGE_ALIGN(args->pitch * args->height);
640 gsize = (union omap_gem_size){
644 return omap_gem_new_handle(dev, file, gsize,
645 OMAP_BO_SCANOUT | OMAP_BO_WC, &args->handle);
649 * omap_gem_dumb_map - buffer mapping for dumb interface
650 * @file: our drm client file
652 * @handle: GEM handle to the object (from dumb_create)
654 * Do the necessary setup to allow the mapping of the frame buffer
655 * into user memory. We don't have to do much here at the moment.
657 int omap_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev,
658 uint32_t handle, uint64_t *offset)
660 struct drm_gem_object *obj;
663 /* GEM does all our handle to object mapping */
664 obj = drm_gem_object_lookup(dev, file, handle);
670 *offset = omap_gem_mmap_offset(obj);
672 drm_gem_object_unreference_unlocked(obj);
678 #ifdef CONFIG_DRM_FBDEV_EMULATION
679 /* Set scrolling position. This allows us to implement fast scrolling
682 * Call only from non-atomic contexts.
684 int omap_gem_roll(struct drm_gem_object *obj, uint32_t roll)
686 struct omap_gem_object *omap_obj = to_omap_bo(obj);
687 uint32_t npages = obj->size >> PAGE_SHIFT;
691 dev_err(obj->dev->dev, "invalid roll: %d\n", roll);
695 omap_obj->roll = roll;
697 mutex_lock(&obj->dev->struct_mutex);
699 /* if we aren't mapped yet, we don't need to do anything */
700 if (omap_obj->block) {
702 ret = get_pages(obj, &pages);
705 ret = tiler_pin(omap_obj->block, pages, npages, roll, true);
707 dev_err(obj->dev->dev, "could not repin: %d\n", ret);
711 mutex_unlock(&obj->dev->struct_mutex);
717 /* -----------------------------------------------------------------------------
718 * Memory Management & DMA Sync
722 * shmem buffers that are mapped cached can simulate coherency via using
723 * page faulting to keep track of dirty pages
725 static inline bool is_cached_coherent(struct drm_gem_object *obj)
727 struct omap_gem_object *omap_obj = to_omap_bo(obj);
728 return is_shmem(obj) &&
729 ((omap_obj->flags & OMAP_BO_CACHE_MASK) == OMAP_BO_CACHED);
732 /* Sync the buffer for CPU access.. note pages should already be
733 * attached, ie. omap_gem_get_pages()
735 void omap_gem_cpu_sync(struct drm_gem_object *obj, int pgoff)
737 struct drm_device *dev = obj->dev;
738 struct omap_gem_object *omap_obj = to_omap_bo(obj);
740 if (is_cached_coherent(obj) && omap_obj->addrs[pgoff]) {
741 dma_unmap_page(dev->dev, omap_obj->addrs[pgoff],
742 PAGE_SIZE, DMA_BIDIRECTIONAL);
743 omap_obj->addrs[pgoff] = 0;
747 /* sync the buffer for DMA access */
748 void omap_gem_dma_sync(struct drm_gem_object *obj,
749 enum dma_data_direction dir)
751 struct drm_device *dev = obj->dev;
752 struct omap_gem_object *omap_obj = to_omap_bo(obj);
754 if (is_cached_coherent(obj)) {
755 int i, npages = obj->size >> PAGE_SHIFT;
756 struct page **pages = omap_obj->pages;
759 for (i = 0; i < npages; i++) {
760 if (!omap_obj->addrs[i]) {
761 omap_obj->addrs[i] = dma_map_page(dev->dev, pages[i], 0,
762 PAGE_SIZE, DMA_BIDIRECTIONAL);
768 unmap_mapping_range(obj->filp->f_mapping, 0,
769 omap_gem_mmap_size(obj), 1);
774 /* Get physical address for DMA.. if 'remap' is true, and the buffer is not
775 * already contiguous, remap it to pin in physically contiguous memory.. (ie.
778 int omap_gem_get_paddr(struct drm_gem_object *obj,
779 dma_addr_t *paddr, bool remap)
781 struct omap_drm_private *priv = obj->dev->dev_private;
782 struct omap_gem_object *omap_obj = to_omap_bo(obj);
785 mutex_lock(&obj->dev->struct_mutex);
787 if (remap && is_shmem(obj) && priv->has_dmm) {
788 if (omap_obj->paddr_cnt == 0) {
790 uint32_t npages = obj->size >> PAGE_SHIFT;
791 enum tiler_fmt fmt = gem2fmt(omap_obj->flags);
792 struct tiler_block *block;
794 BUG_ON(omap_obj->block);
796 ret = get_pages(obj, &pages);
800 if (omap_obj->flags & OMAP_BO_TILED) {
801 block = tiler_reserve_2d(fmt,
803 omap_obj->height, 0);
805 block = tiler_reserve_1d(obj->size);
809 ret = PTR_ERR(block);
810 dev_err(obj->dev->dev,
811 "could not remap: %d (%d)\n", ret, fmt);
815 /* TODO: enable async refill.. */
816 ret = tiler_pin(block, pages, npages,
817 omap_obj->roll, true);
819 tiler_release(block);
820 dev_err(obj->dev->dev,
821 "could not pin: %d\n", ret);
825 omap_obj->paddr = tiler_ssptr(block);
826 omap_obj->block = block;
828 DBG("got paddr: %pad", &omap_obj->paddr);
831 omap_obj->paddr_cnt++;
833 *paddr = omap_obj->paddr;
834 } else if (omap_obj->flags & OMAP_BO_DMA) {
835 *paddr = omap_obj->paddr;
842 mutex_unlock(&obj->dev->struct_mutex);
847 /* Release physical address, when DMA is no longer being performed.. this
848 * could potentially unpin and unmap buffers from TILER
850 void omap_gem_put_paddr(struct drm_gem_object *obj)
852 struct omap_gem_object *omap_obj = to_omap_bo(obj);
855 mutex_lock(&obj->dev->struct_mutex);
856 if (omap_obj->paddr_cnt > 0) {
857 omap_obj->paddr_cnt--;
858 if (omap_obj->paddr_cnt == 0) {
859 ret = tiler_unpin(omap_obj->block);
861 dev_err(obj->dev->dev,
862 "could not unpin pages: %d\n", ret);
864 ret = tiler_release(omap_obj->block);
866 dev_err(obj->dev->dev,
867 "could not release unmap: %d\n", ret);
870 omap_obj->block = NULL;
874 mutex_unlock(&obj->dev->struct_mutex);
877 /* Get rotated scanout address (only valid if already pinned), at the
878 * specified orientation and x,y offset from top-left corner of buffer
879 * (only valid for tiled 2d buffers)
881 int omap_gem_rotated_paddr(struct drm_gem_object *obj, uint32_t orient,
882 int x, int y, dma_addr_t *paddr)
884 struct omap_gem_object *omap_obj = to_omap_bo(obj);
887 mutex_lock(&obj->dev->struct_mutex);
888 if ((omap_obj->paddr_cnt > 0) && omap_obj->block &&
889 (omap_obj->flags & OMAP_BO_TILED)) {
890 *paddr = tiler_tsptr(omap_obj->block, orient, x, y);
893 mutex_unlock(&obj->dev->struct_mutex);
897 /* Get tiler stride for the buffer (only valid for 2d tiled buffers) */
898 int omap_gem_tiled_stride(struct drm_gem_object *obj, uint32_t orient)
900 struct omap_gem_object *omap_obj = to_omap_bo(obj);
902 if (omap_obj->flags & OMAP_BO_TILED)
903 ret = tiler_stride(gem2fmt(omap_obj->flags), orient);
907 /* if !remap, and we don't have pages backing, then fail, rather than
908 * increasing the pin count (which we don't really do yet anyways,
909 * because we don't support swapping pages back out). And 'remap'
910 * might not be quite the right name, but I wanted to keep it working
911 * similarly to omap_gem_get_paddr(). Note though that mutex is not
912 * aquired if !remap (because this can be called in atomic ctxt),
913 * but probably omap_gem_get_paddr() should be changed to work in the
914 * same way. If !remap, a matching omap_gem_put_pages() call is not
915 * required (and should not be made).
917 int omap_gem_get_pages(struct drm_gem_object *obj, struct page ***pages,
922 struct omap_gem_object *omap_obj = to_omap_bo(obj);
923 if (!omap_obj->pages)
925 *pages = omap_obj->pages;
928 mutex_lock(&obj->dev->struct_mutex);
929 ret = get_pages(obj, pages);
930 mutex_unlock(&obj->dev->struct_mutex);
934 /* release pages when DMA no longer being performed */
935 int omap_gem_put_pages(struct drm_gem_object *obj)
937 /* do something here if we dynamically attach/detach pages.. at
938 * least they would no longer need to be pinned if everyone has
939 * released the pages..
944 #ifdef CONFIG_DRM_FBDEV_EMULATION
945 /* Get kernel virtual address for CPU access.. this more or less only
946 * exists for omap_fbdev. This should be called with struct_mutex
949 void *omap_gem_vaddr(struct drm_gem_object *obj)
951 struct omap_gem_object *omap_obj = to_omap_bo(obj);
952 WARN_ON(!mutex_is_locked(&obj->dev->struct_mutex));
953 if (!omap_obj->vaddr) {
955 int ret = get_pages(obj, &pages);
958 omap_obj->vaddr = vmap(pages, obj->size >> PAGE_SHIFT,
959 VM_MAP, pgprot_writecombine(PAGE_KERNEL));
961 return omap_obj->vaddr;
965 /* -----------------------------------------------------------------------------
970 /* re-pin objects in DMM in resume path: */
971 int omap_gem_resume(struct device *dev)
973 struct drm_device *drm_dev = dev_get_drvdata(dev);
974 struct omap_drm_private *priv = drm_dev->dev_private;
975 struct omap_gem_object *omap_obj;
978 list_for_each_entry(omap_obj, &priv->obj_list, mm_list) {
979 if (omap_obj->block) {
980 struct drm_gem_object *obj = &omap_obj->base;
981 uint32_t npages = obj->size >> PAGE_SHIFT;
982 WARN_ON(!omap_obj->pages); /* this can't happen */
983 ret = tiler_pin(omap_obj->block,
984 omap_obj->pages, npages,
985 omap_obj->roll, true);
987 dev_err(dev, "could not repin: %d\n", ret);
997 /* -----------------------------------------------------------------------------
1001 #ifdef CONFIG_DEBUG_FS
1002 void omap_gem_describe(struct drm_gem_object *obj, struct seq_file *m)
1004 struct omap_gem_object *omap_obj = to_omap_bo(obj);
1007 off = drm_vma_node_start(&obj->vma_node);
1009 seq_printf(m, "%08x: %2d (%2d) %08llx %pad (%2d) %p %4d",
1010 omap_obj->flags, obj->name, obj->refcount.refcount.counter,
1011 off, &omap_obj->paddr, omap_obj->paddr_cnt,
1012 omap_obj->vaddr, omap_obj->roll);
1014 if (omap_obj->flags & OMAP_BO_TILED) {
1015 seq_printf(m, " %dx%d", omap_obj->width, omap_obj->height);
1016 if (omap_obj->block) {
1017 struct tcm_area *area = &omap_obj->block->area;
1018 seq_printf(m, " (%dx%d, %dx%d)",
1019 area->p0.x, area->p0.y,
1020 area->p1.x, area->p1.y);
1023 seq_printf(m, " %d", obj->size);
1026 seq_printf(m, "\n");
1029 void omap_gem_describe_objects(struct list_head *list, struct seq_file *m)
1031 struct omap_gem_object *omap_obj;
1035 list_for_each_entry(omap_obj, list, mm_list) {
1036 struct drm_gem_object *obj = &omap_obj->base;
1038 omap_gem_describe(obj, m);
1043 seq_printf(m, "Total %d objects, %zu bytes\n", count, size);
1047 /* -----------------------------------------------------------------------------
1048 * Buffer Synchronization
1051 static DEFINE_SPINLOCK(sync_lock);
1053 struct omap_gem_sync_waiter {
1054 struct list_head list;
1055 struct omap_gem_object *omap_obj;
1056 enum omap_gem_op op;
1057 uint32_t read_target, write_target;
1058 /* notify called w/ sync_lock held */
1059 void (*notify)(void *arg);
1063 /* list of omap_gem_sync_waiter.. the notify fxn gets called back when
1064 * the read and/or write target count is achieved which can call a user
1065 * callback (ex. to kick 3d and/or 2d), wakeup blocked task (prep for
1068 static LIST_HEAD(waiters);
1070 static inline bool is_waiting(struct omap_gem_sync_waiter *waiter)
1072 struct omap_gem_object *omap_obj = waiter->omap_obj;
1073 if ((waiter->op & OMAP_GEM_READ) &&
1074 (omap_obj->sync->write_complete < waiter->write_target))
1076 if ((waiter->op & OMAP_GEM_WRITE) &&
1077 (omap_obj->sync->read_complete < waiter->read_target))
1082 /* macro for sync debug.. */
1084 #define SYNC(fmt, ...) do { if (SYNCDBG) \
1085 printk(KERN_ERR "%s:%d: "fmt"\n", \
1086 __func__, __LINE__, ##__VA_ARGS__); \
1090 static void sync_op_update(void)
1092 struct omap_gem_sync_waiter *waiter, *n;
1093 list_for_each_entry_safe(waiter, n, &waiters, list) {
1094 if (!is_waiting(waiter)) {
1095 list_del(&waiter->list);
1096 SYNC("notify: %p", waiter);
1097 waiter->notify(waiter->arg);
1103 static inline int sync_op(struct drm_gem_object *obj,
1104 enum omap_gem_op op, bool start)
1106 struct omap_gem_object *omap_obj = to_omap_bo(obj);
1109 spin_lock(&sync_lock);
1111 if (!omap_obj->sync) {
1112 omap_obj->sync = kzalloc(sizeof(*omap_obj->sync), GFP_ATOMIC);
1113 if (!omap_obj->sync) {
1120 if (op & OMAP_GEM_READ)
1121 omap_obj->sync->read_pending++;
1122 if (op & OMAP_GEM_WRITE)
1123 omap_obj->sync->write_pending++;
1125 if (op & OMAP_GEM_READ)
1126 omap_obj->sync->read_complete++;
1127 if (op & OMAP_GEM_WRITE)
1128 omap_obj->sync->write_complete++;
1133 spin_unlock(&sync_lock);
1138 /* it is a bit lame to handle updates in this sort of polling way, but
1139 * in case of PVR, the GPU can directly update read/write complete
1140 * values, and not really tell us which ones it updated.. this also
1141 * means that sync_lock is not quite sufficient. So we'll need to
1142 * do something a bit better when it comes time to add support for
1145 void omap_gem_op_update(void)
1147 spin_lock(&sync_lock);
1149 spin_unlock(&sync_lock);
1152 /* mark the start of read and/or write operation */
1153 int omap_gem_op_start(struct drm_gem_object *obj, enum omap_gem_op op)
1155 return sync_op(obj, op, true);
1158 int omap_gem_op_finish(struct drm_gem_object *obj, enum omap_gem_op op)
1160 return sync_op(obj, op, false);
1163 static DECLARE_WAIT_QUEUE_HEAD(sync_event);
1165 static void sync_notify(void *arg)
1167 struct task_struct **waiter_task = arg;
1168 *waiter_task = NULL;
1169 wake_up_all(&sync_event);
1172 int omap_gem_op_sync(struct drm_gem_object *obj, enum omap_gem_op op)
1174 struct omap_gem_object *omap_obj = to_omap_bo(obj);
1176 if (omap_obj->sync) {
1177 struct task_struct *waiter_task = current;
1178 struct omap_gem_sync_waiter *waiter =
1179 kzalloc(sizeof(*waiter), GFP_KERNEL);
1184 waiter->omap_obj = omap_obj;
1186 waiter->read_target = omap_obj->sync->read_pending;
1187 waiter->write_target = omap_obj->sync->write_pending;
1188 waiter->notify = sync_notify;
1189 waiter->arg = &waiter_task;
1191 spin_lock(&sync_lock);
1192 if (is_waiting(waiter)) {
1193 SYNC("waited: %p", waiter);
1194 list_add_tail(&waiter->list, &waiters);
1195 spin_unlock(&sync_lock);
1196 ret = wait_event_interruptible(sync_event,
1197 (waiter_task == NULL));
1198 spin_lock(&sync_lock);
1200 SYNC("interrupted: %p", waiter);
1201 /* we were interrupted */
1202 list_del(&waiter->list);
1205 /* freed in sync_op_update() */
1209 spin_unlock(&sync_lock);
1215 /* call fxn(arg), either synchronously or asynchronously if the op
1216 * is currently blocked.. fxn() can be called from any context
1218 * (TODO for now fxn is called back from whichever context calls
1219 * omap_gem_op_update().. but this could be better defined later
1222 * TODO more code in common w/ _sync()..
1224 int omap_gem_op_async(struct drm_gem_object *obj, enum omap_gem_op op,
1225 void (*fxn)(void *arg), void *arg)
1227 struct omap_gem_object *omap_obj = to_omap_bo(obj);
1228 if (omap_obj->sync) {
1229 struct omap_gem_sync_waiter *waiter =
1230 kzalloc(sizeof(*waiter), GFP_ATOMIC);
1235 waiter->omap_obj = omap_obj;
1237 waiter->read_target = omap_obj->sync->read_pending;
1238 waiter->write_target = omap_obj->sync->write_pending;
1239 waiter->notify = fxn;
1242 spin_lock(&sync_lock);
1243 if (is_waiting(waiter)) {
1244 SYNC("waited: %p", waiter);
1245 list_add_tail(&waiter->list, &waiters);
1246 spin_unlock(&sync_lock);
1250 spin_unlock(&sync_lock);
1261 /* special API so PVR can update the buffer to use a sync-object allocated
1262 * from it's sync-obj heap. Only used for a newly allocated (from PVR's
1263 * perspective) sync-object, so we overwrite the new syncobj w/ values
1264 * from the already allocated syncobj (if there is one)
1266 int omap_gem_set_sync_object(struct drm_gem_object *obj, void *syncobj)
1268 struct omap_gem_object *omap_obj = to_omap_bo(obj);
1271 spin_lock(&sync_lock);
1273 if ((omap_obj->flags & OMAP_BO_EXT_SYNC) && !syncobj) {
1274 /* clearing a previously set syncobj */
1275 syncobj = kmemdup(omap_obj->sync, sizeof(*omap_obj->sync),
1281 omap_obj->flags &= ~OMAP_BO_EXT_SYNC;
1282 omap_obj->sync = syncobj;
1283 } else if (syncobj && !(omap_obj->flags & OMAP_BO_EXT_SYNC)) {
1284 /* replacing an existing syncobj */
1285 if (omap_obj->sync) {
1286 memcpy(syncobj, omap_obj->sync, sizeof(*omap_obj->sync));
1287 kfree(omap_obj->sync);
1289 omap_obj->flags |= OMAP_BO_EXT_SYNC;
1290 omap_obj->sync = syncobj;
1294 spin_unlock(&sync_lock);
1298 /* -----------------------------------------------------------------------------
1299 * Constructor & Destructor
1302 /* don't call directly.. called from GEM core when it is time to actually
1305 void omap_gem_free_object(struct drm_gem_object *obj)
1307 struct drm_device *dev = obj->dev;
1308 struct omap_drm_private *priv = dev->dev_private;
1309 struct omap_gem_object *omap_obj = to_omap_bo(obj);
1313 WARN_ON(!mutex_is_locked(&dev->struct_mutex));
1315 spin_lock(&priv->list_lock);
1316 list_del(&omap_obj->mm_list);
1317 spin_unlock(&priv->list_lock);
1319 /* this means the object is still pinned.. which really should
1320 * not happen. I think..
1322 WARN_ON(omap_obj->paddr_cnt > 0);
1324 /* don't free externally allocated backing memory */
1325 if (!(omap_obj->flags & OMAP_BO_EXT_MEM)) {
1326 if (omap_obj->pages)
1327 omap_gem_detach_pages(obj);
1329 if (!is_shmem(obj)) {
1330 dma_free_writecombine(dev->dev, obj->size,
1331 omap_obj->vaddr, omap_obj->paddr);
1332 } else if (omap_obj->vaddr) {
1333 vunmap(omap_obj->vaddr);
1337 /* don't free externally allocated syncobj */
1338 if (!(omap_obj->flags & OMAP_BO_EXT_SYNC))
1339 kfree(omap_obj->sync);
1341 drm_gem_object_release(obj);
1346 /* GEM buffer object constructor */
1347 struct drm_gem_object *omap_gem_new(struct drm_device *dev,
1348 union omap_gem_size gsize, uint32_t flags)
1350 struct omap_drm_private *priv = dev->dev_private;
1351 struct omap_gem_object *omap_obj;
1352 struct drm_gem_object *obj;
1353 struct address_space *mapping;
1357 if (flags & OMAP_BO_TILED) {
1358 if (!priv->usergart) {
1359 dev_err(dev->dev, "Tiled buffers require DMM\n");
1363 /* tiled buffers are always shmem paged backed.. when they are
1364 * scanned out, they are remapped into DMM/TILER
1366 flags &= ~OMAP_BO_SCANOUT;
1368 /* currently don't allow cached buffers.. there is some caching
1369 * stuff that needs to be handled better
1371 flags &= ~(OMAP_BO_CACHED|OMAP_BO_WC|OMAP_BO_UNCACHED);
1372 flags |= tiler_get_cpu_cache_flags();
1374 /* align dimensions to slot boundaries... */
1375 tiler_align(gem2fmt(flags),
1376 &gsize.tiled.width, &gsize.tiled.height);
1378 /* ...and calculate size based on aligned dimensions */
1379 size = tiler_size(gem2fmt(flags),
1380 gsize.tiled.width, gsize.tiled.height);
1382 size = PAGE_ALIGN(gsize.bytes);
1385 omap_obj = kzalloc(sizeof(*omap_obj), GFP_KERNEL);
1389 obj = &omap_obj->base;
1391 if ((flags & OMAP_BO_SCANOUT) && !priv->has_dmm) {
1392 /* attempt to allocate contiguous memory if we don't
1393 * have DMM for remappign discontiguous buffers
1395 omap_obj->vaddr = dma_alloc_writecombine(dev->dev, size,
1396 &omap_obj->paddr, GFP_KERNEL);
1397 if (!omap_obj->vaddr) {
1403 flags |= OMAP_BO_DMA;
1406 spin_lock(&priv->list_lock);
1407 list_add(&omap_obj->mm_list, &priv->obj_list);
1408 spin_unlock(&priv->list_lock);
1410 omap_obj->flags = flags;
1412 if (flags & OMAP_BO_TILED) {
1413 omap_obj->width = gsize.tiled.width;
1414 omap_obj->height = gsize.tiled.height;
1417 if (flags & (OMAP_BO_DMA|OMAP_BO_EXT_MEM)) {
1418 drm_gem_private_object_init(dev, obj, size);
1420 ret = drm_gem_object_init(dev, obj, size);
1424 mapping = file_inode(obj->filp)->i_mapping;
1425 mapping_set_gfp_mask(mapping, GFP_USER | __GFP_DMA32);
1431 omap_gem_free_object(obj);
1435 /* convenience method to construct a GEM buffer object, and userspace handle */
1436 int omap_gem_new_handle(struct drm_device *dev, struct drm_file *file,
1437 union omap_gem_size gsize, uint32_t flags, uint32_t *handle)
1439 struct drm_gem_object *obj;
1442 obj = omap_gem_new(dev, gsize, flags);
1446 ret = drm_gem_handle_create(file, obj, handle);
1448 omap_gem_free_object(obj);
1452 /* drop reference from allocate - handle holds it now */
1453 drm_gem_object_unreference_unlocked(obj);
1458 /* -----------------------------------------------------------------------------
1462 /* If DMM is used, we need to set some stuff up.. */
1463 void omap_gem_init(struct drm_device *dev)
1465 struct omap_drm_private *priv = dev->dev_private;
1466 struct omap_drm_usergart *usergart;
1467 const enum tiler_fmt fmts[] = {
1468 TILFMT_8BIT, TILFMT_16BIT, TILFMT_32BIT
1472 if (!dmm_is_available()) {
1473 /* DMM only supported on OMAP4 and later, so this isn't fatal */
1474 dev_warn(dev->dev, "DMM not available, disable DMM support\n");
1478 usergart = kcalloc(3, sizeof(*usergart), GFP_KERNEL);
1482 /* reserve 4k aligned/wide regions for userspace mappings: */
1483 for (i = 0; i < ARRAY_SIZE(fmts); i++) {
1484 uint16_t h = 1, w = PAGE_SIZE >> i;
1485 tiler_align(fmts[i], &w, &h);
1486 /* note: since each region is 1 4kb page wide, and minimum
1487 * number of rows, the height ends up being the same as the
1488 * # of pages in the region
1490 usergart[i].height = h;
1491 usergart[i].height_shift = ilog2(h);
1492 usergart[i].stride_pfn = tiler_stride(fmts[i], 0) >> PAGE_SHIFT;
1493 usergart[i].slot_shift = ilog2((PAGE_SIZE / h) >> i);
1494 for (j = 0; j < NUM_USERGART_ENTRIES; j++) {
1495 struct omap_drm_usergart_entry *entry;
1496 struct tiler_block *block;
1498 entry = &usergart[i].entry[j];
1499 block = tiler_reserve_2d(fmts[i], w, h, PAGE_SIZE);
1500 if (IS_ERR(block)) {
1502 "reserve failed: %d, %d, %ld\n",
1503 i, j, PTR_ERR(block));
1506 entry->paddr = tiler_ssptr(block);
1507 entry->block = block;
1509 DBG("%d:%d: %dx%d: paddr=%pad stride=%d", i, j, w, h,
1511 usergart[i].stride_pfn << PAGE_SHIFT);
1515 priv->usergart = usergart;
1516 priv->has_dmm = true;
1519 void omap_gem_deinit(struct drm_device *dev)
1521 struct omap_drm_private *priv = dev->dev_private;
1523 /* I believe we can rely on there being no more outstanding GEM
1524 * objects which could depend on usergart/dmm at this point.
1526 kfree(priv->usergart);