2 * Copyright(c) 2004 - 2006 Intel Corporation. All rights reserved.
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)
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
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.
18 * The full GNU General Public License is included in this distribution in the
19 * file called COPYING.
24 #include <linux/device.h>
25 #include <linux/uio.h>
26 #include <linux/dma-mapping.h>
29 * typedef dma_cookie_t - an opaque DMA cookie
31 * if dma_cookie_t is >0 it's a DMA request cookie, <0 it's an error code
33 typedef s32 dma_cookie_t;
35 #define dma_submit_error(cookie) ((cookie) < 0 ? 1 : 0)
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
50 * enum dma_transaction_type - DMA transaction types/indexes
52 enum dma_transaction_type {
67 /* last transaction type for creation of the capabilities mask */
68 #define DMA_TX_TYPE_END (DMA_SLAVE + 1)
72 * enum dma_ctrl_flags - DMA flags to augment operation preparation,
73 * control completion, and communicate status.
74 * @DMA_PREP_INTERRUPT - trigger an interrupt (callback) upon completion of
76 * @DMA_CTRL_ACK - the descriptor cannot be reused until the client
77 * acknowledges receipt, i.e. has has a chance to establish any dependency
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)
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)
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
92 DMA_PREP_INTERRUPT = (1 << 0),
93 DMA_CTRL_ACK = (1 << 1),
94 DMA_COMPL_SKIP_SRC_UNMAP = (1 << 2),
95 DMA_COMPL_SKIP_DEST_UNMAP = (1 << 3),
96 DMA_COMPL_SRC_UNMAP_SINGLE = (1 << 4),
97 DMA_COMPL_DEST_UNMAP_SINGLE = (1 << 5),
98 DMA_PREP_PQ_DISABLE_P = (1 << 6),
99 DMA_PREP_PQ_DISABLE_Q = (1 << 7),
100 DMA_PREP_CONTINUE = (1 << 8),
104 * enum sum_check_bits - bit position of pq_check_flags
106 enum sum_check_bits {
112 * enum pq_check_flags - result of async_{xor,pq}_zero_sum operations
113 * @SUM_CHECK_P_RESULT - 1 if xor zero sum error, 0 otherwise
114 * @SUM_CHECK_Q_RESULT - 1 if reed-solomon zero sum error, 0 otherwise
116 enum sum_check_flags {
117 SUM_CHECK_P_RESULT = (1 << SUM_CHECK_P),
118 SUM_CHECK_Q_RESULT = (1 << SUM_CHECK_Q),
123 * dma_cap_mask_t - capabilities bitmap modeled after cpumask_t.
124 * See linux/cpumask.h
126 typedef struct { DECLARE_BITMAP(bits, DMA_TX_TYPE_END); } dma_cap_mask_t;
129 * struct dma_chan_percpu - the per-CPU part of struct dma_chan
130 * @memcpy_count: transaction counter
131 * @bytes_transferred: byte counter
134 struct dma_chan_percpu {
136 unsigned long memcpy_count;
137 unsigned long bytes_transferred;
141 * struct dma_chan - devices supply DMA channels, clients use them
142 * @device: ptr to the dma device who supplies this channel, always !%NULL
143 * @cookie: last cookie value returned to client
144 * @chan_id: channel ID for sysfs
145 * @dev: class device for sysfs
146 * @device_node: used to add this to the device chan list
147 * @local: per-cpu pointer to a struct dma_chan_percpu
148 * @client-count: how many clients are using this channel
149 * @table_count: number of appearances in the mem-to-mem allocation table
150 * @private: private data for certain client-channel associations
153 struct dma_device *device;
158 struct dma_chan_dev *dev;
160 struct list_head device_node;
161 struct dma_chan_percpu *local;
168 * struct dma_chan_dev - relate sysfs device node to backing channel device
169 * @chan - driver channel device
170 * @device - sysfs device
171 * @dev_id - parent dma_device dev_id
172 * @idr_ref - reference count to gate release of dma_device dev_id
174 struct dma_chan_dev {
175 struct dma_chan *chan;
176 struct device device;
181 static inline const char *dma_chan_name(struct dma_chan *chan)
183 return dev_name(&chan->dev->device);
186 void dma_chan_cleanup(struct kref *kref);
189 * typedef dma_filter_fn - callback filter for dma_request_channel
190 * @chan: channel to be reviewed
191 * @filter_param: opaque parameter passed through dma_request_channel
193 * When this optional parameter is specified in a call to dma_request_channel a
194 * suitable channel is passed to this routine for further dispositioning before
195 * being returned. Where 'suitable' indicates a non-busy channel that
196 * satisfies the given capability mask. It returns 'true' to indicate that the
197 * channel is suitable.
199 typedef bool (*dma_filter_fn)(struct dma_chan *chan, void *filter_param);
201 typedef void (*dma_async_tx_callback)(void *dma_async_param);
203 * struct dma_async_tx_descriptor - async transaction descriptor
204 * ---dma generic offload fields---
205 * @cookie: tracking cookie for this transaction, set to -EBUSY if
206 * this tx is sitting on a dependency list
207 * @flags: flags to augment operation preparation, control completion, and
209 * @phys: physical address of the descriptor
210 * @tx_list: driver common field for operations that require multiple
212 * @chan: target channel for this operation
213 * @tx_submit: set the prepared descriptor(s) to be executed by the engine
214 * @callback: routine to call after this operation is complete
215 * @callback_param: general parameter to pass to the callback routine
216 * ---async_tx api specific fields---
217 * @next: at completion submit this descriptor
218 * @parent: pointer to the next level up in the dependency chain
219 * @lock: protect the parent and next pointers
221 struct dma_async_tx_descriptor {
223 enum dma_ctrl_flags flags; /* not a 'long' to pack with cookie */
225 struct list_head tx_list;
226 struct dma_chan *chan;
227 dma_cookie_t (*tx_submit)(struct dma_async_tx_descriptor *tx);
228 dma_async_tx_callback callback;
229 void *callback_param;
230 struct dma_async_tx_descriptor *next;
231 struct dma_async_tx_descriptor *parent;
236 * struct dma_device - info on the entity supplying DMA services
237 * @chancnt: how many DMA channels are supported
238 * @privatecnt: how many DMA channels are requested by dma_request_channel
239 * @channels: the list of struct dma_chan
240 * @global_node: list_head for global dma_device_list
241 * @cap_mask: one or more dma_capability flags
242 * @max_xor: maximum number of xor sources, 0 if no capability
243 * @max_pq: maximum number of PQ sources and PQ-continue capability
244 * @dev_id: unique device ID
245 * @dev: struct device reference for dma mapping api
246 * @device_alloc_chan_resources: allocate resources and return the
247 * number of allocated descriptors
248 * @device_free_chan_resources: release DMA channel's resources
249 * @device_prep_dma_memcpy: prepares a memcpy operation
250 * @device_prep_dma_xor: prepares a xor operation
251 * @device_prep_dma_xor_val: prepares a xor validation operation
252 * @device_prep_dma_pq: prepares a pq operation
253 * @device_prep_dma_pq_val: prepares a pqzero_sum operation
254 * @device_prep_dma_memset: prepares a memset operation
255 * @device_prep_dma_interrupt: prepares an end of chain interrupt operation
256 * @device_prep_slave_sg: prepares a slave dma operation
257 * @device_terminate_all: terminate all pending operations
258 * @device_is_tx_complete: poll for transaction completion
259 * @device_issue_pending: push pending transactions to hardware
263 unsigned int chancnt;
264 unsigned int privatecnt;
265 struct list_head channels;
266 struct list_head global_node;
267 dma_cap_mask_t cap_mask;
268 unsigned short max_xor;
269 unsigned short max_pq;
270 #define DMA_HAS_PQ_CONTINUE (1 << 15)
275 int (*device_alloc_chan_resources)(struct dma_chan *chan);
276 void (*device_free_chan_resources)(struct dma_chan *chan);
278 struct dma_async_tx_descriptor *(*device_prep_dma_memcpy)(
279 struct dma_chan *chan, dma_addr_t dest, dma_addr_t src,
280 size_t len, unsigned long flags);
281 struct dma_async_tx_descriptor *(*device_prep_dma_xor)(
282 struct dma_chan *chan, dma_addr_t dest, dma_addr_t *src,
283 unsigned int src_cnt, size_t len, unsigned long flags);
284 struct dma_async_tx_descriptor *(*device_prep_dma_xor_val)(
285 struct dma_chan *chan, dma_addr_t *src, unsigned int src_cnt,
286 size_t len, enum sum_check_flags *result, unsigned long flags);
287 struct dma_async_tx_descriptor *(*device_prep_dma_pq)(
288 struct dma_chan *chan, dma_addr_t *dst, dma_addr_t *src,
289 unsigned int src_cnt, const unsigned char *scf,
290 size_t len, unsigned long flags);
291 struct dma_async_tx_descriptor *(*device_prep_dma_pq_val)(
292 struct dma_chan *chan, dma_addr_t *pq, dma_addr_t *src,
293 unsigned int src_cnt, const unsigned char *scf, size_t len,
294 enum sum_check_flags *pqres, unsigned long flags);
295 struct dma_async_tx_descriptor *(*device_prep_dma_memset)(
296 struct dma_chan *chan, dma_addr_t dest, int value, size_t len,
297 unsigned long flags);
298 struct dma_async_tx_descriptor *(*device_prep_dma_interrupt)(
299 struct dma_chan *chan, unsigned long flags);
301 struct dma_async_tx_descriptor *(*device_prep_slave_sg)(
302 struct dma_chan *chan, struct scatterlist *sgl,
303 unsigned int sg_len, enum dma_data_direction direction,
304 unsigned long flags);
305 void (*device_terminate_all)(struct dma_chan *chan);
307 enum dma_status (*device_is_tx_complete)(struct dma_chan *chan,
308 dma_cookie_t cookie, dma_cookie_t *last,
310 void (*device_issue_pending)(struct dma_chan *chan);
314 dma_set_maxpq(struct dma_device *dma, int maxpq, int has_pq_continue)
318 dma->max_pq |= DMA_HAS_PQ_CONTINUE;
321 static inline bool dmaf_continue(enum dma_ctrl_flags flags)
323 return (flags & DMA_PREP_CONTINUE) == DMA_PREP_CONTINUE;
326 static inline bool dmaf_p_disabled_continue(enum dma_ctrl_flags flags)
328 enum dma_ctrl_flags mask = DMA_PREP_CONTINUE | DMA_PREP_PQ_DISABLE_P;
330 return (flags & mask) == mask;
333 static inline bool dma_dev_has_pq_continue(struct dma_device *dma)
335 return (dma->max_pq & DMA_HAS_PQ_CONTINUE) == DMA_HAS_PQ_CONTINUE;
338 static unsigned short dma_dev_to_maxpq(struct dma_device *dma)
340 return dma->max_pq & ~DMA_HAS_PQ_CONTINUE;
343 /* dma_maxpq - reduce maxpq in the face of continued operations
344 * @dma - dma device with PQ capability
345 * @flags - to check if DMA_PREP_CONTINUE and DMA_PREP_PQ_DISABLE_P are set
347 * When an engine does not support native continuation we need 3 extra
348 * source slots to reuse P and Q with the following coefficients:
349 * 1/ {00} * P : remove P from Q', but use it as a source for P'
350 * 2/ {01} * Q : use Q to continue Q' calculation
351 * 3/ {00} * Q : subtract Q from P' to cancel (2)
353 * In the case where P is disabled we only need 1 extra source:
354 * 1/ {01} * Q : use Q to continue Q' calculation
356 static inline int dma_maxpq(struct dma_device *dma, enum dma_ctrl_flags flags)
358 if (dma_dev_has_pq_continue(dma) || !dmaf_continue(flags))
359 return dma_dev_to_maxpq(dma);
360 else if (dmaf_p_disabled_continue(flags))
361 return dma_dev_to_maxpq(dma) - 1;
362 else if (dmaf_continue(flags))
363 return dma_dev_to_maxpq(dma) - 3;
367 /* --- public DMA engine API --- */
369 #ifdef CONFIG_DMA_ENGINE
370 void dmaengine_get(void);
371 void dmaengine_put(void);
373 static inline void dmaengine_get(void)
376 static inline void dmaengine_put(void)
381 #ifdef CONFIG_NET_DMA
382 #define net_dmaengine_get() dmaengine_get()
383 #define net_dmaengine_put() dmaengine_put()
385 static inline void net_dmaengine_get(void)
388 static inline void net_dmaengine_put(void)
393 #ifdef CONFIG_ASYNC_TX_DMA
394 #define async_dmaengine_get() dmaengine_get()
395 #define async_dmaengine_put() dmaengine_put()
396 #define async_dma_find_channel(type) dma_find_channel(type)
398 static inline void async_dmaengine_get(void)
401 static inline void async_dmaengine_put(void)
404 static inline struct dma_chan *
405 async_dma_find_channel(enum dma_transaction_type type)
411 dma_cookie_t dma_async_memcpy_buf_to_buf(struct dma_chan *chan,
412 void *dest, void *src, size_t len);
413 dma_cookie_t dma_async_memcpy_buf_to_pg(struct dma_chan *chan,
414 struct page *page, unsigned int offset, void *kdata, size_t len);
415 dma_cookie_t dma_async_memcpy_pg_to_pg(struct dma_chan *chan,
416 struct page *dest_pg, unsigned int dest_off, struct page *src_pg,
417 unsigned int src_off, size_t len);
418 void dma_async_tx_descriptor_init(struct dma_async_tx_descriptor *tx,
419 struct dma_chan *chan);
421 static inline void async_tx_ack(struct dma_async_tx_descriptor *tx)
423 tx->flags |= DMA_CTRL_ACK;
426 static inline void async_tx_clear_ack(struct dma_async_tx_descriptor *tx)
428 tx->flags &= ~DMA_CTRL_ACK;
431 static inline bool async_tx_test_ack(struct dma_async_tx_descriptor *tx)
433 return (tx->flags & DMA_CTRL_ACK) == DMA_CTRL_ACK;
436 #define first_dma_cap(mask) __first_dma_cap(&(mask))
437 static inline int __first_dma_cap(const dma_cap_mask_t *srcp)
439 return min_t(int, DMA_TX_TYPE_END,
440 find_first_bit(srcp->bits, DMA_TX_TYPE_END));
443 #define next_dma_cap(n, mask) __next_dma_cap((n), &(mask))
444 static inline int __next_dma_cap(int n, const dma_cap_mask_t *srcp)
446 return min_t(int, DMA_TX_TYPE_END,
447 find_next_bit(srcp->bits, DMA_TX_TYPE_END, n+1));
450 #define dma_cap_set(tx, mask) __dma_cap_set((tx), &(mask))
452 __dma_cap_set(enum dma_transaction_type tx_type, dma_cap_mask_t *dstp)
454 set_bit(tx_type, dstp->bits);
457 #define dma_cap_clear(tx, mask) __dma_cap_clear((tx), &(mask))
459 __dma_cap_clear(enum dma_transaction_type tx_type, dma_cap_mask_t *dstp)
461 clear_bit(tx_type, dstp->bits);
464 #define dma_cap_zero(mask) __dma_cap_zero(&(mask))
465 static inline void __dma_cap_zero(dma_cap_mask_t *dstp)
467 bitmap_zero(dstp->bits, DMA_TX_TYPE_END);
470 #define dma_has_cap(tx, mask) __dma_has_cap((tx), &(mask))
472 __dma_has_cap(enum dma_transaction_type tx_type, dma_cap_mask_t *srcp)
474 return test_bit(tx_type, srcp->bits);
477 #define for_each_dma_cap_mask(cap, mask) \
478 for ((cap) = first_dma_cap(mask); \
479 (cap) < DMA_TX_TYPE_END; \
480 (cap) = next_dma_cap((cap), (mask)))
483 * dma_async_issue_pending - flush pending transactions to HW
484 * @chan: target DMA channel
486 * This allows drivers to push copies to HW in batches,
487 * reducing MMIO writes where possible.
489 static inline void dma_async_issue_pending(struct dma_chan *chan)
491 chan->device->device_issue_pending(chan);
494 #define dma_async_memcpy_issue_pending(chan) dma_async_issue_pending(chan)
497 * dma_async_is_tx_complete - poll for transaction completion
499 * @cookie: transaction identifier to check status of
500 * @last: returns last completed cookie, can be NULL
501 * @used: returns last issued cookie, can be NULL
503 * If @last and @used are passed in, upon return they reflect the driver
504 * internal state and can be used with dma_async_is_complete() to check
505 * the status of multiple cookies without re-checking hardware state.
507 static inline enum dma_status dma_async_is_tx_complete(struct dma_chan *chan,
508 dma_cookie_t cookie, dma_cookie_t *last, dma_cookie_t *used)
510 return chan->device->device_is_tx_complete(chan, cookie, last, used);
513 #define dma_async_memcpy_complete(chan, cookie, last, used)\
514 dma_async_is_tx_complete(chan, cookie, last, used)
517 * dma_async_is_complete - test a cookie against chan state
518 * @cookie: transaction identifier to test status of
519 * @last_complete: last know completed transaction
520 * @last_used: last cookie value handed out
522 * dma_async_is_complete() is used in dma_async_memcpy_complete()
523 * the test logic is separated for lightweight testing of multiple cookies
525 static inline enum dma_status dma_async_is_complete(dma_cookie_t cookie,
526 dma_cookie_t last_complete, dma_cookie_t last_used)
528 if (last_complete <= last_used) {
529 if ((cookie <= last_complete) || (cookie > last_used))
532 if ((cookie <= last_complete) && (cookie > last_used))
535 return DMA_IN_PROGRESS;
538 enum dma_status dma_sync_wait(struct dma_chan *chan, dma_cookie_t cookie);
539 #ifdef CONFIG_DMA_ENGINE
540 enum dma_status dma_wait_for_async_tx(struct dma_async_tx_descriptor *tx);
541 void dma_issue_pending_all(void);
543 static inline enum dma_status dma_wait_for_async_tx(struct dma_async_tx_descriptor *tx)
547 static inline void dma_issue_pending_all(void)
553 /* --- DMA device --- */
555 int dma_async_device_register(struct dma_device *device);
556 void dma_async_device_unregister(struct dma_device *device);
557 void dma_run_dependencies(struct dma_async_tx_descriptor *tx);
558 struct dma_chan *dma_find_channel(enum dma_transaction_type tx_type);
559 #define dma_request_channel(mask, x, y) __dma_request_channel(&(mask), x, y)
560 struct dma_chan *__dma_request_channel(dma_cap_mask_t *mask, dma_filter_fn fn, void *fn_param);
561 void dma_release_channel(struct dma_chan *chan);
563 /* --- Helper iov-locking functions --- */
565 struct dma_page_list {
566 char __user *base_address;
571 struct dma_pinned_list {
573 struct dma_page_list page_list[0];
576 struct dma_pinned_list *dma_pin_iovec_pages(struct iovec *iov, size_t len);
577 void dma_unpin_iovec_pages(struct dma_pinned_list* pinned_list);
579 dma_cookie_t dma_memcpy_to_iovec(struct dma_chan *chan, struct iovec *iov,
580 struct dma_pinned_list *pinned_list, unsigned char *kdata, size_t len);
581 dma_cookie_t dma_memcpy_pg_to_iovec(struct dma_chan *chan, struct iovec *iov,
582 struct dma_pinned_list *pinned_list, struct page *page,
583 unsigned int offset, size_t len);
585 #endif /* DMAENGINE_H */