drm_prime.c 20.4 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
/*
 * Copyright © 2012 Red Hat
 *
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice (including the next
 * paragraph) shall be included in all copies or substantial portions of the
 * Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 *
 * Authors:
 *      Dave Airlie <airlied@redhat.com>
 *      Rob Clark <rob.clark@linaro.org>
 *
 */

#include <linux/export.h>
#include <linux/dma-buf.h>
31
#include <drm/drmP.h>
D
Daniel Vetter 已提交
32 33
#include <drm/drm_gem.h>

34
#include "drm_internal.h"
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58

/*
 * DMA-BUF/GEM Object references and lifetime overview:
 *
 * On the export the dma_buf holds a reference to the exporting GEM
 * object. It takes this reference in handle_to_fd_ioctl, when it
 * first calls .prime_export and stores the exporting GEM object in
 * the dma_buf priv. This reference is released when the dma_buf
 * object goes away in the driver .release function.
 *
 * On the import the importing GEM object holds a reference to the
 * dma_buf (which in turn holds a ref to the exporting GEM object).
 * It takes that reference in the fd_to_handle ioctl.
 * It calls dma_buf_get, creates an attachment to it and stores the
 * attachment in the GEM object. When this attachment is destroyed
 * when the imported object is destroyed, we remove the attachment
 * and drop the reference to the dma_buf.
 *
 * Thus the chain of references always flows in one direction
 * (avoiding loops): importing_gem -> dmabuf -> exporting_gem
 *
 * Self-importing: if userspace is using PRIME as a replacement for flink
 * then it will get a fd->handle request for a GEM object that it created.
 * Drivers should detect this situation and return back the gem object
A
Aaron Plattner 已提交
59 60
 * from the dma-buf private.  Prime will do this automatically for drivers that
 * use the drm_gem_prime_{import,export} helpers.
61 62 63 64 65 66 67
 */

struct drm_prime_member {
	struct list_head entry;
	struct dma_buf *dma_buf;
	uint32_t handle;
};
68 69 70 71 72 73

struct drm_prime_attachment {
	struct sg_table *sgt;
	enum dma_data_direction dir;
};

74 75
static int drm_prime_add_buf_handle(struct drm_prime_file_private *prime_fpriv,
				    struct dma_buf *dma_buf, uint32_t handle)
76 77 78 79 80 81 82 83 84 85 86 87 88
{
	struct drm_prime_member *member;

	member = kmalloc(sizeof(*member), GFP_KERNEL);
	if (!member)
		return -ENOMEM;

	get_dma_buf(dma_buf);
	member->dma_buf = dma_buf;
	member->handle = handle;
	list_add(&member->entry, &prime_fpriv->head);
	return 0;
}
89

90 91 92 93 94 95 96 97 98 99 100 101 102
static struct dma_buf *drm_prime_lookup_buf_by_handle(struct drm_prime_file_private *prime_fpriv,
						      uint32_t handle)
{
	struct drm_prime_member *member;

	list_for_each_entry(member, &prime_fpriv->head, entry) {
		if (member->handle == handle)
			return member->dma_buf;
	}

	return NULL;
}

103 104 105 106 107 108 109 110 111 112 113 114 115 116 117
static int drm_prime_lookup_buf_handle(struct drm_prime_file_private *prime_fpriv,
				       struct dma_buf *dma_buf,
				       uint32_t *handle)
{
	struct drm_prime_member *member;

	list_for_each_entry(member, &prime_fpriv->head, entry) {
		if (member->dma_buf == dma_buf) {
			*handle = member->handle;
			return 0;
		}
	}
	return -ENOENT;
}

118 119 120 121
static int drm_gem_map_attach(struct dma_buf *dma_buf,
			      struct device *target_dev,
			      struct dma_buf_attachment *attach)
{
122
	struct drm_prime_attachment *prime_attach;
123 124 125
	struct drm_gem_object *obj = dma_buf->priv;
	struct drm_device *dev = obj->dev;

126 127 128 129 130 131 132
	prime_attach = kzalloc(sizeof(*prime_attach), GFP_KERNEL);
	if (!prime_attach)
		return -ENOMEM;

