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>
22 #include <linux/pfn_t.h>
24 #include <drm/drm_vma_manager.h>
27 #include "omap_dmm_tiler.h"
29 /* remove these once drm core helpers are merged */
30 struct page **_drm_gem_get_pages(struct drm_gem_object *obj, gfp_t gfpmask);
31 void _drm_gem_put_pages(struct drm_gem_object *obj, struct page **pages,
32 bool dirty, bool accessed);
33 int _drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size);
36 * GEM buffer object implementation.
39 #define to_omap_bo(x) container_of(x, struct omap_gem_object, base)
41 /* note: we use upper 8 bits of flags for driver-internal flags: */
42 #define OMAP_BO_DMA 0x01000000 /* actually is physically contiguous */
43 #define OMAP_BO_EXT_SYNC 0x02000000 /* externally allocated sync object */
44 #define OMAP_BO_EXT_MEM 0x04000000 /* externally allocated memory */
47 struct omap_gem_object {
48 struct drm_gem_object base;
50 struct list_head mm_list;
54 /** width/height for tiled formats (rounded up to slot boundaries) */
55 uint16_t width, height;
57 /** roll applied when mapping to DMM */
61 * If buffer is allocated physically contiguous, the OMAP_BO_DMA flag
62 * is set and the paddr is valid. Also if the buffer is remapped in
63 * TILER and paddr_cnt > 0, then paddr is valid. But if you are using
64 * the physical address and OMAP_BO_DMA is not set, then you should
65 * be going thru omap_gem_{get,put}_paddr() to ensure the mapping is
66 * not removed from under your feet.
68 * Note that OMAP_BO_SCANOUT is a hint from userspace that DMA capable
69 * buffer is requested, but doesn't mean that it is. Use the
70 * OMAP_BO_DMA flag to determine if the buffer has a DMA capable
81 * tiler block used when buffer is remapped in DMM/TILER.
83 struct tiler_block *block;
86 * Array of backing pages, if allocated. Note that pages are never
87 * allocated for buffers originally allocated from contiguous memory
91 /** addresses corresponding to pages in above array */
95 * Virtual address, if mapped.
100 * sync-object allocated on demand (if needed)
102 * Per-buffer sync-object for tracking pending and completed hw/dma
103 * read and write operations. The layout in memory is dictated by
104 * the SGX firmware, which uses this information to stall the command
105 * stream if a surface is not ready yet.
107 * Note that when buffer is used by SGX, the sync-object needs to be
108 * allocated from a special heap of sync-objects. This way many sync
109 * objects can be packed in a page, and not waste GPU virtual address
110 * space. Because of this we have to have a omap_gem_set_sync_object()
111 * API to allow replacement of the syncobj after it has (potentially)
112 * already been allocated. A bit ugly but I haven't thought of a
113 * better alternative.
116 uint32_t write_pending;
117 uint32_t write_complete;
118 uint32_t read_pending;
119 uint32_t read_complete;
123 static int get_pages(struct drm_gem_object *obj, struct page ***pages);
124 static uint64_t mmap_offset(struct drm_gem_object *obj);
126 /* To deal with userspace mmap'ings of 2d tiled buffers, which (a) are
127 * not necessarily pinned in TILER all the time, and (b) when they are
128 * they are not necessarily page aligned, we reserve one or more small
129 * regions in each of the 2d containers to use as a user-GART where we
130 * can create a second page-aligned mapping of parts of the buffer
131 * being accessed from userspace.
133 * Note that we could optimize slightly when we know that multiple
134 * tiler containers are backed by the same PAT.. but I'll leave that
137 #define NUM_USERGART_ENTRIES 2
138 struct usergart_entry {
139 struct tiler_block *block; /* the reserved tiler block */
141 struct drm_gem_object *obj; /* the current pinned obj */
142 pgoff_t obj_pgoff; /* page offset of obj currently
146 struct usergart_entry entry[NUM_USERGART_ENTRIES];
147 int height; /* height in rows */
148 int height_shift; /* ilog2(height in rows) */
149 int slot_shift; /* ilog2(width per slot) */
150 int stride_pfn; /* stride in pages */
151 int last; /* index of last used entry */
154 static void evict_entry(struct drm_gem_object *obj,
155 enum tiler_fmt fmt, struct usergart_entry *entry)
157 struct omap_gem_object *omap_obj = to_omap_bo(obj);
158 int n = usergart[fmt].height;
159 size_t size = PAGE_SIZE * n;
160 loff_t off = mmap_offset(obj) +
161 (entry->obj_pgoff << PAGE_SHIFT);
162 const int m = 1 + ((omap_obj->width << fmt) / PAGE_SIZE);
166 /* if stride > than PAGE_SIZE then sparse mapping: */
167 for (i = n; i > 0; i--) {
168 unmap_mapping_range(obj->dev->anon_inode->i_mapping,
170 off += PAGE_SIZE * m;
173 unmap_mapping_range(obj->dev->anon_inode->i_mapping,
180 /* Evict a buffer from usergart, if it is mapped there */
181 static void evict(struct drm_gem_object *obj)
183 struct omap_gem_object *omap_obj = to_omap_bo(obj);
185 if (omap_obj->flags & OMAP_BO_TILED) {
186 enum tiler_fmt fmt = gem2fmt(omap_obj->flags);
192 for (i = 0; i < NUM_USERGART_ENTRIES; i++) {
193 struct usergart_entry *entry = &usergart[fmt].entry[i];
194 if (entry->obj == obj)
195 evict_entry(obj, fmt, entry);
200 /* GEM objects can either be allocated from contiguous memory (in which
201 * case obj->filp==NULL), or w/ shmem backing (obj->filp!=NULL). But non
202 * contiguous buffers can be remapped in TILER/DMM if they need to be
203 * contiguous... but we don't do this all the time to reduce pressure
204 * on TILER/DMM space when we know at allocation time that the buffer
205 * will need to be scanned out.
207 static inline bool is_shmem(struct drm_gem_object *obj)
209 return obj->filp != NULL;
213 * shmem buffers that are mapped cached can simulate coherency via using
214 * page faulting to keep track of dirty pages
216 static inline bool is_cached_coherent(struct drm_gem_object *obj)
218 struct omap_gem_object *omap_obj = to_omap_bo(obj);
219 return is_shmem(obj) &&
220 ((omap_obj->flags & OMAP_BO_CACHE_MASK) == OMAP_BO_CACHED);
223 static DEFINE_SPINLOCK(sync_lock);
225 /** ensure backing pages are allocated */
226 static int omap_gem_attach_pages(struct drm_gem_object *obj)
228 struct drm_device *dev = obj->dev;
229 struct omap_gem_object *omap_obj = to_omap_bo(obj);
231 int npages = obj->size >> PAGE_SHIFT;
235 WARN_ON(omap_obj->pages);
237 pages = drm_gem_get_pages(obj);
239 dev_err(obj->dev->dev, "could not get pages: %ld\n", PTR_ERR(pages));
240 return PTR_ERR(pages);
243 /* for non-cached buffers, ensure the new pages are clean because
244 * DSS, GPU, etc. are not cache coherent:
246 if (omap_obj->flags & (OMAP_BO_WC|OMAP_BO_UNCACHED)) {
247 addrs = kmalloc(npages * sizeof(*addrs), GFP_KERNEL);
253 for (i = 0; i < npages; i++) {
254 addrs[i] = dma_map_page(dev->dev, pages[i],
255 0, PAGE_SIZE, DMA_BIDIRECTIONAL);
258 addrs = kzalloc(npages * sizeof(*addrs), GFP_KERNEL);
265 omap_obj->addrs = addrs;
266 omap_obj->pages = pages;
271 drm_gem_put_pages(obj, pages, true, false);
276 /** release backing pages */
277 static void omap_gem_detach_pages(struct drm_gem_object *obj)
279 struct omap_gem_object *omap_obj = to_omap_bo(obj);
281 /* for non-cached buffers, ensure the new pages are clean because
282 * DSS, GPU, etc. are not cache coherent:
284 if (omap_obj->flags & (OMAP_BO_WC|OMAP_BO_UNCACHED)) {
285 int i, npages = obj->size >> PAGE_SHIFT;
286 for (i = 0; i < npages; i++) {
287 dma_unmap_page(obj->dev->dev, omap_obj->addrs[i],
288 PAGE_SIZE, DMA_BIDIRECTIONAL);
292 kfree(omap_obj->addrs);
293 omap_obj->addrs = NULL;
295 drm_gem_put_pages(obj, omap_obj->pages, true, false);
296 omap_obj->pages = NULL;
299 /* get buffer flags */
300 uint32_t omap_gem_flags(struct drm_gem_object *obj)
302 return to_omap_bo(obj)->flags;
305 /** get mmap offset */
306 static uint64_t mmap_offset(struct drm_gem_object *obj)
308 struct drm_device *dev = obj->dev;
312 WARN_ON(!mutex_is_locked(&dev->struct_mutex));
314 /* Make it mmapable */
315 size = omap_gem_mmap_size(obj);
316 ret = drm_gem_create_mmap_offset_size(obj, size);
318 dev_err(dev->dev, "could not allocate mmap offset\n");
322 return drm_vma_node_offset_addr(&obj->vma_node);
325 uint64_t omap_gem_mmap_offset(struct drm_gem_object *obj)
328 mutex_lock(&obj->dev->struct_mutex);
329 offset = mmap_offset(obj);
330 mutex_unlock(&obj->dev->struct_mutex);
335 size_t omap_gem_mmap_size(struct drm_gem_object *obj)
337 struct omap_gem_object *omap_obj = to_omap_bo(obj);
338 size_t size = obj->size;
340 if (omap_obj->flags & OMAP_BO_TILED) {
341 /* for tiled buffers, the virtual size has stride rounded up
342 * to 4kb.. (to hide the fact that row n+1 might start 16kb or
343 * 32kb later!). But we don't back the entire buffer with
344 * pages, only the valid picture part.. so need to adjust for
345 * this in the size used to mmap and generate mmap offset
347 size = tiler_vsize(gem2fmt(omap_obj->flags),
348 omap_obj->width, omap_obj->height);
354 /* get tiled size, returns -EINVAL if not tiled buffer */
355 int omap_gem_tiled_size(struct drm_gem_object *obj, uint16_t *w, uint16_t *h)
357 struct omap_gem_object *omap_obj = to_omap_bo(obj);
358 if (omap_obj->flags & OMAP_BO_TILED) {
359 *w = omap_obj->width;
360 *h = omap_obj->height;
366 /* Normal handling for the case of faulting in non-tiled buffers */
367 static int fault_1d(struct drm_gem_object *obj,
368 struct vm_area_struct *vma, struct vm_fault *vmf)
370 struct omap_gem_object *omap_obj = to_omap_bo(obj);
374 /* We don't use vmf->pgoff since that has the fake offset: */
375 pgoff = ((unsigned long)vmf->virtual_address -
376 vma->vm_start) >> PAGE_SHIFT;
378 if (omap_obj->pages) {
379 omap_gem_cpu_sync(obj, pgoff);
380 pfn = page_to_pfn(omap_obj->pages[pgoff]);
382 BUG_ON(!(omap_obj->flags & OMAP_BO_DMA));
383 pfn = (omap_obj->paddr >> PAGE_SHIFT) + pgoff;
386 VERB("Inserting %p pfn %lx, pa %lx", vmf->virtual_address,
387 pfn, pfn << PAGE_SHIFT);
389 return vm_insert_mixed(vma, (unsigned long)vmf->virtual_address,
390 __pfn_to_pfn_t(pfn, PFN_DEV));
393 /* Special handling for the case of faulting in 2d tiled buffers */
394 static int fault_2d(struct drm_gem_object *obj,
395 struct vm_area_struct *vma, struct vm_fault *vmf)
397 struct omap_gem_object *omap_obj = to_omap_bo(obj);
398 struct usergart_entry *entry;
399 enum tiler_fmt fmt = gem2fmt(omap_obj->flags);
400 struct page *pages[64]; /* XXX is this too much to have on stack? */
402 pgoff_t pgoff, base_pgoff;
407 * Note the height of the slot is also equal to the number of pages
408 * that need to be mapped in to fill 4kb wide CPU page. If the slot
409 * height is 64, then 64 pages fill a 4kb wide by 64 row region.
411 const int n = usergart[fmt].height;
412 const int n_shift = usergart[fmt].height_shift;
415 * If buffer width in bytes > PAGE_SIZE then the virtual stride is
416 * rounded up to next multiple of PAGE_SIZE.. this need to be taken
417 * into account in some of the math, so figure out virtual stride
420 const int m = 1 + ((omap_obj->width << fmt) / PAGE_SIZE);
422 /* We don't use vmf->pgoff since that has the fake offset: */
423 pgoff = ((unsigned long)vmf->virtual_address -
424 vma->vm_start) >> PAGE_SHIFT;
427 * Actual address we start mapping at is rounded down to previous slot
428 * boundary in the y direction:
430 base_pgoff = round_down(pgoff, m << n_shift);
432 /* figure out buffer width in slots */
433 slots = omap_obj->width >> usergart[fmt].slot_shift;
435 vaddr = vmf->virtual_address - ((pgoff - base_pgoff) << PAGE_SHIFT);
437 entry = &usergart[fmt].entry[usergart[fmt].last];
439 /* evict previous buffer using this usergart entry, if any: */
441 evict_entry(entry->obj, fmt, entry);
444 entry->obj_pgoff = base_pgoff;
446 /* now convert base_pgoff to phys offset from virt offset: */
447 base_pgoff = (base_pgoff >> n_shift) * slots;
449 /* for wider-than 4k.. figure out which part of the slot-row we want: */
452 entry->obj_pgoff += off;
454 slots = min(slots - (off << n_shift), n);
455 base_pgoff += off << n_shift;
456 vaddr += off << PAGE_SHIFT;
460 * Map in pages. Beyond the valid pixel part of the buffer, we set
461 * pages[i] to NULL to get a dummy page mapped in.. if someone
462 * reads/writes it they will get random/undefined content, but at
463 * least it won't be corrupting whatever other random page used to
464 * be mapped in, or other undefined behavior.
466 memcpy(pages, &omap_obj->pages[base_pgoff],
467 sizeof(struct page *) * slots);
468 memset(pages + slots, 0,
469 sizeof(struct page *) * (n - slots));
471 ret = tiler_pin(entry->block, pages, ARRAY_SIZE(pages), 0, true);
473 dev_err(obj->dev->dev, "failed to pin: %d\n", ret);
477 pfn = entry->paddr >> PAGE_SHIFT;
479 VERB("Inserting %p pfn %lx, pa %lx", vmf->virtual_address,
480 pfn, pfn << PAGE_SHIFT);
482 for (i = n; i > 0; i--) {
483 vm_insert_mixed(vma, (unsigned long)vaddr,
484 __pfn_to_pfn_t(pfn, PFN_DEV));
485 pfn += usergart[fmt].stride_pfn;
486 vaddr += PAGE_SIZE * m;
489 /* simple round-robin: */
490 usergart[fmt].last = (usergart[fmt].last + 1) % NUM_USERGART_ENTRIES;
496 * omap_gem_fault - pagefault handler for GEM objects
497 * @vma: the VMA of the GEM object
500 * Invoked when a fault occurs on an mmap of a GEM managed area. GEM
501 * does most of the work for us including the actual map/unmap calls
502 * but we need to do the actual page work.
504 * The VMA was set up by GEM. In doing so it also ensured that the
505 * vma->vm_private_data points to the GEM object that is backing this
508 int omap_gem_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
510 struct drm_gem_object *obj = vma->vm_private_data;
511 struct omap_gem_object *omap_obj = to_omap_bo(obj);
512 struct drm_device *dev = obj->dev;
516 /* Make sure we don't parallel update on a fault, nor move or remove
517 * something from beneath our feet
519 mutex_lock(&dev->struct_mutex);
521 /* if a shmem backed object, make sure we have pages attached now */
522 ret = get_pages(obj, &pages);
526 /* where should we do corresponding put_pages().. we are mapping
527 * the original page, rather than thru a GART, so we can't rely
528 * on eviction to trigger this. But munmap() or all mappings should
529 * probably trigger put_pages()?
532 if (omap_obj->flags & OMAP_BO_TILED)
533 ret = fault_2d(obj, vma, vmf);
535 ret = fault_1d(obj, vma, vmf);
539 mutex_unlock(&dev->struct_mutex);
544 return VM_FAULT_NOPAGE;
548 return VM_FAULT_SIGBUS;
552 /** We override mainly to fix up some of the vm mapping flags.. */
553 int omap_gem_mmap(struct file *filp, struct vm_area_struct *vma)
557 ret = drm_gem_mmap(filp, vma);
559 DBG("mmap failed: %d", ret);
563 return omap_gem_mmap_obj(vma->vm_private_data, vma);
566 int omap_gem_mmap_obj(struct drm_gem_object *obj,
567 struct vm_area_struct *vma)
569 struct omap_gem_object *omap_obj = to_omap_bo(obj);
571 vma->vm_flags &= ~VM_PFNMAP;
572 vma->vm_flags |= VM_MIXEDMAP;
574 if (omap_obj->flags & OMAP_BO_WC) {
575 vma->vm_page_prot = pgprot_writecombine(vm_get_page_prot(vma->vm_flags));
576 } else if (omap_obj->flags & OMAP_BO_UNCACHED) {
577 vma->vm_page_prot = pgprot_noncached(vm_get_page_prot(vma->vm_flags));
580 * We do have some private objects, at least for scanout buffers
581 * on hardware without DMM/TILER. But these are allocated write-
584 if (WARN_ON(!obj->filp))
588 * Shunt off cached objs to shmem file so they have their own
589 * address_space (so unmap_mapping_range does what we want,
590 * in particular in the case of mmap'd dmabufs)
594 vma->vm_file = get_file(obj->filp);
596 vma->vm_page_prot = vm_get_page_prot(vma->vm_flags);
604 * omap_gem_dumb_create - create a dumb buffer
605 * @drm_file: our client file
607 * @args: the requested arguments copied from userspace
609 * Allocate a buffer suitable for use for a frame buffer of the
610 * form described by user space. Give userspace a handle by which
613 int omap_gem_dumb_create(struct drm_file *file, struct drm_device *dev,
614 struct drm_mode_create_dumb *args)
616 union omap_gem_size gsize;
618 args->pitch = align_pitch(0, args->width, args->bpp);
619 args->size = PAGE_ALIGN(args->pitch * args->height);
621 gsize = (union omap_gem_size){
625 return omap_gem_new_handle(dev, file, gsize,
626 OMAP_BO_SCANOUT | OMAP_BO_WC, &args->handle);
630 * omap_gem_dumb_map - buffer mapping for dumb interface
631 * @file: our drm client file
633 * @handle: GEM handle to the object (from dumb_create)
635 * Do the necessary setup to allow the mapping of the frame buffer
636 * into user memory. We don't have to do much here at the moment.
638 int omap_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev,
639 uint32_t handle, uint64_t *offset)
641 struct drm_gem_object *obj;
644 /* GEM does all our handle to object mapping */
645 obj = drm_gem_object_lookup(dev, file, handle);
651 *offset = omap_gem_mmap_offset(obj);
653 drm_gem_object_unreference_unlocked(obj);
659 /* Set scrolling position. This allows us to implement fast scrolling
662 * Call only from non-atomic contexts.
664 int omap_gem_roll(struct drm_gem_object *obj, uint32_t roll)
666 struct omap_gem_object *omap_obj = to_omap_bo(obj);
667 uint32_t npages = obj->size >> PAGE_SHIFT;
671 dev_err(obj->dev->dev, "invalid roll: %d\n", roll);
675 omap_obj->roll = roll;
677 mutex_lock(&obj->dev->struct_mutex);
679 /* if we aren't mapped yet, we don't need to do anything */
680 if (omap_obj->block) {
682 ret = get_pages(obj, &pages);
685 ret = tiler_pin(omap_obj->block, pages, npages, roll, true);
687 dev_err(obj->dev->dev, "could not repin: %d\n", ret);
691 mutex_unlock(&obj->dev->struct_mutex);
696 /* Sync the buffer for CPU access.. note pages should already be
697 * attached, ie. omap_gem_get_pages()
699 void omap_gem_cpu_sync(struct drm_gem_object *obj, int pgoff)
701 struct drm_device *dev = obj->dev;
702 struct omap_gem_object *omap_obj = to_omap_bo(obj);
704 if (is_cached_coherent(obj) && omap_obj->addrs[pgoff]) {
705 dma_unmap_page(dev->dev, omap_obj->addrs[pgoff],
706 PAGE_SIZE, DMA_BIDIRECTIONAL);
707 omap_obj->addrs[pgoff] = 0;
711 /* sync the buffer for DMA access */
712 void omap_gem_dma_sync(struct drm_gem_object *obj,
713 enum dma_data_direction dir)
715 struct drm_device *dev = obj->dev;
716 struct omap_gem_object *omap_obj = to_omap_bo(obj);
718 if (is_cached_coherent(obj)) {
719 int i, npages = obj->size >> PAGE_SHIFT;
720 struct page **pages = omap_obj->pages;
723 for (i = 0; i < npages; i++) {
724 if (!omap_obj->addrs[i]) {
725 omap_obj->addrs[i] = dma_map_page(dev->dev, pages[i], 0,
726 PAGE_SIZE, DMA_BIDIRECTIONAL);
732 unmap_mapping_range(obj->filp->f_mapping, 0,
733 omap_gem_mmap_size(obj), 1);
738 /* Get physical address for DMA.. if 'remap' is true, and the buffer is not
739 * already contiguous, remap it to pin in physically contiguous memory.. (ie.
742 int omap_gem_get_paddr(struct drm_gem_object *obj,
743 dma_addr_t *paddr, bool remap)
745 struct omap_drm_private *priv = obj->dev->dev_private;
746 struct omap_gem_object *omap_obj = to_omap_bo(obj);
749 mutex_lock(&obj->dev->struct_mutex);
751 if (remap && is_shmem(obj) && priv->has_dmm) {
752 if (omap_obj->paddr_cnt == 0) {
754 uint32_t npages = obj->size >> PAGE_SHIFT;
755 enum tiler_fmt fmt = gem2fmt(omap_obj->flags);
756 struct tiler_block *block;
758 BUG_ON(omap_obj->block);
760 ret = get_pages(obj, &pages);
764 if (omap_obj->flags & OMAP_BO_TILED) {
765 block = tiler_reserve_2d(fmt,
767 omap_obj->height, 0);
769 block = tiler_reserve_1d(obj->size);
773 ret = PTR_ERR(block);
774 dev_err(obj->dev->dev,
775 "could not remap: %d (%d)\n", ret, fmt);
779 /* TODO: enable async refill.. */
780 ret = tiler_pin(block, pages, npages,
781 omap_obj->roll, true);
783 tiler_release(block);
784 dev_err(obj->dev->dev,
785 "could not pin: %d\n", ret);
789 omap_obj->paddr = tiler_ssptr(block);
790 omap_obj->block = block;
792 DBG("got paddr: %pad", &omap_obj->paddr);
795 omap_obj->paddr_cnt++;
797 *paddr = omap_obj->paddr;
798 } else if (omap_obj->flags & OMAP_BO_DMA) {
799 *paddr = omap_obj->paddr;
806 mutex_unlock(&obj->dev->struct_mutex);
811 /* Release physical address, when DMA is no longer being performed.. this
812 * could potentially unpin and unmap buffers from TILER
814 void omap_gem_put_paddr(struct drm_gem_object *obj)
816 struct omap_gem_object *omap_obj = to_omap_bo(obj);
819 mutex_lock(&obj->dev->struct_mutex);
820 if (omap_obj->paddr_cnt > 0) {
821 omap_obj->paddr_cnt--;
822 if (omap_obj->paddr_cnt == 0) {
823 ret = tiler_unpin(omap_obj->block);
825 dev_err(obj->dev->dev,
826 "could not unpin pages: %d\n", ret);
828 ret = tiler_release(omap_obj->block);
830 dev_err(obj->dev->dev,
831 "could not release unmap: %d\n", ret);
834 omap_obj->block = NULL;
838 mutex_unlock(&obj->dev->struct_mutex);
841 /* Get rotated scanout address (only valid if already pinned), at the
842 * specified orientation and x,y offset from top-left corner of buffer
843 * (only valid for tiled 2d buffers)
845 int omap_gem_rotated_paddr(struct drm_gem_object *obj, uint32_t orient,
846 int x, int y, dma_addr_t *paddr)
848 struct omap_gem_object *omap_obj = to_omap_bo(obj);
851 mutex_lock(&obj->dev->struct_mutex);
852 if ((omap_obj->paddr_cnt > 0) && omap_obj->block &&
853 (omap_obj->flags & OMAP_BO_TILED)) {
854 *paddr = tiler_tsptr(omap_obj->block, orient, x, y);
857 mutex_unlock(&obj->dev->struct_mutex);
861 /* Get tiler stride for the buffer (only valid for 2d tiled buffers) */
862 int omap_gem_tiled_stride(struct drm_gem_object *obj, uint32_t orient)
864 struct omap_gem_object *omap_obj = to_omap_bo(obj);
866 if (omap_obj->flags & OMAP_BO_TILED)
867 ret = tiler_stride(gem2fmt(omap_obj->flags), orient);
871 /* acquire pages when needed (for example, for DMA where physically
872 * contiguous buffer is not required
874 static int get_pages(struct drm_gem_object *obj, struct page ***pages)
876 struct omap_gem_object *omap_obj = to_omap_bo(obj);
879 if (is_shmem(obj) && !omap_obj->pages) {
880 ret = omap_gem_attach_pages(obj);
882 dev_err(obj->dev->dev, "could not attach pages\n");
887 /* TODO: even phys-contig.. we should have a list of pages? */
888 *pages = omap_obj->pages;
893 /* if !remap, and we don't have pages backing, then fail, rather than
894 * increasing the pin count (which we don't really do yet anyways,
895 * because we don't support swapping pages back out). And 'remap'
896 * might not be quite the right name, but I wanted to keep it working
897 * similarly to omap_gem_get_paddr(). Note though that mutex is not
898 * aquired if !remap (because this can be called in atomic ctxt),
899 * but probably omap_gem_get_paddr() should be changed to work in the
900 * same way. If !remap, a matching omap_gem_put_pages() call is not
901 * required (and should not be made).
903 int omap_gem_get_pages(struct drm_gem_object *obj, struct page ***pages,
908 struct omap_gem_object *omap_obj = to_omap_bo(obj);
909 if (!omap_obj->pages)
911 *pages = omap_obj->pages;
914 mutex_lock(&obj->dev->struct_mutex);
915 ret = get_pages(obj, pages);
916 mutex_unlock(&obj->dev->struct_mutex);
920 /* release pages when DMA no longer being performed */
921 int omap_gem_put_pages(struct drm_gem_object *obj)
923 /* do something here if we dynamically attach/detach pages.. at
924 * least they would no longer need to be pinned if everyone has
925 * released the pages..
930 /* Get kernel virtual address for CPU access.. this more or less only
931 * exists for omap_fbdev. This should be called with struct_mutex
934 void *omap_gem_vaddr(struct drm_gem_object *obj)
936 struct omap_gem_object *omap_obj = to_omap_bo(obj);
937 WARN_ON(!mutex_is_locked(&obj->dev->struct_mutex));
938 if (!omap_obj->vaddr) {
940 int ret = get_pages(obj, &pages);
943 omap_obj->vaddr = vmap(pages, obj->size >> PAGE_SHIFT,
944 VM_MAP, pgprot_writecombine(PAGE_KERNEL));
946 return omap_obj->vaddr;
950 /* re-pin objects in DMM in resume path: */
951 int omap_gem_resume(struct device *dev)
953 struct drm_device *drm_dev = dev_get_drvdata(dev);
954 struct omap_drm_private *priv = drm_dev->dev_private;
955 struct omap_gem_object *omap_obj;
958 list_for_each_entry(omap_obj, &priv->obj_list, mm_list) {
959 if (omap_obj->block) {
960 struct drm_gem_object *obj = &omap_obj->base;
961 uint32_t npages = obj->size >> PAGE_SHIFT;
962 WARN_ON(!omap_obj->pages); /* this can't happen */
963 ret = tiler_pin(omap_obj->block,
964 omap_obj->pages, npages,
965 omap_obj->roll, true);
967 dev_err(dev, "could not repin: %d\n", ret);
977 #ifdef CONFIG_DEBUG_FS
978 void omap_gem_describe(struct drm_gem_object *obj, struct seq_file *m)
980 struct omap_gem_object *omap_obj = to_omap_bo(obj);
983 off = drm_vma_node_start(&obj->vma_node);
985 seq_printf(m, "%08x: %2d (%2d) %08llx %pad (%2d) %p %4d",
986 omap_obj->flags, obj->name, obj->refcount.refcount.counter,
987 off, &omap_obj->paddr, omap_obj->paddr_cnt,
988 omap_obj->vaddr, omap_obj->roll);
990 if (omap_obj->flags & OMAP_BO_TILED) {
991 seq_printf(m, " %dx%d", omap_obj->width, omap_obj->height);
992 if (omap_obj->block) {
993 struct tcm_area *area = &omap_obj->block->area;
994 seq_printf(m, " (%dx%d, %dx%d)",
995 area->p0.x, area->p0.y,
996 area->p1.x, area->p1.y);
999 seq_printf(m, " %d", obj->size);
1002 seq_printf(m, "\n");
1005 void omap_gem_describe_objects(struct list_head *list, struct seq_file *m)
1007 struct omap_gem_object *omap_obj;
1011 list_for_each_entry(omap_obj, list, mm_list) {
1012 struct drm_gem_object *obj = &omap_obj->base;
1014 omap_gem_describe(obj, m);
1019 seq_printf(m, "Total %d objects, %zu bytes\n", count, size);
1023 /* Buffer Synchronization:
1026 struct omap_gem_sync_waiter {
1027 struct list_head list;
1028 struct omap_gem_object *omap_obj;
1029 enum omap_gem_op op;
1030 uint32_t read_target, write_target;
1031 /* notify called w/ sync_lock held */
1032 void (*notify)(void *arg);
1036 /* list of omap_gem_sync_waiter.. the notify fxn gets called back when
1037 * the read and/or write target count is achieved which can call a user
1038 * callback (ex. to kick 3d and/or 2d), wakeup blocked task (prep for
1041 static LIST_HEAD(waiters);
1043 static inline bool is_waiting(struct omap_gem_sync_waiter *waiter)
1045 struct omap_gem_object *omap_obj = waiter->omap_obj;
1046 if ((waiter->op & OMAP_GEM_READ) &&
1047 (omap_obj->sync->write_complete < waiter->write_target))
1049 if ((waiter->op & OMAP_GEM_WRITE) &&
1050 (omap_obj->sync->read_complete < waiter->read_target))
1055 /* macro for sync debug.. */
1057 #define SYNC(fmt, ...) do { if (SYNCDBG) \
1058 printk(KERN_ERR "%s:%d: "fmt"\n", \
1059 __func__, __LINE__, ##__VA_ARGS__); \
1063 static void sync_op_update(void)
1065 struct omap_gem_sync_waiter *waiter, *n;
1066 list_for_each_entry_safe(waiter, n, &waiters, list) {
1067 if (!is_waiting(waiter)) {
1068 list_del(&waiter->list);
1069 SYNC("notify: %p", waiter);
1070 waiter->notify(waiter->arg);
1076 static inline int sync_op(struct drm_gem_object *obj,
1077 enum omap_gem_op op, bool start)
1079 struct omap_gem_object *omap_obj = to_omap_bo(obj);
1082 spin_lock(&sync_lock);
1084 if (!omap_obj->sync) {
1085 omap_obj->sync = kzalloc(sizeof(*omap_obj->sync), GFP_ATOMIC);
1086 if (!omap_obj->sync) {
1093 if (op & OMAP_GEM_READ)
1094 omap_obj->sync->read_pending++;
1095 if (op & OMAP_GEM_WRITE)
1096 omap_obj->sync->write_pending++;
1098 if (op & OMAP_GEM_READ)
1099 omap_obj->sync->read_complete++;
1100 if (op & OMAP_GEM_WRITE)
1101 omap_obj->sync->write_complete++;
1106 spin_unlock(&sync_lock);
1111 /* it is a bit lame to handle updates in this sort of polling way, but
1112 * in case of PVR, the GPU can directly update read/write complete
1113 * values, and not really tell us which ones it updated.. this also
1114 * means that sync_lock is not quite sufficient. So we'll need to
1115 * do something a bit better when it comes time to add support for
1118 void omap_gem_op_update(void)
1120 spin_lock(&sync_lock);
1122 spin_unlock(&sync_lock);
1125 /* mark the start of read and/or write operation */
1126 int omap_gem_op_start(struct drm_gem_object *obj, enum omap_gem_op op)
1128 return sync_op(obj, op, true);
1131 int omap_gem_op_finish(struct drm_gem_object *obj, enum omap_gem_op op)
1133 return sync_op(obj, op, false);
1136 static DECLARE_WAIT_QUEUE_HEAD(sync_event);
1138 static void sync_notify(void *arg)
1140 struct task_struct **waiter_task = arg;
1141 *waiter_task = NULL;
1142 wake_up_all(&sync_event);
1145 int omap_gem_op_sync(struct drm_gem_object *obj, enum omap_gem_op op)
1147 struct omap_gem_object *omap_obj = to_omap_bo(obj);
1149 if (omap_obj->sync) {
1150 struct task_struct *waiter_task = current;
1151 struct omap_gem_sync_waiter *waiter =
1152 kzalloc(sizeof(*waiter), GFP_KERNEL);
1157 waiter->omap_obj = omap_obj;
1159 waiter->read_target = omap_obj->sync->read_pending;
1160 waiter->write_target = omap_obj->sync->write_pending;
1161 waiter->notify = sync_notify;
1162 waiter->arg = &waiter_task;
1164 spin_lock(&sync_lock);
1165 if (is_waiting(waiter)) {
1166 SYNC("waited: %p", waiter);
1167 list_add_tail(&waiter->list, &waiters);
1168 spin_unlock(&sync_lock);
1169 ret = wait_event_interruptible(sync_event,
1170 (waiter_task == NULL));
1171 spin_lock(&sync_lock);
1173 SYNC("interrupted: %p", waiter);
1174 /* we were interrupted */
1175 list_del(&waiter->list);
1178 /* freed in sync_op_update() */
1182 spin_unlock(&sync_lock);
1188 /* call fxn(arg), either synchronously or asynchronously if the op
1189 * is currently blocked.. fxn() can be called from any context
1191 * (TODO for now fxn is called back from whichever context calls
1192 * omap_gem_op_update().. but this could be better defined later
1195 * TODO more code in common w/ _sync()..
1197 int omap_gem_op_async(struct drm_gem_object *obj, enum omap_gem_op op,
1198 void (*fxn)(void *arg), void *arg)
1200 struct omap_gem_object *omap_obj = to_omap_bo(obj);
1201 if (omap_obj->sync) {
1202 struct omap_gem_sync_waiter *waiter =
1203 kzalloc(sizeof(*waiter), GFP_ATOMIC);
1208 waiter->omap_obj = omap_obj;
1210 waiter->read_target = omap_obj->sync->read_pending;
1211 waiter->write_target = omap_obj->sync->write_pending;
1212 waiter->notify = fxn;
1215 spin_lock(&sync_lock);
1216 if (is_waiting(waiter)) {
1217 SYNC("waited: %p", waiter);
1218 list_add_tail(&waiter->list, &waiters);
1219 spin_unlock(&sync_lock);
1223 spin_unlock(&sync_lock);
1234 /* special API so PVR can update the buffer to use a sync-object allocated
1235 * from it's sync-obj heap. Only used for a newly allocated (from PVR's
1236 * perspective) sync-object, so we overwrite the new syncobj w/ values
1237 * from the already allocated syncobj (if there is one)
1239 int omap_gem_set_sync_object(struct drm_gem_object *obj, void *syncobj)
1241 struct omap_gem_object *omap_obj = to_omap_bo(obj);
1244 spin_lock(&sync_lock);
1246 if ((omap_obj->flags & OMAP_BO_EXT_SYNC) && !syncobj) {
1247 /* clearing a previously set syncobj */
1248 syncobj = kmemdup(omap_obj->sync, sizeof(*omap_obj->sync),
1254 omap_obj->flags &= ~OMAP_BO_EXT_SYNC;
1255 omap_obj->sync = syncobj;
1256 } else if (syncobj && !(omap_obj->flags & OMAP_BO_EXT_SYNC)) {
1257 /* replacing an existing syncobj */
1258 if (omap_obj->sync) {
1259 memcpy(syncobj, omap_obj->sync, sizeof(*omap_obj->sync));
1260 kfree(omap_obj->sync);
1262 omap_obj->flags |= OMAP_BO_EXT_SYNC;
1263 omap_obj->sync = syncobj;
1267 spin_unlock(&sync_lock);
1271 /* don't call directly.. called from GEM core when it is time to actually
1274 void omap_gem_free_object(struct drm_gem_object *obj)
1276 struct drm_device *dev = obj->dev;
1277 struct omap_drm_private *priv = dev->dev_private;
1278 struct omap_gem_object *omap_obj = to_omap_bo(obj);
1282 WARN_ON(!mutex_is_locked(&dev->struct_mutex));
1284 spin_lock(&priv->list_lock);
1285 list_del(&omap_obj->mm_list);
1286 spin_unlock(&priv->list_lock);
1288 drm_gem_free_mmap_offset(obj);
1290 /* this means the object is still pinned.. which really should
1291 * not happen. I think..
1293 WARN_ON(omap_obj->paddr_cnt > 0);
1295 /* don't free externally allocated backing memory */
1296 if (!(omap_obj->flags & OMAP_BO_EXT_MEM)) {
1297 if (omap_obj->pages)
1298 omap_gem_detach_pages(obj);
1300 if (!is_shmem(obj)) {
1301 dma_free_writecombine(dev->dev, obj->size,
1302 omap_obj->vaddr, omap_obj->paddr);
1303 } else if (omap_obj->vaddr) {
1304 vunmap(omap_obj->vaddr);
1308 /* don't free externally allocated syncobj */
1309 if (!(omap_obj->flags & OMAP_BO_EXT_SYNC))
1310 kfree(omap_obj->sync);
1312 drm_gem_object_release(obj);
1317 /* convenience method to construct a GEM buffer object, and userspace handle */
1318 int omap_gem_new_handle(struct drm_device *dev, struct drm_file *file,
1319 union omap_gem_size gsize, uint32_t flags, uint32_t *handle)
1321 struct drm_gem_object *obj;
1324 obj = omap_gem_new(dev, gsize, flags);
1328 ret = drm_gem_handle_create(file, obj, handle);
1330 drm_gem_object_release(obj);
1331 kfree(obj); /* TODO isn't there a dtor to call? just copying i915 */
1335 /* drop reference from allocate - handle holds it now */
1336 drm_gem_object_unreference_unlocked(obj);
1341 /* GEM buffer object constructor */
1342 struct drm_gem_object *omap_gem_new(struct drm_device *dev,
1343 union omap_gem_size gsize, uint32_t flags)
1345 struct omap_drm_private *priv = dev->dev_private;
1346 struct omap_gem_object *omap_obj;
1347 struct drm_gem_object *obj = NULL;
1348 struct address_space *mapping;
1352 if (flags & OMAP_BO_TILED) {
1354 dev_err(dev->dev, "Tiled buffers require DMM\n");
1358 /* tiled buffers are always shmem paged backed.. when they are
1359 * scanned out, they are remapped into DMM/TILER
1361 flags &= ~OMAP_BO_SCANOUT;
1363 /* currently don't allow cached buffers.. there is some caching
1364 * stuff that needs to be handled better
1366 flags &= ~(OMAP_BO_CACHED|OMAP_BO_WC|OMAP_BO_UNCACHED);
1367 flags |= tiler_get_cpu_cache_flags();
1369 /* align dimensions to slot boundaries... */
1370 tiler_align(gem2fmt(flags),
1371 &gsize.tiled.width, &gsize.tiled.height);
1373 /* ...and calculate size based on aligned dimensions */
1374 size = tiler_size(gem2fmt(flags),
1375 gsize.tiled.width, gsize.tiled.height);
1377 size = PAGE_ALIGN(gsize.bytes);
1380 omap_obj = kzalloc(sizeof(*omap_obj), GFP_KERNEL);
1384 obj = &omap_obj->base;
1386 if ((flags & OMAP_BO_SCANOUT) && !priv->has_dmm) {
1387 /* attempt to allocate contiguous memory if we don't
1388 * have DMM for remappign discontiguous buffers
1390 omap_obj->vaddr = dma_alloc_writecombine(dev->dev, size,
1391 &omap_obj->paddr, GFP_KERNEL);
1392 if (!omap_obj->vaddr) {
1398 flags |= OMAP_BO_DMA;
1401 spin_lock(&priv->list_lock);
1402 list_add(&omap_obj->mm_list, &priv->obj_list);
1403 spin_unlock(&priv->list_lock);
1405 omap_obj->flags = flags;
1407 if (flags & OMAP_BO_TILED) {
1408 omap_obj->width = gsize.tiled.width;
1409 omap_obj->height = gsize.tiled.height;
1412 if (flags & (OMAP_BO_DMA|OMAP_BO_EXT_MEM)) {
1413 drm_gem_private_object_init(dev, obj, size);
1415 ret = drm_gem_object_init(dev, obj, size);
1419 mapping = file_inode(obj->filp)->i_mapping;
1420 mapping_set_gfp_mask(mapping, GFP_USER | __GFP_DMA32);
1427 omap_gem_free_object(obj);
1432 /* init/cleanup.. if DMM is used, we need to set some stuff up.. */
1433 void omap_gem_init(struct drm_device *dev)
1435 struct omap_drm_private *priv = dev->dev_private;
1436 const enum tiler_fmt fmts[] = {
1437 TILFMT_8BIT, TILFMT_16BIT, TILFMT_32BIT
1441 if (!dmm_is_available()) {
1442 /* DMM only supported on OMAP4 and later, so this isn't fatal */
1443 dev_warn(dev->dev, "DMM not available, disable DMM support\n");
1447 usergart = kcalloc(3, sizeof(*usergart), GFP_KERNEL);
1451 /* reserve 4k aligned/wide regions for userspace mappings: */
1452 for (i = 0; i < ARRAY_SIZE(fmts); i++) {
1453 uint16_t h = 1, w = PAGE_SIZE >> i;
1454 tiler_align(fmts[i], &w, &h);
1455 /* note: since each region is 1 4kb page wide, and minimum
1456 * number of rows, the height ends up being the same as the
1457 * # of pages in the region
1459 usergart[i].height = h;
1460 usergart[i].height_shift = ilog2(h);
1461 usergart[i].stride_pfn = tiler_stride(fmts[i], 0) >> PAGE_SHIFT;
1462 usergart[i].slot_shift = ilog2((PAGE_SIZE / h) >> i);
1463 for (j = 0; j < NUM_USERGART_ENTRIES; j++) {
1464 struct usergart_entry *entry = &usergart[i].entry[j];
1465 struct tiler_block *block =
1466 tiler_reserve_2d(fmts[i], w, h,
1468 if (IS_ERR(block)) {
1470 "reserve failed: %d, %d, %ld\n",
1471 i, j, PTR_ERR(block));
1474 entry->paddr = tiler_ssptr(block);
1475 entry->block = block;
1477 DBG("%d:%d: %dx%d: paddr=%pad stride=%d", i, j, w, h,
1479 usergart[i].stride_pfn << PAGE_SHIFT);
1483 priv->has_dmm = true;
1486 void omap_gem_deinit(struct drm_device *dev)
1488 /* I believe we can rely on there being no more outstanding GEM
1489 * objects which could depend on usergart/dmm at this point.