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