xref: /OK3568_Linux_fs/kernel/drivers/gpu/drm/drm_gem_shmem_helper.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Copyright 2018 Noralf Trønnes
4*4882a593Smuzhiyun  */
5*4882a593Smuzhiyun 
6*4882a593Smuzhiyun #include <linux/dma-buf.h>
7*4882a593Smuzhiyun #include <linux/export.h>
8*4882a593Smuzhiyun #include <linux/mutex.h>
9*4882a593Smuzhiyun #include <linux/shmem_fs.h>
10*4882a593Smuzhiyun #include <linux/slab.h>
11*4882a593Smuzhiyun #include <linux/vmalloc.h>
12*4882a593Smuzhiyun 
13*4882a593Smuzhiyun #include <drm/drm.h>
14*4882a593Smuzhiyun #include <drm/drm_device.h>
15*4882a593Smuzhiyun #include <drm/drm_drv.h>
16*4882a593Smuzhiyun #include <drm/drm_gem_shmem_helper.h>
17*4882a593Smuzhiyun #include <drm/drm_prime.h>
18*4882a593Smuzhiyun #include <drm/drm_print.h>
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun /**
21*4882a593Smuzhiyun  * DOC: overview
22*4882a593Smuzhiyun  *
23*4882a593Smuzhiyun  * This library provides helpers for GEM objects backed by shmem buffers
24*4882a593Smuzhiyun  * allocated using anonymous pageable memory.
25*4882a593Smuzhiyun  */
26*4882a593Smuzhiyun 
27*4882a593Smuzhiyun static const struct drm_gem_object_funcs drm_gem_shmem_funcs = {
28*4882a593Smuzhiyun 	.free = drm_gem_shmem_free_object,
29*4882a593Smuzhiyun 	.print_info = drm_gem_shmem_print_info,
30*4882a593Smuzhiyun 	.pin = drm_gem_shmem_pin,
31*4882a593Smuzhiyun 	.unpin = drm_gem_shmem_unpin,
32*4882a593Smuzhiyun 	.get_sg_table = drm_gem_shmem_get_sg_table,
33*4882a593Smuzhiyun 	.vmap = drm_gem_shmem_vmap,
34*4882a593Smuzhiyun 	.vunmap = drm_gem_shmem_vunmap,
35*4882a593Smuzhiyun 	.mmap = drm_gem_shmem_mmap,
36*4882a593Smuzhiyun };
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun static struct drm_gem_shmem_object *
__drm_gem_shmem_create(struct drm_device * dev,size_t size,bool private)39*4882a593Smuzhiyun __drm_gem_shmem_create(struct drm_device *dev, size_t size, bool private)
40*4882a593Smuzhiyun {
41*4882a593Smuzhiyun 	struct drm_gem_shmem_object *shmem;
42*4882a593Smuzhiyun 	struct drm_gem_object *obj;
43*4882a593Smuzhiyun 	int ret = 0;
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun 	size = PAGE_ALIGN(size);
46*4882a593Smuzhiyun 
47*4882a593Smuzhiyun 	if (dev->driver->gem_create_object)
48*4882a593Smuzhiyun 		obj = dev->driver->gem_create_object(dev, size);
49*4882a593Smuzhiyun 	else
50*4882a593Smuzhiyun 		obj = kzalloc(sizeof(*shmem), GFP_KERNEL);
51*4882a593Smuzhiyun 	if (!obj)
52*4882a593Smuzhiyun 		return ERR_PTR(-ENOMEM);
53*4882a593Smuzhiyun 
54*4882a593Smuzhiyun 	if (!obj->funcs)
55*4882a593Smuzhiyun 		obj->funcs = &drm_gem_shmem_funcs;
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun 	if (private)
58*4882a593Smuzhiyun 		drm_gem_private_object_init(dev, obj, size);
59*4882a593Smuzhiyun 	else
60*4882a593Smuzhiyun 		ret = drm_gem_object_init(dev, obj, size);
61*4882a593Smuzhiyun 	if (ret)
62*4882a593Smuzhiyun 		goto err_free;
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun 	ret = drm_gem_create_mmap_offset(obj);
65*4882a593Smuzhiyun 	if (ret)
66*4882a593Smuzhiyun 		goto err_release;
67*4882a593Smuzhiyun 
68*4882a593Smuzhiyun 	shmem = to_drm_gem_shmem_obj(obj);
69*4882a593Smuzhiyun 	mutex_init(&shmem->pages_lock);
70*4882a593Smuzhiyun 	mutex_init(&shmem->vmap_lock);
71*4882a593Smuzhiyun 	INIT_LIST_HEAD(&shmem->madv_list);
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun 	if (!private) {
74*4882a593Smuzhiyun 		/*
75*4882a593Smuzhiyun 		 * Our buffers are kept pinned, so allocating them
76*4882a593Smuzhiyun 		 * from the MOVABLE zone is a really bad idea, and
77*4882a593Smuzhiyun 		 * conflicts with CMA. See comments above new_inode()
78*4882a593Smuzhiyun 		 * why this is required _and_ expected if you're
79*4882a593Smuzhiyun 		 * going to pin these pages.
80*4882a593Smuzhiyun 		 */
81*4882a593Smuzhiyun 		mapping_set_gfp_mask(obj->filp->f_mapping, GFP_HIGHUSER |
82*4882a593Smuzhiyun 				     __GFP_RETRY_MAYFAIL | __GFP_NOWARN);
83*4882a593Smuzhiyun 	}
84*4882a593Smuzhiyun 
85*4882a593Smuzhiyun 	return shmem;
86*4882a593Smuzhiyun 
87*4882a593Smuzhiyun err_release:
88*4882a593Smuzhiyun 	drm_gem_object_release(obj);
89*4882a593Smuzhiyun err_free:
90*4882a593Smuzhiyun 	kfree(obj);
91*4882a593Smuzhiyun 
92*4882a593Smuzhiyun 	return ERR_PTR(ret);
93*4882a593Smuzhiyun }
94*4882a593Smuzhiyun /**
95*4882a593Smuzhiyun  * drm_gem_shmem_create - Allocate an object with the given size
96*4882a593Smuzhiyun  * @dev: DRM device
97*4882a593Smuzhiyun  * @size: Size of the object to allocate
98*4882a593Smuzhiyun  *
99*4882a593Smuzhiyun  * This function creates a shmem GEM object.
100*4882a593Smuzhiyun  *
101*4882a593Smuzhiyun  * Returns:
102*4882a593Smuzhiyun  * A struct drm_gem_shmem_object * on success or an ERR_PTR()-encoded negative
103*4882a593Smuzhiyun  * error code on failure.
104*4882a593Smuzhiyun  */
drm_gem_shmem_create(struct drm_device * dev,size_t size)105*4882a593Smuzhiyun struct drm_gem_shmem_object *drm_gem_shmem_create(struct drm_device *dev, size_t size)
106*4882a593Smuzhiyun {
107*4882a593Smuzhiyun 	return __drm_gem_shmem_create(dev, size, false);
108*4882a593Smuzhiyun }
109*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(drm_gem_shmem_create);
110*4882a593Smuzhiyun 
111*4882a593Smuzhiyun /**
112*4882a593Smuzhiyun  * drm_gem_shmem_free_object - Free resources associated with a shmem GEM object
113*4882a593Smuzhiyun  * @obj: GEM object to free
114*4882a593Smuzhiyun  *
115*4882a593Smuzhiyun  * This function cleans up the GEM object state and frees the memory used to
116*4882a593Smuzhiyun  * store the object itself. It should be used to implement
117*4882a593Smuzhiyun  * &drm_gem_object_funcs.free.
118*4882a593Smuzhiyun  */
drm_gem_shmem_free_object(struct drm_gem_object * obj)119*4882a593Smuzhiyun void drm_gem_shmem_free_object(struct drm_gem_object *obj)
120*4882a593Smuzhiyun {
121*4882a593Smuzhiyun 	struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
122*4882a593Smuzhiyun 
123*4882a593Smuzhiyun 	WARN_ON(shmem->vmap_use_count);
124*4882a593Smuzhiyun 
125*4882a593Smuzhiyun 	if (obj->import_attach) {
126*4882a593Smuzhiyun 		drm_prime_gem_destroy(obj, shmem->sgt);
127*4882a593Smuzhiyun 	} else {
128*4882a593Smuzhiyun 		if (shmem->sgt) {
129*4882a593Smuzhiyun 			dma_unmap_sgtable(obj->dev->dev, shmem->sgt,
130*4882a593Smuzhiyun 					  DMA_BIDIRECTIONAL, 0);
131*4882a593Smuzhiyun 			sg_free_table(shmem->sgt);
132*4882a593Smuzhiyun 			kfree(shmem->sgt);
133*4882a593Smuzhiyun 		}
134*4882a593Smuzhiyun 		if (shmem->pages)
135*4882a593Smuzhiyun 			drm_gem_shmem_put_pages(shmem);
136*4882a593Smuzhiyun 	}
137*4882a593Smuzhiyun 
138*4882a593Smuzhiyun 	WARN_ON(shmem->pages_use_count);
139*4882a593Smuzhiyun 
140*4882a593Smuzhiyun 	drm_gem_object_release(obj);
141*4882a593Smuzhiyun 	mutex_destroy(&shmem->pages_lock);
142*4882a593Smuzhiyun 	mutex_destroy(&shmem->vmap_lock);
143*4882a593Smuzhiyun 	kfree(shmem);
144*4882a593Smuzhiyun }
145*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(drm_gem_shmem_free_object);
146*4882a593Smuzhiyun 
drm_gem_shmem_get_pages_locked(struct drm_gem_shmem_object * shmem)147*4882a593Smuzhiyun static int drm_gem_shmem_get_pages_locked(struct drm_gem_shmem_object *shmem)
148*4882a593Smuzhiyun {
149*4882a593Smuzhiyun 	struct drm_gem_object *obj = &shmem->base;
150*4882a593Smuzhiyun 	struct page **pages;
151*4882a593Smuzhiyun 
152*4882a593Smuzhiyun 	if (shmem->pages_use_count++ > 0)
153*4882a593Smuzhiyun 		return 0;
154*4882a593Smuzhiyun 
155*4882a593Smuzhiyun 	pages = drm_gem_get_pages(obj);
156*4882a593Smuzhiyun 	if (IS_ERR(pages)) {
157*4882a593Smuzhiyun 		DRM_DEBUG_KMS("Failed to get pages (%ld)\n", PTR_ERR(pages));
158*4882a593Smuzhiyun 		shmem->pages_use_count = 0;
159*4882a593Smuzhiyun 		return PTR_ERR(pages);
160*4882a593Smuzhiyun 	}
161*4882a593Smuzhiyun 
162*4882a593Smuzhiyun 	shmem->pages = pages;
163*4882a593Smuzhiyun 
164*4882a593Smuzhiyun 	return 0;
165*4882a593Smuzhiyun }
166*4882a593Smuzhiyun 
167*4882a593Smuzhiyun /*
168*4882a593Smuzhiyun  * drm_gem_shmem_get_pages - Allocate backing pages for a shmem GEM object
169*4882a593Smuzhiyun  * @shmem: shmem GEM object
170*4882a593Smuzhiyun  *
171*4882a593Smuzhiyun  * This function makes sure that backing pages exists for the shmem GEM object
172*4882a593Smuzhiyun  * and increases the use count.
173*4882a593Smuzhiyun  *
174*4882a593Smuzhiyun  * Returns:
175*4882a593Smuzhiyun  * 0 on success or a negative error code on failure.
176*4882a593Smuzhiyun  */
drm_gem_shmem_get_pages(struct drm_gem_shmem_object * shmem)177*4882a593Smuzhiyun int drm_gem_shmem_get_pages(struct drm_gem_shmem_object *shmem)
178*4882a593Smuzhiyun {
179*4882a593Smuzhiyun 	int ret;
180*4882a593Smuzhiyun 
181*4882a593Smuzhiyun 	WARN_ON(shmem->base.import_attach);
182*4882a593Smuzhiyun 
183*4882a593Smuzhiyun 	ret = mutex_lock_interruptible(&shmem->pages_lock);
184*4882a593Smuzhiyun 	if (ret)
185*4882a593Smuzhiyun 		return ret;
186*4882a593Smuzhiyun 	ret = drm_gem_shmem_get_pages_locked(shmem);
187*4882a593Smuzhiyun 	mutex_unlock(&shmem->pages_lock);
188*4882a593Smuzhiyun 
189*4882a593Smuzhiyun 	return ret;
190*4882a593Smuzhiyun }
191*4882a593Smuzhiyun EXPORT_SYMBOL(drm_gem_shmem_get_pages);
192*4882a593Smuzhiyun 
drm_gem_shmem_put_pages_locked(struct drm_gem_shmem_object * shmem)193*4882a593Smuzhiyun static void drm_gem_shmem_put_pages_locked(struct drm_gem_shmem_object *shmem)
194*4882a593Smuzhiyun {
195*4882a593Smuzhiyun 	struct drm_gem_object *obj = &shmem->base;
196*4882a593Smuzhiyun 
197*4882a593Smuzhiyun 	if (WARN_ON_ONCE(!shmem->pages_use_count))
198*4882a593Smuzhiyun 		return;
199*4882a593Smuzhiyun 
200*4882a593Smuzhiyun 	if (--shmem->pages_use_count > 0)
201*4882a593Smuzhiyun 		return;
202*4882a593Smuzhiyun 
203*4882a593Smuzhiyun 	drm_gem_put_pages(obj, shmem->pages,
204*4882a593Smuzhiyun 			  shmem->pages_mark_dirty_on_put,
205*4882a593Smuzhiyun 			  shmem->pages_mark_accessed_on_put);
206*4882a593Smuzhiyun 	shmem->pages = NULL;
207*4882a593Smuzhiyun }
208*4882a593Smuzhiyun 
209*4882a593Smuzhiyun /*
210*4882a593Smuzhiyun  * drm_gem_shmem_put_pages - Decrease use count on the backing pages for a shmem GEM object
211*4882a593Smuzhiyun  * @shmem: shmem GEM object
212*4882a593Smuzhiyun  *
213*4882a593Smuzhiyun  * This function decreases the use count and puts the backing pages when use drops to zero.
214*4882a593Smuzhiyun  */
drm_gem_shmem_put_pages(struct drm_gem_shmem_object * shmem)215*4882a593Smuzhiyun void drm_gem_shmem_put_pages(struct drm_gem_shmem_object *shmem)
216*4882a593Smuzhiyun {
217*4882a593Smuzhiyun 	mutex_lock(&shmem->pages_lock);
218*4882a593Smuzhiyun 	drm_gem_shmem_put_pages_locked(shmem);
219*4882a593Smuzhiyun 	mutex_unlock(&shmem->pages_lock);
220*4882a593Smuzhiyun }
221*4882a593Smuzhiyun EXPORT_SYMBOL(drm_gem_shmem_put_pages);
222*4882a593Smuzhiyun 
223*4882a593Smuzhiyun /**
224*4882a593Smuzhiyun  * drm_gem_shmem_pin - Pin backing pages for a shmem GEM object
225*4882a593Smuzhiyun  * @obj: GEM object
226*4882a593Smuzhiyun  *
227*4882a593Smuzhiyun  * This function makes sure the backing pages are pinned in memory while the
228*4882a593Smuzhiyun  * buffer is exported. It should only be used to implement
229*4882a593Smuzhiyun  * &drm_gem_object_funcs.pin.
230*4882a593Smuzhiyun  *
231*4882a593Smuzhiyun  * Returns:
232*4882a593Smuzhiyun  * 0 on success or a negative error code on failure.
233*4882a593Smuzhiyun  */
drm_gem_shmem_pin(struct drm_gem_object * obj)234*4882a593Smuzhiyun int drm_gem_shmem_pin(struct drm_gem_object *obj)
235*4882a593Smuzhiyun {
236*4882a593Smuzhiyun 	struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
237*4882a593Smuzhiyun 
238*4882a593Smuzhiyun 	WARN_ON(shmem->base.import_attach);
239*4882a593Smuzhiyun 
240*4882a593Smuzhiyun 	return drm_gem_shmem_get_pages(shmem);
241*4882a593Smuzhiyun }
242*4882a593Smuzhiyun EXPORT_SYMBOL(drm_gem_shmem_pin);
243*4882a593Smuzhiyun 
244*4882a593Smuzhiyun /**
245*4882a593Smuzhiyun  * drm_gem_shmem_unpin - Unpin backing pages for a shmem GEM object
246*4882a593Smuzhiyun  * @obj: GEM object
247*4882a593Smuzhiyun  *
248*4882a593Smuzhiyun  * This function removes the requirement that the backing pages are pinned in
249*4882a593Smuzhiyun  * memory. It should only be used to implement &drm_gem_object_funcs.unpin.
250*4882a593Smuzhiyun  */
drm_gem_shmem_unpin(struct drm_gem_object * obj)251*4882a593Smuzhiyun void drm_gem_shmem_unpin(struct drm_gem_object *obj)
252*4882a593Smuzhiyun {
253*4882a593Smuzhiyun 	struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
254*4882a593Smuzhiyun 
255*4882a593Smuzhiyun 	WARN_ON(shmem->base.import_attach);
256*4882a593Smuzhiyun 
257*4882a593Smuzhiyun 	drm_gem_shmem_put_pages(shmem);
258*4882a593Smuzhiyun }
259*4882a593Smuzhiyun EXPORT_SYMBOL(drm_gem_shmem_unpin);
260*4882a593Smuzhiyun 
drm_gem_shmem_vmap_locked(struct drm_gem_shmem_object * shmem)261*4882a593Smuzhiyun static void *drm_gem_shmem_vmap_locked(struct drm_gem_shmem_object *shmem)
262*4882a593Smuzhiyun {
263*4882a593Smuzhiyun 	struct drm_gem_object *obj = &shmem->base;
264*4882a593Smuzhiyun 	int ret;
265*4882a593Smuzhiyun 
266*4882a593Smuzhiyun 	if (shmem->vmap_use_count++ > 0)
267*4882a593Smuzhiyun 		return shmem->vaddr;
268*4882a593Smuzhiyun 
269*4882a593Smuzhiyun 	if (obj->import_attach) {
270*4882a593Smuzhiyun 		shmem->vaddr = dma_buf_vmap(obj->import_attach->dmabuf);
271*4882a593Smuzhiyun 	} else {
272*4882a593Smuzhiyun 		pgprot_t prot = PAGE_KERNEL;
273*4882a593Smuzhiyun 
274*4882a593Smuzhiyun 		ret = drm_gem_shmem_get_pages(shmem);
275*4882a593Smuzhiyun 		if (ret)
276*4882a593Smuzhiyun 			goto err_zero_use;
277*4882a593Smuzhiyun 
278*4882a593Smuzhiyun 		if (!shmem->map_cached)
279*4882a593Smuzhiyun 			prot = pgprot_writecombine(prot);
280*4882a593Smuzhiyun 		shmem->vaddr = vmap(shmem->pages, obj->size >> PAGE_SHIFT,
281*4882a593Smuzhiyun 				    VM_MAP, prot);
282*4882a593Smuzhiyun 	}
283*4882a593Smuzhiyun 
284*4882a593Smuzhiyun 	if (!shmem->vaddr) {
285*4882a593Smuzhiyun 		DRM_DEBUG_KMS("Failed to vmap pages\n");
286*4882a593Smuzhiyun 		ret = -ENOMEM;
287*4882a593Smuzhiyun 		goto err_put_pages;
288*4882a593Smuzhiyun 	}
289*4882a593Smuzhiyun 
290*4882a593Smuzhiyun 	return shmem->vaddr;
291*4882a593Smuzhiyun 
292*4882a593Smuzhiyun err_put_pages:
293*4882a593Smuzhiyun 	if (!obj->import_attach)
294*4882a593Smuzhiyun 		drm_gem_shmem_put_pages(shmem);
295*4882a593Smuzhiyun err_zero_use:
296*4882a593Smuzhiyun 	shmem->vmap_use_count = 0;
297*4882a593Smuzhiyun 
298*4882a593Smuzhiyun 	return ERR_PTR(ret);
299*4882a593Smuzhiyun }
300*4882a593Smuzhiyun 
301*4882a593Smuzhiyun /*
302*4882a593Smuzhiyun  * drm_gem_shmem_vmap - Create a virtual mapping for a shmem GEM object
303*4882a593Smuzhiyun  * @shmem: shmem GEM object
304*4882a593Smuzhiyun  *
305*4882a593Smuzhiyun  * This function makes sure that a contiguous kernel virtual address mapping
306*4882a593Smuzhiyun  * exists for the buffer backing the shmem GEM object.
307*4882a593Smuzhiyun  *
308*4882a593Smuzhiyun  * This function can be used to implement &drm_gem_object_funcs.vmap. But it can
309*4882a593Smuzhiyun  * also be called by drivers directly, in which case it will hide the
310*4882a593Smuzhiyun  * differences between dma-buf imported and natively allocated objects.
311*4882a593Smuzhiyun  *
312*4882a593Smuzhiyun  * Acquired mappings should be cleaned up by calling drm_gem_shmem_vunmap().
313*4882a593Smuzhiyun  *
314*4882a593Smuzhiyun  * Returns:
315*4882a593Smuzhiyun  * 0 on success or a negative error code on failure.
316*4882a593Smuzhiyun  */
drm_gem_shmem_vmap(struct drm_gem_object * obj)317*4882a593Smuzhiyun void *drm_gem_shmem_vmap(struct drm_gem_object *obj)
318*4882a593Smuzhiyun {
319*4882a593Smuzhiyun 	struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
320*4882a593Smuzhiyun 	void *vaddr;
321*4882a593Smuzhiyun 	int ret;
322*4882a593Smuzhiyun 
323*4882a593Smuzhiyun 	ret = mutex_lock_interruptible(&shmem->vmap_lock);
324*4882a593Smuzhiyun 	if (ret)
325*4882a593Smuzhiyun 		return ERR_PTR(ret);
326*4882a593Smuzhiyun 	vaddr = drm_gem_shmem_vmap_locked(shmem);
327*4882a593Smuzhiyun 	mutex_unlock(&shmem->vmap_lock);
328*4882a593Smuzhiyun 
329*4882a593Smuzhiyun 	return vaddr;
330*4882a593Smuzhiyun }
331*4882a593Smuzhiyun EXPORT_SYMBOL(drm_gem_shmem_vmap);
332*4882a593Smuzhiyun 
drm_gem_shmem_vunmap_locked(struct drm_gem_shmem_object * shmem)333*4882a593Smuzhiyun static void drm_gem_shmem_vunmap_locked(struct drm_gem_shmem_object *shmem)
334*4882a593Smuzhiyun {
335*4882a593Smuzhiyun 	struct drm_gem_object *obj = &shmem->base;
336*4882a593Smuzhiyun 
337*4882a593Smuzhiyun 	if (WARN_ON_ONCE(!shmem->vmap_use_count))
338*4882a593Smuzhiyun 		return;
339*4882a593Smuzhiyun 
340*4882a593Smuzhiyun 	if (--shmem->vmap_use_count > 0)
341*4882a593Smuzhiyun 		return;
342*4882a593Smuzhiyun 
343*4882a593Smuzhiyun 	if (obj->import_attach) {
344*4882a593Smuzhiyun 		dma_buf_vunmap(obj->import_attach->dmabuf, shmem->vaddr);
345*4882a593Smuzhiyun 	} else {
346*4882a593Smuzhiyun 		vunmap(shmem->vaddr);
347*4882a593Smuzhiyun 		drm_gem_shmem_put_pages(shmem);
348*4882a593Smuzhiyun 	}
349*4882a593Smuzhiyun 
350*4882a593Smuzhiyun 	shmem->vaddr = NULL;
351*4882a593Smuzhiyun }
352*4882a593Smuzhiyun 
353*4882a593Smuzhiyun /*
354*4882a593Smuzhiyun  * drm_gem_shmem_vunmap - Unmap a virtual mapping fo a shmem GEM object
355*4882a593Smuzhiyun  * @shmem: shmem GEM object
356*4882a593Smuzhiyun  *
357*4882a593Smuzhiyun  * This function cleans up a kernel virtual address mapping acquired by
358*4882a593Smuzhiyun  * drm_gem_shmem_vmap(). The mapping is only removed when the use count drops to
359*4882a593Smuzhiyun  * zero.
360*4882a593Smuzhiyun  *
361*4882a593Smuzhiyun  * This function can be used to implement &drm_gem_object_funcs.vmap. But it can
362*4882a593Smuzhiyun  * also be called by drivers directly, in which case it will hide the
363*4882a593Smuzhiyun  * differences between dma-buf imported and natively allocated objects.
364*4882a593Smuzhiyun  */
drm_gem_shmem_vunmap(struct drm_gem_object * obj,void * vaddr)365*4882a593Smuzhiyun void drm_gem_shmem_vunmap(struct drm_gem_object *obj, void *vaddr)
366*4882a593Smuzhiyun {
367*4882a593Smuzhiyun 	struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
368*4882a593Smuzhiyun 
369*4882a593Smuzhiyun 	mutex_lock(&shmem->vmap_lock);
370*4882a593Smuzhiyun 	drm_gem_shmem_vunmap_locked(shmem);
371*4882a593Smuzhiyun 	mutex_unlock(&shmem->vmap_lock);
372*4882a593Smuzhiyun }
373*4882a593Smuzhiyun EXPORT_SYMBOL(drm_gem_shmem_vunmap);
374*4882a593Smuzhiyun 
375*4882a593Smuzhiyun struct drm_gem_shmem_object *
drm_gem_shmem_create_with_handle(struct drm_file * file_priv,struct drm_device * dev,size_t size,uint32_t * handle)376*4882a593Smuzhiyun drm_gem_shmem_create_with_handle(struct drm_file *file_priv,
377*4882a593Smuzhiyun 				 struct drm_device *dev, size_t size,
378*4882a593Smuzhiyun 				 uint32_t *handle)
379*4882a593Smuzhiyun {
380*4882a593Smuzhiyun 	struct drm_gem_shmem_object *shmem;
381*4882a593Smuzhiyun 	int ret;
382*4882a593Smuzhiyun 
383*4882a593Smuzhiyun 	shmem = drm_gem_shmem_create(dev, size);
384*4882a593Smuzhiyun 	if (IS_ERR(shmem))
385*4882a593Smuzhiyun 		return shmem;
386*4882a593Smuzhiyun 
387*4882a593Smuzhiyun 	/*
388*4882a593Smuzhiyun 	 * Allocate an id of idr table where the obj is registered
389*4882a593Smuzhiyun 	 * and handle has the id what user can see.
390*4882a593Smuzhiyun 	 */
391*4882a593Smuzhiyun 	ret = drm_gem_handle_create(file_priv, &shmem->base, handle);
392*4882a593Smuzhiyun 	/* drop reference from allocate - handle holds it now. */
393*4882a593Smuzhiyun 	drm_gem_object_put(&shmem->base);
394*4882a593Smuzhiyun 	if (ret)
395*4882a593Smuzhiyun 		return ERR_PTR(ret);
396*4882a593Smuzhiyun 
397*4882a593Smuzhiyun 	return shmem;
398*4882a593Smuzhiyun }
399*4882a593Smuzhiyun EXPORT_SYMBOL(drm_gem_shmem_create_with_handle);
400*4882a593Smuzhiyun 
401*4882a593Smuzhiyun /* Update madvise status, returns true if not purged, else
402*4882a593Smuzhiyun  * false or -errno.
403*4882a593Smuzhiyun  */
drm_gem_shmem_madvise(struct drm_gem_object * obj,int madv)404*4882a593Smuzhiyun int drm_gem_shmem_madvise(struct drm_gem_object *obj, int madv)
405*4882a593Smuzhiyun {
406*4882a593Smuzhiyun 	struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
407*4882a593Smuzhiyun 
408*4882a593Smuzhiyun 	mutex_lock(&shmem->pages_lock);
409*4882a593Smuzhiyun 
410*4882a593Smuzhiyun 	if (shmem->madv >= 0)
411*4882a593Smuzhiyun 		shmem->madv = madv;
412*4882a593Smuzhiyun 
413*4882a593Smuzhiyun 	madv = shmem->madv;
414*4882a593Smuzhiyun 
415*4882a593Smuzhiyun 	mutex_unlock(&shmem->pages_lock);
416*4882a593Smuzhiyun 
417*4882a593Smuzhiyun 	return (madv >= 0);
418*4882a593Smuzhiyun }
419*4882a593Smuzhiyun EXPORT_SYMBOL(drm_gem_shmem_madvise);
420*4882a593Smuzhiyun 
drm_gem_shmem_purge_locked(struct drm_gem_object * obj)421*4882a593Smuzhiyun void drm_gem_shmem_purge_locked(struct drm_gem_object *obj)
422*4882a593Smuzhiyun {
423*4882a593Smuzhiyun 	struct drm_device *dev = obj->dev;
424*4882a593Smuzhiyun 	struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
425*4882a593Smuzhiyun 
426*4882a593Smuzhiyun 	WARN_ON(!drm_gem_shmem_is_purgeable(shmem));
427*4882a593Smuzhiyun 
428*4882a593Smuzhiyun 	dma_unmap_sgtable(obj->dev->dev, shmem->sgt, DMA_BIDIRECTIONAL, 0);
429*4882a593Smuzhiyun 	sg_free_table(shmem->sgt);
430*4882a593Smuzhiyun 	kfree(shmem->sgt);
431*4882a593Smuzhiyun 	shmem->sgt = NULL;
432*4882a593Smuzhiyun 
433*4882a593Smuzhiyun 	drm_gem_shmem_put_pages_locked(shmem);
434*4882a593Smuzhiyun 
435*4882a593Smuzhiyun 	shmem->madv = -1;
436*4882a593Smuzhiyun 
437*4882a593Smuzhiyun 	drm_vma_node_unmap(&obj->vma_node, dev->anon_inode->i_mapping);
438*4882a593Smuzhiyun 	drm_gem_free_mmap_offset(obj);
439*4882a593Smuzhiyun 
440*4882a593Smuzhiyun 	/* Our goal here is to return as much of the memory as
441*4882a593Smuzhiyun 	 * is possible back to the system as we are called from OOM.
442*4882a593Smuzhiyun 	 * To do this we must instruct the shmfs to drop all of its
443*4882a593Smuzhiyun 	 * backing pages, *now*.
444*4882a593Smuzhiyun 	 */
445*4882a593Smuzhiyun 	shmem_truncate_range(file_inode(obj->filp), 0, (loff_t)-1);
446*4882a593Smuzhiyun 
447*4882a593Smuzhiyun 	invalidate_mapping_pages(file_inode(obj->filp)->i_mapping,
448*4882a593Smuzhiyun 			0, (loff_t)-1);
449*4882a593Smuzhiyun }
450*4882a593Smuzhiyun EXPORT_SYMBOL(drm_gem_shmem_purge_locked);
451*4882a593Smuzhiyun 
drm_gem_shmem_purge(struct drm_gem_object * obj)452*4882a593Smuzhiyun bool drm_gem_shmem_purge(struct drm_gem_object *obj)
453*4882a593Smuzhiyun {
454*4882a593Smuzhiyun 	struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
455*4882a593Smuzhiyun 
456*4882a593Smuzhiyun 	if (!mutex_trylock(&shmem->pages_lock))
457*4882a593Smuzhiyun 		return false;
458*4882a593Smuzhiyun 	drm_gem_shmem_purge_locked(obj);
459*4882a593Smuzhiyun 	mutex_unlock(&shmem->pages_lock);
460*4882a593Smuzhiyun 
461*4882a593Smuzhiyun 	return true;
462*4882a593Smuzhiyun }
463*4882a593Smuzhiyun EXPORT_SYMBOL(drm_gem_shmem_purge);
464*4882a593Smuzhiyun 
465*4882a593Smuzhiyun /**
466*4882a593Smuzhiyun  * drm_gem_shmem_create_object_cached - Create a shmem buffer object with
467*4882a593Smuzhiyun  *                                      cached mappings
468*4882a593Smuzhiyun  * @dev: DRM device
469*4882a593Smuzhiyun  * @size: Size of the object to allocate
470*4882a593Smuzhiyun  *
471*4882a593Smuzhiyun  * By default, shmem buffer objects use writecombine mappings. This
472*4882a593Smuzhiyun  * function implements struct drm_driver.gem_create_object for shmem
473*4882a593Smuzhiyun  * buffer objects with cached mappings.
474*4882a593Smuzhiyun  *
475*4882a593Smuzhiyun  * Returns:
476*4882a593Smuzhiyun  * A struct drm_gem_shmem_object * on success or NULL negative on failure.
477*4882a593Smuzhiyun  */
478*4882a593Smuzhiyun struct drm_gem_object *
drm_gem_shmem_create_object_cached(struct drm_device * dev,size_t size)479*4882a593Smuzhiyun drm_gem_shmem_create_object_cached(struct drm_device *dev, size_t size)
480*4882a593Smuzhiyun {
481*4882a593Smuzhiyun 	struct drm_gem_shmem_object *shmem;
482*4882a593Smuzhiyun 
483*4882a593Smuzhiyun 	shmem = kzalloc(sizeof(*shmem), GFP_KERNEL);
484*4882a593Smuzhiyun 	if (!shmem)
485*4882a593Smuzhiyun 		return NULL;
486*4882a593Smuzhiyun 	shmem->map_cached = true;
487*4882a593Smuzhiyun 
488*4882a593Smuzhiyun 	return &shmem->base;
489*4882a593Smuzhiyun }
490*4882a593Smuzhiyun EXPORT_SYMBOL(drm_gem_shmem_create_object_cached);
491*4882a593Smuzhiyun 
492*4882a593Smuzhiyun /**
493*4882a593Smuzhiyun  * drm_gem_shmem_dumb_create - Create a dumb shmem buffer object
494*4882a593Smuzhiyun  * @file: DRM file structure to create the dumb buffer for
495*4882a593Smuzhiyun  * @dev: DRM device
496*4882a593Smuzhiyun  * @args: IOCTL data
497*4882a593Smuzhiyun  *
498*4882a593Smuzhiyun  * This function computes the pitch of the dumb buffer and rounds it up to an
499*4882a593Smuzhiyun  * integer number of bytes per pixel. Drivers for hardware that doesn't have
500*4882a593Smuzhiyun  * any additional restrictions on the pitch can directly use this function as
501*4882a593Smuzhiyun  * their &drm_driver.dumb_create callback.
502*4882a593Smuzhiyun  *
503*4882a593Smuzhiyun  * For hardware with additional restrictions, drivers can adjust the fields
504*4882a593Smuzhiyun  * set up by userspace before calling into this function.
505*4882a593Smuzhiyun  *
506*4882a593Smuzhiyun  * Returns:
507*4882a593Smuzhiyun  * 0 on success or a negative error code on failure.
508*4882a593Smuzhiyun  */
drm_gem_shmem_dumb_create(struct drm_file * file,struct drm_device * dev,struct drm_mode_create_dumb * args)509*4882a593Smuzhiyun int drm_gem_shmem_dumb_create(struct drm_file *file, struct drm_device *dev,
510*4882a593Smuzhiyun 			      struct drm_mode_create_dumb *args)
511*4882a593Smuzhiyun {
512*4882a593Smuzhiyun 	u32 min_pitch = DIV_ROUND_UP(args->width * args->bpp, 8);
513*4882a593Smuzhiyun 	struct drm_gem_shmem_object *shmem;
514*4882a593Smuzhiyun 
515*4882a593Smuzhiyun 	if (!args->pitch || !args->size) {
516*4882a593Smuzhiyun 		args->pitch = min_pitch;
517*4882a593Smuzhiyun 		args->size = args->pitch * args->height;
518*4882a593Smuzhiyun 	} else {
519*4882a593Smuzhiyun 		/* ensure sane minimum values */
520*4882a593Smuzhiyun 		if (args->pitch < min_pitch)
521*4882a593Smuzhiyun 			args->pitch = min_pitch;
522*4882a593Smuzhiyun 		if (args->size < args->pitch * args->height)
523*4882a593Smuzhiyun 			args->size = args->pitch * args->height;
524*4882a593Smuzhiyun 	}
525*4882a593Smuzhiyun 
526*4882a593Smuzhiyun 	shmem = drm_gem_shmem_create_with_handle(file, dev, args->size, &args->handle);
527*4882a593Smuzhiyun 
528*4882a593Smuzhiyun 	return PTR_ERR_OR_ZERO(shmem);
529*4882a593Smuzhiyun }
530*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(drm_gem_shmem_dumb_create);
531*4882a593Smuzhiyun 
drm_gem_shmem_fault(struct vm_fault * vmf)532*4882a593Smuzhiyun static vm_fault_t drm_gem_shmem_fault(struct vm_fault *vmf)
533*4882a593Smuzhiyun {
534*4882a593Smuzhiyun 	struct vm_area_struct *vma = vmf->vma;
535*4882a593Smuzhiyun 	struct drm_gem_object *obj = vma->vm_private_data;
536*4882a593Smuzhiyun 	struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
537*4882a593Smuzhiyun 	loff_t num_pages = obj->size >> PAGE_SHIFT;
538*4882a593Smuzhiyun 	vm_fault_t ret;
539*4882a593Smuzhiyun 	struct page *page;
540*4882a593Smuzhiyun 	pgoff_t page_offset;
541*4882a593Smuzhiyun 
542*4882a593Smuzhiyun 	/* We don't use vmf->pgoff since that has the fake offset */
543*4882a593Smuzhiyun 	page_offset = (vmf->address - vma->vm_start) >> PAGE_SHIFT;
544*4882a593Smuzhiyun 
545*4882a593Smuzhiyun 	mutex_lock(&shmem->pages_lock);
546*4882a593Smuzhiyun 
547*4882a593Smuzhiyun 	if (page_offset >= num_pages ||
548*4882a593Smuzhiyun 	    WARN_ON_ONCE(!shmem->pages) ||
549*4882a593Smuzhiyun 	    shmem->madv < 0) {
550*4882a593Smuzhiyun 		ret = VM_FAULT_SIGBUS;
551*4882a593Smuzhiyun 	} else {
552*4882a593Smuzhiyun 		page = shmem->pages[page_offset];
553*4882a593Smuzhiyun 
554*4882a593Smuzhiyun 		ret = vmf_insert_page(vma, vmf->address, page);
555*4882a593Smuzhiyun 	}
556*4882a593Smuzhiyun 
557*4882a593Smuzhiyun 	mutex_unlock(&shmem->pages_lock);
558*4882a593Smuzhiyun 
559*4882a593Smuzhiyun 	return ret;
560*4882a593Smuzhiyun }
561*4882a593Smuzhiyun 
drm_gem_shmem_vm_open(struct vm_area_struct * vma)562*4882a593Smuzhiyun static void drm_gem_shmem_vm_open(struct vm_area_struct *vma)
563*4882a593Smuzhiyun {
564*4882a593Smuzhiyun 	struct drm_gem_object *obj = vma->vm_private_data;
565*4882a593Smuzhiyun 	struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
566*4882a593Smuzhiyun 
567*4882a593Smuzhiyun 	WARN_ON(shmem->base.import_attach);
568*4882a593Smuzhiyun 
569*4882a593Smuzhiyun 	mutex_lock(&shmem->pages_lock);
570*4882a593Smuzhiyun 
571*4882a593Smuzhiyun 	/*
572*4882a593Smuzhiyun 	 * We should have already pinned the pages when the buffer was first
573*4882a593Smuzhiyun 	 * mmap'd, vm_open() just grabs an additional reference for the new
574*4882a593Smuzhiyun 	 * mm the vma is getting copied into (ie. on fork()).
575*4882a593Smuzhiyun 	 */
576*4882a593Smuzhiyun 	if (!WARN_ON_ONCE(!shmem->pages_use_count))
577*4882a593Smuzhiyun 		shmem->pages_use_count++;
578*4882a593Smuzhiyun 
579*4882a593Smuzhiyun 	mutex_unlock(&shmem->pages_lock);
580*4882a593Smuzhiyun 
581*4882a593Smuzhiyun 	drm_gem_vm_open(vma);
582*4882a593Smuzhiyun }
583*4882a593Smuzhiyun 
drm_gem_shmem_vm_close(struct vm_area_struct * vma)584*4882a593Smuzhiyun static void drm_gem_shmem_vm_close(struct vm_area_struct *vma)
585*4882a593Smuzhiyun {
586*4882a593Smuzhiyun 	struct drm_gem_object *obj = vma->vm_private_data;
587*4882a593Smuzhiyun 	struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
588*4882a593Smuzhiyun 
589*4882a593Smuzhiyun 	drm_gem_shmem_put_pages(shmem);
590*4882a593Smuzhiyun 	drm_gem_vm_close(vma);
591*4882a593Smuzhiyun }
592*4882a593Smuzhiyun 
593*4882a593Smuzhiyun static const struct vm_operations_struct drm_gem_shmem_vm_ops = {
594*4882a593Smuzhiyun 	.fault = drm_gem_shmem_fault,
595*4882a593Smuzhiyun 	.open = drm_gem_shmem_vm_open,
596*4882a593Smuzhiyun 	.close = drm_gem_shmem_vm_close,
597*4882a593Smuzhiyun };
598*4882a593Smuzhiyun 
599*4882a593Smuzhiyun /**
600*4882a593Smuzhiyun  * drm_gem_shmem_mmap - Memory-map a shmem GEM object
601*4882a593Smuzhiyun  * @obj: gem object
602*4882a593Smuzhiyun  * @vma: VMA for the area to be mapped
603*4882a593Smuzhiyun  *
604*4882a593Smuzhiyun  * This function implements an augmented version of the GEM DRM file mmap
605*4882a593Smuzhiyun  * operation for shmem objects. Drivers which employ the shmem helpers should
606*4882a593Smuzhiyun  * use this function as their &drm_gem_object_funcs.mmap handler.
607*4882a593Smuzhiyun  *
608*4882a593Smuzhiyun  * Returns:
609*4882a593Smuzhiyun  * 0 on success or a negative error code on failure.
610*4882a593Smuzhiyun  */
drm_gem_shmem_mmap(struct drm_gem_object * obj,struct vm_area_struct * vma)611*4882a593Smuzhiyun int drm_gem_shmem_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma)
612*4882a593Smuzhiyun {
613*4882a593Smuzhiyun 	struct drm_gem_shmem_object *shmem;
614*4882a593Smuzhiyun 	int ret;
615*4882a593Smuzhiyun 
616*4882a593Smuzhiyun 	if (obj->import_attach) {
617*4882a593Smuzhiyun 		/* Drop the reference drm_gem_mmap_obj() acquired.*/
618*4882a593Smuzhiyun 		drm_gem_object_put(obj);
619*4882a593Smuzhiyun 		vma->vm_private_data = NULL;
620*4882a593Smuzhiyun 
621*4882a593Smuzhiyun 		return dma_buf_mmap(obj->dma_buf, vma, 0);
622*4882a593Smuzhiyun 	}
623*4882a593Smuzhiyun 
624*4882a593Smuzhiyun 	shmem = to_drm_gem_shmem_obj(obj);
625*4882a593Smuzhiyun 
626*4882a593Smuzhiyun 	ret = drm_gem_shmem_get_pages(shmem);
627*4882a593Smuzhiyun 	if (ret)
628*4882a593Smuzhiyun 		return ret;
629*4882a593Smuzhiyun 
630*4882a593Smuzhiyun 	vma->vm_flags |= VM_MIXEDMAP | VM_DONTEXPAND;
631*4882a593Smuzhiyun 	vma->vm_page_prot = vm_get_page_prot(vma->vm_flags);
632*4882a593Smuzhiyun 	if (!shmem->map_cached)
633*4882a593Smuzhiyun 		vma->vm_page_prot = pgprot_writecombine(vma->vm_page_prot);
634*4882a593Smuzhiyun 	vma->vm_ops = &drm_gem_shmem_vm_ops;
635*4882a593Smuzhiyun 
636*4882a593Smuzhiyun 	return 0;
637*4882a593Smuzhiyun }
638*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(drm_gem_shmem_mmap);
639*4882a593Smuzhiyun 
640*4882a593Smuzhiyun /**
641*4882a593Smuzhiyun  * drm_gem_shmem_print_info() - Print &drm_gem_shmem_object info for debugfs
642*4882a593Smuzhiyun  * @p: DRM printer
643*4882a593Smuzhiyun  * @indent: Tab indentation level
644*4882a593Smuzhiyun  * @obj: GEM object
645*4882a593Smuzhiyun  *
646*4882a593Smuzhiyun  * This implements the &drm_gem_object_funcs.info callback.
647*4882a593Smuzhiyun  */
drm_gem_shmem_print_info(struct drm_printer * p,unsigned int indent,const struct drm_gem_object * obj)648*4882a593Smuzhiyun void drm_gem_shmem_print_info(struct drm_printer *p, unsigned int indent,
649*4882a593Smuzhiyun 			      const struct drm_gem_object *obj)
650*4882a593Smuzhiyun {
651*4882a593Smuzhiyun 	const struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
652*4882a593Smuzhiyun 
653*4882a593Smuzhiyun 	drm_printf_indent(p, indent, "pages_use_count=%u\n", shmem->pages_use_count);
654*4882a593Smuzhiyun 	drm_printf_indent(p, indent, "vmap_use_count=%u\n", shmem->vmap_use_count);
655*4882a593Smuzhiyun 	drm_printf_indent(p, indent, "vaddr=%p\n", shmem->vaddr);
656*4882a593Smuzhiyun }
657*4882a593Smuzhiyun EXPORT_SYMBOL(drm_gem_shmem_print_info);
658*4882a593Smuzhiyun 
659*4882a593Smuzhiyun /**
660*4882a593Smuzhiyun  * drm_gem_shmem_get_sg_table - Provide a scatter/gather table of pinned
661*4882a593Smuzhiyun  *                              pages for a shmem GEM object
662*4882a593Smuzhiyun  * @obj: GEM object
663*4882a593Smuzhiyun  *
664*4882a593Smuzhiyun  * This function exports a scatter/gather table suitable for PRIME usage by
665*4882a593Smuzhiyun  * calling the standard DMA mapping API. Drivers should not call this function
666*4882a593Smuzhiyun  * directly, instead it should only be used as an implementation for
667*4882a593Smuzhiyun  * &drm_gem_object_funcs.get_sg_table.
668*4882a593Smuzhiyun  *
669*4882a593Smuzhiyun  * Drivers who need to acquire an scatter/gather table for objects need to call
670*4882a593Smuzhiyun  * drm_gem_shmem_get_pages_sgt() instead.
671*4882a593Smuzhiyun  *
672*4882a593Smuzhiyun  * Returns:
673*4882a593Smuzhiyun  * A pointer to the scatter/gather table of pinned pages or NULL on failure.
674*4882a593Smuzhiyun  */
drm_gem_shmem_get_sg_table(struct drm_gem_object * obj)675*4882a593Smuzhiyun struct sg_table *drm_gem_shmem_get_sg_table(struct drm_gem_object *obj)
676*4882a593Smuzhiyun {
677*4882a593Smuzhiyun 	struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
678*4882a593Smuzhiyun 
679*4882a593Smuzhiyun 	WARN_ON(shmem->base.import_attach);
680*4882a593Smuzhiyun 
681*4882a593Smuzhiyun 	return drm_prime_pages_to_sg(obj->dev, shmem->pages, obj->size >> PAGE_SHIFT);
682*4882a593Smuzhiyun }
683*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(drm_gem_shmem_get_sg_table);
684*4882a593Smuzhiyun 
685*4882a593Smuzhiyun /**
686*4882a593Smuzhiyun  * drm_gem_shmem_get_pages_sgt - Pin pages, dma map them, and return a
687*4882a593Smuzhiyun  *				 scatter/gather table for a shmem GEM object.
688*4882a593Smuzhiyun  * @obj: GEM object
689*4882a593Smuzhiyun  *
690*4882a593Smuzhiyun  * This function returns a scatter/gather table suitable for driver usage. If
691*4882a593Smuzhiyun  * the sg table doesn't exist, the pages are pinned, dma-mapped, and a sg
692*4882a593Smuzhiyun  * table created.
693*4882a593Smuzhiyun  *
694*4882a593Smuzhiyun  * This is the main function for drivers to get at backing storage, and it hides
695*4882a593Smuzhiyun  * and difference between dma-buf imported and natively allocated objects.
696*4882a593Smuzhiyun  * drm_gem_shmem_get_sg_table() should not be directly called by drivers.
697*4882a593Smuzhiyun  *
698*4882a593Smuzhiyun  * Returns:
699*4882a593Smuzhiyun  * A pointer to the scatter/gather table of pinned pages or errno on failure.
700*4882a593Smuzhiyun  */
drm_gem_shmem_get_pages_sgt(struct drm_gem_object * obj)701*4882a593Smuzhiyun struct sg_table *drm_gem_shmem_get_pages_sgt(struct drm_gem_object *obj)
702*4882a593Smuzhiyun {
703*4882a593Smuzhiyun 	int ret;
704*4882a593Smuzhiyun 	struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
705*4882a593Smuzhiyun 	struct sg_table *sgt;
706*4882a593Smuzhiyun 
707*4882a593Smuzhiyun 	if (shmem->sgt)
708*4882a593Smuzhiyun 		return shmem->sgt;
709*4882a593Smuzhiyun 
710*4882a593Smuzhiyun 	WARN_ON(obj->import_attach);
711*4882a593Smuzhiyun 
712*4882a593Smuzhiyun 	ret = drm_gem_shmem_get_pages(shmem);
713*4882a593Smuzhiyun 	if (ret)
714*4882a593Smuzhiyun 		return ERR_PTR(ret);
715*4882a593Smuzhiyun 
716*4882a593Smuzhiyun 	sgt = drm_gem_shmem_get_sg_table(&shmem->base);
717*4882a593Smuzhiyun 	if (IS_ERR(sgt)) {
718*4882a593Smuzhiyun 		ret = PTR_ERR(sgt);
719*4882a593Smuzhiyun 		goto err_put_pages;
720*4882a593Smuzhiyun 	}
721*4882a593Smuzhiyun 	/* Map the pages for use by the h/w. */
722*4882a593Smuzhiyun 	ret = dma_map_sgtable(obj->dev->dev, sgt, DMA_BIDIRECTIONAL, 0);
723*4882a593Smuzhiyun 	if (ret)
724*4882a593Smuzhiyun 		goto err_free_sgt;
725*4882a593Smuzhiyun 
726*4882a593Smuzhiyun 	shmem->sgt = sgt;
727*4882a593Smuzhiyun 
728*4882a593Smuzhiyun 	return sgt;
729*4882a593Smuzhiyun 
730*4882a593Smuzhiyun err_free_sgt:
731*4882a593Smuzhiyun 	sg_free_table(sgt);
732*4882a593Smuzhiyun 	kfree(sgt);
733*4882a593Smuzhiyun err_put_pages:
734*4882a593Smuzhiyun 	drm_gem_shmem_put_pages(shmem);
735*4882a593Smuzhiyun 	return ERR_PTR(ret);
736*4882a593Smuzhiyun }
737*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(drm_gem_shmem_get_pages_sgt);
738*4882a593Smuzhiyun 
739*4882a593Smuzhiyun /**
740*4882a593Smuzhiyun  * drm_gem_shmem_prime_import_sg_table - Produce a shmem GEM object from
741*4882a593Smuzhiyun  *                 another driver's scatter/gather table of pinned pages
742*4882a593Smuzhiyun  * @dev: Device to import into
743*4882a593Smuzhiyun  * @attach: DMA-BUF attachment
744*4882a593Smuzhiyun  * @sgt: Scatter/gather table of pinned pages
745*4882a593Smuzhiyun  *
746*4882a593Smuzhiyun  * This function imports a scatter/gather table exported via DMA-BUF by
747*4882a593Smuzhiyun  * another driver. Drivers that use the shmem helpers should set this as their
748*4882a593Smuzhiyun  * &drm_driver.gem_prime_import_sg_table callback.
749*4882a593Smuzhiyun  *
750*4882a593Smuzhiyun  * Returns:
751*4882a593Smuzhiyun  * A pointer to a newly created GEM object or an ERR_PTR-encoded negative
752*4882a593Smuzhiyun  * error code on failure.
753*4882a593Smuzhiyun  */
754*4882a593Smuzhiyun struct drm_gem_object *
drm_gem_shmem_prime_import_sg_table(struct drm_device * dev,struct dma_buf_attachment * attach,struct sg_table * sgt)755*4882a593Smuzhiyun drm_gem_shmem_prime_import_sg_table(struct drm_device *dev,
756*4882a593Smuzhiyun 				    struct dma_buf_attachment *attach,
757*4882a593Smuzhiyun 				    struct sg_table *sgt)
758*4882a593Smuzhiyun {
759*4882a593Smuzhiyun 	size_t size = PAGE_ALIGN(attach->dmabuf->size);
760*4882a593Smuzhiyun 	struct drm_gem_shmem_object *shmem;
761*4882a593Smuzhiyun 
762*4882a593Smuzhiyun 	shmem = __drm_gem_shmem_create(dev, size, true);
763*4882a593Smuzhiyun 	if (IS_ERR(shmem))
764*4882a593Smuzhiyun 		return ERR_CAST(shmem);
765*4882a593Smuzhiyun 
766*4882a593Smuzhiyun 	shmem->sgt = sgt;
767*4882a593Smuzhiyun 
768*4882a593Smuzhiyun 	DRM_DEBUG_PRIME("size = %zu\n", size);
769*4882a593Smuzhiyun 
770*4882a593Smuzhiyun 	return &shmem->base;
771*4882a593Smuzhiyun }
772*4882a593Smuzhiyun EXPORT_SYMBOL_GPL(drm_gem_shmem_prime_import_sg_table);
773