blob: aab0f3f1f42d5528efb184770d9f5bc9d949ce9d [file] [log] [blame]
Dave Airlie32488772011-11-25 15:21:02 +00001/*
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>
David Howells760285e2012-10-02 18:01:07 +010031#include <drm/drmP.h>
Daniel Vetterd9fc9412014-09-23 15:46:53 +020032#include <drm/drm_gem.h>
33
Daniel Vetter67d0ec42014-09-10 12:43:53 +020034#include "drm_internal.h"
Dave Airlie32488772011-11-25 15:21:02 +000035
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
Aaron Plattner89177642013-01-15 20:47:42 +000059 * from the dma-buf private. Prime will do this automatically for drivers that
60 * use the drm_gem_prime_{import,export} helpers.
Dave Airlie32488772011-11-25 15:21:02 +000061 */
62
63struct drm_prime_member {
64 struct list_head entry;
65 struct dma_buf *dma_buf;
66 uint32_t handle;
67};
Joonyoung Shim538d6662013-06-19 15:03:05 +090068
69struct drm_prime_attachment {
70 struct sg_table *sgt;
71 enum dma_data_direction dir;
72};
73
Daniel Vetter39cc3442014-01-22 19:16:30 +010074static int drm_prime_add_buf_handle(struct drm_prime_file_private *prime_fpriv,
75 struct dma_buf *dma_buf, uint32_t handle)
Seung-Woo Kimce92e3c2013-06-26 10:21:41 +090076{
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}
Dave Airlie32488772011-11-25 15:21:02 +000089
Daniel Vetterd0b2c532013-08-15 00:02:49 +020090static 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
Daniel Vetterde9564d2013-08-15 00:02:48 +0200103static 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
Maarten Lankhorstca793f72013-04-09 09:52:54 +0200118static int drm_gem_map_attach(struct dma_buf *dma_buf,
119 struct device *target_dev,
120 struct dma_buf_attachment *attach)
121{
Joonyoung Shim538d6662013-06-19 15:03:05 +0900122 struct drm_prime_attachment *prime_attach;
Maarten Lankhorstca793f72013-04-09 09:52:54 +0200123 struct drm_gem_object *obj = dma_buf->priv;
124 struct drm_device *dev = obj->dev;
125
Joonyoung Shim538d6662013-06-19 15:03:05 +0900126 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
Maarten Lankhorstca793f72013-04-09 09:52:54 +0200133 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{
Joonyoung Shim538d6662013-06-19 15:03:05 +0900142 struct drm_prime_attachment *prime_attach = attach->priv;
Maarten Lankhorstca793f72013-04-09 09:52:54 +0200143 struct drm_gem_object *obj = dma_buf->priv;
144 struct drm_device *dev = obj->dev;
Joonyoung Shim538d6662013-06-19 15:03:05 +0900145 struct sg_table *sgt;
Maarten Lankhorstca793f72013-04-09 09:52:54 +0200146
147 if (dev->driver->gem_prime_unpin)
148 dev->driver->gem_prime_unpin(obj);
Joonyoung Shim538d6662013-06-19 15:03:05 +0900149
150 if (!prime_attach)
151 return;
152
153 sgt = prime_attach->sgt;
Joonyoung Shimf9d8a122013-07-04 16:19:12 +0900154 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 }
Joonyoung Shim538d6662013-06-19 15:03:05 +0900160
Joonyoung Shim538d6662013-06-19 15:03:05 +0900161 kfree(sgt);
162 kfree(prime_attach);
163 attach->priv = NULL;
Maarten Lankhorstca793f72013-04-09 09:52:54 +0200164}
165
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200166void drm_prime_remove_buf_handle_locked(struct drm_prime_file_private *prime_fpriv,
167 struct dma_buf *dma_buf)
YoungJun Choda342422013-06-26 10:21:42 +0900168{
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
Aaron Plattner89177642013-01-15 20:47:42 +0000180static struct sg_table *drm_gem_map_dma_buf(struct dma_buf_attachment *attach,
Daniel Vetter39cc3442014-01-22 19:16:30 +0100181 enum dma_data_direction dir)
Aaron Plattner89177642013-01-15 20:47:42 +0000182{
Joonyoung Shim538d6662013-06-19 15:03:05 +0900183 struct drm_prime_attachment *prime_attach = attach->priv;
Aaron Plattner89177642013-01-15 20:47:42 +0000184 struct drm_gem_object *obj = attach->dmabuf->priv;
185 struct sg_table *sgt;
186
Joonyoung Shim538d6662013-06-19 15:03:05 +0900187 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
Aaron Plattner89177642013-01-15 20:47:42 +0000201 sgt = obj->dev->driver->gem_prime_get_sg_table(obj);
202
YoungJun Cho7e3d88f2013-06-24 16:40:53 +0900203 if (!IS_ERR(sgt)) {
YoungJun Chob720d542013-06-24 15:34:21 +0900204 if (!dma_map_sg(attach->dev, sgt->sgl, sgt->nents, dir)) {
205 sg_free_table(sgt);
206 kfree(sgt);
207 sgt = ERR_PTR(-ENOMEM);
Joonyoung Shim538d6662013-06-19 15:03:05 +0900208 } else {
209 prime_attach->sgt = sgt;
210 prime_attach->dir = dir;
YoungJun Chob720d542013-06-24 15:34:21 +0900211 }
212 }
Aaron Plattner89177642013-01-15 20:47:42 +0000213
Aaron Plattner89177642013-01-15 20:47:42 +0000214 return sgt;
215}
216
217static void drm_gem_unmap_dma_buf(struct dma_buf_attachment *attach,
Daniel Vetter39cc3442014-01-22 19:16:30 +0100218 struct sg_table *sgt,
219 enum dma_data_direction dir)
Aaron Plattner89177642013-01-15 20:47:42 +0000220{
Joonyoung Shim538d6662013-06-19 15:03:05 +0900221 /* nothing to be done here */
Aaron Plattner89177642013-01-15 20:47:42 +0000222}
223
Daniel Vetter39cc3442014-01-22 19:16:30 +0100224/**
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 */
Daniel Vetterc1d67982013-08-15 00:02:30 +0200231void drm_gem_dmabuf_release(struct dma_buf *dma_buf)
Aaron Plattner89177642013-01-15 20:47:42 +0000232{
233 struct drm_gem_object *obj = dma_buf->priv;
234
Daniel Vetter319c9332013-08-15 00:02:46 +0200235 /* drop the reference on the export fd holds */
236 drm_gem_object_unreference_unlocked(obj);
Aaron Plattner89177642013-01-15 20:47:42 +0000237}
Daniel Vetterc1d67982013-08-15 00:02:30 +0200238EXPORT_SYMBOL(drm_gem_dmabuf_release);
Aaron Plattner89177642013-01-15 20:47:42 +0000239
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,
Daniel Vetter39cc3442014-01-22 19:16:30 +0100257 unsigned long page_num)
Aaron Plattner89177642013-01-15 20:47:42 +0000258{
259 return NULL;
260}
261
262static void drm_gem_dmabuf_kunmap_atomic(struct dma_buf *dma_buf,
Daniel Vetter39cc3442014-01-22 19:16:30 +0100263 unsigned long page_num, void *addr)
Aaron Plattner89177642013-01-15 20:47:42 +0000264{
265
266}
267static void *drm_gem_dmabuf_kmap(struct dma_buf *dma_buf,
Daniel Vetter39cc3442014-01-22 19:16:30 +0100268 unsigned long page_num)
Aaron Plattner89177642013-01-15 20:47:42 +0000269{
270 return NULL;
271}
272
273static void drm_gem_dmabuf_kunmap(struct dma_buf *dma_buf,
Daniel Vetter39cc3442014-01-22 19:16:30 +0100274 unsigned long page_num, void *addr)
Aaron Plattner89177642013-01-15 20:47:42 +0000275{
276
277}
278
279static int drm_gem_dmabuf_mmap(struct dma_buf *dma_buf,
Daniel Vetter39cc3442014-01-22 19:16:30 +0100280 struct vm_area_struct *vma)
Aaron Plattner89177642013-01-15 20:47:42 +0000281{
Joonyoung Shim7c397cd2013-06-28 14:24:53 +0900282 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);
Aaron Plattner89177642013-01-15 20:47:42 +0000289}
290
291static const struct dma_buf_ops drm_gem_prime_dmabuf_ops = {
Maarten Lankhorstca793f72013-04-09 09:52:54 +0200292 .attach = drm_gem_map_attach,
293 .detach = drm_gem_map_detach,
Aaron Plattner89177642013-01-15 20:47:42 +0000294 .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
Daniel Thompsonffc5fbd2015-06-19 14:52:29 +0100312 * six lower-level driver callbacks:
Aaron Plattner89177642013-01-15 20:47:42 +0000313 *
314 * Export callbacks:
315 *
Danilo Cesar Lemes de Paulaf03d8ed2015-11-25 18:07:55 +0100316 * * @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
Daniel Thompsonffc5fbd2015-06-19 14:52:29 +0100321 *
Aaron Plattner89177642013-01-15 20:47:42 +0000322 * Import callback:
323 *
Danilo Cesar Lemes de Paulaf03d8ed2015-11-25 18:07:55 +0100324 * * @gem_prime_import_sg_table (import): produce a GEM object from another
Aaron Plattner89177642013-01-15 20:47:42 +0000325 * driver's scatter/gather table
326 */
327
Daniel Vetter39cc3442014-01-22 19:16:30 +0100328/**
Masanari Iida32197aa2014-10-20 23:53:13 +0900329 * drm_gem_prime_export - helper library implementation of the export callback
Daniel Vetter39cc3442014-01-22 19:16:30 +0100330 * @dev: drm_device to export from
331 * @obj: GEM object to export
Daniel Thompsonbfe981a2015-12-22 19:36:44 -0200332 * @flags: flags like DRM_CLOEXEC and DRM_RDWR
Daniel Vetter39cc3442014-01-22 19:16:30 +0100333 *
334 * This is the implementation of the gem_prime_export functions for GEM drivers
335 * using the PRIME helpers.
336 */
Aaron Plattner89177642013-01-15 20:47:42 +0000337struct dma_buf *drm_gem_prime_export(struct drm_device *dev,
338 struct drm_gem_object *obj, int flags)
339{
Sumit Semwald8fbe342015-01-23 12:53:43 +0530340 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;
Maarten Lankhorst3aac4502014-07-01 12:57:26 +0200346
347 if (dev->driver->gem_prime_res_obj)
Sumit Semwald8fbe342015-01-23 12:53:43 +0530348 exp_info.resv = dev->driver->gem_prime_res_obj(obj);
Maarten Lankhorst3aac4502014-07-01 12:57:26 +0200349
Sumit Semwald8fbe342015-01-23 12:53:43 +0530350 return dma_buf_export(&exp_info);
Aaron Plattner89177642013-01-15 20:47:42 +0000351}
352EXPORT_SYMBOL(drm_gem_prime_export);
353
Daniel Vetter319c9332013-08-15 00:02:46 +0200354static 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);
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200381 /* Grab a new ref since the callers is now used by the dma-buf */
382 drm_gem_object_reference(obj);
Daniel Vetter319c9332013-08-15 00:02:46 +0200383
384 return dmabuf;
385}
386
Daniel Vetter39cc3442014-01-22 19:16:30 +0100387/**
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 */
Dave Airlie32488772011-11-25 15:21:02 +0000400int drm_gem_prime_handle_to_fd(struct drm_device *dev,
Daniel Vetter39cc3442014-01-22 19:16:30 +0100401 struct drm_file *file_priv, uint32_t handle,
402 uint32_t flags,
403 int *prime_fd)
Dave Airlie32488772011-11-25 15:21:02 +0000404{
405 struct drm_gem_object *obj;
Dave Airlie219b4732013-04-22 09:54:36 +1000406 int ret = 0;
407 struct dma_buf *dmabuf;
Dave Airlie32488772011-11-25 15:21:02 +0000408
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200409 mutex_lock(&file_priv->prime.lock);
Chris Wilsona8ad0bd2016-05-09 11:04:54 +0100410 obj = drm_gem_object_lookup(file_priv, handle);
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200411 if (!obj) {
412 ret = -ENOENT;
413 goto out_unlock;
414 }
Dave Airlie32488772011-11-25 15:21:02 +0000415
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200416 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);
Dave Airlie32488772011-11-25 15:21:02 +0000423 /* re-export the original imported object */
424 if (obj->import_attach) {
Dave Airlie219b4732013-04-22 09:54:36 +1000425 dmabuf = obj->import_attach->dmabuf;
Daniel Vetter319c9332013-08-15 00:02:46 +0200426 get_dma_buf(dmabuf);
Dave Airlie219b4732013-04-22 09:54:36 +1000427 goto out_have_obj;
Dave Airlie32488772011-11-25 15:21:02 +0000428 }
429
Daniel Vetter319c9332013-08-15 00:02:46 +0200430 if (obj->dma_buf) {
431 get_dma_buf(obj->dma_buf);
432 dmabuf = obj->dma_buf;
Dave Airlie219b4732013-04-22 09:54:36 +1000433 goto out_have_obj;
Dave Airlie32488772011-11-25 15:21:02 +0000434 }
Dave Airlie219b4732013-04-22 09:54:36 +1000435
Daniel Vetter319c9332013-08-15 00:02:46 +0200436 dmabuf = export_and_register_object(dev, obj, flags);
Daniel Vetter4332bf42013-08-15 00:02:41 +0200437 if (IS_ERR(dmabuf)) {
Dave Airlie219b4732013-04-22 09:54:36 +1000438 /* normally the created dma-buf takes ownership of the ref,
439 * but if that fails then drop the ref
440 */
Daniel Vetter4332bf42013-08-15 00:02:41 +0200441 ret = PTR_ERR(dmabuf);
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200442 mutex_unlock(&dev->object_name_lock);
Dave Airlie219b4732013-04-22 09:54:36 +1000443 goto out;
444 }
Dave Airlie219b4732013-04-22 09:54:36 +1000445
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200446out_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.
Dave Airlie0ff926c2012-05-20 17:31:16 +0100452 */
Dave Airlie219b4732013-04-22 09:54:36 +1000453 ret = drm_prime_add_buf_handle(&file_priv->prime,
Daniel Vetter319c9332013-08-15 00:02:46 +0200454 dmabuf, handle);
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200455 mutex_unlock(&dev->object_name_lock);
Dave Airlie219b4732013-04-22 09:54:36 +1000456 if (ret)
YoungJun Cho7d8f06a2013-06-26 10:21:40 +0900457 goto fail_put_dmabuf;
Dave Airlie0ff926c2012-05-20 17:31:16 +0100458
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200459out_have_handle:
Daniel Vetter4332bf42013-08-15 00:02:41 +0200460 ret = dma_buf_fd(dmabuf, flags);
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200461 /*
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 */
Daniel Vetter4a88f732013-07-02 09:18:39 +0200467 if (ret < 0) {
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200468 goto fail_put_dmabuf;
Daniel Vetter4a88f732013-07-02 09:18:39 +0200469 } else {
YoungJun Choda342422013-06-26 10:21:42 +0900470 *prime_fd = ret;
Daniel Vetter4a88f732013-07-02 09:18:39 +0200471 ret = 0;
472 }
473
YoungJun Cho7d8f06a2013-06-26 10:21:40 +0900474 goto out;
475
476fail_put_dmabuf:
Daniel Vetter4332bf42013-08-15 00:02:41 +0200477 dma_buf_put(dmabuf);
Dave Airlie219b4732013-04-22 09:54:36 +1000478out:
479 drm_gem_object_unreference_unlocked(obj);
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200480out_unlock:
481 mutex_unlock(&file_priv->prime.lock);
482
Dave Airlie219b4732013-04-22 09:54:36 +1000483 return ret;
Dave Airlie32488772011-11-25 15:21:02 +0000484}
485EXPORT_SYMBOL(drm_gem_prime_handle_to_fd);
486
Daniel Vetter39cc3442014-01-22 19:16:30 +0100487/**
Masanari Iida32197aa2014-10-20 23:53:13 +0900488 * drm_gem_prime_import - helper library implementation of the import callback
Daniel Vetter39cc3442014-01-22 19:16:30 +0100489 * @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 */
Aaron Plattner89177642013-01-15 20:47:42 +0000495struct 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
Aaron Plattner89177642013-01-15 20:47:42 +0000503 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);
Aaron Plattner89177642013-01-15 20:47:42 +0000511 return obj;
512 }
513 }
514
Tomasz Figa98515032015-05-08 17:13:45 +0900515 if (!dev->driver->gem_prime_import_sg_table)
516 return ERR_PTR(-EINVAL);
517
Aaron Plattner89177642013-01-15 20:47:42 +0000518 attach = dma_buf_attach(dma_buf, dev->dev);
519 if (IS_ERR(attach))
Thomas Meyerf2a5da42013-06-01 10:09:27 +0000520 return ERR_CAST(attach);
Aaron Plattner89177642013-01-15 20:47:42 +0000521
Imre Deak011c2282013-04-19 11:11:56 +1000522 get_dma_buf(dma_buf);
523
Aaron Plattner89177642013-01-15 20:47:42 +0000524 sgt = dma_buf_map_attachment(attach, DMA_BIDIRECTIONAL);
Colin Crossfee0c542013-12-20 16:43:50 -0800525 if (IS_ERR(sgt)) {
Aaron Plattner89177642013-01-15 20:47:42 +0000526 ret = PTR_ERR(sgt);
527 goto fail_detach;
528 }
529
Maarten Lankhorstb5e9c1a2014-01-09 11:03:14 +0100530 obj = dev->driver->gem_prime_import_sg_table(dev, attach, sgt);
Aaron Plattner89177642013-01-15 20:47:42 +0000531 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);
Imre Deak011c2282013-04-19 11:11:56 +1000544 dma_buf_put(dma_buf);
545
Aaron Plattner89177642013-01-15 20:47:42 +0000546 return ERR_PTR(ret);
547}
548EXPORT_SYMBOL(drm_gem_prime_import);
549
Daniel Vetter39cc3442014-01-22 19:16:30 +0100550/**
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 */
Dave Airlie32488772011-11-25 15:21:02 +0000562int drm_gem_prime_fd_to_handle(struct drm_device *dev,
Daniel Vetter39cc3442014-01-22 19:16:30 +0100563 struct drm_file *file_priv, int prime_fd,
564 uint32_t *handle)
Dave Airlie32488772011-11-25 15:21:02 +0000565{
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
Dave Airlie219b4732013-04-22 09:54:36 +1000576 ret = drm_prime_lookup_buf_handle(&file_priv->prime,
Dave Airlie32488772011-11-25 15:21:02 +0000577 dma_buf, handle);
Daniel Vetter84341c22013-08-15 00:02:43 +0200578 if (ret == 0)
Dave Airlie32488772011-11-25 15:21:02 +0000579 goto out_put;
Dave Airlie32488772011-11-25 15:21:02 +0000580
581 /* never seen this one, need to import */
Daniel Vetter319c9332013-08-15 00:02:46 +0200582 mutex_lock(&dev->object_name_lock);
Dave Airlie32488772011-11-25 15:21:02 +0000583 obj = dev->driver->gem_prime_import(dev, dma_buf);
584 if (IS_ERR(obj)) {
585 ret = PTR_ERR(obj);
Daniel Vetter319c9332013-08-15 00:02:46 +0200586 goto out_unlock;
Dave Airlie32488772011-11-25 15:21:02 +0000587 }
588
Daniel Vetter319c9332013-08-15 00:02:46 +0200589 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);
Dave Airlie32488772011-11-25 15:21:02 +0000598 drm_gem_object_unreference_unlocked(obj);
599 if (ret)
600 goto out_put;
601
Dave Airlie219b4732013-04-22 09:54:36 +1000602 ret = drm_prime_add_buf_handle(&file_priv->prime,
Dave Airlie32488772011-11-25 15:21:02 +0000603 dma_buf, *handle);
604 if (ret)
605 goto fail;
606
607 mutex_unlock(&file_priv->prime.lock);
Imre Deak011c2282013-04-19 11:11:56 +1000608
609 dma_buf_put(dma_buf);
610
Dave Airlie32488772011-11-25 15:21:02 +0000611 return 0;
612
613fail:
614 /* hmm, if driver attached, we are relying on the free-object path
615 * to detach.. which seems ok..
616 */
Daniel Vetter730c4ff2013-08-15 00:02:38 +0200617 drm_gem_handle_delete(file_priv, *handle);
Daniel Vetter319c9332013-08-15 00:02:46 +0200618out_unlock:
Dan Carpenter0adb2372013-08-23 23:46:02 +0300619 mutex_unlock(&dev->object_name_lock);
Dave Airlie32488772011-11-25 15:21:02 +0000620out_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;
Dave Airlie32488772011-11-25 15:21:02 +0000631
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 */
Daniel Thompsonbfe981a2015-12-22 19:36:44 -0200639 if (args->flags & ~(DRM_CLOEXEC | DRM_RDWR))
Dave Airlie32488772011-11-25 15:21:02 +0000640 return -EINVAL;
641
Dave Airlie32488772011-11-25 15:21:02 +0000642 return dev->driver->prime_handle_to_fd(dev, file_priv,
Daniel Thompsonbfe981a2015-12-22 19:36:44 -0200643 args->handle, args->flags, &args->fd);
Dave Airlie32488772011-11-25 15:21:02 +0000644}
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
Daniel Vetter39cc3442014-01-22 19:16:30 +0100661/**
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
Dave Airlie32488772011-11-25 15:21:02 +0000665 *
Daniel Vetter39cc3442014-01-22 19:16:30 +0100666 * This helper creates an sg table object from a set of pages
Dave Airlie32488772011-11-25 15:21:02 +0000667 * the driver is responsible for mapping the pages into the
Daniel Vetter39cc3442014-01-22 19:16:30 +0100668 * importers address space for use with dma_buf itself.
Dave Airlie32488772011-11-25 15:21:02 +0000669 */
Thierry Reding34eab432014-06-04 09:18:29 +0200670struct sg_table *drm_prime_pages_to_sg(struct page **pages, unsigned int nr_pages)
Dave Airlie32488772011-11-25 15:21:02 +0000671{
672 struct sg_table *sg = NULL;
Dave Airlie32488772011-11-25 15:21:02 +0000673 int ret;
674
675 sg = kmalloc(sizeof(struct sg_table), GFP_KERNEL);
YoungJun Cho7e3d88f2013-06-24 16:40:53 +0900676 if (!sg) {
677 ret = -ENOMEM;
Dave Airlie32488772011-11-25 15:21:02 +0000678 goto out;
YoungJun Cho7e3d88f2013-06-24 16:40:53 +0900679 }
Dave Airlie32488772011-11-25 15:21:02 +0000680
Rahul Sharmadca25cb2013-01-28 08:38:48 -0500681 ret = sg_alloc_table_from_pages(sg, pages, nr_pages, 0,
682 nr_pages << PAGE_SHIFT, GFP_KERNEL);
Dave Airlie32488772011-11-25 15:21:02 +0000683 if (ret)
684 goto out;
685
Dave Airlie32488772011-11-25 15:21:02 +0000686 return sg;
687out:
688 kfree(sg);
YoungJun Cho7e3d88f2013-06-24 16:40:53 +0900689 return ERR_PTR(ret);
Dave Airlie32488772011-11-25 15:21:02 +0000690}
691EXPORT_SYMBOL(drm_prime_pages_to_sg);
692
Daniel Vetter39cc3442014-01-22 19:16:30 +0100693/**
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 */
Dave Airlie51ab7ba2012-05-18 15:40:33 +0100703int 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;
Lespiau, Damien36dccc82013-09-28 16:24:02 +0100709 u32 len;
Dave Airlie51ab7ba2012-05-18 15:40:33 +0100710 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;
Dave Airlie51ab7ba2012-05-18 15:40:33 +0100716 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);
Daniel Vetter39cc3442014-01-22 19:16:30 +0100735
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 */
Dave Airlie32488772011-11-25 15:21:02 +0000744void 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}
Dave Airlie32488772011-11-25 15:21:02 +0000763
764void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv)
765{
Imre Deak98b76232013-04-24 19:04:57 +0300766 /* by now drm_gem_release should've made sure the list is empty */
767 WARN_ON(!list_empty(&prime_fpriv->head));
Dave Airlie32488772011-11-25 15:21:02 +0000768}