Linux Audio

Check our new training course

Linux debugging, profiling, tracing and performance analysis training

Mar 24-27, 2025, special US time zones
Register
Loading...
Note: File does not exist in v3.1.
  1/*
  2 * Copyright © 2012 Red Hat
  3 *
  4 * Permission is hereby granted, free of charge, to any person obtaining a
  5 * copy of this software and associated documentation files (the "Software"),
  6 * to deal in the Software without restriction, including without limitation
  7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  8 * and/or sell copies of the Software, and to permit persons to whom the
  9 * Software is furnished to do so, subject to the following conditions:
 10 *
 11 * The above copyright notice and this permission notice (including the next
 12 * paragraph) shall be included in all copies or substantial portions of the
 13 * Software.
 14 *
 15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 21 * IN THE SOFTWARE.
 22 *
 23 * Authors:
 24 *      Dave Airlie <airlied@redhat.com>
 25 *      Rob Clark <rob.clark@linaro.org>
 26 *
 27 */
 28
 29#include <linux/export.h>
 30#include <linux/dma-buf.h>
 31#include <drm/drmP.h>
 32#include <drm/drm_gem.h>
 33
 34#include "drm_internal.h"
 35
 36/*
 37 * DMA-BUF/GEM Object references and lifetime overview:
 38 *
 39 * On the export the dma_buf holds a reference to the exporting GEM
 40 * object. It takes this reference in handle_to_fd_ioctl, when it
 41 * first calls .prime_export and stores the exporting GEM object in
 42 * the dma_buf priv. This reference is released when the dma_buf
 43 * object goes away in the driver .release function.
 44 *
 45 * On the import the importing GEM object holds a reference to the
 46 * dma_buf (which in turn holds a ref to the exporting GEM object).
 47 * It takes that reference in the fd_to_handle ioctl.
 48 * It calls dma_buf_get, creates an attachment to it and stores the
 49 * attachment in the GEM object. When this attachment is destroyed
 50 * when the imported object is destroyed, we remove the attachment
 51 * and drop the reference to the dma_buf.
 52 *
 53 * Thus the chain of references always flows in one direction
 54 * (avoiding loops): importing_gem -> dmabuf -> exporting_gem
 55 *
 56 * Self-importing: if userspace is using PRIME as a replacement for flink
 57 * then it will get a fd->handle request for a GEM object that it created.
 58 * Drivers should detect this situation and return back the gem object
 59 * from the dma-buf private.  Prime will do this automatically for drivers that
 60 * use the drm_gem_prime_{import,export} helpers.
 61 */
 62
 63struct drm_prime_member {
 64	struct list_head entry;
 65	struct dma_buf *dma_buf;
 66	uint32_t handle;
 67};
 68
 69struct drm_prime_attachment {
 70	struct sg_table *sgt;
 71	enum dma_data_direction dir;
 72};
 73
 74static int drm_prime_add_buf_handle(struct drm_prime_file_private *prime_fpriv,
 75				    struct dma_buf *dma_buf, uint32_t handle)
 76{
 77	struct drm_prime_member *member;
 78
 79	member = kmalloc(sizeof(*member), GFP_KERNEL);
 80	if (!member)
 81		return -ENOMEM;
 82
 83	get_dma_buf(dma_buf);
 84	member->dma_buf = dma_buf;
 85	member->handle = handle;
 86	list_add(&member->entry, &prime_fpriv->head);
 87	return 0;
 88}
 89
 90static struct dma_buf *drm_prime_lookup_buf_by_handle(struct drm_prime_file_private *prime_fpriv,
 91						      uint32_t handle)
 92{
 93	struct drm_prime_member *member;
 94
 95	list_for_each_entry(member, &prime_fpriv->head, entry) {
 96		if (member->handle == handle)
 97			return member->dma_buf;
 98	}
 99
100	return NULL;
101}
102
103static int drm_prime_lookup_buf_handle(struct drm_prime_file_private *prime_fpriv,
104				       struct dma_buf *dma_buf,
105				       uint32_t *handle)
106{
107	struct drm_prime_member *member;
108
109	list_for_each_entry(member, &prime_fpriv->head, entry) {
110		if (member->dma_buf == dma_buf) {
111			*handle = member->handle;
112			return 0;
113		}
114	}
115	return -ENOENT;
116}
117
118static int drm_gem_map_attach(struct dma_buf *dma_buf,
119			      struct device *target_dev,
120			      struct dma_buf_attachment *attach)
121{
122	struct drm_prime_attachment *prime_attach;
123	struct drm_gem_object *obj = dma_buf->priv;
124	struct drm_device *dev = obj->dev;
125
126	prime_attach = kzalloc(sizeof(*prime_attach), GFP_KERNEL);
127	if (!prime_attach)
128		return -ENOMEM;
129
130	prime_attach->dir = DMA_NONE;
131	attach->priv = prime_attach;
132
133	if (!dev->driver->gem_prime_pin)
134		return 0;
135
136	return dev->driver->gem_prime_pin(obj);
137}
138
139static void drm_gem_map_detach(struct dma_buf *dma_buf,
140			       struct dma_buf_attachment *attach)
141{
142	struct drm_prime_attachment *prime_attach = attach->priv;
143	struct drm_gem_object *obj = dma_buf->priv;
144	struct drm_device *dev = obj->dev;
145	struct sg_table *sgt;
146
147	if (dev->driver->gem_prime_unpin)
148		dev->driver->gem_prime_unpin(obj);
149
150	if (!prime_attach)
151		return;
152
153	sgt = prime_attach->sgt;
154	if (sgt) {
155		if (prime_attach->dir != DMA_NONE)
156			dma_unmap_sg(attach->dev, sgt->sgl, sgt->nents,
157					prime_attach->dir);
158		sg_free_table(sgt);
159	}
160
161	kfree(sgt);
162	kfree(prime_attach);
163	attach->priv = NULL;
164}
165
166void drm_prime_remove_buf_handle_locked(struct drm_prime_file_private *prime_fpriv,
167					struct dma_buf *dma_buf)
168{
169	struct drm_prime_member *member, *safe;
170
171	list_for_each_entry_safe(member, safe, &prime_fpriv->head, entry) {
172		if (member->dma_buf == dma_buf) {
173			dma_buf_put(dma_buf);
174			list_del(&member->entry);
175			kfree(member);
176		}
177	}
178}
179
180static struct sg_table *drm_gem_map_dma_buf(struct dma_buf_attachment *attach,
181					    enum dma_data_direction dir)
182{
183	struct drm_prime_attachment *prime_attach = attach->priv;
184	struct drm_gem_object *obj = attach->dmabuf->priv;
185	struct sg_table *sgt;
186
187	if (WARN_ON(dir == DMA_NONE || !prime_attach))
188		return ERR_PTR(-EINVAL);
189
190	/* return the cached mapping when possible */
191	if (prime_attach->dir == dir)
192		return prime_attach->sgt;
193
194	/*
195	 * two mappings with different directions for the same attachment are
196	 * not allowed
197	 */
198	if (WARN_ON(prime_attach->dir != DMA_NONE))
199		return ERR_PTR(-EBUSY);
200
201	sgt = obj->dev->driver->gem_prime_get_sg_table(obj);
202
203	if (!IS_ERR(sgt)) {
204		if (!dma_map_sg(attach->dev, sgt->sgl, sgt->nents, dir)) {
205			sg_free_table(sgt);
206			kfree(sgt);
207			sgt = ERR_PTR(-ENOMEM);
208		} else {
209			prime_attach->sgt = sgt;
210			prime_attach->dir = dir;
211		}
212	}
213
214	return sgt;
215}
216
217static void drm_gem_unmap_dma_buf(struct dma_buf_attachment *attach,
218				  struct sg_table *sgt,
219				  enum dma_data_direction dir)
220{
221	/* nothing to be done here */
222}
223
224/**
225 * drm_gem_dmabuf_release - dma_buf release implementation for GEM
226 * @dma_buf: buffer to be released
227 *
228 * Generic release function for dma_bufs exported as PRIME buffers. GEM drivers
229 * must use this in their dma_buf ops structure as the release callback.
230 */
231void drm_gem_dmabuf_release(struct dma_buf *dma_buf)
232{
233	struct drm_gem_object *obj = dma_buf->priv;
234
235	/* drop the reference on the export fd holds */
236	drm_gem_object_unreference_unlocked(obj);
237}
238EXPORT_SYMBOL(drm_gem_dmabuf_release);
239
240static void *drm_gem_dmabuf_vmap(struct dma_buf *dma_buf)
241{
242	struct drm_gem_object *obj = dma_buf->priv;
243	struct drm_device *dev = obj->dev;
244
245	return dev->driver->gem_prime_vmap(obj);
246}
247
248static void drm_gem_dmabuf_vunmap(struct dma_buf *dma_buf, void *vaddr)
249{
250	struct drm_gem_object *obj = dma_buf->priv;
251	struct drm_device *dev = obj->dev;
252
253	dev->driver->gem_prime_vunmap(obj, vaddr);
254}
255
256static void *drm_gem_dmabuf_kmap_atomic(struct dma_buf *dma_buf,
257					unsigned long page_num)
258{
259	return NULL;
260}
261
262static void drm_gem_dmabuf_kunmap_atomic(struct dma_buf *dma_buf,
263					 unsigned long page_num, void *addr)
264{
265
266}
267static void *drm_gem_dmabuf_kmap(struct dma_buf *dma_buf,
268				 unsigned long page_num)
269{
270	return NULL;
271}
272
273static void drm_gem_dmabuf_kunmap(struct dma_buf *dma_buf,
274				  unsigned long page_num, void *addr)
275{
276
277}
278
279static int drm_gem_dmabuf_mmap(struct dma_buf *dma_buf,
280			       struct vm_area_struct *vma)
281{
282	struct drm_gem_object *obj = dma_buf->priv;
283	struct drm_device *dev = obj->dev;
284
285	if (!dev->driver->gem_prime_mmap)
286		return -ENOSYS;
287
288	return dev->driver->gem_prime_mmap(obj, vma);
289}
290
291static const struct dma_buf_ops drm_gem_prime_dmabuf_ops =  {
292	.attach = drm_gem_map_attach,
293	.detach = drm_gem_map_detach,
294	.map_dma_buf = drm_gem_map_dma_buf,
295	.unmap_dma_buf = drm_gem_unmap_dma_buf,
296	.release = drm_gem_dmabuf_release,
297	.kmap = drm_gem_dmabuf_kmap,
298	.kmap_atomic = drm_gem_dmabuf_kmap_atomic,
299	.kunmap = drm_gem_dmabuf_kunmap,
300	.kunmap_atomic = drm_gem_dmabuf_kunmap_atomic,
301	.mmap = drm_gem_dmabuf_mmap,
302	.vmap = drm_gem_dmabuf_vmap,
303	.vunmap = drm_gem_dmabuf_vunmap,
304};
305
306/**
307 * DOC: PRIME Helpers
308 *
309 * Drivers can implement @gem_prime_export and @gem_prime_import in terms of
310 * simpler APIs by using the helper functions @drm_gem_prime_export and
311 * @drm_gem_prime_import.  These functions implement dma-buf support in terms of
312 * six lower-level driver callbacks:
313 *
314 * Export callbacks:
315 *
316 *  * @gem_prime_pin (optional): prepare a GEM object for exporting
317 *  * @gem_prime_get_sg_table: provide a scatter/gather table of pinned pages
318 *  * @gem_prime_vmap: vmap a buffer exported by your driver
319 *  * @gem_prime_vunmap: vunmap a buffer exported by your driver
320 *  * @gem_prime_mmap (optional): mmap a buffer exported by your driver
321 *
322 * Import callback:
323 *
324 *  * @gem_prime_import_sg_table (import): produce a GEM object from another
325 *    driver's scatter/gather table
326 */
327
328/**
329 * drm_gem_prime_export - helper library implementation of the export callback
330 * @dev: drm_device to export from
331 * @obj: GEM object to export
332 * @flags: flags like DRM_CLOEXEC and DRM_RDWR
333 *
334 * This is the implementation of the gem_prime_export functions for GEM drivers
335 * using the PRIME helpers.
336 */
337struct dma_buf *drm_gem_prime_export(struct drm_device *dev,
338				     struct drm_gem_object *obj, int flags)
339{
340	DEFINE_DMA_BUF_EXPORT_INFO(exp_info);
341
342	exp_info.ops = &drm_gem_prime_dmabuf_ops;
343	exp_info.size = obj->size;
344	exp_info.flags = flags;
345	exp_info.priv = obj;
346
347	if (dev->driver->gem_prime_res_obj)
348		exp_info.resv = dev->driver->gem_prime_res_obj(obj);
349
350	return dma_buf_export(&exp_info);
351}
352EXPORT_SYMBOL(drm_gem_prime_export);
353
354static struct dma_buf *export_and_register_object(struct drm_device *dev,
355						  struct drm_gem_object *obj,
356						  uint32_t flags)
357{
358	struct dma_buf *dmabuf;
359
360	/* prevent races with concurrent gem_close. */
361	if (obj->handle_count == 0) {
362		dmabuf = ERR_PTR(-ENOENT);
363		return dmabuf;
364	}
365
366	dmabuf = dev->driver->gem_prime_export(dev, obj, flags);
367	if (IS_ERR(dmabuf)) {
368		/* normally the created dma-buf takes ownership of the ref,
369		 * but if that fails then drop the ref
370		 */
371		return dmabuf;
372	}
373
374	/*
375	 * Note that callers do not need to clean up the export cache
376	 * since the check for obj->handle_count guarantees that someone
377	 * will clean it up.
378	 */
379	obj->dma_buf = dmabuf;
380	get_dma_buf(obj->dma_buf);
381	/* Grab a new ref since the callers is now used by the dma-buf */
382	drm_gem_object_reference(obj);
383
384	return dmabuf;
385}
386
387/**
388 * drm_gem_prime_handle_to_fd - PRIME export function for GEM drivers
389 * @dev: dev to export the buffer from
390 * @file_priv: drm file-private structure
391 * @handle: buffer handle to export
392 * @flags: flags like DRM_CLOEXEC
393 * @prime_fd: pointer to storage for the fd id of the create dma-buf
394 *
395 * This is the PRIME export function which must be used mandatorily by GEM
396 * drivers to ensure correct lifetime management of the underlying GEM object.
397 * The actual exporting from GEM object to a dma-buf is done through the
398 * gem_prime_export driver callback.
399 */
400int drm_gem_prime_handle_to_fd(struct drm_device *dev,
401			       struct drm_file *file_priv, uint32_t handle,
402			       uint32_t flags,
403			       int *prime_fd)
404{
405	struct drm_gem_object *obj;
406	int ret = 0;
407	struct dma_buf *dmabuf;
408
409	mutex_lock(&file_priv->prime.lock);
410	obj = drm_gem_object_lookup(dev, file_priv, handle);
411	if (!obj)  {
412		ret = -ENOENT;
413		goto out_unlock;
414	}
415
416	dmabuf = drm_prime_lookup_buf_by_handle(&file_priv->prime, handle);
417	if (dmabuf) {
418		get_dma_buf(dmabuf);
419		goto out_have_handle;
420	}
421
422	mutex_lock(&dev->object_name_lock);
423	/* re-export the original imported object */
424	if (obj->import_attach) {
425		dmabuf = obj->import_attach->dmabuf;
426		get_dma_buf(dmabuf);
427		goto out_have_obj;
428	}
429
430	if (obj->dma_buf) {
431		get_dma_buf(obj->dma_buf);
432		dmabuf = obj->dma_buf;
433		goto out_have_obj;
434	}
435
436	dmabuf = export_and_register_object(dev, obj, flags);
437	if (IS_ERR(dmabuf)) {
438		/* normally the created dma-buf takes ownership of the ref,
439		 * but if that fails then drop the ref
440		 */
441		ret = PTR_ERR(dmabuf);
442		mutex_unlock(&dev->object_name_lock);
443		goto out;
444	}
445
446out_have_obj:
447	/*
448	 * If we've exported this buffer then cheat and add it to the import list
449	 * so we get the correct handle back. We must do this under the
450	 * protection of dev->object_name_lock to ensure that a racing gem close
451	 * ioctl doesn't miss to remove this buffer handle from the cache.
452	 */
453	ret = drm_prime_add_buf_handle(&file_priv->prime,
454				       dmabuf, handle);
455	mutex_unlock(&dev->object_name_lock);
456	if (ret)
457		goto fail_put_dmabuf;
458
459out_have_handle:
460	ret = dma_buf_fd(dmabuf, flags);
461	/*
462	 * We must _not_ remove the buffer from the handle cache since the newly
463	 * created dma buf is already linked in the global obj->dma_buf pointer,
464	 * and that is invariant as long as a userspace gem handle exists.
465	 * Closing the handle will clean out the cache anyway, so we don't leak.
466	 */
467	if (ret < 0) {
468		goto fail_put_dmabuf;
469	} else {
470		*prime_fd = ret;
471		ret = 0;
472	}
473
474	goto out;
475
476fail_put_dmabuf:
477	dma_buf_put(dmabuf);
478out:
479	drm_gem_object_unreference_unlocked(obj);
480out_unlock:
481	mutex_unlock(&file_priv->prime.lock);
482
483	return ret;
484}
485EXPORT_SYMBOL(drm_gem_prime_handle_to_fd);
486
487/**
488 * drm_gem_prime_import - helper library implementation of the import callback
489 * @dev: drm_device to import into
490 * @dma_buf: dma-buf object to import
491 *
492 * This is the implementation of the gem_prime_import functions for GEM drivers
493 * using the PRIME helpers.
494 */
495struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev,
496					    struct dma_buf *dma_buf)
497{
498	struct dma_buf_attachment *attach;
499	struct sg_table *sgt;
500	struct drm_gem_object *obj;
501	int ret;
502
503	if (dma_buf->ops == &drm_gem_prime_dmabuf_ops) {
504		obj = dma_buf->priv;
505		if (obj->dev == dev) {
506			/*
507			 * Importing dmabuf exported from out own gem increases
508			 * refcount on gem itself instead of f_count of dmabuf.
509			 */
510			drm_gem_object_reference(obj);
511			return obj;
512		}
513	}
514
515	if (!dev->driver->gem_prime_import_sg_table)
516		return ERR_PTR(-EINVAL);
517
518	attach = dma_buf_attach(dma_buf, dev->dev);
519	if (IS_ERR(attach))
520		return ERR_CAST(attach);
521
522	get_dma_buf(dma_buf);
523
524	sgt = dma_buf_map_attachment(attach, DMA_BIDIRECTIONAL);
525	if (IS_ERR(sgt)) {
526		ret = PTR_ERR(sgt);
527		goto fail_detach;
528	}
529
530	obj = dev->driver->gem_prime_import_sg_table(dev, attach, sgt);
531	if (IS_ERR(obj)) {
532		ret = PTR_ERR(obj);
533		goto fail_unmap;
534	}
535
536	obj->import_attach = attach;
537
538	return obj;
539
540fail_unmap:
541	dma_buf_unmap_attachment(attach, sgt, DMA_BIDIRECTIONAL);
542fail_detach:
543	dma_buf_detach(dma_buf, attach);
544	dma_buf_put(dma_buf);
545
546	return ERR_PTR(ret);
547}
548EXPORT_SYMBOL(drm_gem_prime_import);
549
550/**
551 * drm_gem_prime_fd_to_handle - PRIME import function for GEM drivers
552 * @dev: dev to export the buffer from
553 * @file_priv: drm file-private structure
554 * @prime_fd: fd id of the dma-buf which should be imported
555 * @handle: pointer to storage for the handle of the imported buffer object
556 *
557 * This is the PRIME import function which must be used mandatorily by GEM
558 * drivers to ensure correct lifetime management of the underlying GEM object.
559 * The actual importing of GEM object from the dma-buf is done through the
560 * gem_import_export driver callback.
561 */
562int drm_gem_prime_fd_to_handle(struct drm_device *dev,
563			       struct drm_file *file_priv, int prime_fd,
564			       uint32_t *handle)
565{
566	struct dma_buf *dma_buf;
567	struct drm_gem_object *obj;
568	int ret;
569
570	dma_buf = dma_buf_get(prime_fd);
571	if (IS_ERR(dma_buf))
572		return PTR_ERR(dma_buf);
573
574	mutex_lock(&file_priv->prime.lock);
575
576	ret = drm_prime_lookup_buf_handle(&file_priv->prime,
577			dma_buf, handle);
578	if (ret == 0)
579		goto out_put;
580
581	/* never seen this one, need to import */
582	mutex_lock(&dev->object_name_lock);
583	obj = dev->driver->gem_prime_import(dev, dma_buf);
584	if (IS_ERR(obj)) {
585		ret = PTR_ERR(obj);
586		goto out_unlock;
587	}
588
589	if (obj->dma_buf) {
590		WARN_ON(obj->dma_buf != dma_buf);
591	} else {
592		obj->dma_buf = dma_buf;
593		get_dma_buf(dma_buf);
594	}
595
596	/* drm_gem_handle_create_tail unlocks dev->object_name_lock. */
597	ret = drm_gem_handle_create_tail(file_priv, obj, handle);
598	drm_gem_object_unreference_unlocked(obj);
599	if (ret)
600		goto out_put;
601
602	ret = drm_prime_add_buf_handle(&file_priv->prime,
603			dma_buf, *handle);
604	if (ret)
605		goto fail;
606
607	mutex_unlock(&file_priv->prime.lock);
608
609	dma_buf_put(dma_buf);
610
611	return 0;
612
613fail:
614	/* hmm, if driver attached, we are relying on the free-object path
615	 * to detach.. which seems ok..
616	 */
617	drm_gem_handle_delete(file_priv, *handle);
618out_unlock:
619	mutex_unlock(&dev->object_name_lock);
620out_put:
621	dma_buf_put(dma_buf);
622	mutex_unlock(&file_priv->prime.lock);
623	return ret;
624}
625EXPORT_SYMBOL(drm_gem_prime_fd_to_handle);
626
627int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data,
628				 struct drm_file *file_priv)
629{
630	struct drm_prime_handle *args = data;
631
632	if (!drm_core_check_feature(dev, DRIVER_PRIME))
633		return -EINVAL;
634
635	if (!dev->driver->prime_handle_to_fd)
636		return -ENOSYS;
637
638	/* check flags are valid */
639	if (args->flags & ~(DRM_CLOEXEC | DRM_RDWR))
640		return -EINVAL;
641
642	return dev->driver->prime_handle_to_fd(dev, file_priv,
643			args->handle, args->flags, &args->fd);
644}
645
646int drm_prime_fd_to_handle_ioctl(struct drm_device *dev, void *data,
647				 struct drm_file *file_priv)
648{
649	struct drm_prime_handle *args = data;
650
651	if (!drm_core_check_feature(dev, DRIVER_PRIME))
652		return -EINVAL;
653
654	if (!dev->driver->prime_fd_to_handle)
655		return -ENOSYS;
656
657	return dev->driver->prime_fd_to_handle(dev, file_priv,
658			args->fd, &args->handle);
659}
660
661/**
662 * drm_prime_pages_to_sg - converts a page array into an sg list
663 * @pages: pointer to the array of page pointers to convert
664 * @nr_pages: length of the page vector
665 *
666 * This helper creates an sg table object from a set of pages
667 * the driver is responsible for mapping the pages into the
668 * importers address space for use with dma_buf itself.
669 */
670struct sg_table *drm_prime_pages_to_sg(struct page **pages, unsigned int nr_pages)
671{
672	struct sg_table *sg = NULL;
673	int ret;
674
675	sg = kmalloc(sizeof(struct sg_table), GFP_KERNEL);
676	if (!sg) {
677		ret = -ENOMEM;
678		goto out;
679	}
680
681	ret = sg_alloc_table_from_pages(sg, pages, nr_pages, 0,
682				nr_pages << PAGE_SHIFT, GFP_KERNEL);
683	if (ret)
684		goto out;
685
686	return sg;
687out:
688	kfree(sg);
689	return ERR_PTR(ret);
690}
691EXPORT_SYMBOL(drm_prime_pages_to_sg);
692
693/**
694 * drm_prime_sg_to_page_addr_arrays - convert an sg table into a page array
695 * @sgt: scatter-gather table to convert
696 * @pages: array of page pointers to store the page array in
697 * @addrs: optional array to store the dma bus address of each page
698 * @max_pages: size of both the passed-in arrays
699 *
700 * Exports an sg table into an array of pages and addresses. This is currently
701 * required by the TTM driver in order to do correct fault handling.
702 */
703int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages,
704				     dma_addr_t *addrs, int max_pages)
705{
706	unsigned count;
707	struct scatterlist *sg;
708	struct page *page;
709	u32 len;
710	int pg_index;
711	dma_addr_t addr;
712
713	pg_index = 0;
714	for_each_sg(sgt->sgl, sg, sgt->nents, count) {
715		len = sg->length;
716		page = sg_page(sg);
717		addr = sg_dma_address(sg);
718
719		while (len > 0) {
720			if (WARN_ON(pg_index >= max_pages))
721				return -1;
722			pages[pg_index] = page;
723			if (addrs)
724				addrs[pg_index] = addr;
725
726			page++;
727			addr += PAGE_SIZE;
728			len -= PAGE_SIZE;
729			pg_index++;
730		}
731	}
732	return 0;
733}
734EXPORT_SYMBOL(drm_prime_sg_to_page_addr_arrays);
735
736/**
737 * drm_prime_gem_destroy - helper to clean up a PRIME-imported GEM object
738 * @obj: GEM object which was created from a dma-buf
739 * @sg: the sg-table which was pinned at import time
740 *
741 * This is the cleanup functions which GEM drivers need to call when they use
742 * @drm_gem_prime_import to import dma-bufs.
743 */
744void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg)
745{
746	struct dma_buf_attachment *attach;
747	struct dma_buf *dma_buf;
748	attach = obj->import_attach;
749	if (sg)
750		dma_buf_unmap_attachment(attach, sg, DMA_BIDIRECTIONAL);
751	dma_buf = attach->dmabuf;
752	dma_buf_detach(attach->dmabuf, attach);
753	/* remove the reference */
754	dma_buf_put(dma_buf);
755}
756EXPORT_SYMBOL(drm_prime_gem_destroy);
757
758void drm_prime_init_file_private(struct drm_prime_file_private *prime_fpriv)
759{
760	INIT_LIST_HEAD(&prime_fpriv->head);
761	mutex_init(&prime_fpriv->lock);
762}
763
764void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv)
765{
766	/* by now drm_gem_release should've made sure the list is empty */
767	WARN_ON(!list_empty(&prime_fpriv->head));
768}