aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGustavo Padovan <gustavo.padovan@collabora.co.uk>2016-04-28 10:46:55 -0300
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>2016-04-29 17:37:10 -0700
commitc240a714a6ad68458c3caf61ab6216184e52b631 (patch)
treee6834fc9289e2082fd12ae2b6f0f1ffa0685ffbc
parentd4cab38e153d62ecd502645390c0289c1b8337df (diff)
staging/android: improve documentation for sync_file
num_fences was missing a colon mark and sync_file_create() now have better description. Signed-off-by: Gustavo Padovan <gustavo.padovan@collabora.co.uk> Reviewed-by: Daniel Vetter <daniel.vetter@ffwll.ch> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
-rw-r--r--drivers/staging/android/sync_file.c5
-rw-r--r--drivers/staging/android/sync_file.h2
2 files changed, 4 insertions, 3 deletions
diff --git a/drivers/staging/android/sync_file.c b/drivers/staging/android/sync_file.c
index 2c724ec..d9da3a4 100644
--- a/drivers/staging/android/sync_file.c
+++ b/drivers/staging/android/sync_file.c
@@ -65,11 +65,12 @@ static void fence_check_cb_func(struct fence *f, struct fence_cb *cb)
}
/**
- * sync_fence_create() - creates a sync fence
+ * sync_file_create() - creates a sync file
* @fence: fence to add to the sync_fence
*
* Creates a sync_file containg @fence. Once this is called, the sync_file
- * takes ownership of @fence.
+ * takes ownership of @fence. The sync_file can be released with
+ * fput(sync_file->file). Returns the sync_file or NULL in case of error.
*/
struct sync_file *sync_file_create(struct fence *fence)
{
diff --git a/drivers/staging/android/sync_file.h b/drivers/staging/android/sync_file.h
index 8a1b546..c6ffe8b 100644
--- a/drivers/staging/android/sync_file.h
+++ b/drivers/staging/android/sync_file.h
@@ -32,7 +32,7 @@ struct sync_file_cb {
* @kref: reference count on fence.
* @name: name of sync_file. Useful for debugging
* @sync_file_list: membership in global file list
- * @num_fences number of sync_pts in the fence
+ * @num_fences: number of sync_pts in the fence
* @wq: wait queue for fence signaling
* @status: 0: signaled, >0:active, <0: error
* @cbs: sync_pts callback information