[mirror_ubuntu-bionic-kernel.git] / include / linux / sync_file.h

/*
 * include/linux/sync_file.h
 *
 * Copyright (C) 2012 Google, Inc.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 */

#ifndef _LINUX_SYNC_FILE_H
#define _LINUX_SYNC_FILE_H

#include <linux/types.h>
#include <linux/ktime.h>
#include <linux/list.h>
#include <linux/spinlock.h>
#include <linux/dma-fence.h>
#include <linux/dma-fence-array.h>

/**
 * struct sync_file - sync file to export to the userspace
 * @file:		file representing this fence
 * @sync_file_list:	membership in global file list
 * @wq:			wait queue for fence signaling
 * @flags:		flags for the sync_file
 * @fence:		fence with the fences in the sync_file
 * @cb:			fence callback information
 *
 * flags:
 * POLL_ENABLED: whether userspace is currently poll()'ing or not
 */
struct sync_file {
	struct file		*file;
	/**
	 * @user_name:
	 *
	 * Name of the sync file provided by userspace, for merged fences.
	 * Otherwise generated through driver callbacks (in which case the
	 * entire array is 0).
	 */
	char			user_name[32];
#ifdef CONFIG_DEBUG_FS
	struct list_head	sync_file_list;
#endif

	wait_queue_head_t	wq;
	unsigned long		flags;

	struct dma_fence	*fence;
	struct dma_fence_cb cb;
};

#define POLL_ENABLED 0

struct sync_file *sync_file_create(struct dma_fence *fence);
struct dma_fence *sync_file_get_fence(int fd);
char *sync_file_get_name(struct sync_file *sync_file, char *buf, int len);

#endif /* _LINUX_SYNC_H */
Commit	Line	Data
d4cab38e GP	1	/*
	2	* include/linux/sync_file.h
	3	*
	4	* Copyright (C) 2012 Google, Inc.
	5	*
	6	* This program is distributed in the hope that it will be useful,
	7	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	8	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	9	* GNU General Public License for more details.
	10	*
	11	*/
	12
	13	#ifndef _LINUX_SYNC_FILE_H
	14	#define _LINUX_SYNC_FILE_H
	15
	16	#include <linux/types.h>
d4cab38e GP	17	#include <linux/ktime.h>
	18	#include <linux/list.h>
	19	#include <linux/spinlock.h>
f54d1867 CW	20	#include <linux/dma-fence.h>
f54d1867 CW	21	#include <linux/dma-fence-array.h>
d4cab38e GP	22
	23	/**
	24	* struct sync_file - sync file to export to the userspace
	25	* @file: file representing this fence
d4cab38e	26	* @sync_file_list: membership in global file list
d4cab38e	27	* @wq: wait queue for fence signaling
300238ce	28	* @flags: flags for the sync_file
a02b9dc9 GP	29	* @fence: fence with the fences in the sync_file
a02b9dc9 GP	30	* @cb: fence callback information
300238ce GP	31	*
	32	* flags:
	33	* POLL_ENABLED: whether userspace is currently poll()'ing or not
d4cab38e GP	34	*/
	35	struct sync_file {
	36	struct file *file;
71ebc9a3 CW	37	/**
	38	* @user_name:
	39	*
	40	* Name of the sync file provided by userspace, for merged fences.
	41	* Otherwise generated through driver callbacks (in which case the
	42	* entire array is 0).
	43	*/
	44	char user_name[32];
d4cab38e GP	45	#ifdef CONFIG_DEBUG_FS
	46	struct list_head sync_file_list;
	47	#endif
d4cab38e GP	48
d4cab38e GP	49	wait_queue_head_t wq;
db1fc97c	50	unsigned long flags;
d4cab38e	51
f54d1867 CW	52	struct dma_fence *fence;
f54d1867 CW	53	struct dma_fence_cb cb;
d4cab38e GP	54	};
d4cab38e GP	55
db1fc97c	56	#define POLL_ENABLED 0
e2416553	57
f54d1867 CW	58	struct sync_file sync_file_create(struct dma_fence fence);
f54d1867 CW	59	struct dma_fence *sync_file_get_fence(int fd);
71ebc9a3	60	char sync_file_get_name(struct sync_file sync_file, char *buf, int len);
d4cab38e GP	61
d4cab38e GP	62	#endif /* _LINUX_SYNC_H */