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_agpsupport.h>
44 #include <drm/drm_device.h>
45 #include <drm/drm_drv.h>
46 #include <drm/drm_file.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;
57 list_for_each_entry(entry, &dev->maplist, head) {
59 * Because the kernel-userspace ABI is fixed at a 32-bit offset
60 * while PCI resources may live above that, we only compare the
61 * lower 32 bits of the map offset for maps of type
62 * _DRM_FRAMEBUFFER or _DRM_REGISTERS.
63 * It is assumed that if a driver have more than one resource
64 * of each type, the lower 32 bits are different.
67 map->type != entry->map->type ||
68 entry->master != dev->master)
72 if (map->flags != _DRM_CONTAINS_LOCK)
76 case _DRM_FRAME_BUFFER:
77 if ((entry->map->offset & 0xffffffff) ==
78 (map->offset & 0xffffffff))
81 default: /* Make gcc happy */
84 if (entry->map->offset == map->offset)
91 static int drm_map_handle(struct drm_device *dev, struct drm_hash_item *hash,
92 unsigned long user_token, int hashed_handle, int shm)
94 int use_hashed_handle, shift;
97 #if (BITS_PER_LONG == 64)
98 use_hashed_handle = ((user_token & 0xFFFFFFFF00000000UL) || hashed_handle);
99 #elif (BITS_PER_LONG == 32)
100 use_hashed_handle = hashed_handle;
102 #error Unsupported long size. Neither 64 nor 32 bits.
105 if (!use_hashed_handle) {
108 hash->key = user_token >> PAGE_SHIFT;
109 ret = drm_ht_insert_item(&dev->map_hash, hash);
115 add = DRM_MAP_HASH_OFFSET >> PAGE_SHIFT;
116 if (shm && (SHMLBA > PAGE_SIZE)) {
117 int bits = ilog2(SHMLBA >> PAGE_SHIFT) + 1;
119 /* For shared memory, we have to preserve the SHMLBA
120 * bits of the eventual vma->vm_pgoff value during
121 * mmap(). Otherwise we run into cache aliasing problems
122 * on some platforms. On these platforms, the pgoff of
123 * a mmap() request is used to pick a suitable virtual
124 * address for the mmap() region such that it will not
125 * cause cache aliasing problems.
127 * Therefore, make sure the SHMLBA relevant bits of the
128 * hash value we use are equal to those in the original
129 * kernel virtual address.
132 add |= ((user_token >> PAGE_SHIFT) & ((1UL << bits) - 1UL));
135 return drm_ht_just_insert_please(&dev->map_hash, hash,
136 user_token, 32 - PAGE_SHIFT - 3,
141 * Core function to create a range of memory available for mapping by a
144 * Adjusts the memory offset to its absolute value according to the mapping
145 * type. Adds the map to the map list drm_device::maplist. Adds MTRR's where
146 * applicable and if supported by the kernel.
148 static int drm_addmap_core(struct drm_device *dev, resource_size_t offset,
149 unsigned int size, enum drm_map_type type,
150 enum drm_map_flags flags,
151 struct drm_map_list **maplist)
153 struct drm_local_map *map;
154 struct drm_map_list *list;
155 unsigned long user_token;
158 map = kmalloc(sizeof(*map), GFP_KERNEL);
162 map->offset = offset;
167 /* Only allow shared memory to be removable since we only keep enough
168 * book keeping information about shared memory to allow for removal
169 * when processes fork.
171 if ((map->flags & _DRM_REMOVABLE) && map->type != _DRM_SHM) {
175 DRM_DEBUG("offset = 0x%08llx, size = 0x%08lx, type = %d\n",
176 (unsigned long long)map->offset, map->size, map->type);
178 /* page-align _DRM_SHM maps. They are allocated here so there is no security
179 * hole created by that and it works around various broken drivers that use
180 * a non-aligned quantity to map the SAREA. --BenH
182 if (map->type == _DRM_SHM)
183 map->size = PAGE_ALIGN(map->size);
185 if ((map->offset & (~(resource_size_t)PAGE_MASK)) || (map->size & (~PAGE_MASK))) {
194 case _DRM_FRAME_BUFFER:
195 #if !defined(__sparc__) && !defined(__alpha__) && !defined(__ia64__) && !defined(__powerpc64__) && !defined(__x86_64__) && !defined(__arm__)
196 if (map->offset + (map->size-1) < map->offset ||
197 map->offset < virt_to_phys(high_memory)) {
202 /* Some drivers preinitialize some maps, without the X Server
203 * needing to be aware of it. Therefore, we just return success
204 * when the server tries to create a duplicate map.
206 list = drm_find_matching_map(dev, map);
208 if (list->map->size != map->size) {
209 DRM_DEBUG("Matching maps of type %d with "
210 "mismatched sizes, (%ld vs %ld)\n",
211 map->type, map->size,
213 list->map->size = map->size;
221 if (map->type == _DRM_FRAME_BUFFER ||
222 (map->flags & _DRM_WRITE_COMBINING)) {
224 arch_phys_wc_add(map->offset, map->size);
226 if (map->type == _DRM_REGISTERS) {
227 if (map->flags & _DRM_WRITE_COMBINING)
228 map->handle = ioremap_wc(map->offset,
231 map->handle = ioremap(map->offset, map->size);
240 list = drm_find_matching_map(dev, map);
242 if (list->map->size != map->size) {
243 DRM_DEBUG("Matching maps of type %d with "
244 "mismatched sizes, (%ld vs %ld)\n",
245 map->type, map->size, list->map->size);
246 list->map->size = map->size;
253 map->handle = vmalloc_user(map->size);
254 DRM_DEBUG("%lu %d %p\n",
255 map->size, order_base_2(map->size), map->handle);
260 map->offset = (unsigned long)map->handle;
261 if (map->flags & _DRM_CONTAINS_LOCK) {
262 /* Prevent a 2nd X Server from creating a 2nd lock */
263 if (dev->master->lock.hw_lock != NULL) {
268 dev->sigdata.lock = dev->master->lock.hw_lock = map->handle; /* Pointer to lock */
272 struct drm_agp_mem *entry;
280 map->offset += dev->hose->mem_space->start;
282 /* In some cases (i810 driver), user space may have already
283 * added the AGP base itself, because dev->agp->base previously
284 * only got set during AGP enable. So, only add the base
285 * address if the map's offset isn't already within the
288 if (map->offset < dev->agp->base ||
289 map->offset > dev->agp->base +
290 dev->agp->agp_info.aper_size * 1024 * 1024 - 1) {
291 map->offset += dev->agp->base;
293 map->mtrr = dev->agp->agp_mtrr; /* for getmap */
295 /* This assumes the DRM is in total control of AGP space.
296 * It's not always the case as AGP can be in the control
297 * of user space (i.e. i810 driver). So this loop will get
298 * skipped and we double check that dev->agp->memory is
299 * actually set as well as being invalid before EPERM'ing
301 list_for_each_entry(entry, &dev->agp->memory, head) {
302 if ((map->offset >= entry->bound) &&
303 (map->offset + map->size <= entry->bound + entry->pages * PAGE_SIZE)) {
308 if (!list_empty(&dev->agp->memory) && !valid) {
312 DRM_DEBUG("AGP offset = 0x%08llx, size = 0x%08lx\n",
313 (unsigned long long)map->offset, map->size);
317 case _DRM_SCATTER_GATHER:
322 map->offset += (unsigned long)dev->sg->virtual;
324 case _DRM_CONSISTENT:
325 /* dma_addr_t is 64bit on i386 with CONFIG_HIGHMEM64G,
326 * As we're limiting the address to 2^32-1 (or less),
327 * casting it down to 32 bits is no problem, but we
328 * 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)
679 if (entry->seg_count) {
680 for (i = 0; i < entry->seg_count; i++) {
681 if (entry->seglist[i]) {
682 drm_pci_free(dev, entry->seglist[i]);
685 kfree(entry->seglist);
687 entry->seg_count = 0;
690 if (entry->buf_count) {
691 for (i = 0; i < entry->buf_count; i++) {
692 kfree(entry->buflist[i].dev_private);
694 kfree(entry->buflist);
696 entry->buf_count = 0;
700 #if IS_ENABLED(CONFIG_AGP)
702 * Add AGP buffers for DMA transfers.
704 * \param dev struct drm_device to which the buffers are to be added.
705 * \param request pointer to a struct drm_buf_desc describing the request.
706 * \return zero on success or a negative number on failure.
708 * After some sanity checks creates a drm_buf structure for each buffer and
709 * reallocates the buffer list of the same size order to accommodate the new
712 int drm_legacy_addbufs_agp(struct drm_device *dev,
713 struct drm_buf_desc *request)
715 struct drm_device_dma *dma = dev->dma;
716 struct drm_buf_entry *entry;
717 struct drm_agp_mem *agp_entry;
719 unsigned long offset;
720 unsigned long agp_offset;
729 struct drm_buf **temp_buflist;
734 count = request->count;
735 order = order_base_2(request->size);
738 alignment = (request->flags & _DRM_PAGE_ALIGN)
739 ? PAGE_ALIGN(size) : size;
740 page_order = order - PAGE_SHIFT > 0 ? order - PAGE_SHIFT : 0;
741 total = PAGE_SIZE << page_order;
744 agp_offset = dev->agp->base + request->agp_start;
746 DRM_DEBUG("count: %d\n", count);
747 DRM_DEBUG("order: %d\n", order);
748 DRM_DEBUG("size: %d\n", size);
749 DRM_DEBUG("agp_offset: %lx\n", agp_offset);
750 DRM_DEBUG("alignment: %d\n", alignment);
751 DRM_DEBUG("page_order: %d\n", page_order);
752 DRM_DEBUG("total: %d\n", total);
754 if (order < DRM_MIN_ORDER || order > DRM_MAX_ORDER)
757 /* Make sure buffers are located in AGP memory that we own */
759 list_for_each_entry(agp_entry, &dev->agp->memory, head) {
760 if ((agp_offset >= agp_entry->bound) &&
761 (agp_offset + total * count <= agp_entry->bound + agp_entry->pages * PAGE_SIZE)) {
766 if (!list_empty(&dev->agp->memory) && !valid) {
767 DRM_DEBUG("zone invalid\n");
770 spin_lock(&dev->buf_lock);
772 spin_unlock(&dev->buf_lock);
775 atomic_inc(&dev->buf_alloc);
776 spin_unlock(&dev->buf_lock);
778 mutex_lock(&dev->struct_mutex);
779 entry = &dma->bufs[order];
780 if (entry->buf_count) {
781 mutex_unlock(&dev->struct_mutex);
782 atomic_dec(&dev->buf_alloc);
783 return -ENOMEM; /* May only call once for each order */
786 if (count < 0 || count > 4096) {
787 mutex_unlock(&dev->struct_mutex);
788 atomic_dec(&dev->buf_alloc);
792 entry->buflist = kcalloc(count, sizeof(*entry->buflist), GFP_KERNEL);
793 if (!entry->buflist) {
794 mutex_unlock(&dev->struct_mutex);
795 atomic_dec(&dev->buf_alloc);
799 entry->buf_size = size;
800 entry->page_order = page_order;
804 while (entry->buf_count < count) {
805 buf = &entry->buflist[entry->buf_count];
806 buf->idx = dma->buf_count + entry->buf_count;
807 buf->total = alignment;
811 buf->offset = (dma->byte_count + offset);
812 buf->bus_address = agp_offset + offset;
813 buf->address = (void *)(agp_offset + offset);
817 buf->file_priv = NULL;
819 buf->dev_priv_size = dev->driver->dev_priv_size;
820 buf->dev_private = kzalloc(buf->dev_priv_size, GFP_KERNEL);
821 if (!buf->dev_private) {
822 /* Set count correctly so we free the proper amount. */
823 entry->buf_count = count;
824 drm_cleanup_buf_error(dev, entry);
825 mutex_unlock(&dev->struct_mutex);
826 atomic_dec(&dev->buf_alloc);
830 DRM_DEBUG("buffer %d @ %p\n", entry->buf_count, buf->address);
834 byte_count += PAGE_SIZE << page_order;
837 DRM_DEBUG("byte_count: %d\n", byte_count);
839 temp_buflist = krealloc(dma->buflist,
840 (dma->buf_count + entry->buf_count) *
841 sizeof(*dma->buflist), GFP_KERNEL);
843 /* Free the entry because it isn't valid */
844 drm_cleanup_buf_error(dev, entry);
845 mutex_unlock(&dev->struct_mutex);
846 atomic_dec(&dev->buf_alloc);
849 dma->buflist = temp_buflist;
851 for (i = 0; i < entry->buf_count; i++) {
852 dma->buflist[i + dma->buf_count] = &entry->buflist[i];
855 dma->buf_count += entry->buf_count;
856 dma->seg_count += entry->seg_count;
857 dma->page_count += byte_count >> PAGE_SHIFT;
858 dma->byte_count += byte_count;
860 DRM_DEBUG("dma->buf_count : %d\n", dma->buf_count);
861 DRM_DEBUG("entry->buf_count : %d\n", entry->buf_count);
863 mutex_unlock(&dev->struct_mutex);
865 request->count = entry->buf_count;
866 request->size = size;
868 dma->flags = _DRM_DMA_USE_AGP;
870 atomic_dec(&dev->buf_alloc);
873 EXPORT_SYMBOL(drm_legacy_addbufs_agp);
874 #endif /* CONFIG_AGP */
876 int drm_legacy_addbufs_pci(struct drm_device *dev,
877 struct drm_buf_desc *request)
879 struct drm_device_dma *dma = dev->dma;
885 struct drm_buf_entry *entry;
886 drm_dma_handle_t *dmah;
889 unsigned long offset;
893 unsigned long *temp_pagelist;
894 struct drm_buf **temp_buflist;
896 if (!drm_core_check_feature(dev, DRIVER_PCI_DMA))
902 if (!capable(CAP_SYS_ADMIN))
905 count = request->count;
906 order = order_base_2(request->size);
909 DRM_DEBUG("count=%d, size=%d (%d), order=%d\n",
910 request->count, request->size, size, order);
912 if (order < DRM_MIN_ORDER || order > DRM_MAX_ORDER)
915 alignment = (request->flags & _DRM_PAGE_ALIGN)
916 ? PAGE_ALIGN(size) : size;
917 page_order = order - PAGE_SHIFT > 0 ? order - PAGE_SHIFT : 0;
918 total = PAGE_SIZE << page_order;
920 spin_lock(&dev->buf_lock);
922 spin_unlock(&dev->buf_lock);
925 atomic_inc(&dev->buf_alloc);
926 spin_unlock(&dev->buf_lock);
928 mutex_lock(&dev->struct_mutex);
929 entry = &dma->bufs[order];
930 if (entry->buf_count) {
931 mutex_unlock(&dev->struct_mutex);
932 atomic_dec(&dev->buf_alloc);
933 return -ENOMEM; /* May only call once for each order */
936 if (count < 0 || count > 4096) {
937 mutex_unlock(&dev->struct_mutex);
938 atomic_dec(&dev->buf_alloc);
942 entry->buflist = kcalloc(count, sizeof(*entry->buflist), GFP_KERNEL);
943 if (!entry->buflist) {
944 mutex_unlock(&dev->struct_mutex);
945 atomic_dec(&dev->buf_alloc);
949 entry->seglist = kcalloc(count, sizeof(*entry->seglist), GFP_KERNEL);
950 if (!entry->seglist) {
951 kfree(entry->buflist);
952 mutex_unlock(&dev->struct_mutex);
953 atomic_dec(&dev->buf_alloc);
957 /* Keep the original pagelist until we know all the allocations
960 temp_pagelist = kmalloc_array(dma->page_count + (count << page_order),
961 sizeof(*dma->pagelist),
963 if (!temp_pagelist) {
964 kfree(entry->buflist);
965 kfree(entry->seglist);
966 mutex_unlock(&dev->struct_mutex);
967 atomic_dec(&dev->buf_alloc);
970 memcpy(temp_pagelist,
971 dma->pagelist, dma->page_count * sizeof(*dma->pagelist));
972 DRM_DEBUG("pagelist: %d entries\n",
973 dma->page_count + (count << page_order));
975 entry->buf_size = size;
976 entry->page_order = page_order;
980 while (entry->buf_count < count) {
982 dmah = drm_pci_alloc(dev, PAGE_SIZE << page_order, 0x1000);
985 /* Set count correctly so we free the proper amount. */
986 entry->buf_count = count;
987 entry->seg_count = count;
988 drm_cleanup_buf_error(dev, entry);
989 kfree(temp_pagelist);
990 mutex_unlock(&dev->struct_mutex);
991 atomic_dec(&dev->buf_alloc);
994 entry->seglist[entry->seg_count++] = dmah;
995 for (i = 0; i < (1 << page_order); i++) {
996 DRM_DEBUG("page %d @ 0x%08lx\n",
997 dma->page_count + page_count,
998 (unsigned long)dmah->vaddr + PAGE_SIZE * i);
999 temp_pagelist[dma->page_count + page_count++]
1000 = (unsigned long)dmah->vaddr + PAGE_SIZE * i;
1003 offset + size <= total && entry->buf_count < count;
1004 offset += alignment, ++entry->buf_count) {
1005 buf = &entry->buflist[entry->buf_count];
1006 buf->idx = dma->buf_count + entry->buf_count;
1007 buf->total = alignment;
1010 buf->offset = (dma->byte_count + byte_count + offset);
1011 buf->address = (void *)(dmah->vaddr + offset);
1012 buf->bus_address = dmah->busaddr + offset;
1016 buf->file_priv = NULL;
1018 buf->dev_priv_size = dev->driver->dev_priv_size;
1019 buf->dev_private = kzalloc(buf->dev_priv_size,
1021 if (!buf->dev_private) {
1022 /* Set count correctly so we free the proper amount. */
1023 entry->buf_count = count;
1024 entry->seg_count = count;
1025 drm_cleanup_buf_error(dev, entry);
1026 kfree(temp_pagelist);
1027 mutex_unlock(&dev->struct_mutex);
1028 atomic_dec(&dev->buf_alloc);
1032 DRM_DEBUG("buffer %d @ %p\n",
1033 entry->buf_count, buf->address);
1035 byte_count += PAGE_SIZE << page_order;
1038 temp_buflist = krealloc(dma->buflist,
1039 (dma->buf_count + entry->buf_count) *
1040 sizeof(*dma->buflist), GFP_KERNEL);
1041 if (!temp_buflist) {
1042 /* Free the entry because it isn't valid */
1043 drm_cleanup_buf_error(dev, entry);
1044 kfree(temp_pagelist);
1045 mutex_unlock(&dev->struct_mutex);
1046 atomic_dec(&dev->buf_alloc);
1049 dma->buflist = temp_buflist;
1051 for (i = 0; i < entry->buf_count; i++) {
1052 dma->buflist[i + dma->buf_count] = &entry->buflist[i];
1055 /* No allocations failed, so now we can replace the original pagelist
1058 if (dma->page_count) {
1059 kfree(dma->pagelist);
1061 dma->pagelist = temp_pagelist;
1063 dma->buf_count += entry->buf_count;
1064 dma->seg_count += entry->seg_count;
1065 dma->page_count += entry->seg_count << page_order;
1066 dma->byte_count += PAGE_SIZE * (entry->seg_count << page_order);
1068 mutex_unlock(&dev->struct_mutex);
1070 request->count = entry->buf_count;
1071 request->size = size;
1073 if (request->flags & _DRM_PCI_BUFFER_RO)
1074 dma->flags = _DRM_DMA_USE_PCI_RO;
1076 atomic_dec(&dev->buf_alloc);
1080 EXPORT_SYMBOL(drm_legacy_addbufs_pci);
1082 static int drm_legacy_addbufs_sg(struct drm_device *dev,
1083 struct drm_buf_desc *request)
1085 struct drm_device_dma *dma = dev->dma;
1086 struct drm_buf_entry *entry;
1087 struct drm_buf *buf;
1088 unsigned long offset;
1089 unsigned long agp_offset;
1098 struct drm_buf **temp_buflist;
1100 if (!drm_core_check_feature(dev, DRIVER_SG))
1106 if (!capable(CAP_SYS_ADMIN))
1109 count = request->count;
1110 order = order_base_2(request->size);
1113 alignment = (request->flags & _DRM_PAGE_ALIGN)
1114 ? PAGE_ALIGN(size) : size;
1115 page_order = order - PAGE_SHIFT > 0 ? order - PAGE_SHIFT : 0;
1116 total = PAGE_SIZE << page_order;
1119 agp_offset = request->agp_start;
1121 DRM_DEBUG("count: %d\n", count);
1122 DRM_DEBUG("order: %d\n", order);
1123 DRM_DEBUG("size: %d\n", size);
1124 DRM_DEBUG("agp_offset: %lu\n", agp_offset);
1125 DRM_DEBUG("alignment: %d\n", alignment);
1126 DRM_DEBUG("page_order: %d\n", page_order);
1127 DRM_DEBUG("total: %d\n", total);
1129 if (order < DRM_MIN_ORDER || order > DRM_MAX_ORDER)
1132 spin_lock(&dev->buf_lock);
1134 spin_unlock(&dev->buf_lock);
1137 atomic_inc(&dev->buf_alloc);
1138 spin_unlock(&dev->buf_lock);
1140 mutex_lock(&dev->struct_mutex);
1141 entry = &dma->bufs[order];
1142 if (entry->buf_count) {
1143 mutex_unlock(&dev->struct_mutex);
1144 atomic_dec(&dev->buf_alloc);
1145 return -ENOMEM; /* May only call once for each order */
1148 if (count < 0 || count > 4096) {
1149 mutex_unlock(&dev->struct_mutex);
1150 atomic_dec(&dev->buf_alloc);
1154 entry->buflist = kcalloc(count, sizeof(*entry->buflist), GFP_KERNEL);
1155 if (!entry->buflist) {
1156 mutex_unlock(&dev->struct_mutex);
1157 atomic_dec(&dev->buf_alloc);
1161 entry->buf_size = size;
1162 entry->page_order = page_order;
1166 while (entry->buf_count < count) {
1167 buf = &entry->buflist[entry->buf_count];
1168 buf->idx = dma->buf_count + entry->buf_count;
1169 buf->total = alignment;
1173 buf->offset = (dma->byte_count + offset);
1174 buf->bus_address = agp_offset + offset;
1175 buf->address = (void *)(agp_offset + offset
1176 + (unsigned long)dev->sg->virtual);
1180 buf->file_priv = NULL;
1182 buf->dev_priv_size = dev->driver->dev_priv_size;
1183 buf->dev_private = kzalloc(buf->dev_priv_size, GFP_KERNEL);
1184 if (!buf->dev_private) {
1185 /* Set count correctly so we free the proper amount. */
1186 entry->buf_count = count;
1187 drm_cleanup_buf_error(dev, entry);
1188 mutex_unlock(&dev->struct_mutex);
1189 atomic_dec(&dev->buf_alloc);
1193 DRM_DEBUG("buffer %d @ %p\n", entry->buf_count, buf->address);
1195 offset += alignment;
1197 byte_count += PAGE_SIZE << page_order;
1200 DRM_DEBUG("byte_count: %d\n", byte_count);
1202 temp_buflist = krealloc(dma->buflist,
1203 (dma->buf_count + entry->buf_count) *
1204 sizeof(*dma->buflist), GFP_KERNEL);
1205 if (!temp_buflist) {
1206 /* Free the entry because it isn't valid */
1207 drm_cleanup_buf_error(dev, entry);
1208 mutex_unlock(&dev->struct_mutex);
1209 atomic_dec(&dev->buf_alloc);
1212 dma->buflist = temp_buflist;
1214 for (i = 0; i < entry->buf_count; i++) {
1215 dma->buflist[i + dma->buf_count] = &entry->buflist[i];
1218 dma->buf_count += entry->buf_count;
1219 dma->seg_count += entry->seg_count;
1220 dma->page_count += byte_count >> PAGE_SHIFT;
1221 dma->byte_count += byte_count;
1223 DRM_DEBUG("dma->buf_count : %d\n", dma->buf_count);
1224 DRM_DEBUG("entry->buf_count : %d\n", entry->buf_count);
1226 mutex_unlock(&dev->struct_mutex);
1228 request->count = entry->buf_count;
1229 request->size = size;
1231 dma->flags = _DRM_DMA_USE_SG;
1233 atomic_dec(&dev->buf_alloc);
1238 * Add buffers for DMA transfers (ioctl).
1240 * \param inode device inode.
1241 * \param file_priv DRM file private.
1242 * \param cmd command.
1243 * \param arg pointer to a struct drm_buf_desc request.
1244 * \return zero on success or a negative number on failure.
1246 * According with the memory type specified in drm_buf_desc::flags and the
1247 * build options, it dispatches the call either to addbufs_agp(),
1248 * addbufs_sg() or addbufs_pci() for AGP, scatter-gather or consistent
1249 * PCI memory respectively.
1251 int drm_legacy_addbufs(struct drm_device *dev, void *data,
1252 struct drm_file *file_priv)
1254 struct drm_buf_desc *request = data;
1257 if (!drm_core_check_feature(dev, DRIVER_LEGACY))
1260 if (!drm_core_check_feature(dev, DRIVER_HAVE_DMA))
1263 #if IS_ENABLED(CONFIG_AGP)
1264 if (request->flags & _DRM_AGP_BUFFER)
1265 ret = drm_legacy_addbufs_agp(dev, request);
1268 if (request->flags & _DRM_SG_BUFFER)
1269 ret = drm_legacy_addbufs_sg(dev, request);
1270 else if (request->flags & _DRM_FB_BUFFER)
1273 ret = drm_legacy_addbufs_pci(dev, request);
1279 * Get information about the buffer mappings.
1281 * This was originally mean for debugging purposes, or by a sophisticated
1282 * client library to determine how best to use the available buffers (e.g.,
1283 * large buffers can be used for image transfer).
1285 * \param inode device inode.
1286 * \param file_priv DRM file private.
1287 * \param cmd command.
1288 * \param arg pointer to a drm_buf_info structure.
1289 * \return zero on success or a negative number on failure.
1291 * Increments drm_device::buf_use while holding the drm_device::buf_lock
1292 * lock, preventing of allocating more buffers after this call. Information
1293 * about each requested buffer is then copied into user space.
1295 int __drm_legacy_infobufs(struct drm_device *dev,
1297 int (*f)(void *, int, struct drm_buf_entry *))
1299 struct drm_device_dma *dma = dev->dma;
1303 if (!drm_core_check_feature(dev, DRIVER_LEGACY))
1306 if (!drm_core_check_feature(dev, DRIVER_HAVE_DMA))
1312 spin_lock(&dev->buf_lock);
1313 if (atomic_read(&dev->buf_alloc)) {
1314 spin_unlock(&dev->buf_lock);
1317 ++dev->buf_use; /* Can't allocate more after this call */
1318 spin_unlock(&dev->buf_lock);
1320 for (i = 0, count = 0; i < DRM_MAX_ORDER + 1; i++) {
1321 if (dma->bufs[i].buf_count)
1325 DRM_DEBUG("count = %d\n", count);
1328 for (i = 0, count = 0; i < DRM_MAX_ORDER + 1; i++) {
1329 struct drm_buf_entry *from = &dma->bufs[i];
1331 if (from->buf_count) {
1332 if (f(data, count, from) < 0)
1334 DRM_DEBUG("%d %d %d %d %d\n",
1336 dma->bufs[i].buf_count,
1337 dma->bufs[i].buf_size,
1338 dma->bufs[i].low_mark,
1339 dma->bufs[i].high_mark);
1349 static int copy_one_buf(void *data, int count, struct drm_buf_entry *from)
1351 struct drm_buf_info *request = data;
1352 struct drm_buf_desc __user *to = &request->list[count];
1353 struct drm_buf_desc v = {.count = from->buf_count,
1354 .size = from->buf_size,
1355 .low_mark = from->low_mark,
1356 .high_mark = from->high_mark};
1358 if (copy_to_user(to, &v, offsetof(struct drm_buf_desc, flags)))
1363 int drm_legacy_infobufs(struct drm_device *dev, void *data,
1364 struct drm_file *file_priv)
1366 struct drm_buf_info *request = data;
1368 return __drm_legacy_infobufs(dev, data, &request->count, copy_one_buf);
1372 * Specifies a low and high water mark for buffer allocation
1374 * \param inode device inode.
1375 * \param file_priv DRM file private.
1376 * \param cmd command.
1377 * \param arg a pointer to a drm_buf_desc structure.
1378 * \return zero on success or a negative number on failure.
1380 * Verifies that the size order is bounded between the admissible orders and
1381 * updates the respective drm_device_dma::bufs entry low and high water mark.
1383 * \note This ioctl is deprecated and mostly never used.
1385 int drm_legacy_markbufs(struct drm_device *dev, void *data,
1386 struct drm_file *file_priv)
1388 struct drm_device_dma *dma = dev->dma;
1389 struct drm_buf_desc *request = data;
1391 struct drm_buf_entry *entry;
1393 if (!drm_core_check_feature(dev, DRIVER_LEGACY))
1396 if (!drm_core_check_feature(dev, DRIVER_HAVE_DMA))
1402 DRM_DEBUG("%d, %d, %d\n",
1403 request->size, request->low_mark, request->high_mark);
1404 order = order_base_2(request->size);
1405 if (order < DRM_MIN_ORDER || order > DRM_MAX_ORDER)
1407 entry = &dma->bufs[order];
1409 if (request->low_mark < 0 || request->low_mark > entry->buf_count)
1411 if (request->high_mark < 0 || request->high_mark > entry->buf_count)
1414 entry->low_mark = request->low_mark;
1415 entry->high_mark = request->high_mark;
1421 * Unreserve the buffers in list, previously reserved using drmDMA.
1423 * \param inode device inode.
1424 * \param file_priv DRM file private.
1425 * \param cmd command.
1426 * \param arg pointer to a drm_buf_free structure.
1427 * \return zero on success or a negative number on failure.
1429 * Calls free_buffer() for each used buffer.
1430 * This function is primarily used for debugging.
1432 int drm_legacy_freebufs(struct drm_device *dev, void *data,
1433 struct drm_file *file_priv)
1435 struct drm_device_dma *dma = dev->dma;
1436 struct drm_buf_free *request = data;
1439 struct drm_buf *buf;
1441 if (!drm_core_check_feature(dev, DRIVER_LEGACY))
1444 if (!drm_core_check_feature(dev, DRIVER_HAVE_DMA))
1450 DRM_DEBUG("%d\n", request->count);
1451 for (i = 0; i < request->count; i++) {
1452 if (copy_from_user(&idx, &request->list[i], sizeof(idx)))
1454 if (idx < 0 || idx >= dma->buf_count) {
1455 DRM_ERROR("Index %d (of %d max)\n",
1456 idx, dma->buf_count - 1);
1459 idx = array_index_nospec(idx, dma->buf_count);
1460 buf = dma->buflist[idx];
1461 if (buf->file_priv != file_priv) {
1462 DRM_ERROR("Process %d freeing buffer not owned\n",
1463 task_pid_nr(current));
1466 drm_legacy_free_buffer(dev, buf);
1473 * Maps all of the DMA buffers into client-virtual space (ioctl).
1475 * \param inode device inode.
1476 * \param file_priv DRM file private.
1477 * \param cmd command.
1478 * \param arg pointer to a drm_buf_map structure.
1479 * \return zero on success or a negative number on failure.
1481 * Maps the AGP, SG or PCI buffer region with vm_mmap(), and copies information
1482 * about each buffer into user space. For PCI buffers, it calls vm_mmap() with
1483 * offset equal to 0, which drm_mmap() interpretes as PCI buffers and calls
1486 int __drm_legacy_mapbufs(struct drm_device *dev, void *data, int *p,
1488 int (*f)(void *, int, unsigned long,
1490 struct drm_file *file_priv)
1492 struct drm_device_dma *dma = dev->dma;
1494 unsigned long virtual;
1497 if (!drm_core_check_feature(dev, DRIVER_LEGACY))
1500 if (!drm_core_check_feature(dev, DRIVER_HAVE_DMA))
1506 spin_lock(&dev->buf_lock);
1507 if (atomic_read(&dev->buf_alloc)) {
1508 spin_unlock(&dev->buf_lock);
1511 dev->buf_use++; /* Can't allocate more after this call */
1512 spin_unlock(&dev->buf_lock);
1514 if (*p >= dma->buf_count) {
1515 if ((dev->agp && (dma->flags & _DRM_DMA_USE_AGP))
1516 || (drm_core_check_feature(dev, DRIVER_SG)
1517 && (dma->flags & _DRM_DMA_USE_SG))) {
1518 struct drm_local_map *map = dev->agp_buffer_map;
1519 unsigned long token = dev->agp_buffer_token;
1525 virtual = vm_mmap(file_priv->filp, 0, map->size,
1526 PROT_READ | PROT_WRITE,
1530 virtual = vm_mmap(file_priv->filp, 0, dma->byte_count,
1531 PROT_READ | PROT_WRITE,
1534 if (virtual > -1024UL) {
1536 retcode = (signed long)virtual;
1539 *v = (void __user *)virtual;
1541 for (i = 0; i < dma->buf_count; i++) {
1542 if (f(data, i, virtual, dma->buflist[i]) < 0) {
1549 *p = dma->buf_count;
1550 DRM_DEBUG("%d buffers, retcode = %d\n", *p, retcode);
1555 static int map_one_buf(void *data, int idx, unsigned long virtual,
1556 struct drm_buf *buf)
1558 struct drm_buf_map *request = data;
1559 unsigned long address = virtual + buf->offset; /* *** */
1561 if (copy_to_user(&request->list[idx].idx, &buf->idx,
1562 sizeof(request->list[0].idx)))
1564 if (copy_to_user(&request->list[idx].total, &buf->total,
1565 sizeof(request->list[0].total)))
1567 if (clear_user(&request->list[idx].used, sizeof(int)))
1569 if (copy_to_user(&request->list[idx].address, &address,
1575 int drm_legacy_mapbufs(struct drm_device *dev, void *data,
1576 struct drm_file *file_priv)
1578 struct drm_buf_map *request = data;
1580 return __drm_legacy_mapbufs(dev, data, &request->count,
1581 &request->virtual, map_one_buf,
1585 int drm_legacy_dma_ioctl(struct drm_device *dev, void *data,
1586 struct drm_file *file_priv)
1588 if (!drm_core_check_feature(dev, DRIVER_LEGACY))
1591 if (dev->driver->dma_ioctl)
1592 return dev->driver->dma_ioctl(dev, data, file_priv);
1597 struct drm_local_map *drm_legacy_getsarea(struct drm_device *dev)
1599 struct drm_map_list *entry;
1601 list_for_each_entry(entry, &dev->maplist, head) {
1602 if (entry->map && entry->map->type == _DRM_SHM &&
1603 (entry->map->flags & _DRM_CONTAINS_LOCK)) {
1609 EXPORT_SYMBOL(drm_legacy_getsarea);