1 /* SPDX-License-Identifier: GPL-2.0 */
3 #ifndef __DRM_GEM_SHMEM_HELPER_H__
4 #define __DRM_GEM_SHMEM_HELPER_H__
8 #include <linux/mutex.h>
10 #include <drm/drm_file.h>
11 #include <drm/drm_gem.h>
12 #include <drm/drm_ioctl.h>
13 #include <drm/drm_prime.h>
15 struct dma_buf_attachment;
16 struct drm_mode_create_dumb;
21 * struct drm_gem_shmem_object - GEM object backed by shmem
23 struct drm_gem_shmem_object {
25 * @base: Base GEM object
27 struct drm_gem_object base;
30 * @pages_lock: Protects the page table and use count
32 struct mutex pages_lock;
42 * Reference count on the pages table.
43 * The pages are put when the count reaches zero.
45 unsigned int pages_use_count;
48 struct list_head madv_list;
51 * @pages_mark_dirty_on_put:
53 * Mark pages as dirty when they are put.
55 unsigned int pages_mark_dirty_on_put : 1;
58 * @pages_mark_accessed_on_put:
60 * Mark pages as accessed when they are put.
62 unsigned int pages_mark_accessed_on_put : 1;
65 * @sgt: Scatter/gather table for imported PRIME buffers
70 * @vmap_lock: Protects the vmap address and use count
72 struct mutex vmap_lock;
75 * @vaddr: Kernel virtual address of the backing memory
82 * Reference count on the virtual address.
83 * The address are un-mapped when the count reaches zero.
85 unsigned int vmap_use_count;
88 #define to_drm_gem_shmem_obj(obj) \
89 container_of(obj, struct drm_gem_shmem_object, base)
91 struct drm_gem_shmem_object *drm_gem_shmem_create(struct drm_device *dev, size_t size);
92 void drm_gem_shmem_free_object(struct drm_gem_object *obj);
94 int drm_gem_shmem_get_pages(struct drm_gem_shmem_object *shmem);
95 void drm_gem_shmem_put_pages(struct drm_gem_shmem_object *shmem);
96 int drm_gem_shmem_pin(struct drm_gem_object *obj);
97 void drm_gem_shmem_unpin(struct drm_gem_object *obj);
98 void *drm_gem_shmem_vmap(struct drm_gem_object *obj);
99 void drm_gem_shmem_vunmap(struct drm_gem_object *obj, void *vaddr);
101 int drm_gem_shmem_madvise(struct drm_gem_object *obj, int madv);
103 static inline bool drm_gem_shmem_is_purgeable(struct drm_gem_shmem_object *shmem)
105 return (shmem->madv > 0) &&
106 !shmem->vmap_use_count && shmem->sgt &&
107 !shmem->base.dma_buf && !shmem->base.import_attach;
110 void drm_gem_shmem_purge_locked(struct drm_gem_object *obj);
111 bool drm_gem_shmem_purge(struct drm_gem_object *obj);
113 struct drm_gem_shmem_object *
114 drm_gem_shmem_create_with_handle(struct drm_file *file_priv,
115 struct drm_device *dev, size_t size,
117 int drm_gem_shmem_dumb_create(struct drm_file *file, struct drm_device *dev,
118 struct drm_mode_create_dumb *args);
120 int drm_gem_shmem_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma);
122 void drm_gem_shmem_print_info(struct drm_printer *p, unsigned int indent,
123 const struct drm_gem_object *obj);
125 struct sg_table *drm_gem_shmem_get_sg_table(struct drm_gem_object *obj);
126 struct drm_gem_object *
127 drm_gem_shmem_prime_import_sg_table(struct drm_device *dev,
128 struct dma_buf_attachment *attach,
129 struct sg_table *sgt);
131 struct sg_table *drm_gem_shmem_get_pages_sgt(struct drm_gem_object *obj);
134 * DRM_GEM_SHMEM_DRIVER_OPS - Default shmem GEM operations
136 * This macro provides a shortcut for setting the shmem GEM operations in
137 * the &drm_driver structure.
139 #define DRM_GEM_SHMEM_DRIVER_OPS \
140 .prime_handle_to_fd = drm_gem_prime_handle_to_fd, \
141 .prime_fd_to_handle = drm_gem_prime_fd_to_handle, \
142 .gem_prime_import_sg_table = drm_gem_shmem_prime_import_sg_table, \
143 .gem_prime_mmap = drm_gem_prime_mmap, \
144 .dumb_create = drm_gem_shmem_dumb_create
146 #endif /* __DRM_GEM_SHMEM_HELPER_H__ */