dmaengine: Add slave DMA interface
[linux-2.6.git] / include / linux / dmaengine.h
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
23
24 #include <linux/device.h>
25 #include <linux/uio.h>
26 #include <linux/kref.h>
27 #include <linux/completion.h>
28 #include <linux/rcupdate.h>
29 #include <linux/dma-mapping.h>
30
31 /**
32  * enum dma_state - resource PNP/power management state
33  * @DMA_RESOURCE_SUSPEND: DMA device going into low power state
34  * @DMA_RESOURCE_RESUME: DMA device returning to full power
35  * @DMA_RESOURCE_AVAILABLE: DMA device available to the system
36  * @DMA_RESOURCE_REMOVED: DMA device removed from the system
37  */
38 enum dma_state {
39         DMA_RESOURCE_SUSPEND,
40         DMA_RESOURCE_RESUME,
41         DMA_RESOURCE_AVAILABLE,
42         DMA_RESOURCE_REMOVED,
43 };
44
45 /**
46  * enum dma_state_client - state of the channel in the client
47  * @DMA_ACK: client would like to use, or was using this channel
48  * @DMA_DUP: client has already seen this channel, or is not using this channel
49  * @DMA_NAK: client does not want to see any more channels
50  */
51 enum dma_state_client {
52         DMA_ACK,
53         DMA_DUP,
54         DMA_NAK,
55 };
56
57 /**
58  * typedef dma_cookie_t - an opaque DMA cookie
59  *
60  * if dma_cookie_t is >0 it's a DMA request cookie, <0 it's an error code
61  */
62 typedef s32 dma_cookie_t;
63
64 #define dma_submit_error(cookie) ((cookie) < 0 ? 1 : 0)
65
66 /**
67  * enum dma_status - DMA transaction status
68  * @DMA_SUCCESS: transaction completed successfully
69  * @DMA_IN_PROGRESS: transaction not yet processed
70  * @DMA_ERROR: transaction failed
71  */
72 enum dma_status {
73         DMA_SUCCESS,
74         DMA_IN_PROGRESS,
75         DMA_ERROR,
76 };
77
78 /**
79  * enum dma_transaction_type - DMA transaction types/indexes
80  */
81 enum dma_transaction_type {
82         DMA_MEMCPY,
83         DMA_XOR,
84         DMA_PQ_XOR,
85         DMA_DUAL_XOR,
86         DMA_PQ_UPDATE,
87         DMA_ZERO_SUM,
88         DMA_PQ_ZERO_SUM,
89         DMA_MEMSET,
90         DMA_MEMCPY_CRC32C,
91         DMA_INTERRUPT,
92         DMA_SLAVE,
93 };
94
95 /* last transaction type for creation of the capabilities mask */
96 #define DMA_TX_TYPE_END (DMA_SLAVE + 1)
97
98 /**
99  * enum dma_slave_width - DMA slave register access width.
100  * @DMA_SLAVE_WIDTH_8BIT: Do 8-bit slave register accesses
101  * @DMA_SLAVE_WIDTH_16BIT: Do 16-bit slave register accesses
102  * @DMA_SLAVE_WIDTH_32BIT: Do 32-bit slave register accesses
103  */
104 enum dma_slave_width {
105         DMA_SLAVE_WIDTH_8BIT,
106         DMA_SLAVE_WIDTH_16BIT,
107         DMA_SLAVE_WIDTH_32BIT,
108 };
109
110 /**
111  * enum dma_ctrl_flags - DMA flags to augment operation preparation,
112  *      control completion, and communicate status.
113  * @DMA_PREP_INTERRUPT - trigger an interrupt (callback) upon completion of
114  *      this transaction
115  * @DMA_CTRL_ACK - the descriptor cannot be reused until the client
116  *      acknowledges receipt, i.e. has has a chance to establish any
117  *      dependency chains
118  * @DMA_COMPL_SKIP_SRC_UNMAP - set to disable dma-unmapping the source buffer(s)
119  * @DMA_COMPL_SKIP_DEST_UNMAP - set to disable dma-unmapping the destination(s)
120  */
121 enum dma_ctrl_flags {
122         DMA_PREP_INTERRUPT = (1 << 0),
123         DMA_CTRL_ACK = (1 << 1),
124         DMA_COMPL_SKIP_SRC_UNMAP = (1 << 2),
125         DMA_COMPL_SKIP_DEST_UNMAP = (1 << 3),
126 };
127
128 /**
129  * dma_cap_mask_t - capabilities bitmap modeled after cpumask_t.
130  * See linux/cpumask.h
131  */
132 typedef struct { DECLARE_BITMAP(bits, DMA_TX_TYPE_END); } dma_cap_mask_t;
133
134 /**
135  * struct dma_slave - Information about a DMA slave
136  * @dev: device acting as DMA slave
137  * @dma_dev: required DMA master device. If non-NULL, the client can not be
138  *      bound to other masters than this.
139  * @tx_reg: physical address of data register used for
140  *      memory-to-peripheral transfers
141  * @rx_reg: physical address of data register used for
142  *      peripheral-to-memory transfers
143  * @reg_width: peripheral register width
144  *
145  * If dma_dev is non-NULL, the client can not be bound to other DMA
146  * masters than the one corresponding to this device. The DMA master
147  * driver may use this to determine if there is controller-specific
148  * data wrapped around this struct. Drivers of platform code that sets
149  * the dma_dev field must therefore make sure to use an appropriate
150  * controller-specific dma slave structure wrapping this struct.
151  */
152 struct dma_slave {
153         struct device           *dev;
154         struct device           *dma_dev;
155         dma_addr_t              tx_reg;
156         dma_addr_t              rx_reg;
157         enum dma_slave_width    reg_width;
158 };
159
160 /**
161  * struct dma_chan_percpu - the per-CPU part of struct dma_chan
162  * @refcount: local_t used for open-coded "bigref" counting
163  * @memcpy_count: transaction counter
164  * @bytes_transferred: byte counter
165  */
166
167 struct dma_chan_percpu {
168         local_t refcount;
169         /* stats */
170         unsigned long memcpy_count;
171         unsigned long bytes_transferred;
172 };
173
174 /**
175  * struct dma_chan - devices supply DMA channels, clients use them
176  * @device: ptr to the dma device who supplies this channel, always !%NULL
177  * @cookie: last cookie value returned to client
178  * @chan_id: channel ID for sysfs
179  * @class_dev: class device for sysfs
180  * @refcount: kref, used in "bigref" slow-mode
181  * @slow_ref: indicates that the DMA channel is free
182  * @rcu: the DMA channel's RCU head
183  * @device_node: used to add this to the device chan list
184  * @local: per-cpu pointer to a struct dma_chan_percpu
185  * @client-count: how many clients are using this channel
186  */
187 struct dma_chan {
188         struct dma_device *device;
189         dma_cookie_t cookie;
190
191         /* sysfs */
192         int chan_id;
193         struct device dev;
194
195         struct kref refcount;
196         int slow_ref;
197         struct rcu_head rcu;
198
199         struct list_head device_node;
200         struct dma_chan_percpu *local;
201         int client_count;
202 };
203
204 #define to_dma_chan(p) container_of(p, struct dma_chan, dev)
205
206 void dma_chan_cleanup(struct kref *kref);
207
208 static inline void dma_chan_get(struct dma_chan *chan)
209 {
210         if (unlikely(chan->slow_ref))
211                 kref_get(&chan->refcount);
212         else {
213                 local_inc(&(per_cpu_ptr(chan->local, get_cpu())->refcount));
214                 put_cpu();
215         }
216 }
217
218 static inline void dma_chan_put(struct dma_chan *chan)
219 {
220         if (unlikely(chan->slow_ref))
221                 kref_put(&chan->refcount, dma_chan_cleanup);
222         else {
223                 local_dec(&(per_cpu_ptr(chan->local, get_cpu())->refcount));
224                 put_cpu();
225         }
226 }
227
228 /*
229  * typedef dma_event_callback - function pointer to a DMA event callback
230  * For each channel added to the system this routine is called for each client.
231  * If the client would like to use the channel it returns '1' to signal (ack)
232  * the dmaengine core to take out a reference on the channel and its
233  * corresponding device.  A client must not 'ack' an available channel more
234  * than once.  When a channel is removed all clients are notified.  If a client
235  * is using the channel it must 'ack' the removal.  A client must not 'ack' a
236  * removed channel more than once.
237  * @client - 'this' pointer for the client context
238  * @chan - channel to be acted upon
239  * @state - available or removed
240  */
241 struct dma_client;
242 typedef enum dma_state_client (*dma_event_callback) (struct dma_client *client,
243                 struct dma_chan *chan, enum dma_state state);
244
245 /**
246  * struct dma_client - info on the entity making use of DMA services
247  * @event_callback: func ptr to call when something happens
248  * @cap_mask: only return channels that satisfy the requested capabilities
249  *  a value of zero corresponds to any capability
250  * @slave: data for preparing slave transfer. Must be non-NULL iff the
251  *  DMA_SLAVE capability is requested.
252  * @global_node: list_head for global dma_client_list
253  */
254 struct dma_client {
255         dma_event_callback      event_callback;
256         dma_cap_mask_t          cap_mask;
257         struct dma_slave        *slave;
258         struct list_head        global_node;
259 };
260
261 typedef void (*dma_async_tx_callback)(void *dma_async_param);
262 /**
263  * struct dma_async_tx_descriptor - async transaction descriptor
264  * ---dma generic offload fields---
265  * @cookie: tracking cookie for this transaction, set to -EBUSY if
266  *      this tx is sitting on a dependency list
267  * @flags: flags to augment operation preparation, control completion, and
268  *      communicate status
269  * @phys: physical address of the descriptor
270  * @tx_list: driver common field for operations that require multiple
271  *      descriptors
272  * @chan: target channel for this operation
273  * @tx_submit: set the prepared descriptor(s) to be executed by the engine
274  * @callback: routine to call after this operation is complete
275  * @callback_param: general parameter to pass to the callback routine
276  * ---async_tx api specific fields---
277  * @next: at completion submit this descriptor
278  * @parent: pointer to the next level up in the dependency chain
279  * @lock: protect the parent and next pointers
280  */
281 struct dma_async_tx_descriptor {
282         dma_cookie_t cookie;
283         enum dma_ctrl_flags flags; /* not a 'long' to pack with cookie */
284         dma_addr_t phys;
285         struct list_head tx_list;
286         struct dma_chan *chan;
287         dma_cookie_t (*tx_submit)(struct dma_async_tx_descriptor *tx);
288         dma_async_tx_callback callback;
289         void *callback_param;
290         struct dma_async_tx_descriptor *next;
291         struct dma_async_tx_descriptor *parent;
292         spinlock_t lock;
293 };
294
295 /**
296  * struct dma_device - info on the entity supplying DMA services
297  * @chancnt: how many DMA channels are supported
298  * @channels: the list of struct dma_chan
299  * @global_node: list_head for global dma_device_list
300  * @cap_mask: one or more dma_capability flags
301  * @max_xor: maximum number of xor sources, 0 if no capability
302  * @refcount: reference count
303  * @done: IO completion struct
304  * @dev_id: unique device ID
305  * @dev: struct device reference for dma mapping api
306  * @device_alloc_chan_resources: allocate resources and return the
307  *      number of allocated descriptors
308  * @device_free_chan_resources: release DMA channel's resources
309  * @device_prep_dma_memcpy: prepares a memcpy operation
310  * @device_prep_dma_xor: prepares a xor operation
311  * @device_prep_dma_zero_sum: prepares a zero_sum operation
312  * @device_prep_dma_memset: prepares a memset operation
313  * @device_prep_dma_interrupt: prepares an end of chain interrupt operation
314  * @device_prep_slave_sg: prepares a slave dma operation
315  * @device_terminate_all: terminate all pending operations
316  * @device_issue_pending: push pending transactions to hardware
317  */
318 struct dma_device {
319
320         unsigned int chancnt;
321         struct list_head channels;
322         struct list_head global_node;
323         dma_cap_mask_t  cap_mask;
324         int max_xor;
325
326         struct kref refcount;
327         struct completion done;
328
329         int dev_id;
330         struct device *dev;
331
332         int (*device_alloc_chan_resources)(struct dma_chan *chan,
333                         struct dma_client *client);
334         void (*device_free_chan_resources)(struct dma_chan *chan);
335
336         struct dma_async_tx_descriptor *(*device_prep_dma_memcpy)(
337                 struct dma_chan *chan, dma_addr_t dest, dma_addr_t src,
338                 size_t len, unsigned long flags);
339         struct dma_async_tx_descriptor *(*device_prep_dma_xor)(
340                 struct dma_chan *chan, dma_addr_t dest, dma_addr_t *src,
341                 unsigned int src_cnt, size_t len, unsigned long flags);
342         struct dma_async_tx_descriptor *(*device_prep_dma_zero_sum)(
343                 struct dma_chan *chan, dma_addr_t *src, unsigned int src_cnt,
344                 size_t len, u32 *result, unsigned long flags);
345         struct dma_async_tx_descriptor *(*device_prep_dma_memset)(
346                 struct dma_chan *chan, dma_addr_t dest, int value, size_t len,
347                 unsigned long flags);
348         struct dma_async_tx_descriptor *(*device_prep_dma_interrupt)(
349                 struct dma_chan *chan, unsigned long flags);
350
351         struct dma_async_tx_descriptor *(*device_prep_slave_sg)(
352                 struct dma_chan *chan, struct scatterlist *sgl,
353                 unsigned int sg_len, enum dma_data_direction direction,
354                 unsigned long flags);
355         void (*device_terminate_all)(struct dma_chan *chan);
356
357         enum dma_status (*device_is_tx_complete)(struct dma_chan *chan,
358                         dma_cookie_t cookie, dma_cookie_t *last,
359                         dma_cookie_t *used);
360         void (*device_issue_pending)(struct dma_chan *chan);
361 };
362
363 /* --- public DMA engine API --- */
364
365 void dma_async_client_register(struct dma_client *client);
366 void dma_async_client_unregister(struct dma_client *client);
367 void dma_async_client_chan_request(struct dma_client *client);
368 dma_cookie_t dma_async_memcpy_buf_to_buf(struct dma_chan *chan,
369         void *dest, void *src, size_t len);
370 dma_cookie_t dma_async_memcpy_buf_to_pg(struct dma_chan *chan,
371         struct page *page, unsigned int offset, void *kdata, size_t len);
372 dma_cookie_t dma_async_memcpy_pg_to_pg(struct dma_chan *chan,
373         struct page *dest_pg, unsigned int dest_off, struct page *src_pg,
374         unsigned int src_off, size_t len);
375 void dma_async_tx_descriptor_init(struct dma_async_tx_descriptor *tx,
376         struct dma_chan *chan);
377
378 static inline void
379 async_tx_ack(struct dma_async_tx_descriptor *tx)
380 {
381         tx->flags |= DMA_CTRL_ACK;
382 }
383
384 static inline int
385 async_tx_test_ack(struct dma_async_tx_descriptor *tx)
386 {
387         return tx->flags & DMA_CTRL_ACK;
388 }
389
390 #define first_dma_cap(mask) __first_dma_cap(&(mask))
391 static inline int __first_dma_cap(const dma_cap_mask_t *srcp)
392 {
393         return min_t(int, DMA_TX_TYPE_END,
394                 find_first_bit(srcp->bits, DMA_TX_TYPE_END));
395 }
396
397 #define next_dma_cap(n, mask) __next_dma_cap((n), &(mask))
398 static inline int __next_dma_cap(int n, const dma_cap_mask_t *srcp)
399 {
400         return min_t(int, DMA_TX_TYPE_END,
401                 find_next_bit(srcp->bits, DMA_TX_TYPE_END, n+1));
402 }
403
404 #define dma_cap_set(tx, mask) __dma_cap_set((tx), &(mask))
405 static inline void
406 __dma_cap_set(enum dma_transaction_type tx_type, dma_cap_mask_t *dstp)
407 {
408         set_bit(tx_type, dstp->bits);
409 }
410
411 #define dma_has_cap(tx, mask) __dma_has_cap((tx), &(mask))
412 static inline int
413 __dma_has_cap(enum dma_transaction_type tx_type, dma_cap_mask_t *srcp)
414 {
415         return test_bit(tx_type, srcp->bits);
416 }
417
418 #define for_each_dma_cap_mask(cap, mask) \
419         for ((cap) = first_dma_cap(mask);       \
420                 (cap) < DMA_TX_TYPE_END;        \
421                 (cap) = next_dma_cap((cap), (mask)))
422
423 /**
424  * dma_async_issue_pending - flush pending transactions to HW
425  * @chan: target DMA channel
426  *
427  * This allows drivers to push copies to HW in batches,
428  * reducing MMIO writes where possible.
429  */
430 static inline void dma_async_issue_pending(struct dma_chan *chan)
431 {
432         chan->device->device_issue_pending(chan);
433 }
434
435 #define dma_async_memcpy_issue_pending(chan) dma_async_issue_pending(chan)
436
437 /**
438  * dma_async_is_tx_complete - poll for transaction completion
439  * @chan: DMA channel
440  * @cookie: transaction identifier to check status of
441  * @last: returns last completed cookie, can be NULL
442  * @used: returns last issued cookie, can be NULL
443  *
444  * If @last and @used are passed in, upon return they reflect the driver
445  * internal state and can be used with dma_async_is_complete() to check
446  * the status of multiple cookies without re-checking hardware state.
447  */
448 static inline enum dma_status dma_async_is_tx_complete(struct dma_chan *chan,
449         dma_cookie_t cookie, dma_cookie_t *last, dma_cookie_t *used)
450 {
451         return chan->device->device_is_tx_complete(chan, cookie, last, used);
452 }
453
454 #define dma_async_memcpy_complete(chan, cookie, last, used)\
455         dma_async_is_tx_complete(chan, cookie, last, used)
456
457 /**
458  * dma_async_is_complete - test a cookie against chan state
459  * @cookie: transaction identifier to test status of
460  * @last_complete: last know completed transaction
461  * @last_used: last cookie value handed out
462  *
463  * dma_async_is_complete() is used in dma_async_memcpy_complete()
464  * the test logic is separated for lightweight testing of multiple cookies
465  */
466 static inline enum dma_status dma_async_is_complete(dma_cookie_t cookie,
467                         dma_cookie_t last_complete, dma_cookie_t last_used)
468 {
469         if (last_complete <= last_used) {
470                 if ((cookie <= last_complete) || (cookie > last_used))
471                         return DMA_SUCCESS;
472         } else {
473                 if ((cookie <= last_complete) && (cookie > last_used))
474                         return DMA_SUCCESS;
475         }
476         return DMA_IN_PROGRESS;
477 }
478
479 enum dma_status dma_sync_wait(struct dma_chan *chan, dma_cookie_t cookie);
480
481 /* --- DMA device --- */
482
483 int dma_async_device_register(struct dma_device *device);
484 void dma_async_device_unregister(struct dma_device *device);
485
486 /* --- Helper iov-locking functions --- */
487
488 struct dma_page_list {
489         char __user *base_address;
490         int nr_pages;
491         struct page **pages;
492 };
493
494 struct dma_pinned_list {
495         int nr_iovecs;
496         struct dma_page_list page_list[0];
497 };
498
499 struct dma_pinned_list *dma_pin_iovec_pages(struct iovec *iov, size_t len);
500 void dma_unpin_iovec_pages(struct dma_pinned_list* pinned_list);
501
502 dma_cookie_t dma_memcpy_to_iovec(struct dma_chan *chan, struct iovec *iov,
503         struct dma_pinned_list *pinned_list, unsigned char *kdata, size_t len);
504 dma_cookie_t dma_memcpy_pg_to_iovec(struct dma_chan *chan, struct iovec *iov,
505         struct dma_pinned_list *pinned_list, struct page *page,
506         unsigned int offset, size_t len);
507
508 #endif /* DMAENGINE_H */