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