[linux-2.6-block.git] / drivers / gpu / drm / i915 / i915_sw_fence.h

/*
 * SPDX-License-Identifier: MIT
 *
 * i915_sw_fence.h - library routines for N:M synchronisation points
 *
 * Copyright (C) 2016 Intel Corporation
 */

#ifndef _I915_SW_FENCE_H_
#define _I915_SW_FENCE_H_

#include <linux/dma-fence.h>
#include <linux/gfp.h>
#include <linux/kref.h>
#include <linux/notifier.h> /* for NOTIFY_DONE */
#include <linux/wait.h>

struct completion;
struct reservation_object;

struct i915_sw_fence {
	wait_queue_head_t wait;
	unsigned long flags;
	atomic_t pending;
};

#define I915_SW_FENCE_CHECKED_BIT	0 /* used internally for DAG checking */
#define I915_SW_FENCE_PRIVATE_BIT	1 /* available for use by owner */
#define I915_SW_FENCE_MASK		(~3)

enum i915_sw_fence_notify {
	FENCE_COMPLETE,
	FENCE_FREE
};

typedef int (*i915_sw_fence_notify_t)(struct i915_sw_fence *,
				      enum i915_sw_fence_notify state);
#define __i915_sw_fence_call __aligned(4)

void __i915_sw_fence_init(struct i915_sw_fence *fence,
			  i915_sw_fence_notify_t fn,
			  const char *name,
			  struct lock_class_key *key);
