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