kernel_samsung_a34x-permissive/drivers/gpu/drm/mediatek/mtk_sync.h
2024-04-28 15:51:13 +02:00

121 lines
3.1 KiB
C

/* SPDX-License-Identifier: GPL-2.0 */
/*
* Copyright (c) 2019 MediaTek Inc.
*/
#ifndef _MTK_SYNC_H
#define _MTK_SYNC_H
/*
* TIMEOUT_NEVER may be passed to the wait method to indicate that it
* should wait indefinitely for the fence to signal.
*/
#define TIMEOUT_NEVER -1
/* ---------------------------------------------------------------------------
*/
#ifdef __KERNEL__
#include <linux/version.h>
#include <linux/dma-fence.h>
/**
* struct sync_timeline - sync object
* @kref: reference count on fence.
* @name: name of the sync_timeline. Useful for debugging
* @lock: lock protecting @pt_list and @value
* @pt_tree: rbtree of active (unsignaled/errored) sync_pts
* @pt_list: list of active (unsignaled/errored) sync_pts
* @sync_timeline_list: membership in global sync_timeline_list
*/
struct sync_timeline {
struct kref kref;
char name[32];
/* protected by lock */
u64 context;
int value;
struct rb_root pt_tree;
struct list_head pt_list;
spinlock_t lock;
struct list_head sync_timeline_list;
};
/**
* struct sync_pt - sync_pt object
* @base: base fence object
* @link: link on the sync timeline's list
* @node: node in the sync timeline's tree
*/
struct sync_pt {
struct dma_fence base;
struct list_head link;
struct rb_node node;
};
/*
* sync_timeline, sync_fence data structure
*/
struct fence_data {
__u32 value;
char name[32];
__s32 fence; /* fd of new fence */
};
/*
* sync_timeline, sync_fence API
*/
/**
* mtk_sync_timeline_create() - creates a sync object
* @name: sync_timeline name
*
* The mtk_sync_timeline_create() function creates a sync object named @name,
* which represents a 32-bit monotonically increasing counter.
*/
struct sync_timeline *mtk_sync_timeline_create(const char *name);
/**
* mtk_sync_timeline_destroy() - releases a sync object
* @obj: sync_timeline obj
*
* The mtk_sync_timeline_destroy() function releases a sync object.
* The remaining active points would be put into signaled list,
* and their statuses are set to VENOENT.
*/
void mtk_sync_timeline_destroy(struct sync_timeline *obj);
/**
* mtk_sync_timeline_inc() - increases timeline
* @obj: sync_timeline obj
* @value: the increment to a sync object
* @time: siganl at the time if not 0
*
* The mtk_sync_timeline_inc() function increase the counter of @obj by @value
* Each sync point contains a value. A sync point on a parent timeline transits
* from active to signaled status when the counter of a timeline reaches
* to that of a sync point.
*/
void mtk_sync_timeline_inc(struct sync_timeline *obj, u32 value, ktime_t time);
/**
* mtk_sync_fence_create() - create a fence
* @obj: sync_timeline obj
* @data: fence struct with its name and the number a sync point bears
*
* The mtk_sync_fence_create() function creates a new sync point with
* @data->value,
* and assign the sync point to a newly created fence named @data->name.
* A file descriptor binded with the fence is stored in @data->fence.
*/
int mtk_sync_fence_create(struct sync_timeline *obj, struct fence_data *data);
#endif /* __KERNEL __ */
#endif /* _MTK_SYNC_H */