#ifdef CONFIG_LOCKDEP
#define i915_sw_fence_init(fence, fn)				\
do {								\
	static struct lock_class_key __key;			\
								\
	__i915_sw_fence_init((fence), (fn), #fence, &__key);	\
} while (0)
#else
#define i915_sw_fence_init(fence, fn)				\
	__i915_sw_fence_init((fence), (fn), NULL, NULL)
#endif

#ifdef CONFIG_DRM_I915_SW_FENCE_DEBUG_OBJECTS
void i915_sw_fence_fini(struct i915_sw_fence *fence);
#else
static inline void i915_sw_fence_fini(struct i915_sw_fence *fence) {}
#endif

void i915_sw_fence_commit(struct i915_sw_fence *fence);

int i915_sw_fence_await_sw_fence(struct i915_sw_fence *fence,
				 struct i915_sw_fence *after,
				 wait_queue_entry_t *wq);
int i915_sw_fence_await_sw_fence_gfp(struct i915_sw_fence *fence,
				     struct i915_sw_fence *after,
				     gfp_t gfp);

struct i915_sw_dma_fence_cb {
	struct dma_fence_cb base;
	struct i915_sw_fence *fence;
};

int __i915_sw_fence_await_dma_fence(struct i915_sw_fence *fence,
				    struct dma_fence *dma,
				    struct i915_sw_dma_fence_cb *cb);
int i915_sw_fence_await_dma_fence(struct i915_sw_fence *fence,
				  struct dma_fence *dma,
				  unsigned long timeout,
				  gfp_t gfp);

int i915_sw_fence_await_reservation(struct i915_sw_fence *fence,
				    struct reservation_object *resv,
				    const struct dma_fence_ops *exclude,
				    bool write,
				    unsigned long timeout,
				    gfp_t gfp);

void i915_sw_fence_await(struct i915_sw_fence *fence);
void i915_sw_fence_complete(struct i915_sw_fence *fence);

static inline bool i915_sw_fence_signaled(const struct i915_sw_fence *fence)
{
	return atomic_read(&fence->pending) <= 0;
}

static inline bool i915_sw_fence_done(const struct i915_sw_fence *fence)
{
	return atomic_read(&fence->pending) < 0;
}

static inline void i915_sw_fence_wait(struct i915_sw_fence *fence)
{
	wait_event(fence->wait, i915_sw_fence_done(fence));
}

#endif /* _I915_SW_FENCE_H_ */
Commit	Line	Data
e68a139f	1	/*
635b3bc6 JG	2	* SPDX-License-Identifier: MIT
635b3bc6 JG	3	*
e68a139f CW	4	* i915_sw_fence.h - library routines for N:M synchronisation points
	5	*
	6	* Copyright (C) 2016 Intel Corporation
e68a139f CW	7	*/
	8
	9	#ifndef _I915_SW_FENCE_H_
	10	#define _I915_SW_FENCE_H_
	11
ea593dbb	12	#include <linux/dma-fence.h>
e68a139f CW	13	#include <linux/gfp.h>
	14	#include <linux/kref.h>
	15	#include <linux/notifier.h> /* for NOTIFY_DONE */
	16	#include <linux/wait.h>
	17
	18	struct completion;
e68a139f CW	19	struct reservation_object;
	20
	21	struct i915_sw_fence {
	22	wait_queue_head_t wait;
	23	unsigned long flags;
e68a139f CW	24	atomic_t pending;
	25	};
	26
	27	#define I915_SW_FENCE_CHECKED_BIT 0 /* used internally for DAG checking */
	28	#define I915_SW_FENCE_PRIVATE_BIT 1 /* available for use by owner */
	29	#define I915_SW_FENCE_MASK (~3)
	30
	31	enum i915_sw_fence_notify {
	32	FENCE_COMPLETE,
	33	FENCE_FREE
	34	};
	35
	36	typedef int (i915_sw_fence_notify_t)(struct i915_sw_fence ,
	37	enum i915_sw_fence_notify state);
	38	#define __i915_sw_fence_call __aligned(4)
	39
556b7487 CW	40	void __i915_sw_fence_init(struct i915_sw_fence *fence,
	41	i915_sw_fence_notify_t fn,
	42	const char *name,
	43	struct lock_class_key *key);
	44	#ifdef CONFIG_LOCKDEP
	45	#define i915_sw_fence_init(fence, fn) \
	46	do { \
	47	static struct lock_class_key __key; \
	48	\
	49	__i915_sw_fence_init((fence), (fn), #fence, &__key); \
	50	} while (0)
	51	#else
	52	#define i915_sw_fence_init(fence, fn) \
	53	__i915_sw_fence_init((fence), (fn), NULL, NULL)
	54	#endif
	55
fc158405 CW	56	#ifdef CONFIG_DRM_I915_SW_FENCE_DEBUG_OBJECTS
	57	void i915_sw_fence_fini(struct i915_sw_fence *fence);
	58	#else
	59	static inline void i915_sw_fence_fini(struct i915_sw_fence *fence) {}
	60	#endif
	61
e68a139f CW	62	void i915_sw_fence_commit(struct i915_sw_fence *fence);
	63
	64	int i915_sw_fence_await_sw_fence(struct i915_sw_fence *fence,
	65	struct i915_sw_fence *after,
ac6424b9	66	wait_queue_entry_t *wq);
7e941861 CW	67	int i915_sw_fence_await_sw_fence_gfp(struct i915_sw_fence *fence,
	68	struct i915_sw_fence *after,
	69	gfp_t gfp);
ea593dbb CW	70
	71	struct i915_sw_dma_fence_cb {
	72	struct dma_fence_cb base;
	73	struct i915_sw_fence *fence;
	74	};
	75
	76	int __i915_sw_fence_await_dma_fence(struct i915_sw_fence *fence,
	77	struct dma_fence *dma,
	78	struct i915_sw_dma_fence_cb *cb);
e68a139f	79	int i915_sw_fence_await_dma_fence(struct i915_sw_fence *fence,
f54d1867	80	struct dma_fence *dma,
e68a139f CW	81	unsigned long timeout,
e68a139f CW	82	gfp_t gfp);
ea593dbb	83
e68a139f CW	84	int i915_sw_fence_await_reservation(struct i915_sw_fence *fence,
e68a139f CW	85	struct reservation_object *resv,
f54d1867	86	const struct dma_fence_ops *exclude,
e68a139f CW	87	bool write,
	88	unsigned long timeout,
	89	gfp_t gfp);
	90
e8861964 CW	91	void i915_sw_fence_await(struct i915_sw_fence *fence);
	92	void i915_sw_fence_complete(struct i915_sw_fence *fence);
	93
48bc2a4a CW	94	static inline bool i915_sw_fence_signaled(const struct i915_sw_fence *fence)
	95	{
	96	return atomic_read(&fence->pending) <= 0;
	97	}
	98
e68a139f CW	99	static inline bool i915_sw_fence_done(const struct i915_sw_fence *fence)
	100	{
	101	return atomic_read(&fence->pending) < 0;
	102	}
	103
7e941861 CW	104	static inline void i915_sw_fence_wait(struct i915_sw_fence *fence)
	105	{
	106	wait_event(fence->wait, i915_sw_fence_done(fence));
	107	}
	108
e68a139f	109	#endif /* _I915_SW_FENCE_H_ */