Documentation/driver-api/sync_file.rst

8 sync_file API is, and how drivers can support it. Sync file is the carrier of
12 The sync_file API is meant to be used to send and receive fence information
15 driver) sends the fence related to the buffer to userspace via a sync_file.
17 The sync_file then can be sent to the consumer (DRM driver for example), that
32 Sync files can go either to or from userspace. When a sync_file is sent from
39 On the other hand if the driver receives fence(s) through a sync_file from
47 When a driver needs to send an out-fence userspace it creates a sync_file.
51 	struct sync_file *sync_file_create(struct dma_fence *fence);
53 The caller pass the out-fence and gets back the sync_file. That is just the
54 first step, next it needs to install an fd on sync_file->file. So it gets an
59 and installs it on sync_file->file::
61 	fd_install(fd, sync_file->file);
63 The sync_file fd now can be sent to userspace.
65 If the creation process fail, or the sync_file needs to be released by any
66 other reason fput(sync_file->file) should be used.
85 1. struct sync_file in include/linux/sync_file.h
86 2. All interfaces mentioned above defined in include/linux/sync_file.h