Commit | Line | Data |
---|---|---|
c13c8260 CL |
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 | */ | |
21 | #ifndef DMAENGINE_H | |
22 | #define DMAENGINE_H | |
1c0f16e5 | 23 | |
c13c8260 CL |
24 | #include <linux/device.h> |
25 | #include <linux/uio.h> | |
7405f74b | 26 | #include <linux/dma-mapping.h> |
c13c8260 | 27 | |
c13c8260 | 28 | /** |
fe4ada2d | 29 | * typedef dma_cookie_t - an opaque DMA cookie |
c13c8260 CL |
30 | * |
31 | * if dma_cookie_t is >0 it's a DMA request cookie, <0 it's an error code | |
32 | */ | |
33 | typedef s32 dma_cookie_t; | |
34 | ||
35 | #define dma_submit_error(cookie) ((cookie) < 0 ? 1 : 0) | |
36 | ||
37 | /** | |
38 | * enum dma_status - DMA transaction status | |
39 | * @DMA_SUCCESS: transaction completed successfully | |
40 | * @DMA_IN_PROGRESS: transaction not yet processed | |
41 | * @DMA_ERROR: transaction failed | |
42 | */ | |
43 | enum dma_status { | |
44 | DMA_SUCCESS, | |
45 | DMA_IN_PROGRESS, | |
46 | DMA_ERROR, | |
47 | }; | |
48 | ||
7405f74b DW |
49 | /** |
50 | * enum dma_transaction_type - DMA transaction types/indexes | |
51 | */ | |
52 | enum dma_transaction_type { | |
53 | DMA_MEMCPY, | |
54 | DMA_XOR, | |
b2f46fd8 | 55 | DMA_PQ, |
7405f74b DW |
56 | DMA_DUAL_XOR, |
57 | DMA_PQ_UPDATE, | |
099f53cb DW |
58 | DMA_XOR_VAL, |
59 | DMA_PQ_VAL, | |
7405f74b DW |
60 | DMA_MEMSET, |
61 | DMA_MEMCPY_CRC32C, | |
62 | DMA_INTERRUPT, | |
59b5ec21 | 63 | DMA_PRIVATE, |
dc0ee643 | 64 | DMA_SLAVE, |
7405f74b DW |
65 | }; |
66 | ||
67 | /* last transaction type for creation of the capabilities mask */ | |
dc0ee643 HS |
68 | #define DMA_TX_TYPE_END (DMA_SLAVE + 1) |
69 | ||
7405f74b | 70 | |
d4c56f97 | 71 | /** |
636bdeaa | 72 | * enum dma_ctrl_flags - DMA flags to augment operation preparation, |
b2f46fd8 | 73 | * control completion, and communicate status. |
d4c56f97 | 74 | * @DMA_PREP_INTERRUPT - trigger an interrupt (callback) upon completion of |
b2f46fd8 | 75 | * this transaction |
636bdeaa | 76 | * @DMA_CTRL_ACK - the descriptor cannot be reused until the client |
b2f46fd8 DW |
77 | * acknowledges receipt, i.e. has has a chance to establish any dependency |
78 | * chains | |
e1d181ef DW |
79 | * @DMA_COMPL_SKIP_SRC_UNMAP - set to disable dma-unmapping the source buffer(s) |
80 | * @DMA_COMPL_SKIP_DEST_UNMAP - set to disable dma-unmapping the destination(s) | |
4f005dbe MS |
81 | * @DMA_COMPL_SRC_UNMAP_SINGLE - set to do the source dma-unmapping as single |
82 | * (if not set, do the source dma-unmapping as page) | |
83 | * @DMA_COMPL_DEST_UNMAP_SINGLE - set to do the destination dma-unmapping as single | |
84 | * (if not set, do the destination dma-unmapping as page) | |
b2f46fd8 DW |
85 | * @DMA_PREP_PQ_DISABLE_P - prevent generation of P while generating Q |
86 | * @DMA_PREP_PQ_DISABLE_Q - prevent generation of Q while generating P | |
87 | * @DMA_PREP_CONTINUE - indicate to a driver that it is reusing buffers as | |
88 | * sources that were the result of a previous operation, in the case of a PQ | |
89 | * operation it continues the calculation with new sources | |
0403e382 DW |
90 | * @DMA_PREP_FENCE - tell the driver that subsequent operations depend |
91 | * on the result of this operation | |
d4c56f97 | 92 | */ |
636bdeaa | 93 | enum dma_ctrl_flags { |
d4c56f97 | 94 | DMA_PREP_INTERRUPT = (1 << 0), |
636bdeaa | 95 | DMA_CTRL_ACK = (1 << 1), |
e1d181ef DW |
96 | DMA_COMPL_SKIP_SRC_UNMAP = (1 << 2), |
97 | DMA_COMPL_SKIP_DEST_UNMAP = (1 << 3), | |
4f005dbe MS |
98 | DMA_COMPL_SRC_UNMAP_SINGLE = (1 << 4), |
99 | DMA_COMPL_DEST_UNMAP_SINGLE = (1 << 5), | |
f9dd2134 DW |
100 | DMA_PREP_PQ_DISABLE_P = (1 << 6), |
101 | DMA_PREP_PQ_DISABLE_Q = (1 << 7), | |
102 | DMA_PREP_CONTINUE = (1 << 8), | |
0403e382 | 103 | DMA_PREP_FENCE = (1 << 9), |
d4c56f97 DW |
104 | }; |
105 | ||
ad283ea4 DW |
106 | /** |
107 | * enum sum_check_bits - bit position of pq_check_flags | |
108 | */ | |
109 | enum sum_check_bits { | |
110 | SUM_CHECK_P = 0, | |
111 | SUM_CHECK_Q = 1, | |
112 | }; | |
113 | ||
114 | /** | |
115 | * enum pq_check_flags - result of async_{xor,pq}_zero_sum operations | |
116 | * @SUM_CHECK_P_RESULT - 1 if xor zero sum error, 0 otherwise | |
117 | * @SUM_CHECK_Q_RESULT - 1 if reed-solomon zero sum error, 0 otherwise | |
118 | */ | |
119 | enum sum_check_flags { | |
120 | SUM_CHECK_P_RESULT = (1 << SUM_CHECK_P), | |
121 | SUM_CHECK_Q_RESULT = (1 << SUM_CHECK_Q), | |
122 | }; | |
123 | ||
124 | ||
7405f74b DW |
125 | /** |
126 | * dma_cap_mask_t - capabilities bitmap modeled after cpumask_t. | |
127 | * See linux/cpumask.h | |
128 | */ | |
129 | typedef struct { DECLARE_BITMAP(bits, DMA_TX_TYPE_END); } dma_cap_mask_t; | |
130 | ||
c13c8260 CL |
131 | /** |
132 | * struct dma_chan_percpu - the per-CPU part of struct dma_chan | |
c13c8260 CL |
133 | * @memcpy_count: transaction counter |
134 | * @bytes_transferred: byte counter | |
135 | */ | |
136 | ||
137 | struct dma_chan_percpu { | |
c13c8260 CL |
138 | /* stats */ |
139 | unsigned long memcpy_count; | |
140 | unsigned long bytes_transferred; | |
141 | }; | |
142 | ||
143 | /** | |
144 | * struct dma_chan - devices supply DMA channels, clients use them | |
fe4ada2d | 145 | * @device: ptr to the dma device who supplies this channel, always !%NULL |
c13c8260 | 146 | * @cookie: last cookie value returned to client |
fe4ada2d | 147 | * @chan_id: channel ID for sysfs |
41d5e59c | 148 | * @dev: class device for sysfs |
c13c8260 CL |
149 | * @device_node: used to add this to the device chan list |
150 | * @local: per-cpu pointer to a struct dma_chan_percpu | |
7cc5bf9a | 151 | * @client-count: how many clients are using this channel |
bec08513 | 152 | * @table_count: number of appearances in the mem-to-mem allocation table |
287d8592 | 153 | * @private: private data for certain client-channel associations |
c13c8260 CL |
154 | */ |
155 | struct dma_chan { | |
c13c8260 CL |
156 | struct dma_device *device; |
157 | dma_cookie_t cookie; | |
158 | ||
159 | /* sysfs */ | |
160 | int chan_id; | |
41d5e59c | 161 | struct dma_chan_dev *dev; |
c13c8260 | 162 | |
c13c8260 CL |
163 | struct list_head device_node; |
164 | struct dma_chan_percpu *local; | |
7cc5bf9a | 165 | int client_count; |
bec08513 | 166 | int table_count; |
287d8592 | 167 | void *private; |
c13c8260 CL |
168 | }; |
169 | ||
41d5e59c DW |
170 | /** |
171 | * struct dma_chan_dev - relate sysfs device node to backing channel device | |
172 | * @chan - driver channel device | |
173 | * @device - sysfs device | |
864498aa DW |
174 | * @dev_id - parent dma_device dev_id |
175 | * @idr_ref - reference count to gate release of dma_device dev_id | |
41d5e59c DW |
176 | */ |
177 | struct dma_chan_dev { | |
178 | struct dma_chan *chan; | |
179 | struct device device; | |
864498aa DW |
180 | int dev_id; |
181 | atomic_t *idr_ref; | |
41d5e59c DW |
182 | }; |
183 | ||
184 | static inline const char *dma_chan_name(struct dma_chan *chan) | |
185 | { | |
186 | return dev_name(&chan->dev->device); | |
187 | } | |
d379b01e | 188 | |
c13c8260 CL |
189 | void dma_chan_cleanup(struct kref *kref); |
190 | ||
59b5ec21 DW |
191 | /** |
192 | * typedef dma_filter_fn - callback filter for dma_request_channel | |
193 | * @chan: channel to be reviewed | |
194 | * @filter_param: opaque parameter passed through dma_request_channel | |
195 | * | |
196 | * When this optional parameter is specified in a call to dma_request_channel a | |
197 | * suitable channel is passed to this routine for further dispositioning before | |
198 | * being returned. Where 'suitable' indicates a non-busy channel that | |
7dd60251 DW |
199 | * satisfies the given capability mask. It returns 'true' to indicate that the |
200 | * channel is suitable. | |
59b5ec21 | 201 | */ |
7dd60251 | 202 | typedef bool (*dma_filter_fn)(struct dma_chan *chan, void *filter_param); |
59b5ec21 | 203 | |
7405f74b DW |
204 | typedef void (*dma_async_tx_callback)(void *dma_async_param); |
205 | /** | |
206 | * struct dma_async_tx_descriptor - async transaction descriptor | |
207 | * ---dma generic offload fields--- | |
208 | * @cookie: tracking cookie for this transaction, set to -EBUSY if | |
209 | * this tx is sitting on a dependency list | |
636bdeaa DW |
210 | * @flags: flags to augment operation preparation, control completion, and |
211 | * communicate status | |
7405f74b DW |
212 | * @phys: physical address of the descriptor |
213 | * @tx_list: driver common field for operations that require multiple | |
214 | * descriptors | |
215 | * @chan: target channel for this operation | |
216 | * @tx_submit: set the prepared descriptor(s) to be executed by the engine | |
7405f74b DW |
217 | * @callback: routine to call after this operation is complete |
218 | * @callback_param: general parameter to pass to the callback routine | |
219 | * ---async_tx api specific fields--- | |
19242d72 | 220 | * @next: at completion submit this descriptor |
7405f74b | 221 | * @parent: pointer to the next level up in the dependency chain |
19242d72 | 222 | * @lock: protect the parent and next pointers |
7405f74b DW |
223 | */ |
224 | struct dma_async_tx_descriptor { | |
225 | dma_cookie_t cookie; | |
636bdeaa | 226 | enum dma_ctrl_flags flags; /* not a 'long' to pack with cookie */ |
7405f74b DW |
227 | dma_addr_t phys; |
228 | struct list_head tx_list; | |
229 | struct dma_chan *chan; | |
230 | dma_cookie_t (*tx_submit)(struct dma_async_tx_descriptor *tx); | |
7405f74b DW |
231 | dma_async_tx_callback callback; |
232 | void *callback_param; | |
19242d72 | 233 | struct dma_async_tx_descriptor *next; |
7405f74b DW |
234 | struct dma_async_tx_descriptor *parent; |
235 | spinlock_t lock; | |
236 | }; | |
237 | ||
c13c8260 CL |
238 | /** |
239 | * struct dma_device - info on the entity supplying DMA services | |
240 | * @chancnt: how many DMA channels are supported | |
0f571515 | 241 | * @privatecnt: how many DMA channels are requested by dma_request_channel |
c13c8260 CL |
242 | * @channels: the list of struct dma_chan |
243 | * @global_node: list_head for global dma_device_list | |
7405f74b DW |
244 | * @cap_mask: one or more dma_capability flags |
245 | * @max_xor: maximum number of xor sources, 0 if no capability | |
b2f46fd8 | 246 | * @max_pq: maximum number of PQ sources and PQ-continue capability |
fe4ada2d | 247 | * @dev_id: unique device ID |
7405f74b | 248 | * @dev: struct device reference for dma mapping api |
fe4ada2d RD |
249 | * @device_alloc_chan_resources: allocate resources and return the |
250 | * number of allocated descriptors | |
251 | * @device_free_chan_resources: release DMA channel's resources | |
7405f74b DW |
252 | * @device_prep_dma_memcpy: prepares a memcpy operation |
253 | * @device_prep_dma_xor: prepares a xor operation | |
099f53cb | 254 | * @device_prep_dma_xor_val: prepares a xor validation operation |
b2f46fd8 DW |
255 | * @device_prep_dma_pq: prepares a pq operation |
256 | * @device_prep_dma_pq_val: prepares a pqzero_sum operation | |
7405f74b DW |
257 | * @device_prep_dma_memset: prepares a memset operation |
258 | * @device_prep_dma_interrupt: prepares an end of chain interrupt operation | |
dc0ee643 HS |
259 | * @device_prep_slave_sg: prepares a slave dma operation |
260 | * @device_terminate_all: terminate all pending operations | |
1d93e52e | 261 | * @device_is_tx_complete: poll for transaction completion |
7405f74b | 262 | * @device_issue_pending: push pending transactions to hardware |
c13c8260 CL |
263 | */ |
264 | struct dma_device { | |
265 | ||
266 | unsigned int chancnt; | |
0f571515 | 267 | unsigned int privatecnt; |
c13c8260 CL |
268 | struct list_head channels; |
269 | struct list_head global_node; | |
7405f74b | 270 | dma_cap_mask_t cap_mask; |
b2f46fd8 DW |
271 | unsigned short max_xor; |
272 | unsigned short max_pq; | |
273 | #define DMA_HAS_PQ_CONTINUE (1 << 15) | |
c13c8260 | 274 | |
c13c8260 | 275 | int dev_id; |
7405f74b | 276 | struct device *dev; |
c13c8260 | 277 | |
aa1e6f1a | 278 | int (*device_alloc_chan_resources)(struct dma_chan *chan); |
c13c8260 | 279 | void (*device_free_chan_resources)(struct dma_chan *chan); |
7405f74b DW |
280 | |
281 | struct dma_async_tx_descriptor *(*device_prep_dma_memcpy)( | |
0036731c | 282 | struct dma_chan *chan, dma_addr_t dest, dma_addr_t src, |
d4c56f97 | 283 | size_t len, unsigned long flags); |
7405f74b | 284 | struct dma_async_tx_descriptor *(*device_prep_dma_xor)( |
0036731c | 285 | struct dma_chan *chan, dma_addr_t dest, dma_addr_t *src, |
d4c56f97 | 286 | unsigned int src_cnt, size_t len, unsigned long flags); |
099f53cb | 287 | struct dma_async_tx_descriptor *(*device_prep_dma_xor_val)( |
0036731c | 288 | struct dma_chan *chan, dma_addr_t *src, unsigned int src_cnt, |
ad283ea4 | 289 | size_t len, enum sum_check_flags *result, unsigned long flags); |
b2f46fd8 DW |
290 | struct dma_async_tx_descriptor *(*device_prep_dma_pq)( |
291 | struct dma_chan *chan, dma_addr_t *dst, dma_addr_t *src, | |
292 | unsigned int src_cnt, const unsigned char *scf, | |
293 | size_t len, unsigned long flags); | |
294 | struct dma_async_tx_descriptor *(*device_prep_dma_pq_val)( | |
295 | struct dma_chan *chan, dma_addr_t *pq, dma_addr_t *src, | |
296 | unsigned int src_cnt, const unsigned char *scf, size_t len, | |
297 | enum sum_check_flags *pqres, unsigned long flags); | |
7405f74b | 298 | struct dma_async_tx_descriptor *(*device_prep_dma_memset)( |
0036731c | 299 | struct dma_chan *chan, dma_addr_t dest, int value, size_t len, |
d4c56f97 | 300 | unsigned long flags); |
7405f74b | 301 | struct dma_async_tx_descriptor *(*device_prep_dma_interrupt)( |
636bdeaa | 302 | struct dma_chan *chan, unsigned long flags); |
7405f74b | 303 | |
dc0ee643 HS |
304 | struct dma_async_tx_descriptor *(*device_prep_slave_sg)( |
305 | struct dma_chan *chan, struct scatterlist *sgl, | |
306 | unsigned int sg_len, enum dma_data_direction direction, | |
307 | unsigned long flags); | |
308 | void (*device_terminate_all)(struct dma_chan *chan); | |
309 | ||
7405f74b | 310 | enum dma_status (*device_is_tx_complete)(struct dma_chan *chan, |
c13c8260 CL |
311 | dma_cookie_t cookie, dma_cookie_t *last, |
312 | dma_cookie_t *used); | |
7405f74b | 313 | void (*device_issue_pending)(struct dma_chan *chan); |
c13c8260 CL |
314 | }; |
315 | ||
b2f46fd8 DW |
316 | static inline void |
317 | dma_set_maxpq(struct dma_device *dma, int maxpq, int has_pq_continue) | |
318 | { | |
319 | dma->max_pq = maxpq; | |
320 | if (has_pq_continue) | |
321 | dma->max_pq |= DMA_HAS_PQ_CONTINUE; | |
322 | } | |
323 | ||
324 | static inline bool dmaf_continue(enum dma_ctrl_flags flags) | |
325 | { | |
326 | return (flags & DMA_PREP_CONTINUE) == DMA_PREP_CONTINUE; | |
327 | } | |
328 | ||
329 | static inline bool dmaf_p_disabled_continue(enum dma_ctrl_flags flags) | |
330 | { | |
331 | enum dma_ctrl_flags mask = DMA_PREP_CONTINUE | DMA_PREP_PQ_DISABLE_P; | |
332 | ||
333 | return (flags & mask) == mask; | |
334 | } | |
335 | ||
336 | static inline bool dma_dev_has_pq_continue(struct dma_device *dma) | |
337 | { | |
338 | return (dma->max_pq & DMA_HAS_PQ_CONTINUE) == DMA_HAS_PQ_CONTINUE; | |
339 | } | |
340 | ||
341 | static unsigned short dma_dev_to_maxpq(struct dma_device *dma) | |
342 | { | |
343 | return dma->max_pq & ~DMA_HAS_PQ_CONTINUE; | |
344 | } | |
345 | ||
346 | /* dma_maxpq - reduce maxpq in the face of continued operations | |
347 | * @dma - dma device with PQ capability | |
348 | * @flags - to check if DMA_PREP_CONTINUE and DMA_PREP_PQ_DISABLE_P are set | |
349 | * | |
350 | * When an engine does not support native continuation we need 3 extra | |
351 | * source slots to reuse P and Q with the following coefficients: | |
352 | * 1/ {00} * P : remove P from Q', but use it as a source for P' | |
353 | * 2/ {01} * Q : use Q to continue Q' calculation | |
354 | * 3/ {00} * Q : subtract Q from P' to cancel (2) | |
355 | * | |
356 | * In the case where P is disabled we only need 1 extra source: | |
357 | * 1/ {01} * Q : use Q to continue Q' calculation | |
358 | */ | |
359 | static inline int dma_maxpq(struct dma_device *dma, enum dma_ctrl_flags flags) | |
360 | { | |
361 | if (dma_dev_has_pq_continue(dma) || !dmaf_continue(flags)) | |
362 | return dma_dev_to_maxpq(dma); | |
363 | else if (dmaf_p_disabled_continue(flags)) | |
364 | return dma_dev_to_maxpq(dma) - 1; | |
365 | else if (dmaf_continue(flags)) | |
366 | return dma_dev_to_maxpq(dma) - 3; | |
367 | BUG(); | |
368 | } | |
369 | ||
c13c8260 CL |
370 | /* --- public DMA engine API --- */ |
371 | ||
649274d9 | 372 | #ifdef CONFIG_DMA_ENGINE |
209b84a8 DW |
373 | void dmaengine_get(void); |
374 | void dmaengine_put(void); | |
649274d9 DW |
375 | #else |
376 | static inline void dmaengine_get(void) | |
377 | { | |
378 | } | |
379 | static inline void dmaengine_put(void) | |
380 | { | |
381 | } | |
382 | #endif | |
383 | ||
b4bd07c2 DM |
384 | #ifdef CONFIG_NET_DMA |
385 | #define net_dmaengine_get() dmaengine_get() | |
386 | #define net_dmaengine_put() dmaengine_put() | |
387 | #else | |
388 | static inline void net_dmaengine_get(void) | |
389 | { | |
390 | } | |
391 | static inline void net_dmaengine_put(void) | |
392 | { | |
393 | } | |
394 | #endif | |
395 | ||
729b5d1b DW |
396 | #ifdef CONFIG_ASYNC_TX_DMA |
397 | #define async_dmaengine_get() dmaengine_get() | |
398 | #define async_dmaengine_put() dmaengine_put() | |
399 | #define async_dma_find_channel(type) dma_find_channel(type) | |
400 | #else | |
401 | static inline void async_dmaengine_get(void) | |
402 | { | |
403 | } | |
404 | static inline void async_dmaengine_put(void) | |
405 | { | |
406 | } | |
407 | static inline struct dma_chan * | |
408 | async_dma_find_channel(enum dma_transaction_type type) | |
409 | { | |
410 | return NULL; | |
411 | } | |
412 | #endif | |
413 | ||
7405f74b DW |
414 | dma_cookie_t dma_async_memcpy_buf_to_buf(struct dma_chan *chan, |
415 | void *dest, void *src, size_t len); | |
416 | dma_cookie_t dma_async_memcpy_buf_to_pg(struct dma_chan *chan, | |
417 | struct page *page, unsigned int offset, void *kdata, size_t len); | |
418 | dma_cookie_t dma_async_memcpy_pg_to_pg(struct dma_chan *chan, | |
419 | struct page *dest_pg, unsigned int dest_off, struct page *src_pg, | |
420 | unsigned int src_off, size_t len); | |
421 | void dma_async_tx_descriptor_init(struct dma_async_tx_descriptor *tx, | |
422 | struct dma_chan *chan); | |
c13c8260 | 423 | |
0839875e | 424 | static inline void async_tx_ack(struct dma_async_tx_descriptor *tx) |
7405f74b | 425 | { |
636bdeaa DW |
426 | tx->flags |= DMA_CTRL_ACK; |
427 | } | |
428 | ||
ef560682 GL |
429 | static inline void async_tx_clear_ack(struct dma_async_tx_descriptor *tx) |
430 | { | |
431 | tx->flags &= ~DMA_CTRL_ACK; | |
432 | } | |
433 | ||
0839875e | 434 | static inline bool async_tx_test_ack(struct dma_async_tx_descriptor *tx) |
636bdeaa | 435 | { |
0839875e | 436 | return (tx->flags & DMA_CTRL_ACK) == DMA_CTRL_ACK; |
c13c8260 CL |
437 | } |
438 | ||
7405f74b DW |
439 | #define first_dma_cap(mask) __first_dma_cap(&(mask)) |
440 | static inline int __first_dma_cap(const dma_cap_mask_t *srcp) | |
c13c8260 | 441 | { |
7405f74b DW |
442 | return min_t(int, DMA_TX_TYPE_END, |
443 | find_first_bit(srcp->bits, DMA_TX_TYPE_END)); | |
444 | } | |
c13c8260 | 445 | |
7405f74b DW |
446 | #define next_dma_cap(n, mask) __next_dma_cap((n), &(mask)) |
447 | static inline int __next_dma_cap(int n, const dma_cap_mask_t *srcp) | |
448 | { | |
449 | return min_t(int, DMA_TX_TYPE_END, | |
450 | find_next_bit(srcp->bits, DMA_TX_TYPE_END, n+1)); | |
c13c8260 CL |
451 | } |
452 | ||
7405f74b DW |
453 | #define dma_cap_set(tx, mask) __dma_cap_set((tx), &(mask)) |
454 | static inline void | |
455 | __dma_cap_set(enum dma_transaction_type tx_type, dma_cap_mask_t *dstp) | |
c13c8260 | 456 | { |
7405f74b DW |
457 | set_bit(tx_type, dstp->bits); |
458 | } | |
c13c8260 | 459 | |
0f571515 AN |
460 | #define dma_cap_clear(tx, mask) __dma_cap_clear((tx), &(mask)) |
461 | static inline void | |
462 | __dma_cap_clear(enum dma_transaction_type tx_type, dma_cap_mask_t *dstp) | |
463 | { | |
464 | clear_bit(tx_type, dstp->bits); | |
465 | } | |
466 | ||
33df8ca0 DW |
467 | #define dma_cap_zero(mask) __dma_cap_zero(&(mask)) |
468 | static inline void __dma_cap_zero(dma_cap_mask_t *dstp) | |
469 | { | |
470 | bitmap_zero(dstp->bits, DMA_TX_TYPE_END); | |
471 | } | |
472 | ||
7405f74b DW |
473 | #define dma_has_cap(tx, mask) __dma_has_cap((tx), &(mask)) |
474 | static inline int | |
475 | __dma_has_cap(enum dma_transaction_type tx_type, dma_cap_mask_t *srcp) | |
476 | { | |
477 | return test_bit(tx_type, srcp->bits); | |
c13c8260 CL |
478 | } |
479 | ||
7405f74b DW |
480 | #define for_each_dma_cap_mask(cap, mask) \ |
481 | for ((cap) = first_dma_cap(mask); \ | |
482 | (cap) < DMA_TX_TYPE_END; \ | |
483 | (cap) = next_dma_cap((cap), (mask))) | |
484 | ||
c13c8260 | 485 | /** |
7405f74b | 486 | * dma_async_issue_pending - flush pending transactions to HW |
fe4ada2d | 487 | * @chan: target DMA channel |
c13c8260 CL |
488 | * |
489 | * This allows drivers to push copies to HW in batches, | |
490 | * reducing MMIO writes where possible. | |
491 | */ | |
7405f74b | 492 | static inline void dma_async_issue_pending(struct dma_chan *chan) |
c13c8260 | 493 | { |
ec8670f1 | 494 | chan->device->device_issue_pending(chan); |
c13c8260 CL |
495 | } |
496 | ||
7405f74b DW |
497 | #define dma_async_memcpy_issue_pending(chan) dma_async_issue_pending(chan) |
498 | ||
c13c8260 | 499 | /** |
7405f74b | 500 | * dma_async_is_tx_complete - poll for transaction completion |
c13c8260 CL |
501 | * @chan: DMA channel |
502 | * @cookie: transaction identifier to check status of | |
503 | * @last: returns last completed cookie, can be NULL | |
504 | * @used: returns last issued cookie, can be NULL | |
505 | * | |
506 | * If @last and @used are passed in, upon return they reflect the driver | |
507 | * internal state and can be used with dma_async_is_complete() to check | |
508 | * the status of multiple cookies without re-checking hardware state. | |
509 | */ | |
7405f74b | 510 | static inline enum dma_status dma_async_is_tx_complete(struct dma_chan *chan, |
c13c8260 CL |
511 | dma_cookie_t cookie, dma_cookie_t *last, dma_cookie_t *used) |
512 | { | |
7405f74b | 513 | return chan->device->device_is_tx_complete(chan, cookie, last, used); |
c13c8260 CL |
514 | } |
515 | ||
7405f74b DW |
516 | #define dma_async_memcpy_complete(chan, cookie, last, used)\ |
517 | dma_async_is_tx_complete(chan, cookie, last, used) | |
518 | ||
c13c8260 CL |
519 | /** |
520 | * dma_async_is_complete - test a cookie against chan state | |
521 | * @cookie: transaction identifier to test status of | |
522 | * @last_complete: last know completed transaction | |
523 | * @last_used: last cookie value handed out | |
524 | * | |
525 | * dma_async_is_complete() is used in dma_async_memcpy_complete() | |
8a5703f8 | 526 | * the test logic is separated for lightweight testing of multiple cookies |
c13c8260 CL |
527 | */ |
528 | static inline enum dma_status dma_async_is_complete(dma_cookie_t cookie, | |
529 | dma_cookie_t last_complete, dma_cookie_t last_used) | |
530 | { | |
531 | if (last_complete <= last_used) { | |
532 | if ((cookie <= last_complete) || (cookie > last_used)) | |
533 | return DMA_SUCCESS; | |
534 | } else { | |
535 | if ((cookie <= last_complete) && (cookie > last_used)) | |
536 | return DMA_SUCCESS; | |
537 | } | |
538 | return DMA_IN_PROGRESS; | |
539 | } | |
540 | ||
7405f74b | 541 | enum dma_status dma_sync_wait(struct dma_chan *chan, dma_cookie_t cookie); |
07f2211e DW |
542 | #ifdef CONFIG_DMA_ENGINE |
543 | enum dma_status dma_wait_for_async_tx(struct dma_async_tx_descriptor *tx); | |
c50331e8 | 544 | void dma_issue_pending_all(void); |
07f2211e DW |
545 | #else |
546 | static inline enum dma_status dma_wait_for_async_tx(struct dma_async_tx_descriptor *tx) | |
547 | { | |
548 | return DMA_SUCCESS; | |
549 | } | |
c50331e8 DW |
550 | static inline void dma_issue_pending_all(void) |
551 | { | |
552 | do { } while (0); | |
553 | } | |
07f2211e | 554 | #endif |
c13c8260 CL |
555 | |
556 | /* --- DMA device --- */ | |
557 | ||
558 | int dma_async_device_register(struct dma_device *device); | |
559 | void dma_async_device_unregister(struct dma_device *device); | |
07f2211e | 560 | void dma_run_dependencies(struct dma_async_tx_descriptor *tx); |
bec08513 | 561 | struct dma_chan *dma_find_channel(enum dma_transaction_type tx_type); |
59b5ec21 DW |
562 | #define dma_request_channel(mask, x, y) __dma_request_channel(&(mask), x, y) |
563 | struct dma_chan *__dma_request_channel(dma_cap_mask_t *mask, dma_filter_fn fn, void *fn_param); | |
564 | void dma_release_channel(struct dma_chan *chan); | |
c13c8260 | 565 | |
de5506e1 CL |
566 | /* --- Helper iov-locking functions --- */ |
567 | ||
568 | struct dma_page_list { | |
b2ddb901 | 569 | char __user *base_address; |
de5506e1 CL |
570 | int nr_pages; |
571 | struct page **pages; | |
572 | }; | |
573 | ||
574 | struct dma_pinned_list { | |
575 | int nr_iovecs; | |
576 | struct dma_page_list page_list[0]; | |
577 | }; | |
578 | ||
579 | struct dma_pinned_list *dma_pin_iovec_pages(struct iovec *iov, size_t len); | |
580 | void dma_unpin_iovec_pages(struct dma_pinned_list* pinned_list); | |
581 | ||
582 | dma_cookie_t dma_memcpy_to_iovec(struct dma_chan *chan, struct iovec *iov, | |
583 | struct dma_pinned_list *pinned_list, unsigned char *kdata, size_t len); | |
584 | dma_cookie_t dma_memcpy_pg_to_iovec(struct dma_chan *chan, struct iovec *iov, | |
585 | struct dma_pinned_list *pinned_list, struct page *page, | |
586 | unsigned int offset, size_t len); | |
587 | ||
c13c8260 | 588 | #endif /* DMAENGINE_H */ |