Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/dtor/input
[linux-2.6-block.git] / drivers / dma / at_hdmac_regs.h
CommitLineData
dc78baa2
NF
1/*
2 * Header file for the Atmel AHB DMA Controller driver
3 *
4 * Copyright (C) 2008 Atmel Corporation
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 */
11#ifndef AT_HDMAC_REGS_H
12#define AT_HDMAC_REGS_H
13
14#include <mach/at_hdmac.h>
15
16#define AT_DMA_MAX_NR_CHANNELS 8
17
18
19#define AT_DMA_GCFG 0x00 /* Global Configuration Register */
20#define AT_DMA_IF_BIGEND(i) (0x1 << (i)) /* AHB-Lite Interface i in Big-endian mode */
21#define AT_DMA_ARB_CFG (0x1 << 4) /* Arbiter mode. */
22#define AT_DMA_ARB_CFG_FIXED (0x0 << 4)
23#define AT_DMA_ARB_CFG_ROUND_ROBIN (0x1 << 4)
24
25#define AT_DMA_EN 0x04 /* Controller Enable Register */
26#define AT_DMA_ENABLE (0x1 << 0)
27
28#define AT_DMA_SREQ 0x08 /* Software Single Request Register */
29#define AT_DMA_SSREQ(x) (0x1 << ((x) << 1)) /* Request a source single transfer on channel x */
30#define AT_DMA_DSREQ(x) (0x1 << (1 + ((x) << 1))) /* Request a destination single transfer on channel x */
31
32#define AT_DMA_CREQ 0x0C /* Software Chunk Transfer Request Register */
33#define AT_DMA_SCREQ(x) (0x1 << ((x) << 1)) /* Request a source chunk transfer on channel x */
34#define AT_DMA_DCREQ(x) (0x1 << (1 + ((x) << 1))) /* Request a destination chunk transfer on channel x */
35
36#define AT_DMA_LAST 0x10 /* Software Last Transfer Flag Register */
37#define AT_DMA_SLAST(x) (0x1 << ((x) << 1)) /* This src rq is last tx of buffer on channel x */
38#define AT_DMA_DLAST(x) (0x1 << (1 + ((x) << 1))) /* This dst rq is last tx of buffer on channel x */
39
40#define AT_DMA_SYNC 0x14 /* Request Synchronization Register */
41#define AT_DMA_SYR(h) (0x1 << (h)) /* Synchronize handshake line h */
42
43/* Error, Chained Buffer transfer completed and Buffer transfer completed Interrupt registers */
44#define AT_DMA_EBCIER 0x18 /* Enable register */
45#define AT_DMA_EBCIDR 0x1C /* Disable register */
46#define AT_DMA_EBCIMR 0x20 /* Mask Register */
47#define AT_DMA_EBCISR 0x24 /* Status Register */
48#define AT_DMA_CBTC_OFFSET 8
49#define AT_DMA_ERR_OFFSET 16
50#define AT_DMA_BTC(x) (0x1 << (x))
51#define AT_DMA_CBTC(x) (0x1 << (AT_DMA_CBTC_OFFSET + (x)))
52#define AT_DMA_ERR(x) (0x1 << (AT_DMA_ERR_OFFSET + (x)))
53
54#define AT_DMA_CHER 0x28 /* Channel Handler Enable Register */
55#define AT_DMA_ENA(x) (0x1 << (x))
56#define AT_DMA_SUSP(x) (0x1 << ( 8 + (x)))
57#define AT_DMA_KEEP(x) (0x1 << (24 + (x)))
58
59#define AT_DMA_CHDR 0x2C /* Channel Handler Disable Register */
60#define AT_DMA_DIS(x) (0x1 << (x))
61#define AT_DMA_RES(x) (0x1 << ( 8 + (x)))
62
63#define AT_DMA_CHSR 0x30 /* Channel Handler Status Register */
64#define AT_DMA_EMPT(x) (0x1 << (16 + (x)))
65#define AT_DMA_STAL(x) (0x1 << (24 + (x)))
66
67
68#define AT_DMA_CH_REGS_BASE 0x3C /* Channel registers base address */
69#define ch_regs(x) (AT_DMA_CH_REGS_BASE + (x) * 0x28) /* Channel x base addr */
70
71/* Hardware register offset for each channel */
72#define ATC_SADDR_OFFSET 0x00 /* Source Address Register */
73#define ATC_DADDR_OFFSET 0x04 /* Destination Address Register */
74#define ATC_DSCR_OFFSET 0x08 /* Descriptor Address Register */
75#define ATC_CTRLA_OFFSET 0x0C /* Control A Register */
76#define ATC_CTRLB_OFFSET 0x10 /* Control B Register */
77#define ATC_CFG_OFFSET 0x14 /* Configuration Register */
78#define ATC_SPIP_OFFSET 0x18 /* Src PIP Configuration Register */
79#define ATC_DPIP_OFFSET 0x1C /* Dst PIP Configuration Register */
80
81
82/* Bitfield definitions */
83
84/* Bitfields in DSCR */
85#define ATC_DSCR_IF(i) (0x3 & (i)) /* Dsc feched via AHB-Lite Interface i */
86
87/* Bitfields in CTRLA */
88#define ATC_BTSIZE_MAX 0xFFFFUL /* Maximum Buffer Transfer Size */
89#define ATC_BTSIZE(x) (ATC_BTSIZE_MAX & (x)) /* Buffer Transfer Size */
808347f6 90/* Chunck Tranfer size definitions are in at_hdmac.h */
dc78baa2 91#define ATC_SRC_WIDTH_MASK (0x3 << 24) /* Source Single Transfer Size */
808347f6 92#define ATC_SRC_WIDTH(x) ((x) << 24)
dc78baa2
NF
93#define ATC_SRC_WIDTH_BYTE (0x0 << 24)
94#define ATC_SRC_WIDTH_HALFWORD (0x1 << 24)
95#define ATC_SRC_WIDTH_WORD (0x2 << 24)
96#define ATC_DST_WIDTH_MASK (0x3 << 28) /* Destination Single Transfer Size */
808347f6 97#define ATC_DST_WIDTH(x) ((x) << 28)
dc78baa2
NF
98#define ATC_DST_WIDTH_BYTE (0x0 << 28)
99#define ATC_DST_WIDTH_HALFWORD (0x1 << 28)
100#define ATC_DST_WIDTH_WORD (0x2 << 28)
101#define ATC_DONE (0x1 << 31) /* Tx Done (only written back in descriptor) */
102
103/* Bitfields in CTRLB */
104#define ATC_SIF(i) (0x3 & (i)) /* Src tx done via AHB-Lite Interface i */
105#define ATC_DIF(i) ((0x3 & (i)) << 4) /* Dst tx done via AHB-Lite Interface i */
ae14d4b5
NF
106 /* Specify AHB interfaces */
107#define AT_DMA_MEM_IF 0 /* interface 0 as memory interface */
108#define AT_DMA_PER_IF 1 /* interface 1 as peripheral interface */
109
dc78baa2
NF
110#define ATC_SRC_PIP (0x1 << 8) /* Source Picture-in-Picture enabled */
111#define ATC_DST_PIP (0x1 << 12) /* Destination Picture-in-Picture enabled */
112#define ATC_SRC_DSCR_DIS (0x1 << 16) /* Src Descriptor fetch disable */
113#define ATC_DST_DSCR_DIS (0x1 << 20) /* Dst Descriptor fetch disable */
114#define ATC_FC_MASK (0x7 << 21) /* Choose Flow Controller */
115#define ATC_FC_MEM2MEM (0x0 << 21) /* Mem-to-Mem (DMA) */
116#define ATC_FC_MEM2PER (0x1 << 21) /* Mem-to-Periph (DMA) */
117#define ATC_FC_PER2MEM (0x2 << 21) /* Periph-to-Mem (DMA) */
118#define ATC_FC_PER2PER (0x3 << 21) /* Periph-to-Periph (DMA) */
119#define ATC_FC_PER2MEM_PER (0x4 << 21) /* Periph-to-Mem (Peripheral) */
120#define ATC_FC_MEM2PER_PER (0x5 << 21) /* Mem-to-Periph (Peripheral) */
808347f6
NF
121#define ATC_FC_PER2PER_SRCPER (0x6 << 21) /* Periph-to-Periph (Src Peripheral) */
122#define ATC_FC_PER2PER_DSTPER (0x7 << 21) /* Periph-to-Periph (Dst Peripheral) */
dc78baa2
NF
123#define ATC_SRC_ADDR_MODE_MASK (0x3 << 24)
124#define ATC_SRC_ADDR_MODE_INCR (0x0 << 24) /* Incrementing Mode */
125#define ATC_SRC_ADDR_MODE_DECR (0x1 << 24) /* Decrementing Mode */
126#define ATC_SRC_ADDR_MODE_FIXED (0x2 << 24) /* Fixed Mode */
127#define ATC_DST_ADDR_MODE_MASK (0x3 << 28)
128#define ATC_DST_ADDR_MODE_INCR (0x0 << 28) /* Incrementing Mode */
129#define ATC_DST_ADDR_MODE_DECR (0x1 << 28) /* Decrementing Mode */
130#define ATC_DST_ADDR_MODE_FIXED (0x2 << 28) /* Fixed Mode */
131#define ATC_IEN (0x1 << 30) /* BTC interrupt enable (active low) */
132#define ATC_AUTO (0x1 << 31) /* Auto multiple buffer tx enable */
133
134/* Bitfields in CFG */
808347f6 135/* are in at_hdmac.h */
dc78baa2
NF
136
137/* Bitfields in SPIP */
138#define ATC_SPIP_HOLE(x) (0xFFFFU & (x))
139#define ATC_SPIP_BOUNDARY(x) ((0x3FF & (x)) << 16)
140
141/* Bitfields in DPIP */
142#define ATC_DPIP_HOLE(x) (0xFFFFU & (x))
143#define ATC_DPIP_BOUNDARY(x) ((0x3FF & (x)) << 16)
144
145
146/*-- descriptors -----------------------------------------------------*/
147
148/* LLI == Linked List Item; aka DMA buffer descriptor */
149struct at_lli {
150 /* values that are not changed by hardware */
151 dma_addr_t saddr;
152 dma_addr_t daddr;
153 /* value that may get written back: */
154 u32 ctrla;
155 /* more values that are not changed by hardware */
156 u32 ctrlb;
157 dma_addr_t dscr; /* chain to next lli */
158};
159
160/**
161 * struct at_desc - software descriptor
162 * @at_lli: hardware lli structure
163 * @txd: support for the async_tx api
164 * @desc_node: node on the channed descriptors list
165 * @len: total transaction bytecount
166 */
167struct at_desc {
168 /* FIRST values the hardware uses */
169 struct at_lli lli;
170
171 /* THEN values for driver housekeeping */
285a3c71 172 struct list_head tx_list;
dc78baa2
NF
173 struct dma_async_tx_descriptor txd;
174 struct list_head desc_node;
175 size_t len;
176};
177
178static inline struct at_desc *
179txd_to_at_desc(struct dma_async_tx_descriptor *txd)
180{
181 return container_of(txd, struct at_desc, txd);
182}
183
184
185/*-- Channels --------------------------------------------------------*/
186
53830cc7
NF
187/**
188 * atc_status - information bits stored in channel status flag
189 *
190 * Manipulated with atomic operations.
191 */
192enum atc_status {
193 ATC_IS_ERROR = 0,
23b5e3ad 194 ATC_IS_PAUSED = 1,
53830cc7
NF
195 ATC_IS_CYCLIC = 24,
196};
197
dc78baa2
NF
198/**
199 * struct at_dma_chan - internal representation of an Atmel HDMAC channel
200 * @chan_common: common dmaengine channel object members
201 * @device: parent device
202 * @ch_regs: memory mapped register base
203 * @mask: channel index in a mask
53830cc7 204 * @status: transmit status information from irq/prep* functions
dc78baa2
NF
205 * to tasklet (use atomic operations)
206 * @tasklet: bottom half to finish transaction work
207 * @lock: serializes enqueue/dequeue operations to descriptors lists
208 * @completed_cookie: identifier for the most recently completed operation
209 * @active_list: list of descriptors dmaengine is being running on
210 * @queue: list of descriptors ready to be submitted to engine
211 * @free_list: list of descriptors usable by the channel
212 * @descs_allocated: records the actual size of the descriptor pool
213 */
214struct at_dma_chan {
215 struct dma_chan chan_common;
216 struct at_dma *device;
217 void __iomem *ch_regs;
218 u8 mask;
53830cc7 219 unsigned long status;
dc78baa2
NF
220 struct tasklet_struct tasklet;
221
222 spinlock_t lock;
223
224 /* these other elements are all protected by lock */
225 dma_cookie_t completed_cookie;
226 struct list_head active_list;
227 struct list_head queue;
228 struct list_head free_list;
229 unsigned int descs_allocated;
230};
231
232#define channel_readl(atchan, name) \
233 __raw_readl((atchan)->ch_regs + ATC_##name##_OFFSET)
234
235#define channel_writel(atchan, name, val) \
236 __raw_writel((val), (atchan)->ch_regs + ATC_##name##_OFFSET)
237
238static inline struct at_dma_chan *to_at_dma_chan(struct dma_chan *dchan)
239{
240 return container_of(dchan, struct at_dma_chan, chan_common);
241}
242
243
244/*-- Controller ------------------------------------------------------*/
245
246/**
247 * struct at_dma - internal representation of an Atmel HDMA Controller
248 * @chan_common: common dmaengine dma_device object members
249 * @ch_regs: memory mapped register base
250 * @clk: dma controller clock
251 * @all_chan_mask: all channels availlable in a mask
252 * @dma_desc_pool: base of DMA descriptor region (DMA address)
253 * @chan: channels table to store at_dma_chan structures
254 */
255struct at_dma {
256 struct dma_device dma_common;
257 void __iomem *regs;
258 struct clk *clk;
259
260 u8 all_chan_mask;
261
262 struct dma_pool *dma_desc_pool;
263 /* AT THE END channels table */
264 struct at_dma_chan chan[0];
265};
266
267#define dma_readl(atdma, name) \
268 __raw_readl((atdma)->regs + AT_DMA_##name)
269#define dma_writel(atdma, name, val) \
270 __raw_writel((val), (atdma)->regs + AT_DMA_##name)
271
272static inline struct at_dma *to_at_dma(struct dma_device *ddev)
273{
274 return container_of(ddev, struct at_dma, dma_common);
275}
276
277
278/*-- Helper functions ------------------------------------------------*/
279
280static struct device *chan2dev(struct dma_chan *chan)
281{
282 return &chan->dev->device;
283}
284static struct device *chan2parent(struct dma_chan *chan)
285{
286 return chan->dev->device.parent;
287}
288
289#if defined(VERBOSE_DEBUG)
290static void vdbg_dump_regs(struct at_dma_chan *atchan)
291{
292 struct at_dma *atdma = to_at_dma(atchan->chan_common.device);
293
294 dev_err(chan2dev(&atchan->chan_common),
295 " channel %d : imr = 0x%x, chsr = 0x%x\n",
296 atchan->chan_common.chan_id,
297 dma_readl(atdma, EBCIMR),
298 dma_readl(atdma, CHSR));
299
300 dev_err(chan2dev(&atchan->chan_common),
808347f6 301 " channel: s0x%x d0x%x ctrl0x%x:0x%x cfg0x%x l0x%x\n",
dc78baa2
NF
302 channel_readl(atchan, SADDR),
303 channel_readl(atchan, DADDR),
304 channel_readl(atchan, CTRLA),
305 channel_readl(atchan, CTRLB),
808347f6 306 channel_readl(atchan, CFG),
dc78baa2
NF
307 channel_readl(atchan, DSCR));
308}
309#else
310static void vdbg_dump_regs(struct at_dma_chan *atchan) {}
311#endif
312
313static void atc_dump_lli(struct at_dma_chan *atchan, struct at_lli *lli)
314{
315 dev_printk(KERN_CRIT, chan2dev(&atchan->chan_common),
316 " desc: s0x%x d0x%x ctrl0x%x:0x%x l0x%x\n",
317 lli->saddr, lli->daddr,
318 lli->ctrla, lli->ctrlb, lli->dscr);
319}
320
321
322static void atc_setup_irq(struct at_dma_chan *atchan, int on)
323{
324 struct at_dma *atdma = to_at_dma(atchan->chan_common.device);
325 u32 ebci;
326
9b3aa589
NF
327 /* enable interrupts on buffer transfer completion & error */
328 ebci = AT_DMA_BTC(atchan->chan_common.chan_id)
dc78baa2
NF
329 | AT_DMA_ERR(atchan->chan_common.chan_id);
330 if (on)
331 dma_writel(atdma, EBCIER, ebci);
332 else
333 dma_writel(atdma, EBCIDR, ebci);
334}
335
336static inline void atc_enable_irq(struct at_dma_chan *atchan)
337{
338 atc_setup_irq(atchan, 1);
339}
340
341static inline void atc_disable_irq(struct at_dma_chan *atchan)
342{
343 atc_setup_irq(atchan, 0);
344}
345
346
347/**
348 * atc_chan_is_enabled - test if given channel is enabled
349 * @atchan: channel we want to test status
350 */
351static inline int atc_chan_is_enabled(struct at_dma_chan *atchan)
352{
353 struct at_dma *atdma = to_at_dma(atchan->chan_common.device);
354
355 return !!(dma_readl(atdma, CHSR) & atchan->mask);
356}
357
358
359/**
360 * set_desc_eol - set end-of-link to descriptor so it will end transfer
361 * @desc: descriptor, signle or at the end of a chain, to end chain on
362 */
363static void set_desc_eol(struct at_desc *desc)
364{
9b3aa589
NF
365 u32 ctrlb = desc->lli.ctrlb;
366
367 ctrlb &= ~ATC_IEN;
368 ctrlb |= ATC_SRC_DSCR_DIS | ATC_DST_DSCR_DIS;
369
370 desc->lli.ctrlb = ctrlb;
dc78baa2
NF
371 desc->lli.dscr = 0;
372}
373
374#endif /* AT_HDMAC_REGS_H */