	prime_attach->dir = DMA_NONE;
	attach->priv = prime_attach;

133 134 135 136 137 138 139 140 141
	if (!dev->driver->gem_prime_pin)
		return 0;

	return dev->driver->gem_prime_pin(obj);
}

static void drm_gem_map_detach(struct dma_buf *dma_buf,
			       struct dma_buf_attachment *attach)
{
142
	struct drm_prime_attachment *prime_attach = attach->priv;
143 144
	struct drm_gem_object *obj = dma_buf->priv;
	struct drm_device *dev = obj->dev;
145
	struct sg_table *sgt;
146 147 148

	if (dev->driver->gem_prime_unpin)
		dev->driver->gem_prime_unpin(obj);
149 150 151 152 153

	if (!prime_attach)
		return;

	sgt = prime_attach->sgt;
154 155 156 157 158 159
	if (sgt) {
		if (prime_attach->dir != DMA_NONE)
			dma_unmap_sg(attach->dev, sgt->sgl, sgt->nents,
					prime_attach->dir);
		sg_free_table(sgt);
	}
160 161 162 163

	kfree(sgt);
	kfree(prime_attach);
	attach->priv = NULL;
164 165
}

166 167
void drm_prime_remove_buf_handle_locked(struct drm_prime_file_private *prime_fpriv,
					struct dma_buf *dma_buf)
168 169 170 171 172 173 174 175 176 177 178 179
{
	struct drm_prime_member *member, *safe;

	list_for_each_entry_safe(member, safe, &prime_fpriv->head, entry) {
		if (member->dma_buf == dma_buf) {
			dma_buf_put(dma_buf);
			list_del(&member->entry);
			kfree(member);
		}
	}
}

A
Aaron Plattner 已提交
180
static struct sg_table *drm_gem_map_dma_buf(struct dma_buf_attachment *attach,
181
					    enum dma_data_direction dir)
A
Aaron Plattner 已提交
182
{
183
	struct drm_prime_attachment *prime_attach = attach->priv;
A
Aaron Plattner 已提交
184 185 186
	struct drm_gem_object *obj = attach->dmabuf->priv;
	struct sg_table *sgt;

187 188 189 190 191 192 193 194 195 196 197 198 199 200
	if (WARN_ON(dir == DMA_NONE || !prime_attach))
		return ERR_PTR(-EINVAL);

	/* return the cached mapping when possible */
	if (prime_attach->dir == dir)
		return prime_attach->sgt;

	/*
	 * two mappings with different directions for the same attachment are
	 * not allowed
	 */
	if (WARN_ON(prime_attach->dir != DMA_NONE))
		return ERR_PTR(-EBUSY);

A
Aaron Plattner 已提交
201 202
	sgt = obj->dev->driver->gem_prime_get_sg_table(obj);

203
	if (!IS_ERR(sgt)) {
204 205 206 207
		if (!dma_map_sg(attach->dev, sgt->sgl, sgt->nents, dir)) {
			sg_free_table(sgt);
			kfree(sgt);
			sgt = ERR_PTR(-ENOMEM);
208 209 210
		} else {
			prime_attach->sgt = sgt;
			prime_attach->dir = dir;
211 212
		}
	}
A
Aaron Plattner 已提交
213 214 215 216 217

	return sgt;
}

static void drm_gem_unmap_dma_buf(struct dma_buf_attachment *attach,
218 219
				  struct sg_table *sgt,
				  enum dma_data_direction dir)
A
Aaron Plattner 已提交
220
{
221
	/* nothing to be done here */
A
Aaron Plattner 已提交
222 223
}

224 225 226 227 228 229 230
/**
 * drm_gem_dmabuf_release - dma_buf release implementation for GEM
 * @dma_buf: buffer to be released
 *
 * Generic release function for dma_bufs exported as PRIME buffers. GEM drivers
 * must use this in their dma_buf ops structure as the release callback.
 */
