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;
34 #define DMA_MIN_COOKIE 1
35 #define DMA_MAX_COOKIE INT_MAX
37 #define dma_submit_error(cookie) ((cookie) < 0 ? 1 : 0)
40 * enum dma_status - DMA transaction status
41 * @DMA_SUCCESS: transaction completed successfully
42 * @DMA_IN_PROGRESS: transaction not yet processed
43 * @DMA_PAUSED: transaction is paused
44 * @DMA_ERROR: transaction failed
54 * enum dma_transaction_type - DMA transaction types/indexes
56 * Note: The DMA_ASYNC_TX capability is not to be set by drivers. It is
57 * automatically set as dma devices are registered.
59 enum dma_transaction_type {
72 /* last transaction type for creation of the capabilities mask */
73 #define DMA_TX_TYPE_END (DMA_SLAVE + 1)
77 * enum dma_ctrl_flags - DMA flags to augment operation preparation,
78 * control completion, and communicate status.
79 * @DMA_PREP_INTERRUPT - trigger an interrupt (callback) upon completion of
81 * @DMA_CTRL_ACK - if clear, the descriptor cannot be reused until the client
82 * acknowledges receipt, i.e. has has a chance to establish any dependency
84 * @DMA_COMPL_SKIP_SRC_UNMAP - set to disable dma-unmapping the source buffer(s)
85 * @DMA_COMPL_SKIP_DEST_UNMAP - set to disable dma-unmapping the destination(s)
86 * @DMA_COMPL_SRC_UNMAP_SINGLE - set to do the source dma-unmapping as single
87 * (if not set, do the source dma-unmapping as page)
88 * @DMA_COMPL_DEST_UNMAP_SINGLE - set to do the destination dma-unmapping as single
89 * (if not set, do the destination dma-unmapping as page)
90 * @DMA_PREP_PQ_DISABLE_P - prevent generation of P while generating Q
91 * @DMA_PREP_PQ_DISABLE_Q - prevent generation of Q while generating P
92 * @DMA_PREP_CONTINUE - indicate to a driver that it is reusing buffers as
93 * sources that were the result of a previous operation, in the case of a PQ
94 * operation it continues the calculation with new sources
95 * @DMA_PREP_FENCE - tell the driver that subsequent operations depend
96 * on the result of this operation
99 DMA_PREP_INTERRUPT = (1 << 0),
100 DMA_CTRL_ACK = (1 << 1),
101 DMA_COMPL_SKIP_SRC_UNMAP = (1 << 2),
102 DMA_COMPL_SKIP_DEST_UNMAP = (1 << 3),
103 DMA_COMPL_SRC_UNMAP_SINGLE = (1 << 4),
104 DMA_COMPL_DEST_UNMAP_SINGLE = (1 << 5),
105 DMA_PREP_PQ_DISABLE_P = (1 << 6),
106 DMA_PREP_PQ_DISABLE_Q = (1 << 7),
107 DMA_PREP_CONTINUE = (1 << 8),
108 DMA_PREP_FENCE = (1 << 9),
112 * enum dma_ctrl_cmd - DMA operations that can optionally be exercised
113 * on a running channel.
114 * @DMA_TERMINATE_ALL: terminate all ongoing transfers
115 * @DMA_PAUSE: pause ongoing transfers
116 * @DMA_RESUME: resume paused transfer
125 * enum sum_check_bits - bit position of pq_check_flags
127 enum sum_check_bits {
133 * enum pq_check_flags - result of async_{xor,pq}_zero_sum operations
134 * @SUM_CHECK_P_RESULT - 1 if xor zero sum error, 0 otherwise
135 * @SUM_CHECK_Q_RESULT - 1 if reed-solomon zero sum error, 0 otherwise
137 enum sum_check_flags {
138 SUM_CHECK_P_RESULT = (1 << SUM_CHECK_P),
139 SUM_CHECK_Q_RESULT = (1 << SUM_CHECK_Q),
144 * dma_cap_mask_t - capabilities bitmap modeled after cpumask_t.
145 * See linux/cpumask.h
147 typedef struct { DECLARE_BITMAP(bits, DMA_TX_TYPE_END); } dma_cap_mask_t;
150 * struct dma_chan_percpu - the per-CPU part of struct dma_chan
151 * @memcpy_count: transaction counter
152 * @bytes_transferred: byte counter
155 struct dma_chan_percpu {
157 unsigned long memcpy_count;
158 unsigned long bytes_transferred;
162 * struct dma_chan - devices supply DMA channels, clients use them
163 * @device: ptr to the dma device who supplies this channel, always !%NULL
164 * @cookie: last cookie value returned to client
165 * @chan_id: channel ID for sysfs
166 * @dev: class device for sysfs
167 * @device_node: used to add this to the device chan list
168 * @local: per-cpu pointer to a struct dma_chan_percpu
169 * @client-count: how many clients are using this channel
170 * @table_count: number of appearances in the mem-to-mem allocation table
171 * @private: private data for certain client-channel associations
174 struct dma_device *device;
179 struct dma_chan_dev *dev;
181 struct list_head device_node;
182 struct dma_chan_percpu __percpu *local;
189 * struct dma_chan_dev - relate sysfs device node to backing channel device
190 * @chan - driver channel device
191 * @device - sysfs device
192 * @dev_id - parent dma_device dev_id
193 * @idr_ref - reference count to gate release of dma_device dev_id
195 struct dma_chan_dev {
196 struct dma_chan *chan;
197 struct device device;
202 static inline const char *dma_chan_name(struct dma_chan *chan)
204 return dev_name(&chan->dev->device);
207 void dma_chan_cleanup(struct kref *kref);
210 * typedef dma_filter_fn - callback filter for dma_request_channel
211 * @chan: channel to be reviewed
212 * @filter_param: opaque parameter passed through dma_request_channel
214 * When this optional parameter is specified in a call to dma_request_channel a
215 * suitable channel is passed to this routine for further dispositioning before
216 * being returned. Where 'suitable' indicates a non-busy channel that
217 * satisfies the given capability mask. It returns 'true' to indicate that the
218 * channel is suitable.
220 typedef bool (*dma_filter_fn)(struct dma_chan *chan, void *filter_param);
222 typedef void (*dma_async_tx_callback)(void *dma_async_param);
224 * struct dma_async_tx_descriptor - async transaction descriptor
225 * ---dma generic offload fields---
226 * @cookie: tracking cookie for this transaction, set to -EBUSY if
227 * this tx is sitting on a dependency list
228 * @flags: flags to augment operation preparation, control completion, and
230 * @phys: physical address of the descriptor
231 * @chan: target channel for this operation
232 * @tx_submit: set the prepared descriptor(s) to be executed by the engine
233 * @callback: routine to call after this operation is complete
234 * @callback_param: general parameter to pass to the callback routine
235 * ---async_tx api specific fields---
236 * @next: at completion submit this descriptor
237 * @parent: pointer to the next level up in the dependency chain
238 * @lock: protect the parent and next pointers
240 struct dma_async_tx_descriptor {
242 enum dma_ctrl_flags flags; /* not a 'long' to pack with cookie */
244 struct dma_chan *chan;
245 dma_cookie_t (*tx_submit)(struct dma_async_tx_descriptor *tx);
246 dma_async_tx_callback callback;
247 void *callback_param;
248 struct dma_async_tx_descriptor *next;
249 struct dma_async_tx_descriptor *parent;
254 * struct dma_tx_state - filled in to report the status of
256 * @last: last completed DMA cookie
257 * @used: last issued DMA cookie (i.e. the one in progress)
258 * @residue: the remaining number of bytes left to transmit
259 * on the selected transfer for states DMA_IN_PROGRESS and
260 * DMA_PAUSED if this is implemented in the driver, else 0
262 struct dma_tx_state {
269 * struct dma_device - info on the entity supplying DMA services
270 * @chancnt: how many DMA channels are supported
271 * @privatecnt: how many DMA channels are requested by dma_request_channel
272 * @channels: the list of struct dma_chan
273 * @global_node: list_head for global dma_device_list
274 * @cap_mask: one or more dma_capability flags
275 * @max_xor: maximum number of xor sources, 0 if no capability
276 * @max_pq: maximum number of PQ sources and PQ-continue capability
277 * @copy_align: alignment shift for memcpy operations
278 * @xor_align: alignment shift for xor operations
279 * @pq_align: alignment shift for pq operations
280 * @fill_align: alignment shift for memset operations
281 * @dev_id: unique device ID
282 * @dev: struct device reference for dma mapping api
283 * @device_alloc_chan_resources: allocate resources and return the
284 * number of allocated descriptors
285 * @device_free_chan_resources: release DMA channel's resources
286 * @device_prep_dma_memcpy: prepares a memcpy operation
287 * @device_prep_dma_xor: prepares a xor operation
288 * @device_prep_dma_xor_val: prepares a xor validation operation
289 * @device_prep_dma_pq: prepares a pq operation
290 * @device_prep_dma_pq_val: prepares a pqzero_sum operation
291 * @device_prep_dma_memset: prepares a memset operation
292 * @device_prep_dma_interrupt: prepares an end of chain interrupt operation
293 * @device_prep_slave_sg: prepares a slave dma operation
294 * @device_control: manipulate all pending operations on a channel, returns
296 * @device_tx_status: poll for transaction completion, the optional
297 * txstate parameter can be supplied with a pointer to get a
298 * struct with auxilary transfer status information, otherwise the call
299 * will just return a simple status code
300 * @device_issue_pending: push pending transactions to hardware
304 unsigned int chancnt;
305 unsigned int privatecnt;
306 struct list_head channels;
307 struct list_head global_node;
308 dma_cap_mask_t cap_mask;
309 unsigned short max_xor;
310 unsigned short max_pq;
315 #define DMA_HAS_PQ_CONTINUE (1 << 15)
320 int (*device_alloc_chan_resources)(struct dma_chan *chan);
321 void (*device_free_chan_resources)(struct dma_chan *chan);
323 struct dma_async_tx_descriptor *(*device_prep_dma_memcpy)(
324 struct dma_chan *chan, dma_addr_t dest, dma_addr_t src,
325 size_t len, unsigned long flags);
326 struct dma_async_tx_descriptor *(*device_prep_dma_xor)(
327 struct dma_chan *chan, dma_addr_t dest, dma_addr_t *src,
328 unsigned int src_cnt, size_t len, unsigned long flags);
329 struct dma_async_tx_descriptor *(*device_prep_dma_xor_val)(
330 struct dma_chan *chan, dma_addr_t *src, unsigned int src_cnt,
331 size_t len, enum sum_check_flags *result, unsigned long flags);
332 struct dma_async_tx_descriptor *(*device_prep_dma_pq)(
333 struct dma_chan *chan, dma_addr_t *dst, dma_addr_t *src,
334 unsigned int src_cnt, const unsigned char *scf,
335 size_t len, unsigned long flags);
336 struct dma_async_tx_descriptor *(*device_prep_dma_pq_val)(
337 struct dma_chan *chan, dma_addr_t *pq, dma_addr_t *src,
338 unsigned int src_cnt, const unsigned char *scf, size_t len,
339 enum sum_check_flags *pqres, unsigned long flags);
340 struct dma_async_tx_descriptor *(*device_prep_dma_memset)(
341 struct dma_chan *chan, dma_addr_t dest, int value, size_t len,
342 unsigned long flags);
343 struct dma_async_tx_descriptor *(*device_prep_dma_interrupt)(
344 struct dma_chan *chan, unsigned long flags);
346 struct dma_async_tx_descriptor *(*device_prep_slave_sg)(
347 struct dma_chan *chan, struct scatterlist *sgl,
348 unsigned int sg_len, enum dma_data_direction direction,
349 unsigned long flags);
350 int (*device_control)(struct dma_chan *chan, enum dma_ctrl_cmd cmd);
352 enum dma_status (*device_tx_status)(struct dma_chan *chan,
354 struct dma_tx_state *txstate);
355 void (*device_issue_pending)(struct dma_chan *chan);
358 static inline bool dmaengine_check_align(u8 align, size_t off1, size_t off2, size_t len)
364 mask = (1 << align) - 1;
365 if (mask & (off1 | off2 | len))
370 static inline bool is_dma_copy_aligned(struct dma_device *dev, size_t off1,
371 size_t off2, size_t len)
373 return dmaengine_check_align(dev->copy_align, off1, off2, len);
376 static inline bool is_dma_xor_aligned(struct dma_device *dev, size_t off1,
377 size_t off2, size_t len)
379 return dmaengine_check_align(dev->xor_align, off1, off2, len);
382 static inline bool is_dma_pq_aligned(struct dma_device *dev, size_t off1,
383 size_t off2, size_t len)
385 return dmaengine_check_align(dev->pq_align, off1, off2, len);
388 static inline bool is_dma_fill_aligned(struct dma_device *dev, size_t off1,
389 size_t off2, size_t len)
391 return dmaengine_check_align(dev->fill_align, off1, off2, len);
395 dma_set_maxpq(struct dma_device *dma, int maxpq, int has_pq_continue)
399 dma->max_pq |= DMA_HAS_PQ_CONTINUE;
402 static inline bool dmaf_continue(enum dma_ctrl_flags flags)
404 return (flags & DMA_PREP_CONTINUE) == DMA_PREP_CONTINUE;
407 static inline bool dmaf_p_disabled_continue(enum dma_ctrl_flags flags)
409 enum dma_ctrl_flags mask = DMA_PREP_CONTINUE | DMA_PREP_PQ_DISABLE_P;
411 return (flags & mask) == mask;
414 static inline bool dma_dev_has_pq_continue(struct dma_device *dma)
416 return (dma->max_pq & DMA_HAS_PQ_CONTINUE) == DMA_HAS_PQ_CONTINUE;
419 static unsigned short dma_dev_to_maxpq(struct dma_device *dma)
421 return dma->max_pq & ~DMA_HAS_PQ_CONTINUE;
424 /* dma_maxpq - reduce maxpq in the face of continued operations
425 * @dma - dma device with PQ capability
426 * @flags - to check if DMA_PREP_CONTINUE and DMA_PREP_PQ_DISABLE_P are set
428 * When an engine does not support native continuation we need 3 extra
429 * source slots to reuse P and Q with the following coefficients:
430 * 1/ {00} * P : remove P from Q', but use it as a source for P'
431 * 2/ {01} * Q : use Q to continue Q' calculation
432 * 3/ {00} * Q : subtract Q from P' to cancel (2)
434 * In the case where P is disabled we only need 1 extra source:
435 * 1/ {01} * Q : use Q to continue Q' calculation
437 static inline int dma_maxpq(struct dma_device *dma, enum dma_ctrl_flags flags)
439 if (dma_dev_has_pq_continue(dma) || !dmaf_continue(flags))
440 return dma_dev_to_maxpq(dma);
441 else if (dmaf_p_disabled_continue(flags))
442 return dma_dev_to_maxpq(dma) - 1;
443 else if (dmaf_continue(flags))
444 return dma_dev_to_maxpq(dma) - 3;
448 /* --- public DMA engine API --- */
450 #ifdef CONFIG_DMA_ENGINE
451 void dmaengine_get(void);
452 void dmaengine_put(void);
454 static inline void dmaengine_get(void)
457 static inline void dmaengine_put(void)
462 #ifdef CONFIG_NET_DMA
463 #define net_dmaengine_get() dmaengine_get()
464 #define net_dmaengine_put() dmaengine_put()
466 static inline void net_dmaengine_get(void)
469 static inline void net_dmaengine_put(void)
474 #ifdef CONFIG_ASYNC_TX_DMA
475 #define async_dmaengine_get() dmaengine_get()
476 #define async_dmaengine_put() dmaengine_put()
477 #ifdef CONFIG_ASYNC_TX_DISABLE_CHANNEL_SWITCH
478 #define async_dma_find_channel(type) dma_find_channel(DMA_ASYNC_TX)
480 #define async_dma_find_channel(type) dma_find_channel(type)
481 #endif /* CONFIG_ASYNC_TX_DISABLE_CHANNEL_SWITCH */
483 static inline void async_dmaengine_get(void)
486 static inline void async_dmaengine_put(void)
489 static inline struct dma_chan *
490 async_dma_find_channel(enum dma_transaction_type type)
494 #endif /* CONFIG_ASYNC_TX_DMA */
496 dma_cookie_t dma_async_memcpy_buf_to_buf(struct dma_chan *chan,
497 void *dest, void *src, size_t len);
498 dma_cookie_t dma_async_memcpy_buf_to_pg(struct dma_chan *chan,
499 struct page *page, unsigned int offset, void *kdata, size_t len);
500 dma_cookie_t dma_async_memcpy_pg_to_pg(struct dma_chan *chan,
501 struct page *dest_pg, unsigned int dest_off, struct page *src_pg,
502 unsigned int src_off, size_t len);
503 void dma_async_tx_descriptor_init(struct dma_async_tx_descriptor *tx,
504 struct dma_chan *chan);
506 static inline void async_tx_ack(struct dma_async_tx_descriptor *tx)
508 tx->flags |= DMA_CTRL_ACK;
511 static inline void async_tx_clear_ack(struct dma_async_tx_descriptor *tx)
513 tx->flags &= ~DMA_CTRL_ACK;
516 static inline bool async_tx_test_ack(struct dma_async_tx_descriptor *tx)
518 return (tx->flags & DMA_CTRL_ACK) == DMA_CTRL_ACK;
521 #define first_dma_cap(mask) __first_dma_cap(&(mask))
522 static inline int __first_dma_cap(const dma_cap_mask_t *srcp)
524 return min_t(int, DMA_TX_TYPE_END,
525 find_first_bit(srcp->bits, DMA_TX_TYPE_END));
528 #define next_dma_cap(n, mask) __next_dma_cap((n), &(mask))
529 static inline int __next_dma_cap(int n, const dma_cap_mask_t *srcp)
531 return min_t(int, DMA_TX_TYPE_END,
532 find_next_bit(srcp->bits, DMA_TX_TYPE_END, n+1));
535 #define dma_cap_set(tx, mask) __dma_cap_set((tx), &(mask))
537 __dma_cap_set(enum dma_transaction_type tx_type, dma_cap_mask_t *dstp)
539 set_bit(tx_type, dstp->bits);
542 #define dma_cap_clear(tx, mask) __dma_cap_clear((tx), &(mask))
544 __dma_cap_clear(enum dma_transaction_type tx_type, dma_cap_mask_t *dstp)
546 clear_bit(tx_type, dstp->bits);
549 #define dma_cap_zero(mask) __dma_cap_zero(&(mask))
550 static inline void __dma_cap_zero(dma_cap_mask_t *dstp)
552 bitmap_zero(dstp->bits, DMA_TX_TYPE_END);
555 #define dma_has_cap(tx, mask) __dma_has_cap((tx), &(mask))
557 __dma_has_cap(enum dma_transaction_type tx_type, dma_cap_mask_t *srcp)
559 return test_bit(tx_type, srcp->bits);
562 #define for_each_dma_cap_mask(cap, mask) \
563 for ((cap) = first_dma_cap(mask); \
564 (cap) < DMA_TX_TYPE_END; \
565 (cap) = next_dma_cap((cap), (mask)))
568 * dma_async_issue_pending - flush pending transactions to HW
569 * @chan: target DMA channel
571 * This allows drivers to push copies to HW in batches,
572 * reducing MMIO writes where possible.
574 static inline void dma_async_issue_pending(struct dma_chan *chan)
576 chan->device->device_issue_pending(chan);
579 #define dma_async_memcpy_issue_pending(chan) dma_async_issue_pending(chan)
582 * dma_async_is_tx_complete - poll for transaction completion
584 * @cookie: transaction identifier to check status of
585 * @last: returns last completed cookie, can be NULL
586 * @used: returns last issued cookie, can be NULL
588 * If @last and @used are passed in, upon return they reflect the driver
589 * internal state and can be used with dma_async_is_complete() to check
590 * the status of multiple cookies without re-checking hardware state.
592 static inline enum dma_status dma_async_is_tx_complete(struct dma_chan *chan,
593 dma_cookie_t cookie, dma_cookie_t *last, dma_cookie_t *used)
595 struct dma_tx_state state;
596 enum dma_status status;
598 status = chan->device->device_tx_status(chan, cookie, &state);
606 #define dma_async_memcpy_complete(chan, cookie, last, used)\
607 dma_async_is_tx_complete(chan, cookie, last, used)
610 * dma_async_is_complete - test a cookie against chan state
611 * @cookie: transaction identifier to test status of
612 * @last_complete: last know completed transaction
613 * @last_used: last cookie value handed out
615 * dma_async_is_complete() is used in dma_async_memcpy_complete()
616 * the test logic is separated for lightweight testing of multiple cookies
618 static inline enum dma_status dma_async_is_complete(dma_cookie_t cookie,
619 dma_cookie_t last_complete, dma_cookie_t last_used)
621 if (last_complete <= last_used) {
622 if ((cookie <= last_complete) || (cookie > last_used))
625 if ((cookie <= last_complete) && (cookie > last_used))
628 return DMA_IN_PROGRESS;
631 enum dma_status dma_sync_wait(struct dma_chan *chan, dma_cookie_t cookie);
632 #ifdef CONFIG_DMA_ENGINE
633 enum dma_status dma_wait_for_async_tx(struct dma_async_tx_descriptor *tx);
634 void dma_issue_pending_all(void);
636 static inline enum dma_status dma_wait_for_async_tx(struct dma_async_tx_descriptor *tx)
640 static inline void dma_issue_pending_all(void)
646 /* --- DMA device --- */
648 int dma_async_device_register(struct dma_device *device);
649 void dma_async_device_unregister(struct dma_device *device);
650 void dma_run_dependencies(struct dma_async_tx_descriptor *tx);
651 struct dma_chan *dma_find_channel(enum dma_transaction_type tx_type);
652 #define dma_request_channel(mask, x, y) __dma_request_channel(&(mask), x, y)
653 struct dma_chan *__dma_request_channel(dma_cap_mask_t *mask, dma_filter_fn fn, void *fn_param);
654 void dma_release_channel(struct dma_chan *chan);
656 /* --- Helper iov-locking functions --- */
658 struct dma_page_list {
659 char __user *base_address;
664 struct dma_pinned_list {
666 struct dma_page_list page_list[0];
669 struct dma_pinned_list *dma_pin_iovec_pages(struct iovec *iov, size_t len);
670 void dma_unpin_iovec_pages(struct dma_pinned_list* pinned_list);
672 dma_cookie_t dma_memcpy_to_iovec(struct dma_chan *chan, struct iovec *iov,
673 struct dma_pinned_list *pinned_list, unsigned char *kdata, size_t len);
674 dma_cookie_t dma_memcpy_pg_to_iovec(struct dma_chan *chan, struct iovec *iov,
675 struct dma_pinned_list *pinned_list, struct page *page,
676 unsigned int offset, size_t len);
678 #endif /* DMAENGINE_H */