blob: 304ca8cacbc44f3cb27829551a4ead61472c5171 [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{
Laurent Pinchartebc0bad2013-06-19 03:14:20 +0200339 return dma_buf_export(obj, &drm_gem_prime_dmabuf_ops, obj->size, flags);
Aaron Plattner89177642013-01-15 20:47:42 +0000340}
341EXPORT_SYMBOL(drm_gem_prime_export);
342
Daniel Vetter319c9332013-08-15 00:02:46 +0200343static struct dma_buf *export_and_register_object(struct drm_device *dev,
344 struct drm_gem_object *obj,
345 uint32_t flags)
346{
347 struct dma_buf *dmabuf;
348
349 /* prevent races with concurrent gem_close. */
350 if (obj->handle_count == 0) {
351 dmabuf = ERR_PTR(-ENOENT);
352 return dmabuf;
353 }
354
355 dmabuf = dev->driver->gem_prime_export(dev, obj, flags);
356 if (IS_ERR(dmabuf)) {
357 /* normally the created dma-buf takes ownership of the ref,
358 * but if that fails then drop the ref
359 */
360 return dmabuf;
361 }
362
363 /*
364 * Note that callers do not need to clean up the export cache
365 * since the check for obj->handle_count guarantees that someone
366 * will clean it up.
367 */
368 obj->dma_buf = dmabuf;
369 get_dma_buf(obj->dma_buf);
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200370 /* Grab a new ref since the callers is now used by the dma-buf */
371 drm_gem_object_reference(obj);
Daniel Vetter319c9332013-08-15 00:02:46 +0200372
373 return dmabuf;
374}
375
Daniel Vetter39cc3442014-01-22 19:16:30 +0100376/**
377 * drm_gem_prime_handle_to_fd - PRIME export function for GEM drivers
378 * @dev: dev to export the buffer from
379 * @file_priv: drm file-private structure
380 * @handle: buffer handle to export
381 * @flags: flags like DRM_CLOEXEC
382 * @prime_fd: pointer to storage for the fd id of the create dma-buf
383 *
384 * This is the PRIME export function which must be used mandatorily by GEM
385 * drivers to ensure correct lifetime management of the underlying GEM object.
386 * The actual exporting from GEM object to a dma-buf is done through the
387 * gem_prime_export driver callback.
388 */
Dave Airlie32488772011-11-25 15:21:02 +0000389int drm_gem_prime_handle_to_fd(struct drm_device *dev,
Daniel Vetter39cc3442014-01-22 19:16:30 +0100390 struct drm_file *file_priv, uint32_t handle,
391 uint32_t flags,
392 int *prime_fd)
Dave Airlie32488772011-11-25 15:21:02 +0000393{
394 struct drm_gem_object *obj;
Dave Airlie219b4732013-04-22 09:54:36 +1000395 int ret = 0;
396 struct dma_buf *dmabuf;
Dave Airlie32488772011-11-25 15:21:02 +0000397
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200398 mutex_lock(&file_priv->prime.lock);
Dave Airlie32488772011-11-25 15:21:02 +0000399 obj = drm_gem_object_lookup(dev, file_priv, handle);
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200400 if (!obj) {
401 ret = -ENOENT;
402 goto out_unlock;
403 }
Dave Airlie32488772011-11-25 15:21:02 +0000404
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200405 dmabuf = drm_prime_lookup_buf_by_handle(&file_priv->prime, handle);
406 if (dmabuf) {
407 get_dma_buf(dmabuf);
408 goto out_have_handle;
409 }
410
411 mutex_lock(&dev->object_name_lock);
Dave Airlie32488772011-11-25 15:21:02 +0000412 /* re-export the original imported object */
413 if (obj->import_attach) {
Dave Airlie219b4732013-04-22 09:54:36 +1000414 dmabuf = obj->import_attach->dmabuf;
Daniel Vetter319c9332013-08-15 00:02:46 +0200415 get_dma_buf(dmabuf);
Dave Airlie219b4732013-04-22 09:54:36 +1000416 goto out_have_obj;
Dave Airlie32488772011-11-25 15:21:02 +0000417 }
418
Daniel Vetter319c9332013-08-15 00:02:46 +0200419 if (obj->dma_buf) {
420 get_dma_buf(obj->dma_buf);
421 dmabuf = obj->dma_buf;
Dave Airlie219b4732013-04-22 09:54:36 +1000422 goto out_have_obj;
Dave Airlie32488772011-11-25 15:21:02 +0000423 }
Dave Airlie219b4732013-04-22 09:54:36 +1000424
Daniel Vetter319c9332013-08-15 00:02:46 +0200425 dmabuf = export_and_register_object(dev, obj, flags);
Daniel Vetter4332bf42013-08-15 00:02:41 +0200426 if (IS_ERR(dmabuf)) {
Dave Airlie219b4732013-04-22 09:54:36 +1000427 /* normally the created dma-buf takes ownership of the ref,
428 * but if that fails then drop the ref
429 */
Daniel Vetter4332bf42013-08-15 00:02:41 +0200430 ret = PTR_ERR(dmabuf);
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200431 mutex_unlock(&dev->object_name_lock);
Dave Airlie219b4732013-04-22 09:54:36 +1000432 goto out;
433 }
Dave Airlie219b4732013-04-22 09:54:36 +1000434
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200435out_have_obj:
436 /*
437 * If we've exported this buffer then cheat and add it to the import list
438 * so we get the correct handle back. We must do this under the
439 * protection of dev->object_name_lock to ensure that a racing gem close
440 * ioctl doesn't miss to remove this buffer handle from the cache.
Dave Airlie0ff926c2012-05-20 17:31:16 +0100441 */
Dave Airlie219b4732013-04-22 09:54:36 +1000442 ret = drm_prime_add_buf_handle(&file_priv->prime,
Daniel Vetter319c9332013-08-15 00:02:46 +0200443 dmabuf, handle);
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200444 mutex_unlock(&dev->object_name_lock);
Dave Airlie219b4732013-04-22 09:54:36 +1000445 if (ret)
YoungJun Cho7d8f06a2013-06-26 10:21:40 +0900446 goto fail_put_dmabuf;
Dave Airlie0ff926c2012-05-20 17:31:16 +0100447
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200448out_have_handle:
Daniel Vetter4332bf42013-08-15 00:02:41 +0200449 ret = dma_buf_fd(dmabuf, flags);
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200450 /*
451 * We must _not_ remove the buffer from the handle cache since the newly
452 * created dma buf is already linked in the global obj->dma_buf pointer,
453 * and that is invariant as long as a userspace gem handle exists.
454 * Closing the handle will clean out the cache anyway, so we don't leak.
455 */
Daniel Vetter4a88f732013-07-02 09:18:39 +0200456 if (ret < 0) {
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200457 goto fail_put_dmabuf;
Daniel Vetter4a88f732013-07-02 09:18:39 +0200458 } else {
YoungJun Choda342422013-06-26 10:21:42 +0900459 *prime_fd = ret;
Daniel Vetter4a88f732013-07-02 09:18:39 +0200460 ret = 0;
461 }
462
YoungJun Cho7d8f06a2013-06-26 10:21:40 +0900463 goto out;
464
465fail_put_dmabuf:
Daniel Vetter4332bf42013-08-15 00:02:41 +0200466 dma_buf_put(dmabuf);
Dave Airlie219b4732013-04-22 09:54:36 +1000467out:
468 drm_gem_object_unreference_unlocked(obj);
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200469out_unlock:
470 mutex_unlock(&file_priv->prime.lock);
471
Dave Airlie219b4732013-04-22 09:54:36 +1000472 return ret;
Dave Airlie32488772011-11-25 15:21:02 +0000473}
474EXPORT_SYMBOL(drm_gem_prime_handle_to_fd);
475
Daniel Vetter39cc3442014-01-22 19:16:30 +0100476/**
477 * drm_gem_prime_import - helper library implemention of the import callback
478 * @dev: drm_device to import into
479 * @dma_buf: dma-buf object to import
480 *
481 * This is the implementation of the gem_prime_import functions for GEM drivers
482 * using the PRIME helpers.
483 */
Aaron Plattner89177642013-01-15 20:47:42 +0000484struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev,
485 struct dma_buf *dma_buf)
486{
487 struct dma_buf_attachment *attach;
488 struct sg_table *sgt;
489 struct drm_gem_object *obj;
490 int ret;
491
492 if (!dev->driver->gem_prime_import_sg_table)
493 return ERR_PTR(-EINVAL);
494
495 if (dma_buf->ops == &drm_gem_prime_dmabuf_ops) {
496 obj = dma_buf->priv;
497 if (obj->dev == dev) {
498 /*
499 * Importing dmabuf exported from out own gem increases
500 * refcount on gem itself instead of f_count of dmabuf.
501 */
502 drm_gem_object_reference(obj);
Aaron Plattner89177642013-01-15 20:47:42 +0000503 return obj;
504 }
505 }
506
507 attach = dma_buf_attach(dma_buf, dev->dev);
508 if (IS_ERR(attach))
Thomas Meyerf2a5da42013-06-01 10:09:27 +0000509 return ERR_CAST(attach);
Aaron Plattner89177642013-01-15 20:47:42 +0000510
Imre Deak011c22822013-04-19 11:11:56 +1000511 get_dma_buf(dma_buf);
512
Aaron Plattner89177642013-01-15 20:47:42 +0000513 sgt = dma_buf_map_attachment(attach, DMA_BIDIRECTIONAL);
Colin Crossfee0c542013-12-20 16:43:50 -0800514 if (IS_ERR(sgt)) {
Aaron Plattner89177642013-01-15 20:47:42 +0000515 ret = PTR_ERR(sgt);
516 goto fail_detach;
517 }
518
519 obj = dev->driver->gem_prime_import_sg_table(dev, dma_buf->size, sgt);
520 if (IS_ERR(obj)) {
521 ret = PTR_ERR(obj);
522 goto fail_unmap;
523 }
524
525 obj->import_attach = attach;
526
527 return obj;
528
529fail_unmap:
530 dma_buf_unmap_attachment(attach, sgt, DMA_BIDIRECTIONAL);
531fail_detach:
532 dma_buf_detach(dma_buf, attach);
Imre Deak011c22822013-04-19 11:11:56 +1000533 dma_buf_put(dma_buf);
534
Aaron Plattner89177642013-01-15 20:47:42 +0000535 return ERR_PTR(ret);
536}
537EXPORT_SYMBOL(drm_gem_prime_import);
538
Daniel Vetter39cc3442014-01-22 19:16:30 +0100539/**
540 * drm_gem_prime_fd_to_handle - PRIME import function for GEM drivers
541 * @dev: dev to export the buffer from
542 * @file_priv: drm file-private structure
543 * @prime_fd: fd id of the dma-buf which should be imported
544 * @handle: pointer to storage for the handle of the imported buffer object
545 *
546 * This is the PRIME import function which must be used mandatorily by GEM
547 * drivers to ensure correct lifetime management of the underlying GEM object.
548 * The actual importing of GEM object from the dma-buf is done through the
549 * gem_import_export driver callback.
550 */
Dave Airlie32488772011-11-25 15:21:02 +0000551int drm_gem_prime_fd_to_handle(struct drm_device *dev,
Daniel Vetter39cc3442014-01-22 19:16:30 +0100552 struct drm_file *file_priv, int prime_fd,
553 uint32_t *handle)
Dave Airlie32488772011-11-25 15:21:02 +0000554{
555 struct dma_buf *dma_buf;
556 struct drm_gem_object *obj;
557 int ret;
558
559 dma_buf = dma_buf_get(prime_fd);
560 if (IS_ERR(dma_buf))
561 return PTR_ERR(dma_buf);
562
563 mutex_lock(&file_priv->prime.lock);
564
Dave Airlie219b4732013-04-22 09:54:36 +1000565 ret = drm_prime_lookup_buf_handle(&file_priv->prime,
Dave Airlie32488772011-11-25 15:21:02 +0000566 dma_buf, handle);
Daniel Vetter84341c22013-08-15 00:02:43 +0200567 if (ret == 0)
Dave Airlie32488772011-11-25 15:21:02 +0000568 goto out_put;
Dave Airlie32488772011-11-25 15:21:02 +0000569
570 /* never seen this one, need to import */
Daniel Vetter319c9332013-08-15 00:02:46 +0200571 mutex_lock(&dev->object_name_lock);
Dave Airlie32488772011-11-25 15:21:02 +0000572 obj = dev->driver->gem_prime_import(dev, dma_buf);
573 if (IS_ERR(obj)) {
574 ret = PTR_ERR(obj);
Daniel Vetter319c9332013-08-15 00:02:46 +0200575 goto out_unlock;
Dave Airlie32488772011-11-25 15:21:02 +0000576 }
577
Daniel Vetter319c9332013-08-15 00:02:46 +0200578 if (obj->dma_buf) {
579 WARN_ON(obj->dma_buf != dma_buf);
580 } else {
581 obj->dma_buf = dma_buf;
582 get_dma_buf(dma_buf);
583 }
584
585 /* drm_gem_handle_create_tail unlocks dev->object_name_lock. */
586 ret = drm_gem_handle_create_tail(file_priv, obj, handle);
Dave Airlie32488772011-11-25 15:21:02 +0000587 drm_gem_object_unreference_unlocked(obj);
588 if (ret)
589 goto out_put;
590
Dave Airlie219b4732013-04-22 09:54:36 +1000591 ret = drm_prime_add_buf_handle(&file_priv->prime,
Dave Airlie32488772011-11-25 15:21:02 +0000592 dma_buf, *handle);
593 if (ret)
594 goto fail;
595
596 mutex_unlock(&file_priv->prime.lock);
Imre Deak011c22822013-04-19 11:11:56 +1000597
598 dma_buf_put(dma_buf);
599
Dave Airlie32488772011-11-25 15:21:02 +0000600 return 0;
601
602fail:
603 /* hmm, if driver attached, we are relying on the free-object path
604 * to detach.. which seems ok..
605 */
Daniel Vetter730c4ff2013-08-15 00:02:38 +0200606 drm_gem_handle_delete(file_priv, *handle);
Daniel Vetter319c9332013-08-15 00:02:46 +0200607out_unlock:
Dan Carpenter0adb2372013-08-23 23:46:02 +0300608 mutex_unlock(&dev->object_name_lock);
Dave Airlie32488772011-11-25 15:21:02 +0000609out_put:
610 dma_buf_put(dma_buf);
611 mutex_unlock(&file_priv->prime.lock);
612 return ret;
613}
614EXPORT_SYMBOL(drm_gem_prime_fd_to_handle);
615
616int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data,
617 struct drm_file *file_priv)
618{
619 struct drm_prime_handle *args = data;
620 uint32_t flags;
621
622 if (!drm_core_check_feature(dev, DRIVER_PRIME))
623 return -EINVAL;
624
625 if (!dev->driver->prime_handle_to_fd)
626 return -ENOSYS;
627
628 /* check flags are valid */
629 if (args->flags & ~DRM_CLOEXEC)
630 return -EINVAL;
631
632 /* we only want to pass DRM_CLOEXEC which is == O_CLOEXEC */
633 flags = args->flags & DRM_CLOEXEC;
634
635 return dev->driver->prime_handle_to_fd(dev, file_priv,
636 args->handle, flags, &args->fd);
637}
638
639int drm_prime_fd_to_handle_ioctl(struct drm_device *dev, void *data,
640 struct drm_file *file_priv)
641{
642 struct drm_prime_handle *args = data;
643
644 if (!drm_core_check_feature(dev, DRIVER_PRIME))
645 return -EINVAL;
646
647 if (!dev->driver->prime_fd_to_handle)
648 return -ENOSYS;
649
650 return dev->driver->prime_fd_to_handle(dev, file_priv,
651 args->fd, &args->handle);
652}
653
Daniel Vetter39cc3442014-01-22 19:16:30 +0100654/**
655 * drm_prime_pages_to_sg - converts a page array into an sg list
656 * @pages: pointer to the array of page pointers to convert
657 * @nr_pages: length of the page vector
Dave Airlie32488772011-11-25 15:21:02 +0000658 *
Daniel Vetter39cc3442014-01-22 19:16:30 +0100659 * This helper creates an sg table object from a set of pages
Dave Airlie32488772011-11-25 15:21:02 +0000660 * the driver is responsible for mapping the pages into the
Daniel Vetter39cc3442014-01-22 19:16:30 +0100661 * importers address space for use with dma_buf itself.
Dave Airlie32488772011-11-25 15:21:02 +0000662 */
663struct sg_table *drm_prime_pages_to_sg(struct page **pages, int nr_pages)
664{
665 struct sg_table *sg = NULL;
Dave Airlie32488772011-11-25 15:21:02 +0000666 int ret;
667
668 sg = kmalloc(sizeof(struct sg_table), GFP_KERNEL);
YoungJun Cho7e3d88f2013-06-24 16:40:53 +0900669 if (!sg) {
670 ret = -ENOMEM;
Dave Airlie32488772011-11-25 15:21:02 +0000671 goto out;
YoungJun Cho7e3d88f2013-06-24 16:40:53 +0900672 }
Dave Airlie32488772011-11-25 15:21:02 +0000673
Rahul Sharmadca25cb2013-01-28 08:38:48 -0500674 ret = sg_alloc_table_from_pages(sg, pages, nr_pages, 0,
675 nr_pages << PAGE_SHIFT, GFP_KERNEL);
Dave Airlie32488772011-11-25 15:21:02 +0000676 if (ret)
677 goto out;
678
Dave Airlie32488772011-11-25 15:21:02 +0000679 return sg;
680out:
681 kfree(sg);
YoungJun Cho7e3d88f2013-06-24 16:40:53 +0900682 return ERR_PTR(ret);
Dave Airlie32488772011-11-25 15:21:02 +0000683}
684EXPORT_SYMBOL(drm_prime_pages_to_sg);
685
Daniel Vetter39cc3442014-01-22 19:16:30 +0100686/**
687 * drm_prime_sg_to_page_addr_arrays - convert an sg table into a page array
688 * @sgt: scatter-gather table to convert
689 * @pages: array of page pointers to store the page array in
690 * @addrs: optional array to store the dma bus address of each page
691 * @max_pages: size of both the passed-in arrays
692 *
693 * Exports an sg table into an array of pages and addresses. This is currently
694 * required by the TTM driver in order to do correct fault handling.
695 */
Dave Airlie51ab7ba2012-05-18 15:40:33 +0100696int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages,
697 dma_addr_t *addrs, int max_pages)
698{
699 unsigned count;
700 struct scatterlist *sg;
701 struct page *page;
Lespiau, Damien36dccc82013-09-28 16:24:02 +0100702 u32 len;
Dave Airlie51ab7ba2012-05-18 15:40:33 +0100703 int pg_index;
704 dma_addr_t addr;
705
706 pg_index = 0;
707 for_each_sg(sgt->sgl, sg, sgt->nents, count) {
708 len = sg->length;
Dave Airlie51ab7ba2012-05-18 15:40:33 +0100709 page = sg_page(sg);
710 addr = sg_dma_address(sg);
711
712 while (len > 0) {
713 if (WARN_ON(pg_index >= max_pages))
714 return -1;
715 pages[pg_index] = page;
716 if (addrs)
717 addrs[pg_index] = addr;
718
719 page++;
720 addr += PAGE_SIZE;
721 len -= PAGE_SIZE;
722 pg_index++;
723 }
724 }
725 return 0;
726}
727EXPORT_SYMBOL(drm_prime_sg_to_page_addr_arrays);
Daniel Vetter39cc3442014-01-22 19:16:30 +0100728
729/**
730 * drm_prime_gem_destroy - helper to clean up a PRIME-imported GEM object
731 * @obj: GEM object which was created from a dma-buf
732 * @sg: the sg-table which was pinned at import time
733 *
734 * This is the cleanup functions which GEM drivers need to call when they use
735 * @drm_gem_prime_import to import dma-bufs.
736 */
Dave Airlie32488772011-11-25 15:21:02 +0000737void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg)
738{
739 struct dma_buf_attachment *attach;
740 struct dma_buf *dma_buf;
741 attach = obj->import_attach;
742 if (sg)
743 dma_buf_unmap_attachment(attach, sg, DMA_BIDIRECTIONAL);
744 dma_buf = attach->dmabuf;
745 dma_buf_detach(attach->dmabuf, attach);
746 /* remove the reference */
747 dma_buf_put(dma_buf);
748}
749EXPORT_SYMBOL(drm_prime_gem_destroy);
750
751void drm_prime_init_file_private(struct drm_prime_file_private *prime_fpriv)
752{
753 INIT_LIST_HEAD(&prime_fpriv->head);
754 mutex_init(&prime_fpriv->lock);
755}
Dave Airlie32488772011-11-25 15:21:02 +0000756
757void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv)
758{
Imre Deak98b76232013-04-24 19:04:57 +0300759 /* by now drm_gem_release should've made sure the list is empty */
760 WARN_ON(!list_empty(&prime_fpriv->head));
Dave Airlie32488772011-11-25 15:21:02 +0000761}