231
void drm_gem_dmabuf_release(struct dma_buf *dma_buf)
A
Aaron Plattner 已提交
232 233 234
{
	struct drm_gem_object *obj = dma_buf->priv;

235 236
	/* drop the reference on the export fd holds */
	drm_gem_object_unreference_unlocked(obj);
A
Aaron Plattner 已提交
237
}
238
EXPORT_SYMBOL(drm_gem_dmabuf_release);
A
Aaron Plattner 已提交
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256

static void *drm_gem_dmabuf_vmap(struct dma_buf *dma_buf)
{
	struct drm_gem_object *obj = dma_buf->priv;
	struct drm_device *dev = obj->dev;

	return dev->driver->gem_prime_vmap(obj);
}

static void drm_gem_dmabuf_vunmap(struct dma_buf *dma_buf, void *vaddr)
{
	struct drm_gem_object *obj = dma_buf->priv;
	struct drm_device *dev = obj->dev;

	dev->driver->gem_prime_vunmap(obj, vaddr);
}

static void *drm_gem_dmabuf_kmap_atomic(struct dma_buf *dma_buf,
257
					unsigned long page_num)
A
Aaron Plattner 已提交
258 259 260 261 262
{
	return NULL;
}

static void drm_gem_dmabuf_kunmap_atomic(struct dma_buf *dma_buf,
263
					 unsigned long page_num, void *addr)
A
Aaron Plattner 已提交
264 265 266 267
{

}
static void *drm_gem_dmabuf_kmap(struct dma_buf *dma_buf,
268
				 unsigned long page_num)
A
Aaron Plattner 已提交
269 270 271 272 273
{
	return NULL;
}

static void drm_gem_dmabuf_kunmap(struct dma_buf *dma_buf,
274
				  unsigned long page_num, void *addr)
A
Aaron Plattner 已提交
275 276 277 278 279
{

}

static int drm_gem_dmabuf_mmap(struct dma_buf *dma_buf,
280
			       struct vm_area_struct *vma)
A
Aaron Plattner 已提交
281
{
282 283 284 285 286 287 288
	struct drm_gem_object *obj = dma_buf->priv;
	struct drm_device *dev = obj->dev;

	if (!dev->driver->gem_prime_mmap)
		return -ENOSYS;

	return dev->driver->gem_prime_mmap(obj, vma);
A
Aaron Plattner 已提交
289 290 291
}

static const struct dma_buf_ops drm_gem_prime_dmabuf_ops =  {
292 293
	.attach = drm_gem_map_attach,
	.detach = drm_gem_map_detach,
A
Aaron Plattner 已提交
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
	.map_dma_buf = drm_gem_map_dma_buf,
	.unmap_dma_buf = drm_gem_unmap_dma_buf,
	.release = drm_gem_dmabuf_release,
	.kmap = drm_gem_dmabuf_kmap,
	.kmap_atomic = drm_gem_dmabuf_kmap_atomic,
	.kunmap = drm_gem_dmabuf_kunmap,
	.kunmap_atomic = drm_gem_dmabuf_kunmap_atomic,
	.mmap = drm_gem_dmabuf_mmap,
	.vmap = drm_gem_dmabuf_vmap,
	.vunmap = drm_gem_dmabuf_vunmap,
};

