blob: 99d578bad17eabc26d972fab1c4e475f9ba46096 [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>
Dave Airlie32488772011-11-25 15:21:02 +000032
33/*
34 * DMA-BUF/GEM Object references and lifetime overview:
35 *
36 * On the export the dma_buf holds a reference to the exporting GEM
37 * object. It takes this reference in handle_to_fd_ioctl, when it
38 * first calls .prime_export and stores the exporting GEM object in
39 * the dma_buf priv. This reference is released when the dma_buf
40 * object goes away in the driver .release function.
41 *
42 * On the import the importing GEM object holds a reference to the
43 * dma_buf (which in turn holds a ref to the exporting GEM object).
44 * It takes that reference in the fd_to_handle ioctl.
45 * It calls dma_buf_get, creates an attachment to it and stores the
46 * attachment in the GEM object. When this attachment is destroyed
47 * when the imported object is destroyed, we remove the attachment
48 * and drop the reference to the dma_buf.
49 *
50 * Thus the chain of references always flows in one direction
51 * (avoiding loops): importing_gem -> dmabuf -> exporting_gem
52 *
53 * Self-importing: if userspace is using PRIME as a replacement for flink
54 * then it will get a fd->handle request for a GEM object that it created.
55 * Drivers should detect this situation and return back the gem object
Aaron Plattner89177642013-01-15 20:47:42 +000056 * from the dma-buf private. Prime will do this automatically for drivers that
57 * use the drm_gem_prime_{import,export} helpers.
Dave Airlie32488772011-11-25 15:21:02 +000058 */
59
60struct drm_prime_member {
61 struct list_head entry;
62 struct dma_buf *dma_buf;
63 uint32_t handle;
64};
Joonyoung Shim538d6662013-06-19 15:03:05 +090065
66struct drm_prime_attachment {
67 struct sg_table *sgt;
68 enum dma_data_direction dir;
69};
70
Daniel Vetter39cc3442014-01-22 19:16:30 +010071static int drm_prime_add_buf_handle(struct drm_prime_file_private *prime_fpriv,
72 struct dma_buf *dma_buf, uint32_t handle)
Seung-Woo Kimce92e3c2013-06-26 10:21:41 +090073{
74 struct drm_prime_member *member;
75
76 member = kmalloc(sizeof(*member), GFP_KERNEL);
77 if (!member)
78 return -ENOMEM;
79
80 get_dma_buf(dma_buf);
81 member->dma_buf = dma_buf;
82 member->handle = handle;
83 list_add(&member->entry, &prime_fpriv->head);
84 return 0;
85}
Dave Airlie32488772011-11-25 15:21:02 +000086
Daniel Vetterd0b2c532013-08-15 00:02:49 +020087static struct dma_buf *drm_prime_lookup_buf_by_handle(struct drm_prime_file_private *prime_fpriv,
88 uint32_t handle)
89{
90 struct drm_prime_member *member;
91
92 list_for_each_entry(member, &prime_fpriv->head, entry) {
93 if (member->handle == handle)
94 return member->dma_buf;
95 }
96
97 return NULL;
98}
99
Daniel Vetterde9564d2013-08-15 00:02:48 +0200100static int drm_prime_lookup_buf_handle(struct drm_prime_file_private *prime_fpriv,
101 struct dma_buf *dma_buf,
102 uint32_t *handle)
103{
104 struct drm_prime_member *member;
105
106 list_for_each_entry(member, &prime_fpriv->head, entry) {
107 if (member->dma_buf == dma_buf) {
108 *handle = member->handle;
109 return 0;
110 }
111 }
112 return -ENOENT;
113}
114
Maarten Lankhorstca793f72013-04-09 09:52:54 +0200115static int drm_gem_map_attach(struct dma_buf *dma_buf,
116 struct device *target_dev,
117 struct dma_buf_attachment *attach)
118{
Joonyoung Shim538d6662013-06-19 15:03:05 +0900119 struct drm_prime_attachment *prime_attach;
Maarten Lankhorstca793f72013-04-09 09:52:54 +0200120 struct drm_gem_object *obj = dma_buf->priv;
121 struct drm_device *dev = obj->dev;
122
Joonyoung Shim538d6662013-06-19 15:03:05 +0900123 prime_attach = kzalloc(sizeof(*prime_attach), GFP_KERNEL);
124 if (!prime_attach)
125 return -ENOMEM;
126
127 prime_attach->dir = DMA_NONE;
128 attach->priv = prime_attach;
129
Maarten Lankhorstca793f72013-04-09 09:52:54 +0200130 if (!dev->driver->gem_prime_pin)
131 return 0;
132
133 return dev->driver->gem_prime_pin(obj);
134}
135
136static void drm_gem_map_detach(struct dma_buf *dma_buf,
137 struct dma_buf_attachment *attach)
138{
Joonyoung Shim538d6662013-06-19 15:03:05 +0900139 struct drm_prime_attachment *prime_attach = attach->priv;
Maarten Lankhorstca793f72013-04-09 09:52:54 +0200140 struct drm_gem_object *obj = dma_buf->priv;
141 struct drm_device *dev = obj->dev;
Joonyoung Shim538d6662013-06-19 15:03:05 +0900142 struct sg_table *sgt;
Maarten Lankhorstca793f72013-04-09 09:52:54 +0200143
144 if (dev->driver->gem_prime_unpin)
145 dev->driver->gem_prime_unpin(obj);
Joonyoung Shim538d6662013-06-19 15:03:05 +0900146
147 if (!prime_attach)
148 return;
149
150 sgt = prime_attach->sgt;
Joonyoung Shimf9d8a122013-07-04 16:19:12 +0900151 if (sgt) {
152 if (prime_attach->dir != DMA_NONE)
153 dma_unmap_sg(attach->dev, sgt->sgl, sgt->nents,
154 prime_attach->dir);
155 sg_free_table(sgt);
156 }
Joonyoung Shim538d6662013-06-19 15:03:05 +0900157
Joonyoung Shim538d6662013-06-19 15:03:05 +0900158 kfree(sgt);
159 kfree(prime_attach);
160 attach->priv = NULL;
Maarten Lankhorstca793f72013-04-09 09:52:54 +0200161}
162
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200163void drm_prime_remove_buf_handle_locked(struct drm_prime_file_private *prime_fpriv,
164 struct dma_buf *dma_buf)
YoungJun Choda342422013-06-26 10:21:42 +0900165{
166 struct drm_prime_member *member, *safe;
167
168 list_for_each_entry_safe(member, safe, &prime_fpriv->head, entry) {
169 if (member->dma_buf == dma_buf) {
170 dma_buf_put(dma_buf);
171 list_del(&member->entry);
172 kfree(member);
173 }
174 }
175}
176
Aaron Plattner89177642013-01-15 20:47:42 +0000177static struct sg_table *drm_gem_map_dma_buf(struct dma_buf_attachment *attach,
Daniel Vetter39cc3442014-01-22 19:16:30 +0100178 enum dma_data_direction dir)
Aaron Plattner89177642013-01-15 20:47:42 +0000179{
Joonyoung Shim538d6662013-06-19 15:03:05 +0900180 struct drm_prime_attachment *prime_attach = attach->priv;
Aaron Plattner89177642013-01-15 20:47:42 +0000181 struct drm_gem_object *obj = attach->dmabuf->priv;
182 struct sg_table *sgt;
183
Joonyoung Shim538d6662013-06-19 15:03:05 +0900184 if (WARN_ON(dir == DMA_NONE || !prime_attach))
185 return ERR_PTR(-EINVAL);
186
187 /* return the cached mapping when possible */
188 if (prime_attach->dir == dir)
189 return prime_attach->sgt;
190
191 /*
192 * two mappings with different directions for the same attachment are
193 * not allowed
194 */
195 if (WARN_ON(prime_attach->dir != DMA_NONE))
196 return ERR_PTR(-EBUSY);
197
Aaron Plattner89177642013-01-15 20:47:42 +0000198 sgt = obj->dev->driver->gem_prime_get_sg_table(obj);
199
YoungJun Cho7e3d88f2013-06-24 16:40:53 +0900200 if (!IS_ERR(sgt)) {
YoungJun Chob720d542013-06-24 15:34:21 +0900201 if (!dma_map_sg(attach->dev, sgt->sgl, sgt->nents, dir)) {
202 sg_free_table(sgt);
203 kfree(sgt);
204 sgt = ERR_PTR(-ENOMEM);
Joonyoung Shim538d6662013-06-19 15:03:05 +0900205 } else {
206 prime_attach->sgt = sgt;
207 prime_attach->dir = dir;
YoungJun Chob720d542013-06-24 15:34:21 +0900208 }
209 }
Aaron Plattner89177642013-01-15 20:47:42 +0000210
Aaron Plattner89177642013-01-15 20:47:42 +0000211 return sgt;
212}
213
214static void drm_gem_unmap_dma_buf(struct dma_buf_attachment *attach,
Daniel Vetter39cc3442014-01-22 19:16:30 +0100215 struct sg_table *sgt,
216 enum dma_data_direction dir)
Aaron Plattner89177642013-01-15 20:47:42 +0000217{
Joonyoung Shim538d6662013-06-19 15:03:05 +0900218 /* nothing to be done here */
Aaron Plattner89177642013-01-15 20:47:42 +0000219}
220
Daniel Vetter39cc3442014-01-22 19:16:30 +0100221/**
222 * drm_gem_dmabuf_release - dma_buf release implementation for GEM
223 * @dma_buf: buffer to be released
224 *
225 * Generic release function for dma_bufs exported as PRIME buffers. GEM drivers
226 * must use this in their dma_buf ops structure as the release callback.
227 */
Daniel Vetterc1d67982013-08-15 00:02:30 +0200228void drm_gem_dmabuf_release(struct dma_buf *dma_buf)
Aaron Plattner89177642013-01-15 20:47:42 +0000229{
230 struct drm_gem_object *obj = dma_buf->priv;
231
Daniel Vetter319c9332013-08-15 00:02:46 +0200232 /* drop the reference on the export fd holds */
233 drm_gem_object_unreference_unlocked(obj);
Aaron Plattner89177642013-01-15 20:47:42 +0000234}
Daniel Vetterc1d67982013-08-15 00:02:30 +0200235EXPORT_SYMBOL(drm_gem_dmabuf_release);
Aaron Plattner89177642013-01-15 20:47:42 +0000236
237static void *drm_gem_dmabuf_vmap(struct dma_buf *dma_buf)
238{
239 struct drm_gem_object *obj = dma_buf->priv;
240 struct drm_device *dev = obj->dev;
241
242 return dev->driver->gem_prime_vmap(obj);
243}
244
245static void drm_gem_dmabuf_vunmap(struct dma_buf *dma_buf, void *vaddr)
246{
247 struct drm_gem_object *obj = dma_buf->priv;
248 struct drm_device *dev = obj->dev;
249
250 dev->driver->gem_prime_vunmap(obj, vaddr);
251}
252
253static void *drm_gem_dmabuf_kmap_atomic(struct dma_buf *dma_buf,
Daniel Vetter39cc3442014-01-22 19:16:30 +0100254 unsigned long page_num)
Aaron Plattner89177642013-01-15 20:47:42 +0000255{
256 return NULL;
257}
258
259static void drm_gem_dmabuf_kunmap_atomic(struct dma_buf *dma_buf,
Daniel Vetter39cc3442014-01-22 19:16:30 +0100260 unsigned long page_num, void *addr)
Aaron Plattner89177642013-01-15 20:47:42 +0000261{
262
263}
264static void *drm_gem_dmabuf_kmap(struct dma_buf *dma_buf,
Daniel Vetter39cc3442014-01-22 19:16:30 +0100265 unsigned long page_num)
Aaron Plattner89177642013-01-15 20:47:42 +0000266{
267 return NULL;
268}
269
270static void drm_gem_dmabuf_kunmap(struct dma_buf *dma_buf,
Daniel Vetter39cc3442014-01-22 19:16:30 +0100271 unsigned long page_num, void *addr)
Aaron Plattner89177642013-01-15 20:47:42 +0000272{
273
274}
275
276static int drm_gem_dmabuf_mmap(struct dma_buf *dma_buf,
Daniel Vetter39cc3442014-01-22 19:16:30 +0100277 struct vm_area_struct *vma)
Aaron Plattner89177642013-01-15 20:47:42 +0000278{
Joonyoung Shim7c397cd2013-06-28 14:24:53 +0900279 struct drm_gem_object *obj = dma_buf->priv;
280 struct drm_device *dev = obj->dev;
281
282 if (!dev->driver->gem_prime_mmap)
283 return -ENOSYS;
284
285 return dev->driver->gem_prime_mmap(obj, vma);
Aaron Plattner89177642013-01-15 20:47:42 +0000286}
287
288static const struct dma_buf_ops drm_gem_prime_dmabuf_ops = {
Maarten Lankhorstca793f72013-04-09 09:52:54 +0200289 .attach = drm_gem_map_attach,
290 .detach = drm_gem_map_detach,
Aaron Plattner89177642013-01-15 20:47:42 +0000291 .map_dma_buf = drm_gem_map_dma_buf,
292 .unmap_dma_buf = drm_gem_unmap_dma_buf,
293 .release = drm_gem_dmabuf_release,
294 .kmap = drm_gem_dmabuf_kmap,
295 .kmap_atomic = drm_gem_dmabuf_kmap_atomic,
296 .kunmap = drm_gem_dmabuf_kunmap,
297 .kunmap_atomic = drm_gem_dmabuf_kunmap_atomic,
298 .mmap = drm_gem_dmabuf_mmap,
299 .vmap = drm_gem_dmabuf_vmap,
300 .vunmap = drm_gem_dmabuf_vunmap,
301};
302
303/**
304 * DOC: PRIME Helpers
305 *
306 * Drivers can implement @gem_prime_export and @gem_prime_import in terms of
307 * simpler APIs by using the helper functions @drm_gem_prime_export and
308 * @drm_gem_prime_import. These functions implement dma-buf support in terms of
309 * five lower-level driver callbacks:
310 *
311 * Export callbacks:
312 *
313 * - @gem_prime_pin (optional): prepare a GEM object for exporting
314 *
315 * - @gem_prime_get_sg_table: provide a scatter/gather table of pinned pages
316 *
317 * - @gem_prime_vmap: vmap a buffer exported by your driver
318 *
319 * - @gem_prime_vunmap: vunmap a buffer exported by your driver
320 *
321 * Import callback:
322 *
323 * - @gem_prime_import_sg_table (import): produce a GEM object from another
324 * driver's scatter/gather table
325 */
326
Daniel Vetter39cc3442014-01-22 19:16:30 +0100327/**
328 * drm_gem_prime_export - helper library implemention of the export callback
329 * @dev: drm_device to export from
330 * @obj: GEM object to export
331 * @flags: flags like DRM_CLOEXEC
332 *
333 * This is the implementation of the gem_prime_export functions for GEM drivers
334 * using the PRIME helpers.
335 */
Aaron Plattner89177642013-01-15 20:47:42 +0000336struct dma_buf *drm_gem_prime_export(struct drm_device *dev,
337 struct drm_gem_object *obj, int flags)
338{
Maarten Lankhorst3aac4502014-07-01 12:57:26 +0200339 struct reservation_object *robj = NULL;
340
341 if (dev->driver->gem_prime_res_obj)
342 robj = dev->driver->gem_prime_res_obj(obj);
343
344 return dma_buf_export(obj, &drm_gem_prime_dmabuf_ops, obj->size,
345 flags, robj);
Aaron Plattner89177642013-01-15 20:47:42 +0000346}
347EXPORT_SYMBOL(drm_gem_prime_export);
348
Daniel Vetter319c9332013-08-15 00:02:46 +0200349static struct dma_buf *export_and_register_object(struct drm_device *dev,
350 struct drm_gem_object *obj,
351 uint32_t flags)
352{
353 struct dma_buf *dmabuf;
354
355 /* prevent races with concurrent gem_close. */
356 if (obj->handle_count == 0) {
357 dmabuf = ERR_PTR(-ENOENT);
358 return dmabuf;
359 }
360
361 dmabuf = dev->driver->gem_prime_export(dev, obj, flags);
362 if (IS_ERR(dmabuf)) {
363 /* normally the created dma-buf takes ownership of the ref,
364 * but if that fails then drop the ref
365 */
366 return dmabuf;
367 }
368
369 /*
370 * Note that callers do not need to clean up the export cache
371 * since the check for obj->handle_count guarantees that someone
372 * will clean it up.
373 */
374 obj->dma_buf = dmabuf;
375 get_dma_buf(obj->dma_buf);
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200376 /* Grab a new ref since the callers is now used by the dma-buf */
377 drm_gem_object_reference(obj);
Daniel Vetter319c9332013-08-15 00:02:46 +0200378
379 return dmabuf;
380}
381
Daniel Vetter39cc3442014-01-22 19:16:30 +0100382/**
383 * drm_gem_prime_handle_to_fd - PRIME export function for GEM drivers
384 * @dev: dev to export the buffer from
385 * @file_priv: drm file-private structure
386 * @handle: buffer handle to export
387 * @flags: flags like DRM_CLOEXEC
388 * @prime_fd: pointer to storage for the fd id of the create dma-buf
389 *
390 * This is the PRIME export function which must be used mandatorily by GEM
391 * drivers to ensure correct lifetime management of the underlying GEM object.
392 * The actual exporting from GEM object to a dma-buf is done through the
393 * gem_prime_export driver callback.
394 */
Dave Airlie32488772011-11-25 15:21:02 +0000395int drm_gem_prime_handle_to_fd(struct drm_device *dev,
Daniel Vetter39cc3442014-01-22 19:16:30 +0100396 struct drm_file *file_priv, uint32_t handle,
397 uint32_t flags,
398 int *prime_fd)
Dave Airlie32488772011-11-25 15:21:02 +0000399{
400 struct drm_gem_object *obj;
Dave Airlie219b4732013-04-22 09:54:36 +1000401 int ret = 0;
402 struct dma_buf *dmabuf;
Dave Airlie32488772011-11-25 15:21:02 +0000403
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200404 mutex_lock(&file_priv->prime.lock);
Dave Airlie32488772011-11-25 15:21:02 +0000405 obj = drm_gem_object_lookup(dev, file_priv, handle);
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200406 if (!obj) {
407 ret = -ENOENT;
408 goto out_unlock;
409 }
Dave Airlie32488772011-11-25 15:21:02 +0000410
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200411 dmabuf = drm_prime_lookup_buf_by_handle(&file_priv->prime, handle);
412 if (dmabuf) {
413 get_dma_buf(dmabuf);
414 goto out_have_handle;
415 }
416
417 mutex_lock(&dev->object_name_lock);
Dave Airlie32488772011-11-25 15:21:02 +0000418 /* re-export the original imported object */
419 if (obj->import_attach) {
Dave Airlie219b4732013-04-22 09:54:36 +1000420 dmabuf = obj->import_attach->dmabuf;
Daniel Vetter319c9332013-08-15 00:02:46 +0200421 get_dma_buf(dmabuf);
Dave Airlie219b4732013-04-22 09:54:36 +1000422 goto out_have_obj;
Dave Airlie32488772011-11-25 15:21:02 +0000423 }
424
Daniel Vetter319c9332013-08-15 00:02:46 +0200425 if (obj->dma_buf) {
426 get_dma_buf(obj->dma_buf);
427 dmabuf = obj->dma_buf;
Dave Airlie219b4732013-04-22 09:54:36 +1000428 goto out_have_obj;
Dave Airlie32488772011-11-25 15:21:02 +0000429 }
Dave Airlie219b4732013-04-22 09:54:36 +1000430
Daniel Vetter319c9332013-08-15 00:02:46 +0200431 dmabuf = export_and_register_object(dev, obj, flags);
Daniel Vetter4332bf42013-08-15 00:02:41 +0200432 if (IS_ERR(dmabuf)) {
Dave Airlie219b4732013-04-22 09:54:36 +1000433 /* normally the created dma-buf takes ownership of the ref,
434 * but if that fails then drop the ref
435 */
Daniel Vetter4332bf42013-08-15 00:02:41 +0200436 ret = PTR_ERR(dmabuf);
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200437 mutex_unlock(&dev->object_name_lock);
Dave Airlie219b4732013-04-22 09:54:36 +1000438 goto out;
439 }
Dave Airlie219b4732013-04-22 09:54:36 +1000440
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200441out_have_obj:
442 /*
443 * If we've exported this buffer then cheat and add it to the import list
444 * so we get the correct handle back. We must do this under the
445 * protection of dev->object_name_lock to ensure that a racing gem close
446 * ioctl doesn't miss to remove this buffer handle from the cache.
Dave Airlie0ff926c2012-05-20 17:31:16 +0100447 */
Dave Airlie219b4732013-04-22 09:54:36 +1000448 ret = drm_prime_add_buf_handle(&file_priv->prime,
Daniel Vetter319c9332013-08-15 00:02:46 +0200449 dmabuf, handle);
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200450 mutex_unlock(&dev->object_name_lock);
Dave Airlie219b4732013-04-22 09:54:36 +1000451 if (ret)
YoungJun Cho7d8f06a2013-06-26 10:21:40 +0900452 goto fail_put_dmabuf;
Dave Airlie0ff926c2012-05-20 17:31:16 +0100453
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200454out_have_handle:
Daniel Vetter4332bf42013-08-15 00:02:41 +0200455 ret = dma_buf_fd(dmabuf, flags);
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200456 /*
457 * We must _not_ remove the buffer from the handle cache since the newly
458 * created dma buf is already linked in the global obj->dma_buf pointer,
459 * and that is invariant as long as a userspace gem handle exists.
460 * Closing the handle will clean out the cache anyway, so we don't leak.
461 */
Daniel Vetter4a88f732013-07-02 09:18:39 +0200462 if (ret < 0) {
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200463 goto fail_put_dmabuf;
Daniel Vetter4a88f732013-07-02 09:18:39 +0200464 } else {
YoungJun Choda342422013-06-26 10:21:42 +0900465 *prime_fd = ret;
Daniel Vetter4a88f732013-07-02 09:18:39 +0200466 ret = 0;
467 }
468
YoungJun Cho7d8f06a2013-06-26 10:21:40 +0900469 goto out;
470
471fail_put_dmabuf:
Daniel Vetter4332bf42013-08-15 00:02:41 +0200472 dma_buf_put(dmabuf);
Dave Airlie219b4732013-04-22 09:54:36 +1000473out:
474 drm_gem_object_unreference_unlocked(obj);
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200475out_unlock:
476 mutex_unlock(&file_priv->prime.lock);
477
Dave Airlie219b4732013-04-22 09:54:36 +1000478 return ret;
Dave Airlie32488772011-11-25 15:21:02 +0000479}
480EXPORT_SYMBOL(drm_gem_prime_handle_to_fd);
481
Daniel Vetter39cc3442014-01-22 19:16:30 +0100482/**
483 * drm_gem_prime_import - helper library implemention of the import callback
484 * @dev: drm_device to import into
485 * @dma_buf: dma-buf object to import
486 *
487 * This is the implementation of the gem_prime_import functions for GEM drivers
488 * using the PRIME helpers.
489 */
Aaron Plattner89177642013-01-15 20:47:42 +0000490struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev,
491 struct dma_buf *dma_buf)
492{
493 struct dma_buf_attachment *attach;
494 struct sg_table *sgt;
495 struct drm_gem_object *obj;
496 int ret;
497
498 if (!dev->driver->gem_prime_import_sg_table)
499 return ERR_PTR(-EINVAL);
500
501 if (dma_buf->ops == &drm_gem_prime_dmabuf_ops) {
502 obj = dma_buf->priv;
503 if (obj->dev == dev) {
504 /*
505 * Importing dmabuf exported from out own gem increases
506 * refcount on gem itself instead of f_count of dmabuf.
507 */
508 drm_gem_object_reference(obj);
Aaron Plattner89177642013-01-15 20:47:42 +0000509 return obj;
510 }
511 }
512
513 attach = dma_buf_attach(dma_buf, dev->dev);
514 if (IS_ERR(attach))
Thomas Meyerf2a5da42013-06-01 10:09:27 +0000515 return ERR_CAST(attach);
Aaron Plattner89177642013-01-15 20:47:42 +0000516
Imre Deak011c2282013-04-19 11:11:56 +1000517 get_dma_buf(dma_buf);
518
Aaron Plattner89177642013-01-15 20:47:42 +0000519 sgt = dma_buf_map_attachment(attach, DMA_BIDIRECTIONAL);
Colin Crossfee0c542013-12-20 16:43:50 -0800520 if (IS_ERR(sgt)) {
Aaron Plattner89177642013-01-15 20:47:42 +0000521 ret = PTR_ERR(sgt);
522 goto fail_detach;
523 }
524
525 obj = dev->driver->gem_prime_import_sg_table(dev, dma_buf->size, sgt);
526 if (IS_ERR(obj)) {
527 ret = PTR_ERR(obj);
528 goto fail_unmap;
529 }
530
531 obj->import_attach = attach;
532
533 return obj;
534
535fail_unmap:
536 dma_buf_unmap_attachment(attach, sgt, DMA_BIDIRECTIONAL);
537fail_detach:
538 dma_buf_detach(dma_buf, attach);
Imre Deak011c2282013-04-19 11:11:56 +1000539 dma_buf_put(dma_buf);
540
Aaron Plattner89177642013-01-15 20:47:42 +0000541 return ERR_PTR(ret);
542}
543EXPORT_SYMBOL(drm_gem_prime_import);
544
Daniel Vetter39cc3442014-01-22 19:16:30 +0100545/**
546 * drm_gem_prime_fd_to_handle - PRIME import function for GEM drivers
547 * @dev: dev to export the buffer from
548 * @file_priv: drm file-private structure
549 * @prime_fd: fd id of the dma-buf which should be imported
550 * @handle: pointer to storage for the handle of the imported buffer object
551 *
552 * This is the PRIME import function which must be used mandatorily by GEM
553 * drivers to ensure correct lifetime management of the underlying GEM object.
554 * The actual importing of GEM object from the dma-buf is done through the
555 * gem_import_export driver callback.
556 */
Dave Airlie32488772011-11-25 15:21:02 +0000557int drm_gem_prime_fd_to_handle(struct drm_device *dev,
Daniel Vetter39cc3442014-01-22 19:16:30 +0100558 struct drm_file *file_priv, int prime_fd,
559 uint32_t *handle)
Dave Airlie32488772011-11-25 15:21:02 +0000560{
561 struct dma_buf *dma_buf;
562 struct drm_gem_object *obj;
563 int ret;
564
565 dma_buf = dma_buf_get(prime_fd);
566 if (IS_ERR(dma_buf))
567 return PTR_ERR(dma_buf);
568
569 mutex_lock(&file_priv->prime.lock);
570
Dave Airlie219b4732013-04-22 09:54:36 +1000571 ret = drm_prime_lookup_buf_handle(&file_priv->prime,
Dave Airlie32488772011-11-25 15:21:02 +0000572 dma_buf, handle);
Daniel Vetter84341c22013-08-15 00:02:43 +0200573 if (ret == 0)
Dave Airlie32488772011-11-25 15:21:02 +0000574 goto out_put;
Dave Airlie32488772011-11-25 15:21:02 +0000575
576 /* never seen this one, need to import */
Daniel Vetter319c9332013-08-15 00:02:46 +0200577 mutex_lock(&dev->object_name_lock);
Dave Airlie32488772011-11-25 15:21:02 +0000578 obj = dev->driver->gem_prime_import(dev, dma_buf);
579 if (IS_ERR(obj)) {
580 ret = PTR_ERR(obj);
Daniel Vetter319c9332013-08-15 00:02:46 +0200581 goto out_unlock;
Dave Airlie32488772011-11-25 15:21:02 +0000582 }
583
Daniel Vetter319c9332013-08-15 00:02:46 +0200584 if (obj->dma_buf) {
585 WARN_ON(obj->dma_buf != dma_buf);
586 } else {
587 obj->dma_buf = dma_buf;
588 get_dma_buf(dma_buf);
589 }
590
591 /* drm_gem_handle_create_tail unlocks dev->object_name_lock. */
592 ret = drm_gem_handle_create_tail(file_priv, obj, handle);
Dave Airlie32488772011-11-25 15:21:02 +0000593 drm_gem_object_unreference_unlocked(obj);
594 if (ret)
595 goto out_put;
596
Dave Airlie219b4732013-04-22 09:54:36 +1000597 ret = drm_prime_add_buf_handle(&file_priv->prime,
Dave Airlie32488772011-11-25 15:21:02 +0000598 dma_buf, *handle);
599 if (ret)
600 goto fail;
601
602 mutex_unlock(&file_priv->prime.lock);
Imre Deak011c2282013-04-19 11:11:56 +1000603
604 dma_buf_put(dma_buf);
605
Dave Airlie32488772011-11-25 15:21:02 +0000606 return 0;
607
608fail:
609 /* hmm, if driver attached, we are relying on the free-object path
610 * to detach.. which seems ok..
611 */
Daniel Vetter730c4ff2013-08-15 00:02:38 +0200612 drm_gem_handle_delete(file_priv, *handle);
Daniel Vetter319c9332013-08-15 00:02:46 +0200613out_unlock:
Dan Carpenter0adb2372013-08-23 23:46:02 +0300614 mutex_unlock(&dev->object_name_lock);
Dave Airlie32488772011-11-25 15:21:02 +0000615out_put:
616 dma_buf_put(dma_buf);
617 mutex_unlock(&file_priv->prime.lock);
618 return ret;
619}
620EXPORT_SYMBOL(drm_gem_prime_fd_to_handle);
621
622int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data,
623 struct drm_file *file_priv)
624{
625 struct drm_prime_handle *args = data;
626 uint32_t flags;
627
628 if (!drm_core_check_feature(dev, DRIVER_PRIME))
629 return -EINVAL;
630
631 if (!dev->driver->prime_handle_to_fd)
632 return -ENOSYS;
633
634 /* check flags are valid */
635 if (args->flags & ~DRM_CLOEXEC)
636 return -EINVAL;
637
638 /* we only want to pass DRM_CLOEXEC which is == O_CLOEXEC */
639 flags = args->flags & DRM_CLOEXEC;
640
641 return dev->driver->prime_handle_to_fd(dev, file_priv,
642 args->handle, flags, &args->fd);
643}
644
645int drm_prime_fd_to_handle_ioctl(struct drm_device *dev, void *data,
646 struct drm_file *file_priv)
647{
648 struct drm_prime_handle *args = data;
649
650 if (!drm_core_check_feature(dev, DRIVER_PRIME))
651 return -EINVAL;
652
653 if (!dev->driver->prime_fd_to_handle)
654 return -ENOSYS;
655
656 return dev->driver->prime_fd_to_handle(dev, file_priv,
657 args->fd, &args->handle);
658}
659
Daniel Vetter39cc3442014-01-22 19:16:30 +0100660/**
661 * drm_prime_pages_to_sg - converts a page array into an sg list
662 * @pages: pointer to the array of page pointers to convert
663 * @nr_pages: length of the page vector
Dave Airlie32488772011-11-25 15:21:02 +0000664 *
Daniel Vetter39cc3442014-01-22 19:16:30 +0100665 * This helper creates an sg table object from a set of pages
Dave Airlie32488772011-11-25 15:21:02 +0000666 * the driver is responsible for mapping the pages into the
Daniel Vetter39cc3442014-01-22 19:16:30 +0100667 * importers address space for use with dma_buf itself.
Dave Airlie32488772011-11-25 15:21:02 +0000668 */
669struct sg_table *drm_prime_pages_to_sg(struct page **pages, int nr_pages)
670{
671 struct sg_table *sg = NULL;
Dave Airlie32488772011-11-25 15:21:02 +0000672 int ret;
673
674 sg = kmalloc(sizeof(struct sg_table), GFP_KERNEL);
YoungJun Cho7e3d88f2013-06-24 16:40:53 +0900675 if (!sg) {
676 ret = -ENOMEM;
Dave Airlie32488772011-11-25 15:21:02 +0000677 goto out;
YoungJun Cho7e3d88f2013-06-24 16:40:53 +0900678 }
Dave Airlie32488772011-11-25 15:21:02 +0000679
Rahul Sharmadca25cb2013-01-28 08:38:48 -0500680 ret = sg_alloc_table_from_pages(sg, pages, nr_pages, 0,
681 nr_pages << PAGE_SHIFT, GFP_KERNEL);
Dave Airlie32488772011-11-25 15:21:02 +0000682 if (ret)
683 goto out;
684
Dave Airlie32488772011-11-25 15:21:02 +0000685 return sg;
686out:
687 kfree(sg);
YoungJun Cho7e3d88f2013-06-24 16:40:53 +0900688 return ERR_PTR(ret);
Dave Airlie32488772011-11-25 15:21:02 +0000689}
690EXPORT_SYMBOL(drm_prime_pages_to_sg);
691
Daniel Vetter39cc3442014-01-22 19:16:30 +0100692/**
693 * drm_prime_sg_to_page_addr_arrays - convert an sg table into a page array
694 * @sgt: scatter-gather table to convert
695 * @pages: array of page pointers to store the page array in
696 * @addrs: optional array to store the dma bus address of each page
697 * @max_pages: size of both the passed-in arrays
698 *
699 * Exports an sg table into an array of pages and addresses. This is currently
700 * required by the TTM driver in order to do correct fault handling.
701 */
Dave Airlie51ab7ba2012-05-18 15:40:33 +0100702int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages,
703 dma_addr_t *addrs, int max_pages)
704{
705 unsigned count;
706 struct scatterlist *sg;
707 struct page *page;
Lespiau, Damien36dccc82013-09-28 16:24:02 +0100708 u32 len;
Dave Airlie51ab7ba2012-05-18 15:40:33 +0100709 int pg_index;
710 dma_addr_t addr;
711
712 pg_index = 0;
713 for_each_sg(sgt->sgl, sg, sgt->nents, count) {
714 len = sg->length;
Dave Airlie51ab7ba2012-05-18 15:40:33 +0100715 page = sg_page(sg);
716 addr = sg_dma_address(sg);
717
718 while (len > 0) {
719 if (WARN_ON(pg_index >= max_pages))
720 return -1;
721 pages[pg_index] = page;
722 if (addrs)
723 addrs[pg_index] = addr;
724
725 page++;
726 addr += PAGE_SIZE;
727 len -= PAGE_SIZE;
728 pg_index++;
729 }
730 }
731 return 0;
732}
733EXPORT_SYMBOL(drm_prime_sg_to_page_addr_arrays);
Daniel Vetter39cc3442014-01-22 19:16:30 +0100734
735/**
736 * drm_prime_gem_destroy - helper to clean up a PRIME-imported GEM object
737 * @obj: GEM object which was created from a dma-buf
738 * @sg: the sg-table which was pinned at import time
739 *
740 * This is the cleanup functions which GEM drivers need to call when they use
741 * @drm_gem_prime_import to import dma-bufs.
742 */
Dave Airlie32488772011-11-25 15:21:02 +0000743void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg)
744{
745 struct dma_buf_attachment *attach;
746 struct dma_buf *dma_buf;
747 attach = obj->import_attach;
748 if (sg)
749 dma_buf_unmap_attachment(attach, sg, DMA_BIDIRECTIONAL);
750 dma_buf = attach->dmabuf;
751 dma_buf_detach(attach->dmabuf, attach);
752 /* remove the reference */
753 dma_buf_put(dma_buf);
754}
755EXPORT_SYMBOL(drm_prime_gem_destroy);
756
757void drm_prime_init_file_private(struct drm_prime_file_private *prime_fpriv)
758{
759 INIT_LIST_HEAD(&prime_fpriv->head);
760 mutex_init(&prime_fpriv->lock);
761}
Dave Airlie32488772011-11-25 15:21:02 +0000762
763void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv)
764{
Imre Deak98b76232013-04-24 19:04:57 +0300765 /* by now drm_gem_release should've made sure the list is empty */
766 WARN_ON(!list_empty(&prime_fpriv->head));
Dave Airlie32488772011-11-25 15:21:02 +0000767}