Commit 395dec6f authored by Gustavo Padovan's avatar Gustavo Padovan Committed by Sumit Semwal

Documentation: add doc for sync_file_get_fence()

Document the new function added to sync_file.c

v2: Adapt to fence_array

v3: Take in Chris Wilson suggestions
Signed-off-by: default avatarGustavo Padovan <gustavo.padovan@collabora.co.uk>
Acked-by: default avatarChristian König <christian.koenig@amd.com>
Reviewed-by: default avatarChris Wilson <chris@chris-wilson.co.uk>
Signed-off-by: default avatarSumit Semwal <sumit.semwal@linaro.org>
parent 972526a4
...@@ -64,6 +64,20 @@ The sync_file fd now can be sent to userspace. ...@@ -64,6 +64,20 @@ The sync_file fd now can be sent to userspace.
If the creation process fail, or the sync_file needs to be released by any If the creation process fail, or the sync_file needs to be released by any
other reason fput(sync_file->file) should be used. other reason fput(sync_file->file) should be used.
Receiving Sync Files from Userspace
-----------------------------------
When userspace needs to send an in-fence to the driver it passes file descriptor
of the Sync File to the kernel. The kernel can then retrieve the fences
from it.
Interface:
struct fence *sync_file_get_fence(int fd);
The returned reference is owned by the caller and must be disposed of
afterwards using fence_put(). In case of error, a NULL is returned instead.
References: References:
[1] struct sync_file in include/linux/sync_file.h [1] struct sync_file in include/linux/sync_file.h
[2] All interfaces mentioned above defined in include/linux/sync_file.h [2] All interfaces mentioned above defined in include/linux/sync_file.h
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment