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
90 * @DMA_PREP_FENCE - tell the driver that subsequent operations depend
91 * on the result of this operation
94 DMA_PREP_INTERRUPT = (1 << 0),
95 DMA_CTRL_ACK = (1 << 1),
96 DMA_COMPL_SKIP_SRC_UNMAP = (1 << 2),
97 DMA_COMPL_SKIP_DEST_UNMAP = (1 << 3),
98 DMA_COMPL_SRC_UNMAP_SINGLE = (1 << 4),
99 DMA_COMPL_DEST_UNMAP_SINGLE = (1 << 5),
100 DMA_PREP_PQ_DISABLE_P = (1 << 6),
101 DMA_PREP_PQ_DISABLE_Q = (1 << 7),
102 DMA_PREP_CONTINUE = (1 << 8),
103 DMA_PREP_FENCE = (1 << 9),
107 * enum sum_check_bits - bit position of pq_check_flags
109 enum sum_check_bits {
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
119 enum sum_check_flags {
120 SUM_CHECK_P_RESULT = (1 << SUM_CHECK_P),
121 SUM_CHECK_Q_RESULT = (1 << SUM_CHECK_Q),
126 * dma_cap_mask_t - capabilities bitmap modeled after cpumask_t.
127 * See linux/cpumask.h
129 typedef struct { DECLARE_BITMAP(bits, DMA_TX_TYPE_END); } dma_cap_mask_t;
132 * struct dma_chan_percpu - the per-CPU part of struct dma_chan
133 * @memcpy_count: transaction counter
134 * @bytes_transferred: byte counter
137 struct dma_chan_percpu {
139 unsigned long memcpy_count;
140 unsigned long bytes_transferred;
144 * struct dma_chan - devices supply DMA channels, clients use them
145 * @device: ptr to the dma device who supplies this channel, always !%NULL
146 * @cookie: last cookie value returned to client
147 * @chan_id: channel ID for sysfs
148 * @dev: class device for sysfs
149 * @device_node: used to add this to the device chan list
150 * @local: per-cpu pointer to a struct dma_chan_percpu
151 * @client-count: how many clients are using this channel
152 * @table_count: number of appearances in the mem-to-mem allocation table
153 * @private: private data for certain client-channel associations
156 struct dma_device *device;
161 struct dma_chan_dev *dev;
163 struct list_head device_node;
164 struct dma_chan_percpu *local;
171 * struct dma_chan_dev - relate sysfs device node to backing channel device
172 * @chan - driver channel device
173 * @device - sysfs device
174 * @dev_id - parent dma_device dev_id
175 * @idr_ref - reference count to gate release of dma_device dev_id
177 struct dma_chan_dev {
178 struct dma_chan *chan;
179 struct device device;
184 static inline const char *dma_chan_name(struct dma_chan *chan)
186 return dev_name(&chan->dev->device);
189 void dma_chan_cleanup(struct kref *kref);
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
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
199 * satisfies the given capability mask. It returns 'true' to indicate that the
200 * channel is suitable.
202 typedef bool (*dma_filter_fn)(struct dma_chan *chan, void *filter_param);
204 typedef void (*dma_async_tx_callback)(void *dma_async_param);
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
210 * @flags: flags to augment operation preparation, control completion, and
212 * @phys: physical address of the descriptor
213 * @tx_list: driver common field for operations that require multiple
215 * @chan: target channel for this operation
216 * @tx_submit: set the prepared descriptor(s) to be executed by the engine
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---
220 * @next: at completion submit this descriptor
221 * @parent: pointer to the next level up in the dependency chain
222 * @lock: protect the parent and next pointers
224 struct dma_async_tx_descriptor {
226 enum dma_ctrl_flags flags; /* not a 'long' to pack with cookie */
228 struct list_head tx_list;
229 struct dma_chan *chan;
230 dma_cookie_t (*tx_submit)(struct dma_async_tx_descriptor *tx);
231 dma_async_tx_callback callback;
232 void *callback_param;
233 struct dma_async_tx_descriptor *next;
234 struct dma_async_tx_descriptor *parent;
239 * struct dma_device - info on the entity supplying DMA services
240 * @chancnt: how many DMA channels are supported
241 * @privatecnt: how many DMA channels are requested by dma_request_channel
242 * @channels: the list of struct dma_chan
243 * @global_node: list_head for global dma_device_list
244 * @cap_mask: one or more dma_capability flags
245 * @max_xor: maximum number of xor sources, 0 if no capability
246 * @max_pq: maximum number of PQ sources and PQ-continue capability
247 * @dev_id: unique device ID
248 * @dev: struct device reference for dma mapping api
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
252 * @device_prep_dma_memcpy: prepares a memcpy operation
253 * @device_prep_dma_xor: prepares a xor operation
254 * @device_prep_dma_xor_val: prepares a xor validation operation
255 * @device_prep_dma_pq: prepares a pq operation
256 * @device_prep_dma_pq_val: prepares a pqzero_sum operation
257 * @device_prep_dma_memset: prepares a memset operation
258 * @device_prep_dma_interrupt: prepares an end of chain interrupt operation
259 * @device_prep_slave_sg: prepares a slave dma operation
260 * @device_terminate_all: terminate all pending operations
261 * @device_is_tx_complete: poll for transaction completion
262 * @device_issue_pending: push pending transactions to hardware
266 unsigned int chancnt;
267 unsigned int privatecnt;
268 struct list_head channels;
269 struct list_head global_node;
270 dma_cap_mask_t cap_mask;
271 unsigned short max_xor;
272 unsigned short max_pq;
273 #define DMA_HAS_PQ_CONTINUE (1 << 15)
278 int (*device_alloc_chan_resources)(struct dma_chan *chan);
279 void (*device_free_chan_resources)(struct dma_chan *chan);
281 struct dma_async_tx_descriptor *(*device_prep_dma_memcpy)(
282 struct dma_chan *chan, dma_addr_t dest, dma_addr_t src,
283 size_t len, unsigned long flags);
284 struct dma_async_tx_descriptor *(*device_prep_dma_xor)(
285 struct dma_chan *chan, dma_addr_t dest, dma_addr_t *src,
286 unsigned int src_cnt, size_t len, unsigned long flags);
287 struct dma_async_tx_descriptor *(*device_prep_dma_xor_val)(
288 struct dma_chan *chan, dma_addr_t *src, unsigned int src_cnt,
289 size_t len, enum sum_check_flags *result, unsigned long flags);
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);
298 struct dma_async_tx_descriptor *(*device_prep_dma_memset)(
299 struct dma_chan *chan, dma_addr_t dest, int value, size_t len,
300 unsigned long flags);
301 struct dma_async_tx_descriptor *(*device_prep_dma_interrupt)(
302 struct dma_chan *chan, unsigned long flags);
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);
310 enum dma_status (*device_is_tx_complete)(struct dma_chan *chan,
311 dma_cookie_t cookie, dma_cookie_t *last,
313 void (*device_issue_pending)(struct dma_chan *chan);
317 dma_set_maxpq(struct dma_device *dma, int maxpq, int has_pq_continue)
321 dma->max_pq |= DMA_HAS_PQ_CONTINUE;
324 static inline bool dmaf_continue(enum dma_ctrl_flags flags)
326 return (flags & DMA_PREP_CONTINUE) == DMA_PREP_CONTINUE;
329 static inline bool dmaf_p_disabled_continue(enum dma_ctrl_flags flags)
331 enum dma_ctrl_flags mask = DMA_PREP_CONTINUE | DMA_PREP_PQ_DISABLE_P;
333 return (flags & mask) == mask;
336 static inline bool dma_dev_has_pq_continue(struct dma_device *dma)
338 return (dma->max_pq & DMA_HAS_PQ_CONTINUE) == DMA_HAS_PQ_CONTINUE;
341 static unsigned short dma_dev_to_maxpq(struct dma_device *dma)
343 return dma->max_pq & ~DMA_HAS_PQ_CONTINUE;
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
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)
356 * In the case where P is disabled we only need 1 extra source:
357 * 1/ {01} * Q : use Q to continue Q' calculation
359 static inline int dma_maxpq(struct dma_device *dma, enum dma_ctrl_flags flags)
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;
370 /* --- public DMA engine API --- */
372 #ifdef CONFIG_DMA_ENGINE
373 void dmaengine_get(void);
374 void dmaengine_put(void);
376 static inline void dmaengine_get(void)
379 static inline void dmaengine_put(void)
384 #ifdef CONFIG_NET_DMA
385 #define net_dmaengine_get() dmaengine_get()
386 #define net_dmaengine_put() dmaengine_put()
388 static inline void net_dmaengine_get(void)
391 static inline void net_dmaengine_put(void)
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)
401 static inline void async_dmaengine_get(void)
404 static inline void async_dmaengine_put(void)
407 static inline struct dma_chan *
408 async_dma_find_channel(enum dma_transaction_type type)
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);
424 static inline void async_tx_ack(struct dma_async_tx_descriptor *tx)
426 tx->flags |= DMA_CTRL_ACK;
429 static inline void async_tx_clear_ack(struct dma_async_tx_descriptor *tx)
431 tx->flags &= ~DMA_CTRL_ACK;
434 static inline bool async_tx_test_ack(struct dma_async_tx_descriptor *tx)
436 return (tx->flags & DMA_CTRL_ACK) == DMA_CTRL_ACK;
439 #define first_dma_cap(mask) __first_dma_cap(&(mask))
440 static inline int __first_dma_cap(const dma_cap_mask_t *srcp)
442 return min_t(int, DMA_TX_TYPE_END,
443 find_first_bit(srcp->bits, DMA_TX_TYPE_END));
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)
449 return min_t(int, DMA_TX_TYPE_END,
450 find_next_bit(srcp->bits, DMA_TX_TYPE_END, n+1));
453 #define dma_cap_set(tx, mask) __dma_cap_set((tx), &(mask))
455 __dma_cap_set(enum dma_transaction_type tx_type, dma_cap_mask_t *dstp)
457 set_bit(tx_type, dstp->bits);
460 #define dma_cap_clear(tx, mask) __dma_cap_clear((tx), &(mask))
462 __dma_cap_clear(enum dma_transaction_type tx_type, dma_cap_mask_t *dstp)
464 clear_bit(tx_type, dstp->bits);
467 #define dma_cap_zero(mask) __dma_cap_zero(&(mask))
468 static inline void __dma_cap_zero(dma_cap_mask_t *dstp)
470 bitmap_zero(dstp->bits, DMA_TX_TYPE_END);
473 #define dma_has_cap(tx, mask) __dma_has_cap((tx), &(mask))
475 __dma_has_cap(enum dma_transaction_type tx_type, dma_cap_mask_t *srcp)
477 return test_bit(tx_type, srcp->bits);
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)))
486 * dma_async_issue_pending - flush pending transactions to HW
487 * @chan: target DMA channel
489 * This allows drivers to push copies to HW in batches,
490 * reducing MMIO writes where possible.
492 static inline void dma_async_issue_pending(struct dma_chan *chan)
494 chan->device->device_issue_pending(chan);
497 #define dma_async_memcpy_issue_pending(chan) dma_async_issue_pending(chan)
500 * dma_async_is_tx_complete - poll for transaction completion
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
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.
510 static inline enum dma_status dma_async_is_tx_complete(struct dma_chan *chan,
511 dma_cookie_t cookie, dma_cookie_t *last, dma_cookie_t *used)
513 return chan->device->device_is_tx_complete(chan, cookie, last, used);
516 #define dma_async_memcpy_complete(chan, cookie, last, used)\
517 dma_async_is_tx_complete(chan, cookie, last, used)
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
525 * dma_async_is_complete() is used in dma_async_memcpy_complete()
526 * the test logic is separated for lightweight testing of multiple cookies
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)
531 if (last_complete <= last_used) {
532 if ((cookie <= last_complete) || (cookie > last_used))
535 if ((cookie <= last_complete) && (cookie > last_used))
538 return DMA_IN_PROGRESS;
541 enum dma_status dma_sync_wait(struct dma_chan *chan, dma_cookie_t cookie);
542 #ifdef CONFIG_DMA_ENGINE
543 enum dma_status dma_wait_for_async_tx(struct dma_async_tx_descriptor *tx);
544 void dma_issue_pending_all(void);
546 static inline enum dma_status dma_wait_for_async_tx(struct dma_async_tx_descriptor *tx)
550 static inline void dma_issue_pending_all(void)
556 /* --- DMA device --- */
558 int dma_async_device_register(struct dma_device *device);
559 void dma_async_device_unregister(struct dma_device *device);
560 void dma_run_dependencies(struct dma_async_tx_descriptor *tx);
561 struct dma_chan *dma_find_channel(enum dma_transaction_type tx_type);
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);
566 /* --- Helper iov-locking functions --- */
568 struct dma_page_list {
569 char __user *base_address;
574 struct dma_pinned_list {
576 struct dma_page_list page_list[0];
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);
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);
588 #endif /* DMAENGINE_H */