Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit c16f291d authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab Committed by Gustavo Padovan
Browse files

sync_file.txt: standardize document format 



Each text file under Documentation follows a different
format. Some doesn't even have titles!

Change its representation to follow the adopted standard,
using ReST markups for it to be parseable by Sphinx:
- Use markup for document title and authorship;
- Mark literal blocks;
- Use a numbered list for references.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: default avatarGustavo Padovan <gustavo.padovan@collabora.com>
Link: http://patchwork.freedesktop.org/patch/msgid/e781f61e582e7c7eb5de456608043aff9fe2b2b5.1495157082.git.mchehab@s-opensource.com
parent 7fcd0750

Documentation/sync_file.txt

+13 −10
Original line number Original line Diff line number Diff line 
===================

Sync File API Guide

Sync File API Guide

			      ~~~~~~~~~~~~~~~~~~~

===================





				Gustavo Padovan

:Author: Gustavo Padovan <gustavo at padovan dot org>

			  <gustavo at padovan dot org>





This document serves as a guide for device drivers writers on what the

This document serves as a guide for device drivers writers on what the

sync_file API is, and how drivers can support it. Sync file is the carrier of

sync_file API is, and how drivers can support it. Sync file is the carrier of
@@ -46,16 +46,17 @@ Creating Sync Files 




When a driver needs to send an out-fence userspace it creates a sync_file.

When a driver needs to send an out-fence userspace it creates a sync_file.





Interface:

Interface::



	struct sync_file *sync_file_create(struct dma_fence *fence);

	struct sync_file *sync_file_create(struct dma_fence *fence);





The caller pass the out-fence and gets back the sync_file. That is just the

The caller pass the out-fence and gets back the sync_file. That is just the

first step, next it needs to install an fd on sync_file->file. So it gets an

first step, next it needs to install an fd on sync_file->file. So it gets an

fd:

fd::





	fd = get_unused_fd_flags(O_CLOEXEC);

	fd = get_unused_fd_flags(O_CLOEXEC);





and installs it on sync_file->file:

and installs it on sync_file->file::





	fd_install(fd, sync_file->file);

	fd_install(fd, sync_file->file);
@@ -71,7 +72,8 @@ 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

of the Sync File to the kernel. The kernel can then retrieve the fences

from it.

from it.





Interface:

Interface::



	struct dma_fence *sync_file_get_fence(int fd);

	struct dma_fence *sync_file_get_fence(int fd);
@@ -79,5 +81,6 @@ The returned reference is owned by the caller and must be disposed of 
afterwards using dma_fence_put(). In case of error, a NULL is returned instead.

afterwards using dma_fence_put(). In case of error, a NULL is returned instead.





References:

References:

[1] struct sync_file in include/linux/sync_file.h



[2] All interfaces mentioned above defined 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