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> | |
077675c1 | 31 | #include <linux/rbtree.h> |
16b0314a | 32 | #include <linux/module.h> |
0500c04e | 33 | |
39716270 | 34 | #include <drm/drm.h> |
0500c04e SR |
35 | #include <drm/drm_drv.h> |
36 | #include <drm/drm_file.h> | |
37 | #include <drm/drm_framebuffer.h> | |
d9fc9413 | 38 | #include <drm/drm_gem.h> |
0500c04e | 39 | #include <drm/drm_prime.h> |
d9fc9413 | 40 | |
67d0ec4e | 41 | #include "drm_internal.h" |
3248877e | 42 | |
16b0314a GKH |
43 | MODULE_IMPORT_NS(DMA_BUF); |
44 | ||
805dc614 DV |
45 | /** |
46 | * DOC: overview and lifetime rules | |
47 | * | |
48 | * Similar to GEM global names, PRIME file descriptors are also used to share | |
49 | * buffer objects across processes. They offer additional security: as file | |
50 | * descriptors must be explicitly sent over UNIX domain sockets to be shared | |
51 | * between applications, they can't be guessed like the globally unique GEM | |
52 | * names. | |
53 | * | |
ee8375d5 | 54 | * Drivers that support the PRIME API implement the |
805dc614 DV |
55 | * &drm_driver.prime_handle_to_fd and &drm_driver.prime_fd_to_handle operations. |
56 | * GEM based drivers must use drm_gem_prime_handle_to_fd() and | |
57 | * drm_gem_prime_fd_to_handle() to implement these. For GEM based drivers the | |
58 | * actual driver interfaces is provided through the &drm_gem_object_funcs.export | |
59 | * and &drm_driver.gem_prime_import hooks. | |
60 | * | |
61 | * &dma_buf_ops implementations for GEM drivers are all individually exported | |
62 | * for drivers which need to overwrite or reimplement some of them. | |
63 | * | |
64 | * Reference Counting for GEM Drivers | |
65 | * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
66 | * | |
67 | * On the export the &dma_buf holds a reference to the exported buffer object, | |
68 | * usually a &drm_gem_object. It takes this reference in the PRIME_HANDLE_TO_FD | |
69 | * IOCTL, when it first calls &drm_gem_object_funcs.export | |
70 | * and stores the exporting GEM object in the &dma_buf.priv field. This | |
71 | * reference needs to be released when the final reference to the &dma_buf | |
72 | * itself is dropped and its &dma_buf_ops.release function is called. For | |
73 | * GEM-based drivers, the &dma_buf should be exported using | |
74 | * drm_gem_dmabuf_export() and then released by drm_gem_dmabuf_release(). | |
75 | * | |
76 | * Thus the chain of references always flows in one direction, avoiding loops: | |
77 | * importing GEM object -> dma-buf -> exported GEM bo. A further complication | |
78 | * are the lookup caches for import and export. These are required to guarantee | |
0ae865ef | 79 | * that any given object will always have only one unique userspace handle. This |
805dc614 DV |
80 | * is required to allow userspace to detect duplicated imports, since some GEM |
81 | * drivers do fail command submissions if a given buffer object is listed more | |
82 | * than once. These import and export caches in &drm_prime_file_private only | |
83 | * retain a weak reference, which is cleaned up when the corresponding object is | |
84 | * released. | |
85 | * | |
86 | * Self-importing: If userspace is using PRIME as a replacement for flink then | |
87 | * it will get a fd->handle request for a GEM object that it created. Drivers | |
88 | * should detect this situation and return back the underlying object from the | |
89 | * dma-buf private. For GEM based drivers this is handled in | |
90 | * drm_gem_prime_import() already. | |
3248877e DA |
91 | */ |
92 | ||
93 | struct drm_prime_member { | |
3248877e DA |
94 | struct dma_buf *dma_buf; |
95 | uint32_t handle; | |
077675c1 CW |
96 | |
97 | struct rb_node dmabuf_rb; | |
98 | struct rb_node handle_rb; | |
3248877e | 99 | }; |
538d6661 | 100 | |
39cc344a DV |
101 | static int drm_prime_add_buf_handle(struct drm_prime_file_private *prime_fpriv, |
102 | struct dma_buf *dma_buf, uint32_t handle) | |
ce92e3c9 SWK |
103 | { |
104 | struct drm_prime_member *member; | |
077675c1 | 105 | struct rb_node **p, *rb; |
ce92e3c9 SWK |
106 | |
107 | member = kmalloc(sizeof(*member), GFP_KERNEL); | |
108 | if (!member) | |
109 | return -ENOMEM; | |
110 | ||
111 | get_dma_buf(dma_buf); | |
112 | member->dma_buf = dma_buf; | |
113 | member->handle = handle; | |
077675c1 CW |
114 | |
115 | rb = NULL; | |
116 | p = &prime_fpriv->dmabufs.rb_node; | |
117 | while (*p) { | |
118 | struct drm_prime_member *pos; | |
119 | ||
120 | rb = *p; | |
121 | pos = rb_entry(rb, struct drm_prime_member, dmabuf_rb); | |
122 | if (dma_buf > pos->dma_buf) | |
123 | p = &rb->rb_right; | |
124 | else | |
125 | p = &rb->rb_left; | |
126 | } | |
127 | rb_link_node(&member->dmabuf_rb, rb, p); | |
128 | rb_insert_color(&member->dmabuf_rb, &prime_fpriv->dmabufs); | |
129 | ||
130 | rb = NULL; | |
131 | p = &prime_fpriv->handles.rb_node; | |
132 | while (*p) { | |
133 | struct drm_prime_member *pos; | |
134 | ||
135 | rb = *p; | |
136 | pos = rb_entry(rb, struct drm_prime_member, handle_rb); | |
137 | if (handle > pos->handle) | |
138 | p = &rb->rb_right; | |
139 | else | |
140 | p = &rb->rb_left; | |
141 | } | |
142 | rb_link_node(&member->handle_rb, rb, p); | |
143 | rb_insert_color(&member->handle_rb, &prime_fpriv->handles); | |
144 | ||
ce92e3c9 SWK |
145 | return 0; |
146 | } | |
3248877e | 147 | |
d0b2c533 DV |
148 | static struct dma_buf *drm_prime_lookup_buf_by_handle(struct drm_prime_file_private *prime_fpriv, |
149 | uint32_t handle) | |
150 | { | |
077675c1 CW |
151 | struct rb_node *rb; |
152 | ||
153 | rb = prime_fpriv->handles.rb_node; | |
154 | while (rb) { | |
155 | struct drm_prime_member *member; | |
d0b2c533 | 156 | |
077675c1 | 157 | member = rb_entry(rb, struct drm_prime_member, handle_rb); |
d0b2c533 DV |
158 | if (member->handle == handle) |
159 | return member->dma_buf; | |
077675c1 CW |
160 | else if (member->handle < handle) |
161 | rb = rb->rb_right; | |
162 | else | |
163 | rb = rb->rb_left; | |
d0b2c533 DV |
164 | } |
165 | ||
166 | return NULL; | |
167 | } | |
168 | ||
de9564d8 DV |
169 | static int drm_prime_lookup_buf_handle(struct drm_prime_file_private *prime_fpriv, |
170 | struct dma_buf *dma_buf, | |
171 | uint32_t *handle) | |
172 | { | |
077675c1 CW |
173 | struct rb_node *rb; |
174 | ||
175 | rb = prime_fpriv->dmabufs.rb_node; | |
176 | while (rb) { | |
177 | struct drm_prime_member *member; | |
de9564d8 | 178 | |
077675c1 | 179 | member = rb_entry(rb, struct drm_prime_member, dmabuf_rb); |
de9564d8 DV |
180 | if (member->dma_buf == dma_buf) { |
181 | *handle = member->handle; | |
182 | return 0; | |
077675c1 CW |
183 | } else if (member->dma_buf < dma_buf) { |
184 | rb = rb->rb_right; | |
185 | } else { | |
186 | rb = rb->rb_left; | |
de9564d8 DV |
187 | } |
188 | } | |
077675c1 | 189 | |
de9564d8 DV |
190 | return -ENOENT; |
191 | } | |
192 | ||
ea2aa97c JC |
193 | void drm_prime_remove_buf_handle(struct drm_prime_file_private *prime_fpriv, |
194 | uint32_t handle) | |
da34242e | 195 | { |
077675c1 | 196 | struct rb_node *rb; |
da34242e | 197 | |
ea2aa97c JC |
198 | mutex_lock(&prime_fpriv->lock); |
199 | ||
200 | rb = prime_fpriv->handles.rb_node; | |
077675c1 CW |
201 | while (rb) { |
202 | struct drm_prime_member *member; | |
203 | ||
ea2aa97c JC |
204 | member = rb_entry(rb, struct drm_prime_member, handle_rb); |
205 | if (member->handle == handle) { | |
077675c1 CW |
206 | rb_erase(&member->handle_rb, &prime_fpriv->handles); |
207 | rb_erase(&member->dmabuf_rb, &prime_fpriv->dmabufs); | |
208 | ||
ea2aa97c | 209 | dma_buf_put(member->dma_buf); |
da34242e | 210 | kfree(member); |
ea2aa97c JC |
211 | break; |
212 | } else if (member->handle < handle) { | |
077675c1 CW |
213 | rb = rb->rb_right; |
214 | } else { | |
215 | rb = rb->rb_left; | |
da34242e YC |
216 | } |
217 | } | |
ea2aa97c JC |
218 | |
219 | mutex_unlock(&prime_fpriv->lock); | |
da34242e YC |
220 | } |
221 | ||
b283e92a | 222 | void drm_prime_init_file_private(struct drm_prime_file_private *prime_fpriv) |
89177644 | 223 | { |
b283e92a DV |
224 | mutex_init(&prime_fpriv->lock); |
225 | prime_fpriv->dmabufs = RB_ROOT; | |
226 | prime_fpriv->handles = RB_ROOT; | |
89177644 AP |
227 | } |
228 | ||
b283e92a | 229 | void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv) |
89177644 | 230 | { |
b283e92a DV |
231 | /* by now drm_gem_release should've made sure the list is empty */ |
232 | WARN_ON(!RB_EMPTY_ROOT(&prime_fpriv->dmabufs)); | |
89177644 AP |
233 | } |
234 | ||
a4fce9cb | 235 | /** |
805dc614 | 236 | * drm_gem_dmabuf_export - &dma_buf export implementation for GEM |
67c8f116 CW |
237 | * @dev: parent device for the exported dmabuf |
238 | * @exp_info: the export information used by dma_buf_export() | |
a4fce9cb CW |
239 | * |
240 | * This wraps dma_buf_export() for use by generic GEM drivers that are using | |
241 | * drm_gem_dmabuf_release(). In addition to calling dma_buf_export(), we take | |
72a93e8d | 242 | * a reference to the &drm_device and the exported &drm_gem_object (stored in |
940eba2d | 243 | * &dma_buf_export_info.priv) which is released by drm_gem_dmabuf_release(). |
a4fce9cb CW |
244 | * |
245 | * Returns the new dmabuf. | |
246 | */ | |
247 | struct dma_buf *drm_gem_dmabuf_export(struct drm_device *dev, | |
248 | struct dma_buf_export_info *exp_info) | |
249 | { | |
b3fac52c | 250 | struct drm_gem_object *obj = exp_info->priv; |
a4fce9cb CW |
251 | struct dma_buf *dma_buf; |
252 | ||
253 | dma_buf = dma_buf_export(exp_info); | |
72a93e8d CW |
254 | if (IS_ERR(dma_buf)) |
255 | return dma_buf; | |
256 | ||
9a96f550 | 257 | drm_dev_get(dev); |
b3fac52c GH |
258 | drm_gem_object_get(obj); |
259 | dma_buf->file->f_mapping = obj->dev->anon_inode->i_mapping; | |
a4fce9cb CW |
260 | |
261 | return dma_buf; | |
262 | } | |
263 | EXPORT_SYMBOL(drm_gem_dmabuf_export); | |
264 | ||
39cc344a | 265 | /** |
805dc614 | 266 | * drm_gem_dmabuf_release - &dma_buf release implementation for GEM |
39cc344a DV |
267 | * @dma_buf: buffer to be released |
268 | * | |
269 | * Generic release function for dma_bufs exported as PRIME buffers. GEM drivers | |
805dc614 | 270 | * must use this in their &dma_buf_ops structure as the release callback. |
a4fce9cb CW |
271 | * drm_gem_dmabuf_release() should be used in conjunction with |
272 | * drm_gem_dmabuf_export(). | |
39cc344a | 273 | */ |
c1d6798d | 274 | void drm_gem_dmabuf_release(struct dma_buf *dma_buf) |
89177644 AP |
275 | { |
276 | struct drm_gem_object *obj = dma_buf->priv; | |
a4fce9cb | 277 | struct drm_device *dev = obj->dev; |
89177644 | 278 | |
319c933c | 279 | /* drop the reference on the export fd holds */ |
be6ee102 | 280 | drm_gem_object_put(obj); |
a4fce9cb | 281 | |
ffeeeed0 | 282 | drm_dev_put(dev); |
89177644 | 283 | } |
c1d6798d | 284 | EXPORT_SYMBOL(drm_gem_dmabuf_release); |
89177644 | 285 | |
f7a71b0c | 286 | /** |
b283e92a DV |
287 | * drm_gem_prime_fd_to_handle - PRIME import function for GEM drivers |
288 | * @dev: dev to export the buffer from | |
289 | * @file_priv: drm file-private structure | |
290 | * @prime_fd: fd id of the dma-buf which should be imported | |
291 | * @handle: pointer to storage for the handle of the imported buffer object | |
f7a71b0c | 292 | * |
b283e92a DV |
293 | * This is the PRIME import function which must be used mandatorily by GEM |
294 | * drivers to ensure correct lifetime management of the underlying GEM object. | |
295 | * The actual importing of GEM object from the dma-buf is done through the | |
805dc614 DV |
296 | * &drm_driver.gem_prime_import driver callback. |
297 | * | |
298 | * Returns 0 on success or a negative error code on failure. | |
f7a71b0c | 299 | */ |
b283e92a DV |
300 | int drm_gem_prime_fd_to_handle(struct drm_device *dev, |
301 | struct drm_file *file_priv, int prime_fd, | |
302 | uint32_t *handle) | |
89177644 | 303 | { |
b283e92a DV |
304 | struct dma_buf *dma_buf; |
305 | struct drm_gem_object *obj; | |
306 | int ret; | |
89177644 | 307 | |
b283e92a DV |
308 | dma_buf = dma_buf_get(prime_fd); |
309 | if (IS_ERR(dma_buf)) | |
310 | return PTR_ERR(dma_buf); | |
b39b5394 | 311 | |
b283e92a | 312 | mutex_lock(&file_priv->prime.lock); |
89177644 | 313 | |
b283e92a DV |
314 | ret = drm_prime_lookup_buf_handle(&file_priv->prime, |
315 | dma_buf, handle); | |
316 | if (ret == 0) | |
317 | goto out_put; | |
89177644 | 318 | |
b283e92a DV |
319 | /* never seen this one, need to import */ |
320 | mutex_lock(&dev->object_name_lock); | |
321 | if (dev->driver->gem_prime_import) | |
322 | obj = dev->driver->gem_prime_import(dev, dma_buf); | |
323 | else | |
324 | obj = drm_gem_prime_import(dev, dma_buf); | |
325 | if (IS_ERR(obj)) { | |
326 | ret = PTR_ERR(obj); | |
327 | goto out_unlock; | |
328 | } | |
89177644 | 329 | |
b283e92a DV |
330 | if (obj->dma_buf) { |
331 | WARN_ON(obj->dma_buf != dma_buf); | |
332 | } else { | |
333 | obj->dma_buf = dma_buf; | |
334 | get_dma_buf(dma_buf); | |
335 | } | |
7c397cd9 | 336 | |
b283e92a DV |
337 | /* _handle_create_tail unconditionally unlocks dev->object_name_lock. */ |
338 | ret = drm_gem_handle_create_tail(file_priv, obj, handle); | |
be6ee102 | 339 | drm_gem_object_put(obj); |
b283e92a DV |
340 | if (ret) |
341 | goto out_put; | |
7c397cd9 | 342 | |
b283e92a DV |
343 | ret = drm_prime_add_buf_handle(&file_priv->prime, |
344 | dma_buf, *handle); | |
345 | mutex_unlock(&file_priv->prime.lock); | |
346 | if (ret) | |
347 | goto fail; | |
89177644 | 348 | |
b283e92a | 349 | dma_buf_put(dma_buf); |
89177644 | 350 | |
b283e92a | 351 | return 0; |
89177644 | 352 | |
b283e92a DV |
353 | fail: |
354 | /* hmm, if driver attached, we are relying on the free-object path | |
355 | * to detach.. which seems ok.. | |
356 | */ | |
357 | drm_gem_handle_delete(file_priv, *handle); | |
358 | dma_buf_put(dma_buf); | |
359 | return ret; | |
360 | ||
361 | out_unlock: | |
362 | mutex_unlock(&dev->object_name_lock); | |
363 | out_put: | |
364 | mutex_unlock(&file_priv->prime.lock); | |
365 | dma_buf_put(dma_buf); | |
366 | return ret; | |
367 | } | |
368 | EXPORT_SYMBOL(drm_gem_prime_fd_to_handle); | |
369 | ||
370 | int drm_prime_fd_to_handle_ioctl(struct drm_device *dev, void *data, | |
371 | struct drm_file *file_priv) | |
89177644 | 372 | { |
b283e92a | 373 | struct drm_prime_handle *args = data; |
3aac4502 | 374 | |
b283e92a DV |
375 | if (!dev->driver->prime_fd_to_handle) |
376 | return -ENOSYS; | |
377 | ||
378 | return dev->driver->prime_fd_to_handle(dev, file_priv, | |
379 | args->fd, &args->handle); | |
89177644 | 380 | } |
89177644 | 381 | |
319c933c DV |
382 | static struct dma_buf *export_and_register_object(struct drm_device *dev, |
383 | struct drm_gem_object *obj, | |
384 | uint32_t flags) | |
385 | { | |
386 | struct dma_buf *dmabuf; | |
387 | ||
388 | /* prevent races with concurrent gem_close. */ | |
389 | if (obj->handle_count == 0) { | |
390 | dmabuf = ERR_PTR(-ENOENT); | |
391 | return dmabuf; | |
392 | } | |
393 | ||
b39b5394 NT |
394 | if (obj->funcs && obj->funcs->export) |
395 | dmabuf = obj->funcs->export(obj, flags); | |
f0014881 | 396 | else |
e4fa8457 | 397 | dmabuf = drm_gem_prime_export(obj, flags); |
319c933c DV |
398 | if (IS_ERR(dmabuf)) { |
399 | /* normally the created dma-buf takes ownership of the ref, | |
400 | * but if that fails then drop the ref | |
401 | */ | |
402 | return dmabuf; | |
403 | } | |
404 | ||
405 | /* | |
406 | * Note that callers do not need to clean up the export cache | |
407 | * since the check for obj->handle_count guarantees that someone | |
408 | * will clean it up. | |
409 | */ | |
410 | obj->dma_buf = dmabuf; | |
411 | get_dma_buf(obj->dma_buf); | |
412 | ||
413 | return dmabuf; | |
414 | } | |
415 | ||
39cc344a DV |
416 | /** |
417 | * drm_gem_prime_handle_to_fd - PRIME export function for GEM drivers | |
418 | * @dev: dev to export the buffer from | |
419 | * @file_priv: drm file-private structure | |
420 | * @handle: buffer handle to export | |
421 | * @flags: flags like DRM_CLOEXEC | |
422 | * @prime_fd: pointer to storage for the fd id of the create dma-buf | |
423 | * | |
424 | * This is the PRIME export function which must be used mandatorily by GEM | |
425 | * drivers to ensure correct lifetime management of the underlying GEM object. | |
426 | * The actual exporting from GEM object to a dma-buf is done through the | |
d693def4 | 427 | * &drm_gem_object_funcs.export callback. |
39cc344a | 428 | */ |
3248877e | 429 | int drm_gem_prime_handle_to_fd(struct drm_device *dev, |
39cc344a DV |
430 | struct drm_file *file_priv, uint32_t handle, |
431 | uint32_t flags, | |
432 | int *prime_fd) | |
3248877e DA |
433 | { |
434 | struct drm_gem_object *obj; | |
219b4733 DA |
435 | int ret = 0; |
436 | struct dma_buf *dmabuf; | |
3248877e | 437 | |
d0b2c533 | 438 | mutex_lock(&file_priv->prime.lock); |
a8ad0bd8 | 439 | obj = drm_gem_object_lookup(file_priv, handle); |
d0b2c533 DV |
440 | if (!obj) { |
441 | ret = -ENOENT; | |
442 | goto out_unlock; | |
443 | } | |
444 | ||
445 | dmabuf = drm_prime_lookup_buf_by_handle(&file_priv->prime, handle); | |
446 | if (dmabuf) { | |
447 | get_dma_buf(dmabuf); | |
448 | goto out_have_handle; | |
449 | } | |
3248877e | 450 | |
d0b2c533 | 451 | mutex_lock(&dev->object_name_lock); |
3248877e DA |
452 | /* re-export the original imported object */ |
453 | if (obj->import_attach) { | |
219b4733 | 454 | dmabuf = obj->import_attach->dmabuf; |
319c933c | 455 | get_dma_buf(dmabuf); |
219b4733 | 456 | goto out_have_obj; |
3248877e DA |
457 | } |
458 | ||
319c933c DV |
459 | if (obj->dma_buf) { |
460 | get_dma_buf(obj->dma_buf); | |
461 | dmabuf = obj->dma_buf; | |
219b4733 | 462 | goto out_have_obj; |
3248877e | 463 | } |
219b4733 | 464 | |
319c933c | 465 | dmabuf = export_and_register_object(dev, obj, flags); |
4332bf43 | 466 | if (IS_ERR(dmabuf)) { |
219b4733 DA |
467 | /* normally the created dma-buf takes ownership of the ref, |
468 | * but if that fails then drop the ref | |
469 | */ | |
4332bf43 | 470 | ret = PTR_ERR(dmabuf); |
d0b2c533 | 471 | mutex_unlock(&dev->object_name_lock); |
219b4733 DA |
472 | goto out; |
473 | } | |
219b4733 | 474 | |
d0b2c533 DV |
475 | out_have_obj: |
476 | /* | |
477 | * If we've exported this buffer then cheat and add it to the import list | |
478 | * so we get the correct handle back. We must do this under the | |
479 | * protection of dev->object_name_lock to ensure that a racing gem close | |
480 | * ioctl doesn't miss to remove this buffer handle from the cache. | |
0ff926c7 | 481 | */ |
219b4733 | 482 | ret = drm_prime_add_buf_handle(&file_priv->prime, |
319c933c | 483 | dmabuf, handle); |
d0b2c533 | 484 | mutex_unlock(&dev->object_name_lock); |
219b4733 | 485 | if (ret) |
7d8f06ac | 486 | goto fail_put_dmabuf; |
0ff926c7 | 487 | |
d0b2c533 | 488 | out_have_handle: |
4332bf43 | 489 | ret = dma_buf_fd(dmabuf, flags); |
d0b2c533 DV |
490 | /* |
491 | * We must _not_ remove the buffer from the handle cache since the newly | |
492 | * created dma buf is already linked in the global obj->dma_buf pointer, | |
493 | * and that is invariant as long as a userspace gem handle exists. | |
494 | * Closing the handle will clean out the cache anyway, so we don't leak. | |
495 | */ | |
4a88f73f | 496 | if (ret < 0) { |
d0b2c533 | 497 | goto fail_put_dmabuf; |
4a88f73f | 498 | } else { |
da34242e | 499 | *prime_fd = ret; |
4a88f73f DV |
500 | ret = 0; |
501 | } | |
502 | ||
7d8f06ac YC |
503 | goto out; |
504 | ||
505 | fail_put_dmabuf: | |
4332bf43 | 506 | dma_buf_put(dmabuf); |
219b4733 | 507 | out: |
be6ee102 | 508 | drm_gem_object_put(obj); |
d0b2c533 DV |
509 | out_unlock: |
510 | mutex_unlock(&file_priv->prime.lock); | |
511 | ||
b283e92a DV |
512 | return ret; |
513 | } | |
514 | EXPORT_SYMBOL(drm_gem_prime_handle_to_fd); | |
515 | ||
516 | int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data, | |
517 | struct drm_file *file_priv) | |
518 | { | |
519 | struct drm_prime_handle *args = data; | |
520 | ||
b283e92a DV |
521 | if (!dev->driver->prime_handle_to_fd) |
522 | return -ENOSYS; | |
523 | ||
524 | /* check flags are valid */ | |
525 | if (args->flags & ~(DRM_CLOEXEC | DRM_RDWR)) | |
526 | return -EINVAL; | |
527 | ||
528 | return dev->driver->prime_handle_to_fd(dev, file_priv, | |
529 | args->handle, args->flags, &args->fd); | |
530 | } | |
531 | ||
532 | /** | |
533 | * DOC: PRIME Helpers | |
534 | * | |
805dc614 DV |
535 | * Drivers can implement &drm_gem_object_funcs.export and |
536 | * &drm_driver.gem_prime_import in terms of simpler APIs by using the helper | |
537 | * functions drm_gem_prime_export() and drm_gem_prime_import(). These functions | |
538 | * implement dma-buf support in terms of some lower-level helpers, which are | |
539 | * again exported for drivers to use individually: | |
540 | * | |
541 | * Exporting buffers | |
542 | * ~~~~~~~~~~~~~~~~~ | |
543 | * | |
544 | * Optional pinning of buffers is handled at dma-buf attach and detach time in | |
545 | * drm_gem_map_attach() and drm_gem_map_detach(). Backing storage itself is | |
546 | * handled by drm_gem_map_dma_buf() and drm_gem_unmap_dma_buf(), which relies on | |
547 | * &drm_gem_object_funcs.get_sg_table. | |
548 | * | |
549 | * For kernel-internal access there's drm_gem_dmabuf_vmap() and | |
550 | * drm_gem_dmabuf_vunmap(). Userspace mmap support is provided by | |
551 | * drm_gem_dmabuf_mmap(). | |
b283e92a | 552 | * |
805dc614 DV |
553 | * Note that these export helpers can only be used if the underlying backing |
554 | * storage is fully coherent and either permanently pinned, or it is safe to pin | |
555 | * it indefinitely. | |
b283e92a | 556 | * |
805dc614 | 557 | * FIXME: The underlying helper functions are named rather inconsistently. |
b283e92a | 558 | * |
40f2218d | 559 | * Importing buffers |
805dc614 | 560 | * ~~~~~~~~~~~~~~~~~ |
b283e92a | 561 | * |
805dc614 DV |
562 | * Importing dma-bufs using drm_gem_prime_import() relies on |
563 | * &drm_driver.gem_prime_import_sg_table. | |
564 | * | |
565 | * Note that similarly to the export helpers this permanently pins the | |
566 | * underlying backing storage. Which is ok for scanout, but is not the best | |
567 | * option for sharing lots of buffers for rendering. | |
b283e92a DV |
568 | */ |
569 | ||
570 | /** | |
571 | * drm_gem_map_attach - dma_buf attach implementation for GEM | |
572 | * @dma_buf: buffer to attach device to | |
573 | * @attach: buffer attachment data | |
574 | * | |
805dc614 DV |
575 | * Calls &drm_gem_object_funcs.pin for device specific handling. This can be |
576 | * used as the &dma_buf_ops.attach callback. Must be used together with | |
577 | * drm_gem_map_detach(). | |
b283e92a DV |
578 | * |
579 | * Returns 0 on success, negative error code on failure. | |
580 | */ | |
581 | int drm_gem_map_attach(struct dma_buf *dma_buf, | |
582 | struct dma_buf_attachment *attach) | |
583 | { | |
584 | struct drm_gem_object *obj = dma_buf->priv; | |
585 | ||
586 | return drm_gem_pin(obj); | |
587 | } | |
588 | EXPORT_SYMBOL(drm_gem_map_attach); | |
589 | ||
590 | /** | |
591 | * drm_gem_map_detach - dma_buf detach implementation for GEM | |
592 | * @dma_buf: buffer to detach from | |
593 | * @attach: attachment to be detached | |
594 | * | |
805dc614 DV |
595 | * Calls &drm_gem_object_funcs.pin for device specific handling. Cleans up |
596 | * &dma_buf_attachment from drm_gem_map_attach(). This can be used as the | |
597 | * &dma_buf_ops.detach callback. | |
b283e92a DV |
598 | */ |
599 | void drm_gem_map_detach(struct dma_buf *dma_buf, | |
600 | struct dma_buf_attachment *attach) | |
601 | { | |
602 | struct drm_gem_object *obj = dma_buf->priv; | |
603 | ||
604 | drm_gem_unpin(obj); | |
605 | } | |
606 | EXPORT_SYMBOL(drm_gem_map_detach); | |
607 | ||
608 | /** | |
609 | * drm_gem_map_dma_buf - map_dma_buf implementation for GEM | |
610 | * @attach: attachment whose scatterlist is to be returned | |
611 | * @dir: direction of DMA transfer | |
612 | * | |
805dc614 DV |
613 | * Calls &drm_gem_object_funcs.get_sg_table and then maps the scatterlist. This |
614 | * can be used as the &dma_buf_ops.map_dma_buf callback. Should be used together | |
615 | * with drm_gem_unmap_dma_buf(). | |
b283e92a | 616 | * |
805dc614 | 617 | * Returns:sg_table containing the scatterlist to be returned; returns ERR_PTR |
b283e92a DV |
618 | * on error. May return -EINTR if it is interrupted by a signal. |
619 | */ | |
b283e92a DV |
620 | struct sg_table *drm_gem_map_dma_buf(struct dma_buf_attachment *attach, |
621 | enum dma_data_direction dir) | |
622 | { | |
623 | struct drm_gem_object *obj = attach->dmabuf->priv; | |
624 | struct sg_table *sgt; | |
6c6fa39c | 625 | int ret; |
b283e92a DV |
626 | |
627 | if (WARN_ON(dir == DMA_NONE)) | |
628 | return ERR_PTR(-EINVAL); | |
629 | ||
d693def4 TZ |
630 | if (WARN_ON(!obj->funcs->get_sg_table)) |
631 | return ERR_PTR(-ENOSYS); | |
632 | ||
633 | sgt = obj->funcs->get_sg_table(obj); | |
634 | if (IS_ERR(sgt)) | |
635 | return sgt; | |
b283e92a | 636 | |
6c6fa39c MS |
637 | ret = dma_map_sgtable(attach->dev, sgt, dir, |
638 | DMA_ATTR_SKIP_CPU_SYNC); | |
639 | if (ret) { | |
b283e92a DV |
640 | sg_free_table(sgt); |
641 | kfree(sgt); | |
6c6fa39c | 642 | sgt = ERR_PTR(ret); |
b283e92a DV |
643 | } |
644 | ||
645 | return sgt; | |
646 | } | |
647 | EXPORT_SYMBOL(drm_gem_map_dma_buf); | |
648 | ||
649 | /** | |
650 | * drm_gem_unmap_dma_buf - unmap_dma_buf implementation for GEM | |
651 | * @attach: attachment to unmap buffer from | |
652 | * @sgt: scatterlist info of the buffer to unmap | |
653 | * @dir: direction of DMA transfer | |
654 | * | |
655 | * This can be used as the &dma_buf_ops.unmap_dma_buf callback. | |
656 | */ | |
657 | void drm_gem_unmap_dma_buf(struct dma_buf_attachment *attach, | |
658 | struct sg_table *sgt, | |
659 | enum dma_data_direction dir) | |
660 | { | |
661 | if (!sgt) | |
662 | return; | |
663 | ||
6c6fa39c | 664 | dma_unmap_sgtable(attach->dev, sgt, dir, DMA_ATTR_SKIP_CPU_SYNC); |
b283e92a DV |
665 | sg_free_table(sgt); |
666 | kfree(sgt); | |
667 | } | |
668 | EXPORT_SYMBOL(drm_gem_unmap_dma_buf); | |
669 | ||
670 | /** | |
671 | * drm_gem_dmabuf_vmap - dma_buf vmap implementation for GEM | |
672 | * @dma_buf: buffer to be mapped | |
6619ccf1 | 673 | * @map: the virtual address of the buffer |
b283e92a DV |
674 | * |
675 | * Sets up a kernel virtual mapping. This can be used as the &dma_buf_ops.vmap | |
805dc614 | 676 | * callback. Calls into &drm_gem_object_funcs.vmap for device specific handling. |
a745fb1c | 677 | * The kernel virtual address is returned in map. |
b283e92a | 678 | * |
a745fb1c | 679 | * Returns 0 on success or a negative errno code otherwise. |
b283e92a | 680 | */ |
7938f421 | 681 | int drm_gem_dmabuf_vmap(struct dma_buf *dma_buf, struct iosys_map *map) |
b283e92a DV |
682 | { |
683 | struct drm_gem_object *obj = dma_buf->priv; | |
b283e92a | 684 | |
a745fb1c | 685 | return drm_gem_vmap(obj, map); |
b283e92a DV |
686 | } |
687 | EXPORT_SYMBOL(drm_gem_dmabuf_vmap); | |
688 | ||
689 | /** | |
690 | * drm_gem_dmabuf_vunmap - dma_buf vunmap implementation for GEM | |
691 | * @dma_buf: buffer to be unmapped | |
20e76f1a | 692 | * @map: the virtual address of the buffer |
b283e92a DV |
693 | * |
694 | * Releases a kernel virtual mapping. This can be used as the | |
805dc614 | 695 | * &dma_buf_ops.vunmap callback. Calls into &drm_gem_object_funcs.vunmap for device specific handling. |
b283e92a | 696 | */ |
7938f421 | 697 | void drm_gem_dmabuf_vunmap(struct dma_buf *dma_buf, struct iosys_map *map) |
b283e92a DV |
698 | { |
699 | struct drm_gem_object *obj = dma_buf->priv; | |
700 | ||
a745fb1c | 701 | drm_gem_vunmap(obj, map); |
b283e92a DV |
702 | } |
703 | EXPORT_SYMBOL(drm_gem_dmabuf_vunmap); | |
704 | ||
705 | /** | |
706 | * drm_gem_prime_mmap - PRIME mmap function for GEM drivers | |
707 | * @obj: GEM object | |
708 | * @vma: Virtual address range | |
709 | * | |
710 | * This function sets up a userspace mapping for PRIME exported buffers using | |
711 | * the same codepath that is used for regular GEM buffer mapping on the DRM fd. | |
712 | * The fake GEM offset is added to vma->vm_pgoff and &drm_driver->fops->mmap is | |
713 | * called to set up the mapping. | |
714 | * | |
715 | * Drivers can use this as their &drm_driver.gem_prime_mmap callback. | |
716 | */ | |
717 | int drm_gem_prime_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma) | |
718 | { | |
719 | struct drm_file *priv; | |
720 | struct file *fil; | |
721 | int ret; | |
722 | ||
e5516553 GH |
723 | /* Add the fake offset */ |
724 | vma->vm_pgoff += drm_vma_node_start(&obj->vma_node); | |
725 | ||
c40069cb | 726 | if (obj->funcs && obj->funcs->mmap) { |
47d35c1c TZ |
727 | vma->vm_ops = obj->funcs->vm_ops; |
728 | ||
8244a3bc | 729 | drm_gem_object_get(obj); |
c40069cb | 730 | ret = obj->funcs->mmap(obj, vma); |
8244a3bc AM |
731 | if (ret) { |
732 | drm_gem_object_put(obj); | |
c40069cb | 733 | return ret; |
8244a3bc | 734 | } |
c40069cb | 735 | vma->vm_private_data = obj; |
c40069cb GH |
736 | return 0; |
737 | } | |
738 | ||
b283e92a DV |
739 | priv = kzalloc(sizeof(*priv), GFP_KERNEL); |
740 | fil = kzalloc(sizeof(*fil), GFP_KERNEL); | |
741 | if (!priv || !fil) { | |
742 | ret = -ENOMEM; | |
743 | goto out; | |
744 | } | |
745 | ||
746 | /* Used by drm_gem_mmap() to lookup the GEM object */ | |
747 | priv->minor = obj->dev->primary; | |
748 | fil->private_data = priv; | |
749 | ||
750 | ret = drm_vma_node_allow(&obj->vma_node, priv); | |
751 | if (ret) | |
752 | goto out; | |
753 | ||
b283e92a DV |
754 | ret = obj->dev->driver->fops->mmap(fil, vma); |
755 | ||
756 | drm_vma_node_revoke(&obj->vma_node, priv); | |
757 | out: | |
758 | kfree(priv); | |
759 | kfree(fil); | |
760 | ||
761 | return ret; | |
762 | } | |
763 | EXPORT_SYMBOL(drm_gem_prime_mmap); | |
764 | ||
765 | /** | |
766 | * drm_gem_dmabuf_mmap - dma_buf mmap implementation for GEM | |
767 | * @dma_buf: buffer to be mapped | |
768 | * @vma: virtual address range | |
769 | * | |
770 | * Provides memory mapping for the buffer. This can be used as the | |
805dc614 DV |
771 | * &dma_buf_ops.mmap callback. It just forwards to &drm_driver.gem_prime_mmap, |
772 | * which should be set to drm_gem_prime_mmap(). | |
773 | * | |
774 | * FIXME: There's really no point to this wrapper, drivers which need anything | |
775 | * else but drm_gem_prime_mmap can roll their own &dma_buf_ops.mmap callback. | |
b283e92a DV |
776 | * |
777 | * Returns 0 on success or a negative error code on failure. | |
778 | */ | |
779 | int drm_gem_dmabuf_mmap(struct dma_buf *dma_buf, struct vm_area_struct *vma) | |
780 | { | |
781 | struct drm_gem_object *obj = dma_buf->priv; | |
782 | struct drm_device *dev = obj->dev; | |
783 | ||
39ce2529 DO |
784 | dma_resv_assert_held(dma_buf->resv); |
785 | ||
b283e92a DV |
786 | if (!dev->driver->gem_prime_mmap) |
787 | return -ENOSYS; | |
788 | ||
789 | return dev->driver->gem_prime_mmap(obj, vma); | |
3248877e | 790 | } |
b283e92a DV |
791 | EXPORT_SYMBOL(drm_gem_dmabuf_mmap); |
792 | ||
793 | static const struct dma_buf_ops drm_gem_prime_dmabuf_ops = { | |
794 | .cache_sgt_mapping = true, | |
795 | .attach = drm_gem_map_attach, | |
796 | .detach = drm_gem_map_detach, | |
797 | .map_dma_buf = drm_gem_map_dma_buf, | |
798 | .unmap_dma_buf = drm_gem_unmap_dma_buf, | |
799 | .release = drm_gem_dmabuf_release, | |
800 | .mmap = drm_gem_dmabuf_mmap, | |
801 | .vmap = drm_gem_dmabuf_vmap, | |
802 | .vunmap = drm_gem_dmabuf_vunmap, | |
803 | }; | |
3248877e | 804 | |
7698799f | 805 | /** |
b283e92a | 806 | * drm_prime_pages_to_sg - converts a page array into an sg list |
7811a339 | 807 | * @dev: DRM device |
b283e92a DV |
808 | * @pages: pointer to the array of page pointers to convert |
809 | * @nr_pages: length of the page vector | |
7698799f | 810 | * |
b283e92a DV |
811 | * This helper creates an sg table object from a set of pages |
812 | * the driver is responsible for mapping the pages into the | |
813 | * importers address space for use with dma_buf itself. | |
805dc614 DV |
814 | * |
815 | * This is useful for implementing &drm_gem_object_funcs.get_sg_table. | |
7698799f | 816 | */ |
707d561f GH |
817 | struct sg_table *drm_prime_pages_to_sg(struct drm_device *dev, |
818 | struct page **pages, unsigned int nr_pages) | |
7698799f | 819 | { |
a1e16bc7 | 820 | struct sg_table *sg; |
707d561f | 821 | size_t max_segment = 0; |
90e7a6de | 822 | int err; |
7698799f | 823 | |
b283e92a | 824 | sg = kmalloc(sizeof(struct sg_table), GFP_KERNEL); |
a1e16bc7 LT |
825 | if (!sg) |
826 | return ERR_PTR(-ENOMEM); | |
10fdb7d2 | 827 | |
707d561f GH |
828 | if (dev) |
829 | max_segment = dma_max_mapping_size(dev->dev); | |
7a60c2dd JG |
830 | if (max_segment == 0) |
831 | max_segment = UINT_MAX; | |
90e7a6de MG |
832 | err = sg_alloc_table_from_pages_segment(sg, pages, nr_pages, 0, |
833 | nr_pages << PAGE_SHIFT, | |
834 | max_segment, GFP_KERNEL); | |
835 | if (err) { | |
a1e16bc7 | 836 | kfree(sg); |
90e7a6de | 837 | sg = ERR_PTR(err); |
10fdb7d2 | 838 | } |
b283e92a | 839 | return sg; |
b283e92a DV |
840 | } |
841 | EXPORT_SYMBOL(drm_prime_pages_to_sg); | |
7698799f | 842 | |
d46e7ae2 MS |
843 | /** |
844 | * drm_prime_get_contiguous_size - returns the contiguous size of the buffer | |
845 | * @sgt: sg_table describing the buffer to check | |
846 | * | |
847 | * This helper calculates the contiguous size in the DMA address space | |
7cd6bb82 | 848 | * of the buffer described by the provided sg_table. |
d46e7ae2 MS |
849 | * |
850 | * This is useful for implementing | |
851 | * &drm_gem_object_funcs.gem_prime_import_sg_table. | |
852 | */ | |
853 | unsigned long drm_prime_get_contiguous_size(struct sg_table *sgt) | |
854 | { | |
855 | dma_addr_t expected = sg_dma_address(sgt->sgl); | |
856 | struct scatterlist *sg; | |
857 | unsigned long size = 0; | |
858 | int i; | |
859 | ||
860 | for_each_sgtable_dma_sg(sgt, sg, i) { | |
861 | unsigned int len = sg_dma_len(sg); | |
862 | ||
863 | if (!len) | |
864 | break; | |
865 | if (sg_dma_address(sg) != expected) | |
866 | break; | |
867 | expected += len; | |
868 | size += len; | |
869 | } | |
870 | return size; | |
871 | } | |
872 | EXPORT_SYMBOL(drm_prime_get_contiguous_size); | |
873 | ||
b283e92a DV |
874 | /** |
875 | * drm_gem_prime_export - helper library implementation of the export callback | |
b283e92a DV |
876 | * @obj: GEM object to export |
877 | * @flags: flags like DRM_CLOEXEC and DRM_RDWR | |
878 | * | |
805dc614 DV |
879 | * This is the implementation of the &drm_gem_object_funcs.export functions for GEM drivers |
880 | * using the PRIME helpers. It is used as the default in | |
881 | * drm_gem_prime_handle_to_fd(). | |
b283e92a | 882 | */ |
e4fa8457 | 883 | struct dma_buf *drm_gem_prime_export(struct drm_gem_object *obj, |
b283e92a DV |
884 | int flags) |
885 | { | |
e4fa8457 | 886 | struct drm_device *dev = obj->dev; |
b283e92a DV |
887 | struct dma_buf_export_info exp_info = { |
888 | .exp_name = KBUILD_MODNAME, /* white lie for debug */ | |
889 | .owner = dev->driver->fops->owner, | |
890 | .ops = &drm_gem_prime_dmabuf_ops, | |
891 | .size = obj->size, | |
892 | .flags = flags, | |
893 | .priv = obj, | |
894 | .resv = obj->resv, | |
895 | }; | |
7698799f | 896 | |
b283e92a | 897 | return drm_gem_dmabuf_export(dev, &exp_info); |
7698799f | 898 | } |
b283e92a | 899 | EXPORT_SYMBOL(drm_gem_prime_export); |
7698799f | 900 | |
39cc344a | 901 | /** |
7e491583 | 902 | * drm_gem_prime_import_dev - core implementation of the import callback |
39cc344a DV |
903 | * @dev: drm_device to import into |
904 | * @dma_buf: dma-buf object to import | |
7e491583 | 905 | * @attach_dev: struct device to dma_buf attach |
39cc344a | 906 | * |
805dc614 DV |
907 | * This is the core of drm_gem_prime_import(). It's designed to be called by |
908 | * drivers who want to use a different device structure than &drm_device.dev for | |
909 | * attaching via dma_buf. This function calls | |
910 | * &drm_driver.gem_prime_import_sg_table internally. | |
911 | * | |
912 | * Drivers must arrange to call drm_prime_gem_destroy() from their | |
913 | * &drm_gem_object_funcs.free hook when using this function. | |
39cc344a | 914 | */ |
7e491583 LA |
915 | struct drm_gem_object *drm_gem_prime_import_dev(struct drm_device *dev, |
916 | struct dma_buf *dma_buf, | |
917 | struct device *attach_dev) | |
89177644 AP |
918 | { |
919 | struct dma_buf_attachment *attach; | |
920 | struct sg_table *sgt; | |
921 | struct drm_gem_object *obj; | |
922 | int ret; | |
923 | ||
89177644 AP |
924 | if (dma_buf->ops == &drm_gem_prime_dmabuf_ops) { |
925 | obj = dma_buf->priv; | |
926 | if (obj->dev == dev) { | |
927 | /* | |
928 | * Importing dmabuf exported from out own gem increases | |
929 | * refcount on gem itself instead of f_count of dmabuf. | |
930 | */ | |
e6b62714 | 931 | drm_gem_object_get(obj); |
89177644 AP |
932 | return obj; |
933 | } | |
934 | } | |
935 | ||
98515035 TF |
936 | if (!dev->driver->gem_prime_import_sg_table) |
937 | return ERR_PTR(-EINVAL); | |
938 | ||
7e491583 | 939 | attach = dma_buf_attach(dma_buf, attach_dev); |
89177644 | 940 | if (IS_ERR(attach)) |
f2a5da4f | 941 | return ERR_CAST(attach); |
89177644 | 942 | |
011c2282 ID |
943 | get_dma_buf(dma_buf); |
944 | ||
ac530e0b | 945 | sgt = dma_buf_map_attachment_unlocked(attach, DMA_BIDIRECTIONAL); |
fee0c54e | 946 | if (IS_ERR(sgt)) { |
89177644 AP |
947 | ret = PTR_ERR(sgt); |
948 | goto fail_detach; | |
949 | } | |
950 | ||
b5e9c1a2 | 951 | obj = dev->driver->gem_prime_import_sg_table(dev, attach, sgt); |
89177644 AP |
952 | if (IS_ERR(obj)) { |
953 | ret = PTR_ERR(obj); | |
954 | goto fail_unmap; | |
955 | } | |
956 | ||
957 | obj->import_attach = attach; | |
5f6ed987 | 958 | obj->resv = dma_buf->resv; |
89177644 AP |
959 | |
960 | return obj; | |
961 | ||
962 | fail_unmap: | |
ac530e0b | 963 | dma_buf_unmap_attachment_unlocked(attach, sgt, DMA_BIDIRECTIONAL); |
89177644 AP |
964 | fail_detach: |
965 | dma_buf_detach(dma_buf, attach); | |
011c2282 ID |
966 | dma_buf_put(dma_buf); |
967 | ||
89177644 AP |
968 | return ERR_PTR(ret); |
969 | } | |
7e491583 LA |
970 | EXPORT_SYMBOL(drm_gem_prime_import_dev); |
971 | ||
972 | /** | |
973 | * drm_gem_prime_import - helper library implementation of the import callback | |
974 | * @dev: drm_device to import into | |
975 | * @dma_buf: dma-buf object to import | |
976 | * | |
977 | * This is the implementation of the gem_prime_import functions for GEM drivers | |
805dc614 DV |
978 | * using the PRIME helpers. Drivers can use this as their |
979 | * &drm_driver.gem_prime_import implementation. It is used as the default | |
980 | * implementation in drm_gem_prime_fd_to_handle(). | |
981 | * | |
982 | * Drivers must arrange to call drm_prime_gem_destroy() from their | |
983 | * &drm_gem_object_funcs.free hook when using this function. | |
7e491583 LA |
984 | */ |
985 | struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev, | |
986 | struct dma_buf *dma_buf) | |
987 | { | |
988 | return drm_gem_prime_import_dev(dev, dma_buf, dev->dev); | |
989 | } | |
89177644 AP |
990 | EXPORT_SYMBOL(drm_gem_prime_import); |
991 | ||
39cc344a | 992 | /** |
c67e6279 | 993 | * drm_prime_sg_to_page_array - convert an sg table into a page array |
39cc344a | 994 | * @sgt: scatter-gather table to convert |
c67e6279 CK |
995 | * @pages: array of page pointers to store the pages in |
996 | * @max_entries: size of the passed-in array | |
997 | * | |
998 | * Exports an sg table into an array of pages. | |
999 | * | |
1000 | * This function is deprecated and strongly discouraged to be used. | |
1001 | * The page array is only useful for page faults and those can corrupt fields | |
1002 | * in the struct page if they are not handled by the exporting driver. | |
1003 | */ | |
1004 | int __deprecated drm_prime_sg_to_page_array(struct sg_table *sgt, | |
1005 | struct page **pages, | |
1006 | int max_entries) | |
1007 | { | |
1008 | struct sg_page_iter page_iter; | |
1009 | struct page **p = pages; | |
1010 | ||
1011 | for_each_sgtable_page(sgt, &page_iter, 0) { | |
1012 | if (WARN_ON(p - pages >= max_entries)) | |
1013 | return -1; | |
1014 | *p++ = sg_page_iter_page(&page_iter); | |
1015 | } | |
1016 | return 0; | |
1017 | } | |
1018 | EXPORT_SYMBOL(drm_prime_sg_to_page_array); | |
1019 | ||
1020 | /** | |
1021 | * drm_prime_sg_to_dma_addr_array - convert an sg table into a dma addr array | |
1022 | * @sgt: scatter-gather table to convert | |
1023 | * @addrs: array to store the dma bus address of each page | |
186ca446 | 1024 | * @max_entries: size of both the passed-in arrays |
39cc344a | 1025 | * |
c67e6279 | 1026 | * Exports an sg table into an array of addresses. |
805dc614 | 1027 | * |
c67e6279 | 1028 | * Drivers should use this in their &drm_driver.gem_prime_import_sg_table |
805dc614 | 1029 | * implementation. |
39cc344a | 1030 | */ |
c67e6279 CK |
1031 | int drm_prime_sg_to_dma_addr_array(struct sg_table *sgt, dma_addr_t *addrs, |
1032 | int max_entries) | |
51ab7ba2 | 1033 | { |
0552daac | 1034 | struct sg_dma_page_iter dma_iter; |
0552daac MS |
1035 | dma_addr_t *a = addrs; |
1036 | ||
c67e6279 CK |
1037 | for_each_sgtable_dma_page(sgt, &dma_iter, 0) { |
1038 | if (WARN_ON(a - addrs >= max_entries)) | |
1039 | return -1; | |
1040 | *a++ = sg_page_iter_dma_address(&dma_iter); | |
51ab7ba2 DA |
1041 | } |
1042 | return 0; | |
1043 | } | |
c67e6279 | 1044 | EXPORT_SYMBOL(drm_prime_sg_to_dma_addr_array); |
39cc344a DV |
1045 | |
1046 | /** | |
1047 | * drm_prime_gem_destroy - helper to clean up a PRIME-imported GEM object | |
1048 | * @obj: GEM object which was created from a dma-buf | |
1049 | * @sg: the sg-table which was pinned at import time | |
1050 | * | |
1051 | * This is the cleanup functions which GEM drivers need to call when they use | |
805dc614 | 1052 | * drm_gem_prime_import() or drm_gem_prime_import_dev() to import dma-bufs. |
39cc344a | 1053 | */ |
3248877e DA |
1054 | void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg) |
1055 | { | |
1056 | struct dma_buf_attachment *attach; | |
1057 | struct dma_buf *dma_buf; | |
948de842 | 1058 | |
3248877e DA |
1059 | attach = obj->import_attach; |
1060 | if (sg) | |
ac530e0b | 1061 | dma_buf_unmap_attachment_unlocked(attach, sg, DMA_BIDIRECTIONAL); |
3248877e DA |
1062 | dma_buf = attach->dmabuf; |
1063 | dma_buf_detach(attach->dmabuf, attach); | |
1064 | /* remove the reference */ | |
1065 | dma_buf_put(dma_buf); | |
1066 | } | |
1067 | EXPORT_SYMBOL(drm_prime_gem_destroy); |