1 /*
2 * Copyright © 2006, Intel Corporation.
3 *
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
11 * more details.
12 *
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
16 *
17 */
18 #ifndef _ASYNC_TX_H_
19 #define _ASYNC_TX_H_
20 #include <linux/dmaengine.h>
21 #include <linux/spinlock.h>
22 #include <linux/interrupt.h>
23
24 /**
25 * dma_chan_ref - object used to manage dma channels received from the
26 * dmaengine core.
27 * @chan - the channel being tracked
28 * @node - node for the channel to be placed on async_tx_master_list
29 * @rcu - for list_del_rcu
30 * @count - number of times this channel is listed in the pool
31 * (for channels with multiple capabiities)
32 */
33 struct dma_chan_ref {
34 struct dma_chan *chan;
35 struct list_head node;
36 struct rcu_head rcu;
37 atomic_t count;
38 };
39
40 /**
41 * async_tx_flags - modifiers for the async_* calls
42 * @ASYNC_TX_XOR_ZERO_DST: this flag must be used for xor operations where the
43 * the destination address is not a source. The asynchronous case handles this
44 * implicitly, the synchronous case needs to zero the destination block.
45 * @ASYNC_TX_XOR_DROP_DST: this flag must be used if the destination address is
46 * also one of the source addresses. In the synchronous case the destination
47 * address is an implied source, whereas the asynchronous case it must be listed
48 * as a source. The destination address must be the first address in the source
49 * array.
50 * @ASYNC_TX_ACK: immediately ack the descriptor, precludes setting up a
51 * dependency chain
52 * @ASYNC_TX_DEP_ACK: ack the dependency descriptor. Useful for chaining.
53 */
54 enum async_tx_flags {
55 ASYNC_TX_XOR_ZERO_DST = (1 << 0),
56 ASYNC_TX_XOR_DROP_DST = (1 << 1),
57 ASYNC_TX_ACK = (1 << 3),
58 ASYNC_TX_DEP_ACK = (1 << 4),
59 };
60
61 #ifdef CONFIG_DMA_ENGINE
62 #define async_tx_issue_pending_all dma_issue_pending_all
63 #ifdef CONFIG_ARCH_HAS_ASYNC_TX_FIND_CHANNEL
64 #include <asm/async_tx.h>
65 #else
66 #define async_tx_find_channel(dep, type, dst, dst_count, src, src_count, len) \
67 __async_tx_find_channel(dep, type)
68 struct dma_chan *
69 __async_tx_find_channel(struct dma_async_tx_descriptor *depend_tx,
70 enum dma_transaction_type tx_type);
71 #endif /* CONFIG_ARCH_HAS_ASYNC_TX_FIND_CHANNEL */
72 #else
async_tx_issue_pending_all(void)73 static inline void async_tx_issue_pending_all(void)
74 {
75 do { } while (0);
76 }
77
78 static inline struct dma_chan *
async_tx_find_channel(struct dma_async_tx_descriptor * depend_tx,enum dma_transaction_type tx_type,struct page ** dst,int dst_count,struct page ** src,int src_count,size_t len)79 async_tx_find_channel(struct dma_async_tx_descriptor *depend_tx,
80 enum dma_transaction_type tx_type, struct page **dst, int dst_count,
81 struct page **src, int src_count, size_t len)
82 {
83 return NULL;
84 }
85 #endif
86
87 /**
88 * async_tx_sync_epilog - actions to take if an operation is run synchronously
89 * @cb_fn: function to call when the transaction completes
90 * @cb_fn_param: parameter to pass to the callback routine
91 */
92 static inline void
async_tx_sync_epilog(dma_async_tx_callback cb_fn,void * cb_fn_param)93 async_tx_sync_epilog(dma_async_tx_callback cb_fn, void *cb_fn_param)
94 {
95 if (cb_fn)
96 cb_fn(cb_fn_param);
97 }
98
99 void
100 async_tx_submit(struct dma_chan *chan, struct dma_async_tx_descriptor *tx,
101 enum async_tx_flags flags, struct dma_async_tx_descriptor *depend_tx,
102 dma_async_tx_callback cb_fn, void *cb_fn_param);
103
104 struct dma_async_tx_descriptor *
105 async_xor(struct page *dest, struct page **src_list, unsigned int offset,
106 int src_cnt, size_t len, enum async_tx_flags flags,
107 struct dma_async_tx_descriptor *depend_tx,
108 dma_async_tx_callback cb_fn, void *cb_fn_param);
109
110 struct dma_async_tx_descriptor *
111 async_xor_zero_sum(struct page *dest, struct page **src_list,
112 unsigned int offset, int src_cnt, size_t len,
113 u32 *result, enum async_tx_flags flags,
114 struct dma_async_tx_descriptor *depend_tx,
115 dma_async_tx_callback cb_fn, void *cb_fn_param);
116
117 struct dma_async_tx_descriptor *
118 async_memcpy(struct page *dest, struct page *src, unsigned int dest_offset,
119 unsigned int src_offset, size_t len, enum async_tx_flags flags,
120 struct dma_async_tx_descriptor *depend_tx,
121 dma_async_tx_callback cb_fn, void *cb_fn_param);
122
123 struct dma_async_tx_descriptor *
124 async_memset(struct page *dest, int val, unsigned int offset,
125 size_t len, enum async_tx_flags flags,
126 struct dma_async_tx_descriptor *depend_tx,
127 dma_async_tx_callback cb_fn, void *cb_fn_param);
128
129 struct dma_async_tx_descriptor *
130 async_trigger_callback(enum async_tx_flags flags,
131 struct dma_async_tx_descriptor *depend_tx,
132 dma_async_tx_callback cb_fn, void *cb_fn_param);
133
134 void async_tx_quiesce(struct dma_async_tx_descriptor **tx);
135 #endif /* _ASYNC_TX_H_ */
136