2 * Legacy: Generic DRM Buffer Management
4 * Copyright 1999, 2000 Precision Insight, Inc., Cedar Park, Texas.
5 * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
11 * Permission is hereby granted, free of charge, to any person obtaining a
12 * copy of this software and associated documentation files (the "Software"),
13 * to deal in the Software without restriction, including without limitation
14 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
15 * and/or sell copies of the Software, and to permit persons to whom the
16 * Software is furnished to do so, subject to the following conditions:
18 * The above copyright notice and this permission notice (including the next
19 * paragraph) shall be included in all copies or substantial portions of the
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
25 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
26 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
27 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
28 * OTHER DEALINGS IN THE SOFTWARE.
31 #include <linux/export.h>
32 #include <linux/log2.h>
34 #include <linux/mman.h>
35 #include <linux/nospec.h>
36 #include <linux/slab.h>
37 #include <linux/uaccess.h>
38 #include <linux/vmalloc.h>
40 #include <asm/shmparam.h>
42 #include <drm/drm_agpsupport.h>
43 #include <drm/drm_device.h>
44 #include <drm/drm_drv.h>
45 #include <drm/drm_file.h>
46 #include <drm/drm_pci.h>
47 #include <drm/drm_print.h>
49 #include "drm_legacy.h"
52 static struct drm_map_list *drm_find_matching_map(struct drm_device *dev,
53 struct drm_local_map *map)
55 struct drm_map_list *entry;
56 list_for_each_entry(entry, &dev->maplist, head) {
58 * Because the kernel-userspace ABI is fixed at a 32-bit offset
59 * while PCI resources may live above that, we only compare the
60 * lower 32 bits of the map offset for maps of type
61 * _DRM_FRAMEBUFFER or _DRM_REGISTERS.
62 * It is assumed that if a driver have more than one resource
63 * of each type, the lower 32 bits are different.
66 map->type != entry->map->type ||
67 entry->master != dev->master)
71 if (map->flags != _DRM_CONTAINS_LOCK)
75 case _DRM_FRAME_BUFFER:
76 if ((entry->map->offset & 0xffffffff) ==
77 (map->offset & 0xffffffff))
79 default: /* Make gcc happy */
82 if (entry->map->offset == map->offset)
89 static int drm_map_handle(struct drm_device *dev, struct drm_hash_item *hash,
90 unsigned long user_token, int hashed_handle, int shm)
92 int use_hashed_handle, shift;
95 #if (BITS_PER_LONG == 64)
96 use_hashed_handle = ((user_token & 0xFFFFFFFF00000000UL) || hashed_handle);
97 #elif (BITS_PER_LONG == 32)
98 use_hashed_handle = hashed_handle;
100 #error Unsupported long size. Neither 64 nor 32 bits.
103 if (!use_hashed_handle) {
105 hash->key = user_token >> PAGE_SHIFT;
106 ret = drm_ht_insert_item(&dev->map_hash, hash);
112 add = DRM_MAP_HASH_OFFSET >> PAGE_SHIFT;
113 if (shm && (SHMLBA > PAGE_SIZE)) {
114 int bits = ilog2(SHMLBA >> PAGE_SHIFT) + 1;
116 /* For shared memory, we have to preserve the SHMLBA
117 * bits of the eventual vma->vm_pgoff value during
118 * mmap(). Otherwise we run into cache aliasing problems
119 * on some platforms. On these platforms, the pgoff of
120 * a mmap() request is used to pick a suitable virtual
121 * address for the mmap() region such that it will not
122 * cause cache aliasing problems.
124 * Therefore, make sure the SHMLBA relevant bits of the
125 * hash value we use are equal to those in the original
126 * kernel virtual address.
129 add |= ((user_token >> PAGE_SHIFT) & ((1UL << bits) - 1UL));
132 return drm_ht_just_insert_please(&dev->map_hash, hash,
133 user_token, 32 - PAGE_SHIFT - 3,
138 * Core function to create a range of memory available for mapping by a
141 * Adjusts the memory offset to its absolute value according to the mapping
142 * type. Adds the map to the map list drm_device::maplist. Adds MTRR's where
143 * applicable and if supported by the kernel.
145 static int drm_addmap_core(struct drm_device *dev, resource_size_t offset,
146 unsigned int size, enum drm_map_type type,
147 enum drm_map_flags flags,
148 struct drm_map_list **maplist)
150 struct drm_local_map *map;
151 struct drm_map_list *list;
152 drm_dma_handle_t *dmah;
153 unsigned long user_token;
156 map = kmalloc(sizeof(*map), GFP_KERNEL);
160 map->offset = offset;
165 /* Only allow shared memory to be removable since we only keep enough
166 * book keeping information about shared memory to allow for removal
167 * when processes fork.
169 if ((map->flags & _DRM_REMOVABLE) && map->type != _DRM_SHM) {
173 DRM_DEBUG("offset = 0x%08llx, size = 0x%08lx, type = %d\n",
174 (unsigned long long)map->offset, map->size, map->type);
176 /* page-align _DRM_SHM maps. They are allocated here so there is no security
177 * hole created by that and it works around various broken drivers that use
178 * a non-aligned quantity to map the SAREA. --BenH
180 if (map->type == _DRM_SHM)
181 map->size = PAGE_ALIGN(map->size);
183 if ((map->offset & (~(resource_size_t)PAGE_MASK)) || (map->size & (~PAGE_MASK))) {
192 case _DRM_FRAME_BUFFER:
193 #if !defined(__sparc__) && !defined(__alpha__) && !defined(__ia64__) && !defined(__powerpc64__) && !defined(__x86_64__) && !defined(__arm__)
194 if (map->offset + (map->size-1) < map->offset ||
195 map->offset < virt_to_phys(high_memory)) {
200 /* Some drivers preinitialize some maps, without the X Server
201 * needing to be aware of it. Therefore, we just return success
202 * when the server tries to create a duplicate map.
204 list = drm_find_matching_map(dev, map);
206 if (list->map->size != map->size) {
207 DRM_DEBUG("Matching maps of type %d with "
208 "mismatched sizes, (%ld vs %ld)\n",
209 map->type, map->size,
211 list->map->size = map->size;
219 if (map->type == _DRM_FRAME_BUFFER ||
220 (map->flags & _DRM_WRITE_COMBINING)) {
222 arch_phys_wc_add(map->offset, map->size);
224 if (map->type == _DRM_REGISTERS) {
225 if (map->flags & _DRM_WRITE_COMBINING)
226 map->handle = ioremap_wc(map->offset,
229 map->handle = ioremap(map->offset, map->size);
238 list = drm_find_matching_map(dev, map);
240 if (list->map->size != map->size) {
241 DRM_DEBUG("Matching maps of type %d with "
242 "mismatched sizes, (%ld vs %ld)\n",
243 map->type, map->size, list->map->size);
244 list->map->size = map->size;
251 map->handle = vmalloc_user(map->size);
252 DRM_DEBUG("%lu %d %p\n",
253 map->size, order_base_2(map->size), map->handle);
258 map->offset = (unsigned long)map->handle;
259 if (map->flags & _DRM_CONTAINS_LOCK) {
260 /* Prevent a 2nd X Server from creating a 2nd lock */
261 if (dev->master->lock.hw_lock != NULL) {
266 dev->sigdata.lock = dev->master->lock.hw_lock = map->handle; /* Pointer to lock */
270 struct drm_agp_mem *entry;
278 map->offset += dev->hose->mem_space->start;
280 /* In some cases (i810 driver), user space may have already
281 * added the AGP base itself, because dev->agp->base previously
282 * only got set during AGP enable. So, only add the base
283 * address if the map's offset isn't already within the
286 if (map->offset < dev->agp->base ||
287 map->offset > dev->agp->base +
288 dev->agp->agp_info.aper_size * 1024 * 1024 - 1) {
289 map->offset += dev->agp->base;
291 map->mtrr = dev->agp->agp_mtrr; /* for getmap */
293 /* This assumes the DRM is in total control of AGP space.
294 * It's not always the case as AGP can be in the control
295 * of user space (i.e. i810 driver). So this loop will get
296 * skipped and we double check that dev->agp->memory is
297 * actually set as well as being invalid before EPERM'ing
299 list_for_each_entry(entry, &dev->agp->memory, head) {
300 if ((map->offset >= entry->bound) &&
301 (map->offset + map->size <= entry->bound + entry->pages * PAGE_SIZE)) {
306 if (!list_empty(&dev->agp->memory) && !valid) {
310 DRM_DEBUG("AGP offset = 0x%08llx, size = 0x%08lx\n",
311 (unsigned long long)map->offset, map->size);
315 case _DRM_SCATTER_GATHER:
320 map->offset += (unsigned long)dev->sg->virtual;
322 case _DRM_CONSISTENT:
323 /* dma_addr_t is 64bit on i386 with CONFIG_HIGHMEM64G,
324 * As we're limiting the address to 2^32-1 (or less),
325 * casting it down to 32 bits is no problem, but we
326 * need to point to a 64bit variable first. */
327 dmah = drm_pci_alloc(dev, map->size, map->size);
332 map->handle = dmah->vaddr;
333 map->offset = (unsigned long)dmah->busaddr;
341 list = kzalloc(sizeof(*list), GFP_KERNEL);
343 if (map->type == _DRM_REGISTERS)
344 iounmap(map->handle);
350 mutex_lock(&dev->struct_mutex);
351 list_add(&list->head, &dev->maplist);
353 /* Assign a 32-bit handle */
354 /* We do it here so that dev->struct_mutex protects the increment */
355 user_token = (map->type == _DRM_SHM) ? (unsigned long)map->handle :
357 ret = drm_map_handle(dev, &list->hash, user_token, 0,
358 (map->type == _DRM_SHM));
360 if (map->type == _DRM_REGISTERS)
361 iounmap(map->handle);
364 mutex_unlock(&dev->struct_mutex);
368 list->user_token = list->hash.key << PAGE_SHIFT;
369 mutex_unlock(&dev->struct_mutex);
371 if (!(map->flags & _DRM_DRIVER))
372 list->master = dev->master;
377 int drm_legacy_addmap(struct drm_device *dev, resource_size_t offset,
378 unsigned int size, enum drm_map_type type,
379 enum drm_map_flags flags, struct drm_local_map **map_ptr)
381 struct drm_map_list *list;
384 rc = drm_addmap_core(dev, offset, size, type, flags, &list);
386 *map_ptr = list->map;
389 EXPORT_SYMBOL(drm_legacy_addmap);
391 struct drm_local_map *drm_legacy_findmap(struct drm_device *dev,
394 struct drm_map_list *_entry;
395 list_for_each_entry(_entry, &dev->maplist, head)
396 if (_entry->user_token == token)
400 EXPORT_SYMBOL(drm_legacy_findmap);
403 * Ioctl to specify a range of memory that is available for mapping by a
406 * \param inode device inode.
407 * \param file_priv DRM file private.
408 * \param cmd command.
409 * \param arg pointer to a drm_map structure.
410 * \return zero on success or a negative value on error.
413 int drm_legacy_addmap_ioctl(struct drm_device *dev, void *data,
414 struct drm_file *file_priv)
416 struct drm_map *map = data;
417 struct drm_map_list *maplist;
420 if (!(capable(CAP_SYS_ADMIN) || map->type == _DRM_AGP || map->type == _DRM_SHM))
423 if (!drm_core_check_feature(dev, DRIVER_KMS_LEGACY_CONTEXT) &&
424 !drm_core_check_feature(dev, DRIVER_LEGACY))
427 err = drm_addmap_core(dev, map->offset, map->size, map->type,
428 map->flags, &maplist);
433 /* avoid a warning on 64-bit, this casting isn't very nice, but the API is set so too late */
434 map->handle = (void *)(unsigned long)maplist->user_token;
437 * It appears that there are no users of this value whatsoever --
438 * drmAddMap just discards it. Let's not encourage its use.
439 * (Keeping drm_addmap_core's returned mtrr value would be wrong --
440 * it's not a real mtrr index anymore.)
448 * Get a mapping information.
450 * \param inode device inode.
451 * \param file_priv DRM file private.
452 * \param cmd command.
453 * \param arg user argument, pointing to a drm_map structure.
455 * \return zero on success or a negative number on failure.
457 * Searches for the mapping with the specified offset and copies its information
460 int drm_legacy_getmap_ioctl(struct drm_device *dev, void *data,
461 struct drm_file *file_priv)
463 struct drm_map *map = data;
464 struct drm_map_list *r_list = NULL;
465 struct list_head *list;
469 if (!drm_core_check_feature(dev, DRIVER_KMS_LEGACY_CONTEXT) &&
470 !drm_core_check_feature(dev, DRIVER_LEGACY))
478 mutex_lock(&dev->struct_mutex);
479 list_for_each(list, &dev->maplist) {
481 r_list = list_entry(list, struct drm_map_list, head);
486 if (!r_list || !r_list->map) {
487 mutex_unlock(&dev->struct_mutex);
491 map->offset = r_list->map->offset;
492 map->size = r_list->map->size;
493 map->type = r_list->map->type;
494 map->flags = r_list->map->flags;
495 map->handle = (void *)(unsigned long) r_list->user_token;
496 map->mtrr = arch_phys_wc_index(r_list->map->mtrr);
498 mutex_unlock(&dev->struct_mutex);
504 * Remove a map private from list and deallocate resources if the mapping
507 * Searches the map on drm_device::maplist, removes it from the list, see if
508 * it's being used, and free any associated resource (such as MTRR's) if it's not
511 * \sa drm_legacy_addmap
513 int drm_legacy_rmmap_locked(struct drm_device *dev, struct drm_local_map *map)
515 struct drm_map_list *r_list = NULL, *list_t;
516 drm_dma_handle_t dmah;
518 struct drm_master *master;
520 /* Find the list entry for the map and remove it */
521 list_for_each_entry_safe(r_list, list_t, &dev->maplist, head) {
522 if (r_list->map == map) {
523 master = r_list->master;
524 list_del(&r_list->head);
525 drm_ht_remove_key(&dev->map_hash,
526 r_list->user_token >> PAGE_SHIFT);
538 iounmap(map->handle);
540 case _DRM_FRAME_BUFFER:
541 arch_phys_wc_del(map->mtrr);
546 if (dev->sigdata.lock == master->lock.hw_lock)
547 dev->sigdata.lock = NULL;
548 master->lock.hw_lock = NULL; /* SHM removed */
549 master->lock.file_priv = NULL;
550 wake_up_interruptible_all(&master->lock.lock_queue);
554 case _DRM_SCATTER_GATHER:
556 case _DRM_CONSISTENT:
557 dmah.vaddr = map->handle;
558 dmah.busaddr = map->offset;
559 dmah.size = map->size;
560 __drm_legacy_pci_free(dev, &dmah);
567 EXPORT_SYMBOL(drm_legacy_rmmap_locked);
569 void drm_legacy_rmmap(struct drm_device *dev, struct drm_local_map *map)
571 if (!drm_core_check_feature(dev, DRIVER_KMS_LEGACY_CONTEXT) &&
572 !drm_core_check_feature(dev, DRIVER_LEGACY))
575 mutex_lock(&dev->struct_mutex);
576 drm_legacy_rmmap_locked(dev, map);
577 mutex_unlock(&dev->struct_mutex);
579 EXPORT_SYMBOL(drm_legacy_rmmap);
581 void drm_legacy_master_rmmaps(struct drm_device *dev, struct drm_master *master)
583 struct drm_map_list *r_list, *list_temp;
585 if (!drm_core_check_feature(dev, DRIVER_LEGACY))
588 mutex_lock(&dev->struct_mutex);
589 list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head) {
590 if (r_list->master == master) {
591 drm_legacy_rmmap_locked(dev, r_list->map);
595 mutex_unlock(&dev->struct_mutex);
598 void drm_legacy_rmmaps(struct drm_device *dev)
600 struct drm_map_list *r_list, *list_temp;
602 list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head)
603 drm_legacy_rmmap(dev, r_list->map);
606 /* The rmmap ioctl appears to be unnecessary. All mappings are torn down on
607 * the last close of the device, and this is necessary for cleanup when things
608 * exit uncleanly. Therefore, having userland manually remove mappings seems
609 * like a pointless exercise since they're going away anyway.
611 * One use case might be after addmap is allowed for normal users for SHM and
612 * gets used by drivers that the server doesn't need to care about. This seems
615 * \param inode device inode.
616 * \param file_priv DRM file private.
617 * \param cmd command.
618 * \param arg pointer to a struct drm_map structure.
619 * \return zero on success or a negative value on error.
621 int drm_legacy_rmmap_ioctl(struct drm_device *dev, void *data,
622 struct drm_file *file_priv)
624 struct drm_map *request = data;
625 struct drm_local_map *map = NULL;
626 struct drm_map_list *r_list;
629 if (!drm_core_check_feature(dev, DRIVER_KMS_LEGACY_CONTEXT) &&
630 !drm_core_check_feature(dev, DRIVER_LEGACY))
633 mutex_lock(&dev->struct_mutex);
634 list_for_each_entry(r_list, &dev->maplist, head) {
636 r_list->user_token == (unsigned long)request->handle &&
637 r_list->map->flags & _DRM_REMOVABLE) {
643 /* List has wrapped around to the head pointer, or it's empty we didn't
646 if (list_empty(&dev->maplist) || !map) {
647 mutex_unlock(&dev->struct_mutex);
651 /* Register and framebuffer maps are permanent */
652 if ((map->type == _DRM_REGISTERS) || (map->type == _DRM_FRAME_BUFFER)) {
653 mutex_unlock(&dev->struct_mutex);
657 ret = drm_legacy_rmmap_locked(dev, map);
659 mutex_unlock(&dev->struct_mutex);
665 * Cleanup after an error on one of the addbufs() functions.
667 * \param dev DRM device.
668 * \param entry buffer entry where the error occurred.
670 * Frees any pages and buffers associated with the given entry.
672 static void drm_cleanup_buf_error(struct drm_device *dev,
673 struct drm_buf_entry *entry)
677 if (entry->seg_count) {
678 for (i = 0; i < entry->seg_count; i++) {
679 if (entry->seglist[i]) {
680 drm_pci_free(dev, entry->seglist[i]);
683 kfree(entry->seglist);
685 entry->seg_count = 0;
688 if (entry->buf_count) {
689 for (i = 0; i < entry->buf_count; i++) {
690 kfree(entry->buflist[i].dev_private);
692 kfree(entry->buflist);
694 entry->buf_count = 0;
698 #if IS_ENABLED(CONFIG_AGP)
700 * Add AGP buffers for DMA transfers.
702 * \param dev struct drm_device to which the buffers are to be added.
703 * \param request pointer to a struct drm_buf_desc describing the request.
704 * \return zero on success or a negative number on failure.
706 * After some sanity checks creates a drm_buf structure for each buffer and
707 * reallocates the buffer list of the same size order to accommodate the new
710 int drm_legacy_addbufs_agp(struct drm_device *dev,
711 struct drm_buf_desc *request)
713 struct drm_device_dma *dma = dev->dma;
714 struct drm_buf_entry *entry;
715 struct drm_agp_mem *agp_entry;
717 unsigned long offset;
718 unsigned long agp_offset;
727 struct drm_buf **temp_buflist;
732 count = request->count;
733 order = order_base_2(request->size);
736 alignment = (request->flags & _DRM_PAGE_ALIGN)
737 ? PAGE_ALIGN(size) : size;
738 page_order = order - PAGE_SHIFT > 0 ? order - PAGE_SHIFT : 0;
739 total = PAGE_SIZE << page_order;
742 agp_offset = dev->agp->base + request->agp_start;
744 DRM_DEBUG("count: %d\n", count);
745 DRM_DEBUG("order: %d\n", order);
746 DRM_DEBUG("size: %d\n", size);
747 DRM_DEBUG("agp_offset: %lx\n", agp_offset);
748 DRM_DEBUG("alignment: %d\n", alignment);
749 DRM_DEBUG("page_order: %d\n", page_order);
750 DRM_DEBUG("total: %d\n", total);
752 if (order < DRM_MIN_ORDER || order > DRM_MAX_ORDER)
755 /* Make sure buffers are located in AGP memory that we own */
757 list_for_each_entry(agp_entry, &dev->agp->memory, head) {
758 if ((agp_offset >= agp_entry->bound) &&
759 (agp_offset + total * count <= agp_entry->bound + agp_entry->pages * PAGE_SIZE)) {
764 if (!list_empty(&dev->agp->memory) && !valid) {
765 DRM_DEBUG("zone invalid\n");
768 spin_lock(&dev->buf_lock);
770 spin_unlock(&dev->buf_lock);
773 atomic_inc(&dev->buf_alloc);
774 spin_unlock(&dev->buf_lock);
776 mutex_lock(&dev->struct_mutex);
777 entry = &dma->bufs[order];
778 if (entry->buf_count) {
779 mutex_unlock(&dev->struct_mutex);
780 atomic_dec(&dev->buf_alloc);
781 return -ENOMEM; /* May only call once for each order */
784 if (count < 0 || count > 4096) {
785 mutex_unlock(&dev->struct_mutex);
786 atomic_dec(&dev->buf_alloc);
790 entry->buflist = kcalloc(count, sizeof(*entry->buflist), GFP_KERNEL);
791 if (!entry->buflist) {
792 mutex_unlock(&dev->struct_mutex);
793 atomic_dec(&dev->buf_alloc);
797 entry->buf_size = size;
798 entry->page_order = page_order;
802 while (entry->buf_count < count) {
803 buf = &entry->buflist[entry->buf_count];
804 buf->idx = dma->buf_count + entry->buf_count;
805 buf->total = alignment;
809 buf->offset = (dma->byte_count + offset);
810 buf->bus_address = agp_offset + offset;
811 buf->address = (void *)(agp_offset + offset);
815 buf->file_priv = NULL;
817 buf->dev_priv_size = dev->driver->dev_priv_size;
818 buf->dev_private = kzalloc(buf->dev_priv_size, GFP_KERNEL);
819 if (!buf->dev_private) {
820 /* Set count correctly so we free the proper amount. */
821 entry->buf_count = count;
822 drm_cleanup_buf_error(dev, entry);
823 mutex_unlock(&dev->struct_mutex);
824 atomic_dec(&dev->buf_alloc);
828 DRM_DEBUG("buffer %d @ %p\n", entry->buf_count, buf->address);
832 byte_count += PAGE_SIZE << page_order;
835 DRM_DEBUG("byte_count: %d\n", byte_count);
837 temp_buflist = krealloc(dma->buflist,
838 (dma->buf_count + entry->buf_count) *
839 sizeof(*dma->buflist), GFP_KERNEL);
841 /* Free the entry because it isn't valid */
842 drm_cleanup_buf_error(dev, entry);
843 mutex_unlock(&dev->struct_mutex);
844 atomic_dec(&dev->buf_alloc);
847 dma->buflist = temp_buflist;
849 for (i = 0; i < entry->buf_count; i++) {
850 dma->buflist[i + dma->buf_count] = &entry->buflist[i];
853 dma->buf_count += entry->buf_count;
854 dma->seg_count += entry->seg_count;
855 dma->page_count += byte_count >> PAGE_SHIFT;
856 dma->byte_count += byte_count;
858 DRM_DEBUG("dma->buf_count : %d\n", dma->buf_count);
859 DRM_DEBUG("entry->buf_count : %d\n", entry->buf_count);
861 mutex_unlock(&dev->struct_mutex);
863 request->count = entry->buf_count;
864 request->size = size;
866 dma->flags = _DRM_DMA_USE_AGP;
868 atomic_dec(&dev->buf_alloc);
871 EXPORT_SYMBOL(drm_legacy_addbufs_agp);
872 #endif /* CONFIG_AGP */
874 int drm_legacy_addbufs_pci(struct drm_device *dev,
875 struct drm_buf_desc *request)
877 struct drm_device_dma *dma = dev->dma;
883 struct drm_buf_entry *entry;
884 drm_dma_handle_t *dmah;
887 unsigned long offset;
891 unsigned long *temp_pagelist;
892 struct drm_buf **temp_buflist;
894 if (!drm_core_check_feature(dev, DRIVER_PCI_DMA))
900 if (!capable(CAP_SYS_ADMIN))
903 count = request->count;
904 order = order_base_2(request->size);
907 DRM_DEBUG("count=%d, size=%d (%d), order=%d\n",
908 request->count, request->size, size, order);
910 if (order < DRM_MIN_ORDER || order > DRM_MAX_ORDER)
913 alignment = (request->flags & _DRM_PAGE_ALIGN)
914 ? PAGE_ALIGN(size) : size;
915 page_order = order - PAGE_SHIFT > 0 ? order - PAGE_SHIFT : 0;
916 total = PAGE_SIZE << page_order;
918 spin_lock(&dev->buf_lock);
920 spin_unlock(&dev->buf_lock);
923 atomic_inc(&dev->buf_alloc);
924 spin_unlock(&dev->buf_lock);
926 mutex_lock(&dev->struct_mutex);
927 entry = &dma->bufs[order];
928 if (entry->buf_count) {
929 mutex_unlock(&dev->struct_mutex);
930 atomic_dec(&dev->buf_alloc);
931 return -ENOMEM; /* May only call once for each order */
934 if (count < 0 || count > 4096) {
935 mutex_unlock(&dev->struct_mutex);
936 atomic_dec(&dev->buf_alloc);
940 entry->buflist = kcalloc(count, sizeof(*entry->buflist), GFP_KERNEL);
941 if (!entry->buflist) {
942 mutex_unlock(&dev->struct_mutex);
943 atomic_dec(&dev->buf_alloc);
947 entry->seglist = kcalloc(count, sizeof(*entry->seglist), GFP_KERNEL);
948 if (!entry->seglist) {
949 kfree(entry->buflist);
950 mutex_unlock(&dev->struct_mutex);
951 atomic_dec(&dev->buf_alloc);
955 /* Keep the original pagelist until we know all the allocations
958 temp_pagelist = kmalloc_array(dma->page_count + (count << page_order),
959 sizeof(*dma->pagelist),
961 if (!temp_pagelist) {
962 kfree(entry->buflist);
963 kfree(entry->seglist);
964 mutex_unlock(&dev->struct_mutex);
965 atomic_dec(&dev->buf_alloc);
968 memcpy(temp_pagelist,
969 dma->pagelist, dma->page_count * sizeof(*dma->pagelist));
970 DRM_DEBUG("pagelist: %d entries\n",
971 dma->page_count + (count << page_order));
973 entry->buf_size = size;
974 entry->page_order = page_order;
978 while (entry->buf_count < count) {
980 dmah = drm_pci_alloc(dev, PAGE_SIZE << page_order, 0x1000);
983 /* Set count correctly so we free the proper amount. */
984 entry->buf_count = count;
985 entry->seg_count = count;
986 drm_cleanup_buf_error(dev, entry);
987 kfree(temp_pagelist);
988 mutex_unlock(&dev->struct_mutex);
989 atomic_dec(&dev->buf_alloc);
992 entry->seglist[entry->seg_count++] = dmah;
993 for (i = 0; i < (1 << page_order); i++) {
994 DRM_DEBUG("page %d @ 0x%08lx\n",
995 dma->page_count + page_count,
996 (unsigned long)dmah->vaddr + PAGE_SIZE * i);
997 temp_pagelist[dma->page_count + page_count++]
998 = (unsigned long)dmah->vaddr + PAGE_SIZE * i;
1001 offset + size <= total && entry->buf_count < count;
1002 offset += alignment, ++entry->buf_count) {
1003 buf = &entry->buflist[entry->buf_count];
1004 buf->idx = dma->buf_count + entry->buf_count;
1005 buf->total = alignment;
1008 buf->offset = (dma->byte_count + byte_count + offset);
1009 buf->address = (void *)(dmah->vaddr + offset);
1010 buf->bus_address = dmah->busaddr + offset;
1014 buf->file_priv = NULL;
1016 buf->dev_priv_size = dev->driver->dev_priv_size;
1017 buf->dev_private = kzalloc(buf->dev_priv_size,
1019 if (!buf->dev_private) {
1020 /* Set count correctly so we free the proper amount. */
1021 entry->buf_count = count;
1022 entry->seg_count = count;
1023 drm_cleanup_buf_error(dev, entry);
1024 kfree(temp_pagelist);
1025 mutex_unlock(&dev->struct_mutex);
1026 atomic_dec(&dev->buf_alloc);
1030 DRM_DEBUG("buffer %d @ %p\n",
1031 entry->buf_count, buf->address);
1033 byte_count += PAGE_SIZE << page_order;
1036 temp_buflist = krealloc(dma->buflist,
1037 (dma->buf_count + entry->buf_count) *
1038 sizeof(*dma->buflist), GFP_KERNEL);
1039 if (!temp_buflist) {
1040 /* Free the entry because it isn't valid */
1041 drm_cleanup_buf_error(dev, entry);
1042 kfree(temp_pagelist);
1043 mutex_unlock(&dev->struct_mutex);
1044 atomic_dec(&dev->buf_alloc);
1047 dma->buflist = temp_buflist;
1049 for (i = 0; i < entry->buf_count; i++) {
1050 dma->buflist[i + dma->buf_count] = &entry->buflist[i];
1053 /* No allocations failed, so now we can replace the original pagelist
1056 if (dma->page_count) {
1057 kfree(dma->pagelist);
1059 dma->pagelist = temp_pagelist;
1061 dma->buf_count += entry->buf_count;
1062 dma->seg_count += entry->seg_count;
1063 dma->page_count += entry->seg_count << page_order;
1064 dma->byte_count += PAGE_SIZE * (entry->seg_count << page_order);
1066 mutex_unlock(&dev->struct_mutex);
1068 request->count = entry->buf_count;
1069 request->size = size;
1071 if (request->flags & _DRM_PCI_BUFFER_RO)
1072 dma->flags = _DRM_DMA_USE_PCI_RO;
1074 atomic_dec(&dev->buf_alloc);
1078 EXPORT_SYMBOL(drm_legacy_addbufs_pci);
1080 static int drm_legacy_addbufs_sg(struct drm_device *dev,
1081 struct drm_buf_desc *request)
1083 struct drm_device_dma *dma = dev->dma;
1084 struct drm_buf_entry *entry;
1085 struct drm_buf *buf;
1086 unsigned long offset;
1087 unsigned long agp_offset;
1096 struct drm_buf **temp_buflist;
1098 if (!drm_core_check_feature(dev, DRIVER_SG))
1104 if (!capable(CAP_SYS_ADMIN))
1107 count = request->count;
1108 order = order_base_2(request->size);
1111 alignment = (request->flags & _DRM_PAGE_ALIGN)
1112 ? PAGE_ALIGN(size) : size;
1113 page_order = order - PAGE_SHIFT > 0 ? order - PAGE_SHIFT : 0;
1114 total = PAGE_SIZE << page_order;
1117 agp_offset = request->agp_start;
1119 DRM_DEBUG("count: %d\n", count);
1120 DRM_DEBUG("order: %d\n", order);
1121 DRM_DEBUG("size: %d\n", size);
1122 DRM_DEBUG("agp_offset: %lu\n", agp_offset);
1123 DRM_DEBUG("alignment: %d\n", alignment);
1124 DRM_DEBUG("page_order: %d\n", page_order);
1125 DRM_DEBUG("total: %d\n", total);
1127 if (order < DRM_MIN_ORDER || order > DRM_MAX_ORDER)
1130 spin_lock(&dev->buf_lock);
1132 spin_unlock(&dev->buf_lock);
1135 atomic_inc(&dev->buf_alloc);
1136 spin_unlock(&dev->buf_lock);
1138 mutex_lock(&dev->struct_mutex);
1139 entry = &dma->bufs[order];
1140 if (entry->buf_count) {
1141 mutex_unlock(&dev->struct_mutex);
1142 atomic_dec(&dev->buf_alloc);
1143 return -ENOMEM; /* May only call once for each order */
1146 if (count < 0 || count > 4096) {
1147 mutex_unlock(&dev->struct_mutex);
1148 atomic_dec(&dev->buf_alloc);
1152 entry->buflist = kcalloc(count, sizeof(*entry->buflist), GFP_KERNEL);
1153 if (!entry->buflist) {
1154 mutex_unlock(&dev->struct_mutex);
1155 atomic_dec(&dev->buf_alloc);
1159 entry->buf_size = size;
1160 entry->page_order = page_order;
1164 while (entry->buf_count < count) {
1165 buf = &entry->buflist[entry->buf_count];
1166 buf->idx = dma->buf_count + entry->buf_count;
1167 buf->total = alignment;
1171 buf->offset = (dma->byte_count + offset);
1172 buf->bus_address = agp_offset + offset;
1173 buf->address = (void *)(agp_offset + offset
1174 + (unsigned long)dev->sg->virtual);
1178 buf->file_priv = NULL;
1180 buf->dev_priv_size = dev->driver->dev_priv_size;
1181 buf->dev_private = kzalloc(buf->dev_priv_size, GFP_KERNEL);
1182 if (!buf->dev_private) {
1183 /* Set count correctly so we free the proper amount. */
1184 entry->buf_count = count;
1185 drm_cleanup_buf_error(dev, entry);
1186 mutex_unlock(&dev->struct_mutex);
1187 atomic_dec(&dev->buf_alloc);
1191 DRM_DEBUG("buffer %d @ %p\n", entry->buf_count, buf->address);
1193 offset += alignment;
1195 byte_count += PAGE_SIZE << page_order;
1198 DRM_DEBUG("byte_count: %d\n", byte_count);
1200 temp_buflist = krealloc(dma->buflist,
1201 (dma->buf_count + entry->buf_count) *
1202 sizeof(*dma->buflist), GFP_KERNEL);
1203 if (!temp_buflist) {
1204 /* Free the entry because it isn't valid */
1205 drm_cleanup_buf_error(dev, entry);
1206 mutex_unlock(&dev->struct_mutex);
1207 atomic_dec(&dev->buf_alloc);
1210 dma->buflist = temp_buflist;
1212 for (i = 0; i < entry->buf_count; i++) {
1213 dma->buflist[i + dma->buf_count] = &entry->buflist[i];
1216 dma->buf_count += entry->buf_count;
1217 dma->seg_count += entry->seg_count;
1218 dma->page_count += byte_count >> PAGE_SHIFT;
1219 dma->byte_count += byte_count;
1221 DRM_DEBUG("dma->buf_count : %d\n", dma->buf_count);
1222 DRM_DEBUG("entry->buf_count : %d\n", entry->buf_count);
1224 mutex_unlock(&dev->struct_mutex);
1226 request->count = entry->buf_count;
1227 request->size = size;
1229 dma->flags = _DRM_DMA_USE_SG;
1231 atomic_dec(&dev->buf_alloc);
1236 * Add buffers for DMA transfers (ioctl).
1238 * \param inode device inode.
1239 * \param file_priv DRM file private.
1240 * \param cmd command.
1241 * \param arg pointer to a struct drm_buf_desc request.
1242 * \return zero on success or a negative number on failure.
1244 * According with the memory type specified in drm_buf_desc::flags and the
1245 * build options, it dispatches the call either to addbufs_agp(),
1246 * addbufs_sg() or addbufs_pci() for AGP, scatter-gather or consistent
1247 * PCI memory respectively.
1249 int drm_legacy_addbufs(struct drm_device *dev, void *data,
1250 struct drm_file *file_priv)
1252 struct drm_buf_desc *request = data;
1255 if (!drm_core_check_feature(dev, DRIVER_LEGACY))
1258 if (!drm_core_check_feature(dev, DRIVER_HAVE_DMA))
1261 #if IS_ENABLED(CONFIG_AGP)
1262 if (request->flags & _DRM_AGP_BUFFER)
1263 ret = drm_legacy_addbufs_agp(dev, request);
1266 if (request->flags & _DRM_SG_BUFFER)
1267 ret = drm_legacy_addbufs_sg(dev, request);
1268 else if (request->flags & _DRM_FB_BUFFER)
1271 ret = drm_legacy_addbufs_pci(dev, request);
1277 * Get information about the buffer mappings.
1279 * This was originally mean for debugging purposes, or by a sophisticated
1280 * client library to determine how best to use the available buffers (e.g.,
1281 * large buffers can be used for image transfer).
1283 * \param inode device inode.
1284 * \param file_priv DRM file private.
1285 * \param cmd command.
1286 * \param arg pointer to a drm_buf_info structure.
1287 * \return zero on success or a negative number on failure.
1289 * Increments drm_device::buf_use while holding the drm_device::buf_lock
1290 * lock, preventing of allocating more buffers after this call. Information
1291 * about each requested buffer is then copied into user space.
1293 int __drm_legacy_infobufs(struct drm_device *dev,
1295 int (*f)(void *, int, struct drm_buf_entry *))
1297 struct drm_device_dma *dma = dev->dma;
1301 if (!drm_core_check_feature(dev, DRIVER_LEGACY))
1304 if (!drm_core_check_feature(dev, DRIVER_HAVE_DMA))
1310 spin_lock(&dev->buf_lock);
1311 if (atomic_read(&dev->buf_alloc)) {
1312 spin_unlock(&dev->buf_lock);
1315 ++dev->buf_use; /* Can't allocate more after this call */
1316 spin_unlock(&dev->buf_lock);
1318 for (i = 0, count = 0; i < DRM_MAX_ORDER + 1; i++) {
1319 if (dma->bufs[i].buf_count)
1323 DRM_DEBUG("count = %d\n", count);
1326 for (i = 0, count = 0; i < DRM_MAX_ORDER + 1; i++) {
1327 struct drm_buf_entry *from = &dma->bufs[i];
1328 if (from->buf_count) {
1329 if (f(data, count, from) < 0)
1331 DRM_DEBUG("%d %d %d %d %d\n",
1333 dma->bufs[i].buf_count,
1334 dma->bufs[i].buf_size,
1335 dma->bufs[i].low_mark,
1336 dma->bufs[i].high_mark);
1346 static int copy_one_buf(void *data, int count, struct drm_buf_entry *from)
1348 struct drm_buf_info *request = data;
1349 struct drm_buf_desc __user *to = &request->list[count];
1350 struct drm_buf_desc v = {.count = from->buf_count,
1351 .size = from->buf_size,
1352 .low_mark = from->low_mark,
1353 .high_mark = from->high_mark};
1355 if (copy_to_user(to, &v, offsetof(struct drm_buf_desc, flags)))
1360 int drm_legacy_infobufs(struct drm_device *dev, void *data,
1361 struct drm_file *file_priv)
1363 struct drm_buf_info *request = data;
1364 return __drm_legacy_infobufs(dev, data, &request->count, copy_one_buf);
1368 * Specifies a low and high water mark for buffer allocation
1370 * \param inode device inode.
1371 * \param file_priv DRM file private.
1372 * \param cmd command.
1373 * \param arg a pointer to a drm_buf_desc structure.
1374 * \return zero on success or a negative number on failure.
1376 * Verifies that the size order is bounded between the admissible orders and
1377 * updates the respective drm_device_dma::bufs entry low and high water mark.
1379 * \note This ioctl is deprecated and mostly never used.
1381 int drm_legacy_markbufs(struct drm_device *dev, void *data,
1382 struct drm_file *file_priv)
1384 struct drm_device_dma *dma = dev->dma;
1385 struct drm_buf_desc *request = data;
1387 struct drm_buf_entry *entry;
1389 if (!drm_core_check_feature(dev, DRIVER_LEGACY))
1392 if (!drm_core_check_feature(dev, DRIVER_HAVE_DMA))
1398 DRM_DEBUG("%d, %d, %d\n",
1399 request->size, request->low_mark, request->high_mark);
1400 order = order_base_2(request->size);
1401 if (order < DRM_MIN_ORDER || order > DRM_MAX_ORDER)
1403 entry = &dma->bufs[order];
1405 if (request->low_mark < 0 || request->low_mark > entry->buf_count)
1407 if (request->high_mark < 0 || request->high_mark > entry->buf_count)
1410 entry->low_mark = request->low_mark;
1411 entry->high_mark = request->high_mark;
1417 * Unreserve the buffers in list, previously reserved using drmDMA.
1419 * \param inode device inode.
1420 * \param file_priv DRM file private.
1421 * \param cmd command.
1422 * \param arg pointer to a drm_buf_free structure.
1423 * \return zero on success or a negative number on failure.
1425 * Calls free_buffer() for each used buffer.
1426 * This function is primarily used for debugging.
1428 int drm_legacy_freebufs(struct drm_device *dev, void *data,
1429 struct drm_file *file_priv)
1431 struct drm_device_dma *dma = dev->dma;
1432 struct drm_buf_free *request = data;
1435 struct drm_buf *buf;
1437 if (!drm_core_check_feature(dev, DRIVER_LEGACY))
1440 if (!drm_core_check_feature(dev, DRIVER_HAVE_DMA))
1446 DRM_DEBUG("%d\n", request->count);
1447 for (i = 0; i < request->count; i++) {
1448 if (copy_from_user(&idx, &request->list[i], sizeof(idx)))
1450 if (idx < 0 || idx >= dma->buf_count) {
1451 DRM_ERROR("Index %d (of %d max)\n",
1452 idx, dma->buf_count - 1);
1455 idx = array_index_nospec(idx, dma->buf_count);
1456 buf = dma->buflist[idx];
1457 if (buf->file_priv != file_priv) {
1458 DRM_ERROR("Process %d freeing buffer not owned\n",
1459 task_pid_nr(current));
1462 drm_legacy_free_buffer(dev, buf);
1469 * Maps all of the DMA buffers into client-virtual space (ioctl).
1471 * \param inode device inode.
1472 * \param file_priv DRM file private.
1473 * \param cmd command.
1474 * \param arg pointer to a drm_buf_map structure.
1475 * \return zero on success or a negative number on failure.
1477 * Maps the AGP, SG or PCI buffer region with vm_mmap(), and copies information
1478 * about each buffer into user space. For PCI buffers, it calls vm_mmap() with
1479 * offset equal to 0, which drm_mmap() interpretes as PCI buffers and calls
1482 int __drm_legacy_mapbufs(struct drm_device *dev, void *data, int *p,
1484 int (*f)(void *, int, unsigned long,
1486 struct drm_file *file_priv)
1488 struct drm_device_dma *dma = dev->dma;
1490 unsigned long virtual;
1493 if (!drm_core_check_feature(dev, DRIVER_LEGACY))
1496 if (!drm_core_check_feature(dev, DRIVER_HAVE_DMA))
1502 spin_lock(&dev->buf_lock);
1503 if (atomic_read(&dev->buf_alloc)) {
1504 spin_unlock(&dev->buf_lock);
1507 dev->buf_use++; /* Can't allocate more after this call */
1508 spin_unlock(&dev->buf_lock);
1510 if (*p >= dma->buf_count) {
1511 if ((dev->agp && (dma->flags & _DRM_DMA_USE_AGP))
1512 || (drm_core_check_feature(dev, DRIVER_SG)
1513 && (dma->flags & _DRM_DMA_USE_SG))) {
1514 struct drm_local_map *map = dev->agp_buffer_map;
1515 unsigned long token = dev->agp_buffer_token;
1521 virtual = vm_mmap(file_priv->filp, 0, map->size,
1522 PROT_READ | PROT_WRITE,
1526 virtual = vm_mmap(file_priv->filp, 0, dma->byte_count,
1527 PROT_READ | PROT_WRITE,
1530 if (virtual > -1024UL) {
1532 retcode = (signed long)virtual;
1535 *v = (void __user *)virtual;
1537 for (i = 0; i < dma->buf_count; i++) {
1538 if (f(data, i, virtual, dma->buflist[i]) < 0) {
1545 *p = dma->buf_count;
1546 DRM_DEBUG("%d buffers, retcode = %d\n", *p, retcode);
1551 static int map_one_buf(void *data, int idx, unsigned long virtual,
1552 struct drm_buf *buf)
1554 struct drm_buf_map *request = data;
1555 unsigned long address = virtual + buf->offset; /* *** */
1557 if (copy_to_user(&request->list[idx].idx, &buf->idx,
1558 sizeof(request->list[0].idx)))
1560 if (copy_to_user(&request->list[idx].total, &buf->total,
1561 sizeof(request->list[0].total)))
1563 if (clear_user(&request->list[idx].used, sizeof(int)))
1565 if (copy_to_user(&request->list[idx].address, &address,
1571 int drm_legacy_mapbufs(struct drm_device *dev, void *data,
1572 struct drm_file *file_priv)
1574 struct drm_buf_map *request = data;
1575 return __drm_legacy_mapbufs(dev, data, &request->count,
1576 &request->virtual, map_one_buf,
1580 int drm_legacy_dma_ioctl(struct drm_device *dev, void *data,
1581 struct drm_file *file_priv)
1583 if (!drm_core_check_feature(dev, DRIVER_LEGACY))
1586 if (dev->driver->dma_ioctl)
1587 return dev->driver->dma_ioctl(dev, data, file_priv);
1592 struct drm_local_map *drm_legacy_getsarea(struct drm_device *dev)
1594 struct drm_map_list *entry;
1596 list_for_each_entry(entry, &dev->maplist, head) {
1597 if (entry->map && entry->map->type == _DRM_SHM &&
1598 (entry->map->flags & _DRM_CONTAINS_LOCK)) {
1604 EXPORT_SYMBOL(drm_legacy_getsarea);