/**
 * DOC: PRIME Helpers
 *
 * Drivers can implement @gem_prime_export and @gem_prime_import in terms of
 * simpler APIs by using the helper functions @drm_gem_prime_export and
 * @drm_gem_prime_import.  These functions implement dma-buf support in terms of
312
 * six lower-level driver callbacks:
A
Aaron Plattner 已提交
313 314 315
 *
 * Export callbacks:
 *
316 317 318 319 320
 *  * @gem_prime_pin (optional): prepare a GEM object for exporting
 *  * @gem_prime_get_sg_table: provide a scatter/gather table of pinned pages
 *  * @gem_prime_vmap: vmap a buffer exported by your driver
 *  * @gem_prime_vunmap: vunmap a buffer exported by your driver
 *  * @gem_prime_mmap (optional): mmap a buffer exported by your driver
321
 *
A
Aaron Plattner 已提交
322 323
 * Import callback:
 *
324
 *  * @gem_prime_import_sg_table (import): produce a GEM object from another
A
Aaron Plattner 已提交
325 326 327
 *    driver's scatter/gather table
 */

328
/**
329
 * drm_gem_prime_export - helper library implementation of the export callback
330 331
 * @dev: drm_device to export from
 * @obj: GEM object to export
332
 * @flags: flags like DRM_CLOEXEC and DRM_RDWR
333 334 335 336
 *
 * This is the implementation of the gem_prime_export functions for GEM drivers
 * using the PRIME helpers.
 */
A
Aaron Plattner 已提交
337 338 339
struct dma_buf *drm_gem_prime_export(struct drm_device *dev,
				     struct drm_gem_object *obj, int flags)
{
340 341 342 343 344 345
	DEFINE_DMA_BUF_EXPORT_INFO(exp_info);

	exp_info.ops = &drm_gem_prime_dmabuf_ops;
	exp_info.size = obj->size;
	exp_info.flags = flags;
	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);
A
Aaron Plattner 已提交
351 352 353
}
EXPORT_SYMBOL(drm_gem_prime_export);

354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380
static struct dma_buf *export_and_register_object(struct drm_device *dev,
						  struct drm_gem_object *obj,
						  uint32_t flags)
{
	struct dma_buf *dmabuf;

	/* prevent races with concurrent gem_close. */
	if (obj->handle_count == 0) {
		dmabuf = ERR_PTR(-ENOENT);
		return dmabuf;
	}

	dmabuf = dev->driver->gem_prime_export(dev, obj, flags);
	if (IS_ERR(dmabuf)) {
		/* normally the created dma-buf takes ownership of the ref,
		 * but if that fails then drop the ref
		 */
		return dmabuf;
	}

	/*
	 * Note that callers do not need to clean up the export cache
	 * since the check for obj->handle_count guarantees that someone
	 * will clean it up.
	 */
	obj->dma_buf = dmabuf;
	get_dma_buf(obj->dma_buf);
381 382
	/* Grab a new ref since the callers is now used by the dma-buf */
	drm_gem_object_reference(obj);
383 384 385 386

	return dmabuf;
}

387 388 389 390 391 392 393 394 395 396 397 398 399
/**
 * drm_gem_prime_handle_to_fd - PRIME export function for GEM drivers
 * @dev: dev to export the buffer from
 * @file_priv: drm file-private structure
 * @handle: buffer handle to export
 * @flags: flags like DRM_CLOEXEC
 * @prime_fd: pointer to storage for the fd id of the create dma-buf
 *
 * This is the PRIME export function which must be used mandatorily by GEM
 * drivers to ensure correct lifetime management of the underlying GEM object.
 * The actual exporting from GEM object to a dma-buf is done through the
 * gem_prime_export driver callback.
 */
400
int drm_gem_prime_handle_to_fd(struct drm_device *dev,
401 402 403
			       struct drm_file *file_priv, uint32_t handle,
			       uint32_t flags,
			       int *prime_fd)
