diff options
| author | Gustavo Padovan <gustavo.padovan@collabora.co.uk> | 2016-08-05 16:39:37 +0300 |
|---|---|---|
| committer | Sumit Semwal <sumit.semwal@linaro.org> | 2016-08-11 13:03:24 +0300 |
| commit | 395dec6f6bc53277bc2b034c7a232ae0c51141b7 (patch) | |
| tree | 0b17fa477909f702563671242c91a82c6353afc1 | |
| parent | 972526a4093243fdaf77dd7c6f8b11fba5b15864 (diff) | |
| download | linux-395dec6f6bc53277bc2b034c7a232ae0c51141b7.tar.xz | |
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: Gustavo Padovan <gustavo.padovan@collabora.co.uk>
Acked-by: Christian König <christian.koenig@amd.com>
Reviewed-by: Chris Wilson <chris@chris-wilson.co.uk>
Signed-off-by: Sumit Semwal <sumit.semwal@linaro.org>
| -rw-r--r-- | Documentation/sync_file.txt | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/Documentation/sync_file.txt b/Documentation/sync_file.txt index e8e2ebafe5fa..b63a68531afd 100644 --- a/Documentation/sync_file.txt +++ b/Documentation/sync_file.txt @@ -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 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: [1] struct sync_file in include/linux/sync_file.h [2] All interfaces mentioned above defined in include/linux/sync_file.h |