2 * SPDX-License-Identifier: MIT
4 * i915_sw_fence.h - library routines for N:M synchronisation points
6 * Copyright (C) 2016 Intel Corporation
9 #ifndef _I915_SW_FENCE_H_
10 #define _I915_SW_FENCE_H_
12 #include <linux/dma-fence.h>
13 #include <linux/gfp.h>
14 #include <linux/kref.h>
15 #include <linux/notifier.h> /* for NOTIFY_DONE */
16 #include <linux/wait.h>
19 struct reservation_object;
21 struct i915_sw_fence {
22 wait_queue_head_t wait;
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)
31 enum i915_sw_fence_notify {
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)
40 void __i915_sw_fence_init(struct i915_sw_fence *fence,
41 i915_sw_fence_notify_t fn,
43 struct lock_class_key *key);
45 #define i915_sw_fence_init(fence, fn) \
47 static struct lock_class_key __key; \
49 __i915_sw_fence_init((fence), (fn), #fence, &__key); \
52 #define i915_sw_fence_init(fence, fn) \
53 __i915_sw_fence_init((fence), (fn), NULL, NULL)
56 #ifdef CONFIG_DRM_I915_SW_FENCE_DEBUG_OBJECTS
57 void i915_sw_fence_fini(struct i915_sw_fence *fence);
59 static inline void i915_sw_fence_fini(struct i915_sw_fence *fence) {}
62 void i915_sw_fence_commit(struct i915_sw_fence *fence);
64 int i915_sw_fence_await_sw_fence(struct i915_sw_fence *fence,
65 struct i915_sw_fence *after,
66 wait_queue_entry_t *wq);
67 int i915_sw_fence_await_sw_fence_gfp(struct i915_sw_fence *fence,
68 struct i915_sw_fence *after,
71 struct i915_sw_dma_fence_cb {
72 struct dma_fence_cb base;
73 struct i915_sw_fence *fence;
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);
79 int i915_sw_fence_await_dma_fence(struct i915_sw_fence *fence,
80 struct dma_fence *dma,
81 unsigned long timeout,
84 int i915_sw_fence_await_reservation(struct i915_sw_fence *fence,
85 struct reservation_object *resv,
86 const struct dma_fence_ops *exclude,
88 unsigned long timeout,
91 void i915_sw_fence_await(struct i915_sw_fence *fence);
92 void i915_sw_fence_complete(struct i915_sw_fence *fence);
94 static inline bool i915_sw_fence_signaled(const struct i915_sw_fence *fence)
96 return atomic_read(&fence->pending) <= 0;
99 static inline bool i915_sw_fence_done(const struct i915_sw_fence *fence)
101 return atomic_read(&fence->pending) < 0;
104 static inline void i915_sw_fence_wait(struct i915_sw_fence *fence)
106 wait_event(fence->wait, i915_sw_fence_done(fence));
109 #endif /* _I915_SW_FENCE_H_ */