404 405
{
	struct drm_gem_object *obj;
406 407
	int ret = 0;
	struct dma_buf *dmabuf;
408

409
	mutex_lock(&file_priv->prime.lock);
410
	obj = drm_gem_object_lookup(dev, file_priv, handle);
411 412 413 414 415 416 417 418 419 420
	if (!obj)  {
		ret = -ENOENT;
		goto out_unlock;
	}

	dmabuf = drm_prime_lookup_buf_by_handle(&file_priv->prime, handle);
	if (dmabuf) {
		get_dma_buf(dmabuf);
		goto out_have_handle;
	}
421

422
	mutex_lock(&dev->object_name_lock);
423 424
	/* re-export the original imported object */
	if (obj->import_attach) {
425
		dmabuf = obj->import_attach->dmabuf;
426
		get_dma_buf(dmabuf);
427
		goto out_have_obj;
428 429
	}

430 431 432
	if (obj->dma_buf) {
		get_dma_buf(obj->dma_buf);
		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 439 440
		/* normally the created dma-buf takes ownership of the ref,
		 * but if that fails then drop the ref
		 */
441
		ret = PTR_ERR(dmabuf);
442
		mutex_unlock(&dev->object_name_lock);
443 444 445
		goto out;
	}

446 447 448 449 450 451
out_have_obj:
	/*
	 * If we've exported this buffer then cheat and add it to the import list
	 * so we get the correct handle back. We must do this under the
	 * protection of dev->object_name_lock to ensure that a racing gem close
	 * 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

459
out_have_handle:
460
	ret = dma_buf_fd(dmabuf, flags);
461 462 463 464 465 466
	/*
	 * We must _not_ remove the buffer from the handle cache since the newly
	 * created dma buf is already linked in the global obj->dma_buf pointer,
	 * and that is invariant as long as a userspace gem handle exists.
	 * Closing the handle will clean out the cache anyway, so we don't leak.
	 */
467
	if (ret < 0) {
468
		goto fail_put_dmabuf;
469
	} else {
470
		*prime_fd = ret;
471 472 473
		ret = 0;
	}

474 475 476
	goto out;

fail_put_dmabuf:
477
	dma_buf_put(dmabuf);
478 479
out:
	drm_gem_object_unreference_unlocked(obj);
480 481 482
out_unlock:
	mutex_unlock(&file_priv->prime.lock);

483
	return ret;
484 485 486
}
EXPORT_SYMBOL(drm_gem_prime_handle_to_fd);

487
/**
488
 * drm_gem_prime_import - helper library implementation of the import callback
489 490 491 492 493 494
 * @dev: drm_device to import into
 * @dma_buf: dma-buf object to import
 *
 * This is the implementation of the gem_prime_import functions for GEM drivers
 * using the PRIME helpers.
 */
A
Aaron Plattner 已提交
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev,
					    struct dma_buf *dma_buf)
{
	struct dma_buf_attachment *attach;
	struct sg_table *sgt;
	struct drm_gem_object *obj;
	int ret;

	if (dma_buf->ops == &drm_gem_prime_dmabuf_ops) {
		obj = dma_buf->priv;
		if (obj->dev == dev) {
			/*
			 * Importing dmabuf exported from out own gem increases
			 * refcount on gem itself instead of f_count of dmabuf.
			 */
			drm_gem_object_reference(obj);
			return obj;
		}
	}

515 516 517
	if (!dev->driver->gem_prime_import_sg_table)
		return ERR_PTR(-EINVAL);

A
Aaron Plattner 已提交
518 519
	attach = dma_buf_attach(dma_buf, dev->dev);
	if (IS_ERR(attach))
520
		return ERR_CAST(attach);
A
Aaron Plattner 已提交
521

522 523
	get_dma_buf(dma_buf);

A
Aaron Plattner 已提交
524
	sgt = dma_buf_map_attachment(attach, DMA_BIDIRECTIONAL);
525
	if (IS_ERR(sgt)) {
A
Aaron Plattner 已提交
526 527 528 529
		ret = PTR_ERR(sgt);
		goto fail_detach;
	}

530
	obj = dev->driver->gem_prime_import_sg_table(dev, attach, sgt);
A
Aaron Plattner 已提交
531 532 533 534 535 536 537 538 539 540 541 542 543
	if (IS_ERR(obj)) {
		ret = PTR_ERR(obj);
		goto fail_unmap;
	}

	obj->import_attach = attach;

