1 /*
2  *
3  * include/linux/coh901318.h
4  *
5  *
6  * Copyright (C) 2007-2009 ST-Ericsson
7  * License terms: GNU General Public License (GPL) version 2
8  * DMA driver for COH 901 318
9  * Author: Per Friden <per.friden@stericsson.com>
10  */
11 
12 #ifndef COH901318_H
13 #define COH901318_H
14 
15 #include <linux/device.h>
16 #include <linux/dmaengine.h>
17 
18 #define MAX_DMA_PACKET_SIZE_SHIFT 11
19 #define MAX_DMA_PACKET_SIZE (1 << MAX_DMA_PACKET_SIZE_SHIFT)
20 
21 /**
22  * struct coh901318_lli - linked list item for DMAC
23  * @control: control settings for DMAC
24  * @src_addr: transfer source address
25  * @dst_addr: transfer destination address
26  * @link_addr:  physical address to next lli
27  * @virt_link_addr: virtual address of next lli (only used by pool_free)
28  * @phy_this: physical address of current lli (only used by pool_free)
29  */
30 struct coh901318_lli {
31 	u32 control;
32 	dma_addr_t src_addr;
33 	dma_addr_t dst_addr;
34 	dma_addr_t link_addr;
35 
36 	void *virt_link_addr;
37 	dma_addr_t phy_this;
38 };
39 /**
40  * struct coh901318_params - parameters for DMAC configuration
41  * @config: DMA config register
42  * @ctrl_lli_last: DMA control register for the last lli in the list
43  * @ctrl_lli: DMA control register for an lli
44  * @ctrl_lli_chained: DMA control register for a chained lli
45  */
46 struct coh901318_params {
47 	u32 config;
48 	u32 ctrl_lli_last;
49 	u32 ctrl_lli;
50 	u32 ctrl_lli_chained;
51 };
52 /**
53  * struct coh_dma_channel - dma channel base
54  * @name: ascii name of dma channel
55  * @number: channel id number
56  * @desc_nbr_max: number of preallocated descriptors
57  * @priority_high: prio of channel, 0 low otherwise high.
58  * @param: configuration parameters
59  * @dev_addr: physical address of periphal connected to channel
60  */
61 struct coh_dma_channel {
62 	const char name[32];
63 	const int number;
64 	const int desc_nbr_max;
65 	const int priority_high;
66 	const struct coh901318_params param;
67 	const dma_addr_t dev_addr;
68 };
69 
70 /**
71  * dma_access_memory_state_t - register dma for memory access
72  *
73  * @dev: The dma device
74  * @active:  1 means dma intends to access memory
75  *           0 means dma wont access memory
76  */
77 typedef void (*dma_access_memory_state_t)(struct device *dev,
78 					  bool active);
79 
80 /**
81  * struct powersave - DMA power save structure
82  * @lock: lock protecting data in this struct
83  * @started_channels: bit mask indicating active dma channels
84  */
85 struct powersave {
86 	spinlock_t lock;
87 	u64 started_channels;
88 };
89 /**
90  * struct coh901318_platform - platform arch structure
91  * @chans_slave: specifying dma slave channels
92  * @chans_memcpy: specifying dma memcpy channels
93  * @access_memory_state: requesting DMA memory access (on / off)
94  * @chan_conf: dma channel configurations
95  * @max_channels: max number of dma chanenls
96  */
97 struct coh901318_platform {
98 	const int *chans_slave;
99 	const int *chans_memcpy;
100 	const dma_access_memory_state_t access_memory_state;
101 	const struct coh_dma_channel *chan_conf;
102 	const int max_channels;
103 };
104 
105 #ifdef CONFIG_COH901318
106 /**
107  * coh901318_filter_id() - DMA channel filter function
108  * @chan: dma channel handle
109  * @chan_id: id of dma channel to be filter out
110  *
111  * In dma_request_channel() it specifies what channel id to be requested
112  */
113 bool coh901318_filter_id(struct dma_chan *chan, void *chan_id);
114 #else
coh901318_filter_id(struct dma_chan * chan,void * chan_id)115 static inline bool coh901318_filter_id(struct dma_chan *chan, void *chan_id)
116 {
117 	return false;
118 }
119 #endif
120 
121 /*
122  * DMA Controller - this access the static mappings of the coh901318 dma.
123  *
124  */
125 
126 #define COH901318_MOD32_MASK					(0x1F)
127 #define COH901318_WORD_MASK					(0xFFFFFFFF)
128 /* INT_STATUS - Interrupt Status Registers 32bit (R/-) */
129 #define COH901318_INT_STATUS1					(0x0000)
130 #define COH901318_INT_STATUS2					(0x0004)
131 /* TC_INT_STATUS - Terminal Count Interrupt Status Registers 32bit (R/-) */
132 #define COH901318_TC_INT_STATUS1				(0x0008)
133 #define COH901318_TC_INT_STATUS2				(0x000C)
134 /* TC_INT_CLEAR - Terminal Count Interrupt Clear Registers 32bit (-/W) */
135 #define COH901318_TC_INT_CLEAR1					(0x0010)
136 #define COH901318_TC_INT_CLEAR2					(0x0014)
137 /* RAW_TC_INT_STATUS - Raw Term Count Interrupt Status Registers 32bit (R/-) */
138 #define COH901318_RAW_TC_INT_STATUS1				(0x0018)
139 #define COH901318_RAW_TC_INT_STATUS2				(0x001C)
140 /* BE_INT_STATUS - Bus Error Interrupt Status Registers 32bit (R/-) */
141 #define COH901318_BE_INT_STATUS1				(0x0020)
142 #define COH901318_BE_INT_STATUS2				(0x0024)
143 /* BE_INT_CLEAR - Bus Error Interrupt Clear Registers 32bit (-/W) */
144 #define COH901318_BE_INT_CLEAR1					(0x0028)
145 #define COH901318_BE_INT_CLEAR2					(0x002C)
146 /* RAW_BE_INT_STATUS - Raw Term Count Interrupt Status Registers 32bit (R/-) */
147 #define COH901318_RAW_BE_INT_STATUS1				(0x0030)
148 #define COH901318_RAW_BE_INT_STATUS2				(0x0034)
149 
150 /*
151  * CX_CFG - Channel Configuration Registers 32bit (R/W)
152  */
153 #define COH901318_CX_CFG					(0x0100)
154 #define COH901318_CX_CFG_SPACING				(0x04)
155 /* Channel enable activates tha dma job */
156 #define COH901318_CX_CFG_CH_ENABLE				(0x00000001)
157 #define COH901318_CX_CFG_CH_DISABLE				(0x00000000)
158 /* Request Mode */
159 #define COH901318_CX_CFG_RM_MASK				(0x00000006)
160 #define COH901318_CX_CFG_RM_MEMORY_TO_MEMORY			(0x0 << 1)
161 #define COH901318_CX_CFG_RM_PRIMARY_TO_MEMORY			(0x1 << 1)
162 #define COH901318_CX_CFG_RM_MEMORY_TO_PRIMARY			(0x1 << 1)
163 #define COH901318_CX_CFG_RM_PRIMARY_TO_SECONDARY		(0x3 << 1)
164 #define COH901318_CX_CFG_RM_SECONDARY_TO_PRIMARY		(0x3 << 1)
165 /* Linked channel request field. RM must == 11 */
166 #define COH901318_CX_CFG_LCRF_SHIFT				3
167 #define COH901318_CX_CFG_LCRF_MASK				(0x000001F8)
168 #define COH901318_CX_CFG_LCR_DISABLE				(0x00000000)
169 /* Terminal Counter Interrupt Request Mask */
170 #define COH901318_CX_CFG_TC_IRQ_ENABLE				(0x00000200)
171 #define COH901318_CX_CFG_TC_IRQ_DISABLE				(0x00000000)
172 /* Bus Error interrupt Mask */
173 #define COH901318_CX_CFG_BE_IRQ_ENABLE				(0x00000400)
174 #define COH901318_CX_CFG_BE_IRQ_DISABLE				(0x00000000)
175 
176 /*
177  * CX_STAT - Channel Status Registers 32bit (R/-)
178  */
179 #define COH901318_CX_STAT					(0x0200)
180 #define COH901318_CX_STAT_SPACING				(0x04)
181 #define COH901318_CX_STAT_RBE_IRQ_IND				(0x00000008)
182 #define COH901318_CX_STAT_RTC_IRQ_IND				(0x00000004)
183 #define COH901318_CX_STAT_ACTIVE				(0x00000002)
184 #define COH901318_CX_STAT_ENABLED				(0x00000001)
185 
186 /*
187  * CX_CTRL - Channel Control Registers 32bit (R/W)
188  */
189 #define COH901318_CX_CTRL					(0x0400)
190 #define COH901318_CX_CTRL_SPACING				(0x10)
191 /* Transfer Count Enable */
192 #define COH901318_CX_CTRL_TC_ENABLE				(0x00001000)
193 #define COH901318_CX_CTRL_TC_DISABLE				(0x00000000)
194 /* Transfer Count Value 0 - 4095 */
195 #define COH901318_CX_CTRL_TC_VALUE_MASK				(0x00000FFF)
196 /* Burst count */
197 #define COH901318_CX_CTRL_BURST_COUNT_MASK			(0x0000E000)
198 #define COH901318_CX_CTRL_BURST_COUNT_64_BYTES			(0x7 << 13)
199 #define COH901318_CX_CTRL_BURST_COUNT_48_BYTES			(0x6 << 13)
200 #define COH901318_CX_CTRL_BURST_COUNT_32_BYTES			(0x5 << 13)
201 #define COH901318_CX_CTRL_BURST_COUNT_16_BYTES			(0x4 << 13)
202 #define COH901318_CX_CTRL_BURST_COUNT_8_BYTES			(0x3 << 13)
203 #define COH901318_CX_CTRL_BURST_COUNT_4_BYTES			(0x2 << 13)
204 #define COH901318_CX_CTRL_BURST_COUNT_2_BYTES			(0x1 << 13)
205 #define COH901318_CX_CTRL_BURST_COUNT_1_BYTE			(0x0 << 13)
206 /* Source bus size  */
207 #define COH901318_CX_CTRL_SRC_BUS_SIZE_MASK			(0x00030000)
208 #define COH901318_CX_CTRL_SRC_BUS_SIZE_32_BITS			(0x2 << 16)
209 #define COH901318_CX_CTRL_SRC_BUS_SIZE_16_BITS			(0x1 << 16)
210 #define COH901318_CX_CTRL_SRC_BUS_SIZE_8_BITS			(0x0 << 16)
211 /* Source address increment */
212 #define COH901318_CX_CTRL_SRC_ADDR_INC_ENABLE			(0x00040000)
213 #define COH901318_CX_CTRL_SRC_ADDR_INC_DISABLE			(0x00000000)
214 /* Destination Bus Size */
215 #define COH901318_CX_CTRL_DST_BUS_SIZE_MASK			(0x00180000)
216 #define COH901318_CX_CTRL_DST_BUS_SIZE_32_BITS			(0x2 << 19)
217 #define COH901318_CX_CTRL_DST_BUS_SIZE_16_BITS			(0x1 << 19)
218 #define COH901318_CX_CTRL_DST_BUS_SIZE_8_BITS			(0x0 << 19)
219 /* Destination address increment */
220 #define COH901318_CX_CTRL_DST_ADDR_INC_ENABLE			(0x00200000)
221 #define COH901318_CX_CTRL_DST_ADDR_INC_DISABLE			(0x00000000)
222 /* Master Mode (Master2 is only connected to MSL) */
223 #define COH901318_CX_CTRL_MASTER_MODE_MASK			(0x00C00000)
224 #define COH901318_CX_CTRL_MASTER_MODE_M2R_M1W			(0x3 << 22)
225 #define COH901318_CX_CTRL_MASTER_MODE_M1R_M2W			(0x2 << 22)
226 #define COH901318_CX_CTRL_MASTER_MODE_M2RW			(0x1 << 22)
227 #define COH901318_CX_CTRL_MASTER_MODE_M1RW			(0x0 << 22)
228 /* Terminal Count flag to PER enable */
229 #define COH901318_CX_CTRL_TCP_ENABLE				(0x01000000)
230 #define COH901318_CX_CTRL_TCP_DISABLE				(0x00000000)
231 /* Terminal Count flags to CPU enable */
232 #define COH901318_CX_CTRL_TC_IRQ_ENABLE				(0x02000000)
233 #define COH901318_CX_CTRL_TC_IRQ_DISABLE			(0x00000000)
234 /* Hand shake to peripheral */
235 #define COH901318_CX_CTRL_HSP_ENABLE				(0x04000000)
236 #define COH901318_CX_CTRL_HSP_DISABLE				(0x00000000)
237 #define COH901318_CX_CTRL_HSS_ENABLE				(0x08000000)
238 #define COH901318_CX_CTRL_HSS_DISABLE				(0x00000000)
239 /* DMA mode */
240 #define COH901318_CX_CTRL_DDMA_MASK				(0x30000000)
241 #define COH901318_CX_CTRL_DDMA_LEGACY				(0x0 << 28)
242 #define COH901318_CX_CTRL_DDMA_DEMAND_DMA1			(0x1 << 28)
243 #define COH901318_CX_CTRL_DDMA_DEMAND_DMA2			(0x2 << 28)
244 /* Primary Request Data Destination */
245 #define COH901318_CX_CTRL_PRDD_MASK				(0x40000000)
246 #define COH901318_CX_CTRL_PRDD_DEST				(0x1 << 30)
247 #define COH901318_CX_CTRL_PRDD_SOURCE				(0x0 << 30)
248 
249 /*
250  * CX_SRC_ADDR - Channel Source Address Registers 32bit (R/W)
251  */
252 #define COH901318_CX_SRC_ADDR					(0x0404)
253 #define COH901318_CX_SRC_ADDR_SPACING				(0x10)
254 
255 /*
256  * CX_DST_ADDR - Channel Destination Address Registers 32bit R/W
257  */
258 #define COH901318_CX_DST_ADDR					(0x0408)
259 #define COH901318_CX_DST_ADDR_SPACING				(0x10)
260 
261 /*
262  * CX_LNK_ADDR - Channel Link Address Registers 32bit (R/W)
263  */
264 #define COH901318_CX_LNK_ADDR					(0x040C)
265 #define COH901318_CX_LNK_ADDR_SPACING				(0x10)
266 #define COH901318_CX_LNK_LINK_IMMEDIATE				(0x00000001)
267 #endif /* COH901318_H */
268