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>
41 static void drm_vm_open(struct vm_area_struct *vma);
42 static void drm_vm_close(struct vm_area_struct *vma);
45 * \c nopage method for AGP virtual memory.
47 * \param vma virtual memory area.
48 * \param address access address.
49 * \return pointer to the page structure.
51 * Find the right map and if it's AGP memory find the real physical page to
52 * map, get the page, increment the use count and return it.
55 static __inline__ struct page *drm_do_vm_nopage(struct vm_area_struct *vma,
56 unsigned long address)
58 drm_file_t *priv = vma->vm_file->private_data;
59 drm_device_t *dev = priv->head->dev;
60 drm_map_t *map = NULL;
61 drm_map_list_t *r_list;
62 struct list_head *list;
67 if (!drm_core_has_AGP(dev))
70 if(!dev->agp || !dev->agp->cant_use_aperture) goto vm_nopage_error;
72 list_for_each(list, &dev->maplist->head) {
73 r_list = list_entry(list, drm_map_list_t, head);
76 if (map->offset == VM_OFFSET(vma)) break;
79 if (map && map->type == _DRM_AGP) {
80 unsigned long offset = address - vma->vm_start;
81 unsigned long baddr = VM_OFFSET(vma) + offset;
82 struct drm_agp_mem *agpmem;
87 * Adjust to a bus-relative address
89 baddr -= dev->hose->mem_space->start;
93 * It's AGP memory - find the real physical page to map
95 for(agpmem = dev->agp->memory; agpmem; agpmem = agpmem->next) {
96 if (agpmem->bound <= baddr &&
97 agpmem->bound + agpmem->pages * PAGE_SIZE > baddr)
101 if (!agpmem) goto vm_nopage_error;
104 * Get the page, inc the use count, and return it
106 offset = (baddr - agpmem->bound) >> PAGE_SHIFT;
107 page = virt_to_page(__va(agpmem->memory->memory[offset]));
110 DRM_DEBUG("baddr = 0x%lx page = 0x%p, offset = 0x%lx, count=%d\n",
111 baddr, __va(agpmem->memory->memory[offset]), offset,
117 return NOPAGE_SIGBUS; /* Disallow mremap */
119 #else /* __OS_HAS_AGP */
120 static __inline__ struct page *drm_do_vm_nopage(struct vm_area_struct *vma,
121 unsigned long address)
123 return NOPAGE_SIGBUS;
125 #endif /* __OS_HAS_AGP */
128 * \c nopage method for shared virtual memory.
130 * \param vma virtual memory area.
131 * \param address access address.
132 * \return pointer to the page structure.
134 * Get the the mapping, find the real physical page to map, get the page, and
137 static __inline__ struct page *drm_do_vm_shm_nopage(struct vm_area_struct *vma,
138 unsigned long address)
140 drm_map_t *map = (drm_map_t *)vma->vm_private_data;
141 unsigned long offset;
145 if (address > vma->vm_end) return NOPAGE_SIGBUS; /* Disallow mremap */
146 if (!map) return NOPAGE_OOM; /* Nothing allocated */
148 offset = address - vma->vm_start;
149 i = (unsigned long)map->handle + offset;
150 page = vmalloc_to_page((void *)i);
155 DRM_DEBUG("shm_nopage 0x%lx\n", address);
161 * \c close method for shared virtual memory.
163 * \param vma virtual memory area.
165 * Deletes map information if we are the last
166 * person to close a mapping and it's not in the global maplist.
168 static void drm_vm_shm_close(struct vm_area_struct *vma)
170 drm_file_t *priv = vma->vm_file->private_data;
171 drm_device_t *dev = priv->head->dev;
172 drm_vma_entry_t *pt, *prev, *next;
174 drm_map_list_t *r_list;
175 struct list_head *list;
178 DRM_DEBUG("0x%08lx,0x%08lx\n",
179 vma->vm_start, vma->vm_end - vma->vm_start);
180 atomic_dec(&dev->vma_count);
182 map = vma->vm_private_data;
184 down(&dev->struct_sem);
185 for (pt = dev->vmalist, prev = NULL; pt; pt = next) {
187 if (pt->vma->vm_private_data == map) found_maps++;
188 if (pt->vma == vma) {
190 prev->next = pt->next;
192 dev->vmalist = pt->next;
194 drm_free(pt, sizeof(*pt), DRM_MEM_VMAS);
199 /* We were the only map that was found */
200 if(found_maps == 1 &&
201 map->flags & _DRM_REMOVABLE) {
202 /* Check to see if we are in the maplist, if we are not, then
203 * we delete this mappings information.
206 list = &dev->maplist->head;
207 list_for_each(list, &dev->maplist->head) {
208 r_list = list_entry(list, drm_map_list_t, head);
209 if (r_list->map == map) found_maps++;
213 drm_dma_handle_t dmah;
217 case _DRM_FRAME_BUFFER:
218 if (drm_core_has_MTRR(dev) && map->mtrr >= 0) {
220 retcode = mtrr_del(map->mtrr,
223 DRM_DEBUG("mtrr_del = %d\n", retcode);
225 drm_ioremapfree(map->handle, map->size, dev);
231 case _DRM_SCATTER_GATHER:
233 case _DRM_CONSISTENT:
234 dmah.vaddr = map->handle;
235 dmah.busaddr = map->offset;
236 dmah.size = map->size;
237 __drm_pci_free(dev, &dmah);
240 drm_free(map, sizeof(*map), DRM_MEM_MAPS);
243 up(&dev->struct_sem);
247 * \c nopage method for DMA virtual memory.
249 * \param vma virtual memory area.
250 * \param address access address.
251 * \return pointer to the page structure.
253 * Determine the page number from the page offset and get it from drm_device_dma::pagelist.
255 static __inline__ struct page *drm_do_vm_dma_nopage(struct vm_area_struct *vma,
256 unsigned long address)
258 drm_file_t *priv = vma->vm_file->private_data;
259 drm_device_t *dev = priv->head->dev;
260 drm_device_dma_t *dma = dev->dma;
261 unsigned long offset;
262 unsigned long page_nr;
265 if (!dma) return NOPAGE_SIGBUS; /* Error */
266 if (address > vma->vm_end) return NOPAGE_SIGBUS; /* Disallow mremap */
267 if (!dma->pagelist) return NOPAGE_OOM ; /* Nothing allocated */
269 offset = address - vma->vm_start; /* vm_[pg]off[set] should be 0 */
270 page_nr = offset >> PAGE_SHIFT;
271 page = virt_to_page((dma->pagelist[page_nr] +
272 (offset & (~PAGE_MASK))));
276 DRM_DEBUG("dma_nopage 0x%lx (page %lu)\n", address, page_nr);
281 * \c nopage method for scatter-gather virtual memory.
283 * \param vma virtual memory area.
284 * \param address access address.
285 * \return pointer to the page structure.
287 * Determine the map offset from the page offset and get it from drm_sg_mem::pagelist.
289 static __inline__ struct page *drm_do_vm_sg_nopage(struct vm_area_struct *vma,
290 unsigned long address)
292 drm_map_t *map = (drm_map_t *)vma->vm_private_data;
293 drm_file_t *priv = vma->vm_file->private_data;
294 drm_device_t *dev = priv->head->dev;
295 drm_sg_mem_t *entry = dev->sg;
296 unsigned long offset;
297 unsigned long map_offset;
298 unsigned long page_offset;
301 if (!entry) return NOPAGE_SIGBUS; /* Error */
302 if (address > vma->vm_end) return NOPAGE_SIGBUS; /* Disallow mremap */
303 if (!entry->pagelist) return NOPAGE_OOM ; /* Nothing allocated */
306 offset = address - vma->vm_start;
307 map_offset = map->offset - dev->sg->handle;
308 page_offset = (offset >> PAGE_SHIFT) + (map_offset >> PAGE_SHIFT);
309 page = entry->pagelist[page_offset];
316 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,0)
318 static struct page *drm_vm_nopage(struct vm_area_struct *vma,
319 unsigned long address,
321 if (type) *type = VM_FAULT_MINOR;
322 return drm_do_vm_nopage(vma, address);
325 static struct page *drm_vm_shm_nopage(struct vm_area_struct *vma,
326 unsigned long address,
328 if (type) *type = VM_FAULT_MINOR;
329 return drm_do_vm_shm_nopage(vma, address);
332 static struct page *drm_vm_dma_nopage(struct vm_area_struct *vma,
333 unsigned long address,
335 if (type) *type = VM_FAULT_MINOR;
336 return drm_do_vm_dma_nopage(vma, address);
339 static struct page *drm_vm_sg_nopage(struct vm_area_struct *vma,
340 unsigned long address,
342 if (type) *type = VM_FAULT_MINOR;
343 return drm_do_vm_sg_nopage(vma, address);
346 #else /* LINUX_VERSION_CODE <= KERNEL_VERSION(2,6,0) */
348 static struct page *drm_vm_nopage(struct vm_area_struct *vma,
349 unsigned long address,
351 return drm_do_vm_nopage(vma, address);
354 static struct page *drm_vm_shm_nopage(struct vm_area_struct *vma,
355 unsigned long address,
357 return drm_do_vm_shm_nopage(vma, address);
360 static struct page *drm_vm_dma_nopage(struct vm_area_struct *vma,
361 unsigned long address,
363 return drm_do_vm_dma_nopage(vma, address);
366 static struct page *drm_vm_sg_nopage(struct vm_area_struct *vma,
367 unsigned long address,
369 return drm_do_vm_sg_nopage(vma, address);
375 /** AGP virtual memory operations */
376 static struct vm_operations_struct drm_vm_ops = {
377 .nopage = drm_vm_nopage,
379 .close = drm_vm_close,
382 /** Shared virtual memory operations */
383 static struct vm_operations_struct drm_vm_shm_ops = {
384 .nopage = drm_vm_shm_nopage,
386 .close = drm_vm_shm_close,
389 /** DMA virtual memory operations */
390 static struct vm_operations_struct drm_vm_dma_ops = {
391 .nopage = drm_vm_dma_nopage,
393 .close = drm_vm_close,
396 /** Scatter-gather virtual memory operations */
397 static struct vm_operations_struct drm_vm_sg_ops = {
398 .nopage = drm_vm_sg_nopage,
400 .close = drm_vm_close,
405 * \c open method for shared virtual memory.
407 * \param vma virtual memory area.
409 * Create a new drm_vma_entry structure as the \p vma private data entry and
410 * add it to drm_device::vmalist.
412 static void drm_vm_open(struct vm_area_struct *vma)
414 drm_file_t *priv = vma->vm_file->private_data;
415 drm_device_t *dev = priv->head->dev;
416 drm_vma_entry_t *vma_entry;
418 DRM_DEBUG("0x%08lx,0x%08lx\n",
419 vma->vm_start, vma->vm_end - vma->vm_start);
420 atomic_inc(&dev->vma_count);
422 vma_entry = drm_alloc(sizeof(*vma_entry), DRM_MEM_VMAS);
424 down(&dev->struct_sem);
425 vma_entry->vma = vma;
426 vma_entry->next = dev->vmalist;
427 vma_entry->pid = current->pid;
428 dev->vmalist = vma_entry;
429 up(&dev->struct_sem);
434 * \c close method for all virtual memory types.
436 * \param vma virtual memory area.
438 * Search the \p vma private data entry in drm_device::vmalist, unlink it, and
441 static void drm_vm_close(struct vm_area_struct *vma)
443 drm_file_t *priv = vma->vm_file->private_data;
444 drm_device_t *dev = priv->head->dev;
445 drm_vma_entry_t *pt, *prev;
447 DRM_DEBUG("0x%08lx,0x%08lx\n",
448 vma->vm_start, vma->vm_end - vma->vm_start);
449 atomic_dec(&dev->vma_count);
451 down(&dev->struct_sem);
452 for (pt = dev->vmalist, prev = NULL; pt; prev = pt, pt = pt->next) {
453 if (pt->vma == vma) {
455 prev->next = pt->next;
457 dev->vmalist = pt->next;
459 drm_free(pt, sizeof(*pt), DRM_MEM_VMAS);
463 up(&dev->struct_sem);
469 * \param filp file pointer.
470 * \param vma virtual memory area.
471 * \return zero on success or a negative number on failure.
473 * Sets the virtual memory area operations structure to vm_dma_ops, the file
474 * pointer, and calls vm_open().
476 static int drm_mmap_dma(struct file *filp, struct vm_area_struct *vma)
478 drm_file_t *priv = filp->private_data;
480 drm_device_dma_t *dma;
481 unsigned long length = vma->vm_end - vma->vm_start;
484 dev = priv->head->dev;
486 DRM_DEBUG("start = 0x%lx, end = 0x%lx, offset = 0x%lx\n",
487 vma->vm_start, vma->vm_end, VM_OFFSET(vma));
489 /* Length must match exact page count */
490 if (!dma || (length >> PAGE_SHIFT) != dma->page_count) {
496 vma->vm_ops = &drm_vm_dma_ops;
498 #if LINUX_VERSION_CODE <= 0x02040e /* KERNEL_VERSION(2,4,14) */
499 vma->vm_flags |= VM_LOCKED | VM_SHM; /* Don't swap */
501 vma->vm_flags |= VM_RESERVED; /* Don't swap */
504 vma->vm_file = filp; /* Needed for drm_vm_open() */
509 unsigned long drm_core_get_map_ofs(drm_map_t *map)
513 EXPORT_SYMBOL(drm_core_get_map_ofs);
515 unsigned long drm_core_get_reg_ofs(struct drm_device *dev)
518 return dev->hose->dense_mem_base - dev->hose->mem_space->start;
523 EXPORT_SYMBOL(drm_core_get_reg_ofs);
528 * \param filp file pointer.
529 * \param vma virtual memory area.
530 * \return zero on success or a negative number on failure.
532 * If the virtual memory area has no offset associated with it then it's a DMA
533 * area, so calls mmap_dma(). Otherwise searches the map in drm_device::maplist,
534 * checks that the restricted flag is not set, sets the virtual memory operations
535 * according to the mapping type and remaps the pages. Finally sets the file
536 * pointer and calls vm_open().
538 int drm_mmap(struct file *filp, struct vm_area_struct *vma)
540 drm_file_t *priv = filp->private_data;
541 drm_device_t *dev = priv->head->dev;
542 drm_map_t *map = NULL;
543 drm_map_list_t *r_list;
544 unsigned long offset = 0;
545 struct list_head *list;
547 DRM_DEBUG("start = 0x%lx, end = 0x%lx, offset = 0x%lx\n",
548 vma->vm_start, vma->vm_end, VM_OFFSET(vma));
550 if ( !priv->authenticated ) return -EACCES;
552 /* We check for "dma". On Apple's UniNorth, it's valid to have
553 * the AGP mapped at physical address 0
558 && (!dev->agp || dev->agp->agp_info.device->vendor != PCI_VENDOR_ID_APPLE)
561 return drm_mmap_dma(filp, vma);
563 /* A sequential search of a linked list is
564 fine here because: 1) there will only be
565 about 5-10 entries in the list and, 2) a
566 DRI client only has to do this mapping
567 once, so it doesn't have to be optimized
568 for performance, even if the list was a
570 list_for_each(list, &dev->maplist->head) {
573 r_list = list_entry(list, drm_map_list_t, head);
576 off = dev->driver->get_map_ofs(map);
577 if (off == VM_OFFSET(vma)) break;
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) return -EINVAL;
586 if (!capable(CAP_SYS_ADMIN) && (map->flags & _DRM_READ_ONLY)) {
587 vma->vm_flags &= ~(VM_WRITE | VM_MAYWRITE);
588 #if defined(__i386__) || defined(__x86_64__)
589 pgprot_val(vma->vm_page_prot) &= ~_PAGE_RW;
591 /* Ye gads this is ugly. With more thought
592 we could move this up higher and use
593 `protection_map' instead. */
594 vma->vm_page_prot = __pgprot(pte_val(pte_wrprotect(
595 __pte(pgprot_val(vma->vm_page_prot)))));
601 if (drm_core_has_AGP(dev) && dev->agp->cant_use_aperture) {
603 * On some platforms we can't talk to bus dma address from the CPU, so for
604 * memory of type DRM_AGP, we'll deal with sorting out the real physical
605 * pages and mappings in nopage()
607 #if defined(__powerpc__)
608 pgprot_val(vma->vm_page_prot) |= _PAGE_NO_CACHE;
610 vma->vm_ops = &drm_vm_ops;
613 /* fall through to _DRM_FRAME_BUFFER... */
614 case _DRM_FRAME_BUFFER:
616 if (VM_OFFSET(vma) >= __pa(high_memory)) {
617 #if defined(__i386__) || defined(__x86_64__)
618 if (boot_cpu_data.x86 > 3 && map->type != _DRM_AGP) {
619 pgprot_val(vma->vm_page_prot) |= _PAGE_PCD;
620 pgprot_val(vma->vm_page_prot) &= ~_PAGE_PWT;
622 #elif defined(__powerpc__)
623 pgprot_val(vma->vm_page_prot) |= _PAGE_NO_CACHE | _PAGE_GUARDED;
625 vma->vm_flags |= VM_IO; /* not in core dump */
627 #if defined(__ia64__)
628 if (efi_range_is_wc(vma->vm_start, vma->vm_end -
631 pgprot_writecombine(vma->vm_page_prot);
634 pgprot_noncached(vma->vm_page_prot);
636 offset = dev->driver->get_reg_ofs(dev);
638 if (io_remap_pfn_range(DRM_RPR_ARG(vma) vma->vm_start,
639 (VM_OFFSET(vma) + offset) >> PAGE_SHIFT,
640 vma->vm_end - vma->vm_start,
643 if (io_remap_pfn_range(vma, vma->vm_start,
644 (VM_OFFSET(vma) + offset) >> PAGE_SHIFT,
645 vma->vm_end - vma->vm_start,
649 DRM_DEBUG(" Type = %d; start = 0x%lx, end = 0x%lx,"
652 vma->vm_start, vma->vm_end, VM_OFFSET(vma) + offset);
653 vma->vm_ops = &drm_vm_ops;
656 case _DRM_CONSISTENT:
657 /* Consistent memory is really like shared memory. It's only
658 * allocate in a different way */
659 vma->vm_ops = &drm_vm_shm_ops;
660 vma->vm_private_data = (void *)map;
661 /* Don't let this area swap. Change when
662 DRM_KERNEL advisory is supported. */
663 #if LINUX_VERSION_CODE <= 0x02040e /* KERNEL_VERSION(2,4,14) */
664 vma->vm_flags |= VM_LOCKED;
666 vma->vm_flags |= VM_RESERVED;
669 case _DRM_SCATTER_GATHER:
670 vma->vm_ops = &drm_vm_sg_ops;
671 vma->vm_private_data = (void *)map;
672 #if LINUX_VERSION_CODE <= 0x02040e /* KERNEL_VERSION(2,4,14) */
673 vma->vm_flags |= VM_LOCKED;
675 vma->vm_flags |= VM_RESERVED;
679 return -EINVAL; /* This should never happen. */
681 #if LINUX_VERSION_CODE <= 0x02040e /* KERNEL_VERSION(2,4,14) */
682 vma->vm_flags |= VM_LOCKED | VM_SHM; /* Don't swap */
684 vma->vm_flags |= VM_RESERVED; /* Don't swap */
687 vma->vm_file = filp; /* Needed for drm_vm_open() */
691 EXPORT_SYMBOL(drm_mmap);