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

Path	csiph.com!news.mixmin.net!aioe.org!bofh.it!news.nic.it!robomod
From	Gustavo Padovan <gustavo@padovan.org>
Newsgroups	linux.kernel
Subject	[PATCH v6 4/5] Documentation: add doc for sync_file_get_fence()
Date	Fri, 05 Aug 2016 15:50:01 +0200
Message-ID	<s2NFD-8dj-19@gated-at.bofh.it> (permalink)
References	<s2NvX-89z-1@gated-at.bofh.it>
X-Google-Dkim-Signature	v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=Ii9aPly7AC/7P3THMMVjrLHVwva5cpowpXtmq0hMtHc=; b=GPuYA9gimJ107/mRaP+IwkvcqiLNQxy3iqW8vXunPFkqKQCtsFRa+H/6PAPZgBr6ct Ef6ILO7WQ5pUbhxQav/k+GseIWMs399K8qnChtEvkjm0/LDRU71QTBNELHIV5FDMFbNy OV6vi7eDCBV5OfkCqgnp5nq8maId9njzdvo/WBtJeqNuj0xETift7AEgWbX3Twzm6EAp xoktVG3iLdNbEimnsR5xuBQv7DK8ijM0qJENbYAiXRfGi9QZBA80MEzjoMhIzZdA/HWU GPNfjROVdbqICSxhT/3rf7ed4sRSFKTMLPms1vcs7hqcSJjaXeU1wuT15PSNPZmjTWhA asWw==
X-Gm-Message-State	AEkoousVAJOyoJzVsxBPD/7vJeAhNv6L1fL+EumHBdolNCbbWFZAWawlclCctz4pVtbwYQ==
X-Received	by 10.37.209.86 with SMTP id i83mr1112150ybg.40.1470404407211; Fri, 05 Aug 2016 06:40:07 -0700 (PDT)
X-Mailer	git-send-email 2.5.5
MIME-Version	1.0
Content-Type	text/plain; charset=UTF-8
Content-Transfer-Encoding	8bit
Sender	robomod@news.nic.it
List-ID	<linux-kernel.vger.kernel.org>
X-Mailing-List	linux-kernel@vger.kernel.org
Approved	robomod@news.nic.it
Lines	42
Organization	linux.* mail to news gateway
X-Original-Cc	linux-kernel@vger.kernel.org, Daniel Stone <daniels@collabora.com>, Daniel Vetter <daniel.vetter@ffwll.ch>, Rob Clark <robdclark@gmail.com>, Greg Hackmann <ghackmann@google.com>, John Harrison <John.C.Harrison@Intel.com>, laurent.pinchart@ideasonboard.com, seanpaul@google.com, marcheu@google.com, m.chehab@samsung.com, Sumit Semwal <sumit.semwal@linaro.org>, Maarten Lankhorst <maarten.lankhorst@linux.intel.com>, Gustavo Padovan <gustavo.padovan@collabora.co.uk>
X-Original-Date	Fri, 5 Aug 2016 10:39:37 -0300
X-Original-Message-ID	<1470404378-27961-4-git-send-email-gustavo@padovan.org>
X-Original-References	<1470404378-27961-1-git-send-email-gustavo@padovan.org>
X-Original-Sender	linux-kernel-owner@vger.kernel.org
Xref	csiph.com linux.kernel:1457105

Show key headers only | 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

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