1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /*
3 * fence-array: aggregates fence to be waited together
4 *
5 * Copyright (C) 2016 Collabora Ltd
6 * Copyright (C) 2016 Advanced Micro Devices, Inc.
7 * Authors:
8 * Gustavo Padovan <gustavo@padovan.org>
9 * Christian König <christian.koenig@amd.com>
10 */
11
12 #ifndef __LINUX_DMA_FENCE_ARRAY_H
13 #define __LINUX_DMA_FENCE_ARRAY_H
14
15 #include <linux/dma-fence.h>
16 #include <linux/irq_work.h>
17
18 /**
19 * struct dma_fence_array_cb - callback helper for fence array
20 * @cb: fence callback structure for signaling
21 * @array: reference to the parent fence array object
22 */
23 struct dma_fence_array_cb {
24 struct dma_fence_cb cb;
25 struct dma_fence_array *array;
26 };
27
28 /**
29 * struct dma_fence_array - fence to represent an array of fences
30 * @base: fence base class
31 * @lock: spinlock for fence handling
32 * @num_fences: number of fences in the array
33 * @num_pending: fences in the array still pending
34 * @fences: array of the fences
35 * @work: internal irq_work function
36 */
37 struct dma_fence_array {
38 struct dma_fence base;
39
40 spinlock_t lock;
41 unsigned num_fences;
42 atomic_t num_pending;
43 struct dma_fence **fences;
44
45 struct irq_work work;
46 };
47
48 extern const struct dma_fence_ops dma_fence_array_ops;
49
50 /**
51 * dma_fence_is_array - check if a fence is from the array subsclass
52 * @fence: fence to test
53 *
54 * Return true if it is a dma_fence_array and false otherwise.
55 */
dma_fence_is_array(struct dma_fence * fence)56 static inline bool dma_fence_is_array(struct dma_fence *fence)
57 {
58 return fence->ops == &dma_fence_array_ops;
59 }
60
61 /**
62 * to_dma_fence_array - cast a fence to a dma_fence_array
63 * @fence: fence to cast to a dma_fence_array
64 *
65 * Returns NULL if the fence is not a dma_fence_array,
66 * or the dma_fence_array otherwise.
67 */
68 static inline struct dma_fence_array *
to_dma_fence_array(struct dma_fence * fence)69 to_dma_fence_array(struct dma_fence *fence)
70 {
71 if (fence->ops != &dma_fence_array_ops)
72 return NULL;
73
74 return container_of(fence, struct dma_fence_array, base);
75 }
76
77 /**
78 * dma_fence_array_for_each - iterate over all fences in array
79 * @fence: current fence
80 * @index: index into the array
81 * @head: potential dma_fence_array object
82 *
83 * Test if @array is a dma_fence_array object and if yes iterate over all fences
84 * in the array. If not just iterate over the fence in @array itself.
85 *
86 * For a deep dive iterator see dma_fence_unwrap_for_each().
87 */
88 #define dma_fence_array_for_each(fence, index, head) \
89 for (index = 0, fence = dma_fence_array_first(head); fence; \
90 ++(index), fence = dma_fence_array_next(head, index))
91
92 struct dma_fence_array *dma_fence_array_create(int num_fences,
93 struct dma_fence **fences,
94 u64 context, unsigned seqno,
95 bool signal_on_any);
96
97 bool dma_fence_match_context(struct dma_fence *fence, u64 context);
98
99 struct dma_fence *dma_fence_array_first(struct dma_fence *head);
100 struct dma_fence *dma_fence_array_next(struct dma_fence *head,
101 unsigned int index);
102
103 #endif /* __LINUX_DMA_FENCE_ARRAY_H */
104