	return obj;

fail_unmap:
	dma_buf_unmap_attachment(attach, sgt, DMA_BIDIRECTIONAL);
fail_detach:
	dma_buf_detach(dma_buf, attach);
544 545
	dma_buf_put(dma_buf);

A
Aaron Plattner 已提交
546 547 548 549
	return ERR_PTR(ret);
}
EXPORT_SYMBOL(drm_gem_prime_import);

550 551 552 553 554 555 556 557 558 559 560 561
/**
 * drm_gem_prime_fd_to_handle - PRIME import function for GEM drivers
 * @dev: dev to export the buffer from
 * @file_priv: drm file-private structure
 * @prime_fd: fd id of the dma-buf which should be imported
 * @handle: pointer to storage for the handle of the imported buffer object
 *
 * This is the PRIME import function which must be used mandatorily by GEM
 * drivers to ensure correct lifetime management of the underlying GEM object.
 * The actual importing of GEM object from the dma-buf is done through the
 * gem_import_export driver callback.
 */
562
int drm_gem_prime_fd_to_handle(struct drm_device *dev,
563 564
			       struct drm_file *file_priv, int prime_fd,
			       uint32_t *handle)
565 566 567 568 569 570 571 572 573 574 575
{
	struct dma_buf *dma_buf;
	struct drm_gem_object *obj;
	int ret;

	dma_buf = dma_buf_get(prime_fd);
	if (IS_ERR(dma_buf))
		return PTR_ERR(dma_buf);

	mutex_lock(&file_priv->prime.lock);

576
	ret = drm_prime_lookup_buf_handle(&file_priv->prime,
577
			dma_buf, handle);
578
	if (ret == 0)
579 580 581
		goto out_put;

	/* never seen this one, need to import */
582
	mutex_lock(&dev->object_name_lock);
583 584 585
	obj = dev->driver->gem_prime_import(dev, dma_buf);
	if (IS_ERR(obj)) {
		ret = PTR_ERR(obj);
586 587 588 589 590 591 592 593
		goto out_unlock;
	}

	if (obj->dma_buf) {
		WARN_ON(obj->dma_buf != dma_buf);
	} else {
		obj->dma_buf = dma_buf;
		get_dma_buf(dma_buf);
594 595
	}

596 597
	/* drm_gem_handle_create_tail unlocks dev->object_name_lock. */
	ret = drm_gem_handle_create_tail(file_priv, obj, handle);
598 599 600 601
	drm_gem_object_unreference_unlocked(obj);
	if (ret)
		goto out_put;

602
	ret = drm_prime_add_buf_handle(&file_priv->prime,
603 604 605 606 607
			dma_buf, *handle);
	if (ret)
		goto fail;

	mutex_unlock(&file_priv->prime.lock);
608 609 610

	dma_buf_put(dma_buf);

611 612 613 614 615 616
	return 0;

fail:
	/* hmm, if driver attached, we are relying on the free-object path
	 * to detach.. which seems ok..
	 */
617
	drm_gem_handle_delete(file_priv, *handle);
618
out_unlock:
D
Dan Carpenter 已提交
619
	mutex_unlock(&dev->object_name_lock);
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638
out_put:
	dma_buf_put(dma_buf);
	mutex_unlock(&file_priv->prime.lock);
	return ret;
}
EXPORT_SYMBOL(drm_gem_prime_fd_to_handle);

int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data,
				 struct drm_file *file_priv)
{
	struct drm_prime_handle *args = data;

	if (!drm_core_check_feature(dev, DRIVER_PRIME))
		return -EINVAL;

	if (!dev->driver->prime_handle_to_fd)
		return -ENOSYS;

	/* check flags are valid */
639
	if (args->flags & ~(DRM_CLOEXEC | DRM_RDWR))
640 641 642
		return -EINVAL;

	return dev->driver->prime_handle_to_fd(dev, file_priv,
643
			args->handle, args->flags, &args->fd);
644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660
}

