1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun
3*4882a593Smuzhiyun #ifndef __DRM_GEM_SHMEM_HELPER_H__
4*4882a593Smuzhiyun #define __DRM_GEM_SHMEM_HELPER_H__
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun #include <linux/fs.h>
7*4882a593Smuzhiyun #include <linux/mm.h>
8*4882a593Smuzhiyun #include <linux/mutex.h>
9*4882a593Smuzhiyun
10*4882a593Smuzhiyun #include <drm/drm_file.h>
11*4882a593Smuzhiyun #include <drm/drm_gem.h>
12*4882a593Smuzhiyun #include <drm/drm_ioctl.h>
13*4882a593Smuzhiyun #include <drm/drm_prime.h>
14*4882a593Smuzhiyun
15*4882a593Smuzhiyun struct dma_buf_attachment;
16*4882a593Smuzhiyun struct drm_mode_create_dumb;
17*4882a593Smuzhiyun struct drm_printer;
18*4882a593Smuzhiyun struct sg_table;
19*4882a593Smuzhiyun
20*4882a593Smuzhiyun /**
21*4882a593Smuzhiyun * struct drm_gem_shmem_object - GEM object backed by shmem
22*4882a593Smuzhiyun */
23*4882a593Smuzhiyun struct drm_gem_shmem_object {
24*4882a593Smuzhiyun /**
25*4882a593Smuzhiyun * @base: Base GEM object
26*4882a593Smuzhiyun */
27*4882a593Smuzhiyun struct drm_gem_object base;
28*4882a593Smuzhiyun
29*4882a593Smuzhiyun /**
30*4882a593Smuzhiyun * @pages_lock: Protects the page table and use count
31*4882a593Smuzhiyun */
32*4882a593Smuzhiyun struct mutex pages_lock;
33*4882a593Smuzhiyun
34*4882a593Smuzhiyun /**
35*4882a593Smuzhiyun * @pages: Page table
36*4882a593Smuzhiyun */
37*4882a593Smuzhiyun struct page **pages;
38*4882a593Smuzhiyun
39*4882a593Smuzhiyun /**
40*4882a593Smuzhiyun * @pages_use_count:
41*4882a593Smuzhiyun *
42*4882a593Smuzhiyun * Reference count on the pages table.
43*4882a593Smuzhiyun * The pages are put when the count reaches zero.
44*4882a593Smuzhiyun */
45*4882a593Smuzhiyun unsigned int pages_use_count;
46*4882a593Smuzhiyun
47*4882a593Smuzhiyun /**
48*4882a593Smuzhiyun * @madv: State for madvise
49*4882a593Smuzhiyun *
50*4882a593Smuzhiyun * 0 is active/inuse.
51*4882a593Smuzhiyun * A negative value is the object is purged.
52*4882a593Smuzhiyun * Positive values are driver specific and not used by the helpers.
53*4882a593Smuzhiyun */
54*4882a593Smuzhiyun int madv;
55*4882a593Smuzhiyun
56*4882a593Smuzhiyun /**
57*4882a593Smuzhiyun * @madv_list: List entry for madvise tracking
58*4882a593Smuzhiyun *
59*4882a593Smuzhiyun * Typically used by drivers to track purgeable objects
60*4882a593Smuzhiyun */
61*4882a593Smuzhiyun struct list_head madv_list;
62*4882a593Smuzhiyun
63*4882a593Smuzhiyun /**
64*4882a593Smuzhiyun * @pages_mark_dirty_on_put:
65*4882a593Smuzhiyun *
66*4882a593Smuzhiyun * Mark pages as dirty when they are put.
67*4882a593Smuzhiyun */
68*4882a593Smuzhiyun unsigned int pages_mark_dirty_on_put : 1;
69*4882a593Smuzhiyun
70*4882a593Smuzhiyun /**
71*4882a593Smuzhiyun * @pages_mark_accessed_on_put:
72*4882a593Smuzhiyun *
73*4882a593Smuzhiyun * Mark pages as accessed when they are put.
74*4882a593Smuzhiyun */
75*4882a593Smuzhiyun unsigned int pages_mark_accessed_on_put : 1;
76*4882a593Smuzhiyun
77*4882a593Smuzhiyun /**
78*4882a593Smuzhiyun * @sgt: Scatter/gather table for imported PRIME buffers
79*4882a593Smuzhiyun */
80*4882a593Smuzhiyun struct sg_table *sgt;
81*4882a593Smuzhiyun
82*4882a593Smuzhiyun /**
83*4882a593Smuzhiyun * @vmap_lock: Protects the vmap address and use count
84*4882a593Smuzhiyun */
85*4882a593Smuzhiyun struct mutex vmap_lock;
86*4882a593Smuzhiyun
87*4882a593Smuzhiyun /**
88*4882a593Smuzhiyun * @vaddr: Kernel virtual address of the backing memory
89*4882a593Smuzhiyun */
90*4882a593Smuzhiyun void *vaddr;
91*4882a593Smuzhiyun
92*4882a593Smuzhiyun /**
93*4882a593Smuzhiyun * @vmap_use_count:
94*4882a593Smuzhiyun *
95*4882a593Smuzhiyun * Reference count on the virtual address.
96*4882a593Smuzhiyun * The address are un-mapped when the count reaches zero.
97*4882a593Smuzhiyun */
98*4882a593Smuzhiyun unsigned int vmap_use_count;
99*4882a593Smuzhiyun
100*4882a593Smuzhiyun /**
101*4882a593Smuzhiyun * @map_cached: map object cached (instead of using writecombine).
102*4882a593Smuzhiyun */
103*4882a593Smuzhiyun bool map_cached;
104*4882a593Smuzhiyun };
105*4882a593Smuzhiyun
106*4882a593Smuzhiyun #define to_drm_gem_shmem_obj(obj) \
107*4882a593Smuzhiyun container_of(obj, struct drm_gem_shmem_object, base)
108*4882a593Smuzhiyun
109*4882a593Smuzhiyun struct drm_gem_shmem_object *drm_gem_shmem_create(struct drm_device *dev, size_t size);
110*4882a593Smuzhiyun void drm_gem_shmem_free_object(struct drm_gem_object *obj);
111*4882a593Smuzhiyun
112*4882a593Smuzhiyun int drm_gem_shmem_get_pages(struct drm_gem_shmem_object *shmem);
113*4882a593Smuzhiyun void drm_gem_shmem_put_pages(struct drm_gem_shmem_object *shmem);
114*4882a593Smuzhiyun int drm_gem_shmem_pin(struct drm_gem_object *obj);
115*4882a593Smuzhiyun void drm_gem_shmem_unpin(struct drm_gem_object *obj);
116*4882a593Smuzhiyun void *drm_gem_shmem_vmap(struct drm_gem_object *obj);
117*4882a593Smuzhiyun void drm_gem_shmem_vunmap(struct drm_gem_object *obj, void *vaddr);
118*4882a593Smuzhiyun
119*4882a593Smuzhiyun int drm_gem_shmem_madvise(struct drm_gem_object *obj, int madv);
120*4882a593Smuzhiyun
drm_gem_shmem_is_purgeable(struct drm_gem_shmem_object * shmem)121*4882a593Smuzhiyun static inline bool drm_gem_shmem_is_purgeable(struct drm_gem_shmem_object *shmem)
122*4882a593Smuzhiyun {
123*4882a593Smuzhiyun return (shmem->madv > 0) &&
124*4882a593Smuzhiyun !shmem->vmap_use_count && shmem->sgt &&
125*4882a593Smuzhiyun !shmem->base.dma_buf && !shmem->base.import_attach;
126*4882a593Smuzhiyun }
127*4882a593Smuzhiyun
128*4882a593Smuzhiyun void drm_gem_shmem_purge_locked(struct drm_gem_object *obj);
129*4882a593Smuzhiyun bool drm_gem_shmem_purge(struct drm_gem_object *obj);
130*4882a593Smuzhiyun
131*4882a593Smuzhiyun struct drm_gem_shmem_object *
132*4882a593Smuzhiyun drm_gem_shmem_create_with_handle(struct drm_file *file_priv,
133*4882a593Smuzhiyun struct drm_device *dev, size_t size,
134*4882a593Smuzhiyun uint32_t *handle);
135*4882a593Smuzhiyun
136*4882a593Smuzhiyun struct drm_gem_object *
137*4882a593Smuzhiyun drm_gem_shmem_create_object_cached(struct drm_device *dev, size_t size);
138*4882a593Smuzhiyun
139*4882a593Smuzhiyun int drm_gem_shmem_dumb_create(struct drm_file *file, struct drm_device *dev,
140*4882a593Smuzhiyun struct drm_mode_create_dumb *args);
141*4882a593Smuzhiyun
142*4882a593Smuzhiyun int drm_gem_shmem_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma);
143*4882a593Smuzhiyun
144*4882a593Smuzhiyun void drm_gem_shmem_print_info(struct drm_printer *p, unsigned int indent,
145*4882a593Smuzhiyun const struct drm_gem_object *obj);
146*4882a593Smuzhiyun
147*4882a593Smuzhiyun struct sg_table *drm_gem_shmem_get_sg_table(struct drm_gem_object *obj);
148*4882a593Smuzhiyun struct drm_gem_object *
149*4882a593Smuzhiyun drm_gem_shmem_prime_import_sg_table(struct drm_device *dev,
150*4882a593Smuzhiyun struct dma_buf_attachment *attach,
151*4882a593Smuzhiyun struct sg_table *sgt);
152*4882a593Smuzhiyun
153*4882a593Smuzhiyun struct sg_table *drm_gem_shmem_get_pages_sgt(struct drm_gem_object *obj);
154*4882a593Smuzhiyun
155*4882a593Smuzhiyun /**
156*4882a593Smuzhiyun * DRM_GEM_SHMEM_DRIVER_OPS - Default shmem GEM operations
157*4882a593Smuzhiyun *
158*4882a593Smuzhiyun * This macro provides a shortcut for setting the shmem GEM operations in
159*4882a593Smuzhiyun * the &drm_driver structure.
160*4882a593Smuzhiyun */
161*4882a593Smuzhiyun #define DRM_GEM_SHMEM_DRIVER_OPS \
162*4882a593Smuzhiyun .prime_handle_to_fd = drm_gem_prime_handle_to_fd, \
163*4882a593Smuzhiyun .prime_fd_to_handle = drm_gem_prime_fd_to_handle, \
164*4882a593Smuzhiyun .gem_prime_import_sg_table = drm_gem_shmem_prime_import_sg_table, \
165*4882a593Smuzhiyun .gem_prime_mmap = drm_gem_prime_mmap, \
166*4882a593Smuzhiyun .dumb_create = drm_gem_shmem_dumb_create
167*4882a593Smuzhiyun
168*4882a593Smuzhiyun #endif /* __DRM_GEM_SHMEM_HELPER_H__ */
169