Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright(c) 2004 - 2006 Intel Corporation. All rights reserved. |
| 3 | * |
| 4 | * This program is free software; you can redistribute it and/or modify it |
| 5 | * under the terms of the GNU General Public License as published by the Free |
| 6 | * Software Foundation; either version 2 of the License, or (at your option) |
| 7 | * any later version. |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, but WITHOUT |
| 10 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| 11 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for |
| 12 | * more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License along with |
| 15 | * this program; if not, write to the Free Software Foundation, Inc., 59 |
| 16 | * Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
| 17 | * |
| 18 | * The full GNU General Public License is included in this distribution in the |
| 19 | * file called COPYING. |
| 20 | */ |
Russell King - ARM Linux | d2ebfb3 | 2012-03-06 22:34:26 +0000 | [diff] [blame] | 21 | #ifndef LINUX_DMAENGINE_H |
| 22 | #define LINUX_DMAENGINE_H |
David Woodhouse | 1c0f16e | 2006-06-27 02:53:56 -0700 | [diff] [blame] | 23 | |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 24 | #include <linux/device.h> |
| 25 | #include <linux/uio.h> |
Paul Gortmaker | 187f188 | 2011-11-23 20:12:59 -0500 | [diff] [blame] | 26 | #include <linux/bug.h> |
Vinod Koul | 90b44f8 | 2011-07-25 19:57:52 +0530 | [diff] [blame] | 27 | #include <linux/scatterlist.h> |
Paul Gortmaker | a8efa9d | 2011-07-29 16:55:11 +1000 | [diff] [blame] | 28 | #include <linux/bitmap.h> |
Viresh Kumar | dcc043d | 2012-02-01 16:12:18 +0530 | [diff] [blame] | 29 | #include <linux/types.h> |
Paul Gortmaker | a8efa9d | 2011-07-29 16:55:11 +1000 | [diff] [blame] | 30 | #include <asm/page.h> |
Alexey Dobriyan | b7f080c | 2011-06-16 11:01:34 +0000 | [diff] [blame] | 31 | |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 32 | /** |
Randy Dunlap | fe4ada2 | 2006-07-03 19:44:51 -0700 | [diff] [blame] | 33 | * typedef dma_cookie_t - an opaque DMA cookie |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 34 | * |
| 35 | * if dma_cookie_t is >0 it's a DMA request cookie, <0 it's an error code |
| 36 | */ |
| 37 | typedef s32 dma_cookie_t; |
Steven J. Magnani | 76bd061 | 2010-02-28 22:18:16 -0700 | [diff] [blame] | 38 | #define DMA_MIN_COOKIE 1 |
| 39 | #define DMA_MAX_COOKIE INT_MAX |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 40 | |
| 41 | #define dma_submit_error(cookie) ((cookie) < 0 ? 1 : 0) |
| 42 | |
| 43 | /** |
| 44 | * enum dma_status - DMA transaction status |
| 45 | * @DMA_SUCCESS: transaction completed successfully |
| 46 | * @DMA_IN_PROGRESS: transaction not yet processed |
Linus Walleij | 0793448 | 2010-03-26 16:50:49 -0700 | [diff] [blame] | 47 | * @DMA_PAUSED: transaction is paused |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 48 | * @DMA_ERROR: transaction failed |
| 49 | */ |
| 50 | enum dma_status { |
| 51 | DMA_SUCCESS, |
| 52 | DMA_IN_PROGRESS, |
Linus Walleij | 0793448 | 2010-03-26 16:50:49 -0700 | [diff] [blame] | 53 | DMA_PAUSED, |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 54 | DMA_ERROR, |
| 55 | }; |
| 56 | |
| 57 | /** |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 58 | * enum dma_transaction_type - DMA transaction types/indexes |
Dan Williams | 138f4c3 | 2009-09-08 17:42:51 -0700 | [diff] [blame] | 59 | * |
| 60 | * Note: The DMA_ASYNC_TX capability is not to be set by drivers. It is |
| 61 | * automatically set as dma devices are registered. |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 62 | */ |
| 63 | enum dma_transaction_type { |
| 64 | DMA_MEMCPY, |
| 65 | DMA_XOR, |
Dan Williams | b2f46fd | 2009-07-14 12:20:36 -0700 | [diff] [blame] | 66 | DMA_PQ, |
Dan Williams | 099f53c | 2009-04-08 14:28:37 -0700 | [diff] [blame] | 67 | DMA_XOR_VAL, |
| 68 | DMA_PQ_VAL, |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 69 | DMA_MEMSET, |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 70 | DMA_INTERRUPT, |
Ira Snyder | a86ee03 | 2010-09-30 11:46:44 +0000 | [diff] [blame] | 71 | DMA_SG, |
Dan Williams | 59b5ec2 | 2009-01-06 11:38:15 -0700 | [diff] [blame] | 72 | DMA_PRIVATE, |
Dan Williams | 138f4c3 | 2009-09-08 17:42:51 -0700 | [diff] [blame] | 73 | DMA_ASYNC_TX, |
Haavard Skinnemoen | dc0ee643 | 2008-07-08 11:59:35 -0700 | [diff] [blame] | 74 | DMA_SLAVE, |
Sascha Hauer | 782bc95 | 2010-09-30 13:56:32 +0000 | [diff] [blame] | 75 | DMA_CYCLIC, |
Jassi Brar | b14dab7 | 2011-10-13 12:33:30 +0530 | [diff] [blame] | 76 | DMA_INTERLEAVE, |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 77 | /* last transaction type for creation of the capabilities mask */ |
Jassi Brar | b14dab7 | 2011-10-13 12:33:30 +0530 | [diff] [blame] | 78 | DMA_TX_TYPE_END, |
| 79 | }; |
Haavard Skinnemoen | dc0ee643 | 2008-07-08 11:59:35 -0700 | [diff] [blame] | 80 | |
Vinod Koul | 49920bc | 2011-10-13 15:15:27 +0530 | [diff] [blame] | 81 | /** |
| 82 | * enum dma_transfer_direction - dma transfer mode and direction indicator |
| 83 | * @DMA_MEM_TO_MEM: Async/Memcpy mode |
| 84 | * @DMA_MEM_TO_DEV: Slave mode & From Memory to Device |
| 85 | * @DMA_DEV_TO_MEM: Slave mode & From Device to Memory |
| 86 | * @DMA_DEV_TO_DEV: Slave mode & From Device to Device |
| 87 | */ |
| 88 | enum dma_transfer_direction { |
| 89 | DMA_MEM_TO_MEM, |
| 90 | DMA_MEM_TO_DEV, |
| 91 | DMA_DEV_TO_MEM, |
| 92 | DMA_DEV_TO_DEV, |
Shawn Guo | 62268ce | 2011-12-13 23:48:03 +0800 | [diff] [blame] | 93 | DMA_TRANS_NONE, |
Vinod Koul | 49920bc | 2011-10-13 15:15:27 +0530 | [diff] [blame] | 94 | }; |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 95 | |
| 96 | /** |
Jassi Brar | b14dab7 | 2011-10-13 12:33:30 +0530 | [diff] [blame] | 97 | * Interleaved Transfer Request |
| 98 | * ---------------------------- |
| 99 | * A chunk is collection of contiguous bytes to be transfered. |
| 100 | * The gap(in bytes) between two chunks is called inter-chunk-gap(ICG). |
| 101 | * ICGs may or maynot change between chunks. |
| 102 | * A FRAME is the smallest series of contiguous {chunk,icg} pairs, |
| 103 | * that when repeated an integral number of times, specifies the transfer. |
| 104 | * A transfer template is specification of a Frame, the number of times |
| 105 | * it is to be repeated and other per-transfer attributes. |
| 106 | * |
| 107 | * Practically, a client driver would have ready a template for each |
| 108 | * type of transfer it is going to need during its lifetime and |
| 109 | * set only 'src_start' and 'dst_start' before submitting the requests. |
| 110 | * |
| 111 | * |
| 112 | * | Frame-1 | Frame-2 | ~ | Frame-'numf' | |
| 113 | * |====....==.===...=...|====....==.===...=...| ~ |====....==.===...=...| |
| 114 | * |
| 115 | * == Chunk size |
| 116 | * ... ICG |
| 117 | */ |
| 118 | |
| 119 | /** |
| 120 | * struct data_chunk - Element of scatter-gather list that makes a frame. |
| 121 | * @size: Number of bytes to read from source. |
| 122 | * size_dst := fn(op, size_src), so doesn't mean much for destination. |
| 123 | * @icg: Number of bytes to jump after last src/dst address of this |
| 124 | * chunk and before first src/dst address for next chunk. |
| 125 | * Ignored for dst(assumed 0), if dst_inc is true and dst_sgl is false. |
| 126 | * Ignored for src(assumed 0), if src_inc is true and src_sgl is false. |
| 127 | */ |
| 128 | struct data_chunk { |
| 129 | size_t size; |
| 130 | size_t icg; |
| 131 | }; |
| 132 | |
| 133 | /** |
| 134 | * struct dma_interleaved_template - Template to convey DMAC the transfer pattern |
| 135 | * and attributes. |
| 136 | * @src_start: Bus address of source for the first chunk. |
| 137 | * @dst_start: Bus address of destination for the first chunk. |
| 138 | * @dir: Specifies the type of Source and Destination. |
| 139 | * @src_inc: If the source address increments after reading from it. |
| 140 | * @dst_inc: If the destination address increments after writing to it. |
| 141 | * @src_sgl: If the 'icg' of sgl[] applies to Source (scattered read). |
| 142 | * Otherwise, source is read contiguously (icg ignored). |
| 143 | * Ignored if src_inc is false. |
| 144 | * @dst_sgl: If the 'icg' of sgl[] applies to Destination (scattered write). |
| 145 | * Otherwise, destination is filled contiguously (icg ignored). |
| 146 | * Ignored if dst_inc is false. |
| 147 | * @numf: Number of frames in this template. |
| 148 | * @frame_size: Number of chunks in a frame i.e, size of sgl[]. |
| 149 | * @sgl: Array of {chunk,icg} pairs that make up a frame. |
| 150 | */ |
| 151 | struct dma_interleaved_template { |
| 152 | dma_addr_t src_start; |
| 153 | dma_addr_t dst_start; |
| 154 | enum dma_transfer_direction dir; |
| 155 | bool src_inc; |
| 156 | bool dst_inc; |
| 157 | bool src_sgl; |
| 158 | bool dst_sgl; |
| 159 | size_t numf; |
| 160 | size_t frame_size; |
| 161 | struct data_chunk sgl[0]; |
| 162 | }; |
| 163 | |
| 164 | /** |
Dan Williams | 636bdea | 2008-04-17 20:17:26 -0700 | [diff] [blame] | 165 | * enum dma_ctrl_flags - DMA flags to augment operation preparation, |
Dan Williams | b2f46fd | 2009-07-14 12:20:36 -0700 | [diff] [blame] | 166 | * control completion, and communicate status. |
Dan Williams | d4c56f9 | 2008-02-02 19:49:58 -0700 | [diff] [blame] | 167 | * @DMA_PREP_INTERRUPT - trigger an interrupt (callback) upon completion of |
Dan Williams | b2f46fd | 2009-07-14 12:20:36 -0700 | [diff] [blame] | 168 | * this transaction |
Guennadi Liakhovetski | a88f666 | 2009-12-10 18:35:15 +0100 | [diff] [blame] | 169 | * @DMA_CTRL_ACK - if clear, the descriptor cannot be reused until the client |
Dan Williams | b2f46fd | 2009-07-14 12:20:36 -0700 | [diff] [blame] | 170 | * acknowledges receipt, i.e. has has a chance to establish any dependency |
| 171 | * chains |
Dan Williams | e1d181e | 2008-07-04 00:13:40 -0700 | [diff] [blame] | 172 | * @DMA_COMPL_SKIP_SRC_UNMAP - set to disable dma-unmapping the source buffer(s) |
| 173 | * @DMA_COMPL_SKIP_DEST_UNMAP - set to disable dma-unmapping the destination(s) |
Maciej Sosnowski | 4f005db | 2009-04-23 12:31:51 +0200 | [diff] [blame] | 174 | * @DMA_COMPL_SRC_UNMAP_SINGLE - set to do the source dma-unmapping as single |
| 175 | * (if not set, do the source dma-unmapping as page) |
| 176 | * @DMA_COMPL_DEST_UNMAP_SINGLE - set to do the destination dma-unmapping as single |
| 177 | * (if not set, do the destination dma-unmapping as page) |
Dan Williams | b2f46fd | 2009-07-14 12:20:36 -0700 | [diff] [blame] | 178 | * @DMA_PREP_PQ_DISABLE_P - prevent generation of P while generating Q |
| 179 | * @DMA_PREP_PQ_DISABLE_Q - prevent generation of Q while generating P |
| 180 | * @DMA_PREP_CONTINUE - indicate to a driver that it is reusing buffers as |
| 181 | * sources that were the result of a previous operation, in the case of a PQ |
| 182 | * operation it continues the calculation with new sources |
Dan Williams | 0403e38 | 2009-09-08 17:42:50 -0700 | [diff] [blame] | 183 | * @DMA_PREP_FENCE - tell the driver that subsequent operations depend |
| 184 | * on the result of this operation |
Dan Williams | d4c56f9 | 2008-02-02 19:49:58 -0700 | [diff] [blame] | 185 | */ |
Dan Williams | 636bdea | 2008-04-17 20:17:26 -0700 | [diff] [blame] | 186 | enum dma_ctrl_flags { |
Dan Williams | d4c56f9 | 2008-02-02 19:49:58 -0700 | [diff] [blame] | 187 | DMA_PREP_INTERRUPT = (1 << 0), |
Dan Williams | 636bdea | 2008-04-17 20:17:26 -0700 | [diff] [blame] | 188 | DMA_CTRL_ACK = (1 << 1), |
Dan Williams | e1d181e | 2008-07-04 00:13:40 -0700 | [diff] [blame] | 189 | DMA_COMPL_SKIP_SRC_UNMAP = (1 << 2), |
| 190 | DMA_COMPL_SKIP_DEST_UNMAP = (1 << 3), |
Maciej Sosnowski | 4f005db | 2009-04-23 12:31:51 +0200 | [diff] [blame] | 191 | DMA_COMPL_SRC_UNMAP_SINGLE = (1 << 4), |
| 192 | DMA_COMPL_DEST_UNMAP_SINGLE = (1 << 5), |
Dan Williams | f9dd213 | 2009-09-08 17:42:29 -0700 | [diff] [blame] | 193 | DMA_PREP_PQ_DISABLE_P = (1 << 6), |
| 194 | DMA_PREP_PQ_DISABLE_Q = (1 << 7), |
| 195 | DMA_PREP_CONTINUE = (1 << 8), |
Dan Williams | 0403e38 | 2009-09-08 17:42:50 -0700 | [diff] [blame] | 196 | DMA_PREP_FENCE = (1 << 9), |
Dan Williams | d4c56f9 | 2008-02-02 19:49:58 -0700 | [diff] [blame] | 197 | }; |
| 198 | |
| 199 | /** |
Linus Walleij | c3635c7 | 2010-03-26 16:44:01 -0700 | [diff] [blame] | 200 | * enum dma_ctrl_cmd - DMA operations that can optionally be exercised |
| 201 | * on a running channel. |
| 202 | * @DMA_TERMINATE_ALL: terminate all ongoing transfers |
| 203 | * @DMA_PAUSE: pause ongoing transfers |
| 204 | * @DMA_RESUME: resume paused transfer |
Linus Walleij | c156d0a | 2010-08-04 13:37:33 +0200 | [diff] [blame] | 205 | * @DMA_SLAVE_CONFIG: this command is only implemented by DMA controllers |
| 206 | * that need to runtime reconfigure the slave channels (as opposed to passing |
| 207 | * configuration data in statically from the platform). An additional |
| 208 | * argument of struct dma_slave_config must be passed in with this |
| 209 | * command. |
Ira Snyder | 968f19a | 2010-09-30 11:46:46 +0000 | [diff] [blame] | 210 | * @FSLDMA_EXTERNAL_START: this command will put the Freescale DMA controller |
| 211 | * into external start mode. |
Linus Walleij | c3635c7 | 2010-03-26 16:44:01 -0700 | [diff] [blame] | 212 | */ |
| 213 | enum dma_ctrl_cmd { |
| 214 | DMA_TERMINATE_ALL, |
| 215 | DMA_PAUSE, |
| 216 | DMA_RESUME, |
Linus Walleij | c156d0a | 2010-08-04 13:37:33 +0200 | [diff] [blame] | 217 | DMA_SLAVE_CONFIG, |
Ira Snyder | 968f19a | 2010-09-30 11:46:46 +0000 | [diff] [blame] | 218 | FSLDMA_EXTERNAL_START, |
Linus Walleij | c3635c7 | 2010-03-26 16:44:01 -0700 | [diff] [blame] | 219 | }; |
| 220 | |
| 221 | /** |
Dan Williams | ad283ea | 2009-08-29 19:09:26 -0700 | [diff] [blame] | 222 | * enum sum_check_bits - bit position of pq_check_flags |
| 223 | */ |
| 224 | enum sum_check_bits { |
| 225 | SUM_CHECK_P = 0, |
| 226 | SUM_CHECK_Q = 1, |
| 227 | }; |
| 228 | |
| 229 | /** |
| 230 | * enum pq_check_flags - result of async_{xor,pq}_zero_sum operations |
| 231 | * @SUM_CHECK_P_RESULT - 1 if xor zero sum error, 0 otherwise |
| 232 | * @SUM_CHECK_Q_RESULT - 1 if reed-solomon zero sum error, 0 otherwise |
| 233 | */ |
| 234 | enum sum_check_flags { |
| 235 | SUM_CHECK_P_RESULT = (1 << SUM_CHECK_P), |
| 236 | SUM_CHECK_Q_RESULT = (1 << SUM_CHECK_Q), |
| 237 | }; |
| 238 | |
| 239 | |
| 240 | /** |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 241 | * dma_cap_mask_t - capabilities bitmap modeled after cpumask_t. |
| 242 | * See linux/cpumask.h |
| 243 | */ |
| 244 | typedef struct { DECLARE_BITMAP(bits, DMA_TX_TYPE_END); } dma_cap_mask_t; |
| 245 | |
| 246 | /** |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 247 | * struct dma_chan_percpu - the per-CPU part of struct dma_chan |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 248 | * @memcpy_count: transaction counter |
| 249 | * @bytes_transferred: byte counter |
| 250 | */ |
| 251 | |
| 252 | struct dma_chan_percpu { |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 253 | /* stats */ |
| 254 | unsigned long memcpy_count; |
| 255 | unsigned long bytes_transferred; |
| 256 | }; |
| 257 | |
| 258 | /** |
| 259 | * struct dma_chan - devices supply DMA channels, clients use them |
Randy Dunlap | fe4ada2 | 2006-07-03 19:44:51 -0700 | [diff] [blame] | 260 | * @device: ptr to the dma device who supplies this channel, always !%NULL |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 261 | * @cookie: last cookie value returned to client |
Russell King - ARM Linux | 4d4e58d | 2012-03-06 22:34:06 +0000 | [diff] [blame] | 262 | * @completed_cookie: last completed cookie for this channel |
Randy Dunlap | fe4ada2 | 2006-07-03 19:44:51 -0700 | [diff] [blame] | 263 | * @chan_id: channel ID for sysfs |
Dan Williams | 41d5e59 | 2009-01-06 11:38:21 -0700 | [diff] [blame] | 264 | * @dev: class device for sysfs |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 265 | * @device_node: used to add this to the device chan list |
| 266 | * @local: per-cpu pointer to a struct dma_chan_percpu |
Dan Williams | 7cc5bf9 | 2008-07-08 11:58:21 -0700 | [diff] [blame] | 267 | * @client-count: how many clients are using this channel |
Dan Williams | bec0851 | 2009-01-06 11:38:14 -0700 | [diff] [blame] | 268 | * @table_count: number of appearances in the mem-to-mem allocation table |
Dan Williams | 287d859 | 2009-02-18 14:48:26 -0800 | [diff] [blame] | 269 | * @private: private data for certain client-channel associations |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 270 | */ |
| 271 | struct dma_chan { |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 272 | struct dma_device *device; |
| 273 | dma_cookie_t cookie; |
Russell King - ARM Linux | 4d4e58d | 2012-03-06 22:34:06 +0000 | [diff] [blame] | 274 | dma_cookie_t completed_cookie; |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 275 | |
| 276 | /* sysfs */ |
| 277 | int chan_id; |
Dan Williams | 41d5e59 | 2009-01-06 11:38:21 -0700 | [diff] [blame] | 278 | struct dma_chan_dev *dev; |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 279 | |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 280 | struct list_head device_node; |
Tejun Heo | a29d8b8 | 2010-02-02 14:39:15 +0900 | [diff] [blame] | 281 | struct dma_chan_percpu __percpu *local; |
Dan Williams | 7cc5bf9 | 2008-07-08 11:58:21 -0700 | [diff] [blame] | 282 | int client_count; |
Dan Williams | bec0851 | 2009-01-06 11:38:14 -0700 | [diff] [blame] | 283 | int table_count; |
Dan Williams | 287d859 | 2009-02-18 14:48:26 -0800 | [diff] [blame] | 284 | void *private; |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 285 | }; |
| 286 | |
Dan Williams | 41d5e59 | 2009-01-06 11:38:21 -0700 | [diff] [blame] | 287 | /** |
| 288 | * struct dma_chan_dev - relate sysfs device node to backing channel device |
| 289 | * @chan - driver channel device |
| 290 | * @device - sysfs device |
Dan Williams | 864498a | 2009-01-06 11:38:21 -0700 | [diff] [blame] | 291 | * @dev_id - parent dma_device dev_id |
| 292 | * @idr_ref - reference count to gate release of dma_device dev_id |
Dan Williams | 41d5e59 | 2009-01-06 11:38:21 -0700 | [diff] [blame] | 293 | */ |
| 294 | struct dma_chan_dev { |
| 295 | struct dma_chan *chan; |
| 296 | struct device device; |
Dan Williams | 864498a | 2009-01-06 11:38:21 -0700 | [diff] [blame] | 297 | int dev_id; |
| 298 | atomic_t *idr_ref; |
Dan Williams | 41d5e59 | 2009-01-06 11:38:21 -0700 | [diff] [blame] | 299 | }; |
| 300 | |
Linus Walleij | c156d0a | 2010-08-04 13:37:33 +0200 | [diff] [blame] | 301 | /** |
| 302 | * enum dma_slave_buswidth - defines bus with of the DMA slave |
| 303 | * device, source or target buses |
| 304 | */ |
| 305 | enum dma_slave_buswidth { |
| 306 | DMA_SLAVE_BUSWIDTH_UNDEFINED = 0, |
| 307 | DMA_SLAVE_BUSWIDTH_1_BYTE = 1, |
| 308 | DMA_SLAVE_BUSWIDTH_2_BYTES = 2, |
| 309 | DMA_SLAVE_BUSWIDTH_4_BYTES = 4, |
| 310 | DMA_SLAVE_BUSWIDTH_8_BYTES = 8, |
| 311 | }; |
| 312 | |
| 313 | /** |
| 314 | * struct dma_slave_config - dma slave channel runtime config |
| 315 | * @direction: whether the data shall go in or out on this slave |
| 316 | * channel, right now. DMA_TO_DEVICE and DMA_FROM_DEVICE are |
| 317 | * legal values, DMA_BIDIRECTIONAL is not acceptable since we |
| 318 | * need to differentiate source and target addresses. |
| 319 | * @src_addr: this is the physical address where DMA slave data |
| 320 | * should be read (RX), if the source is memory this argument is |
| 321 | * ignored. |
| 322 | * @dst_addr: this is the physical address where DMA slave data |
| 323 | * should be written (TX), if the source is memory this argument |
| 324 | * is ignored. |
| 325 | * @src_addr_width: this is the width in bytes of the source (RX) |
| 326 | * register where DMA data shall be read. If the source |
| 327 | * is memory this may be ignored depending on architecture. |
| 328 | * Legal values: 1, 2, 4, 8. |
| 329 | * @dst_addr_width: same as src_addr_width but for destination |
| 330 | * target (TX) mutatis mutandis. |
| 331 | * @src_maxburst: the maximum number of words (note: words, as in |
| 332 | * units of the src_addr_width member, not bytes) that can be sent |
| 333 | * in one burst to the device. Typically something like half the |
| 334 | * FIFO depth on I/O peripherals so you don't overflow it. This |
| 335 | * may or may not be applicable on memory sources. |
| 336 | * @dst_maxburst: same as src_maxburst but for destination target |
| 337 | * mutatis mutandis. |
Viresh Kumar | dcc043d | 2012-02-01 16:12:18 +0530 | [diff] [blame] | 338 | * @device_fc: Flow Controller Settings. Only valid for slave channels. Fill |
| 339 | * with 'true' if peripheral should be flow controller. Direction will be |
| 340 | * selected at Runtime. |
Laxman Dewangan | 4fd1e32 | 2012-06-06 10:55:26 +0530 | [diff] [blame] | 341 | * @slave_id: Slave requester id. Only valid for slave channels. The dma |
| 342 | * slave peripheral will have unique id as dma requester which need to be |
| 343 | * pass as slave config. |
Linus Walleij | c156d0a | 2010-08-04 13:37:33 +0200 | [diff] [blame] | 344 | * |
| 345 | * This struct is passed in as configuration data to a DMA engine |
| 346 | * in order to set up a certain channel for DMA transport at runtime. |
| 347 | * The DMA device/engine has to provide support for an additional |
| 348 | * command in the channel config interface, DMA_SLAVE_CONFIG |
| 349 | * and this struct will then be passed in as an argument to the |
| 350 | * DMA engine device_control() function. |
| 351 | * |
| 352 | * The rationale for adding configuration information to this struct |
| 353 | * is as follows: if it is likely that most DMA slave controllers in |
| 354 | * the world will support the configuration option, then make it |
| 355 | * generic. If not: if it is fixed so that it be sent in static from |
| 356 | * the platform data, then prefer to do that. Else, if it is neither |
| 357 | * fixed at runtime, nor generic enough (such as bus mastership on |
| 358 | * some CPU family and whatnot) then create a custom slave config |
| 359 | * struct and pass that, then make this config a member of that |
| 360 | * struct, if applicable. |
| 361 | */ |
| 362 | struct dma_slave_config { |
Vinod Koul | 49920bc | 2011-10-13 15:15:27 +0530 | [diff] [blame] | 363 | enum dma_transfer_direction direction; |
Linus Walleij | c156d0a | 2010-08-04 13:37:33 +0200 | [diff] [blame] | 364 | dma_addr_t src_addr; |
| 365 | dma_addr_t dst_addr; |
| 366 | enum dma_slave_buswidth src_addr_width; |
| 367 | enum dma_slave_buswidth dst_addr_width; |
| 368 | u32 src_maxburst; |
| 369 | u32 dst_maxburst; |
Viresh Kumar | dcc043d | 2012-02-01 16:12:18 +0530 | [diff] [blame] | 370 | bool device_fc; |
Laxman Dewangan | 4fd1e32 | 2012-06-06 10:55:26 +0530 | [diff] [blame] | 371 | unsigned int slave_id; |
Linus Walleij | c156d0a | 2010-08-04 13:37:33 +0200 | [diff] [blame] | 372 | }; |
| 373 | |
Dan Williams | 41d5e59 | 2009-01-06 11:38:21 -0700 | [diff] [blame] | 374 | static inline const char *dma_chan_name(struct dma_chan *chan) |
| 375 | { |
| 376 | return dev_name(&chan->dev->device); |
| 377 | } |
Dan Williams | d379b01 | 2007-07-09 11:56:42 -0700 | [diff] [blame] | 378 | |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 379 | void dma_chan_cleanup(struct kref *kref); |
| 380 | |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 381 | /** |
Dan Williams | 59b5ec2 | 2009-01-06 11:38:15 -0700 | [diff] [blame] | 382 | * typedef dma_filter_fn - callback filter for dma_request_channel |
| 383 | * @chan: channel to be reviewed |
| 384 | * @filter_param: opaque parameter passed through dma_request_channel |
| 385 | * |
| 386 | * When this optional parameter is specified in a call to dma_request_channel a |
| 387 | * suitable channel is passed to this routine for further dispositioning before |
| 388 | * being returned. Where 'suitable' indicates a non-busy channel that |
Dan Williams | 7dd6025 | 2009-01-06 11:38:19 -0700 | [diff] [blame] | 389 | * satisfies the given capability mask. It returns 'true' to indicate that the |
| 390 | * channel is suitable. |
Dan Williams | 59b5ec2 | 2009-01-06 11:38:15 -0700 | [diff] [blame] | 391 | */ |
Dan Williams | 7dd6025 | 2009-01-06 11:38:19 -0700 | [diff] [blame] | 392 | typedef bool (*dma_filter_fn)(struct dma_chan *chan, void *filter_param); |
Dan Williams | 59b5ec2 | 2009-01-06 11:38:15 -0700 | [diff] [blame] | 393 | |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 394 | typedef void (*dma_async_tx_callback)(void *dma_async_param); |
| 395 | /** |
| 396 | * struct dma_async_tx_descriptor - async transaction descriptor |
| 397 | * ---dma generic offload fields--- |
| 398 | * @cookie: tracking cookie for this transaction, set to -EBUSY if |
| 399 | * this tx is sitting on a dependency list |
Dan Williams | 636bdea | 2008-04-17 20:17:26 -0700 | [diff] [blame] | 400 | * @flags: flags to augment operation preparation, control completion, and |
| 401 | * communicate status |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 402 | * @phys: physical address of the descriptor |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 403 | * @chan: target channel for this operation |
| 404 | * @tx_submit: set the prepared descriptor(s) to be executed by the engine |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 405 | * @callback: routine to call after this operation is complete |
| 406 | * @callback_param: general parameter to pass to the callback routine |
| 407 | * ---async_tx api specific fields--- |
Dan Williams | 19242d7 | 2008-04-17 20:17:25 -0700 | [diff] [blame] | 408 | * @next: at completion submit this descriptor |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 409 | * @parent: pointer to the next level up in the dependency chain |
Dan Williams | 19242d7 | 2008-04-17 20:17:25 -0700 | [diff] [blame] | 410 | * @lock: protect the parent and next pointers |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 411 | */ |
| 412 | struct dma_async_tx_descriptor { |
| 413 | dma_cookie_t cookie; |
Dan Williams | 636bdea | 2008-04-17 20:17:26 -0700 | [diff] [blame] | 414 | enum dma_ctrl_flags flags; /* not a 'long' to pack with cookie */ |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 415 | dma_addr_t phys; |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 416 | struct dma_chan *chan; |
| 417 | dma_cookie_t (*tx_submit)(struct dma_async_tx_descriptor *tx); |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 418 | dma_async_tx_callback callback; |
| 419 | void *callback_param; |
Dan Williams | 5fc6d89 | 2010-10-07 16:44:50 -0700 | [diff] [blame] | 420 | #ifdef CONFIG_ASYNC_TX_ENABLE_CHANNEL_SWITCH |
Dan Williams | 19242d7 | 2008-04-17 20:17:25 -0700 | [diff] [blame] | 421 | struct dma_async_tx_descriptor *next; |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 422 | struct dma_async_tx_descriptor *parent; |
| 423 | spinlock_t lock; |
Dan Williams | caa20d97 | 2010-05-17 16:24:16 -0700 | [diff] [blame] | 424 | #endif |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 425 | }; |
| 426 | |
Dan Williams | 5fc6d89 | 2010-10-07 16:44:50 -0700 | [diff] [blame] | 427 | #ifndef CONFIG_ASYNC_TX_ENABLE_CHANNEL_SWITCH |
Dan Williams | caa20d97 | 2010-05-17 16:24:16 -0700 | [diff] [blame] | 428 | static inline void txd_lock(struct dma_async_tx_descriptor *txd) |
| 429 | { |
| 430 | } |
| 431 | static inline void txd_unlock(struct dma_async_tx_descriptor *txd) |
| 432 | { |
| 433 | } |
| 434 | static inline void txd_chain(struct dma_async_tx_descriptor *txd, struct dma_async_tx_descriptor *next) |
| 435 | { |
| 436 | BUG(); |
| 437 | } |
| 438 | static inline void txd_clear_parent(struct dma_async_tx_descriptor *txd) |
| 439 | { |
| 440 | } |
| 441 | static inline void txd_clear_next(struct dma_async_tx_descriptor *txd) |
| 442 | { |
| 443 | } |
| 444 | static inline struct dma_async_tx_descriptor *txd_next(struct dma_async_tx_descriptor *txd) |
| 445 | { |
| 446 | return NULL; |
| 447 | } |
| 448 | static inline struct dma_async_tx_descriptor *txd_parent(struct dma_async_tx_descriptor *txd) |
| 449 | { |
| 450 | return NULL; |
| 451 | } |
| 452 | |
| 453 | #else |
| 454 | static inline void txd_lock(struct dma_async_tx_descriptor *txd) |
| 455 | { |
| 456 | spin_lock_bh(&txd->lock); |
| 457 | } |
| 458 | static inline void txd_unlock(struct dma_async_tx_descriptor *txd) |
| 459 | { |
| 460 | spin_unlock_bh(&txd->lock); |
| 461 | } |
| 462 | static inline void txd_chain(struct dma_async_tx_descriptor *txd, struct dma_async_tx_descriptor *next) |
| 463 | { |
| 464 | txd->next = next; |
| 465 | next->parent = txd; |
| 466 | } |
| 467 | static inline void txd_clear_parent(struct dma_async_tx_descriptor *txd) |
| 468 | { |
| 469 | txd->parent = NULL; |
| 470 | } |
| 471 | static inline void txd_clear_next(struct dma_async_tx_descriptor *txd) |
| 472 | { |
| 473 | txd->next = NULL; |
| 474 | } |
| 475 | static inline struct dma_async_tx_descriptor *txd_parent(struct dma_async_tx_descriptor *txd) |
| 476 | { |
| 477 | return txd->parent; |
| 478 | } |
| 479 | static inline struct dma_async_tx_descriptor *txd_next(struct dma_async_tx_descriptor *txd) |
| 480 | { |
| 481 | return txd->next; |
| 482 | } |
| 483 | #endif |
| 484 | |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 485 | /** |
Linus Walleij | 0793448 | 2010-03-26 16:50:49 -0700 | [diff] [blame] | 486 | * struct dma_tx_state - filled in to report the status of |
| 487 | * a transfer. |
| 488 | * @last: last completed DMA cookie |
| 489 | * @used: last issued DMA cookie (i.e. the one in progress) |
| 490 | * @residue: the remaining number of bytes left to transmit |
| 491 | * on the selected transfer for states DMA_IN_PROGRESS and |
| 492 | * DMA_PAUSED if this is implemented in the driver, else 0 |
| 493 | */ |
| 494 | struct dma_tx_state { |
| 495 | dma_cookie_t last; |
| 496 | dma_cookie_t used; |
| 497 | u32 residue; |
| 498 | }; |
| 499 | |
| 500 | /** |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 501 | * struct dma_device - info on the entity supplying DMA services |
| 502 | * @chancnt: how many DMA channels are supported |
Atsushi Nemoto | 0f57151 | 2009-03-06 20:07:14 +0900 | [diff] [blame] | 503 | * @privatecnt: how many DMA channels are requested by dma_request_channel |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 504 | * @channels: the list of struct dma_chan |
| 505 | * @global_node: list_head for global dma_device_list |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 506 | * @cap_mask: one or more dma_capability flags |
| 507 | * @max_xor: maximum number of xor sources, 0 if no capability |
Dan Williams | b2f46fd | 2009-07-14 12:20:36 -0700 | [diff] [blame] | 508 | * @max_pq: maximum number of PQ sources and PQ-continue capability |
Dan Williams | 83544ae | 2009-09-08 17:42:53 -0700 | [diff] [blame] | 509 | * @copy_align: alignment shift for memcpy operations |
| 510 | * @xor_align: alignment shift for xor operations |
| 511 | * @pq_align: alignment shift for pq operations |
| 512 | * @fill_align: alignment shift for memset operations |
Randy Dunlap | fe4ada2 | 2006-07-03 19:44:51 -0700 | [diff] [blame] | 513 | * @dev_id: unique device ID |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 514 | * @dev: struct device reference for dma mapping api |
Randy Dunlap | fe4ada2 | 2006-07-03 19:44:51 -0700 | [diff] [blame] | 515 | * @device_alloc_chan_resources: allocate resources and return the |
| 516 | * number of allocated descriptors |
| 517 | * @device_free_chan_resources: release DMA channel's resources |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 518 | * @device_prep_dma_memcpy: prepares a memcpy operation |
| 519 | * @device_prep_dma_xor: prepares a xor operation |
Dan Williams | 099f53c | 2009-04-08 14:28:37 -0700 | [diff] [blame] | 520 | * @device_prep_dma_xor_val: prepares a xor validation operation |
Dan Williams | b2f46fd | 2009-07-14 12:20:36 -0700 | [diff] [blame] | 521 | * @device_prep_dma_pq: prepares a pq operation |
| 522 | * @device_prep_dma_pq_val: prepares a pqzero_sum operation |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 523 | * @device_prep_dma_memset: prepares a memset operation |
| 524 | * @device_prep_dma_interrupt: prepares an end of chain interrupt operation |
Haavard Skinnemoen | dc0ee643 | 2008-07-08 11:59:35 -0700 | [diff] [blame] | 525 | * @device_prep_slave_sg: prepares a slave dma operation |
Sascha Hauer | 782bc95 | 2010-09-30 13:56:32 +0000 | [diff] [blame] | 526 | * @device_prep_dma_cyclic: prepare a cyclic dma operation suitable for audio. |
| 527 | * The function takes a buffer of size buf_len. The callback function will |
| 528 | * be called after period_len bytes have been transferred. |
Jassi Brar | b14dab7 | 2011-10-13 12:33:30 +0530 | [diff] [blame] | 529 | * @device_prep_interleaved_dma: Transfer expression in a generic way. |
Linus Walleij | c3635c7 | 2010-03-26 16:44:01 -0700 | [diff] [blame] | 530 | * @device_control: manipulate all pending operations on a channel, returns |
| 531 | * zero or error code |
Linus Walleij | 0793448 | 2010-03-26 16:50:49 -0700 | [diff] [blame] | 532 | * @device_tx_status: poll for transaction completion, the optional |
| 533 | * txstate parameter can be supplied with a pointer to get a |
Lucas De Marchi | 25985ed | 2011-03-30 22:57:33 -0300 | [diff] [blame] | 534 | * struct with auxiliary transfer status information, otherwise the call |
Linus Walleij | 0793448 | 2010-03-26 16:50:49 -0700 | [diff] [blame] | 535 | * will just return a simple status code |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 536 | * @device_issue_pending: push pending transactions to hardware |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 537 | */ |
| 538 | struct dma_device { |
| 539 | |
| 540 | unsigned int chancnt; |
Atsushi Nemoto | 0f57151 | 2009-03-06 20:07:14 +0900 | [diff] [blame] | 541 | unsigned int privatecnt; |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 542 | struct list_head channels; |
| 543 | struct list_head global_node; |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 544 | dma_cap_mask_t cap_mask; |
Dan Williams | b2f46fd | 2009-07-14 12:20:36 -0700 | [diff] [blame] | 545 | unsigned short max_xor; |
| 546 | unsigned short max_pq; |
Dan Williams | 83544ae | 2009-09-08 17:42:53 -0700 | [diff] [blame] | 547 | u8 copy_align; |
| 548 | u8 xor_align; |
| 549 | u8 pq_align; |
| 550 | u8 fill_align; |
Dan Williams | b2f46fd | 2009-07-14 12:20:36 -0700 | [diff] [blame] | 551 | #define DMA_HAS_PQ_CONTINUE (1 << 15) |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 552 | |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 553 | int dev_id; |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 554 | struct device *dev; |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 555 | |
Dan Williams | aa1e6f1 | 2009-01-06 11:38:17 -0700 | [diff] [blame] | 556 | int (*device_alloc_chan_resources)(struct dma_chan *chan); |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 557 | void (*device_free_chan_resources)(struct dma_chan *chan); |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 558 | |
| 559 | struct dma_async_tx_descriptor *(*device_prep_dma_memcpy)( |
Dan Williams | 0036731 | 2008-02-02 19:49:57 -0700 | [diff] [blame] | 560 | struct dma_chan *chan, dma_addr_t dest, dma_addr_t src, |
Dan Williams | d4c56f9 | 2008-02-02 19:49:58 -0700 | [diff] [blame] | 561 | size_t len, unsigned long flags); |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 562 | struct dma_async_tx_descriptor *(*device_prep_dma_xor)( |
Dan Williams | 0036731 | 2008-02-02 19:49:57 -0700 | [diff] [blame] | 563 | struct dma_chan *chan, dma_addr_t dest, dma_addr_t *src, |
Dan Williams | d4c56f9 | 2008-02-02 19:49:58 -0700 | [diff] [blame] | 564 | unsigned int src_cnt, size_t len, unsigned long flags); |
Dan Williams | 099f53c | 2009-04-08 14:28:37 -0700 | [diff] [blame] | 565 | struct dma_async_tx_descriptor *(*device_prep_dma_xor_val)( |
Dan Williams | 0036731 | 2008-02-02 19:49:57 -0700 | [diff] [blame] | 566 | struct dma_chan *chan, dma_addr_t *src, unsigned int src_cnt, |
Dan Williams | ad283ea | 2009-08-29 19:09:26 -0700 | [diff] [blame] | 567 | size_t len, enum sum_check_flags *result, unsigned long flags); |
Dan Williams | b2f46fd | 2009-07-14 12:20:36 -0700 | [diff] [blame] | 568 | struct dma_async_tx_descriptor *(*device_prep_dma_pq)( |
| 569 | struct dma_chan *chan, dma_addr_t *dst, dma_addr_t *src, |
| 570 | unsigned int src_cnt, const unsigned char *scf, |
| 571 | size_t len, unsigned long flags); |
| 572 | struct dma_async_tx_descriptor *(*device_prep_dma_pq_val)( |
| 573 | struct dma_chan *chan, dma_addr_t *pq, dma_addr_t *src, |
| 574 | unsigned int src_cnt, const unsigned char *scf, size_t len, |
| 575 | enum sum_check_flags *pqres, unsigned long flags); |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 576 | struct dma_async_tx_descriptor *(*device_prep_dma_memset)( |
Dan Williams | 0036731 | 2008-02-02 19:49:57 -0700 | [diff] [blame] | 577 | struct dma_chan *chan, dma_addr_t dest, int value, size_t len, |
Dan Williams | d4c56f9 | 2008-02-02 19:49:58 -0700 | [diff] [blame] | 578 | unsigned long flags); |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 579 | struct dma_async_tx_descriptor *(*device_prep_dma_interrupt)( |
Dan Williams | 636bdea | 2008-04-17 20:17:26 -0700 | [diff] [blame] | 580 | struct dma_chan *chan, unsigned long flags); |
Ira Snyder | a86ee03 | 2010-09-30 11:46:44 +0000 | [diff] [blame] | 581 | struct dma_async_tx_descriptor *(*device_prep_dma_sg)( |
| 582 | struct dma_chan *chan, |
| 583 | struct scatterlist *dst_sg, unsigned int dst_nents, |
| 584 | struct scatterlist *src_sg, unsigned int src_nents, |
| 585 | unsigned long flags); |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 586 | |
Haavard Skinnemoen | dc0ee643 | 2008-07-08 11:59:35 -0700 | [diff] [blame] | 587 | struct dma_async_tx_descriptor *(*device_prep_slave_sg)( |
| 588 | struct dma_chan *chan, struct scatterlist *sgl, |
Vinod Koul | 49920bc | 2011-10-13 15:15:27 +0530 | [diff] [blame] | 589 | unsigned int sg_len, enum dma_transfer_direction direction, |
Alexandre Bounine | 185ecb5 | 2012-03-08 15:35:13 -0500 | [diff] [blame] | 590 | unsigned long flags, void *context); |
Sascha Hauer | 782bc95 | 2010-09-30 13:56:32 +0000 | [diff] [blame] | 591 | struct dma_async_tx_descriptor *(*device_prep_dma_cyclic)( |
| 592 | struct dma_chan *chan, dma_addr_t buf_addr, size_t buf_len, |
Alexandre Bounine | 185ecb5 | 2012-03-08 15:35:13 -0500 | [diff] [blame] | 593 | size_t period_len, enum dma_transfer_direction direction, |
Peter Ujfalusi | ec8b5e4 | 2012-09-14 15:05:47 +0300 | [diff] [blame] | 594 | unsigned long flags, void *context); |
Jassi Brar | b14dab7 | 2011-10-13 12:33:30 +0530 | [diff] [blame] | 595 | struct dma_async_tx_descriptor *(*device_prep_interleaved_dma)( |
| 596 | struct dma_chan *chan, struct dma_interleaved_template *xt, |
| 597 | unsigned long flags); |
Linus Walleij | 0582763 | 2010-05-17 16:30:42 -0700 | [diff] [blame] | 598 | int (*device_control)(struct dma_chan *chan, enum dma_ctrl_cmd cmd, |
| 599 | unsigned long arg); |
Haavard Skinnemoen | dc0ee643 | 2008-07-08 11:59:35 -0700 | [diff] [blame] | 600 | |
Linus Walleij | 0793448 | 2010-03-26 16:50:49 -0700 | [diff] [blame] | 601 | enum dma_status (*device_tx_status)(struct dma_chan *chan, |
| 602 | dma_cookie_t cookie, |
| 603 | struct dma_tx_state *txstate); |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 604 | void (*device_issue_pending)(struct dma_chan *chan); |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 605 | }; |
| 606 | |
Sascha Hauer | 6e3ecaf | 2010-09-30 13:56:33 +0000 | [diff] [blame] | 607 | static inline int dmaengine_device_control(struct dma_chan *chan, |
| 608 | enum dma_ctrl_cmd cmd, |
| 609 | unsigned long arg) |
| 610 | { |
Jon Mason | 944ea4d | 2012-11-11 23:03:20 +0000 | [diff] [blame] | 611 | if (chan->device->device_control) |
| 612 | return chan->device->device_control(chan, cmd, arg); |
Andy Shevchenko | 978c417 | 2013-02-14 11:00:16 +0200 | [diff] [blame] | 613 | |
| 614 | return -ENOSYS; |
Sascha Hauer | 6e3ecaf | 2010-09-30 13:56:33 +0000 | [diff] [blame] | 615 | } |
| 616 | |
| 617 | static inline int dmaengine_slave_config(struct dma_chan *chan, |
| 618 | struct dma_slave_config *config) |
| 619 | { |
| 620 | return dmaengine_device_control(chan, DMA_SLAVE_CONFIG, |
| 621 | (unsigned long)config); |
| 622 | } |
| 623 | |
Andy Shevchenko | 61cc13a | 2013-01-10 10:52:56 +0200 | [diff] [blame] | 624 | static inline bool is_slave_direction(enum dma_transfer_direction direction) |
| 625 | { |
| 626 | return (direction == DMA_MEM_TO_DEV) || (direction == DMA_DEV_TO_MEM); |
| 627 | } |
| 628 | |
Vinod Koul | 90b44f8 | 2011-07-25 19:57:52 +0530 | [diff] [blame] | 629 | static inline struct dma_async_tx_descriptor *dmaengine_prep_slave_single( |
Kuninori Morimoto | 922ee08 | 2012-04-25 20:50:53 +0200 | [diff] [blame] | 630 | struct dma_chan *chan, dma_addr_t buf, size_t len, |
Vinod Koul | 49920bc | 2011-10-13 15:15:27 +0530 | [diff] [blame] | 631 | enum dma_transfer_direction dir, unsigned long flags) |
Vinod Koul | 90b44f8 | 2011-07-25 19:57:52 +0530 | [diff] [blame] | 632 | { |
| 633 | struct scatterlist sg; |
Kuninori Morimoto | 922ee08 | 2012-04-25 20:50:53 +0200 | [diff] [blame] | 634 | sg_init_table(&sg, 1); |
| 635 | sg_dma_address(&sg) = buf; |
| 636 | sg_dma_len(&sg) = len; |
Vinod Koul | 90b44f8 | 2011-07-25 19:57:52 +0530 | [diff] [blame] | 637 | |
Alexandre Bounine | 185ecb5 | 2012-03-08 15:35:13 -0500 | [diff] [blame] | 638 | return chan->device->device_prep_slave_sg(chan, &sg, 1, |
| 639 | dir, flags, NULL); |
Vinod Koul | 90b44f8 | 2011-07-25 19:57:52 +0530 | [diff] [blame] | 640 | } |
| 641 | |
Alexandre Bounine | 1605282 | 2012-03-08 16:11:18 -0500 | [diff] [blame] | 642 | static inline struct dma_async_tx_descriptor *dmaengine_prep_slave_sg( |
| 643 | struct dma_chan *chan, struct scatterlist *sgl, unsigned int sg_len, |
| 644 | enum dma_transfer_direction dir, unsigned long flags) |
| 645 | { |
| 646 | return chan->device->device_prep_slave_sg(chan, sgl, sg_len, |
Alexandre Bounine | 185ecb5 | 2012-03-08 15:35:13 -0500 | [diff] [blame] | 647 | dir, flags, NULL); |
Alexandre Bounine | 1605282 | 2012-03-08 16:11:18 -0500 | [diff] [blame] | 648 | } |
| 649 | |
Alexandre Bounine | e42d98e | 2012-05-31 16:26:38 -0700 | [diff] [blame] | 650 | #ifdef CONFIG_RAPIDIO_DMA_ENGINE |
| 651 | struct rio_dma_ext; |
| 652 | static inline struct dma_async_tx_descriptor *dmaengine_prep_rio_sg( |
| 653 | struct dma_chan *chan, struct scatterlist *sgl, unsigned int sg_len, |
| 654 | enum dma_transfer_direction dir, unsigned long flags, |
| 655 | struct rio_dma_ext *rio_ext) |
| 656 | { |
| 657 | return chan->device->device_prep_slave_sg(chan, sgl, sg_len, |
| 658 | dir, flags, rio_ext); |
| 659 | } |
| 660 | #endif |
| 661 | |
Alexandre Bounine | 1605282 | 2012-03-08 16:11:18 -0500 | [diff] [blame] | 662 | static inline struct dma_async_tx_descriptor *dmaengine_prep_dma_cyclic( |
| 663 | struct dma_chan *chan, dma_addr_t buf_addr, size_t buf_len, |
Peter Ujfalusi | e7736cd | 2012-09-24 10:58:04 +0300 | [diff] [blame] | 664 | size_t period_len, enum dma_transfer_direction dir, |
| 665 | unsigned long flags) |
Alexandre Bounine | 1605282 | 2012-03-08 16:11:18 -0500 | [diff] [blame] | 666 | { |
| 667 | return chan->device->device_prep_dma_cyclic(chan, buf_addr, buf_len, |
Peter Ujfalusi | ec8b5e4 | 2012-09-14 15:05:47 +0300 | [diff] [blame] | 668 | period_len, dir, flags, NULL); |
Sascha Hauer | 6e3ecaf | 2010-09-30 13:56:33 +0000 | [diff] [blame] | 669 | } |
| 670 | |
Barry Song | a14acb4 | 2012-11-06 21:32:39 +0800 | [diff] [blame] | 671 | static inline struct dma_async_tx_descriptor *dmaengine_prep_interleaved_dma( |
| 672 | struct dma_chan *chan, struct dma_interleaved_template *xt, |
| 673 | unsigned long flags) |
| 674 | { |
| 675 | return chan->device->device_prep_interleaved_dma(chan, xt, flags); |
| 676 | } |
| 677 | |
Sascha Hauer | 6e3ecaf | 2010-09-30 13:56:33 +0000 | [diff] [blame] | 678 | static inline int dmaengine_terminate_all(struct dma_chan *chan) |
| 679 | { |
| 680 | return dmaengine_device_control(chan, DMA_TERMINATE_ALL, 0); |
| 681 | } |
| 682 | |
| 683 | static inline int dmaengine_pause(struct dma_chan *chan) |
| 684 | { |
| 685 | return dmaengine_device_control(chan, DMA_PAUSE, 0); |
| 686 | } |
| 687 | |
| 688 | static inline int dmaengine_resume(struct dma_chan *chan) |
| 689 | { |
| 690 | return dmaengine_device_control(chan, DMA_RESUME, 0); |
| 691 | } |
| 692 | |
Lars-Peter Clausen | 3052cc2 | 2012-06-11 20:11:40 +0200 | [diff] [blame] | 693 | static inline enum dma_status dmaengine_tx_status(struct dma_chan *chan, |
| 694 | dma_cookie_t cookie, struct dma_tx_state *state) |
| 695 | { |
| 696 | return chan->device->device_tx_status(chan, cookie, state); |
| 697 | } |
| 698 | |
Russell King - ARM Linux | 98d530f | 2011-01-01 23:00:23 +0000 | [diff] [blame] | 699 | static inline dma_cookie_t dmaengine_submit(struct dma_async_tx_descriptor *desc) |
Sascha Hauer | 6e3ecaf | 2010-09-30 13:56:33 +0000 | [diff] [blame] | 700 | { |
| 701 | return desc->tx_submit(desc); |
| 702 | } |
| 703 | |
Dan Williams | 83544ae | 2009-09-08 17:42:53 -0700 | [diff] [blame] | 704 | static inline bool dmaengine_check_align(u8 align, size_t off1, size_t off2, size_t len) |
| 705 | { |
| 706 | size_t mask; |
| 707 | |
| 708 | if (!align) |
| 709 | return true; |
| 710 | mask = (1 << align) - 1; |
| 711 | if (mask & (off1 | off2 | len)) |
| 712 | return false; |
| 713 | return true; |
| 714 | } |
| 715 | |
| 716 | static inline bool is_dma_copy_aligned(struct dma_device *dev, size_t off1, |
| 717 | size_t off2, size_t len) |
| 718 | { |
| 719 | return dmaengine_check_align(dev->copy_align, off1, off2, len); |
| 720 | } |
| 721 | |
| 722 | static inline bool is_dma_xor_aligned(struct dma_device *dev, size_t off1, |
| 723 | size_t off2, size_t len) |
| 724 | { |
| 725 | return dmaengine_check_align(dev->xor_align, off1, off2, len); |
| 726 | } |
| 727 | |
| 728 | static inline bool is_dma_pq_aligned(struct dma_device *dev, size_t off1, |
| 729 | size_t off2, size_t len) |
| 730 | { |
| 731 | return dmaengine_check_align(dev->pq_align, off1, off2, len); |
| 732 | } |
| 733 | |
| 734 | static inline bool is_dma_fill_aligned(struct dma_device *dev, size_t off1, |
| 735 | size_t off2, size_t len) |
| 736 | { |
| 737 | return dmaengine_check_align(dev->fill_align, off1, off2, len); |
| 738 | } |
| 739 | |
Dan Williams | b2f46fd | 2009-07-14 12:20:36 -0700 | [diff] [blame] | 740 | static inline void |
| 741 | dma_set_maxpq(struct dma_device *dma, int maxpq, int has_pq_continue) |
| 742 | { |
| 743 | dma->max_pq = maxpq; |
| 744 | if (has_pq_continue) |
| 745 | dma->max_pq |= DMA_HAS_PQ_CONTINUE; |
| 746 | } |
| 747 | |
| 748 | static inline bool dmaf_continue(enum dma_ctrl_flags flags) |
| 749 | { |
| 750 | return (flags & DMA_PREP_CONTINUE) == DMA_PREP_CONTINUE; |
| 751 | } |
| 752 | |
| 753 | static inline bool dmaf_p_disabled_continue(enum dma_ctrl_flags flags) |
| 754 | { |
| 755 | enum dma_ctrl_flags mask = DMA_PREP_CONTINUE | DMA_PREP_PQ_DISABLE_P; |
| 756 | |
| 757 | return (flags & mask) == mask; |
| 758 | } |
| 759 | |
| 760 | static inline bool dma_dev_has_pq_continue(struct dma_device *dma) |
| 761 | { |
| 762 | return (dma->max_pq & DMA_HAS_PQ_CONTINUE) == DMA_HAS_PQ_CONTINUE; |
| 763 | } |
| 764 | |
Mathieu Lacage | d3f3cf8 | 2010-08-14 15:02:44 +0200 | [diff] [blame] | 765 | static inline unsigned short dma_dev_to_maxpq(struct dma_device *dma) |
Dan Williams | b2f46fd | 2009-07-14 12:20:36 -0700 | [diff] [blame] | 766 | { |
| 767 | return dma->max_pq & ~DMA_HAS_PQ_CONTINUE; |
| 768 | } |
| 769 | |
| 770 | /* dma_maxpq - reduce maxpq in the face of continued operations |
| 771 | * @dma - dma device with PQ capability |
| 772 | * @flags - to check if DMA_PREP_CONTINUE and DMA_PREP_PQ_DISABLE_P are set |
| 773 | * |
| 774 | * When an engine does not support native continuation we need 3 extra |
| 775 | * source slots to reuse P and Q with the following coefficients: |
| 776 | * 1/ {00} * P : remove P from Q', but use it as a source for P' |
| 777 | * 2/ {01} * Q : use Q to continue Q' calculation |
| 778 | * 3/ {00} * Q : subtract Q from P' to cancel (2) |
| 779 | * |
| 780 | * In the case where P is disabled we only need 1 extra source: |
| 781 | * 1/ {01} * Q : use Q to continue Q' calculation |
| 782 | */ |
| 783 | static inline int dma_maxpq(struct dma_device *dma, enum dma_ctrl_flags flags) |
| 784 | { |
| 785 | if (dma_dev_has_pq_continue(dma) || !dmaf_continue(flags)) |
| 786 | return dma_dev_to_maxpq(dma); |
| 787 | else if (dmaf_p_disabled_continue(flags)) |
| 788 | return dma_dev_to_maxpq(dma) - 1; |
| 789 | else if (dmaf_continue(flags)) |
| 790 | return dma_dev_to_maxpq(dma) - 3; |
| 791 | BUG(); |
| 792 | } |
| 793 | |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 794 | /* --- public DMA engine API --- */ |
| 795 | |
Dan Williams | 649274d | 2009-01-11 00:20:39 -0800 | [diff] [blame] | 796 | #ifdef CONFIG_DMA_ENGINE |
Dan Williams | 209b84a | 2009-01-06 11:38:17 -0700 | [diff] [blame] | 797 | void dmaengine_get(void); |
| 798 | void dmaengine_put(void); |
Dan Williams | 649274d | 2009-01-11 00:20:39 -0800 | [diff] [blame] | 799 | #else |
| 800 | static inline void dmaengine_get(void) |
| 801 | { |
| 802 | } |
| 803 | static inline void dmaengine_put(void) |
| 804 | { |
| 805 | } |
| 806 | #endif |
| 807 | |
David S. Miller | b4bd07c | 2009-02-06 22:06:43 -0800 | [diff] [blame] | 808 | #ifdef CONFIG_NET_DMA |
| 809 | #define net_dmaengine_get() dmaengine_get() |
| 810 | #define net_dmaengine_put() dmaengine_put() |
| 811 | #else |
| 812 | static inline void net_dmaengine_get(void) |
| 813 | { |
| 814 | } |
| 815 | static inline void net_dmaengine_put(void) |
| 816 | { |
| 817 | } |
| 818 | #endif |
| 819 | |
Dan Williams | 729b5d1 | 2009-03-25 09:13:25 -0700 | [diff] [blame] | 820 | #ifdef CONFIG_ASYNC_TX_DMA |
| 821 | #define async_dmaengine_get() dmaengine_get() |
| 822 | #define async_dmaengine_put() dmaengine_put() |
Dan Williams | 5fc6d89 | 2010-10-07 16:44:50 -0700 | [diff] [blame] | 823 | #ifndef CONFIG_ASYNC_TX_ENABLE_CHANNEL_SWITCH |
Dan Williams | 138f4c3 | 2009-09-08 17:42:51 -0700 | [diff] [blame] | 824 | #define async_dma_find_channel(type) dma_find_channel(DMA_ASYNC_TX) |
| 825 | #else |
Dan Williams | 729b5d1 | 2009-03-25 09:13:25 -0700 | [diff] [blame] | 826 | #define async_dma_find_channel(type) dma_find_channel(type) |
Dan Williams | 5fc6d89 | 2010-10-07 16:44:50 -0700 | [diff] [blame] | 827 | #endif /* CONFIG_ASYNC_TX_ENABLE_CHANNEL_SWITCH */ |
Dan Williams | 729b5d1 | 2009-03-25 09:13:25 -0700 | [diff] [blame] | 828 | #else |
| 829 | static inline void async_dmaengine_get(void) |
| 830 | { |
| 831 | } |
| 832 | static inline void async_dmaengine_put(void) |
| 833 | { |
| 834 | } |
| 835 | static inline struct dma_chan * |
| 836 | async_dma_find_channel(enum dma_transaction_type type) |
| 837 | { |
| 838 | return NULL; |
| 839 | } |
Dan Williams | 138f4c3 | 2009-09-08 17:42:51 -0700 | [diff] [blame] | 840 | #endif /* CONFIG_ASYNC_TX_DMA */ |
Dan Williams | 729b5d1 | 2009-03-25 09:13:25 -0700 | [diff] [blame] | 841 | |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 842 | dma_cookie_t dma_async_memcpy_buf_to_buf(struct dma_chan *chan, |
| 843 | void *dest, void *src, size_t len); |
| 844 | dma_cookie_t dma_async_memcpy_buf_to_pg(struct dma_chan *chan, |
| 845 | struct page *page, unsigned int offset, void *kdata, size_t len); |
| 846 | dma_cookie_t dma_async_memcpy_pg_to_pg(struct dma_chan *chan, |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 847 | struct page *dest_pg, unsigned int dest_off, struct page *src_pg, |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 848 | unsigned int src_off, size_t len); |
| 849 | void dma_async_tx_descriptor_init(struct dma_async_tx_descriptor *tx, |
| 850 | struct dma_chan *chan); |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 851 | |
Dan Williams | 0839875 | 2008-07-17 17:59:56 -0700 | [diff] [blame] | 852 | static inline void async_tx_ack(struct dma_async_tx_descriptor *tx) |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 853 | { |
Dan Williams | 636bdea | 2008-04-17 20:17:26 -0700 | [diff] [blame] | 854 | tx->flags |= DMA_CTRL_ACK; |
| 855 | } |
| 856 | |
Guennadi Liakhovetski | ef56068 | 2009-01-19 15:36:21 -0700 | [diff] [blame] | 857 | static inline void async_tx_clear_ack(struct dma_async_tx_descriptor *tx) |
| 858 | { |
| 859 | tx->flags &= ~DMA_CTRL_ACK; |
| 860 | } |
| 861 | |
Dan Williams | 0839875 | 2008-07-17 17:59:56 -0700 | [diff] [blame] | 862 | static inline bool async_tx_test_ack(struct dma_async_tx_descriptor *tx) |
Dan Williams | 636bdea | 2008-04-17 20:17:26 -0700 | [diff] [blame] | 863 | { |
Dan Williams | 0839875 | 2008-07-17 17:59:56 -0700 | [diff] [blame] | 864 | return (tx->flags & DMA_CTRL_ACK) == DMA_CTRL_ACK; |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 865 | } |
| 866 | |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 867 | #define dma_cap_set(tx, mask) __dma_cap_set((tx), &(mask)) |
| 868 | static inline void |
| 869 | __dma_cap_set(enum dma_transaction_type tx_type, dma_cap_mask_t *dstp) |
| 870 | { |
| 871 | set_bit(tx_type, dstp->bits); |
| 872 | } |
| 873 | |
Atsushi Nemoto | 0f57151 | 2009-03-06 20:07:14 +0900 | [diff] [blame] | 874 | #define dma_cap_clear(tx, mask) __dma_cap_clear((tx), &(mask)) |
| 875 | static inline void |
| 876 | __dma_cap_clear(enum dma_transaction_type tx_type, dma_cap_mask_t *dstp) |
| 877 | { |
| 878 | clear_bit(tx_type, dstp->bits); |
| 879 | } |
| 880 | |
Dan Williams | 33df8ca | 2009-01-06 11:38:15 -0700 | [diff] [blame] | 881 | #define dma_cap_zero(mask) __dma_cap_zero(&(mask)) |
| 882 | static inline void __dma_cap_zero(dma_cap_mask_t *dstp) |
| 883 | { |
| 884 | bitmap_zero(dstp->bits, DMA_TX_TYPE_END); |
| 885 | } |
| 886 | |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 887 | #define dma_has_cap(tx, mask) __dma_has_cap((tx), &(mask)) |
| 888 | static inline int |
| 889 | __dma_has_cap(enum dma_transaction_type tx_type, dma_cap_mask_t *srcp) |
| 890 | { |
| 891 | return test_bit(tx_type, srcp->bits); |
| 892 | } |
| 893 | |
| 894 | #define for_each_dma_cap_mask(cap, mask) \ |
Akinobu Mita | e5a087f | 2012-10-26 23:35:15 +0900 | [diff] [blame] | 895 | for_each_set_bit(cap, mask.bits, DMA_TX_TYPE_END) |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 896 | |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 897 | /** |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 898 | * dma_async_issue_pending - flush pending transactions to HW |
Randy Dunlap | fe4ada2 | 2006-07-03 19:44:51 -0700 | [diff] [blame] | 899 | * @chan: target DMA channel |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 900 | * |
| 901 | * This allows drivers to push copies to HW in batches, |
| 902 | * reducing MMIO writes where possible. |
| 903 | */ |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 904 | static inline void dma_async_issue_pending(struct dma_chan *chan) |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 905 | { |
Dan Williams | ec8670f | 2008-03-01 07:51:29 -0700 | [diff] [blame] | 906 | chan->device->device_issue_pending(chan); |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 907 | } |
| 908 | |
| 909 | /** |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 910 | * dma_async_is_tx_complete - poll for transaction completion |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 911 | * @chan: DMA channel |
| 912 | * @cookie: transaction identifier to check status of |
| 913 | * @last: returns last completed cookie, can be NULL |
| 914 | * @used: returns last issued cookie, can be NULL |
| 915 | * |
| 916 | * If @last and @used are passed in, upon return they reflect the driver |
| 917 | * internal state and can be used with dma_async_is_complete() to check |
| 918 | * the status of multiple cookies without re-checking hardware state. |
| 919 | */ |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 920 | static inline enum dma_status dma_async_is_tx_complete(struct dma_chan *chan, |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 921 | dma_cookie_t cookie, dma_cookie_t *last, dma_cookie_t *used) |
| 922 | { |
Linus Walleij | 0793448 | 2010-03-26 16:50:49 -0700 | [diff] [blame] | 923 | struct dma_tx_state state; |
| 924 | enum dma_status status; |
| 925 | |
| 926 | status = chan->device->device_tx_status(chan, cookie, &state); |
| 927 | if (last) |
| 928 | *last = state.last; |
| 929 | if (used) |
| 930 | *used = state.used; |
| 931 | return status; |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 932 | } |
| 933 | |
| 934 | /** |
| 935 | * dma_async_is_complete - test a cookie against chan state |
| 936 | * @cookie: transaction identifier to test status of |
| 937 | * @last_complete: last know completed transaction |
| 938 | * @last_used: last cookie value handed out |
| 939 | * |
Bartlomiej Zolnierkiewicz | e239345f | 2012-11-08 10:01:01 +0000 | [diff] [blame] | 940 | * dma_async_is_complete() is used in dma_async_is_tx_complete() |
Sebastian Siewior | 8a5703f | 2008-04-21 22:38:45 +0000 | [diff] [blame] | 941 | * the test logic is separated for lightweight testing of multiple cookies |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 942 | */ |
| 943 | static inline enum dma_status dma_async_is_complete(dma_cookie_t cookie, |
| 944 | dma_cookie_t last_complete, dma_cookie_t last_used) |
| 945 | { |
| 946 | if (last_complete <= last_used) { |
| 947 | if ((cookie <= last_complete) || (cookie > last_used)) |
| 948 | return DMA_SUCCESS; |
| 949 | } else { |
| 950 | if ((cookie <= last_complete) && (cookie > last_used)) |
| 951 | return DMA_SUCCESS; |
| 952 | } |
| 953 | return DMA_IN_PROGRESS; |
| 954 | } |
| 955 | |
Dan Williams | bca3469 | 2010-03-26 16:52:10 -0700 | [diff] [blame] | 956 | static inline void |
| 957 | dma_set_tx_state(struct dma_tx_state *st, dma_cookie_t last, dma_cookie_t used, u32 residue) |
| 958 | { |
| 959 | if (st) { |
| 960 | st->last = last; |
| 961 | st->used = used; |
| 962 | st->residue = residue; |
| 963 | } |
| 964 | } |
| 965 | |
Dan Williams | 7405f74 | 2007-01-02 11:10:43 -0700 | [diff] [blame] | 966 | enum dma_status dma_sync_wait(struct dma_chan *chan, dma_cookie_t cookie); |
Dan Williams | 07f2211 | 2009-01-05 17:14:31 -0700 | [diff] [blame] | 967 | #ifdef CONFIG_DMA_ENGINE |
| 968 | enum dma_status dma_wait_for_async_tx(struct dma_async_tx_descriptor *tx); |
Dan Williams | c50331e | 2009-01-19 15:33:14 -0700 | [diff] [blame] | 969 | void dma_issue_pending_all(void); |
Guennadi Liakhovetski | 8f33d52 | 2010-12-22 14:46:46 +0100 | [diff] [blame] | 970 | struct dma_chan *__dma_request_channel(dma_cap_mask_t *mask, dma_filter_fn fn, void *fn_param); |
Jon Hunter | 9a6cecc | 2012-09-14 17:41:57 -0500 | [diff] [blame] | 971 | struct dma_chan *dma_request_slave_channel(struct device *dev, char *name); |
Guennadi Liakhovetski | 8f33d52 | 2010-12-22 14:46:46 +0100 | [diff] [blame] | 972 | void dma_release_channel(struct dma_chan *chan); |
Dan Williams | 07f2211 | 2009-01-05 17:14:31 -0700 | [diff] [blame] | 973 | #else |
| 974 | static inline enum dma_status dma_wait_for_async_tx(struct dma_async_tx_descriptor *tx) |
| 975 | { |
| 976 | return DMA_SUCCESS; |
| 977 | } |
Dan Williams | c50331e | 2009-01-19 15:33:14 -0700 | [diff] [blame] | 978 | static inline void dma_issue_pending_all(void) |
| 979 | { |
Guennadi Liakhovetski | 8f33d52 | 2010-12-22 14:46:46 +0100 | [diff] [blame] | 980 | } |
| 981 | static inline struct dma_chan *__dma_request_channel(dma_cap_mask_t *mask, |
| 982 | dma_filter_fn fn, void *fn_param) |
| 983 | { |
| 984 | return NULL; |
| 985 | } |
Jon Hunter | 9a6cecc | 2012-09-14 17:41:57 -0500 | [diff] [blame] | 986 | static inline struct dma_chan *dma_request_slave_channel(struct device *dev, |
| 987 | char *name) |
| 988 | { |
Vinod Koul | d18d5f5 | 2012-09-25 16:18:55 +0530 | [diff] [blame] | 989 | return NULL; |
Jon Hunter | 9a6cecc | 2012-09-14 17:41:57 -0500 | [diff] [blame] | 990 | } |
Guennadi Liakhovetski | 8f33d52 | 2010-12-22 14:46:46 +0100 | [diff] [blame] | 991 | static inline void dma_release_channel(struct dma_chan *chan) |
| 992 | { |
Dan Williams | c50331e | 2009-01-19 15:33:14 -0700 | [diff] [blame] | 993 | } |
Dan Williams | 07f2211 | 2009-01-05 17:14:31 -0700 | [diff] [blame] | 994 | #endif |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 995 | |
| 996 | /* --- DMA device --- */ |
| 997 | |
| 998 | int dma_async_device_register(struct dma_device *device); |
| 999 | void dma_async_device_unregister(struct dma_device *device); |
Dan Williams | 07f2211 | 2009-01-05 17:14:31 -0700 | [diff] [blame] | 1000 | void dma_run_dependencies(struct dma_async_tx_descriptor *tx); |
Dan Williams | bec0851 | 2009-01-06 11:38:14 -0700 | [diff] [blame] | 1001 | struct dma_chan *dma_find_channel(enum dma_transaction_type tx_type); |
Dave Jiang | a2bd114 | 2012-04-04 16:10:46 -0700 | [diff] [blame] | 1002 | struct dma_chan *net_dma_find_channel(void); |
Dan Williams | 59b5ec2 | 2009-01-06 11:38:15 -0700 | [diff] [blame] | 1003 | #define dma_request_channel(mask, x, y) __dma_request_channel(&(mask), x, y) |
Matt Porter | 864ef69 | 2013-02-01 18:22:52 +0000 | [diff] [blame] | 1004 | #define dma_request_slave_channel_compat(mask, x, y, dev, name) \ |
| 1005 | __dma_request_slave_channel_compat(&(mask), x, y, dev, name) |
| 1006 | |
| 1007 | static inline struct dma_chan |
| 1008 | *__dma_request_slave_channel_compat(dma_cap_mask_t *mask, dma_filter_fn fn, |
| 1009 | void *fn_param, struct device *dev, |
| 1010 | char *name) |
| 1011 | { |
| 1012 | struct dma_chan *chan; |
| 1013 | |
| 1014 | chan = dma_request_slave_channel(dev, name); |
| 1015 | if (chan) |
| 1016 | return chan; |
| 1017 | |
| 1018 | return __dma_request_channel(mask, fn, fn_param); |
| 1019 | } |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 1020 | |
Chris Leech | de5506e | 2006-05-23 17:50:37 -0700 | [diff] [blame] | 1021 | /* --- Helper iov-locking functions --- */ |
| 1022 | |
| 1023 | struct dma_page_list { |
Al Viro | b2ddb90 | 2008-03-29 03:09:38 +0000 | [diff] [blame] | 1024 | char __user *base_address; |
Chris Leech | de5506e | 2006-05-23 17:50:37 -0700 | [diff] [blame] | 1025 | int nr_pages; |
| 1026 | struct page **pages; |
| 1027 | }; |
| 1028 | |
| 1029 | struct dma_pinned_list { |
| 1030 | int nr_iovecs; |
| 1031 | struct dma_page_list page_list[0]; |
| 1032 | }; |
| 1033 | |
| 1034 | struct dma_pinned_list *dma_pin_iovec_pages(struct iovec *iov, size_t len); |
| 1035 | void dma_unpin_iovec_pages(struct dma_pinned_list* pinned_list); |
| 1036 | |
| 1037 | dma_cookie_t dma_memcpy_to_iovec(struct dma_chan *chan, struct iovec *iov, |
| 1038 | struct dma_pinned_list *pinned_list, unsigned char *kdata, size_t len); |
| 1039 | dma_cookie_t dma_memcpy_pg_to_iovec(struct dma_chan *chan, struct iovec *iov, |
| 1040 | struct dma_pinned_list *pinned_list, struct page *page, |
| 1041 | unsigned int offset, size_t len); |
| 1042 | |
Chris Leech | c13c826 | 2006-05-23 17:18:44 -0700 | [diff] [blame] | 1043 | #endif /* DMAENGINE_H */ |