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;
37 * Reference count on the pages table.
38 * The pages are put when the count reaches zero.
40 unsigned int pages_use_count;
43 * @madv: State for madvise
46 * A negative value is the object is purged.
47 * Positive values are driver specific and not used by the helpers.
52 * @madv_list: List entry for madvise tracking
54 * Typically used by drivers to track purgeable objects
56 struct list_head madv_list;
59 * @sgt: Scatter/gather table for imported PRIME buffers
64 * @vaddr: Kernel virtual address of the backing memory
71 * Reference count on the virtual address.
72 * The address are un-mapped when the count reaches zero.
74 unsigned int vmap_use_count;
77 * @pages_mark_dirty_on_put:
79 * Mark pages as dirty when they are put.
81 bool pages_mark_dirty_on_put : 1;
84 * @pages_mark_accessed_on_put:
86 * Mark pages as accessed when they are put.
88 bool pages_mark_accessed_on_put : 1;
91 * @map_wc: map object write-combined (instead of using shmem defaults).
96 #define to_drm_gem_shmem_obj(obj) \
97 container_of(obj, struct drm_gem_shmem_object, base)
99 struct drm_gem_shmem_object *drm_gem_shmem_create(struct drm_device *dev, size_t size);
100 void drm_gem_shmem_free(struct drm_gem_shmem_object *shmem);
102 void drm_gem_shmem_put_pages(struct drm_gem_shmem_object *shmem);
103 int drm_gem_shmem_pin(struct drm_gem_shmem_object *shmem);
104 void drm_gem_shmem_unpin(struct drm_gem_shmem_object *shmem);
105 int drm_gem_shmem_vmap(struct drm_gem_shmem_object *shmem,
106 struct iosys_map *map);
107 void drm_gem_shmem_vunmap(struct drm_gem_shmem_object *shmem,
108 struct iosys_map *map);
109 int drm_gem_shmem_mmap(struct drm_gem_shmem_object *shmem, struct vm_area_struct *vma);
111 int drm_gem_shmem_madvise(struct drm_gem_shmem_object *shmem, int madv);
113 static inline bool drm_gem_shmem_is_purgeable(struct drm_gem_shmem_object *shmem)
115 return (shmem->madv > 0) &&
116 !shmem->vmap_use_count && shmem->sgt &&
117 !shmem->base.dma_buf && !shmem->base.import_attach;
120 void drm_gem_shmem_purge(struct drm_gem_shmem_object *shmem);
122 struct sg_table *drm_gem_shmem_get_sg_table(struct drm_gem_shmem_object *shmem);
123 struct sg_table *drm_gem_shmem_get_pages_sgt(struct drm_gem_shmem_object *shmem);
125 void drm_gem_shmem_print_info(const struct drm_gem_shmem_object *shmem,
126 struct drm_printer *p, unsigned int indent);
128 extern const struct vm_operations_struct drm_gem_shmem_vm_ops;
131 * GEM object functions
135 * drm_gem_shmem_object_free - GEM object function for drm_gem_shmem_free()
136 * @obj: GEM object to free
138 * This function wraps drm_gem_shmem_free(). Drivers that employ the shmem helpers
139 * should use it as their &drm_gem_object_funcs.free handler.
141 static inline void drm_gem_shmem_object_free(struct drm_gem_object *obj)
143 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
145 drm_gem_shmem_free(shmem);
149 * drm_gem_shmem_object_print_info() - Print &drm_gem_shmem_object info for debugfs
151 * @indent: Tab indentation level
154 * This function wraps drm_gem_shmem_print_info(). Drivers that employ the shmem helpers should
155 * use this function as their &drm_gem_object_funcs.print_info handler.
157 static inline void drm_gem_shmem_object_print_info(struct drm_printer *p, unsigned int indent,
158 const struct drm_gem_object *obj)
160 const struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
162 drm_gem_shmem_print_info(shmem, p, indent);
166 * drm_gem_shmem_object_pin - GEM object function for drm_gem_shmem_pin()
169 * This function wraps drm_gem_shmem_pin(). Drivers that employ the shmem helpers should
170 * use it as their &drm_gem_object_funcs.pin handler.
172 static inline int drm_gem_shmem_object_pin(struct drm_gem_object *obj)
174 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
176 return drm_gem_shmem_pin(shmem);
180 * drm_gem_shmem_object_unpin - GEM object function for drm_gem_shmem_unpin()
183 * This function wraps drm_gem_shmem_unpin(). Drivers that employ the shmem helpers should
184 * use it as their &drm_gem_object_funcs.unpin handler.
186 static inline void drm_gem_shmem_object_unpin(struct drm_gem_object *obj)
188 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
190 drm_gem_shmem_unpin(shmem);
194 * drm_gem_shmem_object_get_sg_table - GEM object function for drm_gem_shmem_get_sg_table()
197 * This function wraps drm_gem_shmem_get_sg_table(). Drivers that employ the shmem helpers should
198 * use it as their &drm_gem_object_funcs.get_sg_table handler.
201 * A pointer to the scatter/gather table of pinned pages or error pointer on failure.
203 static inline struct sg_table *drm_gem_shmem_object_get_sg_table(struct drm_gem_object *obj)
205 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
207 return drm_gem_shmem_get_sg_table(shmem);
211 * drm_gem_shmem_object_vmap - GEM object function for drm_gem_shmem_vmap()
213 * @map: Returns the kernel virtual address of the SHMEM GEM object's backing store.
215 * This function wraps drm_gem_shmem_vmap(). Drivers that employ the shmem helpers should
216 * use it as their &drm_gem_object_funcs.vmap handler.
219 * 0 on success or a negative error code on failure.
221 static inline int drm_gem_shmem_object_vmap(struct drm_gem_object *obj,
222 struct iosys_map *map)
224 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
226 return drm_gem_shmem_vmap(shmem, map);
230 * drm_gem_shmem_object_vunmap - GEM object function for drm_gem_shmem_vunmap()
232 * @map: Kernel virtual address where the SHMEM GEM object was mapped
234 * This function wraps drm_gem_shmem_vunmap(). Drivers that employ the shmem helpers should
235 * use it as their &drm_gem_object_funcs.vunmap handler.
237 static inline void drm_gem_shmem_object_vunmap(struct drm_gem_object *obj,
238 struct iosys_map *map)
240 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
242 drm_gem_shmem_vunmap(shmem, map);
246 * drm_gem_shmem_object_mmap - GEM object function for drm_gem_shmem_mmap()
248 * @vma: VMA for the area to be mapped
250 * This function wraps drm_gem_shmem_mmap(). Drivers that employ the shmem helpers should
251 * use it as their &drm_gem_object_funcs.mmap handler.
254 * 0 on success or a negative error code on failure.
256 static inline int drm_gem_shmem_object_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma)
258 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
260 return drm_gem_shmem_mmap(shmem, vma);
267 struct drm_gem_object *
268 drm_gem_shmem_prime_import_sg_table(struct drm_device *dev,
269 struct dma_buf_attachment *attach,
270 struct sg_table *sgt);
271 int drm_gem_shmem_dumb_create(struct drm_file *file, struct drm_device *dev,
272 struct drm_mode_create_dumb *args);
275 * DRM_GEM_SHMEM_DRIVER_OPS - Default shmem GEM operations
277 * This macro provides a shortcut for setting the shmem GEM operations in
278 * the &drm_driver structure.
280 #define DRM_GEM_SHMEM_DRIVER_OPS \
281 .gem_prime_import_sg_table = drm_gem_shmem_prime_import_sg_table, \
282 .dumb_create = drm_gem_shmem_dumb_create
284 #endif /* __DRM_GEM_SHMEM_HELPER_H__ */