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 /* on architectures without dma-mapping capabilities we need to ensure 25 * that the asynchronous path compiles away 26 */ 27 #ifdef CONFIG_HAS_DMA 28 #define __async_inline 29 #else 30 #define __async_inline __always_inline 31 #endif 32 33 /** 34 * dma_chan_ref - object used to manage dma channels received from the 35 * dmaengine core. 36 * @chan - the channel being tracked 37 * @node - node for the channel to be placed on async_tx_master_list 38 * @rcu - for list_del_rcu 39 * @count - number of times this channel is listed in the pool 40 * (for channels with multiple capabiities) 41 */ 42 struct dma_chan_ref { 43 struct dma_chan *chan; 44 struct list_head node; 45 struct rcu_head rcu; 46 atomic_t count; 47 }; 48 49 /** 50 * async_tx_flags - modifiers for the async_* calls 51 * @ASYNC_TX_XOR_ZERO_DST: this flag must be used for xor operations where the 52 * the destination address is not a source. The asynchronous case handles this 53 * implicitly, the synchronous case needs to zero the destination block. 54 * @ASYNC_TX_XOR_DROP_DST: this flag must be used if the destination address is 55 * also one of the source addresses. In the synchronous case the destination 56 * address is an implied source, whereas the asynchronous case it must be listed 57 * as a source. The destination address must be the first address in the source 58 * array. 59 * @ASYNC_TX_ACK: immediately ack the descriptor, precludes setting up a 60 * dependency chain 61 */ 62 enum async_tx_flags { 63 ASYNC_TX_XOR_ZERO_DST = (1 << 0), 64 ASYNC_TX_XOR_DROP_DST = (1 << 1), 65 ASYNC_TX_ACK = (1 << 2), 66 }; 67 68 /** 69 * struct async_submit_ctl - async_tx submission/completion modifiers 70 * @flags: submission modifiers 71 * @depend_tx: parent dependency of the current operation being submitted 72 * @cb_fn: callback routine to run at operation completion 73 * @cb_param: parameter for the callback routine 74 * @scribble: caller provided space for dma/page address conversions 75 */ 76 struct async_submit_ctl { 77 enum async_tx_flags flags; 78 struct dma_async_tx_descriptor *depend_tx; 79 dma_async_tx_callback cb_fn; 80 void *cb_param; 81 void *scribble; 82 }; 83 84 #ifdef CONFIG_DMA_ENGINE 85 #define async_tx_issue_pending_all dma_issue_pending_all 86 #ifdef CONFIG_ARCH_HAS_ASYNC_TX_FIND_CHANNEL 87 #include <asm/async_tx.h> 88 #else 89 #define async_tx_find_channel(dep, type, dst, dst_count, src, src_count, len) \ 90 __async_tx_find_channel(dep, type) 91 struct dma_chan * 92 __async_tx_find_channel(struct async_submit_ctl *submit, 93 enum dma_transaction_type tx_type); 94 #endif /* CONFIG_ARCH_HAS_ASYNC_TX_FIND_CHANNEL */ 95 #else 96 static inline void async_tx_issue_pending_all(void) 97 { 98 do { } while (0); 99 } 100 101 static inline struct dma_chan * 102 async_tx_find_channel(struct async_submit_ctl *submit, 103 enum dma_transaction_type tx_type, struct page **dst, 104 int dst_count, struct page **src, int src_count, 105 size_t len) 106 { 107 return NULL; 108 } 109 #endif 110 111 /** 112 * async_tx_sync_epilog - actions to take if an operation is run synchronously 113 * @cb_fn: function to call when the transaction completes 114 * @cb_fn_param: parameter to pass to the callback routine 115 */ 116 static inline void 117 async_tx_sync_epilog(struct async_submit_ctl *submit) 118 { 119 if (submit->cb_fn) 120 submit->cb_fn(submit->cb_param); 121 } 122 123 typedef union { 124 unsigned long addr; 125 struct page *page; 126 dma_addr_t dma; 127 } addr_conv_t; 128 129 static inline void 130 init_async_submit(struct async_submit_ctl *args, enum async_tx_flags flags, 131 struct dma_async_tx_descriptor *tx, 132 dma_async_tx_callback cb_fn, void *cb_param, 133 addr_conv_t *scribble) 134 { 135 args->flags = flags; 136 args->depend_tx = tx; 137 args->cb_fn = cb_fn; 138 args->cb_param = cb_param; 139 args->scribble = scribble; 140 } 141 142 void async_tx_submit(struct dma_chan *chan, struct dma_async_tx_descriptor *tx, 143 struct async_submit_ctl *submit); 144 145 struct dma_async_tx_descriptor * 146 async_xor(struct page *dest, struct page **src_list, unsigned int offset, 147 int src_cnt, size_t len, struct async_submit_ctl *submit); 148 149 struct dma_async_tx_descriptor * 150 async_xor_val(struct page *dest, struct page **src_list, unsigned int offset, 151 int src_cnt, size_t len, enum sum_check_flags *result, 152 struct async_submit_ctl *submit); 153 154 struct dma_async_tx_descriptor * 155 async_memcpy(struct page *dest, struct page *src, unsigned int dest_offset, 156 unsigned int src_offset, size_t len, 157 struct async_submit_ctl *submit); 158 159 struct dma_async_tx_descriptor * 160 async_memset(struct page *dest, int val, unsigned int offset, 161 size_t len, struct async_submit_ctl *submit); 162 163 struct dma_async_tx_descriptor *async_trigger_callback(struct async_submit_ctl *submit); 164 165 void async_tx_quiesce(struct dma_async_tx_descriptor **tx); 166 #endif /* _ASYNC_TX_H_ */ 167