Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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 */
33struct 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 */
54enum 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
62void async_tx_issue_pending_all(void);
63enum dma_status dma_wait_for_async_tx(struct dma_async_tx_descriptor *tx);
64void async_tx_run_dependencies(struct dma_async_tx_descriptor *tx);
65#ifdef CONFIG_ARCH_HAS_ASYNC_TX_FIND_CHANNEL
66#include <asm/async_tx.h>
67#else
68#define async_tx_find_channel(dep, type, dst, dst_count, src, src_count, len) \
69 __async_tx_find_channel(dep, type)
70struct dma_chan *
71__async_tx_find_channel(struct dma_async_tx_descriptor *depend_tx,
72 enum dma_transaction_type tx_type);
73#endif /* CONFIG_ARCH_HAS_ASYNC_TX_FIND_CHANNEL */
74#else
75static inline void async_tx_issue_pending_all(void)
76{
77 do { } while (0);
78}
79
80static inline enum dma_status
81dma_wait_for_async_tx(struct dma_async_tx_descriptor *tx)
82{
83 return DMA_SUCCESS;
84}
85
86static inline void
87async_tx_run_dependencies(struct dma_async_tx_descriptor *tx,
88 struct dma_chan *host_chan)
89{
90 do { } while (0);
91}
92
93static inline struct dma_chan *
94async_tx_find_channel(struct dma_async_tx_descriptor *depend_tx,
95 enum dma_transaction_type tx_type, struct page **dst, int dst_count,
96 struct page **src, int src_count, size_t len)
97{
98 return NULL;
99}
100#endif
101
102/**
103 * async_tx_sync_epilog - actions to take if an operation is run synchronously
104 * @flags: async_tx flags
105 * @depend_tx: transaction depends on depend_tx
106 * @cb_fn: function to call when the transaction completes
107 * @cb_fn_param: parameter to pass to the callback routine
108 */
109static inline void
110async_tx_sync_epilog(unsigned long flags,
111 struct dma_async_tx_descriptor *depend_tx,
112 dma_async_tx_callback cb_fn, void *cb_fn_param)
113{
114 if (cb_fn)
115 cb_fn(cb_fn_param);
116
117 if (depend_tx && (flags & ASYNC_TX_DEP_ACK))
118 async_tx_ack(depend_tx);
119}
120
121void
122async_tx_submit(struct dma_chan *chan, struct dma_async_tx_descriptor *tx,
123 enum async_tx_flags flags, struct dma_async_tx_descriptor *depend_tx,
124 dma_async_tx_callback cb_fn, void *cb_fn_param);
125
126struct dma_async_tx_descriptor *
127async_xor(struct page *dest, struct page **src_list, unsigned int offset,
128 int src_cnt, size_t len, enum async_tx_flags flags,
129 struct dma_async_tx_descriptor *depend_tx,
130 dma_async_tx_callback cb_fn, void *cb_fn_param);
131
132struct dma_async_tx_descriptor *
133async_xor_zero_sum(struct page *dest, struct page **src_list,
134 unsigned int offset, int src_cnt, size_t len,
135 u32 *result, enum async_tx_flags flags,
136 struct dma_async_tx_descriptor *depend_tx,
137 dma_async_tx_callback cb_fn, void *cb_fn_param);
138
139struct dma_async_tx_descriptor *
140async_memcpy(struct page *dest, struct page *src, unsigned int dest_offset,
141 unsigned int src_offset, size_t len, enum async_tx_flags flags,
142 struct dma_async_tx_descriptor *depend_tx,
143 dma_async_tx_callback cb_fn, void *cb_fn_param);
144
145struct dma_async_tx_descriptor *
146async_memset(struct page *dest, int val, unsigned int offset,
147 size_t len, enum async_tx_flags flags,
148 struct dma_async_tx_descriptor *depend_tx,
149 dma_async_tx_callback cb_fn, void *cb_fn_param);
150
151struct dma_async_tx_descriptor *
152async_trigger_callback(enum async_tx_flags flags,
153 struct dma_async_tx_descriptor *depend_tx,
154 dma_async_tx_callback cb_fn, void *cb_fn_param);
155#endif /* _ASYNC_TX_H_ */