Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]


Groups > linux.kernel > #1457105

[PATCH v6 4/5] Documentation: add doc for sync_file_get_fence()

From Gustavo Padovan <gustavo@padovan.org>
Newsgroups linux.kernel
Subject [PATCH v6 4/5] Documentation: add doc for sync_file_get_fence()
Date 2016-08-05 15:50 +0200
Message-ID <s2NFD-8dj-19@gated-at.bofh.it> (permalink)
References <s2NvX-89z-1@gated-at.bofh.it>
Organization linux.* mail to news gateway

Show all headers | View raw


From: Gustavo Padovan <gustavo.padovan@collabora.co.uk>

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>
---
 Documentation/sync_file.txt | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/Documentation/sync_file.txt b/Documentation/sync_file.txt
index e8e2eba..b63a685 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
-- 
2.5.5

Back to linux.kernel | Previous | NextPrevious in thread | Next in thread | Find similar | Unroll thread


Thread

[PATCH v6 1/5] dma-buf/fence-array: add fence_is_array() Gustavo Padovan <gustavo@padovan.org> - 2016-08-05 15:40 +0200
  [PATCH v6 2/5] dma-buf/sync_file: refactor fence storage in struct sync_file Gustavo Padovan <gustavo@padovan.org> - 2016-08-05 15:50 +0200
  [PATCH v6 5/5] dma-buf/sync_file: only enable fence signalling on poll() Gustavo Padovan <gustavo@padovan.org> - 2016-08-05 15:50 +0200
  [PATCH v6 4/5] Documentation: add doc for sync_file_get_fence() Gustavo Padovan <gustavo@padovan.org> - 2016-08-05 15:50 +0200
  [PATCH v6 3/5] dma-buf/sync_file: add sync_file_get_fence() Gustavo Padovan <gustavo@padovan.org> - 2016-08-05 15:50 +0200

csiph-web