int drm_prime_fd_to_handle_ioctl(struct drm_device *dev, void *data,
				 struct drm_file *file_priv)
{
	struct drm_prime_handle *args = data;

	if (!drm_core_check_feature(dev, DRIVER_PRIME))
		return -EINVAL;

	if (!dev->driver->prime_fd_to_handle)
		return -ENOSYS;

	return dev->driver->prime_fd_to_handle(dev, file_priv,
			args->fd, &args->handle);
}

661 662 663 664
/**
 * drm_prime_pages_to_sg - converts a page array into an sg list
 * @pages: pointer to the array of page pointers to convert
 * @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
 */
670
struct sg_table *drm_prime_pages_to_sg(struct page **pages, unsigned int nr_pages)
671 672 673 674 675
{
	struct sg_table *sg = NULL;
	int ret;

	sg = kmalloc(sizeof(struct sg_table), GFP_KERNEL);
676 677
	if (!sg) {
		ret = -ENOMEM;
678
		goto out;
679
	}
680

681 682
	ret = sg_alloc_table_from_pages(sg, pages, nr_pages, 0,
				nr_pages << PAGE_SHIFT, GFP_KERNEL);
683 684 685 686 687 688
	if (ret)
		goto out;

	return sg;
out:
	kfree(sg);
689
	return ERR_PTR(ret);
690 691 692
}
EXPORT_SYMBOL(drm_prime_pages_to_sg);

693 694 695 696 697 698 699 700 701 702
/**
 * drm_prime_sg_to_page_addr_arrays - convert an sg table into a page array
 * @sgt: scatter-gather table to convert
 * @pages: array of page pointers to store the page array in
 * @addrs: optional array to store the dma bus address of each page
 * @max_pages: size of both the passed-in arrays
 *
 * Exports an sg table into an array of pages and addresses. This is currently
 * required by the TTM driver in order to do correct fault handling.
 */
703 704 705 706 707 708
int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages,
				     dma_addr_t *addrs, int max_pages)
{
	unsigned count;
	struct scatterlist *sg;
	struct page *page;
709
	u32 len;
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734
	int pg_index;
	dma_addr_t addr;

	pg_index = 0;
	for_each_sg(sgt->sgl, sg, sgt->nents, count) {
		len = sg->length;
		page = sg_page(sg);
		addr = sg_dma_address(sg);

		while (len > 0) {
			if (WARN_ON(pg_index >= max_pages))
				return -1;
			pages[pg_index] = page;
			if (addrs)
				addrs[pg_index] = addr;

			page++;
			addr += PAGE_SIZE;
			len -= PAGE_SIZE;
			pg_index++;
		}
	}
	return 0;
}
EXPORT_SYMBOL(drm_prime_sg_to_page_addr_arrays);
735 736 737 738 739 740 741 742 743

/**
 * drm_prime_gem_destroy - helper to clean up a PRIME-imported GEM object
 * @obj: GEM object which was created from a dma-buf
 * @sg: the sg-table which was pinned at import time
 *
 * This is the cleanup functions which GEM drivers need to call when they use
 * @drm_gem_prime_import to import dma-bufs.
 */
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765
void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg)
{
	struct dma_buf_attachment *attach;
	struct dma_buf *dma_buf;
	attach = obj->import_attach;
	if (sg)
		dma_buf_unmap_attachment(attach, sg, DMA_BIDIRECTIONAL);
	dma_buf = attach->dmabuf;
	dma_buf_detach(attach->dmabuf, attach);
	/* remove the reference */
	dma_buf_put(dma_buf);
}
EXPORT_SYMBOL(drm_prime_gem_destroy);

void drm_prime_init_file_private(struct drm_prime_file_private *prime_fpriv)
{
	INIT_LIST_HEAD(&prime_fpriv->head);
	mutex_init(&prime_fpriv->lock);
}

void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv)
{
766 767
	/* by now drm_gem_release should've made sure the list is empty */
	WARN_ON(!list_empty(&prime_fpriv->head));
768
}