3 * Memory mapping for DRM
5 * \author Rickard E. (Rik) Faith <faith@valinux.com>
6 * \author Gareth Hughes <gareth@valinux.com>
10 * Created: Mon Jan 4 08:58:31 1999 by faith@valinux.com
12 * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
13 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
14 * All Rights Reserved.
16 * Permission is hereby granted, free of charge, to any person obtaining a
17 * copy of this software and associated documentation files (the "Software"),
18 * to deal in the Software without restriction, including without limitation
19 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
20 * and/or sell copies of the Software, and to permit persons to whom the
21 * Software is furnished to do so, subject to the following conditions:
23 * The above copyright notice and this permission notice (including the next
24 * paragraph) shall be included in all copies or substantial portions of the
27 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
28 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
29 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
30 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
31 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
32 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
33 * OTHER DEALINGS IN THE SOFTWARE.
38 #include <linux/efi.h>
39 #include <linux/slab.h>
42 static void drm_vm_open(struct vm_area_struct *vma);
43 static void drm_vm_close(struct vm_area_struct *vma);
45 static pgprot_t drm_io_prot(uint32_t map_type, struct vm_area_struct *vma)
47 pgprot_t tmp = vm_get_page_prot(vma->vm_flags);
49 #if defined(__i386__) || defined(__x86_64__)
50 if (boot_cpu_data.x86 > 3 && map_type != _DRM_AGP) {
51 pgprot_val(tmp) |= _PAGE_PCD;
52 pgprot_val(tmp) &= ~_PAGE_PWT;
54 #elif defined(__powerpc__)
55 pgprot_val(tmp) |= _PAGE_NO_CACHE;
56 if (map_type == _DRM_REGISTERS)
57 pgprot_val(tmp) |= _PAGE_GUARDED;
58 #elif defined(__ia64__)
59 if (efi_range_is_wc(vma->vm_start, vma->vm_end -
61 tmp = pgprot_writecombine(tmp);
63 tmp = pgprot_noncached(tmp);
64 #elif defined(__sparc__) || defined(__arm__)
65 tmp = pgprot_noncached(tmp);
70 static pgprot_t drm_dma_prot(uint32_t map_type, struct vm_area_struct *vma)
72 pgprot_t tmp = vm_get_page_prot(vma->vm_flags);
74 #if defined(__powerpc__) && defined(CONFIG_NOT_COHERENT_CACHE)
75 tmp |= _PAGE_NO_CACHE;
81 * \c fault method for AGP virtual memory.
83 * \param vma virtual memory area.
84 * \param address access address.
85 * \return pointer to the page structure.
87 * Find the right map and if it's AGP memory find the real physical page to
88 * map, get the page, increment the use count and return it.
91 static int drm_do_vm_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
93 struct drm_file *priv = vma->vm_file->private_data;
94 struct drm_device *dev = priv->minor->dev;
95 struct drm_local_map *map = NULL;
96 struct drm_map_list *r_list;
97 struct drm_hash_item *hash;
102 if (!drm_core_has_AGP(dev))
105 if (!dev->agp || !dev->agp->cant_use_aperture)
108 if (drm_ht_find_item(&dev->map_hash, vma->vm_pgoff, &hash))
111 r_list = drm_hash_entry(hash, struct drm_map_list, hash);
114 if (map && map->type == _DRM_AGP) {
116 * Using vm_pgoff as a selector forces us to use this unusual
119 resource_size_t offset = (unsigned long)vmf->virtual_address -
121 resource_size_t baddr = map->offset + offset;
122 struct drm_agp_mem *agpmem;
127 * Adjust to a bus-relative address
129 baddr -= dev->hose->mem_space->start;
133 * It's AGP memory - find the real physical page to map
135 list_for_each_entry(agpmem, &dev->agp->memory, head) {
136 if (agpmem->bound <= baddr &&
137 agpmem->bound + agpmem->pages * PAGE_SIZE > baddr)
141 if (&agpmem->head == &dev->agp->memory)
145 * Get the page, inc the use count, and return it
147 offset = (baddr - agpmem->bound) >> PAGE_SHIFT;
148 page = agpmem->memory->pages[offset];
153 ("baddr = 0x%llx page = 0x%p, offset = 0x%llx, count=%d\n",
154 (unsigned long long)baddr,
155 agpmem->memory->pages[offset],
156 (unsigned long long)offset,
161 return VM_FAULT_SIGBUS; /* Disallow mremap */
163 #else /* __OS_HAS_AGP */
164 static int drm_do_vm_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
166 return VM_FAULT_SIGBUS;
168 #endif /* __OS_HAS_AGP */
171 * \c nopage method for shared virtual memory.
173 * \param vma virtual memory area.
174 * \param address access address.
175 * \return pointer to the page structure.
177 * Get the mapping, find the real physical page to map, get the page, and
180 static int drm_do_vm_shm_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
182 struct drm_local_map *map = vma->vm_private_data;
183 unsigned long offset;
188 return VM_FAULT_SIGBUS; /* Nothing allocated */
190 offset = (unsigned long)vmf->virtual_address - vma->vm_start;
191 i = (unsigned long)map->handle + offset;
192 page = vmalloc_to_page((void *)i);
194 return VM_FAULT_SIGBUS;
198 DRM_DEBUG("shm_fault 0x%lx\n", offset);
203 * \c close method for shared virtual memory.
205 * \param vma virtual memory area.
207 * Deletes map information if we are the last
208 * person to close a mapping and it's not in the global maplist.
210 static void drm_vm_shm_close(struct vm_area_struct *vma)
212 struct drm_file *priv = vma->vm_file->private_data;
213 struct drm_device *dev = priv->minor->dev;
214 struct drm_vma_entry *pt, *temp;
215 struct drm_local_map *map;
216 struct drm_map_list *r_list;
219 DRM_DEBUG("0x%08lx,0x%08lx\n",
220 vma->vm_start, vma->vm_end - vma->vm_start);
221 atomic_dec(&dev->vma_count);
223 map = vma->vm_private_data;
225 mutex_lock(&dev->struct_mutex);
226 list_for_each_entry_safe(pt, temp, &dev->vmalist, head) {
227 if (pt->vma->vm_private_data == map)
229 if (pt->vma == vma) {
235 /* We were the only map that was found */
236 if (found_maps == 1 && map->flags & _DRM_REMOVABLE) {
237 /* Check to see if we are in the maplist, if we are not, then
238 * we delete this mappings information.
241 list_for_each_entry(r_list, &dev->maplist, head) {
242 if (r_list->map == map)
247 drm_dma_handle_t dmah;
251 case _DRM_FRAME_BUFFER:
252 if (drm_core_has_MTRR(dev) && map->mtrr >= 0) {
254 retcode = mtrr_del(map->mtrr,
257 DRM_DEBUG("mtrr_del = %d\n", retcode);
259 iounmap(map->handle);
265 case _DRM_SCATTER_GATHER:
267 case _DRM_CONSISTENT:
268 dmah.vaddr = map->handle;
269 dmah.busaddr = map->offset;
270 dmah.size = map->size;
271 __drm_pci_free(dev, &dmah);
274 DRM_ERROR("tried to rmmap GEM object\n");
280 mutex_unlock(&dev->struct_mutex);
284 * \c fault method for DMA virtual memory.
286 * \param vma virtual memory area.
287 * \param address access address.
288 * \return pointer to the page structure.
290 * Determine the page number from the page offset and get it from drm_device_dma::pagelist.
292 static int drm_do_vm_dma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
294 struct drm_file *priv = vma->vm_file->private_data;
295 struct drm_device *dev = priv->minor->dev;
296 struct drm_device_dma *dma = dev->dma;
297 unsigned long offset;
298 unsigned long page_nr;
302 return VM_FAULT_SIGBUS; /* Error */
304 return VM_FAULT_SIGBUS; /* Nothing allocated */
306 offset = (unsigned long)vmf->virtual_address - vma->vm_start; /* vm_[pg]off[set] should be 0 */
307 page_nr = offset >> PAGE_SHIFT; /* page_nr could just be vmf->pgoff */
308 page = virt_to_page((dma->pagelist[page_nr] + (offset & (~PAGE_MASK))));
313 DRM_DEBUG("dma_fault 0x%lx (page %lu)\n", offset, page_nr);
318 * \c fault method for scatter-gather virtual memory.
320 * \param vma virtual memory area.
321 * \param address access address.
322 * \return pointer to the page structure.
324 * Determine the map offset from the page offset and get it from drm_sg_mem::pagelist.
326 static int drm_do_vm_sg_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
328 struct drm_local_map *map = vma->vm_private_data;
329 struct drm_file *priv = vma->vm_file->private_data;
330 struct drm_device *dev = priv->minor->dev;
331 struct drm_sg_mem *entry = dev->sg;
332 unsigned long offset;
333 unsigned long map_offset;
334 unsigned long page_offset;
338 return VM_FAULT_SIGBUS; /* Error */
339 if (!entry->pagelist)
340 return VM_FAULT_SIGBUS; /* Nothing allocated */
342 offset = (unsigned long)vmf->virtual_address - vma->vm_start;
343 map_offset = map->offset - (unsigned long)dev->sg->virtual;
344 page_offset = (offset >> PAGE_SHIFT) + (map_offset >> PAGE_SHIFT);
345 page = entry->pagelist[page_offset];
352 static int drm_vm_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
354 return drm_do_vm_fault(vma, vmf);
357 static int drm_vm_shm_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
359 return drm_do_vm_shm_fault(vma, vmf);
362 static int drm_vm_dma_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
364 return drm_do_vm_dma_fault(vma, vmf);
367 static int drm_vm_sg_fault(struct vm_area_struct *vma, struct vm_fault *vmf)
369 return drm_do_vm_sg_fault(vma, vmf);
372 /** AGP virtual memory operations */
373 static const struct vm_operations_struct drm_vm_ops = {
374 .fault = drm_vm_fault,
376 .close = drm_vm_close,
379 /** Shared virtual memory operations */
380 static const struct vm_operations_struct drm_vm_shm_ops = {
381 .fault = drm_vm_shm_fault,
383 .close = drm_vm_shm_close,
386 /** DMA virtual memory operations */
387 static const struct vm_operations_struct drm_vm_dma_ops = {
388 .fault = drm_vm_dma_fault,
390 .close = drm_vm_close,
393 /** Scatter-gather virtual memory operations */
394 static const struct vm_operations_struct drm_vm_sg_ops = {
395 .fault = drm_vm_sg_fault,
397 .close = drm_vm_close,
401 * \c open method for shared virtual memory.
403 * \param vma virtual memory area.
405 * Create a new drm_vma_entry structure as the \p vma private data entry and
406 * add it to drm_device::vmalist.
408 void drm_vm_open_locked(struct vm_area_struct *vma)
410 struct drm_file *priv = vma->vm_file->private_data;
411 struct drm_device *dev = priv->minor->dev;
412 struct drm_vma_entry *vma_entry;
414 DRM_DEBUG("0x%08lx,0x%08lx\n",
415 vma->vm_start, vma->vm_end - vma->vm_start);
416 atomic_inc(&dev->vma_count);
418 vma_entry = kmalloc(sizeof(*vma_entry), GFP_KERNEL);
420 vma_entry->vma = vma;
421 vma_entry->pid = current->pid;
422 list_add(&vma_entry->head, &dev->vmalist);
426 static void drm_vm_open(struct vm_area_struct *vma)
428 struct drm_file *priv = vma->vm_file->private_data;
429 struct drm_device *dev = priv->minor->dev;
431 mutex_lock(&dev->struct_mutex);
432 drm_vm_open_locked(vma);
433 mutex_unlock(&dev->struct_mutex);
436 void drm_vm_close_locked(struct vm_area_struct *vma)
438 struct drm_file *priv = vma->vm_file->private_data;
439 struct drm_device *dev = priv->minor->dev;
440 struct drm_vma_entry *pt, *temp;
442 DRM_DEBUG("0x%08lx,0x%08lx\n",
443 vma->vm_start, vma->vm_end - vma->vm_start);
444 atomic_dec(&dev->vma_count);
446 list_for_each_entry_safe(pt, temp, &dev->vmalist, head) {
447 if (pt->vma == vma) {
456 * \c close method for all virtual memory types.
458 * \param vma virtual memory area.
460 * Search the \p vma private data entry in drm_device::vmalist, unlink it, and
463 static void drm_vm_close(struct vm_area_struct *vma)
465 struct drm_file *priv = vma->vm_file->private_data;
466 struct drm_device *dev = priv->minor->dev;
468 mutex_lock(&dev->struct_mutex);
469 drm_vm_close_locked(vma);
470 mutex_unlock(&dev->struct_mutex);
476 * \param file_priv DRM file private.
477 * \param vma virtual memory area.
478 * \return zero on success or a negative number on failure.
480 * Sets the virtual memory area operations structure to vm_dma_ops, the file
481 * pointer, and calls vm_open().
483 static int drm_mmap_dma(struct file *filp, struct vm_area_struct *vma)
485 struct drm_file *priv = filp->private_data;
486 struct drm_device *dev;
487 struct drm_device_dma *dma;
488 unsigned long length = vma->vm_end - vma->vm_start;
490 dev = priv->minor->dev;
492 DRM_DEBUG("start = 0x%lx, end = 0x%lx, page offset = 0x%lx\n",
493 vma->vm_start, vma->vm_end, vma->vm_pgoff);
495 /* Length must match exact page count */
496 if (!dma || (length >> PAGE_SHIFT) != dma->page_count) {
500 if (!capable(CAP_SYS_ADMIN) &&
501 (dma->flags & _DRM_DMA_USE_PCI_RO)) {
502 vma->vm_flags &= ~(VM_WRITE | VM_MAYWRITE);
503 #if defined(__i386__) || defined(__x86_64__)
504 pgprot_val(vma->vm_page_prot) &= ~_PAGE_RW;
506 /* Ye gads this is ugly. With more thought
507 we could move this up higher and use
508 `protection_map' instead. */
512 (__pte(pgprot_val(vma->vm_page_prot)))));
516 vma->vm_ops = &drm_vm_dma_ops;
518 vma->vm_flags |= VM_RESERVED; /* Don't swap */
519 vma->vm_flags |= VM_DONTEXPAND;
521 vma->vm_file = filp; /* Needed for drm_vm_open() */
522 drm_vm_open_locked(vma);
526 static resource_size_t drm_core_get_reg_ofs(struct drm_device *dev)
529 return dev->hose->dense_mem_base - dev->hose->mem_space->start;
538 * \param file_priv DRM file private.
539 * \param vma virtual memory area.
540 * \return zero on success or a negative number on failure.
542 * If the virtual memory area has no offset associated with it then it's a DMA
543 * area, so calls mmap_dma(). Otherwise searches the map in drm_device::maplist,
544 * checks that the restricted flag is not set, sets the virtual memory operations
545 * according to the mapping type and remaps the pages. Finally sets the file
546 * pointer and calls vm_open().
548 int drm_mmap_locked(struct file *filp, struct vm_area_struct *vma)
550 struct drm_file *priv = filp->private_data;
551 struct drm_device *dev = priv->minor->dev;
552 struct drm_local_map *map = NULL;
553 resource_size_t offset = 0;
554 struct drm_hash_item *hash;
556 DRM_DEBUG("start = 0x%lx, end = 0x%lx, page offset = 0x%lx\n",
557 vma->vm_start, vma->vm_end, vma->vm_pgoff);
559 if (!priv->authenticated)
562 /* We check for "dma". On Apple's UniNorth, it's valid to have
563 * the AGP mapped at physical address 0
569 || dev->agp->agp_info.device->vendor != PCI_VENDOR_ID_APPLE)
572 return drm_mmap_dma(filp, vma);
574 if (drm_ht_find_item(&dev->map_hash, vma->vm_pgoff, &hash)) {
575 DRM_ERROR("Could not find map\n");
579 map = drm_hash_entry(hash, struct drm_map_list, hash)->map;
580 if (!map || ((map->flags & _DRM_RESTRICTED) && !capable(CAP_SYS_ADMIN)))
583 /* Check for valid size. */
584 if (map->size < vma->vm_end - vma->vm_start)
587 if (!capable(CAP_SYS_ADMIN) && (map->flags & _DRM_READ_ONLY)) {
588 vma->vm_flags &= ~(VM_WRITE | VM_MAYWRITE);
589 #if defined(__i386__) || defined(__x86_64__)
590 pgprot_val(vma->vm_page_prot) &= ~_PAGE_RW;
592 /* Ye gads this is ugly. With more thought
593 we could move this up higher and use
594 `protection_map' instead. */
598 (__pte(pgprot_val(vma->vm_page_prot)))));
603 #if !defined(__arm__)
605 if (drm_core_has_AGP(dev) && dev->agp->cant_use_aperture) {
607 * On some platforms we can't talk to bus dma address from the CPU, so for
608 * memory of type DRM_AGP, we'll deal with sorting out the real physical
609 * pages and mappings in fault()
611 #if defined(__powerpc__)
612 pgprot_val(vma->vm_page_prot) |= _PAGE_NO_CACHE;
614 vma->vm_ops = &drm_vm_ops;
617 /* fall through to _DRM_FRAME_BUFFER... */
619 case _DRM_FRAME_BUFFER:
621 offset = drm_core_get_reg_ofs(dev);
622 vma->vm_flags |= VM_IO; /* not in core dump */
623 vma->vm_page_prot = drm_io_prot(map->type, vma);
624 #if !defined(__arm__)
625 if (io_remap_pfn_range(vma, vma->vm_start,
626 (map->offset + offset) >> PAGE_SHIFT,
627 vma->vm_end - vma->vm_start,
631 if (remap_pfn_range(vma, vma->vm_start,
632 (map->offset + offset) >> PAGE_SHIFT,
633 vma->vm_end - vma->vm_start,
638 DRM_DEBUG(" Type = %d; start = 0x%lx, end = 0x%lx,"
639 " offset = 0x%llx\n",
641 vma->vm_start, vma->vm_end, (unsigned long long)(map->offset + offset));
643 vma->vm_ops = &drm_vm_ops;
645 case _DRM_CONSISTENT:
646 /* Consistent memory is really like shared memory. But
647 * it's allocated in a different way, so avoid fault */
648 if (remap_pfn_range(vma, vma->vm_start,
649 page_to_pfn(virt_to_page(map->handle)),
650 vma->vm_end - vma->vm_start, vma->vm_page_prot))
652 vma->vm_page_prot = drm_dma_prot(map->type, vma);
653 /* fall through to _DRM_SHM */
655 vma->vm_ops = &drm_vm_shm_ops;
656 vma->vm_private_data = (void *)map;
657 /* Don't let this area swap. Change when
658 DRM_KERNEL advisory is supported. */
659 vma->vm_flags |= VM_RESERVED;
661 case _DRM_SCATTER_GATHER:
662 vma->vm_ops = &drm_vm_sg_ops;
663 vma->vm_private_data = (void *)map;
664 vma->vm_flags |= VM_RESERVED;
665 vma->vm_page_prot = drm_dma_prot(map->type, vma);
668 return -EINVAL; /* This should never happen. */
670 vma->vm_flags |= VM_RESERVED; /* Don't swap */
671 vma->vm_flags |= VM_DONTEXPAND;
673 vma->vm_file = filp; /* Needed for drm_vm_open() */
674 drm_vm_open_locked(vma);
678 int drm_mmap(struct file *filp, struct vm_area_struct *vma)
680 struct drm_file *priv = filp->private_data;
681 struct drm_device *dev = priv->minor->dev;
684 mutex_lock(&dev->struct_mutex);
685 ret = drm_mmap_locked(filp, vma);
686 mutex_unlock(&dev->struct_mutex);
690 EXPORT_SYMBOL(drm_mmap);