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.
37 #include <linux/export.h>
39 #include <linux/efi.h>
40 #include <linux/slab.h>
43 static void drm_vm_open(struct vm_area_struct
*vma
);
44 static void drm_vm_close(struct vm_area_struct
*vma
);
46 static pgprot_t
drm_io_prot(struct drm_local_map
*map
,
47 struct vm_area_struct
*vma
)
49 pgprot_t tmp
= vm_get_page_prot(vma
->vm_flags
);
51 #if defined(__i386__) || defined(__x86_64__)
52 if (map
->type
== _DRM_REGISTERS
&& !(map
->flags
& _DRM_WRITE_COMBINING
))
53 tmp
= pgprot_noncached(tmp
);
55 tmp
= pgprot_writecombine(tmp
);
56 #elif defined(__powerpc__)
57 pgprot_val(tmp
) |= _PAGE_NO_CACHE
;
58 if (map
->type
== _DRM_REGISTERS
)
59 pgprot_val(tmp
) |= _PAGE_GUARDED
;
60 #elif defined(__ia64__)
61 if (efi_range_is_wc(vma
->vm_start
, vma
->vm_end
-
63 tmp
= pgprot_writecombine(tmp
);
65 tmp
= pgprot_noncached(tmp
);
66 #elif defined(__sparc__) || defined(__arm__) || defined(__mips__)
67 tmp
= pgprot_noncached(tmp
);
72 static pgprot_t
drm_dma_prot(uint32_t map_type
, struct vm_area_struct
*vma
)
74 pgprot_t tmp
= vm_get_page_prot(vma
->vm_flags
);
76 #if defined(__powerpc__) && defined(CONFIG_NOT_COHERENT_CACHE)
77 tmp
|= _PAGE_NO_CACHE
;
83 * \c fault method for AGP virtual memory.
85 * \param vma virtual memory area.
86 * \param address access address.
87 * \return pointer to the page structure.
89 * Find the right map and if it's AGP memory find the real physical page to
90 * map, get the page, increment the use count and return it.
93 static int drm_do_vm_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
95 struct drm_file
*priv
= vma
->vm_file
->private_data
;
96 struct drm_device
*dev
= priv
->minor
->dev
;
97 struct drm_local_map
*map
= NULL
;
98 struct drm_map_list
*r_list
;
99 struct drm_hash_item
*hash
;
104 if (!drm_core_has_AGP(dev
))
107 if (!dev
->agp
|| !dev
->agp
->cant_use_aperture
)
110 if (drm_ht_find_item(&dev
->map_hash
, vma
->vm_pgoff
, &hash
))
113 r_list
= drm_hash_entry(hash
, struct drm_map_list
, hash
);
116 if (map
&& map
->type
== _DRM_AGP
) {
118 * Using vm_pgoff as a selector forces us to use this unusual
121 resource_size_t offset
= (unsigned long)vmf
->virtual_address
-
123 resource_size_t baddr
= map
->offset
+ offset
;
124 struct drm_agp_mem
*agpmem
;
129 * Adjust to a bus-relative address
131 baddr
-= dev
->hose
->mem_space
->start
;
135 * It's AGP memory - find the real physical page to map
137 list_for_each_entry(agpmem
, &dev
->agp
->memory
, head
) {
138 if (agpmem
->bound
<= baddr
&&
139 agpmem
->bound
+ agpmem
->pages
* PAGE_SIZE
> baddr
)
143 if (&agpmem
->head
== &dev
->agp
->memory
)
147 * Get the page, inc the use count, and return it
149 offset
= (baddr
- agpmem
->bound
) >> PAGE_SHIFT
;
150 page
= agpmem
->memory
->pages
[offset
];
155 ("baddr = 0x%llx page = 0x%p, offset = 0x%llx, count=%d\n",
156 (unsigned long long)baddr
,
157 agpmem
->memory
->pages
[offset
],
158 (unsigned long long)offset
,
163 return VM_FAULT_SIGBUS
; /* Disallow mremap */
165 #else /* __OS_HAS_AGP */
166 static int drm_do_vm_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
168 return VM_FAULT_SIGBUS
;
170 #endif /* __OS_HAS_AGP */
173 * \c nopage method for shared virtual memory.
175 * \param vma virtual memory area.
176 * \param address access address.
177 * \return pointer to the page structure.
179 * Get the mapping, find the real physical page to map, get the page, and
182 static int drm_do_vm_shm_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
184 struct drm_local_map
*map
= vma
->vm_private_data
;
185 unsigned long offset
;
190 return VM_FAULT_SIGBUS
; /* Nothing allocated */
192 offset
= (unsigned long)vmf
->virtual_address
- vma
->vm_start
;
193 i
= (unsigned long)map
->handle
+ offset
;
194 page
= vmalloc_to_page((void *)i
);
196 return VM_FAULT_SIGBUS
;
200 DRM_DEBUG("shm_fault 0x%lx\n", offset
);
205 * \c close method for shared virtual memory.
207 * \param vma virtual memory area.
209 * Deletes map information if we are the last
210 * person to close a mapping and it's not in the global maplist.
212 static void drm_vm_shm_close(struct vm_area_struct
*vma
)
214 struct drm_file
*priv
= vma
->vm_file
->private_data
;
215 struct drm_device
*dev
= priv
->minor
->dev
;
216 struct drm_vma_entry
*pt
, *temp
;
217 struct drm_local_map
*map
;
218 struct drm_map_list
*r_list
;
221 DRM_DEBUG("0x%08lx,0x%08lx\n",
222 vma
->vm_start
, vma
->vm_end
- vma
->vm_start
);
223 atomic_dec(&dev
->vma_count
);
225 map
= vma
->vm_private_data
;
227 mutex_lock(&dev
->struct_mutex
);
228 list_for_each_entry_safe(pt
, temp
, &dev
->vmalist
, head
) {
229 if (pt
->vma
->vm_private_data
== map
)
231 if (pt
->vma
== vma
) {
237 /* We were the only map that was found */
238 if (found_maps
== 1 && map
->flags
& _DRM_REMOVABLE
) {
239 /* Check to see if we are in the maplist, if we are not, then
240 * we delete this mappings information.
243 list_for_each_entry(r_list
, &dev
->maplist
, head
) {
244 if (r_list
->map
== map
)
249 drm_dma_handle_t dmah
;
253 case _DRM_FRAME_BUFFER
:
254 if (drm_core_has_MTRR(dev
))
255 arch_phys_wc_del(map
->mtrr
);
256 iounmap(map
->handle
);
262 case _DRM_SCATTER_GATHER
:
264 case _DRM_CONSISTENT
:
265 dmah
.vaddr
= map
->handle
;
266 dmah
.busaddr
= map
->offset
;
267 dmah
.size
= map
->size
;
268 __drm_pci_free(dev
, &dmah
);
271 DRM_ERROR("tried to rmmap GEM object\n");
277 mutex_unlock(&dev
->struct_mutex
);
281 * \c fault method for DMA virtual memory.
283 * \param vma virtual memory area.
284 * \param address access address.
285 * \return pointer to the page structure.
287 * Determine the page number from the page offset and get it from drm_device_dma::pagelist.
289 static int drm_do_vm_dma_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
291 struct drm_file
*priv
= vma
->vm_file
->private_data
;
292 struct drm_device
*dev
= priv
->minor
->dev
;
293 struct drm_device_dma
*dma
= dev
->dma
;
294 unsigned long offset
;
295 unsigned long page_nr
;
299 return VM_FAULT_SIGBUS
; /* Error */
301 return VM_FAULT_SIGBUS
; /* Nothing allocated */
303 offset
= (unsigned long)vmf
->virtual_address
- vma
->vm_start
; /* vm_[pg]off[set] should be 0 */
304 page_nr
= offset
>> PAGE_SHIFT
; /* page_nr could just be vmf->pgoff */
305 page
= virt_to_page((dma
->pagelist
[page_nr
] + (offset
& (~PAGE_MASK
))));
310 DRM_DEBUG("dma_fault 0x%lx (page %lu)\n", offset
, page_nr
);
315 * \c fault method for scatter-gather virtual memory.
317 * \param vma virtual memory area.
318 * \param address access address.
319 * \return pointer to the page structure.
321 * Determine the map offset from the page offset and get it from drm_sg_mem::pagelist.
323 static int drm_do_vm_sg_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
325 struct drm_local_map
*map
= vma
->vm_private_data
;
326 struct drm_file
*priv
= vma
->vm_file
->private_data
;
327 struct drm_device
*dev
= priv
->minor
->dev
;
328 struct drm_sg_mem
*entry
= dev
->sg
;
329 unsigned long offset
;
330 unsigned long map_offset
;
331 unsigned long page_offset
;
335 return VM_FAULT_SIGBUS
; /* Error */
336 if (!entry
->pagelist
)
337 return VM_FAULT_SIGBUS
; /* Nothing allocated */
339 offset
= (unsigned long)vmf
->virtual_address
- vma
->vm_start
;
340 map_offset
= map
->offset
- (unsigned long)dev
->sg
->virtual;
341 page_offset
= (offset
>> PAGE_SHIFT
) + (map_offset
>> PAGE_SHIFT
);
342 page
= entry
->pagelist
[page_offset
];
349 static int drm_vm_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
351 return drm_do_vm_fault(vma
, vmf
);
354 static int drm_vm_shm_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
356 return drm_do_vm_shm_fault(vma
, vmf
);
359 static int drm_vm_dma_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
361 return drm_do_vm_dma_fault(vma
, vmf
);
364 static int drm_vm_sg_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
366 return drm_do_vm_sg_fault(vma
, vmf
);
369 /** AGP virtual memory operations */
370 static const struct vm_operations_struct drm_vm_ops
= {
371 .fault
= drm_vm_fault
,
373 .close
= drm_vm_close
,
376 /** Shared virtual memory operations */
377 static const struct vm_operations_struct drm_vm_shm_ops
= {
378 .fault
= drm_vm_shm_fault
,
380 .close
= drm_vm_shm_close
,
383 /** DMA virtual memory operations */
384 static const struct vm_operations_struct drm_vm_dma_ops
= {
385 .fault
= drm_vm_dma_fault
,
387 .close
= drm_vm_close
,
390 /** Scatter-gather virtual memory operations */
391 static const struct vm_operations_struct drm_vm_sg_ops
= {
392 .fault
= drm_vm_sg_fault
,
394 .close
= drm_vm_close
,
398 * \c open method for shared virtual memory.
400 * \param vma virtual memory area.
402 * Create a new drm_vma_entry structure as the \p vma private data entry and
403 * add it to drm_device::vmalist.
405 void drm_vm_open_locked(struct drm_device
*dev
,
406 struct vm_area_struct
*vma
)
408 struct drm_vma_entry
*vma_entry
;
410 DRM_DEBUG("0x%08lx,0x%08lx\n",
411 vma
->vm_start
, vma
->vm_end
- vma
->vm_start
);
412 atomic_inc(&dev
->vma_count
);
414 vma_entry
= kmalloc(sizeof(*vma_entry
), GFP_KERNEL
);
416 vma_entry
->vma
= vma
;
417 vma_entry
->pid
= current
->pid
;
418 list_add(&vma_entry
->head
, &dev
->vmalist
);
421 EXPORT_SYMBOL_GPL(drm_vm_open_locked
);
423 static void drm_vm_open(struct vm_area_struct
*vma
)
425 struct drm_file
*priv
= vma
->vm_file
->private_data
;
426 struct drm_device
*dev
= priv
->minor
->dev
;
428 mutex_lock(&dev
->struct_mutex
);
429 drm_vm_open_locked(dev
, vma
);
430 mutex_unlock(&dev
->struct_mutex
);
433 void drm_vm_close_locked(struct drm_device
*dev
,
434 struct vm_area_struct
*vma
)
436 struct drm_vma_entry
*pt
, *temp
;
438 DRM_DEBUG("0x%08lx,0x%08lx\n",
439 vma
->vm_start
, vma
->vm_end
- vma
->vm_start
);
440 atomic_dec(&dev
->vma_count
);
442 list_for_each_entry_safe(pt
, temp
, &dev
->vmalist
, head
) {
443 if (pt
->vma
== vma
) {
452 * \c close method for all virtual memory types.
454 * \param vma virtual memory area.
456 * Search the \p vma private data entry in drm_device::vmalist, unlink it, and
459 static void drm_vm_close(struct vm_area_struct
*vma
)
461 struct drm_file
*priv
= vma
->vm_file
->private_data
;
462 struct drm_device
*dev
= priv
->minor
->dev
;
464 mutex_lock(&dev
->struct_mutex
);
465 drm_vm_close_locked(dev
, vma
);
466 mutex_unlock(&dev
->struct_mutex
);
472 * \param file_priv DRM file private.
473 * \param vma virtual memory area.
474 * \return zero on success or a negative number on failure.
476 * Sets the virtual memory area operations structure to vm_dma_ops, the file
477 * pointer, and calls vm_open().
479 static int drm_mmap_dma(struct file
*filp
, struct vm_area_struct
*vma
)
481 struct drm_file
*priv
= filp
->private_data
;
482 struct drm_device
*dev
;
483 struct drm_device_dma
*dma
;
484 unsigned long length
= vma
->vm_end
- vma
->vm_start
;
486 dev
= priv
->minor
->dev
;
488 DRM_DEBUG("start = 0x%lx, end = 0x%lx, page offset = 0x%lx\n",
489 vma
->vm_start
, vma
->vm_end
, vma
->vm_pgoff
);
491 /* Length must match exact page count */
492 if (!dma
|| (length
>> PAGE_SHIFT
) != dma
->page_count
) {
496 if (!capable(CAP_SYS_ADMIN
) &&
497 (dma
->flags
& _DRM_DMA_USE_PCI_RO
)) {
498 vma
->vm_flags
&= ~(VM_WRITE
| VM_MAYWRITE
);
499 #if defined(__i386__) || defined(__x86_64__)
500 pgprot_val(vma
->vm_page_prot
) &= ~_PAGE_RW
;
502 /* Ye gads this is ugly. With more thought
503 we could move this up higher and use
504 `protection_map' instead. */
508 (__pte(pgprot_val(vma
->vm_page_prot
)))));
512 vma
->vm_ops
= &drm_vm_dma_ops
;
514 vma
->vm_flags
|= VM_DONTEXPAND
| VM_DONTDUMP
;
516 drm_vm_open_locked(dev
, vma
);
520 static resource_size_t
drm_core_get_reg_ofs(struct drm_device
*dev
)
523 return dev
->hose
->dense_mem_base
;
532 * \param file_priv DRM file private.
533 * \param vma virtual memory area.
534 * \return zero on success or a negative number on failure.
536 * If the virtual memory area has no offset associated with it then it's a DMA
537 * area, so calls mmap_dma(). Otherwise searches the map in drm_device::maplist,
538 * checks that the restricted flag is not set, sets the virtual memory operations
539 * according to the mapping type and remaps the pages. Finally sets the file
540 * pointer and calls vm_open().
542 int drm_mmap_locked(struct file
*filp
, struct vm_area_struct
*vma
)
544 struct drm_file
*priv
= filp
->private_data
;
545 struct drm_device
*dev
= priv
->minor
->dev
;
546 struct drm_local_map
*map
= NULL
;
547 resource_size_t offset
= 0;
548 struct drm_hash_item
*hash
;
550 DRM_DEBUG("start = 0x%lx, end = 0x%lx, page offset = 0x%lx\n",
551 vma
->vm_start
, vma
->vm_end
, vma
->vm_pgoff
);
553 if (!priv
->authenticated
)
556 /* We check for "dma". On Apple's UniNorth, it's valid to have
557 * the AGP mapped at physical address 0
563 || dev
->agp
->agp_info
.device
->vendor
!= PCI_VENDOR_ID_APPLE
)
566 return drm_mmap_dma(filp
, vma
);
568 if (drm_ht_find_item(&dev
->map_hash
, vma
->vm_pgoff
, &hash
)) {
569 DRM_ERROR("Could not find map\n");
573 map
= drm_hash_entry(hash
, struct drm_map_list
, hash
)->map
;
574 if (!map
|| ((map
->flags
& _DRM_RESTRICTED
) && !capable(CAP_SYS_ADMIN
)))
577 /* Check for valid size. */
578 if (map
->size
< vma
->vm_end
- vma
->vm_start
)
581 if (!capable(CAP_SYS_ADMIN
) && (map
->flags
& _DRM_READ_ONLY
)) {
582 vma
->vm_flags
&= ~(VM_WRITE
| VM_MAYWRITE
);
583 #if defined(__i386__) || defined(__x86_64__)
584 pgprot_val(vma
->vm_page_prot
) &= ~_PAGE_RW
;
586 /* Ye gads this is ugly. With more thought
587 we could move this up higher and use
588 `protection_map' instead. */
592 (__pte(pgprot_val(vma
->vm_page_prot
)))));
597 #if !defined(__arm__)
599 if (drm_core_has_AGP(dev
) && dev
->agp
->cant_use_aperture
) {
601 * On some platforms we can't talk to bus dma address from the CPU, so for
602 * memory of type DRM_AGP, we'll deal with sorting out the real physical
603 * pages and mappings in fault()
605 #if defined(__powerpc__)
606 pgprot_val(vma
->vm_page_prot
) |= _PAGE_NO_CACHE
;
608 vma
->vm_ops
= &drm_vm_ops
;
611 /* fall through to _DRM_FRAME_BUFFER... */
613 case _DRM_FRAME_BUFFER
:
615 offset
= drm_core_get_reg_ofs(dev
);
616 vma
->vm_page_prot
= drm_io_prot(map
, vma
);
617 if (io_remap_pfn_range(vma
, vma
->vm_start
,
618 (map
->offset
+ offset
) >> PAGE_SHIFT
,
619 vma
->vm_end
- vma
->vm_start
,
622 DRM_DEBUG(" Type = %d; start = 0x%lx, end = 0x%lx,"
623 " offset = 0x%llx\n",
625 vma
->vm_start
, vma
->vm_end
, (unsigned long long)(map
->offset
+ offset
));
627 vma
->vm_ops
= &drm_vm_ops
;
629 case _DRM_CONSISTENT
:
630 /* Consistent memory is really like shared memory. But
631 * it's allocated in a different way, so avoid fault */
632 if (remap_pfn_range(vma
, vma
->vm_start
,
633 page_to_pfn(virt_to_page(map
->handle
)),
634 vma
->vm_end
- vma
->vm_start
, vma
->vm_page_prot
))
636 vma
->vm_page_prot
= drm_dma_prot(map
->type
, vma
);
637 /* fall through to _DRM_SHM */
639 vma
->vm_ops
= &drm_vm_shm_ops
;
640 vma
->vm_private_data
= (void *)map
;
642 case _DRM_SCATTER_GATHER
:
643 vma
->vm_ops
= &drm_vm_sg_ops
;
644 vma
->vm_private_data
= (void *)map
;
645 vma
->vm_page_prot
= drm_dma_prot(map
->type
, vma
);
648 return -EINVAL
; /* This should never happen. */
650 vma
->vm_flags
|= VM_DONTEXPAND
| VM_DONTDUMP
;
652 drm_vm_open_locked(dev
, vma
);
656 int drm_mmap(struct file
*filp
, struct vm_area_struct
*vma
)
658 struct drm_file
*priv
= filp
->private_data
;
659 struct drm_device
*dev
= priv
->minor
->dev
;
662 if (drm_device_is_unplugged(dev
))
665 mutex_lock(&dev
->struct_mutex
);
666 ret
= drm_mmap_locked(filp
, vma
);
667 mutex_unlock(&dev
->struct_mutex
);
671 EXPORT_SYMBOL(drm_mmap
);