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>
38 #include <linux/seq_file.h>
40 #include <linux/efi.h>
41 #include <linux/slab.h>
43 #include <asm/pgtable.h>
44 #include "drm_internal.h"
45 #include "drm_legacy.h"
47 struct drm_vma_entry
{
48 struct list_head head
;
49 struct vm_area_struct
*vma
;
53 static void drm_vm_open(struct vm_area_struct
*vma
);
54 static void drm_vm_close(struct vm_area_struct
*vma
);
56 static pgprot_t
drm_io_prot(struct drm_local_map
*map
,
57 struct vm_area_struct
*vma
)
59 pgprot_t tmp
= vm_get_page_prot(vma
->vm_flags
);
61 #if defined(__i386__) || defined(__x86_64__) || defined(__powerpc__)
62 if (map
->type
== _DRM_REGISTERS
&& !(map
->flags
& _DRM_WRITE_COMBINING
))
63 tmp
= pgprot_noncached(tmp
);
65 tmp
= pgprot_writecombine(tmp
);
66 #elif defined(__ia64__)
67 if (efi_range_is_wc(vma
->vm_start
, vma
->vm_end
-
69 tmp
= pgprot_writecombine(tmp
);
71 tmp
= pgprot_noncached(tmp
);
72 #elif defined(__sparc__) || defined(__arm__) || defined(__mips__)
73 tmp
= pgprot_noncached(tmp
);
78 static pgprot_t
drm_dma_prot(uint32_t map_type
, struct vm_area_struct
*vma
)
80 pgprot_t tmp
= vm_get_page_prot(vma
->vm_flags
);
82 #if defined(__powerpc__) && defined(CONFIG_NOT_COHERENT_CACHE)
83 tmp
= pgprot_noncached_wc(tmp
);
89 * \c fault method for AGP virtual memory.
91 * \param vma virtual memory area.
92 * \param address access address.
93 * \return pointer to the page structure.
95 * Find the right map and if it's AGP memory find the real physical page to
96 * map, get the page, increment the use count and return it.
98 #if IS_ENABLED(CONFIG_AGP)
99 static int drm_do_vm_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
101 struct drm_file
*priv
= vma
->vm_file
->private_data
;
102 struct drm_device
*dev
= priv
->minor
->dev
;
103 struct drm_local_map
*map
= NULL
;
104 struct drm_map_list
*r_list
;
105 struct drm_hash_item
*hash
;
113 if (!dev
->agp
|| !dev
->agp
->cant_use_aperture
)
116 if (drm_ht_find_item(&dev
->map_hash
, vma
->vm_pgoff
, &hash
))
119 r_list
= drm_hash_entry(hash
, struct drm_map_list
, hash
);
122 if (map
&& map
->type
== _DRM_AGP
) {
124 * Using vm_pgoff as a selector forces us to use this unusual
127 resource_size_t offset
= (unsigned long)vmf
->virtual_address
-
129 resource_size_t baddr
= map
->offset
+ offset
;
130 struct drm_agp_mem
*agpmem
;
135 * Adjust to a bus-relative address
137 baddr
-= dev
->hose
->mem_space
->start
;
141 * It's AGP memory - find the real physical page to map
143 list_for_each_entry(agpmem
, &dev
->agp
->memory
, head
) {
144 if (agpmem
->bound
<= baddr
&&
145 agpmem
->bound
+ agpmem
->pages
* PAGE_SIZE
> baddr
)
149 if (&agpmem
->head
== &dev
->agp
->memory
)
153 * Get the page, inc the use count, and return it
155 offset
= (baddr
- agpmem
->bound
) >> PAGE_SHIFT
;
156 page
= agpmem
->memory
->pages
[offset
];
161 ("baddr = 0x%llx page = 0x%p, offset = 0x%llx, count=%d\n",
162 (unsigned long long)baddr
,
163 agpmem
->memory
->pages
[offset
],
164 (unsigned long long)offset
,
169 return VM_FAULT_SIGBUS
; /* Disallow mremap */
172 static int drm_do_vm_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
174 return VM_FAULT_SIGBUS
;
179 * \c nopage method for shared virtual memory.
181 * \param vma virtual memory area.
182 * \param address access address.
183 * \return pointer to the page structure.
185 * Get the mapping, find the real physical page to map, get the page, and
188 static int drm_do_vm_shm_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
190 struct drm_local_map
*map
= vma
->vm_private_data
;
191 unsigned long offset
;
196 return VM_FAULT_SIGBUS
; /* Nothing allocated */
198 offset
= (unsigned long)vmf
->virtual_address
- vma
->vm_start
;
199 i
= (unsigned long)map
->handle
+ offset
;
200 page
= vmalloc_to_page((void *)i
);
202 return VM_FAULT_SIGBUS
;
206 DRM_DEBUG("shm_fault 0x%lx\n", offset
);
211 * \c close method for shared virtual memory.
213 * \param vma virtual memory area.
215 * Deletes map information if we are the last
216 * person to close a mapping and it's not in the global maplist.
218 static void drm_vm_shm_close(struct vm_area_struct
*vma
)
220 struct drm_file
*priv
= vma
->vm_file
->private_data
;
221 struct drm_device
*dev
= priv
->minor
->dev
;
222 struct drm_vma_entry
*pt
, *temp
;
223 struct drm_local_map
*map
;
224 struct drm_map_list
*r_list
;
227 DRM_DEBUG("0x%08lx,0x%08lx\n",
228 vma
->vm_start
, vma
->vm_end
- vma
->vm_start
);
230 map
= vma
->vm_private_data
;
232 mutex_lock(&dev
->struct_mutex
);
233 list_for_each_entry_safe(pt
, temp
, &dev
->vmalist
, head
) {
234 if (pt
->vma
->vm_private_data
== map
)
236 if (pt
->vma
== vma
) {
242 /* We were the only map that was found */
243 if (found_maps
== 1 && map
->flags
& _DRM_REMOVABLE
) {
244 /* Check to see if we are in the maplist, if we are not, then
245 * we delete this mappings information.
248 list_for_each_entry(r_list
, &dev
->maplist
, head
) {
249 if (r_list
->map
== map
)
254 drm_dma_handle_t dmah
;
258 case _DRM_FRAME_BUFFER
:
259 arch_phys_wc_del(map
->mtrr
);
260 iounmap(map
->handle
);
266 case _DRM_SCATTER_GATHER
:
268 case _DRM_CONSISTENT
:
269 dmah
.vaddr
= map
->handle
;
270 dmah
.busaddr
= map
->offset
;
271 dmah
.size
= map
->size
;
272 __drm_legacy_pci_free(dev
, &dmah
);
278 mutex_unlock(&dev
->struct_mutex
);
282 * \c fault method for DMA virtual memory.
284 * \param vma virtual memory area.
285 * \param address access address.
286 * \return pointer to the page structure.
288 * Determine the page number from the page offset and get it from drm_device_dma::pagelist.
290 static int drm_do_vm_dma_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
292 struct drm_file
*priv
= vma
->vm_file
->private_data
;
293 struct drm_device
*dev
= priv
->minor
->dev
;
294 struct drm_device_dma
*dma
= dev
->dma
;
295 unsigned long offset
;
296 unsigned long page_nr
;
300 return VM_FAULT_SIGBUS
; /* Error */
302 return VM_FAULT_SIGBUS
; /* Nothing allocated */
304 offset
= (unsigned long)vmf
->virtual_address
- vma
->vm_start
; /* vm_[pg]off[set] should be 0 */
305 page_nr
= offset
>> PAGE_SHIFT
; /* page_nr could just be vmf->pgoff */
306 page
= virt_to_page((void *)dma
->pagelist
[page_nr
]);
311 DRM_DEBUG("dma_fault 0x%lx (page %lu)\n", offset
, page_nr
);
316 * \c fault method for scatter-gather virtual memory.
318 * \param vma virtual memory area.
319 * \param address access address.
320 * \return pointer to the page structure.
322 * Determine the map offset from the page offset and get it from drm_sg_mem::pagelist.
324 static int drm_do_vm_sg_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
326 struct drm_local_map
*map
= vma
->vm_private_data
;
327 struct drm_file
*priv
= vma
->vm_file
->private_data
;
328 struct drm_device
*dev
= priv
->minor
->dev
;
329 struct drm_sg_mem
*entry
= dev
->sg
;
330 unsigned long offset
;
331 unsigned long map_offset
;
332 unsigned long page_offset
;
336 return VM_FAULT_SIGBUS
; /* Error */
337 if (!entry
->pagelist
)
338 return VM_FAULT_SIGBUS
; /* Nothing allocated */
340 offset
= (unsigned long)vmf
->virtual_address
- vma
->vm_start
;
341 map_offset
= map
->offset
- (unsigned long)dev
->sg
->virtual;
342 page_offset
= (offset
>> PAGE_SHIFT
) + (map_offset
>> PAGE_SHIFT
);
343 page
= entry
->pagelist
[page_offset
];
350 static int drm_vm_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
352 return drm_do_vm_fault(vma
, vmf
);
355 static int drm_vm_shm_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
357 return drm_do_vm_shm_fault(vma
, vmf
);
360 static int drm_vm_dma_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
362 return drm_do_vm_dma_fault(vma
, vmf
);
365 static int drm_vm_sg_fault(struct vm_area_struct
*vma
, struct vm_fault
*vmf
)
367 return drm_do_vm_sg_fault(vma
, vmf
);
370 /** AGP virtual memory operations */
371 static const struct vm_operations_struct drm_vm_ops
= {
372 .fault
= drm_vm_fault
,
374 .close
= drm_vm_close
,
377 /** Shared virtual memory operations */
378 static const struct vm_operations_struct drm_vm_shm_ops
= {
379 .fault
= drm_vm_shm_fault
,
381 .close
= drm_vm_shm_close
,
384 /** DMA virtual memory operations */
385 static const struct vm_operations_struct drm_vm_dma_ops
= {
386 .fault
= drm_vm_dma_fault
,
388 .close
= drm_vm_close
,
391 /** Scatter-gather virtual memory operations */
392 static const struct vm_operations_struct drm_vm_sg_ops
= {
393 .fault
= drm_vm_sg_fault
,
395 .close
= drm_vm_close
,
398 static void drm_vm_open_locked(struct drm_device
*dev
,
399 struct vm_area_struct
*vma
)
401 struct drm_vma_entry
*vma_entry
;
403 DRM_DEBUG("0x%08lx,0x%08lx\n",
404 vma
->vm_start
, vma
->vm_end
- vma
->vm_start
);
406 vma_entry
= kmalloc(sizeof(*vma_entry
), GFP_KERNEL
);
408 vma_entry
->vma
= vma
;
409 vma_entry
->pid
= current
->pid
;
410 list_add(&vma_entry
->head
, &dev
->vmalist
);
414 static void drm_vm_open(struct vm_area_struct
*vma
)
416 struct drm_file
*priv
= vma
->vm_file
->private_data
;
417 struct drm_device
*dev
= priv
->minor
->dev
;
419 mutex_lock(&dev
->struct_mutex
);
420 drm_vm_open_locked(dev
, vma
);
421 mutex_unlock(&dev
->struct_mutex
);
424 static void drm_vm_close_locked(struct drm_device
*dev
,
425 struct vm_area_struct
*vma
)
427 struct drm_vma_entry
*pt
, *temp
;
429 DRM_DEBUG("0x%08lx,0x%08lx\n",
430 vma
->vm_start
, vma
->vm_end
- vma
->vm_start
);
432 list_for_each_entry_safe(pt
, temp
, &dev
->vmalist
, head
) {
433 if (pt
->vma
== vma
) {
442 * \c close method for all virtual memory types.
444 * \param vma virtual memory area.
446 * Search the \p vma private data entry in drm_device::vmalist, unlink it, and
449 static void drm_vm_close(struct vm_area_struct
*vma
)
451 struct drm_file
*priv
= vma
->vm_file
->private_data
;
452 struct drm_device
*dev
= priv
->minor
->dev
;
454 mutex_lock(&dev
->struct_mutex
);
455 drm_vm_close_locked(dev
, vma
);
456 mutex_unlock(&dev
->struct_mutex
);
462 * \param file_priv DRM file private.
463 * \param vma virtual memory area.
464 * \return zero on success or a negative number on failure.
466 * Sets the virtual memory area operations structure to vm_dma_ops, the file
467 * pointer, and calls vm_open().
469 static int drm_mmap_dma(struct file
*filp
, struct vm_area_struct
*vma
)
471 struct drm_file
*priv
= filp
->private_data
;
472 struct drm_device
*dev
;
473 struct drm_device_dma
*dma
;
474 unsigned long length
= vma
->vm_end
- vma
->vm_start
;
476 dev
= priv
->minor
->dev
;
478 DRM_DEBUG("start = 0x%lx, end = 0x%lx, page offset = 0x%lx\n",
479 vma
->vm_start
, vma
->vm_end
, vma
->vm_pgoff
);
481 /* Length must match exact page count */
482 if (!dma
|| (length
>> PAGE_SHIFT
) != dma
->page_count
) {
486 if (!capable(CAP_SYS_ADMIN
) &&
487 (dma
->flags
& _DRM_DMA_USE_PCI_RO
)) {
488 vma
->vm_flags
&= ~(VM_WRITE
| VM_MAYWRITE
);
489 #if defined(__i386__) || defined(__x86_64__)
490 pgprot_val(vma
->vm_page_prot
) &= ~_PAGE_RW
;
492 /* Ye gads this is ugly. With more thought
493 we could move this up higher and use
494 `protection_map' instead. */
498 (__pte(pgprot_val(vma
->vm_page_prot
)))));
502 vma
->vm_ops
= &drm_vm_dma_ops
;
504 vma
->vm_flags
|= VM_DONTEXPAND
| VM_DONTDUMP
;
506 drm_vm_open_locked(dev
, vma
);
510 static resource_size_t
drm_core_get_reg_ofs(struct drm_device
*dev
)
513 return dev
->hose
->dense_mem_base
;
522 * \param file_priv DRM file private.
523 * \param vma virtual memory area.
524 * \return zero on success or a negative number on failure.
526 * If the virtual memory area has no offset associated with it then it's a DMA
527 * area, so calls mmap_dma(). Otherwise searches the map in drm_device::maplist,
528 * checks that the restricted flag is not set, sets the virtual memory operations
529 * according to the mapping type and remaps the pages. Finally sets the file
530 * pointer and calls vm_open().
532 static int drm_mmap_locked(struct file
*filp
, struct vm_area_struct
*vma
)
534 struct drm_file
*priv
= filp
->private_data
;
535 struct drm_device
*dev
= priv
->minor
->dev
;
536 struct drm_local_map
*map
= NULL
;
537 resource_size_t offset
= 0;
538 struct drm_hash_item
*hash
;
540 DRM_DEBUG("start = 0x%lx, end = 0x%lx, page offset = 0x%lx\n",
541 vma
->vm_start
, vma
->vm_end
, vma
->vm_pgoff
);
543 if (!priv
->authenticated
)
546 /* We check for "dma". On Apple's UniNorth, it's valid to have
547 * the AGP mapped at physical address 0
551 #if IS_ENABLED(CONFIG_AGP)
553 || dev
->agp
->agp_info
.device
->vendor
!= PCI_VENDOR_ID_APPLE
)
556 return drm_mmap_dma(filp
, vma
);
558 if (drm_ht_find_item(&dev
->map_hash
, vma
->vm_pgoff
, &hash
)) {
559 DRM_ERROR("Could not find map\n");
563 map
= drm_hash_entry(hash
, struct drm_map_list
, hash
)->map
;
564 if (!map
|| ((map
->flags
& _DRM_RESTRICTED
) && !capable(CAP_SYS_ADMIN
)))
567 /* Check for valid size. */
568 if (map
->size
< vma
->vm_end
- vma
->vm_start
)
571 if (!capable(CAP_SYS_ADMIN
) && (map
->flags
& _DRM_READ_ONLY
)) {
572 vma
->vm_flags
&= ~(VM_WRITE
| VM_MAYWRITE
);
573 #if defined(__i386__) || defined(__x86_64__)
574 pgprot_val(vma
->vm_page_prot
) &= ~_PAGE_RW
;
576 /* Ye gads this is ugly. With more thought
577 we could move this up higher and use
578 `protection_map' instead. */
582 (__pte(pgprot_val(vma
->vm_page_prot
)))));
587 #if !defined(__arm__)
589 if (dev
->agp
&& dev
->agp
->cant_use_aperture
) {
591 * On some platforms we can't talk to bus dma address from the CPU, so for
592 * memory of type DRM_AGP, we'll deal with sorting out the real physical
593 * pages and mappings in fault()
595 #if defined(__powerpc__)
596 vma
->vm_page_prot
= pgprot_noncached(vma
->vm_page_prot
);
598 vma
->vm_ops
= &drm_vm_ops
;
601 /* fall through to _DRM_FRAME_BUFFER... */
603 case _DRM_FRAME_BUFFER
:
605 offset
= drm_core_get_reg_ofs(dev
);
606 vma
->vm_page_prot
= drm_io_prot(map
, vma
);
607 if (io_remap_pfn_range(vma
, vma
->vm_start
,
608 (map
->offset
+ offset
) >> PAGE_SHIFT
,
609 vma
->vm_end
- vma
->vm_start
,
612 DRM_DEBUG(" Type = %d; start = 0x%lx, end = 0x%lx,"
613 " offset = 0x%llx\n",
615 vma
->vm_start
, vma
->vm_end
, (unsigned long long)(map
->offset
+ offset
));
617 vma
->vm_ops
= &drm_vm_ops
;
619 case _DRM_CONSISTENT
:
620 /* Consistent memory is really like shared memory. But
621 * it's allocated in a different way, so avoid fault */
622 if (remap_pfn_range(vma
, vma
->vm_start
,
623 page_to_pfn(virt_to_page(map
->handle
)),
624 vma
->vm_end
- vma
->vm_start
, vma
->vm_page_prot
))
626 vma
->vm_page_prot
= drm_dma_prot(map
->type
, vma
);
627 /* fall through to _DRM_SHM */
629 vma
->vm_ops
= &drm_vm_shm_ops
;
630 vma
->vm_private_data
= (void *)map
;
632 case _DRM_SCATTER_GATHER
:
633 vma
->vm_ops
= &drm_vm_sg_ops
;
634 vma
->vm_private_data
= (void *)map
;
635 vma
->vm_page_prot
= drm_dma_prot(map
->type
, vma
);
638 return -EINVAL
; /* This should never happen. */
640 vma
->vm_flags
|= VM_DONTEXPAND
| VM_DONTDUMP
;
642 drm_vm_open_locked(dev
, vma
);
646 int drm_legacy_mmap(struct file
*filp
, struct vm_area_struct
*vma
)
648 struct drm_file
*priv
= filp
->private_data
;
649 struct drm_device
*dev
= priv
->minor
->dev
;
652 if (drm_device_is_unplugged(dev
))
655 mutex_lock(&dev
->struct_mutex
);
656 ret
= drm_mmap_locked(filp
, vma
);
657 mutex_unlock(&dev
->struct_mutex
);
661 EXPORT_SYMBOL(drm_legacy_mmap
);
663 void drm_legacy_vma_flush(struct drm_device
*dev
)
665 struct drm_vma_entry
*vma
, *vma_temp
;
667 /* Clear vma list (only needed for legacy drivers) */
668 list_for_each_entry_safe(vma
, vma_temp
, &dev
->vmalist
, head
) {
669 list_del(&vma
->head
);