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.
8 * Author: Rickard E. (Rik) Faith <faith@valinux.com>
9 * Author: Gareth Hughes <gareth@valinux.com>
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/pci.h>
37 #include <linux/slab.h>
38 #include <linux/uaccess.h>
39 #include <linux/vmalloc.h>
41 #include <asm/shmparam.h>
43 #include <drm/drm_device.h>
44 #include <drm/drm_drv.h>
45 #include <drm/drm_file.h>
46 #include <drm/drm_print.h>
48 #include "drm_legacy.h"
51 static struct drm_map_list *drm_find_matching_map(struct drm_device *dev,
52 struct drm_local_map *map)
54 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))
80 default: /* Make gcc happy */
83 if (entry->map->offset == map->offset)
90 static int drm_map_handle(struct drm_device *dev, struct drm_hash_item *hash,
91 unsigned long user_token, int hashed_handle, int shm)
93 int use_hashed_handle, shift;
96 #if (BITS_PER_LONG == 64)
97 use_hashed_handle = ((user_token & 0xFFFFFFFF00000000UL) || hashed_handle);
98 #elif (BITS_PER_LONG == 32)
99 use_hashed_handle = hashed_handle;
101 #error Unsupported long size. Neither 64 nor 32 bits.
104 if (!use_hashed_handle) {
107 hash->key = user_token >> PAGE_SHIFT;
108 ret = drm_ht_insert_item(&dev->map_hash, hash);
114 add = DRM_MAP_HASH_OFFSET >> PAGE_SHIFT;
115 if (shm && (SHMLBA > PAGE_SIZE)) {
116 int bits = ilog2(SHMLBA >> PAGE_SHIFT) + 1;
118 /* For shared memory, we have to preserve the SHMLBA
119 * bits of the eventual vma->vm_pgoff value during
120 * mmap(). Otherwise we run into cache aliasing problems
121 * on some platforms. On these platforms, the pgoff of
122 * a mmap() request is used to pick a suitable virtual
123 * address for the mmap() region such that it will not
124 * cause cache aliasing problems.
126 * Therefore, make sure the SHMLBA relevant bits of the
127 * hash value we use are equal to those in the original
128 * kernel virtual address.
131 add |= ((user_token >> PAGE_SHIFT) & ((1UL << bits) - 1UL));
134 return drm_ht_just_insert_please(&dev->map_hash, hash,
135 user_token, 32 - PAGE_SHIFT - 3,
140 * Core function to create a range of memory available for mapping by a
143 * Adjusts the memory offset to its absolute value according to the mapping
144 * type. Adds the map to the map list drm_device::maplist. Adds MTRR's where
145 * applicable and if supported by the kernel.
147 static int drm_addmap_core(struct drm_device *dev, resource_size_t offset,
148 unsigned int size, enum drm_map_type type,
149 enum drm_map_flags flags,
150 struct drm_map_list **maplist)
152 struct drm_local_map *map;
153 struct drm_map_list *list;
154 unsigned long user_token;
157 map = kmalloc(sizeof(*map), GFP_KERNEL);
161 map->offset = offset;
166 /* Only allow shared memory to be removable since we only keep enough
167 * book keeping information about shared memory to allow for removal
168 * when processes fork.
170 if ((map->flags & _DRM_REMOVABLE) && map->type != _DRM_SHM) {
174 DRM_DEBUG("offset = 0x%08llx, size = 0x%08lx, type = %d\n",
175 (unsigned long long)map->offset, map->size, map->type);
177 /* page-align _DRM_SHM maps. They are allocated here so there is no security
178 * hole created by that and it works around various broken drivers that use
179 * a non-aligned quantity to map the SAREA. --BenH
181 if (map->type == _DRM_SHM)
182 map->size = PAGE_ALIGN(map->size);
184 if ((map->offset & (~(resource_size_t)PAGE_MASK)) || (map->size & (~PAGE_MASK))) {
193 case _DRM_FRAME_BUFFER:
194 #if !defined(__sparc__) && !defined(__alpha__) && !defined(__ia64__) && !defined(__powerpc64__) && !defined(__x86_64__) && !defined(__arm__)
195 if (map->offset + (map->size-1) < map->offset ||
196 map->offset < virt_to_phys(high_memory)) {
201 /* Some drivers preinitialize some maps, without the X Server
202 * needing to be aware of it. Therefore, we just return success
203 * when the server tries to create a duplicate map.
205 list = drm_find_matching_map(dev, map);
207 if (list->map->size != map->size) {
208 DRM_DEBUG("Matching maps of type %d with "
209 "mismatched sizes, (%ld vs %ld)\n",
210 map->type, map->size,
212 list->map->size = map->size;
220 if (map->type == _DRM_FRAME_BUFFER ||
221 (map->flags & _DRM_WRITE_COMBINING)) {
223 arch_phys_wc_add(map->offset, map->size);
225 if (map->type == _DRM_REGISTERS) {
226 if (map->flags & _DRM_WRITE_COMBINING)
227 map->handle = ioremap_wc(map->offset,
230 map->handle = ioremap(map->offset, map->size);
239 list = drm_find_matching_map(dev, map);
241 if (list->map->size != map->size) {
242 DRM_DEBUG("Matching maps of type %d with "
243 "mismatched sizes, (%ld vs %ld)\n",
244 map->type, map->size, list->map->size);
245 list->map->size = map->size;
252 map->handle = vmalloc_user(map->size);
253 DRM_DEBUG("%lu %d %p\n",
254 map->size, order_base_2(map->size), map->handle);
259 map->offset = (unsigned long)map->handle;
260 if (map->flags & _DRM_CONTAINS_LOCK) {
261 /* Prevent a 2nd X Server from creating a 2nd lock */
262 if (dev->master->lock.hw_lock != NULL) {
267 dev->sigdata.lock = dev->master->lock.hw_lock = map->handle; /* Pointer to lock */
271 struct drm_agp_mem *entry;
279 map->offset += dev->hose->mem_space->start;
281 /* In some cases (i810 driver), user space may have already
282 * added the AGP base itself, because dev->agp->base previously
283 * only got set during AGP enable. So, only add the base
284 * address if the map's offset isn't already within the
287 if (map->offset < dev->agp->base ||
288 map->offset > dev->agp->base +
289 dev->agp->agp_info.aper_size * 1024 * 1024 - 1) {
290 map->offset += dev->agp->base;
292 map->mtrr = dev->agp->agp_mtrr; /* for getmap */
294 /* This assumes the DRM is in total control of AGP space.
295 * It's not always the case as AGP can be in the control
296 * of user space (i.e. i810 driver). So this loop will get
297 * skipped and we double check that dev->agp->memory is
298 * actually set as well as being invalid before EPERM'ing
300 list_for_each_entry(entry, &dev->agp->memory, head) {
301 if ((map->offset >= entry->bound) &&
302 (map->offset + map->size <= entry->bound + entry->pages * PAGE_SIZE)) {
307 if (!list_empty(&dev->agp->memory) && !valid) {
311 DRM_DEBUG("AGP offset = 0x%08llx, size = 0x%08lx\n",
312 (unsigned long long)map->offset, map->size);
316 case _DRM_SCATTER_GATHER:
321 map->offset += (unsigned long)dev->sg->virtual;
323 case _DRM_CONSISTENT:
324 /* dma_addr_t is 64bit on i386 with CONFIG_HIGHMEM64G,
325 * As we're limiting the address to 2^32-1 (or less),
326 * casting it down to 32 bits is no problem, but we
327 * need to point to a 64bit variable first.
329 map->handle = dma_alloc_coherent(dev->dev,
343 list = kzalloc(sizeof(*list), GFP_KERNEL);
345 if (map->type == _DRM_REGISTERS)
346 iounmap(map->handle);
352 mutex_lock(&dev->struct_mutex);
353 list_add(&list->head, &dev->maplist);
355 /* Assign a 32-bit handle */
356 /* We do it here so that dev->struct_mutex protects the increment */
357 user_token = (map->type == _DRM_SHM) ? (unsigned long)map->handle :
359 ret = drm_map_handle(dev, &list->hash, user_token, 0,
360 (map->type == _DRM_SHM));
362 if (map->type == _DRM_REGISTERS)
363 iounmap(map->handle);
366 mutex_unlock(&dev->struct_mutex);
370 list->user_token = list->hash.key << PAGE_SHIFT;
371 mutex_unlock(&dev->struct_mutex);
373 if (!(map->flags & _DRM_DRIVER))
374 list->master = dev->master;
379 int drm_legacy_addmap(struct drm_device *dev, resource_size_t offset,
380 unsigned int size, enum drm_map_type type,
381 enum drm_map_flags flags, struct drm_local_map **map_ptr)
383 struct drm_map_list *list;
386 rc = drm_addmap_core(dev, offset, size, type, flags, &list);
388 *map_ptr = list->map;
391 EXPORT_SYMBOL(drm_legacy_addmap);
393 struct drm_local_map *drm_legacy_findmap(struct drm_device *dev,
396 struct drm_map_list *_entry;
398 list_for_each_entry(_entry, &dev->maplist, head)
399 if (_entry->user_token == token)
403 EXPORT_SYMBOL(drm_legacy_findmap);
406 * Ioctl to specify a range of memory that is available for mapping by a
409 * \param inode device inode.
410 * \param file_priv DRM file private.
411 * \param cmd command.
412 * \param arg pointer to a drm_map structure.
413 * \return zero on success or a negative value on error.
416 int drm_legacy_addmap_ioctl(struct drm_device *dev, void *data,
417 struct drm_file *file_priv)
419 struct drm_map *map = data;
420 struct drm_map_list *maplist;
423 if (!(capable(CAP_SYS_ADMIN) || map->type == _DRM_AGP || map->type == _DRM_SHM))
426 if (!drm_core_check_feature(dev, DRIVER_KMS_LEGACY_CONTEXT) &&
427 !drm_core_check_feature(dev, DRIVER_LEGACY))
430 err = drm_addmap_core(dev, map->offset, map->size, map->type,
431 map->flags, &maplist);
436 /* avoid a warning on 64-bit, this casting isn't very nice, but the API is set so too late */
437 map->handle = (void *)(unsigned long)maplist->user_token;
440 * It appears that there are no users of this value whatsoever --
441 * drmAddMap just discards it. Let's not encourage its use.
442 * (Keeping drm_addmap_core's returned mtrr value would be wrong --
443 * it's not a real mtrr index anymore.)
451 * Get a mapping information.
453 * \param inode device inode.
454 * \param file_priv DRM file private.
455 * \param cmd command.
456 * \param arg user argument, pointing to a drm_map structure.
458 * \return zero on success or a negative number on failure.
460 * Searches for the mapping with the specified offset and copies its information
463 int drm_legacy_getmap_ioctl(struct drm_device *dev, void *data,
464 struct drm_file *file_priv)
466 struct drm_map *map = data;
467 struct drm_map_list *r_list = NULL;
468 struct list_head *list;
472 if (!drm_core_check_feature(dev, DRIVER_KMS_LEGACY_CONTEXT) &&
473 !drm_core_check_feature(dev, DRIVER_LEGACY))
481 mutex_lock(&dev->struct_mutex);
482 list_for_each(list, &dev->maplist) {
484 r_list = list_entry(list, struct drm_map_list, head);
489 if (!r_list || !r_list->map) {
490 mutex_unlock(&dev->struct_mutex);
494 map->offset = r_list->map->offset;
495 map->size = r_list->map->size;
496 map->type = r_list->map->type;
497 map->flags = r_list->map->flags;
498 map->handle = (void *)(unsigned long) r_list->user_token;
499 map->mtrr = arch_phys_wc_index(r_list->map->mtrr);
501 mutex_unlock(&dev->struct_mutex);
507 * Remove a map private from list and deallocate resources if the mapping
510 * Searches the map on drm_device::maplist, removes it from the list, see if
511 * it's being used, and free any associated resource (such as MTRR's) if it's not
514 * \sa drm_legacy_addmap
516 int drm_legacy_rmmap_locked(struct drm_device *dev, struct drm_local_map *map)
518 struct drm_map_list *r_list = NULL, *list_t;
520 struct drm_master *master;
522 /* Find the list entry for the map and remove it */
523 list_for_each_entry_safe(r_list, list_t, &dev->maplist, head) {
524 if (r_list->map == map) {
525 master = r_list->master;
526 list_del(&r_list->head);
527 drm_ht_remove_key(&dev->map_hash,
528 r_list->user_token >> PAGE_SHIFT);
540 iounmap(map->handle);
542 case _DRM_FRAME_BUFFER:
543 arch_phys_wc_del(map->mtrr);
548 if (dev->sigdata.lock == master->lock.hw_lock)
549 dev->sigdata.lock = NULL;
550 master->lock.hw_lock = NULL; /* SHM removed */
551 master->lock.file_priv = NULL;
552 wake_up_interruptible_all(&master->lock.lock_queue);
556 case _DRM_SCATTER_GATHER:
558 case _DRM_CONSISTENT:
559 dma_free_coherent(dev->dev,
569 EXPORT_SYMBOL(drm_legacy_rmmap_locked);
571 void drm_legacy_rmmap(struct drm_device *dev, struct drm_local_map *map)
573 if (!drm_core_check_feature(dev, DRIVER_KMS_LEGACY_CONTEXT) &&
574 !drm_core_check_feature(dev, DRIVER_LEGACY))
577 mutex_lock(&dev->struct_mutex);
578 drm_legacy_rmmap_locked(dev, map);
579 mutex_unlock(&dev->struct_mutex);
581 EXPORT_SYMBOL(drm_legacy_rmmap);
583 void drm_legacy_master_rmmaps(struct drm_device *dev, struct drm_master *master)
585 struct drm_map_list *r_list, *list_temp;
587 if (!drm_core_check_feature(dev, DRIVER_LEGACY))
590 mutex_lock(&dev->struct_mutex);
591 list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head) {
592 if (r_list->master == master) {
593 drm_legacy_rmmap_locked(dev, r_list->map);
597 mutex_unlock(&dev->struct_mutex);
600 void drm_legacy_rmmaps(struct drm_device *dev)
602 struct drm_map_list *r_list, *list_temp;
604 list_for_each_entry_safe(r_list, list_temp, &dev->maplist, head)
605 drm_legacy_rmmap(dev, r_list->map);
608 /* The rmmap ioctl appears to be unnecessary. All mappings are torn down on
609 * the last close of the device, and this is necessary for cleanup when things
610 * exit uncleanly. Therefore, having userland manually remove mappings seems
611 * like a pointless exercise since they're going away anyway.
613 * One use case might be after addmap is allowed for normal users for SHM and
614 * gets used by drivers that the server doesn't need to care about. This seems
617 * \param inode device inode.
618 * \param file_priv DRM file private.
619 * \param cmd command.
620 * \param arg pointer to a struct drm_map structure.
621 * \return zero on success or a negative value on error.
623 int drm_legacy_rmmap_ioctl(struct drm_device *dev, void *data,
624 struct drm_file *file_priv)
626 struct drm_map *request = data;
627 struct drm_local_map *map = NULL;
628 struct drm_map_list *r_list;
631 if (!drm_core_check_feature(dev, DRIVER_KMS_LEGACY_CONTEXT) &&
632 !drm_core_check_feature(dev, DRIVER_LEGACY))
635 mutex_lock(&dev->struct_mutex);
636 list_for_each_entry(r_list, &dev->maplist, head) {
638 r_list->user_token == (unsigned long)request->handle &&
639 r_list->map->flags & _DRM_REMOVABLE) {
645 /* List has wrapped around to the head pointer, or it's empty we didn't
648 if (list_empty(&dev->maplist) || !map) {
649 mutex_unlock(&dev->struct_mutex);
653 /* Register and framebuffer maps are permanent */
654 if ((map->type == _DRM_REGISTERS) || (map->type == _DRM_FRAME_BUFFER)) {
655 mutex_unlock(&dev->struct_mutex);
659 ret = drm_legacy_rmmap_locked(dev, map);
661 mutex_unlock(&dev->struct_mutex);
667 * Cleanup after an error on one of the addbufs() functions.
669 * \param dev DRM device.
670 * \param entry buffer entry where the error occurred.
672 * Frees any pages and buffers associated with the given entry.
674 static void drm_cleanup_buf_error(struct drm_device *dev,
675 struct drm_buf_entry *entry)
677 drm_dma_handle_t *dmah;
680 if (entry->seg_count) {
681 for (i = 0; i < entry->seg_count; i++) {
682 if (entry->seglist[i]) {
683 dmah = entry->seglist[i];
684 dma_free_coherent(dev->dev,
691 kfree(entry->seglist);
693 entry->seg_count = 0;
696 if (entry->buf_count) {
697 for (i = 0; i < entry->buf_count; i++) {
698 kfree(entry->buflist[i].dev_private);
700 kfree(entry->buflist);
702 entry->buf_count = 0;
706 #if IS_ENABLED(CONFIG_AGP)
708 * Add AGP buffers for DMA transfers.
710 * \param dev struct drm_device to which the buffers are to be added.
711 * \param request pointer to a struct drm_buf_desc describing the request.
712 * \return zero on success or a negative number on failure.
714 * After some sanity checks creates a drm_buf structure for each buffer and
715 * reallocates the buffer list of the same size order to accommodate the new
718 int drm_legacy_addbufs_agp(struct drm_device *dev,
719 struct drm_buf_desc *request)
721 struct drm_device_dma *dma = dev->dma;
722 struct drm_buf_entry *entry;
723 struct drm_agp_mem *agp_entry;
725 unsigned long offset;
726 unsigned long agp_offset;
735 struct drm_buf **temp_buflist;
740 count = request->count;
741 order = order_base_2(request->size);
744 alignment = (request->flags & _DRM_PAGE_ALIGN)
745 ? PAGE_ALIGN(size) : size;
746 page_order = order - PAGE_SHIFT > 0 ? order - PAGE_SHIFT : 0;
747 total = PAGE_SIZE << page_order;
750 agp_offset = dev->agp->base + request->agp_start;
752 DRM_DEBUG("count: %d\n", count);
753 DRM_DEBUG("order: %d\n", order);
754 DRM_DEBUG("size: %d\n", size);
755 DRM_DEBUG("agp_offset: %lx\n", agp_offset);
756 DRM_DEBUG("alignment: %d\n", alignment);
757 DRM_DEBUG("page_order: %d\n", page_order);
758 DRM_DEBUG("total: %d\n", total);
760 if (order < DRM_MIN_ORDER || order > DRM_MAX_ORDER)
763 /* Make sure buffers are located in AGP memory that we own */
765 list_for_each_entry(agp_entry, &dev->agp->memory, head) {
766 if ((agp_offset >= agp_entry->bound) &&
767 (agp_offset + total * count <= agp_entry->bound + agp_entry->pages * PAGE_SIZE)) {
772 if (!list_empty(&dev->agp->memory) && !valid) {
773 DRM_DEBUG("zone invalid\n");
776 spin_lock(&dev->buf_lock);
778 spin_unlock(&dev->buf_lock);
781 atomic_inc(&dev->buf_alloc);
782 spin_unlock(&dev->buf_lock);
784 mutex_lock(&dev->struct_mutex);
785 entry = &dma->bufs[order];
786 if (entry->buf_count) {
787 mutex_unlock(&dev->struct_mutex);
788 atomic_dec(&dev->buf_alloc);
789 return -ENOMEM; /* May only call once for each order */
792 if (count < 0 || count > 4096) {
793 mutex_unlock(&dev->struct_mutex);
794 atomic_dec(&dev->buf_alloc);
798 entry->buflist = kcalloc(count, sizeof(*entry->buflist), GFP_KERNEL);
799 if (!entry->buflist) {
800 mutex_unlock(&dev->struct_mutex);
801 atomic_dec(&dev->buf_alloc);
805 entry->buf_size = size;
806 entry->page_order = page_order;
810 while (entry->buf_count < count) {
811 buf = &entry->buflist[entry->buf_count];
812 buf->idx = dma->buf_count + entry->buf_count;
813 buf->total = alignment;
817 buf->offset = (dma->byte_count + offset);
818 buf->bus_address = agp_offset + offset;
819 buf->address = (void *)(agp_offset + offset);
823 buf->file_priv = NULL;
825 buf->dev_priv_size = dev->driver->dev_priv_size;
826 buf->dev_private = kzalloc(buf->dev_priv_size, GFP_KERNEL);
827 if (!buf->dev_private) {
828 /* Set count correctly so we free the proper amount. */
829 entry->buf_count = count;
830 drm_cleanup_buf_error(dev, entry);
831 mutex_unlock(&dev->struct_mutex);
832 atomic_dec(&dev->buf_alloc);
836 DRM_DEBUG("buffer %d @ %p\n", entry->buf_count, buf->address);
840 byte_count += PAGE_SIZE << page_order;
843 DRM_DEBUG("byte_count: %d\n", byte_count);
845 temp_buflist = krealloc(dma->buflist,
846 (dma->buf_count + entry->buf_count) *
847 sizeof(*dma->buflist), GFP_KERNEL);
849 /* Free the entry because it isn't valid */
850 drm_cleanup_buf_error(dev, entry);
851 mutex_unlock(&dev->struct_mutex);
852 atomic_dec(&dev->buf_alloc);
855 dma->buflist = temp_buflist;
857 for (i = 0; i < entry->buf_count; i++) {
858 dma->buflist[i + dma->buf_count] = &entry->buflist[i];
861 dma->buf_count += entry->buf_count;
862 dma->seg_count += entry->seg_count;
863 dma->page_count += byte_count >> PAGE_SHIFT;
864 dma->byte_count += byte_count;
866 DRM_DEBUG("dma->buf_count : %d\n", dma->buf_count);
867 DRM_DEBUG("entry->buf_count : %d\n", entry->buf_count);
869 mutex_unlock(&dev->struct_mutex);
871 request->count = entry->buf_count;
872 request->size = size;
874 dma->flags = _DRM_DMA_USE_AGP;
876 atomic_dec(&dev->buf_alloc);
879 EXPORT_SYMBOL(drm_legacy_addbufs_agp);
880 #endif /* CONFIG_AGP */
882 int drm_legacy_addbufs_pci(struct drm_device *dev,
883 struct drm_buf_desc *request)
885 struct drm_device_dma *dma = dev->dma;
891 struct drm_buf_entry *entry;
892 drm_dma_handle_t *dmah;
895 unsigned long offset;
899 unsigned long *temp_pagelist;
900 struct drm_buf **temp_buflist;
902 if (!drm_core_check_feature(dev, DRIVER_PCI_DMA))
908 if (!capable(CAP_SYS_ADMIN))
911 count = request->count;
912 order = order_base_2(request->size);
915 DRM_DEBUG("count=%d, size=%d (%d), order=%d\n",
916 request->count, request->size, size, order);
918 if (order < DRM_MIN_ORDER || order > DRM_MAX_ORDER)
921 alignment = (request->flags & _DRM_PAGE_ALIGN)
922 ? PAGE_ALIGN(size) : size;
923 page_order = order - PAGE_SHIFT > 0 ? order - PAGE_SHIFT : 0;
924 total = PAGE_SIZE << page_order;
926 spin_lock(&dev->buf_lock);
928 spin_unlock(&dev->buf_lock);
931 atomic_inc(&dev->buf_alloc);
932 spin_unlock(&dev->buf_lock);
934 mutex_lock(&dev->struct_mutex);
935 entry = &dma->bufs[order];
936 if (entry->buf_count) {
937 mutex_unlock(&dev->struct_mutex);
938 atomic_dec(&dev->buf_alloc);
939 return -ENOMEM; /* May only call once for each order */
942 if (count < 0 || count > 4096) {
943 mutex_unlock(&dev->struct_mutex);
944 atomic_dec(&dev->buf_alloc);
948 entry->buflist = kcalloc(count, sizeof(*entry->buflist), GFP_KERNEL);
949 if (!entry->buflist) {
950 mutex_unlock(&dev->struct_mutex);
951 atomic_dec(&dev->buf_alloc);
955 entry->seglist = kcalloc(count, sizeof(*entry->seglist), GFP_KERNEL);
956 if (!entry->seglist) {
957 kfree(entry->buflist);
958 mutex_unlock(&dev->struct_mutex);
959 atomic_dec(&dev->buf_alloc);
963 /* Keep the original pagelist until we know all the allocations
966 temp_pagelist = kmalloc_array(dma->page_count + (count << page_order),
967 sizeof(*dma->pagelist),
969 if (!temp_pagelist) {
970 kfree(entry->buflist);
971 kfree(entry->seglist);
972 mutex_unlock(&dev->struct_mutex);
973 atomic_dec(&dev->buf_alloc);
976 memcpy(temp_pagelist,
977 dma->pagelist, dma->page_count * sizeof(*dma->pagelist));
978 DRM_DEBUG("pagelist: %d entries\n",
979 dma->page_count + (count << page_order));
981 entry->buf_size = size;
982 entry->page_order = page_order;
986 while (entry->buf_count < count) {
987 dmah = kmalloc(sizeof(drm_dma_handle_t), GFP_KERNEL);
989 /* Set count correctly so we free the proper amount. */
990 entry->buf_count = count;
991 entry->seg_count = count;
992 drm_cleanup_buf_error(dev, entry);
993 kfree(temp_pagelist);
994 mutex_unlock(&dev->struct_mutex);
995 atomic_dec(&dev->buf_alloc);
1000 dmah->vaddr = dma_alloc_coherent(dev->dev,
1007 /* Set count correctly so we free the proper amount. */
1008 entry->buf_count = count;
1009 entry->seg_count = count;
1010 drm_cleanup_buf_error(dev, entry);
1011 kfree(temp_pagelist);
1012 mutex_unlock(&dev->struct_mutex);
1013 atomic_dec(&dev->buf_alloc);
1016 entry->seglist[entry->seg_count++] = dmah;
1017 for (i = 0; i < (1 << page_order); i++) {
1018 DRM_DEBUG("page %d @ 0x%08lx\n",
1019 dma->page_count + page_count,
1020 (unsigned long)dmah->vaddr + PAGE_SIZE * i);
1021 temp_pagelist[dma->page_count + page_count++]
1022 = (unsigned long)dmah->vaddr + PAGE_SIZE * i;
1025 offset + size <= total && entry->buf_count < count;
1026 offset += alignment, ++entry->buf_count) {
1027 buf = &entry->buflist[entry->buf_count];
1028 buf->idx = dma->buf_count + entry->buf_count;
1029 buf->total = alignment;
1032 buf->offset = (dma->byte_count + byte_count + offset);
1033 buf->address = (void *)(dmah->vaddr + offset);
1034 buf->bus_address = dmah->busaddr + offset;
1038 buf->file_priv = NULL;
1040 buf->dev_priv_size = dev->driver->dev_priv_size;
1041 buf->dev_private = kzalloc(buf->dev_priv_size,
1043 if (!buf->dev_private) {
1044 /* Set count correctly so we free the proper amount. */
1045 entry->buf_count = count;
1046 entry->seg_count = count;
1047 drm_cleanup_buf_error(dev, entry);
1048 kfree(temp_pagelist);
1049 mutex_unlock(&dev->struct_mutex);
1050 atomic_dec(&dev->buf_alloc);
1054 DRM_DEBUG("buffer %d @ %p\n",
1055 entry->buf_count, buf->address);
1057 byte_count += PAGE_SIZE << page_order;
1060 temp_buflist = krealloc(dma->buflist,
1061 (dma->buf_count + entry->buf_count) *
1062 sizeof(*dma->buflist), GFP_KERNEL);
1063 if (!temp_buflist) {
1064 /* Free the entry because it isn't valid */
1065 drm_cleanup_buf_error(dev, entry);
1066 kfree(temp_pagelist);
1067 mutex_unlock(&dev->struct_mutex);
1068 atomic_dec(&dev->buf_alloc);
1071 dma->buflist = temp_buflist;
1073 for (i = 0; i < entry->buf_count; i++) {
1074 dma->buflist[i + dma->buf_count] = &entry->buflist[i];
1077 /* No allocations failed, so now we can replace the original pagelist
1080 if (dma->page_count) {
1081 kfree(dma->pagelist);
1083 dma->pagelist = temp_pagelist;
1085 dma->buf_count += entry->buf_count;
1086 dma->seg_count += entry->seg_count;
1087 dma->page_count += entry->seg_count << page_order;
1088 dma->byte_count += PAGE_SIZE * (entry->seg_count << page_order);
1090 mutex_unlock(&dev->struct_mutex);
1092 request->count = entry->buf_count;
1093 request->size = size;
1095 if (request->flags & _DRM_PCI_BUFFER_RO)
1096 dma->flags = _DRM_DMA_USE_PCI_RO;
1098 atomic_dec(&dev->buf_alloc);
1102 EXPORT_SYMBOL(drm_legacy_addbufs_pci);
1104 static int drm_legacy_addbufs_sg(struct drm_device *dev,
1105 struct drm_buf_desc *request)
1107 struct drm_device_dma *dma = dev->dma;
1108 struct drm_buf_entry *entry;
1109 struct drm_buf *buf;
1110 unsigned long offset;
1111 unsigned long agp_offset;
1120 struct drm_buf **temp_buflist;
1122 if (!drm_core_check_feature(dev, DRIVER_SG))
1128 if (!capable(CAP_SYS_ADMIN))
1131 count = request->count;
1132 order = order_base_2(request->size);
1135 alignment = (request->flags & _DRM_PAGE_ALIGN)
1136 ? PAGE_ALIGN(size) : size;
1137 page_order = order - PAGE_SHIFT > 0 ? order - PAGE_SHIFT : 0;
1138 total = PAGE_SIZE << page_order;
1141 agp_offset = request->agp_start;
1143 DRM_DEBUG("count: %d\n", count);
1144 DRM_DEBUG("order: %d\n", order);
1145 DRM_DEBUG("size: %d\n", size);
1146 DRM_DEBUG("agp_offset: %lu\n", agp_offset);
1147 DRM_DEBUG("alignment: %d\n", alignment);
1148 DRM_DEBUG("page_order: %d\n", page_order);
1149 DRM_DEBUG("total: %d\n", total);
1151 if (order < DRM_MIN_ORDER || order > DRM_MAX_ORDER)
1154 spin_lock(&dev->buf_lock);
1156 spin_unlock(&dev->buf_lock);
1159 atomic_inc(&dev->buf_alloc);
1160 spin_unlock(&dev->buf_lock);
1162 mutex_lock(&dev->struct_mutex);
1163 entry = &dma->bufs[order];
1164 if (entry->buf_count) {
1165 mutex_unlock(&dev->struct_mutex);
1166 atomic_dec(&dev->buf_alloc);
1167 return -ENOMEM; /* May only call once for each order */
1170 if (count < 0 || count > 4096) {
1171 mutex_unlock(&dev->struct_mutex);
1172 atomic_dec(&dev->buf_alloc);
1176 entry->buflist = kcalloc(count, sizeof(*entry->buflist), GFP_KERNEL);
1177 if (!entry->buflist) {
1178 mutex_unlock(&dev->struct_mutex);
1179 atomic_dec(&dev->buf_alloc);
1183 entry->buf_size = size;
1184 entry->page_order = page_order;
1188 while (entry->buf_count < count) {
1189 buf = &entry->buflist[entry->buf_count];
1190 buf->idx = dma->buf_count + entry->buf_count;
1191 buf->total = alignment;
1195 buf->offset = (dma->byte_count + offset);
1196 buf->bus_address = agp_offset + offset;
1197 buf->address = (void *)(agp_offset + offset
1198 + (unsigned long)dev->sg->virtual);
1202 buf->file_priv = NULL;
1204 buf->dev_priv_size = dev->driver->dev_priv_size;
1205 buf->dev_private = kzalloc(buf->dev_priv_size, GFP_KERNEL);
1206 if (!buf->dev_private) {
1207 /* Set count correctly so we free the proper amount. */
1208 entry->buf_count = count;
1209 drm_cleanup_buf_error(dev, entry);
1210 mutex_unlock(&dev->struct_mutex);
1211 atomic_dec(&dev->buf_alloc);
1215 DRM_DEBUG("buffer %d @ %p\n", entry->buf_count, buf->address);
1217 offset += alignment;
1219 byte_count += PAGE_SIZE << page_order;
1222 DRM_DEBUG("byte_count: %d\n", byte_count);
1224 temp_buflist = krealloc(dma->buflist,
1225 (dma->buf_count + entry->buf_count) *
1226 sizeof(*dma->buflist), GFP_KERNEL);
1227 if (!temp_buflist) {
1228 /* Free the entry because it isn't valid */
1229 drm_cleanup_buf_error(dev, entry);
1230 mutex_unlock(&dev->struct_mutex);
1231 atomic_dec(&dev->buf_alloc);
1234 dma->buflist = temp_buflist;
1236 for (i = 0; i < entry->buf_count; i++) {
1237 dma->buflist[i + dma->buf_count] = &entry->buflist[i];
1240 dma->buf_count += entry->buf_count;
1241 dma->seg_count += entry->seg_count;
1242 dma->page_count += byte_count >> PAGE_SHIFT;
1243 dma->byte_count += byte_count;
1245 DRM_DEBUG("dma->buf_count : %d\n", dma->buf_count);
1246 DRM_DEBUG("entry->buf_count : %d\n", entry->buf_count);
1248 mutex_unlock(&dev->struct_mutex);
1250 request->count = entry->buf_count;
1251 request->size = size;
1253 dma->flags = _DRM_DMA_USE_SG;
1255 atomic_dec(&dev->buf_alloc);
1260 * Add buffers for DMA transfers (ioctl).
1262 * \param inode device inode.
1263 * \param file_priv DRM file private.
1264 * \param cmd command.
1265 * \param arg pointer to a struct drm_buf_desc request.
1266 * \return zero on success or a negative number on failure.
1268 * According with the memory type specified in drm_buf_desc::flags and the
1269 * build options, it dispatches the call either to addbufs_agp(),
1270 * addbufs_sg() or addbufs_pci() for AGP, scatter-gather or consistent
1271 * PCI memory respectively.
1273 int drm_legacy_addbufs(struct drm_device *dev, void *data,
1274 struct drm_file *file_priv)
1276 struct drm_buf_desc *request = data;
1279 if (!drm_core_check_feature(dev, DRIVER_LEGACY))
1282 if (!drm_core_check_feature(dev, DRIVER_HAVE_DMA))
1285 #if IS_ENABLED(CONFIG_AGP)
1286 if (request->flags & _DRM_AGP_BUFFER)
1287 ret = drm_legacy_addbufs_agp(dev, request);
1290 if (request->flags & _DRM_SG_BUFFER)
1291 ret = drm_legacy_addbufs_sg(dev, request);
1292 else if (request->flags & _DRM_FB_BUFFER)
1295 ret = drm_legacy_addbufs_pci(dev, request);
1301 * Get information about the buffer mappings.
1303 * This was originally mean for debugging purposes, or by a sophisticated
1304 * client library to determine how best to use the available buffers (e.g.,
1305 * large buffers can be used for image transfer).
1307 * \param inode device inode.
1308 * \param file_priv DRM file private.
1309 * \param cmd command.
1310 * \param arg pointer to a drm_buf_info structure.
1311 * \return zero on success or a negative number on failure.
1313 * Increments drm_device::buf_use while holding the drm_device::buf_lock
1314 * lock, preventing of allocating more buffers after this call. Information
1315 * about each requested buffer is then copied into user space.
1317 int __drm_legacy_infobufs(struct drm_device *dev,
1319 int (*f)(void *, int, struct drm_buf_entry *))
1321 struct drm_device_dma *dma = dev->dma;
1325 if (!drm_core_check_feature(dev, DRIVER_LEGACY))
1328 if (!drm_core_check_feature(dev, DRIVER_HAVE_DMA))
1334 spin_lock(&dev->buf_lock);
1335 if (atomic_read(&dev->buf_alloc)) {
1336 spin_unlock(&dev->buf_lock);
1339 ++dev->buf_use; /* Can't allocate more after this call */
1340 spin_unlock(&dev->buf_lock);
1342 for (i = 0, count = 0; i < DRM_MAX_ORDER + 1; i++) {
1343 if (dma->bufs[i].buf_count)
1347 DRM_DEBUG("count = %d\n", count);
1350 for (i = 0, count = 0; i < DRM_MAX_ORDER + 1; i++) {
1351 struct drm_buf_entry *from = &dma->bufs[i];
1353 if (from->buf_count) {
1354 if (f(data, count, from) < 0)
1356 DRM_DEBUG("%d %d %d %d %d\n",
1358 dma->bufs[i].buf_count,
1359 dma->bufs[i].buf_size,
1360 dma->bufs[i].low_mark,
1361 dma->bufs[i].high_mark);
1371 static int copy_one_buf(void *data, int count, struct drm_buf_entry *from)
1373 struct drm_buf_info *request = data;
1374 struct drm_buf_desc __user *to = &request->list[count];
1375 struct drm_buf_desc v = {.count = from->buf_count,
1376 .size = from->buf_size,
1377 .low_mark = from->low_mark,
1378 .high_mark = from->high_mark};
1380 if (copy_to_user(to, &v, offsetof(struct drm_buf_desc, flags)))
1385 int drm_legacy_infobufs(struct drm_device *dev, void *data,
1386 struct drm_file *file_priv)
1388 struct drm_buf_info *request = data;
1390 return __drm_legacy_infobufs(dev, data, &request->count, copy_one_buf);
1394 * Specifies a low and high water mark for buffer allocation
1396 * \param inode device inode.
1397 * \param file_priv DRM file private.
1398 * \param cmd command.
1399 * \param arg a pointer to a drm_buf_desc structure.
1400 * \return zero on success or a negative number on failure.
1402 * Verifies that the size order is bounded between the admissible orders and
1403 * updates the respective drm_device_dma::bufs entry low and high water mark.
1405 * \note This ioctl is deprecated and mostly never used.
1407 int drm_legacy_markbufs(struct drm_device *dev, void *data,
1408 struct drm_file *file_priv)
1410 struct drm_device_dma *dma = dev->dma;
1411 struct drm_buf_desc *request = data;
1413 struct drm_buf_entry *entry;
1415 if (!drm_core_check_feature(dev, DRIVER_LEGACY))
1418 if (!drm_core_check_feature(dev, DRIVER_HAVE_DMA))
1424 DRM_DEBUG("%d, %d, %d\n",
1425 request->size, request->low_mark, request->high_mark);
1426 order = order_base_2(request->size);
1427 if (order < DRM_MIN_ORDER || order > DRM_MAX_ORDER)
1429 entry = &dma->bufs[order];
1431 if (request->low_mark < 0 || request->low_mark > entry->buf_count)
1433 if (request->high_mark < 0 || request->high_mark > entry->buf_count)
1436 entry->low_mark = request->low_mark;
1437 entry->high_mark = request->high_mark;
1443 * Unreserve the buffers in list, previously reserved using drmDMA.
1445 * \param inode device inode.
1446 * \param file_priv DRM file private.
1447 * \param cmd command.
1448 * \param arg pointer to a drm_buf_free structure.
1449 * \return zero on success or a negative number on failure.
1451 * Calls free_buffer() for each used buffer.
1452 * This function is primarily used for debugging.
1454 int drm_legacy_freebufs(struct drm_device *dev, void *data,
1455 struct drm_file *file_priv)
1457 struct drm_device_dma *dma = dev->dma;
1458 struct drm_buf_free *request = data;
1461 struct drm_buf *buf;
1463 if (!drm_core_check_feature(dev, DRIVER_LEGACY))
1466 if (!drm_core_check_feature(dev, DRIVER_HAVE_DMA))
1472 DRM_DEBUG("%d\n", request->count);
1473 for (i = 0; i < request->count; i++) {
1474 if (copy_from_user(&idx, &request->list[i], sizeof(idx)))
1476 if (idx < 0 || idx >= dma->buf_count) {
1477 DRM_ERROR("Index %d (of %d max)\n",
1478 idx, dma->buf_count - 1);
1481 idx = array_index_nospec(idx, dma->buf_count);
1482 buf = dma->buflist[idx];
1483 if (buf->file_priv != file_priv) {
1484 DRM_ERROR("Process %d freeing buffer not owned\n",
1485 task_pid_nr(current));
1488 drm_legacy_free_buffer(dev, buf);
1495 * Maps all of the DMA buffers into client-virtual space (ioctl).
1497 * \param inode device inode.
1498 * \param file_priv DRM file private.
1499 * \param cmd command.
1500 * \param arg pointer to a drm_buf_map structure.
1501 * \return zero on success or a negative number on failure.
1503 * Maps the AGP, SG or PCI buffer region with vm_mmap(), and copies information
1504 * about each buffer into user space. For PCI buffers, it calls vm_mmap() with
1505 * offset equal to 0, which drm_mmap() interprets as PCI buffers and calls
1508 int __drm_legacy_mapbufs(struct drm_device *dev, void *data, int *p,
1510 int (*f)(void *, int, unsigned long,
1512 struct drm_file *file_priv)
1514 struct drm_device_dma *dma = dev->dma;
1516 unsigned long virtual;
1519 if (!drm_core_check_feature(dev, DRIVER_LEGACY))
1522 if (!drm_core_check_feature(dev, DRIVER_HAVE_DMA))
1528 spin_lock(&dev->buf_lock);
1529 if (atomic_read(&dev->buf_alloc)) {
1530 spin_unlock(&dev->buf_lock);
1533 dev->buf_use++; /* Can't allocate more after this call */
1534 spin_unlock(&dev->buf_lock);
1536 if (*p >= dma->buf_count) {
1537 if ((dev->agp && (dma->flags & _DRM_DMA_USE_AGP))
1538 || (drm_core_check_feature(dev, DRIVER_SG)
1539 && (dma->flags & _DRM_DMA_USE_SG))) {
1540 struct drm_local_map *map = dev->agp_buffer_map;
1541 unsigned long token = dev->agp_buffer_token;
1547 virtual = vm_mmap(file_priv->filp, 0, map->size,
1548 PROT_READ | PROT_WRITE,
1552 virtual = vm_mmap(file_priv->filp, 0, dma->byte_count,
1553 PROT_READ | PROT_WRITE,
1556 if (virtual > -1024UL) {
1558 retcode = (signed long)virtual;
1561 *v = (void __user *)virtual;
1563 for (i = 0; i < dma->buf_count; i++) {
1564 if (f(data, i, virtual, dma->buflist[i]) < 0) {
1571 *p = dma->buf_count;
1572 DRM_DEBUG("%d buffers, retcode = %d\n", *p, retcode);
1577 static int map_one_buf(void *data, int idx, unsigned long virtual,
1578 struct drm_buf *buf)
1580 struct drm_buf_map *request = data;
1581 unsigned long address = virtual + buf->offset; /* *** */
1583 if (copy_to_user(&request->list[idx].idx, &buf->idx,
1584 sizeof(request->list[0].idx)))
1586 if (copy_to_user(&request->list[idx].total, &buf->total,
1587 sizeof(request->list[0].total)))
1589 if (clear_user(&request->list[idx].used, sizeof(int)))
1591 if (copy_to_user(&request->list[idx].address, &address,
1597 int drm_legacy_mapbufs(struct drm_device *dev, void *data,
1598 struct drm_file *file_priv)
1600 struct drm_buf_map *request = data;
1602 return __drm_legacy_mapbufs(dev, data, &request->count,
1603 &request->virtual, map_one_buf,
1607 int drm_legacy_dma_ioctl(struct drm_device *dev, void *data,
1608 struct drm_file *file_priv)
1610 if (!drm_core_check_feature(dev, DRIVER_LEGACY))
1613 if (dev->driver->dma_ioctl)
1614 return dev->driver->dma_ioctl(dev, data, file_priv);
1619 struct drm_local_map *drm_legacy_getsarea(struct drm_device *dev)
1621 struct drm_map_list *entry;
1623 list_for_each_entry(entry, &dev->maplist, head) {
1624 if (entry->map && entry->map->type == _DRM_SHM &&
1625 (entry->map->flags & _DRM_CONTAINS_LOCK)) {
1631 EXPORT_SYMBOL(drm_legacy_getsarea);