Merge branch 'release' of git://git.kernel.org/pub/scm/linux/kernel/git/aegl/linux-2.6
[linux-2.6] / include / asm-arm / hardware / iop_adma.h
1 /*
2  * Copyright © 2006, Intel Corporation.
3  *
4  * This program is free software; you can redistribute it and/or modify it
5  * under the terms and conditions of the GNU General Public License,
6  * version 2, as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope it will be useful, but WITHOUT
9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
11  * more details.
12  *
13  * You should have received a copy of the GNU General Public License along with
14  * this program; if not, write to the Free Software Foundation, Inc.,
15  * 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
16  *
17  */
18 #ifndef IOP_ADMA_H
19 #define IOP_ADMA_H
20 #include <linux/types.h>
21 #include <linux/dmaengine.h>
22 #include <linux/interrupt.h>
23
24 #define IOP_ADMA_SLOT_SIZE 32
25 #define IOP_ADMA_THRESHOLD 4
26
27 /**
28  * struct iop_adma_device - internal representation of an ADMA device
29  * @pdev: Platform device
30  * @id: HW ADMA Device selector
31  * @dma_desc_pool: base of DMA descriptor region (DMA address)
32  * @dma_desc_pool_virt: base of DMA descriptor region (CPU address)
33  * @common: embedded struct dma_device
34  */
35 struct iop_adma_device {
36         struct platform_device *pdev;
37         int id;
38         dma_addr_t dma_desc_pool;
39         void *dma_desc_pool_virt;
40         struct dma_device common;
41 };
42
43 /**
44  * struct iop_adma_chan - internal representation of an ADMA device
45  * @pending: allows batching of hardware operations
46  * @completed_cookie: identifier for the most recently completed operation
47  * @lock: serializes enqueue/dequeue operations to the slot pool
48  * @mmr_base: memory mapped register base
49  * @chain: device chain view of the descriptors
50  * @device: parent device
51  * @common: common dmaengine channel object members
52  * @last_used: place holder for allocation to continue from where it left off
53  * @all_slots: complete domain of slots usable by the channel
54  * @slots_allocated: records the actual size of the descriptor slot pool
55  * @irq_tasklet: bottom half where iop_adma_slot_cleanup runs
56  */
57 struct iop_adma_chan {
58         int pending;
59         dma_cookie_t completed_cookie;
60         spinlock_t lock; /* protects the descriptor slot pool */
61         void __iomem *mmr_base;
62         struct list_head chain;
63         struct iop_adma_device *device;
64         struct dma_chan common;
65         struct iop_adma_desc_slot *last_used;
66         struct list_head all_slots;
67         int slots_allocated;
68         struct tasklet_struct irq_tasklet;
69 };
70
71 /**
72  * struct iop_adma_desc_slot - IOP-ADMA software descriptor
73  * @slot_node: node on the iop_adma_chan.all_slots list
74  * @chain_node: node on the op_adma_chan.chain list
75  * @hw_desc: virtual address of the hardware descriptor chain
76  * @phys: hardware address of the hardware descriptor chain
77  * @group_head: first operation in a transaction
78  * @slot_cnt: total slots used in an transaction (group of operations)
79  * @slots_per_op: number of slots per operation
80  * @idx: pool index
81  * @unmap_src_cnt: number of xor sources
82  * @unmap_len: transaction bytecount
83  * @async_tx: support for the async_tx api
84  * @group_list: list of slots that make up a multi-descriptor transaction
85  *      for example transfer lengths larger than the supported hw max
86  * @xor_check_result: result of zero sum
87  * @crc32_result: result crc calculation
88  */
89 struct iop_adma_desc_slot {
90         struct list_head slot_node;
91         struct list_head chain_node;
92         void *hw_desc;
93         struct iop_adma_desc_slot *group_head;
94         u16 slot_cnt;
95         u16 slots_per_op;
96         u16 idx;
97         u16 unmap_src_cnt;
98         size_t unmap_len;
99         struct dma_async_tx_descriptor async_tx;
100         union {
101                 u32 *xor_check_result;
102                 u32 *crc32_result;
103         };
104 };
105
106 struct iop_adma_platform_data {
107         int hw_id;
108         dma_cap_mask_t cap_mask;
109         size_t pool_size;
110 };
111
112 #define to_iop_sw_desc(addr_hw_desc) \
113         container_of(addr_hw_desc, struct iop_adma_desc_slot, hw_desc)
114 #define iop_hw_desc_slot_idx(hw_desc, idx) \
115         ( (void *) (((unsigned long) hw_desc) + ((idx) << 5)) )
116 #endif