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
++;
215 case _DRM_FRAME_BUFFER
:
216 if (drm_core_has_MTRR(dev
) && map
->mtrr
>= 0) {
218 retcode
= mtrr_del(map
->mtrr
,
221 DRM_DEBUG("mtrr_del = %d\n", retcode
);
223 drm_ioremapfree(map
->handle
, map
->size
, dev
);
229 case _DRM_SCATTER_GATHER
:
231 case _DRM_CONSISTENT
:
232 drm_pci_free(dev
, map
->size
, map
->handle
,
236 drm_free(map
, sizeof(*map
), DRM_MEM_MAPS
);
239 up(&dev
->struct_sem
);
243 * \c nopage method for DMA virtual memory.
245 * \param vma virtual memory area.
246 * \param address access address.
247 * \return pointer to the page structure.
249 * Determine the page number from the page offset and get it from drm_device_dma::pagelist.
251 static __inline__
struct page
*drm_do_vm_dma_nopage(struct vm_area_struct
*vma
,
252 unsigned long address
)
254 drm_file_t
*priv
= vma
->vm_file
->private_data
;
255 drm_device_t
*dev
= priv
->head
->dev
;
256 drm_device_dma_t
*dma
= dev
->dma
;
257 unsigned long offset
;
258 unsigned long page_nr
;
261 if (!dma
) return NOPAGE_SIGBUS
; /* Error */
262 if (address
> vma
->vm_end
) return NOPAGE_SIGBUS
; /* Disallow mremap */
263 if (!dma
->pagelist
) return NOPAGE_OOM
; /* Nothing allocated */
265 offset
= address
- vma
->vm_start
; /* vm_[pg]off[set] should be 0 */
266 page_nr
= offset
>> PAGE_SHIFT
;
267 page
= virt_to_page((dma
->pagelist
[page_nr
] +
268 (offset
& (~PAGE_MASK
))));
272 DRM_DEBUG("dma_nopage 0x%lx (page %lu)\n", address
, page_nr
);
277 * \c nopage method for scatter-gather virtual memory.
279 * \param vma virtual memory area.
280 * \param address access address.
281 * \return pointer to the page structure.
283 * Determine the map offset from the page offset and get it from drm_sg_mem::pagelist.
285 static __inline__
struct page
*drm_do_vm_sg_nopage(struct vm_area_struct
*vma
,
286 unsigned long address
)
288 drm_map_t
*map
= (drm_map_t
*)vma
->vm_private_data
;
289 drm_file_t
*priv
= vma
->vm_file
->private_data
;
290 drm_device_t
*dev
= priv
->head
->dev
;
291 drm_sg_mem_t
*entry
= dev
->sg
;
292 unsigned long offset
;
293 unsigned long map_offset
;
294 unsigned long page_offset
;
297 if (!entry
) return NOPAGE_SIGBUS
; /* Error */
298 if (address
> vma
->vm_end
) return NOPAGE_SIGBUS
; /* Disallow mremap */
299 if (!entry
->pagelist
) return NOPAGE_OOM
; /* Nothing allocated */
302 offset
= address
- vma
->vm_start
;
303 map_offset
= map
->offset
- dev
->sg
->handle
;
304 page_offset
= (offset
>> PAGE_SHIFT
) + (map_offset
>> PAGE_SHIFT
);
305 page
= entry
->pagelist
[page_offset
];
312 #if LINUX_VERSION_CODE > KERNEL_VERSION(2,6,0)
314 static struct page
*drm_vm_nopage(struct vm_area_struct
*vma
,
315 unsigned long address
,
317 if (type
) *type
= VM_FAULT_MINOR
;
318 return drm_do_vm_nopage(vma
, address
);
321 static struct page
*drm_vm_shm_nopage(struct vm_area_struct
*vma
,
322 unsigned long address
,
324 if (type
) *type
= VM_FAULT_MINOR
;
325 return drm_do_vm_shm_nopage(vma
, address
);
328 static struct page
*drm_vm_dma_nopage(struct vm_area_struct
*vma
,
329 unsigned long address
,
331 if (type
) *type
= VM_FAULT_MINOR
;
332 return drm_do_vm_dma_nopage(vma
, address
);
335 static struct page
*drm_vm_sg_nopage(struct vm_area_struct
*vma
,
336 unsigned long address
,
338 if (type
) *type
= VM_FAULT_MINOR
;
339 return drm_do_vm_sg_nopage(vma
, address
);
342 #else /* LINUX_VERSION_CODE <= KERNEL_VERSION(2,6,0) */
344 static struct page
*drm_vm_nopage(struct vm_area_struct
*vma
,
345 unsigned long address
,
347 return drm_do_vm_nopage(vma
, address
);
350 static struct page
*drm_vm_shm_nopage(struct vm_area_struct
*vma
,
351 unsigned long address
,
353 return drm_do_vm_shm_nopage(vma
, address
);
356 static struct page
*drm_vm_dma_nopage(struct vm_area_struct
*vma
,
357 unsigned long address
,
359 return drm_do_vm_dma_nopage(vma
, address
);
362 static struct page
*drm_vm_sg_nopage(struct vm_area_struct
*vma
,
363 unsigned long address
,
365 return drm_do_vm_sg_nopage(vma
, address
);
371 /** AGP virtual memory operations */
372 static struct vm_operations_struct drm_vm_ops
= {
373 .nopage
= drm_vm_nopage
,
375 .close
= drm_vm_close
,
378 /** Shared virtual memory operations */
379 static struct vm_operations_struct drm_vm_shm_ops
= {
380 .nopage
= drm_vm_shm_nopage
,
382 .close
= drm_vm_shm_close
,
385 /** DMA virtual memory operations */
386 static struct vm_operations_struct drm_vm_dma_ops
= {
387 .nopage
= drm_vm_dma_nopage
,
389 .close
= drm_vm_close
,
392 /** Scatter-gather virtual memory operations */
393 static struct vm_operations_struct drm_vm_sg_ops
= {
394 .nopage
= drm_vm_sg_nopage
,
396 .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 static void drm_vm_open(struct vm_area_struct
*vma
)
410 drm_file_t
*priv
= vma
->vm_file
->private_data
;
411 drm_device_t
*dev
= priv
->head
->dev
;
412 drm_vma_entry_t
*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
= drm_alloc(sizeof(*vma_entry
), DRM_MEM_VMAS
);
420 down(&dev
->struct_sem
);
421 vma_entry
->vma
= vma
;
422 vma_entry
->next
= dev
->vmalist
;
423 vma_entry
->pid
= current
->pid
;
424 dev
->vmalist
= vma_entry
;
425 up(&dev
->struct_sem
);
430 * \c close method for all virtual memory types.
432 * \param vma virtual memory area.
434 * Search the \p vma private data entry in drm_device::vmalist, unlink it, and
437 static void drm_vm_close(struct vm_area_struct
*vma
)
439 drm_file_t
*priv
= vma
->vm_file
->private_data
;
440 drm_device_t
*dev
= priv
->head
->dev
;
441 drm_vma_entry_t
*pt
, *prev
;
443 DRM_DEBUG("0x%08lx,0x%08lx\n",
444 vma
->vm_start
, vma
->vm_end
- vma
->vm_start
);
445 atomic_dec(&dev
->vma_count
);
447 down(&dev
->struct_sem
);
448 for (pt
= dev
->vmalist
, prev
= NULL
; pt
; prev
= pt
, pt
= pt
->next
) {
449 if (pt
->vma
== vma
) {
451 prev
->next
= pt
->next
;
453 dev
->vmalist
= pt
->next
;
455 drm_free(pt
, sizeof(*pt
), DRM_MEM_VMAS
);
459 up(&dev
->struct_sem
);
465 * \param filp file pointer.
466 * \param vma virtual memory area.
467 * \return zero on success or a negative number on failure.
469 * Sets the virtual memory area operations structure to vm_dma_ops, the file
470 * pointer, and calls vm_open().
472 static int drm_mmap_dma(struct file
*filp
, struct vm_area_struct
*vma
)
474 drm_file_t
*priv
= filp
->private_data
;
476 drm_device_dma_t
*dma
;
477 unsigned long length
= vma
->vm_end
- vma
->vm_start
;
480 dev
= priv
->head
->dev
;
482 DRM_DEBUG("start = 0x%lx, end = 0x%lx, offset = 0x%lx\n",
483 vma
->vm_start
, vma
->vm_end
, VM_OFFSET(vma
));
485 /* Length must match exact page count */
486 if (!dma
|| (length
>> PAGE_SHIFT
) != dma
->page_count
) {
492 vma
->vm_ops
= &drm_vm_dma_ops
;
494 #if LINUX_VERSION_CODE <= 0x02040e /* KERNEL_VERSION(2,4,14) */
495 vma
->vm_flags
|= VM_LOCKED
| VM_SHM
; /* Don't swap */
497 vma
->vm_flags
|= VM_RESERVED
; /* Don't swap */
500 vma
->vm_file
= filp
; /* Needed for drm_vm_open() */
505 unsigned long drm_core_get_map_ofs(drm_map_t
*map
)
509 EXPORT_SYMBOL(drm_core_get_map_ofs
);
511 unsigned long drm_core_get_reg_ofs(struct drm_device
*dev
)
514 return dev
->hose
->dense_mem_base
- dev
->hose
->mem_space
->start
;
519 EXPORT_SYMBOL(drm_core_get_reg_ofs
);
524 * \param filp file pointer.
525 * \param vma virtual memory area.
526 * \return zero on success or a negative number on failure.
528 * If the virtual memory area has no offset associated with it then it's a DMA
529 * area, so calls mmap_dma(). Otherwise searches the map in drm_device::maplist,
530 * checks that the restricted flag is not set, sets the virtual memory operations
531 * according to the mapping type and remaps the pages. Finally sets the file
532 * pointer and calls vm_open().
534 int drm_mmap(struct file
*filp
, struct vm_area_struct
*vma
)
536 drm_file_t
*priv
= filp
->private_data
;
537 drm_device_t
*dev
= priv
->head
->dev
;
538 drm_map_t
*map
= NULL
;
539 drm_map_list_t
*r_list
;
540 unsigned long offset
= 0;
541 struct list_head
*list
;
543 DRM_DEBUG("start = 0x%lx, end = 0x%lx, offset = 0x%lx\n",
544 vma
->vm_start
, vma
->vm_end
, VM_OFFSET(vma
));
546 if ( !priv
->authenticated
) return -EACCES
;
548 /* We check for "dma". On Apple's UniNorth, it's valid to have
549 * the AGP mapped at physical address 0
554 && (!dev
->agp
|| dev
->agp
->agp_info
.device
->vendor
!= PCI_VENDOR_ID_APPLE
)
557 return drm_mmap_dma(filp
, vma
);
559 /* A sequential search of a linked list is
560 fine here because: 1) there will only be
561 about 5-10 entries in the list and, 2) a
562 DRI client only has to do this mapping
563 once, so it doesn't have to be optimized
564 for performance, even if the list was a
566 list_for_each(list
, &dev
->maplist
->head
) {
569 r_list
= list_entry(list
, drm_map_list_t
, head
);
572 off
= dev
->driver
->get_map_ofs(map
);
573 if (off
== VM_OFFSET(vma
)) break;
576 if (!map
|| ((map
->flags
&_DRM_RESTRICTED
) && !capable(CAP_SYS_ADMIN
)))
579 /* Check for valid size. */
580 if (map
->size
!= vma
->vm_end
- vma
->vm_start
) return -EINVAL
;
582 if (!capable(CAP_SYS_ADMIN
) && (map
->flags
& _DRM_READ_ONLY
)) {
583 vma
->vm_flags
&= ~(VM_WRITE
| VM_MAYWRITE
);
584 #if defined(__i386__) || defined(__x86_64__)
585 pgprot_val(vma
->vm_page_prot
) &= ~_PAGE_RW
;
587 /* Ye gads this is ugly. With more thought
588 we could move this up higher and use
589 `protection_map' instead. */
590 vma
->vm_page_prot
= __pgprot(pte_val(pte_wrprotect(
591 __pte(pgprot_val(vma
->vm_page_prot
)))));
597 if (drm_core_has_AGP(dev
) && dev
->agp
->cant_use_aperture
) {
599 * On some platforms we can't talk to bus dma address from the CPU, so for
600 * memory of type DRM_AGP, we'll deal with sorting out the real physical
601 * pages and mappings in nopage()
603 #if defined(__powerpc__)
604 pgprot_val(vma
->vm_page_prot
) |= _PAGE_NO_CACHE
;
606 vma
->vm_ops
= &drm_vm_ops
;
609 /* fall through to _DRM_FRAME_BUFFER... */
610 case _DRM_FRAME_BUFFER
:
612 if (VM_OFFSET(vma
) >= __pa(high_memory
)) {
613 #if defined(__i386__) || defined(__x86_64__)
614 if (boot_cpu_data
.x86
> 3 && map
->type
!= _DRM_AGP
) {
615 pgprot_val(vma
->vm_page_prot
) |= _PAGE_PCD
;
616 pgprot_val(vma
->vm_page_prot
) &= ~_PAGE_PWT
;
618 #elif defined(__powerpc__)
619 pgprot_val(vma
->vm_page_prot
) |= _PAGE_NO_CACHE
| _PAGE_GUARDED
;
621 vma
->vm_flags
|= VM_IO
; /* not in core dump */
623 #if defined(__ia64__)
624 if (efi_range_is_wc(vma
->vm_start
, vma
->vm_end
-
627 pgprot_writecombine(vma
->vm_page_prot
);
630 pgprot_noncached(vma
->vm_page_prot
);
632 offset
= dev
->driver
->get_reg_ofs(dev
);
634 if (io_remap_pfn_range(DRM_RPR_ARG(vma
) vma
->vm_start
,
635 (VM_OFFSET(vma
) + offset
) >> PAGE_SHIFT
,
636 vma
->vm_end
- vma
->vm_start
,
639 if (io_remap_pfn_range(vma
, vma
->vm_start
,
640 (VM_OFFSET(vma
) + offset
) >> PAGE_SHIFT
,
641 vma
->vm_end
- vma
->vm_start
,
645 DRM_DEBUG(" Type = %d; start = 0x%lx, end = 0x%lx,"
648 vma
->vm_start
, vma
->vm_end
, VM_OFFSET(vma
) + offset
);
649 vma
->vm_ops
= &drm_vm_ops
;
652 case _DRM_CONSISTENT
:
653 /* Consistent memory is really like shared memory. It's only
654 * allocate in a different way */
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 #if LINUX_VERSION_CODE <= 0x02040e /* KERNEL_VERSION(2,4,14) */
660 vma
->vm_flags
|= VM_LOCKED
;
662 vma
->vm_flags
|= VM_RESERVED
;
665 case _DRM_SCATTER_GATHER
:
666 vma
->vm_ops
= &drm_vm_sg_ops
;
667 vma
->vm_private_data
= (void *)map
;
668 #if LINUX_VERSION_CODE <= 0x02040e /* KERNEL_VERSION(2,4,14) */
669 vma
->vm_flags
|= VM_LOCKED
;
671 vma
->vm_flags
|= VM_RESERVED
;
675 return -EINVAL
; /* This should never happen. */
677 #if LINUX_VERSION_CODE <= 0x02040e /* KERNEL_VERSION(2,4,14) */
678 vma
->vm_flags
|= VM_LOCKED
| VM_SHM
; /* Don't swap */
680 vma
->vm_flags
|= VM_RESERVED
; /* Don't swap */
683 vma
->vm_file
= filp
; /* Needed for drm_vm_open() */
687 EXPORT_SYMBOL(drm_mmap
);